Difference between revisions of "%object%.ListDescription function"
(Created page with " <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER><<< ListDescriptionDynamic</TD><TD WIDTH="34%" AL...") |
(Preliminary version) |
||
| Line 1: | Line 1: | ||
| + | This function returns the contents of the "...and description when read" property of an object. | ||
| + | This is a [[Text Boxes|text box]], so the returned text can span multiple lines. | ||
| + | == Requirements == | ||
| + | If the object does not have a "...and description when read" property containing text, then this function will do nothing. | ||
| + | This function does '''NOT''' default to the object description or print the "there is nothing worth reading" message like the "read %object%" command. Those outputs are produced by restriction messages and alternate descriptions in the standard library. | ||
| + | == Properties == | ||
| + | The "Object is Readable" property must be selected before the "...and description when read" property becomes available. | ||
| + | If the "...and description when read" property is also selected, then you can enter a description that is to be printed whenever the player enters the "read %object%" command. | ||
| + | [[File:PropertyListDescription.jpg]] | ||
| + | == How to use == | ||
| + | This function simply returns the contents of the "...and description when read" 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>.ListDescription | ||
| + | :Prints the contents of the read-text text box for an object referenced in a task. | ||
| − | + | *<span style="color:red">Object12</span>.ListDescription | |
| − | + | :Prints the contents of the read-text text box for the object with the [[key]] "Object12" | |
<TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%object%.ListDescriptionDynamic function|<<< ListDescriptionDynamic]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.Capacity function|Capacity >>>]]</TD></TABLE> | <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%object%.ListDescriptionDynamic function|<<< ListDescriptionDynamic]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.Capacity function|Capacity >>>]]</TD></TABLE> | ||
[[Category:Functions]] | [[Category:Functions]] | ||
Revision as of 08:29, 8 January 2013
This function returns the contents of the "...and description when read" property of an object.
This is a text box, so the returned text can span multiple lines.
Contents
Requirements
If the object does not have a "...and description when read" property containing text, then this function will do nothing.
This function does NOT default to the object description or print the "there is nothing worth reading" message like the "read %object%" command. Those outputs are produced by restriction messages and alternate descriptions in the standard library.
Properties
The "Object is Readable" property must be selected before the "...and description when read" property becomes available.
If the "...and description when read" property is also selected, then you can enter a description that is to be printed whenever the player enters the "read %object%" command.
How to use
This function simply returns the contents of the "...and description when read" 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 read-text text box for an object referenced in a task.
- Object12.ListDescription
- Prints the contents of the read-text text box for the object with the key "Object12"
| <<< ListDescriptionDynamic | Object Functions | Capacity >>> |
