terraform_cmd.h File Reference

Command definitions related to terraforming. More...

#include "command_type.h"
#include "map_type.h"
#include "slope_type.h"

Go to the source code of this file.

Functions
std::tuple< CommandCost, Money, TileIndex >	CmdTerraformLand (DoCommandFlags flags, TileIndex tile, Slope slope, bool dir_up)
	Terraform land.
std::tuple< CommandCost, Money, TileIndex >	CmdLevelLand (DoCommandFlags flags, TileIndex tile, TileIndex start_tile, bool diagonal, LevelMode lm)
	Levels a selected (rectangle) area of land.
void	CcTerraform (Commands cmd, const CommandCost &result, Money, TileIndex tile)

Variables
CommandCallback	CcPlaySound_EXPLOSION

Detailed Description

Command definitions related to terraforming.

Definition in file terraform_cmd.h.

Function Documentation

CcTerraform()

void CcTerraform	(	Commands	cmd,
		const CommandCost &	result,
		Money	,
		TileIndex	tile
	)

Definition at line 48 of file terraform_gui.cpp.

CmdLevelLand()

std::tuple< CommandCost, Money, TileIndex > CmdLevelLand	(	DoCommandFlags	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(), Execute, EXPENSES_CONSTRUCTION, CommandCost::Failed(), GB(), GetAvailableMoneyForCommand(), CommandCost::GetCost(), CommandCost::GetErrorMessage(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::GetIfValid(), INVALID_STRING_ID, INVALID_TILE, LM_LEVEL, LM_LOWER, LM_RAISE, ConstructionSettings::map_height_limit, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Reset(), Map::Size(), SLOPE_N, CommandCost::Succeeded(), CompanyProperties::terraform_limit, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and TileHeight().

CmdTerraformLand()

std::tuple< CommandCost, Money, TileIndex > CmdTerraformLand	(	DoCommandFlags	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(), Auto, Backup< T >::Change(), GameSettings::construction, TerraformerState::dirty_tiles, Execute, EXPENSES_CONSTRUCTION, CommandCost::Failed(), FindClearedObject(), ClearedObjectArea::first_tile, ForceClearTile, GB(), GetBridgeHeight(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::GetIfValid(), GetSouthernBridgeEnd(), GetTileType(), INVALID_TILE, IsBridgeAbove(), IsTileType(), IsTunnelInWay(), MarkTileDirtyByTile(), ConstructionSettings::max_bridge_height, MP_VOID, NoModifyTownRating, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Reset(), Backup< T >::Restore(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), 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(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TerraformerState::tile_to_new_height, TileDiffXY(), and TileHeight().

Variable Documentation

CcPlaySound_EXPLOSION

CommandCallback CcPlaySound_EXPLOSION

Definition at line 23 of file terraform_cmd.h.