GlobalVariables - Revision history

Frosch: OpenTTD versioning schema changed with version 12

2023-06-27T19:48:32Z

OpenTTD versioning schema changed with version 12

@@ Line 289: / Line 289: @@
 === OpenTTD Version (21 / A1) ===
-Variable A1 has the following format: Mmrbbbbb (though encoded in little endian as bb bb rb Mm). This variable has only a usefull meaning when variable 9D is 1 (OpenTTD). This variable can be used since OpenTTD r11330.
+Variable A1 has the following format: MmrSbbbb (though encoded in little endian as bb bb rS Mm). This variable has only a usefull meaning when variable 9D is 1 (OpenTTD). This variable can be used since OpenTTD r11330.
 {|
 !Element!!Meaning!!Value
@@ Line 299: / Line 302: @@
 |r||revision||Third number of the OpenTTD version
 |-
 |}
 {|
 !Version!!Variable A1!!Elements
 |-
-|0.6.0 r11330||06002C42||M=0, m=6, r=0, bbbbb=11330=2C42
+|0.6.0 r11330||06002C42||M=0, m=6, r=0, S=0, bbbb=11330=0x2C42
 |-
-|0.6.0 (release)||06080000||M=0, m=6, r=0, bbbbb=0=80000 (due to release)
+|17.2 (release)||2128xxxx||Mm=16+17=0x21, r=2, S=8, bbbb=reserved
 |}

Andrew350: /* OpenTTD Version (21 / A1) */ fixed typo

2019-12-22T13:12:34Z

OpenTTD Version (21 / A1): fixed typo

← Older revision		Revision as of 13:12, 22 December 2019
Line 300:		Line 300:
	\|-		\|-
	\|bbbbb\|\|build\|\|Stable releases have 80000h set.		\|bbbbb\|\|build\|\|Stable releases have 80000h set.
	{{ottd\|≤1.8}} When OpenTTD was versioned using SVN the lower bits contained the SVN revision. Since OpenTTD 1.9 these bits ~~care~~ unused.		{{ottd\|≤1.8}} When OpenTTD was versioned using SVN the lower bits contained the SVN revision. Since OpenTTD 1.9 these bits are unused.
	\|}		\|}

Frosch: /* OpenTTD Version (21 / A1) */

2018-04-19T20:31:24Z

OpenTTD Version (21 / A1)

← Older revision		Revision as of 20:31, 19 April 2018
Line 299:		Line 299:
	\|r\|\|revision\|\|Third number of the OpenTTD version		\|r\|\|revision\|\|Third number of the OpenTTD version
	\|-		\|-
	\|bbbbb\|\|build\|\|~~Subversion~~ ~~revision~~ ~~of a build leading towards a release. When a final release is done~~ 80000h is set.		\|bbbbb\|\|build\|\|Stable releases have 80000h set.
			{{ottd\|≤1.8}} When OpenTTD was versioned using SVN the lower bits contained the SVN revision. Since OpenTTD 1.9 these bits care unused.
	\|}		\|}

Frosch: add misc grf feature bit 6

2015-03-20T19:30:38Z

add misc grf feature bit 6

← Older revision		Revision as of 19:30, 20 March 2015
Line 249:		Line 249:
	\|-		\|-
	\|5\|\|20\|\|{{ottdp\|no\|2.5/2.6\|ttdprev=r1439, will be in yet unreleased 2.5 beta 10}}\|\|Enable catenaries over the third track type (only with electrifiedrailway on)		\|5\|\|20\|\|{{ottdp\|no\|2.5/2.6\|ttdprev=r1439, will be in yet unreleased 2.5 beta 10}}\|\|Enable catenaries over the third track type (only with electrifiedrailway on)
			\|-
			\|6\|\|40\|\|{{ottdp\|1.5\|no\|ottdrev=r27200}}\|\|Enable usage of the second rocky tile set. (sprites 4042 to 4061)
	\|-		\|-
	\|31\|\|80000000\|\|{{ottdp\|no\|2.5}}\|\|Only to be set by ttdpbase(w).grf for identification		\|31\|\|80000000\|\|{{ottdp\|no\|2.5}}\|\|Only to be set by ttdpbase(w).grf for identification

Frosch: call refresh offsets historic content

2014-11-05T15:53:28Z

call refresh offsets historic content

← Older revision		Revision as of 15:53, 5 November 2014
Line 185:		Line 185:
	=== Tile refresh offsets (13,14,15,16 / 93,94,95,96) ===		=== Tile refresh offsets (13,14,15,16 / 93,94,95,96) ===

			These four variables belong to an experimental TTDPatch feature. However, their definition is based on an incomplete understanding of the drawing algorithm in TTD, so they actually do not achieve what they were meant to do. Consider this historic content.
