OpenTTD Source 20260206-master-g4d4e37dbf1
depot_base.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#ifndef DEPOT_BASE_H
11#define DEPOT_BASE_H
12
13#include "depot_map.h"
14#include "core/pool_type.hpp"
16
17typedef Pool<Depot, DepotID, 64> DepotPool;
18extern DepotPool _depot_pool;
19
20struct Depot : DepotPool::PoolItem<&_depot_pool> {
21 /* DepotID index member of DepotPool is 2 bytes. */
22 uint16_t town_cn = 0;
24 Town *town = nullptr;
25 std::string name{};
26 TimerGameCalendar::Date build_date{};
27
28 Depot(DepotID index, TileIndex xy = INVALID_TILE) : DepotPool::PoolItem<&_depot_pool>(index), xy(xy), build_date(TimerGameCalendar::date) {}
29 ~Depot();
30
31 static inline Depot *GetByTile(TileIndex tile)
32 {
33 return Depot::Get(GetDepotIndex(tile));
34 }
35
42 inline bool IsOfType(const Depot *d) const
43 {
44 return GetTileType(d->xy) == GetTileType(this->xy);
45 }
46};
47
48#endif /* DEPOT_BASE_H */
Timer that is increased every 27ms, and counts towards ticks / days / months / years.
DepotPool _depot_pool("Depot")
All our depots tucked away in a pool.
Map related accessors for depots.
DepotID GetDepotIndex(Tile t)
Get the index of which depot is attached to the tile.
Definition depot_map.h:53
PoolID< uint16_t, struct DepotIDTag, 64000, 0xFFFF > DepotID
Type for the unique identifier of depots.
Definition depot_type.h:15
Definition of Pool, structure used to access PoolItems, and PoolItem, base structure for Vehicle,...
bool IsOfType(const Depot *d) const
Is the "type" of depot the same as the given depot, i.e.
Definition depot_base.h:42
~Depot()
Clean up a depot.
Definition depot.cpp:28
uint16_t town_cn
The N-1th depot for this town (consecutive number).
Definition depot_base.h:22
TimerGameCalendar::Date build_date
Date of construction.
Definition depot_base.h:26
static Depot * Get(auto index)
Base class for all pools.
Town data structure.
Definition town.h:63
static TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition tile_map.h:96
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:100
Definition of the game-calendar-timer.