openspace.scriptScheduler

Functions overview

Name

Documentation

clear

Clears all scheduled scripts

loadFile

Load timed scripts from a Lua script file that returns a list of scheduled scripts

loadScheduledScript

Load a single scheduled script

scheduledScripts

Returns the list of all scheduled scripts

Functions

clear

Clears all scheduled scripts.

Parameters
  • group Integer?

Return type: void

Signature
openspace.scriptScheduler.clear(group)

loadFile

Load timed scripts from a Lua script file that returns a list of scheduled scripts.

Parameters
  • fileName String

Return type: void

Signature
openspace.scriptScheduler.loadFile(fileName)

loadScheduledScript

Load a single scheduled script. The first argument is the time at which the scheduled script is triggered, the second argument is the script that is executed in the forward direction, the optional third argument is the script executed in the backwards direction, and the optional last argument is the universal script, executed in either direction.

Parameters
  • time String

  • forwardScript String

  • backwardScript String?

  • universalScript String?

  • group Integer?

Return type: void

Signature
openspace.scriptScheduler.loadScheduledScript(time, forwardScript, backwardScript, universalScript, group)

scheduledScripts

Returns the list of all scheduled scripts

Return type: Table[]

Signature
openspace.scriptScheduler.scheduledScripts()