Client
Library
Updated a month ago ·
v1.3.7lib.player.identifier
Get the current character's unique identifier (citizenid)
lib.player.name
Get the current character's name
lib.player.getPlayerData
Get the full player data object, or a specific key from it
| Parameter | Type | Required | Description |
|---|---|---|---|
| key | string | no | Specific key to retrieve. Omit for full data object |
lib.player.getMetadata
Get player metadata, or a specific metadata key
| Parameter | Type | Required | Description |
|---|---|---|---|
| key | string | no | Specific metadata key. Omit for all metadata |
lib.player.getMoney
Get the player's balance for a specific account
| Parameter | Type | Required | Description |
|---|---|---|---|
| account | string | yes | Account name (e.g. "cash", "bank") |
lib.player.getJob
Get the player's current job data
lib.player.getGang
Get the player's current gang data
lib.player.editStatus
Modify player status values (hunger, thirst, etc.)
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | table | yes | Status changes to apply |
lib.player.getItems
Get all items in the player's inventory
lib.player.getLicenses
Get all licenses the player holds
lib.player.hasLicense
Check if the player has a specific license
| Parameter | Type | Required | Description |
|---|---|---|---|
| license | string | yes | License name to check |
lib.player.hasGroup
Check if the player belongs to a specific group (job/gang)
| Parameter | Type | Required | Description |
|---|---|---|---|
| group | string | yes | Group name to check |
lib.player.setSkin
Open the skin/character appearance editor
lib.player.openCustomisation
Open the clothing/barber customisation menu
Was this page helpful?
This page was last updated on 12 March 2026