GrfLoadingStages - Revision history

Frosch: version tags

2011-07-23T14:26:43Z

version tags

← Older revision		Revision as of 14:26, 23 July 2011
Line 18:		Line 18:

	\|-		\|-
	\|Reserve\|\|Called just before activation, to reserve GRM IDs. Also applies action 0 for cargos to make cargo labels valid to check in action 7/9 independent of order of .grf files. Ignores all actions except action 0 (for cargos), 6, 7, 8, 9, B, D and E.		\|Reserve\|\|{{ottdp\|0.6\|2.5}} Called just before activation, to reserve GRM IDs. Also applies action 0 for cargos to make cargo labels valid to check in action 7/9 independent of order of .grf files. Ignores all actions except action 0 (for cargos), 6, 7, 8, 9, B, D and E.

	\|-		\|-
Line 24:		Line 24:

	\|-		\|-
	\|Test\|\|Called when user clicks to enable/disable file in the GRF Status Window to check which other files react to the change. Ignores all actions except 6, 7, 8, 9, B, D and E.		\|Test\|\|{{ottdp\|no\|2.5}} Called when user clicks to enable/disable file in the GRF Status Window to check which other files react to the change. Ignores all actions except 6, 7, 8, 9, B, D and E.
	\|}		\|}

Frosch: use real footnotes

2011-07-23T14:14:01Z

use real footnotes

← Older revision		Revision as of 14:14, 23 July 2011
Line 35:		Line 35:

	\|-		\|-
	\|0\|\| \|\|<center>X</center>\|\|<center>X*<~~/center~~>~~\|\|<center>X</center>\|\| \|\|~~During reservation stage especially cargo- and railtypes are reserved, so their existence can be tested by all GRFs in activation stage independent of loading order.		\|0\|\| \|\|<center>X</center>\|\|<center>X<ref>During reservation stage especially cargo- and railtypes are reserved, so their existence can be tested by all GRFs in activation stage independent of loading order.</ref></center>\|\|<center>X</center>\|\| \|\|

	\|-		\|-
Line 53:		Line 53:

	\|-		\|-
	\|6\|\| \|\|<center>X</center>\|\|<center>X</center>\|\|<center>X*<~~/center~~>~~\|\|<center>X</center>\|\|~~{{ottdp\|0.6\|2.5\|ttdprev=2.0.1 alpha 51}} Processed during activation in ~~a51~~ and later.		\|6\|\| \|\|<center>X</center>\|\|<center>X</center>\|\|<center>X<ref>{{ottdp\|0.6\|2.5\|ttdprev=2.0.1 alpha 51}} Processed during activation in TTDPatch 2.0.1 alpha 51 and later.</ref></center>\|\|<center>X</center>\|\|

	\|-		\|-
Line 68:		Line 68:

	\|-		\|-
	\|B\|\| \|\|<center>X*</center>\|\|<center>X</center>\|\|<center>X</center>\|\|<center>X</center>\|\|~~Processed during initialization only if bit 7 of severity is set.~~		\|B\|\| \|\|<center>X<ref>Processed during initialization only if bit 7 of severity is set.</ref></center>\|\|<center>X</center>\|\|<center>X</center>\|\|<center>X</center>\|\|

	\|-		\|-
Line 97:		Line 97:
	\|14\|\| \|\| \|\| \|\| \|\| \|\| Processed by OpenTTD only when scanning for files. Not processed during the normal loading/activation.		\|14\|\| \|\| \|\| \|\| \|\| \|\| Processed by OpenTTD only when scanning for files. Not processed during the normal loading/activation.
	\|}		\|}
			<references/>

Frosch: version tags

2011-07-23T14:09:09Z

version tags

