1

/* $Id$ */

     2

     3

/** @file newgrf_callbacks.h Callbacks that NewGRFs could implement. */

     4

     5

#ifndef NEWGRF_CALLBACKS_H

     6

#define NEWGRF_CALLBACKS_H

     7

     8

/**

     9

 * List of implemented NewGRF callbacks.

    10

 * Most of these callbacks are only triggered when the corresponding

    11

 * bit is set in the callback flags/trigger for a vehicle, house,

    12

 * industry, etc.

    13

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

    14

 *

    15

 * @note Do not forget to add 15 bits callbacks to the switch in

    16

 *       newgrf_spritegroup.cpp (search for "15 bits callback").

    17

 */

    18

enum CallbackID {

    19

	/** Set when using the callback resolve system, but not to resolve a callback. */

    20

	CBID_NO_CALLBACK                     = 0x00,

    21

    22

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

    23

	CBID_RANDOM_TRIGGER                  = 0x01,

    24

    25

	/* There are no callbacks 0x02 - 0x0F. */

    26

    27

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

    28

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

    29

	CBID_TRAIN_WAGON_POWER               = 0x10, // 8 bit callback

    30

    31

	/** Vehicle length, returns the amount of 1/8's the vehicle is shorter for trains and RVs. */

    32

	CBID_VEHICLE_LENGTH                  = 0x11,

    33

    34

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

    35

	CBID_VEHICLE_LOAD_AMOUNT             = 0x12, // 8 bit callback

    36

    37

	/** Determine whether a newstation should be made available to build. */

    38

	CBID_STATION_AVAILABILITY            = 0x13, // 8 bit callback

    39

    40

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

    41

	CBID_STATION_SPRITE_LAYOUT           = 0x14,

    42

    43

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

    44

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

    45

	CBID_VEHICLE_REFIT_CAPACITY          = 0x15, // 15 bit callback

    46

    47

	/** Builds articulated engines for trains and RVs. */

    48

	CBID_VEHICLE_ARTIC_ENGINE            = 0x16, // 8 bit callback

    49

    50

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

    51

	CBID_HOUSE_ALLOW_CONSTRUCTION        = 0x17, // 8 bit callback

    52

    53

	/** AI construction/purchase selection */

    54

	CBID_GENERIC_AI_PURCHASE_SELECTION   = 0x18, // 8 bit callback, not implemented

    55

    56

	/** Determine the cargo "suffixes" for each refit possibility of a cargo. */

    57

	CBID_VEHICLE_CARGO_SUFFIX            = 0x19,

    58

    59

	/** Determine the next animation frame for a house. */

    60

	CBID_HOUSE_ANIMATION_NEXT_FRAME      = 0x1A, // 15 bit callback

    61

    62

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

    63

	CBID_HOUSE_ANIMATION_START_STOP      = 0x1B, // 15 bit callback

    64

    65

	/** Called whenever the construction state of a house changes. */

    66

	CBID_HOUSE_CONSTRUCTION_STATE_CHANGE = 0x1C, // 15 bit callback

    67

    68

	/** Determine whether a wagon can be attached to an already existing train. */

    69

	CBID_TRAIN_ALLOW_WAGON_ATTACH        = 0x1D,

    70

    71

	/** Called to determine the colour of a town building. */

    72

	CBID_HOUSE_COLOUR                    = 0x1E, // 15 bit callback

    73

    74

	/** Called to decide how much cargo a town building can accept. */

    75

	CBID_HOUSE_CARGO_ACCEPTANCE          = 0x1F, // 15 bit callback

    76

    77

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

    78

	CBID_HOUSE_ANIMATION_SPEED           = 0x20, // 8 bit callback

    79

    80

	/** Called periodically to determine if a house should be destroyed. */

    81

	CBID_HOUSE_DESTRUCTION               = 0x21, // 8 bit callback

    82

    83

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

    84

	CBID_INDUSTRY_AVAILABLE              = 0x22, // 15 bit callback

    85

    86

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

    87

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

    88

	CBID_VEHICLE_ADDITIONAL_TEXT         = 0x23,

    89

    90

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

    91

	CBID_STATION_TILE_LAYOUT             = 0x24, // 15 bit callback

    92

    93

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

    94

	CBID_INDTILE_ANIM_START_STOP         = 0x25, // 15 bit callback

    95

    96

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

    97

	CBID_INDTILE_ANIM_NEXT_FRAME         = 0x26, // 15 bit callback

    98

    99

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

   100

	CBID_INDTILE_ANIMATION_SPEED         = 0x27, // 8 bit callback

   101

   102

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

   103

	CBID_INDUSTRY_LOCATION               = 0x28, // 15 bit callback

   104

   105

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

