listFiles
action_wheel
Action
BlockRaycastTypes Represents a key binding for your script
Instances are obtained using the KeybindAPI's create() function 
Toggles if this keybind should be processed or not
overload 1:
Keybind.enabled(bool: Boolean): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | typings.1729365000||
| Return Value | typings.849613564
Returns the numeric ID of this keybind
overload 1:
Keybind.getID(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets the current key for this keybind
overload 1:
Keybind.getKey(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the name of the current key for this keybind
overload 1:
Keybind.getKeyName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the name of the keybind, which you set when you created the keybind
overload 1:
Keybind.getName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Set whenever or not this keybind should run when a GUI screen is open
overload 1:
Keybind.gui(bool: Boolean): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | typings.1729365000||
| Return Value | typings.849613564
Checks whether this key is currently set to its default state (not been changed using the keybind menu)
overload 1:
Keybind.isDefault(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns if this keybind is enabled or not
overload 1:
Keybind.isEnabled(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns if this keybind should work when a GUI screen (Chat, Inventory, etc) is open or not
overload 1:
Keybind.isGuiEnabled(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets whether this keybind is currently pressed down
overload 1:
Keybind.isPressed(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Sets the key for this keybind
overload 1:
Keybind.key(key: String): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| key accepts | typings.-1808118735||
| Return Value | typings.849613564
Sets the function that is executed when this key is pressed
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
overload 1:
Keybind.onPress(function: Function): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | typings.1445582840||
| Return Value | typings.849613564
Sets the function that is executed when this key is released
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
overload 1:
Keybind.onRelease(function: Function): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | typings.1445582840||
| Return Value | typings.849613564
Toggles if this keybind should be processed or not
overload 1:
Keybind.setEnabled(bool: Boolean): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | typings.1729365000||
| Return Value | typings.849613564
Set whenever or not this keybind should run when a GUI screen is open
overload 1:
Keybind.setGUI(bool: Boolean): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | typings.1729365000||
| Return Value | typings.849613564
Sets the key for this keybind
overload 1:
Keybind.setKey(key: String): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| key accepts | typings.-1808118735||
| Return Value | typings.849613564
Sets the function that is executed when this key is pressed
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
overload 1:
Keybind.setOnPress(function: Function): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | typings.1445582840||
| Return Value | typings.849613564
Sets the function that is executed when this key is released
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
overload 1:
Keybind.setOnRelease(function: Function): Keybind | Method Property | Fluent Description | Representation |
|---|---|---|
| function accepts | typings.1445582840||
| Return Value | typings.849613564
A function that runs when the key is pressed down
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
If the return value is true then all vanilla keybinds using same key will be ignored
field signature:
Keybind.press: Function | Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | typings.1445582840
A function that runs when the key is released
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself
If the return value is true then all vanilla keybinds using same key will be ignored
field signature:
Keybind.release: Function | Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | typings.1445582840