API_InventorySystemV2

API do nosso Inventário na Versão 2.0

Sumário

• Player API

  • Funções : server - side
    • getPlayerItem
    • givePlayerItem
    • takePlayerItem
    • getAllPlayerItens
    • isPlayerReciveItem
    • setPlayerMaxWeight
    • updatePlayerInventory
    • getPlayerActualWeight
    • getPlayerInventoryData

• Aditional API

  • Funções Úteis
    • getAditionalElementFromData
  • Funções : server - side
    • getAditionalItem
    • giveAditionalItem
    • takeAditionalItem
    • setAditionalMaxWeight
    • isAditionalReciveWeight
    • getAditionalActualWeight
    • updateAditionalInventory

Player API

Funções do lado server - side

getPlayerItem

• Argumentos Obrigatórios:

  • element playerElement: Elemento do Jogador.
  • string itemCheck: Item desejado a Checar.

• Retorno da Função:

  • bool haveItem: Retorna true caso o Jogador possua o Item, falso a ação contrária.
  • int amountItem: Retorna a quantidade do Item que o Jogador possui.
  • int indexItem: Retorna a posição / index do Item na tabela de Itens do Jogador.

Syntax

bool, int, int getPlayerItem (playerElement, itemCheck)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("getitem", function (playerElement, commandExecute, itemCheck)
    local haveItem, amountItem, indexItem = inventory:getPlayerItem (playerElement, itemCheck)
    print (haveItem, amountItem, indexItem)
end)

givePlayerItem

• Argumentos Obrigatórios:

  • element playerElement: Elemento do Jogador.
  • string itemGive: Item desejado a Givar.
  • int itemAmount: Quantidade que deseja Givar.

• Retorno da Função:

  • bool: Retorna true caso o Jogador recebeu o Item, falso a ação contrária.

Syntax

bool givePlayerItem (playerElement, itemGive, itemAmount)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("giveitem", function (playerElement, commandExecute, itemGive, itemAmount)
    local giveItem = inventory:givePlayerItem (playerElement, itemGive, itemAmount)
    print (giveItem)
end)

takePlayerItem

• Argumentos Obrigatórios:

  • element playerElement: Elemento do Jogador.
  • string itemTake: Item desejado a Retirar.
  • int itemAmount: Quantidade que deseja Retirar.

• Retorno da Função:

  • bool: Retorna true caso o Item foi removido do Jogador, falso a ação contrária.

Syntax

bool takePlayerItem (playerElement, itemTake, itemAmount)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("takeitem", function (playerElement, commandExecute, itemTake, itemAmount)
    local takeItem = inventory:takePlayerItem (playerElement, itemTake, itemAmount)
    print (takeItem)
end)

getAllPlayerItens

• Argumentos Obrigatórios:

  • element playerElement: Elemento do Jogador.

• Retorno da Função:

  • table: Retorna a tabela de Itens do Jogador.

Syntax

