Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AccessoryDescription

Describes the appearance of an Accessory for the HumanoidDescription.

Member index 10

HistoryMember
596AccessoryType: AccessoryType
596AssetId: int64
596Instance: Instance
596IsLayered: bool
596Order: int
630Position: Vector3
727Puffiness: float
630Rotation: Vector3
630Scale: Vector3
632GetAppliedInstance(): Instance
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
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
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
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

AccessoryDescription is an object that stores the description for an Accessory. It is meant to be placed underneath a HumanoidDescription in order to work with Humanoid:ApplyDescriptionAsync().

History 13

Members 10

AccessoryType

TypeDefault
AccessoryTypeUnknown

The AccessoryType of the Accessory referred to by this description.

History 1

AssetId

TypeDefault
int640

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

History 1

GetAppliedInstance

Parameters (0)
No parameters.
Returns (1)
Instance

Returns the applied Accessory if this AccessoryDescription is the child of an applied HumanoidDescription parented to a Humanoid.

History 1

Instance

TypeDefault
Instance

A reference to the Instance that should be applied when applying this AccessoryDescription. This property can be used instead of AssetId to apply accessories without uploading them to the platform.

History 1

IsLayered

TypeDefault
boolfalse

Whether the Accessory is layered or rigid. This is intended to be read-only. It will be corrected after calling Humanoid:ApplyDescriptionAsync() if this property doesn't match the actual Accessory contents.

History 1

Order

TypeDefault
int0

The WrapLayer.Order value when applying the Accessory, if it is layered.

History 1

Position

TypeDefault
Vector30, 0, 0

The accessory adjustment position offset. Only applies if the Accessory is rigid.

History 1

Puffiness

TypeDefault
float1

The WrapLayer.Puffiness value when applying the Accessory, if it is layered.

This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Rotation

TypeDefault
Vector30, 0, 0

The accessory adjustment rotation offset. Only applies if the Accessory is rigid.

History 1

Scale

TypeDefault
Vector31, 1, 1

The accessory adjustment scale. Only applies if the Accessory is rigid.

History 1

Settings