   106

	CBID_INDUSTRY_PRODUCTION_CHANGE      = 0x29, // 15 bit callback

   107

   108

	/** Called to determine which cargoes a town building should accept. */

   109

	CBID_HOUSE_ACCEPT_CARGO              = 0x2A, // 15 bit callback

   110

   111

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

   112

	CBID_INDTILE_CARGO_ACCEPTANCE        = 0x2B, // 15 bit callback

   113

   114

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

   115

	CBID_INDTILE_ACCEPT_CARGO            = 0x2C, // 15 bit callback

   116

   117

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

   118

	 * instead of the default livery. */

   119

	CBID_VEHICLE_COLOUR_MAPPING          = 0x2D, // 15 bit callback

   120

   121

	/** Called to determine how much cargo a town building produces. */

   122

	CBID_HOUSE_PRODUCE_CARGO             = 0x2E, // 15 bit callback

   123

   124

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

   125

	CBID_INDTILE_SHAPE_CHECK             = 0x2F, // 15 bit callback

   126

   127

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

   128

	CBID_INDUSTRY_DRAW_FOUNDATIONS       = 0x30, // 15 bit callback

   129

   130

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

   131

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

   132

	CBID_VEHICLE_START_STOP_CHECK        = 0x31, // 15 bit callback, but 0xFF test is done with 8 bit

   133

   134

	/** Called for every vehicle every 32 days (not all on same date though). */

   135

	CBID_VEHICLE_32DAY_CALLBACK          = 0x32, // 2 bit callback

   136

   137

	/** Called to play a special sound effect */

   138

	CBID_VEHICLE_SOUND_EFFECT            = 0x33, // 15 bit callback

   139

   140

	/** Return the vehicles this given vehicle can be "upgraded" to. */

   141

	CBID_VEHICLE_AUTOREPLACE_SELECTION   = 0x34, // 15 bit callback

   142

   143

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

   144

	CBID_INDUSTRY_MONTHLYPROD_CHANGE     = 0x35, // 15 bit callback

   145

   146

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

   147

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

   148

	CBID_VEHICLE_MODIFY_PROPERTY         = 0x36, // 8/15 bit depends on queried property

   149

   150

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

   151

	CBID_INDUSTRY_CARGO_SUFFIX           = 0x37, // 15 bit callback, but 0xFF test is done with 8 bit

   152

   153

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

   154

	CBID_INDUSTRY_FUND_MORE_TEXT         = 0x38, // 15 bit callback

   155

   156

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

   157

	CBID_CARGO_PROFIT_CALC               = 0x39, // 15 bit callback

   158

   159

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

   160

	CBID_INDUSTRY_WINDOW_MORE_TEXT       = 0x3A, // 15 bit callback

   161

   162

	/** Called to determine industry special effects */

   163

	CBID_INDUSTRY_SPECIAL_EFFECT         = 0x3B, // 15 bit callback

   164

   165

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

   166

	CBID_INDUSTRY_AUTOSLOPE              = 0x3C, // 15 bit callback

   167

   168

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

   169

	CBID_INDUSTRY_REFUSE_CARGO           = 0x3D, // 15 bit callback

   170

   171

	/* There are no callbacks 0x3E - 0x13F */

   172

   173

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

   174

	CBID_STATION_ANIM_START_STOP         = 0x140, // 15 bit callback

   175

   176

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

   177

	CBID_STATION_ANIM_NEXT_FRAME         = 0x141, // 15 bit callback

   178

   179

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

   180

	CBID_STATION_ANIMATION_SPEED         = 0x142, // 8 bit callback

   181

   182

	/** Called to determine whether a town building can be destroyed. */

   183

	CBID_HOUSE_DENY_DESTRUCTION          = 0x143, // 15 bit callback

   184

   185

	/** Select an ambient sound to play for a given type of tile. */

   186

	CBID_SOUNDS_AMBIENT_EFFECT           = 0x144, // 15 bit callback, not implemented

   187

   188

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

   189

	CBID_CARGO_STATION_RATING_CALC       = 0x145, // 15 bit callback, not implemented

   190

   191

	/** Allow signal sprites to be replaced dynamically. */

   192

	CBID_NEW_SIGNALS_SPRITE_DRAW         = 0x146, // 15 bit callback, not implemented

   193

   194

	/** Add an offset to the default sprite numbers to show another sprite. */

   195

	CBID_CANALS_SPRITE_OFFSET            = 0x147, // 15 bit callback, not implemented

   196

   197

	/** Called when a cargo type specified in property 20 is accepted. */

   198

	CBID_HOUSE_WATCHED_CARGO_ACCEPTED    = 0x148, // 15 bit callback, not implemented

   199

   200

