Open Asterune
FootPlacementControl

FootPlacementControl

Adjusts a character's feet to match nearby ground geometry.

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

Behavior

FootPlacementControl adjusts a character's feet to match nearby ground geometry.

Summary

Members10
Properties9
  • AdjustPelvis: boolean = trueparallel read

    Whether foot placement can adjust the pelvis position.

  • AlignToGround: boolean = trueparallel read

    Whether foot orientation follows the ground surface normal.

  • Enabled: boolean = trueparallel read

    Whether this foot placement control is enabled.

  • LeftFoot: BasePart? = nilparallel read

    The Part used as the left-foot target for ground placement.

  • Priority: number = 0parallel read

    The relative priority used to order or process this object.

  • RightFoot: BasePart? = nilparallel read

    The Part used as the right-foot target for ground placement.

  • SmoothTime: number = 0parallel read

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

  • StepHeight: number = 1.5parallel read

    The maximum ground step the controller can traverse, in studs.

  • Weight: number = 1parallel read

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

Methods1

Properties

AdjustPelvis

FootPlacementControl.AdjustPelvis: boolean = true

Whether foot placement can adjust the pelvis position.

AlignToGround

FootPlacementControl.AlignToGround: boolean = true

Whether foot orientation follows the ground surface normal.

Enabled

FootPlacementControl.Enabled: boolean = true

Whether this foot placement control is enabled.

LeftFoot

FootPlacementControl.LeftFoot: BasePart? = nil

The Part used as the left-foot target for ground placement.

Priority

FootPlacementControl.Priority: number = 0

The relative priority used to order or process this object.

RightFoot

FootPlacementControl.RightFoot: BasePart? = nil

The Part used as the right-foot target for ground placement.

SmoothTime

FootPlacementControl.SmoothTime: number = 0

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

StepHeight

FootPlacementControl.StepHeight: number = 1.5

The maximum ground step the controller can traverse, in studs.

Weight

FootPlacementControl.Weight: number = 1

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

Methods

GetExecutionGroup

FootPlacementControl: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
Instance47
Properties
ArchivableClassNameNameParent
Methods
AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
Events
AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying

Related APIs

RigControl