[1.16.1] Syncing item stack capability to client?

[Electric]

I have attached a capability to my custom item, and it successfully stores the data server side. But I cannot figure out how to sync it to the client item stack properly. 

EDIT: I'm not storing the item stack itself within this capability, just some extra string data that I can edit/change.

 

I sync the server side cap to client every tick in the item class:

/**
     * Called each tick as long the item is on a player inventory. Uses by maps to check if is on a player hand and
     * update it's contents.
     */
    public void inventoryTick(ItemStack stack, World worldIn, Entity entityIn, int itemSlot, boolean isSelected) {

        if (!worldIn.isRemote && entityIn instanceof ServerPlayerEntity) {
            IConsoleItem cap = stack.getCapability(CONSOLE_ITEM, null).orElseThrow(() -> new IllegalArgumentException(("LazyOptional must not be empty!")));

            PacketConsoleItemSync newPacket = new PacketConsoleItemSync(cap.getLinkedUUID(), stack);
            PacketHandler.sendTo(newPacket, (ServerPlayerEntity) entityIn);
        }
    }

 

Here is my packet:

public class PacketConsoleItemSync {

    private String linkedUUID = "none";
    private ItemStack stack = null;

    public PacketConsoleItemSync(PacketBuffer buf) {
        linkedUUID = buf.readString();
        stack = buf.readItemStack();
    }

    public PacketConsoleItemSync(String linkedUUID, ItemStack stack) {
        this.linkedUUID = linkedUUID;
        this.stack = stack;

    }

    public static void encode(PacketConsoleItemSync packet, PacketBuffer buf) {
        buf.writeString(packet.linkedUUID);
        buf.writeItemStack(packet.stack);

    }

    public static void handle(final PacketConsoleItemSync packet, Supplier<NetworkEvent.Context> context) {
        NetworkEvent.Context ctx = context.get();
        ctx.enqueueWork(() -> {

               if (packet.stack != null) {

                   IConsoleItem cap = packet.stack.getCapability(CONSOLE_ITEM, null).orElseThrow(() -> new IllegalArgumentException(("LazyOptional must not be empty!")));
//                   System.out.println(packet.stack);
                   cap.setLinkedUUID(packet.linkedUUID);
//                   System.out.println(packet.linkedUUID);

               }

        });

        ctx.setPacketHandled(true);
    }
}

 

I'm pretty certain that the problem lies with my packet class, as I'm not sure how to properly get the itemstack and replace it client side. Simply sending it through the packet buff and accessing its capability isn't working. It isn't null, but it just won't change.

Edited July 26, 2020 by Electric

[poopoodice]

You shouldn't be sending changes every tick, and for ItemStacks' capability syncing you will need to override getShareTag(), readShareTag().

[Electric]

Thanks guys! I added the getShareTag and readShareTag to my item class. Now everything works well! 

@Override
    public CompoundNBT getShareTag(ItemStack stack) {
        CompoundNBT nbt = stack.getOrCreateTag();
        IConsoleItem cap = stack.getCapability(CONSOLE_ITEM, null).orElseThrow(() -> new IllegalArgumentException("LazyOptional must not be empty!"));

        nbt.putString("linkedUUID", cap.getLinkedUUID());

        return nbt;
    }

    @Override
    public void readShareTag(ItemStack stack, @Nullable CompoundNBT nbt) {
        super.readShareTag(stack, nbt);

        if (nbt != null) {
            IConsoleItem cap = stack.getCapability(CONSOLE_ITEM, null).orElseThrow(() -> new IllegalArgumentException("LazyOptional must not be empty!"));
            cap.setLinkedUUID(nbt.getString("linkedUUID"));
        }
    }

 

I'm wondering what exactly what these methods do. I turned off my packet syncing from earlier and the client still seems to have an updated item stack whenever I change my capability server side. So do these methods sync the capability between server and client by themselves? And it updates every tick or just knows when I change something server side?

Edited July 27, 2020 by Electric

[poopoodice]

I believe whenever there are changes being made to the tag, it will be sync to the client. What 

getShareTag()

does is allows you to modify the tag before the message of syncing being sent.

[Electric]

33 minutes ago, poopoodice said:

I believe whenever there are changes being made to the tag, it will be sync to the client. What 

getShareTag()

does is allows you to modify the tag before the message of syncing being sent.

 

Ahh that makes sense, thanks!