tron@2186: /* $Id$ */
tron@2186: 
rubidium@8706: /** @file terraform_cmd.cpp Commands related to terraforming. */
belugas@6449: 
truelight@0: #include "stdafx.h"
Darkvater@1891: #include "openttd.h"
rubidium@8706: #include "strings_type.h"
rubidium@8612: #include "command_func.h"
rubidium@8706: #include "tile_map.h"
tron@3156: #include "tunnel_map.h"
celestar@5573: #include "bridge_map.h"
tron@2153: #include "variables.h"
rubidium@8627: #include "functions.h"
rubidium@8634: #include "economy_func.h"
truelight@0: 
rubidium@8760: #include "table/strings.h"
rubidium@8760: 
rubidium@8013: /*
rubidium@8013:  * In one terraforming command all four corners of a initial tile can be raised/lowered (though this is not available to the player).
rubidium@8013:  * The maximal amount of height modifications is archieved when raising a complete flat land from sea level to MAX_TILE_HEIGHT or vice versa.
rubidium@8013:  * This affects all corners with a manhatten distance smaller than MAX_TILE_HEIGHT to one of the initial 4 corners.
rubidium@8013:  * Their maximal amount is computed to 4 * \sum_{i=1}^{h_max} i  =  2 * h_max * (h_max + 1).
rubidium@8013:  */
rubidium@8013: static const int TERRAFORMER_MODHEIGHT_SIZE = 2 * MAX_TILE_HEIGHT * (MAX_TILE_HEIGHT + 1);
rubidium@8013: 
rubidium@8013: /*
rubidium@8013:  * The maximal amount of affected tiles (i.e. the tiles that incident with one of the corners above, is computed similiar to
rubidium@8013:  * 1 + 4 * \sum_{i=1}^{h_max} (i+1)  =  1 + 2 * h_max + (h_max + 3).
rubidium@8013:  */
rubidium@8013: static const int TERRAFORMER_TILE_TABLE_SIZE = 1 + 2 * MAX_TILE_HEIGHT * (MAX_TILE_HEIGHT + 3);
rubidium@7976: 
rubidium@6574: struct TerraformerHeightMod {
rubidium@7976: 	TileIndex tile;   ///< Referenced tile.
rubidium@7976: 	byte height;      ///< New TileHeight (height of north corner) of the tile.
rubidium@6574: };
truelight@0: 
rubidium@6574: struct TerraformerState {
smatz@9312: 	int modheight_count;  ///< amount of entries in "modheight".
smatz@9312: 	int tile_table_count; ///< amount of entries in "tile_table".
truelight@193: 
rubidium@8041: 	/**
rubidium@8041: 	 * Dirty tiles, i.e.\ at least one corner changed.
rubidium@8041: 	 *
rubidium@8041: 	 * This array contains the tiles which are or will be marked as dirty.
rubidium@8041: 	 *
rubidium@8041: 	 * @ingroup dirty
rubidium@8041: 	 */
rubidium@8041: 	TileIndex tile_table[TERRAFORMER_TILE_TABLE_SIZE];
rubidium@7976: 	TerraformerHeightMod modheight[TERRAFORMER_MODHEIGHT_SIZE];  ///< Height modifications.
rubidium@6574: };
truelight@0: 
smatz@9312: TileIndex _terraform_err_tile; ///< first tile we couldn't terraform
rubidium@8706: 
rubidium@7976: /**
rubidium@7976:  * Gets the TileHeight (height of north corner) of a tile as of current terraforming progress.
rubidium@7976:  *
rubidium@7976:  * @param ts TerraformerState.
rubidium@7976:  * @param tile Tile.
rubidium@7976:  * @return TileHeight.
rubidium@7976:  */
smatz@9312: static int TerraformGetHeightOfTile(const TerraformerState *ts, TileIndex tile)
truelight@0: {
smatz@9312: 	const TerraformerHeightMod *mod = ts->modheight;
truelight@193: 
smatz@9312: 	for (int count = ts->modheight_count; count != 0; count--, mod++) {
tron@2639: 		if (mod->tile == tile) return mod->height;
truelight@0: 	}
truelight@0: 
rubidium@7976: 	/* TileHeight unchanged so far, read value from map. */
tron@1044: 	return TileHeight(tile);
truelight@0: }
truelight@0: 
rubidium@7976: /**
rubidium@8013:  * Stores the TileHeight (height of north corner) of a tile in a TerraformerState.
rubidium@8013:  *
rubidium@8013:  * @param ts TerraformerState.
rubidium@8013:  * @param tile Tile.
rubidium@8013:  * @param height New TileHeight.
rubidium@8013:  */
rubidium@8013: static void TerraformSetHeightOfTile(TerraformerState *ts, TileIndex tile, int height)
rubidium@8013: {
rubidium@8013: 	/* Find tile in the "modheight" table.
rubidium@8013: 	 * Note: In a normal user-terraform command the tile will not be found in the "modheight" table.
rubidium@8013: 	 *       But during house- or industry-construction multiple corners can be terraformed at once. */
rubidium@8013: 	TerraformerHeightMod *mod = ts->modheight;
rubidium@8013: 	int count = ts->modheight_count;
smatz@9312: 
rubidium@8013: 	while ((count > 0) && (mod->tile != tile)) {
rubidium@8013: 		mod++;
rubidium@8013: 		count--;
rubidium@8013: 	}
rubidium@8013: 
rubidium@8013: 	/* New entry? */
rubidium@8013: 	if (count == 0) {
rubidium@8013: 		assert(ts->modheight_count < TERRAFORMER_MODHEIGHT_SIZE);
rubidium@8013: 		ts->modheight_count++;
rubidium@8013: 	}
rubidium@8013: 
rubidium@8013: 	/* Finally store the new value */
rubidium@8013: 	mod->tile = tile;
rubidium@8013: 	mod->height = (byte)height;
rubidium@8013: }
rubidium@8013: 
rubidium@8013: /**
rubidium@7976:  * Adds a tile to the "tile_table" in a TerraformerState.
rubidium@7976:  *
rubidium@7976:  * @param ts TerraformerState.
rubidium@7976:  * @param tile Tile.
rubidium@8041:  * @ingroup dirty
rubidium@7976:  */
truelight@0: static void TerraformAddDirtyTile(TerraformerState *ts, TileIndex tile)
truelight@0: {
smatz@9312: 	int count = ts->tile_table_count;
truelight@0: 
smatz@9312: 	for (TileIndex *t = ts->tile_table; count != 0; count--, t++) {
tron@2639: 		if (*t == tile) return;
truelight@0: 	}
truelight@0: 
rubidium@7976: 	assert(ts->tile_table_count < TERRAFORMER_TILE_TABLE_SIZE);
rubidium@7976: 
truelight@0: 	ts->tile_table[ts->tile_table_count++] = tile;
truelight@0: }
truelight@0: 
rubidium@7976: /**
rubidium@7976:  * Adds all tiles that incident with the north corner of a specific tile to the "tile_table" in a TerraformerState.
rubidium@7976:  *
rubidium@7976:  * @param ts TerraformerState.
rubidium@7976:  * @param tile Tile.
rubidium@8041:  * @ingroup dirty
rubidium@7976:  */
truelight@0: static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile)
truelight@0: {
tron@1981: 	TerraformAddDirtyTile(ts, tile + TileDiffXY( 0, -1));
tron@1981: 	TerraformAddDirtyTile(ts, tile + TileDiffXY(-1, -1));
tron@1981: 	TerraformAddDirtyTile(ts, tile + TileDiffXY(-1,  0));
truelight@0: 	TerraformAddDirtyTile(ts, tile);
truelight@0: }
truelight@0: 
rubidium@7976: /**
rubidium@7976:  * Terraform the north corner of a tile to a specific height.
rubidium@7976:  *
rubidium@7976:  * @param ts TerraformerState.
rubidium@7976:  * @param tile Tile.
rubidium@7976:  * @param height Aimed height.
rubidium@8013:  * @param return Error code or cost.
rubidium@7976:  */
rubidium@8013: static CommandCost TerraformTileHeight(TerraformerState *ts, TileIndex tile, int height)
truelight@0: {
tron@863: 	assert(tile < MapSize());
truelight@0: 
rubidium@7976: 	/* Check range of destination height */
rubidium@8013: 	if (height < 0) return_cmd_error(STR_1003_ALREADY_AT_SEA_LEVEL);
rubidium@8013: 	if (height > MAX_TILE_HEIGHT) return_cmd_error(STR_1004_TOO_HIGH);
truelight@193: 
rubidium@7976: 	/*
rubidium@7976: 	 * Check if the terraforming has any effect.
rubidium@7976: 	 * This can only be true, if multiple corners of the start-tile are terraformed (i.e. the terraforming is done by towns/industries etc.).
rubidium@7976: 	 * In this case the terraforming should fail. (Don't know why.)
rubidium@7976: 	 */
rubidium@8013: 	if (height == TerraformGetHeightOfTile(ts, tile)) return CMD_ERROR;
truelight@193: 
rubidium@7983: 	/* Check "too close to edge of map" */
rubidium@7983: 	uint x = TileX(tile);
rubidium@7983: 	uint y = TileY(tile);
rubidium@7983: 	if ((x <= 1) || (y <= 1) || (x >= MapMaxX() - 1) || (y >= MapMaxY() - 1)) {
rubidium@7983: 		/*
rubidium@7983: 		 * Determine a sensible error tile
rubidium@7983: 		 * Note: If x and y are both zero this will disable the error tile. (Tile 0 cannot be highlighted :( )
rubidium@7983: 		 */
rubidium@7983: 		if ((x == 1) && (y != 0)) x = 0;
rubidium@7983: 		if ((y == 1) && (x != 0)) y = 0;
rubidium@7983: 		_terraform_err_tile = TileXY(x, y);
rubidium@8013: 		return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);
rubidium@7983: 	}
rubidium@7983: 
rubidium@7983: 	/* Mark incident tiles, that are involved in the terraforming */
rubidium@7983: 	TerraformAddDirtyTileAround(ts, tile);
truelight@0: 
rubidium@7976: 	/* Store the height modification */
rubidium@8013: 	TerraformSetHeightOfTile(ts, tile, height);
truelight@0: 
smatz@9312: 	CommandCost total_cost(EXPENSES_CONSTRUCTION);
smatz@9312: 
rubidium@7976: 	/* Increment cost */
rubidium@8013: 	total_cost.AddCost(_price.terraform);
truelight@0: 
rubidium@7976: 	/* Recurse to neighboured corners if height difference is larger than 1 */
truelight@0: 	{
tron@909: 		const TileIndexDiffC *ttm;
truelight@0: 
tron@909: 		static const TileIndexDiffC _terraform_tilepos[] = {
rubidium@7976: 			{ 1,  0}, // move to tile in SE
rubidium@7976: 			{-2,  0}, // undo last move, and move to tile in NW
rubidium@7976: 			{ 1,  1}, // undo last move, and move to tile in SW
rubidium@7976: 			{ 0, -2}  // undo last move, and move to tile in NE
tron@909: 		};
truelight@0: 
tron@2952: 		for (ttm = _terraform_tilepos; ttm != endof(_terraform_tilepos); ttm++) {
tron@909: 			tile += ToTileIndexDiff(*ttm);
truelight@0: 
rubidium@7976: 			/* Get TileHeight of neighboured tile as of current terraform progress */
rubidium@7976: 			int r = TerraformGetHeightOfTile(ts, tile);
rubidium@7976: 			int height_diff = height - r;
rubidium@7976: 
rubidium@7976: 			/* Is the height difference to the neighboured corner greater than 1? */
rubidium@7976: 			if (abs(height_diff) > 1) {
rubidium@7976: 				/* Terraform the neighboured corner. The resulting height difference should be 1. */
rubidium@7976: 				height_diff += (height_diff < 0 ? 1 : -1);
rubidium@8013: 				CommandCost cost = TerraformTileHeight(ts, tile, r + height_diff);
rubidium@8013: 				if (CmdFailed(cost)) return cost;
rubidium@8013: 				total_cost.AddCost(cost);
truelight@0: 			}
truelight@0: 		}
truelight@0: 	}
truelight@0: 
rubidium@8013: 	return total_cost;
truelight@0: }
truelight@0: 
Darkvater@1775: /** Terraform land
tron@3491:  * @param tile tile to terraform
belugas@6449:  * @param flags for this command type
rubidium@7976:  * @param p1 corners to terraform (SLOPE_xxx)
rubidium@7976:  * @param p2 direction; eg up (non-zero) or down (zero)
belugas@6449:  * @return error or cost of terraforming
truelight@0:  */
rubidium@7439: CommandCost CmdTerraformLand(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
smatz@9312: 	/* Make an extra check for map-bounds cause we add tiles to the originating tile */
smatz@9312: 	if (tile + TileDiffXY(1, 1) >= MapSize()) return CMD_ERROR;
smatz@9312: 
smatz@9312: 	_terraform_err_tile = INVALID_TILE;
smatz@9312: 
rubidium@8726: 	CommandCost total_cost(EXPENSES_CONSTRUCTION);
rubidium@8013: 	int direction = (p2 != 0 ? 1 : -1);
smatz@9312: 	TerraformerState ts;
truelight@0: 
truelight@0: 	ts.modheight_count = ts.tile_table_count = 0;
truelight@0: 
rubidium@7976: 	/* Compute the costs and the terraforming result in a model of the landscape */
rubidium@7976: 	if ((p1 & SLOPE_W) != 0) {
rubidium@8013: 		TileIndex t = tile + TileDiffXY(1, 0);
rubidium@8013: 		CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
rubidium@8013: 		if (CmdFailed(cost)) return cost;
rubidium@8013: 		total_cost.AddCost(cost);
truelight@0: 	}
truelight@0: 
rubidium@7976: 	if ((p1 & SLOPE_S) != 0) {
rubidium@8013: 		TileIndex t = tile + TileDiffXY(1, 1);
rubidium@8013: 		CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
rubidium@8013: 		if (CmdFailed(cost)) return cost;
rubidium@8013: 		total_cost.AddCost(cost);
truelight@0: 	}
truelight@0: 
rubidium@7976: 	if ((p1 & SLOPE_E) != 0) {
rubidium@8013: 		TileIndex t = tile + TileDiffXY(0, 1);
rubidium@8013: 		CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
rubidium@8013: 		if (CmdFailed(cost)) return cost;
rubidium@8013: 		total_cost.AddCost(cost);
truelight@0: 	}
truelight@0: 
rubidium@7976: 	if ((p1 & SLOPE_N) != 0) {
rubidium@8013: 		TileIndex t = tile + TileDiffXY(0, 0);
rubidium@8013: 		CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);
rubidium@8013: 		if (CmdFailed(cost)) return cost;
rubidium@8013: 		total_cost.AddCost(cost);
truelight@0: 	}
truelight@0: 
rubidium@7983: 	/* Check if the terraforming is valid wrt. tunnels, bridges and objects on the surface */
celestar@5573: 	{
truelight@0: 		TileIndex *ti = ts.tile_table;
truelight@193: 
smatz@9312: 		for (int count = ts.tile_table_count; count != 0; count--, ti++) {
tron@1977: 			TileIndex tile = *ti;
truelight@0: 
rubidium@7983: 			/* Find new heights of tile corners */
rubidium@7983: 			uint z_N = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(0, 0));
rubidium@7983: 			uint z_W = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(1, 0));
rubidium@7983: 			uint z_S = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(1, 1));
rubidium@7983: 			uint z_E = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(0, 1));
rubidium@7983: 
rubidium@7976: 			/* Find min and max height of tile */
rubidium@7983: 			uint z_min = min(min(z_N, z_W), min(z_S, z_E));
rubidium@7983: 			uint z_max = max(max(z_N, z_W), max(z_S, z_E));
rubidium@7214: 
rubidium@7990: 			/* Compute tile slope */
frosch@9297: 			Slope tileh = (z_max > z_min + 1 ? SLOPE_STEEP : SLOPE_FLAT);
frosch@9297: 			if (z_W > z_min) tileh |= SLOPE_W;
frosch@9297: 			if (z_S > z_min) tileh |= SLOPE_S;
frosch@9297: 			if (z_E > z_min) tileh |= SLOPE_E;
frosch@9297: 			if (z_N > z_min) tileh |= SLOPE_N;
rubidium@7990: 
rubidium@7976: 			/* Check if bridge would take damage */
rubidium@7214: 			if (direction == 1 && MayHaveBridgeAbove(tile) && IsBridgeAbove(tile) &&
rubidium@7214: 					GetBridgeHeight(GetSouthernBridgeEnd(tile)) <= z_max * TILE_HEIGHT) {
rubidium@8013: 				_terraform_err_tile = tile; // highlight the tile under the bridge
celestar@5573: 				return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);
celestar@5573: 			}
rubidium@7976: 			/* Check if tunnel would take damage */
rubidium@7214: 			if (direction == -1 && IsTunnelInWay(tile, z_min * TILE_HEIGHT)) {
rubidium@8013: 				_terraform_err_tile = tile; // highlight the tile above the tunnel
rubidium@7214: 				return_cmd_error(STR_1002_EXCAVATION_WOULD_DAMAGE);
tron@2639: 			}
rubidium@7983: 			/* Check tiletype-specific things, and add extra-cost */
belugas@10633: 			const bool curr_gen = _generating_world;
belugas@10633: 			if (_game_mode == GM_EDITOR) _generating_world = true; // used to create green terraformed land
frosch@9297: 			CommandCost cost = _tile_type_procs[GetTileType(tile)]->terraform_tile_proc(tile, flags | DC_AUTO, z_min * TILE_HEIGHT, tileh);
belugas@10633: 			_generating_world = curr_gen;
rubidium@7990: 			if (CmdFailed(cost)) {
rubidium@7990: 				_terraform_err_tile = tile;
rubidium@7990: 				return cost;
rubidium@7990: 			}
rubidium@8013: 			total_cost.AddCost(cost);
truelight@0: 		}
truelight@0: 	}
truelight@0: 
truelight@0: 	if (flags & DC_EXEC) {
truelight@0: 		/* change the height */
truelight@0: 		{
truelight@0: 			int count;
truelight@0: 			TerraformerHeightMod *mod;
truelight@0: 
truelight@0: 			mod = ts.modheight;
Darkvater@1775: 			for (count = ts.modheight_count; count != 0; count--, mod++) {
tron@1979: 				TileIndex til = mod->tile;
truelight@193: 
tron@1059: 				SetTileHeight(til, mod->height);
truelight@0: 			}
truelight@0: 		}
truelight@0: 
truelight@0: 		/* finally mark the dirty tiles dirty */
truelight@0: 		{
truelight@0: 			int count;
truelight@0: 			TileIndex *ti = ts.tile_table;
Darkvater@1775: 			for (count = ts.tile_table_count; count != 0; count--, ti++) {
truelight@0: 				MarkTileDirtyByTile(*ti);
truelight@0: 			}
truelight@193: 		}
truelight@0: 	}
rubidium@8013: 	return total_cost;
truelight@0: }
truelight@0: 
truelight@0: 
Darkvater@1796: /** Levels a selected (rectangle) area of land
tron@3491:  * @param tile end tile of area-drag
belugas@6449:  * @param flags for this command type
Darkvater@1796:  * @param p1 start tile of area drag
peter1138@8692:  * @param p2 height difference; eg raise (+1), lower (-1) or level (0)
belugas@6449:  * @return  error or cost of terraforming
truelight@0:  */
rubidium@7439: CommandCost CmdLevelLand(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
tron@2934: 	if (p1 >= MapSize()) return CMD_ERROR;
Darkvater@1796: 
belugas@6449: 	/* remember level height */
smatz@9312: 	uint oldh = TileHeight(p1);
peter1138@8692: 
peter1138@8692: 	/* compute new height */
smatz@9312: 	uint h = oldh + p2;
peter1138@8692: 
peter1138@8692: 	/* Check range of destination height */
peter1138@8692: 	if (h > MAX_TILE_HEIGHT) return_cmd_error((oldh == 0) ? STR_1003_ALREADY_AT_SEA_LEVEL : STR_1004_TOO_HIGH);
truelight@0: 
belugas@6449: 	/* make sure sx,sy are smaller than ex,ey */
smatz@9312: 	int ex = TileX(tile);
smatz@9312: 	int ey = TileY(tile);
smatz@9312: 	int sx = TileX(p1);
smatz@9312: 	int sy = TileY(p1);
tron@6432: 	if (ex < sx) Swap(ex, sx);
tron@6432: 	if (ey < sy) Swap(ey, sy);
tron@1981: 	tile = TileXY(sx, sy);
truelight@0: 
smatz@9312: 	int size_x = ex - sx + 1;
smatz@9312: 	int size_y = ey - sy + 1;
truelight@0: 
smatz@9312: 	Money money = GetAvailableMoneyForCommand();
smatz@9312: 	CommandCost cost(EXPENSES_CONSTRUCTION);
truelight@0: 
Darkvater@1796: 	BEGIN_TILE_LOOP(tile2, size_x, size_y, tile) {
smatz@9312: 		uint curh = TileHeight(tile2);
truelight@0: 		while (curh != h) {
smatz@9312: 			CommandCost ret = DoCommand(tile2, SLOPE_N, (curh > h) ? 0 : 1, flags & ~DC_EXEC, CMD_TERRAFORM_LAND);
Darkvater@1796: 			if (CmdFailed(ret)) break;
truelight@0: 
truelight@0: 			if (flags & DC_EXEC) {
smatz@9312: 				money -= ret.GetCost();
smatz@9312: 				if (money < 0) {
rubidium@7446: 					_additional_cash_required = ret.GetCost();
rubidium@7446: 					return cost;
truelight@0: 				}
rubidium@7976: 				DoCommand(tile2, SLOPE_N, (curh > h) ? 0 : 1, flags, CMD_TERRAFORM_LAND);
truelight@0: 			}
truelight@0: 
rubidium@7446: 			cost.AddCost(ret);
truelight@0: 			curh += (curh > h) ? -1 : 1;
truelight@0: 		}
Darkvater@1796: 	} END_TILE_LOOP(tile2, size_x, size_y, tile)
truelight@0: 
rubidium@7446: 	return (cost.GetCost() == 0) ? CMD_ERROR : cost;
truelight@0: }