Client

Client-side events and exports exposed by rcore_police. Call them from other resources running in the same client.

🚔 Actions

Job Menu

Open job menu (F6) via event.

TriggerEvent("rcore_police:client:api:openJobMenu")

Cuff

Cuffs the closest player to the initiator.

TriggerEvent("rcore_police:client:api:Cuff")

Escort

Escort the closest player to the initiator.

TriggerEvent("rcore_police:client:api:Escort")

Licenses

Allows to show Licenses of closest player to the initiator.

TriggerEvent("rcore_police:client:api:Licenses")

InVehicle

Allows to put closest player to closest vehicle seat.

TriggerEvent("rcore_police:client:api:InVehicle")

FromVehicle

Allows to get closest player from closest vehicle seat.

TriggerEvent("rcore_police:client:api:FromVehicle")

Search

Allows to search closest player if supported inventory is running.

TriggerEvent("rcore_police:client:api:Search")

Jail

Allows to open Jail dialog for closest player if supported jail is running.

TriggerEvent("rcore_police:client:api:Jail")

Emergency

Allows to call panic button.

TriggerEvent("rcore_police:client:api:Emergency")

Fine

Allows to Fine closest player to you.

TriggerEvent("rcore_police:client:api:Fine")

Impound

Allows to Impound closest vehicle to you.

TriggerEvent("rcore_police:client:api:Impound")

UnlockVehicle

Allows to unlock closest vehicle to you.

TriggerEvent("rcore_police:client:api:UnlockVehicle")

VehicleInfo

Allows to get VehicleInfo of closest vehicle to you.

TriggerEvent("rcore_police:client:api:VehicleInfo")

Radar

Allows to get in editor mode and place speed camera.

TriggerEvent("rcore_police:client:api:Radar")

🪝 Hooks

rcore_police:tackle:registerHook

Registers a custom hook to define logic that affects tackling behavior in the rcore_police system.

---@param hookName string
---@param callback fun(ctx: table, callback: fun(allow: boolean))

local function PreventTackleInWater(ctx, callback)
    -- Example condition: could check if the initiator is swimming
    callback(true) -- allow tackle
end

TriggerEvent("rcore_police:tackle:registerHook", "PreventInWater", PreventTackleInWater)

🔍 Player State

IsPlayerCuffed

Checks if a player is cuffed. Call without a playerId to check the initiator.

---@param playerId? number - ID of player to check, defaults to the initiator
---@return boolean isCuffed

local isCuffed = exports['rcore_police']:IsPlayerCuffed()

if isCuffed then
    print('Player is cuffed')
else
    print('Player is not cuffed or an error occurred:', statusOrErr)
end

Check any player on client:

---@param playerId number - ID of player which you want to get state of cuffed
---@return boolean isCuffed

local isCuffed = exports['rcore_police']:IsPlayerCuffed(playerId)

IsPlayerEscorted

Checks if a player is escorted. Call without a playerId to check the initiator.

---@param playerId? number - ID of player to check, defaults to the initiator
---@return boolean isEscorted

local isEscorted = exports['rcore_police']:IsPlayerEscorted()

if isEscorted then
    print('Player is escorted')
else
    print('Player is not escorted')
end

IsPlayerHeadBagged

Checks if a player has a paper bag on their head. Call without a playerId to check the initiator.

---@param playerId? number - ID of player to check, defaults to the initiator
---@return boolean isHeadBagged

local isHeadBagged = exports['rcore_police']:IsPlayerHeadBagged()

IsPlayerDead

Experimental: This export is experimental and is not guaranteed to work. It is used internally by rcore_police and no support is provided for external usage.

---@param playerId? number - if not provided it checks the player which invokes the export (yourself)
---@return boolean retval

local retval = exports["rcore_police"]:IsPlayerDead(targetId)

IsPlayerHandsup

---@param playerId? number - if not provided it checks the player which invokes the export (yourself)
---@return boolean retval

local retval = exports["rcore_police"]:IsPlayerHandsup(targetId)

👮 General

GetPoliceOnline

Returns the number of police officers currently online.

---@return number policeOnline - defaults to 0 when none are online

local policeOnline = exports['rcore_police']:GetPoliceOnline()

OpenInvoiceMenu

---@return boolean retval - whether the menu was opened

local retval = exports["rcore_police"]:OpenInvoiceMenu()

🔧 Wheel Clamp

PlaceWheelClamp

Places a wheel clamp on the closest vehicle wheel bone.

exports["rcore_police"]:PlaceWheelClamp()

RemoveWheelClamp

Removes a wheel clamp from the closest vehicle wheel bone.

exports["rcore_police"]:RemoveWheelClamp()

DoesVehicleHaveWheelClamp

Checks if a vehicle has a wheel clamp. By default checks the closest vehicle; an entityId can be passed optionally. Useful for disabling interaction with vehicles when clamped.

---@param vehicleId? number - fully optional, checks closest vehicle near the player if omitted
---@return boolean retval     -- true if the vehicle has a wheel clamp, false otherwise
---@return string statusCode  -- status/result message

local vehicleId = yourVehicleId
local retval, statusCode = exports["rcore_police"]:DoesVehicleHaveWheelClamp(vehicleId)

if retval then
    print("Vehicle is clamped: " .. statusCode)
else
    print("Vehicle is free: " .. statusCode)
end