OxAccount

• accountId number

OxAccountMetadata

• id: number
• balance: number
• isDefault: number
• label?: boolean
• owner?: number
• group?: string
• type: personal | shared | group

OxAccount.get

Pega o valor de uma chave específica dos metadados da conta.

account.get(key)

Parâmetros

• key: string | string[]

Retornos

• OxAccountMetadata[key] | OxAccountMetadata[key][]
  • Retorna um array se forem passadas múltiplas chaves.

OxAccount.addBalance

Adiciona fundos a conta.

account.addBalance({ amount, message })

Parâmetros

• object
  • amount: number
  • message?: string

Retornos

• object
  • success: boolean
  • message: 'amount_not_number' | 'no_balance' | 'something_went_wrong'

OxAccount.removeBalance

Remove fundos da conta.

account.removeBalance({ amount, message, overdraw })

Parâmetros

• object
  • amount: number
  • message?: string
  • overdraw?: boolean

Retornos

• object
  • success: boolean
  • message: 'amount_not_number' | 'no_balance' | 'something_went_wrong'

OxAccount.transferBalance

Transfere fundos para outra conta.

account.transferBalance({ toId, amount, overdraw, message, note, actorId })

Parâmetros

• object
  • toId: number
    • O accountId que receberá os fundos.
  • amount: number
  • message?: string
  • overdraw?: boolean
  • note?: string
  • actorId? number
    • O charId do player que fez a transferência.

Retornos

• object
  • success: boolean
  • message: 'amount_not_number' | 'no_balance' | 'something_went_wrong'

OxAccount.depositMoney

Deposita dinheiro na conta.

account.transferBalance(playerId, amount, message, note)

Parâmetros

• playerId: number
• amount: number
• message?: string
• note?: string

Retornos

• object
  • success: boolean
  • message: 'amount_not_number' | 'insufficient_funds' | 'no_balance' | 'no_access' | 'something_went_wrong'

OxAccount.withdrawMoney

Retira dinheiro da conta(saque).

account.transferBalance(playerId, amount, message, note)

Parâmetros

• playerId: number
• amount: number
• message?: string
• note?: string

Retornos

• object
  • success: boolean
  • message: 'amount_not_number' | 'no_charId' | 'insufficient_funds' | 'no_balance' | 'no_access' | 'something_went_wrong'

OxAccount.deleteAccount

Marca a conta como excluída. Ela não pode mais ser acessada, mas permanece no banco de dados.

account.deleteAccount()

Retornos

• object
  • success: boolean
  • message: 'something_went_wrong'

OxAccount.getCharacterRole

Pega o cargo de acesso de um personagem pelo seu charId ou stateId.

account.getCharacterRole(id)

Parâmetros

• id: number | string

Retornos

• string

OxAccount.setCharacterRole

Seta o cargo de acesso de um personagem pelo seu charId ou stateId.

account.setCharacterRole(id, role)

Parâmetros

• id: number | string
• role?: string

Retornos

• object
  • success: boolean
  • message: 'something_went_wrong'

OxAccount.playerHasPermission

Verifica se o personagem ativo do jogadortem permissão para realizar uma ação na conta.

account.playerHasPermission(playerId, permission)

Parâmetros

• playerId: number
• permission: string

Retornos

• boolean

OxAccount.setShared

Marca a conta como compartilhada, permitindo que permissões sejam atribuidas a outros personagens.

account.setShared()

Retornos

• object
  • success: boolean
  • message: 'update_account_error'

OxAccount.createInvoice

Cria uma nova cobrança na conta.

account.createInvoice(invoice)

Parâmetros

• invoice: object
  • actorId?: number;
    • O charId do player que fez a cobrança.
  • toAccount: number;
    • O accountId da conta que receberá a cobrança.
  • amount: number;
  • message: string;
  • dueDate: string;

Retornos

• object
  • success: boolean
  • message: 'no_charId' | 'no_permission' | 'no_target_account'