Callback: Engine name - Revision history

Frosch: /* Engine name (161) */

2025-05-13T13:59:07Z

Engine name (161)

← Older revision		Revision as of 13:59, 13 May 2025
Line 1:		Line 1:
	== Engine name (161) ==		== Engine name (161) ==

	This callback allows you to dynamically determine the name shown for an engine type. The return value should be the number of a D0xx text to be displayed. The contents of registers 100h..105h are copied onto the text reference stack and can be used with string codes 80/81 to show texts from the D8xx range as well, extending the available unique strings.		This callback allows you to dynamically determine the name shown for an engine type.

			{\|
	{{grfFrom\|8}} For GRF version 8 and above you can return 400 to display the engine name from the property (instead of failing the callback).
			\|-
			!Return value!!Version!!Meaning
			\|-
			\|0000..03FF\|\| \|\|D0xx text to display.
			\|-
			\|0400\|\|{{grfFrom\|8}}\|\|Display regular name from Action4 (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.
			\|}

			The contents of registers {{ottdp\|14\|no}} 100h..105h {{ottdp\|15\|no}} 100h..10Fh are copied onto the text reference stack and can be used with string codes 80/81 to show texts from the D8xx range as well, extending the available unique strings.
⚫	The callback is run in purchase list scope, i.e. for cargotype FF. No variables of an actual vehicle are available.

		⚫	The callback is run in purchase list scope, i.e. for cargotype FF. No variables of an actual vehicle are available.

	During this callback, variable 10 (extra callback info 1) contains information about the context where the name is shown.		During this callback, variable 10 (extra callback info 1) contains information about the context where the name is shown.

Brickblock1: /* Engine name (161) */

2023-11-30T20:53:56Z

Engine name (161)

← Older revision		Revision as of 20:53, 30 November 2023
Line 31:		Line 31:
	\| 30..FF \|\| reserved		\| 30..FF \|\| reserved
	\|}		\|}


			<references/>


	This callback is available from {{ottdp\|14\|no\|ottdrev=g05ed9f56fd}} OpenTTD 14 and above.		This callback is available from {{ottdp\|14\|no\|ottdrev=g05ed9f56fd}} OpenTTD 14 and above.

Andythenorth: /* Nope */

2023-11-30T20:30:34Z

Nope

← Older revision		Revision as of 20:30, 30 November 2023
Line 31:		Line 31:
	\| 30..FF \|\| reserved		\| 30..FF \|\| reserved
	\|}		\|}

	This callback is available from {{ottdp\|14\|no\|ottdrev=g05ed9f56fd}} OpenTTD 14 and above.
	[[Category:Callbacks]]

	== Build probability (e.g. Reverse rail vehicle on build) (162) ==

	(Details to be added)

	This callback is available from {{ottdp\|14\|no\|ottdrev=g05ed9f56fd}} OpenTTD 14 and above.		This callback is available from {{ottdp\|14\|no\|ottdrev=g05ed9f56fd}} OpenTTD 14 and above.

Andythenorth: /* Build probability (162) */

2023-11-30T20:30:11Z

Build probability (162)

← Older revision		Revision as of 20:30, 30 November 2023
Line 31:		Line 31:
	\| 30..FF \|\| reserved		\| 30..FF \|\| reserved
	\|}		\|}

			This callback is available from {{ottdp\|14\|no\|ottdrev=g05ed9f56fd}} OpenTTD 14 and above.
			[[Category:Callbacks]]

			== Build probability (e.g. Reverse rail vehicle on build) (162) ==

			(Details to be added)

	This callback is available from {{ottdp\|14\|no\|ottdrev=g05ed9f56fd}} OpenTTD 14 and above.		This callback is available from {{ottdp\|14\|no\|ottdrev=g05ed9f56fd}} OpenTTD 14 and above.

Andythenorth: /* Engine name (161) */

2023-04-17T17:06:16Z

Engine name (161)

← Older revision		Revision as of 17:06, 17 April 2023
Line 27:		Line 27:
	\| 22 \|\| Vehicle is drawn in the "Vehicles in use" panel of autoreplace GUI.		\| 22 \|\| Vehicle is drawn in the "Vehicles in use" panel of autoreplace GUI.
	\|-		\|-
	\| 22..2F \|\| reserved for other future GUIs with non-purchased vehicles.		\| 23..2F \|\| reserved for other future GUIs with non-purchased vehicles.
	\|-		\|-
	\| 30..FF \|\| reserved		\| 30..FF \|\| reserved

Andythenorth: /* Engine name (161) */ - added value 0x22 for autoreplace "Vehicles in use"

2023-04-17T17:06:07Z

Engine name (161): - added value 0x22 for autoreplace "Vehicles in use"

← Older revision		Revision as of 17:06, 17 April 2023
Line 21:		Line 21:
	\| 12..1F \|\| reserved for other future GUIs.		\| 12..1F \|\| reserved for other future GUIs.
	\|-		\|-
	\| 20 \|\| Vehicle is drawn in the purchase list. (This includes the autoreplace GUI.)<br>Bits '''8 - 15''' contain the indentation level in the list, e.g. when using vehicle variants.		\| 20 \|\| Vehicle is drawn in the purchase list. (This includes the "Available vehicles" panel of autoreplace GUI.)<br>Bits '''8 - 15''' contain the indentation level in the list, e.g. when using vehicle variants.
	\|-		\|-
	\| 21 \|\| Vehicle is drawn in the exclusive preview GUI or in the advertisement news.		\| 21 \|\| Vehicle is drawn in the exclusive preview GUI or in the advertisement news.
			\|-
			\| 22 \|\| Vehicle is drawn in the "Vehicles in use" panel of autoreplace GUI.
	\|-		\|-
	\| 22..2F \|\| reserved for other future GUIs with non-purchased vehicles.		\| 22..2F \|\| reserved for other future GUIs with non-purchased vehicles.

Michi cc: Engine name callback

2023-01-30T22:20:50Z

Engine name callback

New page

== Engine name (161) ==

This callback allows you to dynamically determine the name shown for an engine type. The return value should be the number of a D0xx text to be displayed. The contents of registers 100h..105h are copied onto the text reference stack and can be used with string codes 80/81 to show texts from the D8xx range as well, extending the available unique strings.

{{grfFrom|8}} For GRF version 8 and above you can return 400 to display the engine name from the property (instead of failing the callback).

The callback is run in purchase list scope, i.e. for cargotype FF. No variables of an actual vehicle are available.

During this callback, variable 10 (extra callback info 1) contains information about the context where the name is shown.

{| |-
! Bits 0 - 7 of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 10]]<ref>Values correspond to the values used for [[Action2/Vehicles#Drawing_different_sprites_on_map_in_various_GUIs|sprite drawing]].</ref>!! Meaning
|-
| 00 || No specific context is avaible.
|-
| 01..10 || reserved
|-
| 11 || Name is shown in the vehicle details GUI. (This includes the refit GUI.)
|-
| 12..1F || reserved for other future GUIs.
|-
| 20 || Vehicle is drawn in the purchase list. (This includes the autoreplace GUI.)<br>Bits '''8 - 15''' contain the indentation level in the list, e.g. when using vehicle variants.
|-
| 21 || Vehicle is drawn in the exclusive preview GUI or in the advertisement news.
|-
| 22..2F || reserved for other future GUIs with non-purchased vehicles.
|-
| 30..FF || reserved
|}

This callback is available from {{ottdp|14|no|ottdrev=g05ed9f56fd}} OpenTTD 14 and above.
[[Category:Callbacks]]