BaseWrap
Abstract base class for WrapTarget and WrapLayer that stores cage mesh data for layered clothing deformation.
| Memory category | Instances |
|---|
Member index 20
Removed member index 2
| History | Member |
|---|
Description
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.
History 73
- 731 Add
- 731 Add
- 731 Change Default of ImportOriginWorld from to
- 731 Change Default of ImportOrigin from to
- 731 Add
- 731 Add
- 731 Add
- 731 Add HSRContent
- 731 Change Default of HSRAssetId from to
- 731 Change Default of CageOriginWorld from to
- 731 Change Default of CageOrigin from to
- 731 Change Default of CageMeshId from to
- 731 Change Default of CageMeshContent from to
- 726 Remove
- 726 Change Default of ImportOriginWorld from to
- 726 Change Default of ImportOrigin from to
- 726 Remove
- 726 Remove
- 726 Remove
- 726 Change Default of HSRAssetId from to
- 726 Change Default of CageOriginWorld from to
- 726 Change Default of CageOrigin from to
- 726 Change Default of CageMeshId from to
- 726 Change Default of CageMeshContent from to
- 693 Change Tags of HSRAssetId from [NotScriptable] to []
- 693 Change ReadSecurity of HSRAssetId from RobloxSecurity to RobloxScriptSecurity
- 674 Remove
- 674 Remove
- 672 Add
- 672 Add
- 664 Change Tags of CageMeshContent from [Hidden] to []
- 649 Change CanSave of CageMeshContent from false to true
- 649 Change CanLoad of CageMeshContent from false to true
- 648 Add CageMeshContent
- 645 Change ValueType of from Content to ContentId
- 645 Change ValueType of HSRAssetId from Content to ContentId
- 645 Change ValueType of CageMeshId from Content to ContentId
- 639 Change Parameters of VerticesModified from () to (vertices: Array)
- 629 Add GetUVs
- 619 Add VerticesModified
- 603 Add GetCageOffset
- 573 Change ReturnType of ModifyVertices from void to null
- 553 Add
- 553 Change Default of ImportOriginWorld from to
- 553 Change Default of ImportOrigin from to
- 553 Add
- 553 Add
- 553 Add
- 553 Change Default of HSRAssetId from to
- 553 Change Default of CageOriginWorld from to
- 553 Change Default of CageOrigin from to
- 553 Change Default of CageMeshId from to
- 506 Add HSRAssetId
- 499 Add IsHSRReady
- 486 Change ThreadSafety of ImportOriginWorld from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ImportOrigin from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CageOriginWorld from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CageOrigin from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CageMeshId from ReadOnly to ReadSafe
- 475 Add ModifyVertices
- 475 Add GetVertices
- 475 Add GetFaces
- 462 Change ThreadSafety of ImportOriginWorld from to ReadOnly
- 462 Change ThreadSafety of ImportOrigin from to ReadOnly
- 462 Change ThreadSafety of CageOriginWorld from to ReadOnly
- 462 Change ThreadSafety of CageOrigin from to ReadOnly
- 462 Change ThreadSafety of CageMeshId from to ReadOnly
- 458 Add ImportOriginWorld
- 458 Add ImportOrigin
- 458 Add CageOriginWorld
- 458 Add CageOrigin
- 458 Add CageMeshId
- 458 Add BaseWrap
Members 20
CageMeshContent
| Type | Default | |
|---|---|---|
| Content | ||
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.
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 6
- 731 Change Default of CageMeshContent from to
- 726 Change Default of CageMeshContent from to
- 664 Change Tags of CageMeshContent from [Hidden] to []
- 649 Change CanSave of CageMeshContent from false to true
- 649 Change CanLoad of CageMeshContent from false to true
- 648 Add CageMeshContent
CageMeshId
| Type | Default | |
|---|---|---|
| ContentId | ||
This property is set up automatically by the 3D Importer.
Asset ID for cage mesh.
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 7
- 731 Change Default of CageMeshId from to
- 726 Change Default of CageMeshId from to
- 645 Change ValueType of CageMeshId from Content to ContentId
- 553 Change Default of CageMeshId from to
- 486 Change ThreadSafety of CageMeshId from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CageMeshId from to ReadOnly
- 458 Add CageMeshId
CageOrigin
| Type | Default | |
|---|---|---|
| CFrame | ||
This property is set up automatically by the 3D Importer.
Cage mesh offset relative to parent MeshPart.
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 6
- 731 Change Default of CageOrigin from to
- 726 Change Default of CageOrigin from to
- 553 Change Default of CageOrigin from to
- 486 Change ThreadSafety of CageOrigin from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CageOrigin from to ReadOnly
- 458 Add CageOrigin
CageOriginWorld
| Type | Default | |
|---|---|---|
| CFrame | ||
Cage mesh offset in world space.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 6
- 731 Change Default of CageOriginWorld from to
- 726 Change Default of CageOriginWorld from to
- 553 Change Default of CageOriginWorld from to
- 486 Change ThreadSafety of CageOriginWorld from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CageOriginWorld from to ReadOnly
- 458 Add CageOriginWorld
GetCageOffset
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Vector3 | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 603 Add GetCageOffset
GetFaces
| Parameters (1) | ||
|---|---|---|
| cageType | CageType | |
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
GetUVs
| Parameters (1) | ||
|---|---|---|
| cageType | CageType | |
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
GetVertices
| Parameters (1) | ||
|---|---|---|
| cageType | CageType | |
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 475 Add GetVertices
HSRAssetId
| Type | Default | |
|---|---|---|
| ContentId | ||
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.
| Read security | RobloxScriptSecurity |
|---|---|
| Write security | RobloxSecurity |
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | true |
History 7
- 731 Change Default of HSRAssetId from to
- 726 Change Default of HSRAssetId from to
- 693 Change Tags of HSRAssetId from [NotScriptable] to []
- 693 Change ReadSecurity of HSRAssetId from RobloxSecurity to RobloxScriptSecurity
- 645 Change ValueType of HSRAssetId from Content to ContentId
- 553 Change Default of HSRAssetId from to
- 506 Add HSRAssetId
HSRContent
| Type | Default | |
|---|---|---|
| Content | ||
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.
| Read security | RobloxScriptSecurity |
|---|---|
| Write security | RobloxSecurity |
| Thread safety | ReadSafe |
| Category | Data |
| Loaded/Saved | true |
History 1
- 731 Add HSRContent
ImportOrigin
| Type | Default | |
|---|---|---|
| CFrame | ||
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:
| Write security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Appearance |
| Loaded/Saved | true |
History 6
- 731 Change Default of ImportOrigin from to
- 726 Change Default of ImportOrigin from to
- 553 Change Default of ImportOrigin from to
- 486 Change ThreadSafety of ImportOrigin from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ImportOrigin from to ReadOnly
- 458 Add ImportOrigin
ImportOriginWorld
| Type | Default | |
|---|---|---|
| CFrame | ||
Describes where the origin (in world space) was while authoring the cage mesh in an asset creation tool such as Blender or Maya.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 6
- 731 Change Default of ImportOriginWorld from to
- 726 Change Default of ImportOriginWorld from to
- 553 Change Default of ImportOriginWorld from to
- 486 Change ThreadSafety of ImportOriginWorld from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ImportOriginWorld from to ReadOnly
- 458 Add ImportOriginWorld
IsHSRReady
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 499 Add IsHSRReady
ModifyVertices
| Parameters (2) | ||
|---|---|---|
| cageType | CageType | |
| vertices | Array | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 573 Change ReturnType of ModifyVertices from void to null
- 475 Add ModifyVertices
VerticesModified
| Parameters (1) | |
|---|---|
| vertices | Array |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 639 Change Parameters of VerticesModified from () to (vertices: Array)
- 619 Add VerticesModified