OpenTTD Source: src/newgrf_town.h Source File

OpenTTD Source 15.0-beta1

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
22 struct TownScopeResolver : public ScopeResolver {
23 Town *t;
24 bool readonly;
25
32 TownScopeResolver(ResolverObject &ro, Town *t, bool readonly)
33 : ScopeResolver(ro), t(t), readonly(readonly)
34 {
35 }
36
37 uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
38 void StorePSA(uint reg, int32_t value) override;
39};
40
42 struct TownResolverObject : public ResolverObject {
43 TownScopeResolver town_scope;
44
45 TownResolverObject(const struct GRFFile *grffile, Town *t, bool readonly);
46
47 ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t 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 */
newgrf_spritegroup.h
Action 2 handling.
VarSpriteGroupScope
VarSpriteGroupScope
Definition newgrf_spritegroup.h:97
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition newgrf_spritegroup.h:100
GRFFile
Dynamic data of a loaded NewGRF.
Definition newgrf.h:108
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition newgrf_spritegroup.h:296
ResolverObject::grffile
const GRFFile * grffile
GRFFile the resolved SpriteGroup belongs to.
Definition newgrf_spritegroup.h:324
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0)
Get a resolver for the scope.
Definition newgrf_spritegroup.cpp:135
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition newgrf_spritegroup.h:277
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition newgrf_spritegroup.h:278
TownResolverObject
Resolver of town properties.
Definition newgrf_town.h:42
TownResolverObject::town_scope
TownScopeResolver town_scope
Scope resolver specific for towns.
Definition newgrf_town.h:43
TownResolverObject::GetScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
Get a resolver for the scope.
Definition newgrf_town.h:47
TownScopeResolver
Scope resolver for a town.
Definition newgrf_town.h:22
TownScopeResolver::GetVariable
uint32_t GetVariable(uint8_t variable, uint32_t parameter, bool &available) const override
Get a variable value.
Definition newgrf_town.cpp:18
TownScopeResolver::readonly
bool readonly
When set, persistent storage of the town is read-only,.
Definition newgrf_town.h:24
TownScopeResolver::StorePSA
void StorePSA(uint reg, int32_t value) override
Store a value into the persistent storage area (PSA).
Definition newgrf_town.cpp:126
TownScopeResolver::TownScopeResolver
TownScopeResolver(ResolverObject &ro, Town *t, bool readonly)
Resolver of a town scope.
Definition newgrf_town.h:32
TownScopeResolver::t
Town * t
Town of the scope.
Definition newgrf_town.h:23
Town
Town data structure.
Definition town.h:54
town_type.h
Types related to towns.