NML:GRF - Revision history

Dawdledeer: Undo revision 4957 by Dawdledeer (talk)

2025-03-28T01:28:41Z

Undo revision 4957 by Dawdledeer (talk)

← Older revision		Revision as of 01:28, 28 March 2025
Line 75:		Line 75:
	bit		bit

	Only valid for settings with type "~~int~~". The value is the bit in which this setting should be stored.		Only valid for settings with type "bool". The value is the bit in which this setting should be stored.

	names		names

Dawdledeer: replace "bool" with "int"

2025-03-28T01:28:16Z

replace "bool" with "int"

← Older revision		Revision as of 01:28, 28 March 2025
Line 75:		Line 75:
	bit		bit

	Only valid for settings with type "~~bool~~". The value is the bit in which this setting should be stored.		Only valid for settings with type "int". The value is the bit in which this setting should be stored.

	names		names

Planetmaker: /* GRF block */ must be first block. Actions before that are invalid.

2015-04-11T07:18:44Z

GRF block: must be first block. Actions before that are invalid.

← Older revision		Revision as of 07:18, 11 April 2015
Line 16:		Line 16:

	Mind: the items enclosed in [...] indicate optional lines: The [] itself are not part of the syntax.		Mind: the items enclosed in [...] indicate optional lines: The [] itself are not part of the syntax.
			The grf block must be the first block within a NewGRF.

	Concerning the choice of the <code style="color:darkgreen">grfid</code>, see [[Action8#GRFID\|these]] guidelines		Concerning the choice of the <code style="color:darkgreen">grfid</code>, see [[Action8#GRFID\|these]] guidelines

Juzza1: Required - according to nmlc

2014-06-26T19:12:47Z

Required - according to nmlc

← Older revision		Revision as of 19:12, 26 June 2014
Line 9:		Line 9:
	name: <string>;		name: <string>;
	desc: <string>;		desc: <string>;
		⚫	version: <expression>;
		⚫	min_compatible_version: <expression>;
	[url: <string>;]		[url: <string>;]
⚫	[version: <expression>;
⚫	[min_compatible_version: <expression>;]]
	[param { ... }]		[param { ... }]
	}		}

Planetmaker: link to guidelines for choosing a grfid

2014-06-24T15:52:52Z

link to guidelines for choosing a grfid

← Older revision		Revision as of 15:52, 24 June 2014
Line 16:		Line 16:

	Mind: the items enclosed in [...] indicate optional lines: The [] itself are not part of the syntax.		Mind: the items enclosed in [...] indicate optional lines: The [] itself are not part of the syntax.

			Concerning the choice of the <code style="color:darkgreen">grfid</code>, see [[Action8#GRFID\|these]] guidelines

	== GRF parameters ==		== GRF parameters ==

Hyronymus: Added an example of the string for providing an URL

2012-07-08T11:51:11Z

Added an example of the string for providing an URL

← Older revision		Revision as of 11:51, 8 July 2012
Line 85:		Line 85:
	name: string(STR_GRF_NAME);		name: string(STR_GRF_NAME);
	desc: string(STR_GRF_DESC);		desc: string(STR_GRF_DESC);
			url: string(STR_GRF_URL);
	version: 1;		version: 1;
	min_compatible_version: 0;		min_compatible_version: 0;

Planetmaker: indicate optional items of the grf block

2012-07-08T10:53:54Z

indicate optional items of the grf block

← Older revision		Revision as of 10:53, 8 July 2012
Line 9:		Line 9:
	name: <string>;		name: <string>;
	desc: <string>;		desc: <string>;
	[url: <string>;		[url: <string>;]
	version: <expression>;		[version: <expression>;
	min_compatible_version: <expression>;		[min_compatible_version: <expression>;]]
	[param { ... }]		[param { ... }]
	}		}

			Mind: the items enclosed in [...] indicate optional lines: The [] itself are not part of the syntax.

	== GRF parameters ==		== GRF parameters ==

Yexo: Document "url" property in grf-block

2011-12-11T13:05:52Z

Document "url" property in grf-block

← Older revision		Revision as of 13:05, 11 December 2011
Line 9:		Line 9:
	name: <string>;		name: <string>;
	desc: <string>;		desc: <string>;
			[url: <string>;
	version: <expression>;		version: <expression>;
	min_compatible_version: <expression>;		min_compatible_version: <expression>;
	~~<~~param { ... }~~>~~		[param { ... }]
	}		}

Yexo at 14:07, 13 September 2011

2011-09-13T14:07:39Z

← Older revision		Revision as of 14:07, 13 September 2011
Line 18:		Line 18:
	As part of the grf block you can specify some parameter settings that the user will be able to change as part of the newgrf configuration. These can for example be used to disable parts of your NewGRF or to change between multiple graphics in case that's not possible at runtime. In general the settings (sub-)block looks like		As part of the grf block you can specify some parameter settings that the user will be able to change as part of the newgrf configuration. These can for example be used to disable parts of your NewGRF or to change between multiple graphics in case that's not possible at runtime. In general the settings (sub-)block looks like

	param {		param <num> {
	<name> {		<name> {
	type: <type>;		type: <type>;
Line 26:		Line 26:
	max_value: <expression>;		max_value: <expression>;
	def_value: <expression>;		def_value: <expression>;
			bit: <expression>;
	names: {		names: {
	0: <string>;		0: <string>;
Line 37:		Line 38:

	Looking at the single entries:		Looking at the single entries:

			<num>

			Optional, you can specify in which param number this setting should be stored.

	type		type
Line 52:		Line 57:
	min_value		min_value

	The minimum acceptable value for the parameter (~~makes~~ only ~~sense~~ for type int)		The minimum acceptable value for the parameter (only valid for type int), default of min_value is 0

	max_value		max_value

	The maximum acceptable value for the parameter (~~makes~~ only ~~sense~~ for type int)		The maximum acceptable value for the parameter (only valid for type int), default of max_value = 0xFFFFFFFF

	def_value		def_value

	This sets the default value for this parameter. If left out, the default value of 0 will be used.		This sets the default value for this parameter. If left out, the default value of 0 will be used.

			bit

			Only valid for settings with type "bool". The value is the bit in which this setting should be stored.

	names		names

Planetmaker: one common example is better

2011-09-09T22:53:04Z

one common example is better

@@ Line 13: / Line 13: @@
  	&lt;param { ... }&gt;
+ }
 == GRF parameters ==
@@ Line 76: / Line 64: @@
  names
-If you chose type <code style="color:darkgreen">int</code> and the numbers themselves are only used internally, have no direct numerical meaning and are better explained in words, you can use this to associate the single numbers with a string which describes it and is shown to the user instead of the value. A simple example:
+If you chose type <code style="color:darkgreen">int</code> and the numbers themselves are only used internally, have no direct numerical meaning and are better explained in words, you can use this to associate the single numbers with a string which describes it and is shown to the user instead of the value.
- 		desc:    string(STR_PARAM_PROVIDE_DESC);
+ 	name: string(STR_GRF_NAME);
- 		max_value: 1;
+ 	version: 1;
- 		def_value: 0;
+ 	min_compatible_version: 0;
- 		names: {
+ 	param {