OpenTTD
|
Map accessors for tree tiles. More...
#include "tile_map.h"
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... |
Functions | |
static TreeType | GetTreeType (TileIndex t) |
Returns the treetype of a tile. | |
static TreeGround | GetTreeGround (TileIndex t) |
Returns the groundtype for tree tiles. | |
static uint | GetTreeDensity (TileIndex t) |
Returns the 'density' of a tile with trees. | |
static void | SetTreeGroundDensity (TileIndex t, TreeGround g, uint d) |
Set the density and ground type of a tile with trees. | |
static uint | GetTreeCount (TileIndex t) |
Returns the number of trees on a tile. | |
static void | AddTreeCount (TileIndex t, int c) |
Add a amount to the tree-count value of a tile with trees. | |
static uint | GetTreeGrowth (TileIndex t) |
Returns the tree growth status. | |
static void | AddTreeGrowth (TileIndex t, int a) |
Add a value to the tree growth status. | |
static void | SetTreeGrowth (TileIndex t, uint g) |
Sets the tree growth status of a tile. | |
static uint | GetTreeCounter (TileIndex t) |
Get the tick counter of a tree tile. | |
static void | AddTreeCounter (TileIndex t, int a) |
Add a value on the tick counter of a tree-tile. | |
static void | SetTreeCounter (TileIndex t, uint c) |
Set the tick counter for a tree-tile. | |
static void | MakeTree (TileIndex t, TreeType type, uint count, uint growth, TreeGround ground, uint density) |
Make a tree-tile. |
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 53 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 26 of file tree_map.h.
|
inlinestatic |
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 166 of file tree_map.h.
References _m, IsTileType(), Tile::m5, and MP_TREES.
Referenced by CmdPlantTree().
|
inlinestatic |
Add a value on the tick counter of a tree-tile.
This function adds a value on the tick counter of a tree-tile.
t | The tile to add the value on |
a | The value to add on the tick counter |
Definition at line 241 of file tree_map.h.
References _m, IsTileType(), Tile::m2, and MP_TREES.
|
inlinestatic |
Add a value to the tree growth status.
This function adds a value to the tree grow status of a tile.
t | The tile to add the value on |
a | The value to add on the tree growth status |
Definition at line 196 of file tree_map.h.
References _m, IsTileType(), Tile::m5, and MP_TREES.
|
inlinestatic |
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 149 of file tree_map.h.
References _m, GB(), IsTileType(), and MP_TREES.
Referenced by CmdPlantTree().
|
inlinestatic |
Get the tick counter of a tree tile.
Returns the saved tick counter of a given tile.
t | The tile to get the counter value from |
Definition at line 226 of file tree_map.h.
References _m, GB(), IsTileType(), and MP_TREES.
|
inlinestatic |
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 informations about the trees must be saved somehow other informations 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 114 of file tree_map.h.
References _m, GB(), IsTileType(), and MP_TREES.
Referenced by GetTerrainType().
|
inlinestatic |
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 89 of file tree_map.h.
References _m, GB(), IsTileType(), and MP_TREES.
Referenced by GenerateRockyArea(), GetFloodingBehaviour(), GetNearbyTileInformation(), GetSmallMapVegetationPixels(), GetTerrainType(), IsSuitableForFarmField(), PlaceTree(), and TileLoop_Water().
|
inlinestatic |
Returns the tree growth status.
This function returns the tree growth status of a tile with trees.
t | The tile to get the tree growth status |
Definition at line 181 of file tree_map.h.
References _m, GB(), IsTileType(), 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 74 of file tree_map.h.
References _m, IsTileType(), Tile::m3, and MP_TREES.
|
inlinestatic |
Make a tree-tile.
This functions change the tile to a tile with trees and all informations 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 status |
ground | the ground type |
density | the density (not the number of trees) |
Definition at line 274 of file tree_map.h.
References _m, _me, Tile::m2, Tile::m3, Tile::m4, Tile::m5, TileExtended::m7, MP_TREES, OWNER_NONE, SB(), SetTileOwner(), and SetTileType().
Referenced by PlantTreesOnTile().
|
inlinestatic |
Set the tick counter for a tree-tile.
This function sets directly the tick counter for a tree-tile.
t | The tile to set the tick counter |
c | The new tick counter value |
Definition at line 256 of file tree_map.h.
References _m, IsTileType(), MP_TREES, and SB().
Referenced by PlaceTree().
|
inlinestatic |
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 131 of file tree_map.h.
References _m, IsTileType(), MP_TREES, and SB().
Referenced by DoDryUp(), DoFloodTile(), and PlaceTree().
|
inlinestatic |
Sets the tree growth status of a tile.
This function sets the tree growth status of a tile directly with the given value.
t | The tile to change the tree growth status |
g | The new value |
Definition at line 212 of file tree_map.h.
References _m, IsTileType(), MP_TREES, and SB().