Class
CylinderHandleAdornment
A cylinder-shaped handle that can be adorned to a BasePart.
CylinderHandleAdornment is a cylinder-shaped handle that can be adorned to a
BasePart. If parented to a player's PlayerGui or the
CoreGui, handles can listen to input events for purposes such as
making dragger tools.
Properties 5#
Anglefloat | Angle of the cylinder handle as in a "pie slice" sector.ReadSafe |
Heightfloat | Height of the cylinder adornment.ReadSafe |
InnerRadiusfloat | Inner radius with which to render a hollow cylinder.ReadSafe |
Radiusfloat | Radius of the cylinder adornment.ReadSafe |
ShadingAdornShading | Determines how the cylinder adornment is shaded and whether it draws through geometry that would otherwise occlude it.ReadSafe |
Angle: float#
ReadSafe
The angle of the cylinder handle as in a "pie slice" sector. For example,
if set to 90, a quarter cylinder will render instead of a full cylinder.
This property can be combined with
InnerRadius to render a sector
of a hollow cylinder.
Height: float#
ReadSafe
The height of the cylinder adornment in studs.
InnerRadius: float#
ReadSafe
Radius: float#
ReadSafe
The radius of the cylinder adornment in studs.
Shading: AdornShading#
ReadSafe
Shading selects the material and render pass used to draw the cylinder,
using a value of the AdornShading enum. It defaults to
Default, which draws the cylinder unlit and occluded
by scene geometry like an ordinary world object.
Shaded and XRayShaded light the
cylinder with the scene's lighting instead of drawing it unlit, while
XRay and XRayShaded draw the
cylinder through geometry that would otherwise occlude it.
AlwaysOnTop draws the cylinder on top of everything
else with no depth testing.
The legacy HandleAdornment.AlwaysOnTop property only takes effect
while Shading is Default; any other Shading value
determines the render pass on its own.
Inherited members#
Inherited from HandleAdornment 9
Properties (5)
AdornCullingMode, AlwaysOnTop, CFrame, SizeRelativeOffset, ZIndex
Events (4)
Inherited from PVAdornment 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