Action2/Industries - Revision history

Frosch: use proper version template

2018-11-04T12:09:20Z

use proper version template

← Older revision		Revision as of 12:09, 4 November 2018
Line 109:		Line 109:

	=== Format version 02 ===		=== Format version 02 ===
	{{ottdp\|1.9\|no\|e66cec8f}}		{{ottdp\|1.9\|no\|ottdrev=e66cec8f}}

	<pre> <Sprite-number> * <Length> 02 0A <set-id> <version> <numinputs> (<inputcargo> <subtract-in>)* <numoutputs> (<outputcargo> <add-out>)* <again> </pre>		<pre> <Sprite-number> * <Length> 02 0A <set-id> <version> <numinputs> (<inputcargo> <subtract-in>)* <numoutputs> (<outputcargo> <add-out>)* <again> </pre>
Line 185:		Line 185:
	{{ottdp\|0.6\|2.6\|ttdprev=r1307}} Using the version 1 format, available since TTDPatch 2.6 r1307, you can decide the instructions dynamically. Instead of constants, you give register numbers that contain the needed values; you can compute these values earlier in the action2 chain. Registers are 4 bytes long and are considered to be signed. Negative add-out values don't make sense and are ignored. The results are clamped to the allowed range (0..65535 for both incoming and outgoing cargo amounts).		{{ottdp\|0.6\|2.6\|ttdprev=r1307}} Using the version 1 format, available since TTDPatch 2.6 r1307, you can decide the instructions dynamically. Instead of constants, you give register numbers that contain the needed values; you can compute these values earlier in the action2 chain. Registers are 4 bytes long and are considered to be signed. Negative add-out values don't make sense and are ignored. The results are clamped to the allowed range (0..65535 for both incoming and outgoing cargo amounts).

	{{ottdp\|1.9\|no\|e66cec8f}} Using the version 2 format, you can list more input and output cargos than in version 1. The cargo types are specified according to the cargo translation table; the amounts are specified via registers as in version 1. Listed cargo types which are not accepted/produced by the industry (properties 10..11, 25..26, callback 14B..14C) are ignored.		{{ottdp\|1.9\|no\|ottdrev=e66cec8f}} Using the version 2 format, you can list more input and output cargos than in version 1. The cargo types are specified according to the cargo translation table; the amounts are specified via registers as in version 1. Listed cargo types which are not accepted/produced by the industry (properties 10..11, 25..26, callback 14B..14C) are ignored.
	* You do not need to list all cargo types produced/accepted by the industry. Amounts for unlisted cargo types remain unchanged.		* You do not need to list all cargo types produced/accepted by the industry. Amounts for unlisted cargo types remain unchanged.
	* You can include more cargo types than actually produced/accepted (for example when callback 14B..14C selected a subset of cargos). Excess items are ignored.		* You can include more cargo types than actually produced/accepted (for example when callback 14B..14C selected a subset of cargos). Excess items are ignored.

Frosch: add version 2

2018-11-04T01:18:14Z

add version 2

@@ Line 108: / Line 108: @@
 |}
-== Details ==
+=== Format version 02 ===
 The total amount of cargo waiting cannot go negative. &nbsp;If you specify more than the amount actually waiting, the incoming amount will be zeroed instead. You can use negative subtract-in values to increase the amount of cargo waiting.
@@ Line 121: / Line 184: @@
 {{ottdp|0.6|2.6|ttdprev=r1307}} Using the version 1 format, available since TTDPatch 2.6 r1307, you can decide the instructions dynamically. Instead of constants, you give register numbers that contain the needed values; you can compute these values earlier in the action2 chain. Registers are 4 bytes long and are considered to be signed. Negative add-out values don't make sense and are ignored. The results are clamped to the allowed range (0..65535 for both incoming and outgoing cargo amounts).

Frosch: version tags

2011-08-15T15:24:14Z

version tags

← Older revision		Revision as of 15:24, 15 August 2011
Line 1:		Line 1:
	'''''Defining the industry production callback'''''

	= Industry Production Callback =		= Industry Production Callback =

	Defining the industry production callback

	Industries don't have graphics directly associated with them (they have graphics through their tiles), so they can't have a traditional action 2. However, they still can use action 2 for a special purpose: production callbacks. A production callback can define exactly how an industry is producing cargo, but this needs more than the 15 bits a normal callback can return.		Industries don't have graphics directly associated with them (they have graphics through their tiles), so they can't have a traditional action 2. However, they still can use action 2 for a special purpose: production callbacks. A production callback can define exactly how an industry is producing cargo, but this needs more than the 15 bits a normal callback can return.
Line 15:		Line 11:
	For the production callback, the action 2 data looks as follows:		For the production callback, the action 2 data looks as follows:

			=== Format version 00 ===
	Version 0:

	<pre> <Sprite-number> * <Length> 02 0A <set-id> <version> <subtract-in-1> <subtract-in-2> <subtract-in-3> <add-out-1> <add-out-2> <again> </pre>		<pre> <Sprite-number> * <Length> 02 0A <set-id> <version> <subtract-in-1> <subtract-in-2> <subtract-in-3> <add-out-1> <add-out-2> <again> </pre>
