Keybind

Represents a key binding for your script
Instances are obtained using the KeybindAPI's create() function

Keybind.getName

Gets the name of the keybind, which you set when you created the keybind
overload 1:
Keybind:getName()
Method Property Fluent Description Representation
Return Value a String

Keybind.getKey

Gets the current key for this keybind
overload 1:
Keybind:getKey()
Method Property Fluent Description Representation
Return Value a String

Keybind.isDefault

Checks whether this key is currently set to its default state (not been changed using the keybind menu)
overload 1:
Keybind:isDefault()
Method Property Fluent Description Representation
Return Value a Boolean

Keybind.setKey

Sets the key for this keybind
overload 1:
Keybind:setKey(key)
Method Property Fluent Description Representation
key accepts a String
Return Value nil

Keybind.isPressed

Gets whether this keybind is currently pressed down
overload 1:
Keybind:isPressed()
Method Property Fluent Description Representation
Return Value a Boolean

Keybind.getKeyName

Gets the name of the current key for this keybind
overload 1:
Keybind:getKeyName()
Method Property Fluent Description Representation
Return Value a String

Keybind.onPress

figura.docs.keybind.on_press
field signature:
onPress
typings.-2047067631
Method Property Fluent Description Representation
Field Type

Keybind.onRelease

figura.docs.keybind.on_release
field signature:
onRelease
typings.-2047067631
Method Property Fluent Description Representation
Field Type

Keybind.enabled

figura.docs.keybind.enabled
field signature:
enabled
Method Property Fluent Description Representation
Field Type a Boolean

Keybind.gui

figura.docs.keybind.gui
field signature:
gui
Method Property Fluent Description Representation
Field Type a Boolean
a a