Reference API Roblox

Engine API

Website

Related

Reference API Roblox

HandleAdornment

An abstract class inherited by 3D handle adornments.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable]

Member index 10

HistoryMember
553AdornCullingMode: AdornCullingMode
553AlwaysOnTop: bool
553CFrame: CFrame
553SizeRelativeOffset: Vector3
553ZIndex: int
462MouseButton1Down()
462MouseButton1Up()
462MouseEnter()
462MouseLeave()
inherited from PVAdornment
553Adornee: PVInstance
inherited from GuiBase3d
553Color3: Color3
553Transparency: float
553Visible: bool
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
691GetPredictionMode(): PredictionMode
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
690IsPredicted(): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
690SetPredictionMode(mode: PredictionMode): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

HandleAdornment is an abstract class inherited by 3D handle adornments. If parented to a player's PlayerGui or the CoreGui, handles can listen to input events for purposes such as making dragger tools.

History 30

Members 10

AdornCullingMode

TypeDefault
AdornCullingMode

This property determines whether to automatically cull the adornment based on distance from the camera.

History 4

AlwaysOnTop

TypeDefault
bool

If true, forces this adornment to render on top of all 3D objects in the workspace. As an exception, setting ZIndex to -1 will override an AlwaysOnTop value of true and cause the adornment to appear either in front of or behind other adornments and objects based on their relative position in the 3D space.

History 4

CFrame

TypeDefault
CFrame

CFrame position and rotation relative to its PVAdornment.Adornee, applied after any translations due to SizeRelativeOffset.

History 4

MouseButton1Down

Parameters (0)
No parameters.

This event fires when a player presses down their left mouse button while hovering over the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.

History 2

MouseButton1Up

Parameters (0)
No parameters.

This event fires when a player releases their left mouse button while hovering over the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.

History 2

MouseEnter

Parameters (0)
No parameters.

This event fires when a player moves their mouse over the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.

History 2

MouseLeave

Parameters (0)
No parameters.

This event fires when a player moves their mouse out of the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.

History 2

SizeRelativeOffset

TypeDefault
Vector3

By default, an adornment draws in the center of its Adornee, but this property shifts the adornment's relative position based on the adornee's BasePart.Size.

Note that the units of SizeRelativeOffset are a scale based on the size of the adornee itself, such that a value of 1 will move the adornment to the corresponding edge of the adornee. For example, a value of Vector3.new(0, 1, 0) will shift the adornment to the exact top of its adornee.

History 4

ZIndex

TypeDefault
int

Only applies if AlwaysOnTop is true and determines the draw order of this HandleAdornment relative to other adornments. It does not relate to the ZIndex property for GuiObjects.

Valid values are from -1 to 10 with higher values drawing on top (in front) of lesser values. This drawing order will be respected even if an adornment is in front of or behind another adornment in the 3D space.

As an exception, setting ZIndex to -1 or AlwaysOnTop to false will cause the adornment to appear either in front of or behind other adornments and objects based on their relative position in the 3D space.

History 4

Settings