← Older revision		Revision as of 14:09, 23 July 2011
Line 53:		Line 53:

	\|-		\|-
	\|6\|\| \|\|<center>X</center>\|\|<center>X</center>\|\|<center>X*</center>\|\|<center>X</center>\|\|Processed during activation in a51 and later.		\|6\|\| \|\|<center>X</center>\|\|<center>X</center>\|\|<center>X*</center>\|\|<center>X</center>\|\|{{ottdp\|0.6\|2.5\|ttdprev=2.0.1 alpha 51}} Processed during activation in a51 and later.

	\|-		\|-

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

2011-06-14T23:42:14Z

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

Show changes

Orudge: 7 revisions

2011-06-12T19:23:34Z

7 revisions

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

Orudge: 6 revisions

2011-06-12T19:08:51Z

6 revisions

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

Frosch at 19:42, 17 March 2011

2011-03-17T19:42:09Z

← Older revision		Revision as of 19:42, 17 March 2011
Line 26:		Line 26:
	\|\|Action\|Load\|Init\|Res\|Act\|Test\|Notes		\|\|Action\|Load\|Init\|Res\|Act\|Test\|Notes

	0\| \|<center>X</center>\|<center>X*</center>\|<center>X</center>\| \|During reservation stage especially cargo and ~~railtype~~ are reserved, so their ~~existance~~ can be tested by all GRFs in activation stage independent of loading order.		0\| \|<center>X</center>\|<center>X*</center>\|<center>X</center>\| \|During reservation stage especially cargo- and railtypes are reserved, so their existence can be tested by all GRFs in activation stage independent of loading order.

	1\| \|<center>I</center>\| \|<center>X</center>\| \|		1\| \|<center>I</center>\| \|<center>X</center>\| \|

Frosch at 19:41, 17 March 2011

2011-03-17T19:41:09Z

← Older revision		Revision as of 19:41, 17 March 2011
Line 26:		Line 26:
	\|\|Action\|Load\|Init\|Res\|Act\|Test\|Notes		\|\|Action\|Load\|Init\|Res\|Act\|Test\|Notes

	0\| \|<center>X</center>\|<center>X*</center>\|<center>X</center>\| \|~~Only~~ cargo ~~action~~ 0 ~~applied~~ ~~during~~ ~~reservation~~ ~~pass~~.		0\| \|<center>X</center>\|<center>X*</center>\|<center>X</center>\| \|During reservation stage especially cargo and railtype are reserved, so their existance can be tested by all GRFs in activation stage independent of loading order.

	1\| \|<center>I</center>\| \|<center>X</center>\| \|		1\| \|<center>I</center>\| \|<center>X</center>\| \|

Frosch at 17:20, 6 January 2011

2011-01-06T17:20:13Z

New page

'''''Stages of loading a GRF file'''''

=The stages of loading a grf file=

Processing of .grf files is done in several passes, most of which happen repeatedly, once per activations, which is whenever a game is started/loaded or the "Apply" button in the GRF Status Window is pressed. Each pass processes all files in the order they appear in the GRF Status Window.

Essentially, initialization is a two-pass system (first resolve jump targets, then initialize everything) that happens only once, activation is a two-pass system (first define cargos and reserve GRM IDs, then activate) that happens multiple times, and testing is a one-pass system run per click on a red/green flag in the GRF Status Window.

||Pass|Description

Post-Load|Run once after loading all files. Initializes the targets of action 7&9 (to resolve goto jumps), ignores all other actions.

Initialization|Run once after the post-load pass. Checks action 0 for validity, records action 1 sprite numbers, resolves action 2 references (to the sprite numbers within the grf file of action 1 sprites and references to variational/random action 2), executes actions 6, 9, B, D and F, initializes action 3, 4, 8 and 11, and ignores the rest of the actions (including in particular action 7).

Reserve|Called just before activation, to reserve GRM IDs. Also applies action 0 for cargos to make cargo labels valid to check in action 7/9 independent of order of .grf files. Ignores all actions except action 0 (for cargos), 6, 7, 8, 9, B, D and E.

Activate|Called during activation. Applies all actions except F and 10.

