Version: bleeding-edge 🩸

🕹️ Input

Create custom keybindings and retrieve input information.

🗿Static Class

🎒 Examples

Client/Index.lua
-- Registers the binding_name 'SpawnMenu' with default key 'Q'
-- This will add 'SpawnMenu' to user KeyBinding Settings automatically
Input.Register("SpawnMenu", "Q")

-- Subscribes for Pressing the key
Input.Bind("SpawnMenu", InputEvent.Pressed, function()
	-- Opens the Spawn Menu
end)

-- Subscribes for Releasing the key
Input.Bind("SpawnMenu", InputEvent.Released, function()
	-- Closes the Spawn Menu
end)

Client/Index.lua
-- Subscribes for native Bindings
Input.Bind("MoveForward", InputEvent.Pressed, function(delta)
	-- Pressed MoveForward key (usually W)
end)

-- Subscribes for native Bindings
Input.Bind("MoveBackward", InputEvent.Pressed, function(delta)
	-- Pressed MoveBackward key (usually S)
end)

(Input.GetModifierKeys) Checks if has Shift pressed
local modifier_keys = Input.GetModifierKeys()
local has_shift_pressed = modifier_keys & KeyModifier.LeftShiftDown
-- Outputs "true"

🗿 Static Functions

Returns	Name	Description
	`Bind`	Binds a function to an Input defined using `Register` or from the game
table	`GetGameKeyBindings`	Returns a table with all Game KeyBindings
KeyboardLayout	`GetKeyboardLayout`	Gets the keyboard layout of the user
integer	`GetKeyCode`	Gets the key code of a key
string	`GetKeyIcon`	Gets the icon path of a key
table of string	`GetMappedKeys`	Returns the keys bound to a keybinding
KeyModifier	`GetModifierKeys`	Gets the currently pressed modifier keys
CursorType	`GetMouseCursor`	Gets the current Mouse Cursor type
table	`GetScriptingKeyBindings`	Returns a table with all Scripting KeyBindings
	`InputKey`	Forces an Input Key event on Local Player
boolean	`IsBindingDown`	Returns if a Key Binding is being pressed
boolean	`IsInputEnabled`	Gets if the game input is enabled
boolean	`IsKeyDown`	Returns if a key is being pressed
boolean	`IsMouseEnabled`	Gets if the mouse cursor is enabled
	`Register`	Registers a keybinding to a default key
	`ResetBindings`	Resets all bound functions by this Package
	`SetInputEnabled`	Toggles Local Player input
	`SetMouseCursor`	Sets the current Mouse Cursor type
	`SetMouseEnabled`	Shows or hides the mouse cursor
function	`Subscribe`	Subscribes to an Event
	`Unbind`	Unbinds an Input function
	`Unregister`	Unregisters a keybinding
	`Unsubscribe`	Unsubscribes from all subscribed Events in this Class and in this Package, optionally passing the function to unsubscribe only that callback

Optimal

`Bind`

Binds a function to an Input defined using Register or from the game

Input.Bind(binding_name, input_event, callback)

Parameters

Type	Parameter	Default	Description
string	`binding_name`	Required parameter	The keybinding id
InputEvent	`input_event`	Required parameter	Which event to register (Released/Pressed)
function	`callback`	Required parameter	The function to trigger with this format

Moderate

`GetGameKeyBindings`

Returns a table with all Game KeyBindings

local ret = Input.GetGameKeyBindings()

Returns

Type	Description
table	Table with all Game KeyBindings with this format

Optimal

`GetKeyboardLayout`

Gets the keyboard layout of the user

local ret = Input.GetKeyboardLayout()

Returns

Type	Description
KeyboardLayout	Keyboard layout of the user

Optimal

`GetKeyCode`

Gets the key code of a key

local ret = Input.GetKeyCode(key_name)

Parameters

Type	Parameter	Default	Description
string	`key_name`	Required parameter	The key name, e.g. `E` or `LeftMouseButton`

