keybinds

The global instance of the KeybindAPI and its subtypes
field signature:
keybinds
Method Property Fluent Description Representation
Field Type a KeybindAPI

KeybindAPI.newKeybind

Creates and returns a new Keybind
The name is used in the keybind menu
The key parameter is an identifier for a key,
such as "key.keyboard.r"
The boolean gui indicates whether the keybind should always work,
or if it should only work when you don't have a screen open
Check the docs enum command for all key names
overload 1:
keybinds:newKeybind(name)
Method Property Fluent Description Representation
name accepts a String
Return Value a Keybind
overload 2:
keybinds:newKeybind(name, key)
Method Property Fluent Description Representation
name accepts a String
key accepts a String
Return Value a Keybind
overload 3:
keybinds:newKeybind(name, key, gui)
Method Property Fluent Description Representation
name accepts a String
key accepts a String
gui accepts a Boolean
Return Value a Keybind

KeybindAPI.getKeybinds

Returns a table with all registered keybinds
overload 1:
keybinds:getKeybinds()
Method Property Fluent Description Representation
Return Value a table

KeybindAPI.getVanillaKey

Gets the id of the key bound to the given action, as a string
Check the docs enum command for all key names and vanilla actions
overload 1:
keybinds:getVanillaKey(id)
Method Property Fluent Description Representation
id accepts a KeyIDs
Return Value a String

KeybindAPI.fromVanilla

Creates a new Keybind based from a vanilla key
overload 1:
keybinds:fromVanilla(id)
Method Property Fluent Description Representation
id accepts a String
Return Value a Keybind

KeybindAPI.of

Creates and returns a new Keybind
The name is used in the keybind menu
The key parameter is an identifier for a key,
such as "key.keyboard.r"
The boolean gui indicates whether the keybind should always work,
or if it should only work when you don't have a screen open
Check the docs enum command for all key names
overload 1:
keybinds:of(name)
Method Property Fluent Description Representation
name accepts a String
Return Value a Keybind
overload 2:
keybinds:of(name, key)
Method Property Fluent Description Representation
name accepts a String
key accepts a String
Return Value a Keybind
overload 3:
keybinds:of(name, key, gui)
Method Property Fluent Description Representation
name accepts a String
key accepts a String
gui accepts a Boolean
Return Value a Keybind
a a