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:

  • elementplayerElement: Elemento do Jogador.
  • stringitemCheck: Item desejado a Checar.

• Retorno da Função:

  • boolhaveItem: Retorna true caso o Jogador possua o Item, falso a ação contrária.
  • intamountItem: Retorna a quantidade do Item que o Jogador possui.
  • intindexItem: Retorna a posição / index do Item na tabela de Itens do Jogador.

Syntax

bool, int, intgetPlayerItem (playerElement, itemCheck)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("getitem", function (playerElement, commandExecute, itemCheck)
localhaveItem, amountItem, indexItem=inventory:getPlayerItem (playerElement, itemCheck)
print (haveItem, amountItem, indexItem)
end)

givePlayerItem

• Argumentos Obrigatórios:

  • elementplayerElement: Elemento do Jogador.
  • stringitemGive: Item desejado a Givar.
  • intitemAmount: Quantidade que deseja Givar.

• Retorno da Função:

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

Syntax

boolgivePlayerItem (playerElement, itemGive, itemAmount)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("giveitem", function (playerElement, commandExecute, itemGive, itemAmount)
localgiveItem=inventory:givePlayerItem (playerElement, itemGive, itemAmount)
print (giveItem)
end)

takePlayerItem

• Argumentos Obrigatórios:

  • elementplayerElement: Elemento do Jogador.
  • stringitemTake: Item desejado a Retirar.
  • intitemAmount: 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

booltakePlayerItem (playerElement, itemTake, itemAmount)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("takeitem", function (playerElement, commandExecute, itemTake, itemAmount)
localtakeItem=inventory:takePlayerItem (playerElement, itemTake, itemAmount)
print (takeItem)
end)

getAllPlayerItens

• Argumentos Obrigatórios:

  • elementplayerElement: Elemento do Jogador.

• Retorno da Função:

  • table: Retorna a tabela de Itens do Jogador.

Syntax

