unreal.IKRetargetWeaponGoalsOpSettings

class unreal.IKRetargetWeaponGoalsOpSettings(enabled: bool = False, lod_threshold: int = 0, alpha: float = 0.0, enable_weapon_scale: bool = False, weapon_scale: float = 0.0, snap_ik_hand_gun: bool = False, left_right_hand_ik_alpha: float = 0.0, left_hand_ik_alpha: float = 0.0, right_hand_ik_alpha: float = 0.0, suppress_missing_bone_warnings: bool = False)

Bases: IKRetargetOpSettingsBase

Weapon Op Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: WeaponGoalsOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • alpha (float): [Read-Write] Range 0 to 1. Default 1. Blends the effect of the op off. At 0, there is no effect.

  • enable_weapon_scale (bool): [Read-Write] When false, all weapon scaling is skipped and WeaponScale has no effect.

  • enabled (bool): [Read-Write] Enable/disable the entire operation. Disabled ops are skipped entirely and do not run at all.

  • ik_hand_gun (BoneReference): [Read-Write] A bone located at the right hand, and parent of IKHandLeftBone and IKHandRightBone. This will be scaled with Weapon Scale. Defaults to “ik_hand_gun”.

  • ik_hand_left_bone (BoneReference): [Read-Write] A bone representing the location of the left hand IK position while holding a two-handed prop. Typically, a child of the IKHandGun. Defaults to “ik_hand_l”.

  • ik_hand_right_bone (BoneReference): [Read-Write] A bone representing the location of the right hand IK position while holding a two-handed prop. Typically, a child of the IKHandGun. Defaults to “ik_hand_r”.

  • left_hand_attach_bone (BoneReference): [Read-Write] An optional bone used to attach props to the left hand. This will be scaled with Weapon Scale. Defaults to “hand_attach_l”.

  • left_hand_bone (BoneReference): [Read-Write] The bone skinned to the left hand at wrist location. This bone must have an associated IK Goal. Defaults to “hand_l”.

  • left_hand_ik_alpha (double): [Read-Write] Blend the effect of the left hand IK Goal from it’s input location (0.0) to the IKHandLeftBone location (1.0). Default is 1.0.

  • left_right_hand_ik_alpha (double): [Read-Write] Blends the entire Hand Gun bone hierarchy location from the left hand (at 0.0) to the right hand (at 1.0). Default is 1.0 (right hand). NOTE: this propagates the translational offset to the children bones (IKHandLeftBone/IKHandRightBone).

  • left_weapon_bone (BoneReference): [Read-Write] An ancillary weapon bone for the left hand. This will be scaled with Weapon Scale. Defaults to “weapon_l”.

  • lod_threshold (int32): [Read-Write] The maximum LOD that this Op is allowed to run at. For example if you have LODThreshold of 2, the Op will run until LOD 2 (based on 0 index). When the component LOD becomes 3, it will stop running. A value of -1 forces the Op to execute at all LOD levels. Default is -1.

  • right_hand_attach_bone (BoneReference): [Read-Write] An optional bone used to attach props to the right hand. This will be scaled with Weapon Scale. Defaults to “hand_attach_r”.

  • right_hand_bone (BoneReference): [Read-Write] The bone skinned to the right hand at wrist location. This bone must have an associated IK Goal. Defaults to “hand_r”.

  • right_hand_ik_alpha (double): [Read-Write] Blend the effect of the right hand IK Goal from it’s input location (0.0) to the IKHandRightBone location (1.0). Default is 1.0.

  • right_weapon_bone (BoneReference): [Read-Write] An ancillary weapon bone for the right hand. This will be scaled with Weapon Scale. Defaults to “weapon_r”.

  • snap_ik_hand_gun (bool): [Read-Write] When true, enables RetargetHandIKAlpha to blend the IK Gun hierarchy between left/right hands.

  • suppress_missing_bone_warnings (bool): [Read-Write] When true, will suppress warnings in the retarget editor output log about missing bones from this op.

  • weapon_scale (double): [Read-Write] Range 0 to inf. Default 1. Scales the IKHandGun bones, Left/Right Weapon bones and hand attach bones.

property alpha: float

[Read-Write] Range 0 to 1. Default 1. Blends the effect of the op off. At 0, there is no effect.

Type:

(float)

property enable_weapon_scale: bool

[Read-Write] When false, all weapon scaling is skipped and WeaponScale has no effect.

Type:

(bool)

property left_hand_ik_alpha: float

[Read-Write] Blend the effect of the left hand IK Goal from it’s input location (0.0) to the IKHandLeftBone location (1.0). Default is 1.0.

Type:

(double)

property left_right_hand_ik_alpha: float

[Read-Write] Blends the entire Hand Gun bone hierarchy location from the left hand (at 0.0) to the right hand (at 1.0). Default is 1.0 (right hand). NOTE: this propagates the translational offset to the children bones (IKHandLeftBone/IKHandRightBone).

Type:

(double)

property right_hand_ik_alpha: float

[Read-Write] Blend the effect of the right hand IK Goal from it’s input location (0.0) to the IKHandRightBone location (1.0). Default is 1.0.

Type:

(double)

property snap_ik_hand_gun: bool

[Read-Write] When true, enables RetargetHandIKAlpha to blend the IK Gun hierarchy between left/right hands.

Type:

(bool)

property suppress_missing_bone_warnings: bool

[Read-Write] When true, will suppress warnings in the retarget editor output log about missing bones from this op.

Type:

(bool)

property weapon_scale: float

[Read-Write] Range 0 to inf. Default 1. Scales the IKHandGun bones, Left/Right Weapon bones and hand attach bones.

Type:

(double)