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

 * Most of these callbacks are only triggered when the corresponding

    13

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

    14

 * industry, etc.

    15

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

    16

 *

    17

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

    18

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

    19

 */

    20

enum CallbackID {

    21

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

    22

	CBID_NO_CALLBACK                     = 0x00,

    23

    24

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

    25

	CBID_RANDOM_TRIGGER                  = 0x01,

    26

    27

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

    28

    29

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

    30

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

    31

	CBID_TRAIN_WAGON_POWER               = 0x10,

    32

    33

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

    34

	CBID_VEHICLE_LENGTH                  = 0x11,

    35

    36

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

    37

	CBID_VEHICLE_LOAD_AMOUNT             = 0x12,

    38

    39

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

    40

	CBID_STATION_AVAILABILITY            = 0x13,

    41

    42

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

    43

	CBID_STATION_SPRITE_LAYOUT           = 0x14,

    44

    45

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

    46

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

    47

	CBID_VEHICLE_REFIT_CAPACITY          = 0x15,

    48

    49

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

    50

	CBID_VEHICLE_ARTIC_ENGINE            = 0x16,

    51

    52

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

    53

	CBID_HOUSE_ALLOW_CONSTRUCTION        = 0x17,

    54

    55

	/** AI construction/purchase selection */

    56

	CBID_GENERIC_AI_PURCHASE_SELECTION   = 0x18, // not implemented

    57

    58

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

    59

	CBID_VEHICLE_CARGO_SUFFIX            = 0x19,

    60

    61

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

    62

	CBID_HOUSE_ANIMATION_NEXT_FRAME      = 0x1A,

    63

    64

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

    65

	CBID_HOUSE_ANIMATION_START_STOP      = 0x1B,

    66

    67

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

    68

	CBID_HOUSE_CONSTRUCTION_STATE_CHANGE = 0x1C,

    69

    70

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

    71

	CBID_TRAIN_ALLOW_WAGON_ATTACH        = 0x1D,

    72

    73

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

    74

	CBID_HOUSE_COLOUR                    = 0x1E,

    75

    76

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

    77

	CBID_HOUSE_CARGO_ACCEPTANCE          = 0x1F,

    78

    79

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

    80

	CBID_HOUSE_ANIMATION_SPEED           = 0x20,

    81

    82

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

    83

	CBID_HOUSE_DESTRUCTION               = 0x21,

    84

    85

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

    86

	CBID_INDUSTRY_AVAILABLE              = 0x22,

    87

    88

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

    89

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

    90

	CBID_VEHICLE_ADDITIONAL_TEXT         = 0x23,

    91

    92

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

    93

	CBID_STATION_TILE_LAYOUT             = 0x24,

    94

    95

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

    96

	CBID_INDTILE_ANIM_START_STOP         = 0x25,

    97

    98

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

    99

	CBID_INDTILE_ANIM_NEXT_FRAME         = 0x26,

   100

   101

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

   102

	CBID_INDTILE_ANIMATION_SPEED         = 0x27,

   103

   104

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

   105

	CBID_INDUSTRY_LOCATION               = 0x28,

   106

   107

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

   108

	CBID_INDUSTRY_PRODUCTION_CHANGE      = 0x29,

   109

   110

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

   111

	CBID_HOUSE_ACCEPT_CARGO              = 0x2A,

   112

   113

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

   114

	CBID_INDTILE_CARGO_ACCEPTANCE        = 0x2B,

   115

   116

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

   117

	CBID_INDTILE_ACCEPT_CARGO            = 0x2C,

   118

   119

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

   120

	 * instead of the default livery. */

   121

	CBID_VEHICLE_COLOUR_MAPPING          = 0x2D,

   122

   123

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

   124

	CBID_HOUSE_PRODUCE_CARGO             = 0x2E,

   125

   126

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

   127

	CBID_INDTILE_SHAPE_CHECK             = 0x2F,

   128

   129

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

   130

	CBID_INDUSTRY_DRAW_FOUNDATIONS       = 0x30,

   131

   132

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

   133

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

   134

	CBID_VEHICLE_START_STOP_CHECK        = 0x31,

   135

   136

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

   137

	CBID_VEHICLE_32DAY_CALLBACK          = 0x32,

   138

   139

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

   140

	CBID_VEHICLE_SOUND_EFFECT            = 0x33,

   141

   142

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

   143

	CBID_VEHICLE_AUTOREPLACE_SELECTION   = 0x34,

   144

   145

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

   146

	CBID_INDUSTRY_MONTHLYPROD_CHANGE     = 0x35,

   147

   148

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

   149

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

   150

	CBID_VEHICLE_MODIFY_PROPERTY         = 0x36,

   151

   152

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

   153

	CBID_INDUSTRY_CARGO_SUFFIX           = 0x37,

   154

   155

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

   156

	CBID_INDUSTRY_FUND_MORE_TEXT         = 0x38,

   157

   158

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

   159

	CBID_CARGO_PROFIT_CALC               = 0x39,

   160

   161

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

   162

	CBID_INDUSTRY_WINDOW_MORE_TEXT       = 0x3A,

