OpenTTD GameScript API
20240906-master-gd5ff6b4156
|
Class that handles all bridge related functions. More...
Public Types | |
enum | ErrorMessages { ERR_BRIDGE_BASE, ERR_BRIDGE_TYPE_UNAVAILABLE, ERR_BRIDGE_CANNOT_END_IN_WATER, ERR_BRIDGE_HEADS_NOT_ON_SAME_HEIGHT } |
All bridge related error messages. More... | |
Static Public Member Functions | |
static bool | IsValidBridge (BridgeID bridge_id) |
Checks whether the given bridge type is valid. More... | |
static bool | IsBridgeTile (TileIndex tile) |
Checks whether the given tile is actually a bridge start or end tile. More... | |
static BridgeID | GetBridgeID (TileIndex tile) |
Get the BridgeID of a bridge at a given tile. More... | |
static string | GetName (BridgeID bridge_id, GSVehicle::VehicleType vehicle_type) |
Get the name of a bridge. More... | |
static int | GetMaxSpeed (BridgeID bridge_id) |
Get the maximum speed of a bridge. More... | |
static Money | GetPrice (BridgeID bridge_id, int length) |
Get the new cost of a bridge, excluding the road and/or rail. More... | |
static int | GetMaxLength (BridgeID bridge_id) |
Get the maximum length of a bridge. More... | |
static int | GetMinLength (BridgeID bridge_id) |
Get the minimum length of a bridge. More... | |
static bool | BuildBridge (GSVehicle::VehicleType vehicle_type, BridgeID bridge_id, TileIndex start, TileIndex end) |
Build a bridge from one tile to the other. More... | |
static bool | RemoveBridge (TileIndex tile) |
Removes a bridge, by executing it on either the start or end tile. More... | |
static TileIndex | GetOtherBridgeEnd (TileIndex tile) |
Get the tile that is on the other end of a bridge starting at tile. More... | |
Class that handles all bridge related functions.
All bridge related error messages.
|
static |
Build a bridge from one tile to the other.
As an extra for road, this functions builds two half-pieces of road on each end of the bridge, making it easier for you to connect it to your network.
vehicle_type | The vehicle-type of bridge to build. |
bridge_id | The bridge-type to build. |
start | Where to start the bridge. |
end | Where to end the bridge. |
Get the BridgeID of a bridge at a given tile.
tile | The tile to get the BridgeID from. |
|
static |
Get the maximum length of a bridge.
bridge_id | The bridge to get the maximum length of. |
|
static |
Get the maximum speed of a bridge.
bridge_id | The bridge to get the maximum speed of. |
|
static |
Get the minimum length of a bridge.
bridge_id | The bridge to get the minimum length of. |
|
static |
Get the name of a bridge.
bridge_id | The bridge to get the name of. |
vehicle_type | The vehicle-type of bridge to get the name of. |
Get the tile that is on the other end of a bridge starting at tile.
tile | The tile that is an end of a bridge. |
Get the new cost of a bridge, excluding the road and/or rail.
bridge_id | The bridge to get the new cost of. |
length | The length of the bridge. The value will be clamped to 0 .. MAX(int). |
|
static |
Checks whether the given tile is actually a bridge start or end tile.
tile | The tile to check. |
|
static |
Checks whether the given bridge type is valid.
bridge_id | The bridge to check. |
|
static |
Removes a bridge, by executing it on either the start or end tile.
tile | An end or start tile of the bridge. |
GSError::ERR_OWNED_BY_ANOTHER_COMPANY |