(svn r12470) -Codechange: split order related types from order.h (and openttd.h) to order_type.h.
parent
bf54e0ba1c
commit
492d132831
@ -0,0 +1,90 @@
|
||||
/* $Id$ */
|
||||
|
||||
/** @file order_type.h Types related to orders. */
|
||||
|
||||
#ifndef ORDER_TYPE_H
|
||||
#define ORDER_TYPE_H
|
||||
|
||||
#include "core/enum_type.hpp"
|
||||
|
||||
typedef byte VehicleOrderID; ///< The index of an order within its current vehicle (not pool related)
|
||||
typedef uint16 OrderID;
|
||||
|
||||
enum {
|
||||
INVALID_VEH_ORDER_ID = 0xFF,
|
||||
};
|
||||
|
||||
static const OrderID INVALID_ORDER = 0xFFFF;
|
||||
|
||||
/* Order types */
|
||||
enum OrderType {
|
||||
OT_BEGIN = 0,
|
||||
OT_NOTHING = 0,
|
||||
OT_GOTO_STATION = 1,
|
||||
OT_GOTO_DEPOT = 2,
|
||||
OT_LOADING = 3,
|
||||
OT_LEAVESTATION = 4,
|
||||
OT_DUMMY = 5,
|
||||
OT_GOTO_WAYPOINT = 6,
|
||||
OT_END
|
||||
};
|
||||
|
||||
/* It needs to be 8bits, because we save and load it as such */
|
||||
/** Define basic enum properties */
|
||||
template <> struct EnumPropsT<OrderType> : MakeEnumPropsT<OrderType, byte, OT_BEGIN, OT_END, OT_END> {};
|
||||
typedef TinyEnumT<OrderType> OrderTypeByte;
|
||||
|
||||
|
||||
/* Order flags -- please use OF instead OF and use HASBIT/SETBIT/CLEARBIT */
|
||||
|
||||
/** Order flag masks - these are for direct bit operations */
|
||||
enum OrderFlagMasks {
|
||||
//Flags for stations:
|
||||
/** vehicle will transfer cargo (i. e. not deliver to nearby industry/town even if accepted there) */
|
||||
OFB_TRANSFER = 0x1,
|
||||
/** If OFB_TRANSFER is not set, drop any cargo loaded. If accepted, deliver, otherwise cargo remains at the station.
|
||||
* No new cargo is loaded onto the vehicle whatsoever */
|
||||
OFB_UNLOAD = 0x2,
|
||||
/** Wait for full load of all vehicles, or of at least one cargo type, depending on patch setting
|
||||
* @todo make this two different flags */
|
||||
OFB_FULL_LOAD = 0x4,
|
||||
|
||||
//Flags for depots:
|
||||
/** The current depot-order was initiated because it was in the vehicle's order list */
|
||||
OFB_PART_OF_ORDERS = 0x2,
|
||||
/** if OFB_PART_OF_ORDERS is not set, this will cause the vehicle to be stopped in the depot */
|
||||
OFB_HALT_IN_DEPOT = 0x4,
|
||||
/** if OFB_PART_OF_ORDERS is set, this will cause the order only be come active if the vehicle needs servicing */
|
||||
OFB_SERVICE_IF_NEEDED = 0x4, //used when OFB_PART_OF_ORDERS is set.
|
||||
|
||||
//Common flags
|
||||
/** This causes the vehicle not to stop at intermediate OR the destination station (depending on patch settings)
|
||||
* @todo make this two different flags */
|
||||
OFB_NON_STOP = 0x8
|
||||
};
|
||||
|
||||
/** Order flags bits - these are for the *BIT macros
|
||||
* for descrption of flags, see OrderFlagMasks
|
||||
* @see OrderFlagMasks
|
||||
*/
|
||||
enum {
|
||||
OF_TRANSFER = 0,
|
||||
OF_UNLOAD = 1,
|
||||
OF_FULL_LOAD = 2,
|
||||
OF_PART_OF_ORDERS = 1,
|
||||
OF_HALT_IN_DEPOT = 2,
|
||||
OF_SERVICE_IF_NEEDED = 2,
|
||||
OF_NON_STOP = 3
|
||||
};
|
||||
|
||||
|
||||
/* Possible clone options */
|
||||
enum {
|
||||
CO_SHARE = 0,
|
||||
CO_COPY = 1,
|
||||
CO_UNSHARE = 2
|
||||
};
|
||||
|
||||
struct Order;
|
||||
|
||||
#endif /* ORDER_TYPE_H */
|
Loading…
Reference in New Issue