Forge Community Wiki - User contributions [en-gb]

Main Page

2022-10-06T16:25:58Z

Tmvkrpxl0: Adding Hotswap to Other entries

__NOTOC__
<templatestyles src=":Main_Page/styles.css" />

<div class="center title">Forge Community Wiki</div>

The Forge Community Wiki exists so that the community can:

* collectively keep track of major changes and updates to Forge and Vanilla code;
* create and edit articles with in-depth explanations about a variety of Forge-related subjects; and
* contribute example code and tutorials for both simple and difficult concepts.

This wiki is editable by any registered user with an account. This is to allow tracking of harmful edits, but isn't imposing any annoying limits. We welcome any edit, however small. Join the [https://discord.gg/Nn42eAh Discord] to discuss changes and edits to the wiki with others and the staff.

{{Supported versions}}

<div class="center round_warning">
Please read the [[FCWMeta:Wiki Policy|wiki policy]] before editing!
</div>

<div class="center" style="margin-bottom: 2em">
{{Supported versions|text=1}}
</div>

<div class="box_container center">

<div class="box">
<h3>Beginner Topics</h3>
* [[Getting Started]]
* [[Proper Mod Structuring]]
* [[Mods.toml file]]
* [[Debug Profiler|The Debug Profiler]]
* [[Version Checker]]
</div>

<div class="box">
<h3>Advanced Topics</h3>
* [[Jar-in-jar]]
</div>

<div class="box">
<h3>Common Concepts</h3>
* [[Sides|Understanding Sides]]
* [[Events|Understanding Events]]
* [[Registration]]
* [[Internationalization]]
* [[Configs]]
</div>

<div class="box">
<h3>Forge Conventions</h3>
* [[Semantic Versioning]]
* [[Stages of Modloading]]
</div>

<div class="box">
<h3>Resources and Data</h3>
* [[Using Resources|Introduction]]
* [[Recipes]]
* [[Tags]]
* [[Holders]]
</div>

<div class="box">
<h3>Blocks</h3>
* [[Making Blocks|Creating Blocks]]
* [[Understanding Blockstates]]
* [[Interacting With Blocks|Block Interactions]]
</div>

<div class="box">
<h3>Items</h3>
* [[Making Items]]
* [[Making Tools]]
* [[BlockEntityWithoutLevelRenderer|<tt>BlockEntityWithoutLevelRenderer</tt>]]
* [[Custom Item Animations]]
</div>

<div class="box">
<h3>Entities</h3>
* [[Making Entities]]
</div>

<div class="box">
<h3>Data Generation</h3>
* [[Datageneration|Introduction]]
* [[Datageneration/Recipes|Recipes]]
* [[Datageneration/Tags|Tags]]
* [[Datageneration/Loot_Tables|Loot Tables]]
* [[Datageneration/I18n|Localization]]
* [[Datageneration/States and Models|<tt>BlockState</tt>s and Models]]
</div>

<div class="box">
<h3>Block Entities</h3>
* [[Block Entities|Introduction]]
* [[Block Entity Renderer|<tt>BlockEntityRenderer</tt>]]
</div>

<div class="box">
<h3>Models</h3>
* [[Introduction to Models|Introduction]]
* [[Model JSONs]]
* [[BlockState JSONs]]
* [[Coloring textures dynamically|Dynamically Colored Textures]]
* [[Item Properties]]
</div>

<div class="box">
<h3>Handling Information</h3>
* [[Understanding Networking|Introduction]]
* [[Using NBT|Named Binary Tag (NBT)]]
* [[Using FriendlyByteBuf|Using <tt>FriendlyByteBuf</tt>]]
* [[Sending Packets|Sending and Receiving Packets]]
* [[Using SimpleChannel|Using <tt>SimpleChannel</tt>]]
* [[Networking with Entities]]
* [[DynamicOps|Using DynamicOps]]
* [[Codecs|Using Codecs]]
</div>

<div class="box">
<h3>Data Storage</h3>
* [[Capabilities|Understanding Capabilities]]
* [[Capabilities/Attaching|Attaching Capabilities]]
* [[Saved Data]]
</div>

<div class="box">
<h3>Game Effects</h3>
* [[Mob Effects]]
* [[Potions]]
* [[Particles]]
* [[Sounds]]
</div>

<div class="box">
<h3>Events</h3>
* [[Events|Understanding Events]]
* [[Entity Events]]
</div>

<div class="box">
<h3>Others</h3>
* [[Dependencies]]
* [[Dynamic Loot Modification]]
* [[Components|Components and Translation Keys]]
* [[Key Mappings]]
* [[Access Transformers]]
* [[Toolchain]]
* [[Game_Tests|Game Tests]]
* [[Biome_Modifiers|Biome Modifiers]]
* [[Datapack_Registries|Datapack Registries]]
* [[Hotswap]]
</div>

