Home › System plugins › Modules

System

Modules

What it gives you

—

Requires

None

Required by

None

23 assets288 API members

Note

Narrative documentation for this plugin is still being written. The API reference below is complete.

API reference

Every blueprint asset in this plugin. Expand an asset to see its members.

/

AddControl13 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Control Name`	`name`	—
var	`Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Secondary Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Control Suffix`	`name`	—
var	`Null Suffix`	`name`	—
var	`Add Null Above`	`bool`	—
var	`Add Null Below`	`bool`	—
var	`Add Secondary Control`	`bool`	—
var	`Orient To World`	`bool`	—
var	`Offset Control`	`Transform`	—
var	`Constrain Ctrl To Skeleton`	`bool`	—
var	`Drive Skeleton`	`bool`	—

AnimalNeck18 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Spline Mode`	`ESplineType`	—
var	`Primary Axis`	`Vector`	—
var	`Secondary Axis`	`Vector`	—
var	`Secondary Spline Direction`	`Vector`	—
var	`Number Of Controls`	`int`	—
var	`Number Of Neck Bones`	`int`	—
var	`Inner Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Tangent Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Head Neck Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Head Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Head Local Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`FK Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Number Of Main Controls`	`int`	—
var	`Debug`	`bool`	—
var	`Stretch`	`bool`	—
var	`Re- Orient Controls`	`bool`	—
var	`Default IK Or FK`	`bool`	—

AnimalSpine18 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`FK Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Mid IK Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Body Control Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Hips Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Hips Chest Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Chest Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Main Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Primary Axis`	`Vector`	—
var	`Secondary Axis`	`Vector`	—
var	`Secondary Spline Direction`	`Vector`	—
var	`Chest Hips Position`	`Vector`	—
var	`Body Control Adjustment`	`float`	—
var	`Number Of Spines Bones`	`int`	—
var	`Debug`	`bool`	—
var	`Hips At Pelvis`	`bool`	—
var	`Enable Stretch`	`bool`	—
var	`Default FK Or IK`	`bool`	—

Arm16 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`IK Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`PV Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`FK Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Offset IK Ctrl`	`Transform`	—
var	`Offset PV Control`	`Transform`	—
var	`Elbow Bone Offset`	`Vector`	—
var	`Pole Vector Position`	`float`	—
var	`Auto Determine Axis`	`bool`	—
var	`Elbow Bone Offset Global Space`	`bool`	—
var	`Orient IK To World`	`bool`	—
var	`FK IK Default`	`bool`	—
var	`Local Default`	`bool`	—
var	`Enable Keep Aligned`	`bool`	—
var	`Enable PV Follow`	`bool`	—
var	`Enable Softness`	`bool`	—

Chain18 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Debug`	`bool`	—
var	`Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Add Null`	`bool`	—
var	`Create Control Per Bone`	`bool`	—
var	`Solve With Spline IK`	`bool`	—
var	`Stretch`	`bool`	—
var	`Spline Mode`	`ESplineType`	—
var	`Up Axis`	`Vector`	—
var	`Secondary Spline Direction`	`Vector`	—
var	`Number Of Controls`	`int`	—
var	`Re- Orient Controls`	`bool`	—
var	`Dynamics`	`bool`	—
var	`Default Strength`	`float`	—
var	`Default Damping`	`float`	—
var	`Default Blend Start`	`float`	—
var	`Default Blend End`	`float`	—
var	`Default Blend Twist`	`float`	—

Constraint16 members

extends ControlRig

Kind	Name	Signature	Description
var	`Parent`	`bool`	—
var	`Position`	`bool`	—
var	`Rotation`	`bool`	—
var	`Scale`	`bool`	—
var	`Aim`	`bool`	—
var	`Aim Axis`	`Vector`	—
var	`Aim Up Axis`	`Vector`	—
var	`Aim Up Kind`	`EControlRigVectorKind`	—
var	`Maintain Offset`	`bool`	—
var	`Active`	`bool`	—
var	`Debug`	`bool`	—
var	`Parent Constraint Filter`	`TransformFilter`	—
var	`Position Constraint Filter`	`FilterOptionPerAxis`	—
var	`Rotation Constraint Filter`	`FilterOptionPerAxis`	—
var	`Scale Constraint Filter`	`FilterOptionPerAxis`	—
var	`Aim Constraint Filter`	`FilterOptionPerAxis`	—

