Action14 - Revision history

Planetmaker: change palette naming DOS->default and windows->legacy to match OpenTTD's naming of those

2013-12-18T12:42:27Z

change palette naming DOS->default and windows->legacy to match OpenTTD's naming of those

← Older revision		Revision as of 12:42, 18 December 2013
Line 9:		Line 9:
	Currently this action can be used to define		Currently this action can be used to define
	* {{ottdp\|1.1\|no\|ottdrev=r20250}} translations for the name and description of the GRF. (Those from action 8)		* {{ottdp\|1.1\|no\|ottdrev=r20250}} translations for the name and description of the GRF. (Those from action 8)
	* {{ottdp\|1.1\|no\|ottdrev=r20254}} the palette (DOS, Windows) the GRF needs, or whether the palette does not matter.		* {{ottdp\|1.1\|no\|ottdrev=r20254}} the palette (default (=DOS), legacy (=Windows)) the GRF needs, or whether the palette does not matter.
	* {{ottdp\|1.2\|no\|ottdrev=r23001}} the colour depth (8bpp, 32bpp) the GRF needs		* {{ottdp\|1.2\|no\|ottdrev=r23001}} the colour depth (8bpp, 32bpp) the GRF needs
	* {{ottdp\|1.1\|no\|ottdrev=r20255}} the number, format and purpose of GRF parameters. (allowed values, names, descriptions, ...)		* {{ottdp\|1.1\|no\|ottdrev=r20255}} the number, format and purpose of GRF parameters. (allowed values, names, descriptions, ...)
Line 133:		Line 133:
	\|-		\|-
	\|"D"		\|"D"
	\|DOS palette		\|Default (DOS) palette
	\|-		\|-
	\|"W"		\|"W"
	\|Windows palette		\|Legacy (Windows) palette
	\|-		\|-
	\|"A"		\|"A"

Frosch: /* Enumeration values ("INFO" -> "PARA" -> -> "VALU") */

2012-10-16T15:57:43Z

Enumeration values ("INFO" -> "PARA" -> -> "VALU")

← Older revision		Revision as of 15:57, 16 October 2012
Line 315:		Line 315:

	This chunk allows you to specify texts to display instead of the raw value for integer/enumeration. You can also specify texts only for some of the valid values. So if a setting e.g. allows values betweeen 0 to 42 you can instruct the GUI to show "none" instead of "0".		This chunk allows you to specify texts to display instead of the raw value for integer/enumeration. You can also specify texts only for some of the valid values. So if a setting e.g. allows values betweeen 0 to 42 you can instruct the GUI to show "none" instead of "0".

			{{ottdp\|1.3\|no}} If you specify texts for all allowed values (according to "LIMI"), then a dropdown box is displayed instead of [<][>] buttons.

	==== Default value ("INFO" -> "PARA" -> <setting-number> -> "DFLT") ====		==== Default value ("INFO" -> "PARA" -> <setting-number> -> "DFLT") ====

Frosch: link to version numbers page

2012-04-01T17:12:57Z

link to version numbers page

