Simutrans-Squirrel-API
Public Member Functions | List of all members
map_object_x Class Reference
Inheritance diagram for map_object_x:
extend_get coord3d ingame_object building_x label_x sign_x tree_x way_x depot_x

Public Member Functions

 map_object_x (integer x, integer y, integer z, map_objects type)
 
bool is_valid ()
 
player_x get_owner ()
 
string get_name ()
 
way_types get_waytype ()
 
coord3d get_pos ()
 
string is_removable (player_x)
 
map_objects get_type ()
 
void mark ()
 
void unmark ()
 
bool is_marked ()
 

Additional Inherited Members

- Private Member Functions inherited from coord3d
 coord (int x, int y, int z)
 
coord3d operator+ (coord3d other)
 
coord3d operator- (coord other)
 
coord3d operator+ (coord3d other)
 
coord3d operator- (coord other)
 
coord3d operator- ()
 
coord3d operator* (integer fac)
 
coord3d operator/ (integer fac)
 
string _tostring ()
 
string href (string text)
 
- Private Member Functions inherited from coord
 coord (int x, int y)
 
coord operator+ (coord other)
 
coord operator- (coord other)
 
coord operator- ()
 
coord operator* (integer fac)
 
coord operator/ (integer fac)
 
string _tostring ()
 
string href (string text)
 
dir to_dir ()
 
- Private Attributes inherited from coord3d
integer x
 x-coordinate
 
integer y
 y-coordinate
 
integer z
 z-coordinate - height
 
- Private Attributes inherited from coord
integer x
 x-coordinate
 
integer y
 y-coordinate
 

Detailed Description

Class to access objects on the map These classes cannot modify anything.

Definition at line 7 of file api_map_objects.cc.

Constructor & Destructor Documentation

map_object_x::map_object_x ( integer  x,
integer  y,
integer  z,
map_objects  type 
)

Constructor. Implemented by derived classes. Fails if no object of precisely the requested type is on the tile.

Parameters
x
y
z
typeof the map object

Member Function Documentation

string map_object_x::get_name ( )
Returns
raw name.
player_x map_object_x::get_owner ( )
Returns
owner of the object.
coord3d map_object_x::get_pos ( )
Returns
position.
map_objects map_object_x::get_type ( )
Returns
type of object.
way_types map_object_x::get_waytype ( )
Returns
way type, can be wt_invalid.
bool map_object_x::is_marked ( )
Returns
whether object is highlighted.
string map_object_x::is_removable ( player_x  )

Checks whether player can remove this object.

Returns
error message or null if object can be removed.
bool map_object_x::is_valid ( )
Returns
if object is still valid.
void map_object_x::mark ( )

Marks the object for highlighting. Use with care.

void map_object_x::unmark ( )

Unmarks the object for highlighting.


The documentation for this class was generated from the following file: