NATIVE ATLASA field guide for builders
RED DEAD REDEMPTION II
Connect your AI
From the reference libraryRedM

User class

jo_libs/modules/framework-bridge/user.md

User class

A class to get all the user information.

::: tip If you have a custom framework, you can overwrite methods by added the one you want edit inside _custom/UserClass.lua file. :::

Constructor > <Badge type="server" text="Server" /> jo.framework.UserClass:get()

<!-- @include: ./slots/headers.md#UserClass|jo.framework.UserClass:get -->

<br> <br> Creates and returns a new User instance for the specified player <br>

<!-- @include: ./slots/descriptions.md#UserClass|jo.framework.UserClass:get -->

Constructor > <Badge type="server" text="Server" /> jo.framework.UserClass:get() > Syntax

jo.framework.UserClass:get(source)

Constructor > <Badge type="server" text="Server" /> jo.framework.UserClass:get() > Parameters

source : integer

The source ID of the player

Constructor > <Badge type="server" text="Server" /> jo.framework.UserClass:get() > Return Value

Type : UserClass

Return a User class object containing player data and methods

<!-- @include: ./slots/examples.md#UserClass|jo.framework.UserClass:get -->

<!-- @include: ./slots/footers.md#UserClass|jo.framework.UserClass:get -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:addMoney()

<!-- @include: ./slots/headers.md#UserClass|UserClass:addMoney -->

Adds money to the player <br>

<!-- @include: ./slots/descriptions.md#UserClass|UserClass:addMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:addMoney() > Syntax

UserClass:addMoney(amount, moneyType)

UserClass Methods > <Badge type="server" text="Server" /> UserClass:addMoney() > Parameters

amount : number

The amount of money to add

moneyType : integer

The type of currency: 0: dollar, 1: gold, 2: rol

<!-- @include: ./slots/examples.md#UserClass|UserClass:addMoney -->

<!-- @include: ./slots/footers.md#UserClass|UserClass:addMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:canBuy()

<!-- @include: ./slots/headers.md#server|UserClass:canBuy -->

Checks if a player has sufficient funds of a specified currency type <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:canBuy -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:canBuy() > Syntax

UserClass:canBuy(price, moneyType, removeIfCan)

UserClass Methods > <Badge type="server" text="Server" /> UserClass:canBuy() > Parameters

price : number|table

The amount of money the player needs to have <br> if table: {money = 1, gold = 1, rol = 1}

moneyType : integer <BadgeOptional />

0: dollar, 1: gold, 2: rol <br> default:1

removeIfCan : boolean <BadgeOptional />

Remove the money if the player has enough <br> default:false

UserClass Methods > <Badge type="server" text="Server" /> UserClass:canBuy() > Return Value

Type : boolean

Return true if the player has more money than the amount

<!-- @include: ./slots/examples.md#server|UserClass:canBuy -->

<!-- @include: ./slots/footers.md#server|UserClass:canBuy -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getIdentifiers()

<!-- @include: ./slots/headers.md#UserClass|UserClass:getIdentifiers -->

Retrieves all identifiers associated with the player <br>

<!-- @include: ./slots/descriptions.md#UserClass|UserClass:getIdentifiers -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getIdentifiers() > Syntax

UserClass:getIdentifiers()

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getIdentifiers() > Return Value

Type : table

Return the player's identifiers <br> identifiers.identifier - Unique identifier of the player <br> identifiers.charid - Unique id of the player

<!-- @include: ./slots/examples.md#UserClass|UserClass:getIdentifiers -->

<!-- @include: ./slots/footers.md#UserClass|UserClass:getIdentifiers -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJob()

<!-- @include: ./slots/headers.md#UserClass|UserClass:getJob -->

Returns the current job assigned to a player <br>

<!-- @include: ./slots/descriptions.md#UserClass|UserClass:getJob -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJob() > Syntax

UserClass:getJob()

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJob() > Return Value

