OpenTTD Source: src/tree_map.h Source File

OpenTTD Source 13.1

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
60
73 static inline TreeType GetTreeType(TileIndex t)
74 {
75 assert(IsTileType(t, MP_TREES));
76 return (TreeType)_m[t].m3;
77 }
78
88 static inline TreeGround GetTreeGround(TileIndex t)
89 {
90 assert(IsTileType(t, MP_TREES));
91 return (TreeGround)GB(_m[t].m2, 6, 3);
92 }
93
113 static inline uint GetTreeDensity(TileIndex t)
114 {
115 assert(IsTileType(t, MP_TREES));
116 return GB(_m[t].m2, 4, 2);
117 }
118
130 static inline void SetTreeGroundDensity(TileIndex t, TreeGround g, uint d)
131 {
132 assert(IsTileType(t, MP_TREES)); // XXX incomplete
133 SB(_m[t].m2, 4, 2, d);
134 SB(_m[t].m2, 6, 3, g);
135 SetWaterClass(t, g == TREE_GROUND_SHORE ? WATER_CLASS_SEA : WATER_CLASS_INVALID);
136 }
137
149 static inline uint GetTreeCount(TileIndex t)
150 {
151 assert(IsTileType(t, MP_TREES));
152 return GB(_m[t].m5, 6, 2) + 1;
153 }
154
166 static inline void AddTreeCount(TileIndex t, int c)
167 {
168 assert(IsTileType(t, MP_TREES)); // XXX incomplete
169 _m[t].m5 += c << 6;
170 }
171
181 static inline uint GetTreeGrowth(TileIndex t)
182 {
183 assert(IsTileType(t, MP_TREES));
184 return GB(_m[t].m5, 0, 3);
185 }
186
196 static inline void AddTreeGrowth(TileIndex t, int a)
197 {
198 assert(IsTileType(t, MP_TREES)); // XXX incomplete
199 _m[t].m5 += a;
200 }
201
212 static inline void SetTreeGrowth(TileIndex t, uint g)
213 {
214 assert(IsTileType(t, MP_TREES)); // XXX incomplete
215 SB(_m[t].m5, 0, 3, g);
216 }
217
226 static inline uint GetTreeCounter(TileIndex t)
227 {
228 assert(IsTileType(t, MP_TREES));
229 return GB(_m[t].m2, 0, 4);
230 }
231
241 static inline void AddTreeCounter(TileIndex t, int a)
242 {
243 assert(IsTileType(t, MP_TREES)); // XXX incomplete
244 _m[t].m2 += a;
245 }
246
256 static inline void SetTreeCounter(TileIndex t, uint c)
257 {
258 assert(IsTileType(t, MP_TREES)); // XXX incomplete
259 SB(_m[t].m2, 0, 4, c);
260 }
261
274 static inline void MakeTree(TileIndex t, TreeType type, uint count, uint growth, TreeGround ground, uint density)
275 {
276 SetTileType(t, MP_TREES);
277 SetTileOwner(t, OWNER_NONE);
278 SetWaterClass(t, ground == TREE_GROUND_SHORE ? WATER_CLASS_SEA : WATER_CLASS_INVALID);
279 _m[t].m2 = ground << 6 | density << 4 | 0;
280 _m[t].m3 = type;
281 _m[t].m4 = 0 << 5 | 0 << 2;
282 _m[t].m5 = count << 6 | growth;
283 SB(_me[t].m6, 2, 4, 0);
284 _me[t].m7 = 0;
285 }
286
287 #endif /* TREE_MAP_H */
GetTreeType
static TreeType GetTreeType(TileIndex t)
Returns the treetype of a tile.
Definition: tree_map.h:73
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
GetTreeGrowth
static uint GetTreeGrowth(TileIndex t)
Returns the tree growth status.
Definition: tree_map.h:181
SetTileType
static void SetTileType(TileIndex tile, TileType type)
Set the type of a tile.
Definition: tile_map.h:131
SetTreeGrowth
static void SetTreeGrowth(TileIndex t, uint g)
Sets the tree growth status of a tile.
Definition: tree_map.h:212
TREE_RAINFOREST
@ TREE_RAINFOREST
tree on the 'green part' on a sub-tropical map
Definition: tree_map.h:28
TREE_GROUND_SHORE
@ TREE_GROUND_SHORE
shore
Definition: tree_map.h:56
GetTreeDensity
static uint GetTreeDensity(TileIndex t)
Returns the 'density' of a tile with trees.
Definition: tree_map.h:113
_me
TileExtended * _me
Extended Tiles of the map.
Definition: map.cpp:31
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
Tile::m2
uint16 m2
Primarily used for indices to towns, industries and stations.
Definition: map_type.h:20
TREE_COUNT_TEMPERATE
static const uint TREE_COUNT_TEMPERATE
number of tree types on a temperate map.
Definition: tree_map.h:41
WATER_CLASS_INVALID
@ WATER_CLASS_INVALID
Used for industry tiles on land (also for oilrig if newgrf says so).
Definition: water_map.h:51
SetTreeCounter
static void SetTreeCounter(TileIndex t, uint c)
Set the tick counter for a tree-tile.
Definition: tree_map.h:256
GetTreeCounter
static uint GetTreeCounter(TileIndex t)
Get the tick counter of a tree tile.
Definition: tree_map.h:226
GetTreeCount
static uint GetTreeCount(TileIndex t)
Returns the number of trees on a tile.
Definition: tree_map.h:149
TREE_GROUND_ROUGH
@ TREE_GROUND_ROUGH
some rough tile
Definition: tree_map.h:54
TREE_SUB_ARCTIC
@ TREE_SUB_ARCTIC
tree on a sub_arctic landscape
Definition: tree_map.h:27
tile_map.h
SB
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
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
TREE_TOYLAND
@ TREE_TOYLAND
tree on a toyland map
Definition: tree_map.h:31
WATER_CLASS_SEA
@ WATER_CLASS_SEA
Sea.
Definition: water_map.h:48
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
TREE_GROUND_GRASS
@ TREE_GROUND_GRASS
normal grass
Definition: tree_map.h:53
MP_TREES
@ MP_TREES
Tile got trees.
Definition: tile_type.h:52
water_map.h
TREE_SUB_TROPICAL
@ TREE_SUB_TROPICAL
tree on a sub-tropical map, non-rainforest, non-desert
Definition: tree_map.h:30
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
TreeGround
TreeGround
Enumeration for ground types of tiles with trees.
Definition: tree_map.h:52
Tile::m5
byte m5
General purpose.
Definition: map_type.h:24
TREE_COUNT_TOYLAND
static const uint TREE_COUNT_TOYLAND
number of tree types on a toyland map.
Definition: tree_map.h:45
AddTreeGrowth
static void AddTreeGrowth(TileIndex t, int a)
Add a value to the tree growth status.
Definition: tree_map.h:196
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
AddTreeCount
static void AddTreeCount(TileIndex t, int c)
Add a amount to the tree-count value of a tile with trees.
Definition: tree_map.h:166
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
MakeTree
static void MakeTree(TileIndex t, TreeType type, uint count, uint growth, TreeGround ground, uint density)
Make a tree-tile.
Definition: tree_map.h:274
GetTreeGround
static TreeGround GetTreeGround(TileIndex t)
Returns the groundtype for tree tiles.
Definition: tree_map.h:88
TileExtended::m7
byte m7
Primarily used for newgrf support.
Definition: map_type.h:35
TREE_TEMPERATE
@ TREE_TEMPERATE
temperate tree
Definition: tree_map.h:26
AddTreeCounter
static void AddTreeCounter(TileIndex t, int a)
Add a value on the tick counter of a tree-tile.
Definition: tree_map.h:241
SetTileOwner
static void SetTileOwner(TileIndex tile, Owner owner)
Sets the owner of a tile.
Definition: tile_map.h:198
TREE_GROUND_SNOW_DESERT
@ TREE_GROUND_SNOW_DESERT
a desert or snow tile, depend on landscape
Definition: tree_map.h:55
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
SetWaterClass
static void SetWaterClass(TileIndex t, WaterClass wc)
Set the water class at a tile.
Definition: water_map.h:129
Tile::m3
byte m3
General purpose.
Definition: map_type.h:22
Tile::m4
byte m4
General purpose.
Definition: map_type.h:23
_m
Tile * _m
Tiles of the map.
Definition: map.cpp:30
TreeType
TreeType
List of tree types along all landscape types.
Definition: tree_map.h:25
SetTreeGroundDensity
static void SetTreeGroundDensity(TileIndex t, TreeGround g, uint d)
Set the density and ground type of a tile with trees.
Definition: tree_map.h:130
TREE_GROUND_ROUGH_SNOW
@ TREE_GROUND_ROUGH_SNOW
A snow tile that is rough underneath.
Definition: tree_map.h:57