WrapDeformer

Inherits from: BaseWrap → Instance → Object

The WrapDeformer object provides a low-resolution cage mesh that pairs with a WrapTarget sibling to deform a parent MeshPart. The MeshPart geometry is deformed according to the displacement between pairs of WrapTarget cage mesh vertices and WrapDeformer cage mesh vertices. Cage mesh vertices are paired based on UV equivalence.

WrapDeformer may be used with avatars or on distinct MeshParts, as long as WrapTarget children are present for the parent MeshParts. WrapDeformer is similar to WrapLayer but doesn't require layered clothing and can directly deform MeshParts for publishing.

Inherits from: BaseWrap

Memory category: Instances

Methods

Name	Type / Returns	Description
WrapDeformer:CreateEditableMeshAsync	EditableMesh	Returns an `EditableMesh` (currently unskinned) equivalent to the deformed parent mesh.
WrapDeformer:GetDeformedCFrameAsync	CFrame	Returns a `CFrame` deformed comparably to the `MeshPart`.
WrapDeformer:SetCageMeshContent	()	Sets the cage mesh used to deform against a sibling `WrapTarget` cage mesh.

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

WrapDeformer:CreateEditableMeshAsync

Constructs and returns an EditableMesh corresponding to the deformed parent mesh geometry. This method respects all updates made to the deformation inputs prior to the request. It also sets the returned result's FixedSize to true.

Returns

Type	Description
EditableMesh	An `EditableMesh` matching the deformed parent mesh geometry, with its `FixedSize` set to `true`.

Field	Value
tags	["Yields"]
security	None
thread safety	Unsafe
capabilities	["AvatarAppearance"]

WrapDeformer:GetDeformedCFrameAsync

Returns a CFrame deformed by the same deformation field used for the geometry of the parent MeshPart. This method is useful for the placement of accessories.

The input and output CFrame are both in the space of the parent MeshPart; only position (not rotation) will be deformed. This method respects all updates made to the deformation inputs prior to the request.

Parameters

Name	Type	Default	Description
originalCFrame	CFrame		The `CFrame`, expressed in the local space of the parent `MeshPart`, whose position is deformed.

Returns

Type	Description
CFrame	A `CFrame` in the parent `MeshPart` space with its position displaced by the same deformation field applied to the parent mesh; rotation is unchanged.

Field	Value
tags	["Yields"]
security	None
thread safety	Unsafe
capabilities	["AvatarAppearance"]

WrapDeformer:SetCageMeshContent

Sets the cage mesh used to deform the parent MeshPart in conjunction with a sibling WrapTarget cage mesh. The content parameter should represent a Roblox mesh asset ID or an EditableMesh reference in your DataModel.

Parameters

Name	Type	Default	Description
content	Content		A Roblox mesh asset ID or an `EditableMesh` reference specifying the cage mesh to deform against the sibling `WrapTarget`.
cageOrigin	CFrame?		An optional `CFrame`, in the parent `MeshPart` space, that sets the cage's `CageOrigin`. When omitted, the existing `CageOrigin` is left unchanged.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["AvatarAppearance"]

Properties

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

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.