Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SelectionSphere

Renders a 3D sphere around its Adornee.

Memory categoryInstances

Member index 3

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

SelectionSphere is an object which 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. By default, only the outline is visible.

There are a few properties available to configure the appearance of the sphere. The outline can modified through the GuiBase3d.Color3 and GuiBase3d.Transparency properties. The surface can be modified through the SurfaceColor3 and SurfaceTransparency properties. Finally, rendering of the sphere can be toggled with the GuiBase3d.Visible property.

GuiBase3d.

The SelectionSphere object does not capture any form of input; it is solely a visual effect. To capture simple pointer input on the adornee, consider using a ClickDetector.

History 15

Members 3

SurfaceColor3

TypeDefault
Color30.0509804, 0.411765, 0.67451

SurfaceColor3 determines the color of the SelectionSphere's surface.

See also:

  • SurfaceTransparency, which controls the transparency of the surface. You may need to adjust this property in order to see changes to SurfaceColor3.
  • GuiBase3d.Color, a property of the superclass GuiBase3d which controls the color of the outline rather than the surface faces
Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

SurfaceTransparency

TypeDefault
float1

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

See also:

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

Settings