Custom Item Bug

yahwho · Mar 17th 2019

Custom items are bloody awesome addition thank you! I'm sure the folk on Medieval Realms are going to love getting their gemstones in their inventory instead of instantly being converted to cash.

One problem though, the stacks spit fine, but when you try to stack them back up they won't stack until you close the inventory down and re-open up. A wee bug I think?

red51 · Mar 17th 2019

Hehe, this looks really promising!
Unfortunately I wasn't able to reproduce this issue, but I've already made some changes to the custom item handling (maybe that bug was fixed as a side effect)^^ A new hotfix will be available tomorrow, if you still experience any custom item related issues with it, please let me know

Ryan · Mar 17th 2019

Hot darn, look at that! Nice Succinite! Sorry to derail your thread; I'm a gemologist by trade and an avid fan of games, so when the two come together, I get a little giddy. People get minerals on your server? That's awesome!

yahwho · Mar 18th 2019

Quote from red51

A new hotfix will be available tomorrow

Thanks for the heads up! Yep one gemstone down, 9 more to go.

Quote from Ryan

People get minerals on your server?

Yep, there have been gemstones for quite some time now but they were instantly sold. Red's new update makes it way more fun now as they go into your inventory instead.

yahwho · Mar 19th 2019

Hi @red51 I'm using this code to add gems to a players inventory:

Java

Inventory inventory = player.getInventory();
inventory.insertNewCustomItem(EMERALD, 1, 1, 1, 
Inventory.SlotType.Inventory);

When a player finds a gemstone and they currently do not have one in their inventory the notification shows correct ( 1x Emerald * )

However, the second one found shows up at ( 2x Emerald * ) even though only one is added to the inventory (meaning they now have 2).

red51 · Mar 19th 2019

Quote from yahwho

However, the second one found shows up at ( 2x Emerald * ) even though only one is added to the inventory (meaning they now have 2).

