mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
167 lines
4.1 KiB
YAML
167 lines
4.1 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: Handles
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
Places 3D handles around any object that its `Class.Handles.Adornee|Adornee`
|
|
is set to.
|
|
description: |
|
|
The `Handles` object places 3D handles around any object that its
|
|
`Class.Handles.Adornee|Adornee` is set to; this property must be set to a 3D
|
|
object for the handles to appear. The color can be changed and the shape of
|
|
the handles can be set to either arrows or spheres.
|
|
|
|
For handles to be interactive, they must be parented to a player's
|
|
`Class.PlayerGui` or the `Class.CoreGui`.
|
|
code_samples: []
|
|
inherits:
|
|
- HandlesBase
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: Handles.Faces
|
|
summary: |
|
|
Sets which sides the GUI handles will appear.
|
|
description: |
|
|
Sets which sides the GUI handles will appear.
|
|
code_samples: []
|
|
type: Faces
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Basic
|
|
- UI
|
|
- Input
|
|
- name: Handles.Style
|
|
summary: |
|
|
Sets the GUI style of the handles.
|
|
description: |
|
|
Sets the GUI style of the handles. Currently there are only two types:
|
|
`Enum.HandlesStyle|Resize` and `Enum.HandlesStyle|Movement`.
|
|
code_samples: []
|
|
type: HandlesStyle
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Appearance
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Basic
|
|
- UI
|
|
- Input
|
|
methods: []
|
|
events:
|
|
- name: Handles.MouseButton1Down
|
|
summary: |
|
|
Fired when the left mouse button goes down on one of the GUI handles.
|
|
description: |
|
|
Fired when the left mouse button goes down on one of the GUI handles.
|
|
code_samples: []
|
|
parameters:
|
|
- name: face
|
|
type: NormalId
|
|
default:
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
capabilities:
|
|
- Basic
|
|
- UI
|
|
- Input
|
|
- name: Handles.MouseButton1Up
|
|
summary: |
|
|
Fired when the left mouse button is released on one of the GUI handles.
|
|
description: |
|
|
Fired when the left mouse button is released on one of the GUI handles.
|
|
code_samples: []
|
|
parameters:
|
|
- name: face
|
|
type: NormalId
|
|
default:
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
capabilities:
|
|
- Basic
|
|
- UI
|
|
- Input
|
|
- name: Handles.MouseDrag
|
|
summary: |
|
|
Fired when the mouse moves while the MouseButton1Down event has fired, but
|
|
the left mouse button has not been released yet.
|
|
description: |
|
|
Fired when the mouse moves while the MouseButton1Down event has fired, but
|
|
the left mouse button has not been released yet.
|
|
code_samples: []
|
|
parameters:
|
|
- name: face
|
|
type: NormalId
|
|
default:
|
|
summary: ''
|
|
- name: distance
|
|
type: float
|
|
default:
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
capabilities:
|
|
- Basic
|
|
- UI
|
|
- Input
|
|
- name: Handles.MouseEnter
|
|
summary: |
|
|
Fired when a mouse "enters" the GUI handle.
|
|
description: |
|
|
Fired when a mouse "enters" the GUI handle.
|
|
code_samples: []
|
|
parameters:
|
|
- name: face
|
|
type: NormalId
|
|
default:
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
capabilities:
|
|
- Basic
|
|
- UI
|
|
- Input
|
|
- name: Handles.MouseLeave
|
|
summary: |
|
|
Fired when the mouse leaves the GUI handle.
|
|
description: |
|
|
Fired when the mouse leaves the GUI handle.
|
|
code_samples: []
|
|
parameters:
|
|
- name: face
|
|
type: NormalId
|
|
default:
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
capabilities:
|
|
- Basic
|
|
- UI
|
|
- Input
|
|
callbacks: []
|