OpenTTD Source  20241108-master-g80f628063a
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 <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef DEPOT_BASE_H
11 #define DEPOT_BASE_H
12 
13 #include "depot_map.h"
14 #include "core/pool_type.hpp"
16 
18 extern DepotPool _depot_pool;
19 
20 struct Depot : DepotPool::PoolItem<&_depot_pool> {
21  /* DepotID index member of DepotPool is 2 bytes. */
22  uint16_t town_cn;
23  TileIndex xy;
24  Town *town;
25  std::string name;
27 
28  Depot(TileIndex xy = INVALID_TILE) : xy(xy) {}
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 */
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:52
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
Base class for all PoolItems.
Definition: pool_type.hpp:237
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:339
Base class for all pools.
Definition: pool_type.hpp:80
Town data structure.
Definition: town.h:54
static debug_inline TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition: tile_map.h:96
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:95
Definition of the game-calendar-timer.