11 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

WrapLayer

Inherits from: BaseWrap → Instance → Object

The WrapLayer object defines a 3D accessory's inner and outer surfaces and other properties related to layering accessories. These surfaces, or the Inner Cage and Outer Cage, are similar to collision boxes, and describe the surfaces of which other 3D accessories can be placed without clipping or breaking.

Internally, WrapLayer also uses the UV layout of the Inner and Outer cages to match coordinates to another 3D object's cage. This powers the deformation of objects around differently shaped avatars and underlying accessories.

Inherits from: BaseWrap

Memory category: Instances

Properties

Name	Type / Returns	Description
WrapLayer.AutoSkin	WrapLayerAutoSkin	Determines whether this WrapLayer automatically transfers skinning data from the underlying body mesh to the clothing mesh.
WrapLayer.BindOffset	CFrame	`CFrame` is used to adjust a binding point for clothing item mesh. Could be used to move and rotate clothing items. This property is intended for fine-tuning only and it is heavily optional.
WrapLayer.Color	Color3	Sets color used for the debug rendering. See `WrapTarget.DebugMode`.
WrapLayer.DebugMode	WrapLayerDebugMode	Allows switching between different debugging visualization modes for cage meshes.
WrapLayer.Enabled	boolean	Allows for disabling of the `WrapLayer` object as if it does not exist.
WrapLayer.Order	int	Controls the composition order for layered clothing.
WrapLayer.Puffiness	float	Controls how much underlying clothing items inflate the current clothing item.
WrapLayer.ReferenceMeshContent	Content	The reference mesh that defines the Inner Cage of the `WrapLayer`, stored as a `Content` value.
WrapLayer.ReferenceMeshId	ContentId	AssetID for reference mesh used to define Inner Cage of a 3D object.
WrapLayer.ReferenceOrigin	CFrame	Reference mesh offset relative to parent MeshPart (in the parent MeshPart space) Note: this property is set up automatically by the FBX importer.
WrapLayer.ReferenceOriginWorld	CFrame	Reference mesh offset relative to parent MeshPart (in the world space) Note: this property is set up automatically by the FBX importer.
WrapLayer.ShrinkFactor	float	Allows slight shrinking/expanding of the resulting render mesh, without affecting any other layers.

Inherited from BaseWrap

Name	Type / Returns	Description
BaseWrap.CageMeshContent	Content	The cage mesh this wrap uses to deform geometry, stored as a `Content` value.
BaseWrap.CageMeshId	ContentId	Asset ID for cage mesh.
BaseWrap.CageOrigin	CFrame	Cage mesh offset relative to parent `MeshPart`.
BaseWrap.CageOriginWorld	CFrame	Cage mesh offset in world space.
BaseWrap.HSRAssetId	ContentId	Asset ID for the hidden surface removal (HSR) data used by layered clothing.
BaseWrap.HSRContent	Content	The hidden surface removal data for this wrap, stored as a `Content` value.
BaseWrap.ImportOrigin	CFrame	Describes where a global zero was while authoring the cage mesh in an asset creation tool.
BaseWrap.ImportOriginWorld	CFrame	Describes where the origin (in world space) was while authoring the cage mesh in an asset creation tool.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

WrapLayer.AutoSkin

Determines whether this WrapLayer automatically transfers skinning data from the underlying body mesh to the clothing mesh. When set to EnabledOverride, skinning is applied regardless of whether the clothing mesh already has skinning data. When set to EnabledPreserve, skinning is only applied if the mesh does not already have skinning data.

This property requires StarterPlayer.LoadCharacterLayeredClothing to be set to Enabled (or Default) in order to function. When layered clothing is disabled, the auto-skinning pipeline does not run and this property has no effect.

For more information, see Automatic Skinning Transfer.

Field	Value
type	WrapLayerAutoSkin
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Behavior
serialization	{"can_load":true,"can_save":true}
capabilities	["AvatarAppearance"]

WrapLayer.BindOffset

This property is intended for fine-tuning purposes and is highly optional.

CFrame to adjust a binding point for a clothing item mesh. Allows for fine-tuning of clothing items (slight adjustment of position/rotation to get a unique look) in contexts such as community-made avatar editors.

Field	Value
type	CFrame
security	{"read":"None","write":"PluginSecurity"}
thread safety	ReadSafe
category	Tuning
serialization	{"can_load":true,"can_save":true}
capabilities	["AvatarAppearance"]

