IAppScripting#

class omni.kit.app.IAppScripting#

Bases: pybind11_object

Methods

__init__(*args, **kwargs)

add_search_script_folder(self, path)

Adds a folder to the script search path.

execute_file(self, path, args)

Executes a Python file with optional arguments.

execute_string(self, str[, source_file, ...])

Executes a Python string in the app interpreter.

get_event_stream(self)

Event stream for scripting events.

remove_search_script_folder(self, path)

Removes a folder from the script search path.
__init__(*args, **kwargs)#
add_search_script_folder(
self: omni.kit.app._app.IAppScripting,
path: str,
) → bool#

Adds a folder to the script search path.

execute_file(
self: omni.kit.app._app.IAppScripting,
path: str,
args: List[str],
) → bool#

Executes a Python file with optional arguments.

execute_string(
self: omni.kit.app._app.IAppScripting,
str: str,
source_file: str = '',
execute_as_file: bool = '',
) → bool#

Executes a Python string in the app interpreter.

get_event_stream(
self: omni.kit.app._app.IAppScripting,
) → carb.events._events.IEventStream#

Event stream for scripting events.

remove_search_script_folder(
self: omni.kit.app._app.IAppScripting,
path: str,
) → bool#

Removes a folder from the script search path.