OpenTTD Source  20241108-master-g80f628063a
StationSpec Struct Reference

Station specification. More...

#include <newgrf_station.h>

Inheritance diagram for StationSpec:
NewGRFSpecBase< StationClassID >

Public Types

enum class  TileFlags : uint8_t { None = 0 , Pylons = 1U << 0 , NoWires = 1U << 1 , Blocked = 1U << 2 }
 

Data Fields

GRFFilePropsBase< NUM_CARGO+3 > grf_prop
 Properties related the the grf file. More...
 
StringID name
 Name of this station.
 
uint8_t disallowed_platforms
 Bitmask of number of platforms available for the station. More...
 
uint8_t disallowed_lengths
 Bitmask of platform lengths available for the station. More...
 
std::vector< NewGRFSpriteLayoutrenderdata
 Number of tile layouts. More...
 
uint16_t cargo_threshold
 Cargo threshold for choosing between little and lots of cargo. More...
 
CargoTypes cargo_triggers
 Bitmask of cargo types which cause trigger re-randomizing.
 
uint8_t callback_mask
 Bitmask of station callbacks that have to be called.
 
uint8_t flags
 Bitmask of flags, bit 0: use different sprite set; bit 1: divide cargo about by station size.
 
std::vector< TileFlagstileflags
 List of tile flags.
 
AnimationInfo animation
 
std::unordered_map< uint16_t, std::vector< uint8_t > > layouts
 Custom platform layouts, keyed by platform and length combined.
 
- Data Fields inherited from NewGRFSpecBase< StationClassID >
StationClassID class_index
 Class index of this spec, invalid until class is allocated.
 
uint16_t index
 Index within class of this spec, invalid until inserted into class.
 

Detailed Description

Station specification.

Definition at line 115 of file newgrf_station.h.

Member Enumeration Documentation

◆ TileFlags

enum StationSpec::TileFlags : uint8_t
strong
Enumerator
Pylons 

Tile should contain catenary pylons.

NoWires 

Tile should NOT contain catenary wires.

Blocked 

Tile is blocked to vehicles.

Definition at line 163 of file newgrf_station.h.

Field Documentation

◆ cargo_threshold

uint16_t StationSpec::cargo_threshold

Cargo threshold for choosing between little and lots of cargo.

Note
little/lots are equivalent to the moving/loading states for vehicles

Definition at line 155 of file newgrf_station.h.

◆ disallowed_lengths

uint8_t StationSpec::disallowed_lengths

Bitmask of platform lengths available for the station.

0..6 correspond to 1..7, while bit 7 corresponds to >7 tiles long.

Definition at line 139 of file newgrf_station.h.

Referenced by BuildRailStationWindow::CheckSelectedSize().

◆ disallowed_platforms

uint8_t StationSpec::disallowed_platforms

Bitmask of number of platforms available for the station.

0..6 correspond to 1..7, while bit 7 corresponds to >7 platforms.

Definition at line 134 of file newgrf_station.h.

Referenced by BuildRailStationWindow::CheckSelectedSize().

◆ grf_prop

GRFFilePropsBase<NUM_CARGO + 3> StationSpec::grf_prop

Properties related the the grf file.

NUM_CARGO real cargo plus three pseudo cargo sprite groups. Used for obtaining the sprite offset of custom sprites, and for evaluating callbacks.

Definition at line 127 of file newgrf_station.h.

Referenced by AllocateSpecToStation(), StationResolverObject::GetDebugID(), MoveWaypointsToBaseStations(), and StationResolverObject::StationResolverObject().

◆ renderdata

std::vector<NewGRFSpriteLayout> StationSpec::renderdata

Number of tile layouts.

A minimum of 8 is required is required for stations. 0-1 = plain platform 2-3 = platform with building 4-5 = platform with roof, left side 6-7 = platform with roof, right side Array of tile layouts.

Definition at line 149 of file newgrf_station.h.


The documentation for this struct was generated from the following file: