Action2/Vehicles - Revision history

Andythenorth at 17:04, 4 May 2022

2022-05-04T17:04:51Z

← Older revision		Revision as of 17:04, 4 May 2022
Line 66:		Line 66:
	For OpenTTD 1.7 - 12.0 limited to at most 4 sprites per articulated part.		For OpenTTD 1.7 - 12.0 limited to at most 4 sprites per articulated part.

	Increased to 4 sprites per articulated part for OpenTTD 13.0 {{ottdp\|13.0\|no}}		Increased to 8 sprites per articulated part for OpenTTD 13.0 {{ottdp\|13.0\|no}}

	In addition to returning a sprite, you need to set register 100 to return this information:		In addition to returning a sprite, you need to set register 100 to return this information:

Andythenorth at 17:04, 4 May 2022

2022-05-04T17:04:30Z

← Older revision		Revision as of 17:04, 4 May 2022
Line 63:		Line 63:

	When enabled, sprites are resolved multiple times while incrementing the iteration number in bits 8 to 15 of variable 10.		When enabled, sprites are resolved multiple times while incrementing the iteration number in bits 8 to 15 of variable 10.

	For OpenTTD 1.7 - 12.0 limited to at most 4 sprites per articulated part.		For OpenTTD 1.7 - 12.0 limited to at most 4 sprites per articulated part.

	Increased to 4 sprites per articulated part for OpenTTD 13.0 {{ottdp\|13.0\|no}}		Increased to 4 sprites per articulated part for OpenTTD 13.0 {{ottdp\|13.0\|no}}

Andythenorth: Note sprites increased to 8 when composing with sprite stack.

2022-05-04T17:04:05Z

Note sprites increased to 8 when composing with sprite stack.

← Older revision		Revision as of 17:04, 4 May 2022
Line 63:		Line 63:

	When enabled, sprites are resolved multiple times while incrementing the iteration number in bits 8 to 15 of variable 10.		When enabled, sprites are resolved multiple times while incrementing the iteration number in bits 8 to 15 of variable 10.
	~~Currently~~ ~~this~~ is limited to at most 4 sprites per articulated part.		For OpenTTD 1.7 - 12.0 limited to at most 4 sprites per articulated part.
			Increased to 4 sprites per articulated part for OpenTTD 13.0 {{ottdp\|13.0\|no}}

	In addition to returning a sprite, you need to set register 100 to return this information:		In addition to returning a sprite, you need to set register 100 to return this information:

Frosch: stacked vehicle sprites in OpenTTD r27668

2016-10-16T15:32:40Z

stacked vehicle sprites in OpenTTD r27668

@@ Line 11: / Line 11: @@
 If there are two load types, the first is shown below 50%, the other above 50%. If there are three load types, they are shown above/below 33% and 66%. If there are four load types, they are shown above/below 25%, 50% and 75%, etc.
 {{ottdp|1.2|no|ottdrev=r23080}} Since OpenTTD r23080 you can use variable 10 to display different sprites in the GUI and on the map. Currently these cases are available:
 {| |-
-! Lowest byte of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 10]] !! Meaning
+! Bits 0 - 7 of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 10]] !! Meaning
 |-
 | 00 || Vehicle is drawn in a viewport, i.e. on the map.
@@ Line 39: / Line 54: @@
 The other bytes of variable 10 are reserved, and must be masked.
 The cases 20..2F are called using the purchase-list chain (cargotype FF), the other cases are called for actual vehicles (except for the special depot-gridsize call).
 ==Syntax==

Frosch: depot gridsize

2012-07-22T13:58:26Z

depot gridsize

