Class that handles all sign related functions. More...
#include <script_sign.hpp>
Public Types | |
enum | ErrorMessages { ERR_SIGN_BASE = ScriptError::ERR_CAT_SIGN << ScriptError::ERR_CAT_BIT_SIZE, 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, const char *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, const char *text) |
Builds a sign on the map. | |
static bool | RemoveSign (SignID sign_id) |
Removes a sign from the map. |
Class that handles all sign related functions.
ai
Definition at line 21 of file script_sign.hpp.
All sign related error messages.
ERR_SIGN_BASE |
Base for sign building related errors. |
ERR_SIGN_TOO_MANY_SIGNS |
Too many signs have been placed. |
Definition at line 26 of file script_sign.hpp.
Builds a sign on the map.
location | The place to build the sign. | |
text | The text to place on the sign. |
ScriptSign::ERR_SIGN_TOO_MANY_SIGNS |
Definition at line 66 of file script_sign.cpp.
References CMD_PLACE_SIGN, ScriptObject::DoCommand(), ScriptInstance::DoCommandReturnSignID(), EnforcePrecondition, EnforcePreconditionCustomError, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG, INVALID_SIGN, IsValidTile(), MAX_LENGTH_SIGN_NAME_CHARS, StrEmpty(), and Utf8StringLength().
Gets the location of the sign.
sign_id | The sign to get the location of. |
Definition at line 52 of file script_sign.cpp.
References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_sign_pool >::Get(), INVALID_TILE, IsValidSign(), and TileVirtXY().
char * ScriptSign::GetName | ( | SignID | sign_id | ) | [static] |
Get the name of the sign.
sign_id | The sign to get the name of. |
Definition at line 39 of file script_sign.cpp.
References IsValidSign(), and SetDParam().
bool ScriptSign::IsValidSign | ( | SignID | sign_id | ) | [static] |
Checks whether the given sign index is valid.
sign_id | The index to check. |
Definition at line 24 of file script_sign.cpp.
References _current_company, and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_sign_pool >::GetIfValid().
Referenced by GetLocation(), GetName(), RemoveSign(), and SetName().
bool ScriptSign::RemoveSign | ( | SignID | sign_id | ) | [static] |
Removes a sign from the map.
sign_id | The sign to remove. |
Definition at line 60 of file script_sign.cpp.
References CMD_RENAME_SIGN, ScriptObject::DoCommand(), EnforcePrecondition, and IsValidSign().
bool ScriptSign::SetName | ( | SignID | sign_id, | |
const char * | name | |||
) | [static] |
Set the name of a sign.
sign_id | The sign to set the name for. | |
name | The name for the sign. |
ScriptError::ERR_NAME_IS_NOT_UNIQUE |
Definition at line 30 of file script_sign.cpp.
References CMD_RENAME_SIGN, ScriptObject::DoCommand(), EnforcePrecondition, EnforcePreconditionCustomError, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG, IsValidSign(), MAX_LENGTH_SIGN_NAME_CHARS, StrEmpty(), and Utf8StringLength().