NML:Houses - Revision history

Rito12: /* House variables */

2026-01-04T14:44:04Z

House variables

← Older revision		Revision as of 14:44, 4 January 2026
Line 344:		Line 344:
	\| -1, 0 or a GRFID		\| -1, 0 or a GRFID
	\| Return value is -1 if the tile is not a house tile, 0 if the house tile contains an old house type, or else the GRFID of the NewGRF defining the house.		\| Return value is -1 if the tile is not a house tile, 0 if the house tile contains an old house type, or else the GRFID of the NewGRF defining the house.
			\|-
			\| has_badge
			\| Label from the [[NML:Badgetable\|badgetable]].
			\| [0 <nowiki>\|</nowiki> 1]
			\| {{ottd\|15.0}} Check if the house has that specific badge attached.
	\|}		\|}
	<references/>		<references/>

Rito12: /* House properties */ badges property

2026-01-03T21:27:20Z

House properties: badges property

← Older revision		Revision as of 21:27, 3 January 2026
Line 135:		Line 135:
	\| array of values from your [[NML:Cargotable\|cargo table]]		\| array of values from your [[NML:Cargotable\|cargo table]]
	\| {{ottdp\|1.2\|2.6\|ottdrev=r23072\|ttdprev=r1677}}List of cargo types to watch, to be used with the <code style:darkgreen>watched_cargo_accepted</code> callback.		\| {{ottdp\|1.2\|2.6\|ottdrev=r23072\|ttdprev=r1677}}List of cargo types to watch, to be used with the <code style:darkgreen>watched_cargo_accepted</code> callback.
			\|-
			\| badges
			\| Array of badge labels from the [[NML:Badgetable\|badgetable]].
			\| Since {{ottd\|15.0}}
	\|}		\|}

Peter1138: /* House IDs */

2024-12-23T09:23:54Z

House IDs

← Older revision		Revision as of 09:23, 23 December 2024
Line 2:		Line 2:
	==House IDs==		==House IDs==
	House IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range. You should start your item definition with the 'substitute'-property, which allocates a new house. The value of this property should be the ID of a [[NML:List_of_default_house_properties\|default house type]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).		House IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range. You should start your item definition with the 'substitute'-property, which allocates a new house. The value of this property should be the ID of a [[NML:List_of_default_house_properties\|default house type]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).

			{{ottdp\|15}} Since OpenTTD 15 the allowed ID range is increased to 0..4095.

	Although the majority of all original houses occupy a single tile, it is possible to define a larger house of up to 2x2 tiles. For this, you should set the fourth 'size' parameter in the item-block. Valid values are HOUSE_SIZE_XXX, XXX = <nowiki>[1X1 \| 1X2 \| 2X1 \| 2X2]</nowiki>. This size should match the size of the substitute house type.		Although the majority of all original houses occupy a single tile, it is possible to define a larger house of up to 2x2 tiles. For this, you should set the fourth 'size' parameter in the item-block. Valid values are HOUSE_SIZE_XXX, XXX = <nowiki>[1X1 \| 1X2 \| 2X1 \| 2X2]</nowiki>. This size should match the size of the substitute house type.

Peter1138: /* House callbacks */

2024-08-02T13:18:44Z

House callbacks

← Older revision		Revision as of 13:18, 2 August 2024
Line 366:		Line 366:
	\| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played.		\| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played.
	* <code>extra_callback_info1</code>: 32 random bits, if enabled in the <code>building_flags</code> property.		* <code>extra_callback_info1</code>: 32 random bits, if enabled in the <code>building_flags</code> property.
			Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
	\|-		\|-
	\| anim_control		\| anim_control
