Roblox Wiki
Roblox Wiki
38,933
pages
Missing API Documentation
This API Class does not have any or complete API documentation. Please add API documentation if possible.

The AccessoryDescription class is used to describe an accessory that is applied to a character. In order to function properly, the AccessoryDescription should be placed under a HumanoidDescription light iconHumanoidDescription dark iconHumanoidDescription, the accessory is then applied to the character by calling Humanoid light iconHumanoid dark iconHumanoid:ApplyDescription with the HumanoidDescription that this AccessoryDescription is placed under.

It contains information such as the accessory's asset ID, whether the accessory is adjusted (scaled/offset/rotated) by the user, or if it is layered.

AccessoryDescription was added in version 596 (September 2023), and inherits from Instance.

Properties

AccessoryType: AccessoryType

The AccessoryType of the Accessory light iconAccessory dark iconAccessory that this AccessoryDescription describes.

  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

AssetId: int64

If this AccessoryDescription describes a Marketplace accessory, this property will be the ID of that accessory. Otherwise, it will be equal to 0.

  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

Instance: Instance

If this AccessoryDescription describes an Accessory light iconAccessory dark iconAccessory instance that exists in the DataModel (i.e. does not represent a Marketplace accessory), this will be the original reference to the Accessory instance.

  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

IsLayered: bool

Whether or not the accessory is layered.

  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

Order: int

If the accessory is layered, this represents the WrapLayer.Order.

  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

Position: Vector3

If the accessory is rigid (not layered), this represents the adjusted offset in studs from the accessory's original position.

  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

Puffiness: float

If the accessory is layered, this represents the WrapLayer light iconWrapLayer dark iconWrapLayer.Puffiness.

  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

Rotation: Vector3

If the accessory is rigid (not layered), this represents the adjusted offset in degrees from the accessory's original rotation.

  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

Scale: Vector3

If the accessory is rigid (not layered), this represents the adjusted scale factor from the accessory's original size. Calculated as handle.Size * accessoryDescription.Scale.

  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

Methods

GetAppliedInstance(): Instance

Returns the Accessory light iconAccessory dark iconAccessory instance that was applied to the Character.

  • Thread safety: unsafe

External links[]