OpenTTD Source 20250312-master-gcdcc6b491d
object_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 OBJECT_BASE_H
11#define OBJECT_BASE_H
12
13#include "core/pool_type.hpp"
14#include "object_type.h"
15#include "tilearea_type.h"
16#include "town_type.h"
18
20extern ObjectPool _object_pool;
21
23struct Object : ObjectPool::PoolItem<&_object_pool> {
25 Town *town = nullptr;
28 uint8_t colour = 0;
29 uint8_t view = 0;
30
32 Object() {}
33 Object(ObjectType type, Town *town, TileArea location, TimerGameCalendar::Date build_date, uint8_t view) :
37
38 static Object *GetByTile(TileIndex tile);
39
45 static inline void IncTypeCount(ObjectType type)
46 {
47 assert(type < NUM_OBJECTS);
48 counts[type]++;
49 }
50
56 static inline void DecTypeCount(ObjectType type)
57 {
58 assert(type < NUM_OBJECTS);
59 counts[type]--;
60 }
61
67 static inline uint16_t GetTypeCount(ObjectType type)
68 {
69 assert(type < NUM_OBJECTS);
70 return counts[type];
71 }
72
74 static inline void ResetTypeCounts()
75 {
76 memset(&counts, 0, sizeof(counts));
77 }
78
79protected:
80 static uint16_t counts[NUM_OBJECTS];
81};
82
90
92extern std::vector<ClearedObjectArea> _cleared_object_areas;
93
94#endif /* OBJECT_BASE_H */
ClearedObjectArea * FindClearedObject(TileIndex tile)
Find the entry in _cleared_object_areas which occupies a certain tile.
Types related to object tiles.
uint16_t ObjectType
Types of objects.
Definition object_type.h:16
static const ObjectType INVALID_OBJECT_TYPE
An invalid object.
Definition object_type.h:27
static const ObjectType NUM_OBJECTS
Number of supported objects overall.
Definition object_type.h:25
Definition of Pool, structure used to access PoolItems, and PoolItem, base structure for Vehicle,...
Keeps track of removed objects during execution/testruns of commands.
Definition object_base.h:86
TileArea area
The area of the object.
Definition object_base.h:88
TileIndex first_tile
The first tile being cleared, which then causes the whole object to be cleared.
Definition object_base.h:87
An object, such as transmitter, on the map.
Definition object_base.h:23
ObjectType type
Type of the object.
Definition object_base.h:24
Town * town
Town the object is built in.
Definition object_base.h:25
static uint16_t GetTypeCount(ObjectType type)
Get the count of objects for this type.
Definition object_base.h:67
Object()
Make sure the object isn't zeroed.
Definition object_base.h:32
static Object * GetByTile(TileIndex tile)
Get the object associated with a tile.
static void IncTypeCount(ObjectType type)
Increment the count of objects for this type.
Definition object_base.h:45
TimerGameCalendar::Date build_date
Date of construction.
Definition object_base.h:27
static uint16_t counts[NUM_OBJECTS]
Number of objects per type ingame.
Definition object_base.h:80
uint8_t view
The view setting for this object.
Definition object_base.h:29
TileArea location
Location of the object.
Definition object_base.h:26
uint8_t colour
Colour of the object, for display purpose.
Definition object_base.h:28
static void DecTypeCount(ObjectType type)
Decrement the count of objects for this type.
Definition object_base.h:56
static void ResetTypeCounts()
Resets object counts.
Definition object_base.h:74
~Object()
Make sure the right destructor is called as well!
Definition object_base.h:36
Represents the covered area of e.g.
Base class for all PoolItems.
Base class for all pools.
Templated helper to make a type-safe 'typedef' representing a single POD value.
Town data structure.
Definition town.h:52
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
Type for storing the 'area' of something uses on the map.
Definition of the game-calendar-timer.
Types related to towns.