Simutrans-Squirrel-API
Public Member Functions | Public Attributes | List of all members
coord3d Class Reference
Inheritance diagram for coord3d:
coord map_object_x schedule_entry_x tile_object_list_x tile_x building_x label_x sign_x tree_x way_x depot_x

Public Member Functions

 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)
 
- Public 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 ()
 

Public Attributes

integer x
 x-coordinate
 
integer y
 y-coordinate
 
integer z
 z-coordinate - height
 
- Public Attributes inherited from coord
integer x
 x-coordinate
 
integer y
 y-coordinate
 

Detailed Description

Class that holds 3d coordinates. All functions that use this as input parameters will accept every data structure that contains members x, y, and z.

Coordinates always refer to the original rotation in map::file. They will be rotated if transferred between the game engine and squirrel.

Definition at line 70 of file api_simple.cc.

Member Function Documentation

string coord3d::_tostring ( )

Converts coordinate to string containing the coordinates in the current rotation of the map.

Cannot be used in links in scenario texts. Use href instead.

string coord3d::href ( string  text)

Generates text to generate links to coordinates in scenario texts.

Parameters
texttext to be shown in the link
Returns
a-tag with link in href
See also
get_rule_text

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