GRFSpecs - Recent changes [en-gb]

Action0

Rito12 — Fri, 08 May 2026 08:33:58 GMT

Feature: Fix last commit.

← Older revision		Revision as of 08:33, 8 May 2026
(One intermediate revision by the same user not shown)
Line 109:		Line 109:
	\|-		\|-
	\|10		\|10
	\|colspan="2"\| {{ottdp\|1.0\|no\|ottdrev=r18969}} [[Action0/Railtypes\|~~Railtypes~~]]		\|colspan="2"\| {{ottdp\|1.0\|no\|ottdrev=r18969}} [[Action0/Railtypes\|Rail Types]]
	\|-		\|-
	\|11		\|11
Line 115:		Line 115:
	\|-		\|-
	\|12		\|12
	\|colspan="2"\| {{ottdp\|1.10\|no\|ottdrev=gc02ef3e456}} [[Action0/Roadtypes\|~~Roadtypes~~]]		\|colspan="2"\| {{ottdp\|1.10\|no\|ottdrev=gc02ef3e456}} [[Action0/Roadtypes\|Road Types]]
	\|-		\|-
	\|13		\|13
	\|colspan="2"\| {{ottdp\|1.10\|no\|ottdrev=gc02ef3e456}} [[Action0/Tramtypes\|~~Tramtypes~~]]		\|colspan="2"\| {{ottdp\|1.10\|no\|ottdrev=gc02ef3e456}} [[Action0/Tramtypes\|Tram Types]]
	\|-		\|-
	\|14		\|14

NML:Badges

Peter1138 — Tue, 05 May 2026 20:48:00 GMT

Badge callbacks: Add comment about maximum badge width