Line 371:		Line 372:
	\| Called every 256 ticks. Return the animation frame to show, or CB_RESULT_XXX with XXX = <nowiki>[CB_RESULT_START_ANIMATION \| STOP_ANIMATION \| DO_NOTHING]</nowiki> to respectively start the animation in its current frame, stop the animation or do nothing. Returning a sound effect in the high byte will cause that sound effect to be played.		\| Called every 256 ticks. Return the animation frame to show, or CB_RESULT_XXX with XXX = <nowiki>[CB_RESULT_START_ANIMATION \| STOP_ANIMATION \| DO_NOTHING]</nowiki> to respectively start the animation in its current frame, stop the animation or do nothing. Returning a sound effect in the high byte will cause that sound effect to be played.
	* <code>extra_callback_info1</code>: 32 random bits. The low 16 bits are always different for each house tile, but the high 16 bits are the same for each tile if synchronized animation is enabled in the <code>building_flags</code>-property.		* <code>extra_callback_info1</code>: 32 random bits. The low 16 bits are always different for each house tile, but the high 16 bits are the same for each tile if synchronized animation is enabled in the <code>building_flags</code>-property.
			Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
	\|-		\|-
	\| construction_anim		\| construction_anim

Heresy: Changed from table to sortable.

2022-08-30T21:40:47Z

Changed from table to sortable.

