Documentation

Resource Description

How the lockpicking minigame, picks, and wear work.

#The Lock

Each attempt opens a fitted 3D lock with 3 to 9 pins, each with its own housing, cylinder, pins, and springs. The resource that starts the attempt chooses the pin count. The binding order is random for every attempt.

A tension dial sits below the lock. Pins only bind and set inside its brass working band. Above the band, the pick strains and wears.

#Close-Up Camera

The close-up anchors on the target the calling resource gives, such as a car door handle, and checks that the camera has a clear view of the lock. Without an anchor, or when the target has no room, the lock floats in front of the player. The camera can ease in from the gameplay camera and back out.

A details panel with controls, technique tips, and wear stages opens with H during an attempt. The attempt pauses while it is open.

#Picks & Wear

Each pick keeps its own durability. The pick model in the minigame shows its wear, from gouged and bent to snapped. The wear is saved to the item each time the pick reaches a new wear stage, and again when the attempt ends. Inventory icons change with the wear stage.

Every attempt also needs a tension wrench. It has no durability and is never consumed.

An optional lockpick kit unpacks into picks and a tension wrench.

#Server Validation

The server reserves one exact pick for each attempt and validates the result. A win faster than the fastest possible solve for that lock is treated as cancelled. Other resources check the validated result on the server before they unlock anything.

#Integration

Exports start and cancel an attempt, offer locks to picks used from the inventory, prepare an exact pick slot, and read the validated result. Server hooks and events report started and finished attempts, and a client event reports pin progress.

#Practice Mode

With debug enabled, /lockpicktest opens a local practice lock that never touches inventory items.

#Languages

The resource ships with 17 languages, shown in each player's chosen language through zyke_lib.