OpenTTD Source  20241108-master-g80f628063a
town.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 TOWN_H
11 #define TOWN_H
12 
13 #include "viewport_type.h"
14 #include "timer/timer_game_tick.h"
15 #include "town_map.h"
16 #include "subsidy_type.h"
17 #include "newgrf_storage.h"
18 #include "cargotype.h"
19 
20 template <typename T>
22  std::vector<T> id_count;
23  std::vector<T> class_count;
24 
25  auto operator<=>(const BuildingCounts &) const = default;
26 };
27 
28 static const uint CUSTOM_TOWN_NUMBER_DIFFICULTY = 4;
29 static const uint CUSTOM_TOWN_MAX_NUMBER = 5000;
30 
31 static const TownID INVALID_TOWN = 0xFFFF;
32 
33 static const uint TOWN_GROWTH_WINTER = 0xFFFFFFFE;
34 static const uint TOWN_GROWTH_DESERT = 0xFFFFFFFF;
35 static const uint16_t TOWN_GROWTH_RATE_NONE = 0xFFFF;
36 static const uint16_t MAX_TOWN_GROWTH_TICKS = 930;
37 
39 extern TownPool _town_pool;
40 
42 struct TownCache {
43  uint32_t num_houses;
44  uint32_t population;
47  std::array<uint32_t, HZB_END> squared_town_zone_radius;
49 
50  auto operator<=>(const TownCache &) const = default;
51 };
52 
54 struct Town : TownPool::PoolItem<&_town_pool> {
56 
58 
59  /* Town name */
60  uint32_t townnamegrfid;
61  uint16_t townnametype;
62  uint32_t townnameparts;
63  std::string name;
64  mutable std::string cached_name;
65 
66  uint8_t flags;
67 
68  uint16_t noise_reached;
69 
70  CompanyMask statues;
71 
72  /* Company ratings. */
73  CompanyMask have_ratings;
78 
81  uint32_t goal[NUM_TAE];
82 
83  std::string text;
84 
85  inline uint8_t GetPercentTransported(CargoID cid) const
86  {
87  if (!IsValidCargoID(cid)) return 0;
88  return this->supplied[cid].old_act * 256 / (this->supplied[cid].old_max + 1);
89  }
90 
92 
93  uint16_t time_until_rebuild;
94 
95  uint16_t grow_counter;
96  uint16_t growth_rate;
97 
100 
101  bool larger_town;
103 
104  bool show_zone;
105 
106  std::list<PersistentStorage *> psa_list;
107 
112  Town(TileIndex tile = INVALID_TILE) : xy(tile) { }
113 
115  ~Town();
116 
118 
125  inline uint16_t MaxTownNoise() const
126  {
127  if (this->cache.population == 0) return 0; // no population? no noise
128 
129  /* 3 is added (the noise of the lowest airport), so the user can at least build a small airfield. */
131  }
132 
133  void UpdateVirtCoord();
134 
135  inline const std::string &GetCachedName() const
136  {
137  if (!this->name.empty()) return this->name;
138  if (this->cached_name.empty()) this->FillCachedName();
139  return this->cached_name;
140  }
141 
142  static inline Town *GetByTile(TileIndex tile)
143  {
144  return Town::Get(GetTownIndex(tile));
145  }
146 
147  static Town *GetRandom();
148  static void PostDestructor(size_t index);
149 
150 private:
151  void FillCachedName() const;
152 };
153 
154 uint32_t GetWorldPopulation();
155 
158 void ShowTownViewWindow(TownID town);
159 void ExpandTown(Town *t);
160 
161 void RebuildTownKdtree();
162 
165  TOWN_COUNCIL_LENIENT = 0,
166  TOWN_COUNCIL_TOLERANT = 1,
167  TOWN_COUNCIL_HOSTILE = 2,
168  TOWN_COUNCIL_PERMISSIVE = 3,
169 };
170 
179 };
180 
183  TDIWD_FORCE_REBUILD,
184  TDIWD_POPULATION_CHANGE,
185  TDIWD_FORCE_RESORT,
186 };
187 
195 enum TownFlags {
200 };
201 
203 
204 
206 
207 Town *CalcClosestTownFromTile(TileIndex tile, uint threshold = UINT_MAX);
208 
209 void ResetHouses();
210 
213  TACT_NONE = 0x00,
214 
222  TACT_BRIBE = 0x80,
223 
225 
230 };
232 
233 void ClearTownHouse(Town *t, TileIndex tile);
234 void UpdateTownMaxPass(Town *t);
235 void UpdateTownRadius(Town *t);
237 Town *ClosestTownFromTile(TileIndex tile, uint threshold);
238 void ChangeTownRating(Town *t, int add, int max, DoCommandFlag flags);
239 HouseZonesBits GetTownRadiusGroup(const Town *t, TileIndex tile);
240 void SetTownRatingTestMode(bool mode);
242 bool GenerateTowns(TownLayout layout);
244 
245 extern const uint8_t _town_action_costs[TACT_COUNT];
246 
252 template <class T>
253 void MakeDefaultName(T *obj)
254 {
255  /* We only want to set names if it hasn't been set before, or when we're calling from afterload. */
256  assert(obj->name.empty() || obj->town_cn == UINT16_MAX);
257 
258  obj->town = ClosestTownFromTile(obj->xy, UINT_MAX);
259 
260  /* Find first unused number belonging to this town. This can never fail,
261  * as long as there can be at most 65535 waypoints/depots in total.
262  *
263  * This does 'n * m' search, but with 32bit 'used' bitmap, it needs at
264  * most 'n * (1 + ceil(m / 32))' steps (n - number of waypoints in pool,
265  * m - number of waypoints near this town).
266  * Usually, it needs only 'n' steps.
267  *
268  * If it wasn't using 'used' and 'idx', it would just search for increasing 'next',
269  * but this way it is faster */
270 
271  uint32_t used = 0; // bitmap of used waypoint numbers, sliding window with 'next' as base
272  uint32_t next = 0; // first number in the bitmap
273  uint32_t idx = 0; // index where we will stop
274  uint32_t cid = 0; // current index, goes to T::GetPoolSize()-1, then wraps to 0
275 
276  do {
277  T *lobj = T::GetIfValid(cid);
278 
279  /* check only valid waypoints... */
280  if (lobj != nullptr && obj != lobj) {
281  /* only objects within the same city and with the same type */
282  if (lobj->town == obj->town && lobj->IsOfType(obj)) {
283  /* if lobj->town_cn < next, uint will overflow to '+inf' */
284  uint i = (uint)lobj->town_cn - next;
285 
286  if (i < 32) {
287  SetBit(used, i); // update bitmap
288  if (i == 0) {
289  /* shift bitmap while the lowest bit is '1';
290  * increase the base of the bitmap too */
291  do {
292  used >>= 1;
293  next++;
294  } while (HasBit(used, 0));
295  /* when we are at 'idx' again at end of the loop and
296  * 'next' hasn't changed, then no object had town_cn == next,
297  * so we can safely use it */
298  idx = cid;
299  }
300  }
301  }
302  }
303 
304  cid++;
305  if (cid == T::GetPoolSize()) cid = 0; // wrap to zero...
306  } while (cid != idx);
307 
308  obj->town_cn = (uint16_t)next; // set index...
309 }
310 
311 /*
312  * Converts original town ticks counters to plain game ticks. Note that
313  * tick 0 is a valid tick so actual amount is one more than the counter value.
314  */
315 inline uint16_t TownTicksToGameTicks(uint16_t ticks)
316 {
317  return (std::min(ticks, MAX_TOWN_GROWTH_TICKS) + 1) * Ticks::TOWN_GROWTH_TICKS - 1;
318 }
319 
320 
322 bool CheckTownRoadTypes();
323 std::span<const DrawBuildingsTileStruct> GetTownDrawTileData();
324 
325 #endif /* TOWN_H */
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
bool IsValidCargoID(CargoID t)
Test whether cargo type is not INVALID_CARGO.
Definition: cargo_type.h:107
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
Definition: cargo_type.h:74
Types/functions related to cargoes.
TownAcceptanceEffect
Town growth effect when delivering cargo.
Definition: cargotype.h:21
@ NUM_TAE
Amount of town effects.
Definition: cargotype.h:30
Common return value for all commands.
Definition: command_type.h:23
static constexpr TimerGameTick::Ticks TOWN_GROWTH_TICKS
Cycle duration for towns trying to grow (this originates from the size of the town array in TTD).
DoCommandFlag
List of flags for a command.
Definition: command_type.h:374
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
uint16_t HouseID
OpenTTD ID of house types.
Definition: house_type.h:13
int32_t TileIndexDiff
An offset value between two tiles.
Definition: map_type.h:23
Functionality related to the temporary and persistent storage arrays for NewGRFs.
RoadType
The different roadtypes we support.
Definition: road_type.h:25
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:57
std::set< Station *, StationCompare > StationList
List of stations.
Definition: station_type.h:94
Specification of a cargo type.
Definition: cargotype.h:71
uint8_t town_council_tolerance
minimum required town ratings to be allowed to demolish stuff
uint16_t town_noise_population[4]
population to base decision on noise evaluation (
EconomySettings economy
settings to change the economy
DifficultySettings difficulty
settings related to the difficulty
Base class for all PoolItems.
Definition: pool_type.hpp:237
Tindex index
Index of this pool item.
Definition: pool_type.hpp:238
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
Data structure with cached data of towns.
Definition: town.h:42
uint32_t population
Current population of people.
Definition: town.h:44
uint32_t num_houses
Amount of houses.
Definition: town.h:43
std::array< uint32_t, HZB_END > squared_town_zone_radius
UpdateTownRadius updates this given the house count.
Definition: town.h:47
PartOfSubsidy part_of_subsidy
Is this town a source/destination of a subsidy?
Definition: town.h:46
TrackedViewportSign sign
Location of name sign, UpdateVirtCoord updates this.
Definition: town.h:45
BuildingCounts< uint16_t > building_counts
The number of each type of building in the town.
Definition: town.h:48
Town data structure.
Definition: town.h:54
bool larger_town
if this is a larger town and should grow more quickly
Definition: town.h:101
Town(TileIndex tile=INVALID_TILE)
Creates a new town.
Definition: town.h:112
TransportedCargoStat< uint32_t > supplied[NUM_CARGO]
Cargo statistics about supplied cargo.
Definition: town.h:79
CompanyMask statues
which companies have a statue?
Definition: town.h:70
uint16_t time_until_rebuild
time until we rebuild a house
Definition: town.h:93
std::string cached_name
NOSAVE: Cache of the resolved name of the town, if not using a custom town name.
Definition: town.h:64
TileIndex xy
town center tile
Definition: town.h:55
uint8_t fund_buildings_months
fund buildings program in action?
Definition: town.h:98
uint16_t noise_reached
level of noise that all the airports are generating
Definition: town.h:68
int16_t ratings[MAX_COMPANIES]
ratings of each company for this town
Definition: town.h:77
TownLayout layout
town specific road layout
Definition: town.h:102
TransportedCargoStat< uint16_t > received[NUM_TAE]
Cargo statistics about received cargotypes.
Definition: town.h:80
uint16_t MaxTownNoise() const
Calculate the max town noise.
Definition: town.h:125
static Town * GetRandom()
Return a random valid town.
Definition: town_cmd.cpp:196
std::string name
Custom town name. If empty, the town was not renamed and uses the generated name.
Definition: town.h:63
uint16_t grow_counter
counter to count when to grow, value is smaller than or equal to growth_rate
Definition: town.h:95
uint8_t flags
See TownFlags.
Definition: town.h:66
TownCache cache
Container for all cacheable data.
Definition: town.h:57
CompanyID exclusivity
which company has exclusivity
Definition: town.h:75
void InitializeLayout(TownLayout layout)
Assign the town layout.
Definition: town_cmd.cpp:182
bool show_zone
NOSAVE: mark town to show the local authority zone in the viewports.
Definition: town.h:104
uint32_t goal[NUM_TAE]
Amount of cargo required for the town to grow.
Definition: town.h:81
uint8_t exclusive_counter
months till the exclusivity expires
Definition: town.h:76
void UpdateVirtCoord()
Resize the sign (label) of the town after it changes population.
Definition: town_cmd.cpp:409
std::string text
General text with additional information.
Definition: town.h:83
CompanyMask have_ratings
which companies have a rating
Definition: town.h:73
~Town()
Destroy the town.
Definition: town_cmd.cpp:110
uint8_t unwanted[MAX_COMPANIES]
how many months companies aren't wanted by towns (bribe)
Definition: town.h:74
uint16_t growth_rate
town growth rate
Definition: town.h:96
StationList stations_near
NOSAVE: List of nearby stations.
Definition: town.h:91
static void PostDestructor(size_t index)
Invalidating of the "nearest town cache" has to be done after removing item from the pool.
Definition: town_cmd.cpp:167
uint8_t road_build_months
fund road reconstruction in action?
Definition: town.h:99
Specialised ViewportSign that tracks whether it is valid for entering into a Kdtree.
Definition: viewport_type.h:51
Tstorage old_max
Maximum amount last month.
Definition: town_type.h:114
Tstorage old_act
Actually transported last month.
Definition: town_type.h:116
basic types related to subsidies
PartOfSubsidy
What part of a subsidy is something?
Definition: subsidy_type.h:16
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:95
Definition of the tick-based game-timer.
static const uint TOWN_GROWTH_WINTER
The town only needs this cargo in the winter (any amount)
Definition: town.h:33
const CargoSpec * FindFirstCargoWithTownAcceptanceEffect(TownAcceptanceEffect effect)
Determines the first cargo with a certain town effect.
Definition: town_cmd.cpp:3026
HouseZonesBits GetTownRadiusGroup(const Town *t, TileIndex tile)
Returns the bit corresponding to the town zone of the specified tile.
Definition: town_cmd.cpp:2447
TileIndexDiff GetHouseNorthPart(HouseID &house)
Determines if a given HouseID is part of a multitile house.
Definition: town_cmd.cpp:2924
void ClearTownHouse(Town *t, TileIndex tile)
Clear a town house.
Definition: town_cmd.cpp:2949
TownActions GetMaskOfTownActions(CompanyID cid, const Town *t)
Get a list of available town authority actions.
Definition: town_cmd.cpp:3579
static const uint TOWN_GROWTH_DESERT
The town needs the cargo for growth when on desert (any amount)
Definition: town.h:34
TownDirectoryInvalidateWindowData
Special values for town list window for the data parameter of InvalidateWindowData.
Definition: town.h:182
TownFlags
This enum is used in conjunction with town->flags.
Definition: town.h:195
@ TOWN_HAS_CHURCH
There can be only one church by town.
Definition: town.h:197
@ TOWN_HAS_STADIUM
There can be only one stadium by town.
Definition: town.h:198
@ TOWN_IS_GROWING
Conditions for town growth are met. Grow according to Town::growth_rate.
Definition: town.h:196
@ TOWN_CUSTOM_GROWTH
Growth rate is controlled by GS.
Definition: town.h:199
TownRatingCheckType
Action types that a company must ask permission for to a town authority.
Definition: town.h:175
@ ROAD_REMOVE
Removal of a road owned by the town.
Definition: town.h:176
@ TUNNELBRIDGE_REMOVE
Removal of a tunnel or bridge owned by the towb.
Definition: town.h:177
@ TOWN_RATING_CHECK_TYPE_COUNT
Number of town checking action types.
Definition: town.h:178
uint32_t GetWorldPopulation()
Get the total population, the sum of all towns in the world.
Definition: town_cmd.cpp:462
static const uint CUSTOM_TOWN_MAX_NUMBER
this is the maximum number of towns a user can specify in customisation
Definition: town.h:29
TownActions
Town actions of a company.
Definition: town.h:212
@ TACT_BUILD_STATUE
Build a statue.
Definition: town.h:219
@ TACT_CONSTRUCTION
All possible construction actions.
Definition: town.h:227
@ TACT_ROAD_REBUILD
Rebuild the roads.
Definition: town.h:218
@ TACT_ADVERTISE_MEDIUM
Medium advertising campaign.
Definition: town.h:216
@ TACT_BUY_RIGHTS
Buy exclusive transport rights.
Definition: town.h:221
@ TACT_BRIBE
Try to bribe the council.
Definition: town.h:222
@ TACT_ADVERTISE
All possible advertising actions.
Definition: town.h:226
@ TACT_COUNT
Number of available town actions.
Definition: town.h:224
@ TACT_ALL
All possible actions.
Definition: town.h:229
@ TACT_FUND_BUILDINGS
Fund new buildings.
Definition: town.h:220
@ TACT_FUNDS
All possible funding actions.
Definition: town.h:228
@ TACT_NONE
Empty action set.
Definition: town.h:213
@ TACT_ADVERTISE_LARGE
Large advertising campaign.
Definition: town.h:217
@ TACT_ADVERTISE_SMALL
Small advertising campaign.
Definition: town.h:215
const uint8_t _town_action_costs[TACT_COUNT]
Factor in the cost of each town action.
Definition: town_cmd.cpp:3288
void UpdateTownMaxPass(Town *t)
Update the maximum amount of montly passengers and mail for a town, based on its population.
Definition: town_cmd.cpp:1966
Town * CalcClosestTownFromTile(TileIndex tile, uint threshold=UINT_MAX)
Return the town closest to the given tile within threshold.
Definition: town_cmd.cpp:3852
static const uint CUSTOM_TOWN_NUMBER_DIFFICULTY
value for custom town number in difficulty settings
Definition: town.h:28
void ClearAllTownCachedNames()
Clear the cached_name of all towns.
Definition: town_cmd.cpp:435
void ChangeTownRating(Town *t, int add, int max, DoCommandFlag flags)
Changes town rating of the current company.
Definition: town_cmd.cpp:3949
RoadType GetTownRoadType()
Get the road type that towns should build at this current moment.
Definition: town_cmd.cpp:926
bool CheckTownRoadTypes()
Check if towns are able to build road.
Definition: town_cmd.cpp:982
bool GenerateTowns(TownLayout layout)
Generate a number of towns with a given layout.
Definition: town_cmd.cpp:2386
CommandCost CheckIfAuthorityAllowsNewStation(TileIndex tile, DoCommandFlag flags)
Checks whether the local authority allows construction of a new station (rail, road,...
Definition: town_cmd.cpp:3828
static const uint16_t MAX_TOWN_GROWTH_TICKS
Max amount of original town ticks that still fit into uint16_t, about equal to UINT16_MAX / TOWN_GROW...
Definition: town.h:36
CommandCost CheckforTownRating(DoCommandFlag flags, Town *t, TownRatingCheckType type)
Does the town authority allow the (destructive) action of the current company?
Definition: town_cmd.cpp:3986
TownCouncilAttitudes
Settings for town council attitudes.
Definition: town.h:164
void SetTownRatingTestMode(bool mode)
Switch the town rating to test-mode, to allow commands to be tested without affecting current ratings...
Definition: town_cmd.cpp:3911
void UpdateTownRadius(Town *t)
Update the cached town zone radii of a town, based on the number of houses.
Definition: town_cmd.cpp:1919
static const uint16_t TOWN_GROWTH_RATE_NONE
Special value for Town::growth_rate to disable town growth.
Definition: town.h:35
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold.
Definition: town_cmd.cpp:3870
void MakeDefaultName(T *obj)
Set the default name for a depot/waypoint.
Definition: town.h:253
void UpdateAllTownVirtCoords()
Update the virtual coords needed to draw the town sign for all towns.
Definition: town_cmd.cpp:427
Accessors for towns.
TownID GetTownIndex(Tile t)
Get the index of which town this house/street is attached to.
Definition: town_map.h:23
TownLayout
Town Layouts.
Definition: town_type.h:79
Types related to viewports.