Callback: Custom cargo production - Revision history

Adf88: /* Custom cargo production (2E) */ Link to house production algorithm description on Action0/Houses page.

2014-08-31T12:00:07Z

Custom cargo production (2E): Link to house production algorithm description on Action0/Houses page.

← Older revision		Revision as of 12:00, 31 August 2014
Line 7:		Line 7:
	During the callback, the lowest byte of variable 10 contains the number of iterations happened so far and variable 18 contains a		During the callback, the lowest byte of variable 10 contains the number of iterations happened so far and variable 18 contains a
	random value to help randomizing the production. (The old code randomizes production to make it look more natural, you can do the		random value to help randomizing the production. (The old code randomizes production to make it look more natural, you can do the
			same via a VarAction2 with nvar=0). Original passenger/mail generation algorithm is described [[Action0/Houses#Population_.280B.29_and_Mail_generation_multiplier_.280C.29\|here]].
	same via a VarAction2 with nvar=0)

	This is how the original passenger generation is done: In each periodic processing (i.e. every 256 ticks), a random value 0<=X<=255
	is generated for each house tile. If X isn't smaller than the population of the tile, no passengers are generated. Otherwise, X/8+1
	passengers are generated (rounded down). If there is a recession going on, the number of generated passengers is halved, but this
	division gets rounded up instead of down. Mail generation happens in a similar manner, but with a new random value, and checking
	against the mail generation multiplier instead of the population.

	Uses 15 return bits.		Uses 15 return bits.

Frosch: use new grf templates

2012-04-01T13:27:23Z

use new grf templates

← Older revision		Revision as of 13:27, 1 April 2012
Line 17:		Line 17:
	Uses 15 return bits.		Uses 15 return bits.

	{{~~grf~~\|7}} From GRF version 7 and above, the interpretation of the high byte in the returned value changes: instead of a climate-dependent		{{grfFrom\|7}} From GRF version 7 and above, the interpretation of the high byte in the returned value changes: instead of a climate-dependent
	cargo slot number, you have to return a climate-independent cargo ID. If your GRF has a cargo translation table, then this ID		cargo slot number, you have to return a climate-independent cargo ID. If your GRF has a cargo translation table, then this ID
	is the index in that table; otherwise, it's the cargo bit. Trying to produce a cargo not currently present is not an error, but will be ignored.		is the index in that table; otherwise, it's the cargo bit. Trying to produce a cargo not currently present is not an error, but will be ignored.

Michi cc: formatting

2011-07-25T20:53:22Z

formatting

← Older revision		Revision as of 20:53, 25 July 2011
Line 17:		Line 17:
	Uses 15 return bits.		Uses 15 return bits.

	{{grf\|7}}From GRF version 7 and above, the interpretation of the high byte in the returned value changes: instead of a climate-dependent		{{grf\|7}} From GRF version 7 and above, the interpretation of the high byte in the returned value changes: instead of a climate-dependent
	cargo slot number, you have to return a climate-independent cargo ID. If your GRF has a cargo translation table, then this ID		cargo slot number, you have to return a climate-independent cargo ID. If your GRF has a cargo translation table, then this ID
	is the index in that table; otherwise, it's the cargo bit. Trying to produce a cargo not currently present is not an error, but will be ignored.		is the index in that table; otherwise, it's the cargo bit. Trying to produce a cargo not currently present is not an error, but will be ignored.

Michi cc: /* Custom cargo production (2E) */ GRF version icon

2011-07-23T17:06:28Z

Custom cargo production (2E): GRF version icon

← Older revision		Revision as of 17:06, 23 July 2011
Line 15:		Line 15:
	against the mail generation multiplier instead of the population.		against the mail generation multiplier instead of the population.

	Uses 15 return bits		Uses 15 return bits.

	From GRF version 7 and above, the interpretation of the high byte in the returned value changes: instead of a climate-dependent		{{grf\|7}}From GRF version 7 and above, the interpretation of the high byte in the returned value changes: instead of a climate-dependent
	cargo slot number, you have to return a climate-independent cargo ID. If your GRF has a cargo translation table, then this ID		cargo slot number, you have to return a climate-independent cargo ID. If your GRF has a cargo translation table, then this ID
	is the index in that table; otherwise, it's the cargo bit. Trying to produce a cargo not currently present is not an error, but will be ignored.		is the index in that table; otherwise, it's the cargo bit. Trying to produce a cargo not currently present is not an error, but will be ignored.

Pm-bot: Bot: Automated text replacement (-variational action 2 +VarAction2)

2011-06-19T16:33:05Z

Bot: Automated text replacement (-variational action 2 +VarAction2)

← Older revision		Revision as of 16:33, 19 June 2011
Line 7:		Line 7:
	During the callback, the lowest byte of variable 10 contains the number of iterations happened so far and variable 18 contains a		During the callback, the lowest byte of variable 10 contains the number of iterations happened so far and variable 18 contains a
	random value to help randomizing the production. (The old code randomizes production to make it look more natural, you can do the		random value to help randomizing the production. (The old code randomizes production to make it look more natural, you can do the
	same via a ~~variational action 2~~ with nvar=0)		same via a VarAction2 with nvar=0)

	This is how the original passenger generation is done: In each periodic processing (i.e. every 256 ticks), a random value 0<=X<=255		This is how the original passenger generation is done: In each periodic processing (i.e. every 256 ticks), a random value 0<=X<=255

Pm-bot: Create a separate page for each callback

2011-06-16T18:58:03Z

Create a separate page for each callback

New page

== Custom cargo production (2E) ==

This callback can be used to customize cargo production of house tiles. It is called every 256 ticks when the tile can produce cargo.
Because a tile can produce many types of cargo, this callback is called in a loop until it returns 20FFh (the loop count is limited
to 256 to avoid endless loops). If the returned value is not 20FFh, the high byte must be a cargo type and the low byte must be the
amount to be distributed. You can return a cargo type more than once if needed, so you can distribute more than 255 units from it.
During the callback, the lowest byte of variable 10 contains the number of iterations happened so far and variable 18 contains a
random value to help randomizing the production. (The old code randomizes production to make it look more natural, you can do the
same via a variational action 2 with nvar=0)

This is how the original passenger generation is done: In each periodic processing (i.e. every 256 ticks), a random value 0<=X<=255
is generated for each house tile. If X isn't smaller than the population of the tile, no passengers are generated. Otherwise, X/8+1
passengers are generated (rounded down). If there is a recession going on, the number of generated passengers is halved, but this
division gets rounded up instead of down. Mail generation happens in a similar manner, but with a new random value, and checking
against the mail generation multiplier instead of the population.

Uses 15 return bits

From GRF version 7 and above, the interpretation of the high byte in the returned value changes: instead of a climate-dependent
cargo slot number, you have to return a climate-independent cargo ID. If your GRF has a cargo translation table, then this ID
is the index in that table; otherwise, it's the cargo bit. Trying to produce a cargo not currently present is not an error, but will be ignored.
[[Category:Callbacks]]