Jump to content

How do you find the functions you need to modify (when you know what you want to do)?


Recommended Posts

Posted

I'll keep it short. I have a very specific idea of what I want to do, and I have several possible approaches outlined in how to implement it. However, I am being completely stymied by not being able to find any actual library documentation. How is someone new to Forge/Minecraft supposed to find the classes and functions that need to be extended or overloaded in the first place? I know the information has to be around somewhere but I can't find it.

(Disclaimer: I'm an experienced amateur programmer/game dev but have basically no Java-specific experience, and this is my first serious look at making my own mod.)

  • Like 1
Posted
11 minutes ago, InspectorCaracal said:

I'll keep it short. I have a very specific idea of what I want to do, and I have several possible approaches outlined in how to implement it. However, I am being completely stymied by not being able to find any actual library documentation. How is someone new to Forge/Minecraft supposed to find the classes and functions that need to be extended or overloaded in the first place? I know the information has to be around somewhere but I can't find it.

first of all do you know basic java?

this is the doc of forge:
https://mcforge.readthedocs.io/en/latest/

and this is the forge community wiki:
https://forge.gemwire.uk/wiki/Main_Page

read the docs, after that ask the remaining questions

  • Like 1
Posted (edited)
2 hours ago, Luis_ST said:

first of all do you know basic java?

this is the doc of forge:
https://mcforge.readthedocs.io/en/latest/

and this is the forge community wiki:
https://forge.gemwire.uk/wiki/Main_Page

read the docs, after that ask the remaining questions

1. Yes. I am also sufficiently familiar with OOP in general to understand the necessary concepts and to find, understand and reference code examples to implement specific functionality.

2. I've read it.

3. I hadn't seen this one before and it looks very useful, thank you!

 

There! I have done the things you asked. Now, on to my remaining questions. Are those the closest to library documentation that exist for making Forge mods? There is nothing out there that documents, for example, the IGrowable class, what methods it has, etc? Or that would allow you to find out that the IGrowable class exists to define growable plants in the first place?

These docs are very useful for general concepts, and the wiki has a good number of specifics listed in certain categories, but they're still quite general and not what I was asking about.

 

Just in case you're unfamiliar, library documentation is usually something like this (a small display library) or this (a game engine library). They describe the classes, methods, functions, modules, etc. that are available within the library, what parameters they take, and what they're used for. I've been trying to find something similar for Forge to no avail.

Edited by InspectorCaracal
additional info
Posted
25 minutes ago, InspectorCaracal said:

There! I have done the things you asked. Now, on to my remaining questions. Are those the closest to library documentation that exist for making Forge mods? There is nothing out there that documents, for example, the IGrowable class, what methods it has, etc? Or that would allow you to find out that the IGrowable class exists to define growable plants in the first place?

unfortunately most of the methods have no comments,
there are only a few ways to find out what a method does

  1. find out for yourself what the method does
  2. ask for help here in the forum or on the discord server
  3. simple logic e.g.: World#setBlock -> set the block to a position in the world
  4. look for a code example, for most things there are examples of vanilla else look in the www.
  5. testing...
38 minutes ago, InspectorCaracal said:

for example, the IGrowable class, what methods it has, etc? Or that would allow you to find out that the IGrowable class exists to define growable plants in the first place?

look at the interface / and the classes that implement it

Note: if you look in the vanilla classes, only methods and fields have 'correct names',

Posted
8 minutes ago, Luis_ST said:

unfortunately most of the methods have no comments,
there are only a few ways to find out what a method does

  1. find out for yourself what the method does
  2. ask for help here in the forum or on the discord server
  3. simple logic e.g.: World#setBlock -> set the block to a position in the world
  4. look for a code example, for most things there are examples of vanilla else look in the www.
  5. testing...

look at the interface / and the classes that implement it

Note: if you look in the vanilla classes, only methods and fields have 'correct names',

Okay, great! Well, great in the sense that this answers my question with "unfortunately it doesn't exist", oh nooo. xD

That all makes sense for figuring out how things work, but how do people go the other way - if you know the thing that happens, how do you find the method that controls it?

I'm specifically looking into campfires, beehives/nests and bees, and I've collected all the relevant information about tags, block states etc. that's available on the official Minecraft wiki, but I was hoping to get a look at how exactly those interact. Is trial and error really the only way?

Posted
51 minutes ago, InspectorCaracal said:

I'm specifically looking into campfires, beehives/nests and bees, and I've collected all the relevant information about tags, block states etc. that's available on the official Minecraft wiki, but I was hoping to get a look at how exactly those interact. Is trial and error really the only way?

I'd start by reading the beehive and the campfire methods... and looking for lines of code that handle the interaction.

for instance, does the campfire or the beehive have a tile entity? if so that logic could be handle in the tick method. if not it's probably done through random ticks, which is done in the tickRandomly (iirc) of the block.

the beehive was added in a later update, and the logic concerns it's state and doesn't affect the campfire, so I'd assume that it is handled somewhere in beehive related code.

reading through the vanilla classes is how to get around and understand, for the most part

Posted (edited)
3 hours ago, kiou.23 said:

I'd start by reading the beehive and the campfire methods... and looking for lines of code that handle the interaction.

for instance, does the campfire or the beehive have a tile entity? if so that logic could be handle in the tick method. if not it's probably done through random ticks, which is done in the tickRandomly (iirc) of the block.

the beehive was added in a later update, and the logic concerns it's state and doesn't affect the campfire, so I'd assume that it is handled somewhere in beehive related code.

reading through the vanilla classes is how to get around and understand, for the most part

Ohhh. Okay! I've been trying to find the vanilla code and also not been able to find anything about where it is, so it sounds like that's the root of my problem. Where is it?

(And yeah, my best guess is that the check is done on the hive itself, so that's where I wanted to look first.)

Edited by InspectorCaracal
Posted
2 hours ago, InspectorCaracal said:

Ohhh. Okay! I've been trying to find the vanilla code and also not been able to find anything about where it is, so it sounds like that's the root of my problem. Where is it?

(And yeah, my best guess is that the check is done on the hive itself, so that's where I wanted to look first.)

you can check the code using your IDE, it should have a code navigation feature, which allows you to read class definitions, method references, interface implementations and all that
I believe that in IntelliJ you can press double shift to search for files, and in there you can search for the source.

Posted
12 hours ago, kiou.23 said:

you can check the code using your IDE, it should have a code navigation feature, which allows you to read class definitions, method references, interface implementations and all that
I believe that in IntelliJ you can press double shift to search for files, and in there you can search for the source.

Ah, great! I only just finished setting all that up last night, I'll take a look through it today. You've been a huge help, thanks so much!

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Unfortunately, your content contains terms that we do not allow. Please edit your content to remove the highlighted words below.
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Announcements



  • Recently Browsing

    • No registered users viewing this page.
  • Posts

    • It is 1.12.2 - I have no idea if there is a 1.12 pack
    • Okay, but does the modpack works with 1.12 or just with 1.12.2, because I need the Forge client specifically for Minecraft 1.12, not 1.12.2
    • Version 1.19 - Forge 41.0.63 I want to create a wolf entity that I can ride, so far it seems to be working, but the problem is that when I get on the wolf, I can’t control it. I then discovered that the issue is that the server doesn’t detect that I’m riding the wolf, so I’m struggling with synchronization. However, it seems to not be working properly. As I understand it, the server receives the packet but doesn’t register it correctly. I’m a bit new to Java, and I’ll try to provide all the relevant code and prints *The comments and prints are translated by chatgpt since they were originally in Spanish* Thank you very much in advance No player is mounted, or the passenger is not a player. No player is mounted, or the passenger is not a player. No player is mounted, or the passenger is not a player. No player is mounted, or the passenger is not a player. No player is mounted, or the passenger is not a player. MountableWolfEntity package com.vals.valscraft.entity; import com.vals.valscraft.network.MountSyncPacket; import com.vals.valscraft.network.NetworkHandler; import net.minecraft.client.Minecraft; import net.minecraft.network.syncher.EntityDataAccessor; import net.minecraft.network.syncher.EntityDataSerializers; import net.minecraft.network.syncher.SynchedEntityData; import net.minecraft.server.MinecraftServer; import net.minecraft.server.level.ServerPlayer; import net.minecraft.world.entity.EntityType; import net.minecraft.world.entity.Mob; import net.minecraft.world.entity.ai.attributes.AttributeSupplier; import net.minecraft.world.entity.ai.attributes.Attributes; import net.minecraft.world.entity.animal.Wolf; import net.minecraft.world.entity.player.Player; import net.minecraft.world.entity.Entity; import net.minecraft.world.InteractionHand; import net.minecraft.world.InteractionResult; import net.minecraft.world.item.ItemStack; import net.minecraft.world.item.Items; import net.minecraft.world.level.Level; import net.minecraft.world.phys.Vec3; import net.minecraftforge.event.TickEvent; import net.minecraftforge.eventbus.api.SubscribeEvent; import net.minecraftforge.network.PacketDistributor; public class MountableWolfEntity extends Wolf { private boolean hasSaddle; private static final EntityDataAccessor<Byte> DATA_ID_FLAGS = SynchedEntityData.defineId(MountableWolfEntity.class, EntityDataSerializers.BYTE); public MountableWolfEntity(EntityType<? extends Wolf> type, Level level) { super(type, level); this.hasSaddle = false; } @Override protected void defineSynchedData() { super.defineSynchedData(); this.entityData.define(DATA_ID_FLAGS, (byte)0); } public static AttributeSupplier.Builder createAttributes() { return Wolf.createAttributes() .add(Attributes.MAX_HEALTH, 20.0) .add(Attributes.MOVEMENT_SPEED, 0.3); } @Override public InteractionResult mobInteract(Player player, InteractionHand hand) { ItemStack itemstack = player.getItemInHand(hand); if (itemstack.getItem() == Items.SADDLE && !this.hasSaddle()) { if (!player.isCreative()) { itemstack.shrink(1); } this.setSaddle(true); return InteractionResult.SUCCESS; } else if (!level.isClientSide && this.hasSaddle()) { player.startRiding(this); MountSyncPacket packet = new MountSyncPacket(true); // 'true' means the player is mounted NetworkHandler.CHANNEL.sendToServer(packet); // Ensure the server handles the packet return InteractionResult.SUCCESS; } return InteractionResult.PASS; } @Override public void travel(Vec3 travelVector) { if (this.isVehicle() && this.getControllingPassenger() instanceof Player) { System.out.println("The wolf has a passenger."); System.out.println("The passenger is a player."); Player player = (Player) this.getControllingPassenger(); // Ensure the player is the controller this.setYRot(player.getYRot()); this.yRotO = this.getYRot(); this.setXRot(player.getXRot() * 0.5F); this.setRot(this.getYRot(), this.getXRot()); this.yBodyRot = this.getYRot(); this.yHeadRot = this.yBodyRot; float forward = player.zza; float strafe = player.xxa; if (forward <= 0.0F) { forward *= 0.25F; } this.flyingSpeed = this.getSpeed() * 0.1F; this.setSpeed((float) this.getAttributeValue(Attributes.MOVEMENT_SPEED) * 1.5F); this.setDeltaMovement(new Vec3(strafe, travelVector.y, forward).scale(this.getSpeed())); this.calculateEntityAnimation(this, false); } else { // The wolf does not have a passenger or the passenger is not a player System.out.println("No player is mounted, or the passenger is not a player."); super.travel(travelVector); } } public boolean hasSaddle() { return this.hasSaddle; } public void setSaddle(boolean hasSaddle) { this.hasSaddle = hasSaddle; } @Override protected void dropEquipment() { super.dropEquipment(); if (this.hasSaddle()) { this.spawnAtLocation(Items.SADDLE); this.setSaddle(false); } } @SubscribeEvent public static void onServerTick(TickEvent.ServerTickEvent event) { if (event.phase == TickEvent.Phase.START) { MinecraftServer server = net.minecraftforge.server.ServerLifecycleHooks.getCurrentServer(); if (server != null) { for (ServerPlayer player : server.getPlayerList().getPlayers()) { if (player.isPassenger() && player.getVehicle() instanceof MountableWolfEntity) { MountableWolfEntity wolf = (MountableWolfEntity) player.getVehicle(); System.out.println("Tick: " + player.getName().getString() + " is correctly mounted on " + wolf); } } } } } private boolean lastMountedState = false; @Override public void tick() { super.tick(); if (!this.level.isClientSide) { // Only on the server boolean isMounted = this.isVehicle() && this.getControllingPassenger() instanceof Player; // Only print if the state changed if (isMounted != lastMountedState) { if (isMounted) { Player player = (Player) this.getControllingPassenger(); // Verify the passenger is a player System.out.println("Server: Player " + player.getName().getString() + " is now mounted."); } else { System.out.println("Server: The wolf no longer has a passenger."); } lastMountedState = isMounted; } } } @Override public void addPassenger(Entity passenger) { super.addPassenger(passenger); if (passenger instanceof Player) { Player player = (Player) passenger; if (!this.level.isClientSide && player instanceof ServerPlayer) { // Send the packet to the server to indicate the player is mounted NetworkHandler.CHANNEL.send(PacketDistributor.PLAYER.with(() -> (ServerPlayer) player), new MountSyncPacket(true)); } } } @Override public void removePassenger(Entity passenger) { super.removePassenger(passenger); if (passenger instanceof Player) { Player player = (Player) passenger; if (!this.level.isClientSide && player instanceof ServerPlayer) { // Send the packet to the server to indicate the player is no longer mounted NetworkHandler.CHANNEL.send(PacketDistributor.PLAYER.with(() -> (ServerPlayer) player), new MountSyncPacket(false)); } } } @Override public boolean isControlledByLocalInstance() { Entity entity = this.getControllingPassenger(); return entity instanceof Player; } @Override public void positionRider(Entity passenger) { if (this.hasPassenger(passenger)) { double xOffset = Math.cos(Math.toRadians(this.getYRot() + 90)) * 0.4; double zOffset = Math.sin(Math.toRadians(this.getYRot() + 90)) * 0.4; passenger.setPos(this.getX() + xOffset, this.getY() + this.getPassengersRidingOffset() + passenger.getMyRidingOffset(), this.getZ() + zOffset); } } } MountSyncPacket package com.vals.valscraft.network; import com.vals.valscraft.entity.MountableWolfEntity; import net.minecraft.network.FriendlyByteBuf; import net.minecraft.server.level.ServerLevel; import net.minecraft.server.level.ServerPlayer; import net.minecraft.world.entity.Entity; import net.minecraft.world.entity.player.Player; import net.minecraftforge.network.NetworkEvent; import java.util.function.Supplier; public class MountSyncPacket { private final boolean isMounted; public MountSyncPacket(boolean isMounted) { this.isMounted = isMounted; } public void encode(FriendlyByteBuf buffer) { buffer.writeBoolean(isMounted); } public static MountSyncPacket decode(FriendlyByteBuf buffer) { return new MountSyncPacket(buffer.readBoolean()); } public void handle(NetworkEvent.Context context) { context.enqueueWork(() -> { ServerPlayer player = context.getSender(); // Get the player from the context if (player != null) { // Verifies if the player has dismounted if (!isMounted) { Entity vehicle = player.getVehicle(); if (vehicle instanceof MountableWolfEntity wolf) { // Logic to remove the player as a passenger wolf.removePassenger(player); System.out.println("Server: Player " + player.getName().getString() + " is no longer mounted."); } } } }); context.setPacketHandled(true); // Marks the packet as handled } } networkHandler package com.vals.valscraft.network; import com.vals.valscraft.valscraft; import net.minecraft.resources.ResourceLocation; import net.minecraftforge.network.NetworkRegistry; import net.minecraftforge.network.simple.SimpleChannel; import net.minecraftforge.network.NetworkEvent; import java.util.function.Supplier; public class NetworkHandler { private static final String PROTOCOL_VERSION = "1"; public static final SimpleChannel CHANNEL = NetworkRegistry.newSimpleChannel( new ResourceLocation(valscraft.MODID, "main"), () -> PROTOCOL_VERSION, PROTOCOL_VERSION::equals, PROTOCOL_VERSION::equals ); public static void init() { int packetId = 0; // Register the mount synchronization packet CHANNEL.registerMessage( packetId++, MountSyncPacket.class, MountSyncPacket::encode, MountSyncPacket::decode, (msg, context) -> msg.handle(context.get()) // Get the context with context.get() ); } }  
    • Do you use features of inventory profiles next (ipnext) or is there a change without it?
  • Topics

×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.