%object%.DynamicLocation function

From ADRIFT 5 Manual Wiki
Revision as of 01:25, 14 December 2012 by Saabie (Talk | contribs) (requirements)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The DynamicLocation function returns the type of the parent of the selected dynamic 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 dynamic 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 dynamic.

RestrictionObjectDynamic.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 DynamicLocation function.

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

  • Object7.DynamicLocation
The Location of a specific object.
  • %character%.DynamicLocation
The Location of the referenced object, in a task with an %object% reference.


<<< DescriptionObject FunctionsStaticLocation >>>