1 /* $Id: script_tile.cpp 25815 2013-10-06 11:16:00Z frosch $ */
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/>.
10 /** @file script_tile.cpp Implementation of ScriptTile. */
12 #include "../../stdafx.h"
13 #include "script_tile.hpp"
14 #include "script_map.hpp"
15 #include "script_town.hpp"
16 #include "../../station_func.h"
17 #include "../../water_map.h"
18 #include "../../clear_map.h"
19 #include "../../tree_map.h"
20 #include "../../town.h"
21 #include "../../landscape.h"
23 #include "../../safeguards.h"
25 /* static */ bool ScriptTile::IsBuildable(TileIndex tile
)
27 if (!::IsValidTile(tile
)) return false;
29 switch (::GetTileType(tile
)) {
30 default: return false;
31 case MP_CLEAR
: return true;
32 case MP_TREES
: return true;
33 case MP_WATER
: return IsCoast(tile
);
35 /* Tram bits aren't considered buildable */
36 if (::GetRoadTypes(tile
) != ROADTYPES_ROAD
) return false;
37 /* Depots and crossings aren't considered buildable */
38 if (::GetRoadTileType(tile
) != ROAD_TILE_NORMAL
) return false;
39 if (!HasExactlyOneBit(::GetRoadBits(tile
, ROADTYPE_ROAD
))) return false;
40 if (::IsRoadOwner(tile
, ROADTYPE_ROAD
, OWNER_TOWN
)) return true;
41 if (::IsRoadOwner(tile
, ROADTYPE_ROAD
, ScriptObject::GetCompany())) return true;
46 /* static */ bool ScriptTile::IsBuildableRectangle(TileIndex tile
, uint width
, uint height
)
48 /* Check whether we can extract valid X and Y */
49 if (!::IsValidTile(tile
)) return false;
51 uint tx
= ScriptMap::GetTileX(tile
);
52 uint ty
= ScriptMap::GetTileY(tile
);
54 for (uint x
= tx
; x
< width
+ tx
; x
++) {
55 for (uint y
= ty
; y
< height
+ ty
; y
++) {
56 if (!IsBuildable(ScriptMap::GetTileIndex(x
, y
))) return false;
63 /* static */ bool ScriptTile::IsWaterTile(TileIndex tile
)
65 if (!::IsValidTile(tile
)) return false;
67 return ::IsTileType(tile
, MP_WATER
) && !::IsCoast(tile
);
70 /* static */ bool ScriptTile::IsCoastTile(TileIndex tile
)
72 if (!::IsValidTile(tile
)) return false;
74 return (::IsTileType(tile
, MP_WATER
) && ::IsCoast(tile
)) ||
75 (::IsTileType(tile
, MP_TREES
) && ::GetTreeGround(tile
) == TREE_GROUND_SHORE
);
78 /* static */ bool ScriptTile::IsStationTile(TileIndex tile
)
80 if (!::IsValidTile(tile
)) return false;
82 return ::IsTileType(tile
, MP_STATION
);
85 /* static */ bool ScriptTile::IsSteepSlope(Slope slope
)
87 if ((slope
& ~(SLOPE_ELEVATED
| SLOPE_STEEP
| SLOPE_HALFTILE_MASK
)) != 0) return false;
89 return ::IsSteepSlope((::Slope
)slope
);
92 /* static */ bool ScriptTile::IsHalftileSlope(Slope slope
)
94 if ((slope
& ~(SLOPE_ELEVATED
| SLOPE_STEEP
| SLOPE_HALFTILE_MASK
)) != 0) return false;
96 return ::IsHalftileSlope((::Slope
)slope
);
99 /* static */ bool ScriptTile::HasTreeOnTile(TileIndex tile
)
101 if (!::IsValidTile(tile
)) return false;
103 return ::IsTileType(tile
, MP_TREES
);
106 /* static */ bool ScriptTile::IsFarmTile(TileIndex tile
)
108 if (!::IsValidTile(tile
)) return false;
110 return (::IsTileType(tile
, MP_CLEAR
) && ::IsClearGround(tile
, CLEAR_FIELDS
));
113 /* static */ bool ScriptTile::IsRockTile(TileIndex tile
)
115 if (!::IsValidTile(tile
)) return false;
117 return (::IsTileType(tile
, MP_CLEAR
) && ::GetRawClearGround(tile
) == ::CLEAR_ROCKS
);
120 /* static */ bool ScriptTile::IsRoughTile(TileIndex tile
)
122 if (!::IsValidTile(tile
)) return false;
124 return (::IsTileType(tile
, MP_CLEAR
) && ::GetRawClearGround(tile
) == ::CLEAR_ROUGH
);
127 /* static */ bool ScriptTile::IsSnowTile(TileIndex tile
)
129 if (!::IsValidTile(tile
)) return false;
131 return (::IsTileType(tile
, MP_CLEAR
) && ::IsSnowTile(tile
));
134 /* static */ bool ScriptTile::IsDesertTile(TileIndex tile
)
136 if (!::IsValidTile(tile
)) return false;
138 return (::IsTileType(tile
, MP_CLEAR
) && ::IsClearGround(tile
, CLEAR_DESERT
));
141 /* static */ ScriptTile::TerrainType
ScriptTile::GetTerrainType(TileIndex tile
)
143 if (!::IsValidTile(tile
)) return TERRAIN_NORMAL
;
145 switch (::GetTerrainType(tile
)) {
147 case 0: return TERRAIN_NORMAL
;
148 case 1: return TERRAIN_DESERT
;
149 case 2: return TERRAIN_RAINFOREST
;
150 case 4: return TERRAIN_SNOW
;
154 /* static */ ScriptTile::Slope
ScriptTile::GetSlope(TileIndex tile
)
156 if (!::IsValidTile(tile
)) return SLOPE_INVALID
;
158 return (Slope
)::GetTileSlope(tile
);
161 /* static */ ScriptTile::Slope
ScriptTile::GetComplementSlope(Slope slope
)
163 if ((slope
& ~SLOPE_ELEVATED
) != 0) return SLOPE_INVALID
;
165 return (Slope
)::ComplementSlope((::Slope
)slope
);
168 /* static */ int32
ScriptTile::GetMinHeight(TileIndex tile
)
170 if (!::IsValidTile(tile
)) return -1;
172 return ::GetTileZ(tile
);
175 /* static */ int32
ScriptTile::GetMaxHeight(TileIndex tile
)
177 if (!::IsValidTile(tile
)) return -1;
179 return ::GetTileMaxZ(tile
);
182 /* static */ int32
ScriptTile::GetCornerHeight(TileIndex tile
, Corner corner
)
184 if (!::IsValidTile(tile
) || !::IsValidCorner((::Corner
)corner
)) return -1;
187 ::Slope slope
= ::GetTileSlope(tile
, &z
);
188 return (z
+ ::GetSlopeZInCorner(slope
, (::Corner
)corner
));
191 /* static */ ScriptCompany::CompanyID
ScriptTile::GetOwner(TileIndex tile
)
193 if (!::IsValidTile(tile
)) return ScriptCompany::COMPANY_INVALID
;
194 if (::IsTileType(tile
, MP_HOUSE
)) return ScriptCompany::COMPANY_INVALID
;
195 if (::IsTileType(tile
, MP_INDUSTRY
)) return ScriptCompany::COMPANY_INVALID
;
197 return ScriptCompany::ResolveCompanyID((ScriptCompany::CompanyID
)(byte
)::GetTileOwner(tile
));
200 /* static */ bool ScriptTile::HasTransportType(TileIndex tile
, TransportType transport_type
)
202 if (!::IsValidTile(tile
)) return false;
204 if (transport_type
== TRANSPORT_ROAD
) {
205 return ::TrackStatusToTrackdirBits(::GetTileTrackStatus(tile
, (::TransportType
)transport_type
, ROADTYPE_ROAD
)) != TRACKDIR_BIT_NONE
||
206 ::TrackStatusToTrackdirBits(::GetTileTrackStatus(tile
, (::TransportType
)transport_type
, ROADTYPE_TRAM
)) != TRACKDIR_BIT_NONE
;
208 return ::TrackStatusToTrackdirBits(::GetTileTrackStatus(tile
, (::TransportType
)transport_type
, 0)) != TRACKDIR_BIT_NONE
;
212 /* static */ int32
ScriptTile::GetCargoAcceptance(TileIndex tile
, CargoID cargo_type
, int width
, int height
, int radius
)
214 if (!::IsValidTile(tile
) || width
<= 0 || height
<= 0 || radius
< 0 || !ScriptCargo::IsValidCargo(cargo_type
)) return -1;
216 CargoArray acceptance
= ::GetAcceptanceAroundTiles(tile
, width
, height
, _settings_game
.station
.modified_catchment
? radius
: (int)CA_UNMODIFIED
);
217 return acceptance
[cargo_type
];
220 /* static */ int32
ScriptTile::GetCargoProduction(TileIndex tile
, CargoID cargo_type
, int width
, int height
, int radius
)
222 if (!::IsValidTile(tile
) || width
<= 0 || height
<= 0 || radius
< 0 || !ScriptCargo::IsValidCargo(cargo_type
)) return -1;
224 CargoArray produced
= ::GetProductionAroundTiles(tile
, width
, height
, _settings_game
.station
.modified_catchment
? radius
: (int)CA_UNMODIFIED
);
225 return produced
[cargo_type
];
228 /* static */ int32
ScriptTile::GetDistanceManhattanToTile(TileIndex tile_from
, TileIndex tile_to
)
230 return ScriptMap::DistanceManhattan(tile_from
, tile_to
);
233 /* static */ int32
ScriptTile::GetDistanceSquareToTile(TileIndex tile_from
, TileIndex tile_to
)
235 return ScriptMap::DistanceSquare(tile_from
, tile_to
);
238 /* static */ bool ScriptTile::RaiseTile(TileIndex tile
, int32 slope
)
240 EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY
);
241 EnforcePrecondition(false, tile
< ::MapSize());
243 return ScriptObject::DoCommand(tile
, slope
, 1, CMD_TERRAFORM_LAND
);
246 /* static */ bool ScriptTile::LowerTile(TileIndex tile
, int32 slope
)
248 EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY
);
249 EnforcePrecondition(false, tile
< ::MapSize());
251 return ScriptObject::DoCommand(tile
, slope
, 0, CMD_TERRAFORM_LAND
);
254 /* static */ bool ScriptTile::LevelTiles(TileIndex start_tile
, TileIndex end_tile
)
256 EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY
);
257 EnforcePrecondition(false, start_tile
< ::MapSize());
258 EnforcePrecondition(false, end_tile
< ::MapSize());
260 return ScriptObject::DoCommand(end_tile
, start_tile
, LM_LEVEL
<< 1, CMD_LEVEL_LAND
);
263 /* static */ bool ScriptTile::DemolishTile(TileIndex tile
)
265 EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY
);
266 EnforcePrecondition(false, ::IsValidTile(tile
));
268 return ScriptObject::DoCommand(tile
, 0, 0, CMD_LANDSCAPE_CLEAR
);
271 /* static */ bool ScriptTile::PlantTree(TileIndex tile
)
273 EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY
);
274 EnforcePrecondition(false, ::IsValidTile(tile
));
276 return ScriptObject::DoCommand(tile
, TREE_INVALID
, tile
, CMD_PLANT_TREE
);
279 /* static */ bool ScriptTile::PlantTreeRectangle(TileIndex tile
, uint width
, uint height
)
281 EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY
);
282 EnforcePrecondition(false, ::IsValidTile(tile
));
283 EnforcePrecondition(false, width
>= 1 && width
<= 20);
284 EnforcePrecondition(false, height
>= 1 && height
<= 20);
285 TileIndex end_tile
= tile
+ ::TileDiffXY(width
- 1, height
- 1);
287 return ScriptObject::DoCommand(tile
, TREE_INVALID
, end_tile
, CMD_PLANT_TREE
);
290 /* static */ bool ScriptTile::IsWithinTownInfluence(TileIndex tile
, TownID town_id
)
292 return ScriptTown::IsWithinTownInfluence(town_id
, tile
);
295 /* static */ TownID
ScriptTile::GetTownAuthority(TileIndex tile
)
297 if (!::IsValidTile(tile
)) return INVALID_TOWN
;
299 Town
*town
= ::ClosestTownFromTile(tile
, _settings_game
.economy
.dist_local_authority
);
300 if (town
== nullptr) return INVALID_TOWN
;
305 /* static */ TownID
ScriptTile::GetClosestTown(TileIndex tile
)
307 if (!::IsValidTile(tile
)) return INVALID_TOWN
;
309 Town
*town
= ::ClosestTownFromTile(tile
, UINT_MAX
);
310 if (town
== nullptr) return INVALID_TOWN
;
315 /* static */ Money
ScriptTile::GetBuildCost(BuildType build_type
)
317 switch (build_type
) {
318 case BT_FOUNDATION
: return ::GetPrice(PR_BUILD_FOUNDATION
, 1, nullptr);
319 case BT_TERRAFORM
: return ::GetPrice(PR_TERRAFORM
, 1, nullptr);
320 case BT_BUILD_TREES
: return ::GetPrice(PR_BUILD_TREES
, 1, nullptr);
321 case BT_CLEAR_GRASS
: return ::GetPrice(PR_CLEAR_GRASS
, 1, nullptr);
322 case BT_CLEAR_ROUGH
: return ::GetPrice(PR_CLEAR_ROUGH
, 1, nullptr);
323 case BT_CLEAR_ROCKY
: return ::GetPrice(PR_CLEAR_ROCKS
, 1, nullptr);
324 case BT_CLEAR_FIELDS
: return ::GetPrice(PR_CLEAR_FIELDS
, 1, nullptr);
325 case BT_CLEAR_HOUSE
: return ::GetPrice(PR_CLEAR_HOUSE
, 1, nullptr);