Type : string

Returns the job name of the player

<!-- @include: ./slots/examples.md#UserClass|UserClass:getJob -->

<!-- @include: ./slots/footers.md#UserClass|UserClass:getJob -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJobGrade()

<!-- @include: ./slots/headers.md#UserClass|UserClass:getJobGrade -->

Returns the current job grade assigned to a player <br>

<!-- @include: ./slots/descriptions.md#UserClass|UserClass:getJobGrade -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJobGrade() > Syntax

UserClass:getJobGrade()

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJobGrade() > Return Value

Type : number

Returns the job grade of the player

<!-- @include: ./slots/examples.md#UserClass|UserClass:getJobGrade -->

<!-- @include: ./slots/footers.md#UserClass|UserClass:getJobGrade -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getMoney()

<!-- @include: ./slots/headers.md#UserClass|UserClass:getMoney -->

Gets the amount of money a player has of the specified type <br>

<!-- @include: ./slots/descriptions.md#UserClass|UserClass:getMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getMoney() > Syntax

UserClass:getMoney(moneyType)

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getMoney() > Parameters

moneyType : integer

The type of currency: 0: dollar, 1: gold, 2: rol

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getMoney() > Return Value

Type : number

Return the amount for this kind of money

<!-- @include: ./slots/examples.md#UserClass|UserClass:getMoney -->

<!-- @include: ./slots/footers.md#UserClass|UserClass:getMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getRPName()

<!-- @include: ./slots/headers.md#UserClass|UserClass:getRPName -->

Returns the roleplay name (first and last name) of the player <br>

<!-- @include: ./slots/descriptions.md#UserClass|UserClass:getRPName -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getRPName() > Syntax

UserClass:getRPName()

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getRPName() > Return Value

Type : string

Returns the formatted first and last name of the player

<!-- @include: ./slots/examples.md#UserClass|UserClass:getRPName -->

<!-- @include: ./slots/footers.md#UserClass|UserClass:getRPName -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:giveGold()

<!-- @include: ./slots/headers.md#server|UserClass:giveGold -->

Adds gold to the player's account <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:giveGold -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:giveGold() > Syntax

UserClass:giveGold(amount)

UserClass Methods > <Badge type="server" text="Server" /> UserClass:giveGold() > Parameters

amount : number

The amount of gold to add

<!-- @include: ./slots/examples.md#server|UserClass:giveGold -->

<!-- @include: ./slots/footers.md#server|UserClass:giveGold -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:removeMoney()

<!-- @include: ./slots/headers.md#UserClass|UserClass:removeMoney -->

Removes money from the player <br>

<!-- @include: ./slots/descriptions.md#UserClass|UserClass:removeMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:removeMoney() > Syntax

UserClass:removeMoney(amount, moneyType)

UserClass Methods > <Badge type="server" text="Server" /> UserClass:removeMoney() > Parameters

amount : number

The amount of money to remove

moneyType : integer

The type of currency: 0: dollar, 1: gold, 2: rol

<!-- @include: ./slots/examples.md#UserClass|UserClass:removeMoney -->

<!-- @include: ./slots/footers.md#UserClass|UserClass:removeMoney -->

Constructor > <Badge type="server" text="Server" /> jo.framework.UserClass:get()

<!-- @include: ./slots/headers.md#server|jo.framework.UserClass:get -->

Creates and returns a new User instance for the specified player <br>

<!-- @include: ./slots/descriptions.md#server|jo.framework.UserClass:get -->

Constructor > <Badge type="server" text="Server" /> jo.framework.UserClass:get() > Return Value

Type : UserClass

Return a User class object containing player data and methods

<!-- @include: ./slots/examples.md#server|jo.framework.UserClass:get -->

<!-- @include: ./slots/footers.md#server|jo.framework.UserClass:get -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:addMoney()

<!-- @include: ./slots/headers.md#server|UserClass:addMoney -->

