Difference between revisions of "%object%.AtLocationGroup function"
From ADRIFT 5 Manual Wiki
(Created page with " <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER><<< Weight</TD><TD WIDTH="34%" ALIGN=CENTER>Object Functions<...") |
|||
| Line 1: | Line 1: | ||
| + | This function returns the [[key]] of the [[Groups/Classes|location group]] in which the selected static object is located. | ||
| + | == Requirements == | ||
| + | *This function will not work for dynamic objects, or if the object is part of an object or character, in a single location, or if it is hidden. | ||
| + | :If you cannot be certain that the object is within a location group, then you must use the following restriction in the [[Tasks|task]] or an [[Alternate Descriptions|alternate description]] to ensure that it is. | ||
| + | [[File:RestrictionObjectInLocationGroup.jpg]] | ||
| + | == Properties == | ||
| + | When the "Initial Location" property is set to "Location Group", the second drop-down list will contain a list of the location groups. | ||
| + | Selecting a Location group determines which group will be returned by the AtLocationGroup function. | ||
| + | [[File:PropertyLocationGroup.jpg]] | ||
| + | == How to use == | ||
| + | AtLocationGroup obtains the [[key]] of the group. | ||
| − | + | == Examples == | |
| − | + | As well as the %object% reference, you can use the key of an object, or any function that returns the key of an object with this function: | |
| − | + | *<span style="color:red">Object4</span>.AtLocationGroup | |
| − | + | :This example obtains the location of the object who's [[key]] is Object4, then prints the key of the location group. | |
| − | + | ||
| − | + | ||
| − | + | ||
<TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%object%.Weight function|<<< Weight]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.Children function|Children >>>]]</TD></TABLE> | <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%object%.Weight function|<<< Weight]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Object Functions]]</TD><TD ALIGN=CENTER>[[%object%.Children function|Children >>>]]</TD></TABLE> | ||
[[Category:Functions]] | [[Category:Functions]] | ||
Revision as of 06:36, 26 January 2013
This function returns the key of the location group in which the selected static object is located.
Contents
Requirements
- This function will not work for dynamic objects, or if the object is part of an object or character, in a single location, or if it is hidden.
- If you cannot be certain that the object is within a location group, then you must use the following restriction in the task or an alternate description to ensure that it is.
Properties
When the "Initial Location" property is set to "Location Group", the second drop-down list will contain a list of the location groups. Selecting a Location group determines which group will be returned by the AtLocationGroup function.
How to use
AtLocationGroup obtains the key of the group.
Examples
As well as the %object% reference, you can use the key of an object, or any function that returns the key of an object with this function:
- Object4.AtLocationGroup
- This example obtains the location of the object who's key is Object4, then prints the key of the location group.
| <<< Weight | Object Functions | Children >>> |