tablegetAllPlayerItens (playerElement)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("getitens", function (playerElement, commandExecute)
localplayerItens=inventory:getAllPlayerItens (playerElement)
iprint (playerItens, #playerItens)
end)

isPlayerReciveItem

• Argumentos Obrigatórios:

  • elementplayerElement: Elemento do Jogador.
  • stringitemRecive: Item desejado a Verificar.
  • intitemAmount: 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

boolisPlayerReciveItem (playerElement, itemRecive, itemAmount)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("isitem", function (playerElement, commandExecute, itemRecive, itemAmount)
localreciveItem=inventory:isPlayerReciveItem (playerElement, itemRecive, itemAmount)
print (reciveItem)
end)

setPlayerMaxWeight

• Argumentos Obrigatórios:

  • elementplayerElement: Elemento do Jogador.
  • intnewWeight: Peso desejado a Adicionar.
  • boolwithOld: 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

boolsetPlayerMaxWeight (playerElement, newWeight, withOld)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("setweight", function (playerElement, commandExecute, newWeight, withOld)
localsetWeight=inventory:setPlayerMaxWeight (playerElement, newWeight, withOld)
print (setWeight)
end)

updatePlayerInventory

• Argumentos Obrigatórios:

  • elementplayerElement: 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

boolupdatePlayerInventory (playerElement)

Exemplo 1

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("updateinv", function (playerElement, commandExecute)
localupdateInv=inventory:updatePlayerInventory (playerElement)
print (updateInv)
end)

Exemplo 2

-- server - sideaddEventHandler ("mistic_inventory:forceUpdatePlayerInventory", getRootElement (), function (playerElement)
print ("Update Enviado.")
end)
-- client - sideaddEventHandler ("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:

  • elementplayerElement: Elemento do Jogador.

• Retorno da Função:

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

Syntax

intgetPlayerActualWeight (playerElement)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("getweight", function (playerElement, commandExecute)
localmyWeight=inventory:getPlayerActualWeight (playerElement)
print (myWeight)
end)

getPlayerInventoryData

• Argumentos Obrigatórios:

  • elementplayerElement: Elemento do Jogador.

• Retorno da Função:

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

Syntax

tablegetPlayerInventoryData (playerElement)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("getinv", function (playerElement, commandExecute)
localplayerItens=inventory:getPlayerInventoryData (playerElement)
iprint (playerItens, playerItens.itensData, playerItens.informationsData)
end)

Aditional API

Funções Úteis

getAditionalElementFromData

functiongetAditionalElementFromData (nameAditional)
localtableAditional=getElementsByType ("objects")
iftableAditionaland#tableAditional~=0thenlocaladitionalElement=tableAditional[i]
ifaditionalElementandisElement (aditionalElement) andgetElementData (aditionalElement, "mistic_inventory:thisInventoryObject") andgetElementData (aditionalElement, "mistic_inventory:thisInventoryObject").identify==nameAditionalthenreturnaditionalElementendendreturnfalseend

Funções do lado server - side

getAditionalItem

• Argumentos Obrigatórios:

  • elementaditionalElement: Elemento do Adicional.
  • stringaditionalData: Data do Adicional.
  • stringitemCheck: Item desejado a Checar.

• Retorno da Função:

  • boolhaveItem: Retorna true caso o Adicional possua o Item, falso a ação contrária.
  • intamountItem: Retorna a quantidade do Item que o Adicional possui.
  • intindexItem: Retorna a posição / index do Item na tabela de Itens do Adicional.

Syntax

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

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("getaitem", function (playerElement, commandExecute, aditionalData, itemCheck)
localaditionalElement=getAditionalElementFromData (aditionalData)
ifaditionalElementthenlocalhaveItem, amountItem, indexItem=inventory:getAditionalItem (aditionalElement, aditionalData, itemCheck)
print (haveItem, amountItem, indexItem)
endend)

giveAditionalItem

• Argumentos Obrigatórios:

  • elementaditionalElement: Elemento do Adicional.
  • stringaditionalData: Data do Adicional.
  • stringitemGive: Item desejado a Givar.
  • intitemAmount: 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, intgiveAditionalItem (aditionalElement, aditionalData, itemGive, itemAmount)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("giveaitem", function (playerElement, commandExecute, aditionalData, itemGive, itemAmount)
localaditionalElement=getAditionalElementFromData (aditionalData)
ifaditionalElementthenlocalgiveItem=inventory:giveAditionalItem (aditionalElement, aditionalData, itemGive, itemAmount)
print (giveItem)
endend)

takeAditionalItem

• Argumentos Obrigatórios:

  • elementaditionalElement: Elemento do Adicional.
  • stringaditionalData: Data do Adicional.
  • stringitemTake: Item desejado a Remover.
  • intitemAmount: 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, inttakeAditionalItem (aditionalElement, aditionalData, itemTake, itemAmount)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("takeaitem", function (playerElement, commandExecute, aditionalData, itemTake, itemAmount)
localaditionalElement=getAditionalElementFromData (aditionalData)
ifaditionalElementthenlocaltakeItem=inventory:takeAditionalItem (aditionalElement, aditionalData, itemTake, itemAmount)
print (takeItem)
endend)

setAditionalMaxWeight

• Argumentos Obrigatórios:

  • elementaditionalElement: Elemento do Adicional.
  • stringaditionalData: Data do Adicional.
  • intnewWeight: Peso desejado a Adicionar.
  • boolwithOld: 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

boolsetAditionalMaxWeight (aditionalElement, aditionalData, newWeight, withOld)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("setaweight", function (playerElement, commandExecute, aditionalData, newWeight, withOld)
localaditionalElement=getAditionalElementFromData (aditionalData)
ifaditionalElementthenlocalsetWeight=inventory:setAditionalMaxWeight (aditionalElement, aditionalData, newWeight, withOld)
print (setWeight)
endend)

isAditionalReciveWeight

• Argumentos Obrigatórios:

  • elementaditionalElement: Elemento do Adicional.
  • stringaditionalData: Data do Adicional.
  • stringitemCheck: Item desejado a Verificar.
  • intitemAmount: 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

boolisAditionalReciveWeight (aditionalElement, aditionalData, itemCheck, itemAmount)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("isaitem", function (playerElement, commandExecute, aditionalData, itemCheck, itemAmount)
localaditionalElement=getAditionalElementFromData (aditionalData)
ifaditionalElementthenlocalisRecive=inventory:setAditionalMaxWeight (aditionalElement, aditionalData, itemCheck, itemAmount)
print (isRecive)
endend)

getAditionalActualWeight

• Argumentos Obrigatórios:

  • elementaditionalElement: Elemento do Adicional.
  • stringaditionalData: Data do Adicional.

• Retorno da Função:

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

Syntax

intgetAditionalActualWeight (aditionalElement, aditionalData)

Exemplo

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("getaweight", function (playerElement, commandExecute, aditionalData)
localaditionalElement=getAditionalElementFromData (aditionalData)
ifaditionalElementthenlocalmyWeight=inventory:getAditionalActualWeight (aditionalElement, aditionalData)
print (myWeight)
endend)

updateAditionalInventory

• Argumentos Obrigatórios:

  • elementaditionalElement: Elemento do Adicional.
  • stringaditionalData: 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

boolupdateAditionalInventory (aditionalElement, aditionalData)

Exemplo 1

localinventory=exports["mistic_inventory_v2"]
addCommandHandler ("updateainv", function (playerElement, commandExecute, aditionalData)
localaditionalElement=getAditionalElementFromData (aditionalData)
ifaditionalElementthenlocalupdateInv=inventory:updateAditionalInventory (aditionalElement, aditionalData)
print (updateInv)
endend)

Exemplo 2

-- client - sideaddEventHandler ("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)