NML:Item - Revision history

Frosch: numeric ids and savegame compatibility

2014-11-05T14:05:57Z

numeric ids and savegame compatibility

← Older revision		Revision as of 14:05, 5 November 2014
Line 12:		Line 12:
	Mind, while arguments 2 to 4 are called "optional", you can only leave them out starting from the end, but not skip only some in the middle.		Mind, while arguments 2 to 4 are called "optional", you can only leave them out starting from the end, but not skip only some in the middle.
	That is, if you want so set argument 4, you must also set arguments 2 and 3.		That is, if you want so set argument 4, you must also set arguments 2 and 3.

			Note, while the third argument (the numerical id) is optional, it should only be left out in simple short-lived NewGRF.
			The numerical id is relevant for OpenTTD '''savegame compatibilty'''. If you delete items or insert items in front, the automatically assigned ids of following items will change, and thus your NewGRF will be incompatible to earlier versions of itself.
			So, if your NewGRF is not a one-shot, but will evolve over multiple versions, you should assign ids manually, and keep them unchanged.

	Example:		Example:

Frosch: express the "optional" part from the abstract in syntax in prosa

2014-11-05T13:59:17Z

express the "optional" part from the abstract in syntax in prosa

← Older revision		Revision as of 13:59, 5 November 2014
Line 9:		Line 9:

	The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information. The default value is -1, which lets NML pick an id for you. The fourth (optional) argument is the size, which is relevant for [[NML:Houses\|houses]] only and explained there.		The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information. The default value is -1, which lets NML pick an id for you. The fourth (optional) argument is the size, which is relevant for [[NML:Houses\|houses]] only and explained there.

			Mind, while arguments 2 to 4 are called "optional", you can only leave them out starting from the end, but not skip only some in the middle.
			That is, if you want so set argument 4, you must also set arguments 2 and 3.

	Example:		Example:

Alberth: Fixed typo

2014-02-02T10:37:20Z

Fixed typo

← Older revision		Revision as of 10:37, 2 February 2014
Line 8:		Line 8:
	}		}

	The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information. The default value is -1, which lets NML pick an id for you. The fourth (optional) argument is the size, which is ~~relavant~~ for [[NML:Houses\|houses]] only and explained there.		The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information. The default value is -1, which lets NML pick an id for you. The fourth (optional) argument is the size, which is relevant for [[NML:Houses\|houses]] only and explained there.

	Example:		Example:

Hirundo: /* General */ ID allocation by NML

2012-09-03T19:57:12Z

General: ID allocation by NML

← Older revision		Revision as of 19:57, 3 September 2012
Line 8:		Line 8:
	}		}

	The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information. The fourth (optional) argument is the size, which is relavant for [[NML:Houses\|houses]] only and explained there.		The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information. The default value is -1, which lets NML pick an id for you. The fourth (optional) argument is the size, which is relavant for [[NML:Houses\|houses]] only and explained there.

	Example:		Example:

Hirundo: /* General */ Add information about item size

2012-09-03T19:53:15Z

General: Add information about item size

← Older revision		Revision as of 19:53, 3 September 2012
Line 4:		Line 4:


	item (<expression> [, <ID> [, <expression>]]) {		item (<expression> [, <ID> [, <expression> [, <expression>]]]) {
	(<property-block>\|<graphics-block>\|<livery_override-block>)+		(<property-block>\|<graphics-block>\|<livery_override-block>)+
	}		}

	The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information.		The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information. The fourth (optional) argument is the size, which is relavant for [[NML:Houses\|houses]] only and explained there.

	Example:		Example:

Hirundo: /* General */ Remove note about cargo slots, mention feature-specific pages instead

2012-08-02T20:34:21Z

General: Remove note about cargo slots, mention feature-specific pages instead

← Older revision		Revision as of 20:34, 2 August 2012
Line 8:		Line 8:
	}		}

	The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. ~~Note~~ ~~that~~ ~~for cargos, this numerical ID corresponds to the [[CargoDefaultProps\|cargo type~~ ~~slot]]~~ of ~~the~~ ~~cargo. TTD default cargos occupy~~ ~~slots~~ 0-11, ~~so if you want~~ to ~~define~~ a ~~new~~ ~~cargo~~ be ~~sure to set this ID to 12 or higher~~.		The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information.

	Example:		Example:

