Server
v1.3.7lib.player.get
Get the player's information
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source of the target |
lib.player.identifier
Returns the identifier (CitizenID) of the player
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source of the target |
lib.player.name
Returns the name of the character
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source of the target |
lib.player.phone_number
Return the phone number of the character
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source of the target |
lib.player.gender
Return the gender of the character
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source of the target |
lib.player.checkOnline
Check if a player is online by their CitizenID
| Parameter | Type | Required | Description |
|---|---|---|---|
| identifier | String | true | Identifier to be checked for |
lib.player.jail
Send a player to jail
| Parameter | Type | Required | Description |
|---|---|---|---|
| trg | Number | true | Source to be targeted |
| data | Object | true | Data to be used, for example time |
lib.player.addMoney
Add money to a player
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source to be targeted |
| acc | String | true | Account to be deposited in |
| amount | Number | true | Amount to be moved |
| reason | String | true | Transaction reason |
lib.player.removeMoney
Remove money to a player
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source to be targeted |
| acc | String | true | Account to be removed |
| amount | Number | true | Amount to be moved |
| reason | String | true | Transaction reason |
lib.player.addItem
Add item to a player
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source to be targeted |
| item | String | true | Item spawncode |
| amount | Number | true | Quantity |
| md | Object | false | Metadata for the item |
| slot | Number | false | Slot to be placed in, default is next available |
lib.player.removeItem
Remove an item for a player
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source to be targeted |
| item | String | true | Item spawncode |
| amount | Number | true | Quantity |
| md | Object | false | Metadata for the item |
| slot | Number | false | Slot to be placed in, default is next available |
lib.player.editItem
Edit the metadata of an item
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source to be targeted |
| slot | Number | true | Item slot to be targeted |
| new_data | Object | true | Data to be set |
lib.player.getInventory
Returns the inventory of the player
Example Return:
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | Number | true | Source to be targeted |
Additional Functions
lib.player.deleteCharacter
Delete a character
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | number | yes | Player source |
| citizenId | string | yes | Character identifier to delete |
lib.player.loginCharacter
Log into a character
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | number | yes | Player source |
| citizenId | string | yes | Character identifier |
| newData | table | no | Additional data for login |
lib.player.logoutCharacter
Log out of the current character
lib.player.createCharacter
Create a new character
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | number | yes | Player source |
| data | table | yes | Character creation data |
lib.player.getCharacters
Get all characters for a player
lib.player.getSkin
Get a player's skin/appearance data
lib.player.setJob
Set a player's job
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | number | yes | Player source |
| job | string | yes | Job name |
| rank | number | yes | Job grade/rank |
lib.player.getJob
Get a player's job data
lib.player.getGang
Get a player's gang data
lib.player.setDuty
Set a player's duty status
lib.player.setMoney
Set a player's account balance directly
lib.player.getMoney
Get a player's balance for a specific account
lib.player.setPlayerData
Set arbitrary player data
lib.player.getPlayerData
Get player data, or a specific key
lib.player.setMetadata
Set player metadata
lib.player.getMetadata
Get player metadata
lib.player.hasLicense
Check if a player has a license
lib.player.getLicenses
Get all player licenses
lib.player.hasGroup
Check if a player belongs to a group
lib.player.getIdentifierType
Get a specific identifier type for a player
| Parameter | Type | Required | Description |
|---|---|---|---|
| src | number | yes | Player source |
| type | string | yes | Identifier type (e.g. "license", "discord", "steam") |