Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Bone

Bones are non-rendered objects that drive the movement of one or more parts for the purposes of animation, or creating clothing and characters.

Member index 3

HistoryMember
553Transform: CFrame
553TransformedWorldCFrame: CFrame
inherited from Attachment
553Axis: Vector3
553CFrame: CFrame
553SecondaryAxis: Vector3
553Visible: bool
553WorldAxis: Vector3
553WorldCFrame: CFrame
553WorldSecondaryAxis: Vector3
553GetAxis(): Vector3
648GetConstraints(): Instances
553GetSecondaryAxis(): Vector3
573SetAxis(axis: Vector3): null
573SetSecondaryAxis(axis: Vector3): null
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): 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()
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)

Removed member index 1

HistoryMember

Description

Bones are non-rendered objects that drive the movement of one or more parts for the purposes of animation, or creating clothing and characters. Bones are part of a Model or MeshPart object's skeletal rig that you typically access and animate through the Animation Editor.

Rigs are created during the modeling process in third-party software such as Blender or Maya. After importing the rigged model into Studio, you can add the model directly to your experience, or save and share the model as an asset. See Rigging for more details on creating and using rigged models.

Note that you can parent Bones under other Bones and parts. When parenting a bone to another bone, the child bone's world position will be relative to the parent bone's position, and the hierarchy of parented Bone objects can change the behavior of affected parts during posing or animation.

Relationship with Motor6D

To support animations with older rigs using joints, such as Motor6D, you can use the Bone.Transform property in the same way as Motor6D.Transform. Roblox uses the offset of the bones from the default pose to drive an animation, and bones are not replicated or serialized.

Bone.CFrame

Bones inherit the CFrame property of Attachments which Roblox uses as the bone's reference position. The inherited WorldCFrame and other world properties return the initial un-transformed position.

History 20

Members 3

Transform

TypeDefault
CFrame

Transform determines the current animated offset of the bone relative to its CFrame. This property is set by Roblox when animations on skinned meshes are played, although it can be manipulated manually in a manner similar to Motor6D.Transform.

See also:

This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated]

TransformedWorldCFrame

TypeDefault
CFrame

TransformedWorldCFrame describes the combined CFrame offset of the bone and the current animation offset (Transform) in world space.

See also:

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 6

Tags: [ReadOnly, NotReplicated]

Removed members 1

Settings