Returns

Type	Description
integer	Key code of a key

Optimal

`GetKeyIcon`

Gets the icon path of a key

local ret = Input.GetKeyIcon(key_name, dark_mode?)

Parameters

Type	Parameter	Default	Description
string	`key_name`	Required parameter	The key name, e.g. `E` or `LeftMouseButton`
boolean	`dark_mode?`	`false`	Whether to return the dark version of the icon

Returns

Type	Description
string	Icon path of a key

Moderate

`GetMappedKeys`

Returns the keys bound to a keybinding

local ret = Input.GetMappedKeys(binding_name)

Parameters

Type	Parameter	Default	Description
string	`binding_name`	Required parameter	The keybinding id

Returns

Type	Description
table of string	list of all keys

Optimal

`GetModifierKeys`

Gets the currently pressed modifier keys

local ret = Input.GetModifierKeys()

Returns

Type	Description
KeyModifier	Currently pressed modifier keys

Input.GetModifierKeys Examples

Checks if has Shift pressed
local modifier_keys = Input.GetModifierKeys()
local has_shift_pressed = modifier_keys & KeyModifier.LeftShiftDown
-- Outputs "true"

Optimal

`GetMouseCursor`

Gets the current Mouse Cursor type

local ret = Input.GetMouseCursor()

Returns

Type	Description
CursorType	the current Cursor type

`GetScriptingKeyBindings`

Returns a table with all Scripting KeyBindings

local ret = Input.GetScriptingKeyBindings()

Returns

Type	Description
table	Table with all Scripting KeyBindings with this format

Moderate

`InputKey`

Forces an Input Key event on Local Player

This won't trigger any Scripting event as it bypass internal validations

Input.InputKey(key_name, input_event, amount_depressed?)

Parameters

Type	Parameter	Default	Description
string	`key_name`	Required parameter	Key Name to input
InputEvent	`input_event`	Required parameter	Which Event to input
float	`amount_depressed?`	`1`	The amount pressed

Optimal

`IsBindingDown`

Returns if a Key Binding is being pressed.

A Binding can be mapped to more than one Key, any of them being pressed is enough for this to return true.

local ret = Input.IsBindingDown(binding_name)

Parameters

Type	Parameter	Default	Description
string	`binding_name`	Required parameter	The name of the Key Binding

Returns

Type	Description
boolean	if the Key Binding is pressed

Optimal

`IsInputEnabled`

Gets if the game input is enabled

local ret = Input.IsInputEnabled()

Returns

Type	Description
boolean	if the input is visible

`IsKeyDown`

Returns if a key is being pressed

local ret = Input.IsKeyDown(key_name)

Parameters

Type	Parameter	Default	Description
string	`key_name`	Required parameter	The key name, e.g. `E` or `LeftMouseButton`

Returns

Type	Description
boolean	if the key is pressed

Optimal

`IsMouseEnabled`

Gets if the mouse cursor is enabled

local ret = Input.IsMouseEnabled()

Returns

Type	Description
boolean	if the mouse is visible

`Register`

Registers a keybinding to a default key

Input.Register(binding_name, key_name, description)

Parameters

Type	Parameter	Default	Description
string	`binding_name`	Required parameter	The keybinding id
string	`key_name`	Required parameter	The Key to use by default if this wasn't set before
string or nil	`description`	Required parameter	Text to show on Key Bindings Settings

Optimal

`ResetBindings`

Resets all bound functions by this Package

Input.ResetBindings()

Optimal

`SetInputEnabled`

Toggles Local Player input

Input.SetInputEnabled(enable_input)

Parameters

Type	Parameter	Default	Description
boolean	`enable_input`	Required parameter	Whether to enable Local Player input

`SetMouseCursor`

Sets the current Mouse Cursor type

Input.SetMouseCursor(cursor_type)

Parameters

Type	Parameter	Default	Description
CursorType	`cursor_type`	Required parameter	The new current Mouse Cursor type

