dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r19014) -Add: [NoAI] AIOrder::[G|S]etStopLocation to get/set the stop location of trains in a rail station

Browse Source
This commit is contained in:
yexo
2010-02-04 23:18:19 +00:00
parent 0cd9bc27de
commit 2241cd487d
6 changed files with 84 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/ai/api/ai_order.hpp
View File

@@ -118,6 +118,14 @@ public:
ORDER_INVALID = -1, //!< An invalid order.
};
/** Where to stop trains in a station that's longer then the train */
enum StopLocation {
STOPLOCATION_NEAR, //!< Stop the train as soon as it's completely in the station
STOPLOCATION_MIDDLE, //!< Stop the train in the middle of the station
STOPLOCATION_FAR, //!< Stop the train at the far end of the station
STOPLOCATION_INVALID = -1, //!< An invalid stop location
};
/**
* Checks whether the given order id is valid for the given vehicle.
* @param vehicle_id The vehicle to check the order index for.
@@ -281,6 +289,17 @@ public:
*/
static int32 GetOrderCompareValue(VehicleID vehicle_id, OrderPosition order_position);
/**
* Gets the stoplocation of the given order for the given train.
* @param vehicle_id The vehicle to get the value for.
* @param order_position The order to get the value for.
* @pre IsValidVehicleOrder(vehicle_id, order_position).
* @pre AIVehicle::GetVehicleType(vehicle_id) == AIVehicle::VT_RAIL.
* @pre IsGotoStationOrder(vehicle_id, order_position).
* @return The relative position where the train will stop inside a station.
*/
static StopLocation GetStopLocation(VehicleID vehicle_id, OrderPosition order_position);
/**
* Sets the OrderPosition to jump to if the check succeeds of the given order for the given vehicle.
* @param vehicle_id The vehicle to set the OrderPosition for.
@@ -329,6 +348,17 @@ public:
*/
static bool SetOrderCompareValue(VehicleID vehicle_id, OrderPosition order_position, int32 value);
/**
* Sets the stoplocation of the given order for the given train.
* @param vehicle_id The vehicle to get the value for.
* @param order_position The order to get the value for.
* @pre IsValidVehicleOrder(vehicle_id, order_position).
* @pre AIVehicle::GetVehicleType(vehicle_id) == AIVehicle::VT_RAIL.
* @pre IsGotoStationOrder(vehicle_id, order_position).
* @return Whether the order has been/can be changed.
*/
static bool SetStopLocation(VehicleID vehicle_id, OrderPosition order_position, StopLocation stop_location);
/**
* Appends an order to the end of the vehicle's order list.
* @param vehicle_id The vehicle to append the order to.