<div class="box">
<h3>Recipes</h3>
* [[Recipes]]
* [[Custom Recipes|Custom Recipe Types]]
* [[Datageneration/Recipes|Datageneration]]
</div>

</div>

Hotswap

2022-10-06T16:14:01Z

Tmvkrpxl0:

{{Under construction}} 
== What is Hot-swapping? ==
Hot-swapping is a feature letting you to swap-out code of your mod without restarting game, allowing you to see changes quickly and tinker around with it more easily.

In this article, we will also be covering how to swap resources so that you can change models and textures, and see it in-game quickly.

== Swapping resources ==
=== Swapping resources on Intellij Idea ===
After you made changes to resource file, hit this "hammer icon", or build button.
[[File:Intellij_idea_menu_for_hot_swap_doc.png]]
After that, hit F3+T if resources you changed are assets. It's a shortcut-key for reloading assets.
If they're data pack, use /datapack command to disable and then re-enable data pack of your mod.

== Hot-swapping code ==
You can also swap out code if only method's internal has been changed. You would still need to restart game if you added/removed/renamed method/variable/class. This change is called "schema change", and guide for applying schema change is in below section.

Ensure that you are running the game on debug mode in IDE. It is usually indicated by green bug-shaped icon.
[[File:Debugmodeintellij.png]]
=== Hot-swapping code on Intellij Idea ===
It's more simple than swapping out resources. After making changes to the code, just hit the build button. Then It will show you this message on bottom-left corner. If your mod project is big and it takes a long time to do so, hit <code>Build -> Recompile "currently opened file's name"</code>, this will only recompile file that is currently open. This option will not be visible if you don't have compile-able file opened. Files with extensions such as <code>.java</code> or <code>.kt</code> are compile-able.
[[File:Hotswapmessage.png]]
If you changed class's schematics then will show you error messages saying it is unsupported. Head to Applying schema changes section if you need to change schematics.

=== Applying schema changes ===
This requires more setup and specific JDK, Jetbrains Runtime (JBR).
But it will greatly accelerate development process and make tinkering easier by allowing you to:
* Create/Remove classes
* Add/Rename/Remove variables/methods
* Change value of final constants
All without restarting the game.

