# terraform_cmd.cpp

Go to the documentation of this file.

    00001 /* $Id$ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * 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.
    00006  * 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.
    00007  * 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/>.
    00008  */
    00009
    00012 #include "stdafx.h"
    00013 #include "command_func.h"
    00014 #include "tunnel_map.h"
    00015 #include "bridge_map.h"
    00016 #include "viewport_func.h"
    00017 #include "economy_func.h"
    00018 #include "genworld.h"
    00019 #include "object_base.h"
    00020 #include "company_base.h"
    00021 #include "company_func.h"
    00022
    00023 #include "table/strings.h"
    00024
    00025 /*
    00026  * In one terraforming command all four corners of a initial tile can be raised/lowered (though this is not available to the player).
    00027  * The maximal amount of height modifications is archieved when raising a complete flat land from sea level to MAX_TILE_HEIGHT or vice versa.
    00028  * This affects all corners with a manhatten distance smaller than MAX_TILE_HEIGHT to one of the initial 4 corners.
    00029  * Their maximal amount is computed to 4 * \sum_{i=1}^{h_max} i  =  2 * h_max * (h_max + 1).
    00030  */
    00031 static const int TERRAFORMER_MODHEIGHT_SIZE = 2 * MAX_TILE_HEIGHT * (MAX_TILE_HEIGHT + 1);
    00032
    00033 /*
    00034  * The maximal amount of affected tiles (i.e. the tiles that incident with one of the corners above, is computed similiar to
    00035  * 1 + 4 * \sum_{i=1}^{h_max} (i+1)  =  1 + 2 * h_max + (h_max + 3).
    00036  */
    00037 static const int TERRAFORMER_TILE_TABLE_SIZE = 1 + 2 * MAX_TILE_HEIGHT * (MAX_TILE_HEIGHT + 3);
    00038
    00039 struct TerraformerHeightMod {
    00040   TileIndex tile;
    00041   byte height;
    00042 };
    00043
    00044 struct TerraformerState {
    00045   int modheight_count;
    00046   int tile_table_count;
    00047
    00055   TileIndex tile_table[TERRAFORMER_TILE_TABLE_SIZE];
    00056   TerraformerHeightMod modheight[TERRAFORMER_MODHEIGHT_SIZE];
    00057 };
    00058
    00059 TileIndex _terraform_err_tile;
    00060
    00068 static int TerraformGetHeightOfTile(const TerraformerState *ts, TileIndex tile)
    00069 {
    00070   const TerraformerHeightMod *mod = ts->modheight;
    00071
    00072   for (int count = ts->modheight_count; count != 0; count--, mod++) {
    00073     if (mod->tile == tile) return mod->height;
    00074   }
    00075
    00076   /* TileHeight unchanged so far, read value from map. */
    00077   return TileHeight(tile);
    00078 }
    00079
    00087 static void TerraformSetHeightOfTile(TerraformerState *ts, TileIndex tile, int height)
    00088 {
    00089   /* Find tile in the "modheight" table.
    00090    * Note: In a normal user-terraform command the tile will not be found in the "modheight" table.
    00091    *       But during house- or industry-construction multiple corners can be terraformed at once. */
    00092   TerraformerHeightMod *mod = ts->modheight;
    00093   int count = ts->modheight_count;
    00094
    00095   while ((count > 0) && (mod->tile != tile)) {
    00096     mod++;
    00097     count--;
    00098   }
    00099
    00100   /* New entry? */
    00101   if (count == 0) {
    00102     assert(ts->modheight_count < TERRAFORMER_MODHEIGHT_SIZE);
    00103     ts->modheight_count++;
    00104   }
    00105
    00106   /* Finally store the new value */
    00107   mod->tile = tile;
    00108   mod->height = (byte)height;
    00109 }
    00110
    00118 static void TerraformAddDirtyTile(TerraformerState *ts, TileIndex tile)
    00119 {
    00120   int count = ts->tile_table_count;
    00121
    00122   for (TileIndex *t = ts->tile_table; count != 0; count--, t++) {
    00123     if (*t == tile) return;
    00124   }
    00125
    00126   assert(ts->tile_table_count < TERRAFORMER_TILE_TABLE_SIZE);
    00127
    00128   ts->tile_table[ts->tile_table_count++] = tile;
    00129 }
    00130
    00138 static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile)
    00139 {
    00140   /* Make sure all tiles passed to TerraformAddDirtyTile are within [0, MapSize()] */
    00141   if (TileY(tile) >= 1) TerraformAddDirtyTile(ts, tile + TileDiffXY( 0, -1));
    00142   if (TileY(tile) >= 1 && TileX(tile) >= 1) TerraformAddDirtyTile(ts, tile + TileDiffXY(-1, -1));
    00143   if (TileX(tile) >= 1) TerraformAddDirtyTile(ts, tile + TileDiffXY(-1,  0));
    00144   TerraformAddDirtyTile(ts, tile);
    00145 }
    00146
    00155 static CommandCost TerraformTileHeight(TerraformerState *ts, TileIndex tile, int height)
    00156 {
    00157   assert(tile < MapSize());
    00158
    00159   /* Check range of destination height */
    00160   if (height < 0) return_cmd_error(STR_ERROR_ALREADY_AT_SEA_LEVEL);
    00161   if (height > (int)MAX_TILE_HEIGHT) return_cmd_error(STR_ERROR_TOO_HIGH);
    00162
    00163   /*
    00164    * Check if the terraforming has any effect.
    00165    * This can only be true, if multiple corners of the start-tile are terraformed (i.e. the terraforming is done by towns/industries etc.).
    00166    * In this case the terraforming should fail. (Don't know why.)
    00167    */
    00168   if (height == TerraformGetHeightOfTile(ts, tile)) return CMD_ERROR;
    00169
    00170   /* Check "too close to edge of map". Only possible when freeform-edges is off. */
    00171   uint x = TileX(tile);
    00172   uint y = TileY(tile);
    00173   if (!_settings_game.construction.freeform_edges && ((x <= 1) || (y <= 1) || (x >= MapMaxX() - 1) || (y >= MapMaxY() - 1))) {
    00174     /*
    00175      * Determine a sensible error tile
    00176      */
    00177     if (x == 1) x = 0;
    00178     if (y == 1) y = 0;
    00179     _terraform_err_tile = TileXY(x, y);
    00180     return_cmd_error(STR_ERROR_TOO_CLOSE_TO_EDGE_OF_MAP);
    00181   }
    00182
    00183   /* Mark incident tiles that are involved in the terraforming. */
    00184   TerraformAddDirtyTileAround(ts, tile);
    00185
    00186   /* Store the height modification */
    00187   TerraformSetHeightOfTile(ts, tile, height);
    00188
    00189   CommandCost total_cost(EXPENSES_CONSTRUCTION);
    00190
    00191   /* Increment cost */
    00192   total_cost.AddCost(_price[PR_TERRAFORM]);
    00193
    00194   /* Recurse to neighboured corners if height difference is larger than 1 */
    00195   {
    00196     const TileIndexDiffC *ttm;
    00197
    00198     TileIndex orig_tile = tile;
    00199     static const TileIndexDiffC _terraform_tilepos[] = {
    00200       { 1,  0}, // move to tile in SE
    00201       {-2,  0}, // undo last move, and move to tile in NW
    00202       { 1,  1}, // undo last move, and move to tile in SW
    00203       { 0, -2}  // undo last move, and move to tile in NE
    00204     };
    00205
    00206     for (ttm = _terraform_tilepos; ttm != endof(_terraform_tilepos); ttm++) {
    00207       tile += ToTileIndexDiff(*ttm);
    00208
    00209       if (tile >= MapSize()) continue;
    00210       /* Make sure we don't wrap around the map */
    00211       if (Delta(TileX(orig_tile), TileX(tile)) == MapSizeX() - 1) continue;
    00212       if (Delta(TileY(orig_tile), TileY(tile)) == MapSizeY() - 1) continue;
    00213
    00214       /* Get TileHeight of neighboured tile as of current terraform progress */
    00215       int r = TerraformGetHeightOfTile(ts, tile);
    00216       int height_diff = height - r;
    00217
    00218       /* Is the height difference to the neighboured corner greater than 1? */
    00219       if (abs(height_diff) > 1) {
    00220         /* Terraform the neighboured corner. The resulting height difference should be 1. */
    00221         height_diff += (height_diff < 0 ? 1 : -1);
    00222         CommandCost cost = TerraformTileHeight(ts, tile, r + height_diff);
    00223         if (cost.Failed()) return cost;
    00224         total_cost.AddCost(cost);
    00225       }
    00226     }
    00227   }
    00228
    00229   return total_cost;
    00230 }
    00231
    00241 CommandCost CmdTerraformLand(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
    00242 {
    00243   _terraform_err_tile = INVALID_TILE;
    00244
    00245   CommandCost total_cost(EXPENSES_CONSTRUCTION);
    00246   int direction = (p2 != 0 ? 1 : -1);
    00247   TerraformerState ts;
    00248
    00249   ts.modheight_count = ts.tile_table_count = 0;
    00250
    00251   /* Compute the costs and the terraforming result in a model of the landscape */
    00252   if ((p1 & SLOPE_W) != 0 && tile + TileDiffXY(1, 0) < MapSize()) {
    00253     TileIndex t = tile + TileDiffXY(1, 0);
    00254     CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
    00255     if (cost.Failed()) return cost;
    00256     total_cost.AddCost(cost);
    00257   }
    00258
    00259   if ((p1 & SLOPE_S) != 0 && tile + TileDiffXY(1, 1) < MapSize()) {
    00260     TileIndex t = tile + TileDiffXY(1, 1);
    00261     CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
    00262     if (cost.Failed()) return cost;
    00263     total_cost.AddCost(cost);
    00264   }
    00265
    00266   if ((p1 & SLOPE_E) != 0 && tile + TileDiffXY(0, 1) < MapSize()) {
    00267     TileIndex t = tile + TileDiffXY(0, 1);
    00268     CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
    00269     if (cost.Failed()) return cost;
    00270     total_cost.AddCost(cost);
    00271   }
    00272
    00273   if ((p1 & SLOPE_N) != 0) {
    00274     TileIndex t = tile + TileDiffXY(0, 0);
    00275     CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
    00276     if (cost.Failed()) return cost;
    00277     total_cost.AddCost(cost);
    00278   }
    00279
    00280   /* Check if the terraforming is valid wrt. tunnels, bridges and objects on the surface
    00281    * Pass == 0: Collect tileareas which are caused to be auto-cleared.
    00282    * Pass == 1: Collect the actual cost. */
    00283   for (int pass = 0; pass < 2; pass++) {
    00284     TileIndex *ti = ts.tile_table;
    00285
    00286     for (int count = ts.tile_table_count; count != 0; count--, ti++) {
    00287       TileIndex tile = *ti;
    00288
    00289       assert(tile < MapSize());
    00290       /* MP_VOID tiles can be terraformed but as tunnels and bridges
    00291        * cannot go under / over these tiles they don't need checking. */
    00292       if (IsTileType(tile, MP_VOID)) continue;
    00293
    00294       /* Find new heights of tile corners */
    00295       uint z_N = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(0, 0));
    00296       uint z_W = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(1, 0));
    00297       uint z_S = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(1, 1));
    00298       uint z_E = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(0, 1));
    00299
    00300       /* Find min and max height of tile */
    00301       uint z_min = min(min(z_N, z_W), min(z_S, z_E));
    00302       uint z_max = max(max(z_N, z_W), max(z_S, z_E));
    00303
    00304       /* Compute tile slope */
    00305       Slope tileh = (z_max > z_min + 1 ? SLOPE_STEEP : SLOPE_FLAT);
    00306       if (z_W > z_min) tileh |= SLOPE_W;
    00307       if (z_S > z_min) tileh |= SLOPE_S;
    00308       if (z_E > z_min) tileh |= SLOPE_E;
    00309       if (z_N > z_min) tileh |= SLOPE_N;
    00310
    00311       /* Check if bridge would take damage */
    00312       if (direction == 1 && MayHaveBridgeAbove(tile) && IsBridgeAbove(tile) &&
    00313           GetBridgeHeight(GetSouthernBridgeEnd(tile)) <= z_max * TILE_HEIGHT) {
    00314         _terraform_err_tile = tile; // highlight the tile under the bridge
    00315         return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
    00316       }
    00317       /* Check if tunnel would take damage */
    00318       if (direction == -1 && IsTunnelInWay(tile, z_min * TILE_HEIGHT)) {
    00319         _terraform_err_tile = tile; // highlight the tile above the tunnel
    00320         return_cmd_error(STR_ERROR_EXCAVATION_WOULD_DAMAGE);
    00321       }
    00322
    00323       /* Is the tile already cleared? */
    00324       const ClearedObjectArea *coa = FindClearedObject(tile);
    00325       bool indirectly_cleared = coa != NULL && coa->first_tile != tile;
    00326
    00327       /* Check tiletype-specific things, and add extra-cost */
    00328       const bool curr_gen = _generating_world;
    00329       if (_game_mode == GM_EDITOR) _generating_world = true; // used to create green terraformed land
    00330       DoCommandFlag tile_flags = flags | DC_AUTO | DC_FORCE_CLEAR_TILE;
    00331       if (pass == 0) {
    00332         tile_flags &= ~DC_EXEC;
    00333         tile_flags |= DC_NO_MODIFY_TOWN_RATING;
    00334       }
    00335       CommandCost cost;
    00336       if (indirectly_cleared) {
    00337         cost = DoCommand(tile, 0, 0, tile_flags, CMD_LANDSCAPE_CLEAR);
    00338       } else {
    00339         cost = _tile_type_procs[GetTileType(tile)]->terraform_tile_proc(tile, tile_flags, z_min * TILE_HEIGHT, tileh);
    00340       }
    00341       _generating_world = curr_gen;
    00342       if (cost.Failed()) {
    00343         _terraform_err_tile = tile;
    00344         return cost;
    00345       }
    00346       if (pass == 1) total_cost.AddCost(cost);
    00347     }
    00348   }
    00349
    00350   Company *c = Company::GetIfValid(_current_company);
    00351   if (c != NULL && (int)GB(c->terraform_limit, 16, 16) < ts.modheight_count) {
    00352     return_cmd_error(STR_ERROR_TERRAFORM_LIMIT_REACHED);
    00353   }
    00354
    00355   if (flags & DC_EXEC) {
    00356     /* change the height */
    00357     {
    00358       int count;
    00359       TerraformerHeightMod *mod;
    00360
    00361       mod = ts.modheight;
    00362       for (count = ts.modheight_count; count != 0; count--, mod++) {
    00363         TileIndex til = mod->tile;
    00364
    00365         SetTileHeight(til, mod->height);
    00366       }
    00367     }
    00368
    00369     /* finally mark the dirty tiles dirty */
    00370     {
    00371       int count;
    00372       TileIndex *ti = ts.tile_table;
    00373       for (count = ts.tile_table_count; count != 0; count--, ti++) {
    00374         MarkTileDirtyByTile(*ti);
    00375       }
    00376     }
    00377
    00378     if (c != NULL) c->terraform_limit -= ts.modheight_count << 16;
    00379   }
    00380   return total_cost;
    00381 }
    00382
    00383
    00395 CommandCost CmdLevelLand(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
    00396 {
    00397   if (p1 >= MapSize()) return CMD_ERROR;
    00398
    00399   _terraform_err_tile = INVALID_TILE;
    00400
    00401   /* remember level height */
    00402   uint oldh = TileHeight(p1);
    00403
    00404   /* compute new height */
    00405   uint h = oldh;
    00406   LevelMode lm = (LevelMode)GB(p2, 1, 2);
    00407   switch (lm) {
    00408     case LM_LEVEL: break;
    00409     case LM_RAISE: h++; break;
    00410     case LM_LOWER: h--; break;
    00411     default: return CMD_ERROR;
    00412   }
    00413
    00414   /* Check range of destination height */
    00415   if (h > MAX_TILE_HEIGHT) return_cmd_error((oldh == 0) ? STR_ERROR_ALREADY_AT_SEA_LEVEL : STR_ERROR_TOO_HIGH);
    00416
    00417   Money money = GetAvailableMoneyForCommand();
    00418   CommandCost cost(EXPENSES_CONSTRUCTION);
    00419   CommandCost last_error(lm == LM_LEVEL ? STR_ERROR_ALREADY_LEVELLED : INVALID_STRING_ID);
    00420   bool had_success = false;
    00421
    00422   const Company *c = Company::GetIfValid(_current_company);
    00423   int limit = (c == NULL ? INT32_MAX : GB(c->terraform_limit, 16, 16));
    00424   if (limit == 0) return_cmd_error(STR_ERROR_TERRAFORM_LIMIT_REACHED);
    00425
    00426   TileArea ta(tile, p1);
    00427   TileIterator *iter = HasBit(p2, 0) ? (TileIterator *)new DiagonalTileIterator(tile, p1) : new OrthogonalTileIterator(ta);
    00428   for (; *iter != INVALID_TILE; ++(*iter)) {
    00429     TileIndex t = *iter;
    00430     uint curh = TileHeight(t);
    00431     while (curh != h) {
    00432       CommandCost ret = DoCommand(t, SLOPE_N, (curh > h) ? 0 : 1, flags & ~DC_EXEC, CMD_TERRAFORM_LAND);
    00433       if (ret.Failed()) {
    00434         last_error = ret;
    00435
    00436         /* Did we reach the limit? */
    00437         if (ret.GetErrorMessage() == STR_ERROR_TERRAFORM_LIMIT_REACHED) limit = 0;
    00438         break;
    00439       }
    00440
    00441       if (flags & DC_EXEC) {
    00442         money -= ret.GetCost();
    00443         if (money < 0) {
    00444           _additional_cash_required = ret.GetCost();
    00445           delete iter;
    00446           return cost;
    00447         }
    00448         DoCommand(t, SLOPE_N, (curh > h) ? 0 : 1, flags, CMD_TERRAFORM_LAND);
    00449       } else {
    00450         /* When we're at the terraform limit we better bail (unneeded) testing as well.
    00451          * This will probably cause the terraforming cost to be underestimated, but only
    00452          * when it's near the terraforming limit. Even then, the estimation is
    00453          * completely off due to it basically counting terraforming double, so it being
    00454          * cut off earlier might even give a better estimate in some cases. */
    00455         if (--limit <= 0) {
    00456           had_success = true;
    00457           break;
    00458         }
    00459       }
    00460
    00461       cost.AddCost(ret);
    00462       curh += (curh > h) ? -1 : 1;
    00463       had_success = true;
    00464     }
    00465
    00466     if (limit <= 0) break;
    00467   }
    00468
    00469   delete iter;
    00470   return had_success ? cost : last_error;
    00471 }