Buy Me a Coffee at ko-fi.com

A global API containing a function to create new Keybind instances

Creates a new Keybind based from a vanilla key

overload 1:
KeybindAPI.fromVanilla(id: String): Keybind
typings.-1808118735typings.849613564
Method PropertyFluent DescriptionRepresentation
id accepts
Return Value

Returns a table with all registered keybinds

overload 1:
KeybindAPI.getKeybinds(): Table
typings.80563118
Method PropertyFluent DescriptionRepresentation
Return Value

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:
KeybindAPI.getVanillaKey(id: KeyIDs): String
typings.-2050828263typings.-1808118735
Method PropertyFluent DescriptionRepresentation
id accepts
Return Value

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:
KeybindAPI.newKeybind(name: String): Keybind
typings.-1808118735typings.849613564
Method PropertyFluent DescriptionRepresentation
name accepts
Return Value
overload 2:
KeybindAPI.newKeybind(name: String, key: String): Keybind
typings.-1808118735typings.-1808118735typings.849613564
Method PropertyFluent DescriptionRepresentation
name accepts
key accepts
Return Value
overload 3:
KeybindAPI.newKeybind(name: String, key: String, gui: Boolean): Keybind
typings.-1808118735typings.-1808118735typings.1729365000typings.849613564
Method PropertyFluent DescriptionRepresentation
name accepts
key accepts
gui accepts
Return Value

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:
KeybindAPI.of(name: String): Keybind
typings.-1808118735typings.849613564
Method PropertyFluent DescriptionRepresentation
name accepts
Return Value
overload 2:
KeybindAPI.of(name: String, key: String): Keybind
typings.-1808118735typings.-1808118735typings.849613564
Method PropertyFluent DescriptionRepresentation
name accepts
key accepts
Return Value
overload 3:
KeybindAPI.of(name: String, key: String, gui: Boolean): Keybind
typings.-1808118735typings.-1808118735typings.1729365000typings.849613564
Method PropertyFluent DescriptionRepresentation
name accepts
key accepts
gui accepts
Return Value