Difference between revisions of "%object%.ReadText function"
(Created page with " <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER><<< WornByWho</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functi...") |
|||
| 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 == | ||
| + | This function can only be used with an object that has the "Object is Readable" property selected. | ||
| + | You can test this using the object restriction: | ||
| + | : [''object''] [must] [have property] [Object is Readable] | ||
| + | == 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:PropertyObjectRead.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>.ReadText | ||
| + | :Prints the contents of the read-text text box for an object referenced in a task. | ||
| − | + | *<span style="color:red">Object12</span>.ReadText | |
| − | + | :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%.WornByWho function|<<< WornByWho]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.Description function|Description >>>]]</TD></TABLE> | <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%object%.WornByWho function|<<< WornByWho]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.Description function|Description >>>]]</TD></TABLE> | ||
[[Category:Functions]] | [[Category:Functions]] | ||
Revision as of 00:46, 14 December 2012
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
This function can only be used with an object that has the "Object is Readable" property selected.
You can test this using the object restriction:
- [object] [must] [have property] [Object is Readable]
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%.ReadText
- Prints the contents of the read-text text box for an object referenced in a task.
- Object12.ReadText
- Prints the contents of the read-text text box for the object with the key "Object12"
| <<< WornByWho | Object Functions | Description >>> |
