Codechange: Don't use a global for the terrforming error tile.

This commit is contained in:
Michael Lutz 2021-12-01 00:44:57 +01:00
parent 2e39637db2
commit c521b965bd
7 changed files with 46 additions and 54 deletions

View File

@ -1601,7 +1601,7 @@ static bool CheckIfCanLevelIndustryPlatform(TileIndex tile, DoCommandFlag flags,
} }
/* This is not 100% correct check, but the best we can do without modifying the map. /* This is not 100% correct check, but the best we can do without modifying the map.
* What is missing, is if the difference in height is more than 1.. */ * What is missing, is if the difference in height is more than 1.. */
if (Command<CMD_TERRAFORM_LAND>::Do(flags & ~DC_EXEC, tile_walk, SLOPE_N, curh <= h).Failed()) { if (std::get<0>(Command<CMD_TERRAFORM_LAND>::Do(flags & ~DC_EXEC, tile_walk, SLOPE_N, curh <= h)).Failed()) {
cur_company.Restore(); cur_company.Restore();
return false; return false;
} }

View File

@ -26,6 +26,7 @@
#include "zoom_func.h" #include "zoom_func.h"
#include "terraform_cmd.h" #include "terraform_cmd.h"
#include "object_cmd.h" #include "object_cmd.h"
#include "road_cmd.h"
#include "widgets/object_widget.h" #include "widgets/object_widget.h"
@ -543,7 +544,7 @@ public:
void OnPlaceObject(Point pt, TileIndex tile) override void OnPlaceObject(Point pt, TileIndex tile) override
{ {
ObjectClass *objclass = ObjectClass::Get(_selected_object_class); ObjectClass *objclass = ObjectClass::Get(_selected_object_class);
Command<CMD_BUILD_OBJECT>::Post(STR_ERROR_CAN_T_BUILD_OBJECT, CcTerraform, Command<CMD_BUILD_OBJECT>::Post(STR_ERROR_CAN_T_BUILD_OBJECT, CcPlaySound_CONSTRUCTION_OTHER,
tile, objclass->GetSpec(_selected_object_index)->Index(), _selected_object_view); tile, objclass->GetSpec(_selected_object_index)->Index(), _selected_object_view);
} }

View File

