Class
BaseWrap
NotCreatable
Abstract base class for WrapTarget and WrapLayer that stores
cage mesh data for layered clothing deformation.
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.
Properties 8#
CageMeshContentContent | The cage mesh this wrap uses to deform geometry, stored as a
Content value.Write: PluginSecurityReadSafe |
CageMeshIdContentId | Asset ID for cage mesh.Write: PluginSecurityReadSafe |
CageOriginCFrame | Cage mesh offset relative to parent MeshPart.Write: PluginSecurityReadSafe |
CageOriginWorldCFrame | Cage mesh offset in world space.ReadSafeReadOnlyNotReplicated |
HSRAssetIdContentId | Asset ID for the hidden surface removal (HSR) data used by layered clothing.Read: RobloxScriptSecurityWrite: RobloxEngineSecurityReadSafe |
HSRContentContent | The hidden surface removal data for this wrap, stored as a
Content value.Read: RobloxScriptSecurityWrite: RobloxEngineSecurityReadSafe |
ImportOriginCFrame | Describes where a global zero was while authoring the cage mesh in an asset creation tool.Write: PluginSecurityReadSafe |
ImportOriginWorldCFrame | Describes where the origin (in world space) was while authoring the cage mesh in an asset creation tool.ReadSafeReadOnlyNotReplicated |
CageMeshContent: Content#
Write: PluginSecurityReadSafe
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.
CageMeshId: ContentId#
Write: PluginSecurityReadSafe
This property is set up automatically by the 3D Importer.
Asset ID for cage mesh.
CageOrigin: CFrame#
Write: PluginSecurityReadSafe
This property is set up automatically by the 3D Importer.
Cage mesh offset relative to parent MeshPart.
CageOriginWorld: CFrame#
ReadOnlyNotReplicatedReadSafe
Cage mesh offset in world space.
HSRAssetId: ContentId#
Read: RobloxScriptSecurityWrite: RobloxEngineSecurityReadSafe
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.
HSRContent: Content#
Read: RobloxScriptSecurityWrite: RobloxEngineSecurityReadSafe
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.
ImportOrigin: CFrame#
Write: PluginSecurityReadSafe
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:
ImportOriginWorld: CFrame#
ReadOnlyNotReplicatedReadSafe
Describes where the origin (in world space) was while authoring the cage mesh in an asset creation tool such as Blender or Maya.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild