OpenTTD
tree_map.h
Go to the documentation of this file.
1 /* $Id: tree_map.h 26878 2014-09-21 11:23:33Z rubidium $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #ifndef TREE_MAP_H
13 #define TREE_MAP_H
14 
15 #include "tile_map.h"
16 
26 enum TreeType {
27  TREE_TEMPERATE = 0x00,
28  TREE_SUB_ARCTIC = 0x0C,
29  TREE_RAINFOREST = 0x14,
30  TREE_CACTUS = 0x1B,
32  TREE_TOYLAND = 0x20,
33  TREE_INVALID = 0xFF,
34 };
35 
36 /* Counts the number of tree types for each landscape.
37  *
38  * This list contains the counts of different tree types for each landscape. This list contains
39  * 5 entries instead of 4 (as there are only 4 landscape types) as the sub tropic landscape
40  * has two types of area, one for normal trees and one only for cacti.
41  */
46 static const uint TREE_COUNT_TOYLAND = 9;
47 
53 enum TreeGround {
59 };
60 
61 
74 static inline TreeType GetTreeType(TileIndex t)
75 {
76  assert(IsTileType(t, MP_TREES));
77  return (TreeType)_m[t].m3;
78 }
79 
90 {
91  assert(IsTileType(t, MP_TREES));
92  return (TreeGround)GB(_m[t].m2, 6, 3);
93 }
94 
114 static inline uint GetTreeDensity(TileIndex t)
115 {
116  assert(IsTileType(t, MP_TREES));
117  return GB(_m[t].m2, 4, 2);
118 }
119 
131 static inline void SetTreeGroundDensity(TileIndex t, TreeGround g, uint d)
132 {
133  assert(IsTileType(t, MP_TREES)); // XXX incomplete
134  SB(_m[t].m2, 4, 2, d);
135  SB(_m[t].m2, 6, 3, g);
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);
278  _m[t].m2 = ground << 6 | density << 4 | 0;
279  _m[t].m3 = type;
280  _m[t].m4 = 0 << 5 | 0 << 2;
281  _m[t].m5 = count << 6 | growth;
282  SB(_me[t].m6, 2, 4, 0);
283  _me[t].m7 = 0;
284 }
285 
286 #endif /* TREE_MAP_H */
static const uint TREE_COUNT_TEMPERATE
number of tree types on a temperate map.
Definition: tree_map.h:42
static const uint TREE_COUNT_SUB_TROPICAL
number of tree types for the &#39;sub-tropic part&#39; of a sub-tropic map.
Definition: tree_map.h:45
static void AddTreeCounter(TileIndex t, int a)
Add a value on the tick counter of a tree-tile.
Definition: tree_map.h:241
static void SetTileOwner(TileIndex tile, Owner owner)
Sets the owner of a tile.
Definition: tile_map.h:191
static const uint TREE_COUNT_TOYLAND
number of tree types on a toyland map.
Definition: tree_map.h:46
static void SetTreeCounter(TileIndex t, uint c)
Set the tick counter for a tree-tile.
Definition: tree_map.h:256
static uint GetTreeCounter(TileIndex t)
Get the tick counter of a tree tile.
Definition: tree_map.h:226
byte m7
Primarily used for newgrf support.
Definition: map_type.h:37
uint16 m2
Primarily used for indices to towns, industries and stations.
Definition: map_type.h:22
Tile * _m
Tiles of the map.
Definition: map.cpp:32
A snow tile that is rough underneath.
Definition: tree_map.h:58
static void SetTreeGroundDensity(TileIndex t, TreeGround g, uint d)
Set the density and ground type of a tile with trees.
Definition: tree_map.h:131
static void MakeTree(TileIndex t, TreeType type, uint count, uint growth, TreeGround ground, uint density)
Make a tree-tile.
Definition: tree_map.h:274
static const uint TREE_COUNT_RAINFOREST
number of tree types for the &#39;rainforest part&#39; of a sub-tropic map.
Definition: tree_map.h:44
static TreeType GetTreeType(TileIndex t)
Returns the treetype of a tile.
Definition: tree_map.h:74
some rough tile
Definition: tree_map.h:55
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.
An invalid tree.
Definition: tree_map.h:33
static uint GetTreeGrowth(TileIndex t)
Returns the tree growth status.
Definition: tree_map.h:181
static void SetTreeGrowth(TileIndex t, uint g)
Sets the tree growth status of a tile.
Definition: tree_map.h:212
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a give tiletype.
Definition: tile_map.h:143
TileExtended * _me
Extended Tiles of the map.
Definition: map.cpp:33
byte m5
General purpose.
Definition: map_type.h:26
static uint GetTreeDensity(TileIndex t)
Returns the &#39;density&#39; of a tile with trees.
Definition: tree_map.h:114
tree on a sub_arctic landscape
Definition: tree_map.h:28
The tile has no ownership.
Definition: company_type.h:27
a desert or snow tile, depend on landscape
Definition: tree_map.h:56
a cactus for the &#39;desert part&#39; on a sub-tropical map
Definition: tree_map.h:30
temperate tree
Definition: tree_map.h:27
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
Tile got trees.
Definition: tile_type.h:47
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
static TreeGround GetTreeGround(TileIndex t)
Returns the groundtype for tree tiles.
Definition: tree_map.h:89
static uint GetTreeCount(TileIndex t)
Returns the number of trees on a tile.
Definition: tree_map.h:149
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
static void SetTileType(TileIndex tile, TileType type)
Set the type of a tile.
Definition: tile_map.h:124
tree on a toyland map
Definition: tree_map.h:32
TreeType
List of tree types along all landscape types.
Definition: tree_map.h:26
static void AddTreeGrowth(TileIndex t, int a)
Add a value to the tree growth status.
Definition: tree_map.h:196
normal grass
Definition: tree_map.h:54
tree on a sub-tropical map, non-rainforest, non-desert
Definition: tree_map.h:31
TreeGround
Enumeration for ground types of tiles with trees.
Definition: tree_map.h:53
Map writing/reading functions for tiles.
static const uint TREE_COUNT_SUB_ARCTIC
number of tree types on a sub arctic map.
Definition: tree_map.h:43
tree on the &#39;green part&#39; on a sub-tropical map
Definition: tree_map.h:29
byte m3
General purpose.
Definition: map_type.h:24
byte m4
General purpose.
Definition: map_type.h:25