OpenTTD
Public Member Functions | Static Public Member Functions | Data Fields
BaseStation Struct Referenceabstract

Base class for all station-ish types. More...

#include <base_station_base.h>

Inheritance diagram for BaseStation:
Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_station_pool > SpecializedStation< T, Tis_waypoint > SpecializedStation< Station, false > SpecializedStation< Waypoint, true > Station Waypoint

Public Member Functions

 BaseStation (TileIndex tile)
 Initialize the base station. More...
 
virtual bool TileBelongsToRailStation (TileIndex tile) const =0
 Check whether a specific tile belongs to this station. More...
 
virtual uint32 GetNewGRFVariable (const struct ResolverObject &object, byte variable, byte parameter, bool *available) const =0
 Helper function to get a NewGRF variable that isn't implemented by the base class. More...
 
virtual void UpdateVirtCoord ()=0
 Update the coordinated of the sign (as shown in the viewport).
 
virtual void GetTileArea (TileArea *ta, StationType type) const =0
 Get the tile area for a given station type. More...
 
virtual uint GetPlatformLength (TileIndex tile) const =0
 Obtain the length of a platform. More...
 
virtual uint GetPlatformLength (TileIndex tile, DiagDirection dir) const =0
 Determines the REMAINING length of a platform, starting at (and including) the given tile. More...
 
bool IsInUse () const
 Check whether the base station currently is in use; in use means that it is not scheduled for deletion and that it still has some facilities left. More...
 
- Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_station_pool >
void * operator new (size_t size)
 Allocates space for new Titem. More...
 
void * operator new (size_t size, size_t index)
 Allocates space for new Titem with given index. More...
 
void * operator new (size_t size, void *ptr)
 Allocates space for new Titem at given memory address. More...
 
void operator delete (void *p)
 Marks Titem as free. More...
 

Static Public Member Functions

static BaseStationGetByTile (TileIndex tile)
 Get the base station belonging to a specific tile. More...
 
static void PostDestructor (size_t index)
 Invalidating of the JoinStation window has to be done after removing item from the pool. More...
 
- Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_station_pool >
static bool CanAllocateItem (size_t n=1)
 Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() More...
 
static bool CleaningPool ()
 Returns current state of pool cleaning - yes or no. More...
 
static bool IsValidID (size_t index)
 Tests whether given index can be used to get valid (non-NULL) Titem. More...
 
static Titem * Get (size_t index)
 Returns Titem with given index. More...
 
static Titem * GetIfValid (size_t index)
 Returns Titem with given index. More...
 
static size_t GetPoolSize ()
 Returns first unused index. More...
 
static size_t GetNumItems ()
 Returns number of valid items in the pool. More...
 
static void PostDestructor (size_t index)
 Dummy function called after destructor of each member. More...
 

Data Fields

TileIndex xy
 Base tile of the station.
 
ViewportSign sign
 NOSAVE: Dimensions of sign.
 
byte delete_ctr
 Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is deleted.
 
char * name
 Custom name.
 
StringID string_id
 Default name (town area) of station.
 
Towntown
 The town this station is associated with.
 
OwnerByte owner
 The owner of this station.
 
StationFacilityByte facilities
 The facilities that this station has.
 
uint8 num_specs
 Number of specs in the speclist.
 
StationSpecListspeclist
 List of station specs of this station.
 
Date build_date
 Date of construction.
 
uint16 random_bits
 Random bits assigned to this station.
 
byte waiting_triggers
 Waiting triggers (NewGRF) for this station.
 
uint8 cached_anim_triggers
 NOSAVE: Combined animation trigger bitmask, used to determine if trigger processing should happen.
 
uint32 cached_cargo_triggers
 NOSAVE: Combined cargo trigger bitmask.
 
TileArea train_station
 Tile area the train 'station' part covers.
 
StationRect rect
 NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
 
- Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_station_pool >
Tindex index
 Index of this pool item.
 

Detailed Description

Base class for all station-ish types.

Definition at line 54 of file base_station_base.h.

Constructor & Destructor Documentation

◆ BaseStation()

BaseStation::BaseStation ( TileIndex  tile)
inline

Initialize the base station.

Parameters
tileThe location of the station sign

Definition at line 83 of file base_station_base.h.

Member Function Documentation

◆ GetByTile()

static BaseStation* BaseStation::GetByTile ( TileIndex  tile)
inlinestatic

Get the base station belonging to a specific tile.

Parameters
tileThe tile to get the base station from.
Returns
the station associated with that tile.

Definition at line 143 of file base_station_base.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_station_pool >::Get(), and GetStationIndex().

Referenced by CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::CanEnterNewTile().

◆ GetNewGRFVariable()

virtual uint32 BaseStation::GetNewGRFVariable ( const struct ResolverObject object,
byte  variable,
byte  parameter,
bool *  available 
) const
pure virtual

Helper function to get a NewGRF variable that isn't implemented by the base class.

Parameters
objectthe resolver object related to this query
variablethat is queried
parameterparameter for that variable
availablewill return false if ever the variable asked for does not exist
Returns
the value stored in the corresponding variable

Implemented in Waypoint.

◆ GetPlatformLength() [1/2]

virtual uint BaseStation::GetPlatformLength ( TileIndex  tile) const
pure virtual

Obtain the length of a platform.

Precondition
tile must be a rail station tile
Parameters
tileA tile that contains the platform in question
Returns
The length of the platform

Implemented in Station, and Waypoint.

Referenced by CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::CanEnterNewTile().

◆ GetPlatformLength() [2/2]

virtual uint BaseStation::GetPlatformLength ( TileIndex  tile,
DiagDirection  dir 
) const
pure virtual

Determines the REMAINING length of a platform, starting at (and including) the given tile.

Parameters
tilethe tile from which to start searching. Must be a rail station tile
dirThe direction in which to search.
Returns
The platform length

Implemented in Station, and Waypoint.

◆ GetTileArea()

virtual void BaseStation::GetTileArea ( TileArea ta,
StationType  type 
) const
pure virtual

Get the tile area for a given station type.

Parameters
tatile area to fill.
typethe type of the area

Implemented in Station, and Waypoint.

Referenced by CalcClosestStationTile().

◆ IsInUse()

bool BaseStation::IsInUse ( ) const
inline

Check whether the base station currently is in use; in use means that it is not scheduled for deletion and that it still has some facilities left.

Returns
true if still in use

Definition at line 154 of file base_station_base.h.

References FACIL_WAYPOINT.

Referenced by DeleteStationIfEmpty(), FindDeletedWaypointCloseTo(), WaypointWindow::GetCenterTile(), WaypointWindow::OnInvalidateData(), StationHandleBigTick(), and UpdateStationAcceptance().

◆ PostDestructor()

void BaseStation::PostDestructor ( size_t  index)
static

Invalidating of the JoinStation window has to be done after removing item from the pool.

Parameters
indexindex of deleted item

Definition at line 156 of file station.cpp.

References GetRoadTypes(), Vehicle::HasArticulatedPart(), InvalidateWindowData(), RoadVehicle::IsBus(), IsStandardRoadStopTile(), RoadStop::next, ROADSTOP_BUS, ROADSTOP_TRUCK, ROADTYPES_NONE, WC_SELECT_STATION, and RoadStop::xy.

◆ TileBelongsToRailStation()

virtual bool BaseStation::TileBelongsToRailStation ( TileIndex  tile) const
pure virtual

Check whether a specific tile belongs to this station.

Parameters
tilethe tile to check
Returns
true if the tile belongs to this station

Implemented in Station, and Waypoint.


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