omni::kit::IAppScripting

class IAppScripting

Scripting Engine interface.

Public Functions

virtual bool executeString(const char *str, const char *commandName = nullptr, bool executeAsFile = false) = 0

Run script from a string.

A kScriptingEventCommand event is always dispatched before executing the script.

Parameters

str – Content of the script to execute
commandName – (optional) A command name that will logged for multi-line scripts
executeAsFile – If true, str is first written to a temporary file which is then executed. The file is not removed which allows inspecting the script at a later point.

Return values

true – if execution was successful
false – if an error occurs (kScriptingEventStdErr was dispatched with the error message)

virtual bool executeFile(const char *path, const char *const *args, size_t argCount) = 0

Run script from a file.

A kScriptingEventCommand event is always dispatched before executing the script.

Parameters

path – The path to the script file. May be a file name that exists in folders that have been added to the search path with addSearchScriptFolder(). A “.py” suffix is optional.
args – An optional array of string arguments to pass to the script file
argCount – The number of arguments in the args array

Return values

true – if execution was successful
false – if the file was not found (an error is logged), or the script could not be loaded (an error is logged), or execution failed (kScriptingEventStdErr was dispatched with the error message)

virtual bool addSearchScriptFolder(const char *path) = 0

Adds a folder path that will be searched for scripts.

Calls to executeFile() will search the paths added in the order that they were added.