← Older revision		Revision as of 13:58, 22 July 2012
Line 19:		Line 19:
	\| 01..0F \|\| reserved		\| 01..0F \|\| reserved
	\|-		\|-
	\| 10 \|\| Vehicle is drawn in the depot GUI.		\| 10 \|\| Vehicle is drawn in the depot GUI. <ref>OpenTTD also uses this value with the purchase-list chain (cargotype FF) to determine the gridsize in ship and aircraft depots.</ref>
	\|-		\|-
	\| 11 \|\| Vehicle is drawn in the vehicle details GUI. (This includes the refit GUI.)		\| 11 \|\| Vehicle is drawn in the vehicle details GUI. (This includes the refit GUI.)
Line 35:		Line 35:
	\| 30..FF \|\| reserved		\| 30..FF \|\| reserved
	\|}		\|}
			<references/>

	The other bytes of variable 10 are reserved, and must be masked.		The other bytes of variable 10 are reserved, and must be masked.
	The cases 20..2F are called using the purchase-list chain (cargotype FF), the other cases are called for actual vehicles.		The cases 20..2F are called using the purchase-list chain (cargotype FF), the other cases are called for actual vehicles (except for the special depot-gridsize call).

	==Syntax==		==Syntax==

Frosch: link var 10

2011-11-01T17:23:57Z

link var 10

← Older revision		Revision as of 17:23, 1 November 2011
Line 13:		Line 13:
	{{ottdp\|1.2\|no\|ottdrev=r23080}} Since OpenTTD r23080 you can use variable 10 to display different sprites in the GUI and on the map. Currently these cases are available:		{{ottdp\|1.2\|no\|ottdrev=r23080}} Since OpenTTD r23080 you can use variable 10 to display different sprites in the GUI and on the map. Currently these cases are available:
	{\| \|-		{\| \|-
	! Lowest byte of variable 10 !! Meaning		! Lowest byte of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29\|variable 10]] !! Meaning
	\|-		\|-
	\| 00 \|\| Vehicle is drawn in a viewport, i.e. on the map.		\| 00 \|\| Vehicle is drawn in a viewport, i.e. on the map.

Frosch: new usage of var 10

2011-11-01T17:11:40Z

new usage of var 10

← Older revision		Revision as of 17:11, 1 November 2011
Line 10:		Line 10:

	If there are two load types, the first is shown below 50%, the other above 50%. If there are three load types, they are shown above/below 33% and 66%. If there are four load types, they are shown above/below 25%, 50% and 75%, etc.		If there are two load types, the first is shown below 50%, the other above 50%. If there are three load types, they are shown above/below 33% and 66%. If there are four load types, they are shown above/below 25%, 50% and 75%, etc.

			{{ottdp\|1.2\|no\|ottdrev=r23080}} Since OpenTTD r23080 you can use variable 10 to display different sprites in the GUI and on the map. Currently these cases are available:
			{\| \|-
			! Lowest byte of variable 10 !! Meaning
			\|-
			\| 00 \|\| Vehicle is drawn in a viewport, i.e. on the map.
			\|-
			\| 01..0F \|\| reserved
			\|-
			\| 10 \|\| Vehicle is drawn in the depot GUI.
			\|-
			\| 11 \|\| Vehicle is drawn in the vehicle details GUI. (This includes the refit GUI.)
			\|-
			\| 12 \|\| Vehicle is drawn in the vehicle list.
			\|-
			\| 13..1F \|\| reserved for other future GUIs.
			\|-
			\| 20 \|\| Vehicle is drawn in the purchase list. (This includes the autoreplace GUI.)
			\|-
			\| 21 \|\| Vehicle is drawn in the exclusive preview GUI or in the advertisement news.
			\|-
			\| 22..2F \|\| reserved for other future GUIs with non-purchased vehicles.
			\|-
			\| 30..FF \|\| reserved
			\|}
			The other bytes of variable 10 are reserved, and must be masked.
			The cases 20..2F are called using the purchase-list chain (cargotype FF), the other cases are called for actual vehicles.

	==Syntax==		==Syntax==

Frosch: move notes to the top and add some links

2011-06-21T21:44:37Z

