Client

This page lists all the available client-side events and exports.

Events (General)

Job Menu

  • Open job menu (F6) via event.

  • Event Name: rcore_police:client:openJobMenu

  • Example:

TriggerEvent("rcore_police:client:openJobMenu")

Cuff

  • Cuffs the closest player to the initiator.

  • Event Name: rcore_police:client:Cuff

  • Example:

TriggerEvent("rcore_police:client:Cuff")

Escort

  • Escort the closest player to the initiator.

  • Event Name: rcore_police:client:Escort

  • Example:

TriggerEvent("rcore_police:client:Escort")

Licenses

  • Allows to show Licenses of closest player to the initiator.

  • Event Name: rcore_police:client:Licenses

  • Example:

TriggerEvent("rcore_police:client:Licenses")

InVehicle

  • Allows to put closest player to closest vehicle seat.

  • Event Name: rcore_police:client:InVehicle

  • Example:

TriggerEvent("rcore_police:client:InVehicle")

FromVehicle

  • Allows to get closest player from closest vehicle seat.

  • Event Name: rcore_police:client:FromVehicle

  • Example:

TriggerEvent("rcore_police:client:FromVehicle")

Search

  • Allows to search closest player if supported inventory is running

  • Event Name: rcore_police:client:Search

  • Example:

TriggerEvent("rcore_police:client:Search")

Jail

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

  • Event Name: rcore_police:client:Jail

  • Example:

TriggerEvent("rcore_police:client:Jail")

Emergency

  • Allows to call panic button

  • Event Name: rcore_police:client:Emergency

  • Example:

TriggerEvent("rcore_police:client:Emergency")

Fine

  • Allows to Fine closest player to you

  • Event Name: rcore_police:client:Fine

  • Example:

TriggerEvent("rcore_police:client:Fine")

Impound

  • Allows to Impound closest vehicle to you

  • Event Name: rcore_police:client:Impound

  • Example:

TriggerEvent("rcore_police:client:Impound")

UnlockVehicle

  • Allows to UnlockVehicle closest vehicle to you

  • Event Name: rcore_police:client:UnlockVehicle

  • Example:

TriggerEvent("rcore_police:client:UnlockVehicle")

VehicleInfo

  • Allows to get VehicleInfo of closest vehicle to you

  • Event Name: rcore_police:client:VehicleInfo

  • Example:

TriggerEvent("rcore_police:client:VehicleInfo")

Radar

  • Allows to get in editor mode and place speed camera.

  • Event Name: rcore_police:client:Radar

  • Example:

TriggerEvent("rcore_police:client:Radar")

registerHook

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

rcore_police:tackle:registerHook

  • Type: boolean

  • Default value: false

  • Example:

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)

Exports (States)

IsPlayerCuffed

  • Used for checking if player is cuffed

IsPlayerCuffed

  • Type: boolean

  • Default value: false

Check initiator if cuffed

  • Params:

    • None

  • Returns:

    • boolean: true if player is cuffed, otherwise false.

  • Example:

-- return: boolean
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

  • Params:

    Name
    Type
    Description

    playerId

    number

    ID of player which you want to get state of cuffed

  • Returns:

    • boolean: true if player is cuffed, otherwise false.

  • Example:

-- playerId: number
-- return: boolean
local isCuffed = exports['rcore_police']:IsPlayerCuffed(playerId)

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

IsPlayerEscorted

  • Used for checking if player is escorted

IsPlayerEscorted

  • Type: boolean

  • Default value: false

Check initiator if escorted

  • Params:

    • None

  • Returns:

    • boolean: true if player is escorted, otherwise false.

  • Example:

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

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

Check any player on client

  • Params:

    Name
    Type
    Description

    playerId

    number

    ID of player which you want to get state of escorted

  • Returns:

    • boolean: true if player is escorted, otherwise false.

  • Example:


-- playerId: number
-- return: boolean
local isEscorted  = exports['rcore_police']:IsPlayerEscorted(playerId)

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

IsPlayerHeadBagged

IsPlayerHeadBagged

  • Type: boolean

  • Default value: false

Check initiator if IsPlayerHeadBagged

  • Params:

    • None

  • Returns:

    • boolean: true if player is IsPlayerHeadBagged, otherwise false.

  • Example:

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

if isHeadBagged then
    print('Player is IsPlayerHeadBagged')
else
    print('Player is not IsPlayerHeadBagged')
end

Check any player on client

  • Params:

    Name
    Type
    Description

    playerId

    number

    ID of player which you want to get state of IsPlayerHeadBagged

  • Returns:

    • boolean: true if player is IsPlayerHeadBagged, otherwise false.

  • Example:


-- playerId: number
-- return: boolean
local isHeadBagged = exports['rcore_police']:IsPlayerHeadBagged(playerId)

if isHeadBagged then
    print('Player is IsPlayerHeadBagged')
else
    print('Player is not IsPlayerHeadBagged')
end

Exports (General)

GetPoliceOnline

  • Used for getting all police officers online

GetPoliceOnline

  • Type: number

  • Default value:: 0

  • Returns:

    • number: Number of officers online, by default returns 0 when not any online

  • Example:

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

if policeOnline then
    print('Online units: ', retval)
end

Wheel Clamp

PlaceWheelClamp

  • Function for placing wheel clamp on closest vehicle wheel bone.

PlaceWheelClamp

  • Type: void

  • Returns: nothing

  • Example:

exports["rcore_police"]:PlaceWheelClamp()

RemoveWheelClamp

  • Function for removing wheel clamp from closest vehicle wheel bone.

RemoveWheelClamp

  • Type: void

  • Returns: nothing

  • Example:

exports["rcore_police"]:RemoveWheelClamp()

DoesVehicleHaveWheelClamp

  • Function for checking if a vehicle has a wheel clamp.

  • By default, it automatically checks the closest vehicle.

  • An entityId can be passed optionally.

  • Useful for disabling interaction with vehicles when clamped.

DoesVehicleHaveWheelClamp

  • Type: (boolean, string)

  • Returns:

    • boolean retval → true if the vehicle has a wheel clamp, false otherwise

    • string statusCode → status/result message

  • Example:

---@return boolean retval     -- true if the vehicle has a wheel clamp, false otherwise
---@return string statusCode  -- status/result message

local vehicleId = yourVehicleId -- Fully optional and not required, it checks closest vehicle near player which initiate the export.
local retval, statusCode = exports["rcore_police"]:DoesVehicleHaveWheelClamp(vehicleId)

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

Last updated

Was this helpful?