map_type.h File Reference

Types related to maps. More...

Go to the source code of this file.

Data Structures
struct	TileIndexDiffC
	A pair-construct of a TileIndexDiff. More...

Typedefs
typedef int32_t	TileIndexDiff
	An offset value between two tiles.

Enumerations
enum class	LevelMode : uint8_t { Level , Lower , Raise }
	Argument for CmdLevelLand describing what to do. More...

Variables
static const uint	MIN_MAP_SIZE_BITS = 6
	Minimal and maximal map width and height.
static const uint	MAX_MAP_SIZE_BITS = 12
	Maximal size of map is equal to 2 ^ MAX_MAP_SIZE_BITS.
static const uint	MIN_MAP_SIZE = 1U << MIN_MAP_SIZE_BITS
	Minimal map size = 64.
static const uint	MAX_MAP_SIZE = 1U << MAX_MAP_SIZE_BITS
	Maximal map size = 4096.

Detailed Description

Types related to maps.

Definition in file map_type.h.

Typedef Documentation

TileIndexDiff

typedef int32_t TileIndexDiff

An offset value between two tiles.

This value is used for the difference between two tiles. It can be added to a TileIndex to get the resulting TileIndex of the start tile applied with this saved difference.

See also

TileDiffXY(int, int)

Definition at line 23 of file map_type.h.

Enumeration Type Documentation

LevelMode

enum class LevelMode : uint8_t

strong

Argument for CmdLevelLand describing what to do.

Enumerator
Level	Level the land.
Lower	Lower the land.
Raise	Raise the land.

Definition at line 43 of file map_type.h.

Variable Documentation

MAX_MAP_SIZE

const uint MAX_MAP_SIZE = 1U << MAX_MAP_SIZE_BITS

static

Maximal map size = 4096.

Definition at line 40 of file map_type.h.

Referenced by Map::Allocate(), CYapfCostRoadT< Types >::PfCalcCost(), CreateScenarioWindow::UpdateWidgetSize(), GenerateLandscapeWindow::UpdateWidgetSize(), and NetworkGameWindow::UpdateWidgetSize().

MAX_MAP_SIZE_BITS

const uint MAX_MAP_SIZE_BITS = 12

static

Maximal size of map is equal to 2 ^ MAX_MAP_SIZE_BITS.

Definition at line 38 of file map_type.h.

Referenced by DecrementTreeCounter(), RunTileLoop(), and TGPGetMaxHeight().

MIN_MAP_SIZE

const uint MIN_MAP_SIZE = 1U << MIN_MAP_SIZE_BITS

static

Minimal map size = 64.

Definition at line 39 of file map_type.h.

Referenced by Map::Allocate().

MIN_MAP_SIZE_BITS

const uint MIN_MAP_SIZE_BITS = 6

static

Minimal and maximal map width and height.

Minimal size of map is equal to 2 ^ MIN_MAP_SIZE_BITS

Definition at line 37 of file map_type.h.

Referenced by DecrementTreeCounter(), RunTileLoop(), and TGPGetMaxHeight().