We use cookies on this site to enhance your user experience
Collapse Sidebar

ConeHandleAdornment

Deprecated

ConeHandleAdornment

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

A ConeHandleAdornment is a cone that can be adorned to a BasePart. This adornment can listen to input events and is commonly used to make dragger tools.

Properties

float

Height

The height of the cone adornment.

float

Radius

The radius of the cone adornment.

Inherited from HandleAdornment: Show Hide

int

ZIndex

The ZIndex property determines the draw order of the HandleAdornment.
Vector3

SizeRelativeOffset

The positional offset of the adornment based on the adornee’s `BasePart/Size`.
CFrame

CFrame

The position and rotation of the object relative to its `PVAdornment/Adornee`.
bool

AlwaysOnTop

Forces this object to render on top of all 3d objects in the Workspace.

Inherited from PVAdornment: Show Hide

PVInstance

Adornee

The PVInstance the PVAdornment is attached to.

Inherited from GuiBase3d: Show Hide

bool

Visible

Determines whether the object and its descendants will be displayed.
float

Transparency

Sets the transparency of a GUI object, where 1 is invisible and 0 is completely visible.
Color3

Color3

Sets the color of a GUI object.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
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.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from HandleAdornment: Show Hide

RBXScriptSignal

MouseLeave ( )

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

MouseEnter ( )

Fires when a user moves their mouse over the adornment.
RBXScriptSignal

MouseButton1Up ( )

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

MouseButton1Down ( )

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

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.