ARDI Documentation - ardieffects

AddToLevel

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

AddToLevel Summary This behaviour will add any asset in the scene to a level layer. The level layer it gets added to can be toggled on or off from the levels / layers page from the UI bar. When an asset is added, a level name must be specified. If no name is specified it will use the asset's name for the level name.

AlertProperty

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

AlertProperty Summary The AlertProperty effect adds an alert that only exists at runtime (ie. only when ARDI-VE is running). They are often used to drive cosmetic effects based on calculations that aren't being performed in your existing control or information management system(s).

AnalogueTint

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

AnalogueTint Summary The AnalogueTint effect applies a colour tint to a 3D model based on an anlogue value, meaning that the colour gets more pronounced as the value reaches given maximum or minimum values. A similar effect, Tint, is available for Boolean values, such as the status of a motor or valve.

Animate

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Animate Summary The animate effect is used to link an animation to an analogue value. When the value is at its lowest, the first frame of the animation plays. When the value is at its highest, the last frame animation plays. And of course where the value is anywhere in between, the animation plays in a proportional state.

Asset

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Asset The name or number of an ARDI asset, or the path to a component of an ARDI asset. There are a few different ways the asset can be specified... By Number If you place a '#' at the start of this attribute, then the system searches for an ARDI ID (the unique ID number in ARDI for the asset).

Autofocus

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Autofocus Summary The autofocus function changes the behaviour of the Perspective script command. Normally, when you call perspective with the 'all' target, ARDI will then change the view to show every asset in the scene. This will also have an effect on the speed of camera movement. Your camera moves at a speed determined by the size of the scene. This function also limits the assets used in that calculation, which can have the effect of noticeably reducing the camera speed.

Bindable

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Bindable Bindable attributes are attributes that can be linked to the properties of an ARDI asset. For example, you might assign the Tint effect to an asset to change its colour and shade it in red. For example...

Binding Expressions

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Binding Expressions Expressions allow you to connect ARDI properties to the effects you apply in ARDI-VE. You can substitute a property where you'd normally have any string or numeric value in your effects. For example, you could have the following....

Boolean

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Boolean Boolean properties have only two possible values - on or off. To specify one of these values, you can use any of the following... Off ValueOn Value01noyesfalsetrue Some boolean properties are also Bindable, allowing you to toggle them on or off based on state.

Colour

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Colour A colour is given as a set of four numbers, separated by commas. The numbers are decimal between 0 and 1, each representing one colour of the RGB colour space, plus an 'alpha' (transparency) factor. Here are some common values... RGBA Code

Measure

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Measure Summary The Measure effect adds an additional property to the asset that measures the distance between two assets in the scene. Available since version 2880 Parameters PointA Type: Asset Default: This Asset The name or path to the asset you would like to measure

Enum

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Enum Note that this documentation is describing an 'enum', the effect parameter. If you are looking for the Enumeration properties type, please see the appropriate section. An enum lets you choose from a set of pre-defined options. These are normally text-based. In most cases, a chart in the documentation for the parameter will explain the available options.

Filenames

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Filenames Filenames in ARDI effects are always relative to the script file. So when you load a script from the hard drive at My Documents\Optrix\ARDI\Scripts\Script.xml, and ask for a file with a path of “Voiceover.ogg”, the path will be converted to

FitAsset

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

FitAsset Summary This behaviour allows you to specify 3 points in which to stretch an asset by. The asset will be centered on the “Origin” point and then stretched along the “Right” and “Back” points. The 3 points can be specified as either world co-ordinate points or actual assets in the scene.

FlatIndicator

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

FlatIndicator Summary Creates a large 'billboard' (a sign that floats in the air and orients itself towards your camera). This is used to point out specific items of interest in the scene, or to display text information related to an asset. Parameters

Float

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Float A float is a floating-point number (one with an optional decimal point). In scripts, floating point numbers are usually fixed. In effects, most floating point numbers are Bindable.

FollowARelationship

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

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

FollowAsset

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

