Documentation

Keybind - Open Dev Kit Documentation

Open Dev Kit Documentation :: Game :: Keybind

Game.Keybind
Keybinding configuration for handling input events

Functions

Find Input ( Input Input ) Integer
Finds the specified input in the keybind
Is Held ( Player Integer ) Boolean
Returns whether the keybind is currently being held down factoring in dead-zone.
Get Value ( Player Integer ) Float
Returns the keybind's value mulitplied by their input factor.

Properties

Owner Resource Object Resource*
resource that created this instance
Player Values Float Array
last value of the input for each player
Player Presses Boolean Array
last pressed state of the input for each player
Inputs Input Array
inputs associated with this keybind
Press Held on Enable Boolean
presses held buttons when enabled
Release Held on Disable Boolean
release held buttons when disabled
Merge Inputs Boolean
whether all keybind's inputs for the same player should share a value, trigger events together, and be indistinguishable

Events

Pressed ( Input Input, Device Integer, Player Integer, Value Float, Delta Float )
Triggers when the keybind is pressed
Held ( Input Input, Device Integer, Player Integer, Value Float, Delta Float )
Triggers while the keybind is held
Released ( Input Input, Device Integer, Player Integer, Value Float, Delta Float )
Triggers when the keybind is released

If you think anything is missing, please feel free to: submit documentation feedback on this page