1

/* $Id$ */

     2

     3

#ifndef NEWGRF_CALLBACKS_H

     4

#define NEWGRF_CALLBACKS_H

     5

     6

/** @file newgrf_callbacks.h

     7

 */

     8

     9

/**

    10

 * List of implemented NewGRF callbacks.

    11

 * Names are formatted as CBID_<CLASS>_<CALLBACK>

    12

 */

    13

enum CallbackID {

    14

	// Powered wagons, if the result is lower as 0x40 then the wagon is powered

    15

	// TODO: interpret the rest of the result, aka "visual effects"

    16

	CBID_TRAIN_WAGON_POWER          = 0x10,

    17

    18

	// Vehicle length, returns the amount of 1/8's the vehicle is shorter

    19

	// only for train vehicles

    20

	CBID_TRAIN_VEHICLE_LENGTH       = 0x11,

    21

    22

	// Refit capacity, the passed vehicle needs to have its ->cargo_type set to

    23

	// the cargo we are refitting to, returns the new cargo capacity

    24

	CBID_VEHICLE_REFIT_CAPACITY     = 0x15,

    25

    26

	CBID_TRAIN_ARTIC_ENGINE         = 0x16,

    27

};

    28

    29

/**

    30

 * Callback masks for vehicles, indicates which callbacks are used by a vehicle.

    31

 * Some callbacks are always used and don't have a mask.

    32

 */

    33

enum VehicleCallbackMask {

    34

	CBM_WAGON_POWER    = 0, ///< Powered wagons (trains only)

    35

	CBM_VEHICLE_LENGTH = 1, ///< Vehicle length (trains only)

    36

	CBM_LOAD_AMOUNT    = 2, ///< Load amount

    37

	CBM_REFIT_CAPACITY = 3, ///< Cargo capacity after refit

    38

	CBM_ARTIC_ENGINE   = 4, ///< Add articulated engines (trains only)

    39

	CBM_CARGO_SUFFIX   = 5, ///< Show suffix after cargo name

    40

	CBM_COLOUR_REMAP   = 6, ///< Change colour mapping of vehicle

    41

	CBM_SOUND_EFFECT   = 7, ///< Vehicle uses custom sound effects

    42

};

    43

    44

/**

    45

 * Result of a failed callback.

    46

 */

    47

enum {

    48

	CALLBACK_FAILED = 0xFFFF

    49

};

    50

    51

#endif /* NEWGRF_CALLBACKS_H */