`SetMouseEnabled`

Shows or hides the mouse cursor

Input.SetMouseEnabled(is_enabled)

Parameters

Type	Parameter	Default	Description
boolean	`is_enabled`	Required parameter	Whether the mouse cursor is enabled

`Subscribe`

Subscribes to an Event

local ret = Input.Subscribe(event_name, callback)

Parameters

Type	Parameter	Default	Description
string	`event_name`	Required parameter	Event to subscribe to
function	`callback`	Required parameter	Callback to run on the event occurring

Returns

Type	Description
function	The function callback

Optimal

`Unbind`

Unbinds all Input functions related to the given binding_name and input_event

Input.Unbind(binding_name, input_event, callback?)

Parameters

Type	Parameter	Default	Description
string	`binding_name`	Required parameter	The keybinding id
InputEvent	`input_event`	Required parameter	Which event to register (Released/Pressed)
function	`callback?`	`nil`	The specific function to unbind

Optimal

`Unregister`

Unregisters a keybinding

Input.Unregister(binding_name)

Parameters

Type	Parameter	Default	Description
string	`binding_name`	Required parameter	The keybinding id

Optimal

`Unsubscribe`

Unsubscribes from all subscribed Events in this Class and in this Package, optionally passing the function to unsubscribe only that callback

Input.Unsubscribe(event_name, callback?)

Parameters

Type	Parameter	Default	Description
string	`event_name`	Required parameter	Event to unsubscribe to
function	`callback?`	`nil`	Optional callback to specifically unsubscribe to

🚀 Events

	Name	Description
	`KeyBindingChange`	A key binding has been changed through the settings
	`KeyDown`	A keyboard key is being pressed
	`KeyPress`	A keyboard key has been pressed
	`KeyUp`	A keyboard key has been released
	`MouseDown`	A mouse button has been pressed / is being pressed
	`MouseEnable`	When mouse cursor is displayed/hidden
	`MouseMove`	Called when the mouse moves
	`MouseScroll`	Called when the mouse scrolls
	`MouseUp`	A mouse button has been released

`KeyBindingChange`

A key binding has been changed through the settings

Input.Subscribe("KeyBindingChange", function(binding_name, key, scale)
	-- KeyBindingChange was called
end)

Arguments

Type	Argument	Description
string	`binding_name`	The keybinding id
string	`key`	The new key associated
float	`scale`	The scale input (usually 1 or -1)

`KeyDown`

A keyboard key is being pressed

Return false to block it

Input.Subscribe("KeyDown", function(key_name, delta)
	-- KeyDown was called
	return true
end)

Arguments

Type	Argument	Description
string	`key_name`	The key pressed
float or nil	`delta`	The amount depressed in case of this is an Axis input

`KeyPress`

A keyboard key has been pressed

Return false to block it

Input.Subscribe("KeyPress", function(key_name, delta)
	-- KeyPress was called
	return true
end)

Arguments

Type	Argument	Description
string	`key_name`	The key pressed
float or nil	`delta`	The amount depressed in case of this is an Axis input

`KeyUp`

A keyboard key has been released

Return false to block it

Input.Subscribe("KeyUp", function(key_name, delta)
	-- KeyUp was called
	return true
end)

Arguments

Type	Argument	Description
string	`key_name`	The key pressed
float or nil	`delta`	The amount depressed in case of this is an Axis input

`MouseDown`

A mouse button has been pressed / is being pressed

Return false to block it

Input.Subscribe("MouseDown", function(key_name, mouse_x, mouse_y)
	-- MouseDown was called
	return true
end)

Arguments

Type	Argument	Description
string	`key_name`	The key name, e.g. `E` or `LeftMouseButton`
float	`mouse_x`	Mouse X position on screen, in pixels
float	`mouse_y`	Mouse Y position on screen, in pixels

`MouseEnable`

When mouse cursor is displayed/hidden

