OxPlayer
- state:
StateBagInterface
- userId:
number
- charId?:
number
- stateId?:
string
OxPlayer.addStatus
Increases value of a status.
player.addStatus(statusName, value)
Parameters
- statusName:
string
- value:
number
Returns
- success:
boolean
OxPlayer.get
Returns a value from the players metadata.
player.get(key)
Parameters
- key:
string
Returns
unknown
OxPlayer.getCoords
Returns the player's current coordinates.
player.getCoords()
Parameters
vector3
OxPlayer.getGroup
Returns the player's grade of a given group name, or the first matched name and grade in a filter.
player.getGroup(filter)
Parameters
- filter:
string
|string[]
|{ [string]: number }
Returns
unknown
OxPlayer.getGroupByType
Returns the player's name and grade of a group with a matching type.
player.getGroupByType(type)
Parameters
- type:
string
Returns
string
number
OxPlayer.getGroups
Returns an object of all groups the player is currently in, using the group name as a key.
player.getGroups()
Returns
{ [string]: number }
OxPlayer.getStatus
Returns the value of the status.
player.getStatus(statusName)
Parameters
- statusName:
string
Returns
number
OxPlayer.getStatuses
Returns an object containing all statuses, using the status name as the key.
player.getStatuses()
Returns
{ [string]: number }
OxPlayer.hasPermission
Checks if a user has a permission, given by one of their groups.
player.hasPermission(permission)
Parameters
- permission:
string
Returns
boolean
Example
-- Adding a permission to a group (server side)
Ox.SetGroupPermission('police', 1, 'handcuff', 'allow')
-- Checking if a player has the 'handcuff' permission
if player.hasPermission('group.police.handcuff') then
-- Do something
end
OxPlayer.removeStatus
Reduces the value of a status.
player.removeStatus(statusName, value)
Parameters
- statusName:
string
- value:
number
Returns
boolean
OxPlayer.on
Listens for changes to the players metadata, specified by a key.
player.on(key, cb(data))
Parameters
- key:
string
- cb:
function
Returns
- data:
unknown
- new value of
key
- new value of