Players — RCPlayer

RCPlayer is the server-side player class. It is stored in RP.players[source] and holds all DB-backed player data with live dynamic properties.

Lookup functions

RP.GetPlayerFromSource(src)

Returns the RCPlayer for a connected player, or nil if the player is not loaded.

--- @param src number  Server ID
--- @return RCPlayer?
local p = RP.GetPlayerFromSource(source)
if p then
    print(p.name, p.pid)
end

RP.GetPlayerFromIdentifier(identifier)

Finds an online player by their license identifier string (e.g. "license:abc123").

--- @param identifier string
--- @return RCPlayer?
local p = RP.GetPlayerFromIdentifier("license:abc123")

RP.GetPlayerFromPid(pid)

Finds an online player by their database ID.

--- @param pid number
--- @return RCPlayer?
local p = RP.GetPlayerFromPid(42)

RP.IsIdentifierOnline(identifier)

Returns true, source if the identifier is online, otherwise false.

--- @param identifier string | table  Single identifier or table of identifiers
--- @return boolean online, number? source
local online, src = RP.IsIdentifierOnline("license:abc123")

RP.IsPidOnline(pid)

Returns true, source if a player with that database ID is online.

--- @param pid number
--- @return boolean online, number? source
local online, src = RP.IsPidOnline(42)

Properties

All properties can be read directly from the player object. Dynamic properties are computed on access — they are never stale.

Writing special properties

-- Teleports ped to new coords (vector3 required)
p.coords = vector3(0.0, 0.0, 70.0)
 
-- Writes to DB + syncs to client
p.group = "admin"
 
-- Shorthand for p.metadata.xp = val
p.xp = 500

Accounts — RCAccounts

Accounts are indexed like a table. Reads are backed by the in-memory store; writes persist to the database and sync to the player's client.

local balance = p.accounts["credits"]    -- read
p.accounts["credits"] = balance + 100   -- write → DB + client sync

Iterating accounts

for key, amount in pairs(p.accounts) do
    print(key, amount)
end

Converting to a plain table

local t = p.accounts:toTable()

Metadata — RCMetadata

Same interface as accounts: index-read, index-write, pairs, and :toTable().

local jumps = p.metadata["stunt_jumps"]  -- read
p.metadata["stunt_jumps"] = jumps        -- write → DB + client sync

Methods

p:kick(reason?)

Drops the player from the server.

p:kick("You have been banned.")

p:triggerEvent(eventName, ...)

Fires a client event on this player.

p:triggerEvent("myResource:hello", "world")

p:setCoords(x, y, z, heading?) / p:teleport(...)

Teleports the player's ped. Accepts either individual numbers or a vector3/table.

p:setCoords(100.0, 200.0, 30.0)
p:setCoords(vector3(100.0, 200.0, 30.0), 90.0)
p:teleport(100.0, 200.0, 30.0, 90.0)  -- alias

p:save(cb?)

Persists playtime to the database. The optional callback fires after the query.

p:save(function() print("saved") end)

p:showNotification(msg, delay?)

Triggers rp-notify:notify on the player's client.

p:showNotification("Race starting in 10 seconds!", 5000)

p:hasDoneStuntJump(id)

Returns true if stunt jump id is recorded in metadata.stunt_jumps.

if p:hasDoneStuntJump(3) then ... end

p:getRank()

Returns the player's rank name derived from their XP level.

print(p:getRank())  -- "Drift King"

p:GetDiscordPfp()

Fetches the latest Discord avatar URL from rp-queue and updates the stored value.

local url = p:GetDiscordPfp()

Internal helpers (used by the framework)

These are primarily used by import.lua to forward property accesses through the lightweight proxy it creates for external resources.