GRFSpecs - Recent changes [en-gb]

NML:Roadstops

Rito12 — Tue, 09 Jun 2026 21:20:06 GMT

Road stop properties: Fix some value ranges.

← Older revision		Revision as of 21:20, 9 June 2026
Line 48:		Line 48:
	\|-		\|-
	\| cargo_random_triggers		\| cargo_random_triggers
			\| cargo bitmask
	\| Array of cargo labels from the [[NML:Cargotable\|cargotable]]
	\| Cargo types, which will [[NML:Random_switch#Stations\|trigger re-randomization]] when delivered, loaded or unloaded at the station.		\| Cargo types, which will [[NML:Random_switch#Stations\|trigger re-randomization]] when delivered, loaded or unloaded at the station.
	\|-		\|-
Line 61:		Line 61:
	\|-		\|-
	\| animation_triggers		\| animation_triggers
			\| bitmask(ANIM_TRIGGER_ROAD_STOP_XXX, ...)
	\|
	\|		\|
	See [[#Animation_triggers\|list of animation triggers]]		See [[#Animation_triggers\|list of animation triggers]]

NML:Animation speed

Rito12 — Tue, 09 Jun 2026 20:25:01 GMT

Fix: 'as' and 'length' used twice in single sentence.

← Older revision		Revision as of 20:25, 9 June 2026
Line 1:		Line 1:
	{{NMLNavAdditionalreferences}}		{{NMLNavAdditionalreferences}}

	House, industry and airport tiles can define an animation speed. This property gives the animation speed in ticks, spaced by powers of two. For houses the minimum value is 2 (=4 ticks). ~~The~~ ingame ~~length as well~~ real ~~length~~ is given as rounded values for reference only, assuming normal game speed.		House, industry and airport tiles can define an animation speed. This property gives the animation speed in ticks, spaced by powers of two. For houses the minimum value is 2 (=4 ticks). Both the ingame and real lengths are given as rounded values for reference only, assuming normal game speed.

	{\| class="t"		{\| class="t"

NML:Roadstops

Rito12 — Tue, 09 Jun 2026 15:44:16 GMT

Road stop callbacks: CB_RESULT_CB_RESULT_START_ANIMATION is wrong.

← Older revision		Revision as of 15:44, 9 June 2026
Line 532:		Line 532:
	\| Next animation frame or CB_RESULT_XXX		\| Next animation frame or CB_RESULT_XXX
	\|		\|
	Called whenever an object animation trigger happens. Return the animation frame to show, or CB_RESULT_XXX with XXX = [~~CB_RESULT_START_ANIMATION~~ <nowiki>\|</nowiki> STOP_ANIMATION <nowiki>\|</nowiki> DO_NOTHING] 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 whenever an object animation trigger happens. Return the animation frame to show, or CB_RESULT_XXX with XXX = [START_ANIMATION <nowiki>\|</nowiki> STOP_ANIMATION <nowiki>\|</nowiki> DO_NOTHING] 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 style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.		* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.
	* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\| table]] below.		* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\| table]] below.

NML:Parameter assignment

Rito12 — Mon, 08 Jun 2026 09:14:23 GMT

Named parameters and constants.

@@ Line 1: / Line 1: @@
 {{NMLNavBlocksyntax}}
  param[&lt;expression&gt;] = &lt;expression&gt;;
@@ Line 8: / Line 10: @@
  param[param[2] + 1] = param[3] * param[4];
 </pre>

NML:Stations

Rito12 — Mon, 08 Jun 2026 07:22:04 GMT

Variables without a parameter: It is station not vehicle.

← Older revision		Revision as of 07:22, 8 June 2026
Line 288:		Line 288:
	\| company_num		\| company_num
	\| 0 ... 14		\| 0 ... 14
	\| ~~company~~ number of the ~~vehicle~~ owner. TTDPatch only supports up to 8 companies (0 ... 7)		\| Company number of the station owner. TTDPatch only supports up to 8 companies (0 ... 7)
	\|-		\|-
	\| company_type		\| company_type

NML:Roadstops

Rito12 — Mon, 08 Jun 2026 07:21:06 GMT

Variables without a parameter: TTDP does not support roadstops at all, and probably will never do.

← Older revision		Revision as of 07:21, 8 June 2026
(2 intermediate revisions by the same user not shown)
Line 317:		Line 317:
	\| company_num		\| company_num
	\| 0 ... 14		\| 0 ... 14
	\| ~~company~~ number of the ~~vehicle~~ owner. ~~TTDPatch only supports up to 8 companies (0 ... 7)~~		\| Company number of the roadstop owner.
	\|-		\|-
	\| company_type		\| company_type
Line 408:		Line 408:
	\| x, y offset (-8..7)		\| x, y offset (-8..7)
	\|		\|
	\| Is nearby_tile_same_grf is true, ID of a road stop on a nearby tile		\| If nearby_tile_same_grf is true, ID of a road stop on a nearby tile
	\|-		\|-
	\| nearby_tile_same_grf		\| nearby_tile_same_grf

VariationalAction2/Stations

Rito12 — Fri, 05 Jun 2026 16:45:15 GMT

Description: add var 6B

← Older revision		Revision as of 16:45, 5 June 2026
Line 271:		Line 271:
	* '''00000000h''' if the selected station is a default station (no NewGRF station)		* '''00000000h''' if the selected station is a default station (no NewGRF station)
	* otherwise, the GRFID of the GRF which defined the type of the selected station		* otherwise, the GRFID of the GRF which defined the type of the selected station

			=== Station id of nearby tiles (6B) ===

			The parameter of this variable works the same way as the parameter of variable 66. The returned value is 0xFFFFFFFF if the selected tile isn't a railway station tile and 0xFFFE if it is from another grf. Otherwise, the returned value is a 16 bit station id.

	==Example==		==Example==

NML:IndustryTiles

Rito12 — Fri, 05 Jun 2026 10:45:30 GMT

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.
	\|-		\|-

NML:Houses

Rito12 — Fri, 05 Jun 2026 10:42:51 GMT

House callbacks: var18 bit 0

← Older revision		Revision as of 10:42, 5 June 2026
(One intermediate revision by the same user not shown)
Line 388:		Line 388:
	\| Same as <code>anim_control</code>		\| Same as <code>anim_control</code>
	\| Works the same as the <code>anim_control</code> callback, except that it's called when the construction state changes.		\| Works the same as the <code>anim_control</code> callback, except that it's called when the construction state changes.
			Since {{ottd\|15.0}} also triggered when placing new house.
			*<code>getbits(extra_callback_info2, 0, 1)</code> : Whether triggered when placing new house.
	\|-		\|-
	\| watched_cargo_accepted		\| watched_cargo_accepted

NML:IndustryTiles

Rito12 — Fri, 05 Jun 2026 10:33:34 GMT

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

NML:Roadstops

Rito12 — Fri, 05 Jun 2026 10:11:37 GMT

Road stop properties: nml #388

← Older revision		Revision as of 10:11, 5 June 2026
(One intermediate revision by the same user not shown)
Line 76:		Line 76:
	\| Array of badge labels from the [[NML:Badgetable\|badgetable]].		\| Array of badge labels from the [[NML:Badgetable\|badgetable]].
	\| Since {{ottd\|15.0}}		\| Since {{ottd\|15.0}}
			\|-
			\| heights
			\| Array of unsigned ints
			\| Since {{ottd\|15.0}} {{nml\|0.8.1}} <br>
			Each element of array corresponds to one [[#List of road stop views\|view]]. <br>
			Specifies the bridge height so bridges can be build above the road stop.
			The bridge height defines minimum clearances required for a bridge for the sprite layouts of this road stop (or zero to not allow any bridge).
			Values are given in "height level" units (1 level == 8px).
			\|-
			\| blocked_pillars
			\| Array of <code>bitmask(BRIDGE_PILLAR_XXX, ...)</code>
			\| Since {{ottd\|15.0}} {{nml\|0.8.1}} <br>
			Each element of array corresponds to one [[#List of road stop views\|view]]. <br>
			Allows information to provided about blocked bridge pillars to assist the game in hiding pillars if necessary depending on what is above the road stop tile. Blocking a pillar prevents the pillar from being drawn. It does not prevent the road stop being bridgeable.
			See [[#List_of_bridge_pillar_flags\|list of bridge pillar flags]].
	\|}		\|}

Line 120:		Line 135:
	\| RST_GENERAL_FLAG_DRAW_MODE_REGISTER		\| RST_GENERAL_FLAG_DRAW_MODE_REGISTER
	\| {{ottdp\|15.0\|no}} Read the road stop draw mode from variable 0x100 (set using STORE_TEMP), this overrides the draw_mode property.		\| {{ottdp\|15.0\|no}} Read the road stop draw mode from variable 0x100 (set using STORE_TEMP), this overrides the draw_mode property.
			\|}

			===List of bridge pillar flags===

			{\| class="wikitable sortable"
			! Name
			! Meaning
			\|-
			\| BRIDGE_PILLAR_CORNER_W
			\| Tile layout blocks a pillar on the west corner of the tile.
			\|-
			\| BRIDGE_PILLAR_CORNER_S
			\| Tile layout blocks a pillar on the south corner of the tile.
			\|-
			\| BRIDGE_PILLAR_CORNER_E
			\| Tile layout blocks a pillar on the east corner of the tile.
			\|-
			\| BRIDGE_PILLAR_CORNER_N
			\| Tile layout blocks a pillar on the north corner of the tile.
			\|-
			\| BRIDGE_PILLAR_EDGE_NE
			\| Tile layout blocks a wall on the north east side of the tile.
			\|-
			\| BRIDGE_PILLAR_EDGE_SE
			\| Tile layout blocks a wall on the south east side of the tile.
			\|-
			\| BRIDGE_PILLAR_EDGE_SW
			\| Tile layout blocks a wall on the south west side of the tile.
			\|-
			\| BRIDGE_PILLAR_EDGE_NW
			\| Tile layout blocks a wall on the north west side of the tile.
	\|}		\|}

Line 426:		Line 472:
	! Type		! Type
	! Meaning		! Meaning
			! Value
	\|-		\|-
	\| RST_VIEW_BAY_NE		\| RST_VIEW_BAY_NE
	\| Bay		\| Bay
	\| Facing north-east		\| Facing north-east
			\| 0
	\|-		\|-
	\| RST_VIEW_BAY_SE		\| RST_VIEW_BAY_SE
	\| Bay		\| Bay
	\| Facing south-east		\| Facing south-east
			\| 1
	\|-		\|-
	\| RST_VIEW_BAY_SW		\| RST_VIEW_BAY_SW
	\| Bay		\| Bay
	\| Facing south-west		\| Facing south-west
			\| 2
	\|-		\|-
	\| RST_VIEW_BAY_NW		\| RST_VIEW_BAY_NW
	\| Bay		\| Bay
	\| Facing north-west		\| Facing north-west
			\| 3
	\|-		\|-
	\| RST_VIEW_DRIVE_THROUGH_X		\| RST_VIEW_DRIVE_THROUGH_X
	\| Drive-through		\| Drive-through
	\| X-axis: north-east to south-west		\| X-axis: north-east to south-west
			\| 4
	\|-		\|-
	\| RST_VIEW_DRIVE_THROUGH_Y		\| RST_VIEW_DRIVE_THROUGH_Y
	\| Drive-through		\| Drive-through
	\| Y-axis: north-west to south-east		\| Y-axis: north-west to south-east
			\| 5
	\|}		\|}

NML:Stations

Rito12 — Fri, 05 Jun 2026 09:27:45 GMT

Station properties: add #388

@@ Line 151: / Line 151: @@
 ; BLOCKED
 : Do not allow trains to enter tile with that type.
 |}

NML:Vehicles

Rito12 — Fri, 05 Jun 2026 08:11:55 GMT

Variables that require an argument: ` -> <code>

← Older revision		Revision as of 08:11, 5 June 2026
(3 intermediate revisions by the same user not shown)
Line 1,153:		Line 1,153:
	\| [0 <nowiki>\|</nowiki> 1]		\| [0 <nowiki>\|</nowiki> 1]
	\| yes		\| yes
	\| {{ottd\|15.0}} Check if the vehicle has that specific badge attached.		\| {{ottd\|15.0}} {{nml\|0.9.0}} Check if the vehicle has that specific badge attached.
	\|-		\|-
	\| count_has_badge		\| count_has_badge
Line 1,159:		Line 1,159:
	\| 0..255		\| 0..255
	\| no		\| no
	\| {{ottd\|15.0}} The number of vehicles in the current consist that have that specific badge attached.		\| {{ottd\|15.0}} {{nml\|0.9.0}} The number of vehicles in the current consist that have that specific badge attached.
			\|-
			\| tile_has_railtype_badge <br /> tile_has_roadtype_badge <br /> tile_has_tramtype_badge
			\| Label from the [[NML:Badgetable\|badgetable]].
			\| [0 <nowiki>\|</nowiki> 1]
			\| no
			\| {{ottd\|15.0}} {{nml\|0.9.0}} Check if the rail/road/tram type of the current tile occupied by the vehicle has that specific badge attached. '''Trains/RVs/Trams only.''' <code>tile_has_roadtype_badge</code> also works for trams to allow code reuse.
	\|}		\|}
	<references/>		<references/>

VariationalAction2/Vehicles

Rito12 — Fri, 05 Jun 2026 07:52:28 GMT

Test if rail or road type of the current type occupied by the vehicle has that specific badge attached (65): type -> tile

@@ Line 1: / Line 1: @@
 <div style="float:right; padding-left:12px; background:none;">{{NFONavVehicles}}</div>
 == Variables ==
@@ Line 45: / Line 43: @@
 |-
 |63||D||{{ottdp|1.11|no|ottdrev=g868d84bbf}}||Test track-type of tile against another track-type||no
 |-
 |97||B||{{ottdp|0.6|2.0}}||Tick counter, increased every engine tick||no
@@ Line 361: / Line 363: @@
 The remaining bytes are reserved, and must be masked.
 === Modflags (FE and FF) ===
@@ Line 386: / Line 402: @@
 Other bits are reserved; most are actually used for TTDPatch internal states.