Test|Called when user clicks to enable/disable file in the GRF Status Window to check which other files react to the change. Ignores all actions except 6, 7, 8, 9, B, D and E.||

A .grf file is activated only if it was active when the game was started. If a game is loaded, only its active .grfs will be reactivated. A .grf file is considered active if its action 8 has been processed, i.e. its action 8 hasn't been skipped using an action 7.

The following table shows exactly which actions are excuted in which passes (X=action executed, I=action initialized, empty=action ignored).

||Action|Load|Init|Res|Act|Test|Notes

0| |<center>X</center>|<center>X*</center>|<center>X</center>| |Only cargo action 0 applied during reservation pass.

1| |<center>I</center>| |<center>X</center>| |

2| |<center>I</center>| |<center>X</center>| |

3| |<center>I</center>| |<center>X</center>| |

4| |<center>I</center>| |<center>X</center>| |

5| | | |<center>X</center>| |

6| |<center>X</center>|<center>X</center>|<center>X*</center>|<center>X</center>|Processed during activation in a51 and later.

7|<center>I</center>| |<center>X</center>|<center>X</center>|<center>X</center>|

8| |<center>I</center>|<center>X</center>|<center>X</center>|<center>X</center>|When executed for an inactive file, skips remainder of file.

9|<center>I</center>|<center>X</center>|<center>X</center>|<center>X</center>|<center>X</center>|

A| | | |<center>X</center>| |

B| |<center>X*</center>|<center>X</center>|<center>X</center>|<center>X</center>|Processed during initialization only if bit 7 of severity is set.

C| | | | | |

D| |<center>X</center>|<center>X</center>|<center>X</center>|<center>X</center>|

E| | |<center>X</center>|<center>X</center>|<center>X</center>|

F| |<center>X</center>| | | |

10|<center>X</center>| | | | |

11| |<center>I</center>| |<center>X</center>| |

12| | | |<center>X</center>| | If TTDPatch encounters any Action12 during any stage (including "Load"), Unicode handling is enabled.

13| | | |<center>X</center>| |

14| | | | | | Processed by OpenTTD only when scanning for files. Not processed during the normal loading/activation. ||

dmccoy at 03:32, 17 November 2005

2005-11-17T03:32:08Z

New page

'''''Stages of loading a GRF file'''''

=The stages of loading a grf file=

('''WARNING:''' Some parts of this page are known to be incorrect.)

Every .grf file is processed in two stages. The first stage, initialization, is run only once. In this stage, TTDPatch records the GRF IDs, and resolves all cargo IDs and sprite IDs as well as doing some other bookkeeping tasks.

During initialization, actions 3, 4, 5, 7, and E are ignored. Action 7 is ignored because otherwise the sprite IDs and cargo IDs that are skipped won't be resolved. Action 8 has the GRF ID recorded so that it can be looked up later.

During activation, actions 1, 2, F, 10, and 11 are ignored, because they only need to be processed once at initialization.

Action C is always ignored.

A .grf file is activated only if it was active when the game was started. If a game is loaded, only its active .grfs will be reactivated, unless "[[NewVehicleGraphics|loadallgraphics]] on" is used. A .grf file is considered active if its action 8 has been processed, i.e. its action 8 hasn't been skipped using an action 7.

This table shows exactly which actions are processed when.

||Action|Init|Activate|Notes

0|*|Yes|Processed during initialization for features 05, 07, 09, and 0A only

1|Yes|No|

2|Yes|No|

3|No|Yes|

4|Yes|Yes|

5|Yes|Yes|

6|Yes|*|Processed during activation in a51 and later.

7|No|Yes|

8|Yes|Yes|

9|Yes|Yes|

A|No|Yes|

B|*|Yes|Processed during initialization only if bit 7 of severity is set.

C|No|No|

D|Yes|Yes|

E|No|Yes|

F|Yes|No|

10|Yes|No|

11|Yes|No| ||