Input.Subscribe("MouseEnable", function(is_enabled)
	-- MouseEnable was called
end)

Arguments

Type	Argument	Description
boolean	`is_enabled`	Whether the cursor is now displayed

`MouseMove`

Called when the mouse moves

Return false to block it

Input.Subscribe("MouseMove", function(cursor_delta_x, cursor_delta_y, mouse_x, mouse_y)
	-- MouseMove was called
	return true
end)

Arguments

Type	Argument	Description
float	`cursor_delta_x`	Horizontal movement since the last event
float	`cursor_delta_y`	Vertical movement since the last event
float	`mouse_x`	Mouse X position on screen, in pixels
float	`mouse_y`	Mouse Y position on screen, in pixels

`MouseScroll`

Called when the mouse scrolls

Return false to block it

Input.Subscribe("MouseScroll", function(mouse_x, mouse_y, delta)
	-- MouseScroll was called
	return true
end)

Arguments

Type	Argument	Description
float	`mouse_x`	Mouse X position on screen, in pixels
float	`mouse_y`	Mouse Y position on screen, in pixels
float	`delta`	Scroll amount, positive when scrolling up and negative when scrolling down

`MouseUp`

A mouse button has been released

Return false to block it

Input.Subscribe("MouseUp", function(key_name, mouse_x, mouse_y)
	-- MouseUp was called
	return true
end)

Arguments

Type	Argument	Description
string	`key_name`	The key name, e.g. `E` or `LeftMouseButton`
float	`mouse_x`	Mouse X position on screen, in pixels
float	`mouse_y`	Mouse Y position on screen, in pixels

⌨️ Key Names

List of all keys names returned in Key/Mouse events.

▶️ Function Keys

Key Name	Description
`F1`	Function One
`F2`	Function Two
`F3`	Function Three
`F4`	Function Four
`F5`	Function Five
`F6`	Function Six
`F7`	Function Seven
`F8`	Function Eight
`F9`	Function Nine
`F10`	Function Ten
`F11`	Function Eleven
`F12`	Function Twelve

▶️ Alphanumerical keys

Key Name	Description
`A`	Letter A
`B`	Letter B
`C`	Letter C
`D`	Letter D
`E`	Letter E
`F`	Letter F
`G`	Letter G
`H`	Letter H
`I`	Letter I
`J`	Letter J
`K`	Letter K
`L`	Letter L
`M`	Letter M
`N`	Letter N
`O`	Letter O
`P`	Letter P
`Q`	Letter Q
`R`	Letter R
`S`	Letter S
`T`	Letter T
`U`	Letter U
`V`	Letter V
`W`	Letter W
`X`	Letter X
`Y`	Letter Y
`Z`	Letter Z

▶️ Special keys

Key Name	Description
`Escape`	Escape
`Tab`	Tab
`Tilde`	~
`ScrollLock`	Scroll Lock
`Pause`	Pause
`BackSpace`	BackSpace
`One`	One
`Two`	Two
`Three`	Three
`Four`	Four
`Five`	Five
`Six`	Six
`Seven`	Seven
`Eight`	Eight
`Nine`	Nine
`Zero`	Zero
`Underscore`	_
`Equals`	=
`Backslash`	\
`LeftBracket`	[
`RightBracket`	]
`Enter`	Enter or Numpad Enter
`CapsLock`	Caps Lock
`Semicolon`	;
`Quote`	'
`LeftShift`	Left Shift
`Comma`	,
`Period`	.
`Slash`	/
`RightShift`	Right Shift
`LeftControl`	Left Control
`LeftAlt`	Left Alt
`SpaceBar`	Space Bar
`RightAlt`	Right Alt
`RightControl`	Right Control
`Left`	Left
`Up`	Up
`Down`	Down
`Right`	Right
`Home`	Home
`End`	End
`Insert`	Insert
`PageUp`	Page Up
`Delete`	Delete
`PageDown`	Page Down
`NumLock`	Num Lock
`Divide`	Numpad /
`Multiply`	Numpad *
`Subtract`	Numpad -
`Add`	Numpad +
`NumPadOne`	Numpad One
`NumPadTwo`	Numpad Two
`NumPadThree`	Numpad Three
`NumPadFour`	Numpad Four
`NumPadFive`	Numpad Five
`NumPadSix`	Numpad Six
`NumPadSeven`	Numpad Seven
`NumPadEight`	Numpad Eight
`NumPadNine`	Numpad Nine
`NumPadZero`	Numpad Zero
`Decimal`	Numpad Decimal

