Callback: Industry location permissibility - Revision history

Frosch: /* Industry location permissibility (28) */

2025-05-13T14:13:02Z

Industry location permissibility (28)

← Older revision		Revision as of 14:13, 13 May 2025
Line 55:		Line 55:
	!Value!!Version!!Meaning		!Value!!Version!!Meaning
	\|-		\|-
	\|0000-03ff\|\|{{ottdp\| \| }}\|\|Industry can't be built, display the misc. GRF text ~~Dxxx~~ as error message		\|0000-03ff\|\|{{ottdp\| \| }}\|\|Industry can't be built, display the misc. GRF text D0xx as error message
	\|-		\|-
	\|0400\|\|{{ottdp\| \| }}\|\|Industry can be built		\|0400\|\|{{ottdp\| \| }}\|\|Industry can be built

Frosch: /* Industry location permissibility (28) */

2025-05-13T14:04:20Z

Industry location permissibility (28)

← Older revision		Revision as of 14:04, 13 May 2025
Line 74:		Line 74:
	\|-		\|-
	\|0408\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}}\|\|Industry can't be built, display the "...can't build on river" error message.		\|0408\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}}\|\|Industry can't be built, display the "...can't build on river" error message.
			\|-
			\|040F\|\|{{ottdp\|15\|no}}\|\|Industry can't be built. Display error message using text ID from register 0x100 (not limited to D0xx texts). The text stack starts at register 0x101.
	\|}		\|}

	{{ottdp\|0.6\|2.6\|ttdprev=r1755}} Since TTDPatch r1755, you can use the text reference stack for your error messages, similarly to callback 3A. The only difference is that only 4 registers are copied instead of 6 because error messages support 20 bytes of reference stack only, and two of those bytes may be used by TTD.		{{ottdp\|0.6-14\|2.6\|ttdprev=r1755}} Since TTDPatch r1755, you can use the text reference stack for your error messages, similarly to callback 3A. The only difference is that only 4 registers are copied instead of 6 because error messages support 20 bytes of reference stack only, and two of those bytes may be used by TTD.

			{{ottdp\|15\|no}} The contents of registers 100h..10Fh are copied onto the text reference stack.

	[[Category:Callbacks]]		[[Category:Callbacks]]

Frosch: use new grf templates

2012-04-01T13:26:05Z

use new grf templates

← Older revision		Revision as of 13:26, 1 April 2012
Line 23:		Line 23:
	\|-		\|-
	\|8A\|\|B\|\|{{ottdp\| \| }}\|\|Height of the lowest corner of the tile		\|8A\|\|B\|\|{{ottdp\| \| }}\|\|Height of the lowest corner of the tile
	* {{~~grf~~\|7}} For GRF version 7 and below: Multiple of 8.		* {{grfTill\|7}} For GRF version 7 and below: Multiple of 8.
	* {{~~grf~~\|8}} For GRF version 8 and above: Multiple of 1.		* {{grfFrom\|8}} For GRF version 8 and above: Multiple of 1.
	\|-		\|-
	\|8B\|\|W\|\|{{ottdp\| \| }}\|\|Distance to the closest water tile if property 1A bit 2 is clear (built on land); distance to the closest empty dry land tile if property 1A bit 2 is clear (built on water)		\|8B\|\|W\|\|{{ottdp\| \| }}\|\|Distance to the closest water tile if property 1A bit 2 is clear (built on land); distance to the closest empty dry land tile if property 1A bit 2 is clear (built on water)

Frosch: grf version 8

2011-11-08T20:42:04Z

grf version 8

