unreal.RigUnit_AddPhysicsControl

class unreal.RigUnit_AddPhysicsControl(execute_pin: RigVMExecutePin = [], owner: RigElementKey = Ellipsis, control_component_key: RigComponentKey = Ellipsis, parent_body_component_key: RigComponentKey = Ellipsis, use_parent_body_as_default: bool = False, child_body_component_key: RigComponentKey = Ellipsis, control_data: PhysicsControlData = Ellipsis, control_multiplier: PhysicsControlMultiplier = Ellipsis, control_target: PhysicsControlTarget = Ellipsis)

Bases: RigUnit_PhysicsBaseMutable

Adds a new physics control as a component on the owner element. Note: This node only runs as part of the construction event.

C++ Source:

  • Plugin: ControlRigPhysics

  • Module: ControlRigPhysics

  • File: RigPhysicsControlExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

  • child_body_component_key (RigComponentKey): [Read-Write] The body that is controlled

  • control_component_key (RigComponentKey): [Read-Write]

  • control_data (PhysicsControlData): [Read-Write] Describes the initial strength etc of the new control

  • control_multiplier (PhysicsControlMultiplier): [Read-Write] Fine control over the control strengths etc

  • control_target (PhysicsControlTarget): [Read-Write] Describes the initial target for the new control

  • execute_pin (RigVMExecutePin): [Read-Write] * This property is used to chain multiple mutable units together

  • owner (RigElementKey): [Read-Write] The owner of the newly created component (must be set/valid)

  • parent_body_component_key (RigComponentKey): [Read-Write] The optional body that “does” the controlling - though if it is dynamic then it can move too

  • use_parent_body_as_default (bool): [Read-Write]

property child_body_component_key: RigComponentKey

[Read-Write] The body that is controlled

Type:

(RigComponentKey)

property control_component_key: RigComponentKey

[Read-Only]

Type:

(RigComponentKey)

property control_data: PhysicsControlData

[Read-Write] Describes the initial strength etc of the new control

Type:

(PhysicsControlData)

property control_multiplier: PhysicsControlMultiplier

[Read-Write] Fine control over the control strengths etc

Type:

(PhysicsControlMultiplier)

property control_target: PhysicsControlTarget

[Read-Write] Describes the initial target for the new control

Type:

(PhysicsControlTarget)

property owner: RigElementKey

[Read-Write] The owner of the newly created component (must be set/valid)

Type:

(RigElementKey)

property parent_body_component_key: RigComponentKey

[Read-Write] The optional body that “does” the controlling - though if it is dynamic then it can move too

Type:

(RigComponentKey)

property use_parent_body_as_default: bool

[Read-Write]

Type:

(bool)