Server

The ak47_lib automatically detects the running framework. You can access these functions by importing the lib export in your script.

local Lib47 = exports['ak47_lib']:GetLibObject()

Core Player & Identity

These functions handle identifying players and retrieving their basic information across all frameworks.

Lib47.GetPlayer

Retrieves the raw framework-specific player object (e.g., xPlayer for ESX, Player for QBCore).

--- @param source number The player's server ID
--- @return table|nil The player object
local player = Lib47.GetPlayer(source)

Lib47.GetIdentifier

Returns the unique identifier for the player (CitizenID for QBCore/QBX, Identifier for ESX).

--- @param source number The player's server ID
--- @return string The unique identifier
local identifier = Lib47.GetIdentifier(source)

Lib47.GetName

Returns the player's full character name.

--- @param source number The player's server ID
--- @return string The full name (Firstname Lastname)
local name = Lib47.GetName(source)

Lib47.GetPhoneNumber

Returns the player's phone number.

--- @param source number The player's server ID
--- @return string The phone number
local phone = Lib47.GetPhoneNumber(source)

Lib47.GetLicense

Returns the Rockstar license of the player.

--- @param source number The player's server ID
--- @return string The license
local license = Lib47.GetLicense(source)

Lib47.GetSourceFromIdentifier

Finds a player's server ID based on their identifier.

--- @param identifier string The unique identifier
--- @return number|nil The source ID (or nil if offline)
local source = Lib47.GetSourceFromIdentifier(identifier)

Lib47.GetPlayerMetaValue / Lib47.SetPlayerMetaValue

Gets or sets metadata for a player. (Bridges QBCore metadata and ESX xPlayer.getMeta/setMeta).

-- Get
local val = Lib47.GetPlayerMetaValue(source, 'hunger')

-- Set
Lib47.SetPlayerMetaValue(source, 'hunger', 100)

---

Jobs, Gangs & Permissions

Lib47.GetJob

Returns a standardized job table.

--- @param source number
--- @return table { name, label, payment, isboss, grade = { name, level } }
local job = Lib47.GetJob(source)
print(job.name, job.grade.level)

Lib47.SetJob

Sets the player's job and grade.

--- @param source number
--- @param jobName string
--- @param grade number
Lib47.SetJob(source, 'police', 2)

Lib47.GetGang

Returns a standardized gang table.

--- @param source number
--- @return table { name, label, isboss, grade = { name, level } }
local gang = Lib47.GetGang(source)

Lib47.SetGang

Sets the player's gang and grade.

--- @param source number
--- @param gangName string
--- @param grade number
Lib47.SetGang(source, 'ballas', 1)

Lib47.IsAdmin

Checks if the player has admin privileges (checks for 'command' ace permission).

--- @param source number
--- @return boolean
if Lib47.IsAdmin(source) then
    print("Player is admin")
end

---

Economy

Lib47.GetMoney

Retrieves the balance of a specific account.

--- @param source number
--- @param account string 'money' (or 'cash'), 'bank', 'black_money'
--- @return number
local cash = Lib47.GetMoney(source, 'cash')

Lib47.AddMoney

Adds money to a specific account.

--- @param source number
--- @param account string
--- @param amount number
Lib47.AddMoney(source, 'bank', 5000)

Lib47.RemoveMoney

Removes money from a specific account.

--- @param source number
--- @param account string
--- @param amount number
Lib47.RemoveMoney(source, 'money', 100)

Lib47.GetSocietyMoney

Gets the money associated with a job/society. Supports esx_addonaccount, qb-management, qb-banking, okokBanking, and Renewed-Banking.

--- @param jobName string
--- @return number
local balance = Lib47.GetSocietyMoney('police')

Lib47.AddSocietyMoney / Lib47.RemoveSocietyMoney

Modifies society funds.

Lib47.AddSocietyMoney('police', 1000)
Lib47.RemoveSocietyMoney('police', 500)

---

Basic Vehicle Management

Lib47.IsVehicleOwner

Checks if a player owns a vehicle with a specific plate.

--- @param source number
--- @param plate string
--- @return boolean
local owned = Lib47.IsVehicleOwner(source, 'ABC 123')

Lib47.GetVehicleOwner

Returns the identifier of the owner of a specific plate.

--- @param plate string
--- @return string|nil Identifier
local owner = Lib47.GetVehicleOwner('ABC 123')

Lib47.GeneratePlate

Generates a unique plate based on a pattern.

--- @param format string (optional) Default: "AAAA 11A"
--- @param prefix string (optional)
--- @return string
local newPlate = Lib47.GeneratePlate("AA111111")

Lib47.GiveVehicle

Inserts a vehicle into the database (owned_vehicles / player_vehicles).

--- @param source number
--- @param model string|number Model name or hash
Lib47.GiveVehicle(source, 'adder')