Line 59:		Line 55:
	\|<again>		\|<again>
	\|B		\|B
	\|~~(before TTDPatch 2.0.1 alpha 73)~~ Repeat callback if 01, do not repeat if 00 ~~(after~~ TTDPatch 2.0.1 alpha 73) ~~Repeat~~ ~~callback~~ if ~~nonzero,~~ do ~~not~~ ~~repeat if~~ 00		\|Repeat callback if nonzero, do not repeat if 00. <ref>Before TTDPatch 2.0.1 alpha 73 the only valid values were 01 and 00.</ref>
	\|}		\|}
			<references/>

			=== Format version 01 ===
	Version 1 (available since r1307):
			{{ottdp\|0.6\|2.6\|ttdprev=r1307}}

	<pre> <Sprite-number> * <Length> 02 0A <set-id> <version> <subtract-in-1> <subtract-in-2> <subtract-in-3> <add-out-1> <add-out-2> <again> </pre>		<pre> <Sprite-number> * <Length> 02 0A <set-id> <version> <subtract-in-1> <subtract-in-2> <subtract-in-3> <add-out-1> <add-out-2> <again> </pre>
Line 118:		Line 116:
	During this callback, the lowest byte of variable 18 contains the reason the callback is called: 0 if it was called because of incoming cargo, 1 if it was called in the periodic processing. Bits 8-23 contain how many times the callback was already called in this loop, i.e. 0 for the first call, 1 for the second etc.)		During this callback, the lowest byte of variable 18 contains the reason the callback is called: 0 if it was called because of incoming cargo, 1 if it was called in the periodic processing. Bits 8-23 contain how many times the callback was already called in this loop, i.e. 0 for the first call, 1 for the second etc.)

	For TTDPatch 2.0.1 alpha 73 and above, bits 24-31 of variable 18 contain the <again> value of the previous call (the lowest byte only in case of version 1), or 0 if this is the first call. This can be used to have state information during the loop since you can pass information to the next iteration.		{{ottdp\|0.6\|2.5\|ttdprev=2.0.1 alpha 73}} For TTDPatch 2.0.1 alpha 73 and above, bits 24-31 of variable 18 contain the <again> value of the previous call (the lowest byte only in case of version 1), or 0 if this is the first call. This can be used to have state information during the loop since you can pass information to the next iteration.

	Since TTDPatch 2.5 beta 5, you can request some random bits in variable 10 by setting bit 15 of property 1A. These bits won't be re-randomized when you call the callback again by setting a non-zero "again" value; they're randomized only for the first call.		{{ottdp\|0.6\|2.5\|ttdprev=2.5 beta 5}} Since TTDPatch 2.5 beta 5, you can request some random bits in variable 10 by setting bit 15 of property 1A. These bits won't be re-randomized when you call the callback again by setting a non-zero "again" value; they're randomized only for the first call.

	Using the version 1 format, ~~aviailable~~ since TTDPatch 2.6 r1307, you can decide the instructions dynamically. Instead of constants, you give register numbers that contain the needed values; you can compute these values earlier in the action2 chain. Registers are 4 bytes long and are considered to be signed. Negative add-out values don't make sense and are ignored. The results are clamped to the allowed range (0..65535 for both incoming and outgoing cargo amounts).		{{ottdp\|0.6\|2.6\|ttdprev=r1307}} Using the version 1 format, available since TTDPatch 2.6 r1307, you can decide the instructions dynamically. Instead of constants, you give register numbers that contain the needed values; you can compute these values earlier in the action2 chain. Registers are 4 bytes long and are considered to be signed. Negative add-out values don't make sense and are ignored. The results are clamped to the allowed range (0..65535 for both incoming and outgoing cargo amounts).

Frosch: moved Action2Industries to Action2/Industries: use subpages

2011-06-17T21:12:38Z

moved Action2Industries to Action2/Industries: use subpages

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

Pm-bot: Bot: Automated text replacement (- 2.0 + TTDPatch 2.0)

2011-06-15T17:28:43Z

Bot: Automated text replacement (- 2.0 + TTDPatch 2.0)

← Older revision		Revision as of 17:28, 15 June 2011
Line 59:		Line 59:
	\|<again>		\|<again>
	\|B		\|B
	\|(before 2.0.1 alpha 73) Repeat callback if 01, do not repeat if 00 (after 2.0.1 alpha 73) Repeat callback if nonzero, do not repeat if 00		\|(before TTDPatch 2.0.1 alpha 73) Repeat callback if 01, do not repeat if 00 (after TTDPatch 2.0.1 alpha 73) Repeat callback if nonzero, do not repeat if 00
	\|}		\|}

Pm-bot: Beautify wiki markup

2011-06-15T14:47:42Z

