Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
ardiscript:indexbyfunction [2018/04/18 01:19] optrix |
ardiscript:indexbyfunction [2019/02/26 23:24] (current) optrix |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====Script Function Index - By Category==== | ====Script Function Index - By Category==== | ||
| + | |||
| + | ===Audio=== | ||
| + | [[voiceover]] - Play a voiceover or other audio file.\\ | ||
| ===Control=== | ===Control=== | ||
| Line 5: | Line 8: | ||
| [[pause]] - Wait a set amount of time\\ | [[pause]] - Wait a set amount of time\\ | ||
| [[waitforclick]] - Wait until the user clicks 'next'\\ | [[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=== | ===Camera Control=== | ||
| - | [[perspective|Perspective]] - Move the camera to look at asset(s) | + | [[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|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=== | ===Creation and Destruction=== | ||
| - | [[addmesh]] - Add a 3D mesh to the scene.\\ | + | [[addlinkedpoints]] - Add a set of points to the scene linked by a visual path\\ |
| - | [[addshape]] - Add a simple 3D shape to the scene.\\ | + | [[addmesh]] - Add a 3D mesh to the scene\\ |
| - | [[addbeacon]] - Add a pillar of light to highlight an asset.\\ | + | [[addshape]] - Add a simple 3D shape to the scene\\ |
| - | [[remove]] | + | [[addbeacon]] - Add a pillar of light to highlight an asset\\ |
| + | [[addparticle]] - Add a source of particles (liquid/gas/rock etc.) to the scene\\ | ||
| + | [[cleanup]] - Delete all created objects and applied effects\\ | ||
| + | [[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\\ | ||
| + | |||
| + | ===Media=== | ||
| + | [[addimage]] - Adds an image to the UI\\ | ||
| + | [[removeimage]] - Removes an image from the UI\\ | ||
| + | [[viewmedia]] - View an image or movie\\ | ||
| ===Properties=== | ===Properties=== | ||
| - | [[setproperty]] - Sets a property immediately\\ | ||
| [[animateproperty]] - Animates a property value\\ | [[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=== | ===Movement=== | ||
| [[animateposition]] - Move an object to a new position\\ | [[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.\\ | ||
| + | [[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.\\ | ||
| + | [[indicators]] - Enable or disable 2D indicators\\ | ||
| + | [[show]] - Show an object hidden with [[hide]].\\ | ||
| + | [[showlevel]] - Show or hide a level in the virtual environment.\\ | ||
| + | [[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.\\ | ||
| + | [[magnify]] - Enlarge or shrink an asset while being viewed within a vision mode.\\ | ||
| + | [[refreshvision]] - Update the currently active vision mode\\ | ||
| + | [[visionmode]] - Change the vision mode\\ | ||