unreal.IKRigComponent

class unreal.IKRigComponent(outer=None, name='None')

Bases: unreal.ActorComponent

IKRig Component

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: IKRigComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

  • component_tags (Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

  • is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

  • replicates (bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

add_ik_goals()

Add your own goals to the OutGoals map (careful not to remove existing goals in the map!)

Returns

out_goals (Map(Name, IKRigGoal)):

Return type

Map(Name, IKRigGoal)

clear_all_goals() → None

Remove all stored goals in this component.

set_ik_rig_goal(goal) → None

Apply a IKRigGoal and store it on this rig. Goal transform assumed in Component Space of Skeletal Mesh.

Parameters

goal (IKRigGoal) –

set_ik_rig_goal_position_and_rotation(goal_name, position, rotation, position_alpha, rotation_alpha) → None

Set an IK Rig Goal position and rotation (assumed in Component Space of Skeletal Mesh) with separate alpha values.

Parameters
set_ik_rig_goal_transform(goal_name, transform, position_alpha, rotation_alpha) → None

Set an IK Rig Goal transform (assumed in Component Space of Skeletal Mesh) with separate alpha values.

Parameters