Hotkey

This type represents a hotkey control.

This type inherits Control type. All of its base methods and fields are also available in this type.

__call

Constructor

Constructs the hotkey.

This control is best used for temporary hotkeys, as it doesn't save with configurations. You may override this behavior using other controls.

Arguments

Name	Type	Description
id	ControlID|string	ID.
defaultKey	number?	Default hotkey value, virtual key code. Defaults to 0 .

Returns

Type	Description
Hotkey	Hotkey instance.

Example

local hotkey = gui.Hotkey('my_hotkey');

---

Get

Method

Returns the assigned hotkey.

Arguments

None.

Returns

Type	Description
number	Value.

Example

local key = hotkey:Get()