Character

Interface

    ---@param playerSrc number
    ---@param userId number
    ---@param id string
    ---@param license string
    ---@param appearance { model: string, clothes: array, hair: table, eyeColor: number, pedFaceFeatures: table, headOverlay: table, headBlendData: table } 
    ---@param cpf string
    ---@param name string
    ---@param lastName string
    ---@param roles table
    ---@param phone string
    ---@param age number
    ---@param profilePicture string
    ---@param inventory array
    ---@param weight number
    ---@param maxWeight number
    ---@param statistics table
    ---@param coins number
    ---@param lastLogin number
    ---@param xp number
    ---@param maxVehicles number

---

Functions

character.getId

---

Retorna o identificador do personagem.

character.getId()

character.getUserId

---

Retorna o identificador da conta do personagem.

character.getUserId()

character.getCPF

---

Retorna o registro do personagem.

character.getCPF()

character.getName

---

Retorna o nome completo do personagem.

character.getName()

character.getFirstName

---

Retorna o primeiro nome do personagem.

character.getFirstName()

character.getLastName

---

Retorna o último nome do personagem.

character.getLastName()

character.getPhoneNumber

---

Retorna o número de telefone do personagem.

character.getPhoneNumber()

character.getAge

---

Retorna a idade do personagem.

character.getAge()

character.getProfilePicture

---

Retorna a foto de perfil do personagem.

character.getProfilePicture()

character.getPosition

---

Retorna a posição atual do personagem em array.

character.getPosition()

character.triggerEvent

---

Executa um evento na source do personagem.

character.triggerEvent(eventName, ...)

• eventName: string

character.notify

---

Envia notificação para o personagem.

character.notify(message, mode, duration)

• message: string

• mode: string

• duration: number

character.kick

---

Desconecta o personagem do servidor.

character.kick(reason, mode, duration)

• reason: string

character.getMoney

---

Retorna o dinheiro atual do jogador.

character.getMoney()

character.setMoney

---

Atualiza o dinheiro atual do jogador.

character.setMoney(amount)

• amount: number

character.addMoney

---

Adiciona dinheiro para o jogador.

character.addMoney(amount)

• amount: number

character.removeMoney

---

Remove dinheiro do jogador.

character.removeMoney(amount)

• amount: number

character.getInventory

---

Retorna o inventário atual do jogador.

character.getInventory()

character.getInventoryItem

---

Verifica se o jogador possui o item especificado.

character.getInventoryItem(name, metadata)

• name: string

• metadata?: table

character.addInventoryItem

---

Adiciona o item para o jogador.

character.addInventoryItem(name, count, metadata, slot, ignoreMax)

• name: string

• count: number

• metadata?: table

• slot?: number

• ignoreMax?: boolean

character.removeInventoryItem

---

Remove o item do jogador.

character.removeInventoryItem(name, count, metadata, slot)

• name: string

• count: number

• metadata?: table

• slot?: number

character.canCarryItem

---

Verifica se o jogador pode carregar o item.

character.canCarryItem(name, count, metadata)

• name: string

• count: number

• metadata?: table

character.clearInventory

---

Remove todos os items do inventário do jogador.

character.clearInventory()

character.getWeight

---

Retorna o peso em uso do inventário do jogador.

character.getWeight()

character.getMaxWeight

---

Retorna o peso máximo do inventário do jogador.

character.getMaxWeight()

character.setMaxWeight

---

Atualiza o peso máximo do inventário do jogador.

character.setMaxWeight(amount)

• amount: number

character.getServiceStatus

---

Valida se o jogador está com serviço ativo no cargo especificado.

character.getServiceStatus(roleId)

• roleId: number | string

character.getGroupServiceStatus

---

Valida se o jogador está com serviço ativo no grupo especificado.

character.getGroupServiceStatus(groupId)

• groupId: number | string

character.updateServiceEntryTime

---

Atualiza o estado de serviço do jogador no cargo especificado.

character.updateServiceEntryTime(roleId, serviceStatus)

• roleId: number | string

• serviceStatus: boolean

character.hasRole

---

Verifica se o jogador possui o cargo especificado.

character.hasRole(roleId)

• roleId: number | string

character.addRole

---

Adiciona cargo especificado ao jogador.

character.addRole(roleId)

• roleId: number | string

character.getRoleIdByGroupName

---

Retorna o identificador do cargo baseado no grupo especificado.

character.getRoleIdByGroupName(groupId)

• groupId: number | string

character.hasGroup

---

Verifica se o jogador possui o grupo especificado.

character.hasGroup(groupId, rank, serviceStatus)

• groupId: number | string

• rank?: number

• serviceStatus?: boolean

character.getRoleByGroupType

---

Retorna o cargo do jogador baseado no tipo de grupo.

character.getRoleByGroupType(groupType)

• groupType: string

character.getCoins

---

Retorna a quantidade atual de coins do jogador.

character.getCoins()

character.removeCoins

---

Remove coins do jogador.

character.removeCoins(amount)

• amount: number

character.removeCoins

---

Adiciona coins ao jogador.

character.removeCoins(amount)

• amount: number

character.tryRemoveCoins

---

Tenta remover coins do jogador.

character.tryRemoveCoins(amount)

• amount: number

character.addBankMoney

---

Adiciona dinheiro a conta bancária do jogador.

character.addBankMoney(amount, title)

• amount: number

• title?: string

character.getBankMoney

---

Retorna o dinheiro da conta bancária do jogador.

character.getBankMoney()

character.getBankLimit

---

Retorna o limite do cartão de crédito do jogador.

character.getBankLimit()

character.tryPayment

---

Tenta fazer um pagamento usando o metodo especificado jogador.

character.tryPayment(mode, amount, data)

• mode: string | cash | bank | creditCard | coins

• amount: number

• data?: { title: string, type: string }

character.tryFullPayment

---

Tenta fazer um pagamento usando todos os metodos.

--- Metodos aplicados: `cash` | `bank` | `creditCard`
character.tryFullPayment(amount)

• amount: number

character.setXp

---

Atualiza a quantidade de XP do jogador.

character.setXp(amount)

• amount: number

character.addXp

---

Adiciona XP para o jogador.

character.addXp(amount)

• amount: number

character.removeXp

---

Remove XP do jogador.

character.removeXp(amount)

• amount: number

character.getLevel

---

Retorna o nivel atual do jogador.

character.getLevel()

character.getMaxVehicles

---

Retorna a quantidade maxima de veiculos que o jogador pode ter.

character.getMaxVehicles()

character.setMaxVehicles

---

Atualiza a quantidade máxima de veiculos do jogador.

character.setMaxVehicles(amount)

• amount: number

character.addMaxVehicles

---

Adiciona máximo de veiculos para o jogador.

character.addMaxVehicles(amount)

• amount: number

character.removeMaxVehicles

---

Remove máximo de veiculos do jogador.

character.removeMaxVehicles(amount)

• amount: number