house.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 HOUSE_H
#define HOUSE_H
 
#include "cargo_type.h"
#include "timer/timer_game_calendar.h"
#include "house_type.h"
#include "newgrf_animation_type.h"
#include "newgrf_badge_type.h"
#include "newgrf_callbacks.h"
#include "newgrf_commons.h"
 
static const uint8_t TOWN_HOUSE_COMPLETED = 3;
 
static const uint HOUSE_NO_CLASS      = 0;
static const HouseID NEW_HOUSE_OFFSET = 110; 
static const HouseID NUM_HOUSES       = 4096; 
static const HouseID INVALID_HOUSE_ID = UINT16_MAX;
 
static const HouseID NUM_HOUSES_PER_GRF = NUM_HOUSES; 
 
static const uint HOUSE_NUM_ACCEPTS = 16; 
static const uint HOUSE_ORIGINAL_NUM_ACCEPTS = 3; 
 
enum class BuildingFlag : uint8_t {
  Size1x1    = 0,
  NotSloped  = 1,
  Size2x1    = 2,
  Size1x2    = 3,
  Size2x2    = 4,
  IsAnimated = 5,
  IsChurch   = 6,
  IsStadium  = 7,
};
using BuildingFlags = EnumBitSet<BuildingFlag, uint8_t>;
 
static constexpr BuildingFlags BUILDING_HAS_1_TILE  = {BuildingFlag::Size1x1, BuildingFlag::Size2x1, BuildingFlag::Size1x2, BuildingFlag::Size2x2};
static constexpr BuildingFlags BUILDING_HAS_2_TILES = {BuildingFlag::Size2x1, BuildingFlag::Size1x2, BuildingFlag::Size2x2};
static constexpr BuildingFlags BUILDING_2_TILES_X   = {BuildingFlag::Size2x1, BuildingFlag::Size2x2};
static constexpr BuildingFlags BUILDING_2_TILES_Y   = {BuildingFlag::Size1x2, BuildingFlag::Size2x2};
static constexpr BuildingFlags BUILDING_HAS_4_TILES = {BuildingFlag::Size2x2};
 
enum HouseZonesBits : uint8_t {
  HZB_BEGIN     = 0,
  HZB_TOWN_EDGE = 0,
  HZB_TOWN_OUTSKIRT,
  HZB_TOWN_OUTER_SUBURB,
  HZB_TOWN_INNER_SUBURB,
  HZB_TOWN_CENTRE,
  HZB_END,
};
static_assert(HZB_END == 5);
 
DECLARE_INCREMENT_DECREMENT_OPERATORS(HouseZonesBits)
 
enum HouseZones : uint16_t {
  HZ_NOZNS             = 0x0000,  
  HZ_ZON1              = 1U << HZB_TOWN_EDGE,    
  HZ_ZON2              = 1U << HZB_TOWN_OUTSKIRT,
  HZ_ZON3              = 1U << HZB_TOWN_OUTER_SUBURB,
  HZ_ZON4              = 1U << HZB_TOWN_INNER_SUBURB,
  HZ_ZON5              = 1U << HZB_TOWN_CENTRE,  
  HZ_ZONALL            = 0x001F,  
  HZ_SUBARTC_ABOVE     = 0x0800,  
  HZ_TEMP              = 0x1000,  
  HZ_SUBARTC_BELOW     = 0x2000,  
  HZ_SUBTROPIC         = 0x4000,  
  HZ_TOYLND            = 0x8000,  
  HZ_CLIMALL           = 0xF800,  
};
DECLARE_ENUM_AS_BIT_SET(HouseZones)
 
enum class HouseExtraFlag : uint8_t {
  BuildingIsHistorical   = 0, 
  BuildingIsProtected    = 1, 
  SynchronisedCallback1B = 2, 
  Callback1ARandomBits   = 3, 
};
using HouseExtraFlags = EnumBitSet<HouseExtraFlag, uint8_t>;
 
struct HouseSpec {
  /* Standard properties */
  TimerGameCalendar::Year min_year;         
  TimerGameCalendar::Year max_year;         
  uint8_t population;                          
  uint8_t removal_cost;                        
  StringID building_name;                   
  uint16_t remove_rating_decrease;            
  uint8_t mail_generation;                     
  uint8_t cargo_acceptance[HOUSE_NUM_ACCEPTS]; 
  CargoType accepts_cargo[HOUSE_NUM_ACCEPTS]; 
  BuildingFlags building_flags;             
  HouseZones building_availability;         
  bool enabled;                             
 
  /* NewHouses properties */
  GRFFileProps grf_prop;                    
  HouseCallbackMasks callback_mask;                     
  Colours random_colour[4];                 
  uint8_t probability;                         
  HouseExtraFlags extra_flags{};              
  HouseClassID class_id;                    
  AnimationInfo animation;                  
  uint8_t processing_time;                     
  uint8_t minimum_life;                        
  CargoTypes watched_cargoes;               
  std::vector<BadgeID> badges;
 
  CargoLabel accepts_cargo_label[HOUSE_ORIGINAL_NUM_ACCEPTS]; 
 
  HouseID Index() const;
  Money GetRemovalCost() const;
 
  static std::vector<HouseSpec> &Specs();
  static HouseSpec *Get(size_t house_id);
};
 
inline HouseID GetTranslatedHouseID(HouseID hid)
{
  const HouseSpec *hs = HouseSpec::Get(hid);
  return hs->grf_prop.override == INVALID_HOUSE_ID ? hid : hs->grf_prop.override;
}
 
void ShowBuildHousePicker(struct Window *);
 
#endif /* HOUSE_H */