ObjectType:task

From Lavish Software Wiki
Jump to navigation Jump to search
Object Type Vitals
task
Defined By LavishScript
Inherits none
Reduces To Same as ID
Variable Object Type none
Uses Sub-Types no
C/C++ Type void*

Description

See Tasks

Members

  • string Name: Name of the Task, if one was provided
  • int64 ID: ID of the Task
  • tasktype Type: Task Type (such as "ls1.echo")
  • jsonobject Args: A copy of the object used to initiate the Task, held for the Task's lifetime. This object can be modified during use to store additional information.
  • jsonvalue Args[...]: Shortcut to retrieve a value from Args, e.g. Task.Args[someObject,someValue] is the same as Task.Args.Get[someObject].Get[someValue] or Task.Args.Get[someObject,someValue]
  • jsonobject Result: The Result object produced by the Task (currently unused)
  • jsonvalue Result[...]: Shortcut to retrieve a value from Result
  • bool IsRunning: TRUE if the Task is currently running.
  • float RunningTime: Running Time of the Task, in seconds. NULL if the Task is not running.
  • int64 RunningTimeMS: Running Time of the Task, in milliseconds. NULL if the Task is not running.
  • float FrameElapsed: Amount of time since the previous Task Frame (Pulse of the Task), in seconds. NULL if the Task is not running.
  • int64 FrameElapsedMS: Amount of time since the previous Task Frame (Pulse of the Task), in milliseconds. NULL if the Task is not running.
  • int64 StartTimestamp: The timestamp when the Task was started. NULL if the Task is not running.
  • int64 LastFrameTimestamp: The timestamp of the previous Task Frame (Pulse of the Task). NULL if the Task is not running.
  • float Duration: The defined duration of the Task, in seconds. NULL if the Task does not have a specified duration.
  • int64 DurationMS: The defined duration of the Task, in milliseconds. NULL if the Task does not have a specified duration.
  • bool IsInstant: TRUE if the Task is defined as instant


Methods

  • Start: Start the Task
  • Stop: Stop the Task
  • Toggle: Stop or Start the Task

Examples

See Also

LavishScript Object Types