table getAllPlayerItens (playerElement)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("getitens", function (playerElement, commandExecute)
    local playerItens = inventory:getAllPlayerItens (playerElement)
    iprint (playerItens, #playerItens)
end)

isPlayerReciveItem

• Argumentos Obrigatórios:

  • element playerElement: Elemento do Jogador.
  • string itemRecive: Item desejado a Verificar.
  • int itemAmount: Quantidade que deseja Verificar.

• Retorno da Função:

  • bool: Retorna true caso o Jogador possa receber aquela quantidade do Item, falso a ação contrária.

Syntax

bool isPlayerReciveItem (playerElement, itemRecive, itemAmount)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("isitem", function (playerElement, commandExecute, itemRecive, itemAmount)
    local reciveItem = inventory:isPlayerReciveItem (playerElement, itemRecive, itemAmount)
    print (reciveItem)
end)

setPlayerMaxWeight

• Argumentos Obrigatórios:

  • element playerElement: Elemento do Jogador.
  • int newWeight: Peso desejado a Adicionar.
  • bool withOld: Se vai somar com o peso antigo ou não.

• Retorno da Função:

  • bool: Retorna true caso o Jogador tenha o Peso Máximo do inventário alterado, falso a ação contrária.

Syntax

bool setPlayerMaxWeight (playerElement, newWeight, withOld)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("setweight", function (playerElement, commandExecute, newWeight, withOld)
    local setWeight = inventory:setPlayerMaxWeight (playerElement, newWeight, withOld)
    print (setWeight)
end)

updatePlayerInventory

• Argumentos Obrigatórios:

  • element playerElement: Elemento do Jogador.

• Retorno da Função:

  • bool: Retorna true caso o Inventário do Jogador tenha sido atualizado para o client - side, falso a ação contrária.

Syntax

bool updatePlayerInventory (playerElement)

Exemplo 1

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("updateinv", function (playerElement, commandExecute)
    local updateInv = inventory:updatePlayerInventory (playerElement)
    print (updateInv)
end)

Exemplo 2

-- server - side

addEventHandler ("mistic_inventory:forceUpdatePlayerInventory", getRootElement (), function (playerElement)
    print ("Update Enviado.")
end)

-- client - side

addEventHandler ("mistic_inventory:updatePlayerInventory", getRootElement (), function (typeUpdate, elementInventory, tableInventory)
    --[[
        typeUpdate: Tipo do Update ("player" ou "adicional");
        elementInventory: Elemento para Atualizar (tem que ser o mesmo do inventário, ex : Inventário aberto pelo Jogador `Thigas`, elementInventory = `Thigas`);
        tableInventory: Tabela do Inventário do Jogador (tem que conter todas as informações do Inventário);
    ]]
    print ("Inventário Atualizado.")
end)

getPlayerActualWeight

• Argumentos Obrigatórios:

  • element playerElement: Elemento do Jogador.

• Retorno da Função:

  • int: Retorna o peso do Inventário do Jogador.

Syntax

int getPlayerActualWeight (playerElement)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("getweight", function (playerElement, commandExecute)
    local myWeight = inventory:getPlayerActualWeight (playerElement)
    print (myWeight)
end)

getPlayerInventoryData

• Argumentos Obrigatórios:

  • element playerElement: Elemento do Jogador.

• Retorno da Função:

  • table: Retorna a tabela do Inventário do Jogador.

Syntax

table getPlayerInventoryData (playerElement)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("getinv", function (playerElement, commandExecute)
    local playerItens = inventory:getPlayerInventoryData (playerElement)
    iprint (playerItens, playerItens.itensData, playerItens.informationsData)
end)

Aditional API

Funções Úteis

getAditionalElementFromData

function getAditionalElementFromData (nameAditional)
    local tableAditional = getElementsByType ("objects")
    if tableAditional and #tableAditional ~= 0 then
        local aditionalElement = tableAditional[i]
        if aditionalElement and isElement (aditionalElement) and getElementData (aditionalElement, "mistic_inventory:thisInventoryObject") and getElementData (aditionalElement, "mistic_inventory:thisInventoryObject").identify == nameAditional then
            return aditionalElement
        end
    end
    return false
end

Funções do lado server - side

getAditionalItem

• Argumentos Obrigatórios:

  • element aditionalElement: Elemento do Adicional.
  • string aditionalData: Data do Adicional.
  • string itemCheck: Item desejado a Checar.

• Retorno da Função:

  • bool haveItem: Retorna true caso o Adicional possua o Item, falso a ação contrária.
  • int amountItem: Retorna a quantidade do Item que o Adicional possui.
  • int indexItem: Retorna a posição / index do Item na tabela de Itens do Adicional.

Syntax

bool, int, int getAditionalItem (aditionalElement, aditionalData, itemCheck)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("getaitem", function (playerElement, commandExecute, aditionalData, itemCheck)
    local aditionalElement = getAditionalElementFromData (aditionalData)
    if aditionalElement then
        local haveItem, amountItem, indexItem = inventory:getAditionalItem (aditionalElement, aditionalData, itemCheck)
        print (haveItem, amountItem, indexItem)
    end
end)

giveAditionalItem

• Argumentos Obrigatórios:

  • element aditionalElement: Elemento do Adicional.
  • string aditionalData: Data do Adicional.
  • string itemGive: Item desejado a Givar.
  • int itemAmount: Quantidade desejada a Givar.

• Retorno da Função:

  • bool: Retorna true caso o Adicional receba o Item, falso a ação contrária.

Syntax

bool, int, int giveAditionalItem (aditionalElement, aditionalData, itemGive, itemAmount)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("giveaitem", function (playerElement, commandExecute, aditionalData, itemGive, itemAmount)
    local aditionalElement = getAditionalElementFromData (aditionalData)
    if aditionalElement then
        local giveItem = inventory:giveAditionalItem (aditionalElement, aditionalData, itemGive, itemAmount)
        print (giveItem)
    end
end)

takeAditionalItem

• Argumentos Obrigatórios:

  • element aditionalElement: Elemento do Adicional.
  • string aditionalData: Data do Adicional.
  • string itemTake: Item desejado a Remover.
  • int itemAmount: Quantidade desejada a Remover.

• Retorno da Função:

  • bool: Retorna true caso o Item seja removido do Adicional, falso a ação contrária.

Syntax

bool, int, int takeAditionalItem (aditionalElement, aditionalData, itemTake, itemAmount)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("takeaitem", function (playerElement, commandExecute, aditionalData, itemTake, itemAmount)
    local aditionalElement = getAditionalElementFromData (aditionalData)
    if aditionalElement then
        local takeItem = inventory:takeAditionalItem (aditionalElement, aditionalData, itemTake, itemAmount)
        print (takeItem)
    end
end)

setAditionalMaxWeight

• Argumentos Obrigatórios:

  • element aditionalElement: Elemento do Adicional.
  • string aditionalData: Data do Adicional.
  • int newWeight: Peso desejado a Adicionar.
  • bool withOld: Se vai somar com o peso antigo ou não.

• Retorno da Função:

  • bool: Retorna true caso o Adicional tenha o Peso Máximo do inventário alterado, falso a ação contrária.

Syntax

bool setAditionalMaxWeight (aditionalElement, aditionalData, newWeight, withOld)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("setaweight", function (playerElement, commandExecute, aditionalData, newWeight, withOld)
    local aditionalElement = getAditionalElementFromData (aditionalData)
    if aditionalElement then
        local setWeight = inventory:setAditionalMaxWeight (aditionalElement, aditionalData, newWeight, withOld)
        print (setWeight)
    end
end)

isAditionalReciveWeight

• Argumentos Obrigatórios:

  • element aditionalElement: Elemento do Adicional.
  • string aditionalData: Data do Adicional.
  • string itemCheck: Item desejado a Verificar.
  • int itemAmount: Quantidade do item desejado a Verificar.

• Retorno da Função:

  • bool: Retorna true caso o Adicional possa receber aquela quantidade do Item, falso a ação contrária.

Syntax

bool isAditionalReciveWeight (aditionalElement, aditionalData, itemCheck, itemAmount)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("isaitem", function (playerElement, commandExecute, aditionalData, itemCheck, itemAmount)
    local aditionalElement = getAditionalElementFromData (aditionalData)
    if aditionalElement then
        local isRecive = inventory:setAditionalMaxWeight (aditionalElement, aditionalData, itemCheck, itemAmount)
        print (isRecive)
    end
end)

getAditionalActualWeight

• Argumentos Obrigatórios:

  • element aditionalElement: Elemento do Adicional.
  • string aditionalData: Data do Adicional.

• Retorno da Função:

  • int: Retorna o peso do Inventário do Aditional.

Syntax

int getAditionalActualWeight (aditionalElement, aditionalData)

Exemplo

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("getaweight", function (playerElement, commandExecute, aditionalData)
    local aditionalElement = getAditionalElementFromData (aditionalData)
    if aditionalElement then
        local myWeight = inventory:getAditionalActualWeight (aditionalElement, aditionalData)
        print (myWeight)
    end
end)

updateAditionalInventory

• Argumentos Obrigatórios:

  • element aditionalElement: Elemento do Adicional.
  • string aditionalData: Data do Adicional.

• Retorno da Função:

  • bool: Retorna true caso o Inventário do Jogador tenha sido atualizado para o client - side, falso a ação contrária.

Syntax

bool updateAditionalInventory (aditionalElement, aditionalData)

Exemplo 1

local inventory = exports["mistic_inventory_v2"]

addCommandHandler ("updateainv", function (playerElement, commandExecute, aditionalData)
    local aditionalElement = getAditionalElementFromData (aditionalData)
    if aditionalElement then
        local updateInv = inventory:updateAditionalInventory (aditionalElement, aditionalData)
        print (updateInv)
    end
end)

Exemplo 2

-- client - side

addEventHandler ("mistic_inventory:updatePlayerInventory", getRootElement (), function (typeUpdate, elementInventory, tableInventory)
    --[[
        typeUpdate: Tipo do Update ("player" ou "adicional");
        elementInventory: Elemento para Atualizar (tem que ser o mesmo do inventário, ex : Inventário aberto pelo Jogador `Thigas`, elementInventory = `Thigas`);
        tableInventory: Tabela do Inventário do Jogador (tem que conter todas as informações do Inventário);
    ]]
    print ("Inventário Atualizado.")
end)