Inheritance diagram for coord:
Public Member Functions | |
| 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 More... | |
| integer | y |
| y-coordinate More... | |
Detailed Description
Class that holds 2d coordinates. All functions that use this as input parameters will accept every data structure that contains members x and y.
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 32 of file api_simple.cc.
Constructor & Destructor Documentation
◆ coord()
| coord::coord | ( | int | x, |
| int | y | ||
| ) |
Member Function Documentation
◆ _tostring()
| string coord::_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.
◆ href()
| string coord::href | ( | string | text | ) |
Generates text to generate links to coordinates in scenario texts.
- Parameters
-
text text to be shown in the link
- Returns
- a-tag with link in href
- See also
- get_rule_text
◆ operator*()
| coord coord::operator* | ( | integer | fac | ) |
◆ operator+()
◆ operator-() [1/2]
◆ operator-() [2/2]
| coord coord::operator- | ( | ) |
◆ operator/()
| coord coord::operator/ | ( | integer | fac | ) |
◆ to_dir()
| dir coord::to_dir | ( | ) |
Helper function to convert direction vector to dir type.
Member Data Documentation
◆ x
| integer coord::x |
x-coordinate
Definition at line 35 of file api_simple.cc.
◆ y
| integer coord::y |
y-coordinate
Definition at line 37 of file api_simple.cc.
The documentation for this class was generated from the following file:
