OpenTTD Source: src/newgrf_station.h Source File

OpenTTD Source 14.0-RC3

newgrf_station.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_STATION_H
11 #define NEWGRF_STATION_H
12
13 #include "newgrf_animation_type.h"
14 #include "newgrf_callbacks.h"
15 #include "newgrf_class.h"
16 #include "newgrf_commons.h"
17 #include "cargo_type.h"
18 #include "station_type.h"
19 #include "rail_type.h"
20 #include "newgrf_spritegroup.h"
21 #include "newgrf_town.h"
22
24 struct StationScopeResolver : public ScopeResolver {
25 TileIndex tile;
26 struct BaseStation *st;
27 const struct StationSpec *statspec;
28 CargoID cargo_type;
29 Axis axis;
30
38 StationScopeResolver(ResolverObject &ro, const StationSpec *statspec, BaseStation *st, TileIndex tile)
39 : ScopeResolver(ro), tile(tile), st(st), statspec(statspec), cargo_type(INVALID_CARGO), axis(INVALID_AXIS)
40 {
41 }
42
43 uint32_t GetRandomBits() const override;
44 uint32_t GetTriggers() const override;
45
46 uint32_t GetVariable(byte variable, [[maybe_unused]] uint32_t parameter, bool *available) const override;
47 };
48
50 struct StationResolverObject : public ResolverObject {
51 StationScopeResolver station_scope;
52 TownScopeResolver *town_scope;
53
54 StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile,
55 CallbackID callback = CBID_NO_CALLBACK, uint32_t callback_param1 = 0, uint32_t callback_param2 = 0);
56 ~StationResolverObject();
57
58 TownScopeResolver *GetTown();
59
60 ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override
61 {
62 switch (scope) {
63 case VSG_SCOPE_SELF:
64 return &this->station_scope;
65
66 case VSG_SCOPE_PARENT: {
67 TownScopeResolver *tsr = this->GetTown();
68 if (tsr != nullptr) return tsr;
69 [[fallthrough]];
70 }
71
72 default:
73 return ResolverObject::GetScope(scope, relative);
74 }
75 }
76
77 const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const override;
78
79 GrfSpecFeature GetFeature() const override;
80 uint32_t GetDebugID() const override;
81 };
82
83 enum StationClassID : byte {
84 STAT_CLASS_BEGIN = 0,
85 STAT_CLASS_DFLT = 0,
86 STAT_CLASS_WAYP,
87 STAT_CLASS_MAX = 255,
88 };
89
91 DECLARE_POSTFIX_INCREMENT(StationClassID)
92
93 enum StationSpecFlags {
94 SSF_SEPARATE_GROUND,
95 SSF_DIV_BY_STATION_SIZE,
96 SSF_CB141_RANDOM_BITS,
97 SSF_CUSTOM_FOUNDATIONS,
98 SSF_EXTENDED_FOUNDATIONS,
99 };
100
102 enum StationRandomTrigger {
103 SRT_NEW_CARGO,
104 SRT_CARGO_TAKEN,
105 SRT_TRAIN_ARRIVES,
106 SRT_TRAIN_DEPARTS,
107 SRT_TRAIN_LOADS,
108 SRT_PATH_RESERVATION,
109 };
110
112 struct StationSpec {
113 StationSpec() : cls_id(STAT_CLASS_DFLT), name(0),
114 disallowed_platforms(0), disallowed_lengths(0),
115 cargo_threshold(0), cargo_triggers(0),
116 callback_mask(0), flags(0), pylons(0), wires(0), blocked(0),
117 animation({0, 0, 0, 0}) {}
124 GRFFilePropsBase<NUM_CARGO + 3> grf_prop;
125 StationClassID cls_id;
126 StringID name;
127
132 byte disallowed_platforms;
137 byte disallowed_lengths;
138
147 std::vector<NewGRFSpriteLayout> renderdata;
148
153 uint16_t cargo_threshold;
154
155 CargoTypes cargo_triggers;
156
157 byte callback_mask;
158
159 byte flags;
160
161 byte pylons;
162 byte wires;
163 byte blocked;
164
165 AnimationInfo animation;
166
175 std::vector<std::vector<std::vector<byte>>> layouts;
176 };
177
179 typedef NewGRFClass<StationSpec, StationClassID, STAT_CLASS_MAX> StationClass;
180
181 const StationSpec *GetStationSpec(TileIndex t);
182
183 /* Evaluate a tile's position within a station, and return the result a bitstuffed format. */
184 uint32_t GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred);
185
186 SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32_t var10 = 0);
187 SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info);
188 uint16_t GetStationCallback(CallbackID callback, uint32_t param1, uint32_t param2, const StationSpec *statspec, BaseStation *st, TileIndex tile);
189 CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, byte plat_len, byte numtracks);
190
191 /* Allocate a StationSpec to a Station. This is called once per build operation. */
192 int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec);
193
194 /* Deallocate a StationSpec from a Station. Called when removing a single station tile. */
195 void DeallocateSpecFromStation(BaseStation *st, byte specindex);
196
197 /* Draw representation of a station tile for GUI purposes. */
198 bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station);
199
200 void AnimateStationTile(TileIndex tile);
201 void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type = INVALID_CARGO);
202 void TriggerStationRandomisation(Station *st, TileIndex tile, StationRandomTrigger trigger, CargoID cargo_type = INVALID_CARGO);
203 void StationUpdateCachedTriggers(BaseStation *st);
204
205 #endif /* NEWGRF_STATION_H */
VarSpriteGroupScope
VarSpriteGroupScope
Definition: newgrf_spritegroup.h:97
StationScopeResolver::cargo_type
CargoID cargo_type
Type of cargo of the station.
Definition: newgrf_station.h:28
StationUpdateCachedTriggers
void StationUpdateCachedTriggers(BaseStation *st)
Update the cached animation trigger bitmask for a station.
Definition: newgrf_station.cpp:998
StationSpec::flags
byte flags
Bitmask of flags, bit 0: use different sprite set; bit 1: divide cargo about by station size.
Definition: newgrf_station.h:159
StationClass
NewGRFClass< StationSpec, StationClassID, STAT_CLASS_MAX > StationClass
Struct containing information relating to station classes.
Definition: newgrf_station.h:179
StationSpec::renderdata
std::vector< NewGRFSpriteLayout > renderdata
Number of tile layouts.
Definition: newgrf_station.h:147
newgrf_commons.h
SSF_EXTENDED_FOUNDATIONS
@ SSF_EXTENDED_FOUNDATIONS
Extended foundation block instead of simple.
Definition: newgrf_station.h:98
StationRandomTrigger
StationRandomTrigger
Randomisation triggers for stations.
Definition: newgrf_station.h:102
Axis
Axis
Allow incrementing of DiagDirDiff variables.
Definition: direction_type.h:116
Station
Station data structure.
Definition: station_base.h:442
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
SSF_DIV_BY_STATION_SIZE
@ SSF_DIV_BY_STATION_SIZE
Divide cargo amount by station size.
Definition: newgrf_station.h:95
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition: newgrf_spritegroup.h:307
StationResolverObject::GetScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0) override
Get a resolver for the scope.
Definition: newgrf_station.h:60
AnimationInfo
Information about animation.
Definition: newgrf_animation_type.h:18
StationScopeResolver::statspec
const struct StationSpec * statspec
Station (type) specification.
Definition: newgrf_station.h:27
GetPlatformInfo
uint32_t GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred)
Evaluate a tile's position within a station, and return the result in a bit-stuffed format.
Definition: newgrf_station.cpp:103
newgrf_callbacks.h
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition: newgrf_callbacks.h:20
StationScopeResolver::GetTriggers
uint32_t GetTriggers() const override
Get the triggers.
Definition: newgrf_station.cpp:228
VSG_SCOPE_PARENT
@ VSG_SCOPE_PARENT
Related object of the resolved one.
Definition: newgrf_spritegroup.h:101
STAT_CLASS_BEGIN
@ STAT_CLASS_BEGIN
the lowest valid value
Definition: newgrf_station.h:84
StationResolverObject::station_scope
StationScopeResolver station_scope
The station scope resolver.
Definition: newgrf_station.h:51
StationResolverObject::GetTown
TownScopeResolver * GetTown()
Get the town scope associated with a station, if it exists.
Definition: newgrf_station.cpp:254
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition: newgrf_spritegroup.h:288
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition: newgrf_spritegroup.h:100
SSF_SEPARATE_GROUND
@ SSF_SEPARATE_GROUND
Use different sprite set for ground sprites.
Definition: newgrf_station.h:94
SSF_CB141_RANDOM_BITS
@ SSF_CB141_RANDOM_BITS
Callback 141 needs random bits.
Definition: newgrf_station.h:96
DeallocateSpecFromStation
void DeallocateSpecFromStation(BaseStation *st, byte specindex)
Deallocate a StationSpec from a Station.
Definition: newgrf_station.cpp:731
StationScopeResolver::StationScopeResolver
StationScopeResolver(ResolverObject &ro, const StationSpec *statspec, BaseStation *st, TileIndex tile)
Constructor for station scopes.
Definition: newgrf_station.h:38
StationSpec::cls_id
StationClassID cls_id
The class to which this spec belongs.
Definition: newgrf_station.h:125
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:14
StationResolverObject::StationResolverObject
StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
Resolver for stations.
Definition: newgrf_station.cpp:568
RailType
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
STAT_CLASS_WAYP
@ STAT_CLASS_WAYP
Waypoint class.
Definition: newgrf_station.h:86
CommandCost
Common return value for all commands.
Definition: command_type.h:23
StationScopeResolver
Scope resolver for stations.
Definition: newgrf_station.h:24
StationScopeResolver::GetVariable
uint32_t GetVariable(byte variable, [[maybe_unused]] uint32_t parameter, bool *available) const override
Get a variable value.
Definition: newgrf_station.cpp:269
StationSpec::layouts
std::vector< std::vector< std::vector< byte > > > layouts
Custom platform layouts.
Definition: newgrf_station.h:175
StationResolverObject::town_scope
TownScopeResolver * town_scope
The town scope resolver (created on the first call).
Definition: newgrf_station.h:52
StationSpec::pylons
byte pylons
Bitmask of base tiles (0 - 7) which should contain elrail pylons.
Definition: newgrf_station.h:161
CBID_NO_CALLBACK
@ CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
Definition: newgrf_callbacks.h:22
cargo_type.h
GetCustomStationRelocation
SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32_t var10=0)
Resolve sprites for drawing a station tile.
Definition: newgrf_station.cpp:615
NewGRFClass
Struct containing information relating to NewGRF classes for stations and airports.
Definition: newgrf_class.h:20
SRT_NEW_CARGO
@ SRT_NEW_CARGO
Trigger station on new cargo arrival.
Definition: newgrf_station.h:103
StationSpec::cargo_threshold
uint16_t cargo_threshold
Cargo threshold for choosing between little and lots of cargo.
Definition: newgrf_station.h:153
StationSpec::name
StringID name
Name of this station.
Definition: newgrf_station.h:126
StationSpecFlags
StationSpecFlags
Allow incrementing of StationClassID variables.
Definition: newgrf_station.h:93
STAT_CLASS_MAX
@ STAT_CLASS_MAX
Maximum number of classes.
Definition: newgrf_station.h:87
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Definition: newgrf_spritegroup.cpp:135
SRT_TRAIN_DEPARTS
@ SRT_TRAIN_DEPARTS
Trigger platform when train leaves.
Definition: newgrf_station.h:106
TownScopeResolver
Scope resolver for a town.
Definition: newgrf_town.h:22
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
StationResolverObject::GetDebugID
uint32_t GetDebugID() const override
Get an identifier for the item being resolved.
Definition: newgrf_station.cpp:554
StationSpec::disallowed_platforms
byte disallowed_platforms
Bitmask of number of platforms available for the station.
Definition: newgrf_station.h:132
StationResolverObject::ResolveReal
const SpriteGroup * ResolveReal(const RealSpriteGroup *group) const override
Get the real sprites of the grf.
Definition: newgrf_station.cpp:504
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
AllocateSpecToStation
int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec)
Allocate a StationSpec to a Station.
Definition: newgrf_station.cpp:689
PerformStationTileSlopeCheck
CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, byte plat_len, byte numtracks)
Check the slope of a tile of a new station.
Definition: newgrf_station.cpp:661
StationScopeResolver::axis
Axis axis
Station axis, used only for the slope check callback.
Definition: newgrf_station.h:29
newgrf_spritegroup.h
SSF_CUSTOM_FOUNDATIONS
@ SSF_CUSTOM_FOUNDATIONS
Draw custom foundations.
Definition: newgrf_station.h:97
newgrf_town.h
GrfSpecFeature
GrfSpecFeature
Definition: newgrf.h:66
SRT_CARGO_TAKEN
@ SRT_CARGO_TAKEN
Trigger station when cargo is completely taken.
Definition: newgrf_station.h:104
StationSpec
Station specification.
Definition: newgrf_station.h:112
INVALID_AXIS
@ INVALID_AXIS
Flag for an invalid Axis.
Definition: direction_type.h:120
ResolverObject::callback_param2
uint32_t callback_param2
Second parameter (var 18) of the callback.
Definition: newgrf_spritegroup.h:327
newgrf_class.h
RealSpriteGroup
Definition: newgrf_spritegroup.h:79
StationAnimationTrigger
StationAnimationTrigger
Animation triggers for station.
Definition: newgrf_animation_type.h:26
DrawStationTile
bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station)
Draw representation of a station tile for GUI purposes.
Definition: newgrf_station.cpp:779
StationScopeResolver::st
struct BaseStation * st
Instance of the station.
Definition: newgrf_station.h:26
StationClassID
StationClassID
Definition: newgrf_station.h:83
ResolverObject::callback
CallbackID callback
Callback being resolved.
Definition: newgrf_spritegroup.h:325
ResolverObject::callback_param1
uint32_t callback_param1
First parameter (var 10) of the callback.
Definition: newgrf_spritegroup.h:326
BaseStation
Base class for all station-ish types.
Definition: base_station_base.h:64
rail_type.h
TriggerStationRandomisation
void TriggerStationRandomisation(Station *st, TileIndex tile, StationRandomTrigger trigger, CargoID cargo_type=INVALID_CARGO)
Trigger station randomisation.
Definition: newgrf_station.cpp:923
SRT_PATH_RESERVATION
@ SRT_PATH_RESERVATION
Trigger platform when train reserves path.
Definition: newgrf_station.h:108
StationSpec::grf_prop
GRFFilePropsBase< NUM_CARGO+3 > grf_prop
Properties related the the grf file.
Definition: newgrf_station.h:124
StationResolverObject
Station resolver.
Definition: newgrf_station.h:50
StationSpec::callback_mask
byte callback_mask
Bitmask of station callbacks that have to be called.
Definition: newgrf_station.h:157
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition: newgrf_spritegroup.h:289
StationSpec::disallowed_lengths
byte disallowed_lengths
Bitmask of platform lengths available for the station.
Definition: newgrf_station.h:137
newgrf_animation_type.h
STAT_CLASS_DFLT
@ STAT_CLASS_DFLT
Default station class.
Definition: newgrf_station.h:85
GetCustomStationFoundationRelocation
SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info)
Resolve the sprites for custom station foundations.
Definition: newgrf_station.cpp:632
GRFFilePropsBase< NUM_CARGO+3 >
SRT_TRAIN_ARRIVES
@ SRT_TRAIN_ARRIVES
Trigger platform when train arrives.
Definition: newgrf_station.h:105
StationSpec::cargo_triggers
CargoTypes cargo_triggers
Bitmask of cargo types which cause trigger re-randomizing.
Definition: newgrf_station.h:155
StationScopeResolver::tile
TileIndex tile
Tile of the station.
Definition: newgrf_station.h:25
SpriteGroup
Definition: newgrf_spritegroup.h:57
StationSpec::wires
byte wires
Bitmask of base tiles (0 - 7) which should contain elrail wires.
Definition: newgrf_station.h:162
StationSpec::blocked
byte blocked
Bitmask of base tiles (0 - 7) which are blocked to trains.
Definition: newgrf_station.h:163
StationScopeResolver::GetRandomBits
uint32_t GetRandomBits() const override
Get a few random bits.
Definition: newgrf_station.cpp:222
SRT_TRAIN_LOADS
@ SRT_TRAIN_LOADS
Trigger platform when train loads/unloads.
Definition: newgrf_station.h:107
station_type.h
StationResolverObject::GetFeature
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Definition: newgrf_station.cpp:549