GSSign Class Reference

Class that handles all sign related functions. More...


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 GSCompany::CompanyID GetOwner (SignID sign_id)
 Get the owner of a 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.


Detailed Description

Class that handles all sign related functions.

Member Enumeration Documentation

All sign related error messages.

Enumerator:
ERR_SIGN_BASE  Base for sign building related errors.
ERR_SIGN_TOO_MANY_SIGNS  Too many signs have been placed.


Member Function Documentation

static bool GSSign::IsValidSign ( SignID  sign_id  )  [static]

Checks whether the given sign index is valid.

Parameters:
sign_id The index to check.
Returns:
True if and only if the sign is valid.

static bool GSSign::SetName ( SignID  sign_id,
Text *  name 
) [static]

Set the name of a sign.

Parameters:
sign_id The sign to set the name for.
name The name for the sign (can be either a raw string, or a GSText object).
Precondition:
IsValidSign(sign_id).

name != NULL && len(name) != 0.

Exceptions:
GSError::ERR_NAME_IS_NOT_UNIQUE 
Returns:
True if and only if the name was changed.

static char* GSSign::GetName ( SignID  sign_id  )  [static]

Get the name of the sign.

Parameters:
sign_id The sign to get the name of.
Precondition:
IsValidSign(sign_id).
Returns:
The name of the sign.

static GSCompany::CompanyID GSSign::GetOwner ( SignID  sign_id  )  [static]

Get the owner of a sign.

Parameters:
sign_id The sign to get the owner of.
Precondition:
IsValidSign(sign_id).
Returns:
The owner the sign has.

static TileIndex GSSign::GetLocation ( SignID  sign_id  )  [static]

Gets the location of the sign.

Parameters:
sign_id The sign to get the location of.
Precondition:
IsValidSign(sign_id).
Returns:
The location of the sign.

static SignID GSSign::BuildSign ( TileIndex  location,
Text *  name 
) [static]

Builds a sign on the map.

Parameters:
location The place to build the sign.
name The text to place on the sign (can be either a raw string, or a GSText object).
Precondition:
GSMap::IsValidTile(location).

name != NULL && len(name) != 0.

Exceptions:
GSSign::ERR_SIGN_TOO_MANY_SIGNS 
Returns:
The SignID of the build sign (use IsValidSign() to check for validity). In test-mode it returns 0 if successful, or any other value to indicate failure.

static bool GSSign::RemoveSign ( SignID  sign_id  )  [static]

Removes a sign from the map.

Parameters:
sign_id The sign to remove.
Precondition:
IsValidSign(sign_id).
Returns:
True if and only if the sign has been removed.


Generated on Fri Nov 29 12:50:40 2013 for OpenTTD Game API by  doxygen 1.5.6