Action2/Sprite Layout - Revision history

Pikkabird: add road stops

2023-11-30T20:24:10Z

add road stops

← Older revision		Revision as of 20:24, 30 November 2023
Line 10:		Line 10:
	\|-		\|-
	\|Airport Tiles \|\| {{ottdp\|1.1\|no}}		\|Airport Tiles \|\| {{ottdp\|1.1\|no}}
			\|-
			\|Road Stops \|\| {{ottdp\|14\|no}}
	\|}		\|}

Line 19:		Line 21:
	== Basic format for tiles with a single building sprite ==		== Basic format for tiles with a single building sprite ==

	<pre> <Sprite-number> * <Length> 02 07/09/0F/11 <set-id> 00 <groundsprite> <buildingsprite> <xoffset> <yoffset> <xextent> <yextent> <zextent></pre>		<pre> <Sprite-number> * <Length> 02 07/09/0F/11/14 <set-id> 00 <groundsprite> <buildingsprite> <xoffset> <yoffset> <xextent> <yextent> <zextent></pre>

	{\|		{\|
Line 30:		Line 32:
	\|02\|\|B\|\|Defines action 02		\|02\|\|B\|\|Defines action 02
	\|-		\|-
	\|07/09/0F/11\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 airport tiles		\|07/09/0F/11/14\|\|B\|\|feature: 07 town buildings, 09 industry tiles, 0F objects, 11 airport tiles, or 14 road stops
	\|-		\|-
	\|<[[#Set-id\|set-id]]>\|\|B\|\|ID for this definition		\|<[[#Set-id\|set-id]]>\|\|B\|\|ID for this definition
Line 68:		Line 70:
	\|02\|\|B\|\|Defines action 02		\|02\|\|B\|\|Defines action 02
	\|-		\|-
	\|07/09/0F/11\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 = airport tiles		\|07/09/0F/11/14\|\|B\|\|feature: 07 town buildings, 09 industry tiles, 0F objects, 11 airport tiles, or 14 road stops
	\|-		\|-
	\|<[[#Set-id\|set-id]]>\|\|B\|\|ID for this definition		\|<[[#Set-id\|set-id]]>\|\|B\|\|ID for this definition

Planetmaker: some links and small omissions

2012-02-29T10:14:24Z

some links and small omissions

← Older revision		Revision as of 10:14, 29 February 2012
Line 12:		Line 12:
	\|}		\|}

	This Action2 defines a spritelayout for a tile. There are ~~two~~ formats available:		This Action2 defines a spritelayout for a tile. There are three formats available:
	* Basic format for a single groundsprite and a single building sprite.		* Basic format for a single groundsprite and a single building sprite.
	* Extended format for combining multiple sprites.		* Extended format for combining multiple sprites.
			* Advanced format with register offsets

	== Basic format for tiles with a single building sprite ==		== Basic format for tiles with a single building sprite ==
Line 67:		Line 68:
	\|02\|\|B\|\|Defines action 02		\|02\|\|B\|\|Defines action 02
	\|-		\|-
	\|07/09/0F\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 = airport tiles		\|07/09/0F/11\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 = airport tiles
	\|-		\|-
	\|<[[#Set-id\|set-id]]>\|\|B\|\|ID for this definition		\|<[[#Set-id\|set-id]]>\|\|B\|\|ID for this definition
	\|-		\|-
	\|<num-sprites>\|\|B\|\|Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). {{ottdp\|1.2\|no\|ottdrev=r22518}} Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (to be ~~documented~~).		\|<num-sprites>\|\|B\|\|Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). {{ottdp\|1.2\|no\|ottdrev=r22518}} Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers ([[Action2/Advanced Sprite Layout\| see below]]).
	\|-		\|-
	\|<[[#Sprite definition for ground and building sprites\|groundsprite]]>\|\|D\|\|Ground sprite for the building (see format below)		\|<[[#Sprite definition for ground and building sprites\|groundsprite]]>\|\|D\|\|Ground sprite for the building (see format below)

Planetmaker: Link directly to definition of some action 2 elements

2011-11-30T11:23:31Z

Link directly to definition of some action 2 elements

← Older revision		Revision as of 11:23, 30 November 2011
Line 23:		Line 23:
	!Element!![[GRFActionsDetailed\|Size]]!!Description		!Element!![[GRFActionsDetailed\|Size]]!!Description
	\|-		\|-
	\|<Sprite-number>\|\|dec\|\|A sequential sprite number		\|<[[#Sprite-number\|Sprite-number]]>\|\|dec\|\|A sequential sprite number
	\|-		\|-
	\|<length>\|\|dec\|\|The total number of bytes used in this action		\|<[[#Length\|length]]>\|\|dec\|\|The total number of bytes used in this action
	\|-		\|-
	\|02\|\|B\|\|Defines action 02		\|02\|\|B\|\|Defines action 02
	\|-		\|-
	\|07/09/0F\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 airport tiles		\|07/09/0F/11\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 airport tiles
	\|-		\|-
	\|<set-id>\|\|B\|\|ID for this definition		\|<[[#Set-id\|set-id]]>\|\|B\|\|ID for this definition
	\|-		\|-
	\|00\|\|B\|\|Literal 0 (to distinguish this definition from random/variational lists)		\|00\|\|B\|\|Literal 0 (to distinguish this definition from random/variational lists)
	\|-		\|-
	\|<groundsprite>\|\|D\|\|Ground sprite for the building (see format below)		\|<[[#Sprite definition for ground and building sprites\|groundsprite]]>\|\|D\|\|Ground sprite for the building (see format below)
	\|-		\|-
	\|<buildingsprite>\|\|D\|\|The sprite of the building (see format below), can be zero to indicate that no building sprite should be displayed (useful for early building stages)		\|<[[#Sprite definition for ground and building sprites\|buildingsprite]]>\|\|D\|\|The sprite of the building (see format below), can be zero to indicate that no building sprite should be displayed (useful for early building stages)
	\|-		\|-
	\|<xofs>\|\|B\|\|x-offset from northern tile corner (as a signed byte)		\|<xofs>\|\|B\|\|x-offset from northern tile corner (as a signed byte)
Line 61:		Line 61:
	!Element!![[GRFActionsDetailed\|Size]]!!Description		!Element!![[GRFActionsDetailed\|Size]]!!Description
	\|-		\|-
	\|<Sprite-number>\|\|dec\|\|A sequential sprite number		\|<[[#Sprite-number\|Sprite-number]]>\|\|dec\|\|A sequential sprite number
	\|-		\|-
	\|<length>\|\|dec\|\|The total number of bytes used in this action		\|<[[#Length\|length]]>\|\|dec\|\|The total number of bytes used in this action
	\|-		\|-
	\|02\|\|B\|\|Defines action 02		\|02\|\|B\|\|Defines action 02
Line 69:		Line 69:
	\|07/09/0F\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 = airport tiles		\|07/09/0F\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 = airport tiles
	\|-		\|-
	\|<set-id>\|\|B\|\|ID for this definition		\|<[[#Set-id\|set-id]]>\|\|B\|\|ID for this definition
	\|-		\|-
	\|<num-sprites>\|\|B\|\|Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). {{ottdp\|1.2\|no\|ottdrev=r22518}} Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (to be documented).		\|<num-sprites>\|\|B\|\|Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). {{ottdp\|1.2\|no\|ottdrev=r22518}} Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (to be documented).
	\|-		\|-
	\|<groundsprite>\|\|D\|\|Ground sprite for the building (see format below)		\|<[[#Sprite definition for ground and building sprites\|groundsprite]]>\|\|D\|\|Ground sprite for the building (see format below)
	\|-		\|-
	\|<buildingsprite>\|\|D\|\|The sprite to be drawn. Unlike the basic format, zero isn't allowed here.		\|<[[#Sprite definition for ground and building sprites\|buildingsprite]]>\|\|D\|\|The sprite to be drawn. Unlike the basic format, zero isn't allowed here.
	\|-		\|-
	!colspan="3"\| -- for sprites defining a new bounding box --		!colspan="3"\| -- for sprites defining a new bounding box --

Planetmaker: Include Advanced Action2 Spritelayouts

2011-11-30T11:11:35Z

Include Advanced Action2 Spritelayouts

Show changes

Planetmaker: /* Advanced format using register offsets */ clearify formatting a bit

2011-11-30T10:51:09Z

Advanced format using register offsets: clearify formatting a bit

← Older revision		Revision as of 10:51, 30 November 2011
Line 161:		Line 161:
	\|}		\|}

			=== Flags in advanced sprite layouts ===

	<flags>: ~~Word~~ ~~value~~ with these ~~flags~~:		<flags> is a bitset of word size with these meanings:
	{\| border="1"		{\| border="1"
	\|-		\|-
Line 183:		Line 183:
	\|-		\|-
	\|\| 6 \|\| 0040		\|\| 6 \|\| 0040
	\| colspan="2" \| Resolve sprite with Variable 10 set to a specific value ~~(*)~~		\| colspan="2" \| Resolve sprite with Variable 10 set to a specific value<ref name="action123">
		⚫	Only valid for stations: The Action 1/2/3 chain is resolved multiple times, sprites can be part of different Action 1: The associated value in <register/value> is the raw value (not a register!) to put into Variable 10 while resolving the sprites.
			<br><ul>
		⚫	<li>only allowed values currently 0-7</li>
		⚫	<li>the value '2' is used when resolving custom foundations, (so, do not conflict with that)</li>
		⚫	<li>even if the sprite is not from an Action 1, the value still defines which Action2 chains defines the values for the referenced registers.</li>
		⚫	<li>The register for "Add offset to recoloursprite" is defined by the Action 1/2/3 chain with Variable 10 as defined for the recolour sprite.</li>
			<li>The other registers are defined by the Action 1/2/3 chain with Variable 10 as defined for the sprite.</li>
		⚫	<li>If no variable 10 values are defined, then station property 13 bit 0 takes effect; i.e. variable 10 is set to 0 or 1 depending on the bit and whether the first groundsprite is resolved or a different sprite. This applies to both the groundsprite and the palette of the groundsprite.</li>
			</ul>
			</ref>
	\|-		\|-
	\|\| 7 \|\| 0080		\|\| 7 \|\| 0080
	\| colspan="2" \| Resolve recoloursprite with Variable 10 set to a specific value ~~(*)~~		\| colspan="2" \| Resolve recoloursprite with Variable 10 set to a specific value<ref name="action123"/>
	\|-		\|-
	\|\| 8..15 \|\|		\|\| 8..15 \|\|
Line 192:		Line 202:
	\|-		\|-
	\|}		\|}
	(*) The Action 1/2/3 chain is resolved multiple times, sprites can be part of different Action 1:
⚫	:The associated value in <register/value> is the raw value (not a register!) to put into Variable 10 while resolving the sprites.
	:*Only valid for stations,
⚫	:*only allowed values currently 0-7,
⚫	:*the value '2' is used when resolving custom foundations, (so, do not conflict with that)
⚫	:*even if the sprite is not from an Action 1, the value still defines which Action2 chains defines the values for the referenced registers.
⚫	:The register for "Add offset to recoloursprite" is defined by the Action 1/2/3 chain with Variable 10 as defined for the recolour sprite. ~~:The other registers are defined by the Action 1~~/~~2/3 chain with Variable 10 as defined for the sprite.~~
⚫	:*If no variable 10 values are defined, then station property 13 bit 0 takes effect; i.e. variable 10 is set to 0 or 1 depending on the bit and whether the first groundsprite is resolved or a different sprite. This applies to both the groundsprite and the palette of the groundsprite.

			<references />
	<register/value>:

⚫	~~Temporary~~ storage registers to add to the individual parts. The register values are considered signed.
			=== Register or value ===
		⚫	These are the temporary storage registers to add to the individual parts. The register values are considered signed.
	The order of the registers is the same as the bits in <flags>. If a bit is not set, then no registers appears for it.		The order of the registers is the same as the bits in <flags>. If a bit is not set, then no registers appears for it.
	Most bits require one register.		Most bits require one register.

Planetmaker: Add preliminary description of adv. sprite layouts

2011-11-30T07:27:24Z

Add preliminary description of adv. sprite layouts

← Older revision		Revision as of 07:27, 30 November 2011
Line 105:		Line 105:

	{{ttdp\|2.6\|r2313}} The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2313: TTDPatch ignores the xpixeloffset and ypixeloffset fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xpixeloffset and ypixeloffset zero to get the same effect in both games.		{{ttdp\|2.6\|r2313}} The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2313: TTDPatch ignores the xpixeloffset and ypixeloffset fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xpixeloffset and ypixeloffset zero to get the same effect in both games.

			== Advanced format using register offsets ==

			{{ottdp\|1.2\|no\|ottdrev=r22518}}
			The spritelayout defines fixed spritesets to use from the Action 1. The registers can be used to individually select sprites from the spritesets instead of always using the construction stage. The registers are evaluated and their values are saved when the Action 2 sprite layout is evaluated. Other callbacks called during drawing (like CB 1E) have no effect on the used values of the registers.

			{\|
			!Element!![[GRFActionsDetailed\|Size]]!!Description
			\|-
			\|<Sprite-number>\|\|dec\|\|A sequential sprite number
			\|-
			\|<length>\|\|dec\|\|The total number of bytes used in this action
			\|-
			\|02\|\|B\|\|Defines action 02
			\|-
			\|07/09/0F/11\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 = airport tiles
			\|-
			\|<set-id>\|\|B\|\|ID for this definition
			\|-
			\|40 + <num-sprites>\|\|B\|\|Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F).
			\|-
			\|<groundsprite>\|\|D\|\|Ground sprite for the building (see format below)
			\|-
			\|<flags>\|\|W\|\|Flags for the ground sprite (see format below)
			\|-
			\|<register/value>\|\|V\|\|Registers / values to be used. Depending onf <flags> (see format below)
			\|-
			\|<buildingsprite>\|\|D\|\|The sprite to be drawn. Unlike the basic format, zero isn't allowed here.
			\|-
			\|<flags>\|\|W\|\|Flags for the building sprite (see format below)
			\|-
			!colspan="3"\| -- for sprites defining a new bounding box --
			\|-
			\|<xofs>\|\|B\|\|x-offset from northern tile corner (as a signed byte)
			\|-
			\|<yofs>\|\|B\|\|y-offset from northern tile corner (as a signed byte)
			\|-
			\|<zofs>\|\|B\|\|z-offset from the ground
			\|-
			\|<xextent>\|\|B\|\|size of sprite in x direction
			\|-
			\|<yextent>\|\|B\|\|size of sprite in y direction
			\|-
			\|<zextent>\|\|B\|\|size of sprite in z direction
			\|-
			!colspan="3"\| -- for sprites sharing their bounding box with the previous sprite --
			\|-
			\|<xpixeloffset>\|\|B\|\|x offset from the top left corner of the previous sprite
			\|-
			\|<ypixeloffset>\|\|B\|\|y offset from the top left corner of the previous sprite
			\|-
			\|<register/value>\|\|V\|\|Registers / values to be used. Depending onf <flags> (see format below)
			\|-
			\|80\|\|B\|\|a literal 80h byte to distinguish from new-bounding-box definitions
			\|}


			<flags>: Word value with these flags:
			{\| border="1"
			\|-
			! Bit !! Hex !! Parentsprite !! Groundsprite/Childsprite
			\|-
			\|\| 0 \|\| 0001 \|\| Skip bounding box including child sprites \|\| Skip sprite
			\|-
			\|\| 1 \|\| 0002
			\| colspan="2" \| Add offset to sprite, disable default usage of construction stage or railtype-offset
			\|-
			\|\| 2 \|\| 0004
			\| colspan="2" \| Add offset to recoloursprite
			\|-
			\|\| 3 \|\| 0008
			\| colspan="2" \| Recolour sprite is from Action 1 (will be affected by the same construction stage resp. railtype-offsets as sprites, unless bit 2 is set)
			\|-
			\|\| 4 \|\| 0010 \|\| Add offset for <xoffset> and <yoffset> \|\| Add offset for <xpixeloffset>
			\|-
			\|\| 5 \|\| 0020 \|\| Add offset for <zoffset> \|\| Add offset for <ypixeloffset>
			\|-
			\|\| 6 \|\| 0040
			\| colspan="2" \| Resolve sprite with Variable 10 set to a specific value (*)
			\|-
			\|\| 7 \|\| 0080
			\| colspan="2" \| Resolve recoloursprite with Variable 10 set to a specific value (*)
			\|-
			\|\| 8..15 \|\|
			\| colspan="2" \| Reserved, should be zero. If the GRF sets unknown bits, it will be disabled.
			\|-
			\|}
			(*) The Action 1/2/3 chain is resolved multiple times, sprites can be part of different Action 1:
			:The associated value in <register/value> is the raw value (not a register!) to put into Variable 10 while resolving the sprites.
			:*Only valid for stations,
			:*only allowed values currently 0-7,
			:*the value '2' is used when resolving custom foundations, (so, do not conflict with that)
			:*even if the sprite is not from an Action 1, the value still defines which Action2 chains defines the values for the referenced registers.
			:The register for "Add offset to recoloursprite" is defined by the Action 1/2/3 chain with Variable 10 as defined for the recolour sprite. :The other registers are defined by the Action 1/2/3 chain with Variable 10 as defined for the sprite.
			:*If no variable 10 values are defined, then station property 13 bit 0 takes effect; i.e. variable 10 is set to 0 or 1 depending on the bit and whether the first groundsprite is resolved or a different sprite. This applies to both the groundsprite and the palette of the groundsprite.

			<register/value>:
			Temporary storage registers to add to the individual parts. The register values are considered signed.
			The order of the registers is the same as the bits in <flags>. If a bit is not set, then no registers appears for it.
			Most bits require one register.
			*<xoffset> and <yoffset> can only be enabled together, using two registers,
			*the "skip bounding box"-register uses value 1 to draw the sprite, and 0 to skip it,
			*the "recolorsprite from Action 1" uses no register at all,
			*the Variable 10 values are not set via a register, but via a byte-constant.

	== Sprite definition ==		== Sprite definition ==

Frosch: version tags

2011-08-15T15:10:51Z

version tags

← Older revision		Revision as of 15:10, 15 August 2011
Line 3:		Line 3:
	!Feature !! Version		!Feature !! Version
	\|-		\|-
	\|Houses \|\| {{ottdp\| \|2.5~~\|ttdprev=alpha ?~~}}		\|Houses \|\| {{ottdp\|0.6\|2.5}}
	\|-		\|-
	\|Industry Tiles \|\| {{ottdp\|0.6\| \|}}		\|Industry Tiles \|\| {{ottdp\|0.6\|2.5}}
	\|-		\|-
	\|Objects \|\| {{ottdp\|1.1\|2.6\|ttdprev=alpha r2023}}		\|Objects \|\| {{ottdp\|1.1\|2.6\|ttdprev=alpha r2023}}
Line 54:		Line 54:
	== Extended format using multiple combined sprites ==		== Extended format using multiple combined sprites ==

	Since TTDPatch 2.0.1 alpha 55 vcs 3, houses, industry (and object) tiles support an extended syntax as well, which looks as follows:		{{ottdp\|0.6\|2.5\|ttdprev=2.0.1 alpha 55 vcs 3}} Since TTDPatch 2.0.1 alpha 55 vcs 3, houses, industry (and object) tiles support an extended syntax as well, which looks as follows:

	<pre><nowiki><Sprite-number> * <Length> 02 07/09/0F/11 <set-id> <num-sprites> <groundsprite> [<buildingsprite> (<xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>) \| (<xpixeloffset> <ypixeloffset> 80)] ...</nowiki></pre>		<pre><nowiki><Sprite-number> * <Length> 02 07/09/0F/11 <set-id> <num-sprites> <groundsprite> [<buildingsprite> (<xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>) \| (<xpixeloffset> <ypixeloffset> 80)] ...</nowiki></pre>
Line 71:		Line 71:
	\|<set-id>\|\|B\|\|ID for this definition		\|<set-id>\|\|B\|\|ID for this definition
	\|-		\|-
	\|<num-sprites>\|\|B\|\|Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). {{~~ottd~~\|1.2\|r22518}} Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (to be documented).		\|<num-sprites>\|\|B\|\|Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). {{ottdp\|1.2\|no\|ottdrev=r22518}} Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (to be documented).
	\|-		\|-
	\|<groundsprite>\|\|D\|\|Ground sprite for the building (see format below)		\|<groundsprite>\|\|D\|\|Ground sprite for the building (see format below)
Line 113:		Line 113:
	!Bits!!Version!!Content		!Bits!!Version!!Content
	\|-		\|-
	\|0-13\|\|{{ottdp\| \| }}\|\|Sprite number, exact meaning specified by bit 31		\|0-13\|\|{{ottdp\|0.6\|2.5}}\|\|Sprite number, exact meaning specified by bit 31
	\|-		\|-
	\|14-15\|\|{{ottdp\| \| }}\|\|0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite		\|14-15\|\|{{ottdp\|0.6\|2.5}}\|\|0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite
	\|-		\|-
	\|16-29\|\|{{ottdp\| \| }}\|\|Color translation special sprite number, see below		\|16-29\|\|{{ottdp\|0.6\|2.5}}\|\|Color translation special sprite number, see below
	\|-		\|-
	\|30\|\|{{ottdp\| \|2.5\|ttdprev=alpha 57}}\|\|If set, sprite is drawn normally even in transparent buildings mode (for building sprites only)		\|30\|\|{{ottdp\|0.6\|2.5\|ttdprev=alpha 57}}\|\|If set, sprite is drawn normally even in transparent buildings mode (for building sprites only)
	\|-		\|-
	\|31\|\|{{ottdp\| \| }}\|\|Sprite type, see below		\|31\|\|{{ottdp\|0.6\|2.5}}\|\|Sprite type, see below
	\|}		\|}

	{{ottdp\| \|2.5\|ttdprev=alpha 57}} Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150\|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.		{{ottdp\|0.6\|2.5\|ttdprev=alpha 57}} Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150\|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.

	=== Colour translation special sprite number ===		=== Colour translation special sprite number ===

Planetmaker: /* Extended format using multiple combined sprites */ version infos also as icons

2011-08-06T09:14:49Z

Extended format using multiple combined sprites: version infos also as icons

← Older revision		Revision as of 09:14, 6 August 2011
Line 71:		Line 71:
	\|<set-id>\|\|B\|\|ID for this definition		\|<set-id>\|\|B\|\|ID for this definition
	\|-		\|-
	\|<num-sprites>\|\|B\|\|Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (~~since OpenTTD r22518;~~ to be documented).		\|<num-sprites>\|\|B\|\|Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). {{ottd\|1.2\|r22518}} Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (to be documented).
	\|-		\|-
	\|<groundsprite>\|\|D\|\|Ground sprite for the building (see format below)		\|<groundsprite>\|\|D\|\|Ground sprite for the building (see format below)
Line 102:		Line 102:
	Note: restrictions for sprites sharing their bounding box are the same as explained for [[Action0Stations#Sprite layout (09)\|station tiles.]]		Note: restrictions for sprites sharing their bounding box are the same as explained for [[Action0Stations#Sprite layout (09)\|station tiles.]]

	Since OpenTTD r18959 you can draw multiple ground sprites for a tile, which is useful if you want to use the usual grass/water/concrete groundtile, but still need to add features to it without using a new bounding box. To do so use the syntax of sprites sharing the previous bounding box, but use it before the first bounding box definition. xpixeloffset and ypixeloffset refer to the usual spot of groundtiles.		{{ottd\|0.7\|r18959}} Since OpenTTD r18959 you can draw multiple ground sprites for a tile, which is useful if you want to use the usual grass/water/concrete groundtile, but still need to add features to it without using a new bounding box. To do so use the syntax of sprites sharing the previous bounding box, but use it before the first bounding box definition. xpixeloffset and ypixeloffset refer to the usual spot of groundtiles.

	The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2313: TTDPatch ignores the xpixeloffset and ypixeloffset fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xpixeloffset and ypixeloffset zero to get the same effect in both games.		{{ttdp\|2.6\|r2313}} The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2313: TTDPatch ignores the xpixeloffset and ypixeloffset fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xpixeloffset and ypixeloffset zero to get the same effect in both games.

	== Sprite definition ==		== Sprite definition ==

Planetmaker: /* Action2 Sprite Layout */ version info

2011-08-06T09:10:11Z

Action2 Sprite Layout: version info

← Older revision		Revision as of 09:10, 6 August 2011
Line 1:		Line 1:
	= Action2 Sprite Layout =		= Action2 Sprite Layout =
	{\| \|-		{\| \|-
	!Feature !! ~~TTDPatch !! OpenTTD~~		!Feature !! Version
	\|-		\|-
	\|Houses \|\| 2.~~0.1~~ alpha ? ~~\|\| ?~~		\|Houses \|\| {{ottdp\| \|2.5\|ttdprev=alpha ?}}
	\|-		\|-
	\|Industry Tiles \|\| ? \|\| 0.6		\|Industry Tiles \|\| {{ottdp\|0.6\| \|}}
	\|-		\|-
	\|Objects \|\| 2.6 alpha r2023 ~~\|\| 1.1.0~~		\|Objects \|\| {{ottdp\|1.1\|2.6\|ttdprev=alpha r2023}}
	\|-		\|-
	\|Airport Tiles \|\| ~~not supported~~ \|\| 1.1.0		\|Airport Tiles \|\| {{ottdp\|1.1\|no}}
	\|}		\|}

Line 111:		Line 111:

	{\|		{\|
	!Bits!!Content		!Bits!!Version!!Content
	\|-		\|-
	\|0-13\|\|Sprite number, exact meaning specified by bit 31		\|0-13\|\|{{ottdp\| \| }}\|\|Sprite number, exact meaning specified by bit 31
	\|-		\|-
	\|14-15\|\|0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite		\|14-15\|\|{{ottdp\| \| }}\|\|0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite
	\|-		\|-
	\|16-29\|\|Color translation special sprite number, see below		\|16-29\|\|{{ottdp\| \| }}\|\|Color translation special sprite number, see below
	\|-		\|-
	\|30\|\|If set, sprite is drawn normally even in transparent buildings mode (for building sprites only~~; supported in TTDPatch 2.0.1 alpha 57 or later~~)		\|30\|\|{{ottdp\| \|2.5\|ttdprev=alpha 57}}\|\|If set, sprite is drawn normally even in transparent buildings mode (for building sprites only)
	\|-		\|-
	\|31\|\|Sprite type, see below		\|31\|\|{{ottdp\| \| }}\|\|Sprite type, see below
	\|}		\|}

	Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150\|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.		{{ottdp\| \|2.5\|ttdprev=alpha 57}} Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150\|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.

	=== Colour translation special sprite number ===		=== Colour translation special sprite number ===

Alberth: the combined sprites also missed a 11

2011-08-05T14:17:36Z

the combined sprites also missed a 11

← Older revision		Revision as of 14:17, 5 August 2011
Line 56:		Line 56:
	Since TTDPatch 2.0.1 alpha 55 vcs 3, houses, industry (and object) tiles support an extended syntax as well, which looks as follows:		Since TTDPatch 2.0.1 alpha 55 vcs 3, houses, industry (and object) tiles support an extended syntax as well, which looks as follows:

	<pre><nowiki><Sprite-number> * <Length> 02 07/09/0F <set-id> <num-sprites> <groundsprite> [<buildingsprite> (<xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>) \| (<xpixeloffset> <ypixeloffset> 80)] ...</nowiki></pre>		<pre><nowiki><Sprite-number> * <Length> 02 07/09/0F/11 <set-id> <num-sprites> <groundsprite> [<buildingsprite> (<xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>) \| (<xpixeloffset> <ypixeloffset> 80)] ...</nowiki></pre>

	{\|		{\|
Line 67:		Line 67:
	\|02\|\|B\|\|Defines action 02		\|02\|\|B\|\|Defines action 02
	\|-		\|-
	\|07/09/0F\|\|B\|\|feature 7=town buildings, 9=industry tiles or 0F = objects		\|07/09/0F\|\|B\|\|feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 = airport tiles
	\|-		\|-
	\|<set-id>\|\|B\|\|ID for this definition		\|<set-id>\|\|B\|\|ID for this definition