Skip to content
HELIX is in Early Access Preview. Some features and documentation may be non-functional or out of date.

Input

The Input class provides a way to listen for key events such as presses or releases. You can bind custom functions to specific keys, allowing for flexible input handling.

Tip

  • When using a key to set input mode, the key "released" event will automatically trigger!
  • For example, binding a pressed key to open a WebUI, it's "released" counterpart will trigger when you use SetInputMode(1)

Functions#

BindKey#

Binds a function to event listener type for a specific key.

  • Key: string
  • Callback: function
  • ListenerType (Optional): string = 'Pressed'
Input.BindKey('Tab', function()
    print('Tab Pressed')
end, 'Pressed')

Input.BindKey('Tab', function()
    print('Tab Released')
end, 'Released')