Public Types | |
enum | ErrorMessages { ERR_SIGN_BASE, ERR_SIGN_TOO_MANY_SIGNS } |
All sign related error messages. More... | |
Static Public Member Functions | |
static bool | IsValidSign (SignID sign_id) |
Checks whether the given sign index is valid. | |
static bool | SetName (SignID sign_id, Text *name) |
Set the name of a sign. | |
static char * | GetName (SignID sign_id) |
Get the name of the sign. | |
static TileIndex | GetLocation (SignID sign_id) |
Gets the location of the sign. | |
static SignID | BuildSign (TileIndex location, Text *name) |
Builds a sign on the map. | |
static bool | RemoveSign (SignID sign_id) |
Removes a sign from the map. |
static bool AISign::IsValidSign | ( | SignID | sign_id | ) | [static] |
Checks whether the given sign index is valid.
sign_id | The index to check. |
static bool AISign::SetName | ( | SignID | sign_id, | |
Text * | name | |||
) | [static] |
Set the name of a sign.
sign_id | The sign to set the name for. | |
name | The name for the sign (can be either a raw string, or a AIText object). |
name != NULL && len(name) != 0.
AIError::ERR_NAME_IS_NOT_UNIQUE |
static char* AISign::GetName | ( | SignID | sign_id | ) | [static] |
Get the name of the sign.
sign_id | The sign to get the name of. |
static TileIndex AISign::GetLocation | ( | SignID | sign_id | ) | [static] |
Gets the location of the sign.
sign_id | The sign to get the location of. |
static SignID AISign::BuildSign | ( | TileIndex | location, | |
Text * | name | |||
) | [static] |
Builds a sign on the map.
location | The place to build the sign. | |
name | The text to place on the sign (can be either a raw string, or a AIText object). |
name != NULL && len(name) != 0.
AISign::ERR_SIGN_TOO_MANY_SIGNS |
static bool AISign::RemoveSign | ( | SignID | sign_id | ) | [static] |
Removes a sign from the map.
sign_id | The sign to remove. |