town_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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef TOWN_MAP_H
#define TOWN_MAP_H
 
#include "road_map.h"
#include "house.h"
#include "timer/timer_game_calendar.h"
 
inline TownID GetTownIndex(Tile t)
{
  assert(IsTileType(t, MP_HOUSE) || (IsTileType(t, MP_ROAD) && !IsRoadDepot(t)));
  return static_cast<TownID>(t.m2());
}
 
inline void SetTownIndex(Tile t, TownID index)
{
  assert(IsTileType(t, MP_HOUSE) || (IsTileType(t, MP_ROAD) && !IsRoadDepot(t)));
  t.m2() = index.base();
}
 
inline HouseID GetCleanHouseType(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  return GB(t.m8(), 0, 12);
}
 
inline HouseID GetHouseType(Tile t)
{
  return GetTranslatedHouseID(GetCleanHouseType(t));
}
 
inline void SetHouseType(Tile t, HouseID house_id)
{
  assert(IsTileType(t, MP_HOUSE));
  SB(t.m8(), 0, 12, house_id);
}
 
inline bool IsHouseProtected(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  return HasBit(t.m3(), 5);
}
 
inline void SetHouseProtected(Tile t, bool house_protected)
{
  assert(IsTileType(t, MP_HOUSE));
  SB(t.m3(), 5, 1, house_protected ? 1 : 0);
}
 
inline bool LiftHasDestination(Tile t)
{
  return HasBit(t.m7(), 0);
}
 
inline void SetLiftDestination(Tile t, uint8_t dest)
{
  SetBit(t.m7(), 0);
  SB(t.m7(), 1, 3, dest);
}
 
inline uint8_t GetLiftDestination(Tile t)
{
  return GB(t.m7(), 1, 3);
}
 
inline void HaltLift(Tile t)
{
  SB(t.m7(), 0, 4, 0);
}
 
inline uint8_t GetLiftPosition(Tile t)
{
  return GB(t.m6(), 2, 6);
}
 
inline void SetLiftPosition(Tile t, uint8_t pos)
{
  SB(t.m6(), 2, 6, pos);
}
 
inline bool IsHouseCompleted(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  return HasBit(t.m3(), 7);
}
 
inline void SetHouseCompleted(Tile t, bool status)
{
  assert(IsTileType(t, MP_HOUSE));
  SB(t.m3(), 7, 1, !!status);
}
 
inline uint8_t GetHouseBuildingStage(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  return IsHouseCompleted(t) ? (uint8_t)TOWN_HOUSE_COMPLETED : GB(t.m5(), 3, 2);
}
 
inline uint8_t GetHouseConstructionTick(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  return IsHouseCompleted(t) ? 0 : GB(t.m5(), 0, 3);
}
 
inline void IncHouseConstructionTick(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  AB(t.m5(), 0, 5, 1);
 
  if (GB(t.m5(), 3, 2) == TOWN_HOUSE_COMPLETED) {
    /* House is now completed.
     * Store the year of construction as well, for newgrf house purpose */
    SetHouseCompleted(t, true);
  }
}
 
inline void ResetHouseAge(Tile t)
{
  assert(IsTileType(t, MP_HOUSE) && IsHouseCompleted(t));
  t.m5() = 0;
}
 
inline void IncrementHouseAge(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  if (IsHouseCompleted(t) && t.m5() < 0xFF) t.m5()++;
}
 
inline TimerGameCalendar::Year GetHouseAge(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  return TimerGameCalendar::Year{IsHouseCompleted(t) ? t.m5() : 0};
}
 
inline void SetHouseRandomBits(Tile t, uint8_t random)
{
  assert(IsTileType(t, MP_HOUSE));
  t.m1() = random;
}
 
inline uint8_t GetHouseRandomBits(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  return t.m1();
}
 
inline void SetHouseTriggers(Tile t, uint8_t triggers)
{
  assert(IsTileType(t, MP_HOUSE));
  SB(t.m3(), 0, 5, triggers);
}
 
inline uint8_t GetHouseTriggers(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  return GB(t.m3(), 0, 5);
}
 
inline uint8_t GetHouseProcessingTime(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  return GB(t.m6(), 2, 6);
}
 
inline void SetHouseProcessingTime(Tile t, uint8_t time)
{
  assert(IsTileType(t, MP_HOUSE));
  SB(t.m6(), 2, 6, time);
}
 
inline void DecHouseProcessingTime(Tile t)
{
  assert(IsTileType(t, MP_HOUSE));
  t.m6() -= 1 << 2;
}
 
inline void MakeHouseTile(Tile t, TownID tid, uint8_t counter, uint8_t stage, HouseID type, uint8_t random_bits, bool house_protected)
{
  assert(IsTileType(t, MP_CLEAR));
 
  SetTileType(t, MP_HOUSE);
  t.m1() = random_bits;
  t.m2() = tid.base();
  t.m3() = 0;
  SetHouseType(t, type);
  SetHouseCompleted(t, stage == TOWN_HOUSE_COMPLETED);
  t.m5() = IsHouseCompleted(t) ? 0 : (stage << 3 | counter);
  SetHouseProtected(t, house_protected);
  SetAnimationFrame(t, 0);
  SetHouseProcessingTime(t, HouseSpec::Get(type)->processing_time);
}
 
#endif /* TOWN_MAP_H */