The reason why JBR is suggested over other JDKs is that it has [https://dcevm.github.io/ DCEVM](It allows class schema change in debug mode) by default and requires less configuration, such as hot-swap agent and IDE-specific plugins, etc. Although, there isn't exactly "installer" for it, you would have to download and unpack it manually.

==== Downloading JBR ====
Download JBR with right java version and platform from here: https://github.com/JetBrains/JetBrainsRuntime/releases
There are many different "flavors" but I recommend you downloading "JBR (vanilla)" one if you don't know what these are.
After downloading has finished unpack it into suitable location

==== Adding JDK to IDE ====
===== Adding JDK to Intellij Idea =====
Go to File -> Project Structure -> Project -> SDK -> Add JDK
and then select directory you've unpacked JBR into.
After that, It is recommended to choose JBR as project SDK if you're not familiar with gradle and Intellij's run configs
[[File:Addjdk.png]]

==== Changing run configuration ====
Open build.gradle file and then add <code>jvmArg "-XX:+AllowEnhancedClassRedefinition"</code> to desired run configuration. below is example for adding it into <code>runClient</code>
<syntaxhighlight lang="groovy">
runs {
client {
workingDirectory project.file('run')
jvmArg "-XX:+AllowEnhancedClassRedefinition"
property 'forge.logging.markers', 'REGISTRIES'
property 'forge.logging.console.level', 'debug'
property 'forge.enabledGameTestNamespaces', 'examplemod'
mods {
examplemod {
source sourceSets.main
}
}
}
}
</syntaxhighlight>

==== Final step ====
===== Final configuration for Intellij Idea =====
Go to <code>File -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle</code>, and use Intellij Idea for running and building and testing
[[File:Gradleintellij.png]]

Then re-generate run configurations by running <code>genIntellijRuns</code>

Done! Now launch one of these on debug mode and you can now change classes' schematic as much as you want, and then hit build button. it will swap those just fine.
[[File:Runconfigs.png]]

Hotswap

2022-10-06T15:36:07Z

Tmvkrpxl0:

{{Under construction}} 
== What is Hot-swapping? ==
Hot-swapping is a feature letting you to swap-out parts of game without restarting it, allowing you to see resources and code changes quickly and tinker around with it more easily.

{{Tip|It is recommended that you run the game with debug mode in order to use hot-swapping, as code changes will only get applied under debug mode.}}

== Hot-swapping resources ==
=== Hot-swapping resources on Intellij Idea ===
After you made changes to resource file, hit this "hammer icon", or build button.
[[File:Intellij_idea_menu_for_hot_swap_doc.png]]
After that, hit F3+T if resources you changed are assets. It's a shortcut-key for reloading assets.
If they're data pack, use /datapack command to disable and then re-enable data pack of your mod.

== Hot-swapping code ==
You can also swap out code if only method's internal has been changed. You would still need to restart game if you added/removed/renamed method/variable/class. This change is called "schema change", and guide for applying schema change is in below section.

Ensure that you are running the game on debug mode in IDE. It is usually indicated by green bug-shaped icon.
[[File:Debugmodeintellij.png]]
=== Hot-swapping code on Intellij Idea ===
It's more simple than hot-swapping resources. After making changes to the code, just hit the build button. Then It will show you this message on bottom-left corner. If your mod project is big and it takes a long time to do so, hit <code>Build -> Recompile "currently opened file's name"</code>, this will only recompile file that is currently open. This option will not be visible if you don't have compile-able file opened. Files with extensions such as <code>.java</code> or <code>.kt</code> are compile-able.
[[File:Hotswapmessage.png]]
If you changed class's schematics then will show you error messages saying it is unsupported. Head to Applying schema changes section if you need to change schematics.

=== Applying schema changes ===
This requires more setup and specific find of JDK, Jetbrains Runtime (JBR). The reason why JBR is suggested is that it has [https://dcevm.github.io/ DCEVM](It allows class schema change in debug mode) by default and requires less configuration than other JDKs, such as hot-swap agent and IDE-specific plugins, etc. Although, there isn't exactly "installer" for it, you would have to download and unpack it manually.

==== Downloading JBR ====
Download JBR with right java version and platform from here: https://github.com/JetBrains/JetBrainsRuntime/releases
There are many different "flavors" but I recommend you downloading "JBR (vanilla)" one if you don't know what are these.
After downloading has finished unpack it into suitable location

==== Adding JDK to IDE ====
===== Adding JDK to Intellij Idea =====
Go to File -> Project Structure -> Project -> SDK -> Add JDK
and then select directory you've unpacked JBR into.
After that, It is recommended to choose JBR as project SDK if you're not familiar with gradle and Intellij's run configs
[[File:Addjdk.png]]

==== Changing run configuration ====
Open build.gradle file and then add <code>jvmArg "-XX:+AllowEnhancedClassRedefinition"</code> to desired run configuration. below is example for adding it into <code>runClient</code>
<syntaxhighlight lang="groovy">
runs {
client {
workingDirectory project.file('run')
jvmArg "-XX:+AllowEnhancedClassRedefinition"
property 'forge.logging.markers', 'REGISTRIES'
property 'forge.logging.console.level', 'debug'
property 'forge.enabledGameTestNamespaces', 'examplemod'
mods {
examplemod {
source sourceSets.main
}
}
}
}
</syntaxhighlight>

==== Final step ====
===== Final configuration for Intellij Idea =====
Go to <code>File -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle</code>, and use Intellij Idea for running and building and testing
[[File:Gradleintellij.png]]

Then re-generate run configurations by running <code>genIntellijRuns</code>

Done! Now launch one of these on debug mode and you can now change classes' schematic as much as you want, it will swap those just fine.
[[File:Runconfigs.png]]

Hotswap

2022-10-06T15:18:01Z

Tmvkrpxl0:

{{Under construction}} 
== What is Hot-swapping? ==
Hot-swapping is a feature letting you to see code/resource changes in-game without restarting it.

{{Tip|It is recommended that you run the game with debug mode in order to use hot-swapping, as code changes will only get applied under debug mode.}}

== Hot-swapping resources ==
=== Hot-swapping resources on Intellij Idea ===
After you made changes to resource file, hit this "hammer icon", or build button.
[[File:Intellij_idea_menu_for_hot_swap_doc.png]]
After that, hit F3+T if resources you changed are assets. It's a shortcut-key for reloading assets.
If they're data pack, use /datapack command to disable and then re-enable data pack of your mod.

== Hot-swapping code ==
You can also swap out code if only method's internal has been changed. You would still need to restart game if you added/removed/renamed method/variable/class. This change is called "schema change", and guide for applying schema change is in below section.

Ensure that you are running the game on debug mode in IDE. It is usually indicated by green bug-shaped icon.
[[File:Debugmodeintellij.png]]
=== Hot-swapping code on Intellij Idea ===
It's more simple then hot-swapping resources. After making changes to the code, just hit the build button. Then It will show you this message on bottom-left corner. If your mod project is big and it takes a long time to do so, hit <code>Build -> Recompile "currently opened file's name"</code>, this will only recompile file that is currently open. This option will not be visible if you don't have compile-able file opened. Files with extensions such as <code>.java</code> or <code>.kt</code> are compile-able.
[[File:Hotswapmessage.png]]
If you changed class's schematics then will show you error messages saying it is unsupported. Head to Applying schema changes section if you need to change schematics.

=== Applying schema changes ===
This requires more setup and specific find of JDK.

==== Downloading JBR ====
Download Jetbrain runtime(JBR) with right java version and platform from here: https://github.com/JetBrains/JetBrainsRuntime/releases
There are many different "flavors" but I recommend you downloading "JBR (vanilla)" one if you don't know what are these.
After downloading has finished unpack it into suitable location

==== Adding JDK to IDE ====
===== Adding JDK to Intellij Idea =====
Go to File -> Project Structure -> Project -> SDK -> Add JDK
and then select directory you've unpacked JBR into.
After that, It is recommended to choose JBR as project SDK if you're not familiar with gradle and Intellij's run configs
[[File:Addjdk.png]]

==== Changing run configuration ====
Open build.gradle file and then add <code>jvmArg "-XX:+AllowEnhancedClassRedefinition"</code> to desired run configuration. below is example for adding it into <code>runClient</code>
<syntaxhighlight lang="groovy">
runs {
client {
workingDirectory project.file('run')
jvmArg "-XX:+AllowEnhancedClassRedefinition"
property 'forge.logging.markers', 'REGISTRIES'
property 'forge.logging.console.level', 'debug'
property 'forge.enabledGameTestNamespaces', 'examplemod'
mods {
examplemod {
source sourceSets.main
}
}
}
}
</syntaxhighlight>

==== Final step ====
===== Final configuration for Intellij Idea =====
Go to <code>File -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle</code>, and use Intellij Idea for running and building and testing
[[File:Gradleintellij.png]]

Then re-generate run configurations by running <code>genIntellijRuns</code>

Done! Now launch one of these on debug mode and you can now change classes' schematic as much as you want, it will swap those just fine.
[[File:Runconfigs.png]]

File:Runconfigs.png

2022-10-06T14:58:09Z

Tmvkrpxl0: Image listing run configs

== Summary ==
Image listing run configs

File:Gradleintellij.png

2022-10-06T14:27:12Z

Tmvkrpxl0: Image describing how to use Intellij instead of gradle to running the game.

== Summary ==
Image describing how to use Intellij instead of gradle to running the game.

File:Addjdk.png

2022-10-06T14:13:51Z

Tmvkrpxl0: Image describing how to add new jdk

== Summary ==
Image describing how to add new jdk

File:Hotswapmessage.png

2022-10-06T13:53:26Z

Tmvkrpxl0: Image describing what message is displayed after hotswap.

== Summary ==
Image describing what message is displayed after hotswap.

File:Debugmodeintellij.png

2022-10-06T13:49:35Z

Tmvkrpxl0: Image describing indicator of debug mode.

== Summary ==
Image describing indicator of debug mode.

File:Intellij idea menu for hot swap doc.png

2022-10-06T13:42:27Z

Tmvkrpxl0: Image describing which button is the build button

== Summary ==
Image describing which button is the build button

Hotswap

2022-10-06T13:32:41Z

Tmvkrpxl0: Guide about hot-swapping both code and resources

== What even is this? ==
Hot-swapping is a feature letting you to see code/resource changes in-game without restarting it.
This article is divided into 2 sections: Basic hot-swapping and schema change hot-swapping, as latter one requires more setup.

== Basic hot-swapping ==
Here, you would be able to swap out resource pack/data pack of your mod without restarting the game. You can also swap out code if only method's internal has been changed. You would still need to restart game if you added/removed/renamed method/variable/class.

Main Page

2022-09-04T14:20:30Z

Tmvkrpxl0:

__NOTOC__
<templatestyles src=":Main_Page/styles.css" />

<div class="center title">Forge Community Wiki</div>

The Forge Community Wiki exists so that the community can:

* collectively keep track of major changes and updates to Forge and Vanilla code;
* create and edit articles with in-depth explanations about a variety of Forge-related subjects; and
* contribute example code and tutorials for both simple and difficult concepts.

This wiki is editable by any registered user with an account. This is to allow tracking of harmful edits, but isn't imposing any annoying limits. We welcome any edit, however small. Join the [https://discord.gg/Nn42eAh Discord] to discuss changes and edits to the wiki with others and the staff.

{{Supported versions}}

<div class="center round_warning">
Please read the [[FCWMeta:Wiki Policy|wiki policy]] before editing!
</div>

<div class="center" style="margin-bottom: 2em">
{{Supported versions|text=1}}
</div>

<div class="box_container center">

<div class="box">
<h3>Beginner Topics</h3>
* [[Getting Started]]
* [[Proper Mod Structuring]]
* [[Mods.toml file]]
* [[Debug Profiler|The Debug Profiler]]
* [[Version Checker]]
</div>

<div class="box">
<h3>Advanced Topics</h3>
* [[Jar-in-jar]]
</div>

<div class="box">
<h3>Common Concepts</h3>
* [[Sides|Understanding Sides]]
* [[Events|Understanding Events]]
* [[Registration]]
* [[Internationalization]]
* [[Configs]]
</div>

<div class="box">
<h3>Forge Conventions</h3>
* [[Semantic Versioning]]
* [[Stages of Modloading]]
</div>

<div class="box">
<h3>Resources and Data</h3>
* [[Using Resources|Introduction]]
* [[Recipes]]
* [[Tags]]
* [[Holders]]
</div>

<div class="box">
<h3>Blocks</h3>
* [[Making Blocks|Creating Blocks]]
* [[Understanding Blockstates]]
* [[Interacting With Blocks|Block Interactions]]
</div>

<div class="box">
<h3>Items</h3>
* [[Making Items]]
* [[Making Tools]]
* [[BlockEntityWithoutLevelRenderer|<tt>BlockEntityWithoutLevelRenderer</tt>]]
* [[Custom Item Animations]]
</div>

<div class="box">
<h3>Data Generation</h3>
* [[Datageneration|Introduction]]
* [[Datageneration/Recipes|Recipes]]
* [[Datageneration/Tags|Tags]]
* [[Datageneration/Loot_Tables|Loot Tables]]
* [[Datageneration/I18n|Localization]]
* [[Datageneration/States and Models|<tt>BlockState</tt>s and Models]]
</div>

<div class="box">
<h3>Block Entities</h3>
* [[Block Entities|Introduction]]
* [[Block Entity Renderer|<tt>BlockEntityRenderer</tt>]]
</div>

<div class="box">
<h3>Models</h3>
* [[Introduction to Models|Introduction]]
* [[Model JSONs]]
* [[BlockState JSONs]]
* [[Coloring textures dynamically|Dynamically Colored Textures]]
* [[Item Properties]]
</div>

<div class="box">
<h3>Handling Information</h3>
* [[Understanding Networking|Introduction]]
* [[Using NBT|Named Binary Tag (NBT)]]
* [[Using FriendlyByteBuf|Using <tt>FriendlyByteBuf</tt>]]
* [[Sending Packets|Sending and Receiving Packets]]
* [[Using SimpleChannel|Using <tt>SimpleChannel</tt>]]
* [[Networking with Entities]]
* [[DynamicOps|Using DynamicOps]]
* [[Codecs|Using Codecs]]
</div>

<div class="box">
<h3>Data Storage</h3>
* [[Capabilities|Understanding Capabilities]]
* [[Capabilities/Attaching|Attaching Capabilities]]
* [[Saved Data]]
</div>

<div class="box">
<h3>Game Effects</h3>
* [[Mob Effects]]
* [[Potions]]
* [[Particles]]
* [[Sounds]]
</div>

<div class="box">
<h3>Events</h3>
* [[Events|Understanding Events]]
* [[Entity Events]]
</div>

<div class="box">
<h3>Others</h3>
* [[Dependencies]]
* [[Dynamic Loot Modification]]
* [[Components|Components and Translation Keys]]
* [[Key Mappings]]
* [[Access Transformers]]
* [[Toolchain]]
* [[Game_Tests|Game Tests]]
* [[Biome_Modifiers|Biome Modifiers]]
* [[Datapack_Registries|Datapack Registries]]
</div>

<div class="box">
<h3>Recipes</h3>
* [[Recipes]]
* [[Custom Recipes|Custom Recipe Types]]
* [[Datageneration/Recipes|Datageneration]]
</div>

</div>

Custom Item Animations

2022-09-04T10:46:09Z

Tmvkrpxl0:

Custom Item animation allows items to have both 3rd person and 1st person animation. This is done by consuming custom client extension with custom rendering logic in <code>Item#initializeClient</code>.

== Defining custom client extension ==
First, create a implementation of <code>IClientItemExtensions</code>. It can be either anonymous or named.

<syntaxhighlight lang="java">
IClientItemExtensions extension = new IClientItemExtensions() {
// .....
}
</syntaxhighlight>

An instance of it should be consumed in <code>Item#initializeClient</code> like this:

<syntaxhighlight lang="java">
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer) {
consumer.accept(extension);
}
</syntaxhighlight>

Or you can define and consume implementation at same time:

<syntaxhighlight lang="java">
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer) {
consumer.accept(new IClientItemExtensions() {
// .....
});
}
</syntaxhighlight>

