Inventory - Insert New Item - Returned Object

Textra · Aug 15th 2022

Hey all. So I'm reading the Javadocs and they tell me that the Inventory method insertNewItem() should return null if the new item cannot be added to the player's inventory. However, in my code, the method is returning a non-null item object even when the player's inventory is full and the item gets dropped into the world. Hoping I've missed something obvious and one of you might spot it. Any help would be appreciated.

Code

@EventMethod
public void onPlayerChangePosition(final PlayerChangePositionEvent event) {

    ... // Does some stuff

    Item newItem = event.getPlayer().getInventory().insertNewItem(itemId, itemVariation,1);

    if(newItem == null) {
        event.getPlayer().sendTextMessage("cannot add to inventory"); // never gets here even when player inventory is full.
    } else {
        ... // Does some other stuff
    }
}

Display More

red51 · Aug 15th 2022

Oh, this is unfortunately a bug If the item couldn't be added due to a full inventory, the game still returns the unused item instance (which is quite useless)... that's not intended...

But I'm afraid there isn't even a proper workaround available You could check if the newly returned item instance exists in inventory (I've posted an example below), however, that does not work in case of stackable items (if the item was added to an existing stack)... so this solution only works reliably for non-stackable items (e.g. tools, weapons etc).

Java

//Your new code
@EventMethod
public void onPlayerChangePosition(final PlayerChangePositionEvent event) {
    //Do some stuff
    //...

    Item newItem = event.getPlayer().getInventory().insertNewItem(itemID, itemVariation, 1);
    //Check if returned item is null or if it still does not exist in inventory
    if(newItem == null || !isItemInInventory(newItem, event.getPlayer().getInventory())) {
        event.getPlayer().sendTextMessage("cannot add to inventory");
    }
    else {
        //Do other stuff
        //...
    }
}


//Helper function
public boolean isItemInInventory(Item item, Inventory inventory) {
    for(Item i : inventory.getAllItems()) {
        if(item == i) return true;
    }
    return false;
}

Display More

Textra · Aug 16th 2022

Thanks for the update Red51. If it's a bug there's not much I can do but I least I know now. Let's me move on to trying to detect the case in some other way. Thanks again.

Participate now!