FollowAsset Summary This function allows you to make an asset follow another asset in the scene. Parameters Asset Type:Text Default: None The Name or ARDI ID of the Asset you wish to follow. The asset containing this behaviour will maintain a position relative to the asset specified by the

HighlightNeighbours

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

HighlightNeighbours Summary This behaviour will find the associated assets based on a specified relationship and highlight them. Parameters Relationship Type: Property Default: None The property to check relationships with the asset containing the behaviour.

Icon

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Icon Summary This behaviour will display an icon over the containing asset. Parameters Property Type: Property Default: None The ARDI ID of an associated property on the containing asset. This value will be shown on the Icon. Offset Type: Vector3 Default: 0,1,0

IconTexture

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

IconTexture Summary This behaviour allows you to change the texture of an asset in response to data. Parameters Property Type: Text Default: None The name of the property in which will trigger the change in texture. Color Type: RGBA Color Default: 0,0,0,1

Imobile

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Imobile Summary Informs ARDI-VE that the asset and all of it's component parts are not capable of movement. This is an optimisation effect - by disabling movement on the asset, the frame-rate of your scene is improved, as fewer physics calculations have to be carried out.

ARDI Effects Documentation Index

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

ARDI Effects Documentation Index What Are Effects While scripts allow you to create a set of events that play once, effects allow you to change the way your assets behave at all times. As well as simply describing a basic effect - for example, that an asset spins - you can link individual properties of that effect to the attributes of your assets. So your rate of spin can be controlled by how fast the real object is spinning.

ARDI Effects Index - By Function

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

ARDI Effects Index - By Function Camera Control Autofocus - Change camera focus priority Movement and Animation FollowAsset - Follow an asset, but don't rotate along with it. Animate - Play a baked-in animation based on an analogue value FollowARelationship - Move an asset along a relationship between other assets.

ARDI Effects Index - By Name

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

ARDI Effects Index - By Name A AlertProperty - Create a runtime alert based on a property value AnalogueTint - Paint / colour an asset Animate - Play a baked-in animation based on an analogue value Autofocus - Change camera focus priority AddToLevel - Add an asset to a specific level in the scene

Integer

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Integer Integer numbers are whole numbers with no decimal point or fractional representative.

LightingFollow

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

LightingFollow Summary Adjusts the primary light (the light that is usually positioned at the center of your scene) to follow a specified distance from the asset. This is quite useful if the majority of your assets move - by attaching the light to a mobile asset, you ensure that the areas of interest are well lit.

List

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

List A list is a way of sending multiple values for a single property. In this case, the values are placed together in a single piece of text, with a symbol (usually a '|' symbol) separating them. For example, if you'd like to send three numbers in a set called 'ladder', and separated by '|', you'd use the following

LockLayer

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

LockLayer Summary This behaviour allows you to lock a layer to an assets altitude level. The containing asset will have the specified layer name locked to its height level. Parameters LayerName Type: Text Default: None The name of the layer to lock to the containing asset.

Magnify

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Magnify Summary The magnify effect is used to make small objects more visible in vision modes by enlarging them. The effect only operates when the user chooses a vision mode that causes other objects to fade away. It then stops as soon as the normal vision mode is restored.

Math

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Math Summary This behaviour will create a mathematical property containing two float values which can be used by other assets and properties to perform calculations. For example, by creating an “addition” property and assigning it the + value, other properties can set values A and B to appropriate numerical values to find the result of those two values added together mathematically.

Occluded

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Occluded Summary This asset is marked as being occluded (hidden by) other assets. When this asset is selected, any parent asset along the relationships you nominate (defaulting to Model and Location) are faded out to allow you to properly see this asset.

OffsetModel

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

OffsetModel Summary The OffsetModel effect puts a random amount of 'offset' between the position of the object and the location where the 3D model is drawn. This is primarily used when you might have crowds of items in a single position - by adding a random offset to each of the assets, the models appear

