OpenTTD Source 20241224-master-gf74b0cf984
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> {
28 uint8_t colour;
29 uint8_t view;
30
32 Object() {}
35
36 static Object *GetByTile(TileIndex tile);
37
43 static inline void IncTypeCount(ObjectType type)
44 {
45 assert(type < NUM_OBJECTS);
46 counts[type]++;
47 }
48
54 static inline void DecTypeCount(ObjectType type)
55 {
56 assert(type < NUM_OBJECTS);
57 counts[type]--;
58 }
59
65 static inline uint16_t GetTypeCount(ObjectType type)
66 {
67 assert(type < NUM_OBJECTS);
68 return counts[type];
69 }
70
72 static inline void ResetTypeCounts()
73 {
74 memset(&counts, 0, sizeof(counts));
75 }
76
77protected:
78 static uint16_t counts[NUM_OBJECTS];
79};
80
88
90extern std::vector<ClearedObjectArea> _cleared_object_areas;
91
92#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:14
static const ObjectType NUM_OBJECTS
Number of supported objects overall.
Definition object_type.h:23
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:84
TileArea area
The area of the object.
Definition object_base.h:86
TileIndex first_tile
The first tile being cleared, which then causes the whole object to be cleared.
Definition object_base.h:85
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:65
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:43
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:78
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:54
static void ResetTypeCounts()
Resets object counts.
Definition object_base.h:72
~Object()
Make sure the right destructor is called as well!
Definition object_base.h:34
Represents the covered area of e.g.
Base class for all PoolItems.
Base class for all pools.
Definition pool_type.hpp:80
Templated helper to make a type-safe 'typedef' representing a single POD value.
Town data structure.
Definition town.h:54
Type for storing the 'area' of something uses on the map.
Definition of the game-calendar-timer.
Types related to towns.