UgLib.Keybind

Client Runs in your resource.

UgLib.Keybind.Register(options) -> command
UgLib.Keybind.Remove(name) -> boolean
UgLib.Keybind.SetEnabled(name, enabled)
UgLib.Keybind.IsPressed(name) -> boolean

string

required

1 to 32 letters, digits or underscores.

string

required

Shown in the FiveM key settings.

string

Such as E or F6. Players MAY change it.

UgKeyMapper

default:"Keyboard"

function

boolean

default:"true"

Ignores presses while a ug-lib dialog, context menu, radial or skill check is open.

The mapping is registered in your resource, as +<resource>-<name>, so players find it under your resource.
FiveM cannot unregister a key mapping: Remove disables it for good. Registering the same name again reuses it.

Example

client.lua

UgLib.Keybind.Register({
    name = 'radio',
    label = 'Talk on the radio',
    defaultKey = 'CAPITAL',
    onPressed = function() print('on air') end,
    onReleased = function() print('off air') end,
})

Getting started

UI

Client utilities

Shared utilities

Example

​Example

Example