Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GeometryService

Service containing geometric operations.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service]

Member index 11

HistoryMember
598CalculateConstraintsToPreserve(source: Instance, destination: Array, options: Dictionary = nil): Array
711CreateSolidPrimitive(type: SolidPrimitiveType, options: Dictionary = nil): MeshPart
710FragmentAsync(part: BasePart, sites: Array, options: Dictionary = nil): Array
710GenerateFragmentSites(part: BasePart, options: Dictionary = nil): Array
645HashMeshAsync(meshId: ContentId): string
598IntersectAsync(part: Instance, parts: Array, options: Dictionary = nil): Array
598SubtractAsync(part: Instance, parts: Array, options: Dictionary = nil): Array
699SweepPartAsync(part: BasePart, cframes: Array, options: Dictionary = nil): MeshPart
692TranscodeMesh(instance: Instance): null
695TranscodeModel(instance: Instance): Array
598UnionAsync(part: Instance, parts: Array, options: Dictionary = nil): Array
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: 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
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 1

HistoryMember
652StitchMeshesAsync(meshParts: Array): ContentId

Description

Service containing geometric operations not directly related to specific objects.

History 29

Members 11

CalculateConstraintsToPreserve

Parameters (3)Default
sourceInstance
destinationArray
optionsDictionarynil
Returns (1)
Array

Returns a table of Constraints and Attachments which you may choose to preserve, along with their respective parents. Iterating over this table lets you decide whether to reparent recommended constraints and attachments to their respective parents.

For more information and detailed examples, see https://create.roblox.com/docs/parts/solid-modeling#in-experience-solid-modeling.

History 4

CreateSolidPrimitive

Parameters (2)Default
typeSolidPrimitiveType
optionsDictionarynil
Returns (1)
MeshPart

History 1

FragmentAsync

Parameters (3)Default
partBasePart
sitesArray
optionsDictionarynil
Returns (1)
Array

Breaks a BasePart into multiple MeshPart instances, according to the pattern of points passed in, by using voronoi decomposition. Terrain is not supported. Similar to Clone(), the returned parts have no set Parent.

For more information and detailed examples, see https://create.roblox.com/docs/parts/solid-modeling#in-experience-solid-modeling.

This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GenerateFragmentSites

Parameters (2)Default
partBasePart
optionsDictionarynil
Returns (1)
Array

Provides an array of positions which can easily be passed into FragmentAsync() to perform common types of destruction: Fragmenting an entire BasePart into pieces, or a localized area of a BasePart into pieces.

The positions outputted are partially random, so the output should not be relied on to look exactly the same as the first time it is run with the same parameters.

For more information and detailed examples, see https://create.roblox.com/docs/parts/solid-modeling#in-experience-solid-modeling. Luau code to mimic this API has also been provided on that page, which can be freely modified if a slightly different effect is desired.

History 1

HashMeshAsync

Parameters (1)
meshIdContentId
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

IntersectAsync

Parameters (3)Default
partInstance
partsArray
optionsDictionarynil
Returns (1)
Array

Creates one or more PartOperations or MeshParts from the intersecting geometry of multiple parts. Primitive Parts, PartOperations, and MeshParts are supported as inputs, but not Terrain.

Similarly to Clone(), the returned parts have no set Parent. In most cases, you should parent the results to the same place as the main part, then Destroy() the original parts.

This function replaces BasePart:IntersectAsync(). Go to that page for a description of the differences.

For more information and detailed examples, see https://create.roblox.com/docs/parts/solid-modeling#in-experience-solid-modeling.

This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

SubtractAsync

Parameters (3)Default
partInstance
partsArray
optionsDictionarynil
Returns (1)
Array

Creates one or more PartOperations or MeshParts consisting of the space occupied by one part minus the space occupied by the other parts. Primitive Parts, PartOperations, and MeshParts are supported as inputs, but not Terrain.

Similarly to Clone(), the returned parts have no set Parent. In most cases, you should parent the results to the same place as the main part, then Destroy() the original parts.

This function replaces BasePart:SubtractAsync(). Go to that page for a description of the differences.

For more information and detailed examples, see https://create.roblox.com/docs/parts/solid-modeling#in-experience-solid-modeling.

This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

SweepPartAsync

Parameters (3)Default
partBasePart
cframesArray
optionsDictionarynil
Returns (1)
MeshPart

Creates a MeshPart which has the shape of the input part stretched/dragged through the given set of CFrame positions. The exact shape of the result is defined as the union of the convex hulls of each adjacent pair of CFrames.

If a single CFrame is provided, the result will be a convex hull of the input part.

For more information and detailed examples, see https://create.roblox.com/docs/parts/solid-modeling#in-experience-solid-modeling.

This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

TranscodeMesh

Parameters (1)
instanceInstance
Returns (1)
null

History 1

TranscodeModel

Parameters (1)
instanceInstance
Returns (1)
Array

History 1

UnionAsync

Parameters (3)Default
partInstance
partsArray
optionsDictionarynil
Returns (1)
Array

Creates one or more PartOperations or MeshParts consisting of the space occupied by one part plus the space occupied by the other parts. Primitive Parts, PartOperations, and MeshParts are supported as inputs, but not Terrain.

Similarly to Clone(), the returned parts have no set Parent. In most cases, you should parent the results to the same place as the main part, then Destroy() the original parts.

This function replaces BasePart:UnionAsync(). Go to that page for a description of the differences.

For more information and detailed examples, see https://create.roblox.com/docs/parts/solid-modeling#in-experience-solid-modeling.

This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

Removed members 1

StitchMeshesAsync

Parameters (1)
meshPartsArray
Returns (1)
ContentId
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

Settings