terraform_cmd.cpp File Reference

Commands related to terraforming. More...

#include "stdafx.h"
#include "command_func.h"
#include "tunnel_map.h"
#include "bridge_map.h"
#include "viewport_func.h"
#include "genworld.h"
#include "object_base.h"
#include "company_base.h"
#include "company_func.h"
#include "core/backup_type.hpp"
#include "terraform_cmd.h"
#include "landscape_cmd.h"
#include "table/strings.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures
struct	TerraformerState
	State of the terraforming. More...

Typedefs
typedef std::set< TileIndex >	TileIndexSet
	Set of tiles.
typedef std::map< TileIndex, int >	TileIndexToHeightMap
	Mapping of tiles to their height.

Functions
static int	TerraformGetHeightOfTile (const TerraformerState *ts, TileIndex tile)
	Gets the TileHeight (height of north corner) of a tile as of current terraforming progress.
static void	TerraformSetHeightOfTile (TerraformerState *ts, TileIndex tile, int height)
	Stores the TileHeight (height of north corner) of a tile in a TerraformerState.
static void	TerraformAddDirtyTile (TerraformerState *ts, TileIndex tile)
	Adds a tile to the "tile_table" in a TerraformerState.
static void	TerraformAddDirtyTileAround (TerraformerState *ts, TileIndex tile)
	Adds all tiles that incident with the north corner of a specific tile to the "tile_table" in a TerraformerState.
static std::tuple< CommandCost, TileIndex >	TerraformTileHeight (TerraformerState *ts, TileIndex tile, int height)
	Terraform the north corner of a tile to a specific height.
std::tuple< CommandCost, Money, TileIndex >	CmdTerraformLand (DoCommandFlag flags, TileIndex tile, Slope slope, bool dir_up)
	Terraform land.
std::tuple< CommandCost, Money, TileIndex >	CmdLevelLand (DoCommandFlag flags, TileIndex tile, TileIndex start_tile, bool diagonal, LevelMode lm)
	Levels a selected (rectangle) area of land.

Detailed Description

Commands related to terraforming.

Definition in file terraform_cmd.cpp.

Typedef Documentation

TileIndexSet

typedef std::set<TileIndex> TileIndexSet

Set of tiles.

Definition at line 28 of file terraform_cmd.cpp.

TileIndexToHeightMap

typedef std::map<TileIndex, int> TileIndexToHeightMap

Mapping of tiles to their height.

Definition at line 30 of file terraform_cmd.cpp.

Function Documentation

CmdLevelLand()

std::tuple< CommandCost, Money, TileIndex > CmdLevelLand	(	DoCommandFlag	flags,
		TileIndex	tile,
		TileIndex	start_tile,
		bool	diagonal,
		LevelMode	lm
	)

Levels a selected (rectangle) area of land.

Parameters

flags	for this command type
tile	end tile of area-drag
start_tile	start tile of area drag
diagonal	Whether to use the Orthogonal (false) or Diagonal (true) iterator.
LevelMode	Mode of leveling LevelMode.

Returns

the cost of this operation or an error

Definition at line 315 of file terraform_cmd.cpp.

References _current_company, _settings_game, CommandCost::AddCost(), CMD_ERROR, GameSettings::construction, TileIterator::Create(), DC_EXEC, EXPENSES_CONSTRUCTION, CommandCost::Failed(), GB(), GetAvailableMoneyForCommand(), CommandCost::GetCost(), CommandCost::GetErrorMessage(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::GetIfValid(), INVALID_STRING_ID, INVALID_TILE, LM_LEVEL, LM_LOWER, LM_RAISE, ConstructionSettings::map_height_limit, Map::Size(), SLOPE_N, CommandCost::Succeeded(), CompanyProperties::terraform_limit, and TileHeight().

CmdTerraformLand()

std::tuple< CommandCost, Money, TileIndex > CmdTerraformLand	(	DoCommandFlag	flags,
		TileIndex	tile,
		Slope	slope,
		bool	dir_up
	)

Terraform land.

Parameters

flags	for this command type
tile	tile to terraform
slope	corners to terraform (SLOPE_xxx)
dir_up	direction; eg up (true) or down (false)

Returns

the cost of this operation or an error

Definition at line 169 of file terraform_cmd.cpp.

References _current_company, _generating_world, _settings_game, _tile_type_procs, CommandCost::AddCost(), Backup< T >::Change(), GameSettings::construction, DC_AUTO, DC_EXEC, DC_FORCE_CLEAR_TILE, DC_NO_MODIFY_TOWN_RATING, TerraformerState::dirty_tiles, EXPENSES_CONSTRUCTION, CommandCost::Failed(), FindClearedObject(), ClearedObjectArea::first_tile, GB(), GetBridgeHeight(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::GetIfValid(), GetSouthernBridgeEnd(), GetTileType(), INVALID_TILE, IsBridgeAbove(), IsTileType(), IsTunnelInWay(), MarkTileDirtyByTile(), ConstructionSettings::max_bridge_height, MP_VOID, Backup< T >::Restore(), SetTileHeight(), Map::Size(), SLOPE_E, SLOPE_FLAT, SLOPE_N, SLOPE_S, SLOPE_STEEP, SLOPE_W, CommandCost::Succeeded(), CompanyProperties::terraform_limit, TileTypeProcs::terraform_tile_proc, TerraformGetHeightOfTile(), TerraformTileHeight(), TerraformerState::tile_to_new_height, TileDiffXY(), and TileHeight().

TerraformGetHeightOfTile()

static int TerraformGetHeightOfTile ( const TerraformerState *  ts, TileIndex  tile  )

static

Gets the TileHeight (height of north corner) of a tile as of current terraforming progress.

Parameters

ts	TerraformerState.
tile	Tile.

Returns

TileHeight.

Definition at line 45 of file terraform_cmd.cpp.

References TerraformerState::tile_to_new_height, and TileHeight().

Referenced by CmdTerraformLand(), and TerraformTileHeight().

TerraformSetHeightOfTile()

static void TerraformSetHeightOfTile ( TerraformerState *  ts, TileIndex  tile, int  height  )

static

Stores the TileHeight (height of north corner) of a tile in a TerraformerState.

Parameters

ts	TerraformerState.
tile	Tile.
height	New TileHeight.

Definition at line 58 of file terraform_cmd.cpp.

References TerraformerState::tile_to_new_height.

Referenced by TerraformTileHeight().

TerraformTileHeight()

static std::tuple< CommandCost, TileIndex > TerraformTileHeight ( TerraformerState *  ts, TileIndex  tile, int  height  )

static

Terraform the north corner of a tile to a specific height.

Parameters

ts	TerraformerState.
tile	Tile.
height	Aimed height.

Returns

Error code or cost.

Definition at line 99 of file terraform_cmd.cpp.

References _settings_game, abs(), CommandCost::AddCost(), AddTileIndexDiffCWrap(), CMD_ERROR, GameSettings::construction, DIAGDIR_BEGIN, DIAGDIR_END, EXPENSES_CONSTRUCTION, ConstructionSettings::freeform_edges, INVALID_TILE, ConstructionSettings::map_height_limit, Map::MaxX(), Map::MaxY(), Map::Size(), TerraformAddDirtyTileAround(), TerraformGetHeightOfTile(), TerraformSetHeightOfTile(), TerraformTileHeight(), TileIndexDiffCByDiagDir(), TileX(), TileXY(), and TileY().

Referenced by CmdTerraformLand(), and TerraformTileHeight().