Callback: Additional text in purchase screen - Revision history

Frosch: /* Additional text in purchase screen (23) */

2025-05-13T14:12:42Z

Additional text in purchase screen (23)

← Older revision		Revision as of 14:12, 13 May 2025
Line 3:		Line 3:
	This callback can be used to append text below the vehicle information in the purchase screen. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it.		This callback can be used to append text below the vehicle information in the purchase screen. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it.

			{\|
	A text string for the feature in the D0XX range must be defined before using this callback. The return value of this callback is the XX of a D0XX string ID.
			\|-
			!Return value!!Version!!Meaning
			\|-
			\|0000..03FF\|\| \|\|D0xx text to display. {{ttdp\|}} Before r1908 only text IDs D000..D0FF were supported.
			\|-
			\|0400\|\|{{grfFrom\|8}}\|\|Display no text (same as callback failure).
			\|-
			\|040F\|\|{{ottdp\|15\|no}}\|\|Display text using text ID from register 0x100 (not limited to D0xx texts). The text stack starts at register 0x101.
			\|}

		⚫	{{ottdp\|1.2-14\|no\|ottdrev=r23045}} Since OpenTTD r23045 the contents of registers 100h..105h are copied onto the text reference stack.
	As of r1908, text IDs D100..D3FF may also be returned.

	{{grfFrom\|8}} Since GRF version 8 the value 400 can be returned to display no text. In older versions it is necessary to fail the callback.

⚫	{{ottdp\|1.2\|no\|ottdrev=r23045}} Since OpenTTD r23045 the contents of registers 100h..105h are copied onto the text reference stack.

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

	Lines are wrapped automatically, or may be broken explicitly using the newline character 0D. How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc.		Lines are wrapped automatically, or may be broken explicitly using the newline character 0D. How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc.

Frosch: feature 48 is wrong, callback ids must be checked as word

2013-10-17T19:42:55Z

feature 48 is wrong, callback ids must be checked as word

← Older revision		Revision as of 19:42, 17 October 2013
Line 3:		Line 3:
	This callback can be used to append text below the vehicle information in the purchase screen. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it.		This callback can be used to append text below the vehicle information in the purchase screen. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it.

	A text string for feature 48 in the D0XX range must be defined before using this callback~~. Line breaks (0D) and colors are supported~~. The return value of this callback is the XX of a D0XX string ID.		A text string for the feature in the D0XX range must be defined before using this callback. The return value of this callback is the XX of a D0XX string ID.

	As of r1908, text IDs D100..D3FF may also be returned.		As of r1908, text IDs D100..D3FF may also be returned.

		⚫	{{grfFrom\|8}} Since GRF version 8 the value 400 can be returned to display no text. In older versions it is necessary to fail the callback.

		⚫	{{ottdp\|1.2\|no\|ottdrev=r23045}} Since OpenTTD r23045 the contents of registers 100h..105h are copied onto the text reference stack.


	Lines are wrapped automatically, or may be broken explicitly using the newline character 0D. How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc.		Lines are wrapped automatically, or may be broken explicitly using the newline character 0D. How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc.
Line 14:		Line 19:
	Example for setting additional text for a road vehicle:		Example for setting additional text for a road vehicle:

	// Define string with ID D001. Bit 7 of the language byte must be set to 1, because the string ID is a word.		// Define string with ID D001 for featur 01. Bit 7 of the language byte must be set to 1, because the string ID is a word.
	4 * 32 04 48 83 01 ~~01 D0~~ "Hint: This is a " 0D "new line." 00		4 * 32 04 01 83 01 \wxD001 "Hint: This is a " 0D "new line." 00
	// The callback		// The callback
	5 * 14 02 01 10 81 0C 00 FF 01 ~~01 80~~ 23 23 02 00		5 * 14 02 01 10 85 0C 00 \wxFFFF 01 \wx8001 \wx23 \wx23 02 00

⚫	{{grfFrom\|8}} Since GRF version 8 the value 400 can be returned to display no text. In older versions it is necessary to fail the callback.

⚫	{{ottdp\|1.2\|no\|ottdrev=r23045}} Since OpenTTD r23045 the contents of registers 100h..105h are copied onto the text reference stack.

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

Gesia: /* Additional text in purchase screen (23) */ Example added

2013-10-16T18:03:50Z

Additional text in purchase screen (23): Example added

← Older revision		Revision as of 18:03, 16 October 2013
Line 1:		Line 1:
	== Additional text in purchase screen (23) ==		== Additional text in purchase screen (23) ==

	This callback is ~~called~~ ~~when~~ ~~TTDPatch~~ ~~displays~~ the vehicle ~~stats of any vehicle~~ in ~~its~~ purchase screen~~. The return value is the "xx" of a D0xx text ID to be shown below all other stats~~. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it~~. As of r1908, text IDs D100..D3FF may also be returned~~.		This callback can be used to append text below the vehicle information in the purchase screen. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it.

			A text string for feature 48 in the D0XX range must be defined before using this callback. Line breaks (0D) and colors are supported. The return value of this callback is the XX of a D0XX string ID.
⚫	{{grfFrom\|8}} ~~For~~ GRF version 8 ~~and~~ ~~above~~ ~~you~~ can ~~return~~ ~~400~~ to display no text ~~(instead~~ of ~~failing~~ the callback).

			As of r1908, text IDs D100..D3FF may also be returned.
