Designer Functions - Modulo Kinetic user manual

Description

Designer functions were added in version 5.1/6 of Kinetic Designer.

They enable the operator to control different aspects of the current show directly from within a Javascript node.

Functions should be called with the prefix designer. in the javascript
When passing String arguments, take care to use double quotes " around the string. i.e. ("String argument")
When passing boolean arguments use true or false
Take care that all arguments are filled for a function when calling it or the function call will be ignored by the script.
When certain arguments can be omitted from function calls, the manual page will explicitly describe all possible syntaxes.

launchTask()	Launch a task
setEnableTask()	Toggle a task enabled/disabled
setEnableTriggerTask()	Toggle the trigger of a task on/off
launchTaskFolder()	Launch a folder of tasks
launchRandomTaskFolder()	Launch a random task in a folder of task

setOnTimeline()	Toggle a timeline on/off
setPlayTimeline()	Send Play command to a timeline
setLocateTimeline()	Send Pause command to a timeline and/or locate at a timecode in the timeline
setGrandMasterTimeline()	Change the value of a timeline’s GrandMaster fader
setAudioMasterTimeline()	Change the value of a timeline’s Master Audio fader
getOnTimeline()	Receive on/off status from a timeline
getPlayTimeline()	Receive play status from a timeline
getTimecodeTimeline()	Receive the current timecode value of a timeline
getGrandMasterTimeline()	Receive the current value of a timeline’s GrandMaster fader
getAudioMasterTimeline()	Receive the current value of a timeline’s Master Audio fader
setLockToTcTimeline()	Lock a timeline to a timecode
getLockToTcTimeline()	Get the timeline lock information

Toggle a device on/off

Toggle a graph on/off

setVariableValue()	Set a value to a variable
getVariableValue()	Get the current value of a variable
setVariableAddOne()	Increment a variable by one. Works for types `int`, `float` and `double`
setVariableSubOne()	Decrement a variable by one. Works for types `int`, `float` and `double`

launchAnimationScene3D()	Launch an animation in a 3D scene
stopAnimationScene3D()	Stop an animation in a 3D scene
setInstanceMaterialScene3D()	Change the material of an object (instance) in a 3D scene
enableNodeScene3D()	Toggle a node in a 3D scene on/off
deleteAllRunningInstances()	Deletes all instances that were created using the Instantiate 3D node in a 3D Scene
deleteRunningInstance()	Deletes a target instance created using the Instantiate 3D node in a 3D Scene
deleteAnimation3D()	Deletes a target animation track in a 3D Scene
deleteMaterial3D()	Deletes a target material in a 3D Scene
deleteSkeleton3D()	Deletes a target skeleton in a 3D Scene
deleteNode3D()	Deletes a target node in a 3D Scene
instantiateNodeWithAnim3D()	Instantiates a node as a copy of another in a 3D Scene

setMaterialColorTexturePlayMovie()	Play a media on a material’s texture in a 3D scene
setMaterialColorTextureStopMovie()	Stop a media on a material’s texture in a 3D scene
setMaterialColorTextureSegmentMovie()	Play a segment of a media on a material’s texture in a 3D scene
setMaterialColorTextureEnable()	Enable a texture in a material
setMaterialColorTextureDisable()	Disable a texture in a material
setMediaToTexture3D()	Set a media as a texture on a material
setMediaTagToTexture3D()	Set a media as a texture on a material using a tag

deleteFile()	Delete a file
copyFile()	Copy a file
renameFile()	Rename a file
renameTimestamped()	Rename a file with a timestamped extension
resizeImageToMaxWidth()	Resize an image to a maximum width
resizeImageToMaxHeight()	Resize and image to a maximum height
updateMediaPath()	Update a target media using a file path
updateMediaPathByTag()	Update a target media using a file path. Target media with a tag

addToLog()	Add a message to Kinetic’s `Console` panel
clearLog()	Clear Kinetic’s `Console` panel
addLogToClipboard()	Copy Kinetic’s `Console` panel log to the clipboard
msToHHMMSSFF()	Convert milliseconds into a timecode formatted string

saveShow()	Save current Show
saveShowIncremental()	Save current Show and increment filename. Equivalent to the Save+ option of the `File` top menu
saveShowAs()	Save current Show with a specific filename
doBackup()	Perform an automatic backup of the show in the /backup/ folder
enableOnAir()	Activate ON AIR on the Designer
disableOnAir()	Disable ON AIR on the Designer
onlineAllVnode()	Turn all VNodes online
offlineAllVnode()	Turn all VNodes offline
haltDesigner()	Power off the Designer
rebootDesigner()	Reboot the Designer
quitDesigner()	Quit the Designer application
rescanMedia()	Rescan for new new media added
rescanMediaForce()	Force the rescan of all media
offAllTestPatterns()	Turn off all test patterns
offAllControlPoints()	Turn off all control points
offAllBlindOutput()	Blind all outputs
offAllSoloXmap()	Remove all Solo modes from XMaps

node.sendTriggerEvent()	Send a TriggerEvent on an output pin of the Javascript node
node.setValue()	Set the value of an output pin on a Javascript node

Add a link to Visual Code IDE

Explain here information on the typescript file and where it should be placed for auto-completion and help tooltips to work in Visual Code.