== <tt>Implementing first person Item Animation</tt> ==
In order to implmement first person Item Animation in <code>IClientItemExtensions</code>, override <code>#applyForgeHandTransform</code>
<syntaxhighlight lang="java">
IClientItemExtensions extension = new IClientItemExtensions() {
@Override
public boolean applyForgeHandTransform(PoseStack poseStack, LocalPlayer player, HumanoidArm arm, ItemStack itemInHand, float partialTick, float equipProcess, float swingProcess) {
// Returning true in this method is recommended as it will prevent this item stack from being handled by vanilla rendering system, preventing additional unwanted transformations from being applied.
}
}
</syntaxhighlight>
The <code>applyForgeHandTransform</code> method's parameters are for:
* <code><nowiki>PoseStack poseStack</nowiki></code>: For stacking matrix poses. You can translate, rotate, scale item model with it.
* <code><nowiki>LocalPlayer player</nowiki></code>: Main client player holding the item.
* <code><nowiki>HumanoidArm arm</nowiki></code>: For distinguishing which arm is holding the item. It's either <code>#LEFT</code> or <code>#RIGHT</code>
* <code><nowiki>ItemStack itemInHand</nowiki></code>: <code>ItemStack</code> that player is holding. Its <code>Item</code> is always the custom <code>Item</code> that you're implementing animation for.
* <code><nowiki>float partialTick</nowiki></code>: Value ranging from 0.0 to 1.0 for telling how much time has passed since last tick. If it's close to 0.0, it means current tick just started. If it's close to 1.0, it means current tick is almost over.
* <code><nowiki>float equipProcess</nowiki></code>: Value ranging from 0.0 to 1.0. It's close to 0.0 when the sword gauge bar is full. It's close to 1.0 when sword gauge bar is low. [[File:That_short_gage_thing_under_cross.png]]
* <code><nowiki>float swingProcess</nowiki></code>: Value ranging from 0.0 to 1.0 for telling animation progress. If it's exactly at 0.0, the animation is not playing. If it's just close to 0.0, animation has just started playing. If it's close to 1.0, the animation is almost over.

