Class
PyramidHandleAdornment
A pyramid-shaped handle that can be adorned to a BasePart.
PyramidHandleAdornment is a pyramid-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 4#
Heightfloat | Height of the pyramid adornment.ReadSafe |
ShadingAdornShading | The AdornShading mode that controls shading and whether the pyramid
draws through occluding geometry.ReadSafe |
Sidesint | Number of sides for the pyramid adornment.ReadSafe |
Sizefloat | Size of the pyramid adornment's base.ReadSafe |
Height: float#
ReadSafe
The height of the pyramid adornment in studs.
Shading: AdornShading#
ReadSafe
An AdornShading value that selects the material and render pass
used to draw the pyramid. Defaults to Default, which
draws the pyramid unlit and occluded by scene geometry like an ordinary
world object.
Shaded and XRayShaded light the
pyramid with the scene's lighting instead of drawing it unlit, while
XRay and XRayShaded draw the
pyramid through geometry that would otherwise occlude it.
AlwaysOnTop draws the pyramid 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.
Sides: int#
ReadSafe
The number of sides for the pyramid adornment. Default is 4, minimum is
3, and maximum is 32.
Size: float#
ReadSafe
The size of the pyramid adornment's base in studs.
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