Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AnimationConstraint

Aligns two BaseParts with an animate-able kinematic or force-based joint.

This class is not browsable. It is not visible in Studio's object browser.
Memory categoryBaseParts
Tags: [NotBrowsable]

Member index 8

HistoryMember
569IsKinematic: bool
553MaxForce: float
553MaxTorque: float
553Transform: CFrame
inherited from Constraint
553Active: bool
553Attachment0: Attachment
553Attachment1: Attachment
553Color: BrickColor
553Enabled: bool
553Visible: bool
604GetDebugAppliedForce(bodyId: int): Vector3
604GetDebugAppliedTorque(bodyId: int): Vector3
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
691GetPredictionMode(): PredictionMode
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
690IsPredicted(): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
690SetPredictionMode(mode: PredictionMode): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

An AnimationConstraint constrains its Attachments so that they're offset by the Transform CFrame. The Transform can be set manually during RunService.PreSimulation or by an Animator.

History 13

Members 8

IsKinematic

TypeDefault
boolfalse

When true, the connected parts follow the Transform perfectly without participating in physics simulation. When false, the connected parts follow the trajectory using forces and torques limited by AnimationConstraint.MaxForce and AnimationConstraint.MaxTorque.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

MaxForce

TypeDefault
float10000

Maximum force magnitude the constraint can apply to achieve its goal. Only used if IsKinematic is false.

Thread safetyReadSafe
CategoryCompliance
Loaded/Savedtrue

History 2

MaxTorque

TypeDefault
float10000

Maximum torque the constraint can use to reach its goal. Only used if IsKinematic is false.

Thread safetyReadSafe
CategoryCompliance
Loaded/Savedtrue

History 2

Transform

TypeDefault
CFrame

The internal CFrame that is manipulated when a AnimationConstraint is being animated.

Timing

AnimationConstraint transforms are not applied immediately, but rather as a batch in a parallel job after RunService.PreSimulation, immediately before physics steps. The deferred batch update is much more efficient than many immediate updates.

If the AnimationConstraint is part of an animated model with an Animator, then AnimationConstraint.Transform is usually overwritten every frame by the Animator after RunService.PreAnimation and before RunService.PreSimulation.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

Settings