Reference API Roblox

Engine API

Website

Related

Reference API Roblox

CylinderHandleAdornment

A cylinder that can be adorned to a BasePart.

Memory categoryInstances

Member index 4

HistoryMember
553Angle: float
553Height: float
553InnerRadius: float
553Radius: float
inherited from HandleAdornment
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
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): 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()
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

For handles to be interactive, they must be parented to a player's PlayerGui or the CoreGui.

The CylinderHandleAdornment is a cylinder that can be adorned to a BasePart. This adornment can listen to input events and is commonly used to make dragger tools.

History 17

Members 4

Angle

TypeDefault
float360

If Angle is <360, a cylindrical sector (aka a pie-slice) of that angle is rendered instead of a full cylinder. The Angle property can be combined with InnerRadius to render a sector of a hollow cylinder.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

Height

TypeDefault
float1

The height of the cylinder adornment.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

InnerRadius

TypeDefault
float0

If InnerRadius is >0, a hollow cylinder with that inner radius is rendered instead of a full cylinder. The InnerRadius property can be combined with Angle to render a sector of a hollow cylinder.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

Radius

TypeDefault
float1

The radius of the cylinder adornment.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

Settings