Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
BaseWrap
Inherits from: Instance → Object
The base class for WrapTarget and WrapLayer objects. Note that MeshPart is the only valid parent type for BaseWrap and that it behaves more like a component of MeshPart than an independent object.
Inherits from: Instance
Descendants: WrapDeformer, WrapLayer, WrapTarget
Memory category: Instances
Tags: NotCreatable
Properties
| 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 |
BaseWrap.CageMeshContent
The cage mesh this wrap uses to deform geometry, stored as a Content value that can reference an uploaded mesh asset or an in-memory EditableMesh. Set automatically by the Importer. It is the backing store for BaseWrap.CageMeshId: that property reads the mesh ID from this content, and setting either keeps both in sync and raises a change on both.
Defaults to an empty Content. Without a valid cage, the wrap cannot contribute to layered clothing deformation for WrapLayer or WrapTarget.
| Field | Value |
|---|---|
| type | Content |
| security | {"read":"None","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AvatarAppearance"] |
BaseWrap.CageMeshId
This property is set up automatically by the 3D Importer.
Asset ID for cage mesh.
| Field | Value |
|---|---|
| type | ContentId |
| security | {"read":"None","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AvatarAppearance"] |
BaseWrap.CageOrigin
This property is set up automatically by the 3D Importer.
Cage mesh offset relative to parent MeshPart.
| Field | Value |
|---|---|
| type | CFrame |
| security | {"read":"None","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AvatarAppearance"] |
BaseWrap.CageOriginWorld
Cage mesh offset in world space.
| 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"] |
BaseWrap.HSRAssetId
This property is not accessible through scripts but is viewable in the Properties window for any BaseWrap object. It references precomputed data that determines which mesh triangles are hidden when clothing layers overlap.
| Field | Value |
|---|---|
| type | ContentId |
| security | {"read":"RobloxScriptSecurity","write":"RobloxEngineSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AvatarAppearance"] |
BaseWrap.HSRContent
Hidden surface removal (HSR) data for this wrap, stored as a Content value that references a precomputed mesh asset. It is the backing store for BaseWrap.HSRAssetId: that property reads the asset ID from this content, and setting either keeps both in sync.
The content determines which mesh triangles are hidden when clothing layers overlap so occluded geometry can be culled during layered clothing deformation. Generated automatically when a BaseWrap is published; you do not need to set it manually.
| Field | Value |
|---|---|
| type | Content |
| security | {"read":"RobloxScriptSecurity","write":"RobloxEngineSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AvatarAppearance"] |
BaseWrap.ImportOrigin
This property is set up automatically by the 3D Importer.
Describes where a global zero was while authoring the cage mesh in an asset creation tool such as Blender or Maya. This property is not used by the deformer but it is useful for tools/aligning scripts, for example aligning two parts by matching their pivots as follows:
| Field | Value |
|---|---|
| type | CFrame |
| security | {"read":"None","write":"PluginSecurity"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AvatarAppearance"] |
Code samples: View on Creator Hub (BaseWrap-ImportOrigin).
BaseWrap.ImportOriginWorld
Describes where the origin (in world space) was while authoring the cage mesh in an asset creation tool such as Blender or Maya.
| 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"] |
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. |