OxPlayer

• state: StateBagInterface
• userId: number
• charId?: number
• stateId?: string

OxPlayer.addStatus

Aumenta o valor de um status.

player.addStatus(statusName, value)

Parâmetros

• statusName: string
• value: number

Retornos

• success: boolean

OxPlayer.get

Retorna o valor de uma chave dos metadados do player.

player.get(key)

Parâmetros

• key: string

Retornos

• unknown

OxPlayer.getCoords

Retorna as coordenadas do player.

player.getCoords()

Parâmetros

• vector3

OxPlayer.getGroup

Retorna o grau do player em um dado grupo, ou o primeiro nome e grau em um filtro.

player.getGroup(filter)

Parâmetros

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

Retornos

• unknown

OxPlayer.getGroupByType

Retorna o nome do player e o grau de um grupo com um tipo correspondente.

player.getGroupByType(type)

Parâmetros

• type: string

Retornos

• string
• number

OxPlayer.getGroups

Retorna um objeto com todos os grupos do player, usando o nome do grupo como chave.

player.getGroups()

Retornos

• { [string]: number }

OxPlayer.getStatus

Retorna o valor de um status.

player.getStatus(statusName)

Parâmetros

• statusName: string

Retornos

• number

OxPlayer.getStatuses

Retorna todos os status do player, usando o nome do status como chave.

player.getStatuses()

Retornos

• { [string]: number }

OxPlayer.hasPermission

Verifica se um jogador tem uma permissão através de de seus um grupos.

player.hasPermission(permission)

Parâmetros

• permission: string

Retornos

• boolean

OxPlayer.removeStatus

Reduz o valor de um status.

player.removeStatus(statusName, value)

Parâmetros

• statusName: string
• value: number

Retornos

• boolean

OxPlayer.on

Escuta por alterações nos metadados do player, especificando uma chave.

player.on(key, cb(data))

Parâmetros

• key: string
• cb: function

Retornos

• data: unknown
  • new value of key