move notes to the top and add some links

← Older revision		Revision as of 21:44, 21 June 2011
Line 3:		Line 3:
	Defining set-IDs for vehicles.		Defining set-IDs for vehicles.

	For features 0, 1, 2 and 3 (vehicles), ~~action2~~ is mainly used to define sets of sprites that show one vehicle in various states of load for one particular type of cargo.		For features 0, 1, 2 and 3 (vehicles), Action2 is mainly used to define sets of sprites that show one vehicle in various states of load for one particular type of cargo.

		⚫	Do not skip an Action2 using [[Action9]] (unless it skips the whole file). Action2 must not be skipped by Action9 or TTDPatch will most likely crash. Skip or modify [[Action3]] instead. Skipping an Action2 with an [[Action7]] has no effect.

		⚫	If there is only one load type, it is shown for all loads.

		⚫	If there are two load types, the first is shown below 50%, the other above 50%. If there are three load types, they are shown above/below 33% and 66%. If there are four load types, they are shown above/below 25%, 50% and 75%, etc.

	==Syntax==		==Syntax==
Line 82:		Line 88:

	Note that you can share action1 sets between several action2 entries. For example, you might have a wagon that can hold coal or iron ore, and it would look the same if it's empty. Then the empty sprite set could be shared by the action2 entries for iron ore and coal.		Note that you can share action1 sets between several action2 entries. For example, you might have a wagon that can hold coal or iron ore, and it would look the same if it's empty. Then the empty sprite set could be shared by the action2 entries for iron ore and coal.

	== Notes ==

⚫	Do not skip an ~~action2~~ using ~~action9~~ (unless it skips the whole file). Action2 must not be skipped by ~~action9~~ or ~~the patch~~ will most likely crash. Skip or modify ~~action3~~ instead. Skipping an ~~action2~~ with an ~~action7~~ has no effect.

⚫	If there is only one load type, it is shown for all loads.

⚫	If there are two load types, the first is shown below 50%, the other above 50%. If there are three load types, they are shown above/below 33% and 66%. If there are four load types, they are shown above/below 25%, 50% and 75%, etc.

	= Example =		= Example =

Frosch: fix conversion

2011-06-20T20:00:18Z

fix conversion

← Older revision		Revision as of 20:00, 20 June 2011
Line 77:		Line 77:
	=== loadtypes ===		=== loadtypes ===

	The sprite sets to use for the states of load. Each entry is a '''WORD''' value in little endian format, and refers to the most recent action1 sets. For example, action1 sets 4, 5 and 7 would be encoded as -+04 00+-, -+05 00+- and -+07 00+-, respectively. Note the additional 00 which is needed because it must be a word value here.		The sprite sets to use for the states of load. Each entry is a '''WORD''' value in little endian format, and refers to the most recent action1 sets. For example, action1 sets 4, 5 and 7 would be encoded as <tt>04 00</tt>, <tt>05 00</tt> and <tt>07 00</tt>, respectively. Note the additional 00 which is needed because it must be a word value here.

	The first entries of these are used when not loading. There have to be num-loadtypes of these. After this follow the sets to use while loading/unloading, and there must be num-loadingtype of those.		The first entries of these are used when not loading. There have to be num-loadtypes of these. After this follow the sets to use while loading/unloading, and there must be num-loadingtype of those.

Planetmaker: wrong heading

2011-06-18T09:07:55Z

wrong heading

← Older revision		Revision as of 09:07, 18 June 2011
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

	= Action 2 =

	Defining set-IDs for vehicles.		Defining set-IDs for vehicles.


	For features 0, 1, 2 and 3 (vehicles), action2 is mainly used to define sets of sprites that show one vehicle in various states of load for one particular type of cargo.		For features 0, 1, 2 and 3 (vehicles), action2 is mainly used to define sets of sprites that show one vehicle in various states of load for one particular type of cargo.