⚫	How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc. ~~Lines are wrapped automatically, or may be broken explicitly using the newline character 0D.~~

		⚫	Lines are wrapped automatically, or may be broken explicitly using the newline character 0D. How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc.

	If cargo FF (buy menu sprite) is handled explicitly for a vehicle, then the varaction 2 handling [[Callbacks#Additional text in purchase screen (23) \|callback 23]] must be in the buy menu varaction 2 chain.		If cargo FF (buy menu sprite) is handled explicitly for a vehicle, then the varaction 2 handling [[Callbacks#Additional text in purchase screen (23) \|callback 23]] must be in the buy menu varaction 2 chain.


			Example for setting additional text for a road vehicle:

			// Define string with ID D001. Bit 7 of the language byte must be set to 1, because the string ID is a word.
			4 * 32 04 48 83 01 01 D0 "Hint: This is a " 0D "new line." 00
			// The callback
			5 * 14 02 01 10 81 0C 00 FF 01 01 80 23 23 02 00

		⚫	{{grfFrom\|8}} Since GRF version 8 the value 400 can be returned to display no text. In older versions it is necessary to fail the callback.

	{{ottdp\|1.2\|no\|ottdrev=r23045}} Since OpenTTD r23045 the contents of registers 100h..105h are copied onto the text reference stack.		{{ottdp\|1.2\|no\|ottdrev=r23045}} Since OpenTTD r23045 the contents of registers 100h..105h are copied onto the text reference stack.

Frosch: use new grf templates

2012-04-01T13:25:43Z

use new grf templates

← Older revision		Revision as of 13:25, 1 April 2012
Line 3:		Line 3:
	This callback is called when TTDPatch displays the vehicle stats of any vehicle in its purchase screen. The return value is the "xx" of a D0xx text ID to be shown below all other stats. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it. As of r1908, text IDs D100..D3FF may also be returned.		This callback is called when TTDPatch displays the vehicle stats of any vehicle in its purchase screen. The return value is the "xx" of a D0xx text ID to be shown below all other stats. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it. As of r1908, text IDs D100..D3FF may also be returned.

	{{~~grf~~\|8}} For GRF version 8 and above you can return 400 to display no text (instead of failing the callback).		{{grfFrom\|8}} For GRF version 8 and above you can return 400 to display no text (instead of failing the callback).

	How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc. Lines are wrapped automatically, or may be broken explicitly using the newline character 0D.		How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc. Lines are wrapped automatically, or may be broken explicitly using the newline character 0D.

Frosch: grf version 8

2011-11-09T01:21:40Z

grf version 8

← Older revision		Revision as of 01:21, 9 November 2011
Line 2:		Line 2:

	This callback is called when TTDPatch displays the vehicle stats of any vehicle in its purchase screen. The return value is the "xx" of a D0xx text ID to be shown below all other stats. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it. As of r1908, text IDs D100..D3FF may also be returned.		This callback is called when TTDPatch displays the vehicle stats of any vehicle in its purchase screen. The return value is the "xx" of a D0xx text ID to be shown below all other stats. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it. As of r1908, text IDs D100..D3FF may also be returned.

			{{grf\|8}} For GRF version 8 and above you can return 400 to display no text (instead of failing the callback).

	How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc. Lines are wrapped automatically, or may be broken explicitly using the newline character 0D.		How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc. Lines are wrapped automatically, or may be broken explicitly using the newline character 0D.

Frosch: six registers instead of four

2011-10-20T19:03:21Z

six registers instead of four

← Older revision		Revision as of 19:03, 20 October 2011
Line 7:		Line 7:
	If cargo FF (buy menu sprite) is handled explicitly for a vehicle, then the varaction 2 handling [[Callbacks#Additional text in purchase screen (23) \|callback 23]] must be in the buy menu varaction 2 chain.		If cargo FF (buy menu sprite) is handled explicitly for a vehicle, then the varaction 2 handling [[Callbacks#Additional text in purchase screen (23) \|callback 23]] must be in the buy menu varaction 2 chain.

	{{ottdp\|1.2\|no\|ottdrev=~~r23040~~}} Since OpenTTD ~~r23040~~ the contents of registers 100h..~~103h~~ are copied onto the text reference stack.		{{ottdp\|1.2\|no\|ottdrev=r23045}} Since OpenTTD r23045 the contents of registers 100h..105h are copied onto the text reference stack.

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

Frosch: reference stack in cb 23

2011-10-20T18:57:15Z

reference stack in cb 23

← Older revision		Revision as of 18:57, 20 October 2011
Line 6:		Line 6:

	If cargo FF (buy menu sprite) is handled explicitly for a vehicle, then the varaction 2 handling [[Callbacks#Additional text in purchase screen (23) \|callback 23]] must be in the buy menu varaction 2 chain.		If cargo FF (buy menu sprite) is handled explicitly for a vehicle, then the varaction 2 handling [[Callbacks#Additional text in purchase screen (23) \|callback 23]] must be in the buy menu varaction 2 chain.

			{{ottdp\|1.2\|no\|ottdrev=r23040}} Since OpenTTD r23040 the contents of registers 100h..103h are copied onto the text reference stack.

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

Pm-bot: Create a separate page for each callback

2011-06-16T18:57:55Z

Create a separate page for each callback

New page

== Additional text in purchase screen (23) ==

This callback is called when TTDPatch displays the vehicle stats of any vehicle in its purchase screen. The return value is the "xx" of a D0xx text ID to be shown below all other stats. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it. As of r1908, text IDs D100..D3FF may also be returned.

How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc. Lines are wrapped automatically, or may be broken explicitly using the newline character 0D.

If cargo FF (buy menu sprite) is handled explicitly for a vehicle, then the varaction 2 handling [[Callbacks#Additional text in purchase screen (23) |callback 23]] must be in the buy menu varaction 2 chain.
[[Category:Callbacks]]