In the Adornments API reference of the SelectionBox, SelectionSphere, and SelecitonSurface articles, they include some outdated or little-to-no examples of what they look like inside of Roblox Studio and a more in-depth explanation on what they do and how they perform on a certain part(s).
To me, the API reference(s) of the Selection family should improve a bunch with code examples/samples and more descriptions on how to use these properties and some creations with these from users if possible? -- Would be a nice addition to the Developer Hub!
How I would write each documentation:
SelectionBox:
SelectionBox
A SelectionBox is an object which is used to put a 3D box around the part it’s adorned to.
SelectionBoxes require a parent, like all objects and an Adornee
. You can place the SelectionBox wherever you want as its parent unless the Instance
is a part, but you must set its adornee. An adornee what it shows up on, so basically it makes it overlay onto the surfaces of the parts.
A SelectionBox
will and would require a part such as the Instance
Part
.
See also:
-
Selection-Boxes, an article providing more information about or how to use Selection
Instance
. -
Surface-Selection, another article providing more information and description about how to use
SelectionSurface
in situations in Lua and more. -
Selection-Sphere, an article that uses a Ball shape/part and how to use it in Lua and building on Roblox.
SurfaceSelection
SurfaceSelection
An instance used to show a physical selection of a particular side of a BasePart
. However, it should be noted that the GuiBase3d.Transparency
property doesn’t appear to currently work with this instance.
This can be used on any BasePart
or Part
inside Roblox Studio like the Ball or Sphere part.
See also:
-
Selection-Boxes, an article providing more information about or how to use Selection
Instance
. -
Selection-Box, another article providing more information and description about how to use
SelectionSurface
in situations in Lua and more. -
Selection-Sphere, an article that uses a Ball shape/part and how to use it in Lua and building on Roblox.
SelectionSphere:
SelectionSphere
An object which is used to put a 3D sphere around the part it’s adorned to. Intended for use on parts that have their Part.Shape
set to Ball or the part named Sphere.
You can link this to parts like Part, Wedge, and Cylinder, but due to the name of the Instance
, it can be only parented to the Ball part for it to fit well.
You can create a SelectionSphere
Instance as the example listed below:
local part = Instance.new("Part")
part.Parent = game.Workspace
part.Anchored = true
part.Size = Vector3.new(4,4,4)
local sphereSel = Instance.new("SelectionSphere")
sphereSel.Adornee = part
sphereSel.Color3 = Color3.new(1,0,0)
sphereSel.Parent = part
See also:
-
Selection-Boxes, an article providing more information about or how to use Selection
Instance
. -
Selection-Box, another article providing more information and description about how to use
SelectionSurface
in situations in Lua and more. -
Surface-Selection, an article that uses a Ball shape/part and how to use it in Lua and building on Roblox.
As someone who uses the SelectionBox
, I feel like a revamp of the SelectionBox
/ SelectionSphere
API articles would be necessary and appropriate as to me, it doesn’t include enough context or ways you can use it in certain situations and what types of Parent
(s) you can use these on as I mentioned above, would improve my experience and others on the hub.