Sending NBT int value to Client HUD | The Fabric Project | Page 1

severe tapir Dec 6, 2024, 1:45 AM

#

(1.21) Hey! I am a bit confused on how to network a nbt value "projectaot.energy" from the server side to the client. I created a payload class:

#

    public static final CustomPayload.Id<EnergyPayload> ID = new CustomPayload.Id<>(NetworkingConstants.ENERGY_PACKET_ID);
    public static final PacketCodec<RegistryByteBuf, EnergyPayload> CODEC = PacketCodec.tuple(PacketCodecs.INTEGER, EnergyPayload::value, EnergyPayload::new);


    @Override
    public Id<? extends CustomPayload> getId() {
        return null;
    }

    public static int getValue(EnergyPayload payload) {
        return payload.value;
    }
}``` and a EnergyHUD class: ```public class EnergyHUDOverlay implements HudRenderCallback {
    public static final Identifier FILLED_ENERGY = Identifier.of(ProjectAOT.MOD_ID, "textures/energy/filled_energy.png");
    public static final Identifier EMPTY_ENERGY = Identifier.of(ProjectAOT.MOD_ID, "textures/energy/empty_energy.png");
    @Override
    public void onHudRender(DrawContext drawContext, RenderTickCounter renderTickCounter) {
        int x = 100;
        int y = 100;
        MinecraftClient client = MinecraftClient.getInstance();
        if(client != null) {
            int width = client.getWindow().getScaledWidth();
            int height = client.getWindow().getScaledHeight();

            x = width / 2;
            y = height;

        }
        if(client.player != null) {
            IEntityDataSaver p = (IEntityDataSaver) client.player;
            if(p.getPersistentData() != null) {

                int energy = p.getPersistentData().getInt("projtectaot.energy");
                drawContext.drawText(client.textRenderer, energy + "/100", x+10, y, 0xFFFFFFFF, true);

                if(energy > 0) {
                    drawContext.drawTexture(RenderLayer::getGuiTexturedOverlay, FILLED_ENERGY, x, y, 0,0,16,16, 16,16);

                } else {
                    drawContext.drawTexture(RenderLayer::getGuiTexturedOverlay, EMPTY_ENERGY, x, y, 0,0,16,16, 16,16);

                }
            }```

#

How can I send this payload to the client? And how should I grab the information to send on the HUD?

#

The Idea is to display the nbt value onto the screen.

#

from my understand, the nbt data is strictly on the server side and I need the client to recieve the data.

alpine goblet Dec 6, 2024, 2:02 AM

#

severe tapir How can I send this payload to the client? And how should I grab the information...

You're pretty much there, except for returning null on "getId." I believe you get the networkHandler from a ServerPlayerEntity and send it there, possibly with ServerPlayNetworking from fapi. Let me pull up my code ra

severe tapir Dec 6, 2024, 2:02 AM

#

thank you! Yeah tbh idk what im doing so I didn't even notice im returning null lol

#

fixed it to @Override public Id<? extends CustomPayload> getId() { return ID; }

alpine goblet Dec 6, 2024, 2:03 AM

#

https://github.com/skycatminepokie/mystical/blob/master/src%2Fmain%2Fjava%2Fcom%2Fskycat%2Fmystical%2Fnetwork%2FMysticalNetworking.java

#

Something like that. Doesn't need to be in a separate class or have the onPlayReady hook ofc

severe tapir Dec 6, 2024, 2:05 AM

#

interesting. So for my example. Would I send the packet in my HUD class? And should I make the packet in the HUD class as well?

#

ex: int energy = p.getPersistentData().getInt("projtectaot.energy"); EnergyPayload payload = new EnergyPayload(energy);

#

probably not lol...?

alpine goblet Dec 6, 2024, 2:06 AM

#

If that's on the server side, I don't see why not

#

It's a logical place to put it - send it when they open the hud

severe tapir Dec 6, 2024, 2:07 AM

#

Don't believe it is

alpine goblet Dec 6, 2024, 2:07 AM

#

Oh well then no xd

severe tapir Dec 6, 2024, 2:07 AM

#

hahah

alpine goblet Dec 6, 2024, 2:07 AM

#

Does the server know when the client wants it (as of now)?

#

If not, you'll need a way to tell the server to send it, which is likely another (empty) packet

severe tapir Dec 6, 2024, 2:10 AM

#

I don't believe so. My code is very primitive, frankly because I just started. The classes that deal with my nbt value are the 2 the are above and ```public class PlayerTickHandler implements ServerTickEvents.StartTick{

@Override
public void onStartTick(MinecraftServer minecraftServer) {
   if(minecraftServer.getTicks() % 60 == 0) { //every 3 seconds
        for(ServerPlayerEntity player : minecraftServer.getPlayerManager().getPlayerList()) {
            IEntityDataSaver dataSaver = (IEntityDataSaver) player;
            EnergyData.addEnergy(dataSaver, 1);

        }
    }
}

}```

#

maybe I can use this class to create a packet?

#

this is the class that updates the nbt value every 3 seconds

alpine goblet Dec 6, 2024, 2:13 AM

#

Sure, but do you really need to send it that often? If you do that's fine.

#

I don't know the context in which this "energy" is used

severe tapir Dec 6, 2024, 2:14 AM

#

alpine goblet Sure, but do you really need to send it that often? If you do that's fine.

Definitely not

#

let me explain it a bit more

#

(this system is inspired by a stamina energy-like mechanic system) the nbt integer "projectaot.energy" is an integer that is stored on the player. I have a event that increases a player's "energy" every 3 seconds. The idea is to display the player's current "energy" value on their screen. As of now, my current issue is that these values are not being display on screen (I know my HUD works since I tested it with displaying a constant variable). A suggestion by a fellow discord user said they I am not sending this "energy" nbt value to the client, thus the value im displaying on screen doesn't exist.

#

Currently, i'm curious on whether it's because of the client (networking issue) or my HUD code in general (which im slightly confident in)

#

This energy will eventually be used by as a value cost to execute an ability later on... but for now just the HUD

alpine goblet Dec 6, 2024, 2:19 AM

#

Almost certainly the networking. I think fabric API has code for syncing data attachments if you really wanted, but sending packets is just fine. I'd just put a // TODO estimate values on client and call it good.

severe tapir Dec 6, 2024, 2:19 AM

#

if this doesn't answer your question feel free to ask me more about it! I appreciate your help!

alpine goblet Dec 6, 2024, 2:20 AM

#

severe tapir *if this doesn't answer your question feel free to ask me more about it! I appre...

Nah, that's exactly what I was looking for 👍

severe tapir Dec 6, 2024, 2:21 AM

#

Excellent. So yeah, from my understanding there are a few ways to send the nbt value to the client. From what I understand the payload class I made is just fine (besides that minor "null" return as you pointed out).

#

As of now, I guess im a bit confused on how to utilize this payload.

#

@alpine goblet ill also take a further look at your github example

alpine goblet Dec 6, 2024, 2:23 AM

#

You've got it created, now you need to register it on the right sides and create a receiver on the client side.

#

And yeah just yoink from my GitHub that's what I'd do lol

severe tapir Dec 6, 2024, 2:24 AM

#

haha bet

#

    public static final Identifier ENERGY_PACKET_ID = Identifier.of("projectaot", "energy_id");


    private static CustomPayloadS2CPacket makeEnergyValuePacket(MinecraftServer server, int value) {
        return new CustomPayloadS2CPacket(new EnergyPayload(value));
    }

}``` I created a class like this

#

hopefully a good starting point?

alpine goblet Dec 6, 2024, 2:25 AM

#

Yep!

severe tapir Dec 6, 2024, 2:26 AM

#

        CustomPayloadS2CPacket packet = makeEnergyValuePacket(server,value);
        player.networkHandler.sendPacket(packet);
    }``` made this, thinking I use this function in my HUD class?

#

actually no

#

that seems stupid

#

lol

#

now im confused again haha

alpine goblet Dec 6, 2024, 2:27 AM

#

Are you using split sources?

#

You'd have a main folder and a client folder set up for you if you are

severe tapir Dec 6, 2024, 2:28 AM

#

yes I am

#

oh wait

#

no sorry

#

just a client folder.

alpine goblet Dec 6, 2024, 2:28 AM

#

🤨

severe tapir Dec 6, 2024, 2:28 AM

#

I assume this is what you're talking about:

#

unless im mistaken..

#

concern

alpine goblet Dec 6, 2024, 2:29 AM

#

Can you search your build.gradle for "split" as in split sources?

#

splitEnvironmentSourceSets

severe tapir Dec 6, 2024, 2:31 AM

#

alpine goblet Can you search your build.gradle for "split" as in split sources?

no results

alpine goblet Dec 6, 2024, 2:31 AM

#

Ok, not using split sources then. Good to know.

severe tapir Dec 6, 2024, 2:32 AM

#

I may have something interesting.... let me know what you think about this

alpine goblet Dec 6, 2024, 2:32 AM

#

severe tapir ``` public static void sendEnergyValuePacket(MinecraftServer server, ServerPl...

Keep the sides as separate as you can, tangling them up is unfun. Anyways, you want this on the server side, so somewhere from the server entrypoint

severe tapir Dec 6, 2024, 2:33 AM

#

    public static final Identifier FILLED_ENERGY = Identifier.of(ProjectAOT.MOD_ID, "textures/energy/filled_energy.png");
    public static final Identifier EMPTY_ENERGY = Identifier.of(ProjectAOT.MOD_ID, "textures/energy/empty_energy.png");
    @Override
    public void onHudRender(DrawContext drawContext, RenderTickCounter renderTickCounter) {
        int x = 100;
        int y = 100;
        MinecraftClient client = MinecraftClient.getInstance();
        if(client != null) {
            int width = client.getWindow().getScaledWidth();
            int height = client.getWindow().getScaledHeight();

            x = width / 2;
            y = height;

        }
        if(client.player != null) {
            IEntityDataSaver p = (IEntityDataSaver) client.player;
            if(p.getPersistentData() != null) {


                int energy = p.getPersistentData().getInt("projtectaot.energy");
                EnergyPayload payload = new EnergyPayload(energy);
                ProjectAOTNetworking.sendEnergyValuePacket(client.player.getServer(), client.player, energy);

                drawContext.drawText(client.textRenderer, energy + "/100", x+10, y, 0xFFFFFFFF, true);

                if(energy > 0) {
                    drawContext.drawTexture(RenderLayer::getGuiTexturedOverlay, FILLED_ENERGY, x, y, 0,0,16,16, 16,16);

                } else {
                    drawContext.drawTexture(RenderLayer::getGuiTexturedOverlay, EMPTY_ENERGY, x, y, 0,0,16,16, 16,16);

                }
            }
        }
    }
}``` This is the new HUD class, only difference is making the packet. But as you said I probably dont want to make it constantly.

#

sending network class hold up

#

    public static final Identifier ENERGY_PACKET_ID = Identifier.of("projectaot", "energy_id");


    private static CustomPayloadS2CPacket makeEnergyValuePacket(MinecraftServer server, int value) {
        return new CustomPayloadS2CPacket(new EnergyPayload(value));
    }

    public static void sendEnergyValuePacket(MinecraftServer server, ClientPlayerEntity player, int value) {
        CustomPayloadS2CPacket packet = makeEnergyValuePacket(server,value);
        player.networkHandler.sendPacket(packet);
    }

}``` make it clientplayerentity instead (I have a feeling this is completely wrong)

#

maybe instead I put this in my every 3 second tick class?

#

since it uses ServerPlayerEntity

alpine goblet Dec 6, 2024, 2:35 AM

#

severe tapir ```public class EnergyHUDOverlay implements HudRenderCallback { public stati...

You're mixing up sides here. Your "onHudRender" method can only ever be called on the client, so trying to send the packet isn't helpful - the client isn't the one that controls the power. It has to be told the value, not tell it.

severe tapir Dec 6, 2024, 2:35 AM

#

ahhhh

#

I see

alpine goblet Dec 6, 2024, 2:36 AM

#

severe tapir ```public class ProjectAOTNetworking { public static final Identifier ENERGY...

This is much better, but it needs to take a ServerPlayerEntity - that's the server's copy of the player

#

!!sides if that helps

frigid krakenBOT Dec 6, 2024, 2:36 AM

#

https://raw.githubusercontent.com/FabricMC/community/main/images/sides.png

severe tapir Dec 6, 2024, 2:36 AM

#

Okay! So I may have a solution to that

#

let me code it rq lol

#

ill send it in a second

#


    public static int addEnergy(IEntityDataSaver player, int amount) {
        NbtCompound nbt = player.getPersistentData();
        if(nbt != null) {
            int energy = nbt.getInt("projectaot.energy");
            if (energy + amount >= 100) {
                energy = 100;
            } else {
                energy += amount;
            }
            nbt.putInt("projectaot.energy", energy);
            //sync data
            ServerPlayerEntity playerEntity = (ServerPlayerEntity) player;
            ProjectAOTNetworking.sendEnergyValuePacket(playerEntity.getServer(), playerEntity, energy);
            return energy;
        } else {

        }
        return 0;

    }

    public static int removeEnergy(IEntityDataSaver player, int amount) {
        NbtCompound nbt = player.getPersistentData();
        if(nbt != null) {
            int energy = nbt.getInt("projectaot.energy");
            if (energy - amount <= 100) {
                energy = 0;
            } else {
                energy -= amount;
            }
            nbt.putInt("projectaot.energy", energy);
            //sync data
            return energy;
        }
        return 0;

    }
}``` as I was coding this, I know for a fact this is wrong

#

since casting ServerPlayerEntity to IEntityDataSaver probably wont do sh*t lol

#


import net.minecraft.nbt.NbtCompound;

public interface IEntityDataSaver {
    NbtCompound getPersistentData();
}
``` *IEnergyDataSaver class*

severe tapir Dec 6, 2024, 2:39 AM

#

alpine goblet This is much better, but it needs to take a ServerPlayerEntity - that's the serv...

I guess what im struggling with is: where do I put this function xddd

alpine goblet Dec 6, 2024, 2:39 AM

#

severe tapir since casting ServerPlayerEntity to IEntityDataSaver probably wont do sh*t lol

You can do that, as long as you inject the interface - it's actually a rather good way of doing it.

severe tapir Dec 6, 2024, 2:40 AM

#

Oh sweet

alpine goblet Dec 6, 2024, 2:40 AM

#

severe tapir I guess what im struggling with is: where do I put this function xddd

ServerLifecycleEvents.TICK or something

#

Something registered to that

#

Maybe it's serverworldevents

severe tapir Dec 6, 2024, 2:40 AM

#

well actually, good news

#

                IEntityDataSaver dataSaver = (IEntityDataSaver) player;
                EnergyData.addEnergy(dataSaver, 1);

            }``` the class where im getting a server entity is where im calling my function

#

so it should be working...?

#

maybe.

alpine goblet Dec 6, 2024, 2:41 AM

#

Right there is perfect

severe tapir Dec 6, 2024, 2:41 AM

#

the full class is up above

alpine goblet Dec 6, 2024, 2:41 AM

#

Any time you edit the energy you send an update

severe tapir Dec 6, 2024, 2:41 AM

#

but it is a @Override public void onStartTick(MinecraftServer minecraftServer) {

#

awesome.

#

Thank you for your help so far!

#

I guess the last step would be retrieving this value in the HUD

alpine goblet Dec 6, 2024, 2:42 AM

#

Yep! All that's left is registering it.

severe tapir Dec 6, 2024, 2:42 AM

#

haha yea

alpine goblet Dec 6, 2024, 2:42 AM

#

And that

#

https://github.com/skycatminepokie/mystical/blob/master/src%2Fmain%2Fjava%2Fcom%2Fskycat%2Fmystical%2FMystical.java#L72 registration on the server side

severe tapir Dec 6, 2024, 2:43 AM

#

so currently I have it sending the packet, now I need to register it.

#

awesome

#

thank you

alpine goblet Dec 6, 2024, 2:43 AM

#

alpine goblet <https://github.com/skycatminepokie/mystical/blob/master/src%2Fmain%2Fjava%2Fcom...

Oh wait that's the same for both sides

#

Hah, I did it right on accident

severe tapir Dec 6, 2024, 2:44 AM

#

lol

#

am I looking for PayloadTypeRegistry.playS2C().register(ActiveSpellsPacket.ID, ActiveSpellsPacket.CODEC);?

alpine goblet Dec 6, 2024, 2:44 AM

#

Yep

severe tapir Dec 6, 2024, 2:44 AM

#

so for me itll be PayloadTypeRegistry.playS2C().register(EnergyPayload.ID, EnergyPayload.CODEC);?

alpine goblet Dec 6, 2024, 2:44 AM

#

Exactly

severe tapir Dec 6, 2024, 2:44 AM

#

awesome

#

so now I need to retrieve it in HUD correct?

alpine goblet Dec 6, 2024, 2:45 AM

#

Not yet. It's being sent to your client, and the client won't freak out when it gets it, but it still will just ignore it.

#

Then on the client side a handler

severe tapir Dec 6, 2024, 2:46 AM

#

so you recommend making a class like that?

alpine goblet Dec 6, 2024, 2:46 AM

#

And finally register the handler.

alpine goblet Dec 6, 2024, 2:47 AM

#

severe tapir so you recommend making a class like that?

You can do it that way, or just use a lambda.

#

Less boilerplate that way

severe tapir Dec 6, 2024, 2:48 AM

#

ahh I see, I may just use a class since the examples you are providing do as well. Eventually I can learn how to use it with a lambda statement, rn it's just numbers and random code in my brain atm

#

coding it up rn

#

interesting, so you use a HUDManager?

#

makes sense... lol

alpine goblet Dec 6, 2024, 2:50 AM

#

Yeah. It's more of a cache handler, but it's all for the hud

severe tapir Dec 6, 2024, 2:50 AM

#

actually looking at it now, it may be easier to use the lambda.

#

I assume I can just put the lamda in my HUD class

alpine goblet Dec 6, 2024, 2:51 AM

#

Well, you've got to register the handler when the game starts, so it would be in Something implements ClientModInitializer

severe tapir Dec 6, 2024, 2:52 AM

#

    public static final ClientNetworkHandler CLIENT_NETWORK_HANDLER = new ClientNetworkHandler();

    @Override
    public void onInitializeClient() {
        ClientPlayNetworking.registerGlobalReceiver(EnergyPayload.ID, CLIENT_NETWORK_HANDLER);
    }
}```

alpine goblet Dec 6, 2024, 2:52 AM

#

yeah, in there

#

That works

#

You'd just replace the last CLIENT_NETWORK_HANDLER with () -> { /* do stuff */}

severe tapir Dec 6, 2024, 2:54 AM

#

oh? interesting. Is it possible to just do. ClientPlayNetworking.registerGlobalReceiver(EnergyPayload.ID, (payload, context) -> { context.client().execute(() -> { //do shit }); }); in my HUD class? or is that crazy

#

since in this case

#

I can pull my value

#

in the same function the HUD is being made

alpine goblet Dec 6, 2024, 2:55 AM

#

You can't do that, since you've got to make that registerGlobalReceiver call when the client starts. You can, however, merge your HUD class with your ClientNetworkHandler.

severe tapir Dec 6, 2024, 2:55 AM

#

    public void onHudRender(DrawContext drawContext, RenderTickCounter renderTickCounter) {
        int x = 100;
        int y = 100;
        MinecraftClient client = MinecraftClient.getInstance();
        if(client != null) {
            int width = client.getWindow().getScaledWidth();
            int height = client.getWindow().getScaledHeight();

            x = width / 2;
            y = height;

        }
        if(client.player != null) {
            IEntityDataSaver p = (IEntityDataSaver) client.player;
            if(p.getPersistentData() != null) {


                int energy = p.getPersistentData().getInt("projtectaot.energy");
                ClientPlayNetworking.registerGlobalReceiver(EnergyPayload.ID, (payload, context) -> {
                    context.client().execute(() -> {
                        //do shit
                    });
                });


                drawContext.drawText(client.textRenderer, energy + "/100", x+10, y, 0xFFFFFFFF, true);

                if(energy > 0) {
                    drawContext.drawTexture(RenderLayer::getGuiTexturedOverlay, FILLED_ENERGY, x, y, 0,0,16,16, 16,16);

                } else {
                    drawContext.drawTexture(RenderLayer::getGuiTexturedOverlay, EMPTY_ENERGY, x, y, 0,0,16,16, 16,16);

                }
            }
        }
    }
}``` heres a full expansion

severe tapir Dec 6, 2024, 2:55 AM

#

alpine goblet You can't do that, since you've got to make that registerGlobalReceiver call whe...

gotcha

#

sounds good

#

I think im catching on

#

I do have to log off

#

BUT

#

thank you so much for your help

#

im a lot closer now with your guidance

#

Ill keep at this

#

hopefully one day itll stick with me lol

alpine goblet Dec 6, 2024, 2:57 AM

#

Perfect timing I have to go too lol. Enjoy!

severe tapir Dec 6, 2024, 3:13 AM

#

I just had an awakening, I now understand 😂😂

#Sending NBT int value to Client HUD