industry_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 INDUSTRY_MAP_H
#define INDUSTRY_MAP_H
 
#include "industrytype.h"
#include "water_map.h"
 

enum IndustryGraphics : uint8_t {
  GFX_COAL_MINE_TOWER_NOT_ANIMATED   =   0,
  GFX_COAL_MINE_TOWER_ANIMATED       =   1,
  GFX_POWERPLANT_CHIMNEY             =   8,
  GFX_POWERPLANT_SPARKS              =  10,
  GFX_OILRIG_1                       =  24,
  GFX_OILRIG_2                       =  25,
  GFX_OILRIG_3                       =  26,
  GFX_OILRIG_4                       =  27,
  GFX_OILRIG_5                       =  28,
  GFX_OILWELL_NOT_ANIMATED           =  29,
  GFX_OILWELL_ANIMATED_1             =  30,
  GFX_OILWELL_ANIMATED_2             =  31,
  GFX_OILWELL_ANIMATED_3             =  32,
  GFX_COPPER_MINE_TOWER_NOT_ANIMATED =  47,
  GFX_COPPER_MINE_TOWER_ANIMATED     =  48,
  GFX_COPPER_MINE_CHIMNEY            =  49,
  GFX_GOLD_MINE_TOWER_NOT_ANIMATED   =  79,
  GFX_GOLD_MINE_TOWER_ANIMATED       =  88,
  GFX_TOY_FACTORY                    = 143,
  GFX_PLASTIC_FOUNTAIN_ANIMATED_1    = 148,
  GFX_PLASTIC_FOUNTAIN_ANIMATED_2    = 149,
  GFX_PLASTIC_FOUNTAIN_ANIMATED_3    = 150,
  GFX_PLASTIC_FOUNTAIN_ANIMATED_4    = 151,
  GFX_PLASTIC_FOUNTAIN_ANIMATED_5    = 152,
  GFX_PLASTIC_FOUNTAIN_ANIMATED_6    = 153,
  GFX_PLASTIC_FOUNTAIN_ANIMATED_7    = 154,
  GFX_PLASTIC_FOUNTAIN_ANIMATED_8    = 155,
  GFX_BUBBLE_GENERATOR               = 161,
  GFX_BUBBLE_CATCHER                 = 162,
  GFX_TOFFEE_QUARRY                  = 165,
  GFX_SUGAR_MINE_SIEVE               = 174,
  GFX_WATERTILE_SPECIALCHECK         = 255,  
};

inline IndustryID GetIndustryIndex(Tile t)
{
  assert(IsTileType(t, TileType::Industry));
  return static_cast<IndustryID>(t.m2());
}

inline bool IsIndustryCompleted(Tile t)
{
  assert(IsTileType(t, TileType::Industry));
  return HasBit(t.m1(), 7);
}
 
IndustryType GetIndustryType(Tile tile);

inline void SetIndustryCompleted(Tile tile)
{
  assert(IsTileType(tile, TileType::Industry));
  SetBit(tile.m1(), 7);
}

inline uint8_t GetIndustryConstructionStage(Tile tile)
{
  assert(IsTileType(tile, TileType::Industry));
  return IsIndustryCompleted(tile) ? (uint8_t)INDUSTRY_COMPLETED : GB(tile.m1(), 0, 2);
}

inline void SetIndustryConstructionStage(Tile tile, uint8_t value)
{
  assert(IsTileType(tile, TileType::Industry));
  SB(tile.m1(), 0, 2, value);
}

inline IndustryGfx GetCleanIndustryGfx(Tile t)
{
  assert(IsTileType(t, TileType::Industry));
  return t.m5() | (GB(t.m6(), 2, 1) << 8);
}

inline IndustryGfx GetIndustryGfx(Tile t)
{
  assert(IsTileType(t, TileType::Industry));
  return GetTranslatedIndustryTileID(GetCleanIndustryGfx(t));
}

inline void SetIndustryGfx(Tile t, IndustryGfx gfx)
{
  assert(IsTileType(t, TileType::Industry));
  t.m5() = GB(gfx, 0, 8);
  SB(t.m6(), 2, 1, GB(gfx, 8, 1));
}

inline uint8_t GetIndustryConstructionCounter(Tile tile)
{
  assert(IsTileType(tile, TileType::Industry));
  return GB(tile.m1(), 2, 2);
}

inline void SetIndustryConstructionCounter(Tile tile, uint8_t value)
{
  assert(IsTileType(tile, TileType::Industry));
  SB(tile.m1(), 2, 2, value);
}

inline void ResetIndustryConstructionStage(Tile tile)
{
  assert(IsTileType(tile, TileType::Industry));
  SB(tile.m1(), 0, 4, 0);
  SB(tile.m1(), 7, 1, 0);
}

inline uint8_t GetIndustryAnimationLoop(Tile tile)
{
  assert(IsTileType(tile, TileType::Industry));
  return tile.m4();
}

inline void SetIndustryAnimationLoop(Tile tile, uint8_t count)
{
  assert(IsTileType(tile, TileType::Industry));
  tile.m4() = count;
}

inline uint8_t GetIndustryRandomBits(Tile tile)
{
  assert(IsTileType(tile, TileType::Industry));
  return tile.m3();
}

inline void SetIndustryRandomBits(Tile tile, uint8_t bits)
{
  assert(IsTileType(tile, TileType::Industry));
  tile.m3() = bits;
}

inline IndustryRandomTriggers GetIndustryRandomTriggers(Tile tile)
{
  assert(IsTileType(tile, TileType::Industry));
  return static_cast<IndustryRandomTriggers>(GB(tile.m6(), 3, 3));
}
 

inline void SetIndustryRandomTriggers(Tile tile, IndustryRandomTriggers triggers)
{
  assert(IsTileType(tile, TileType::Industry));
  SB(tile.m6(), 3, 3, triggers.base());
}

inline void MakeIndustry(Tile t, IndustryID index, IndustryGfx gfx, uint8_t random, WaterClass wc)
{
  SetTileType(t, TileType::Industry);
  t.m1() = 0;
  t.m2() = index.base();
  SetIndustryRandomBits(t, random); // m3
  t.m4() = 0;
  SetIndustryGfx(t, gfx); // m5, part of m6
  SetIndustryRandomTriggers(t, {}); // rest of m6
  SetWaterClass(t, wc);
  SB(t.m6(), 6, 2, 0);
  t.m7() = 0;
  t.m8() = 0;
}
 
#endif /* INDUSTRY_MAP_H */