Jump to content

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


InspectorCaracal

Recommended Posts

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
Link to comment
Share on other sites

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
Link to comment
Share on other sites

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
Link to comment
Share on other sites

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',

Link to comment
Share on other sites

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?

Link to comment
Share on other sites

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

Link to comment
Share on other sites

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
Link to comment
Share on other sites

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.

Link to comment
Share on other sites

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!

Link to comment
Share on other sites

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.



  • Recently Browsing

    • No registered users viewing this page.
  • Posts

    • Hello There! In the 171st episode of Hunger Games we are for once not the most wanted men in this match however after this I feel like we have officially became enemies with them if we haven't already.  
    • crashed with a empty report i tried again and [18jun.2024 04:38:56.251] [main/INFO] [cpw.mods.modlauncher.Launcher/MODLAUNCHER]: ModLauncher running: args [--username, 42crowley, --version, 1.20.1-forge-47.3.1, --gameDir, C:\Users\********\curseforge\minecraft\Instances\Mine dos cria, --assetsDir, C:\Users\********\AppData\Roaming\.minecraft\assets, --assetIndex, 5, --uuid, b917df67f6ce3ca4ac9b4e438faa1f85, --accessToken, ????????, --clientId, 0, --xuid, 0, --userType, msa, --versionType, release, --width, 854, --height, 480, --launchTarget, forgeclient, --fml.forgeVersion, 47.3.1, --fml.mcVersion, 1.20.1, --fml.forgeGroup, net.minecraftforge, --fml.mcpVersion, 20230612.114412] 2[18jun.2024 04:38:56.263] [main/INFO] [cpw.mods.modlauncher.Launcher/MODLAUNCHER]: ModLauncher 10.0.9 10.0.9 main.dcd20f30 starting: java version 17.0.8 by Microsoft; OS Windows 11 arch amd64 version 10.0 3[18jun.2024 04:38:57.587] [main/INFO] [net.minecraftforge.fml.loading.ImmediateWindowHandler/]: Loading ImmediateWindowProvider fmlearlywindow 4[18jun.2024 04:38:57.967] [main/INFO] [EARLYDISPLAY/]: Trying GL version 4.6 5[18jun.2024 04:38:58.046] [main/INFO] [EARLYDISPLAY/]: Requested GL version 4.6 got version 4.6 6[18jun.2024 04:38:58.464] [main/INFO] [mixin/]: SpongePowered MIXIN Subsystem Version=0.8.5 Source=union:/C:/Users/********/AppData/Roaming/.minecraft/libraries/org/spongepowered/mixin/0.8.5/mixin-0.8.5.jar#100!/ Service=ModLauncher Env=CLIENT 7[18jun.2024 04:38:58.680] [pool-4-thread-1/INFO] [EARLYDISPLAY/]: GL info: Intel(R) UHD Graphics GL version 4.6.0 - Build 30.0.101.2079, Intel 8[18jun.2024 04:38:59.401] [main/WARN] [net.minecraftforge.fml.loading.moddiscovery.ModFileParser/LOADING]: Mod file C:\Users\********\AppData\Roaming\.minecraft\libraries\net\minecraftforge\fmlcore\1.20.1-47.3.1\fmlcore-1.20.1-47.3.1.jar is missing mods.toml file 9[18jun.2024 04:38:59.407] [main/WARN] [net.minecraftforge.fml.loading.moddiscovery.ModFileParser/LOADING]: Mod file C:\Users\********\AppData\Roaming\.minecraft\libraries\net\minecraftforge\javafmllanguage\1.20.1-47.3.1\javafmllanguage-1.20.1-47.3.1.jar is missing mods.toml file 10[18jun.2024 04:38:59.412] [main/WARN] [net.minecraftforge.fml.loading.moddiscovery.ModFileParser/LOADING]: Mod file C:\Users\********\AppData\Roaming\.minecraft\libraries\net\minecraftforge\lowcodelanguage\1.20.1-47.3.1\lowcodelanguage-1.20.1-47.3.1.jar is missing mods.toml file 11[18jun.2024 04:38:59.418] [main/WARN] [net.minecraftforge.fml.loading.moddiscovery.ModFileParser/LOADING]: Mod file C:\Users\********\AppData\Roaming\.minecraft\libraries\net\minecraftforge\mclanguage\1.20.1-47.3.1\mclanguage-1.20.1-47.3.1.jar is missing mods.toml file 12[18jun.2024 04:39:00.142] [main/WARN] [net.minecraftforge.jarjar.selection.JarSelector/]: Attempted to select two dependency jars from JarJar which have the same identification: Mod File: and Mod File: . Using Mod File: 13[18jun.2024 04:39:00.144] [main/WARN] [net.minecraftforge.jarjar.selection.JarSelector/]: Attempted to select a dependency jar for JarJar which was passed in as source: curios. Using Mod File: C:\Users\********\curseforge\minecraft\Instances\Mine dos cria\mods\curios-forge-5.9.1 1.20.1.jar 14[18jun.2024 04:39:00.145] [main/INFO] [net.minecraftforge.fml.loading.moddiscovery.JarInJarDependencyLocator/]: Found 20 dependencies adding them to mods collection 15[18jun.2024 04:39:05.971] [main/INFO] [mixin/]: Compatibility level set to JAVA_17 16[18jun.2024 04:39:06.966] [main/INFO] [mixin/]: Successfully loaded Mixin Connector [com.sonicether.soundphysics.MixinConnector] 17[18jun.2024 04:39:06.972] [main/INFO] [cpw.mods.modlauncher.LaunchServiceHandler/MODLAUNCHER]: Launching target 'forgeclient' with arguments [--version, 1.20.1-forge-47.3.1, --gameDir, C:\Users\********\curseforge\minecraft\Instances\Mine dos cria, --assetsDir, C:\Users\********\AppData\Roaming\.minecraft\assets, --uuid, b917df67f6ce3ca4ac9b4e438faa1f85, --username, 42crowley, --assetIndex, 5, --accessToken, ????????, --clientId, 0, --xuid, 0, --userType, msa, --versionType, release, --width, 854, --height, 480] 18[18jun.2024 04:39:07.007] [main/WARN] [mixin/]: Reference map 'createdeco-forge-refmap.json' for createdeco.mixins.json could not be read. If this is a development environment you can ignore this message 19[18jun.2024 04:39:07.192] [main/INFO] [ModernFix/]: Loaded configuration file for ModernFix 5.17.0 mc1.20.1: 78 options available, 0 override(s) found 20[18jun.2024 04:39:07.194] [main/INFO] [ModernFix/]: Applying Nashorn fix 21[18jun.2024 04:39:07.223] [main/INFO] [ModernFix/]: Applied Forge config corruption patch 22[18jun.2024 04:39:07.413] [main/WARN] [mixin/]: Reference map 'interiors-forge-refmap.json' for interiors.mixins.json could not be read. If this is a development environment you can ignore this message 23[18jun.2024 04:39:07.477] [main/INFO] [Embeddium/]: Loaded configuration file for Embeddium: 132 options available, 3 override(s) found 24[18jun.2024 04:39:07.480] [main/INFO] [Embeddium-GraphicsAdapterProbe/]: Searching for graphics cards... 25[18jun.2024 04:39:08.097] [main/INFO] [Embeddium-GraphicsAdapterProbe/]: Found graphics card: GraphicsAdapterInfo[vendor=INTEL, name=Intel(R) UHD Graphics, version=DriverVersion=30.0.101.2079] 26[18jun.2024 04:39:08.194] [main/WARN] [mixin/]: Reference map 'yungsextras.refmap.json' for yungsextras.mixins.json could not be read. If this is a development environment you can ignore this message 27[18jun.2024 04:39:08.197] [main/WARN] [mixin/]: Reference map 'yungsextras.refmap.json' for yungsextras_forge.mixins.json could not be read. If this is a development environment you can ignore this message 28[18jun.2024 04:39:08.234] [main/WARN] [mixin/]: Reference map 'nitrogen_internals.refmap.json' for nitrogen_internals.mixins.json could not be read. If this is a development environment you can ignore this message 29[18jun.2024 04:39:08.259] [main/WARN] [mixin/]: Reference map 'octolib.refmap.json' for octolib.mixins.json could not be read. If this is a development environment you can ignore this message 30[18jun.2024 04:39:08.384] [main/WARN] [mixin/]: Reference map 'mes-forge-refmap.json' for mes-forge.mixins.json could not be read. If this is a development environment you can ignore this message 31[18jun.2024 04:39:11.680] [main/WARN] [mixin/]: Error loading class: dev/latvian/mods/kubejs/recipe/RecipesEventJS (java.lang.ClassNotFoundException: dev.latvian.mods.kubejs.recipe.RecipesEventJS) 32[18jun.2024 04:39:11.685] [main/WARN] [mixin/]: @Mixin target dev.latvian.mods.kubejs.recipe.RecipesEventJS was not found sliceanddice.mixins.json:RecipeEventJSMixin 33[18jun.2024 04:39:12.476] [main/WARN] [mixin/]: Error loading class: earth/terrarium/botarium/forge/BotariumForge (java.lang.ClassNotFoundException: earth.terrarium.botarium.forge.BotariumForge) 34[18jun.2024 04:39:12.477] [main/WARN] [mixin/]: @Mixin target earth.terrarium.botarium.forge.BotariumForge was not found create_central_kitchen.mixins.json:common.botarium.BotariumForgeMixin 35[18jun.2024 04:39:12.481] [main/WARN] [mixin/]: Error loading class: dan200/computercraft/shared/integration/MoreRedIntegration (java.lang.ClassNotFoundException: dan200.computercraft.shared.integration.MoreRedIntegration) 36[18jun.2024 04:39:12.482] [main/WARN] [mixin/]: @Mixin target dan200.computercraft.shared.integration.MoreRedIntegration was not found create_central_kitchen.mixins.json:common.computercraft.MoreRedIntegrationMixin 37[18jun.2024 04:39:12.739] [main/WARN] [mixin/]: Error loading class: com/sammy/minersdelight/content/block/copper_pot/CopperPotBlockEntity (java.lang.ClassNotFoundException: com.sammy.minersdelight.content.block.copper_pot.CopperPotBlockEntity) 38[18jun.2024 04:39:12.739] [main/WARN] [mixin/]: @Mixin target com.sammy.minersdelight.content.block.copper_pot.CopperPotBlockEntity was not found create_central_kitchen.mixins.json:common.minersdelight.CopperPotBlockEntityMixin 39[18jun.2024 04:39:12.742] [main/WARN] [mixin/]: Error loading class: com/sammy/minersdelight/content/block/sticky_basket/StickyBasketBlockEntity (java.lang.ClassNotFoundException: com.sammy.minersdelight.content.block.sticky_basket.StickyBasketBlockEntity) 40[18jun.2024 04:39:12.742] [main/WARN] [mixin/]: @Mixin target com.sammy.minersdelight.content.block.sticky_basket.StickyBasketBlockEntity was not found create_central_kitchen.mixins.json:common.minersdelight.StickyBasketBlockEntityAccessor 41[18jun.2024 04:39:12.745] [main/WARN] [mixin/]: Error loading class: com/sammy/minersdelight/content/block/sticky_basket/StickyBasketBlockEntity (java.lang.ClassNotFoundException: com.sammy.minersdelight.content.block.sticky_basket.StickyBasketBlockEntity) 42[18jun.2024 04:39:12.745] [main/WARN] [mixin/]: @Mixin target com.sammy.minersdelight.content.block.sticky_basket.StickyBasketBlockEntity was not found create_central_kitchen.mixins.json:common.minersdelight.StickyBasketBlockEntityMixin 43[18jun.2024 04:39:12.749] [main/WARN] [mixin/]: Error loading class: net/orcinus/overweightfarming/blocks/CropFullBlock (java.lang.ClassNotFoundException: net.orcinus.overweightfarming.blocks.CropFullBlock) 44[18jun.2024 04:39:12.749] [main/WARN] [mixin/]: @Mixin target net.orcinus.overweightfarming.blocks.CropFullBlock was not found create_central_kitchen.mixins.json:common.overweightfarming.CropFullBlockMixin 45[18jun.2024 04:39:13.708] [main/WARN] [Embeddium/]: Force-disabling mixin 'features.render.world.sky.WorldRendererMixin' as rule 'mixin.features.render.world.sky' (added by mods [oculus]) disables it and children 46[18jun.2024 04:39:13.710] [main/WARN] [Embeddium/]: Force-disabling mixin 'features.render.world.sky.ClientWorldMixin' as rule 'mixin.features.render.world.sky' (added by mods [oculus]) disables it and children 47[18jun.2024 04:39:13.711] [main/WARN] [Embeddium/]: Force-disabling mixin 'features.render.world.sky.BackgroundRendererMixin' as rule 'mixin.features.render.world.sky' (added by mods [oculus]) disables it and children 48[18jun.2024 04:39:13.719] [main/WARN] [Embeddium/]: Force-disabling mixin 'features.render.gui.font.GlyphRendererMixin' as rule 'mixin.features.render.gui.font' (added by mods [oculus]) disables it and children 49[18jun.2024 04:39:13.720] [main/WARN] [Embeddium/]: Force-disabling mixin 'features.render.gui.font.FontSetMixin' as rule 'mixin.features.render.gui.font' (added by mods [oculus]) disables it and children 50[18jun.2024 04:39:13.722] [main/WARN] [Embeddium/]: Force-disabling mixin 'features.render.entity.shadows.EntityRenderDispatcherMixin' as rule 'mixin.features.render.entity' (added by mods [oculus]) disables it and children 51[18jun.2024 04:39:13.724] [main/WARN] [Embeddium/]: Force-disabling mixin 'features.render.entity.fast_render.ModelPartMixin' as rule 'mixin.features.render.entity' (added by mods [oculus]) disables it and children 52[18jun.2024 04:39:13.726] [main/WARN] [Embeddium/]: Force-disabling mixin 'features.render.entity.fast_render.CuboidMixin' as rule 'mixin.features.render.entity' (added by mods [oculus]) disables it and children 53[18jun.2024 04:39:13.729] [main/WARN] [Embeddium/]: Force-disabling mixin 'features.render.entity.cull.EntityRendererMixin' as rule 'mixin.features.render.entity' (added by mods [oculus]) disables it and children 54[18jun.2024 04:39:15.111] [main/INFO] [MixinExtras|Service/]: Initializing MixinExtras via com.llamalad7.mixinextras.service.MixinExtrasServiceImpl(version=0.3.6). 55[18jun.2024 04:39:18.941] [pool-6-thread-1/INFO] [net.minecraft.server.Bootstrap/]: ModernFix reached bootstrap stage (29.23 s after launch) 56[18jun.2024 04:39:19.116] [pool-6-thread-1/WARN] [mixin/]: @Final field delegatesByName:Ljava/util/Map; in modernfix-forge.mixins.json:perf.forge_registry_alloc.ForgeRegistryMixin should be final 57[18jun.2024 04:39:19.116] [pool-6-thread-1/WARN] [mixin/]: @Final field delegatesByValue:Ljava/util/Map; in modernfix-forge.mixins.json:perf.forge_registry_alloc.ForgeRegistryMixin should be final [18jun.2024 04:39:21.577] [pool-6-thread-1/INFO] [net.minecraft.server.Bootstrap/]: Vanilla bootstrap took 2632 milliseconds
  • Topics

×
×
  • Create New...

Important Information

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