Client

Library
Updated a month ago · v1.3.7

lib.player.identifier

Get the current character's unique identifier (citizenid)

lua
local id = lib.player.identifier()

lib.player.name

Get the current character's name

lua
local first, last = lib.player.name()

lib.player.getPlayerData

Get the full player data object, or a specific key from it

lua
local data = lib.player.getPlayerData(key)
ParameterTypeRequiredDescription
keystringnoSpecific key to retrieve. Omit for full data object

lib.player.getMetadata

Get player metadata, or a specific metadata key

lua
local meta = lib.player.getMetadata(key)
ParameterTypeRequiredDescription
keystringnoSpecific metadata key. Omit for all metadata

lib.player.getMoney

Get the player's balance for a specific account

lua
local amount = lib.player.getMoney(account)
ParameterTypeRequiredDescription
accountstringyesAccount name (e.g. "cash", "bank")

lib.player.getJob

Get the player's current job data

lua
local job = lib.player.getJob()
-- job.name, job.label, job.grade, job.gradeLabel, job.onDuty

lib.player.getGang

Get the player's current gang data

lua
local gang = lib.player.getGang()

lib.player.editStatus

Modify player status values (hunger, thirst, etc.)

lua
lib.player.editStatus(status)
ParameterTypeRequiredDescription
statustableyesStatus changes to apply

lib.player.getItems

Get all items in the player's inventory

lua
local items = lib.player.getItems()

lib.player.getLicenses

Get all licenses the player holds

lua
local licenses = lib.player.getLicenses()

lib.player.hasLicense

Check if the player has a specific license

lua
local has = lib.player.hasLicense(license)
ParameterTypeRequiredDescription
licensestringyesLicense name to check

lib.player.hasGroup

Check if the player belongs to a specific group (job/gang)

lua
local has = lib.player.hasGroup(group)
ParameterTypeRequiredDescription
groupstringyesGroup name to check

lib.player.setSkin

Open the skin/character appearance editor

lua
lib.player.setSkin()

lib.player.openCustomisation

Open the clothing/barber customisation menu

lua
lib.player.openCustomisation()
Was this page helpful?
This page was last updated on 12 March 2026
DIRKSCRIPTS
All you need for your FiveM server.10% off your first order

Unsubscribe any time.

Copyright © 2026 DirkScripts. Not affiliated with or endorsed by Rockstar North or Take-Two Interactive.