← Older revision		Revision as of 20:42, 8 November 2011
Line 22:		Line 22:
	\|89\|\|B\|\|{{ottdp\| \| }}\|\|Distance between the closest town and the selected position.		\|89\|\|B\|\|{{ottdp\| \| }}\|\|Distance between the closest town and the selected position.
	\|-		\|-
	\|8A\|\|B\|\|{{ottdp\| \| }}\|\|Height of the lowest corner of the tile ~~(between 00h and 80h, one land height unit equals 8 units)~~		\|8A\|\|B\|\|{{ottdp\| \| }}\|\|Height of the lowest corner of the tile
			* {{grf\|7}} For GRF version 7 and below: Multiple of 8.
			* {{grf\|8}} For GRF version 8 and above: Multiple of 1.
	\|-		\|-
	\|8B\|\|W\|\|{{ottdp\| \| }}\|\|Distance to the closest water tile if property 1A bit 2 is clear (built on land); distance to the closest empty dry land tile if property 1A bit 2 is clear (built on water)		\|8B\|\|W\|\|{{ottdp\| \| }}\|\|Distance to the closest water tile if property 1A bit 2 is clear (built on land); distance to the closest empty dry land tile if property 1A bit 2 is clear (built on water)

Planetmaker: /* Industry location permissibility (28) */ version info

2011-08-03T23:33:36Z

Industry location permissibility (28): version info

Michi cc: /* Industry location permissibility (28) */ Version tags

2011-07-23T18:33:45Z

Industry location permissibility (28): Version tags

← Older revision		Revision as of 18:33, 23 July 2011
Line 8:		Line 8:
	\|40+x\|\| \|\|Not accessible		\|40+x\|\| \|\|Not accessible
	\|-		\|-
	\|5F\|\| \|\|~~Since OpenTTD r19744:~~ Random bits the industry starts with after construction. Accessible via RandomAction2 as well.		\|5F\|\| \|\|{{ottdp\|1.1\|no\|ottdrev=19744}} Random bits the industry starts with after construction. Accessible via RandomAction2 as well.
	\|-		\|-
	\|60+x\|\| \|\|Only var. 62 and vars 64..68 can be used		\|60+x\|\| \|\|Only var. 62 and vars 64..68 can be used
Line 28:		Line 28:
	\|8D\|\|W\|\|Square of the Euclidean distance between the closest town and the selected position		\|8D\|\|W\|\|Square of the Euclidean distance between the closest town and the selected position
	\|-		\|-
	\|8F\|\|D\|\|32 random bits ~~(since r1816 and r11985)~~		\|8F\|\|D\|\|{{ottdp\|0.6\|2.6\|ottdrev=r11985\|ttdprev=r1816}} 32 random bits
	\|}		\|}
	Unless explicitly noted, distances are Manhattan distance, not Euclidean distance, ie. <tt>\|x-x0\|+\|y-y0\|</tt> instead of <tt>sqrt((x-x0)^2+(y-y0)^2)</tt>		Unless explicitly noted, distances are Manhattan distance, not Euclidean distance, ie. <tt>\|x-x0\|+\|y-y0\|</tt> instead of <tt>sqrt((x-x0)^2+(y-y0)^2)</tt>
Line 34:		Line 34:
	Variable 8B will always be below 80h if prop 1A bit 2 is clear. If bit 2 is set, 8B will be set to its max of 200h in the pathological case of an all-water map.		Variable 8B will always be below 80h if prop 1A bit 2 is clear. If bit 2 is set, 8B will be set to its max of 200h in the pathological case of an all-water map.

	During this callback, variable 18 (extra callback info 2) contains the following values for OpenTTD r20942 and later:		{{ottd\|1.1\|r20942}} During this callback, variable 18 (extra callback info 2) contains the following values for OpenTTD r20942 and later:

	{\| \|-		{\| \|-
Line 63:		Line 63:
	\|0403\|\|Industry can't be built, display the "...can only be built in desert areas" error message.		\|0403\|\|Industry can't be built, display the "...can only be built in desert areas" error message.
	\|-		\|-
	\|0404\|\|~~(a)~~ Industry can't be built, display the "...can only be built above the snow-line" error message.		\|0404\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can only be built above the snow-line" error message.
	\|-		\|-
	\|0405\|\|~~(a)~~ Industry can't be built, display the "...can only be built below the snow-line" error message.		\|0405\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can only be built below the snow-line" error message.
	\|-		\|-
	\|0406\|\|~~(a)~~ Industry can't be built, display the "...can't build on open sea" error message.		\|0406\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can't build on open sea" error message.
	\|-		\|-
	\|0407\|\|~~(a)~~ Industry can't be built, display the "...can't build on canal" error message.		\|0407\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can't build on canal" error message.
	\|-		\|-
	\|0408\|\|~~(a)~~ Industry can't be built, display the "...can't build on river" error message.		\|0408\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can't build on river" error message.
	\|}		\|}

		⚫	{{ottdp\|0.6\|2.6\|ttdprev=r1755}} Since TTDPatch r1755, you can use the text reference stack for your error messages, similarly to callback 3A. The only difference is that only 4 registers are copied instead of 6 because error messages support 20 bytes of reference stack only, and two of those bytes may be used by TTD.
	(a) OpenTTD since r22657

