BodyPartDescription
CreatorHub

Describes the appearance of an avatar body part for the HumanoidDescription.

Memory category	Instances

Member index 5

History		Member
726		AssetId: int64
726		BodyPart: BodyPart
726		Color: Color3
698		HeadShape: string
726		Instance: Instance
60 members inherited from Instance
726		Archivable: bool
726		Capabilities: SecurityCapabilities
726		DataCost: int
726		IsInSandbox: bool
726		Name: string
726		Parent: Instance
726		PredictionMode: PredictionMode
726		RobloxLocked: bool
726		Sandboxed: bool
726		SourceAssetId: int64
726		UniqueId: UniqueId
726		archivable: bool
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
726		children(): Instances
726		clone(): Instance
726		destroy(): null
726		findFirstChild(name: string, recursive: bool = false): Instance
726		getChildren(): Instances
726		isDescendantOf(ancestor: Instance): bool
726		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
726		childAdded(child: Instance)
6 members inherited from Object
726		ClassName: string
726		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
726		isA(className: string): bool
647		Changed(property: string)

Description

BodyPartDescription is an object that stores the description for an avatar's body parts, such as the Color. It is meant to be placed underneath a HumanoidDescription in order to work with Humanoid:ApplyDescriptionAsync().

History 11
Hide member changes

726 Change Default of Instance from to
726 Change Default of Color from Color3(0, 0, 0) to
726 Change Default of BodyPart from Head to
726 Change Default of AssetId from 0 to
698 Add HeadShape
644 Change Tags of BodyPartDescription from [NotBrowsable] to []
595 Add Instance
595 Add Color
595 Add BodyPart
595 Add AssetId
595 Add BodyPartDescription

Members 5

AssetId
CreatorHub

Type		Default
int64

The asset ID that should be applied when applying this BodyPartDescription.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Change Default of AssetId from 0 to
595 Add AssetId

BodyPart
CreatorHub

Type		Default
BodyPart

The type of body part.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Change Default of BodyPart from Head to
595 Add BodyPart

Color
CreatorHub

Type		Default
Color3

The Color3 for this body part.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Change Default of Color from Color3(0, 0, 0) to
595 Add Color

HeadShape
CreatorHub

Type		Default
string

HeadShape specifies a Classic Head shape identifier to apply to a compatible Dynamic Head. This property is only relevant when BodyPart is set to Head and AssetId references a Dynamic Head that supports head shapes.

Example

local AvatarEditorService = game:GetService("AvatarEditorService")

-- Get available head shapes for the user
local headShapes = AvatarEditorService:GetHeadShapesAsync(userId)

-- Create a BodyPartDescription for a Dynamic Head with a Classic shape
local bodyPartDescription = Instance.new("BodyPartDescription")
bodyPartDescription.BodyPart = Enum.BodyPart.Head
bodyPartDescription.AssetId = dynamicHeadAssetId
bodyPartDescription.HeadShape = headShapes[1] -- Apply the first owned head shape
bodyPartDescription.Parent = humanoidDescription

-- Apply the description
humanoid:ApplyDescriptionAsync(humanoidDescription)

History 1

698 Add HeadShape

Instance
CreatorHub

Type		Default
Instance

A reference to the Instance that should be applied when applying this BodyPartDescription. This property can be used instead of AssetId to apply accessories without uploading them to the platform. This can reference either a body part with R15, R15ArtistIntent and R6 folders, or only reference a single subfolder.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Change Default of Instance from to
595 Add Instance

Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BodyPartDescription
CreatorHub

Member index 5

Description

History 11
Hide member changes

Members 5

AssetId
CreatorHub

History 2

BodyPart
CreatorHub

History 2

Color
CreatorHub

History 2

HeadShape
CreatorHub

Example

History 1

Instance
CreatorHub

History 2

Settings