Action2/Stations - Revision history

Frosch: Undo revision 2882; spritelayouts for stations are done via Action0

2011-11-30T19:21:48Z

Undo revision 2882; spritelayouts for stations are done via Action0

← Older revision		Revision as of 19:21, 30 November 2011
Line 7:		Line 7:
	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.		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.

	== ~~Basic Action 2~~ ==		== Syntax ==

	For stations, the data looks as follows:		For stations, the data looks as follows:
Line 41:		Line 41:
	\|}		\|}

			== Description ==
	{{:Action2/Advanced Sprite Layout}}

			=== Sprite-number ===

			This is just the number you are at.

			=== Length ===

			Count the number of bytes in this action.

			=== Set-id ===

			The set-ID that you want to define for this set. You can choose any value between 00 and FF, and you can reuse them within a grf file at a later point (if being equal to an existing set ID, the existing one is overwritten and the new one is used).

	=== numlittlesets, numlotssets ===		=== numlittlesets, numlotssets ===

Planetmaker: /* Basic Action 2 */ Link directly to definition of some action 2 elements

2011-11-30T11:30:14Z

Basic Action 2: Link directly to definition of some action 2 elements

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

	\|-		\|-
	\|<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

	\|-		\|-
Line 29:		Line 29:

	\|-		\|-
	\|<set-id>\|\|B\|\|What set-ID this action2 defines		\|<[[#Set-id\|set-id]]>\|\|B\|\|What set-ID this action2 defines

	\|-		\|-
	\|<numlittlesets>\|\|B\|\|How many different cargo amounts to show when there is little cargo		\|<[[#numlittlesets, numlotssets\|numlittlesets]]>\|\|B\|\|How many different cargo amounts to show when there is little cargo

	\|-		\|-
	\|<numlotssets>\|\|B\|\|Same but when there is lots of cargo		\|<[[#numlittlesets, numlotssets\|numlotssets]]>\|\|B\|\|Same but when there is lots of cargo

	\|-		\|-
	\|<sets...>\|\|W\|\|Sprite sets for each of the cargo amounts		\|<[[#sets\|sets]]...>\|\|W\|\|Sprite sets for each of the cargo amounts
	\|}		\|}

Planetmaker: Include the Adv. Sprite Layout page

2011-11-30T11:08:25Z

Include the Adv. Sprite Layout page

← Older revision		Revision as of 11:08, 30 November 2011
Line 7:		Line 7:
	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.		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.

	== ~~Syntax~~ ==		== Basic Action 2 ==

	For stations, the data looks as follows:		For stations, the data looks as follows:
Line 41:		Line 41:
	\|}		\|}

			{{:Action2/Advanced Sprite Layout}}
	== Description ==

	=== Sprite-number ===

	This is just the number you are at.

	=== Length ===

	Count the number of bytes in this action.

	=== Set-id ===

	The set-ID that you want to define for this set. You can choose any value between 00 and FF, and you can reuse them within a grf file at a later point (if being equal to an existing set ID, the existing one is overwritten and the new one is used).

	=== numlittlesets, numlotssets ===		=== numlittlesets, numlotssets ===

Frosch: move notes to the top and add some links

2011-06-21T21:47:09Z

move notes to the top and add some links

← Older revision		Revision as of 21:47, 21 June 2011
Line 1:		Line 1:
	== Introduction ==		== Introduction ==


	Defining station set-IDs.		Defining station set-IDs.

		⚫	For stations, Action2 is used to define set-IDs, similar to the way it works for vehicles. See the description below for details.

		⚫	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.
⚫	For stations, ~~action 2~~ is used to define set-IDs, similar to the way it works for vehicles.

	== Syntax ==		== Syntax ==
Line 69:		Line 69:

	The sets from the most recent action1 to use for this set-ID, for each stage of numlittlesets and numlotssets, i.e. in total numlittlesets+numlotssets entries.		The sets from the most recent action1 to use for this set-ID, for each stage of numlittlesets and numlotssets, i.e. in total numlittlesets+numlotssets entries.

	=== Notes ===

⚫	Do not skip an ~~action2~~ using ~~either action7 or action9~~ (unless ~~those~~ ~~skip~~ the whole file). Action2 must not be skipped or ~~the~~ ~~patch~~ will most likely crash. Skip or modify ~~action3~~ instead.

	== Example ==		== Example ==

Frosch: moved Action2Stations to Action2/Stations: use subpages

2011-06-17T21:12:19Z

moved Action2Stations to Action2/Stations: use subpages

← Older revision	Revision as of 21:12, 17 June 2011
(No difference)

Pm-bot: Beautify wiki markup

2011-06-15T14:47:36Z

Beautify wiki markup

← Older revision		Revision as of 14:47, 15 June 2011
Line 1:		Line 1:

	== Introduction ==		== Introduction ==

Line 8:		Line 7:
	For stations, action 2 is used to define set-IDs, similar to the way it works for vehicles.		For stations, action 2 is used to define set-IDs, similar to the way it works for vehicles.

	==Syntax==		== Syntax ==

	For stations, the data looks as follows:		For stations, the data looks as follows:
Line 42:		Line 41:
	\|}		\|}

	==Description==		== Description ==

	===Sprite-number===		=== Sprite-number ===

	This is just the number you are at.		This is just the number you are at.

	===Length===		=== Length ===

	Count the number of bytes in this action.		Count the number of bytes in this action.

	===Set-id===		=== Set-id ===

	The set-ID that you want to define for this set. You can choose any value between 00 and FF, and you can reuse them within a grf file at a later point (if being equal to an existing set ID, the existing one is overwritten and the new one is used).		The set-ID that you want to define for this set. You can choose any value between 00 and FF, and you can reuse them within a grf file at a later point (if being equal to an existing set ID, the existing one is overwritten and the new one is used).

	===numlittlesets, numlotssets===		=== numlittlesets, numlotssets ===

	Like for vehicles, this decides the graphics set to use depending on the amount of cargo waiting. There are two caveats, though. Firstly, a station can have 12 different cargoes waiting, not just a single one. Secondly, the maximum amount is 4095 for all stations and all cargo types.		Like for vehicles, this decides the graphics set to use depending on the amount of cargo waiting. There are two caveats, though. Firstly, a station can have 12 different cargoes waiting, not just a single one. Secondly, the maximum amount is 4095 for all stations and all cargo types.

	Regarding the first issue, the amount of cargo this refers to depends on the action3 that triggered this action2:		Regarding the first issue, the amount of cargo this refers to depends on the action3 that triggered this action2:
Line 65:		Line 64:
	* if the station is displayed for construction, the maximum amount is shown		* if the station is displayed for construction, the maximum amount is shown

	Regarding the second issue, TTDPatch introduces the distinction between "little" and "lots of" cargo. The amount where this occurs is set by property 10, which is zero by default. But if set to a non-zero value, for example 200, then the range 0 to 199 is divided by numlittlesets, and the remaining range 200 to 4095 is divided by numlotssets. If property 10 is zero, the "little" sets are never used, and so numlittlesets may be zero. numlotssets must never be zero, however.		Regarding the second issue, TTDPatch introduces the distinction between "little" and "lots of" cargo. The amount where this occurs is set by property 10, which is zero by default. But if set to a non-zero value, for example 200, then the range 0 to 199 is divided by numlittlesets, and the remaining range 200 to 4095 is divided by numlotssets. If property 10 is zero, the "little" sets are never used, and so numlittlesets may be zero. numlotssets must never be zero, however.

	===sets===		=== sets ===

	The sets from the most recent action1 to use for this set-ID, for each stage of numlittlesets and numlotssets, i.e. in total numlittlesets+numlotssets entries.		The sets from the most recent action1 to use for this set-ID, for each stage of numlittlesets and numlotssets, i.e. in total numlittlesets+numlotssets entries.

	===Notes===		=== Notes ===

	Do not skip an action2 using either action7 or action9 (unless those skip the whole file). Action2 must not be skipped or the patch will most likely crash. Skip or modify action3 instead.		Do not skip an action2 using either action7 or action9 (unless those skip the whole file). Action2 must not be skipped or the patch will most likely crash. Skip or modify action3 instead.

	==Example==		== Example ==

	<span style='color:#808080'>Something to go here</span>		<span style='color:#808080'>Something to go here</span>

Pm-bot: Bot: Automated text replacement (--= +==)

2011-06-14T23:05:18Z

Bot: Automated text replacement (--= +==)

← Older revision		Revision as of 23:05, 14 June 2011
Line 1:		Line 1:

		⚫	== Introduction ==
	'''''Defining station set-IDs'''''

	=Action 2=

	Defining station set-IDs.		Defining station set-IDs.

⚫	-=Introduction=-

	For stations, action 2 is used to define set-IDs, similar to the way it works for vehicles.		For stations, action 2 is used to define set-IDs, similar to the way it works for vehicles.

			==Syntax==
	-=Format=-

	For stations, the data looks as follows:		For stations, the data looks as follows:

	<~~pre> -+<~~Sprite-number~~>~~ * ~~<~~Length~~>~~ 02 04 ~~<~~set-id~~>~~ ~~<~~numlittlesets~~>~~ ~~<~~numlotssets~~>~~ ~~<~~sets...~~>+-</pre~~>		<Sprite-number> * <Length> 02 04 <set-id> <numlittlesets> <numlotssets> <sets...>

			{\|
	~~\|\|'''~~Element~~'''\|~~[[GRFActionsDetailed\|~~'''~~Size~~'''~~]]~~\|'''~~Description~~'''~~		!Element!![[GRFActionsDetailed\|Size]]!!Description

			\|-
	~~<~~Sprite-number~~>~~\|dec\|A sequential sprite number		\|<Sprite-number>\|\|dec\|\|A sequential sprite number

			\|-
	~~<~~length~~>~~\|dec\|The total number of bytes used in this action		\|<length>\|\|dec\|\|The total number of bytes used in this action

			\|-
	02\|B\|Defines action2		\|02\|\|B\|\|Defines action2

			\|-
	04\|B\|Stations is feature 4		\|04\|\|B\|\|Stations is feature 4

			\|-
	~~<~~set-id~~>~~\|B\|What set-ID this action2 defines		\|<set-id>\|\|B\|\|What set-ID this action2 defines

			\|-
	~~<~~numlittlesets~~>~~\|B\|How many different cargo amounts to show when there is little cargo		\|<numlittlesets>\|\|B\|\|How many different cargo amounts to show when there is little cargo

			\|-
	~~<~~numlotssets~~>~~\|B\|Same but when there is lots of cargo		\|<numlotssets>\|\|B\|\|Same but when there is lots of cargo

			\|-
	~~<~~sets...~~>~~\|W\|Sprite sets for each of the cargo amounts\|\|		\|<sets...>\|\|W\|\|Sprite sets for each of the cargo amounts
			\|}

			==Description==
	-=Filling in the terms=-

	===Sprite-number===		===Sprite-number===
Line 50:		Line 58:
	===numlittlesets, numlotssets===		===numlittlesets, numlotssets===

	Like for vehicles, this decides the graphics set to use depending on the amount of cargo waiting. ~~ ~~There are two caveats, though. ~~ ~~Firstly, a station can have 12 different cargoes waiting, not just a single one. ~~ ~~Secondly, the maximum amount is 4095 for all stations and all cargo types.		Like for vehicles, this decides the graphics set to use depending on the amount of cargo waiting. There are two caveats, though. Firstly, a station can have 12 different cargoes waiting, not just a single one. Secondly, the maximum amount is 4095 for all stations and all cargo types.

	Regarding the first issue, the amount of cargo this refers to depends on the action3 that triggered this action2:		Regarding the first issue, the amount of cargo this refers to depends on the action3 that triggered this action2:
	* if the cargo type matched exactly, it's the amount of the matching cargo (e.g. the action3 said ~~"~~for coal, use this action2~~"~~)		* if the cargo type matched exactly, it's the amount of the matching cargo (e.g. the action3 said "for coal, use this action2")
	* if the default was used, it's the amount of all cargo types added together		* if the default was used, it's the amount of all cargo types added together
	* if the station is displayed for construction, the maximum amount is shown		* if the station is displayed for construction, the maximum amount is shown

	Regarding the second issue, TTDPatch introduces the distinction between ~~"~~little~~"~~ and ~~"~~lots of~~"~~ cargo. ~~ ~~The amount where this occurs is set by property 10, which is zero by default. ~~ ~~But if set to a non-zero value, for example 200, then the range 0 to 199 is divided by numlittlesets, and the remaining range 200 to 4095 is divided by numlotssets. ~~ ~~If property 10 is zero, the ~~"~~little~~"~~ sets are never used, and so numlittlesets may be zero. ~~ ~~numlotssets must never be zero, however.		Regarding the second issue, TTDPatch introduces the distinction between "little" and "lots of" cargo. The amount where this occurs is set by property 10, which is zero by default. But if set to a non-zero value, for example 200, then the range 0 to 199 is divided by numlittlesets, and the remaining range 200 to 4095 is divided by numlotssets. If property 10 is zero, the "little" sets are never used, and so numlittlesets may be zero. numlotssets must never be zero, however.

	===sets===		===sets===
Line 63:		Line 71:
	The sets from the most recent action1 to use for this set-ID, for each stage of numlittlesets and numlotssets, i.e. in total numlittlesets+numlotssets entries.		The sets from the most recent action1 to use for this set-ID, for each stage of numlittlesets and numlotssets, i.e. in total numlittlesets+numlotssets entries.

	-=Notes=-		===Notes===

	Do not skip an action2 using either action7 or action9 (unless those skip the whole file). Action2 must not be skipped or the patch will most likely crash. Skip or modify action3 instead.		Do not skip an action2 using either action7 or action9 (unless those skip the whole file). Action2 must not be skipped or the patch will most likely crash. Skip or modify action3 instead.

	-=Example=-		==Example==

	<span style='color:#808080'>Something to go here</span>		<span style='color:#808080'>Something to go here</span>

Orudge: 7 revisions

2011-06-12T19:20:23Z

7 revisions

← Older revision	Revision as of 19:20, 12 June 2011
(No difference)

Orudge: 6 revisions

2011-06-12T19:02:00Z

6 revisions

New page

'''''Defining station set-IDs'''''

=Action 2=

Defining station set-IDs.

-=Introduction=-

For stations, action 2 is used to define set-IDs, similar to the way it works for vehicles.

-=Format=-

For stations, the data looks as follows:

<pre> -+<Sprite-number> * <Length> 02 04 <set-id> <numlittlesets> <numlotssets> <sets...>+-</pre>

||'''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 action2

04|B|Stations is feature 4

<set-id>|B|What set-ID this action2 defines

<numlittlesets>|B|How many different cargo amounts to show when there is little cargo

<numlotssets>|B|Same but when there is lots of cargo

<sets...>|W|Sprite sets for each of the cargo amounts||

-=Filling in the terms=-

===Sprite-number===

This is just the number you are at.

===Length===

Count the number of bytes in this action.

===Set-id===

The set-ID that you want to define for this set. You can choose any value between 00 and FF, and you can reuse them within a grf file at a later point (if being equal to an existing set ID, the existing one is overwritten and the new one is used).

===numlittlesets, numlotssets===

Like for vehicles, this decides the graphics set to use depending on the amount of cargo waiting.  There are two caveats, though.  Firstly, a station can have 12 different cargoes waiting, not just a single one.  Secondly, the maximum amount is 4095 for all stations and all cargo types.

Regarding the first issue, the amount of cargo this refers to depends on the action3 that triggered this action2:
* if the cargo type matched exactly, it's the amount of the matching cargo (e.g. the action3 said "for coal, use this action2")
* if the default was used, it's the amount of all cargo types added together
* if the station is displayed for construction, the maximum amount is shown

Regarding the second issue, TTDPatch introduces the distinction between "little" and "lots of" cargo.  The amount where this occurs is set by property 10, which is zero by default.  But if set to a non-zero value, for example 200, then the range 0 to 199 is divided by numlittlesets, and the remaining range 200 to 4095 is divided by numlotssets.  If property 10 is zero, the "little" sets are never used, and so numlittlesets may be zero.  numlotssets must never be zero, however.

===sets===

The sets from the most recent action1 to use for this set-ID, for each stage of numlittlesets and numlotssets, i.e. in total numlittlesets+numlotssets entries.

-=Notes=-

Do not skip an action2 using either action7 or action9 (unless those skip the whole file). Action2 must not be skipped or the patch will most likely crash. Skip or modify action3 instead.

-=Example=-

<span style='color:#808080'>Something to go here</span>