Reference API Roblox

Engine API

Website

Related

Reference API Roblox

WrapTarget

The WrapTarget object defines a target. A target is the 3D body with only an outer surface, or an Outer Cage.

Memory categoryInstances

Member index 3

HistoryMember
726Color: Color3
726DebugMode: WrapTargetDebugMode
727Stiffness: float
inherited from BaseWrap
726CageMeshContent: Content
726CageMeshId: ContentId
726CageOrigin: CFrame
726CageOriginWorld: CFrame
726HSRAssetId: ContentId
726ImportOrigin: CFrame
726ImportOriginWorld: CFrame
603GetCageOffset(): Vector3
475GetFaces(cageType: CageType): Array
629GetUVs(cageType: CageType): Array
475GetVertices(cageType: CageType): Array
499IsHSRReady(): bool
573ModifyVertices(cageType: CageType, vertices: Array): null
639VerticesModified(vertices: Array)
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Description

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.

History 17

Members 3

Color

TypeDefault
Color3

Sets color used for the debug rendering. See WrapTarget.DebugMode

This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
Thread safetyReadSafe
CategoryDebug
Loaded/Savedfalse

History 5

Tags: [NotReplicated, NotScriptable]

DebugMode

TypeDefault
WrapTargetDebugMode

Allows switching between different debugging visualization modes for cage meshes.

This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
Thread safetyReadSafe
CategoryDebug
Loaded/Savedfalse

History 5

Tags: [NotReplicated, NotScriptable]

Stiffness

TypeDefault
float

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.

This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
Write securityPluginSecurity
Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 6

Tags: [Deprecated]

Settings