1

/* $Id$ */

     2

     3

/** @file newgrf_callbacks.h

     4

 */

     5

     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

	/* Set when calling a randomizing trigger (almost undocumented) */

    16

	CBID_RANDOM_TRIGGER             = 0x01,

    17

    18

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

    19

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

    20

	CBID_TRAIN_WAGON_POWER          = 0x10,

    21

    22

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

    23

	 * only for train vehicles */

    24

	CBID_TRAIN_VEHICLE_LENGTH       = 0x11,

    25

    26

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

    27

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

    28

	CBID_VEHICLE_LOAD_AMOUNT        = 0x12,

    29

    30

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

    31

	 * newstation should be made available to build */

    32

	CBID_STATION_AVAILABILITY       = 0x13,

    33

    34

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

    35

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

    36

	CBID_STATION_SPRITE_LAYOUT      = 0x14,

    37

    38

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

    39

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

    40

	CBID_VEHICLE_REFIT_CAPACITY     = 0x15,

    41

    42

	CBID_TRAIN_ARTIC_ENGINE         = 0x16,

    43

    44

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

    45

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

    46

	CBID_HOUSE_ALLOW_CONSTRUCTION   = 0x17,

    47

    48

	CBID_VEHICLE_CARGO_SUFFIX       = 0x19,

    49

    50

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

    51

	 * the next animation frame. */

    52

	CBID_HOUSE_ANIMATION_NEXT_FRAME = 0x1A,

    53

    54

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

    55

	 * starting or stopping the animation. */

    56

	CBID_HOUSE_ANIMATION_START_STOP = 0x1B,

    57

    58

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

    59

	 * construction state of a house changes. */

    60

	CBID_CONSTRUCTION_STATE_CHANGE  = 0x1C,

    61

    62

	CBID_TRAIN_ALLOW_WAGON_ATTACH   = 0x1D,

    63

    64

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

    65

	 * colour of a town building. */

    66

	CBID_BUILDING_COLOUR            = 0x1E,

    67

    68

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

    69

	 * cargo a town building can accept. */

    70

	CBID_HOUSE_CARGO_ACCEPTANCE     = 0x1F,

    71

    72

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

    73

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

    74

	CBID_HOUSE_ANIMATION_SPEED      = 0x20,

    75

    76

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

    77

	 * determine if a house should be destroyed. */

    78

	CBID_HOUSE_DESTRUCTION          = 0x21,

    79

    80

	/* Called to determine if the given industry type is available */

    81

	CBID_INDUSTRY_AVAILABLE         = 0x22, // not yet implemented

    82

    83

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

    84

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

    85

	CBID_VEHICLE_ADDITIONAL_TEXT    = 0x23,

    86

    87

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

    88

	CBID_STATION_TILE_LAYOUT        = 0x24,

    89

    90

	/* Called for periodically starting or stopping the animation. */

    91

	CBID_INDTILE_ANIM_START_STOP    = 0x25, // not yet implemented

    92

    93

	/* Called to determine industry tile next animation frame. */

    94

	CBID_INDTILE_ANIM_NEXT_FRAME    = 0x26, // not yet implemented

    95

    96

	/* Called to indicate how long the current animation frame should last. */

    97

	CBID_INDTILE_ANIMATION_SPEED    = 0x27, // not yet implemented

    98

    99

	/* Called to determine if the given industry can be built on specific area */

   101

   102

	/* Called on production changes, so it can be adjusted */

   103

	CBID_INDUSTRY_PRODUCTION_CHANGE = 0x29, // not yet implemented

   104

   105

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

   106

	 * cargoes a town building should accept. */

   107

	CBID_HOUSE_ACCEPT_CARGO         = 0x2A,

   108

   109

	/* Called to query the cargo acceptance of the industry tile */

   110

	CBID_INDTILE_CARGO_ACCEPTANCE   = 0x2B,

   111

   112

	/* Called to determine which cargoes an industry should accept. */

   113

	CBID_INDTILE_ACCEPT_CARGO       = 0x2C,

   114

   115

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

   116

	 * instead of the default livery */

   117

	CBID_VEHICLE_COLOUR_MAPPING     = 0x2D,

   118

   119

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

   120

	 * cargo a town building produces. */

   121

	CBID_HOUSE_PRODUCE_CARGO        = 0x2E, // not yet implemented

   122

   123

	/* Called to determine if the given industry tile can be built on specific tile */

   124

	CBID_INDTILE_SHAPE_CHECK        = 0x2F, // not yet implemented

   125

   126

	/* Called to determine the type (if any) of foundation to draw for industry tile */

   127

	CBID_INDUSTRY_DRAW_FOUNDATIONS  = 0x30, // not yet implemented

   128

   129

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

   130

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

   131

	CBID_VEHICLE_START_STOP_CHECK   = 0x31,

   132

   133

	/* Called to play a special sound effect */

   134

	CBID_VEHICLE_SOUND_EFFECT       = 0x33,

   135

   136

	/* Called monthly on production changes, so it can be adjusted more frequently */

   137

	CBID_INDUSTRY_MONTHLYPROD_CHANGE= 0x35, // not yet implemented

   138

   139

	/* Called to modify various vehicle properties. Callback parameter 1

   140

	 * specifies the property index, as used in Action 0, to change. */

   141

	CBID_VEHICLE_MODIFY_PROPERTY    = 0x36,

   142

   143

	/* Called to determine text to display after cargo name */

   144

	CBID_INDUSTRY_CARGO_SUFFIX      = 0x37, // not yet implemented

   145

   146

	/* Called to determine more text in the fund industry window */

   147

	CBID_INDUSTRY_FUND_MORE_TEXT    = 0x38, // not yet implemented

   148

   149

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

   150

	CBID_CARGO_PROFIT_CALC          = 0x39,

   151

   152

	/* Called to determine more text in the industry window */

   153

	CBID_INDUSTRY_WINDOW_MORE_TEXT  = 0x3A,

   154

   155

	/* Called to determine industry special effects */

   156

	CBID_INDUSTRY_SPECIAL_EFFECT    = 0x3B,

   157

   158

	/* Called to determine if industry can alter the ground below industry tile */

   159

	CBID_INDUSTRY_AUTOSLOPE         = 0x3C, // not yet implemented

   160

   161

	/* Called to determine if the industry can still accept or refuse more cargo arrival */

   162

	CBID_INDUSTRY_REFUSE_CARGO      = 0x3D,

   163

   164

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

   165

	 * town building can be destroyed. */

   166

	CBID_HOUSE_DENY_DESTRUCTION     = 0x143,

   167

   168

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

   169

	CBID_CARGO_STATION_RATING_CALC  = 0x145,

   170

};

   171

   172

