register_event_alias#

omni.kit.app.register_event_alias(
event_type: int,
event_name: str,
push_event_name: object = None,
) → bool#

Registers an event alias.

This function aids conversion from Events 1.0 to 2.0 by creating an alias to an Events 1.0 `EventType` to Events 2.0 names.

Parameters:

  • event_type – (int) The numeric identifier for a carb.events EventType, such as by carb.events.type_from_string().

  • event_name – (str) The string name for dispatching the deferred event via IEventDispatcher.

  • push_event_name – (str, default: None) An optional string name for dispatching an immediate event. If None (the default) this name is determined by adding `:immediate` to the given `event_name`.

Returns:

True if the aliases were created; False if an error occurs or if the aliases were already registered.

On this page