Beautify wiki markup

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

	'''''Defining the industry production callback'''''		'''''Defining the industry production callback'''''

	=Industry Production Callback=		= Industry Production Callback =

	Defining the industry production callback		Defining the industry production callback
Line 12:		Line 11:
	The production callback is handled in an action 2 chain.  Typically there will be a sub-chain of multiple varaction 2s for logic before the final varaction 2 handling the production cb.  The ID of the first varaction 2 in the subchain should be handled explicitly by a check for production cb using var 0C.  Do not rely on handling production cb sub-chain as default ID for the varaction 2 checking 0C, this can have unexpected results.  However the ID of the varaction 2 handling the production cb itself should be the default ID for the 0C check.  Makes sense?		The production callback is handled in an action 2 chain.  Typically there will be a sub-chain of multiple varaction 2s for logic before the final varaction 2 handling the production cb.  The ID of the first varaction 2 in the subchain should be handled explicitly by a check for production cb using var 0C.  Do not rely on handling production cb sub-chain as default ID for the varaction 2 checking 0C, this can have unexpected results.  However the ID of the varaction 2 handling the production cb itself should be the default ID for the 0C check.  Makes sense?

	==Format==		== Format ==

	For the production callback, the action 2 data looks as follows:		For the production callback, the action 2 data looks as follows:
Line 111:		Line 110:
	\|}		\|}

	==Details==		== Details ==

	===Subtract-in-1..3===		=== Subtract-in-1..3 ===

	The total amount of cargo waiting cannot go negative.  If you specify more than the amount actually waiting, the incoming amount will be zeroed instead. You can use negative subtract-in values to increase the amount of cargo waiting.		The total amount of cargo waiting cannot go negative.  If you specify more than the amount actually waiting, the incoming amount will be zeroed instead. You can use negative subtract-in values to increase the amount of cargo waiting.
Line 121:		Line 120:
	For TTDPatch 2.0.1 alpha 73 and above, bits 24-31 of variable 18 contain the <again> value of the previous call (the lowest byte only in case of version 1), or 0 if this is the first call. This can be used to have state information during the loop since you can pass information to the next iteration.		For TTDPatch 2.0.1 alpha 73 and above, bits 24-31 of variable 18 contain the <again> value of the previous call (the lowest byte only in case of version 1), or 0 if this is the first call. This can be used to have state information during the loop since you can pass information to the next iteration.

	Since TTDPatch 2.5 beta 5, you can request some random bits in variable 10 by setting bit 15 of property 1A. These bits won't be re-randomized when you call the callback again by setting a non-zero ~~"~~again~~"~~ value; they're randomized only for the first call.		Since TTDPatch 2.5 beta 5, you can request some random bits in variable 10 by setting bit 15 of property 1A. These bits won't be re-randomized when you call the callback again by setting a non-zero "again" value; they're randomized only for the first call.

	Using the version 1 format, aviailable since TTDPatch 2.6 r1307, you can decide the instructions dynamically. Instead of constants, you give register numbers that contain the needed values; you can compute these values earlier in the action2 chain. Registers are 4 bytes long and are considered to be signed. Negative add-out values don't make sense and are ignored. The results are clamped to the allowed range (0..65535 for both incoming and outgoing cargo amounts).		Using the version 1 format, aviailable since TTDPatch 2.6 r1307, you can decide the instructions dynamically. Instead of constants, you give register numbers that contain the needed values; you can compute these values earlier in the action2 chain. Registers are 4 bytes long and are considered to be signed. Negative add-out values don't make sense and are ignored. The results are clamped to the allowed range (0..65535 for both incoming and outgoing cargo amounts).

Jvassie: Updated table syntax

2011-06-14T12:26:20Z

Updated table syntax

Show changes

Orudge: 7 revisions

2011-06-12T19:20:22Z

7 revisions

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

Orudge: 6 revisions

2011-06-12T19:01:59Z

6 revisions

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

Andythenorth at 15:15, 23 January 2011

2011-01-23T15:15:51Z

← Older revision		Revision as of 15:15, 23 January 2011
Line 9:		Line 9:

	When an industry has bits 1 or 2 set in property 21, its production is changed. Instead of processing the incoming cargo instantly, it remembers how many units are waiting, and uses the production callback mechanism to decide how much cargo must be produced.		When an industry has bits 1 or 2 set in property 21, its production is changed. Instead of processing the incoming cargo instantly, it remembers how many units are waiting, and uses the production callback mechanism to decide how much cargo must be produced.

			The production callback is handled in an action 2 chain.  Typically there will be a sub-chain of multiple varaction 2s for logic before the final varaction 2 handling the production cb.  The ID of the first varaction 2 in the subchain should be handled explicitly by a check for production cb using var 0C.  Do not rely on handling production cb sub-chain as default ID for the varaction 2 checking 0C, this can have unexpected results.  However the ID of the varaction 2 handling the production cb itself should be the default ID for the 0C check.  Makes sense?

	-=Format=-		-=Format=-