Client: Restraints

All exports

This page documents the supported public integration calls. Client values are never authoritative for police permissions, review decisions, evidence, offences, or billing.

Client Exports

Restraints

These exports use the shared sky_jobs_base interaction system. The local player's job must be registered on the server and have the required capability. Police jobs from Config.Jobs are registered automatically; other job resources must use the server-side registerInteractionJobs export first. Calling a client export alone does not whitelist a job.

See the Sky Jobs Base client exports and server whitelist documentation for the preferred shared API.

Police keeps compatibility forwards for cuffs, zipties, and escort. Use the direct Jobs Base exports for leg restraints and head bags.

cuffPlayer(cuffType?)

• Purpose: Applies cuffs or zipties to the nearest valid player as an officer.
• Arguments:
  • cuffType (string?): "cuffs" (default) or "zipties".
• Returns: boolean, string?.

exports["sky_policejob"]:cuffPlayer()

uncuffPlayer()

• Purpose: Removes cuffs from the nearest player as an officer.
• Returns: boolean, string?.

exports["sky_policejob"]:uncuffPlayer()

cutZipties()

• Purpose: Cuts zipties on the nearest player as an officer.
• Returns: boolean, string?.

exports["sky_policejob"]:cutZipties()

useCuffPlayer(cuffType?) / useUncuffPlayer() / useCutZipties()

• Purpose: Compatibility aliases for cuffPlayer, uncuffPlayer, and cutZipties. They use the same server-side job whitelist and do not bypass access or item checks.
• Returns: boolean, string?.

exports["sky_policejob"]:useCuffPlayer("cuffs") -- or "zipties"
exports["sky_policejob"]:useUncuffPlayer()
exports["sky_policejob"]:useCutZipties()

useHandcuffsItem() / useZiptiesItem()

• Purpose: Runs the full handcuffs/zipties item flow (the same path as using the inventory item), including the item checks.
• Returns: boolean.

exports["sky_policejob"]:useHandcuffsItem()
exports["sky_policejob"]:useZiptiesItem()

isPlayerCuffed(serverId)

• Purpose: Checks the locally known cuff state for a player.
• Returns: boolean.

local cuffed = exports["sky_policejob"]:isPlayerCuffed(serverId)