Parent

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Parent Summary Parameters Offset Type: Vector3 Default: 2,0,0 The positional offset to maintain the following asset in relation to the target parent asset. ROffset Type: Vector3 Default: 0,0,0 The rotational offset to maintain the following asset in relation to the target parent asset.

Effect Paths

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Effect Paths A path allows you to select a 3D model (or a component of a 3D model) from your scene. They work in a similar way to directory paths on your hard drive, using a slash (/) character to separate the individual elements. For example, if you had an object called

PinProperty

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PinProperty Summary This behaviour will allow you to add a property to the pin list. Parameters Property Type: Property Default: None The name of the property to be pinned. Properties must be specified as “ARDI ID:PropertyName”. Examples

Pivot

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Pivot Summary This behaviour allows you to pivot the containing asset around a specific axis by a specified amount. Parameters Amount Type: Float Bindable Default: 45 The amount to pivot around the specified axis. Axis Type: Vector3 Default: 0,0,1 The axis to pivot the asset around. Values are defined as the axis X, Y and Z respectively with normalized values between 0 and 1. For example, a value of 0,1,0.5 will pivot with strength 0 on the X axis, 0.5 on the Y axis, and 1 on the Z axi…

PreventAnimation

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PreventAnimation Summary The PreventAnimation effect changes the animation mode of a specific property to ensure that ARDI doesn't animate it. It's used when a change in the value of an analogue shouldn't involve a smooth transition between the two states - instead, it should immediately snap to the new value.

Property Name

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Property Name A property name parameter is allows you to specify a property name to read from. Note that the property will be expected to exist on the appliesto asset.

Property

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Property Properties in ARDI's Virtual Environment are values that are contained by assets pertaining to the detailed information of each asset.

RepeatChildren

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

RepeatChildren Summary This behaviour will find the first child of the containing asset and create as many duplicates as needed to fill out the length of the asset along its longest axis. Parameters This behaviour takes no parameters Examples

RGBA Color

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

RGBA Color RGBA Color values are assigned with 4 Float values separated using a comma. Each value corresponds to its Red, Green, Blue and Alpha values respectively.

Set

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Set When talking about the scripting and effect system, a set is a way to send a number of pieces of information easily. Each item in the set is sent as it's own attribute with a number index - for example, if you'd like to send three numbers in a set called 'ladder', you'd use the following

SetDefault

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

SetDefault Summary Adjusts the value of an ARDI-VE internal setting - modifies a core behaviour of ARDI across the scene. Parameters Name Type: Strings Default: none The name of the option to change. NameMeaningambientThe ambient colour - the value parameter should be a colour made up of red, green, blue and intensity, all between 0 and 1.

ShowGrid

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

ShowGrid Summary Creates a visual grid plane to help with positioning and modifications. Parameters CX Type: Float Default: 0 The X value of the corner of the grid. CY Type: Float Default: 0 The Y value of the corner of the grid. CZ Type: Float Default:

ShowSequenceMarkers

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

ShowSequenceMarkers Summary This behaviour will show visible markers that indicate the sequence of a relationship. These appear as large, floating arrows that point towards the asset showing their sequence number (ie. 1 for the first item, 2 for the second).

Spin

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Spin Summary The Spin effect continually rotates an object. This is usually used on moving equipment to replicate real world spin on machines such as cutters, drives, fans and agitators. This effect often uses the appliesto and enabled properties.

Standard Effect Properties

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Standard Effect Properties Almost all effects accept the following two properties... Enabled Boolean Bindable Default: 1 This property controls if the effect is being applied. Toggling the enabled property on and off can be used to control colouring, animations etc. that should only apply in certain conditions.

Stretch

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Stretch Summary The stretch effect allows you to stretch a 3D model along a path. This is primarily used when creating conveyors, allowing you to take a model of a small conveyor and convert it into an arbitrarily large and complex one. The model is stretched along 'control points' (3D coordinates), the first being the position of the asset itself.

StretchBetween

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

