OpenTTD Source 20250612-master-gb012d9e3dc
road.cpp
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#include "stdafx.h"
11#include "rail_map.h"
12#include "road_map.h"
13#include "water_map.h"
14#include "genworld.h"
15#include "company_func.h"
16#include "company_base.h"
17#include "engine_base.h"
19#include "landscape.h"
20#include "road.h"
21#include "road_func.h"
22#include "roadveh.h"
23
24#include "safeguards.h"
25
33static bool IsPossibleCrossing(const TileIndex tile, Axis ax)
34{
35 return (IsTileType(tile, MP_RAILWAY) &&
37 GetTrackBits(tile) == (ax == AXIS_X ? TRACK_BIT_Y : TRACK_BIT_X) &&
38 std::get<0>(GetFoundationSlope(tile)) == SLOPE_FLAT);
39}
40
48{
49 if (!IsValidTile(tile)) return ROAD_NONE;
50 for (DiagDirection dir = DIAGDIR_BEGIN; dir < DIAGDIR_END; dir++) {
51 const TileIndex neighbour_tile = TileAddByDiagDir(tile, dir);
52
53 /* Get the Roadbit pointing to the neighbour_tile */
54 const RoadBits target_rb = DiagDirToRoadBits(dir);
55
56 /* If the roadbit is in the current plan */
57 if (org_rb & target_rb) {
58 bool connective = false;
59 const RoadBits mirrored_rb = MirrorRoadBits(target_rb);
60
61 if (IsValidTile(neighbour_tile)) {
62 switch (GetTileType(neighbour_tile)) {
63 /* Always connective ones */
64 case MP_CLEAR: case MP_TREES:
65 connective = true;
66 break;
67
68 /* The conditionally connective ones */
69 case MP_TUNNELBRIDGE:
70 case MP_STATION:
71 case MP_ROAD:
72 if (IsNormalRoadTile(neighbour_tile)) {
73 /* Always connective */
74 connective = true;
75 } else {
76 const RoadBits neighbour_rb = GetAnyRoadBits(neighbour_tile, RTT_ROAD) | GetAnyRoadBits(neighbour_tile, RTT_TRAM);
77
78 /* Accept only connective tiles */
79 connective = (neighbour_rb & mirrored_rb) != ROAD_NONE;
80 }
81 break;
82
83 case MP_RAILWAY:
84 connective = IsPossibleCrossing(neighbour_tile, DiagDirToAxis(dir));
85 break;
86
87 case MP_WATER:
88 /* Check for real water tile */
89 connective = !IsWater(neighbour_tile);
90 break;
91
92 /* The definitely not connective ones */
93 default: break;
94 }
95 }
96
97 /* If the neighbour tile is inconnective, remove the planned road connection to it */
98 if (!connective) org_rb ^= target_rb;
99 }
100 }
101
102 return org_rb;
103}
104
111bool HasRoadTypeAvail(const CompanyID company, RoadType roadtype)
112{
113 if (company == OWNER_DEITY || company == OWNER_TOWN || _game_mode == GM_EDITOR || _generating_world) {
114 const RoadTypeInfo *rti = GetRoadTypeInfo(roadtype);
115 if (rti->label == 0) return false;
116
117 /* Not yet introduced at this date. */
119
120 /*
121 * Do not allow building hidden road types, except when a town may build it.
122 * The GS under deity mode, as well as anybody in the editor builds roads that are
123 * owned by towns. So if a town may build it, it should be buildable by them too.
124 */
126 } else {
127 const Company *c = Company::GetIfValid(company);
128 if (c == nullptr) return false;
129 RoadTypes avail = c->avail_roadtypes;
131 return avail.Test(roadtype);
132 }
133}
134
140bool HasAnyRoadTypesAvail(CompanyID company, RoadTramType rtt)
141{
142 RoadTypes avail = Company::Get(company)->avail_roadtypes;
144 return avail.Any(GetMaskForRoadTramType(rtt));
145}
146
153{
154 return roadtype < ROADTYPE_END && HasRoadTypeAvail(_current_company, roadtype);
155}
156
166{
167 RoadTypes rts = current;
168
169 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
170 const RoadTypeInfo *rti = GetRoadTypeInfo(rt);
171 /* Unused road type. */
172 if (rti->label == 0) continue;
173
174 /* Not date introduced. */
175 if (!IsInsideMM(rti->introduction_date, 0, CalendarTime::MAX_DATE.base())) continue;
176
177 /* Not yet introduced at this date. */
178 if (rti->introduction_date > date) continue;
179
180 /* Have we introduced all required roadtypes? */
182 if ((rts & required) != required) continue;
183
184 rts.Set(rti->introduces_roadtypes);
185 }
186
187 /* When we added roadtypes we need to run this method again; the added
188 * roadtypes might enable more rail types to become introduced. */
189 return rts == current ? rts : AddDateIntroducedRoadTypes(rts, date);
190}
191
198RoadTypes GetCompanyRoadTypes(CompanyID company, bool introduces)
199{
200 RoadTypes rts{};
201
202 for (const Engine *e : Engine::IterateType(VEH_ROAD)) {
203 const EngineInfo *ei = &e->info;
204
206 (e->company_avail.Test(company) || TimerGameCalendar::date >= e->intro_date + CalendarTime::DAYS_IN_YEAR)) {
207 const RoadVehicleInfo *rvi = &e->u.road;
208 assert(rvi->roadtype < ROADTYPE_END);
209 if (introduces) {
211 } else {
212 rts.Set(rvi->roadtype);
213 }
214 }
215 }
216
217 if (introduces) return AddDateIntroducedRoadTypes(rts, TimerGameCalendar::date);
218 return rts;
219}
220
226RoadTypes GetRoadTypes(bool introduces)
227{
228 RoadTypes rts{};
229
230 for (const Engine *e : Engine::IterateType(VEH_ROAD)) {
231 const EngineInfo *ei = &e->info;
233
234 const RoadVehicleInfo *rvi = &e->u.road;
235 assert(rvi->roadtype < ROADTYPE_END);
236 if (introduces) {
238 } else {
239 rts.Set(rvi->roadtype);
240 }
241 }
242
243 if (introduces) return AddDateIntroducedRoadTypes(rts, CalendarTime::MAX_DATE);
244 return rts;
245}
246
253RoadType GetRoadTypeByLabel(RoadTypeLabel label, bool allow_alternate_labels)
254{
255 if (label == 0) return INVALID_ROADTYPE;
256
257 /* Loop through each road type until the label is found */
258 for (RoadType r = ROADTYPE_BEGIN; r != ROADTYPE_END; r++) {
259 const RoadTypeInfo *rti = GetRoadTypeInfo(r);
260 if (rti->label == label) return r;
261 }
262
263 if (allow_alternate_labels) {
264 /* Test if any road type defines the label as an alternate. */
265 for (RoadType r = ROADTYPE_BEGIN; r != ROADTYPE_END; r++) {
266 const RoadTypeInfo *rti = GetRoadTypeInfo(r);
267 if (std::ranges::find(rti->alternate_labels, label) != rti->alternate_labels.end()) return r;
268 }
269 }
270
271 /* No matching label was found, so it is invalid */
272 return INVALID_ROADTYPE;
273}
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
constexpr Timpl & Set()
Set all bits.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
RoadTypeLabel label
Unique 32 bit road type identifier.
Definition road.h:138
RoadTypeLabelList alternate_labels
Road type labels this type provides in addition to the main label.
Definition road.h:143
RoadTypes introduces_roadtypes
Bitmask of which other roadtypes are introduced when this roadtype is introduced.
Definition road.h:168
TimerGameCalendar::Date introduction_date
Introduction date.
Definition road.h:157
RoadTypeFlags flags
Bit mask of road type flags.
Definition road.h:118
RoadTypes introduction_required_roadtypes
Bitmask of roadtypes that are required for this roadtype to be introduced at a given introduction_dat...
Definition road.h:163
static Date date
Current date in days (day counter).
static constexpr TimerGame< struct Calendar >::Date MAX_DATE
The date of the last day of the max year.
static constexpr int DAYS_IN_YEAR
days per year
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _current_company
Company currently doing an action.
Functions related to companies.
static constexpr Owner OWNER_DEITY
The object is owned by a superuser / goal script.
static constexpr Owner OWNER_TOWN
A town owns the tile, or a town is expanding.
Axis DiagDirToAxis(DiagDirection d)
Convert a DiagDirection to the axis.
Axis
Allow incrementing of DiagDirDiff variables.
@ AXIS_X
The X axis.
DiagDirection
Enumeration for diagonal directions.
@ DIAGDIR_END
Used for iterations.
@ DIAGDIR_BEGIN
Used for iterations.
Base class for engines.
bool _generating_world
Whether we are generating the map or not.
Definition genworld.cpp:74
Functions related to world/map generation.
std::tuple< Slope, int > GetFoundationSlope(TileIndex tile)
Get slope of a tile on top of a (possible) foundation If a tile does not have a foundation,...
Functions related to OTTD's landscape.
TileIndex TileAddByDiagDir(TileIndex tile, DiagDirection dir)
Adds a DiagDir to a tile.
Definition map_func.h:610
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
Hides the direct accesses to the map array with map accessors.
static debug_inline RailTileType GetRailTileType(Tile t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition rail_map.h:36
TrackBits GetTrackBits(Tile tile)
Gets the track bits of the given tile.
Definition rail_map.h:136
@ RAIL_TILE_NORMAL
Normal rail tile without signals.
Definition rail_map.h:24
RoadBits CleanUpRoadBits(const TileIndex tile, RoadBits org_rb)
Clean up unnecessary RoadBits of a planned tile.
Definition road.cpp:47
RoadTypes GetCompanyRoadTypes(CompanyID company, bool introduces)
Get the road types the given company can build.
Definition road.cpp:198
RoadTypes GetRoadTypes(bool introduces)
Get list of road types, regardless of company availability.
Definition road.cpp:226
bool ValParamRoadType(RoadType roadtype)
Validate functions for rail building.
Definition road.cpp:152
RoadTypes AddDateIntroducedRoadTypes(RoadTypes current, TimerGameCalendar::Date date)
Add the road types that are to be introduced at the given date.
Definition road.cpp:165
bool HasAnyRoadTypesAvail(CompanyID company, RoadTramType rtt)
Test if any buildable RoadType is available for a company.
Definition road.cpp:140
static bool IsPossibleCrossing(const TileIndex tile, Axis ax)
Return if the tile is a valid tile for a crossing.
Definition road.cpp:33
bool HasRoadTypeAvail(const CompanyID company, RoadType roadtype)
Finds out, whether given company has a given RoadType available for construction.
Definition road.cpp:111
RoadType GetRoadTypeByLabel(RoadTypeLabel label, bool allow_alternate_labels)
Get the road type for a given label.
Definition road.cpp:253
Road specific functions.
@ Hidden
Bit number for hidden from construction.
@ TownBuild
Bit number for allowing towns to build this roadtype.
RoadTypes _roadtypes_hidden_mask
Bitset of hidden roadtypes.
Definition road_cmd.cpp:56
RoadTypes GetMaskForRoadTramType(RoadTramType rtt)
Get the mask for road types of the given RoadTramType.
Definition road.h:198
const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition road.h:230
Functions related to roads.
RoadBits MirrorRoadBits(RoadBits r)
Calculate the mirrored RoadBits.
Definition road_func.h:51
RoadBits DiagDirToRoadBits(DiagDirection d)
Create the road-part which belongs to the given DiagDirection.
Definition road_func.h:96
RoadBits GetAnyRoadBits(Tile tile, RoadTramType rtt, bool straight_tunnel_bridge_entrance)
Returns the RoadBits on an arbitrary tile Special behaviour:
Definition road_map.cpp:54
Map accessors for roads.
static debug_inline bool IsNormalRoadTile(Tile t)
Return whether a tile is a normal road tile.
Definition road_map.h:58
RoadBits
Enumeration for the road parts on a tile.
Definition road_type.h:40
@ ROAD_NONE
No road-part is build.
Definition road_type.h:41
RoadType
The different roadtypes we support.
Definition road_type.h:23
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
@ ROADTYPE_END
Used for iterations.
Definition road_type.h:27
@ ROADTYPE_BEGIN
Used for iterations.
Definition road_type.h:24
Road vehicle states.
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
@ SLOPE_FLAT
a flat tile
Definition slope_type.h:49
Definition of base types and functions in a cross-platform compatible way.
RoadTypes avail_roadtypes
Road types available to this company.
Information about a vehicle.
LandscapeTypes climates
Climates supported by the engine.
static Pool::IterateWrapperFiltered< Engine, EngineTypeFilter > IterateType(VehicleType vt, size_t from=0)
Returns an iterable ensemble of all valid engines of the given type.
LandscapeType landscape
the landscape we're currently in
GameCreationSettings game_creation
settings used during the creation of a game (map)
static Titem * Get(auto index)
Returns Titem with given index.
static Titem * GetIfValid(auto index)
Returns Titem with given index.
Information about a road vehicle.
RoadType roadtype
Road type.
static debug_inline TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition tile_map.h:96
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition tile_map.h:161
static debug_inline bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
@ MP_TREES
Tile got trees.
Definition tile_type.h:52
@ MP_ROAD
A tile with road (or tram tracks)
Definition tile_type.h:50
@ MP_STATION
A tile of a station.
Definition tile_type.h:53
@ MP_TUNNELBRIDGE
Tunnel entry/exit and bridge heads.
Definition tile_type.h:57
@ MP_CLEAR
A tile without any structures, i.e. grass, rocks, farm fields etc.
Definition tile_type.h:48
@ MP_WATER
Water tile.
Definition tile_type.h:54
@ MP_RAILWAY
A railway.
Definition tile_type.h:49
Definition of the game-calendar-timer.
@ TRACK_BIT_Y
Y-axis track.
Definition track_type.h:38
@ TRACK_BIT_X
X-axis track.
Definition track_type.h:37
@ VEH_ROAD
Road vehicle type.
Map accessors for water tiles.
bool IsWater(Tile t)
Is it a plain water tile?
Definition water_map.h:147