WrapLayer.Color

Sets color used for the debug rendering. See WrapTarget.DebugMode

Field	Value
type	Color3
tags	["NotReplicated","NotScriptable"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Debug
serialization	{"can_load":false,"can_save":false}
capabilities	["AvatarAppearance"]

WrapLayer.DebugMode

Allows switching between different debugging visualization modes for cage meshes.

Field	Value
type	WrapLayerDebugMode
tags	["NotReplicated","NotScriptable"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Debug
serialization	{"can_load":false,"can_save":false}
capabilities	["AvatarAppearance"]

WrapLayer.Enabled

Allows for disabling of the WrapLayer object as if it does not exist.

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Behavior
serialization	{"can_load":true,"can_save":true}
capabilities	["AvatarAppearance"]

WrapLayer.Order

Controls the composition order for layered clothing. Clothing items with higher order will appear on top of clothing items with lower order. If two items have the same order, the deformer composition order is ambiguous and depends on serialization order. Default value is 1.

Field	Value
type	int
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["AvatarAppearance"]

WrapLayer.Puffiness

Deprecated.

Controls how much underlying clothing items inflate the current clothing item.

Valid range is -1 to 1. A value of -1 compresses the clothing, body, and all underlying layers such that the clothing itself takes the shape of the body. A value of 0 makes the clothing item fit as if it was the only piece of clothing being worn, compressing all underlying layers. A value of 1 (default) never compresses anything and infinitely inflates over underlying clothing items.

Field	Value
type	float
tags	["Deprecated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["AvatarAppearance"]

WrapLayer.ReferenceMeshContent

The reference mesh that defines the inner cage of a WrapLayer, stored as a Content value. Together with the outer cage from CageMeshContent, the inner cage describes the surfaces used to fit and deform the accessory around an avatar and underlying accessories without clipping. A WrapLayer is only considered valid once both its cage mesh and its reference mesh are set.

The reference mesh establishes the standard topology and UV coordinates used for index matching. It is expected that for all catalog avatars this points to one of the 15 standard reference meshes provided by Roblox, but for some NPCs or a custom avatar system it might point to a different mesh. This property is normally set up automatically by the Importer.

This Content-typed property is the successor to WrapLayer.ReferenceMeshId and reads and writes the same underlying storage. Defaults to an empty Content.

Field	Value
type	Content
security	{"read":"None","write":"PluginSecurity"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["AvatarAppearance"]

WrapLayer.ReferenceMeshId

AssetID for reference mesh used to define Inner Cage of a 3D object

Reference mesh is used to define standard topology and UV coordinates for index matching. It is expected that for all catalog avatars, this will point to one of 15 standard reference meshes provided by Roblox. But for some NPCs or a custom avatar system, this might point to other meshes.

Note: this property is set up automatically by the FBX importer

Field	Value
type	ContentId
security	{"read":"None","write":"PluginSecurity"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["AvatarAppearance"]

WrapLayer.ReferenceOrigin

Reference mesh offset relative to parent MeshPart (in the parent MeshPart space)

Note: this property is set up automatically by the FBX importer

Field	Value
type	CFrame
security	{"read":"None","write":"PluginSecurity"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["AvatarAppearance"]

WrapLayer.ReferenceOriginWorld

Reference mesh offset relative to parent MeshPart (in the world space)

Note: this property is set up automatically by the FBX importer

Field	Value
type	CFrame
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["AvatarAppearance"]

WrapLayer.ShrinkFactor

Deprecated.

This property is intended for fine-tuning purposes and is highly optional.

Allows slight shrinking/expanding of the resulting render mesh, without affecting any other layers. This is useful in rare cases when the clothing mesh does not precisely fit the underlying clothing layers (the cage is usually slightly overestimated atop the real shape to avoid layer interpenetration). Even slight overestimation has the tendency to accumulate, especially when there are a lot of layers. While this is usually not critical, some items like backpacks may be problematic.

Valid range is -1 to 1. A value of -1 will maximally expand while a value of 1 will maximally shrink. A value of 0 (default) has no effect.

Field	Value
type	float
tags	["Deprecated"]
security	{"read":"None","write":"PluginSecurity"}
thread safety	ReadSafe
category	Tuning
serialization	{"can_load":true,"can_save":true}
capabilities	["AvatarAppearance"]

Methods

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.