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

/**

    40

 * Flags related to the unloading order.

    41

 */

    42

enum OrderUnloadFlags {

    43

	OUF_UNLOAD_IF_POSSIBLE = 0,      ///< Unload all cargo that the station accepts.

    44

	OUFB_UNLOAD            = 1 << 0, ///< Force unloading all cargo onto the platform, possibly not getting paid.

    45

	OUFB_TRANSFER          = 1 << 1, ///< Transfer all cargo onto the platform.

    46

	OUFB_NO_UNLOAD         = 1 << 2, ///< Totally no unloading will be done.

    47

};

    48

    49

/**

    50

 * Flags related to the loading order.

    51

 */

    52

enum OrderLoadFlags {

    53

	OLF_LOAD_IF_POSSIBLE = 0,      ///< Load as long as there is cargo that fits in the train.

    54

	OLFB_FULL_LOAD       = 1 << 1, ///< Full load the complete the consist.

    55

	OLF_FULL_LOAD_ANY    = 3,      ///< Full load the a single cargo of the consist.

    56

	OLFB_NO_LOAD         = 4,      ///< Do not load anything.

    57

};

    58

    59

/**

    60

 * Non-stop order flags.

    61

 */

    62

enum OrderNonStopFlags {

    63

	ONSF_STOP_EVERYWHERE                  = 0, ///< The vehicle will stop at any station it passes and the destination.

    64

	ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS = 1, ///< The vehicle will not stop at any stations it passes except the destination.

    65

	ONSF_NO_STOP_AT_DESTINATION_STATION   = 2, ///< The vehicle will stop at any station it passes except the destination.

    66

	ONSF_NO_STOP_AT_ANY_STATION           = 3, ///< The vehicle will not stop at any stations it passes including the destination.

    67

	ONSF_END

    68

};

    69

    70

/**

    71

 * Reasons that could cause us to go to the depot.

    72

 */

    73

enum OrderDepotTypeFlags {

    74

	ODTF_MANUAL          = 0,      ///< The player initiated this order manually.

    75

	ODTFB_SERVICE        = 1 << 0, ///< This depot order is because of the servicing limit.

    76

	ODTFB_PART_OF_ORDERS = 1 << 1, ///< This depot order is because of a regular order.

    77

};

    78

    79

/**

    80

 * Actions that can be performed when the vehicle enters the depot.

    81

 */

    82

enum OrderDepotActionFlags {

    83

	ODATF_SERVICE_ONLY   = 0,      ///< Only service the vehicle.

    84

	ODATFB_HALT          = 1 << 0, ///< Service the vehicle and then halt it.

    85

};

    86

    87

/**

    88

 * Enumeration for the data to set in CmdModifyOrder.

    89

 */

    90

enum ModifyOrderFlags {

    91

	MOF_NON_STOP,      ///< Passes a OrderNonStopFlags.

    92

	MOF_UNLOAD,        ///< Passes an OrderUnloadType.

    93

	MOF_LOAD,          ///< Passes an OrderLoadType

    94

	MOF_DEPOT_ACTION,  ///< Toggle the 'service' if needed flag.

    95

};

    96

    97

    98

/* Possible clone options */

    99

enum {

   100

	CO_SHARE   = 0,

   101

	CO_COPY    = 1,

   102

	CO_UNSHARE = 2

   103

};

   104

   105

struct Order;

   106

   107

#endif /* ORDER_TYPE_H */