Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BodyPartDescription

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

Member index 5

HistoryMember
731AssetId: int64
731BodyPart: BodyPart
731Color: Color3
698HeadShape: string
731Instance: Instance
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(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 15

Members 5

AssetId

TypeDefault
int640

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

History 3

BodyPart

TypeDefault
BodyPartHead

The type of body part.

History 3

Color

TypeDefault
Color30, 0, 0

The Color3 for this body part.

History 3

HeadShape

TypeDefault
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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)

See also:

History 1

Instance

TypeDefault
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.

History 3

Settings