OpenTTD Source: src/map_type.h File Reference

OpenTTD Source 14.0-beta1

Data Structures | Macros | Typedefs | Enumerations | Variables
map_type.h File Reference

Go to the source code of this file.

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

## Macros
#define | STRAIGHT_TRACK_LENGTH 7071/10000
| Approximation of the length of a straight track, relative to a diagonal track (ie the size of a tile side). More...

## Typedefs
typedef int32_t | TileIndexDiff
| An offset value between two tiles. More...

## Enumerations
enum | LevelMode : byte { LM_LEVEL, LM_LOWER, LM_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. More...
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.

## Macro Definition Documentation

## ◆ STRAIGHT_TRACK_LENGTH

#define STRAIGHT_TRACK_LENGTH 7071/10000

Approximation of the length of a straight track, relative to a diagonal track (ie the size of a tile side).

#defined instead of const so it can stay integer. (no runtime float operations) Is this needed? Watch out! There are no brackets around here, to prevent intermediate rounding! Be careful when using this! This value should be sqrt(2)/2 ~ 0.7071

Definition at line 52 of 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 LevelMode : byte

Argument for CmdLevelLand describing what to do.

Enumerator
LM_LEVEL | Level the land.
LM_LOWER | Lower the land.
LM_RAISE | Raise the land.

Definition at line 55 of file map_type.h.

## Variable Documentation

## ◆ 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().