OpenTTD Source: src/newgrf_generic.cpp Source File

OpenTTD Source 13.2.1

newgrf_generic.cpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #include "stdafx.h"
11 #include "debug.h"
12 #include "newgrf_spritegroup.h"
13 #include "industrytype.h"
14 #include "core/random_func.hpp"
15 #include "newgrf_sound.h"
16 #include "water_map.h"
17 #include <list>
18
19 #include "safeguards.h"
20
22 struct GenericScopeResolver : public ScopeResolver {
23 CargoID cargo_type;
24 uint8 default_selection;
25 uint8 src_industry;
26 uint8 dst_industry;
27 uint8 distance;
28 AIConstructionEvent event;
29 uint8 count;
30 uint8 station_size;
31
32 uint8 feature;
33
39 GenericScopeResolver(ResolverObject &ro, bool ai_callback)
40 : ScopeResolver(ro), cargo_type(0), default_selection(0), src_industry(0), dst_industry(0), distance(0),
41 event(), count(0), station_size(0), feature(GSF_INVALID), ai_callback(ai_callback)
42 {
43 }
44
45 uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override;
46
47 private:
48 bool ai_callback;
49 };
50
51
53 struct GenericResolverObject : public ResolverObject {
54 GenericScopeResolver generic_scope;
55
56 GenericResolverObject(bool ai_callback, CallbackID callback = CBID_NO_CALLBACK);
57
58 ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override
59 {
60 switch (scope) {
61 case VSG_SCOPE_SELF: return &this->generic_scope;
62 default: return ResolverObject::GetScope(scope, relative);
63 }
64 }
65
66 GrfSpecFeature GetFeature() const override
67 {
68 return (GrfSpecFeature)this->generic_scope.feature;
69 }
70
71 uint32 GetDebugID() const override
72 {
73 return 0;
74 }
75 };
76
77 struct GenericCallback {
78 const GRFFile *file;
79 const SpriteGroup *group;
80
81 GenericCallback(const GRFFile *file, const SpriteGroup *group) :
82 file(file),
83 group(group)
84 { }
85 };
86
87 typedef std::list<GenericCallback> GenericCallbackList;
88
89 static GenericCallbackList _gcl[GSF_END];
90
91
95 void ResetGenericCallbacks()
96 {
97 for (uint8 feature = 0; feature < lengthof(_gcl); feature++) {
98 _gcl[feature].clear();
99 }
100 }
101
102
109 void AddGenericCallback(uint8 feature, const GRFFile *file, const SpriteGroup *group)
110 {
111 if (feature >= lengthof(_gcl)) {
112 grfmsg(5, "AddGenericCallback: Unsupported feature 0x%02X", feature);
113 return;
114 }
115
116 /* Generic feature callbacks are evaluated in reverse (i.e. the last group
117 * to be added is evaluated first, etc) thus we push the group to the
118 * beginning of the list so a standard iterator will do the right thing. */
119 _gcl[feature].push_front(GenericCallback(file, group));
120 }
121
122 /* virtual */ uint32 GenericScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
123 {
124 if (this->ai_callback) {
125 switch (variable) {
126 case 0x40: return this->ro.grffile->cargo_map[this->cargo_type];
127
128 case 0x80: return this->cargo_type;
129 case 0x81: return CargoSpec::Get(this->cargo_type)->bitnum;
130 case 0x82: return this->default_selection;
131 case 0x83: return this->src_industry;
132 case 0x84: return this->dst_industry;
133 case 0x85: return this->distance;
134 case 0x86: return this->event;
135 case 0x87: return this->count;
136 case 0x88: return this->station_size;
137
138 default: break;
139 }
140 }
141
142 Debug(grf, 1, "Unhandled generic feature variable 0x{:02X}", variable);
143
144 *available = false;
145 return UINT_MAX;
146 }
147
153 GenericResolverObject::GenericResolverObject(bool ai_callback, CallbackID callback) : ResolverObject(nullptr, callback), generic_scope(*this, ai_callback)
154 {
155 }
156
157
168 static uint16 GetGenericCallbackResult(uint8 feature, ResolverObject &object, uint32 param1_grfv7, uint32 param1_grfv8, const GRFFile **file)
169 {
170 assert(feature < lengthof(_gcl));
171
172 /* Test each feature callback sprite group. */
173 for (GenericCallbackList::const_iterator it = _gcl[feature].begin(); it != _gcl[feature].end(); ++it) {
174 object.grffile = it->file;
175 object.root_spritegroup = it->group;
176 /* Set callback param based on GRF version. */
177 object.callback_param1 = it->file->grf_version >= 8 ? param1_grfv8 : param1_grfv7;
178 uint16 result = object.ResolveCallback();
179 if (result == CALLBACK_FAILED) continue;
180
181 /* Return NewGRF file if necessary */
182 if (file != nullptr) *file = it->file;
183
184 return result;
185 }
186
187 /* No callback returned a valid result, so we've failed. */
188 return CALLBACK_FAILED;
189 }
190
191
207 uint16 GetAiPurchaseCallbackResult(uint8 feature, CargoID cargo_type, uint8 default_selection, IndustryType src_industry, IndustryType dst_industry, uint8 distance, AIConstructionEvent event, uint8 count, uint8 station_size, const GRFFile **file)
208 {
209 GenericResolverObject object(true, CBID_GENERIC_AI_PURCHASE_SELECTION);
210
211 if (src_industry != IT_AI_UNKNOWN && src_industry != IT_AI_TOWN) {
212 const IndustrySpec *is = GetIndustrySpec(src_industry);
213 /* If this is no original industry, use the substitute type */
214 if (is->grf_prop.subst_id != INVALID_INDUSTRYTYPE) src_industry = is->grf_prop.subst_id;
215 }
216
217 if (dst_industry != IT_AI_UNKNOWN && dst_industry != IT_AI_TOWN) {
218 const IndustrySpec *is = GetIndustrySpec(dst_industry);
219 /* If this is no original industry, use the substitute type */
220 if (is->grf_prop.subst_id != INVALID_INDUSTRYTYPE) dst_industry = is->grf_prop.subst_id;
221 }
222
223 object.generic_scope.cargo_type = cargo_type;
224 object.generic_scope.default_selection = default_selection;
225 object.generic_scope.src_industry = src_industry;
226 object.generic_scope.dst_industry = dst_industry;
227 object.generic_scope.distance = distance;
228 object.generic_scope.event = event;
229 object.generic_scope.count = count;
230 object.generic_scope.station_size = station_size;
231 object.generic_scope.feature = feature;
232
233 uint16 callback = GetGenericCallbackResult(feature, object, 0, 0, file);
234 if (callback != CALLBACK_FAILED) callback = GB(callback, 0, 8);
235 return callback;
236 }
237
238
243 void AmbientSoundEffectCallback(TileIndex tile)
244 {
245 assert(IsTileType(tile, MP_CLEAR) || IsTileType(tile, MP_TREES) || IsTileType(tile, MP_WATER));
246
247 /* Only run every 1/200-th time. */
248 uint32 r; // Save for later
249 if (!Chance16R(1, 200, r) || !_settings_client.sound.ambient) return;
250
251 /* Prepare resolver object. */
252 GenericResolverObject object(false, CBID_SOUNDS_AMBIENT_EFFECT);
253 object.generic_scope.feature = GSF_SOUNDFX;
254
255 uint32 param1_v7 = GetTileType(tile) << 28 | Clamp(TileHeight(tile), 0, 15) << 24 | GB(r, 16, 8) << 16 | GetTerrainType(tile);
256 uint32 param1_v8 = GetTileType(tile) << 24 | GetTileZ(tile) << 16 | GB(r, 16, 8) << 8 | (HasTileWaterClass(tile) ? GetWaterClass(tile) : 0) << 3 | GetTerrainType(tile);
257
258 /* Run callback. */
259 const GRFFile *grf_file;
260 uint16 callback = GetGenericCallbackResult(GSF_SOUNDFX, object, param1_v7, param1_v8, &grf_file);
261
262 if (callback != CALLBACK_FAILED) PlayTileSound(grf_file, callback, tile);
263 }
MP_CLEAR
@ MP_CLEAR
A tile without any structures, i.e. grass, rocks, farm fields etc.
Definition: tile_type.h:48
VarSpriteGroupScope
VarSpriteGroupScope
Definition: newgrf_spritegroup.h:97
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
HasTileWaterClass
static bool HasTileWaterClass(TileIndex t)
Checks whether the tile has an waterclass associated.
Definition: water_map.h:106
grfmsg
void CDECL grfmsg(int severity, const char *str,...)
Debug() function dedicated to newGRF debugging messages Function is essentially the same as Debug(grf...
Definition: newgrf.cpp:391
CBID_SOUNDS_AMBIENT_EFFECT
@ CBID_SOUNDS_AMBIENT_EFFECT
Select an ambient sound to play for a given type of tile.
Definition: newgrf_callbacks.h:197
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:118
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition: newgrf_spritegroup.h:307
GetTileZ
int GetTileZ(TileIndex tile)
Get bottom height of the tile.
Definition: tile_map.cpp:121
ResolverObject::grffile
const GRFFile * grffile
GRFFile the resolved SpriteGroup belongs to.
Definition: newgrf_spritegroup.h:335
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
GenericCallback
Definition: newgrf_generic.cpp:77
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:53
IT_AI_UNKNOWN
static const IndustryType IT_AI_UNKNOWN
The AI has no specific industry in mind.
Definition: newgrf_generic.h:44
GetAiPurchaseCallbackResult
uint16 GetAiPurchaseCallbackResult(uint8 feature, CargoID cargo_type, uint8 default_selection, IndustryType src_industry, IndustryType dst_industry, uint8 distance, AIConstructionEvent event, uint8 count, uint8 station_size, const GRFFile **file)
'Execute' an AI purchase selection callback
Definition: newgrf_generic.cpp:207
GSF_INVALID
@ GSF_INVALID
An invalid spec feature.
Definition: newgrf.h:92
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition: newgrf_callbacks.h:20
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition: newgrf_spritegroup.h:288
GenericResolverObject::GetDebugID
uint32 GetDebugID() const override
Get an identifier for the item being resolved.
Definition: newgrf_generic.cpp:71
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition: newgrf_spritegroup.h:100
CargoSpec::bitnum
uint8 bitnum
Cargo bit number, is INVALID_CARGO for a non-used spec.
Definition: cargotype.h:58
GenericScopeResolver::dst_industry
uint8 dst_industry
Destination industry substitute type. 0xFF for "town", 0xFE for "unknown".
Definition: newgrf_generic.cpp:26
SoundSettings::ambient
bool ambient
Play ambient, industry and town sounds.
Definition: settings_type.h:220
GenericResolverObject::GetScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0) override
Get a resolver for the scope.
Definition: newgrf_generic.cpp:58
CBID_GENERIC_AI_PURCHASE_SELECTION
@ CBID_GENERIC_AI_PURCHASE_SELECTION
AI construction/purchase selection.
Definition: newgrf_callbacks.h:57
PlayTileSound
void PlayTileSound(const GRFFile *file, SoundID sound_id, TileIndex tile)
Play a NewGRF sound effect at the location of a specific tile.
Definition: newgrf_sound.cpp:220
TileHeight
static uint TileHeight(TileIndex tile)
Returns the height of a tile.
Definition: tile_map.h:29
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:607
AIConstructionEvent
AIConstructionEvent
AI events for asking the NewGRF for information.
Definition: newgrf_generic.h:20
CBID_NO_CALLBACK
@ CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
Definition: newgrf_callbacks.h:22
GetGenericCallbackResult
static uint16 GetGenericCallbackResult(uint8 feature, ResolverObject &object, uint32 param1_grfv7, uint32 param1_grfv8, const GRFFile **file)
Follow a generic feature callback list and return the first successful answer.
Definition: newgrf_generic.cpp:168
GenericResolverObject::GetFeature
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Definition: newgrf_generic.cpp:66
MP_WATER
@ MP_WATER
Water tile.
Definition: tile_type.h:54
AddGenericCallback
void AddGenericCallback(uint8 feature, const GRFFile *file, const SpriteGroup *group)
Add a generic feature callback sprite group to the appropriate feature list.
Definition: newgrf_generic.cpp:109
safeguards.h
GenericScopeResolver::GetVariable
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override
Get a variable value.
Definition: newgrf_generic.cpp:122
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Definition: newgrf_spritegroup.cpp:139
stdafx.h
IndustrySpec
Defines the data structure for constructing industry.
Definition: industrytype.h:107
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
MP_TREES
@ MP_TREES
Tile got trees.
Definition: tile_type.h:52
newgrf_spritegroup.h
water_map.h
GrfSpecFeature
GrfSpecFeature
Definition: newgrf.h:66
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition: newgrf_callbacks.h:408
newgrf_sound.h
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
AmbientSoundEffectCallback
void AmbientSoundEffectCallback(TileIndex tile)
'Execute' the ambient sound effect callback.
Definition: newgrf_generic.cpp:243
GetWaterClass
static WaterClass GetWaterClass(TileIndex t)
Get the water class at a tile.
Definition: water_map.h:117
INVALID_INDUSTRYTYPE
static const IndustryType INVALID_INDUSTRYTYPE
one above amount is considered invalid
Definition: industry_type.h:27
industrytype.h
IndustrySpec::grf_prop
GRFFileProps grf_prop
properties related to the grf file
Definition: industrytype.h:141
GenericScopeResolver::GenericScopeResolver
GenericScopeResolver(ResolverObject &ro, bool ai_callback)
Generic scope resolver.
Definition: newgrf_generic.cpp:39
GRFFile::cargo_map
uint8 cargo_map[NUM_CARGO]
Inverse cargo translation table (CargoID -> local ID)
Definition: newgrf.h:128
ResolverObject::callback
CallbackID callback
Callback being resolved.
Definition: newgrf_spritegroup.h:325
IT_AI_TOWN
static const IndustryType IT_AI_TOWN
The AI actually wants to transport to/from a town, not an industry.
Definition: newgrf_generic.h:45
Debug
#define Debug(name, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:386
random_func.hpp
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
Chance16R
static bool Chance16R(const uint a, const uint b, uint32 &r)
Flips a coin with a given probability and saves the randomize-number in a variable.
Definition: random_func.hpp:155
GetIndustrySpec
const IndustrySpec * GetIndustrySpec(IndustryType thistype)
Accessor for array _industry_specs.
Definition: industry_cmd.cpp:123
GenericResolverObject
Resolver object for generic objects/properties.
Definition: newgrf_generic.cpp:53
GetTileType
static TileType GetTileType(TileIndex tile)
Get the tiletype of a given tile.
Definition: tile_map.h:96
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition: newgrf_spritegroup.h:289
GenericScopeResolver::ai_callback
bool ai_callback
Callback comes from the AI.
Definition: newgrf_generic.cpp:48
GenericResolverObject::GenericResolverObject
GenericResolverObject(bool ai_callback, CallbackID callback=CBID_NO_CALLBACK)
Generic resolver.
Definition: newgrf_generic.cpp:153
SpriteGroup
Definition: newgrf_spritegroup.h:57
GenericScopeResolver::src_industry
uint8 src_industry
Source industry substitute type. 0xFF for "town", 0xFE for "unknown".
Definition: newgrf_generic.cpp:25
ResetGenericCallbacks
void ResetGenericCallbacks()
Reset all generic feature callback sprite groups.
Definition: newgrf_generic.cpp:95
GetTerrainType
uint32 GetTerrainType(TileIndex tile, TileContext context)
Function used by houses (and soon industries) to get information on type of "terrain" the tile it is ...
Definition: newgrf_commons.cpp:348
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:106
debug.h
GenericScopeResolver
Scope resolver for generic objects and properties.
Definition: newgrf_generic.cpp:22