Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SelectionBox

Renders a 3D box around its Adornee.

Memory categoryInstances

Member index 5

HistoryMember
553LineThickness: float
553SurfaceColor3: Color3
553SurfaceTransparency: float
inherited from InstanceAdornment
553Adornee: Instance
inherited from GuiBase3d
553Color3: Color3
553Transparency: float
553Visible: bool
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
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)

Description

SelectionBox renders a 3D box around its Adornee when it is a descendant of the Workspace or anywhere where GUI objects are rendered. The box's geometry consists of rectangular prisms forming an outline/wireframe in addition to a surface for each of its faces. SelectionBox 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 22

Members 5

LineThickness

TypeDefault
float0.150000006

LineThickness determines the thickness of the box's outlines, measured in studs. If set to 0, the outline will not be visible at all.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

SurfaceColor3

TypeDefault
Color30.0509804, 0.411765, 0.67451

SurfaceColor3 determines the color of the box's surfaces.

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 4

SurfaceTransparency

TypeDefault
float1

SurfaceTransparency determines the transparency of the box's surfaces, 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 surfaces.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

Settings