	/** Callback done for each tile of a station to check the slope. */

   201

	CBID_STATION_LAND_SLOPE_CHECK        = 0x149, // 15 bit callback, not implemented

   202

   203

	/** Called to determine the color of an industry. */

   204

	CBID_INDUSTRY_DECIDE_COLOUR          = 0x14A, // 4 bit callback

   205

   206

	/** Customize the input cargo types of a newly build industry. */

   207

	CBID_INDUSTRY_INPUT_CARGO_TYPES      = 0x14B, // 8 bit callback

   208

   209

	/** Customize the output cargo types of a newly build industry. */

   210

	CBID_INDUSTRY_OUTPUT_CARGO_TYPES     = 0x14C, // 8 bit callback

   211

};

   212

   213

/**

   214

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

   215

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

   216

 */

   217

enum VehicleCallbackMask {

   218

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

   219

	CBM_VEHICLE_LENGTH         = 1, ///< Vehicle length (trains and road vehicles)

   220

	CBM_VEHICLE_LOAD_AMOUNT    = 2, ///< Load amount

   221

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

   222

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

   223

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

   224

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

   225

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

   226

};

   227

   228

/**

   229

 * Callback masks for stations.

   230

 */

   231

enum StationCallbackMask {

   232

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

   233

	CBM_STATION_SPRITE_LAYOUT        = 1, ///< Use callback to select a sprite layout to use

   234

	CBM_STATION_ANIMATION_NEXT_FRAME = 2, ///< Use a custom next frame callback

   235

	CBM_STATION_ANIMATION_SPEED      = 3, ///< Customize the animation speed of the station

   236

	CBM_STATION_SLOPE_CHECK          = 4, ///< Check slope of new station tiles

   237

};

   238

   239

/**

   240

 * Callback masks for houses.

   241

 */

   242

enum HouseCallbackMask {

   243

	CBM_HOUSE_ALLOW_CONSTRUCTION        =  0,

   244

	CBM_HOUSE_ANIMATION_NEXT_FRAME      =  1,

   245

	CBM_HOUSE_ANIMATION_START_STOP      =  2,

   246

	CBM_HOUSE_CONSTRUCTION_STATE_CHANGE =  3,

   247

	CBM_HOUSE_COLOUR                    =  4,

   248

	CBM_HOUSE_CARGO_ACCEPTANCE          =  5,

   249

	CBM_HOUSE_ANIMATION_SPEED           =  6,

   250

	CBM_HOUSE_DESTRUCTION               =  7,

   251

	CBM_HOUSE_ACCEPT_CARGO              =  8,

   252

	CBM_HOUSE_PRODUCE_CARGO             =  9,

   253

	CBM_HOUSE_DENY_DESTRUCTION          = 10,

   254

};

   255

   256

/**

   257

 * Callback masks for cargos.

   258

 */

   259

enum CargoCallbackMask {

   260

	CBM_CARGO_PROFIT_CALC         = 0, ///< custom profit calculation

   261

	CBM_CARGO_STATION_RATING_CALC = 1, ///< custom station rating for this cargo type

   262

};

   263

   264

/**

   265

 * Callback masks for Industries

   266

 */

   267

enum IndustryCallbackMask {

   268

	CBM_IND_AVAILABLE                 =  0, ///< industry availability callback

   269

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

   270

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

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

	CBM_IND_SPECIAL_EFFECT            =  9, ///< control special effects

   278

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

   279

	CBM_IND_DECIDE_COLOUR             = 11, ///< give a custom colour to newly build industries

   280

	CBM_IND_INPUT_CARGO_TYPES         = 12, ///< customize the cargos the industry requires

   281

	CBM_IND_OUTPUT_CARGO_TYPES        = 13, ///< customize the cargos the industry produces

   282

};

   283

   284

/**

   285

 * Callback masks for industry tiles

   286

 */

   287

enum IndustryTileCallbackMask {

   288

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

   289

	CBM_INDT_ANIM_SPEED               = 1,  ///< decides animation speed

   290

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

   291

	CBM_INDT_ACCEPT_CARGO             = 3,  ///< decides accepted types

   292

	CBM_INDT_SHAPE_CHECK              = 4,  ///< decides slope suitability

   293

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

   294

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

   295

};

   296

   297

/**

   298

 * Different values for Callback result evaluations

   299

 */

   300

enum {

   301

	CALLBACK_FAILED              = 0xFFFF,  ///< Result of a failed callback.

   302

	CALLBACK_HOUSEPRODCARGO_END  = 0x20FF,  ///< Sentinel indicating that the loop for CBID_HOUSE_PRODUCE_CARGO has ended

   303

};

   304

   305

#endif /* NEWGRF_CALLBACKS_H */