▶️ Mouse

Key Name	Description
`LeftMouseButton`	Left Mouse Button
`RightMouseButton`	Right Mouse Button
`MiddleMouseButton`	Middle Mouse Button
`ThumbMouseButton`	Primary Mouse Thumb Button
`ThumbMouseButton2`	Secondary Mouse Thumb Button
`MouseScrollUp`	Mouse Wheel Scrolling Up
`MouseScrollDown`	Mouse Wheel Scrolling Down
`MouseX`	Mouse Movement on the X Axis
`MouseY`	Mouse Movement on the Y Axis

▶️ AZERTY

Key Name	Description
`Ampersand`	&
`Asterix`	-
`Caret`	^
`Colon`	:
`Dollar`	$
`Exclamation`	!
`LeftParantheses`	(
`RightParantheses`	)
`A_AccentGrave`	À
`C_Cedille`	Ç
`E_AccentAigu`	É
`E_AccentGrave`	È

🎒 Examples​

🗿 Static Functions​

Bind​

Parameters

GetGameKeyBindings​

Returns

GetKeyboardLayout​

Returns

GetKeyCode​

Parameters

Returns

GetKeyIcon​

Parameters

Returns

GetMappedKeys​

Parameters

Returns

GetModifierKeys​

Returns

GetMouseCursor​

Returns

GetScriptingKeyBindings​

Returns

InputKey​

Parameters

IsBindingDown​

Parameters

Returns

IsInputEnabled​

Returns

IsKeyDown​

Parameters

Returns

IsMouseEnabled​

Returns

Register​

Parameters

ResetBindings​

SetInputEnabled​

Parameters

SetMouseCursor​

Parameters

SetMouseEnabled​

Parameters

Subscribe​

Parameters

Returns

Unbind​

Parameters

Unregister​

Parameters

Unsubscribe​

Parameters

🚀 Events​

KeyBindingChange​

Arguments

KeyDown​

Arguments

KeyPress​

Arguments

KeyUp​

Arguments

MouseDown​

Arguments

MouseEnable​

Arguments

MouseMove​

Arguments

MouseScroll​

Arguments

MouseUp​

Arguments

⌨️ Key Names​

▶️ Function Keys​

▶️ Alphanumerical keys​

▶️ Special keys​

▶️ Mouse​

▶️ AZERTY​

🎒 Examples

🗿 Static Functions

`Bind`

`GetGameKeyBindings`

`GetKeyboardLayout`

`GetKeyCode`

`GetKeyIcon`

`GetMappedKeys`

`GetModifierKeys`

`GetMouseCursor`

`GetScriptingKeyBindings`

`InputKey`

`IsBindingDown`

`IsInputEnabled`

`IsKeyDown`

`IsMouseEnabled`

`Register`

`ResetBindings`

`SetInputEnabled`

`SetMouseCursor`

`SetMouseEnabled`

`Subscribe`

`Unbind`

`Unregister`

`Unsubscribe`

🚀 Events

`KeyBindingChange`

`KeyDown`

`KeyPress`

`KeyUp`

`MouseDown`

`MouseEnable`

`MouseMove`

`MouseScroll`

`MouseUp`

⌨️ Key Names

▶️ Function Keys

▶️ Alphanumerical keys

▶️ Special keys

▶️ Mouse

▶️ AZERTY