Finger3 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Override Control Settings`	`bool`	—
var	`Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—

Foot7 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Ball IK Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Ball FK Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Foot BK Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Foot Roll Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Heel IK Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Tip Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—

HindLeg18 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Debug`Advanced Options	`bool`	—
var	`IK Foot Shape`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Pole Vector Shape`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`FK Control Shape`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Pole Vector Position`	`float`	—
var	`IK Control Offset`Advanced Options	`Transform`	—
var	`Knee Bone Offset`Advanced Options	`Vector`	—
var	`Knee Bone Offset Global Space`Advanced Options	`bool`	—
var	`Auto Determine Axis`	`bool`	—
var	`FK IK Default`	`bool`	—
var	`Orient IK To World`	`bool`	—
var	`Enable PV Follow - Version 2`	`bool`	—
var	`Enable Softness`	`bool`	—
var	`Enable Stretch`	`bool`	—
var	`Enable PV Follow - Version 1`Compatibility Options	`bool`	—
var	`Primary Axis`	`Vector`	—
var	`Secondary Axis`	`Vector`	—

Hinge11 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Primary Axis`	`ERigControlAxis`	—
var	`Color`	`LinearColor`	—
var	`Limit Min`	`bool`	—
var	`Limit Max`	`bool`	—
var	`Minimum`	`float`	—
var	`Maximum`	`float`	—
var	`Scale`	`float`	—
var	`Controlled By Proxy`	`bool`	—
var	`Proxy Swing`	`bool`	—
var	`Control Shape`	`name`	—

Leg15 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`IK Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`PV Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`FK Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Auto Determine Axis`	`bool`	—
var	`Primary Axis`	`Vector`	—
var	`Secondary Axis`	`Vector`	—
var	`FK IK Default`	`bool`	—
var	`Orient IK To World`	`bool`	—
var	`Pole Vector Position`	`float`	—
var	`IK Control Offset`	`Transform`	—
var	`Enable PV Follow`	`bool`	—
var	`Enable Softness`	`bool`	—
var	`Knee Bone Offset`	`Vector`	—
var	`Knee Bone Offset Global Space`	`bool`	—

Neck5 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Head IK Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Head FK Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Neck FK Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`FK IK Default`	`bool`	—

Piston12 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Add Up Vector Ctrl`	`bool`	—
var	`Up Vector Axis`	`Vector`	—
var	`Up Vector Offset Factor`	`float`	—
var	`Start Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`End Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Up Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Name`	`name`	—
var	`Sticky`	`bool`	—
var	`Reverse`	`bool`	—
var	`As Controls`	`bool`	—
var	`End Control Position`	`float`	—

PivotProxy8 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Scale`	`float`	—
var	`Controls to Run Backwards`	`RigElementKey[]`	—
var	`Local`	`Transform`	—
var	`Use Initial`	`bool`	—
var	`Project Down`	`bool`	—
var	`Max Projection Distance`	`float`	—
var	`Control Shape`	`name`	—

Root12 members

extends ControlRig

Kind	Name	Signature	Description
var	`Root Module Settings`	`RootModuleSettings`	—
var	`Generate Sockets`	`bool`	—
var	`Global Control Name`	`name`	—
var	`Root Control Name`	`name`	—
var	`Body Offset Control Name`	`name`	—
var	`Root Ctrl Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Global Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Body Offset Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Spine Names`	`name[]`	—
var	`Orient To World`	`bool`	—
var	`Root Control Scale`	`float`	—
var	`Skeleton`	`E_SkeletonData`	—

Shoulder3 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Clavicle Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Enable Translation`	`bool`	—

