1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/* $Id$ */
#ifndef NEWGRF_CALLBACKS_H
#define NEWGRF_CALLBACKS_H
/** @file newgrf_callbacks.h
*/
/**
* List of implemented NewGRF callbacks.
* Names are formatted as CBID_<CLASS>_<CALLBACK>
*/
enum CallbackID {
/* Powered wagons, if the result is lower as 0x40 then the wagon is powered
* @todo : interpret the rest of the result, aka "visual effects" */
CBID_TRAIN_WAGON_POWER = 0x10,
/* Vehicle length, returns the amount of 1/8's the vehicle is shorter
* only for train vehicles */
CBID_TRAIN_VEHICLE_LENGTH = 0x11,
/* Called (if appropriate bit in callback mask is set) to determine the
* amount of cargo to load per unit of time when using gradual loading. */
CBID_VEHICLE_LOAD_AMOUNT = 0x12,
/* Called (if appropriate bit in callback mask is set) to determine if a
* newstation should be made available to build */
CBID_STATION_AVAILABILITY = 0x13,
/* Called (if appropriate bit in callback mask is set) when drawing a tile
* to choose a sprite layout to draw, instead of the standard 0-7 range */
CBID_STATION_SPRITE_LAYOUT = 0x14,
/* Refit capacity, the passed vehicle needs to have its ->cargo_type set to
* the cargo we are refitting to, returns the new cargo capacity */
CBID_VEHICLE_REFIT_CAPACITY = 0x15,
CBID_TRAIN_ARTIC_ENGINE = 0x16,
/* Called (if appropriate bit in callback mask is set) to determine whether
* the house can be built on the specified tile. */
CBID_HOUSE_ALLOW_CONSTRUCTION = 0x17,
CBID_VEHICLE_CARGO_SUFFIX = 0x19,
/* Called (if appropriate bit in callback mask is set) to determine
* the next animation frame. */
CBID_HOUSE_ANIMATION_NEXT_FRAME = 0x1A,
/* Called (if appropriate bit in callback mask is set) for periodically
* starting or stopping the animation. */
CBID_HOUSE_ANIMATION_START_STOP = 0x1B,
/* Called (if appropriate bit in callback mask is set) whenever the
* construction state of a house changes. */
CBID_CONSTRUCTION_STATE_CHANGE = 0x1C,
CBID_TRAIN_ALLOW_WAGON_ATTACH = 0x1D,
/* Called (if appropriate bit in callback mask is set) to determine the
* colour of a town building. */
CBID_BUILDING_COLOUR = 0x1E,
/* Called (if appropriate bit in callback mask is set) to decide how much
* cargo a town building can accept. */
CBID_HOUSE_CARGO_ACCEPTANCE = 0x1F, // not yet implemented
/* Called (if appropriate bit in callback mask is set) to indicate
* how long the current animation frame should last. */
CBID_HOUSE_ANIMATION_SPEED = 0x20,
/* Called (if appropriate bit in callback mask is set) periodically to
* determine if a house should be destroyed. */
CBID_HOUSE_DESTRUCTION = 0x21,
/* This callback is called from vehicle purchase lists. It returns a value to be
* used as a custom string ID in the 0xD000 range. */
CBID_VEHICLE_ADDITIONAL_TEXT = 0x23,
/* Called when building a station to customize the tile layout */
CBID_STATION_TILE_LAYOUT = 0x24,
/* Called (if appropriate bit in callback mask is set) to determine which
* cargoes a town building should accept. */
CBID_HOUSE_ACCEPT_CARGO = 0x2A, // not yet implemented
/* Called to determine if a specific colour map should be used for a vehicle
* instead of the default livery */
CBID_VEHICLE_COLOUR_MAPPING = 0x2D,
/* Called (if appropriate bit in callback mask is set) to determine how much
* cargo a town building produces. */
CBID_HOUSE_PRODUCE_CARGO = 0x2E, // not yet implemented
/* Called when the player (or AI) tries to start or stop a vehicle. Mainly
* used for preventing a vehicle from leaving the depot. */
CBID_VEHICLE_START_STOP_CHECK = 0x31,
/* Called to play a special sound effect */
CBID_VEHICLE_SOUND_EFFECT = 0x33,
/* Called to calculate the income of delivered cargo */
CBID_CARGO_PROFIT_CALC = 0x39,
/* Called (if appropriate bit in callback mask set) to determine whether a
* town building can be destroyed. */
CBID_HOUSE_DENY_DESTRUCTION = 0x143,
/* Called to calculate part of a station rating */
CBID_CARGO_STATION_RATING_CALC = 0x145,
};
/**
* Callback masks for vehicles, indicates which callbacks are used by a vehicle.
* Some callbacks are always used and don't have a mask.
*/
enum VehicleCallbackMask {
CBM_WAGON_POWER = 0, ///< Powered wagons (trains only)
CBM_VEHICLE_LENGTH = 1, ///< Vehicle length (trains only)
CBM_LOAD_AMOUNT = 2, ///< Load amount
CBM_REFIT_CAPACITY = 3, ///< Cargo capacity after refit
CBM_ARTIC_ENGINE = 4, ///< Add articulated engines (trains only)
CBM_CARGO_SUFFIX = 5, ///< Show suffix after cargo name
CBM_COLOUR_REMAP = 6, ///< Change colour mapping of vehicle
CBM_SOUND_EFFECT = 7, ///< Vehicle uses custom sound effects
};
/**
* Callback masks for stations.
*/
enum StationCallbackMask {
CBM_STATION_AVAIL = 0, ///< Availability of station in construction window
CBM_CUSTOM_LAYOUT = 1, ///< Use callback to select a tile layout to use
};
/**
* Callback masks for houses.
*/
enum HouseCallbackMask {
CBM_HOUSE_ALLOW_CONSTRUCTION = 0,
CBM_ANIMATION_NEXT_FRAME = 1,
CBM_ANIMATION_START_STOP = 2,
CBM_CONSTRUCTION_STATE_CHANGE = 3,
CBM_BUILDING_COLOUR = 4,
CBM_CARGO_ACCEPTANCE = 5,
CBM_ANIMATION_SPEED = 6,
CBM_HOUSE_DESTRUCTION = 7,
CBM_HOUSE_ACCEPT_CARGO = 8,
CBM_HOUSE_PRODUCE_CARGO = 9,
CBM_HOUSE_DENY_DESTRUCTION = 10,
};
/**
* Callback masks for cargos.
*/
enum CargoCallbackMask {
CBM_CARGO_PROFIT_CALC = 0,
CBM_CARGO_STATION_RATING_CALC = 1,
};
/**
* Result of a failed callback.
*/
enum {
CALLBACK_FAILED = 0xFFFF
};
#endif /* NEWGRF_CALLBACKS_H */
|
