%object%.AtLocationGroup function

From ADRIFT 5 Manual Wiki
(Redirected from AtLocationGroup)
Jump to: navigation, search

This function returns the key of the location group in which the selected static object is located.


  • 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.



The initial location of the object is set using two drop-down lists on the description page. The first list sets the "Location of the object" property, and setting this determines which property will be set by the second list. 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.


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.

<<< WeightObject FunctionsChildren >>>