NML:Spriteset - Revision history

Glx: Advanced spriteset syntax

2025-10-07T02:36:41Z

Advanced spriteset syntax

← Older revision		Revision as of 02:36, 7 October 2025
Line 11:		Line 11:

	Parameter two <image-file> (optional) is a literal (quoted) string that specifies the default file where the sprites are located. This may be overridden per-sprite (see [[NML:Realsprites\|Real sprites]]).		Parameter two <image-file> (optional) is a literal (quoted) string that specifies the default file where the sprites are located. This may be overridden per-sprite (see [[NML:Realsprites\|Real sprites]]).

			{{nml\|0.7.5}} An alternative syntax combining spriteset and [[NML:Alternative sprites\|Alternative sprites]] allows to create 32bpp only NewGRF.

			spriteset (<spriteset-name>, zoom_level, type[, <image-file>[, <mask-file>]]) {
			[[NML:Realsprites\|list of realsprites]]
			...
			}

	Within the spriteset are a list of [[NML:Realsprites\|Real sprites]], which defines the position and size of the sprite within the image file, its alignment offsets and any other real sprite properties.		Within the spriteset are a list of [[NML:Realsprites\|Real sprites]], which defines the position and size of the sprite within the image file, its alignment offsets and any other real sprite properties.

Zephyris: More clearly point to realsprite page.

2025-01-18T21:36:51Z

More clearly point to realsprite page.

