PyramidHandleAdornment

Inherits from: HandleAdornment → PVAdornment → GuiBase3d → GuiBase → Instance → Object

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.

Inherits from: HandleAdornment

Memory category: Instances

Properties

Name	Type / Returns	Description
PyramidHandleAdornment.Height	float	Height of the pyramid adornment.
PyramidHandleAdornment.Shading	AdornShading	The `AdornShading` mode that controls shading and whether the pyramid draws through occluding geometry.
PyramidHandleAdornment.Sides	int	Number of sides for the pyramid adornment.
PyramidHandleAdornment.Size	float	Size of the pyramid adornment's base.

Inherited from HandleAdornment

Name	Type / Returns	Description
HandleAdornment.AdornCullingMode	AdornCullingMode	Determines whether to automatically cull the adornment.
HandleAdornment.AlwaysOnTop	boolean	Forces this adornment to render on top of all 3D objects in the workspace.
HandleAdornment.CFrame	CFrame	The position and rotation of the object relative to its `PVAdornment.Adornee`.
HandleAdornment.SizeRelativeOffset	Vector3	The positional offset of the adornment based on the adornee's `BasePart.Size`.
HandleAdornment.ZIndex	int	Determines the draw order of this `HandleAdornment` when `AlwaysOnTop` is `true`.

Inherited from PVAdornment

Name	Type / Returns	Description
PVAdornment.Adornee	PVInstance	The `PVInstance` which this `PVAdornment` is attached to.

Inherited from GuiBase3d

Name	Type / Returns	Description
GuiBase3d.Color	BrickColor	Sets the color of a GUI object.
GuiBase3d.Color3	Color3	Sets the color of this `GuiBase3d` object.
GuiBase3d.Transparency	float	Sets the transparency of this `GuiBase3d` object.
GuiBase3d.Visible	boolean	Determines whether this `GuiBase3d` object and its descendants will be displayed.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

PyramidHandleAdornment.Height

The height of the pyramid adornment in studs.

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic","UI"]

PyramidHandleAdornment.Shading

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.

Field	Value
type	AdornShading
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic","UI"]

PyramidHandleAdornment.Sides

The number of sides for the pyramid adornment. Default is 4, minimum is 3, and maximum is 32.

Field	Value
type	int
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic","UI"]

PyramidHandleAdornment.Size

The size of the pyramid adornment's base in studs.

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic","UI"]

Events

Inherited from HandleAdornment

Name	Type / Returns	Description
HandleAdornment.MouseButton1Down		Fires when a player presses down on their left mouse button while hovering over the adornment.
HandleAdornment.MouseButton1Up		Fires when a player releases their left mouse button while hovering over the adornment.
HandleAdornment.MouseEnter		Fires when a player moves their mouse over the adornment.
HandleAdornment.MouseLeave		Fires when a player moves their mouse out of the adornment.

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.

Methods

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean