OpenTTD
newgrf_town.h
Go to the documentation of this file.
1 /* $Id: newgrf_town.h 27984 2018-03-11 13:19:41Z frosch $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #ifndef NEWGRF_TOWN_H
13 #define NEWGRF_TOWN_H
14 
15 #include "town_type.h"
16 #include "newgrf_spritegroup.h"
17 
25  Town *t;
26  bool readonly;
27 
34  TownScopeResolver(ResolverObject &ro, Town *t, bool readonly)
35  : ScopeResolver(ro), t(t), readonly(readonly)
36  {
37  }
38 
39  virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
40  virtual void StorePSA(uint reg, int32 value);
41 };
42 
46 
47  TownResolverObject(const struct GRFFile *grffile, Town *t, bool readonly);
48 
49  /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
50  {
51  switch (scope) {
52  case VSG_SCOPE_SELF: return &town_scope;
53  default: return ResolverObject::GetScope(scope, relative);
54  }
55  }
56 };
57 
58 #endif /* NEWGRF_TOWN_H */
Resolver of town properties.
Definition: newgrf_town.h:44
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope)...
ResolverObject & ro
Surrounding resolver object.
Types related to towns.
VarSpriteGroupScope
TownScopeResolver(ResolverObject &ro, Town *t, bool readonly)
Resolver of a town scope.
Definition: newgrf_town.h:34
Interface for SpriteGroup-s to access the gamestate.
bool readonly
When set, persistent storage of the town is read-only,.
Definition: newgrf_town.h:26
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const
Get a variable value.
Definition: newgrf_town.cpp:19
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Definition: newgrf_town.h:49
Action 2 handling.
Scope resolver for a town.
Definition: newgrf_town.h:24
Resolved object itself.
Town * t
Town of the scope.
Definition: newgrf_town.h:25
TownScopeResolver town_scope
Scope resolver specific for towns.
Definition: newgrf_town.h:45
Town data structure.
Definition: town.h:55
virtual void StorePSA(uint reg, int32 value)
Store a value into the persistent storage area (PSA).
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:104