unreal.RigUnit_SendEvent

class unreal.RigUnit_SendEvent(execute_context: ControlRigExecuteContext = [], event: RigEvent = Ellipsis, item: RigElementKey = Ellipsis, offset_in_seconds: float = 0.0, enable: bool = False, only_during_interaction: bool = False)

Bases: RigUnitMutable

SendEvent is used to notify the engine / editor of a change that happend within the Control Rig.

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_SendEvent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • enable (bool): [Read-Write] Enable: The event will be sent if this is checked

  • event (RigEvent): [Read-Write] Event: The event to send to the engine

  • execute_context (ControlRigExecuteContext): [Read-Write] Execute Context: * This property is used to chain multiple mutable units together

  • item (RigElementKey): [Read-Write] Item: The item to send the event for

  • offset_in_seconds (float): [Read-Write] Offset in Seconds: The time offset to use for the send event

  • only_during_interaction (bool): [Read-Write] Only During Interaction: The event will be sent if this only during an interaction

property enable: bool

[Read-Write] Enable: The event will be sent if this is checked

Type:

(bool)

property event: RigEvent

[Read-Write] Event: The event to send to the engine

Type:

(RigEvent)

property item: RigElementKey

[Read-Write] Item: The item to send the event for

Type:

(RigElementKey)

property offset_in_seconds: float

[Read-Write] Offset in Seconds: The time offset to use for the send event

Type:

(float)

property only_during_interaction: bool

[Read-Write] Only During Interaction: The event will be sent if this only during an interaction

Type:

(bool)