@ -38,8 +38,6 @@ struct TerraformerState {
TileIndexToHeightMap tile_to_new_height; ///< The tiles for which the height has changed. TileIndexToHeightMap tile_to_new_height; ///< The tiles for which the height has changed.
}; };
TileIndex _terraform_err_tile; ///< first tile we couldn't terraform
/** /**
* Gets the TileHeight (height of north corner) of a tile as of current terraforming progress. * Gets the TileHeight (height of north corner) of a tile as of current terraforming progress.
* *
@ -101,20 +99,20 @@ static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile)
* @param height Aimed height. * @param height Aimed height.
* @return Error code or cost. * @return Error code or cost.
*/ */
static CommandCost TerraformTileHeight(TerraformerState *ts, TileIndex tile, int height) static std::tuple<CommandCost, TileIndex> TerraformTileHeight(TerraformerState *ts, TileIndex tile, int height)
{ {
assert(tile < MapSize()); assert(tile < MapSize());
/* Check range of destination height */ /* Check range of destination height */
if (height < 0) return_cmd_error(STR_ERROR_ALREADY_AT_SEA_LEVEL); if (height < 0) return { CommandCost(STR_ERROR_ALREADY_AT_SEA_LEVEL), INVALID_TILE };
if (height > _settings_game.construction.map_height_limit) return_cmd_error(STR_ERROR_TOO_HIGH); if (height > _settings_game.construction.map_height_limit) return { CommandCost(STR_ERROR_TOO_HIGH), INVALID_TILE };
/* /*
* Check if the terraforming has any effect. * Check if the terraforming has any effect.
* This can only be true, if multiple corners of the start-tile are terraformed (i.e. the terraforming is done by towns/industries etc.). * This can only be true, if multiple corners of the start-tile are terraformed (i.e. the terraforming is done by towns/industries etc.).
* In this case the terraforming should fail. (Don't know why.) * In this case the terraforming should fail. (Don't know why.)
*/ */
if (height == TerraformGetHeightOfTile(ts, tile)) return CMD_ERROR; if (height == TerraformGetHeightOfTile(ts, tile)) return { CMD_ERROR, INVALID_TILE };
/* Check "too close to edge of map". Only possible when freeform-edges is off. */ /* Check "too close to edge of map". Only possible when freeform-edges is off. */
uint x = TileX(tile); uint x = TileX(tile);
@ -125,8 +123,7 @@ static CommandCost TerraformTileHeight(TerraformerState *ts, TileIndex tile, int
*/ */
if (x == 1) x = 0; if (x == 1) x = 0;
if (y == 1) y = 0; if (y == 1) y = 0;
_terraform_err_tile = TileXY(x, y); return { CommandCost(STR_ERROR_TOO_CLOSE_TO_EDGE_OF_MAP), TileXY(x, y) };
return_cmd_error(STR_ERROR_TOO_CLOSE_TO_EDGE_OF_MAP);
} }
/* Mark incident tiles that are involved in the terraforming. */ /* Mark incident tiles that are involved in the terraforming. */
@ -168,14 +165,14 @@ static CommandCost TerraformTileHeight(TerraformerState *ts, TileIndex tile, int
if (abs(height_diff) > 1) { if (abs(height_diff) > 1) {
/* Terraform the neighboured corner. The resulting height difference should be 1. */ /* Terraform the neighboured corner. The resulting height difference should be 1. */
height_diff += (height_diff < 0 ? 1 : -1); height_diff += (height_diff < 0 ? 1 : -1);
CommandCost cost = TerraformTileHeight(ts, tile, r + height_diff); auto [cost, err_tile] = TerraformTileHeight(ts, tile, r + height_diff);
if (cost.Failed()) return cost; if (cost.Failed()) return { cost, err_tile };
total_cost.AddCost(cost); total_cost.AddCost(cost);
} }
} }
} }
return total_cost; return { total_cost, INVALID_TILE };
} }
/** /**
@ -186,10 +183,8 @@ static CommandCost TerraformTileHeight(TerraformerState *ts, TileIndex tile, int
* @param dir_up direction; eg up (true) or down (false) * @param dir_up direction; eg up (true) or down (false)
* @return the cost of this operation or an error * @return the cost of this operation or an error
*/ */
CommandCost CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, bool dir_up) std::tuple<CommandCost, Money, TileIndex> CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, bool dir_up)
{ {
_terraform_err_tile = INVALID_TILE;
CommandCost total_cost(EXPENSES_CONSTRUCTION); CommandCost total_cost(EXPENSES_CONSTRUCTION);
int direction = (dir_up ? 1 : -1); int direction = (dir_up ? 1 : -1);
TerraformerState ts; TerraformerState ts;
@ -197,29 +192,29 @@ CommandCost CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, b
/* Compute the costs and the terraforming result in a model of the landscape */ /* Compute the costs and the terraforming result in a model of the landscape */
if ((slope & SLOPE_W) != 0 && tile + TileDiffXY(1, 0) < MapSize()) { if ((slope & SLOPE_W) != 0 && tile + TileDiffXY(1, 0) < MapSize()) {
TileIndex t = tile + TileDiffXY(1, 0); TileIndex t = tile + TileDiffXY(1, 0);
CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction); auto [cost, err_tile] = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
if (cost.Failed()) return cost; if (cost.Failed()) return { cost, 0, err_tile };
total_cost.AddCost(cost); total_cost.AddCost(cost);
} }
if ((slope & SLOPE_S) != 0 && tile + TileDiffXY(1, 1) < MapSize()) { if ((slope & SLOPE_S) != 0 && tile + TileDiffXY(1, 1) < MapSize()) {
TileIndex t = tile + TileDiffXY(1, 1); TileIndex t = tile + TileDiffXY(1, 1);
CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction); auto [cost, err_tile] = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
if (cost.Failed()) return cost; if (cost.Failed()) return { cost, 0, err_tile };
total_cost.AddCost(cost); total_cost.AddCost(cost);
} }
if ((slope & SLOPE_E) != 0 && tile + TileDiffXY(0, 1) < MapSize()) { if ((slope & SLOPE_E) != 0 && tile + TileDiffXY(0, 1) < MapSize()) {
TileIndex t = tile + TileDiffXY(0, 1); TileIndex t = tile + TileDiffXY(0, 1);
CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction); auto [cost, err_tile] = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
if (cost.Failed()) return cost; if (cost.Failed()) return { cost, 0, err_tile };
total_cost.AddCost(cost); total_cost.AddCost(cost);
} }
if ((slope & SLOPE_N) != 0) { if ((slope & SLOPE_N) != 0) {
TileIndex t = tile + TileDiffXY(0, 0); TileIndex t = tile + TileDiffXY(0, 0);
CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction); auto [cost, err_tile] = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
if (cost.Failed()) return cost; if (cost.Failed()) return { cost, 0, err_tile };
total_cost.AddCost(cost); total_cost.AddCost(cost);
} }
@ -259,20 +254,17 @@ CommandCost CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, b
/* Check if bridge would take damage. */ /* Check if bridge would take damage. */
if (direction == 1 && bridge_height <= z_max) { if (direction == 1 && bridge_height <= z_max) {
_terraform_err_tile = t; // highlight the tile under the bridge return { CommandCost(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST), 0, t }; // highlight the tile under the bridge
return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
} }
/* Is the bridge above not too high afterwards? */ /* Is the bridge above not too high afterwards? */
if (direction == -1 && bridge_height > (z_min + _settings_game.construction.max_bridge_height)) { if (direction == -1 && bridge_height > (z_min + _settings_game.construction.max_bridge_height)) {
_terraform_err_tile = t; return { CommandCost(STR_ERROR_BRIDGE_TOO_HIGH_AFTER_LOWER_LAND), 0, t };
return_cmd_error(STR_ERROR_BRIDGE_TOO_HIGH_AFTER_LOWER_LAND);
} }
} }
/* Check if tunnel would take damage */ /* Check if tunnel would take damage */
if (direction == -1 && IsTunnelInWay(t, z_min)) { if (direction == -1 && IsTunnelInWay(t, z_min)) {
_terraform_err_tile = t; // highlight the tile above the tunnel return { CommandCost(STR_ERROR_EXCAVATION_WOULD_DAMAGE), 0, t }; // highlight the tile above the tunnel
return_cmd_error(STR_ERROR_EXCAVATION_WOULD_DAMAGE);
} }
} }
@ -296,8 +288,7 @@ CommandCost CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, b
} }
old_generating_world.Restore(); old_generating_world.Restore();
if (cost.Failed()) { if (cost.Failed()) {
_terraform_err_tile = t; return { cost, 0, t };
return cost;
} }
if (pass == 1) total_cost.AddCost(cost); if (pass == 1) total_cost.AddCost(cost);
} }
@ -305,7 +296,7 @@ CommandCost CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, b
Company *c = Company::GetIfValid(_current_company); Company *c = Company::GetIfValid(_current_company);
if (c != nullptr && GB(c->terraform_limit, 16, 16) < ts.tile_to_new_height.size()) { if (c != nullptr && GB(c->terraform_limit, 16, 16) < ts.tile_to_new_height.size()) {
return_cmd_error(STR_ERROR_TERRAFORM_LIMIT_REACHED); return { CommandCost(STR_ERROR_TERRAFORM_LIMIT_REACHED), 0, INVALID_TILE };
} }
if (flags & DC_EXEC) { if (flags & DC_EXEC) {
@ -328,7 +319,7 @@ CommandCost CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, b
if (c != nullptr) c->terraform_limit -= (uint32)ts.tile_to_new_height.size() << 16; if (c != nullptr) c->terraform_limit -= (uint32)ts.tile_to_new_height.size() << 16;
} }
return total_cost; return { total_cost, 0, total_cost.Succeeded() ? tile : INVALID_TILE };
} }
@ -341,11 +332,9 @@ CommandCost CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, b
* @param LevelMode Mode of leveling \c LevelMode. * @param LevelMode Mode of leveling \c LevelMode.
* @return the cost of this operation or an error * @return the cost of this operation or an error
*/ */
std::tuple<CommandCost, Money> CmdLevelLand(DoCommandFlag flags, TileIndex tile, TileIndex start_tile, bool diagonal, LevelMode lm) std::tuple<CommandCost, Money, TileIndex> CmdLevelLand(DoCommandFlag flags, TileIndex tile, TileIndex start_tile, bool diagonal, LevelMode lm)
{ {
if (start_tile >= MapSize()) return { CMD_ERROR, 0 }; if (start_tile >= MapSize()) return { CMD_ERROR, 0, INVALID_TILE };
_terraform_err_tile = INVALID_TILE;
/* remember level height */ /* remember level height */
uint oldh = TileHeight(start_tile); uint oldh = TileHeight(start_tile);
@ -356,11 +345,11 @@ std::tuple<CommandCost, Money> CmdLevelLand(DoCommandFlag flags, TileIndex tile,
case LM_LEVEL: break; case LM_LEVEL: break;
case LM_RAISE: h++; break; case LM_RAISE: h++; break;
case LM_LOWER: h--; break; case LM_LOWER: h--; break;
default: return { CMD_ERROR, 0 }; default: return { CMD_ERROR, 0, INVALID_TILE };
} }
/* Check range of destination height */ /* Check range of destination height */
if (h > _settings_game.construction.map_height_limit) return { CommandCost(oldh == 0 ? STR_ERROR_ALREADY_AT_SEA_LEVEL : STR_ERROR_TOO_HIGH), 0 }; if (h > _settings_game.construction.map_height_limit) return { CommandCost(oldh == 0 ? STR_ERROR_ALREADY_AT_SEA_LEVEL : STR_ERROR_TOO_HIGH), 0, INVALID_TILE };
Money money = GetAvailableMoneyForCommand(); Money money = GetAvailableMoneyForCommand();
CommandCost cost(EXPENSES_CONSTRUCTION); CommandCost cost(EXPENSES_CONSTRUCTION);
@ -369,14 +358,16 @@ std::tuple<CommandCost, Money> CmdLevelLand(DoCommandFlag flags, TileIndex tile,
const Company *c = Company::GetIfValid(_current_company); const Company *c = Company::GetIfValid(_current_company);
int limit = (c == nullptr ? INT32_MAX : GB(c->terraform_limit, 16, 16)); int limit = (c == nullptr ? INT32_MAX : GB(c->terraform_limit, 16, 16));
if (limit == 0) return { CommandCost(STR_ERROR_TERRAFORM_LIMIT_REACHED), 0 }; if (limit == 0) return { CommandCost(STR_ERROR_TERRAFORM_LIMIT_REACHED), 0, INVALID_TILE };
TileIndex error_tile = INVALID_TILE;
TileIterator *iter = diagonal ? (TileIterator *)new DiagonalTileIterator(tile, start_tile) : new OrthogonalTileIterator(tile, start_tile); TileIterator *iter = diagonal ? (TileIterator *)new DiagonalTileIterator(tile, start_tile) : new OrthogonalTileIterator(tile, start_tile);
for (; *iter != INVALID_TILE; ++(*iter)) { for (; *iter != INVALID_TILE; ++(*iter)) {
TileIndex t = *iter; TileIndex t = *iter;
uint curh = TileHeight(t); uint curh = TileHeight(t);
while (curh != h) { while (curh != h) {
CommandCost ret = Command<CMD_TERRAFORM_LAND>::Do(flags & ~DC_EXEC, t, SLOPE_N, curh <= h); CommandCost ret;
std::tie(ret, std::ignore, error_tile) = Command<CMD_TERRAFORM_LAND>::Do(flags & ~DC_EXEC, t, SLOPE_N, curh <= h);
if (ret.Failed()) { if (ret.Failed()) {
last_error = ret; last_error = ret;
@ -389,7 +380,7 @@ std::tuple<CommandCost, Money> CmdLevelLand(DoCommandFlag flags, TileIndex tile,
money -= ret.GetCost(); money -= ret.GetCost();
if (money < 0) { if (money < 0) {
delete iter; delete iter;
return { cost, ret.GetCost() }; return { cost, ret.GetCost(), error_tile };
} }
Command<CMD_TERRAFORM_LAND>::Do(flags, t, SLOPE_N, curh <= h); Command<CMD_TERRAFORM_LAND>::Do(flags, t, SLOPE_N, curh <= h);
} else { } else {
@ -413,5 +404,6 @@ std::tuple<CommandCost, Money> CmdLevelLand(DoCommandFlag flags, TileIndex tile,
} }
delete iter; delete iter;
return { had_success ? cost : last_error, 0 }; CommandCost cc_ret = had_success ? cost : last_error;
return { cc_ret, 0, cc_ret.Succeeded() ? tile : error_tile };
} }

View File

@ -14,13 +14,13 @@
#include "map_type.h" #include "map_type.h"
#include "slope_type.h" #include "slope_type.h"
CommandCost CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, bool dir_up); std::tuple<CommandCost, Money, TileIndex> CmdTerraformLand(DoCommandFlag flags, TileIndex tile, Slope slope, bool dir_up);
std::tuple<CommandCost, Money> CmdLevelLand(DoCommandFlag flags, TileIndex tile, TileIndex start_tile, bool diagonal, LevelMode lm); std::tuple<CommandCost, Money, TileIndex> CmdLevelLand(DoCommandFlag flags, TileIndex tile, TileIndex start_tile, bool diagonal, LevelMode lm);
DEF_CMD_TRAIT(CMD_TERRAFORM_LAND, CmdTerraformLand, CMD_ALL_TILES | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION) DEF_CMD_TRAIT(CMD_TERRAFORM_LAND, CmdTerraformLand, CMD_ALL_TILES | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION)
DEF_CMD_TRAIT(CMD_LEVEL_LAND, CmdLevelLand, CMD_ALL_TILES | CMD_AUTO | CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION) // test run might clear tiles multiple times, in execution that only happens once DEF_CMD_TRAIT(CMD_LEVEL_LAND, CmdLevelLand, CMD_ALL_TILES | CMD_AUTO | CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION) // test run might clear tiles multiple times, in execution that only happens once
CommandCallback CcPlaySound_EXPLOSION; CommandCallback CcPlaySound_EXPLOSION;
CommandCallback CcTerraform; void CcTerraform(Commands cmd, const CommandCost &result, Money, TileIndex tile);
#endif /* TERRAFORM_CMD_H */ #endif /* TERRAFORM_CMD_H */

View File

@ -44,13 +44,12 @@
#include "safeguards.h" #include "safeguards.h"
void CcTerraform(Commands cmd, const CommandCost &result, TileIndex tile) void CcTerraform(Commands cmd, const CommandCost &result, Money, TileIndex tile)
{ {
if (result.Succeeded()) { if (result.Succeeded()) {
if (_settings_client.sound.confirm) SndPlayTileFx(SND_1F_CONSTRUCTION_OTHER, tile); if (_settings_client.sound.confirm) SndPlayTileFx(SND_1F_CONSTRUCTION_OTHER, tile);
} else { } else {
extern TileIndex _terraform_err_tile; SetRedErrorSquare(tile);
SetRedErrorSquare(_terraform_err_tile);
} }
} }

View File

@ -959,8 +959,8 @@ static bool IsRoadAllowedHere(Town *t, TileIndex tile, DiagDirection dir)
CommandCost res = CMD_ERROR; CommandCost res = CMD_ERROR;
if (!_generating_world && Chance16(1, 10)) { if (!_generating_world && Chance16(1, 10)) {
/* Note: Do not replace "^ SLOPE_ELEVATED" with ComplementSlope(). The slope might be steep. */ /* Note: Do not replace "^ SLOPE_ELEVATED" with ComplementSlope(). The slope might be steep. */
res = Command<CMD_TERRAFORM_LAND>::Do(DC_EXEC | DC_AUTO | DC_NO_WATER, res = std::get<0>(Command<CMD_TERRAFORM_LAND>::Do(DC_EXEC | DC_AUTO | DC_NO_WATER,
tile, Chance16(1, 16) ? cur_slope : cur_slope ^ SLOPE_ELEVATED, false); tile, Chance16(1, 16) ? cur_slope : cur_slope ^ SLOPE_ELEVATED, false));
} }
if (res.Failed() && Chance16(1, 3)) { if (res.Failed() && Chance16(1, 3)) {
/* We can consider building on the slope, though. */ /* We can consider building on the slope, though. */
@ -976,7 +976,7 @@ static bool TerraformTownTile(TileIndex tile, Slope edges, bool dir)
{ {
assert(tile < MapSize()); assert(tile < MapSize());
CommandCost r = Command<CMD_TERRAFORM_LAND>::Do(DC_AUTO | DC_NO_WATER, tile, edges, dir); CommandCost r = std::get<0>(Command<CMD_TERRAFORM_LAND>::Do(DC_AUTO | DC_NO_WATER, tile, edges, dir));
if (r.Failed() || r.GetCost() >= (_price[PR_TERRAFORM] + 2) * 8) return false; if (r.Failed() || r.GetCost() >= (_price[PR_TERRAFORM] + 2) * 8) return false;
Command<CMD_TERRAFORM_LAND>::Do(DC_AUTO | DC_NO_WATER | DC_EXEC, tile, edges, dir); Command<CMD_TERRAFORM_LAND>::Do(DC_AUTO | DC_NO_WATER | DC_EXEC, tile, edges, dir);
return true; return true;

View File

@ -755,7 +755,7 @@ CommandCost CmdBuildTunnel(DoCommandFlag flags, TileIndex start_tile, TransportT
assert(coa_index < UINT_MAX); // more than 2**32 cleared areas would be a bug in itself assert(coa_index < UINT_MAX); // more than 2**32 cleared areas would be a bug in itself
coa = nullptr; coa = nullptr;
ret = Command<CMD_TERRAFORM_LAND>::Do(flags, end_tile, end_tileh & start_tileh, false); ret = std::get<0>(Command<CMD_TERRAFORM_LAND>::Do(flags, end_tile, end_tileh & start_tileh, false));
_cleared_object_areas[(uint)coa_index].first_tile = old_first_tile; _cleared_object_areas[(uint)coa_index].first_tile = old_first_tile;
if (ret.Failed()) return_cmd_error(STR_ERROR_UNABLE_TO_EXCAVATE_LAND); if (ret.Failed()) return_cmd_error(STR_ERROR_UNABLE_TO_EXCAVATE_LAND);
cost.AddCost(ret); cost.AddCost(ret);