Hotkey

class omni.kit.hotkeys.core.Hotkey(hotkey_ext_id: str, key: Union[str, KeyCombination], action_ext_id: str, action_id: str, filter: Optional[HotkeyFilter] = None)

Bases: object

Hotkey object class.

Methods

__init__(hotkey_ext_id, key, action_ext_id, ...)	Define a hotkey object.
execute()	Execute action assigned to the hotkey

Attributes

action	Action object assigned to this hotkey.
action_text	String of action object assigned to this hotkey.
filter_text	String of filter object assigned to this hotkey.
id	Identifier string of this hotkey.
key_text	String of key bindings assigned to this hotkey.

__init__(hotkey_ext_id: str, key: Union[str, KeyCombination], action_ext_id: str, action_id: str, filter: Optional[HotkeyFilter] = None)

Define a hotkey object.

Parameters

• hotkey_ext_id (str) – Extension id which owns the hotkey.

• key (Union[str, KeyCombination]) – Key combination.

• action_ext_id (str) – Extension id which owns the action assigned to the hotkey.

• action_id (str) – Action id assigned to the hotkey.

Keyword Arguments

filter (Optional[HotkeyFilter]) – Hotkey filter. Default None

Returns

The hotkey object that was created.

execute() → None

Execute action assigned to the hotkey

property action: Action

Action object assigned to this hotkey.

property action_text: str

String of action object assigned to this hotkey.

property filter_text: str

String of filter object assigned to this hotkey.

property id: str

Identifier string of this hotkey.

property key_text: str

String of key bindings assigned to this hotkey.