← Older revision		Revision as of 20:48, 5 May 2026
(One intermediate revision by the same user not shown)
Line 52:		Line 52:
	== Badge callbacks ==		== Badge callbacks ==

	'''Note: By design badges are meant to only be up to 12 pixels tall.'''		'''Note: By design badges are meant to only be up to 12 pixels tall, and up to 24 pixels wide. Sprites larger than this may overlap or be clipped.'''

	{\| class="wikitable sortable"		{\| class="wikitable sortable"
Line 85:		Line 85:
	== Prerequisites ==		== Prerequisites ==

	~~Badges require a~~ [[NML:Badgetable\|badgetable]] to be ~~defined~~ ~~for~~ ~~most common usage scenarios~~ (eg to refer to a badge from an item block). ~~This~~ is ~~not~~ a ~~hard~~ ~~requirement~~ ~~and~~ ~~can~~ be ~~omitted~~ ~~if you are~~, ~~for~~ ~~example,~~ ~~creating~~ ~~badges~~ ~~that other newGRFs can later refer to~~		A [[NML:Badgetable\|badgetable]] is required to reference badges (e.g. to refer to a badge from an item block). No badgetable is required for NewGRFs that only define sets of badges, but do not use them.

	Eg for <code style="color:green">power/diesel</code> to be used in the badges property for a vehicle, the badge table must contain ~~entries~~ for ~~both <code style="color:green">power</code> and~~ <code style="color:green">power/diesel</code>		Eg for <code style="color:green">power/diesel</code> to be used in the badges property for a vehicle, the badge table must contain an entry for <code style="color:green">power/diesel</code>

	== Example code ==		== Example code ==

Badge labels

Rito12 — Sun, 19 Apr 2026 21:49:08 GMT

Introduction: Update link.

← Older revision		Revision as of 21:49, 19 April 2026
Line 8:		Line 8:
	For ease of maintenance keep alphabetical order.		For ease of maintenance keep alphabetical order.

	'''Note:''' This page is maintained manually and some grf developers oppose to that despicable labor. Therefore you might also want to visit https://github.com/Rito13/BaNaNaS-get_badge_labels/blob/main/gen_docs%2Fpublic_labels.md, which is updated automatically with content uploaded to BaNaNaS.		'''Note:''' This page is maintained manually and some grf developers oppose to that despicable labor. Therefore you might also want to visit https://github.com/Rito13/BaNaNaS-get_badge_labels/blob/main/gen_docs%2Fbadges%2Fpublic_labels.md, which is updated automatically with content uploaded to BaNaNaS.

	== Classes ==		== Classes ==

NML:Badges

Rito12 — Wed, 15 Apr 2026 14:34:13 GMT

Add nml since.

← Older revision		Revision as of 14:34, 15 April 2026
Line 1:		Line 1:
	{{NMLNavPropVarCB}}		{{NMLNavPropVarCB}}

	'''Since''' {{ottd\|15.0}}		'''Since''' {{ottd\|15.0}} {{nml\|0.9.0}}

	item (FEAT_BADGES, item_name) { ... }		item (FEAT_BADGES, item_name) { ... }

NML:Stations

Rito12 — Wed, 15 Apr 2026 14:31:53 GMT

Station properties: Litle tweaks.

← Older revision		Revision as of 14:31, 15 April 2026
(One intermediate revision by the same user not shown)
Line 53:		Line 53:
	There is one special class:		There is one special class:
	* "WAYP": The station type will be shown in the waypoint construction window, instead of the station construction window.		* "WAYP": The station type will be shown in the waypoint construction window, instead of the station construction window.
	{{ottdp\|15}} Station classes which start with the byte FF are considered waypoint classes, and will appear in the waypoint construction window instead of the station construction window.		{{ottdp\|15.0}} Station classes which start with the byte FF are considered waypoint classes, and will appear in the waypoint construction window instead of the station construction window.
	\|-		\|-
	\| classname		\| classname
Line 91:		Line 91:
	\| bitmask(STAT_FLAG_XXX, STAT_FLAG_YYY, ...)		\| bitmask(STAT_FLAG_XXX, STAT_FLAG_YYY, ...)
	\|		\|
			;STAT_FLAG_DISTRIBUTED_CARGO_BY_PERIMETER {{nml\|0.9.0}}
⚫	;STAT_FLAG_DISTRIBUTED_CARGO
	:Specifies whether waiting cargo amounts are scaled by station ~~size~~ for spriteset selection, see [[NML:Spritegroup#Stations\|spritegroup]] for details.		:Specifies whether waiting cargo amounts are scaled by station '''perimeter''' for spriteset selection, see [[NML:Spritegroup#Stations\|spritegroup]] for details.
			:Since {{ottd\|16.0}} if <code style="color:darkgreen">STAT_FLAG_DISTRIBUTED_CARGO_BY_AREA</code> is also set it does not do anything.
			;STAT_FLAG_DISTRIBUTED_CARGO_BY_AREA {{ottd\|16.0}} {{nml\|0.9.0}}
			:Specifies whether waiting cargo amounts are scaled by station '''area''' for spriteset selection, see [[NML:Spritegroup#Stations\|spritegroup]] for details.
	;STAT_FLAG_RANDOM_ANIMATION		;STAT_FLAG_RANDOM_ANIMATION
	:If set, callback <code style="color:darkgreen">anim_next_frame</code> will get random data in <code style="color:darkgreen">extra_callback_info1</code>		:If set, callback <code style="color:darkgreen">anim_next_frame</code> will get random data in <code style="color:darkgreen">extra_callback_info1</code>
Line 99:		Line 102:
	;STAT_FLAG_EXTENDED_FOUNDATIONS		;STAT_FLAG_EXTENDED_FOUNDATIONS
	:Selects between two possible spriteset formats for callback <code style="color:darkgreen">foundations</code>, see below.		:Selects between two possible spriteset formats for callback <code style="color:darkgreen">foundations</code>, see below.
		⚫	;STAT_FLAG_DISTRIBUTED_CARGO
			:Deprecated since {{nml\|0.9.0}}.
	\|-		\|-
	\| animation_info		\| animation_info

NML:Vehicles

2talltyler — Wed, 15 Apr 2026 13:51:43 GMT

Fix wording of "backing up" -> "driving backwards"

← Older revision		Revision as of 13:51, 15 April 2026
Line 244:		Line 244:
	\| {{ottd\|16}}		\| {{ottd\|16}}
	;VEHICLE_FLAG_TRAIN_HAS_CAB		;VEHICLE_FLAG_TRAIN_HAS_CAB
	: Train wagon has a cab and can lead a train when ~~backing~~ up, without any speed reduction.		: Train wagon has a cab and can lead a train when driving backwards, without any speed reduction.
	Additionally, trains have the extra flags common to all vehicle types, described above.		Additionally, trains have the extra flags common to all vehicle types, described above.
	\|-		\|-

VariationalAction2/Vehicles

2talltyler — Wed, 15 Apr 2026 13:50:35 GMT

Fix wording of "backing up" -> "driving backwards"

← Older revision		Revision as of 13:50, 15 April 2026
(One intermediate revision by the same user not shown)
Line 378:		Line 378:
	\|-		\|-
	\|10\|\|{{ottdp\|0.6\|2.5\|ttdprev=r1334}}\|\|Vehicle was built during the exclusive preview		\|10\|\|{{ottdp\|0.6\|2.5\|ttdprev=r1334}}\|\|Vehicle was built during the exclusive preview
			\|-
			\|11 <ref>This bit is only accurate for the first vehicle in the consist.</ref>\|\|{{ottd\|16}}\|\|The train is driving backwards (trains only)
	\|}		\|}
	<references/>		<references/>

NML:Vehicles

2talltyler — Wed, 15 Apr 2026 13:45:54 GMT

Add train_is_driving_backwards variable, from OpenTTD PR #15379 and NML PR #421.

← Older revision		Revision as of 13:45, 15 April 2026
(One intermediate revision by the same user not shown)
Line 238:		Line 238:
	;TRAIN_FLAG_SPRITE_STACK		;TRAIN_FLAG_SPRITE_STACK
	:{{ottdp\|1.7\|no\|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites\|composition from multiple sprites]].		:{{ottdp\|1.7\|no\|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites\|composition from multiple sprites]].
			\|-
			\| <code style="color:green">extra_flags</code>
			\| bitmask(VEHICLE_FLAG_XXX, ...)
			\| yes
			\| {{ottd\|16}}
			;VEHICLE_FLAG_TRAIN_HAS_CAB
			: Train wagon has a cab and can lead a train when backing up, without any speed reduction.
			Additionally, trains have the extra flags common to all vehicle types, described above.
	\|-		\|-
	\| <code style="color:green">refit_cost</code>		\| <code style="color:green">refit_cost</code>
Line 953:		Line 961:
	\| No		\| No
	\| Value is 1 if the vehicle has reversed an odd number of times		\| Value is 1 if the vehicle has reversed an odd number of times
			\|-
			\| train_is_driving_backwards
			\| [0 <nowiki>\|</nowiki> 1]
			\| No
			\| {{ottd\|16}} Value is 1 if the train is driving backwards (trains only)
	\|-		\|-
	\| built_during_preview		\| built_during_preview

Action0/Vehicles/Trains

2talltyler — Wed, 15 Apr 2026 13:32:04 GMT

Add HasCab extra flag, from OpenTTD PR #15379.

← Older revision		Revision as of 13:32, 15 April 2026
Line 510:		Line 510:
	\|2\|\| 4\|\|{{ottdp\|13\|no}}\|\| Variants - Include this variant when primary engine has "Exclusive Preview"		\|2\|\| 4\|\|{{ottdp\|13\|no}}\|\| Variants - Include this variant when primary engine has "Exclusive Preview"
	\|-		\|-
	\|3\|\| 8\|\|{{ottdp\|13\|no}}\|\| Variants - (Attempt to) Synchronize reliability the primary engine		\|3\|\| 8\|\|{{ottdp\|13\|no}}\|\| Variants - (Attempt to) Synchronize reliability the primary engine
			\|-
			\|4\|\| 16\|\|{{ottdp\|16\|no}}\|\| Train wagon has a cab and can lead a train when backing up, without any speed restriction
	\|-		\|-
	\|}		\|}