%object%.ListDescription function

From ADRIFT 5 Manual Wiki
Jump to: navigation, search

This function returns the contents of the "When the object is listed in location, display this" property of a static object.

This is a text box, so the returned text can span multiple lines.

Requirements

If the object is not a static object with a "When the object is listed in location, display this" property containing text, then this function will do nothing.

Properties

The "Specifically list object in location descriptions" property must be selected before the "When the object is listed in location, display this" property becomes available.

If both of these properties are selected, then you can enter a description that is to be printed, following the location description, whenever the player types the "look" command or enters a new location.

This description will be printed after the location description and before the "Also here is.." message describing the other objects at that location.

PropertyListDescription.jpg

How to use

This function simply returns the contents of the "When the object is listed in location, display this" text box 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%.ListDescription
Prints the contents of the text box for an object referenced in a task.
  • Object12.ListDescription
Prints the contents of the text box for the object with the key "Object12"


<<< ListDescriptionDynamicObject FunctionsCapacity >>>