====Script Function Index - By Name==== ===A=== [[activate]] - Activate an asset in the scene.\\ [[addbeacon]] - Add a shaft of light to indicate an asset location.\\ [[addimage]] - Add an image to the UI\\ [[addlinkedpoints]] - Add a set of linked points forming a line.\\ [[addmesh]] - Add a 3D model to the scene\\ [[addparticle]] - Add a source of particles (liquid/gas/rock etc.) to the scene.\\ [[addshape]] - Add a simple shape to the scene.\\ [[addquestion]] - Add a question to the questionnaire.\\ [[addsubcamera]] - Add a sub-camera to the scene\\ [[animateproperty]] - Change a asset property over time.\\ [[animateposition]] - Change an asset position over time\\ ===B=== [[behaviour]] - Enable or disable a behaviour. Internal use only\\ [[block]] - Wait for all script steps to complete.\\ ===C=== [[cameralookat]] - Turn the camera to look at a given object.\\ [[clearquestions]] - Clear all questions from the questionnaire.\\ [[cleanup]] - Removes all created items from the script so far.\\ ===D=== [[deactivate]] - Deactivate an asset in the scene.\\ [[disablevision]] - Prevent a property from being visible in vision modes.\\ [[duplicateobject]] - Make a copy of an existing object.\\ ===E=== [[enablevision]] - Allow a property to be seen in vision modes.\\ ===F=== [[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.\\ ===H=== [[highlightobject]] - Add a border around an object to highlight it.\\ [[highlightconnection]] - Highlight the flow path along a connection.\\ [[hide]] - Hide an asset or asset part.\\ [[hiderelationships]] - Remove any visible relationships\\ ===I=== [[indicators]] - Enable or disable 2D indicators\\ [[indicator]] - Add a visible indicator to the scene.\\ ===L=== [[lockrange]] - Lock the vision range.\\ [[lockcurrentrange]] - Lock the vision range to the //current// range.\\ ===M=== [[movecamera]] - Move the camera to a new position, relative to another asset.\\ ===P=== [[pause]] - Wait for a set number of seconds\\ [[pauselivedata]] - Prevent new live data from arriving.\\ [[perspective|Perspective]] - Move the camera to view an asset or set of assets\\ [[pinclear]] - Remove all pinned properties.\\ [[pinproperty]] - Pin a property\\ [[pointat]] - Rotate an item to look at a specific object\\ ===R=== [[refreshvision]] - Update the currently active vision mode\\ [[resumelivedata]] - Allow live data to resume.\\ [[remove]] - Remove an object from the scene.\\ [[removebeacon]] - Remove a beacon from the scene.\\ [[removeimage]] - Remove an Image from the UI.\\ [[removesubcamera]] - Remove a sub-camera by name.\\ [[removelastsubcamera]] - Remove the last sub-camera added.\\ [[runscript]] - Run a script from within a script.\\ ===S=== [[setproperty]] - Set an asset property instantly.\\ [[setposition]] - Set an asset position instantly.\\ [[setvalue]] - Set a hidden/developer property. Internal use only\\ [[show]] - Show an object hidden with [[hide]].\\ [[showlevel]] - Show or hide a level in the environment.\\ [[showonlyrelated]] - Remove all assets that aren't related to a given target\\ [[showrelationship]] - Show one relationship from a given asset\\ [[startquestionnaire]] - Start the questionnaire.\\ ===T=== [[texturemove]] - Make a texture animate\\ [[tourrelationship]] - Follow each of the assets along a relationship\\ ===U=== [[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.\\ [[unlockrange]] - Allow the range to float to suit the camera content\\ [[unpinproperty]] - Remove a pin.\\ ===V=== [[viewmedia]] - View an image or movie\\ [[visionmode]] - Change the vision mode\\ [[visionoption]] - Toggle visual options\\ [[voiceover]] - Play a voiceover or other audio file.\\ ===W=== [[waitforclick]] - Wait for the user to click the 'Next' button to proceed.\\