⚫	These four offsets define the size and position of the rectangle refreshed when TTD decides to refresh a tile. The basis of the calculations is the pixel coordinate of the north corner of the tile.

			{{ottdp\|no\|2.5\|ttdprev=2.0.1 alpha 39}}
⚫	After calculating it, TTD subtracts offset_left from it to get the x coordinate of the left edge, adds offset_right to get the x coordinate of the right edge, subtracts offset_up to get the y coordinate of the top edge and adds offset_down to get the y coordinate of the bottom edge. This results in refreshing (offset_left+offset_right)*(offset_up+offset_down) pixels. The default values of these variables are 31, 36, 122 and 32, respectively.

		⚫	''These four offsets define the size and position of the rectangle refreshed when TTD decides to refresh a tile. The basis of the calculations is the pixel coordinate of the north corner of the tile.''
⚫	Reading these values is not too useful, but you can modify them using action D as well, so your sprites that would exceed the original limits can still be redrawn and animated properly. Please note that TTD uses these values for every tile, so specifying too high values may slow the game down. Please also note that these variables are specified as dwords for technical reasons, but only the bottom word will be used.

		⚫	''After calculating it, TTD subtracts offset_left from it to get the x coordinate of the left edge, adds offset_right to get the x coordinate of the right edge, subtracts offset_up to get the y coordinate of the top edge and adds offset_down to get the y coordinate of the bottom edge. This results in refreshing (offset_left+offset_right)*(offset_up+offset_down) pixels. The default values of these variables are 31, 36, 122 and 32, respectively.''
⚫	Since these values are global to the entire game, you shouldn't just overwrite them with an action D. Instead, you should first check if they're big enough for you by using action 7, and skip your action D if they are. This way, the variables will be set to the maximal value needed, not just the value needed for the last grf in the list.

		⚫	''Reading these values is not too useful, but you can modify them using action D as well, so your sprites that would exceed the original limits can still be redrawn and animated properly. Please note that TTD uses these values for every tile, so specifying too high values may slow the game down. Please also note that these variables are specified as dwords for technical reasons, but only the bottom word will be used.''

		⚫	''Since these values are global to the entire game, you shouldn't just overwrite them with an action D. Instead, you should first check if they're big enough for you by using action 7, and skip your action D if they are. This way, the variables will be set to the maximal value needed, not just the value needed for the last grf in the list.''

	=== Snow line height (- / 97) ===		=== Snow line height (- / 97) ===

Michi cc: /* Misc. GRF Features (1E / 9E) */ Ambient sound effects are support by OTTD for some time now.

2012-07-08T18:49:58Z

Misc. GRF Features (1E / 9E): Ambient sound effects are support by OTTD for some time now.

← Older revision		Revision as of 18:49, 8 July 2012
Line 242:		Line 242:
	\|3\|\|8\|\|{{ottdp\|0.6\|2.5}}\|\|Display train vehicles with full width of 32 pixels in depot window (instead of 29 pixels)<ref>Since {{ottdp\|1.0\|no\|ottdrev=r16867}} this flag works per grf file, that is: It only affects trains defined in the same GRF.</ref>		\|3\|\|8\|\|{{ottdp\|0.6\|2.5}}\|\|Display train vehicles with full width of 32 pixels in depot window (instead of 29 pixels)<ref>Since {{ottdp\|1.0\|no\|ottdrev=r16867}} this flag works per grf file, that is: It only affects trains defined in the same GRF.</ref>
	\|-		\|-
	\|4\|\|10\|\|{{ottdp\|no\|2.6\|ttdprev=r821}}\|\|Enable ambient sound effect callback 144		\|4\|\|10\|\|{{ottdp\|1.2\|2.6\|ottdrev=r23114\|ttdprev=r821}}\|\|Enable ambient sound effect callback 144
	\|-		\|-
	\|5\|\|20\|\|{{ottdp\|no\|2.5/2.6\|ttdprev=r1439, will be in yet unreleased 2.5 beta 10}}\|\|Enable catenaries over the third track type (only with electrifiedrailway on)		\|5\|\|20\|\|{{ottdp\|no\|2.5/2.6\|ttdprev=r1439, will be in yet unreleased 2.5 beta 10}}\|\|Enable catenaries over the third track type (only with electrifiedrailway on)

Michi cc: /* Extra callback info (10 / -) and (18 / -) */ Custom signal graphics

2012-07-01T23:37:16Z

Extra callback info (10 / -) and (18 / -): Custom signal graphics