   163

   164

	/** Called to determine industry special effects */

   165

	CBID_INDUSTRY_SPECIAL_EFFECT         = 0x3B,

   166

   167

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

   168

	CBID_INDUSTRY_AUTOSLOPE              = 0x3C,

   169

   170

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

   171

	CBID_INDUSTRY_REFUSE_CARGO           = 0x3D,

   172

   173

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

   174

   175

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

   176

	CBID_STATION_ANIM_START_STOP         = 0x140, // not implemented

   177

   178

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

   179

	CBID_STATION_ANIM_NEXT_FRAME         = 0x141, // not implemented

   180

   181

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

   182

	CBID_STATION_ANIMATION_SPEED         = 0x142, // not implemented

   183

   184

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

   185

	CBID_HOUSE_DENY_DESTRUCTION          = 0x143,

   186

   187

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

   188

	CBID_SOUNDS_AMBIENT_EFFECT           = 0x144, // not implemented

   189

   190

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

   191

	CBID_CARGO_STATION_RATING_CALC       = 0x145,

   192

   193

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

   194

	CBID_NEW_SIGNALS_SPRITE_DRAW         = 0x146, // not implemented

   195

   196

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

   197

	CBID_CANALS_SPRITE_OFFSET            = 0x147, // not implemented

   198

   199

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

   200

	CBID_HOUSE_WATCHED_CARGO_ACCEPTED    = 0x148, // not implemented

   201

   202

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

   203

	CBID_STATION_LAND_SLOPE_CHECK        = 0x149, // not implemented

   204

   205

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

   206

	CBID_INDUSTRY_DECIDE_COLOUR          = 0x14A,

   207

   208

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

   209

	CBID_INDUSTRY_INPUT_CARGO_TYPES      = 0x14B,

   210

   211

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

   212

	CBID_INDUSTRY_OUTPUT_CARGO_TYPES     = 0x14C,

   213

   214

	/* ATTENTION:

   215

	 * When adding new callbacks and their result is 15bit, add them to newgrf_spritegroup.cpp:Is8BitCallback().

   216

	 * It does not harm to add them there though they are not implemented. But it does harm if they get forgotton.

   217

	 */

   218

};

   219

   220

/**

   221

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

   222

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

   223

 */

   224

enum VehicleCallbackMask {

   225

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

   226

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

   227

	CBM_VEHICLE_LOAD_AMOUNT    = 2, ///< Load amount

   228

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

   229

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

   230

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

   231

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

   232

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

   233

};

   234

   235

/**

   236

 * Callback masks for stations.

   237

 */

   238

enum StationCallbackMask {

   239

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

   240

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

   241

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

   242

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

   243

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

   244

};

   245

   246

/**

   247

 * Callback masks for houses.

   248

 */

   249

enum HouseCallbackMask {

   250

	CBM_HOUSE_ALLOW_CONSTRUCTION        =  0,

   251

	CBM_HOUSE_ANIMATION_NEXT_FRAME      =  1,

   252

	CBM_HOUSE_ANIMATION_START_STOP      =  2,

   253

	CBM_HOUSE_CONSTRUCTION_STATE_CHANGE =  3,

   254

	CBM_HOUSE_COLOUR                    =  4,

   255

	CBM_HOUSE_CARGO_ACCEPTANCE          =  5,

   256

	CBM_HOUSE_ANIMATION_SPEED           =  6,

   257

	CBM_HOUSE_DESTRUCTION               =  7,

   258

	CBM_HOUSE_ACCEPT_CARGO              =  8,

   259

	CBM_HOUSE_PRODUCE_CARGO             =  9,

   260

	CBM_HOUSE_DENY_DESTRUCTION          = 10,

   261

};

   262

   263

/**

   264

 * Callback masks for cargos.

   265

 */

   266

enum CargoCallbackMask {

   267

	CBM_CARGO_PROFIT_CALC         = 0, ///< custom profit calculation

   268

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

   269

};

   270

   271

/**

   272

 * Callback masks for Industries

   273

 */

   274

enum IndustryCallbackMask {

   275

	CBM_IND_AVAILABLE                 =  0, ///< industry availability callback

   276

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

   277

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

   278

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

   279

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

   280

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

   281

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

   282

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

   283

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

   284

	CBM_IND_SPECIAL_EFFECT            =  9, ///< control special effects

   285

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

   286

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

   287

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

   288

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

   289

};

   290

   291

/**

   292

 * Callback masks for industry tiles

   293

 */

   294

enum IndustryTileCallbackMask {

   295

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

   296

	CBM_INDT_ANIM_SPEED               = 1,  ///< decides animation speed

   297

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

   298

	CBM_INDT_ACCEPT_CARGO             = 3,  ///< decides accepted types

   299

	CBM_INDT_SHAPE_CHECK              = 4,  ///< decides slope suitability

   300

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

   301

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

   302

};

   303

   304

/**

   305

 * Different values for Callback result evaluations

   306

 */

   307

enum {

   308

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

   309

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

   310

};

   311

   312

#endif /* NEWGRF_CALLBACKS_H */