Exports

A keypad has two halves:

• Server: you register it with its code, its attempt limit, and what happens when someone gets it right. The code never leaves the server.
• Client: you place the prop and call Keypad when a player uses it. The client only draws the keypad and sends what was typed.

A full example

{% code title="server.lua" %}

lua
exports.dirk_keypad:register('bank_vault', {
  code = '4821',
  maxAttempts = 3,
  lockout = 60,
  coords = vector3(254.1, 225.3, 101.9),
  light = { color = 'amber', leds = { red = 1 } },
  onGranted = function(src)
    -- the vault opens here, on the server
    TriggerClientEvent('mybank:openVault', -1)
  end,
})

{% endcode %}

{% code title="client.lua" %}

lua
-- when the player uses the keypad prop:
CreateThread(function()
  exports.dirk_keypad:Keypad(keypadEntity, { id = 'bank_vault' })
end)

{% endcode %}

---

#Server

#register

Registers a keypad, or replaces one with the same id. A resource's keypads are removed when that resource stops.

lua
exports.dirk_keypad:register(id, options)

A keypad registered with coords gets its prompt automatically: players within 25 m are told about it (only them) and pressing E next to it opens it. A keypad prop your script places itself (with no fixed coords) gets one from the client with KeypadPrompt.

By default attempts count per keypad: three wrong codes from anyone lock it for everyone, and every nearby player sees the red padlock on its screen. With lockScope = 'player', each player has their own attempts and lockout. A player can try at most one code every 0.8 seconds.

#setCode

Changes a keypad's code. Everyone's wrong attempts so far are forgotten.

lua
exports.dirk_keypad:setCode('bank_vault', '7730')

#Colours

Use any { r, g, b }, or one of these names:

The colour shows on the keypad while someone is using it. On the wall, when nobody is using it, the keys show the standard white glow.

#setCoords

Tells the server where a keypad is, when you only know once it's placed. Same as options.coords.

lua
exports.dirk_keypad:setCoords('bank_vault', vector3(254.1, 225.3, 101.9))

#reset

Lifts a lockout. For a lockScope = 'player' keypad, pass a player to lift only theirs.

lua
exports.dirk_keypad:reset('bank_vault')        -- the keypad (everyone)
exports.dirk_keypad:reset('bank_vault', src)   -- one player, on a lockScope = 'player' keypad

#unregister

Removes a keypad.

lua
exports.dirk_keypad:unregister('bank_vault')

#Events

Server events, for scripts that would rather listen than pass onGranted:

lua
AddEventHandler('dirk_keypad:lockedOut', function(src, id)
  if id == 'bank_vault' then
    -- set the alarm off
  end
end)

---

#Client

#Keypad

Puts the player on a keypad. The call waits until the player finishes or steps away, so run it inside a thread.

lua
local code, ok, why = exports.dirk_keypad:Keypad(entity, options?)

Without an id, Keypad just returns what was typed. Only use that when you check the code on your server yourself.

#KeypadPrompt

Puts the "use the keypad" prompt on a keypad prop your script placed itself. Pressing E next to it opens the keypad with its id, so the code is still checked on the server.

lua
local handle = exports.dirk_keypad:KeypadPrompt(entity, {
  id = 'my_lab_door',                                  -- the id you registered on the server
  duiPosition = 'top-right',
  canUse = function() return not doorOpen end,         -- false hides the prompt
})
exports.dirk_keypad:KeypadPromptRemove(handle)

A resource's prompts are removed when it stops. Try it with /lockpad, then /lockpad prompt dui left, /lockpad prompt text or /lockpad prompt target.

#KeypadLight

Sets the key backlight: the colour of the glowing numbers, and the glow they throw on the wall. It sets this player's default and changes the keypad live if one is in use. A keypad registered with its own light uses that instead.

lua
exports.dirk_keypad:KeypadLight(color?, level?)

lua
exports.dirk_keypad:KeypadLight('blue', 1.0)
exports.dirk_keypad:KeypadLight({ 255, 120, 0 })         -- any colour
exports.dirk_keypad:KeypadLight(nil, 0.0)                -- backlight off

#KeypadLeds

Sets the red and green status LEDs above the screen. While ACCESS GRANTED, ACCESS DENIED or LOCKED is showing, the keypad sets the LEDs itself.

lua
exports.dirk_keypad:KeypadLeds(red?, green?)

lua
exports.dirk_keypad:KeypadLeds(0, 1)      -- green on: unlocked
exports.dirk_keypad:KeypadLeds(2, 0)      -- red blinking twice a second: alarm

#KeypadScreen

Sets the screen brightness.

lua
exports.dirk_keypad:KeypadScreen(level)