Here's example implementation:
<syntaxhighlight lang="java">
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer) {
consumer.accept(new IClientItemExtensions() {
@Override
public boolean applyForgeHandTransform(PoseStack poseStack, LocalPlayer player, HumanoidArm arm, ItemStack itemInHand, float partialTick, float equipProcess, float swingProcess) {
int i = arm == HumanoidArm.RIGHT ? 1 : -1;
poseStack.translate(i * 0.56F, -0.52F, -0.72F);
if (player.getUseItem() == itemInHand && player.isUsingItem()) {
poseStack.translate(0.0, -0.05, 0.0);
}
return true;
}
});
}
</syntaxhighlight>

== <tt>Implementing third person Item Animation</tt> ==
Implementing third person Item Animation is done via defining custom <code>HumanoidModel$ArmPose</code> and returning it in <code>IClientItemExtensions#getArmPose</code>.

=== Defining custom ArmPose ===
Forge makes <code>HumanoidModel$ArmPose</code> enum extensible, allowing you to create custom entries using <code>HumanoidModel$ArmPose#create</code>.
<syntaxhighlight lang="java">
private static final HumanoidModel.ArmPose EXAMPLE_POSE = HumanoidModel.ArmPose.create("EXAMPLE", false, (model, entity, arm) -> {
if (arm == HumanoidArm.RIGHT) {
model.rightArm.xRot = (float) (Math.random() * Math.PI * 2);
} else {
model.leftArm.xRot = (float) (Math.random() * Math.PI * 2);
}
});
</syntaxhighlight>
<code>create</code> takes in 3 arguments:
* <code><nowiki>String name</nowiki></code>: Name of the custom pose.
* <code><nowiki>boolean twoHanded</nowiki></code>: Whether or not the animation should be two handed or single handed.
* <code><nowiki>IArmPoseTransformer forgeArmPose</nowiki></code>: Functional interface for custom arm rendering logic.

