OpenTTD Source  1.11.0-beta2
newgrf_town.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_TOWN_H
11 #define NEWGRF_TOWN_H
12 
13 #include "town_type.h"
14 #include "newgrf_spritegroup.h"
15 
23  Town *t;
24  bool readonly;
25 
34  {
35  }
36 
37  virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
38  virtual void StorePSA(uint reg, int32 value);
39 };
40 
44 
45  TownResolverObject(const struct GRFFile *grffile, Town *t, bool readonly);
46 
47  ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override
48  {
49  switch (scope) {
50  case VSG_SCOPE_SELF: return &town_scope;
51  default: return ResolverObject::GetScope(scope, relative);
52  }
53  }
54 };
55 
56 #endif /* NEWGRF_TOWN_H */
VarSpriteGroupScope
VarSpriteGroupScope
Definition: newgrf_spritegroup.h:100
TownScopeResolver::t
Town * t
Town of the scope.
Definition: newgrf_town.h:23
TownResolverObject::town_scope
TownScopeResolver town_scope
Scope resolver specific for towns.
Definition: newgrf_town.h:43
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition: newgrf_spritegroup.h:315
ResolverObject::grffile
const GRFFile * grffile
GRFFile the resolved SpriteGroup belongs to.
Definition: newgrf_spritegroup.h:343
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition: newgrf_spritegroup.h:296
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition: newgrf_spritegroup.h:103
TownScopeResolver::readonly
bool readonly
When set, persistent storage of the town is read-only,.
Definition: newgrf_town.h:24
TownResolverObject::GetScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0) override
Get a resolver for the scope.
Definition: newgrf_town.h:47
TownResolverObject
Resolver of town properties.
Definition: newgrf_town.h:42
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Definition: newgrf_spritegroup.cpp:153
TownScopeResolver
Scope resolver for a town.
Definition: newgrf_town.h:22
TownResolverObject::TownResolverObject
TownResolverObject(const struct GRFFile *grffile, Town *t, bool readonly)
Resolver for a town.
Definition: newgrf_town.cpp:157
newgrf_spritegroup.h
TownScopeResolver::TownScopeResolver
TownScopeResolver(ResolverObject &ro, Town *t, bool readonly)
Resolver of a town scope.
Definition: newgrf_town.h:32
Town
Town data structure.
Definition: town.h:50
town_type.h
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition: newgrf_spritegroup.h:297
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:105
TownScopeResolver::StorePSA
virtual void StorePSA(uint reg, int32 value)
Store a value into the persistent storage area (PSA).
Definition: newgrf_town.cpp:120
TownScopeResolver::GetVariable
virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const
Get a variable value.
Definition: newgrf_town.cpp:17