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

enum CallbackID {

    18

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

    19

	CBID_RANDOM_TRIGGER                  = 0x01,

    20

    21

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

    22

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

    23

	CBID_TRAIN_WAGON_POWER               = 0x10,

    24

    25

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

    26

	CBID_VEHICLE_LENGTH                  = 0x11,

    27

    28

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

    29

	CBID_VEHICLE_LOAD_AMOUNT             = 0x12,

    30

    31

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

    32

	CBID_STATION_AVAILABILITY            = 0x13,

    33

    34

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

    35

	CBID_STATION_SPRITE_LAYOUT           = 0x14,

    36

    37

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

    38

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

    39

	CBID_VEHICLE_REFIT_CAPACITY          = 0x15,

    40

    41

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

    42

	CBID_VEHICLE_ARTIC_ENGINE            = 0x16,

    43

    44

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

    45

	CBID_HOUSE_ALLOW_CONSTRUCTION        = 0x17,

    46

    47

	/** AI construction/purchase selection */

    48

	CBID_GENERIC_AI_PURCHASE_SELECTION   = 0x18, // not implemented

    49

    50

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

    51

	CBID_VEHICLE_CARGO_SUFFIX            = 0x19,

    52

    53

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

    54

	CBID_HOUSE_ANIMATION_NEXT_FRAME      = 0x1A,

    55

    56

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

    57

	CBID_HOUSE_ANIMATION_START_STOP      = 0x1B,

    58

    59

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

    60

	CBID_HOUSE_CONSTRUCTION_STATE_CHANGE = 0x1C,

    61

    62

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

    63

	CBID_TRAIN_ALLOW_WAGON_ATTACH        = 0x1D,

    64

    65

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

    66

	CBID_BUILDING_COLOUR                 = 0x1E,

    67

    68

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

    69

	CBID_HOUSE_CARGO_ACCEPTANCE          = 0x1F,

    70

    71

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

    72

	CBID_HOUSE_ANIMATION_SPEED           = 0x20,

    73

    74

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

    75

	CBID_HOUSE_DESTRUCTION               = 0x21,

    76

    77

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

    78

	CBID_INDUSTRY_AVAILABLE              = 0x22, // not implemented

    79

    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

    87

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

    88

	CBID_INDTILE_ANIM_START_STOP         = 0x25, // not implemented

    89

    90

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

    91

	CBID_INDTILE_ANIM_NEXT_FRAME         = 0x26, // not implemented

    92

    93

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

    94

	CBID_INDTILE_ANIMATION_SPEED         = 0x27, // not implemented

    95

    96

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

    97

	CBID_INDUSTRY_LOCATION               = 0x28,

    98

    99

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

   100

	CBID_INDUSTRY_PRODUCTION_CHANGE      = 0x29, // not implemented

   101

   102

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

   103

	CBID_HOUSE_ACCEPT_CARGO              = 0x2A,

   104

   105

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

   106

	CBID_INDTILE_CARGO_ACCEPTANCE        = 0x2B,

   107

   108

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

   109

	CBID_INDTILE_ACCEPT_CARGO            = 0x2C,

   110

   111

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

   112

	 * instead of the default livery. */

   113

	CBID_VEHICLE_COLOUR_MAPPING          = 0x2D,

   114

   115

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

   116

	CBID_HOUSE_PRODUCE_CARGO             = 0x2E,

   117

   118

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

   119

	CBID_INDTILE_SHAPE_CHECK             = 0x2F,

   120

   121

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

   122

	CBID_INDUSTRY_DRAW_FOUNDATIONS       = 0x30,

   123

   124

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

   125

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

   126

	CBID_VEHICLE_START_STOP_CHECK        = 0x31,

   127

   128

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

   129

	CBID_VEHICLE_32DAY_CALLBACK          = 0x32, // not implemented

   130

   131

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

   132

	CBID_VEHICLE_SOUND_EFFECT            = 0x33,

   133

   134

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

   135

	CBID_VEHICLE_AUTOREPLACE_SELECTION   = 0x34,

   136

   137

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

   138

	CBID_INDUSTRY_MONTHLYPROD_CHANGE     = 0x35, // not implemented

