OpenTTD Source: src/town_type.h Source File

OpenTTD Source 15.0-beta1

town_type.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_TYPE_H
11#define TOWN_TYPE_H
12
13#include "core/enum_type.hpp"
14
15typedef uint16_t TownID;
16struct Town;
17
19 enum TownSize : uint8_t {
20 TSZ_SMALL,
21 TSZ_MEDIUM,
22 TSZ_LARGE,
23 TSZ_RANDOM,
24
25 TSZ_END,
26};
27 DECLARE_ENUM_AS_ADDABLE(TownSize)
28
29/* These refer to the maximums, so Appalling is -1000 to -400
30 * MAXIMUM RATINGS BOUNDARIES */
31static constexpr int RATING_MINIMUM = -1000;
32static constexpr int RATING_APPALLING = -400;
33static constexpr int RATING_VERYPOOR = -200;
34static constexpr int RATING_POOR = 0;
35static constexpr int RATING_MEDIOCRE = 200;
36static constexpr int RATING_GOOD = 400;
37static constexpr int RATING_VERYGOOD = 600;
38static constexpr int RATING_EXCELLENT = 800;
39 static constexpr int RATING_OUTSTANDING = 1000;
40
41static constexpr int RATING_MAXIMUM = RATING_OUTSTANDING;
42
43 static constexpr int RATING_INITIAL = 500;
44
45/* RATINGS AFFECTING NUMBERS */
46static constexpr int RATING_TREE_DOWN_STEP = -35;
47static constexpr int RATING_TREE_MINIMUM = RATING_MINIMUM;
48static constexpr int RATING_TREE_UP_STEP = 7;
49static constexpr int RATING_TREE_MAXIMUM = 220;
50
51 static constexpr int RATING_GROWTH_UP_STEP = 5;
52 static constexpr int RATING_GROWTH_MAXIMUM = RATING_MEDIOCRE;
53 static constexpr int RATING_STATION_UP_STEP = 12;
54 static constexpr int RATING_STATION_DOWN_STEP = -15;
55
56 static constexpr int RATING_TUNNEL_BRIDGE_UP_STEP = 50;
57 static constexpr int RATING_TUNNEL_BRIDGE_DOWN_STEP = -250;
58 static constexpr int RATING_TUNNEL_BRIDGE_MINIMUM = 0;
59 static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_LENIENT = 144;
60 static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_NEUTRAL = 208;
61 static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_HOSTILE = 400;
62 static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_PERMISSIVE = RATING_MINIMUM;
63
64 static constexpr int RATING_ROAD_DOWN_STEP_INNER = -50;
65 static constexpr int RATING_ROAD_DOWN_STEP_EDGE = -18;
66 static constexpr int RATING_ROAD_MINIMUM = -100;
67 static constexpr int RATING_ROAD_NEEDED_LENIENT = 16;
68 static constexpr int RATING_ROAD_NEEDED_NEUTRAL = 64;
69 static constexpr int RATING_ROAD_NEEDED_HOSTILE = 112;
70 static constexpr int RATING_ROAD_NEEDED_PERMISSIVE = RATING_MINIMUM;
71
72static constexpr int RATING_HOUSE_MINIMUM = RATING_MINIMUM;
73
74static constexpr int RATING_BRIBE_UP_STEP = 200;
75static constexpr int RATING_BRIBE_MAXIMUM = 800;
76static constexpr int RATING_BRIBE_DOWN_TO = -50; // XXX SHOULD BE SOMETHING LOWER?
77
79 enum TownLayout : uint8_t {
80 TL_BEGIN = 0,
81 TL_ORIGINAL = 0,
82 TL_BETTER_ROADS,
83 TL_2X2_GRID,
84 TL_3X3_GRID,
85
86 TL_RANDOM,
87
88 NUM_TLS,
89};
90 DECLARE_ENUM_AS_ADDABLE(TownLayout)
91
92
93enum TownFounding : uint8_t {
94 TF_BEGIN = 0,
95 TF_FORBIDDEN = 0,
96 TF_ALLOWED,
97 TF_CUSTOM_LAYOUT,
98 TF_END,
99};
100
102 enum TownCargoGenMode : uint8_t {
103 TCGM_BEGIN = 0,
104 TCGM_ORIGINAL = 0,
105 TCGM_BITCOUNT,
106 TCGM_END,
107};
108
109 static const uint MAX_LENGTH_TOWN_NAME_CHARS = 32;
110
112template <typename Tstorage>
113 struct TransportedCargoStat {
114 Tstorage old_max;
115 Tstorage new_max;
116 Tstorage old_act;
117 Tstorage new_act;
118
119 TransportedCargoStat() : old_max(0), new_max(0), old_act(0), new_act(0) {}
120
122 void NewMonth()
123 {
124 this->old_max = this->new_max; this->new_max = 0;
125 this->old_act = this->new_act; this->new_act = 0;
126 }
127};
128
129#endif /* TOWN_TYPE_H */
enum_type.hpp
Type (helpers) for enums.
DECLARE_ENUM_AS_ADDABLE
#define DECLARE_ENUM_AS_ADDABLE(EnumType)
Operator that allows this enumeration to be added to any other enumeration.
Definition enum_type.hpp:45
Town
Town data structure.
Definition town.h:54
TransportedCargoStat
Store the maximum and actually transported cargo amount for the current and the last month.
Definition town_type.h:113
TransportedCargoStat::new_max
Tstorage new_max
Maximum amount this month.
Definition town_type.h:115
TransportedCargoStat::NewMonth
void NewMonth()
Update stats for a new month.
Definition town_type.h:122
TransportedCargoStat::old_max
Tstorage old_max
Maximum amount last month.
Definition town_type.h:114
TransportedCargoStat::old_act
Tstorage old_act
Actually transported last month.
Definition town_type.h:116
TransportedCargoStat::new_act
Tstorage new_act
Actually transported this month.
Definition town_type.h:117
RATING_GROWTH_UP_STEP
static constexpr int RATING_GROWTH_UP_STEP
when a town grows, all companies have rating increased a bit ...
Definition town_type.h:51
RATING_INITIAL
static constexpr int RATING_INITIAL
initial rating
Definition town_type.h:43
RATING_ROAD_NEEDED_HOSTILE
static constexpr int RATING_ROAD_NEEDED_HOSTILE
"Hostile"
Definition town_type.h:69
RATING_TUNNEL_BRIDGE_UP_STEP
static constexpr int RATING_TUNNEL_BRIDGE_UP_STEP
rating increase for improving a town-owned bridge
Definition town_type.h:56
RATING_ROAD_DOWN_STEP_EDGE
static constexpr int RATING_ROAD_DOWN_STEP_EDGE
removing a roadpiece at the edge
Definition town_type.h:65
RATING_ROAD_DOWN_STEP_INNER
static constexpr int RATING_ROAD_DOWN_STEP_INNER
removing a roadpiece in the middle
Definition town_type.h:64
TownCargoGenMode
TownCargoGenMode
Town cargo generation modes.
Definition town_type.h:102
TCGM_BITCOUNT
@ TCGM_BITCOUNT
Bit-counted algorithm (normal distribution from individual house population)
Definition town_type.h:105
TCGM_ORIGINAL
@ TCGM_ORIGINAL
Original algorithm (quadratic cargo by population)
Definition town_type.h:104
RATING_ROAD_NEEDED_NEUTRAL
static constexpr int RATING_ROAD_NEEDED_NEUTRAL
"Neutral"
Definition town_type.h:68
RATING_TUNNEL_BRIDGE_MINIMUM
static constexpr int RATING_TUNNEL_BRIDGE_MINIMUM
minimum rating after removing tunnel or bridge
Definition town_type.h:58
TownLayout
TownLayout
Town Layouts.
Definition town_type.h:79
TL_3X3_GRID
@ TL_3X3_GRID
Geometric 3x3 grid algorithm.
Definition town_type.h:84
TL_ORIGINAL
@ TL_ORIGINAL
Original algorithm (min. 1 distance between roads)
Definition town_type.h:81
TL_2X2_GRID
@ TL_2X2_GRID
Geometric 2x2 grid algorithm.
Definition town_type.h:83
TL_RANDOM
@ TL_RANDOM
Random town layout.
Definition town_type.h:86
TL_BETTER_ROADS
@ TL_BETTER_ROADS
Extended original algorithm (min. 2 distance between roads)
Definition town_type.h:82
NUM_TLS
@ NUM_TLS
Number of town layouts.
Definition town_type.h:88
RATING_TUNNEL_BRIDGE_NEEDED_LENIENT
static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_LENIENT
rating needed, "Lenient" difficulty settings
Definition town_type.h:59
TownFounding
TownFounding
Town founding setting values.
Definition town_type.h:93
TF_ALLOWED
@ TF_ALLOWED
Allowed.
Definition town_type.h:96
TF_CUSTOM_LAYOUT
@ TF_CUSTOM_LAYOUT
Allowed, with custom town layout.
Definition town_type.h:97
TF_END
@ TF_END
Used for iterations and limit testing.
Definition town_type.h:98
TF_BEGIN
@ TF_BEGIN
Used for iterations and limit testing.
Definition town_type.h:94
TF_FORBIDDEN
@ TF_FORBIDDEN
Forbidden.
Definition town_type.h:95
RATING_TUNNEL_BRIDGE_NEEDED_HOSTILE
static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_HOSTILE
"Hostile"
Definition town_type.h:61
RATING_TUNNEL_BRIDGE_NEEDED_PERMISSIVE
static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_PERMISSIVE
"Permissive" (local authority disabled)
Definition town_type.h:62
RATING_STATION_DOWN_STEP
static constexpr int RATING_STATION_DOWN_STEP
... but loses for badly serviced stations
Definition town_type.h:54
RATING_ROAD_MINIMUM
static constexpr int RATING_ROAD_MINIMUM
minimum rating after removing town owned road
Definition town_type.h:66
RATING_TUNNEL_BRIDGE_NEEDED_NEUTRAL
static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_NEUTRAL
"Neutral"
Definition town_type.h:60
RATING_ROAD_NEEDED_LENIENT
static constexpr int RATING_ROAD_NEEDED_LENIENT
rating needed, "Lenient" difficulty settings
Definition town_type.h:67
RATING_STATION_UP_STEP
static constexpr int RATING_STATION_UP_STEP
when a town grows, company gains reputation for all well serviced stations ...
Definition town_type.h:53
RATING_TUNNEL_BRIDGE_DOWN_STEP
static constexpr int RATING_TUNNEL_BRIDGE_DOWN_STEP
penalty for removing town owned tunnel or bridge
Definition town_type.h:57
TownSize
TownSize
Supported initial town sizes.
Definition town_type.h:19
TSZ_RANDOM
@ TSZ_RANDOM
Random size, bigger than small, smaller than large.
Definition town_type.h:23
TSZ_END
@ TSZ_END
Number of available town sizes.
Definition town_type.h:25
TSZ_MEDIUM
@ TSZ_MEDIUM
Medium town.
Definition town_type.h:21
TSZ_SMALL
@ TSZ_SMALL
Small town.
Definition town_type.h:20
TSZ_LARGE
@ TSZ_LARGE
Large town.
Definition town_type.h:22
MAX_LENGTH_TOWN_NAME_CHARS
static const uint MAX_LENGTH_TOWN_NAME_CHARS
The maximum length of a town name in characters including '\0'.
Definition town_type.h:109
RATING_ROAD_NEEDED_PERMISSIVE
static constexpr int RATING_ROAD_NEEDED_PERMISSIVE
"Permissive" (local authority disabled)
Definition town_type.h:70
RATING_OUTSTANDING
static constexpr int RATING_OUTSTANDING
OUTSTANDING.
Definition town_type.h:39
RATING_GROWTH_MAXIMUM
static constexpr int RATING_GROWTH_MAXIMUM
... up to RATING_MEDIOCRE
Definition town_type.h:52