Methods

These functions are inherited from the Player class.

player.set

Update the player's metadata, optionally syncing it with the client.

player.set(key, value, replicated)

• key: string
• value: any
• replicated?: boolean

player.get

Get a value from the player's metadata, or omit the argument to get all metadata.

player.get(key)

• key?: string

player.getState

Return the player's statebag.

player.getState()

player.getCoords

Return the player's position.

player.getCoords()

player.setGroup

Updates the player's grade for the given group. Any value below 1 will remove the group from the player.

player.setGroup(group, grade)

• group: string
• grade?: number

player.getGroup

Returns the player's current grade for a given group.

player.getGroup()

player.getGroups

Returns an object of all groups the player is in, with the current grade as the value.

player.getGroups()

player.hasGroup

Check if the player is a member of a given group, and returns the matching group name and grade.
The filter can be a string, array, or object where key is the group, and value is the minimum grade.

player.hasGroup(filter)

• filter: string | string[] | { [string]: number }

player.setStatus

Set the current value for a status (i.e. hunger, thirst).

player.setStatus(name, value)

• name: string
• value: number

player.addStatus

Add the given amount to the total value for a status (i.e. hunger, thirst).

player.addStatus(name, value)

• name: string
• value: number

player.removeStatus

Remove the given amount from the total value for a status (i.e. hunger, thirst).

player.removeStatus(name, value)

• name: string
• value: number

player.getLicenses

Get all licenses for the player.

player.getLicenses()

player.getLicense

Get the license of the given name for the player, as an object containing license information.

player.getLicense(name)

• name: string

player.addLicense

Grants a license to the player and triggers 'ox:licenseAdded' on the server and client.

player.addLicense(name)

• name: string

player.removeLicense

Revokes a license from the player and triggers 'ox:licenseRemoved' on the server and client.

player.removeLicense(name)

• name: string

player.getPlayersInScope

Return an array of all player id's inside the player's scope.

player.getPlayersInScope()

player.isPlayerInScope

Check if the given source is inside the player's scope.

player.isPlayerInScope(target)

• target: number

player.triggerScopedEvent

player.triggerScopedEvent(eventName, ...)

• eventName: string
• ...?: any[]