Inventory

Returns the data for a particular item owned by the holder. The callback parameters are an InventoryItem containing the item data and the error code. The item will be nil and the error code will be InventoryError.None if the holder does not own the item. The item will be nil and the error code will be a value other than InventoryError.None if an error occurred.

This is the equivalent of calling GetItem(player.user.id, callback).

  function PrintItem(player: Player, itemId: string)
    Inventory.GetPlayerItem(player, itemId, function(item)
      if(item == nil) then
        print(`Player {player.name} does not have {itemId}`)
      else
        print(`Player {player.name} has {item.amount} of {item.id}`)
      end
    end)
  end

Returns up to the given limit number of items the holder owns. To get the first group of items, pass in nil for the cursorId. The callback includes a cursorId that can be passed to GetItems to retrieve the next group of items. If the cursor ID is nil, then there are no more items. The callback parameters are an array of InventoryItem, the cursor ID, and the error code. The array will be empty and the error code will be InventoryError.None if the holder owns no items. The array will be nil and the error code will be a value other than InventoryError.None if an error occurred.

  function GetItems(holder: string, limit: number, cursorId: string)
    Inventory.GetItems(holder, limit, cursorId, function(items, newCursorId, errorCode)
      if(items == nil) then
        print(`Got error {InventoryError[errorCode]} while getting items`)
        return
      end
              
      for index, item in items do
        print(`{item.id} : {item.amount}`)
      end
      
      if(newCursorId ~= nil) then
        GetItems(holder, limit, newCursorId)
      else
        print("done")
      end
    end)
  end
  GetItems("SharedStorage", 15)

This is the equivalent of calling GetItems(player.user.id, limit, cursorId, callback).

CommitTransaction will perform all the actions contained in the transaction if the returned error code is InventoryError.None or none of the actions if the returned error code is a value other than InventoryError.None. The callback parameters are the transaction ID and error code. The returned transaction ID can be used to call RollbackTransaction if the actions need to be undone.

Undos the actions of a committed transaction by passing in the transaction ID that was returned in the callback of CommitTransaction. The callback parameter is the error code.