Difference between revisions of "%object%.StaticLocation function"
(Created page with " <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER><<< DynamicLocation</TD><TD WIDTH="34%" ALIGN=CENTER>[[O...") |
|||
Line 1: | Line 1: | ||
+ | The StaticLocation function returns the type of the parent of the selected static object, which will be one of "Hidden", "Held by Character", "Worn by Character", "In Location", "Inside Object" or "On Object". | ||
+ | == Requirements == | ||
+ | This function can only be used with '''static''' objects. If this function is used in a task with an %object% reference, then use the following restriction to ensure that the object selected by the player is static. | ||
+ | [[File:RestrictionObjectStatic.jpg]] | ||
+ | == Properties == | ||
+ | The "Location of the object" property of the object has a drop-down list containing the six possible settings for this state-list property. Selecting one of these states determines which location type will be returned by the StaticLocation function. | ||
+ | [[File:PropertyStaticLocation.jpg]] | ||
+ | == How to use == | ||
+ | This function simply returns the type of location, of the object's location, as a string of 1 to 3 words that can be inserted into text. | ||
+ | No further functions can be appended to it. | ||
+ | == Examples == | ||
+ | *<span style="color:red">Object7</span>.StaticLocation | ||
+ | : The Location of a specific object. | ||
− | + | *<span style="color:green">%character%</span>.StaticLocation | |
− | + | : The Location of the referenced object, in a task with an %object% reference. | |
− | + | ||
− | + | ||
− | + | ||
<TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%object%.DynamicLocation function|<<< DynamicLocation]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.LockStatus function|LockStatus >>>]]</TD></TABLE> | <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%object%.DynamicLocation function|<<< DynamicLocation]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.LockStatus function|LockStatus >>>]]</TD></TABLE> | ||
[[Category:Functions]] | [[Category:Functions]] |
Revision as of 02:33, 14 December 2012
The StaticLocation function returns the type of the parent of the selected static object, which will be one of "Hidden", "Held by Character", "Worn by Character", "In Location", "Inside Object" or "On Object".
Contents
Requirements
This function can only be used with static objects. If this function is used in a task with an %object% reference, then use the following restriction to ensure that the object selected by the player is static.
Properties
The "Location of the object" property of the object has a drop-down list containing the six possible settings for this state-list property. Selecting one of these states determines which location type will be returned by the StaticLocation function.
How to use
This function simply returns the type of location, of the object's location, as a string of 1 to 3 words that can be inserted into text. No further functions can be appended to it.
Examples
- Object7.StaticLocation
- The Location of a specific object.
- %character%.StaticLocation
- The Location of the referenced object, in a task with an %object% reference.
<<< DynamicLocation | Object Functions | LockStatus >>> |