← Older revision		Revision as of 17:12, 1 April 2012
Line 172:		Line 172:
	00</pre>		00</pre>

	Specifies the version of the GRF. This version is then used (by OpenTTD) to internally order GRFs with the same GRFID. That order will determine which GRF is loading as "compatible" GRF and which GRFs to show in the list of GRFs. By default a GRF has version 0.		Specifies the [[Version_numbers#Version_of_a_specific_NewGRF\|version of the GRF]]. This version is then used (by OpenTTD) to internally order GRFs with the same GRFID. That order will determine which GRF is loading as "compatible" GRF and which GRFs to show in the list of GRFs. By default a GRF has version 0.

	If all GRFs (with the same GRFID) have version 0 all will be shown in the list of GRFs. If the highest version is shared by multiple GRFs one is randomly chosen as "compatible" GRF. As such it is important to prevent releasing multiple GRFs with the same version number.		If all GRFs (with the same GRFID) have version 0 all will be shown in the list of GRFs. If the highest version is shared by multiple GRFs one is randomly chosen as "compatible" GRF. As such it is important to prevent releasing multiple GRFs with the same version number.
Line 185:		Line 185:
	00</pre>		00</pre>

	Specifies the minimal version of GRFs with the same GRFID this GRF is still compatible with.		Specifies the minimal [[Version_numbers#Version_of_a_specific_NewGRF\|version of GRFs]] with the same GRFID this GRF is still compatible with.

	You have to set MINV after VRSN, and MINV has to be smaller or equal to VRSN.		You have to set MINV after VRSN, and MINV has to be smaller or equal to VRSN.

Yexo: Document "INFO"->"URL_"

2011-12-11T13:03:19Z

Document "INFO"->"URL_"

← Older revision		Revision as of 13:03, 11 December 2011
Line 13:		Line 13:
	* {{ottdp\|1.1\|no\|ottdrev=r20255}} the number, format and purpose of GRF parameters. (allowed values, names, descriptions, ...)		* {{ottdp\|1.1\|no\|ottdrev=r20255}} the number, format and purpose of GRF parameters. (allowed values, names, descriptions, ...)
	* {{ottdp\|1.1\|no\|ottdrev=r20960}} version information and compatibility to older versions of the same GRF.		* {{ottdp\|1.1\|no\|ottdrev=r20960}} version information and compatibility to older versions of the same GRF.
			* {{ottdp\|1.2\|no\|ottdrev=r23494}} website url that can be opened in-game.

	The action itself is available since OpenTTD r20250. TTDPatch ignores the action since r2334, so no skipping is needed. The action is only allowed for GRF version 7 or above.		The action itself is available since OpenTTD r20250. TTDPatch ignores the action since r2334, so no skipping is needed. The action is only allowed for GRF version 7 or above.
Line 106:		Line 107:

	Below the top-level chunk "INFO" you can use the leaf-chunks "NAME" and "DESC" to define name and description for additional languages. The information provided in action 8 is used for "other" languages (id 7F).		Below the top-level chunk "INFO" you can use the leaf-chunks "NAME" and "DESC" to define name and description for additional languages. The information provided in action 8 is used for "other" languages (id 7F).

			=== GRF website ("INFO" -> "URL_") ===
			{{ottdp\|1.2\|no\|ottdrev=r23494}}
			<pre>-1 * -1 14 "C" "INFO"
			"T" "URL_" <language-id> "http://www.example.org" 00
			00
			00</pre>

			You can use the "URL_" chunk to provide an url for this grf. You can translate this like the name and description to provide a localized website.


	=== GRF palette ("INFO" -> "PALS") ===		=== GRF palette ("INFO" -> "PALS") ===

Planetmaker: colour depth and palette are slightly different

2011-10-04T22:04:36Z

colour depth and palette are slightly different

← Older revision		Revision as of 22:04, 4 October 2011
Line 10:		Line 10:
	* {{ottdp\|1.1\|no\|ottdrev=r20250}} translations for the name and description of the GRF. (Those from action 8)		* {{ottdp\|1.1\|no\|ottdrev=r20250}} translations for the name and description of the GRF. (Those from action 8)
	* {{ottdp\|1.1\|no\|ottdrev=r20254}} the palette (DOS, Windows) the GRF needs, or whether the palette does not matter.		* {{ottdp\|1.1\|no\|ottdrev=r20254}} the palette (DOS, Windows) the GRF needs, or whether the palette does not matter.
			* {{ottdp\|1.2\|no\|ottdrev=r23001}} the colour depth (8bpp, 32bpp) the GRF needs
	* {{ottdp\|1.1\|no\|ottdrev=r20255}} the number, format and purpose of GRF parameters. (allowed values, names, descriptions, ...)		* {{ottdp\|1.1\|no\|ottdrev=r20255}} the number, format and purpose of GRF parameters. (allowed values, names, descriptions, ...)
	* {{ottdp\|1.1\|no\|ottdrev=r20960}} version information and compatibility to older versions of the same GRF.		* {{ottdp\|1.1\|no\|ottdrev=r20960}} version information and compatibility to older versions of the same GRF.
Line 130:		Line 131:
	\|}		\|}

	=== GRF ~~palette~~ ("INFO" -> "BLTR") ===		=== GRF colour depth ("INFO" -> "BLTR") ===
	{{ottdp\|1.2\|no\|ottdrev=r23001}}		{{ottdp\|1.2\|no\|ottdrev=r23001}}
	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"

Michi cc: /* GRF palette ("INFO" -> "BLTR") */ Too much copypasta

2011-10-04T22:03:56Z

GRF palette ("INFO" -> "BLTR"): Too much copypasta

← Older revision		Revision as of 22:03, 4 October 2011
Line 143:		Line 143:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	!'''<~~palette~~>'''		!'''<blitter>'''
	!'''Meaning'''		!'''Meaning'''
	\|-		\|-

Michi cc: "INFO" -> "BLTR"

2011-10-04T21:45:25Z

"INFO" -> "BLTR"

@@ Line 128: / Line 128: @@
 |"A"
 |Any palette. (e.g. when the GRF does not contain any sprites)
 |}

Frosch: version tags for individual sections

2011-08-06T15:04:45Z

version tags for individual sections

← Older revision		Revision as of 15:04, 6 August 2011
Line 97:		Line 97:

	=== GRF name ("INFO" -> "NAME") and description ("INFO" -> "DESC") ===		=== GRF name ("INFO" -> "NAME") and description ("INFO" -> "DESC") ===
			{{ottdp\|1.1\|no\|ottdrev=r20250}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"T" "NAME" <language-id> "Translatable GRF name" 00		"T" "NAME" <language-id> "Translatable GRF name" 00
Line 107:		Line 107:

	=== GRF palette ("INFO" -> "PALS") ===		=== GRF palette ("INFO" -> "PALS") ===
			{{ottdp\|1.1\|no\|ottdrev=r20254}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"B" "PALS" \w1 <palette>		"B" "PALS" \w1 <palette>
Line 131:		Line 131:

	=== GRF version ("INFO" -> "VRSN") ===		=== GRF version ("INFO" -> "VRSN") ===
			{{ottdp\|1.1\|no\|ottdrev=r20259}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"B" "VRSN" \w4 \d<version>		"B" "VRSN" \w4 \d<version>
Line 144:		Line 144:

	=== Minimal compatible GRF version ("INFO" -> "MINV") ===		=== Minimal compatible GRF version ("INFO" -> "MINV") ===
			{{ottdp\|1.1\|no\|ottdrev=r20960}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"B" "MINV" \w4 \d<version>		"B" "MINV" \w4 \d<version>
Line 165:		Line 165:

	==== Number of settings ("INFO" -> "NPAR") ====		==== Number of settings ("INFO" -> "NPAR") ====
			{{ottdp\|1.1\|no\|ottdrev=r20251}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"B" "NPAR" \w1 <number-of-settings>		"B" "NPAR" \w1 <number-of-settings>
Line 173:		Line 173:

	==== Setting name ("INFO" -> "PARA" -> <setting-number> -> "NAME") and description ("INFO" -> "PARA" -> <setting-number> -> "DESC") ====		==== Setting name ("INFO" -> "PARA" -> <setting-number> -> "NAME") and description ("INFO" -> "PARA" -> <setting-number> -> "DESC") ====
			{{ottdp\|1.1\|no\|ottdrev=r20255}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"C" "PARA"		"C" "PARA"
Line 189:		Line 189:

	==== Setting to GRF parameter mapping ("INFO" -> "PARA" -> <setting-number> -> "MASK") ====		==== Setting to GRF parameter mapping ("INFO" -> "PARA" -> <setting-number> -> "MASK") ====
			{{ottdp\|1.1\|no\|ottdrev=r20255}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"C" "PARA"		"C" "PARA"
Line 223:		Line 223:

	==== Setting type ("INFO" -> "PARA" -> <setting-number> -> "TYPE") ====		==== Setting type ("INFO" -> "PARA" -> <setting-number> -> "TYPE") ====
			{{ottdp\|1.1\|no\|ottdrev=r20255}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"C" "PARA"		"C" "PARA"
Line 251:		Line 251:

	==== Allowed value range ("INFO" -> "PARA" -> <setting-number> -> "LIMI") ====		==== Allowed value range ("INFO" -> "PARA" -> <setting-number> -> "LIMI") ====
			{{ottdp\|1.1\|no\|ottdrev=r20255}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"C" "PARA"		"C" "PARA"
Line 266:		Line 266:

	==== Enumeration values ("INFO" -> "PARA" -> <setting-number> -> "VALU") ====		==== Enumeration values ("INFO" -> "PARA" -> <setting-number> -> "VALU") ====
			{{ottdp\|1.1\|no\|ottdrev=r20255}}

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"C" "PARA"		"C" "PARA"
Line 282:		Line 282:

	==== Default value ("INFO" -> "PARA" -> <setting-number> -> "DFLT") ====		==== Default value ("INFO" -> "PARA" -> <setting-number> -> "DFLT") ====
			{{ottdp\|1.1\|no\|ottdrev=r20602}}

	Available since OpenTTD r20602.

	<pre>-1 * -1 14 "C" "INFO"		<pre>-1 * -1 14 "C" "INFO"
	"C" "PARA"		"C" "PARA"

Michi cc: /* Syntax */ more reordering

2011-08-05T18:46:04Z

Syntax: more reordering

← Older revision		Revision as of 18:46, 5 August 2011
Line 52:		Line 52:
	\| B		\| B
	\| Action 14		\| Action 14
		⚫	\|-
		⚫	\| <chunks ...>
		⚫	\| *
		⚫	\| Any number of sub chunks.
	\|-		\|-
	\| "C"/"B"/"T"		\| "C"/"B"/"T"
Line 60:		Line 64:
	\| 4*B		\| 4*B
	\| Unique identifier for the chunk (see below)		\| Unique identifier for the chunk (see below)
⚫	\|-
⚫	\| <chunks ...>
⚫	\| *
⚫	\| Any number of sub chunks.
	\|-		\|-
	\| <length>		\| <length>

Eddi: /* Syntax */

2011-08-05T18:39:47Z

Syntax

← Older revision		Revision as of 18:39, 5 August 2011
Line 31:		Line 31:
	<pre>"T" <identifier> <language-id> <text> 00</pre>		<pre>"T" <identifier> <language-id> <text> 00</pre>

	These three types of chunks define branch nodes (~~choices~~) and binary and textual leafs in a tree-like information structure. A piece of information is identified by the path in the information tree. E.g. the text leaf node at "INFO" -> "DESC" provides translatable descriptions for the GRF. It does not matter how many action 14 appear in a GRF, and which information is defined in which. Information with different identifier paths or same identifier paths (but e.g. different language-ids) can be set in the same action 14 or in multiple. If information is assigned to the same identifier-path multiple times, the information adds up resp. the last set information wins.		These three types of chunks define branch nodes (containers) and binary and textual leafs in a tree-like information structure. A piece of information is identified by the path in the information tree. E.g. the text leaf node at "INFO" -> "DESC" provides translatable descriptions for the GRF. It does not matter how many action 14 appear in a GRF, and which information is defined in which. Information with different identifier paths or same identifier paths (but e.g. different language-ids) can be set in the same action 14 or in multiple. If information is assigned to the same identifier-path multiple times, the information adds up resp. the last set information wins.

	Chunks with unknown identifiers are just skipped including their subchunks. Following chunks are processed nevertheless.		Chunks with unknown identifiers are just skipped including their subchunks. Following chunks are processed nevertheless.
Line 52:		Line 52:
	\| B		\| B
	\| Action 14		\| Action 14
			\|-
			\| "C"/"B"/"T"
			\| B
			\| chunk type (container/binary/text)
	\|-		\|-
	\| <identifier>		\| <identifier>