Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SelectionSphere

Renders a 3D sphere around its Adornee.

Memory categoryInstances

Member index 3

HistoryMember
726SurfaceColor3: Color3
726SurfaceTransparency: float
inherited from PVAdornment
726Adornee: PVInstance
inherited from GuiBase3d
726Color3: Color3
726Transparency: float
726Visible: bool
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

SelectionSphere renders a 3D sphere around its Adornee when it is a descendant of the Workspace or anywhere where GUI objects are rendered. The sphere's geometry consists of a ring/outline in addition to a surface. SelectionSphere does not capture any form of input; it is solely a visual effect.

For an outline/fill overlay effect which covers non‑primitive geometry such as that of a MeshPart, see Highlight.

History 19

Members 3

SurfaceColor3

TypeDefault
Color3

SurfaceColor3 determines the color of the sphere's surface.

See also Color3, a property of the superclass GuiBase3d which controls the color of the outline rather than the surface faces.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

SurfaceTransparency

TypeDefault
float

SurfaceTransparency determines the transparency of the sphere's surface, similar to the way BasePart.Transparency works. By default, this property is 1 which causes the surfaces to be invisible.

See also Transparency, a property of the superclass GuiBase3d which controls the transparency of the outline rather than the surface.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Settings