en-doorlock

en-doorlock locks map doors, single or double, and the server decides who gets through. A locked door opens for players who meet its rules: a job or player group at or above a grade, or carrying any one of a set of items, such as a keycard.

A door can also have a passcode keypad with a cooldown after wrong guesses, a lockpick difficulty (or be unpickable), and an automatic relock timer. Near a door, players see a padlock icon and an E prompt to lock or unlock it.

Admins build doors in game with /doorlock. Aim at a door and press E (press again on the second half of a double door), then Enter, and fill in the settings dialog.

#At a glance

#How it works

#Access rules

When you press E on a locked door, the server checks, in order:

1. If Config.adminBypass is on and you have the command.doorlock ACE, the door opens.
2. Each entry in the door's groups: a job name with a minimum grade, group:<id> for a specific player group at a minimum grade, or the bare key group for membership of any player group at that grade.
3. Each item in items: carrying any one of them is enough.

If none match and the door has a passcode, you're asked for it. A wrong code locks you out for Config.passcodeCooldown seconds.

#Lockpicking

Lockpicking uses encore.minigame.lockpick with your lockpick skill bonus from en-skills. A success always unlocks the door and never locks it. The server requires at least 1.5 s and that you are close to the door. A failure uses up the pick with probability loseOnFail. Picking a door awards thievery XP.

#Door sources

Doors come from three places:

Door state is broadcast to clients by net events and applied with DoorSystemSetDoorState. Door system hashes are joaat('en-doorlock:<id>:<index>').

#Configuration

#Door fields

These fields apply to config doors, editor doors and the AddDoor export.

#Adding a config door

Config.doors = {
    {
        name = 'Checkpoint armoury',
        doors = { { model = `v_ilev_rc_door2`, coords = vec3(-252.1, -310.4, 21.6) } },
        locked = true,
        distance = 2.0,
        autolock = 30,
        groups = { ['group:12'] = 1 },
        items = { 'keycard_armoury' },
        passcode = '4471',
        lockpick = 'hard',
    },
}

#Exports

#Server

Public door data never includes the passcode or the access rules.

#Client

#Commands

#Events

how is one of key, passcode, lockpick, auto or script. A player toggling a door they're authorised for, by group or item, reports key.

#Database

encore_doors: id (INT auto-increment primary key), data (LONGTEXT JSON of the door fields). Lock state is written back on every change, so editor doors keep it across restarts.

#Examples

Add a door from another resource and open it when a heist step completes:

-- server
local doorId = exports['en-doorlock']:AddDoor('myheist:vault', {
    name = 'Bunker vault',
    doors = { { model = `v_ilev_bk_vaultdoor`, coords = vec3(255.2, 223.9, 102.4) } },
    locked = true,
    lockpick = false,
    items = { 'vault_keycard' },
})

AddEventHandler('myheist:server:hackComplete', function()
    exports['en-doorlock']:SetDoorLocked(doorId, false)
end)

Log every forced entry:

AddEventHandler('en-doorlock:server:stateChanged', function(source, doorId, locked, how)
    if how == 'lockpick' then
        local door = exports['en-doorlock']:GetDoor(doorId)
        print(('%s picked %s'):format(GetPlayerName(source), door and door.name or doorId))
    end
end)

#Related

• Groups
• Jobs
• en-minigames
• en-skills