← Older revision		Revision as of 21:40, 30 August 2022
Line 18:		Line 18:
	==House properties==		==House properties==

	{\| class="t"		{\| class="wikitable sortable"
	! property		! property
	! value range		! value range
Line 137:		Line 137:
	==House variables==		==House variables==

	{\| class="t"		{\| class="wikitable sortable"
	! name		! name
	! value range		! value range
Line 222:		Line 222:

	The following variables require one or more arguments		The following variables require one or more arguments
	{\| class="t"		{\| class="wikitable sortable"
	! name		! name
	! arguments		! arguments
Line 344:		Line 344:
	Unless noted otherwise, callbacks may be called for any of the tiles of a multi-tile house.		Unless noted otherwise, callbacks may be called for any of the tiles of a multi-tile house.

	{\| class="t"		{\| class="wikitable sortable"
	! callback		! callback
	! return value		! return value

Jfs: /* House properties */ Expand on population and mail_multiplier properties

2022-04-10T15:47:07Z

House properties: Expand on population and mail_multiplier properties

← Older revision		Revision as of 15:47, 10 April 2022
Line 57:		Line 57:
	\| population		\| population
	\| 0 ... 255		\| 0 ... 255
	\| ~~number~~ of inhabitants the building adds to the town, if present		\| Number of inhabitants the building adds to the town, if present. This also affects how many passengers the house generates, unless the <code>cargo_production</code> callback is used.
	\|-		\|-
	\| mail_multiplier		\| mail_multiplier
	\| 0 ... 255		\| 0 ... 255
			\| Affects how much mail the building generates. Not used if the <code>cargo_production</code> callback is used.
	\|
	\|-		\|-
	\| accepted_cargos		\| accepted_cargos

2talltyler: Change: x and y coordinates match maximum map size, now 4096*4096.

2021-05-27T18:49:19Z

Change: x and y coordinates match maximum map size, now 4096*4096.

← Older revision		Revision as of 18:49, 27 May 2021
Line 191:		Line 191:
	\|-		\|-
	\| x_coordinate		\| x_coordinate
	\| 0..~~2047~~		\| 0..4095
	\| X-coordinate (top right -> bottom left) of the tile on the map		\| X-coordinate (top right -> bottom left) of the tile on the map
	\|-		\|-
	\| y_coordinate		\| y_coordinate
	\| 0..~~2047~~		\| 0..4095
	\| Y-coordinate (top left -> bottom right) of the tile on the map		\| Y-coordinate (top left -> bottom right) of the tile on the map
	\|-		\|-

Andythenorth: /* House properties */ extend accepted_cargos to 16 with nml 0.5 / OpenTTD 1.9

2020-02-18T21:42:10Z

House properties: extend accepted_cargos to 16 with nml 0.5 / OpenTTD 1.9

← Older revision		Revision as of 21:42, 18 February 2020
Line 64:		Line 64:
	\|-		\|-
	\| accepted_cargos		\| accepted_cargos
	\| Array with up to 3 [cargo_id, amount]-pairs.		\| Array with up to 3 [cargo_id, amount]-pairs.
			{{nml\|0.5}}{{ottdp\|1.9\|no}} Array with up to 16 [cargo_id, amount]-pairs.
	\| The cargos that are accepted by each tile of the house. CargoID is a cargo type from your cargo translation table, amount is the acceptance of the given cargo in 1/8 units.<br /> Example: to make a tile fully accept both PASS and MAIL you could use this: <code style="color:darkgreen"><nowiki>accepted_cargos: [[PASS, 8], [MAIL, 8]];</nowiki></code><br /> Example: for a house tile that doesn't accept any cargos at all you'd use: <code style="color:darkgreen">accepted_cargos: [];</code>		\| The cargos that are accepted by each tile of the house. CargoID is a cargo type from your cargo translation table, amount is the acceptance of the given cargo in 1/8 units.<br /> Example: to make a tile fully accept both PASS and MAIL you could use this: <code style="color:darkgreen"><nowiki>accepted_cargos: [[PASS, 8], [MAIL, 8]];</nowiki></code><br /> Example: for a house tile that doesn't accept any cargos at all you'd use: <code style="color:darkgreen">accepted_cargos: [];</code>
	\|-		\|-

Andythenorth: Undo revision 3996 by Andythenorth (talk)

2020-02-18T21:40:25Z

Undo revision 3996 by Andythenorth (talk)

← Older revision		Revision as of 21:40, 18 February 2020
Line 64:		Line 64:
	\|-		\|-
	\| accepted_cargos		\| accepted_cargos
	\| Array with up to 3 ~~[cargo_id, amount]-pairs. {{nml\|0.5}}{{ottdp\|1.9\|no}} Array with up to 16~~ [cargo_id, amount]-pairs.		\| Array with up to 3 [cargo_id, amount]-pairs.
	\| The cargos that are accepted by each tile of the house. CargoID is a cargo type from your cargo translation table, amount is the acceptance of the given cargo in 1/8 units.<br /> Example: to make a tile fully accept both PASS and MAIL you could use this: <code style="color:darkgreen"><nowiki>accepted_cargos: [[PASS, 8], [MAIL, 8]];</nowiki></code><br /> Example: for a house tile that doesn't accept any cargos at all you'd use: <code style="color:darkgreen">accepted_cargos: [];</code>		\| The cargos that are accepted by each tile of the house. CargoID is a cargo type from your cargo translation table, amount is the acceptance of the given cargo in 1/8 units.<br /> Example: to make a tile fully accept both PASS and MAIL you could use this: <code style="color:darkgreen"><nowiki>accepted_cargos: [[PASS, 8], [MAIL, 8]];</nowiki></code><br /> Example: for a house tile that doesn't accept any cargos at all you'd use: <code style="color:darkgreen">accepted_cargos: [];</code>
	\|-		\|-

Andythenorth: /* House properties */ update accepted_cargos for nml 0.5

2020-02-18T21:39:50Z

House properties: update accepted_cargos for nml 0.5

← Older revision		Revision as of 21:39, 18 February 2020
Line 64:		Line 64:
	\|-		\|-
	\| accepted_cargos		\| accepted_cargos
	\| Array with up to 3 [cargo_id, amount]-pairs.		\| Array with up to 3 [cargo_id, amount]-pairs. {{nml\|0.5}}{{ottdp\|1.9\|no}} Array with up to 16 [cargo_id, amount]-pairs.
	\| The cargos that are accepted by each tile of the house. CargoID is a cargo type from your cargo translation table, amount is the acceptance of the given cargo in 1/8 units.<br /> Example: to make a tile fully accept both PASS and MAIL you could use this: <code style="color:darkgreen"><nowiki>accepted_cargos: [[PASS, 8], [MAIL, 8]];</nowiki></code><br /> Example: for a house tile that doesn't accept any cargos at all you'd use: <code style="color:darkgreen">accepted_cargos: [];</code>		\| The cargos that are accepted by each tile of the house. CargoID is a cargo type from your cargo translation table, amount is the acceptance of the given cargo in 1/8 units.<br /> Example: to make a tile fully accept both PASS and MAIL you could use this: <code style="color:darkgreen"><nowiki>accepted_cargos: [[PASS, 8], [MAIL, 8]];</nowiki></code><br /> Example: for a house tile that doesn't accept any cargos at all you'd use: <code style="color:darkgreen">accepted_cargos: [];</code>
	\|-		\|-