OpenTTD-patches/src/newgrf_town.h
Jonathan G Rennison ba34ec7ade Merge branch 'master' into jgrpp
Replace build and refit, and group collapse implementations
Fix template creation build and refit

# Conflicts:
#	Makefile.bundle.in
#	config.lib
#	src/animated_tile.cpp
#	src/blitter/32bpp_anim.hpp
#	src/blitter/32bpp_base.hpp
#	src/blitter/8bpp_base.hpp
#	src/blitter/null.hpp
#	src/build_vehicle_gui.cpp
#	src/command.cpp
#	src/command_func.h
#	src/console_gui.cpp
#	src/core/smallstack_type.hpp
#	src/date.cpp
#	src/debug.cpp
#	src/genworld_gui.cpp
#	src/ground_vehicle.hpp
#	src/group_gui.cpp
#	src/lang/korean.txt
#	src/linkgraph/linkgraph_gui.h
#	src/main_gui.cpp
#	src/misc_gui.cpp
#	src/network/core/game.h
#	src/network/core/packet.cpp
#	src/network/core/udp.cpp
#	src/network/core/udp.h
#	src/network/network_content.cpp
#	src/network/network_type.h
#	src/network/network_udp.cpp
#	src/newgrf_house.h
#	src/openttd.cpp
#	src/order_cmd.cpp
#	src/order_gui.cpp
#	src/os/unix/crashlog_unix.cpp
#	src/os/windows/crashlog_win.cpp
#	src/osk_gui.cpp
#	src/pathfinder/opf/opf_ship.cpp
#	src/rail_cmd.cpp
#	src/rail_gui.cpp
#	src/saveload/saveload.cpp
#	src/settings.cpp
#	src/settings_gui.cpp
#	src/smallmap_gui.h
#	src/station_base.h
#	src/station_cmd.cpp
#	src/table/gameopt_settings.ini
#	src/table/newgrf_debug_data.h
#	src/table/settings.ini
#	src/timetable_gui.cpp
#	src/toolbar_gui.cpp
#	src/train_gui.cpp
#	src/vehicle.cpp
#	src/vehicle_gui.cpp
#	src/vehiclelist.cpp
#	src/viewport.cpp
#	src/widgets/dropdown.cpp
#	src/window_gui.h
2019-03-27 18:12:04 +00:00

77 lines
2.8 KiB
C

/* $Id$ */
/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file newgrf_town.h Functions to handle the town part of NewGRF towns. */
#ifndef NEWGRF_TOWN_H
#define NEWGRF_TOWN_H
#include "town_type.h"
#include "newgrf_spritegroup.h"
/**
* Scope resolver for a town.
* @note Currently there is no direct town resolver; we only need to get town
* variable results from inside stations, house tiles and industries,
* and to check the town's persistent storage.
*/
struct TownScopeResolver : public ScopeResolver {
Town *t; ///< %Town of the scope.
bool readonly; ///< When set, persistent storage of the town is read-only,
/**
* Resolver of a town scope.
* @param ro Surrounding resolver.
* @param t %Town of the scope.
* @param readonly Scope may change persistent storage of the town.
*/
TownScopeResolver(ResolverObject &ro, Town *t, bool readonly)
: ScopeResolver(ro), t(t), readonly(readonly)
{
}
virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
virtual void StorePSA(uint reg, int32 value);
};
/**
* Fake scope resolver for nonexistent towns.
*
* The purpose of this class is to provide a house resolver for a given house type
* but not an actual house instatntion. We need this when e.g. drawing houses in
* GUI to keep backward compatibility with GRFs that were created before this
* functionality. When querying house sprites, certain GRF may read various town
* variables e.g. the population. Since the building doesn't exists and is not
* bounded to any town we have no real values that we can return. Instead of
* failing, this resolver will return fake values.
*/
struct FakeTownScopeResolver : public ScopeResolver {
FakeTownScopeResolver(ResolverObject &ro) : ScopeResolver(ro)
{ }
virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
};
/** Resolver of town properties. */
struct TownResolverObject : public ResolverObject {
TownScopeResolver town_scope; ///< Scope resolver specific for towns.
TownResolverObject(const struct GRFFile *grffile, Town *t, bool readonly);
ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override
{
switch (scope) {
case VSG_SCOPE_SELF: return &town_scope;
default: return ResolverObject::GetScope(scope, relative);
}
}
};
#endif /* NEWGRF_TOWN_H */