   139

   140

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

   141

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

   142

	CBID_VEHICLE_MODIFY_PROPERTY         = 0x36,

   143

   144

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

   145

	CBID_INDUSTRY_CARGO_SUFFIX           = 0x37, // not implemented

   146

   147

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

   149

   150

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

   151

	CBID_CARGO_PROFIT_CALC               = 0x39,

   152

   153

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

   154

	CBID_INDUSTRY_WINDOW_MORE_TEXT       = 0x3A,

   155

   156

	/** Called to determine industry special effects */

   157

	CBID_INDUSTRY_SPECIAL_EFFECT         = 0x3B,

   158

   159

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

   160

	CBID_INDUSTRY_AUTOSLOPE              = 0x3C, // not implemented

   161

   162

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

   163

	CBID_INDUSTRY_REFUSE_CARGO           = 0x3D,

   164

   165

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

   166

	CBID_HOUSE_DENY_DESTRUCTION          = 0x143,

   167

   168

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

   169

	CBID_SOUNDS_AMBIENT_EFFECT           = 0x144, // not implemented

   170

   171

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

   172

	CBID_CARGO_STATION_RATING_CALC       = 0x145,

   173

   174

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

   175

	CBID_NEW_SIGNALS_SPRITE_DRAW         = 0x146, // not implemented

   176

   177

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

   178

	CBID_CANALS_SPRITE_OFFSET            = 0x147, // not implemented

   179

};

   180

   181

/**

   182

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

   183

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

   184

 */

   185

enum VehicleCallbackMask {

   186

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

   187

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

   188

	CBM_LOAD_AMOUNT    = 2, ///< Load amount

   189

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

   190

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

   191

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

   192

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

   193

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

   194

};

   195

   196

/**

   197

 * Callback masks for stations.

   198

 */

   199

enum StationCallbackMask {

   200

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

   201

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

   202

};

   203

   204

/**

   205

 * Callback masks for houses.

   206

 */

   207

enum HouseCallbackMask {

   208

	CBM_HOUSE_ALLOW_CONSTRUCTION  = 0,

   209

	CBM_ANIMATION_NEXT_FRAME      = 1,

   210

	CBM_ANIMATION_START_STOP      = 2,

   211

	CBM_CONSTRUCTION_STATE_CHANGE = 3,

   212

	CBM_BUILDING_COLOUR           = 4,

   213

	CBM_CARGO_ACCEPTANCE          = 5,

   214

	CBM_ANIMATION_SPEED           = 6,

   215

	CBM_HOUSE_DESTRUCTION         = 7,

   216

	CBM_HOUSE_ACCEPT_CARGO        = 8,

   217

	CBM_HOUSE_PRODUCE_CARGO       = 9,

   218

	CBM_HOUSE_DENY_DESTRUCTION    = 10,

   219

};

   220

   221

/**

   222

 * Callback masks for cargos.

   223

 */

   224

enum CargoCallbackMask {

   225

	CBM_CARGO_PROFIT_CALC         = 0,

   226

	CBM_CARGO_STATION_RATING_CALC = 1,

   227

};

   228

   229

/**

   230

 * Callback masks for Industries

   231

 */

   232

enum IndustryCallbackMask {

   233

	CBM_IND_AVAILABLE                 = 0,  ///< industry availability callback

   234

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

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

	CBM_IND_SPECIAL_EFFECT            = 9,  ///< control special effects

   243

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

   244

};

   245

   246

/**

   247

 * Callback masks for industry tiles

   248

 */

   249

enum IndustryTileCallbackMask {

   250

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

   251

	CBM_INDT_ANIM_SPEED               = 1,  ///< decides animation speed

   252

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

   253

	CBM_INDT_ACCEPT_CARGO             = 3,  ///< decides accepted types

   254

	CBM_INDT_SHAPE_CHECK              = 4,  ///< decides slope suitability

   255

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

   256

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

   257

};

   258

   259

/**

   260

 * Result of a failed callback.

   261

 */

   262

enum {

   263

	CALLBACK_FAILED = 0xFFFF

   264

};

   265

   266

#endif /* NEWGRF_CALLBACKS_H */