Frosch: cargo slots

2012-08-01T21:09:48Z

cargo slots

← Older revision		Revision as of 21:09, 1 August 2012
Line 8:		Line 8:
	}		}

	The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. Note that for cargos, this numerical ID corresponds to the [[CargoDefaultProps\|cargo type slot]] of the cargo. TTD default cargos occupy slots 1-12, so if you want to define a new cargo be sure to set this ID to 13 or higher.		The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. Note that for cargos, this numerical ID corresponds to the [[CargoDefaultProps\|cargo type slot]] of the cargo. TTD default cargos occupy slots 0-11, so if you want to define a new cargo be sure to set this ID to 12 or higher.
	Example:		Example:

Supercheese: add info about cargo type slots and IDs

2012-08-01T20:47:36Z

add info about cargo type slots and IDs

← Older revision		Revision as of 20:47, 1 August 2012
Line 8:		Line 8:
	}		}

	The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. ~~Example:~~		The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. Note that for cargos, this numerical ID corresponds to the [[CargoDefaultProps\|cargo type slot]] of the cargo. TTD default cargos occupy slots 1-12, so if you want to define a new cargo be sure to set this ID to 13 or higher.
			Example:

	<pre style="color:blue">		<pre style="color:blue">

Hirundo: /* Livery override */ emphasis added

2012-02-02T19:21:04Z

Livery override: emphasis added

← Older revision		Revision as of 19:21, 2 February 2012
Line 49:		Line 49:
	[[Image:NML liveryoverride.png\|frame\|left\|Same cars, different engine, different car sprites]]		[[Image:NML liveryoverride.png\|frame\|left\|Same cars, different engine, different car sprites]]

	A livery override block offers the option to change the look and behaviour of a wagon depending on the engine it is attached to. It is basically the same as a graphics-block and its syntax is the same. The difference is that it only applies to a particular combination of an engine and a wagon. E.g. passenger wagons could adapt their livery to match the engine, to make the consist look like a multiple-unit train. The spritegroup needs to be defined before it can be used in a livery override. A livery override block is always part of the engine definition and looks like		A livery override block offers the option to change the look and behaviour of a wagon depending on the engine it is attached to. It is basically the same as a graphics-block and its syntax is the same. The difference is that it only applies to a particular combination of an engine and a wagon. E.g. passenger wagons could adapt their livery to match the engine, to make the consist look like a multiple-unit train. The spritegroup needs to be defined before it can be used in a livery override. A livery override block is always part of the '''engine''' definition and looks like

	livery_override (vehicleID) {		livery_override (vehicleID) {

Planetmaker: /* Livery override */ make more clear that an livery_override block works basically the same as a graphics block

2012-01-19T13:02:09Z

Livery override: make more clear that an livery_override block works basically the same as a graphics block

← Older revision		Revision as of 13:02, 19 January 2012
Line 49:		Line 49:
	[[Image:NML liveryoverride.png\|frame\|left\|Same cars, different engine, different car sprites]]		[[Image:NML liveryoverride.png\|frame\|left\|Same cars, different engine, different car sprites]]

	A livery override block offers the option to change the look and behaviour of a wagon depending on the engine it is attached to. It is basically the same as a graphics-block, ~~except~~ that it only applies to a particular combination of an engine and a wagon. E.g. passenger wagons could adapt their livery to match the engine, to make the consist look like a multiple-unit train. The spritegroup needs to be defined before it can be used in a livery override. A livery override block is always part of the engine definition and looks like		A livery override block offers the option to change the look and behaviour of a wagon depending on the engine it is attached to. It is basically the same as a graphics-block and its syntax is the same. The difference is that it only applies to a particular combination of an engine and a wagon. E.g. passenger wagons could adapt their livery to match the engine, to make the consist look like a multiple-unit train. The spritegroup needs to be defined before it can be used in a livery override. A livery override block is always part of the engine definition and looks like

	livery_override (vehicleID) {		livery_override (vehicleID) {
			callback_name: switch_name;
⚫	spritegroup_name
			callback_name2: return value;
		⚫	default: spritegroup_name;
	}		}