This is an old revision of the document!
Script Function Index - By Category
Audio
VoiceOver - Play a voiceover or other audio file.
Control
Block - Wait until previous steps have completed.
Pause - Wait a set amount of time
WaitForClick - Wait until the user clicks 'next'
Behaviour - Enable or disable a behaviour. Internal use only
RunScript - Run another script file from within a script
Camera Control
CameraLookAt - Turn the camera to look at a given object.
LockRange - Lock the vision range.
LockCurrentRange - Lock the vision range to the current range.
Perspective - Move the camera to look at asset(s)
MoveCamera - Move the camera to a new position, relative to another asset.
UnlockRange - Allow the range to float to suit the camera content
Creation and Destruction
AddMesh - Add a 3D mesh to the scene.
AddShape - Add a simple 3D shape to the scene.
AddBeacon - Add a pillar of light to highlight an asset.
AddParticle - Add a source of particles (liquid/gas/rock etc.) to the scene.
DuplicateObject - Make a copy of an existing object.
Indicator - Add a visible indicator to the scene.
Remove - Remove an object created with an 'add' function
RemoveBeacon - Remove a beacon from the scene.
Images
AddImage - Adds an image to the UI.
RemoveImage - Removes an image from the UI.
Properties
AnimateProperty - Animates a property value
SetProperty - Sets a property immediately
PauseLiveData - Prevent new live data from arriving.
PinClear - Remove all pinned properties.
PinProperty - Pin a property
ResumeLiveData - Allow live data to resume.
SetValue - Set a hidden/developer property. Internal use only
UnPinProperty - Remove a pin.
Relationships
HideRelationships - Remove any visible relationships
ShowOnlyRelated - Remove all assets that aren't related to a given target
ShowRelationship - Show one relationship from a given asset
TourRelationship - Follow each of the assets along a relationship
SubCameras
AddSubCamera - Adds a sub-camera to the scene.
RemoveSubCamera - Removes a sub-camera from the scene by name.
RemoveLastSubCamera - Removes the last sub-camera added.
Movement
AnimatePosition - Move an object to a new position
PointAt - Rotate an item to look at a specific object
SetPosition - Set an asset position instantly.
TextureMove - Make a texture animate
Questionnaire
AddQuestion - Add a question to the Questionnaire
ClearQuestions - Remove all Questions from the Questionnaire
StartQuestionnaire - Begin the Questionnaire
Visibility
Activate - Activate an asset in the scene.
Deactivate - Deactivate an asset in the scene.
Fade - Make an asset fade out.
FadeEverythingBut - Hide all assets except for a given one.
FadeFrom - Fade the whole screen from a colour.
FadeUntagged - Hide all assets not part of a given type.
FadeTag - Make all assets of a given type fade out.
FadeTo - Fade the whole screen to a colour.
Highlight - Add a border around an object to highlight it.
HideObject - Hide an asset or asset part.
Indicators - Enable or disable 2D indicators
ShowObject - Show an object hidden with HideObject.
UnFadeTag - Unfade any assets of a given type
UnFadeEverything - Unfade everything that has been faded out
UnFade - Make an invisible asset visible again
UnHighlight - Remove a highlight effect from an object in the scene.
Vision Modes
DisableVision - Prevent a property from being visible in vision modes.
EnableVision - Allow a property to be seen in vision modes.
RefreshVision - Update the currently active vision mode
VisionMode - Change the vision mode