Spine16 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Spine Control Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Body Control Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Hips Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Chest Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Mid IK Control Shape Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Number Of Spine Bones`	`int`	—
var	`Primary Axis`	`Vector`	—
var	`Secondary Axis`	`Vector`	—
var	`Secondary Spline Direction`	`Vector`	—
var	`Body Control Adjustment`	`float`	—
var	`Default FK Or IK`	`bool`	—
var	`Debug`	`bool`	—
var	`Enable Stretch`	`bool`	—
var	`Hips At Pelvis`	`bool`	—
var	`Even IK Controls`	`bool`	—

Suspension13 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Primary Axis`	`ERigControlAxis`	—
var	`Color`	`LinearColor`	—
var	`Scale`	`Vector`	—
var	`Draw Limits`	`bool`	—
var	`Limit Min`	`bool`	—
var	`Limit Max`	`bool`	—
var	`Minimum`	`float`	—
var	`Maximum`	`float`	—
var	`Weight`	`float`	—
var	`Shape Transform`	`Transform`	—
var	`Controlled By Proxy`	`bool`	—
var	`Control Shape`	`name`	—

Tail21 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Debug`	`bool`	—
var	`IK Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`FK Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Local IK Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Add Null`	`bool`	—
var	`Stretch`	`bool`	—
var	`Spline Mode`	`ESplineType`	—
var	`Up Axis`	`Vector`	—
var	`Secondary Spline Direction`	`Vector`	—
var	`Number Of Controls`	`int`	—
var	`Re- Orient Controls`	`bool`	—
var	`Dynamics`	`bool`	—
var	`Default Strength`	`float`	—
var	`Default Damping`	`float`	—
var	`Default Blend Start`	`float`	—
var	`Default Blend End`	`float`	—
var	`Default Blend Twist`	`float`	—
var	`Number Of Main Controls`	`int`	—
var	`Main Controls As FK`	`bool`	—
var	`Default IK Or FK`	`bool`	—

VehiclePivotProxy8 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Controls to Run Backwards`	`RigElementKey[]`	—
var	`Ground Contact Adjust`	`float`	—
var	`Steering Axis`	`ERigControlAxis`	—
var	`Control Shape`	`name`	—
var	`Control Transform`	`Transform`	—
var	`Auto Steering`	`bool`	—
var	`Suspension Length`	`float`	—

Wheel10 members

extends ControlRig

Kind	Name	Signature	Description
var	`Module Settings`	`ModuleSettings`	—
var	`Axle`	`ERigControlAxis`	—
var	`Color`	`LinearColor`	—
var	`Radius`	`float`	—
var	`Break`	`float`	—
var	`Gas`	`float`	—
var	`Simulate`	`bool`	—
var	`Invert`	`bool`	—
var	`Max Samples`	`int`	—
var	`Direction Axis`	`ERigControlAxis`	—

Modules56

Root12 members

extends ControlRig

Kind	Name	Signature	Description
var	`Root Module Settings`	`RootModuleSettings`	—
var	`Generate Sockets`	`bool`	—
var	`Global Control Name`	`name`	—
var	`Root Control Name`	`name`	—
var	`Body Offset Control Name`	`name`	—
var	`Root Ctrl Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Global Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Body Offset Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Spine Names`	`name[]`	—
var	`Orient To World`	`bool`	—
var	`Root Control Scale`	`float`	—
var	`Skeleton`	`E_SkeletonData`	—

Modules58

Root15 members

extends ControlRig

Kind	Name	Signature	Description
var	`Root Module Settings`	`RootModuleSettings`	—
var	`Generate Sockets`	`bool`	—
var	`Global Control Name`	`name`	—
var	`Root Control Name`	`name`	—
var	`Body Offset Control Name`	`name`	—
var	`Control Name Prefix`	`name`	—
var	`Root Ctrl Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Global Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Body Offset Control Settings`	`RigUnit_HierarchyAddControlTransform_Settings`	—
var	`Spine Names`	`name[]`	—
var	`Orient To World`	`bool`	—
var	`Root Control Scale`	`float`	—
var	`Override Skeleton`Skeleton Options	`E_SkeletonData`	—
var	`Use Override Skeleton`Skeleton Options	`bool`	—
var	`Skeleton`	`E_SkeletonData`	—