Class that handles all group related functions. More...
Public Types | |
enum | GroupID { GROUP_ALL = 0xFFFD, GROUP_DEFAULT = 0xFFFE, GROUP_INVALID = 0xFFFF } |
The group IDs of some special groups. More... | |
Static Public Member Functions | |
static bool | IsValidGroup (GroupID group_id) |
Checks whether the given group is valid. | |
static GroupID | CreateGroup (AIVehicle::VehicleType vehicle_type) |
Create a new group. | |
static bool | DeleteGroup (GroupID group_id) |
Delete the given group. | |
static AIVehicle::VehicleType | GetVehicleType (GroupID group_id) |
Get the vehicle type of a group. | |
static bool | SetName (GroupID group_id, const char *name) |
Set the name of a group. | |
static char * | GetName (GroupID group_id) |
Get the name of a group. | |
static bool | EnableAutoReplaceProtection (GroupID group_id, bool enable) |
Enable or disable autoreplace protected. | |
static bool | GetAutoReplaceProtection (GroupID group_id) |
Get the autoreplace protection status. | |
static int32 | GetNumEngines (GroupID group_id, EngineID engine_id) |
Get the number of engines in a given group. | |
static bool | MoveVehicle (GroupID group_id, VehicleID vehicle_id) |
Move a vehicle to a group. | |
static bool | EnableWagonRemoval (bool keep_length) |
Enable or disable the removal of wagons when a (part of a) vehicle is (auto)replaced with a longer variant (longer wagons or longer engines) If enabled, wagons are removed from the end of the vehicle until it fits in the same number of tiles as it did before. | |
static bool | HasWagonRemoval () |
Get the current status of wagon removal. | |
static bool | SetAutoReplace (GroupID group_id, EngineID engine_id_old, EngineID engine_id_new) |
Start replacing all vehicles with a specified engine with another engine. | |
static EngineID | GetEngineReplacement (GroupID group_id, EngineID engine_id) |
Get the EngineID the given EngineID is replaced with. | |
static bool | StopAutoReplace (GroupID group_id, EngineID engine_id) |
Stop replacing a certain engine in the specified group. |
Class that handles all group related functions.
enum AIGroup::GroupID |
static GroupID AIGroup::CreateGroup | ( | AIVehicle::VehicleType | vehicle_type | ) | [static] |
Create a new group.
vehicle_type | The type of vehicle to create a group for. |
static bool AIGroup::DeleteGroup | ( | GroupID | group_id | ) | [static] |
Delete the given group.
When the deletion succeeds all vehicles in the given group will move to the GROUP_DEFAULT.
group_id | The group to delete. |
static bool AIGroup::EnableAutoReplaceProtection | ( | GroupID | group_id, | |
bool | enable | |||
) | [static] |
Enable or disable autoreplace protected.
If the protection is enabled, global autoreplace won't affect vehicles in this group.
group_id | The group to change the protection for. | |
enable | True if protection should be enabled. |
static bool AIGroup::EnableWagonRemoval | ( | bool | keep_length | ) | [static] |
Enable or disable the removal of wagons when a (part of a) vehicle is (auto)replaced with a longer variant (longer wagons or longer engines) If enabled, wagons are removed from the end of the vehicle until it fits in the same number of tiles as it did before.
keep_length | If true, wagons will be removed if the a new engine is longer. |
static bool AIGroup::GetAutoReplaceProtection | ( | GroupID | group_id | ) | [static] |
Get the autoreplace protection status.
group_id | The group to get the protection status for. |
Get the EngineID the given EngineID is replaced with.
group_id | The group to get the replacement from. | |
engine_id | The engine that is being replaced. |
static char* AIGroup::GetName | ( | GroupID | group_id | ) | [static] |
Get the name of a group.
group_id | The group to get the name of. |
Get the number of engines in a given group.
group_id | The group to get the number of engines in. | |
engine_id | The engine id to count. |
static AIVehicle::VehicleType AIGroup::GetVehicleType | ( | GroupID | group_id | ) | [static] |
Get the vehicle type of a group.
group_id | The group to get the type from. |
static bool AIGroup::HasWagonRemoval | ( | ) | [static] |
Get the current status of wagon removal.
static bool AIGroup::IsValidGroup | ( | GroupID | group_id | ) | [static] |
Checks whether the given group is valid.
group_id | The group to check. |
Move a vehicle to a group.
group_id | The group to move the vehicel to. | |
vehicle_id | The vehicle to move to the group. |
static bool AIGroup::SetAutoReplace | ( | GroupID | group_id, | |
EngineID | engine_id_old, | |||
EngineID | engine_id_new | |||
) | [static] |
Start replacing all vehicles with a specified engine with another engine.
group_id | The group to replace vehicles from. Use ALL_GROUP to replace vehicles from all groups that haven't set autoreplace protection. | |
engine_id_old | The engine id to start replacing. | |
engine_id_new | The engine id to replace with. |
static bool AIGroup::SetName | ( | GroupID | group_id, | |
const char * | name | |||
) | [static] |
Set the name of a group.
group_id | The group to set the name for. | |
name | The name for the group. |
AIError::ERR_NAME_IS_NOT_UNIQUE |
Stop replacing a certain engine in the specified group.
group_id | The group to stop replacing the engine in. | |
engine_id | The engine id to stop replacing with another engine. |