OpenTTD
newgrf_roadtype.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_ROADTYPE_H
11 #define NEWGRF_ROADTYPE_H
12 
13 #include "road.h"
14 #include "newgrf_commons.h"
15 #include "newgrf_spritegroup.h"
16 
21 
23 
24  /* virtual */ uint32 GetRandomBits() const;
25  /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
26 };
27 
31 
32  RoadTypeResolverObject(const RoadTypeInfo *rti, TileIndex tile, TileContext context, RoadTypeSpriteGroup rtsg, uint32 param1 = 0, uint32 param2 = 0);
33 
34  /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
35  {
36  switch (scope) {
37  case VSG_SCOPE_SELF: return &this->roadtype_scope;
38  default: return ResolverObject::GetScope(scope, relative);
39  }
40  }
41 
42  /* virtual */ const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const;
43 };
44 
46 
47 uint8 GetReverseRoadTypeTranslation(RoadType roadtype, const GRFFile *grffile);
48 
49 #endif /* NEWGRF_ROADTYPE_H */
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope)...
ResolverObject & ro
Surrounding resolver object.
VarSpriteGroupScope
RoadTypeSpriteGroup
Sprite groups for a roadtype.
Definition: road.h:57
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Interface for SpriteGroup-s to access the gamestate.
Road specific functions.
TileContext context
Are we resolving sprites for the upper halftile, or on a bridge?
Resolver for the railtype scope.
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
uint32 GetRandomBits() const
Get a few random bits.
Nothing special.
RoadType
The different roadtypes we support.
Definition: road_type.h:22
SpriteID GetCustomRoadSprite(const RoadTypeInfo *rti, TileIndex tile, RoadTypeSpriteGroup rtsg, TileContext context=TCX_NORMAL, uint *num_results=nullptr)
Get the sprite to draw for the given tile.
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const
Get a variable value.
Action 2 handling.
uint8 GetReverseRoadTypeTranslation(RoadType roadtype, const GRFFile *grffile)
Perform a reverse roadtype lookup to get the GRF internal ID.
TileIndex tile
Tracktile. For track on a bridge this is the southern bridgehead.
Resolved object itself.
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
RoadTypeScopeResolver roadtype_scope
Resolver for the roadtype scope.
Resolver object for road types.
RoadTypeScopeResolver(ResolverObject &ro, TileIndex tile, TileContext context)
Constructor of the roadtype scope resolvers.
This file simplyfies and embeds a common mechanism of loading/saving and mapping of grf entities...
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:105
TileContext
Context for tile accesses.