Skip to content

Program

This is the program class. It provides a program that runs in a window.

Extends: VisualElement

Properties

PropertyTypeDefaultDescription
programtablenilThe program instance
pathstring""The path to the program
runningbooleanfalseWhether the program is running
errorCallbackfunctionnilThe error callback function
doneCallbackfunctionnilThe done callback function

Functions

MethodReturnsDescription
Program:executeProgramExecutes a program
Program:stopProgramStops the program
Program:sendEventProgramSends an event to the program
Program:onErrorProgramRegisters a callback for the program's error event
Program:onDoneProgramRegisters a callback for the program's done event

Program:execute(path, env?, addEnvironment?)

Executes a program

Parameters

  • path string The path to the program
  • env (optional) table The environment to run the program in
  • addEnvironment (optional) boolean Whether to add the environment to the program's environment (false = overwrite instead of adding)

Returns

  • Program self The Program instance

Program:stop()

Stops the program

Returns

  • Program self The Program instance

Program:sendEvent(event, any)

Sends an event to the program

Parameters

  • event string The event to send
  • any The event arguments

Returns

  • Program self The Program instance

Program:onError(fn)

Registers a callback for the program's error event, if the function returns false, the program won't stop

Parameters

  • fn function The callback function to register

Returns

  • Program self The Program instance

Program:onDone(fn)

Registers a callback for the program's done event

Parameters

  • fn function The callback function to register

Returns

  • Program self The Program instance

Released under the MIT License.