Index (houses)

Index of m4nfo functions and constants for houses

• Definition functions
• Property functions
• Performance functions
• Callbacks
• Random functions
• Global functions
• Auxiliary functions
• Miscellaneous functions

• definehouse(<House-ID>, <block>)
• makehouse(<House-ID>,<List::ref()>)

• anim_info(<Byte> [,LOOP])
• anim_speed(<Byte>)
• anim_triggers(<List>)
  • BUILT, PERIODIC, SYNCHRON
• callbacks(<List::Callback>)
  • CB_ACONTROL, CB_AFRAME, CB_ASPEED, CB_ASTAGE, CB_AUTOSLOPE, CB_BUILD, CB_CARGOAMOUNT, CB_CARGOPROD, CB_CARGOTYPES, CB_COLOUR, CB_DESTRUCT, CB_FOUNDATION, CB_PROTECT
• cargotypes(<CargoType>*3)
• cargowatch(<List::CargoType>)
• class(<Byte>)
• climate(<List::Climate>)
  • INACTIVE, TEMPERATE, ARCTIC, TROPIC, TOYLAND
• flags(<List>)
  • CHURCH, FLAT, HASANIMATION, HISTORIC, PROTECTED, RANDOMBITS, STADIUM, SYNCHRON
• goodsaccept([0 .. 8])
• housename(<String>)
• lifespan(<Byte>)
• mailgen(<Byte>)
• mailaccept([0 .. 8])
• overridetype(<House-ID>)
• passaccept([0 .. 8])
• population(<Byte>)
• probability(<Byte>)
• randomcolours(<Byte>*4)
• rating(<Word>)
• refresh(<Byte>)
• removalcost(<Byte>)
• size(1 | 2, 1 | 2)
• substitutetype(<House-ID>, <House-ID> | <House-ID>*2 | <House-ID>*4)
• timeframe(<Date> .. <Date>)
• townzone(<List::TownZone>)
  • TZ_OUTSKIRTS, TZ_PERIPHERY, TZ_RESIDENTIAL, TZ_COMMERCIAL, TZ_CENTRE

• age([<block>)
• anim_frame([<Coordinate>,] <block>)
• buildingclasscount(INTOWN | ONMAP, <block>)
• buildingtypecount(INTOWN | ONMAP, <block>)
• callback(<block>)
• cargohist(<CargoType>, <block>)
• constructionstage(<block>)
• else
• findhouse([0 .. 63], TYPE | CLASS | GRFID, <block>)
• houseinfo_class(<Coordinate>, <block>)
• houseinfo_grfid(<Coordinate>, <block>)
• houseinfo_height(<Coordinate>, <block>)
• houseinfo_id(<Coordinate>, <block>)
• houseinfo_lclass(<Coordinate>, <block>)
  • LC_TERRAIN, LC_RAIL, LC_ROAD, LC_HOUSE, LC_TREES, LC_STATIONTILE, LC_WATER, LC_VOID, LC_INDUSTRYTILE, LC_TUNNELBRIDGE, LC_OBJECT
• houseinfo_slope(<Coordinate>, <block>)
  • EAST, FLAT, NORTH, SOUTH, STEEP, WEST
• houseinfo_terrain(<Coordinate>, <block>)
  • NORMAL, DESERT, RAINFOREST, SNOW
• houseinfo_townzone(<Coordinate>, <block>)
  • TZ_CENTRE, TZ_COMMERCIAL, TZ_RESIDENTIAL, TZ_PERIPHERY, TZ_OUTSKIRTS
• houseinfo_type(<Coordinate>, <block>)
• houseinfo_water(<Coordinate>, <block>)
• houseinfo_waterclass(<Coordinate>, <block>)
• houseinfo_4(<Check>, <Data>, <block>)
• houseinfo_8(<Check>, <Data>, <block>)
• iterations(<block>)
• location(<block>)
• position(<block>)
• randombits(<block>)
• removaltype(<block>)
• testposition(<block>)
• testslope(<block>)
• townexpansion(<block>)
• towninfo_location(<block>)
• towninfo_population(<block>)
• towninfo_buildingcount(<block>)
• towninfo_radius([TZ_CENTRE .. TZ_OUTSKIRTS], <block>)

• CB_ACONTROL
  • A_NOP, A_START, A_STOP
• CB_AFRAME
  • A_NOP, A_STOP
• CB_ASPEED
• CB_ASTAGE
• CB_AUTOSLOPE
• CB_BUILD
• CB_CARGOAMOUNTS
• CB_CARGOPROD
• CB_CARGOTYPES
• CB_COLOUR
• CB_DESTRUCT
• CB_FOUNDATION
• CB_PROTECT
• CB_WATCH

• animcontrol(<Byte>), animframe(<Byte>), customcargo(<CargoType>*3), grftext(<Text-ID>), reftxtcb(<String>)

• nibble(<:Coordinate>)
• pos(<Coordinate>)
• shiftmask(<shift>,<mask>)

• randomrel(<trigger>, <randombit>, <List::ref()>)