StretchBetween Summary This behaviour will stretch the containing asset to fill the gap inbetween two other assets. Parameters Origin Type: Text Default: None The Name or ARDI ID of the first asset to stretch between. Target Type: Text Default: None

Strings

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Strings A string is just free-form text. Note that due to XML restrictions, if you would like to include a quote (“) or ampersand (&) character in your string, you need to escape it. To escape XML, you'll need the following substitutions.... Character

Text

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Text Text properties are often simply that - plain text. They don't require any special formatting. However, check the description of the function you are using - certain text properties also have special values that may be relevant.

Text

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Text Summary This behaviour will add a floating text box that is positioned in front of the object. Parameters Text Type: Text Bindable Default: None The text to be displayed on the label. This is usually bound to a property value. Label Type: Text Default:

Texture

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Texture Summary This behaviour will change the texture of an asset based on a property. As the values of the chosen property updates, the assets texture will switch between its original texture and the chosen texture. Parameters Property Type: Effect Paths Default: None

TextureMove

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

TextureMove Summary This behaviour will cause the asset's texture to scroll to create moving or rolling texture. This can be used to create simulated effects such as moving conveyors or running water. Parameters Speed Type: Float Bindable Default: 1

Tint

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Tint Summary The Tint effect colours an asset. In most cases, the Enabled parameter is used to toggle the colour on and off based on a condition. Parameters ColourA Type: Colour Bindable Default: 1,0,0,1 The primary colour for the object to turn. If Flashrate

Trace

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Trace Summary This behaviour will trace an assets movement, causing it to leave a trail as it moves. Parameters Axis Type: Vector3 Default: 0,1,0 The axis from which to dispense a trail. Values must be entered as X, Y, Z respectively. Cut Type: Float Default:

TranslucentInVisionMode

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

TranslucentInVisionMode Summary The TranslucentInVisionMode effect alters an asset so that it appears translucent rather than opaque when being viewed in a vision mode. This is ideally suited to situations where a container has an attribute that may be present on children within it.

Unselectable

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Unselectable Summary The Unselectable effect disables user selection of the asset. Some assets are presented as visual effects - the information they provide is completely apparent from other effects, so there is little reason the user would have for clicking on them.

Vector2

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Vector2 A Vector2 is a comma-separated set of two numbers. These numbers are floating point numbers, meaning that they can be fractional numbers (ie 0.25). You can optionally leave spaces after the comma, between the two digits. For example, a Vector2 giving two numbers, 25.6 and 2.5 would look like the sample below

Vector3

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Vector3 A Vector3 is a position in 3D space, consisting of length, depth and height (often refered to as 'X', 'Y' and 'Z'). Each of the numbers are separated by a comma. So if you would like to nominate that there is something at 12m across, 2m back and 5m up, you would use the following

Vibrate

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Vibrate Summary This behaviour will cause the asset to vibrate rotationally. Parameters Amount Type: Float Default: 5 The amount in which the asset will rotate per vibration. Speed Type: Float Default: 1 The speed at which the asset will vibrate. Axis

VibratePos

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

VibratePos Summary This behaviour causes the asset to vibrate positionally. Parameters Amount Type: Float Default: 5 The distance in which the asset will move per vibration. Speed Type: Float Default: 1 The speed at which the asset will vibrate. Axis

VideoPanel

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

VideoPanel Summary This behaviour allows you to create a video panel from a streaming video feed and attach it to an asset in the scene. Parameters FeedName Type: Text Default: none The name of the video feed you wish to have displayed. Offset

Visibility

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Visibility Summary The Visibility effect makes the asset invisible. If you use the enabled property, the asset is invisible when the effect enabled, and visible when disabled. Parameters IncludeChildren Type: Boolean Default: true If true, all items underneath this asset - including possibly other assets - will become invisible too.

VisibleInRange

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

VisibleInRange Summary The VisibleInRange effect makes the object invisible if a given property is outside its valid range (or in an error state). Parameters Property Type: Text Default: None The name of the property to base the effect on. When this property goes out of range or invalid, the asset will disappear.