Class that handles all engine related functions. More...
Static Public Member Functions | |
static bool | IsValidEngine (EngineID engine_id) |
Checks whether the given engine type is valid. | |
static bool | IsBuildable (EngineID engine_id) |
Checks whether the given engine type is buildable by you. | |
static char * | GetName (EngineID engine_id) |
Get the name of an engine. | |
static CargoID | GetCargoType (EngineID engine_id) |
Get the cargo-type of an engine. | |
static bool | CanRefitCargo (EngineID engine_id, CargoID cargo_id) |
Check if the cargo of an engine can be refitted to your requested. | |
static bool | CanPullCargo (EngineID engine_id, CargoID cargo_id) |
Check if the engine can pull a wagon with the given cargo. | |
static int32 | GetCapacity (EngineID engine_id) |
Get the capacity of an engine. | |
static int32 | GetReliability (EngineID engine_id) |
Get the reliability of an engine. | |
static int32 | GetMaxSpeed (EngineID engine_id) |
Get the maximum speed of an engine. | |
static Money | GetPrice (EngineID engine_id) |
Get the new cost of an engine. | |
static int32 | GetMaxAge (EngineID engine_id) |
Get the maximum age of a brand new engine. | |
static Money | GetRunningCost (EngineID engine_id) |
Get the running cost of an engine. | |
static int32 | GetPower (EngineID engine_id) |
Get the power of an engine. | |
static int32 | GetWeight (EngineID engine_id) |
Get the weight of an engine. | |
static int32 | GetMaxTractiveEffort (EngineID engine_id) |
Get the maximum tractive effort of an engine. | |
static int32 | GetDesignDate (EngineID engine_id) |
Get the date this engine was designed. | |
static AIVehicle::VehicleType | GetVehicleType (EngineID engine_id) |
Get the type of an engine. | |
static bool | IsWagon (EngineID engine_id) |
Check if an engine is a wagon. | |
static bool | CanRunOnRail (EngineID engine_id, AIRail::RailType track_rail_type) |
Check if a train vehicle can run on a RailType. | |
static bool | HasPowerOnRail (EngineID engine_id, AIRail::RailType track_rail_type) |
Check if a train engine has power on a RailType. | |
static AIRoad::RoadType | GetRoadType (EngineID engine_id) |
Get the RoadType of the engine. | |
static AIRail::RailType | GetRailType (EngineID engine_id) |
Get the RailType of the engine. | |
static bool | IsArticulated (EngineID engine_id) |
Check if the engine is articulated. | |
static AIAirport::PlaneType | GetPlaneType (EngineID engine_id) |
Get the PlaneType of the engine. |
Class that handles all engine related functions.
Check if the engine can pull a wagon with the given cargo.
engine_id | The engine to check. | |
cargo_id | The cargo to check. |
Check if the cargo of an engine can be refitted to your requested.
If the engine already allows this cargo, the function also returns true. In case of articulated vehicles the function decides whether at least one part can carry the cargo.
engine_id | The engine to check for refitting. | |
cargo_id | The cargo to check for refitting. |
static bool AIEngine::CanRunOnRail | ( | EngineID | engine_id, | |
AIRail::RailType | track_rail_type | |||
) | [static] |
Check if a train vehicle can run on a RailType.
engine_id | The engine to check. | |
track_rail_type | The type you want to check. |
static int32 AIEngine::GetCapacity | ( | EngineID | engine_id | ) | [static] |
Get the capacity of an engine.
In case it can transport multiple cargos, it returns the first/main.
engine_id | The engine to get the capacity of. |
Get the cargo-type of an engine.
In case it can transport multiple cargos, it returns the first/main.
engine_id | The engine to get the cargo-type of. |
static int32 AIEngine::GetDesignDate | ( | EngineID | engine_id | ) | [static] |
Get the date this engine was designed.
engine_id | The engine to get the design date of. |
static int32 AIEngine::GetMaxAge | ( | EngineID | engine_id | ) | [static] |
Get the maximum age of a brand new engine.
engine_id | The engine to get the maximum age of. |
static int32 AIEngine::GetMaxSpeed | ( | EngineID | engine_id | ) | [static] |
Get the maximum speed of an engine.
engine_id | The engine to get the maximum speed of. |
static int32 AIEngine::GetMaxTractiveEffort | ( | EngineID | engine_id | ) | [static] |
Get the maximum tractive effort of an engine.
engine_id | The engine to get the maximum tractive effort of. |
static char* AIEngine::GetName | ( | EngineID | engine_id | ) | [static] |
Get the name of an engine.
engine_id | The engine to get the name of. |
static AIAirport::PlaneType AIEngine::GetPlaneType | ( | EngineID | engine_id | ) | [static] |
Get the PlaneType of the engine.
engine_id | The engine to get the PlaneType of. |
static int32 AIEngine::GetPower | ( | EngineID | engine_id | ) | [static] |
Get the power of an engine.
engine_id | The engine to get the power of. |
Get the new cost of an engine.
engine_id | The engine to get the new cost of. |
static AIRail::RailType AIEngine::GetRailType | ( | EngineID | engine_id | ) | [static] |
Get the RailType of the engine.
engine_id | The engine to get the RailType of. |
static int32 AIEngine::GetReliability | ( | EngineID | engine_id | ) | [static] |
Get the reliability of an engine.
The value is between 0 and 100, where 100 means 100% reliability (never breaks down) and 0 means 0% reliability (you most likely don't want to buy it).
engine_id | The engine to get the reliability of. |
static AIRoad::RoadType AIEngine::GetRoadType | ( | EngineID | engine_id | ) | [static] |
Get the RoadType of the engine.
engine_id | The engine to get the RoadType of. |
Get the running cost of an engine.
engine_id | The engine to get the running cost of. |
static AIVehicle::VehicleType AIEngine::GetVehicleType | ( | EngineID | engine_id | ) | [static] |
Get the type of an engine.
engine_id | The engine to get the type of. |
static int32 AIEngine::GetWeight | ( | EngineID | engine_id | ) | [static] |
Get the weight of an engine.
engine_id | The engine to get the weight of. |
static bool AIEngine::HasPowerOnRail | ( | EngineID | engine_id, | |
AIRail::RailType | track_rail_type | |||
) | [static] |
Check if a train engine has power on a RailType.
engine_id | The engine to check. | |
track_rail_type | Another RailType. |
static bool AIEngine::IsArticulated | ( | EngineID | engine_id | ) | [static] |
Check if the engine is articulated.
engine_id | The engine to check. |
static bool AIEngine::IsBuildable | ( | EngineID | engine_id | ) | [static] |
Checks whether the given engine type is buildable by you.
engine_id | The engine to check. |
static bool AIEngine::IsValidEngine | ( | EngineID | engine_id | ) | [static] |
Checks whether the given engine type is valid.
An engine is valid if you have at least one vehicle of this engine or it's currently buildable.
engine_id | The engine to check. |
static bool AIEngine::IsWagon | ( | EngineID | engine_id | ) | [static] |
Check if an engine is a wagon.
engine_id | The engine to check. |