1

/* $Id$ */

     2

     3

/** @file order_type.h Types related to orders. */

     4

     5

#ifndef ORDER_TYPE_H

     6

#define ORDER_TYPE_H

     7

     8

#include "core/enum_type.hpp"

     9

    10

typedef byte VehicleOrderID;  ///< The index of an order within its current vehicle (not pool related)

    11

typedef uint16 OrderID;

    12

typedef uint16 DestinationID;

    13

    14

enum {

    15

	INVALID_VEH_ORDER_ID = 0xFF,

    16

};

    17

    18

static const OrderID INVALID_ORDER = 0xFFFF;

    19

    20

/* Order types */

    21

enum OrderType {

    22

	OT_BEGIN         = 0,

    23

	OT_NOTHING       = 0,

    24

	OT_GOTO_STATION  = 1,

    25

	OT_GOTO_DEPOT    = 2,

    26

	OT_LOADING       = 3,

    27

	OT_LEAVESTATION  = 4,

    28

	OT_DUMMY         = 5,

    29

	OT_GOTO_WAYPOINT = 6,

    30

	OT_END

    31

};

    32

    33

/* It needs to be 8bits, because we save and load it as such */

    34

/** Define basic enum properties */

    35

template <> struct EnumPropsT<OrderType> : MakeEnumPropsT<OrderType, byte, OT_BEGIN, OT_END, OT_END> {};

    36

typedef TinyEnumT<OrderType> OrderTypeByte;

    37

    38

    39

/* Order flags -- please use OF instead OF and use HASBIT/SETBIT/CLEARBIT */

    40

    41

/** Order flag masks - these are for direct bit operations */

    42

enum OrderFlagMasks {

    43

	//Flags for stations:

    44

	/** vehicle will transfer cargo (i. e. not deliver to nearby industry/town even if accepted there) */

    45

	OFB_TRANSFER           = 0x1,

    46

	/** If OFB_TRANSFER is not set, drop any cargo loaded. If accepted, deliver, otherwise cargo remains at the station.

    47

      * No new cargo is loaded onto the vehicle whatsoever */

    48

	OFB_UNLOAD             = 0x2,

    49

	/** Wait for full load of all vehicles, or of at least one cargo type, depending on patch setting

    50

	  * @todo make this two different flags */

    51

	OFB_FULL_LOAD          = 0x4,

    52

    53

	//Flags for depots:

    54

	/** The current depot-order was initiated because it was in the vehicle's order list */

    55

	OFB_MANUAL_ORDER       = 0x0,

    56

	OFB_PART_OF_ORDERS     = 0x2,

    57

	/** if OFB_PART_OF_ORDERS is not set, this will cause the vehicle to be stopped in the depot */

    58

 	OFB_NORMAL_ACTION      = 0x0,

    59

	OFB_HALT_IN_DEPOT      = 0x4,

    60

	/** if OFB_PART_OF_ORDERS is set, this will cause the order only be come active if the vehicle needs servicing */

    61

	OFB_SERVICE_IF_NEEDED  = 0x4, //used when OFB_PART_OF_ORDERS is set.

    62

};

    63

    64

/**

    65

 * Non-stop order flags.

    66

 */

    67

enum OrderNonStopFlags {

    68

	ONSF_STOP_EVERYWHERE                  = 0,

    69

	ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS = 1,

    70

	ONSF_NO_STOP_AT_DESTINATION_STATION   = 2,

    71

	ONSF_NO_STOP_AT_ANY_STATION           = 3

    72

};

    73

    74

/** Order flags bits - these are for the *BIT macros

    75

 * for descrption of flags, see OrderFlagMasks

    76

 * @see OrderFlagMasks

    77

 */

    78

enum {

    79

	OF_TRANSFER          = 0,

    80

	OF_UNLOAD            = 1,

    81

	OF_FULL_LOAD         = 2,

    82

	OF_PART_OF_ORDERS    = 1,

    83

	OF_HALT_IN_DEPOT     = 2,

    84

	OF_SERVICE_IF_NEEDED = 2,

    85

	OF_NON_STOP          = 3

    86

};

    87

    88

    89

/* Possible clone options */

    90

enum {

    91

	CO_SHARE   = 0,

    92

	CO_COPY    = 1,

    93

	CO_UNSHARE = 2

    94

};

    95

    96

struct Order;

    97

    98

#endif /* ORDER_TYPE_H */