Class
SelectionBox
Renders a 3D box around its Adornee.
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.
Properties 4#
LineThicknessfloat | Determines the thickness of the boxes outlines, in studs.ReadSafe |
SurfaceColorBrickColor | A BrickColor version of
SurfaceColor3.ReadSafeDeprecatedHiddenNotReplicated |
SurfaceColor3Color3 | Determines the color of the box's surfaces.ReadSafe |
SurfaceTransparencyfloat | Determines the transparency of the box's surfaces.ReadSafe |
LineThickness: float#
ReadSafe
LineThickness determines the thickness of the box's outlines, measured
in studs. If set to 0, the outline will not be visible at all.
SurfaceColor: BrickColor#
HiddenNotReplicatedDeprecatedReadSafeDeprecated
Deprecated. This property is deprecated in favor of
SurfaceColor3 which uses the more
precise Color3 data type instead of a BrickColor
used by this property.
A BrickColor version of
SurfaceColor3.
SurfaceColor3: Color3#
ReadSafe
SurfaceTransparency: float#
ReadSafe
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.
Inherited members#
Inherited from InstanceAdornment 1
Properties (1)
Inherited from GuiBase3d 4
Properties (4)
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild