| Parameter | Type | Description | Default value |
|---|---|---|---|
text | string | name of the message from strings\short.str to display (if the Book→Text property is not set) | — |
text_color | color | color to display the message in | 0xffffff (white) |
text_time | time | how long to display the message | (calculated based on message length) |
text_on_frob | boolean | whether to display the message when frobbed | true |
text_on_focus | boolean | whether to display the message when focused | true |
When frobbed and/or focused, KDShortText displays text in an on-screen message of the specified color for the specified time. The Book→Text property, if present, gives the name of a message in the strings\short.str file; otherwise, the text parameter gives the name of the message. This structure allows for cleaner updating and translation of short readables without requiring a separate .str file for each.
If the text_on_frob parameter is true and the World Action of the object's Engine Features→FrobInfo property includes “Script”, the message will be displayed when the object is frobbed (clicked).
If the text_on_focus parameter is true and the World Action of the object's Engine Features→FrobInfo property includes “FocusScript”, the message will be displayed when the object is focused (highlighted/pointed to).