← Older revision		Revision as of 21:36, 18 January 2025
Line 11:		Line 11:

	Parameter two <image-file> (optional) is a literal (quoted) string that specifies the default file where the sprites are located. This may be overridden per-sprite (see [[NML:Realsprites\|Real sprites]]).		Parameter two <image-file> (optional) is a literal (quoted) string that specifies the default file where the sprites are located. This may be overridden per-sprite (see [[NML:Realsprites\|Real sprites]]).

			Within the spriteset are a list of [[NML:Realsprites\|Real sprites]], which defines the position and size of the sprite within the image file, its alignment offsets and any other real sprite properties.

	Each sprite may be prefixed with a label, see [[NML:Spritelayout#Sprite\| sprite layouts]] for more info. Example:		Each sprite may be prefixed with a label, see [[NML:Spritelayout#Sprite\| sprite layouts]] for more info. Example:

Oberhümer at 15:04, 1 November 2014

2014-11-01T15:04:21Z

← Older revision		Revision as of 15:04, 1 November 2014
Line 10:		Line 10:
	Parameter <spriteset-name> specifies the name of this spriteset. This name is used to refer to the spriteset later on.		Parameter <spriteset-name> specifies the name of this spriteset. This name is used to refer to the spriteset later on.

	Parameter two <image-file> (optional) is a literal (quoted) string that specifies the default file where the sprites are located. This may be overridden per-sprite.		Parameter two <image-file> (optional) is a literal (quoted) string that specifies the default file where the sprites are located. This may be overridden per-sprite (see [[NML:Realsprites\|Real sprites]]).

	Each sprite may be prefixed with a label, see [[NML:Spritelayout#Sprite\| sprite layouts]] for more info. Example:		Each sprite may be prefixed with a label, see [[NML:Spritelayout#Sprite\| sprite layouts]] for more info. Example:

Hirundo: Document parameters better

2012-03-03T21:21:27Z

Document parameters better

← Older revision		Revision as of 21:21, 3 March 2012
Line 3:		Line 3:
	A spriteset associates a name with a number piece of an existing image file and describes the offsets with respect to some origin the graphics will be painted within the game. Different features and situations require that a single set has a certain amount of actual sprites associated. E.g. a vehicle usually requires eight sprites in order to provide on view for each of the eight possible ingame orientations of a vehicle.		A spriteset associates a name with a number piece of an existing image file and describes the offsets with respect to some origin the graphics will be painted within the game. Different features and situations require that a single set has a certain amount of actual sprites associated. E.g. a vehicle usually requires eight sprites in order to provide on view for each of the eight possible ingame orientations of a vehicle.

	spriteset (~~SPRITESET_NAME~~, ~~graphics_file~~) {		spriteset (<spriteset-name>[, <image-file>]) {
	[[NML:Realsprites\|list of realsprites]]		[[NML:Realsprites\|list of realsprites]]
	...		...
	}		}

			Parameter <spriteset-name> specifies the name of this spriteset. This name is used to refer to the spriteset later on.

			Parameter two <image-file> (optional) is a literal (quoted) string that specifies the default file where the sprites are located. This may be overridden per-sprite.

	Each sprite may be prefixed with a label, see [[NML:Spritelayout#Sprite\| sprite layouts]] for more info. Example:		Each sprite may be prefixed with a label, see [[NML:Spritelayout#Sprite\| sprite layouts]] for more info. Example:

Hirundo: fix typo

2012-02-26T17:32:12Z

fix typo

← Older revision		Revision as of 17:32, 26 February 2012
Line 19:		Line 19:
	* For vehicles, the same as above is possible. However, to facilitate the common case of having multiple loading stages, you can also define [[NML:Spritegroup\|sprite groups]], see below. These sprite groups are then used in place of a single sprite set.		* For vehicles, the same as above is possible. However, to facilitate the common case of having multiple loading stages, you can also define [[NML:Spritegroup\|sprite groups]], see below. These sprite groups are then used in place of a single sprite set.
	* Stations, houses, industry tiles, objects and airport tiles all define the look of a tile. This often requires more than one sprite, for example a concrete ground sprite with a building sprite on top of it. To combine and arrange these sprites a [[NML:Spritelayout\|sprite layout]] is used, directly referring to sprite sets is not possible here		* Stations, houses, industry tiles, objects and airport tiles all define the look of a tile. This often requires more than one sprite, for example a concrete ground sprite with a building sprite on top of it. To combine and arrange these sprites a [[NML:Spritelayout\|sprite layout]] is used, directly referring to sprite sets is not possible here
	* Features not ~~mmentioned~~ here have no use for sprite sets, as such they are not supported by NML.		* Features not mentioned here have no use for sprite sets, as such they are not supported by NML.

Planetmaker: Undo revision 2630 by Planetmaker (Talk) but keep link fix

2011-09-09T00:23:41Z

Undo revision 2630 by Planetmaker (Talk) but keep link fix

@@ Line 1: / Line 1: @@
 {{NMLNavBlocksyntax}}
 A spriteset associates a name with a number piece of an existing image file and describes the offsets with respect to some origin the graphics will be painted within the game. Different features and situations require that a single set has a certain amount of actual sprites associated. E.g. a vehicle usually requires eight sprites in order to provide on view for each of the eight possible ingame orientations of a vehicle.
@@ Line 22: / Line 20: @@
 * Stations, houses, industry tiles, objects and airport tiles all define the look of a tile. This often requires more than one sprite, for example a concrete ground sprite with a building sprite on top of it. To combine and arrange these sprites a [[NML:Spritelayout|sprite layout]] is used, directly referring to sprite sets is not possible here
 * Features not mmentioned here have no use for sprite sets, as such they are not supported by NML.

Planetmaker: Real sprites are only used in spritesets

2011-09-09T00:19:48Z

Real sprites are only used in spritesets

@@ Line 1: / Line 1: @@
 {{NMLNavBlocksyntax}}
 A spriteset associates a name with a number piece of an existing image file and describes the offsets with respect to some origin the graphics will be painted within the game. Different features and situations require that a single set has a certain amount of actual sprites associated. E.g. a vehicle usually requires eight sprites in order to provide on view for each of the eight possible ingame orientations of a vehicle.
@@ Line 8: / Line 10: @@
+ }
-Each sprite may be prefixed with a label, see [[NML:Spritelayouts#Sprite| sprite layouts]] for more info. Example:
+Each sprite may be prefixed with a label, see [[NML:Spritelayout#Sprite| sprite layouts]] for more info. Example:
 <pre style="color:blue">
@@ Line 20: / Line 22: @@
 * Stations, houses, industry tiles, objects and airport tiles all define the look of a tile. This often requires more than one sprite, for example a concrete ground sprite with a building sprite on top of it. To combine and arrange these sprites a [[NML:Spritelayout|sprite layout]] is used, directly referring to sprite sets is not possible here
 * Features not mmentioned here have no use for sprite sets, as such they are not supported by NML.

FooBar: add nav template

2011-08-21T16:31:46Z

add nav template

← Older revision		Revision as of 16:31, 21 August 2011
Line 1:		Line 1:
			{{NMLNavBlocksyntax}}

	A spriteset associates a name with a number piece of an existing image file and describes the offsets with respect to some origin the graphics will be painted within the game. Different features and situations require that a single set has a certain amount of actual sprites associated. E.g. a vehicle usually requires eight sprites in order to provide on view for each of the eight possible ingame orientations of a vehicle.		A spriteset associates a name with a number piece of an existing image file and describes the offsets with respect to some origin the graphics will be painted within the game. Different features and situations require that a single set has a certain amount of actual sprites associated. E.g. a vehicle usually requires eight sprites in order to provide on view for each of the eight possible ingame orientations of a vehicle.

FooBar: content of nml r1625

2011-08-21T11:17:33Z

content of nml r1625

New page

A spriteset associates a name with a number piece of an existing image file and describes the offsets with respect to some origin the graphics will be painted within the game. Different features and situations require that a single set has a certain amount of actual sprites associated. E.g. a vehicle usually requires eight sprites in order to provide on view for each of the eight possible ingame orientations of a vehicle.

spriteset (SPRITESET_NAME, graphics_file) {
[[NML:Realsprites|list of realsprites]]
...
}

Each sprite may be prefixed with a label, see [[NML:Spritelayouts#Sprite| sprite layouts]] for more info. Example:

<pre style="color:blue">
some_label: [... real sprite ...]
</pre>

How to use a sprite set depends on the feature:

* For canals, cargos, airports (not tiles!) and railtypes, you can refer to sprite sets directly from the graphics block, or use intermediate (random)switches to make a descision.
* For vehicles, the same as above is possible. However, to facilitate the common case of having multiple loading stages, you can also define [[NML:Spritegroup|sprite groups]], see below. These sprite groups are then used in place of a single sprite set.
* Stations, houses, industry tiles, objects and airport tiles all define the look of a tile. This often requires more than one sprite, for example a concrete ground sprite with a building sprite on top of it. To combine and arrange these sprites a [[NML:Spritelayout|sprite layout]] is used, directly referring to sprite sets is not possible here
* Features not mmentioned here have no use for sprite sets, as such they are not supported by NML.