%object%.ListDescriptionDynamic 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 dynamic object.

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

Requirements

the object must be a dynamic object with a "When object is listed in location, display this" property containing text, otherwise this function will do nothing.

Properties

If the "Specifically exclude object from location descriptions" property is selected, then the "When the object is listed in location, display this" property is no longer available.

If the "When the object is listed in location, display this" property is selected, then you can enter a description that is to be printed whenever the player enters a new location or uses the "look" command.

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

PropertyListDescriptionDynamic.jpg

How to use

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


<<< StaticOrDynamicObject FunctionsListDescription >>>