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_commons.h"
 
static const byte TOWN_HOUSE_COMPLETED = 3;
 
static const HouseID NUM_HOUSES_PER_GRF = 255;    
 
static const uint HOUSE_NO_CLASS      = 0;
static const HouseID NEW_HOUSE_OFFSET = 110;    
static const HouseID NUM_HOUSES       = 512;    
static const HouseID INVALID_HOUSE_ID = 0xFFFF;
 
static const uint HOUSE_NUM_ACCEPTS = 16; 
 
static const uint HOUSE_CLASS_MAX  = NUM_HOUSES - NEW_HOUSE_OFFSET + 1;
 
enum BuildingFlags {
  TILE_NO_FLAG         =       0,
  TILE_SIZE_1x1        = 1U << 0,
  TILE_NOT_SLOPED      = 1U << 1,
  TILE_SIZE_2x1        = 1U << 2,
  TILE_SIZE_1x2        = 1U << 3,
  TILE_SIZE_2x2        = 1U << 4,
  BUILDING_IS_ANIMATED = 1U << 5,
  BUILDING_IS_CHURCH   = 1U << 6,
  BUILDING_IS_STADIUM  = 1U << 7,
  BUILDING_HAS_1_TILE  = TILE_SIZE_1x1 | TILE_SIZE_2x1 | TILE_SIZE_1x2 | TILE_SIZE_2x2,
  BUILDING_HAS_2_TILES = TILE_SIZE_2x1 | TILE_SIZE_1x2 | TILE_SIZE_2x2,
  BUILDING_2_TILES_X   = TILE_SIZE_2x1 | TILE_SIZE_2x2,
  BUILDING_2_TILES_Y   = TILE_SIZE_1x2 | TILE_SIZE_2x2,
  BUILDING_HAS_4_TILES = TILE_SIZE_2x2,
};
DECLARE_ENUM_AS_BIT_SET(BuildingFlags)
 
enum HouseZonesBits {
  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_POSTFIX_INCREMENT(HouseZonesBits)
 
enum HouseZones {                  
  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 HouseExtraFlags {
  NO_EXTRA_FLAG            =       0,
  BUILDING_IS_HISTORICAL   = 1U << 0,  
  BUILDING_IS_PROTECTED    = 1U << 1,  
  SYNCHRONISED_CALLBACK_1B = 1U << 2,  
  CALLBACK_1A_RANDOM_BITS  = 1U << 3,  
};
 
DECLARE_ENUM_AS_BIT_SET(HouseExtraFlags)
 
struct HouseSpec {
  /* Standard properties */
  TimerGameCalendar::Year min_year;         
  TimerGameCalendar::Year max_year;         
  byte population;                          
  byte removal_cost;                        
  StringID building_name;                   
  uint16_t remove_rating_decrease;            
  byte mail_generation;                     
  byte cargo_acceptance[HOUSE_NUM_ACCEPTS]; 
  CargoID accepts_cargo[HOUSE_NUM_ACCEPTS]; 
  CargoLabel accepts_cargo_label[HOUSE_NUM_ACCEPTS]; 
  BuildingFlags building_flags;             
  HouseZones building_availability;         
  bool enabled;                             
 
  /* NewHouses properties */
  GRFFileProps grf_prop;                    
  uint16_t callback_mask;                     
  Colours random_colour[4];                 
  byte probability;                         
  HouseExtraFlags extra_flags;              
  HouseClassID class_id;                    
  AnimationInfo animation;                  
  byte processing_time;                     
  byte minimum_life;                        
  CargoTypes watched_cargoes;               
 
  Money GetRemovalCost() const;
 
  static inline HouseSpec *Get(size_t house_id)
  {
    assert(house_id < NUM_HOUSES);
    extern HouseSpec _house_specs[];
    return &_house_specs[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;
}
 
#endif /* HOUSE_H */