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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#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 class HouseZone : uint8_t {
  TownEdge = 0, 
  TownOutskirt = 1, 
  TownOuterSuburb = 2, 
  TownInnerSuburb = 3, 
  TownCentre = 4, 
  TownEnd,
 
  ClimateSubarcticAboveSnow = 11, 
  ClimateTemperate = 12, 
  ClimateSubarcticBelowSnow = 13, 
  ClimateSubtropic = 14, 
  ClimateToyland = 15, 
};
using HouseZones = EnumBitSet<HouseZone, uint16_t>;
 
static constexpr uint NUM_HOUSE_ZONES = to_underlying(HouseZone::TownEnd);
static_assert(NUM_HOUSE_ZONES == 5);
 
static constexpr HouseZones HZ_ZONE_ALL = {
  HouseZone::TownEdge,
  HouseZone::TownOutskirt,
  HouseZone::TownOuterSuburb,
  HouseZone::TownInnerSuburb,
  HouseZone::TownCentre,
};
 
static constexpr HouseZones HZ_CLIMATE_ALL = {
  HouseZone::ClimateSubarcticAboveSnow,
  HouseZone::ClimateTemperate,
  HouseZone::ClimateSubarcticBelowSnow,
  HouseZone::ClimateSubtropic,
  HouseZone::ClimateToyland,
};
 
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 */
  SubstituteGRFFileProps grf_prop; 
  HouseCallbackMasks callback_mask;                     
  Colours random_colour[4];                 
  uint8_t probability;                         
  HouseExtraFlags extra_flags{};              
  HouseClassID class_id;                    
  AnimationInfo<void> 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_id == INVALID_HOUSE_ID ? hid : hs->grf_prop.override_id;
}
 
void ShowBuildHousePicker(struct Window *);
HouseZones GetClimateMaskForLandscape();
 
#endif /* HOUSE_H */