⚫	Since TTDPatch r1755, you can use the text reference stack for your error messages, similarly to callback 3A. The only difference is that only 4 registers are copied instead of 6 because error messages support 20 bytes of reference stack only, and two of those bytes may be used by TTD.
	[[Category:Callbacks]]		[[Category:Callbacks]]

Michi cc: /* Industry location permissibility (28) */ Specify OpenTTD revision

2011-07-11T16:42:34Z

Industry location permissibility (28): Specify OpenTTD revision

← Older revision		Revision as of 16:42, 11 July 2011
Line 63:		Line 63:
	\|0403\|\|Industry can't be built, display the "...can only be built in desert areas" error message.		\|0403\|\|Industry can't be built, display the "...can only be built in desert areas" error message.
	\|-		\|-
	\|0404\|\|Industry can't be built, display the "...can only be built above the snow-line" error message.		\|0404\|\|(a) Industry can't be built, display the "...can only be built above the snow-line" error message.
	\|-		\|-
	\|0405\|\|Industry can't be built, display the "...can only be built below the snow-line" error message.		\|0405\|\|(a) Industry can't be built, display the "...can only be built below the snow-line" error message.
	\|-		\|-
	\|0406\|\|Industry can't be built, display the "...can't build on open sea" error message.		\|0406\|\|(a) Industry can't be built, display the "...can't build on open sea" error message.
	\|-		\|-
	\|0407\|\|Industry can't be built, display the "...can't build on canal" error message.		\|0407\|\|(a) Industry can't be built, display the "...can't build on canal" error message.
	\|-		\|-
	\|0408\|\|Industry can't be built, display the "...can't build on river" error message.		\|0408\|\|(a) Industry can't be built, display the "...can't build on river" error message.
	\|}		\|}

			(a) OpenTTD since r22657

	Since TTDPatch r1755, you can use the text reference stack for your error messages, similarly to callback 3A. The only difference is that only 4 registers are copied instead of 6 because error messages support 20 bytes of reference stack only, and two of those bytes may be used by TTD.		Since TTDPatch r1755, you can use the text reference stack for your error messages, similarly to callback 3A. The only difference is that only 4 registers are copied instead of 6 because error messages support 20 bytes of reference stack only, and two of those bytes may be used by TTD.

Michi cc: /* Industry location permissibility (28) */ More predefined error messages

2011-07-11T16:28:36Z

Industry location permissibility (28): More predefined error messages

@@ Line 62: / Line 62: @@
 |-
 |0403||Industry can't be built, display the "...can only be built in desert areas" error message.
 |}

Pm-bot: Create a separate page for each callback

2011-06-16T18:57:58Z

Create a separate page for each callback

New page

== Industry location permissibility (28) ==

Called to decide if the industry can be built on a given spot. Since the industry isn't built yet, you can only use a small subset of the data: you can access the data of the nearest town via action 2/type 82 without any problems, but action 2/type 81 will access different variables than it would normally access:

