1

/* $Id$ */

     2

     6

#ifndef NEWGRF_CALLBACKS_H

     7

#define NEWGRF_CALLBACKS_H

     8

     9

    10

/**

    11

 * List of implemented NewGRF callbacks.

    12

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

    13

 */

    14

enum CallbackID {

    15

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

    16

	 * @todo : interpret the rest of the result, aka "visual effects" */

    17

	CBID_TRAIN_WAGON_POWER          = 0x10,

    18

    19

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

    20

	 * only for train vehicles */

    21

	CBID_TRAIN_VEHICLE_LENGTH       = 0x11,

    22

    23

	/* Called (if appropriate bit in callback mask is set) to determine the

    24

	 * amount of cargo to load per unit of time when using gradual loading. */

    25

	CBID_VEHICLE_LOAD_AMOUNT        = 0x12,

    26

    27

	/* Called (if appropriate bit in callback mask is set) to determine if a

    28

	 * newstation should be made available to build */

    29

	CBID_STATION_AVAILABILITY       = 0x13,

    30

    31

	/* Called (if appropriate bit in callback mask is set) when drawing a tile

    32

	 * to choose a sprite layout to draw, instead of the standard 0-7 range */

    33

	CBID_STATION_SPRITE_LAYOUT      = 0x14,

    34

    35

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

    36

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

    37

	CBID_VEHICLE_REFIT_CAPACITY     = 0x15,

    38

    39

	CBID_TRAIN_ARTIC_ENGINE         = 0x16,

    40

    41

	/* Called (if appropriate bit in callback mask is set) to determine whether

    42

	 * the house can be built on the specified tile. */

    43

	CBID_HOUSE_ALLOW_CONSTRUCTION   = 0x17,

    44

    45

	CBID_VEHICLE_CARGO_SUFFIX       = 0x19,

    46

    47

	/* Called (if appropriate bit in callback mask is set) to determine

    48

	 * the next animation frame. */

    49

	CBID_HOUSE_ANIMATION_NEXT_FRAME = 0x1A,

    50

    51

	/* Called (if appropriate bit in callback mask is set) for periodically

    52

	 * starting or stopping the animation. */

    53

	CBID_HOUSE_ANIMATION_START_STOP = 0x1B,

    54

    55

	/* Called (if appropriate bit in callback mask is set) whenever the

    56

	 * construction state of a house changes. */

    57

	CBID_CONSTRUCTION_STATE_CHANGE  = 0x1C,

    58

    59

	CBID_TRAIN_ALLOW_WAGON_ATTACH   = 0x1D,

    60

    61

	/* Called (if appropriate bit in callback mask is set) to determine the

    62

	 * colour of a town building. */

    63

	CBID_BUILDING_COLOUR            = 0x1E,

    64

    65

	/* Called (if appropriate bit in callback mask is set) to decide how much

    66

	 * cargo a town building can accept. */

    67

	CBID_HOUSE_CARGO_ACCEPTANCE     = 0x1F, // not yet implemented

    68

    69

	/* Called (if appropriate bit in callback mask is set) to indicate

    70

	 * how long the current animation frame should last. */

    71

	CBID_HOUSE_ANIMATION_SPEED      = 0x20,

    72

    73

	/* Called (if appropriate bit in callback mask is set) periodically to

    74

	 * determine if a house should be destroyed. */

    75

	CBID_HOUSE_DESTRUCTION          = 0x21,

    76

    80

	/* This callback is called from vehicle purchase lists. It returns a value to be

    81

	 * used as a custom string ID in the 0xD000 range. */

    82

	CBID_VEHICLE_ADDITIONAL_TEXT    = 0x23,

    83

    84

	/* Called when building a station to customize the tile layout */

    85

	CBID_STATION_TILE_LAYOUT        = 0x24,

    86

   102

	/* Called (if appropriate bit in callback mask is set) to determine which

   103

	 * cargoes a town building should accept. */

   104

	CBID_HOUSE_ACCEPT_CARGO         = 0x2A, // not yet implemented

   105

   112

	/* Called to determine if a specific colour map should be used for a vehicle

   113

	 * instead of the default livery */

   114

	CBID_VEHICLE_COLOUR_MAPPING     = 0x2D,

   115

   116

	/* Called (if appropriate bit in callback mask is set) to determine how much

   117

	 * cargo a town building produces. */

   118

	CBID_HOUSE_PRODUCE_CARGO        = 0x2E, // not yet implemented

   119

   126

	/* Called when the player (or AI) tries to start or stop a vehicle. Mainly

   127

	 * used for preventing a vehicle from leaving the depot. */

   128

	CBID_VEHICLE_START_STOP_CHECK   = 0x31,

   129

   130

	/* Called to play a special sound effect */

   131

	CBID_VEHICLE_SOUND_EFFECT       = 0x33,

   132

   142

	/* Called to calculate the income of delivered cargo */

   143

	CBID_CARGO_PROFIT_CALC          = 0x39,

   144

   157

	/* Called (if appropriate bit in callback mask set) to determine whether a

   158

	 * town building can be destroyed. */

   159

	CBID_HOUSE_DENY_DESTRUCTION     = 0x143,

   160

   161

	/* Called to calculate part of a station rating */

   162

	CBID_CARGO_STATION_RATING_CALC  = 0x145,

   163

};

   164

   165

/**

   166

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

   167

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

   168

 */

   169

enum VehicleCallbackMask {

   170

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

   171

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

   172

	CBM_LOAD_AMOUNT    = 2, ///< Load amount

   173

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

   174

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

   175

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

   176

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

   177

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

   178

};

   179

   180

/**

   181

 * Callback masks for stations.

   182

 */

   183

enum StationCallbackMask {

   184

	CBM_STATION_AVAIL = 0, ///< Availability of station in construction window

   185

	CBM_CUSTOM_LAYOUT = 1, ///< Use callback to select a tile layout to use

   186

};

   187

   188

/**

   189

 * Callback masks for houses.

   190

 */

   191

enum HouseCallbackMask {

   192

	CBM_HOUSE_ALLOW_CONSTRUCTION  = 0,

   193

	CBM_ANIMATION_NEXT_FRAME      = 1,

   194

	CBM_ANIMATION_START_STOP      = 2,

   195

	CBM_CONSTRUCTION_STATE_CHANGE = 3,

   196

	CBM_BUILDING_COLOUR           = 4,

   197

	CBM_CARGO_ACCEPTANCE          = 5,

   198

	CBM_ANIMATION_SPEED           = 6,

   199

	CBM_HOUSE_DESTRUCTION         = 7,

   200

	CBM_HOUSE_ACCEPT_CARGO        = 8,

   201

	CBM_HOUSE_PRODUCE_CARGO       = 9,

   202

	CBM_HOUSE_DENY_DESTRUCTION    = 10,

   203

};

   204

   205

/**

   206

 * Callback masks for cargos.

   207

 */

   208

enum CargoCallbackMask {

   209

	CBM_CARGO_PROFIT_CALC         = 0,

   210

	CBM_CARGO_STATION_RATING_CALC = 1,

   211

};

   212

   213

/**

   244

 * Result of a failed callback.

   245

 */

   246

enum {

   247

	CALLBACK_FAILED = 0xFFFF

   248

};

   249

   250

#endif /* NEWGRF_CALLBACKS_H */