FIKRetargetWeaponGoalsOpSettings

API > API/Plugins > API/Plugins/IKRig

   
Name FIKRetargetWeaponGoalsOpSettings
Type struct
Header File /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/RetargetOps/WeaponGoalsOp.h
Include Path #include "Retargeter/RetargetOps/WeaponGoalsOp.h"

Syntax

USTRUCT (BlueprintType , Meta=(DisplayName="Weapon Op Settings"))  
struct FIKRetargetWeaponGoalsOpSettings : public FIKRetargetOpSettingsBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FIKRetargetWeaponGoalsOpSettings()

   Retargeter/RetargetOps/WeaponGoalsOp.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Alpha float Range 0 to 1. Default 1. Blends the effect of the op off. At 0, there is no effect. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Op Settings"
  • Meta=(UIMin="0.0", UIMax="1.0", ClampMin="0.0", ClampMax="1.0")
bEnableWeaponScale bool When false, all weapon scaling is skipped and WeaponScale has no effect. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Op Settings"
bSnapIKHandGun bool When true, enables RetargetHandIKAlpha to blend the IK Gun hierarchy between left/right hands. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Op Settings"
  • DisplayName="Snap IK Hand Gun"
bSuppressMissingBoneWarnings bool When true, will suppress warnings in the retarget editor output log about missing bones from this op. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Op Settings"
IKHandGun FBoneReference A bone located at the right hand, and parent of IKHandLeftBone and IKHandRightBone. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • Category="Bones"
  • Meta=(NotOverrideable)
IKHandLeftBone FBoneReference A bone representing the location of the left hand IK position while holding a two-handed prop. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • Category="Bones"
  • DisplayName="IK Hand Left Bone"
  • Meta=(NotOverrideable)
IKHandRightBone FBoneReference A bone representing the location of the right hand IK position while holding a two-handed prop. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • Category="Bones"
  • DisplayName="IK Hand Right Bone"
  • Meta=(NotOverrideable)
LeftHandAttachBone FBoneReference An optional bone used to attach props to the left hand. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • Category="Bones"
  • Meta=(NotOverrideable)
LeftHandBone FBoneReference The bone skinned to the left hand at wrist location. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • Category="Bones"
  • Meta=(NotOverrideable)
LeftHandIKAlpha double Blend the effect of the left hand IK Goal from it's input location (0.0) to the IKHandLeftBone location (1.0). Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Op Settings"
  • DisplayName="Left Hand IK Alpha"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
LeftRightHandIKAlpha double Blends the entire Hand Gun bone hierarchy location from the left hand (at 0.0) to the right hand (at 1.0). Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Op Settings"
  • DisplayName="Retarget Hand IK Alpha"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
LeftWeaponBone FBoneReference An ancillary weapon bone for the left hand. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • Category="Bones"
  • Meta=(NotOverrideable)
RightHandAttachBone FBoneReference An optional bone used to attach props to the right hand. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • Category="Bones"
  • Meta=(NotOverrideable)
RightHandBone FBoneReference The bone skinned to the right hand at wrist location. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • Category="Bones"
  • Meta=(NotOverrideable)
RightHandIKAlpha double Blend the effect of the right hand IK Goal from it's input location (0.0) to the IKHandRightBone location (1.0). Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Op Settings"
  • DisplayName="Right Hand IK Alpha"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
RightWeaponBone FBoneReference An ancillary weapon bone for the right hand. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • Category="Bones"
  • Meta=(NotOverrideable)
WeaponScale double Range 0 to inf. Retargeter/RetargetOps/WeaponGoalsOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Op Settings"
  • Meta=(ClampMin="0.01", UIMin="0.01", UIMax="10.0")

Functions

Public

Public Virtual

Overridden from FIKRetargetOpSettingsBase

Name Remarks Include Path Unreal Specifiers

virtual void CopySettingsAtRuntime ( const FIKRetargetOpSettingsBase* InSettingsToCopyFrom
)

 (required) override to specify how settings should be applied in a way that will not require reinitialization (ie runtime compatible) Retargeter/RetargetOps/WeaponGoalsOp.h  

virtual const UClass * GetControllerType()

 (optional, but recommended) provide a custom controller type (deriving from UIKRetargetOpControllerBase) as an API for editing the op NOTE: this type will automatically be lazy instantiated when/if the user calls GetController() on the op. Retargeter/RetargetOps/WeaponGoalsOp.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page