NML:IndustryTiles - Revision history

Andythenorth at 14:35, 15 August 2026

2026-08-15T14:35:00Z

← Older revision		Revision as of 14:35, 15 August 2026
Line 5:		Line 5:
	== Industry tile ID allocation ==		== Industry tile ID allocation ==
	Industry tile IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range.		Industry tile IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range.
	{{ottdp\|16}}OpenTTD 16 increased the tile range, choose any ID in the 0..511-range..		{{ottdp\|16}} OpenTTD 16 increased the tile range, choose any ID in the 0..511-range..

	You should start your item definition with the 'substitute'-property, which allocates a new industry tile. The value of this property should be the ID of a [[IndustryTileDefaultProps\|default industry tile]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).		You should start your item definition with the 'substitute'-property, which allocates a new industry tile. The value of this property should be the ID of a [[IndustryTileDefaultProps\|default industry tile]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).

Andythenorth at 14:34, 15 August 2026

2026-08-15T14:34:52Z

← Older revision		Revision as of 14:34, 15 August 2026
Line 4:		Line 4:

	== Industry tile ID allocation ==		== Industry tile ID allocation ==
	Industry tile IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range. {{ottdp\|16}}The tile range increased 0..511. You should start your item definition with the 'substitute'-property, which allocates a new industry tile. The value of this property should be the ID of a [[IndustryTileDefaultProps\|default industry tile]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).		Industry tile IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range.
			{{ottdp\|16}}OpenTTD 16 increased the tile range, choose any ID in the 0..511-range..

			You should start your item definition with the 'substitute'-property, which allocates a new industry tile. The value of this property should be the ID of a [[IndustryTileDefaultProps\|default industry tile]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).

	Furthermore, you can set the 'override'-property, which will cause the existing industry tile to be replaced with your item. You should use this if you are for example defining a coal mine which changes production more dynamically. If your type is not a direct replacement of an existing item, don't set this property.		Furthermore, you can set the 'override'-property, which will cause the existing industry tile to be replaced with your item. You should use this if you are for example defining a coal mine which changes production more dynamically. If your type is not a direct replacement of an existing item, don't set this property.

Andythenorth at 14:32, 15 August 2026

2026-08-15T14:32:57Z

← Older revision		Revision as of 14:32, 15 August 2026
Line 4:		Line 4:

	== Industry tile ID allocation ==		== Industry tile ID allocation ==
	Industry tile 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 industry tile. The value of this property should be the ID of a [[IndustryTileDefaultProps\|default industry tile]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).		Industry tile IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range. {{ottdp\|16}}The tile range increased 0..511. You should start your item definition with the 'substitute'-property, which allocates a new industry tile. The value of this property should be the ID of a [[IndustryTileDefaultProps\|default industry tile]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).

	Furthermore, you can set the 'override'-property, which will cause the existing industry tile to be replaced with your item. You should use this if you are for example defining a coal mine which changes production more dynamically. If your type is not a direct replacement of an existing item, don't set this property.		Furthermore, you can set the 'override'-property, which will cause the existing industry tile to be replaced with your item. You should use this if you are for example defining a coal mine which changes production more dynamically. If your type is not a direct replacement of an existing item, don't set this property.

Rito12: /* Industry tile callbacks */ var 18 bit 8

2026-06-05T10:45:30Z

Industry tile callbacks: var 18 bit 8

← Older revision		Revision as of 10:45, 5 June 2026
Line 187:		Line 187:
	* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if enabled in the <code style="color:darkgreen">special_flags</code> property.		* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if enabled in the <code style="color:darkgreen">special_flags</code> property.
	* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\|table]] below. Note that you need to enable the wanted triggers in the <code style="color:darkgreen">animation_triggers</code> property.		* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\|table]] below. Note that you need to enable the wanted triggers in the <code style="color:darkgreen">animation_triggers</code> property.
			*<code>getbits(extra_callback_info2, 8, 1)</code>: Whether triggered when placing new industries.
	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.		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.
	\|-		\|-

Rito12: /* Animation triggers */ ottd #14089

2026-06-05T10:33:34Z

Animation triggers: ottd #14089

← Older revision		Revision as of 10:33, 5 June 2026
Line 229:		Line 229:
	\| ANIM_TRIGGER_INDTILE_CONSTRUCTION_STATE		\| ANIM_TRIGGER_INDTILE_CONSTRUCTION_STATE
	\| the construction state changes		\| the construction state changes
			Since {{ottd\|15.0}} also triggered when placing new industries.
	\|-		\|-
	\| ANIM_TRIGGER_INDTILE_TILE_LOOP		\| ANIM_TRIGGER_INDTILE_TILE_LOOP

Rito12: /* Industry tile variables */ rail type -> industry tile

2026-01-04T14:39:05Z

Industry tile variables: rail type -> industry tile