after that, override <code>IClientItemExtensions#getArmPose</code> so that it returns newly created enum entry.
<syntaxhighlight lang="java">
@Override
public HumanoidModel.ArmPose getArmPose(LivingEntity entityLiving, InteractionHand hand, ItemStack itemStack) {
if (!itemStack.isEmpty()) {
if (entityLiving.getUsedItemHand() == hand && entityLiving.getUseItemRemainingTicks() > 0) {
return EXAMPLE_POSE;
}
}
return HumanoidModel.ArmPose.EMPTY;
}
</syntaxhighlight>
It has additional check to ensure only play custom arm rendering logic when player is actually using this item.

== Tying it all up ==
Combining both examples into single <code>IClientItemExtensions</code> would look like this:

<syntaxhighlight lang="java">
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer)
{
consumer.accept(new IClientItemExtensions() {

private static final HumanoidModel.ArmPose EXAMPLE_POSE = HumanoidModel.ArmPose.create("EXAMPLE", false, (model, entity, arm) -> {
if (arm == HumanoidArm.RIGHT) {
model.rightArm.xRot = (float) (Math.random() * Math.PI * 2);
} else {
model.leftArm.xRot = (float) (Math.random() * Math.PI * 2);
}
});

@Override
public HumanoidModel.ArmPose getArmPose(LivingEntity entityLiving, InteractionHand hand, ItemStack itemStack) {
if (!itemStack.isEmpty()) {
if (entityLiving.getUsedItemHand() == hand && entityLiving.getUseItemRemainingTicks() > 0) {
return EXAMPLE_POSE;
}
}
return HumanoidModel.ArmPose.EMPTY;
}

@Override
public boolean applyForgeHandTransform(PoseStack poseStack, LocalPlayer player, HumanoidArm arm, ItemStack itemInHand, float partialTick, float equipProcess, float swingProcess) {
int i = arm == HumanoidArm.RIGHT ? 1 : -1;
poseStack.translate(i * 0.56F, -0.52F, -0.72F);
if (player.getUseItem() == itemInHand && player.isUsingItem()) {
poseStack.translate(0.0, -0.05, 0.0);
}
return true;
}
});
}
</syntaxhighlight>

