OpenTTD Source
20241121-master-g67a0fccfad
|
Map accessors for tree tiles. More...
Go to the source code of this file.
Enumerations | |
enum | TreeType { TREE_TEMPERATE = 0x00 , TREE_SUB_ARCTIC = 0x0C , TREE_RAINFOREST = 0x14 , TREE_CACTUS = 0x1B , TREE_SUB_TROPICAL = 0x1C , TREE_TOYLAND = 0x20 , TREE_INVALID = 0xFF } |
List of tree types along all landscape types. More... | |
enum | TreeGround { TREE_GROUND_GRASS = 0 , TREE_GROUND_ROUGH = 1 , TREE_GROUND_SNOW_DESERT = 2 , TREE_GROUND_SHORE = 3 , TREE_GROUND_ROUGH_SNOW = 4 } |
Enumeration for ground types of tiles with trees. More... | |
enum class | TreeGrowthStage : uint { Growing1 = 0 , Growing2 = 1 , Growing3 = 2 , Grown = 3 , Dying1 = 4 , Dying2 = 5 , Dead = 6 } |
Enumeration for tree growth stages. More... | |
Functions | |
TreeType | GetTreeType (Tile t) |
Returns the treetype of a tile. More... | |
TreeGround | GetTreeGround (Tile t) |
Returns the groundtype for tree tiles. More... | |
uint | GetTreeDensity (Tile t) |
Returns the 'density' of a tile with trees. More... | |
void | SetTreeGroundDensity (Tile t, TreeGround g, uint d) |
Set the density and ground type of a tile with trees. More... | |
uint | GetTreeCount (Tile t) |
Returns the number of trees on a tile. More... | |
void | AddTreeCount (Tile t, int c) |
Add a amount to the tree-count value of a tile with trees. More... | |
TreeGrowthStage | GetTreeGrowth (Tile t) |
Returns the tree growth stage. More... | |
void | AddTreeGrowth (Tile t, int a) |
Add a value to the tree growth stage. More... | |
void | SetTreeGrowth (Tile t, TreeGrowthStage g) |
Sets the tree growth stage of a tile. More... | |
void | MakeTree (Tile t, TreeType type, uint count, TreeGrowthStage growth, TreeGround ground, uint density) |
Make a tree-tile. More... | |
Variables | |
static const uint | TREE_COUNT_TEMPERATE = TREE_SUB_ARCTIC - TREE_TEMPERATE |
number of tree types on a temperate map. | |
static const uint | TREE_COUNT_SUB_ARCTIC = TREE_RAINFOREST - TREE_SUB_ARCTIC |
number of tree types on a sub arctic map. | |
static const uint | TREE_COUNT_RAINFOREST = TREE_CACTUS - TREE_RAINFOREST |
number of tree types for the 'rainforest part' of a sub-tropic map. | |
static const uint | TREE_COUNT_SUB_TROPICAL = TREE_TOYLAND - TREE_SUB_TROPICAL |
number of tree types for the 'sub-tropic part' of a sub-tropic map. | |
static const uint | TREE_COUNT_TOYLAND = 9 |
number of tree types on a toyland map. | |
Map accessors for tree tiles.
Definition in file tree_map.h.
enum TreeGround |
Enumeration for ground types of tiles with trees.
This enumeration defines the ground types for tiles with trees on it.
Definition at line 52 of file tree_map.h.
|
strong |
Enumeration for tree growth stages.
This enumeration defines the stages of tree growth for tiles with trees on it.
Definition at line 65 of file tree_map.h.
enum TreeType |
List of tree types along all landscape types.
This enumeration contains a list of the different tree types along all landscape types. The values for the enumerations may be used for offsets from the grfs files. These points to the start of the tree list for a landscape. See the TREE_COUNT_* enumerations for the amount of different trees for a specific landscape.
Definition at line 25 of file tree_map.h.
|
inline |
Add a amount to the tree-count value of a tile with trees.
This function add a value to the tree-count value of a tile. This value may be negative to reduce the tree-counter. If the resulting value reach 0 it doesn't get converted to a "normal" tile.
t | The tile to change the tree amount |
c | The value to add (or reduce) on the tree-count value |
Definition at line 180 of file tree_map.h.
References IsTileType(), Tile::m5(), and MP_TREES.
|
inline |
Add a value to the tree growth stage.
This function adds a value to the tree grow stage of a tile.
t | The tile to add the value on |
a | The value to add on the tree growth stage |
Definition at line 210 of file tree_map.h.
References IsTileType(), Tile::m5(), and MP_TREES.
|
inline |
Returns the number of trees on a tile.
This function returns the number of trees of a tile (1-4). The tile must be contains at least one tree or be more specific: it must be of type MP_TREES.
t | The index to get the number of trees |
Definition at line 163 of file tree_map.h.
References GB(), IsTileType(), Tile::m5(), and MP_TREES.
|
inline |
Returns the 'density' of a tile with trees.
This function returns the density of a tile which got trees. Note that this value doesn't count the number of trees on a tile, use GetTreeCount instead. This function instead returns some kind of groundtype of the tile. As the map-array is finite in size and the information about the trees must be saved somehow other information about a tile must be saved somewhere encoded in the tile. So this function returns the density of a tile for sub arctic and sub tropical games. This means for sub arctic the type of snowline (0 to 3 for all 4 types of snowtiles) and for sub tropical the value 3 for a desert (and 0 for non-desert). The function name is not read as "get the tree density of a tile" but "get the density of a tile which got trees".
t | The tile to get the 'density' |
Definition at line 127 of file tree_map.h.
References GB(), IsTileType(), Tile::m2(), and MP_TREES.
|
inline |
Returns the groundtype for tree tiles.
This function returns the groundtype of a tile with trees.
t | The tile to get the groundtype from |
Definition at line 102 of file tree_map.h.
References GB(), IsTileType(), Tile::m2(), and MP_TREES.
Referenced by GetNearbyTileInformation(), IsSuitableForFarmField(), PlaceTree(), and TileLoop_Water().
|
inline |
Returns the tree growth stage.
This function returns the tree growth stage of a tile with trees.
t | The tile to get the tree growth stage |
Definition at line 195 of file tree_map.h.
References GB(), IsTileType(), Tile::m5(), and MP_TREES.
Referenced by SearchLumberMillTrees().
Returns the treetype of a tile.
This function returns the treetype of a given tile. As there are more possible treetypes for a tile in a game as the enumeration TreeType defines this function may be return a value which isn't catch by an entry of the enumeration TreeType. But there is no problem known about it.
t | The tile to get the treetype from |
Definition at line 87 of file tree_map.h.
References IsTileType(), Tile::m3(), and MP_TREES.
|
inline |
Make a tree-tile.
This functions change the tile to a tile with trees and all information which belongs to it.
t | The tile to make a tree-tile from |
type | The type of the tree |
count | the number of trees |
growth | the growth stage |
ground | the ground type |
density | the density (not the number of trees) |
Definition at line 244 of file tree_map.h.
References Tile::m2(), Tile::m3(), Tile::m4(), Tile::m5(), Tile::m6(), Tile::m7(), MP_TREES, OWNER_NONE, SB(), SetTileOwner(), SetTileType(), SetWaterClass(), TREE_GROUND_SHORE, WATER_CLASS_INVALID, and WATER_CLASS_SEA.
|
inline |
Set the density and ground type of a tile with trees.
This functions saves the ground type and the density which belongs to it for a given tile.
t | The tile to set the density and ground type |
g | The ground type to save |
d | The density to save with |
Definition at line 144 of file tree_map.h.
References IsTileType(), Tile::m2(), MP_TREES, SB(), SetWaterClass(), TREE_GROUND_SHORE, WATER_CLASS_INVALID, and WATER_CLASS_SEA.
Referenced by DoFloodTile(), and PlaceTree().
|
inline |
Sets the tree growth stage of a tile.
This function sets the tree growth stage of a tile directly with the given value.
t | The tile to change the tree growth stage |
g | The new value |
Definition at line 226 of file tree_map.h.
References IsTileType(), Tile::m5(), MP_TREES, and SB().