Files
@ r4962:2ff3f433591e
Branch filter:
Location: cpp/openttd-patchpack/source/newgrf_callbacks.h - annotation
r4962:2ff3f433591e
2.7 KiB
text/x-c
(svn r6961) -Codechange: Remove relic from r212 WWT_NODISTXTBTN which was originally used to not
to allow clicking if a button was disabled. This has been superseded in r212 with
general code that doesn't allow any click events for disabled buttons.
to allow clicking if a button was disabled. This has been superseded in r212 with
general code that doesn't allow any click events for disabled buttons.
r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r3007:480ed0629d74 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r3007:480ed0629d74 r2982:cf402ad65f64 r3754:7e934e84e584 r3754:7e934e84e584 r3754:7e934e84e584 r3754:7e934e84e584 r3754:7e934e84e584 r3754:7e934e84e584 r3754:7e934e84e584 r3754:7e934e84e584 r2982:cf402ad65f64 r2982:cf402ad65f64 r3007:480ed0629d74 r2982:cf402ad65f64 r3007:480ed0629d74 r3650:52328e33959e r4694:2106e27743ca r4694:2106e27743ca r3727:1785a129fadb r3727:1785a129fadb r3650:52328e33959e r3650:52328e33959e r3650:52328e33959e r3754:7e934e84e584 r3754:7e934e84e584 r3754:7e934e84e584 r4244:0db718156ac2 r4244:0db718156ac2 r4244:0db718156ac2 r4244:0db718156ac2 r4656:515f0929a2ed r4656:515f0929a2ed r4656:515f0929a2ed r2982:cf402ad65f64 r2982:cf402ad65f64 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r3007:480ed0629d74 r2982:cf402ad65f64 r2982:cf402ad65f64 r3007:480ed0629d74 r3505:7910967480fd r3505:7910967480fd r3505:7910967480fd r3505:7910967480fd r3505:7910967480fd r3505:7910967480fd r3505:7910967480fd r3505:7910967480fd r3007:480ed0629d74 r3007:480ed0629d74 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 r2982:cf402ad65f64 | /* $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 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,
CBID_VEHICLE_CARGO_SUFFIX = 0x19,
CBID_TRAIN_ALLOW_WAGON_ATTACH = 0x1D,
/* 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 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,
};
/**
* 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
};
/**
* Result of a failed callback.
*/
enum {
CALLBACK_FAILED = 0xFFFF
};
#endif /* NEWGRF_CALLBACKS_H */
|