Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
WrapTarget
Inherits from: BaseWrap → Instance → Object
The WrapTarget object defines a target. A target is the 3D body with only an outer surface, or an Outer Cage.
This target, often an Avatar, is what 3D accessories (using WrapLayer) will be applied to, allowing multiple accessories items to naturally layer over the source target.
Inherits from: BaseWrap
Memory category: Instances
Properties
| Name | Type / Returns | Description |
|---|---|---|
| WrapTarget.Color | Color3 | Sets color used for the debug rendering. See WrapTarget.DebugMode. |
| WrapTarget.DebugMode | WrapTargetDebugMode | Allows switching between different debugging visualization modes for cage meshes. |
| WrapTarget.Stiffness | float | Defines how much the body mesh can be compressed by clothing. |
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 |
WrapTarget.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"] |
WrapTarget.DebugMode
Allows switching between different debugging visualization modes for cage meshes.
| Field | Value |
|---|---|
| type | WrapTargetDebugMode |
| tags | ["NotReplicated","NotScriptable"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Debug |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["AvatarAppearance"] |
WrapTarget.Stiffness
Deprecated.
Defines how much the body mesh can be compressed by clothing. Super tight clothing may lead to an intersection between the clothing mesh and body mesh. To solve this visual artifact, the deformer can compress the body mesh slightly to solve possible intersections.
Valid range is 0 to 1. A value of 0 will compress the body mesh as much as necessary to ensure that the intersections are eliminated (visible body parts might look a little bit deformed). A value of 1 will prevent the body mesh from being compressed (may lead to visible intersections or Z-fighting). A value of 0.9 (default) is a reasonable default that solves most of the intersections without introducing any significant body deformation.
| Field | Value |
|---|---|
| type | float |
| tags | ["Deprecated"] |
| security | {"read":"None","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AvatarAppearance"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| WrapTarget:CreateTextureInCageSpaceAsync | EditableImage | Creates a new EditableImage in cage UV space from a texture in the parent MeshPart's UV space. |
| WrapTarget:CreateTextureInTargetSpaceAsync | EditableImage | Creates a new EditableImage in the parent MeshPart's UV space from a texture in cage UV space. |
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 |
WrapTarget:CreateTextureInCageSpaceAsync
Creates a new EditableImage by transferring texture from the UV space of this WrapTarget's parent MeshPart into the UV space of the WrapTarget's cage. This method yields until the transfer is complete and does not modify the input image.
For example, after a player paints makeup onto a head mesh in an in-experience creation tool, use this method to transfer the texture into cage UV space before uploading it for use with WrapTextureTransfer. This method also supports cage-space texture transfers unrelated to makeup. To transfer a texture in the opposite direction, use WrapTarget:CreateTextureInTargetSpaceAsync().
Use options to specify a region of cage UV space. Each supplied bound must be a finite Vector2. If both bounds are supplied, MaxUVBounds must be greater than MinUVBounds on both axes. Unrecognized option keys raise an error.
This method requires the WrapTarget to be parented to a MeshPart with valid mesh and cage data. It raises an error if the input or options are invalid, required mesh data cannot be loaded, or the transfer fails. If the device-specific editable memory budget is exhausted, it returns nil. See EditableImage for additional usage requirements.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| texture | EditableImage | The EditableImage in the UV space of this WrapTarget's parent MeshPart. | |
| options | Dictionary? | Optional dictionary containing controls for the transfer: - MinUVBounds – A Vector2 specifying the minimum cage UV bound. - MaxUVBounds – A Vector2 specifying the maximum cage UV bound. Each omitted bound is calculated from the cage mesh. If neither is specified, the bounds include the entire cage. |
Returns
| Type | Description |
|---|---|
| EditableImage | A new EditableImage in cage UV space, or nil if the device-specific editable memory budget is exhausted. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["AvatarAppearance","DynamicGeneration"] |
WrapTarget:CreateTextureInTargetSpaceAsync
Creates a new EditableImage by transferring texture from cage UV space into the UV space of this WrapTarget's parent MeshPart. This method yields until the transfer is complete and does not modify the input image.
The wrapTextureTransfer supplies the optional reference cage through WrapTextureTransfer.ReferenceCageMeshContent and the cage UV bounds through WrapTextureTransfer.UVMinBound and WrapTextureTransfer.UVMaxBound. Use a WrapTextureTransfer under a Decal on the same MeshPart as the WrapTarget.
For example, use this method to transfer a makeup texture you own into a head mesh's UV space so players can edit it directly on the head in an in-experience creation tool. This method also supports target-space texture transfers unrelated to makeup. To transfer the edited texture back into cage UV space, use WrapTarget:CreateTextureInCageSpaceAsync().
This method requires the WrapTarget to be parented to a MeshPart with valid mesh and cage data. It raises an error if either input is invalid, required mesh data cannot be loaded, or the transfer fails. If the device-specific editable memory budget is exhausted, it returns nil. See EditableImage for additional usage requirements.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| texture | EditableImage | The EditableImage in cage UV space. | |
| wrapTextureTransfer | WrapTextureTransfer | The WrapTextureTransfer associated with the same parent MeshPart as this WrapTarget. |
Returns
| Type | Description |
|---|---|
| EditableImage | A new EditableImage in the parent MeshPart's UV space, or nil if the device-specific editable memory budget is exhausted. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["AvatarAppearance","DynamicGeneration"] |
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. |