OpenTTD Source
20241108-master-g80f628063a
|
Functions related to generic callbacks. More...
Go to the source code of this file.
Enumerations | |
enum | AIConstructionEvent { AICE_TRAIN_CHECK_RAIL_ENGINE = 0x00 , AICE_TRAIN_CHECK_ELRAIL_ENGINE = 0x01 , AICE_TRAIN_CHECK_MONORAIL_ENGINE = 0x02 , AICE_TRAIN_CHECK_MAGLEV_ENGINE = 0x03 , AICE_TRAIN_GET_RAIL_WAGON = 0x08 , AICE_TRAIN_GET_ELRAIL_WAGON = 0x09 , AICE_TRAIN_GET_MONORAIL_WAGON = 0x0A , AICE_TRAIN_GET_MAGLEV_WAGON = 0x0B , AICE_TRAIN_GET_RAILTYPE = 0x0F , AICE_ROAD_CHECK_ENGINE = 0x00 , AICE_ROAD_GET_FIRST_ENGINE = 0x01 , AICE_ROAD_GET_NUMBER_ENGINES = 0x02 , AICE_SHIP_CHECK_ENGINE = 0x00 , AICE_SHIP_GET_FIRST_ENGINE = 0x01 , AICE_SHIP_GET_NUMBER_ENGINES = 0x02 , AICE_AIRCRAFT_CHECK_ENGINE = 0x00 , AICE_STATION_GET_STATION_ID = 0x00 } |
AI events for asking the NewGRF for information. More... | |
Functions | |
void | ResetGenericCallbacks () |
Reset all generic feature callback sprite groups. | |
void | AddGenericCallback (uint8_t feature, const GRFFile *file, const SpriteGroup *group) |
Add a generic feature callback sprite group to the appropriate feature list. More... | |
uint16_t | GetAiPurchaseCallbackResult (uint8_t feature, CargoID cargo_type, uint8_t default_selection, IndustryType src_industry, IndustryType dst_industry, uint8_t distance, AIConstructionEvent event, uint8_t count, uint8_t station_size, const GRFFile **file) |
'Execute' an AI purchase selection callback More... | |
void | AmbientSoundEffectCallback (TileIndex tile) |
'Execute' the ambient sound effect callback. More... | |
void | AmbientSoundEffect (TileIndex tile) |
Play an ambient sound effect for an empty tile. | |
Variables | |
static const IndustryType | IT_AI_UNKNOWN = 0xFE |
The AI has no specific industry in mind. | |
static const IndustryType | IT_AI_TOWN = 0xFF |
The AI actually wants to transport to/from a town, not an industry. | |
Functions related to generic callbacks.
Definition in file newgrf_generic.h.
enum AIConstructionEvent |
AI events for asking the NewGRF for information.
Definition at line 20 of file newgrf_generic.h.
void AddGenericCallback | ( | uint8_t | feature, |
const GRFFile * | file, | ||
const SpriteGroup * | group | ||
) |
Add a generic feature callback sprite group to the appropriate feature list.
feature | The feature for the callback. |
file | The GRF of the callback. |
group | The sprite group of the callback. |
Definition at line 108 of file newgrf_generic.cpp.
References lengthof.
void AmbientSoundEffectCallback | ( | TileIndex | tile | ) |
'Execute' the ambient sound effect callback.
tile | Tile the sound effect should be generated for. |
Definition at line 242 of file newgrf_generic.cpp.
References _settings_client, SoundSettings::ambient, CBID_SOUNDS_AMBIENT_EFFECT, Chance16R(), IsTileType(), MP_CLEAR, MP_TREES, MP_WATER, and ClientSettings::sound.
uint16_t GetAiPurchaseCallbackResult | ( | uint8_t | feature, |
CargoID | cargo_type, | ||
uint8_t | default_selection, | ||
IndustryType | src_industry, | ||
IndustryType | dst_industry, | ||
uint8_t | distance, | ||
AIConstructionEvent | event, | ||
uint8_t | count, | ||
uint8_t | station_size, | ||
const GRFFile ** | file | ||
) |
'Execute' an AI purchase selection callback
feature | GRF Feature to call callback for. | |
cargo_type | Cargotype to pass to callback. (Variable 80) | |
default_selection | 'Default selection' to pass to callback. (Variable 82) | |
src_industry | 'Source industry type' to pass to callback. (Variable 83) | |
dst_industry | 'Destination industry type' to pass to callback. (Variable 84) | |
distance | 'Distance between source and destination' to pass to callback. (Variable 85) | |
event | 'AI construction event' to pass to callback. (Variable 86) | |
count | 'Construction number' to pass to callback. (Variable 87) | |
station_size | 'Station size' to pass to callback. (Variable 88) | |
[out] | file | Optionally returns the GRFFile which made the final decision for the callback result. May be nullptr if not required. |
Definition at line 206 of file newgrf_generic.cpp.