Package Script

package for the script environment

Methods

exit(integer code) immediately end the script process
reload() reload the entire script
remove(Script.FunctionEvent event) remove a previously scheduled event
resolve(string path) resolves the given path relative to the current script file location
schedule(function function, any userdata, instance context, float measure, Time.Clock clock) schedule a function to execute in a given context at the given time
schedule(function function, any userdata, float measure, Time.Clock clock) schedule a function to execute in a given context at the given time
schedule(function function, float measure, Time.Clock clock) schedule a function to execute in the script context at the given time
stayAlive() keep the script process alive until explicitly terminated

Classes

Script.FunctionEvent

Property Documentation


array argument

An array of command line arguments for the script. The first element in the array is the main executing script file.


array argv

An array of command line arguments for the underlying script interpreter process.

Method Documentation


void exit(integer code)

Immediately end the script process.

Parameters


void reload()

Reload the entire script.


void remove(Script.FunctionEvent event)

Remove a previously scheduled event

Parameters


IO.Path resolve(string path)

Resolves the given path relative to the current script file location.

Parameters

Returns


Script.FunctionEvent schedule(function function, any userdata, instance context, float measure, Time.Clock clock)

Schedule a function to execute in a given context at the given time.

Parameters

Returns


Script.FunctionEvent schedule(function function, any userdata, float measure, Time.Clock clock)

Schedule a function to execute in a given context at the given time.

Parameters

Returns


Script.FunctionEvent schedule(function function, float measure, Time.Clock clock)

Schedule a function to execute in the script context at the given time.

Parameters

Returns


void stayAlive()

Keep the script process alive until explicitly terminated.

A script with no scheduled events will normally terminate immediately after the end of the script, use this method to keep the script process alive for method handlers.

The script process must then be terminated externally (e.g. via signal) or by calling System.exit in a method handler.



Creative Commons Logo This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.