Open Asterune
IKControl

IKControl

Positions an articulated chain with an inverse-kinematics solver.

Creatable
Instance.new("IKControl")
Inherits
RigControlInstance
Replication
Standard

Behavior

IKControl positions an articulated chain with an inverse-kinematics solver.

Summary

Members14
Properties13
Methods1

Properties

AlignRotation

IKControl.AlignRotation: boolean = false

Whether the end effector also aligns with the target orientation.

ChainLength

IKControl.ChainLength: number = 2

The number of joints included in the controlled chain.

ChainRoot

IKControl.ChainRoot: BasePart? = nil

The first Part in the articulated chain controlled by this rig control.

Enabled

IKControl.Enabled: boolean = true

Whether this i k control is enabled.

EndEffector

IKControl.EndEffector: BasePart? = nil

The Part at the end of the controlled chain.

EndEffectorOffset

IKControl.EndEffectorOffset: Vector3 = Vector3.new(0, 0, 0)

The local target offset applied to the end effector.

Pole

IKControl.Pole: Instance? = nil

The Instance used to define the chain's bend direction.

Priority

IKControl.Priority: number = 0

The relative priority used to order or process this object.

SmoothTime

IKControl.SmoothTime: number = 0

The smoothing time applied when approaching the rig-control target, in seconds.

Solver

IKControl.Solver: Enum.IKSolver = Enum.IKSolver.Auto

The inverse-kinematics solver used for the chain.

Target

IKControl.Target: Instance? = nil

The Instance providing the world-space target for this rig control.

TargetPosition

IKControl.TargetPosition: Vector3 = Vector3.new(0, 0, 0)

The linear position sought by a servo, in studs.

Weight

IKControl.Weight: number = 1

The contribution of this pose or rig control to the resulting animation.

Methods

GetExecutionGroup

IKControl:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

Inherited members

Inherited47

RigControl