Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
ardieffects:followarelationship [2020/09/11 02:38] – optrixardieffects:followarelationship [2025/12/18 22:50] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +=====FollowARelationship=====
 +
 +====Summary====
 +
 +This behaviour will start from a specified asset and follow through all of the relationships between assets based on a specified property and create a path listing each asset in the relationship.
 +
 +====Parameters====
 +
 +===StartingAsset===
 +
 +//Type: [[Integer]]
 +Default: **0**//
 +
 +The ARDI ID of the Asset to start following relationships from.
 +
 +===Relationship===
 +
 +//Type: [[text]]
 +Default: **Sequence**//
 +
 +The type of relationship to follow.
 +
 +===BasedOnProperty===
 +
 +//Type: [[property]]
 +Default: **None**//
 +
 +The name of the property that drives the asset between the start and end of the relationship. At 0% of the range of the property, the asset will be at the first asset, at 100% it will be at the last asset in the relationship.
 +
 +Let's say you have an elevator in a building. The elevator has a 'floor' property that ranges between -1 (the basement) to 5 (the fifth floor).
 +
 +If you set up an asset in the basement and an asset at the top floor and created a relationship between them, your asset would then 'follow' that relationship, allowing the elevator to move up and down the shaft appropriately. 
 +
 +===Offset===
 +
 +//Type:[[Vector3]]
 +Default: **1,1,1**//
 +
 +Add a positional offset for the path created by this behaviour.
 +
 +===ROffset===
 +
 +//Type:[[Vector3]]
 +Default: **0,0,0**//
 +
 +Add a rotational offset for the path created by this behaviour.
 +
 +===ConnectorAOffset===
 +
 +//Type: [[Integer]]
 +Default: **0**//
 +
 +Offsets the starting asset by a certain amount of jumps along the relationship.
 +
 +===ConnectorBOffset===
 +
 +//Type: [[Integer]]
 +Default: **0**//
 +
 +Offsets the ending asset by a certain amount of jumps along the relationship.
 +
 +===Minimum===
 +
 +//Type: [[float]]
 +Default: **None**//
 +
 +The minimum property value to accept. If the property value drops below this level, it is treated as the given number (ie. if the minimum is 7 and the property value is 4, the asset will animate as if the value was 7).
 +
 +===Maximum===
 +
 +//Type: [[float]]
 +Default: **None**//
 +
 +As //minimum//, but it limits the maximum value instead.
 +
 +===OnBadData===
 +
 +//Type: [[string]]
 +Default: **hold**//
 +
 +The action to take when the property value is //bad//. 
 +
 +This may be "zero", "hold" or "hide". 
 +
 +====Examples====
 +
 +<code>
 +<followarelationship startingasset="234" basedonproperty="Pressure" />
 +</code>
 +
 +> The above code will find the asset with the ARDI ID **234** and follow the relationship chain between it and each other asset based on the property named **Pressure**.
 +
  

ARDI

Welcome Guides

User Guides

Administrative

Sever
Other

API / SDK

Scripting

Addons / Drivers

Other Media