HouseSpec Struct Reference

Public Member Functions

Money GetRemovalCost () const
 Get the cost for removing this house.

Static Public Member Functions

static FORCEINLINE HouseSpec * Get (size_t house_id)

Data Fields

Year min_year
 introduction year of the house
Year max_year
 last year it can be built
byte population
 population (Zero on other tiles in multi tile house.)
byte removal_cost
 cost multiplier for removing it
StringID building_name
 building name
uint16 remove_rating_decrease
 rating decrease if removed
byte mail_generation
 mail generation multiplier (tile based, as the acceptances below)
byte cargo_acceptance [3]
 acceptance level for the cargo slots
CargoID accepts_cargo [3]
 3 input cargo slots
BuildingFlags building_flags
 some flags that describe the house (size, stadium etc...)
HouseZones building_availability
 where can it be built (climates, zones)
bool enabled
 the house is available to build (true by default, but can be disabled by newgrf)
HouseID substitute_id
 which original house this one is based on
struct SpriteGroup * spritegroup
 pointer to the different sprites of the house
HouseID override
 which house this one replaces
uint16 callback_mask
 Bitmask of house callbacks that have to be called.
byte random_colour [4]
 4 "random" colours
byte probability
 Relative probability of appearing (16 is the standard value).
HouseExtraFlags extra_flags
 some more flags
HouseClassID class_id
 defines the class this house has (not grf file based)
byte animation_frames
 number of animation frames
byte animation_speed
 amount of time between each of those frames
byte processing_time
 Periodic refresh multiplier.
byte minimum_life
 The minimum number of years this house will survive before the town rebuilds it.
uint8 local_id
 id defined by the grf file for this house
struct GRFFile * grffile
 grf file that introduced this house

Detailed Description

Definition at line 93 of file house.h.


Member Function Documentation

Money HouseSpec::GetRemovalCost (  )  const

Get the cost for removing this house.

Returns:
the cost (inflation corrected etc)

Definition at line 161 of file town_cmd.cpp.

References removal_cost.


The documentation for this struct was generated from the following files:

Generated on Tue Sep 14 17:07:34 2010 for OpenTTD by  doxygen 1.6.1