Adds money to the player <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:addMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:addMoney() > Parameters

amount : number

The amount of money to add

moneyType : integer

The type of currency: 0: dollar, 1: gold, 2: rol

<!-- @include: ./slots/examples.md#server|UserClass:addMoney -->

<!-- @include: ./slots/footers.md#server|UserClass:addMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getIdentifiers()

<!-- @include: ./slots/headers.md#server|UserClass:getIdentifiers -->

Retrieves all identifiers associated with the player <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:getIdentifiers -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getIdentifiers() > Return Value

Type : table

Return the player's identifiers <br> identifiers.identifier - Unique identifier of the player <br> identifiers.charid - Unique id of the player

<!-- @include: ./slots/examples.md#server|UserClass:getIdentifiers -->

<!-- @include: ./slots/footers.md#server|UserClass:getIdentifiers -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJob()

<!-- @include: ./slots/headers.md#server|UserClass:getJob -->

Returns the current job assigned to a player <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:getJob -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJob() > Return Value

Type : string

Returns the job name of the player

<!-- @include: ./slots/examples.md#server|UserClass:getJob -->

<!-- @include: ./slots/footers.md#server|UserClass:getJob -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJobGrade()

<!-- @include: ./slots/headers.md#server|UserClass:getJobGrade -->

Returns the current job grade assigned to a player <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:getJobGrade -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getJobGrade() > Return Value

Type : number

Returns the job grade of the player

<!-- @include: ./slots/examples.md#server|UserClass:getJobGrade -->

<!-- @include: ./slots/footers.md#server|UserClass:getJobGrade -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getMoney()

<!-- @include: ./slots/headers.md#server|UserClass:getMoney -->

Gets the amount of money a player has of the specified type <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:getMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getMoney() > Return Value

Type : number

Return the amount for this kind of money

<!-- @include: ./slots/examples.md#server|UserClass:getMoney -->

<!-- @include: ./slots/footers.md#server|UserClass:getMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getRPName()

<!-- @include: ./slots/headers.md#server|UserClass:getRPName -->

Returns the roleplay name (first and last name) of the player <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:getRPName -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:getRPName() > Return Value

Type : string

Returns the formatted first and last name of the player

<!-- @include: ./slots/examples.md#server|UserClass:getRPName -->

<!-- @include: ./slots/footers.md#server|UserClass:getRPName -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:removeMoney()

<!-- @include: ./slots/headers.md#server|UserClass:removeMoney -->

Removes money from the player <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:removeMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:removeMoney() > Parameters

amount : number

The amount of money to remove

moneyType : integer

The type of currency: 0: dollar, 1: gold, 2: rol

<!-- @include: ./slots/examples.md#server|UserClass:removeMoney -->

<!-- @include: ./slots/footers.md#server|UserClass:removeMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:removeMoney() > Parameters

amount : number

The amount of money to remove

moneyType : integer

The type of currency: 0: dollar, 1: gold, 2: rol

<!-- @include: ./slots/examples.md#server|UserClass:removeMoney -->

<!-- @include: ./slots/footers.md#server|UserClass:removeMoney -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:setJob()

<!-- @include: ./slots/headers.md#server|UserClass:setJob -->

Sets the current job assigned to a player <br>

<!-- @include: ./slots/descriptions.md#server|UserClass:setJob -->

UserClass Methods > <Badge type="server" text="Server" /> UserClass:setJob() > Syntax

UserClass:setJob(job, grade)

UserClass Methods > <Badge type="server" text="Server" /> UserClass:setJob() > Parameters

job : string

The name of the job

grade : number

The grade of the job

UserClass Methods > <Badge type="server" text="Server" /> UserClass:setJob() > Return Value

Type : boolean

Returns the combined result of the job and grade assignment

<!-- @include: ./slots/examples.md#server|UserClass:setJob -->

<!-- @include: ./slots/footers.md#server|UserClass:setJob -->

Back to documentation