OpenTTD Source  12.0-beta2
newgrf_spritegroup.h
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 #ifndef NEWGRF_SPRITEGROUP_H
11 #define NEWGRF_SPRITEGROUP_H
12 
13 #include "town_type.h"
14 #include "engine_type.h"
15 #include "house_type.h"
16 #include "industry_type.h"
17 
18 #include "newgrf_callbacks.h"
19 #include "newgrf_generic.h"
20 #include "newgrf_storage.h"
21 #include "newgrf_commons.h"
22 
29 static inline uint32 GetRegister(uint i)
30 {
31  extern TemporaryStorageArray<int32, 0x110> _temp_store;
32  return _temp_store.GetValue(i);
33 }
34 
35 /* List of different sprite group types */
36 enum SpriteGroupType {
37  SGT_REAL,
38  SGT_DETERMINISTIC,
39  SGT_RANDOMIZED,
40  SGT_CALLBACK,
41  SGT_RESULT,
42  SGT_TILELAYOUT,
43  SGT_INDUSTRY_PRODUCTION,
44 };
45 
46 struct SpriteGroup;
47 typedef uint32 SpriteGroupID;
48 struct ResolverObject;
49 
50 /* SPRITE_WIDTH is 24. ECS has roughly 30 sprite groups per real sprite.
51  * Adding an 'extra' margin would be assuming 64 sprite groups per real
52  * sprite. 64 = 2^6, so 2^30 should be enough (for now) */
54 extern SpriteGroupPool _spritegroup_pool;
55 
56 /* Common wrapper for all the different sprite group types */
57 struct SpriteGroup : SpriteGroupPool::PoolItem<&_spritegroup_pool> {
58 protected:
59  SpriteGroup(SpriteGroupType type) : nfo_line(0), type(type) {}
61  virtual const SpriteGroup *Resolve(ResolverObject &object) const { return this; };
62 
63 public:
64  virtual ~SpriteGroup() {}
65 
66  uint32 nfo_line;
67  SpriteGroupType type;
68 
69  virtual SpriteID GetResult() const { return 0; }
70  virtual byte GetNumResults() const { return 0; }
71  virtual uint16 GetCallbackResult() const { return CALLBACK_FAILED; }
72 
73  static const SpriteGroup *Resolve(const SpriteGroup *group, ResolverObject &object, bool top_level = true);
74 };
75 
76 
77 /* 'Real' sprite groups contain a list of other result or callback sprite
78  * groups. */
80  RealSpriteGroup() : SpriteGroup(SGT_REAL) {}
81 
82  /* Loaded = in motion, loading = not moving
83  * Each group contains several spritesets, for various loading stages */
84 
85  /* XXX: For stations the meaning is different - loaded is for stations
86  * with small amount of cargo whilst loading is for stations with a lot
87  * of da stuff. */
88 
89  std::vector<const SpriteGroup *> loaded;
90  std::vector<const SpriteGroup *> loading;
91 
92 protected:
93  const SpriteGroup *Resolve(ResolverObject &object) const;
94 };
95 
96 /* Shared by deterministic and random groups. */
98  VSG_BEGIN,
99 
100  VSG_SCOPE_SELF = VSG_BEGIN,
103 
104  VSG_END
105 };
107 
108 enum DeterministicSpriteGroupSize {
109  DSG_SIZE_BYTE,
110  DSG_SIZE_WORD,
111  DSG_SIZE_DWORD,
112 };
113 
114 enum DeterministicSpriteGroupAdjustType {
115  DSGA_TYPE_NONE,
116  DSGA_TYPE_DIV,
117  DSGA_TYPE_MOD,
118 };
119 
144 };
145 
146 
149  DeterministicSpriteGroupAdjustType type;
150  byte variable;
151  byte parameter;
152  byte shift_num;
153  uint32 and_mask;
154  uint32 add_val;
155  uint32 divmod_val;
156  const SpriteGroup *subroutine;
157 };
158 
159 
161  const SpriteGroup *group;
162  uint32 low;
163  uint32 high;
164 };
165 
166 
168  DeterministicSpriteGroup() : SpriteGroup(SGT_DETERMINISTIC) {}
169 
170  VarSpriteGroupScope var_scope;
171  DeterministicSpriteGroupSize size;
172  bool calculated_result;
173  std::vector<DeterministicSpriteGroupAdjust> adjusts;
174  std::vector<DeterministicSpriteGroupRange> ranges; // Dynamically allocated
175 
176  /* Dynamically allocated, this is the sole owner */
177  const SpriteGroup *default_group;
178 
179  const SpriteGroup *error_group; // was first range, before sorting ranges
180 
181 protected:
182  const SpriteGroup *Resolve(ResolverObject &object) const;
183 };
184 
185 enum RandomizedSpriteGroupCompareMode {
186  RSG_CMP_ANY,
187  RSG_CMP_ALL,
188 };
189 
191  RandomizedSpriteGroup() : SpriteGroup(SGT_RANDOMIZED) {}
192 
194 
195  RandomizedSpriteGroupCompareMode cmp_mode;
196  byte triggers;
197  byte count;
198 
200 
201  std::vector<const SpriteGroup *> groups;
202 
203 protected:
204  const SpriteGroup *Resolve(ResolverObject &object) const;
205 };
206 
207 
208 /* This contains a callback result. A failed callback has a value of
209  * CALLBACK_FAILED */
216  CallbackResultSpriteGroup(uint16 value, bool grf_version8) :
217  SpriteGroup(SGT_CALLBACK),
218  result(value)
219  {
220  /* Old style callback results (only valid for version < 8) have the highest byte 0xFF so signify it is a callback result.
221  * New style ones only have the highest bit set (allows 15-bit results, instead of just 8) */
222  if (!grf_version8 && (this->result >> 8) == 0xFF) {
223  this->result &= ~0xFF00;
224  } else {
225  this->result &= ~0x8000;
226  }
227  }
228 
229  uint16 result;
230  uint16 GetCallbackResult() const { return this->result; }
231 };
232 
233 
234 /* A result sprite group returns the first SpriteID and the number of
235  * sprites in the set */
243  ResultSpriteGroup(SpriteID sprite, byte num_sprites) :
244  SpriteGroup(SGT_RESULT),
245  sprite(sprite),
246  num_sprites(num_sprites)
247  {
248  }
249 
250  SpriteID sprite;
251  byte num_sprites;
252  SpriteID GetResult() const { return this->sprite; }
253  byte GetNumResults() const { return this->num_sprites; }
254 };
255 
260  TileLayoutSpriteGroup() : SpriteGroup(SGT_TILELAYOUT) {}
262 
263  NewGRFSpriteLayout dts;
264 
265  const DrawTileSprites *ProcessRegisters(uint8 *stage) const;
266 };
267 
269  IndustryProductionSpriteGroup() : SpriteGroup(SGT_INDUSTRY_PRODUCTION) {}
270 
271  uint8 version;
272  uint8 num_input;
275  uint8 num_output;
278  uint8 again;
279 
280 };
281 
290 
292  virtual ~ScopeResolver() {}
293 
294  virtual uint32 GetRandomBits() const;
295  virtual uint32 GetTriggers() const;
296 
297  virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
298  virtual void StorePSA(uint reg, int32 value);
299 };
300 
317  {
318  this->ResetState();
319  }
320 
321  virtual ~ResolverObject() {}
322 
324 
328 
329  uint32 last_value;
330 
332  uint32 used_triggers;
333  uint32 reseed[VSG_END];
334 
335  const GRFFile *grffile;
337 
343  {
344  return SpriteGroup::Resolve(this->root_spritegroup, *this);
345  }
346 
352  {
353  const SpriteGroup *result = Resolve();
354  return result != nullptr ? result->GetCallbackResult() : CALLBACK_FAILED;
355  }
356 
357  virtual const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const;
358 
359  virtual ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0);
360 
364  uint32 GetRemainingTriggers() const
365  {
366  return this->waiting_triggers & ~this->used_triggers;
367  }
368 
374  uint32 GetReseedSum() const
375  {
376  uint32 sum = 0;
377  for (VarSpriteGroupScope vsg = VSG_BEGIN; vsg < VSG_END; vsg++) {
378  sum |= this->reseed[vsg];
379  }
380  return sum;
381  }
382 
387  void ResetState()
388  {
389  this->last_value = 0;
390  this->waiting_triggers = 0;
391  this->used_triggers = 0;
392  memset(this->reseed, 0, sizeof(this->reseed));
393  }
394 
399  virtual GrfSpecFeature GetFeature() const { return GSF_INVALID; }
405  virtual uint32 GetDebugID() const { return 0; }
406 };
407 
408 #endif /* NEWGRF_SPRITEGROUP_H */
house_type.h
DSGA_OP_SCMP
@ DSGA_OP_SCMP
(signed) comparison (a < b -> 0, a == b = 1, a > b = 2)
Definition: newgrf_spritegroup.h:139
VarSpriteGroupScope
VarSpriteGroupScope
Definition: newgrf_spritegroup.h:97
ResolverObject::callback_param1
uint32 callback_param1
First parameter (var 10) of the callback.
Definition: newgrf_spritegroup.h:326
INDUSTRY_NUM_OUTPUTS
static const int INDUSTRY_NUM_OUTPUTS
Number of cargo types an industry can produce.
Definition: industry_type.h:39
DSGA_OP_STOP
@ DSGA_OP_STOP
store a into persistent storage, indexed by b, return a
Definition: newgrf_spritegroup.h:137
IndustryProductionSpriteGroup::subtract_input
int16 subtract_input[INDUSTRY_NUM_INPUTS]
Take this much of the input cargo (can be negative, is indirect in cb version 1+)
Definition: newgrf_spritegroup.h:273
DeterministicSpriteGroupRange
Definition: newgrf_spritegroup.h:160
newgrf_commons.h
DeterministicSpriteGroup
Definition: newgrf_spritegroup.h:167
DSGA_OP_SUB
@ DSGA_OP_SUB
a - b
Definition: newgrf_spritegroup.h:122
RandomizedSpriteGroup::Resolve
const SpriteGroup * Resolve(ResolverObject &object) const
Base sprite group resolver.
Definition: newgrf_spritegroup.cpp:260
INDUSTRY_NUM_INPUTS
static const int INDUSTRY_NUM_INPUTS
Number of cargo types an industry can accept.
Definition: industry_type.h:38
ScopeResolver::GetTriggers
virtual uint32 GetTriggers() const
Get the triggers.
Definition: newgrf_spritegroup.cpp:94
RandomizedSpriteGroup::cmp_mode
RandomizedSpriteGroupCompareMode cmp_mode
Check for these triggers:
Definition: newgrf_spritegroup.h:195
DeterministicSpriteGroupAdjust::parameter
byte parameter
Used for variables between 0x60 and 0x7F inclusive.
Definition: newgrf_spritegroup.h:151
IndustryProductionSpriteGroup::num_input
uint8 num_input
How many subtract_input values are valid.
Definition: newgrf_spritegroup.h:272
DSGA_OP_STO
@ DSGA_OP_STO
store a into temporary storage, indexed by b. return a
Definition: newgrf_spritegroup.h:135
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition: newgrf_spritegroup.h:307
DSGA_OP_AND
@ DSGA_OP_AND
a & b
Definition: newgrf_spritegroup.h:132
DSGA_OP_SMAX
@ DSGA_OP_SMAX
(signed) max(a, b)
Definition: newgrf_spritegroup.h:124
ResolverObject::grffile
const GRFFile * grffile
GRFFile the resolved SpriteGroup belongs to.
Definition: newgrf_spritegroup.h:335
ResolverObject::used_triggers
uint32 used_triggers
Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent)
Definition: newgrf_spritegroup.h:332
ScopeResolver::StorePSA
virtual void StorePSA(uint reg, int32 value)
Store a value into the persistent storage area (PSA).
Definition: newgrf_spritegroup.cpp:118
TileLayoutSpriteGroup::ProcessRegisters
const DrawTileSprites * ProcessRegisters(uint8 *stage) const
Process registers and the construction stage into the sprite layout.
Definition: newgrf_spritegroup.cpp:293
ResolverObject::ResolverObject
ResolverObject(const GRFFile *grffile, CallbackID callback=CBID_NO_CALLBACK, uint32 callback_param1=0, uint32 callback_param2=0)
Resolver constructor.
Definition: newgrf_spritegroup.h:315
GetRegister
static uint32 GetRegister(uint i)
Gets the value of a so-called newgrf "register".
Definition: newgrf_spritegroup.h:29
newgrf_callbacks.h
DSGA_OP_XOR
@ DSGA_OP_XOR
a ^ b
Definition: newgrf_spritegroup.h:134
DSGA_OP_ADD
@ DSGA_OP_ADD
a + b
Definition: newgrf_spritegroup.h:121
DSGA_OP_ROR
@ DSGA_OP_ROR
rotate a b positions to the right
Definition: newgrf_spritegroup.h:138
GSF_INVALID
@ GSF_INVALID
An invalid spec feature.
Definition: newgrf.h:92
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition: newgrf_callbacks.h:20
VSG_SCOPE_PARENT
@ VSG_SCOPE_PARENT
Related object of the resolved one.
Definition: newgrf_spritegroup.h:101
ResolverObject::GetRemainingTriggers
uint32 GetRemainingTriggers() const
Returns the waiting triggers that did not trigger any rerandomisation.
Definition: newgrf_spritegroup.h:364
ResolverObject::GetFeature
virtual GrfSpecFeature GetFeature() const
Get the feature number being resolved for.
Definition: newgrf_spritegroup.h:399
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition: newgrf_spritegroup.h:288
ResolverObject::reseed
uint32 reseed[VSG_END]
Collects bits to rerandomise while triggering triggers.
Definition: newgrf_spritegroup.h:333
newgrf_generic.h
ResolverObject::GetReseedSum
uint32 GetReseedSum() const
Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with.
Definition: newgrf_spritegroup.h:374
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition: newgrf_spritegroup.h:100
DeterministicSpriteGroupAdjustOperation
DeterministicSpriteGroupAdjustOperation
Definition: newgrf_spritegroup.h:120
RandomizedSpriteGroup::var_scope
VarSpriteGroupScope var_scope
Take this object:
Definition: newgrf_spritegroup.h:193
ScopeResolver::GetRandomBits
virtual uint32 GetRandomBits() const
Get a few random bits.
Definition: newgrf_spritegroup.cpp:85
DSGA_OP_OR
@ DSGA_OP_OR
a | b
Definition: newgrf_spritegroup.h:133
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
ResolverObject::GetDebugID
virtual uint32 GetDebugID() const
Get an identifier for the item being resolved.
Definition: newgrf_spritegroup.h:405
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:14
IndustryProductionSpriteGroup::num_output
uint8 num_output
How many add_output values are valid.
Definition: newgrf_spritegroup.h:275
RealSpriteGroup::loading
std::vector< const SpriteGroup * > loading
List of loading groups (can be SpriteIDs or Callback results)
Definition: newgrf_spritegroup.h:90
DSGA_OP_UMIN
@ DSGA_OP_UMIN
(unsigned) min(a, b)
Definition: newgrf_spritegroup.h:125
ResolverObject::callback_param2
uint32 callback_param2
Second parameter (var 18) of the callback.
Definition: newgrf_spritegroup.h:327
ResolverObject::waiting_triggers
uint32 waiting_triggers
Waiting triggers to be used by any rerandomisation. (scope independent)
Definition: newgrf_spritegroup.h:331
ResolverObject::default_scope
ScopeResolver default_scope
Default implementation of the grf scope.
Definition: newgrf_spritegroup.h:323
RealSpriteGroup::Resolve
const SpriteGroup * Resolve(ResolverObject &object) const
Base sprite group resolver.
Definition: newgrf_spritegroup.cpp:281
CallbackResultSpriteGroup
Definition: newgrf_spritegroup.h:210
CBID_NO_CALLBACK
@ CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
Definition: newgrf_callbacks.h:22
ResolverObject::root_spritegroup
const SpriteGroup * root_spritegroup
Root SpriteGroup to use for resolving.
Definition: newgrf_spritegroup.h:336
IndustryProductionSpriteGroup
Definition: newgrf_spritegroup.h:268
NewGRFSpriteLayout
NewGRF supplied spritelayout.
Definition: newgrf_commons.h:113
DrawTileSprites
Ground palette sprite of a tile, together with its sprite layout.
Definition: sprite.h:58
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Definition: newgrf_spritegroup.cpp:139
DSGA_OP_UDIV
@ DSGA_OP_UDIV
(unsigned) a / b
Definition: newgrf_spritegroup.h:129
industry_type.h
DSGA_OP_SHR
@ DSGA_OP_SHR
(unsigned) a >> b
Definition: newgrf_spritegroup.h:142
RealSpriteGroup::loaded
std::vector< const SpriteGroup * > loaded
List of loaded groups (can be SpriteIDs or Callback results)
Definition: newgrf_spritegroup.h:89
DeterministicSpriteGroup::Resolve
const SpriteGroup * Resolve(ResolverObject &object) const
Base sprite group resolver.
Definition: newgrf_spritegroup.cpp:192
IndustryProductionSpriteGroup::add_output
uint16 add_output[INDUSTRY_NUM_OUTPUTS]
Add this much output cargo when successful (unsigned, is indirect in cb version 1+)
Definition: newgrf_spritegroup.h:276
DeterministicSpriteGroupAdjust
Definition: newgrf_spritegroup.h:147
DSGA_OP_MUL
@ DSGA_OP_MUL
a * b
Definition: newgrf_spritegroup.h:131
GrfSpecFeature
GrfSpecFeature
Definition: newgrf.h:66
SpriteGroup::Resolve
virtual const SpriteGroup * Resolve(ResolverObject &object) const
Base sprite group resolver.
Definition: newgrf_spritegroup.h:61
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition: newgrf_callbacks.h:404
Pool
Base class for all pools.
Definition: pool_type.hpp:81
engine_type.h
DSGA_OP_UMOD
@ DSGA_OP_UMOD
(unsigned) a & b
Definition: newgrf_spritegroup.h:130
ResolverObject::ResetState
void ResetState()
Resets the dynamic state of the resolver object.
Definition: newgrf_spritegroup.h:387
RealSpriteGroup
Definition: newgrf_spritegroup.h:79
ResolverObject::Resolve
const SpriteGroup * Resolve()
Resolve SpriteGroup.
Definition: newgrf_spritegroup.h:342
DSGA_OP_SHL
@ DSGA_OP_SHL
a << b
Definition: newgrf_spritegroup.h:141
DSGA_OP_UMAX
@ DSGA_OP_UMAX
(unsigned) max(a, b)
Definition: newgrf_spritegroup.h:126
ResolverObject::callback
CallbackID callback
Callback being resolved.
Definition: newgrf_spritegroup.h:325
IndustryProductionSpriteGroup::version
uint8 version
Production callback version used, or 0xFF if marked invalid.
Definition: newgrf_spritegroup.h:271
VSG_SCOPE_RELATIVE
@ VSG_SCOPE_RELATIVE
Relative position (vehicles only)
Definition: newgrf_spritegroup.h:102
ScopeResolver::GetVariable
virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const
Get a variable value.
Definition: newgrf_spritegroup.cpp:106
DSGA_OP_SAR
@ DSGA_OP_SAR
(signed) a >> b
Definition: newgrf_spritegroup.h:143
DSGA_OP_SMIN
@ DSGA_OP_SMIN
(signed) min(a, b)
Definition: newgrf_spritegroup.h:123
CallbackResultSpriteGroup::CallbackResultSpriteGroup
CallbackResultSpriteGroup(uint16 value, bool grf_version8)
Creates a spritegroup representing a callback result.
Definition: newgrf_spritegroup.h:216
RandomizedSpriteGroup::lowest_randbit
byte lowest_randbit
Look for this in the per-object randomized bitmask:
Definition: newgrf_spritegroup.h:199
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
TemporaryStorageArray
Class for temporary storage of data.
Definition: newgrf_storage.h:150
IndustryProductionSpriteGroup::cargo_output
CargoID cargo_output[INDUSTRY_NUM_OUTPUTS]
Which output cargoes to add to (only cb version 2)
Definition: newgrf_spritegroup.h:277
DSGA_OP_UCMP
@ DSGA_OP_UCMP
(unsigned) comparison (a < b -> 0, a == b = 1, a > b = 2)
Definition: newgrf_spritegroup.h:140
ResultSpriteGroup::ResultSpriteGroup
ResultSpriteGroup(SpriteID sprite, byte num_sprites)
Creates a spritegroup representing a sprite number result.
Definition: newgrf_spritegroup.h:243
DSGA_OP_SMOD
@ DSGA_OP_SMOD
(signed) a % b
Definition: newgrf_spritegroup.h:128
ResolverObject::ResolveCallback
uint16 ResolveCallback()
Resolve callback.
Definition: newgrf_spritegroup.h:351
RandomizedSpriteGroup
Definition: newgrf_spritegroup.h:190
town_type.h
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition: newgrf_spritegroup.h:289
IndustryProductionSpriteGroup::cargo_input
CargoID cargo_input[INDUSTRY_NUM_INPUTS]
Which input cargoes to take from (only cb version 2)
Definition: newgrf_spritegroup.h:274
ResolverObject::last_value
uint32 last_value
Result of most recent DeterministicSpriteGroup (including procedure calls)
Definition: newgrf_spritegroup.h:329
ResolverObject::ResolveReal
virtual const SpriteGroup * ResolveReal(const RealSpriteGroup *group) const
Get the real sprites of the grf.
Definition: newgrf_spritegroup.cpp:125
ResultSpriteGroup
Definition: newgrf_spritegroup.h:236
DSGA_OP_RST
@ DSGA_OP_RST
return b
Definition: newgrf_spritegroup.h:136
newgrf_storage.h
Pool::PoolItem
Base class for all PoolItems.
Definition: pool_type.hpp:234
RandomizedSpriteGroup::groups
std::vector< const SpriteGroup * > groups
Take the group with appropriate index:
Definition: newgrf_spritegroup.h:201
SpriteGroup
Definition: newgrf_spritegroup.h:57
DSGA_OP_SDIV
@ DSGA_OP_SDIV
(signed) a / b
Definition: newgrf_spritegroup.h:127
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:105
TileLayoutSpriteGroup
Action 2 sprite layout for houses, industry tiles, objects and airport tiles.
Definition: newgrf_spritegroup.h:259