OpenTTD Source  20241120-master-g6d3adc6169
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 "core/enum_type.hpp"
14 #include "newgrf_animation_type.h"
15 #include "newgrf_callbacks.h"
16 #include "newgrf_class.h"
17 #include "newgrf_commons.h"
18 #include "cargo_type.h"
19 #include "station_type.h"
20 #include "rail_type.h"
21 #include "newgrf_spritegroup.h"
22 #include "newgrf_town.h"
23 
27  struct BaseStation *st;
28  const struct StationSpec *statspec;
31 
41  {
42  }
43 
44  uint32_t GetRandomBits() const override;
45  uint32_t GetTriggers() const override;
46 
47  uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
48 };
49 
53  std::optional<TownScopeResolver> town_scope = std::nullopt;
54 
55  StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile,
57 
59 
60  ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t 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 static const uint32_t STATION_CLASS_LABEL_DEFAULT = 'DFLT';
84 static const uint32_t STATION_CLASS_LABEL_WAYPOINT = 'WAYP';
85 
86 enum StationClassID : uint16_t {
90  STAT_CLASS_MAX = UINT16_MAX,
91 };
92 
95 
102 };
103 
112 };
113 
115 struct StationSpec : NewGRFSpecBase<StationClassID> {
116  StationSpec() : name(0),
119  callback_mask(0), flags(0),
120  animation({0, 0, 0, 0}) {}
129 
140 
149  std::vector<NewGRFSpriteLayout> renderdata;
150 
155  uint16_t cargo_threshold;
156 
157  CargoTypes cargo_triggers;
158 
159  uint8_t callback_mask;
160 
161  uint8_t flags;
162 
163  enum class TileFlags : uint8_t {
164  None = 0,
165  Pylons = 1U << 0,
166  NoWires = 1U << 1,
167  Blocked = 1U << 2,
168  };
169  std::vector<TileFlags> tileflags;
170 
171  AnimationInfo animation;
172 
174  std::unordered_map<uint16_t, std::vector<uint8_t>> layouts;
175 };
177 
180 
181 const StationSpec *GetStationSpec(TileIndex t);
182 
189 inline uint16_t GetStationLayoutKey(uint8_t platforms, uint8_t length)
190 {
191  return (length << 8U) | platforms;
192 }
193 
199 inline bool IsWaypointClass(const StationClass &cls)
200 {
201  return cls.global_id == STATION_CLASS_LABEL_WAYPOINT || GB(cls.global_id, 24, 8) == UINT8_MAX;
202 }
203 
204 /* Evaluate a tile's position within a station, and return the result a bitstuffed format. */
205 uint32_t GetPlatformInfo(Axis axis, uint8_t tile, int platforms, int length, int x, int y, bool centred);
206 
207 SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32_t var10 = 0);
208 SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info);
209 uint16_t GetStationCallback(CallbackID callback, uint32_t param1, uint32_t param2, const StationSpec *statspec, BaseStation *st, TileIndex tile);
210 CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, uint8_t plat_len, uint8_t numtracks);
211 
212 /* Allocate a StationSpec to a Station. This is called once per build operation. */
213 int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec);
214 
215 /* Deallocate a StationSpec from a Station. Called when removing a single station tile. */
216 void DeallocateSpecFromStation(BaseStation *st, uint8_t specindex);
217 
218 /* Draw representation of a station tile for GUI purposes. */
219 bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station);
220 
221 void AnimateStationTile(TileIndex tile);
222 void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type = INVALID_CARGO);
223 void TriggerStationRandomisation(Station *st, TileIndex tile, StationRandomTrigger trigger, CargoID cargo_type = INVALID_CARGO);
225 
226 #endif /* NEWGRF_STATION_H */
constexpr static debug_inline uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Types related to cargoes...
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
Common return value for all commands.
Definition: command_type.h:23
Struct containing information relating to NewGRF classes for stations and airports.
Definition: newgrf_class.h:26
uint32_t global_id
Global ID for class, e.g. 'DFLT', 'WAYP', etc.
Definition: newgrf_class.h:48
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Axis
Allow incrementing of DiagDirDiff variables.
@ INVALID_AXIS
Flag for an invalid Axis.
@ None
No flag set.
Type (helpers) for enums.
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:18
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:18
GrfSpecFeature
Definition: newgrf.h:67
Definitions related to NewGRF animation.
StationAnimationTrigger
Animation triggers for station.
Callbacks that NewGRFs could implement.
CallbackID
List of implemented NewGRF callbacks.
@ CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
Header file for classes to be used by e.g.
This file simplyfies and embeds a common mechanism of loading/saving and mapping of grf entities.
Action 2 handling.
VarSpriteGroupScope
@ VSG_SCOPE_SELF
Resolved object itself.
@ VSG_SCOPE_PARENT
Related object of the resolved one.
int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec)
Allocate a StationSpec to a Station.
uint32_t GetPlatformInfo(Axis axis, uint8_t 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.
SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32_t var10=0)
Resolve sprites for drawing a station tile.
StationSpecFlags
Allow incrementing of StationClassID variables.
@ SSF_SEPARATE_GROUND
Use different sprite set for ground sprites.
@ SSF_CB141_RANDOM_BITS
Callback 141 needs random bits.
@ SSF_CUSTOM_FOUNDATIONS
Draw custom foundations.
@ SSF_EXTENDED_FOUNDATIONS
Extended foundation block instead of simple.
@ SSF_DIV_BY_STATION_SIZE
Divide cargo amount by station size.
SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info)
Resolve the sprites for custom station foundations.
uint16_t GetStationLayoutKey(uint8_t platforms, uint8_t length)
Get the station layout key for a given station layout size.
void TriggerStationRandomisation(Station *st, TileIndex tile, StationRandomTrigger trigger, CargoID cargo_type=INVALID_CARGO)
Trigger station randomisation.
void StationUpdateCachedTriggers(BaseStation *st)
Update the cached animation trigger bitmask for a station.
bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station)
Draw representation of a station tile for GUI purposes.
void DeallocateSpecFromStation(BaseStation *st, uint8_t specindex)
Deallocate a StationSpec from a Station.
CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, uint8_t plat_len, uint8_t numtracks)
Check the slope of a tile of a new station.
StationRandomTrigger
Randomisation triggers for stations.
@ SRT_TRAIN_LOADS
Trigger platform when train loads/unloads.
@ SRT_TRAIN_ARRIVES
Trigger platform when train arrives.
@ SRT_CARGO_TAKEN
Trigger station when cargo is completely taken.
@ SRT_TRAIN_DEPARTS
Trigger platform when train leaves.
@ SRT_PATH_RESERVATION
Trigger platform when train reserves path.
@ SRT_NEW_CARGO
Trigger station on new cargo arrival.
bool IsWaypointClass(const StationClass &cls)
Test if a StationClass is the waypoint class.
StationClassID
@ STAT_CLASS_MAX
Maximum number of classes.
@ STAT_CLASS_BEGIN
the lowest valid value
@ STAT_CLASS_DFLT
Default station class.
@ STAT_CLASS_WAYP
Waypoint class.
Functions to handle the town part of NewGRF towns.
The different types of rail.
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
Types related to stations.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Information about animation.
Base class for all station-ish types.
Interface for SpriteGroup-s to access the gamestate.
uint32_t callback_param2
Second parameter (var 18) of the callback.
CallbackID callback
Callback being resolved.
uint32_t callback_param1
First parameter (var 10) of the callback.
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0)
Get a resolver for the scope.
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
ResolverObject & ro
Surrounding resolver object.
Station resolver.
StationScopeResolver station_scope
The station scope resolver.
uint32_t GetDebugID() const override
Get an identifier for the item being resolved.
TownScopeResolver * GetTown()
Get the town scope associated with a station, if it exists.
std::optional< TownScopeResolver > town_scope
The town scope resolver (created on the first call).
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.
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
Get a resolver for the scope.
const SpriteGroup * ResolveReal(const RealSpriteGroup *group) const override
Get the real sprites of the grf.
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Scope resolver for stations.
uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override
Get a variable value.
struct BaseStation * st
Instance of the station.
uint32_t GetTriggers() const override
Get the triggers.
uint32_t GetRandomBits() const override
Get a few random bits.
StationScopeResolver(ResolverObject &ro, const StationSpec *statspec, BaseStation *st, TileIndex tile)
Constructor for station scopes.
const struct StationSpec * statspec
Station (type) specification.
Axis axis
Station axis, used only for the slope check callback.
TileIndex tile
Tile of the station.
CargoID cargo_type
Type of cargo of the station.
Station specification.
uint8_t callback_mask
Bitmask of station callbacks that have to be called.
uint8_t disallowed_lengths
Bitmask of platform lengths available for the station.
StringID name
Name of this station.
uint8_t disallowed_platforms
Bitmask of number of platforms available for the station.
uint8_t flags
Bitmask of flags, bit 0: use different sprite set; bit 1: divide cargo about by station size.
uint16_t cargo_threshold
Cargo threshold for choosing between little and lots of cargo.
std::unordered_map< uint16_t, std::vector< uint8_t > > layouts
Custom platform layouts, keyed by platform and length combined.
@ NoWires
Tile should NOT contain catenary wires.
@ Pylons
Tile should contain catenary pylons.
@ Blocked
Tile is blocked to vehicles.
std::vector< TileFlags > tileflags
List of tile flags.
GRFFilePropsBase< NUM_CARGO+3 > grf_prop
Properties related the the grf file.
CargoTypes cargo_triggers
Bitmask of cargo types which cause trigger re-randomizing.
std::vector< NewGRFSpriteLayout > renderdata
Number of tile layouts.
Station data structure.
Definition: station_base.h:439
Scope resolver for a town.
Definition: newgrf_town.h:22