← Older revision		Revision as of 23:37, 1 July 2012
Line 180:		Line 180:
	\| Stations \|\| Used to compose station tiles with sprites from different Action-1-2-3 chains, or to draw custom foundations. See [[Action0/Stations#General_Flags_.2813.29\|General station flags]] and [[AdvancedSpriteLayout]].		\| Stations \|\| Used to compose station tiles with sprites from different Action-1-2-3 chains, or to draw custom foundations. See [[Action0/Stations#General_Flags_.2813.29\|General station flags]] and [[AdvancedSpriteLayout]].
	\|-		\|-
	\| Railtypes \|\| Used to distinguish between the type of tunnel portal requested, ~~see~~ [[Action3/Railtypes#Tunnel_portal_overlay_.280A.29\|Railtype tunnel portal overlay]] for details.		\| Railtypes \|\| Used to distinguish between the type of tunnel portal or signal requested. See [[Action3/Railtypes#Tunnel_portal_overlay_.280A.29\|Railtype tunnel portal overlay]] or [[Action3/Railtypes#Signal_sprites_.280B.29\|Railtype signal sprites]] for details, respectively.
	\|}		\|}

Frosch: link to version numbers page

2012-04-01T17:18:50Z

link to version numbers page

← Older revision		Revision as of 17:18, 1 April 2012
Line 30:		Line 30:
	\|0A\|\|8A\|\| \|\|W\|\|{{ottdp\|0.6\|2.0}}\|\| animation counter, incremented every tick		\|0A\|\|8A\|\| \|\|W\|\|{{ottdp\|0.6\|2.0}}\|\| animation counter, incremented every tick
	\|-		\|-
	\|0B\|\|8B\|\| \|\|D\|\|{{ottdp\|no\|2.0}}\|\| TTDPatch version, see [[#TTDPatch_Version_.280B_.2F_8B.29\|below]] <ref>OpenTTD reports some arbitrary TTDPatch 2.6 version number to make old GRFs work, which do not know about OpenTTD. Do not rely on this for new NewGRFs.</ref><ref name="versionchecks">It is generally not useful to check version variables using Action 7. If you want to skip certain actions which are incompatible to some versions, you want to skip them during all loading stages. So, use Action 9.</ref>		\|0B\|\|8B\|\| \|\|D\|\|{{ottdp\|no\|2.0}}\|\| [[Version_numbers#TTDPatch_version\|TTDPatch version]], see [[#TTDPatch_Version_.280B_.2F_8B.29\|below]] <ref>OpenTTD reports some arbitrary TTDPatch 2.6 version number to make old GRFs work, which do not know about OpenTTD. Do not rely on this for new NewGRFs.</ref><ref name="versionchecks">It is generally not useful to check version variables using Action 7. If you want to skip certain actions which are incompatible to some versions, you want to skip them during all loading stages. So, use Action 9.</ref>
	\|-		\|-
	\|0C\|\| \|\| \|\|W\|\|{{ottdp\|0.6\|2.5}}\|\| current [[Callbacks\|callback]] ID (feature-specific), set to 00 when not in a callback		\|0C\|\| \|\| \|\|W\|\|{{ottdp\|0.6\|2.5}}\|\| current [[Callbacks\|callback]] ID (feature-specific), set to 00 when not in a callback
Line 74:		Line 74:
	\|20\|\| \|\| \|\|B\|\|{{ottdp\|0.6\|2.5}}\|\| Current snow line height, FFh if snow isn't present at all <ref name="heightlevel"/>		\|20\|\| \|\| \|\|B\|\|{{ottdp\|0.6\|2.5}}\|\| Current snow line height, FFh if snow isn't present at all <ref name="heightlevel"/>
	\|-		\|-
	\|21\|\|A1\|\| \|\|D\|\|{{ottdp\|0.6\|no}}\|\| OpenTTD version, see [[#OpenTTD_Version_.2821_.2F_A1.29\|below]]. <ref name="versionchecks"/>		\|21\|\|A1\|\| \|\|D\|\|{{ottdp\|0.6\|no}}\|\| [[Version_numbers#OpenTTD_version\|OpenTTD version]], see [[#OpenTTD_Version_.2821_.2F_A1.29\|below]]. <ref name="versionchecks"/>
	\|-		\|-
	\|22\|\|A2\|\| \|\|D\|\|{{ottdp\|0.7\|2.6\|ottdrev=r12499\|ttdprev=r1857}}\|\| Difficulty level: 00= easy, 01=medium, 02=hard, 03=custom		\|22\|\|A2\|\| \|\|D\|\|{{ottdp\|0.7\|2.6\|ottdrev=r12499\|ttdprev=r1857}}\|\| Difficulty level: 00= easy, 01=medium, 02=hard, 03=custom
Line 115:		Line 115:
	!Element!!Meaning!!Value		!Element!!Meaning!!Value
	\|-		\|-
	\|MM\|\|major\|\|First number of the TTDPatch version		\|MM\|\|major\|\|First number of the [[Version_numbers#TTDPatch_version\|TTDPatch version]]
	\|-		\|-
	\|m\|\|minor\|\|Second number of the TTDPatch version		\|m\|\|minor\|\|Second number of the TTDPatch version
Line 287:		Line 287:
	!Element!!Meaning!!Value		!Element!!Meaning!!Value
	\|-		\|-
	\|M\|\|major\|\|First number of the OpenTTD version		\|M\|\|major\|\|First number of the [[Version_numbers#OpenTTD_version\|OpenTTD version]]
	\|-		\|-
	\|m\|\|minor\|\|Second number of the OpenTTD version		\|m\|\|minor\|\|Second number of the OpenTTD version

Frosch: use new grf templates

2012-04-01T13:15:38Z

use new grf templates

← Older revision		Revision as of 13:15, 1 April 2012
Line 54:		Line 54:
	\|16\|\|96\|\|96\|\|W\|\|{{ottdp\|no\|2.5\|ttdprev=2.0.1 alpha 39}}\|\| Tile refresh offset downwards <ref name="tilefresh"/>		\|16\|\|96\|\|96\|\|W\|\|{{ottdp\|no\|2.5\|ttdprev=2.0.1 alpha 39}}\|\| Tile refresh offset downwards <ref name="tilefresh"/>
	\|-		\|-
	\| \|\|97\|\|97\|\|B\|\|{{ottdp\|no\|2.5}}\|\| Fixed snow line height <ref>This variable is a deprecated way to set the snow line height via NewGRFs using [[ActionD]]. It is superseded by the [[Action0/Global Settings#Snow_line_height_table_.2810.29 \| Action 0 snow line height table]]. To read the current snow line with [[VariationalAction2 \| VarAct2]] in a running game, use variable 20 instead.</ref><ref name="heightlevel">{{~~grf~~\|8}} For GRF version 7 and below these variable are multiples of 8; for GRF version 8 and above they directly state the heightlevel as multiple of 1.</ref>		\| \|\|97\|\|97\|\|B\|\|{{ottdp\|no\|2.5}}\|\| Fixed snow line height <ref>This variable is a deprecated way to set the snow line height via NewGRFs using [[ActionD]]. It is superseded by the [[Action0/Global Settings#Snow_line_height_table_.2810.29 \| Action 0 snow line height table]]. To read the current snow line with [[VariationalAction2 \| VarAct2]] in a running game, use variable 20 instead.</ref><ref name="heightlevel">{{grfTill\|7}} For GRF version 7 and below these variable are multiples of 8; {{grfFrom\|8}} for GRF version 8 and above they directly state the heightlevel as multiple of 1.</ref>
	\|-		\|-
	\|18\|\| \|\| \|\|D\|\|{{ottdp\|0.6\|2.5}}\|\| Extra callback info 2, see [[#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29\|below]].		\|18\|\| \|\| \|\|D\|\|{{ottdp\|0.6\|2.5}}\|\| Extra callback info 2, see [[#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29\|below]].
Line 197:		Line 197:
	This is only active if the tempsnowline switch is on. It defaults to FF (no snow) and 38 (GRF version < 8) resp. 07 (GRF version >= 8) in the temperate and arctic climates, respectively.		This is only active if the tempsnowline switch is on. It defaults to FF (no snow) and 38 (GRF version < 8) resp. 07 (GRF version >= 8) in the temperate and arctic climates, respectively.

	{{~~grf~~\|7}} For GRF version 7 and below it must be set to a multiple of 8, which is one level of height difference.		{{grfTill\|7}} For GRF version 7 and below it must be set to a multiple of 8, which is one level of height difference.

	{{~~grf~~\|8}} For GRF version 8 and above the heightlevel is set directly as multiple of 1.		{{grfFrom\|8}} For GRF version 8 and above the heightlevel is set directly as multiple of 1.

	=== Global ID offset (- / 99) ===		=== Global ID offset (- / 99) ===

Michi cc: /* Extra callback info (10 / -) and (18 / -) */ Custom railtype tunnels

2012-02-15T22:15:57Z

Extra callback info (10 / -) and (18 / -): Custom railtype tunnels

← Older revision		Revision as of 22:15, 15 February 2012
Line 179:		Line 179:
	\|-		\|-
	\| Stations \|\| Used to compose station tiles with sprites from different Action-1-2-3 chains, or to draw custom foundations. See [[Action0/Stations#General_Flags_.2813.29\|General station flags]] and [[AdvancedSpriteLayout]].		\| Stations \|\| Used to compose station tiles with sprites from different Action-1-2-3 chains, or to draw custom foundations. See [[Action0/Stations#General_Flags_.2813.29\|General station flags]] and [[AdvancedSpriteLayout]].
			\|-
			\| Railtypes \|\| Used to distinguish between the type of tunnel portal requested, see [[Action3/Railtypes#Tunnel_portal_overlay_.280A.29\|Railtype tunnel portal overlay]] for details.
	\|}		\|}