Reference API Roblox

Engine API

Website

Related

Reference API Roblox

HandleAdornment

HandleAdornment is an abstract class inherited by 3D handle adornments.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
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

Note: For handles to be interactive, they must be parented to a player's PlayerGui or the CoreGui. HandleAdornment is an abstract class inherited by 3D handle adornments.

History 30

Members 10

AdornCullingMode

TypeDefault
AdornCullingMode
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

AlwaysOnTop

TypeDefault
bool

Forces this object to render on top of all 3D objects in the workspace. Even if the adornment is behind a part based on its HandleAdornment.CFrame, if AlwaysOnTop is true then the adornment will still draw on top. The one exception to this behavior is if the HandleAdornment.ZIndex of the adornment is set to -1. If this is the case, the adornment will always draw behind 3D geometry.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

CFrame

TypeDefault
CFrame

The position and rotation relative to its PVAdornment.Adornee. This CFrame is in the local space of the adornee, so forward (0,0,-1) will be forward relative to the adornee. The offset and rotation of this CFrame is applied after any translations due to HandleAdornment.SizeRelativeOffset.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

MouseButton1Down

Parameters (0)
No parameters.

Fires when a user presses down on their left mouse button while hovering over the adornment.

Thread safetyUnsafe

History 2

MouseButton1Up

Parameters (0)
No parameters.

Fires when a user releases their left mouse button while hovering over the adornment.

Thread safetyUnsafe

History 2

MouseEnter

Parameters (0)
No parameters.

Fires when a user moves their mouse over the adornment.

Thread safetyUnsafe

History 2

MouseLeave

Parameters (0)
No parameters.

Fires when a user moves their mouse out of the adornment.

Thread safetyUnsafe

History 2

SizeRelativeOffset

TypeDefault
Vector3

The positional offset of the adornment based on the adornee's BasePart.Size. By default, an adornment draws in the center of its adornee. By using this property, the position of the adornment can be shifted relative to the center of the adornee. The units of SizeRelativeOffset are a scale based on the size of the adornee itself. This scale is such that a value of 1 will move the adornment to the corresponding edge of the adornee. This property is intended to allow adornments to easily be moved to the edges of a parts.

For example, if the SizeRelativeOffset is set to (0,1,0), the adornment will be drawn with its center at the exact top of the adornee. If set to (1,1,1), the adornment will be drawn in the upper corner of the adornee.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

ZIndex

TypeDefault
int

The ZIndex property determines the draw order of the HandleAdornment. This only refers to how the adornment will draw relative to other adornments or 3D objects in the workspace. This does not relate to the GuiObject.ZIndex of GuiObjects.

The valid values for ZIndex are from -1 to 10. If two HandleAdornments are drawn over one another, the one with the higher ZIndex will be drawn. This order of drawing will be respected even if the adornment with higher ZIndex is behind the other adornment in terms of its position in 3D space. If set to -1, ZIndex will force the adornment to draw behind other adornments and objects in the Workspace, even if the HandleAdornment.AlwaysOnTop property for the adornment is true.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

Settings