{| |-
!Variable!![[GRFActionsDetailed|Size]]!!Meaning
|-
|40+x|| ||Not accessible
|-
|5F|| ||Since OpenTTD r19744: Random bits the industry starts with after construction. Accessible via RandomAction2 as well.
|-
|60+x|| ||Only var. 62 and vars 64..68 can be used
|-
|80||W||Coordinates of the selected position
|-
|86||B||Number of the selected layout, according to property 0A
|-
|87||B||Ground type of the selected spot (see [[VarAction2Canals|canal variable 81]] for details)
|-
|88||B||[[TownZones|Town zone]] of the selected spot (see [[VarAction2Houses#Town zone 42|house variable 42]] for details)
|-
|89||B||Distance between the closest town and the selected position.
|-
|8A||B||Height of the lowest corner of the tile (between 00h and 80h, one land height unit equals 8 units)
|-
|8B||W||Distance to the closest water tile if property 1A bit 2 is clear (built on land); distance to the closest empty dry land tile if property 1A bit 2 is clear (built on water)
|-
|8D||W||Square of the Euclidean distance between the closest town and the selected position
|-
|8F||D||32 random bits (since r1816 and r11985)
|}
Unless explicitly noted, distances are Manhattan distance, not Euclidean distance, ie. <tt>|x-x0|+|y-y0|</tt> instead of <tt>sqrt((x-x0)^2+(y-y0)^2)</tt>

Variable 8B will always be below 80h if prop 1A bit 2 is clear. If bit 2 is set, 8B will be set to its max of 200h in the pathological case of an all-water map.

During this callback, variable 18 (extra callback info 2) contains the following values for OpenTTD r20942 and later:

{| |-
!Variable 18!!Meaning
|-
|0||TTD is generating a map.
|-
|1||TTD decided to build a new random industry during regular gameplay.
|-
|2||The user tries to build your industry via the new industry window.
|-
|3||The user tries to prospect for your industry via the new industry window.
|}

This callback must return a 15-bit value, which is interpreted as follows:

{| |-
!Value!!Meaning
|-
|0000-03ff||Industry can't be built, display the misc. GRF text Dxxx as error message
|-
|0400||Industry can be built
|-
|0401||Industry can't be built, display the default "site unsuitable" error message.
|-
|0402||Industry can't be built, display the "...can only be built in rainforest areas" error message.
|-
|0403||Industry can't be built, display the "...can only be built in desert areas" error message.
|}

Since TTDPatch r1755, you can use the text reference stack for your error messages, similarly to callback 3A. The only difference is that only 4 registers are copied instead of 6 because error messages support 20 bytes of reference stack only, and two of those bytes may be used by TTD.
[[Category:Callbacks]]

← Older revision		Revision as of 23:33, 3 August 2011
Line 4:		Line 4:

	{\| \|-		{\| \|-
	!Variable!![[GRFActionsDetailed\|Size]]!!Meaning		!Variable!![[GRFActionsDetailed\|Size]]!!Version!!Meaning
	\|-		\|-
	\|40+x\|\| \|\|Not accessible		\|40+x\|\| \|\|{{ottdp\| \| }}\|\|Not accessible
	\|-		\|-
	\|5F\|\| \|\|{{ottdp\|1.1\|no\|ottdrev=19744}} Random bits the industry starts with after construction. Accessible via RandomAction2 as well.		\|5F\|\| \|\|{{ottdp\|1.1\|no\|ottdrev=19744}}\|\|Random bits the industry starts with after construction. Accessible via RandomAction2 as well.
	\|-		\|-
	\|60+x\|\| \|\|Only var. 62 and vars 64..68 can be used		\|60+x\|\| \|\|{{ottdp\| \| }}\|\|Only var. 62 and vars 64..68 can be used
	\|-		\|-
	\|80\|\|W\|\|Coordinates of the selected position		\|80\|\|W\|\|{{ottdp\| \| }}\|\|Coordinates of the selected position
	\|-		\|-
	\|86\|\|B\|\|Number of the selected layout, according to property 0A		\|86\|\|B\|\|{{ottdp\| \| }}\|\|Number of the selected layout, according to property 0A
	\|-		\|-
	\|87\|\|B\|\|Ground type of the selected spot (see [[VarAction2Canals\|canal variable 81]] for details)		\|87\|\|B\|\|{{ottdp\| \| }}\|\|Ground type of the selected spot (see [[VarAction2Canals\|canal variable 81]] for details)
	\|-		\|-
	\|88\|\|B\|\|[[TownZones\|Town zone]] of the selected spot (see [[VarAction2Houses#Town zone 42\|house variable 42]] for details)		\|88\|\|B\|\|{{ottdp\| \| }}\|\|[[TownZones\|Town zone]] of the selected spot (see [[VarAction2Houses#Town zone 42\|house variable 42]] for details)
	\|-		\|-
	\|89\|\|B\|\|Distance between the closest town and the selected position.		\|89\|\|B\|\|{{ottdp\| \| }}\|\|Distance between the closest town and the selected position.
	\|-		\|-
	\|8A\|\|B\|\|Height of the lowest corner of the tile (between 00h and 80h, one land height unit equals 8 units)		\|8A\|\|B\|\|{{ottdp\| \| }}\|\|Height of the lowest corner of the tile (between 00h and 80h, one land height unit equals 8 units)
	\|-		\|-
	\|8B\|\|W\|\|Distance to the closest water tile if property 1A bit 2 is clear (built on land); distance to the closest empty dry land tile if property 1A bit 2 is clear (built on water)		\|8B\|\|W\|\|{{ottdp\| \| }}\|\|Distance to the closest water tile if property 1A bit 2 is clear (built on land); distance to the closest empty dry land tile if property 1A bit 2 is clear (built on water)
	\|-		\|-
	\|8D\|\|W\|\|Square of the Euclidean distance between the closest town and the selected position		\|8D\|\|W\|\|{{ottdp\| \| }}\|\|Square of the Euclidean distance between the closest town and the selected position
	\|-		\|-
	\|8F\|\|D\|\|{{ottdp\|0.6\|2.6\|ottdrev=r11985\|ttdprev=r1816}} 32 random bits		\|8F\|\|D\|\|{{ottdp\|0.6\|2.6\|ottdrev=r11985\|ttdprev=r1816}}\|\| 32 random bits
	\|}		\|}
	Unless explicitly noted, distances are Manhattan distance, not Euclidean distance, ie. <tt>\|x-x0\|+\|y-y0\|</tt> instead of <tt>sqrt((x-x0)^2+(y-y0)^2)</tt>		Unless explicitly noted, distances are Manhattan distance, not Euclidean distance, ie. <tt>\|x-x0\|+\|y-y0\|</tt> instead of <tt>sqrt((x-x0)^2+(y-y0)^2)</tt>
Line 51:		Line 51:

	{\| \|-		{\| \|-
	!Value!!Meaning		!Value!!Version!!Meaning
	\|-		\|-
	\|0000-03ff\|\|Industry can't be built, display the misc. GRF text Dxxx as error message		\|0000-03ff\|\|{{ottdp\| \| }}\|\|Industry can't be built, display the misc. GRF text Dxxx as error message
	\|-		\|-
	\|0400\|\|Industry can be built		\|0400\|\|{{ottdp\| \| }}\|\|Industry can be built
	\|-		\|-
	\|0401\|\|Industry can't be built, display the default "site unsuitable" error message.		\|0401\|\|{{ottdp\| \| }}\|\|Industry can't be built, display the default "site unsuitable" error message.
	\|-		\|-
	\|0402\|\|Industry can't be built, display the "...can only be built in rainforest areas" error message.		\|0402\|\|{{ottdp\| \| }}\|\|Industry can't be built, display the "...can only be built in rainforest areas" error message.
	\|-		\|-
	\|0403\|\|Industry can't be built, display the "...can only be built in desert areas" error message.		\|0403\|\|{{ottdp\| \| }}\|\|Industry can't be built, display the "...can only be built in desert areas" error message.
	\|-		\|-
	\|0404\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can only be built above the snow-line" error message.		\|0404\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}}\|\|Industry can't be built, display the "...can only be built above the snow-line" error message.
	\|-		\|-
	\|0405\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can only be built below the snow-line" error message.		\|0405\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}}\|\|Industry can't be built, display the "...can only be built below the snow-line" error message.
	\|-		\|-
	\|0406\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can't build on open sea" error message.		\|0406\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}}\|\|Industry can't be built, display the "...can't build on open sea" error message.
	\|-		\|-
	\|0407\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can't build on canal" error message.		\|0407\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}}\|\|Industry can't be built, display the "...can't build on canal" error message.
	\|-		\|-
	\|0408\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}} Industry can't be built, display the "...can't build on river" error message.		\|0408\|\|{{ottdp\|1.2\|no\|ottdrev=r22657}}\|\|Industry can't be built, display the "...can't build on river" error message.
	\|}		\|}