Difference between revisions of "Callback: Customized building name"

From GRFSpecs
Jump to navigationJump to search
(use new grf templates)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
== House customized building name (14D) ==
 
== House customized building name (14D) ==
   
This callback is activated from the Tile Description Query tool, when enquiring a house.  Variable 10 will be set to 1 if the house is complete, otherwise it will be 0.  The return value is the "xx" of a D0xx text ID.  If the callback fails, the Query tool will use the house name set in property 12 (Building name ID).
+
This callback is activated from the Tile Description Query tool, when enquiring a house. Bit 0 of variable 10 will be set to 1 if the house is complete, otherwise it will be 0.
   
  +
{|
{{grfFrom|8}} For GRF version 8 and above you can also return 400 to display the name from the property. (instead of failing the callback).
 
  +
|-
  +
!Return value!!Version!!Meaning
  +
|-
  +
|0000..03FF|| ||D0xx text to display.
  +
|-
  +
|0400||{{grfFrom|8}}||Display usual text from property 12 (same as callback failure).
  +
|-
  +
|040F||{{ottdp|15|no}}||Display text using text ID from register 0x100 (not limited to D0xx texts).
  +
|}
   
 
Since this callback is not performed frequently, you do not need to specify a mask.  It will always be performed, and the name will only change when successful.
 
Since this callback is not performed frequently, you do not need to specify a mask.  It will always be performed, and the name will only change when successful.

Latest revision as of 13:54, 13 May 2025

House customized building name (14D)

This callback is activated from the Tile Description Query tool, when enquiring a house. Bit 0 of variable 10 will be set to 1 if the house is complete, otherwise it will be 0.

Return value Version Meaning
0000..03FF D0xx text to display.
0400 GRFv≥8 Display usual text from property 12 (same as callback failure).
040F Supported by OpenTTD 1515 Not supported by TTDPatch Display text using text ID from register 0x100 (not limited to D0xx texts).

Since this callback is not performed frequently, you do not need to specify a mask.  It will always be performed, and the name will only change when successful.

Available for OpenTTD since r15172, and for TTDPatch since TTDPatch 2.6r2249