Difference between revisions of "%object%.ListDescriptionDynamic function"
(Created page with " <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER><<< StaticOrDynamic</TD><TD WIDTH="34%" ALIGN=CENTER>[[O...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | 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 Boxes|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. | ||
| + | [[File: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 Boxes|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 == | ||
| + | *<span style="color:green">%object%</span>.ListDescriptionDynamic | ||
| + | :Prints the contents of the text box for an object referenced in a task. | ||
| − | + | *<span style="color:red">Object12</span>.ListDescriptionDynamic | |
| − | + | :Prints the contents of the text box for the object with the [[key]] "Object12" | |
<TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%object%.StaticOrDynamic function|<<< StaticOrDynamic]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.ListDescription function|ListDescription >>>]]</TD></TABLE> | <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%object%.StaticOrDynamic function|<<< StaticOrDynamic]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.ListDescription function|ListDescription >>>]]</TD></TABLE> | ||
[[Category:Functions]] | [[Category:Functions]] | ||
Latest revision as of 10:36, 8 January 2013
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.
Contents
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.
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"
| <<< StaticOrDynamic | Object Functions | ListDescription >>> |