[[Category:Items]]

Custom Item Animations

2022-09-04T10:45:54Z

Tmvkrpxl0:

{{Under construction}}
Custom Item animation allows items to have both 3rd person and 1st person animation. This is done by consuming custom client extension with custom rendering logic in <code>Item#initializeClient</code>.

== Defining custom client extension ==
First, create a implementation of <code>IClientItemExtensions</code>. It can be either anonymous or named.

<syntaxhighlight lang="java">
IClientItemExtensions extension = new IClientItemExtensions() {
// .....
}
</syntaxhighlight>

An instance of it should be consumed in <code>Item#initializeClient</code> like this:

<syntaxhighlight lang="java">
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer) {
consumer.accept(extension);
}
</syntaxhighlight>

Or you can define and consume implementation at same time:

<syntaxhighlight lang="java">
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer) {
consumer.accept(new IClientItemExtensions() {
// .....
});
}
</syntaxhighlight>

== <tt>Implementing first person Item Animation</tt> ==
In order to implmement first person Item Animation in <code>IClientItemExtensions</code>, override <code>#applyForgeHandTransform</code>
<syntaxhighlight lang="java">
IClientItemExtensions extension = new IClientItemExtensions() {
@Override
public boolean applyForgeHandTransform(PoseStack poseStack, LocalPlayer player, HumanoidArm arm, ItemStack itemInHand, float partialTick, float equipProcess, float swingProcess) {
// Returning true in this method is recommended as it will prevent this item stack from being handled by vanilla rendering system, preventing additional unwanted transformations from being applied.
}
}
</syntaxhighlight>
The <code>applyForgeHandTransform</code> method's parameters are for:
* <code><nowiki>PoseStack poseStack</nowiki></code>: For stacking matrix poses. You can translate, rotate, scale item model with it.
* <code><nowiki>LocalPlayer player</nowiki></code>: Main client player holding the item.
* <code><nowiki>HumanoidArm arm</nowiki></code>: For distinguishing which arm is holding the item. It's either <code>#LEFT</code> or <code>#RIGHT</code>
* <code><nowiki>ItemStack itemInHand</nowiki></code>: <code>ItemStack</code> that player is holding. Its <code>Item</code> is always the custom <code>Item</code> that you're implementing animation for.
* <code><nowiki>float partialTick</nowiki></code>: Value ranging from 0.0 to 1.0 for telling how much time has passed since last tick. If it's close to 0.0, it means current tick just started. If it's close to 1.0, it means current tick is almost over.
* <code><nowiki>float equipProcess</nowiki></code>: Value ranging from 0.0 to 1.0. It's close to 0.0 when the sword gauge bar is full. It's close to 1.0 when sword gauge bar is low. [[File:That_short_gage_thing_under_cross.png]]
* <code><nowiki>float swingProcess</nowiki></code>: Value ranging from 0.0 to 1.0 for telling animation progress. If it's exactly at 0.0, the animation is not playing. If it's just close to 0.0, animation has just started playing. If it's close to 1.0, the animation is almost over.