/**

   173

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

   174

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

   175

 */

   176

enum VehicleCallbackMask {

   177

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

   178

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

   179

	CBM_LOAD_AMOUNT    = 2, ///< Load amount

   180

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

   181

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

   182

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

   183

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

   184

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

   185

};

   186

   187

/**

   188

 * Callback masks for stations.

   189

 */

   190

enum StationCallbackMask {

   191

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

   192

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

   193

};

   194

   195

/**

   196

 * Callback masks for houses.

   197

 */

   198

enum HouseCallbackMask {

   199

	CBM_HOUSE_ALLOW_CONSTRUCTION  = 0,

   200

	CBM_ANIMATION_NEXT_FRAME      = 1,

   201

	CBM_ANIMATION_START_STOP      = 2,

   202

	CBM_CONSTRUCTION_STATE_CHANGE = 3,

   203

	CBM_BUILDING_COLOUR           = 4,

   204

	CBM_CARGO_ACCEPTANCE          = 5,

   205

	CBM_ANIMATION_SPEED           = 6,

   206

	CBM_HOUSE_DESTRUCTION         = 7,

   207

	CBM_HOUSE_ACCEPT_CARGO        = 8,

   208

	CBM_HOUSE_PRODUCE_CARGO       = 9,

   209

	CBM_HOUSE_DENY_DESTRUCTION    = 10,

   210

};

   211

   212

/**

   213

 * Callback masks for cargos.

   214

 */

   215

enum CargoCallbackMask {

   216

	CBM_CARGO_PROFIT_CALC         = 0,

   217

	CBM_CARGO_STATION_RATING_CALC = 1,

   218

};

   219

   220

/**

   221

 * Callback masks for Industries

   222

 */

   223

enum IndustryCallbackMask {

   224

	CBM_IND_AVAILABLE                 = 0,  ///< industry availability callback

   225

	CBM_IND_PRODUCTION_CARGO_ARRIVAL  = 1,  ///< call production callback when cargo arrives at the industry

   226

	CBM_IND_PRODUCTION_256_TICKS      = 2,  ///< call production callback every 256 ticks

   227

	CBM_IND_LOCATION                  = 3,  ///< check industry construction on given area

   228

	CBM_IND_PRODUCTION_CHANGE         = 4,  ///< controls random production change

   229

	CBM_IND_MONTHLYPROD_CHANGE        = 5,  ///< controls monthly random production change

   230

	CBM_IND_CARGO_SUFFIX              = 6,  ///< cargo sub-type display

   231

	CBM_IND_FUND_MORE_TEXT            = 7,  ///< additional text in fund window

   232

	CBM_IND_WINDOW_MORE_TEXT          = 8,  ///< additional text in industry window

   233

	CBM_IND_SPECIAL_EFFECT            = 9,  ///< control special effects

   234

	CBM_IND_REFUSE_CARGO              = 10, ///< option out of accepting cargo

   235

};

   236

   237

/**

   238

 * Callback masks for industry tiles

   239

 */

   240

enum IndustryTileCallbackMask {

   241

	CBM_INDT_ANIM_NEXT_FRAME          = 0,  ///< decides next animation frame

   242

	CBM_INDT_ANIM_SPEED               = 1,  ///< decides animation speed

   243

	CBM_INDT_CARGO_ACCEPTANCE         = 2,  ///< decides amount of cargo acceptance

   244

	CBM_INDT_ACCEPT_CARGO             = 3,  ///< decides accepted types

   245

	CBM_INDT_SHAPE_CHECK              = 4,  ///< decides slope suitability

   246

	CBM_INDT_DRAW_FOUNDATIONS         = 5,  ///< decides if default foundations need to be drawn

   247

	CBM_INDT_AUTOSLOPE                = 6,  ///< decides allowance of autosloping

   248

};

   249

   250

/**

   251

 * Result of a failed callback.

   252

 */

   253

enum {

   254

	CALLBACK_FAILED = 0xFFFF

   255

};

   256

   257

#endif /* NEWGRF_CALLBACKS_H */