Depot Struct Reference

Inheritance diagram for Depot:

Public Member Functions
	Depot (TileIndex xy)
	~Depot ()
	Clean up a depot.
bool	IsOfType (const Depot *d) const
	Is the "type" of depot the same as the given depot, i.e.
Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_depot_pool >
void *	operator new (size_t size)
	Allocates space for new Titem.
void *	operator new (size_t size, Tindex index)
	Allocates space for new Titem with given index.
void *	operator new (size_t, void *ptr)
	Allocates space for new Titem at given memory address.
void	operator delete (void *p, size_t size)
	Marks Titem as free.

Static Public Member Functions
static Depot *	GetByTile (TileIndex tile)
Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_depot_pool >
static bool	CanAllocateItem (size_t n=1)
	Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
static bool	CleaningPool ()
	Returns current state of pool cleaning - yes or no.
static bool	IsValidID (auto index)
	Tests whether given index can be used to get valid (non-nullptr) Titem.
static Titem *	Get (auto index)
	Returns Titem with given index.
static Titem *	GetIfValid (auto index)
	Returns Titem with given index.
static size_t	GetPoolSize ()
	Returns first unused index.
static size_t	GetNumItems ()
	Returns number of valid items in the pool.
static void	PostDestructor (size_t index)
	Dummy function called after destructor of each member.
static Pool::IterateWrapper< Titem >	Iterate (size_t from=0)
	Returns an iterable ensemble of all valid Titem.

Data Fields
uint16_t	town_cn = 0
	The N-1th depot for this town (consecutive number)
TileIndex	xy = INVALID_TILE
Town *	town = nullptr
std::string	name {}
TimerGameCalendar::Date	build_date {}
	Date of construction.
Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_depot_pool >
Tindex	index
	Index of this pool item.

Additional Inherited Members
Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_depot_pool >
typedef struct Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >	Pool
	Type of the pool this item is going to be part of.

Detailed Description

Definition at line 20 of file depot_base.h.

Constructor & Destructor Documentation

Depot() [1/2]

Depot::Depot ( )

inline

Definition at line 28 of file depot_base.h.

Depot() [2/2]

Depot::Depot ( TileIndex  xy )

inline

Definition at line 29 of file depot_base.h.

~Depot()

Depot::~Depot

(

)

Clean up a depot.

Definition at line 28 of file depot.cpp.

References CloseWindowById(), GetDepotIndex(), GetDepotVehicleType(), GetTileOwner(), GetWindowClassForVehicleType(), IsDepotTile(), RemoveOrderFromAllVehicles(), OrderBackup::Reset(), VL_DEPOT_LIST, and WC_VEHICLE_DEPOT.

Member Function Documentation

GetByTile()

static Depot * Depot::GetByTile ( TileIndex  tile )

inlinestatic

Definition at line 32 of file depot_base.h.

IsOfType()

bool Depot::IsOfType ( const Depot *  d ) const

inline

Is the "type" of depot the same as the given depot, i.e.

are both a rail, road or ship depots?

Parameters

d	The depot to compare to.

Returns

true iff their types are equal.

Definition at line 43 of file depot_base.h.

References GetTileType().

Field Documentation

build_date

TimerGameCalendar::Date Depot::build_date {}

Date of construction.

Definition at line 26 of file depot_base.h.

Referenced by RailTypeScopeResolver::GetVariable(), and RoadTypeScopeResolver::GetVariable().

name

std::string Depot::name {}

Definition at line 25 of file depot_base.h.

town

Town* Depot::town = nullptr

Definition at line 24 of file depot_base.h.

town_cn

uint16_t Depot::town_cn = 0

The N-1th depot for this town (consecutive number)

Definition at line 22 of file depot_base.h.

Referenced by FormatString().

xy

TileIndex Depot::xy = INVALID_TILE

Definition at line 23 of file depot_base.h.

---

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

• src/depot_base.h
• src/depot.cpp