OpenTTD Source: src/tree_map.h Source File

OpenTTD Source 15.0-beta1

tree_map.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#ifndef TREE_MAP_H
11#define TREE_MAP_H
12
13#include "tile_map.h"
14#include "water_map.h"
15
25 enum TreeType {
26 TREE_TEMPERATE = 0x00,
27 TREE_SUB_ARCTIC = 0x0C,
28 TREE_RAINFOREST = 0x14,
29 TREE_CACTUS = 0x1B,
30 TREE_SUB_TROPICAL = 0x1C,
31 TREE_TOYLAND = 0x20,
32 TREE_INVALID = 0xFF,
33};
34
35/* Counts the number of tree types for each landscape.
36 *
37 * This list contains the counts of different tree types for each landscape. This list contains
38 * 5 entries instead of 4 (as there are only 4 landscape types) as the sub tropic landscape
39 * has two types of area, one for normal trees and one only for cacti.
40 */
41 static const uint TREE_COUNT_TEMPERATE = TREE_SUB_ARCTIC - TREE_TEMPERATE;
42 static const uint TREE_COUNT_SUB_ARCTIC = TREE_RAINFOREST - TREE_SUB_ARCTIC;
43 static const uint TREE_COUNT_RAINFOREST = TREE_CACTUS - TREE_RAINFOREST;
44 static const uint TREE_COUNT_SUB_TROPICAL = TREE_TOYLAND - TREE_SUB_TROPICAL;
45 static const uint TREE_COUNT_TOYLAND = 9;
46
52 enum TreeGround {
53 TREE_GROUND_GRASS = 0,
54 TREE_GROUND_ROUGH = 1,
55 TREE_GROUND_SNOW_DESERT = 2,
56 TREE_GROUND_SHORE = 3,
57 TREE_GROUND_ROUGH_SNOW = 4,
58};
59
65 enum class TreeGrowthStage : uint {
66 Growing1 = 0,
67 Growing2 = 1,
68 Growing3 = 2,
69 Grown = 3,
70 Dying1 = 4,
71 Dying2 = 5,
72 Dead = 6,
73};
74
87 inline TreeType GetTreeType(Tile t)
88{
89 assert(IsTileType(t, MP_TREES));
90 return (TreeType)t.m3();
91}
92
102 inline TreeGround GetTreeGround(Tile t)
103{
104 assert(IsTileType(t, MP_TREES));
105 return (TreeGround)GB(t.m2(), 6, 3);
106}
107
127 inline uint GetTreeDensity(Tile t)
128{
129 assert(IsTileType(t, MP_TREES));
130 return GB(t.m2(), 4, 2);
131}
132
144 inline void SetTreeGroundDensity(Tile t, TreeGround g, uint d)
145{
146 assert(IsTileType(t, MP_TREES)); // XXX incomplete
147 SB(t.m2(), 4, 2, d);
148 SB(t.m2(), 6, 3, g);
149 SetWaterClass(t, g == TREE_GROUND_SHORE ? WATER_CLASS_SEA : WATER_CLASS_INVALID);
150}
151
163 inline uint GetTreeCount(Tile t)
164{
165 assert(IsTileType(t, MP_TREES));
166 return GB(t.m5(), 6, 2) + 1;
167}
168
180 inline void AddTreeCount(Tile t, int c)
181{
182 assert(IsTileType(t, MP_TREES)); // XXX incomplete
183 t.m5() += c << 6;
184}
185
195 inline TreeGrowthStage GetTreeGrowth(Tile t)
196{
197 assert(IsTileType(t, MP_TREES));
198 return static_cast<TreeGrowthStage>(GB(t.m5(), 0, 3));
199}
200
210 inline void AddTreeGrowth(Tile t, int a)
211{
212 assert(IsTileType(t, MP_TREES)); // XXX incomplete
213 t.m5() += a;
214}
215
226 inline void SetTreeGrowth(Tile t, TreeGrowthStage g)
227{
228 assert(IsTileType(t, MP_TREES)); // XXX incomplete
229 SB(t.m5(), 0, 3, static_cast<uint>(g));
230}
231
244 inline void MakeTree(Tile t, TreeType type, uint count, TreeGrowthStage growth, TreeGround ground, uint density)
245{
246 SetTileType(t, MP_TREES);
247 SetTileOwner(t, OWNER_NONE);
248 SetWaterClass(t, ground == TREE_GROUND_SHORE ? WATER_CLASS_SEA : WATER_CLASS_INVALID);
249 t.m2() = ground << 6 | density << 4 | 0;
250 t.m3() = type;
251 t.m4() = 0 << 5 | 0 << 2;
252 t.m5() = count << 6 | static_cast<uint>(growth);
253 SB(t.m6(), 2, 4, 0);
254 t.m7() = 0;
255}
256
257#endif /* TREE_MAP_H */
SB
constexpr T SB(T &x, const uint8_t s, const uint8_t n, const U d)
Set n bits in x starting at bit s to d.
Definition bitmath_func.hpp:58
GB
debug_inline static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Definition bitmath_func.hpp:32
Tile
Wrapper class to abstract away the way the tiles are stored.
Definition map_func.h:25
Tile::m2
debug_inline uint16_t & m2()
Primarily used for indices to towns, industries and stations.
Definition map_func.h:125
Tile::m7
debug_inline uint8_t & m7()
Primarily used for newgrf support.
Definition map_func.h:185
Tile::m4
debug_inline uint8_t & m4()
General purpose.
Definition map_func.h:149
Tile::m6
debug_inline uint8_t & m6()
General purpose.
Definition map_func.h:173
Tile::m3
debug_inline uint8_t & m3()
General purpose.
Definition map_func.h:137
Tile::m5
debug_inline uint8_t & m5()
General purpose.
Definition map_func.h:161
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition company_type.h:25
tile_map.h
Map writing/reading functions for tiles.
SetTileType
void SetTileType(Tile tile, TileType type)
Set the type of a tile.
Definition tile_map.h:131
SetTileOwner
void SetTileOwner(Tile tile, Owner owner)
Sets the owner of a tile.
Definition tile_map.h:198
IsTileType
static debug_inline bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
MP_TREES
@ MP_TREES
Tile got trees.
Definition tile_type.h:52
TREE_COUNT_RAINFOREST
static const uint TREE_COUNT_RAINFOREST
number of tree types for the 'rainforest part' of a sub-tropic map.
Definition tree_map.h:43
GetTreeCount
uint GetTreeCount(Tile t)
Returns the number of trees on a tile.
Definition tree_map.h:163
GetTreeGrowth
TreeGrowthStage GetTreeGrowth(Tile t)
Returns the tree growth stage.
Definition tree_map.h:195
TREE_COUNT_SUB_TROPICAL
static const uint TREE_COUNT_SUB_TROPICAL
number of tree types for the 'sub-tropic part' of a sub-tropic map.
Definition tree_map.h:44
TREE_COUNT_TOYLAND
static const uint TREE_COUNT_TOYLAND
number of tree types on a toyland map.
Definition tree_map.h:45
MakeTree
void MakeTree(Tile t, TreeType type, uint count, TreeGrowthStage growth, TreeGround ground, uint density)
Make a tree-tile.
Definition tree_map.h:244
SetTreeGrowth
void SetTreeGrowth(Tile t, TreeGrowthStage g)
Sets the tree growth stage of a tile.
Definition tree_map.h:226
GetTreeGround
TreeGround GetTreeGround(Tile t)
Returns the groundtype for tree tiles.
Definition tree_map.h:102
TreeGrowthStage
TreeGrowthStage
Enumeration for tree growth stages.
Definition tree_map.h:65
TreeGrowthStage::Grown
@ Grown
Fully grown tree.
TreeGrowthStage::Dead
@ Dead
Dead tree.
TreeGrowthStage::Dying1
@ Dying1
First stage of dying.
TreeGrowthStage::Growing1
@ Growing1
First stage of growth.
TreeGrowthStage::Growing2
@ Growing2
Second stage of growth.
TreeGrowthStage::Dying2
@ Dying2
Second stage of dying.
TreeGrowthStage::Growing3
@ Growing3
Third stage of growth.
AddTreeCount
void AddTreeCount(Tile t, int c)
Add a amount to the tree-count value of a tile with trees.
Definition tree_map.h:180
TREE_COUNT_SUB_ARCTIC
static const uint TREE_COUNT_SUB_ARCTIC
number of tree types on a sub arctic map.
Definition tree_map.h:42
GetTreeType
TreeType GetTreeType(Tile t)
Returns the treetype of a tile.
Definition tree_map.h:87
TreeGround
TreeGround
Enumeration for ground types of tiles with trees.
Definition tree_map.h:52
TREE_GROUND_GRASS
@ TREE_GROUND_GRASS
normal grass
Definition tree_map.h:53
TREE_GROUND_SHORE
@ TREE_GROUND_SHORE
shore
Definition tree_map.h:56
TREE_GROUND_ROUGH_SNOW
@ TREE_GROUND_ROUGH_SNOW
A snow tile that is rough underneath.
Definition tree_map.h:57
TREE_GROUND_SNOW_DESERT
@ TREE_GROUND_SNOW_DESERT
a desert or snow tile, depend on landscape
Definition tree_map.h:55
TREE_GROUND_ROUGH
@ TREE_GROUND_ROUGH
some rough tile
Definition tree_map.h:54
TreeType
TreeType
List of tree types along all landscape types.
Definition tree_map.h:25
TREE_RAINFOREST
@ TREE_RAINFOREST
tree on the 'green part' on a sub-tropical map
Definition tree_map.h:28
TREE_TOYLAND
@ TREE_TOYLAND
tree on a toyland map
Definition tree_map.h:31
TREE_SUB_ARCTIC
@ TREE_SUB_ARCTIC
tree on a sub_arctic landscape
Definition tree_map.h:27
TREE_SUB_TROPICAL
@ TREE_SUB_TROPICAL
tree on a sub-tropical map, non-rainforest, non-desert
Definition tree_map.h:30
TREE_TEMPERATE
@ TREE_TEMPERATE
temperate tree
Definition tree_map.h:26
TREE_CACTUS
@ TREE_CACTUS
a cactus for the 'desert part' on a sub-tropical map
Definition tree_map.h:29
TREE_INVALID
@ TREE_INVALID
An invalid tree.
Definition tree_map.h:32
SetTreeGroundDensity
void SetTreeGroundDensity(Tile t, TreeGround g, uint d)
Set the density and ground type of a tile with trees.
Definition tree_map.h:144
AddTreeGrowth
void AddTreeGrowth(Tile t, int a)
Add a value to the tree growth stage.
Definition tree_map.h:210
GetTreeDensity
uint GetTreeDensity(Tile t)
Returns the 'density' of a tile with trees.
Definition tree_map.h:127
TREE_COUNT_TEMPERATE
static const uint TREE_COUNT_TEMPERATE
number of tree types on a temperate map.
Definition tree_map.h:41
water_map.h
Map accessors for water tiles.
SetWaterClass
void SetWaterClass(Tile t, WaterClass wc)
Set the water class at a tile.
Definition water_map.h:124
WATER_CLASS_SEA
@ WATER_CLASS_SEA
Sea.
Definition water_map.h:40
WATER_CLASS_INVALID
@ WATER_CLASS_INVALID
Used for industry tiles on land (also for oilrig if newgrf says so).
Definition water_map.h:43