tree_map.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef TREE_MAP_H
#define TREE_MAP_H
 
#include "tile_map.h"
#include "water_map.h"

enum TreeType : uint8_t {
  TREE_TEMPERATE    = 0x00, 
  TREE_SUB_ARCTIC   = 0x0C, 
  TREE_RAINFOREST   = 0x14, 
  TREE_CACTUS       = 0x1B, 
  TREE_SUB_TROPICAL = 0x1C, 
  TREE_TOYLAND      = 0x20, 
  TREE_INVALID      = 0xFF, 
};
 
/* Counts the number of tree types for each landscape.
 *
 * This list contains the counts of different tree types for each landscape. This list contains
 * 5 entries instead of 4 (as there are only 4 landscape types) as the sub tropic landscape
 * has two types of area, one for normal trees and one only for cacti.
 */
static const uint TREE_COUNT_TEMPERATE    = TREE_SUB_ARCTIC - TREE_TEMPERATE;    
static const uint TREE_COUNT_SUB_ARCTIC   = TREE_RAINFOREST - TREE_SUB_ARCTIC;   
static const uint TREE_COUNT_RAINFOREST   = TREE_CACTUS     - TREE_RAINFOREST;   
static const uint TREE_COUNT_SUB_TROPICAL = TREE_TOYLAND    - TREE_SUB_TROPICAL; 
static const uint TREE_COUNT_TOYLAND      = 9;                                   

enum class TreeGround : uint8_t {
  Grass = 0, 
  Rough = 1, 
  SnowOrDesert = 2, 
  Shore = 3, 
  RoughSnow = 4, 
};

enum class TreeGrowthStage : uint8_t {
  Growing1 = 0,  
  Growing2 = 1,  
  Growing3 = 2,  
  Grown = 3,  
  Dying1 = 4,  
  Dying2 = 5,  
  Dead = 6,  
};

inline TreeType GetTreeType(Tile t)
{
  assert(IsTileType(t, TileType::Trees));
  return (TreeType)t.m3();
}

inline TreeGround GetTreeGround(Tile t)
{
  assert(IsTileType(t, TileType::Trees));
  return (TreeGround)GB(t.m2(), 6, 3);
}

inline uint GetTreeDensity(Tile t)
{
  assert(IsTileType(t, TileType::Trees));
  return GB(t.m2(), 4, 2);
}

inline void SetTreeGroundDensity(Tile t, TreeGround g, uint d)
{
  assert(IsTileType(t, TileType::Trees)); // XXX incomplete
  SB(t.m2(), 4, 2, d);
  SB(t.m2(), 6, 3, to_underlying(g));
  SetWaterClass(t, g == TreeGround::Shore ? WaterClass::Sea : WaterClass::Invalid);
}

inline uint GetTreeCount(Tile t)
{
  assert(IsTileType(t, TileType::Trees));
  return GB(t.m5(), 6, 2) + 1;
}

inline void AddTreeCount(Tile t, int c)
{
  assert(IsTileType(t, TileType::Trees)); // XXX incomplete
  t.m5() += c << 6;
}

inline TreeGrowthStage GetTreeGrowth(Tile t)
{
  assert(IsTileType(t, TileType::Trees));
  return static_cast<TreeGrowthStage>(GB(t.m5(), 0, 3));
}

inline void AddTreeGrowth(Tile t, int a)
{
  assert(IsTileType(t, TileType::Trees)); // XXX incomplete
  t.m5() += a;
}

inline void SetTreeGrowth(Tile t, TreeGrowthStage g)
{
  assert(IsTileType(t, TileType::Trees)); // XXX incomplete
  SB(t.m5(), 0, 3, to_underlying(g));
}

inline void MakeTree(Tile t, TreeType type, uint count, TreeGrowthStage growth, TreeGround ground, uint density)
{
  SetTileType(t, TileType::Trees);
  SetTileOwner(t, OWNER_NONE);
  SetWaterClass(t, ground == TreeGround::Shore ? WaterClass::Sea : WaterClass::Invalid);
  t.m2() = to_underlying(ground) << 6 | density << 4 | 0;
  t.m3() = type;
  t.m4() = 0 << 5 | 0 << 2;
  t.m5() = count << 6 | to_underlying(growth);
  SB(t.m6(), 2, 6, 0);
  t.m7() = 0;
  t.m8() = 0;
}
 
#endif /* TREE_MAP_H */