%object%.Description function
From ADRIFT 5 Manual Wiki
This function returns the contents of the "Description" text box of an object.
This is a text box, so the returned text can span multiple lines.
Using the Description function on the above object will produce:
It is a very simple desk with a flat top and four round legs, just big enough to fit a chair under. |
How to use
This function prints the contents of the "Description" text box on the main page of an object, as one or more lines of text. No further functions can be appended to this function.
If the text box has Alternate Descriptions then the text that is printed will be effected by the restrictions and composition setting of each alternate description.
Examples
- %object%.Description
- Description of the object referenced in a task.
- Object12.Description
- Description of object with the key "Object12"
<<< ReadText | Object Functions | DynamicLocation >>> |