Scripting Messages

Action Messages

• EXECUTE_MODULE - Similar to EXECUTE_SCRIPT, except that we pass in the already loaded module (which should have instantiate method) instead of the name of the module to load.

  Parameters:

  • scriptName (str) - The name of the script to execute.

  • scriptModule (object) - The pre-loaded module with instantiate() method.

• EXECUTE_SCRIPT - Executes the specified Python script.

  Parameters:

  • scriptName (str) - The name of the script to execute.

• JAVASCRIPT_ENABLE - Enables or disables javascript message generation.

  Parameters:

  • state (int) - True to enable, False to disable.

• SCRIPT_CANCEL - Cancels the currently running script.

• SCRIPT_RELOAD - Reloads the currently available scripts.

• SCRIPT_SET_QUIET_MODE -

  Parameters:

  • quiet (bool) - True to run the script silently.

• SCRIPT_SET_QUIT_MODE -

  Parameters:

  • quitOnEnd (bool) - True to terminate the application at the completion of the script.

Information Messages

• SCRIPT_ENDED - Indicates that the named script has completed.

  Parameters:

  • scriptName (str) - The name of the script that completed.

  • wasItTest (bool) - True if this was a test run.

  • success (bool) - True if script ended successfully.

  • message (str) - Message upon completion.

• SCRIPT_STARTED - Indicates that the named script has started.

  Parameters:

  • scriptName (str) - The name of the script that started executing.

  • isAtest (bool) - True if this is a test, False otherwise.