WrapLayer
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.
| Memory category | Instances |
|---|
Member index 16
Description
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.
History 97
- 731 Add
- 731 Add
- 731 Change Default of ShrinkFactor from to 0
- 731 Change Default of ReferenceOriginWorld from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 731 Change Default of ReferenceOrigin from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 731 Change Default of ReferenceMeshContent from to
- 731 Change Default of Puffiness from to 1
- 731 Change Default of Order from to 1
- 731 Change Default of from to Vector3(0, 0, 0)
- 731 Change Default of from to Vector3(0, 0, 0)
- 731 Change Default of Enabled from to true
- 731 Change Default of DebugMode from to None
- 731 Change Default of Color from to Color3(1, 1, 1)
- 731 Change Default of BindOffset from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 731 Change Default of AutoSkin from to Disabled
- 727 Change Tags of ShrinkFactor from [] to [Deprecated]
- 727 Change Tags of Puffiness from [] to [Deprecated]
- 726 Remove
- 726 Change Default of ShrinkFactor from 0 to
- 726 Change Default of ReferenceOriginWorld from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of ReferenceOrigin from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of ReferenceMeshContent from to
- 726 Change Default of Puffiness from 1 to
- 726 Change Default of Order from 1 to
- 726 Change Default of from Vector3(0, 0, 0) to
- 726 Change Default of from Vector3(0, 0, 0) to
- 726 Change Default of Enabled from true to
- 726 Change Default of DebugMode from None to
- 726 Change Default of Color from Color3(1, 1, 1) to
- 726 Change Default of BindOffset from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of AutoSkin from Disabled to
- 705 Change Default of ReferenceOriginWorld from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of ReferenceOrigin from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of BindOffset from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of ReferenceOriginWorld from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 705 Change Default of ReferenceOrigin from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 705 Change Default of BindOffset from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 702 Change Default of ReferenceOriginWorld from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 702 Change Default of ReferenceOrigin from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 702 Change Default of BindOffset from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 688 Change CanSave of from true to false
- 688 Change CanLoad of from true to false
- 688 Change CanLoad of from true to false
- 688 Change CanSave of from true to false
- 674 Add
- 674 Add
- 664 Change Tags of ReferenceMeshContent from [Hidden] to []
- 649 Change CanSave of ReferenceMeshContent from false to true
- 649 Change CanLoad of ReferenceMeshContent from false to true
- 648 Add ReferenceMeshContent
- 645 Change ValueType of from Content to ContentId
- 645 Change ValueType of ReferenceMeshId from Content to ContentId
- 553 Add
- 553 Change Default of ShrinkFactor from to 0
- 553 Change Default of ReferenceOriginWorld from to
- 553 Change Default of ReferenceOrigin from to
- 553 Change Default of Puffiness from to 1
- 553 Change Default of Order from to 1
- 553 Change Default of Enabled from to true
- 553 Change Default of DebugMode from to None
- 553 Change Default of Color from to Color3(1, 1, 1)
- 553 Change Default of BindOffset from to
- 553 Change Default of AutoSkin from to Disabled
- 529 Change WriteSecurity of Puffiness from PluginSecurity to None
- 529 Change WriteSecurity of Order from PluginSecurity to None
- 526 Add AutoSkin
- 486 Change ThreadSafety of ShrinkFactor from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ReferenceOriginWorld from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ReferenceOrigin from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ReferenceMeshId from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Puffiness from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Order from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Enabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DebugMode from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Color from ReadOnly to ReadSafe
- 486 Change ThreadSafety of BindOffset from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ShrinkFactor from to ReadOnly
- 462 Change ThreadSafety of ReferenceOriginWorld from to ReadOnly
- 462 Change ThreadSafety of ReferenceOrigin from to ReadOnly
- 462 Change ThreadSafety of ReferenceMeshId from to ReadOnly
- 462 Change ThreadSafety of Puffiness from to ReadOnly
- 462 Change ThreadSafety of Order from to ReadOnly
- 462 Change ThreadSafety of Enabled from to ReadOnly
- 462 Change ThreadSafety of DebugMode from to ReadOnly
- 462 Change ThreadSafety of Color from to ReadOnly
- 462 Change ThreadSafety of BindOffset from to ReadOnly
- 458 Add ShrinkFactor
- 458 Add ReferenceOriginWorld
- 458 Add ReferenceOrigin
- 458 Add ReferenceMeshId
- 458 Add Puffiness
- 458 Add Order
- 458 Add Enabled
- 458 Add DebugMode
- 458 Add Color
- 458 Add BindOffset
- 458 Add WrapLayer
Members 16
AutoSkin
| Type | Default | |
|---|---|---|
| WrapLayerAutoSkin | Disabled | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Behavior |
| Loaded/Saved | true |
BindOffset
| Type | Default | |
|---|---|---|
| CFrame | 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1 | |
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.
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Tuning |
| Loaded/Saved | true |
History 9
- 731 Change Default of BindOffset from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 726 Change Default of BindOffset from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 705 Change Default of BindOffset from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of BindOffset from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 702 Change Default of BindOffset from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 553 Change Default of BindOffset from to
- 486 Change ThreadSafety of BindOffset from ReadOnly to ReadSafe
- 462 Change ThreadSafety of BindOffset from to ReadOnly
- 458 Add BindOffset
Color
| Type | Default | |
|---|---|---|
| Color3 | 1, 1, 1 | |
Sets color used for the debug rendering. See WrapTarget.DebugMode
| Thread safety | ReadSafe |
|---|---|
| Category | Debug |
| Loaded/Saved | false |
DebugMode
| Type | Default | |
|---|---|---|
| WrapLayerDebugMode | None | |
Allows switching between different debugging visualization modes for cage meshes.
| Thread safety | ReadSafe |
|---|---|
| Category | Debug |
| Loaded/Saved | false |
Enabled
| Type | Default | |
|---|---|---|
| bool | true | |
Allows for disabling of the WrapLayer object as if it does not exist.
| Thread safety | ReadSafe |
|---|---|
| Category | Behavior |
| Loaded/Saved | true |
Order
| Type | Default | |
|---|---|---|
| int | 1 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
History 7
Puffiness
| Type | Default | |
|---|---|---|
| float | 1 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
History 8
- 731 Change Default of Puffiness from to 1
- 727 Change Tags of Puffiness from [] to [Deprecated]
- 726 Change Default of Puffiness from 1 to
- 553 Change Default of Puffiness from to 1
- 529 Change WriteSecurity of Puffiness from PluginSecurity to None
- 486 Change ThreadSafety of Puffiness from ReadOnly to ReadSafe
- 462 Change ThreadSafety of Puffiness from to ReadOnly
- 458 Add Puffiness
ReferenceMeshContent
| Type | Default | |
|---|---|---|
| Content | ||
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.
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 6
- 731 Change Default of ReferenceMeshContent from to
- 726 Change Default of ReferenceMeshContent from to
- 664 Change Tags of ReferenceMeshContent from [Hidden] to []
- 649 Change CanSave of ReferenceMeshContent from false to true
- 649 Change CanLoad of ReferenceMeshContent from false to true
- 648 Add ReferenceMeshContent
ReferenceMeshId
| Type | Default | |
|---|---|---|
| ContentId | ||
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
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 4
- 645 Change ValueType of ReferenceMeshId from Content to ContentId
- 486 Change ThreadSafety of ReferenceMeshId from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ReferenceMeshId from to ReadOnly
- 458 Add ReferenceMeshId
ReferenceOrigin
| Type | Default | |
|---|---|---|
| CFrame | 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1 | |
Reference mesh offset relative to parent MeshPart (in the parent MeshPart space)
Note: this property is set up automatically by the FBX importer
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 9
- 731 Change Default of ReferenceOrigin from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 726 Change Default of ReferenceOrigin from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 705 Change Default of ReferenceOrigin from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of ReferenceOrigin from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 702 Change Default of ReferenceOrigin from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 553 Change Default of ReferenceOrigin from to
- 486 Change ThreadSafety of ReferenceOrigin from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ReferenceOrigin from to ReadOnly
- 458 Add ReferenceOrigin
ReferenceOriginWorld
| Type | Default | |
|---|---|---|
| CFrame | 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1 | |
Reference mesh offset relative to parent MeshPart (in the world space)
Note: this property is set up automatically by the FBX importer
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 9
- 731 Change Default of ReferenceOriginWorld from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 726 Change Default of ReferenceOriginWorld from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 705 Change Default of ReferenceOriginWorld from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of ReferenceOriginWorld from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 702 Change Default of ReferenceOriginWorld from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 553 Change Default of ReferenceOriginWorld from to
- 486 Change ThreadSafety of ReferenceOriginWorld from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ReferenceOriginWorld from to ReadOnly
- 458 Add ReferenceOriginWorld
ShrinkFactor
| Type | Default | |
|---|---|---|
| float | 0 | |
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.
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Tuning |
| Loaded/Saved | true |
History 7
- 731 Change Default of ShrinkFactor from to 0
- 727 Change Tags of ShrinkFactor from [] to [Deprecated]
- 726 Change Default of ShrinkFactor from 0 to
- 553 Change Default of ShrinkFactor from to 0
- 486 Change ThreadSafety of ShrinkFactor from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ShrinkFactor from to ReadOnly
- 458 Add ShrinkFactor