← Older revision		Revision as of 14:39, 4 January 2026
Line 155:		Line 155:
	\| Label from the [[NML:Badgetable\|badgetable]].		\| Label from the [[NML:Badgetable\|badgetable]].
	\| [0 <nowiki>\|</nowiki> 1]		\| [0 <nowiki>\|</nowiki> 1]
	\| {{ottd\|15.0}} Check if the ~~rail~~ ~~type~~ has that specific badge attached.		\| {{ottd\|15.0}} Check if the industry tile has that specific badge attached.
	\|}		\|}

Rito12: /* Industry tile variables */

2026-01-04T14:38:28Z

Industry tile variables

← Older revision		Revision as of 14:38, 4 January 2026
Line 141:		Line 141:
	Industry tiles have access to the [[#Common variables\|common variables]] described above. Additionally, they have access to the following:		Industry tiles have access to the [[#Common variables\|common variables]] described above. Additionally, they have access to the following:

	{\| class="t"		{\| class="wikitable sortable"
	! name		! name
	! arguments		! arguments
			! value range
	! comment		! comment
	\|-		\|-
	\| nearby_tile_is_same_industry		\| nearby_tile_is_same_industry
	\| x, y		\| x, y
			\| [0 <nowiki>\|</nowiki> 1]
	\| Parameters indicate a signed tile offset relative to the current tile. Returns 1 if the tile is part of the same industry, 0 otherwise		\| Parameters indicate a signed tile offset relative to the current tile. Returns 1 if the tile is part of the same industry, 0 otherwise
			\|-
			\| has_badge
			\| Label from the [[NML:Badgetable\|badgetable]].
			\| [0 <nowiki>\|</nowiki> 1]
			\| {{ottd\|15.0}} Check if the rail type has that specific badge attached.
	\|}		\|}

Rito12: /* Industry tile properties */ Move badges property

2026-01-03T21:28:44Z

Industry tile properties: Move badges property

← Older revision		Revision as of 21:28, 3 January 2026
Line 66:		Line 66:
	* This property adds 8/8 acceptance for the matching cargotypes. You can list negative acceptances (-8/8) in property 13 to exclude specific cargos.		* This property adds 8/8 acceptance for the matching cargotypes. You can list negative acceptances (-8/8) in property 13 to exclude specific cargos.
	* Tile callback cargo_type_accept overrides all acceptances including those added by this flag.		* Tile callback cargo_type_accept overrides all acceptances including those added by this flag.
		⚫	\|-
		⚫	\| badges
		⚫	\| Array of badge labels from the [[NML:Badgetable\|badgetable]].
		⚫	\| Since {{ottd\|15.0}}
	\|}		\|}

Line 91:		Line 95:
	\| LSF_ALLOW_ON_WATER		\| LSF_ALLOW_ON_WATER
	\| The land/water check is disabled for this tile so it can be built on water. If you need more control over this use callback "tile_check".		\| The land/water check is disabled for this tile so it can be built on water. If you need more control over this use callback "tile_check".
⚫	\|-
⚫	\| badges
⚫	\| Array of badge labels from the [[NML:Badgetable\|badgetable]].
⚫	\| Since {{ottd\|15.0}}
	\|}		\|}

Rito12: /* Industry tile properties */ badges property

2026-01-03T21:28:05Z

Industry tile properties: badges property

← Older revision		Revision as of 21:28, 3 January 2026
Line 91:		Line 91:
	\| LSF_ALLOW_ON_WATER		\| LSF_ALLOW_ON_WATER
	\| The land/water check is disabled for this tile so it can be built on water. If you need more control over this use callback "tile_check".		\| The land/water check is disabled for this tile so it can be built on water. If you need more control over this use callback "tile_check".
			\|-
			\| badges
			\| Array of badge labels from the [[NML:Badgetable\|badgetable]].
			\| Since {{ottd\|15.0}}
	\|}		\|}

Peter1138: /* Industry tile callbacks */

2024-08-02T13:18:20Z

Industry tile callbacks

← Older revision		Revision as of 13:18, 2 August 2024
Line 168:		Line 168:
	* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if enabled in the <code style="color:darkgreen">special_flags</code> property.		* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if enabled in the <code style="color:darkgreen">special_flags</code> property.
	Returning a sound effect in the high byte will cause that sound effect to be played.		Returning a sound effect in the high byte will cause that sound effect to be played.
			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 175:		Line 176:
	* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if enabled in the <code style="color:darkgreen">special_flags</code> property.		* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if enabled in the <code style="color:darkgreen">special_flags</code> property.
	* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\|table]] below. Note that you need to enable the wanted triggers in the <code style="color:darkgreen">animation_triggers</code> property.		* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\|table]] below. Note that you need to enable the wanted triggers in the <code style="color:darkgreen">animation_triggers</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_speed		\| anim_speed