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

(svn r20389) [NoAI] -Add: AIOrder::IsVoidOrder to find void "(Invalid Order)" orders.

Browse Source 
[NoAI] -Change: AIOrder::GetOrderFlags returns AIOrder::AIOF_INVALID for void orders.
This commit is contained in:
rubidium
2010-08-06 19:04:21 +00:00
parent d54f2ba21f
commit 90a35d2e5b
4 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -172,6 +172,18 @@ public:
*/
static bool IsConditionalOrder(VehicleID vehicle_id, OrderPosition order_position);
/**
* Checks whether the given order is a void order.
* A void order is an order that used to be a goto station, depot or waypoint order but
* its destination got removed. In OpenTTD these orders as shown as "(Invalid Order)"
* in the order list of a vehicle.
* @param vehicle_id The vehicle to check.
* @param order_position The order index to check.
* @pre order_position != ORDER_CURRENT && IsValidVehicleOrder(vehicle_id, order_position).
* @return True if and only if the order is a void order.
*/
static bool IsVoidOrder(VehicleID vehicle_id, OrderPosition order_position);
/**
* Checks whether the current order is part of the orderlist.
* @param vehicle_id The vehicle to check.
@@ -240,7 +252,7 @@ public:
* @param vehicle_id The vehicle to get the destination for.
* @param order_position The order to get the destination for.
* @pre IsValidVehicleOrder(vehicle_id, order_position).
* @pre order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position).
* @pre order_position == ORDER_CURRENT || (!IsConditionalOrder(vehicle_id, order_position) && !IsVoidOrder(vehicle_id, order_position)).
* @note Giving ORDER_CURRENT as order_position will give the order that is
* currently being executed by the vehicle. This is not necessarily the
* current order as given by ResolveOrderPosition (the current index in the