Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BaseWrap

This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable]

Member index 17

HistoryMember
553CageMeshId: Content
553CageOrigin: CFrame
553CageOriginWorld: CFrame
553HSRAssetId: Content
553ImportOrigin: CFrame
553ImportOriginWorld: 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
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

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 36

Members 17

CageMeshId

TypeDefault
Content

This property is set up automatically by the 3D Importer.

Asset ID for cage mesh.

History 4

CageOrigin

TypeDefault
CFrame

This property is set up automatically by the 3D Importer.

Cage mesh offset relative to parent MeshPart.

History 4

CageOriginWorld

TypeDefault
CFrame

Cage mesh offset in world space.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

GetCageOffset

Parameters (0)
No parameters.
Returns (1)
Vector3

History 1

GetFaces

Parameters (1)
cageTypeCageType
Returns (1)
Array

History 1

GetUVs

Parameters (1)
cageTypeCageType
Returns (1)
Array

History 1

GetVertices

Parameters (1)
cageTypeCageType
Returns (1)
Array

History 1

HSRAssetId

TypeDefault
Content
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

ImportOrigin

TypeDefault
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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
local function alignWraps()
	local selectionService = game:GetService("Selection")
	local selectedObjects = selectionService:Get()
	local alignObjects = {}
	for _, obj in selectedObjects do
		if obj:IsA("BaseWrap") then
			--print("Wrap: " .. obj.Name)
			table.insert(alignObjects, obj)
		else
			print("Ignore: " .. obj.Name)
		end
	end

	if #alignObjects < 2 then
		warn("You need to select at least two wraps")
		return
	end

	local anchorWrap = alignObjects[1]
	local worldA_from_Wrap = anchorWrap.ImportOriginWorld
	print("Anchor: " .. anchorWrap.Name)
	for i = 2, #alignObjects do
		local wrapToAlign = alignObjects[i]
		print("Align: " .. wrapToAlign.Name)
		local wrap_from_WorldB = wrapToAlign.ImportOriginWorld:Inverse()
		local worldA_from_WorldB = worldA_from_Wrap * wrap_from_WorldB
		local worldB = wrapToAlign.Parent.CFrame
		-- Note: adjust CFrame of the parent part
		wrapToAlign.Parent.CFrame = (worldB_from_WorldB * worldB)
	end
end

History 4

ImportOriginWorld

TypeDefault
CFrame

Describes where the origin (in world space) was while authoring the cage mesh in an asset creation tool such as Blender or Maya.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

IsHSRReady

Parameters (0)
No parameters.
Returns (1)
bool

History 1

ModifyVertices

Parameters (2)
cageTypeCageType
verticesArray
Returns (1)
null

History 2

VerticesModified

Parameters (1)
verticesArray

History 2

Settings