Here's example implementation:
<syntaxhighlight lang="java">
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer) {
consumer.accept(new IClientItemExtensions() {
@Override
public boolean applyForgeHandTransform(PoseStack poseStack, LocalPlayer player, HumanoidArm arm, ItemStack itemInHand, float partialTick, float equipProcess, float swingProcess) {
int i = arm == HumanoidArm.RIGHT ? 1 : -1;
poseStack.translate(i * 0.56F, -0.52F, -0.72F);
if (player.getUseItem() == itemInHand && player.isUsingItem()) {
poseStack.translate(0.0, -0.05, 0.0);
}
return true;
}
});
}
</syntaxhighlight>

== <tt>Implementing third person Item Animation</tt> ==
Implementing third person Item Animation is done via defining custom <code>HumanoidModel$ArmPose</code> and returning it in <code>IClientItemExtensions#getArmPose</code>.

=== Defining custom ArmPose ===
Forge makes <code>HumanoidModel$ArmPose</code> enum extensible, allowing you to create custom entries using <code>HumanoidModel$ArmPose#create</code>.
<syntaxhighlight lang="java">
private static final HumanoidModel.ArmPose EXAMPLE_POSE = HumanoidModel.ArmPose.create("EXAMPLE", false, (model, entity, arm) -> {
if (arm == HumanoidArm.RIGHT) {
model.rightArm.xRot = (float) (Math.random() * Math.PI * 2);
} else {
model.leftArm.xRot = (float) (Math.random() * Math.PI * 2);
}
});
</syntaxhighlight>
<code>create</code> takes in 3 arguments:
* <code><nowiki>String name</nowiki></code>: Name of the custom pose.
* <code><nowiki>boolean twoHanded</nowiki></code>: Whether or not the animation should be two handed or single handed.
* <code><nowiki>IArmPoseTransformer forgeArmPose</nowiki></code>: Functional interface for custom arm rendering logic.

after that, override <code>IClientItemExtensions#getArmPose</code> so that it returns newly created enum entry.
<syntaxhighlight lang="java">
@Override
public HumanoidModel.ArmPose getArmPose(LivingEntity entityLiving, InteractionHand hand, ItemStack itemStack) {
if (!itemStack.isEmpty()) {
if (entityLiving.getUsedItemHand() == hand && entityLiving.getUseItemRemainingTicks() > 0) {
return EXAMPLE_POSE;
}
}
return HumanoidModel.ArmPose.EMPTY;
}
</syntaxhighlight>
It has additional check to ensure only play custom arm rendering logic when player is actually using this item.

== Tying it all up ==
Combining both examples into single <code>IClientItemExtensions</code> would look like this:

<syntaxhighlight lang="java">
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer)
{
consumer.accept(new IClientItemExtensions() {

private static final HumanoidModel.ArmPose EXAMPLE_POSE = HumanoidModel.ArmPose.create("EXAMPLE", false, (model, entity, arm) -> {
if (arm == HumanoidArm.RIGHT) {
model.rightArm.xRot = (float) (Math.random() * Math.PI * 2);
} else {
model.leftArm.xRot = (float) (Math.random() * Math.PI * 2);
}
});

@Override
public HumanoidModel.ArmPose getArmPose(LivingEntity entityLiving, InteractionHand hand, ItemStack itemStack) {
if (!itemStack.isEmpty()) {
if (entityLiving.getUsedItemHand() == hand && entityLiving.getUseItemRemainingTicks() > 0) {
return EXAMPLE_POSE;
}
}
return HumanoidModel.ArmPose.EMPTY;
}

@Override
public boolean applyForgeHandTransform(PoseStack poseStack, LocalPlayer player, HumanoidArm arm, ItemStack itemInHand, float partialTick, float equipProcess, float swingProcess) {
int i = arm == HumanoidArm.RIGHT ? 1 : -1;
poseStack.translate(i * 0.56F, -0.52F, -0.72F);
if (player.getUseItem() == itemInHand && player.isUsingItem()) {
poseStack.translate(0.0, -0.05, 0.0);
}
return true;
}
});
}
</syntaxhighlight>

[[Category:Items]]

Custom Item Animations

2022-09-03T11:43:06Z

Tmvkrpxl0:

Custom Item Animations

2022-09-03T11:38:25Z

Tmvkrpxl0: Created page with "{{Under construction}} Custom Item animation allows items to have both 3rd person and 1st person animation. This is done by consuming custom client extension with custom rende..."

File:That short gage thing under cross.png

2022-09-03T09:19:24Z

Tmvkrpxl0: I don't know how to name it. It's for Custom Item Animation Documentation

== Summary ==
I don't know how to name it. It's for Custom Item Animation Documentation
== Licencing ==
{{PD-ineligible}}