(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / road.cpp
blobf51597538d8003bf7b282a9bbe6f9eeac30c811c
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
10 /** @file road.cpp Generic road related functions. */
12 #include "stdafx.h"
13 #include "rail_map.h"
14 #include "road_map.h"
15 #include "water_map.h"
16 #include "genworld.h"
17 #include "company_func.h"
18 #include "company_base.h"
19 #include "engine_base.h"
20 #include "date_func.h"
21 #include "landscape.h"
23 #include "safeguards.h"
25 /**
26 * Return if the tile is a valid tile for a crossing.
28 * @param tile the current tile
29 * @param ax the axis of the road over the rail
30 * @return true if it is a valid tile
32 static bool IsPossibleCrossing(const TileIndex tile, Axis ax)
34 return (IsTileType(tile, MP_RAILWAY) &&
35 GetRailTileType(tile) == RAIL_TILE_NORMAL &&
36 GetTrackBits(tile) == (ax == AXIS_X ? TRACK_BIT_Y : TRACK_BIT_X) &&
37 GetFoundationSlope(tile) == SLOPE_FLAT);
40 /**
41 * Clean up unnecessary RoadBits of a planed tile.
42 * @param tile current tile
43 * @param org_rb planed RoadBits
44 * @return optimised RoadBits
46 RoadBits CleanUpRoadBits(const TileIndex tile, RoadBits org_rb)
48 if (!IsValidTile(tile)) return ROAD_NONE;
49 for (DiagDirection dir = DIAGDIR_BEGIN; dir < DIAGDIR_END; dir++) {
50 const TileIndex neighbor_tile = TileAddByDiagDir(tile, dir);
52 /* Get the Roadbit pointing to the neighbor_tile */
53 const RoadBits target_rb = DiagDirToRoadBits(dir);
55 /* If the roadbit is in the current plan */
56 if (org_rb & target_rb) {
57 bool connective = false;
58 const RoadBits mirrored_rb = MirrorRoadBits(target_rb);
60 if (IsValidTile(neighbor_tile)) {
61 switch (GetTileType(neighbor_tile)) {
62 /* Always connective ones */
63 case MP_CLEAR: case MP_TREES:
64 connective = true;
65 break;
67 /* The conditionally connective ones */
68 case MP_TUNNELBRIDGE:
69 case MP_STATION:
70 case MP_ROAD:
71 if (IsNormalRoadTile(neighbor_tile)) {
72 /* Always connective */
73 connective = true;
74 } else {
75 const RoadBits neighbor_rb = GetAnyRoadBits(neighbor_tile, ROADTYPE_ROAD) | GetAnyRoadBits(neighbor_tile, ROADTYPE_TRAM);
77 /* Accept only connective tiles */
78 connective = (neighbor_rb & mirrored_rb) != ROAD_NONE;
80 break;
82 case MP_RAILWAY:
83 connective = IsPossibleCrossing(neighbor_tile, DiagDirToAxis(dir));
84 break;
86 case MP_WATER:
87 /* Check for real water tile */
88 connective = !IsWater(neighbor_tile);
89 break;
91 /* The definitely not connective ones */
92 default: break;
96 /* If the neighbor tile is inconnective, remove the planed road connection to it */
97 if (!connective) org_rb ^= target_rb;
101 return org_rb;
105 * Finds out, whether given company has all given RoadTypes available
106 * @param company ID of company
107 * @param rts RoadTypes to test
108 * @return true if company has all requested RoadTypes available
110 bool HasRoadTypesAvail(const CompanyID company, const RoadTypes rts)
112 RoadTypes avail_roadtypes;
114 if (company == OWNER_DEITY || company == OWNER_TOWN || _game_mode == GM_EDITOR || _generating_world) {
115 avail_roadtypes = ROADTYPES_ROAD;
116 } else {
117 Company *c = Company::GetIfValid(company);
118 if (c == NULL) return false;
119 avail_roadtypes = (RoadTypes)c->avail_roadtypes | ROADTYPES_ROAD; // road is available for always for everybody
121 return (rts & ~avail_roadtypes) == 0;
125 * Validate functions for rail building.
126 * @param rt road type to check.
127 * @return true if the current company may build the road.
129 bool ValParamRoadType(const RoadType rt)
131 return HasRoadTypesAvail(_current_company, RoadTypeToRoadTypes(rt));
135 * Get the road types the given company can build.
136 * @param company the company to get the roadtypes for.
137 * @return the road types.
139 RoadTypes GetCompanyRoadtypes(CompanyID company)
141 RoadTypes rt = ROADTYPES_NONE;
143 Engine *e;
144 FOR_ALL_ENGINES_OF_TYPE(e, VEH_ROAD) {
145 const EngineInfo *ei = &e->info;
147 if (HasBit(ei->climates, _settings_game.game_creation.landscape) &&
148 (HasBit(e->company_avail, company) || _date >= e->intro_date + DAYS_IN_YEAR)) {
149 SetBit(rt, HasBit(ei->misc_flags, EF_ROAD_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD);
153 return rt;