If a 2nd item (of the same type, no matter if it's a vanilla or custom item) is added to the inventory within 1-2 seconds, the "1x item" label just gets updated That's actually intended. The reason for this is that there are sometimes situations in which many items are added to the inventory in a short time, and an updated label showing the total amount of items is sometimes more useful in these situations than several "1x" labels

yahwho · Mar 19th 2019

@red51 yes I know about the 1-2 seconds feature the second item was added about 5 minutes later

yahwho · Mar 19th 2019

I appreciate the 3x Coal underneath on both might confuse things. But that was just by chance!

yahwho · Mar 19th 2019

I have been using "rp" console command a lot, I will check that this isn't causing the weird behaviour and update.

yahwho · Mar 20th 2019

Just to confirm, I tried again on a clean server restart (i.e. no reloadplugins command used). I found one Emerald then stopped (I actually went away and grabbed a coffee) I came back and continued mining and found a second Emerald. Although (correctly) I had one more added to my inventory the lower right hand corner notification said I had found 2x Emerald.

This is the code snippet I am using to add custom item to inventory:

Java

Inventory inventory = player.getInventory();
inventory.insertNewCustomItem(EMERALD, 1, 1, 1, 
Inventory.SlotType.Inventory);

red51 · Mar 20th 2019

Oh, well that's not supposed to happen I will check out what's going on there!
The code looks fine btw, but you should only use "1" as variation if there is more than 1 variation defined for your item (otherwise, the default variation is 0)

yahwho · Mar 20th 2019

Sorry @red51 yet another message!

The method:

Java

//method 1
inventory.insertNewCustomItem(EMERALD, 0, 1);

Work well for adding new custom items to the inventory (in the first available free slot or stacks if item already exists), however, it does not generate the nice inventory addition notification/animation on the lower right hand corner of the screen.

The following method does generate a nice notification/animation on the lower right hand corner;

Java

//method 2
inventory.insertNewCustomItem(EMERALD, 0, 1, 0, Inventory.SlotType.Inventory);

However, the above second method requires that I specify a slot (in my examples case - slot 0) the result of which is the item already occupying the slot(0) gets deleted.

Now I have tried writing some code to analyse the inventory (so I can use method 2) so I can allocate the correct slot (or stack if needed), however using item.getName() I simply get "apiitem" which isn't going to work.

The ideal solution would be a notification/animation on method 1.

Or, a new method like method 1;

Java

//method 3
inventory.insertNewCustomItemWithGuiFeedback(EMERALD, 0, 1);

yahwho · Mar 20th 2019

Hmm just going to try this so don't know if it will work yet. . .

Java

//hack doesnt work
//add 1 emerald with no animation
inventory.insertNewCustomItem(EMERALD, 0, 1);
//add 0 emeralds but with animation
inventory.insertNewCustomItem(EMERALD, 0, 0, 0, Inventory.SlotType.Inventory);

yahwho · Mar 20th 2019

Quote from yahwho

however using item.getName() I simply get "apiitem"

Hmm this is actually causing some roadblock for me. I can't work with the items I've added as I have no means to differentiate between them.

The names, including definition name are all "apiitem" and the getTypeID are all the same at 890.

Edit: I can't even hack around it using different max stack sizes as the event.getItem().getMaxStacksize() for all custom items return 1 even though that's not the set max stack size.

red51 · Mar 21st 2019

Quote from yahwho

Work well for adding new custom items to the inventory (in the first available free slot or stacks if item already exists), however, it does not generate the nice inventory addition notification/animation on the lower right hand corner of the screen.

Oh, thanks for letting me know! This seems to be a general issue with the "insertNewItem()" methods (not only affecting custom items)

Quote from yahwho

The names, including definition name are all "apiitem" and the getTypeID are all the same at 890

Yes, that's intended. Internally there is a universal "apiitem" which is used by every custom item. This way the game makes sure there are no collision between item id's, and in addition to that, the game is still runnable if stop using a certain custom item plugin (while there are still custom items in your inventories or chests)
The game distinguishes individual custom items via the item attribute. Every custom item has a CustomItemAttribute (which can be received with Item.getAttribute()). You can add individual attributes to your CustomItemAttribute (this way you can store additional information per item), for example:

Java

//Store per-item data
Item item = playerInventory.insertNewCustomItem(UUID, 0, 1);
Item.CustomItemAttribute attribute = (Item.CustomItemAttribute) item.getAttribute();
attribute.setAttribute("timestamp", String.valueOf(System.currentTimeMillis()));
attribute.setAttribute("playername", player.getName());
attribute.setAttribute("foundAtLocation", player.getPosition().toString());


...
...


//Get info from attribute
Item item = player.getEquippedItem();


//Find out if this is actually a custom item
if(item != null && item.getAttribute() instanceof Item.CustomItemAttribute){
    Item.CustomItemAttribute attribute = (Item.CustomItemAttribute) item.getAttribute();
    if(attribute.hasAttribute("playername")){
        String playername = attribute.getAttribute("playername");
    }
}

Display More

You can also get the UUID from the CustomItemAttribute. This way you can get the actual CustomItem definition from the server:

Java

Item.CustomItemAttribute attribute = (Item.CustomItemAttribute) item.getAttribute();
CustomItem customItemDef = getServer().getCustomItem(attribute.getUUID());


//Probably it's always a good idea to do a null check
if(customItemDef != null){
    String itemname = customItemDef.getName();
    int maxStackSize = customItemDef.getMaxStacksize();
}

noci · Mar 21st 2019

yahwho · Mar 21st 2019

I second that

yahwho · Mar 21st 2019

Quote from red51

You can add individual attributes

Thanks I should have though of this really being as though the whole custom GUI works this way

yahwho · Mar 21st 2019

I'm getting a lot of:

Code

ATTR FILL: 1
ATTR FILL   -> string string

messages on my console output now whenever a custom item is in a players inventory.

(string string being my own set attributes)

red51 · Mar 21st 2019

Quote from yahwho

I'm getting a lot of:

Oh, this is a debug output, you can just ignore it It will be removed with the next hotfix

Participate now!