Minecraft Forge

https://docs.minecraftforge.net/en/1.21.x
Admin
The official documentation for MinecraftForge, the modding API for Minecraft, providing resources...
Tokens:139,716
Snippets:937
Trust Score:9.6
Update:1 day ago
Show doc for...
Tokens:
Raw
### BeforeBatch and GameTest batching example

Source: https://docs.minecraftforge.net/en/1.21.x/misc/gametest/

Batch methods are Consumer<ServerLevel> references. The @BeforeBatch method must have a batch string matching the @GameTest method's batch to perform setup.

```java
public class ExampleGameTests {
  @BeforeBatch(batch = "firstBatch")
  public static void beforeTest(ServerLevel level) {
    // Perform setup
  }

  @GameTest(batch = "firstBatch")
  public static void exampleTest2(GameTestHelper helper) {
    // Do stuff
  }
}
```

--------------------------------

### Tag Creation and Checking Example

Source: https://docs.minecraftforge.net/en/1.21.x/resources/server/tags/

Example code showing how to create tags for vanilla, Forge-wrapped, and custom registries, and how to check if objects belong to those tags.

```APIDOC
## Tag Creation and Checking Example

### Description
This example demonstrates creating tags for vanilla, Forge-wrapped, and custom registries, and checking if objects belong to those tags.

### Code
```java
public static final TagKey<Item> myItemTag = ItemTags.create(ResourceLocation.fromNamespaceAndPath("mymod", "myitemgroup"));

public static final TagKey<Potion> myPotionTag = ForgeRegistries.POTIONS.tags().createTagKey(ResourceLocation.fromNamespaceAndPath("mymod", "mypotiongroup"));

public static final TagKey<VillagerType> myVillagerTypeTag = TagKey.create(Registries.VILLAGER_TYPE, ResourceLocation.fromNamespaceAndPath("mymod", "myvillagertypegroup"));

// In some method:

ItemStack stack = /*...*/;
boolean isInItemGroup = stack.is(myItemTag);

Potion potion = /*...*/;
boolean isInPotionGroup  = ForgeRegistries.POTIONS.tags().getTag(myPotionTag).contains(potion);

ResourceKey<VillagerType> villagerTypeKey = /*...*/;
boolean isInVillagerTypeGroup = BuiltInRegistries.VILLAGER_TYPE.getHolder(villagerTypeKey).map(holder -> holder.is(myVillagerTypeTag)).orElse(false);
```

```

--------------------------------

### VariantBlockStateBuilder example with partialState, forAllStates, and forAllStatesExcept

Source: https://docs.minecraftforge.net/en/1.21.x/datagen/client/modelproviders/

Shows three examples of generating variants: using partialState with per-property models, forAllStates to rotate models based on HORIZONTAL_FACING, and forAllStatesExcept to ignore WATERLOGGED. The first example uses weighted models and rotation. The second and third use ConfiguredModel.builder().

```java
// In some BlockStateProvider#registerStatesAndModels

// EXAMPLE_BLOCK_1: Has Property BlockStateProperties#AXIS
this.getVariantBuilder(EXAMPLE_BLOCK_1) // Get variant builder
  .partialState() // Construct partial state
  .with(AXIS, Axis.Y) // When BlockState AXIS = Y
    .modelForState() // Set models when AXIS = Y
    .modelFile(yModelFile1) // Can show 'yModelFile1'
    .nextModel() // Adds another model when AXIS = Y
    .modelFile(yModelFile2) // Can show 'yModelFile2'
    .weight(2) // Will show 'yModelFile2' 2/3 of the time
    .addModel() // Finalizes models when AXIS = Y
  .with(AXIS, Axis.Z) // When BlockState AXIS = Z
    .modelForState() // Set models when AXIS = Z
    .modelFile(hModelFile) // Can show 'hModelFile'
    .addModel() // Finalizes models when AXIS = Z
  .with(AXIS, Axis.X)  // When BlockState AXIS = X
    .modelForState() // Set models when AXIS = X
    .modelFile(hModelFile) // Can show 'hModelFile'
    .rotationY(90) // Rotates 'hModelFile' 90 degrees on the Y axis
    .addModel(); // Finalizes models when AXIS = X

// EXAMPLE_BLOCK_2: Has Property BlockStateProperties#HORIZONTAL_FACING
this.getVariantBuilder(EXAMPLE_BLOCK_2) // Get variant builder
  .forAllStates(state -> // For all possible states
    ConfiguredModel.builder() // Creates configured model builder
      .modelFile(modelFile) // Can show 'modelFile'
      .rotationY((int) state.getValue(HORIZONTAL_FACING).toYRot()) // Rotates 'modelFile' on the Y axis depending on the property
      .build() // Creates the array of configured models
  );

// EXAMPLE_BLOCK_3: Has Properties BlockStateProperties#HORIZONTAL_FACING, BlockStateProperties#WATERLOGGED
this.getVariantBuilder(EXAMPLE_BLOCK_3) // Get variant builder
  .forAllStatesExcept(state -> // For all HORIZONTAL_FACING states
    ConfiguredModel.builder() // Creates configured model builder
      .modelFile(modelFile) // Can show 'modelFile'
      .rotationY((int) state.getValue(HORIZONTAL_FACING).toYRot()) // Rotates 'modelFile' on the Y axis depending on the property
      .build(), // Creates the array of configured models
  WATERLOGGED); // Ignores WATERLOGGED property
```

--------------------------------

### Example mods.toml file

Source: https://docs.minecraftforge.net/en/1.21.x/gettingstarted/modfiles/

A complete mods.toml example showing modLoader, loaderVersion, mod metadata, and dependencies for Forge and Minecraft. The file must be stored at src/main/resources/META-INF/mods.toml. Required properties must be specified or an exception is thrown.

```toml
modLoader="javafml"
loaderVersion="[52,)"

license="All Rights Reserved"
issueTrackerURL="https://github.com/MinecraftForge/MinecraftForge/issues"
showAsResourcePack=false
clientSideOnly=false

[[mods]]
  modId="examplemod"
  version="1.0.0.0"
  displayName="Example Mod"
  updateJSONURL="https://files.minecraftforge.net/net/minecraftforge/forge/promotions_slim.json"
  displayURL="https://minecraftforge.net"
  logoFile="logo.png"
  credits="I'd like to thank my mother and father."
  authors="Author"
  description='''
  Lets you craft dirt into diamonds. This is a traditional mod that has existed for eons. It is ancient. The holy Notch created it. Jeb rainbowfied it. Dinnerbone made it upside down. Etc.
  '''
  displayTest="MATCH_VERSION"

[[dependencies.examplemod]]
  modId="forge"
  mandatory=true
  versionRange="[52,)"
  ordering="NONE"
  side="BOTH"

[[dependencies.examplemod]]
  modId="minecraft"
  mandatory=true
  versionRange="[1.21.1,)"
  ordering="NONE"
  side="BOTH"
```

--------------------------------

### Profiling result output example

Source: https://docs.minecraftforge.net/en/1.21.x/misc/debugprofiler/

Example output from a profiling.txt file showing the hierarchical breakdown of tick time by section, with percentages for parent and total tick time.

```text
[00] levels - 96.70%/96.70%
[01] |   Level Name - 99.76%/96.47%
[02] |   |   tick - 99.31%/95.81%
[03] |   |   |   entities - 47.72%/45.72%
[04] |   |   |   |   regular - 98.32%/44.95%
[04] |   |   |   |   blockEntities - 0.90%/0.41%
[05] |   |   |   |   |   unspecified - 64.26%/0.26%
[05] |   |   |   |   |   minecraft:furnace - 33.35%/0.14%
[05] |   |   |   |   |   minecraft:chest - 2.39%/0.01%
```

--------------------------------

### DoorBlock registerDefaultState example

Source: https://docs.minecraftforge.net/en/1.21.x/blocks/states/

Example from DoorBlock showing how to set the default state in the constructor using Block#registerDefaultState. It sets values for FACING, OPEN, HINGE, POWERED, and HALF properties.

```Java
this.registerDefaultState(
  this.stateDefinition.any()
    .setValue(FACING, Direction.NORTH)
    .setValue(OPEN, false)
    .setValue(HINGE, DoorHingeSide.LEFT)
    .setValue(POWERED, false)
    .setValue(HALF, DoubleBlockHalf.LOWER)
);
```

--------------------------------

### MultiPartBlockStateBuilder usage example

Source: https://docs.minecraftforge.net/en/1.21.x/datagen/client/modelproviders/

Example of using MultiPartBlockStateBuilder to define a multipart block state for redstone wire, showing parts with model files, rotations, and conditions.

```APIDOC
## MultiPartBlockStateBuilder

### Description
Builder for creating multipart block states in data generation. Allows defining multiple parts, each with a model file, optional rotation, and conditions under which the part is displayed.

### Usage
Used within `BlockStateProvider#registerStatesAndModels` via `getMultipartBuilder(Block)`.

### Methods
- `part()` - Starts a new part definition.
- `modelFile(ModelFile)` - Sets the model file for the part.
- `rotationY(int)` - Sets the Y-axis rotation for the model.
- `addModel()` - Adds the model to the part with the current conditions.
- `condition(Property, Value...)` - Adds a condition that the property must match one of the given values.
- `useOr()` - Specifies that the conditions in the current group are ORed together.
- `nestedGroup()` - Starts a nested condition group (ANDed by default).
- `endNestedGroup()` - Ends the current nested group.
- `end()` - Finishes the current part.

### Example
```java
// In some BlockStateProvider#registerStatesAndModels

// Redstone Wire
this.getMultipartBuilder(REDSTONE) // Get multipart builder
  .part() // Create part
    .modelFile(redstoneDot) // Can show 'redstoneDot'
    .addModel() // 'redstoneDot' is displayed when...
    .useOr() // At least one of these conditions are true
    .nestedGroup() // true when all grouped conditions are true
      .condition(WEST_REDSTONE, NONE) // true when WEST_REDSTONE is NONE
      .condition(EAST_REDSTONE, NONE) // true when EAST_REDSTONE is NONE
      .condition(SOUTH_REDSTONE, NONE) // true when SOUTH_REDSTONE is NONE
      .condition(NORTH_REDSTONE, NONE) // true when NORTH_REDSTONE is NONE
    .endNestedGroup() // End group
    .nestedGroup() // true when all grouped conditions are true
      .condition(EAST_REDSTONE, SIDE, UP) // true when EAST_REDSTONE is SIDE or UP
      .condition(NORTH_REDSTONE, SIDE, UP) // true when NORTH_REDSTONE is SIDE or UP
    .endNestedGroup() // End group
    .nestedGroup() // true when all grouped conditions are true
      .condition(EAST_REDSTONE, SIDE, UP) // true when EAST_REDSTONE is SIDE or UP
      .condition(SOUTH_REDSTONE, SIDE, UP) // true when SOUTH_REDSTONE is SIDE or UP
    .endNestedGroup() // End group
    .nestedGroup() // true when all grouped conditions are true
      .condition(WEST_REDSTONE, SIDE, UP) // true when WEST_REDSTONE is SIDE or UP
      .condition(SOUTH_REDSTONE, SIDE, UP) // true when SOUTH_REDSTONE is SIDE or UP
    .endNestedGroup() // End group
    .nestedGroup() // true when all grouped conditions are true
      .condition(WEST_REDSTONE, SIDE, UP) // true when WEST_REDSTONE is SIDE or UP
      .condition(NORTH_REDSTONE, SIDE, UP) // true when NORTH_REDSTONE is SIDE or UP
    .endNestedGroup() // End group
    .end() // Finish part
  .part() // Create part
    .modelFile(redstoneSide0) // Can show 'redstoneSide0'
    .addModel() // 'redstoneSide0' is displayed when...
    .condition(NORTH_REDSTONE, SIDE, UP) // NORTH_REDSTONE is SIDE or UP
    .end() // Finish part
  .part() // Create part
    .modelFile(redstoneSideAlt0) // Can show 'redstoneSideAlt0'
    .addModel() // 'redstoneSideAlt0' is displayed when...
    .condition(SOUTH_REDSTONE, SIDE, UP) // SOUTH_REDSTONE is SIDE or UP
    .end() // Finish part
  .part() // Create part
    .modelFile(redstoneSideAlt1) // Can show 'redstoneSideAlt1'
    .rotationY(270) // Rotates 'redstoneSideAlt1' 270 degrees on the Y axis
    .addModel() // 'redstoneSideAlt1' is displayed when...
    .condition(EAST_REDSTONE, SIDE, UP) // EAST_REDSTONE is SIDE or UP
    .end() // Finish part
  .part() // Create part
    .modelFile(redstoneSide1) // Can show 'redstoneSide1'
    .rotationY(270) // Rotates 'redstoneSide1' 270 degrees on the Y axis
    .addModel() // 'redstoneSide1' is displayed when...
    .condition(WEST_REDSTONE, SIDE, UP) // WEST_REDSTONE is SIDE or UP
    .end() // Finish part
  .part() // Create part
    .modelFile(redstoneUp) // Can show 'redstoneUp'
    .addModel() // 'redstoneUp' is displayed when...
    .condition(NORTH_REDSTONE, UP) // NORTH_REDSTONE is UP
    .end() // Finish part
  .part() // Create part
    .modelFile(redstoneUp) // Can show 'redstoneUp'
    .rotationY(90) // Rotates 'redstoneUp' 90 degrees on the Y axis
    .addModel() // 'redstoneUp' is displayed when...
    .condition(EAST_REDSTONE, UP) // EAST_REDSTONE is UP
    .end() // Finish part
  .part() // Create part
    .modelFile(redstoneUp) // Can show 'redstoneUp'
    .rotationY(180) // Rotates 'redstoneUp' 180 degrees on the Y axis
    .addModel() // 'redstoneUp' is displayed when...
    .condition(SOUTH_REDSTONE, UP) // SOUTH_REDSTONE is UP
    .end() // Finish part
  .part() // Create part
    .modelFile(redstoneUp) // Can show 'redstoneUp'
    .rotationY(270) // Rotates 'redstoneUp' 270 degrees on the Y axis
    .addModel() // 'redstoneUp' is displayed when...
    .condition(WEST_REDSTONE, UP) // WEST_REDSTONE is UP
    .end(); // Finish part
```
```

--------------------------------

### ExampleModelProvider subclass

Source: https://docs.minecraftforge.net/en/1.21.x/datagen/client/modelproviders/

Creates a custom model provider by extending ModelProvider. The constructor hardcodes the subdirectory 'example' within the models folder and the ModelBuilder type.

```java
public class ExampleModelProvider extends ModelProvider<ExampleModelBuilder> {

  public ExampleModelProvider(PackOutput output, String modid, ExistingFileHelper existingFileHelper) {
    // Models will be generated to 'assets/<modid>/models/example' if no 'modid' is specified in '#getBuilder'
    super(output, modid, "example", ExampleModelBuilder::new, existingFileHelper);
  }
}
```

--------------------------------

### Example SavedData creation and loading with computeIfAbsent

Source: https://docs.minecraftforge.net/en/1.21.x/datastorage/saveddata/

Shows how to define create and load methods for a SavedData implementation and attach it to a level's DimensionDataStorage using computeIfAbsent. The load method should read saved data from the CompoundTag. The computeIfAbsent call uses method references to the load and create methods and the string 'example' as the .dat file name.

```java
// In some class
public ExampleSavedData create() {
  return new ExampleSavedData();
}

public ExampleSavedData load(CompoundTag tag) {
  ExampleSavedData data = this.create();
  // Load saved data
  return data;
}

// In some method within the class
netherDataStorage.computeIfAbsent(this::load, this::create, "example");
```

--------------------------------

### CompoundIngredient JSON example

Source: https://docs.minecraftforge.net/en/1.21.x/resources/server/recipes/ingredients/

Shows how to use a list of ingredients as a set OR. No type is specified; the stack must match at least one of the supplied ingredients.

```json
// For some input
[
  // At least one of these ingredients must match to succeed
  {
    // Ingredient
  },
  {
    // Custom ingredient
    "type": "examplemod:example_ingredient"
  }
]
```

--------------------------------

### RecipeManager#getRecipeFor

Source: https://docs.minecraftforge.net/en/1.21.x/resources/server/recipes/

Gets the first recipe that matches the current input. Takes a RecipeType, a Container holding the input configuration, and the current level.

```APIDOC
## RecipeManager#getRecipeFor

### Description
Gets the first recipe that matches the current input.

### Method
Method call

### Signature
`getRecipeFor(RecipeType, Container, Level)`

### Parameters
- **RecipeType** (RecipeType) - Required - The type of recipe (e.g., crafting, smelting).
- **Container** (Container) - Required - Holds the configuration of the inputs.
- **Level** (Level) - Required - The current level, passed to `Recipe#matches`.

### Example
```java
recipeManger.getRecipeFor(RecipeType.CRAFTING, new RecipeWrapper(handler), level);
```
```

--------------------------------

### RecipeManager#getRecipesFor

Source: https://docs.minecraftforge.net/en/1.21.x/resources/server/recipes/

Gets all recipes that match the current input. Takes a RecipeType, a Container holding the input configuration, and the current level.

```APIDOC
## RecipeManager#getRecipesFor

### Description
Gets all recipes that match the current input.

### Method
Method call

### Signature
`getRecipesFor(RecipeType, Container, Level)`

### Parameters
- **RecipeType** (RecipeType) - Required - The type of recipe (e.g., crafting, smelting).
- **Container** (Container) - Required - Holds the configuration of the inputs.
- **Level** (Level) - Required - The current level, passed to `Recipe#matches`.

### Example
```java
recipeManger.getRecipesFor(RecipeType.CRAFTING, new RecipeWrapper(handler), level);
```
```

--------------------------------

### Add a Global Loot Modifier in start method

Source: https://docs.minecraftforge.net/en/1.21.x/datagen/server/glm/

Adds a modifier instance with a name, loot conditions, and parameters. The example uses a WeatherCheck condition that executes when raining.

```java
// In some GlobalLootModifierProvider#start
this.add("example_modifier", new ExampleModifier(
  new LootItemCondition[] {
    WeatherCheck.weather().setRaining(true).build() // Executes when raining
  },
  "val1",
  10,
  Items.DIRT
));
```

--------------------------------

### Define mod-specific properties in mods.toml

Source: https://docs.minecraftforge.net/en/1.21.x/gettingstarted/modfiles/

Use this TOML structure to define mod-specific properties for each mod. The [[mods]] header starts an array of tables; all key/value properties are attached to that mod until the next header. The example shows properties for two mods, examplemod1 and examplemod2.

```toml
# Properties for examplemod1
[[mods]]
modId = "examplemod1"

# Properties for examplemod2
[[mods]]
modId = "examplemod2"
```

--------------------------------

### ExampleConfig constructor and static block with ForgeConfigSpec.Builder

Source: https://docs.minecraftforge.net/en/1.21.x/misc/config/

Shows how to use ForgeConfigSpec$Builder#configure with a static block and a class that takes the builder in its constructor to attach and hold config values.

```java
// In some config class
ExampleConfig(ForgeConfigSpec.Builder builder) {
  // Define values here in final fields
}

// Somewhere the constructor is accessible
static {
  Pair<ExampleConfig, ForgeConfigSpec> pair = new ForgeConfigSpec.Builder()
    .configure(ExampleConfig::new);
  // Store pair values in some constant field
}
```

--------------------------------

### new KeyMapping (basic)

Source: https://docs.minecraftforge.net/en/1.21.x/misc/keymappings/

Creates a KeyMapping with a translation key, default keyboard input, and category.

```APIDOC
## new KeyMapping

### Description
Creates a KeyMapping with a translation key for the name, a default input, and a category translation key.

### Constructor
`new KeyMapping(String translationKey, InputConstants.Type type, int keyCode, String categoryTranslationKey)`

### Parameters
- **translationKey** (String) - Required - The translation key for the mapping name.
- **type** (InputConstants.Type) - Required - The input device type (KEYSYM, SCANCODE, MOUSE).
- **keyCode** (int) - Required - The input code (e.g., GLFW.GLFW_KEY_P).
- **categoryTranslationKey** (String) - Required - The translation key for the category in the Controls menu.

### Example
```java
new KeyMapping(
  "key.examplemod.example1", // Will be localized using this translation key
  InputConstants.Type.KEYSYM, // Default mapping is on the keyboard
  GLFW.GLFW_KEY_P, // Default key is P
  "key.categories.misc" // Mapping will be in the misc category
)
```
```

--------------------------------

### Access Transformer Directives Example

Source: https://docs.minecraftforge.net/en/1.21.x/advanced/accesstransformers/

A single code block containing four access transformer directives. Each line starts with a modifier (public, protected-f) followed by the target class, field, or method with optional descriptor and comment. The comments explain the effect of each directive.

```plaintext
# Makes public the ByteArrayToKeyFunction interface in Crypt
public net.minecraft.util.Crypt$ByteArrayToKeyFunction

# Makes protected and removes the final modifier from 'random' in MinecraftServer
protected-f net.minecraft.server.MinecraftServer f_129758_ #random

# Makes public the 'makeExecutor' method in Util,
# accepting a String and returns an ExecutorService
public net.minecraft.Util m_137477_(Ljava/lang/String;)Ljava/util/concurrent/ExecutorService; #makeExecutor

# Makes public the 'leastMostToIntArray' method in UUIDUtil,
# accepting two longs and returning an int[]
public net.minecraft.core.UUIDUtil m_235872_(JJ)[I #leastMostToIntArray
```

--------------------------------

### Looking Up Datapack Registry Objects with BootstrapContext#lookup

Source: https://docs.minecraftforge.net/en/1.21.x/datagen/server/datapackregistries/

Demonstrates how to look up another datapack registry using BootstrapContext#lookup to get a HolderGetter, then use getOrThrow to obtain a Holder.Reference for a configured feature when registering a placed feature. The example registers a placed feature that references the configured feature and applies no placement modifiers.

```java
public static final ResourceKey<ConfiguredFeature<?, ?>> EXAMPLE_CONFIGURED_FEATURE = ResourceKey.create(
  Registries.CONFIGURED_FEATURE,
  ResourceLocation.fromNamespaceAndPath(MOD_ID, "example_configured_feature")
);

public static final ResourceKey<PlacedFeature> EXAMPLE_PLACED_FEATURE = ResourceKey.create(
  Registries.PLACED_FEATURE,
  ResourceLocation.fromNamespaceAndPath(MOD_ID, "example_placed_feature")
);

// In some constant location or argument
new RegistrySetBuilder()
  // Create configured features
  .add(Registries.CONFIGURED_FEATURE, bootstrap -> {
    // Register configured features here
    bootstrap.register(
      // The resource key for the configured feature
      EXAMPLE_CONFIGURED_FEATURE,
      new ConfiguredFeature(/* ... */)
    );
  })
  // Create placed features
  .add(Registries.PLACED_FEATURE, bootstrap -> {
    // Register placed features here

    // Get configured feature registry
    HolderGetter<ConfiguredFeature<?, ?>> configured = bootstrap.lookup(Registries.CONFIGURED_FEATURE);

    bootstrap.register(
      // The resource key for the placed feature
      EXAMPLE_PLACED_FEATURE,
      new PlacedFeature(
        configured.getOrThrow(EXAMPLE_CONFIGURED_FEATURE), // Get the configured feature
        List.of() // and do nothing to the placement location
      )
    )
  });
```

--------------------------------

### Get IItemHandler Capability with CapabilityManager#get

Source: https://docs.minecraftforge.net/en/1.21.x/datastorage/capabilities/

Retrieves the IItemHandler capability instance using CapabilityManager#get with an anonymous CapabilityToken. The returned capability is non-null but may not be registered; check Capability#isRegistered before use.

```java
public static final Capability<IItemHandler> ITEM_HANDLER = CapabilityManager.get(new CapabilityToken<>(){});
```

--------------------------------

### Configured Game Test with setupTicks and required

Source: https://docs.minecraftforge.net/en/1.21.x/misc/gametest/

Shows how to configure a Game Test using the @GameTest annotation members. setupTicks sets the number of ticks for setup, and required=false logs failures without affecting the batch execution.

```java
// In some class
@GameTest(
  setupTicks = 20L, // The test spends 20 ticks to set up for execution
  required = false // The failure is logged but does not affect the execution of the batch
)
public static void exampleConfiguredTest(GameTestHelper helper) {
  // Do stuff
}
```

--------------------------------

### BlockState#getValue(Property<?>)

Source: https://docs.minecraftforge.net/en/1.21.x/blocks/states/

Gets the value of a property from a BlockState. Pass the property you want to get the value of.

```APIDOC
## BlockState#getValue(Property<?>)

### Description
Gets the value of a property from a BlockState. Pass the property you want to get the value of.

### Method
`getValue`

### Parameters
- **property** (Property<?>) - Required - The property to get the value of.

### Returns
- The value of the property (type T).
```

--------------------------------

### quickMoveStack Implementation for a Menu with Data Inventory

Source: https://docs.minecraftforge.net/en/1.21.x/gui/menus/

Standard implementation of quickMoveStack for a menu with a data inventory of size 5 (result slot at index 0, inputs at indices 1-4), player inventory slots (5-31), and hotbar slots (32-40). Handles moving items between the data inventory and player inventory/hotbar, with special logic for the result slot and for containers that cannot transform stacks.

```java
// Assume we have a data inventory of size 5
// The inventory has 4 inputs (index 1 - 4) which outputs to a result slot (index 0)
// We also have the 27 player inventory slots and the 9 hotbar slots
// As such, the actual slots are indexed like so:
//   - Data Inventory: Result (0), Inputs (1 - 4)
//   - Player Inventory (5 - 31)
//   - Player Hotbar (32 - 40)
@Override
public ItemStack quickMoveStack(Player player, int quickMovedSlotIndex) {
  // The quick moved slot stack
  ItemStack quickMovedStack = ItemStack.EMPTY;
  // The quick moved slot
  Slot quickMovedSlot = this.slots.get(quickMovedSlotIndex) 

   // If the slot is in the valid range and the slot is not empty
  if (quickMovedSlot != null && quickMovedSlot.hasItem()) {
    // Get the raw stack to move
    ItemStack rawStack = quickMovedSlot.getItem(); 
    // Set the slot stack to a copy of the raw stack
    quickMovedStack = rawStack.copy();

    /*
    The following quick move logic can be simplified to if in data inventory,
    try to move to player inventory/hotbar and vice versa for containers
    that cannot transform data (e.g. chests).
    */

    // If the quick move was performed on the data inventory result slot
    if (quickMovedSlotIndex == 0) {
      // Try to move the result slot into the player inventory/hotbar
      if (!this.moveItemStackTo(rawStack, 5, 41, true)) {
        // If cannot move, no longer quick move
        return ItemStack.EMPTY;
      }

      // Perform logic on result slot quick move
      slot.onQuickCraft(rawStack, quickMovedStack);
    }
    // Else if the quick move was performed on the player inventory or hotbar slot
    else if (quickMovedSlotIndex >= 5 && quickMovedSlotIndex < 41) {
      // Try to move the inventory/hotbar slot into the data inventory input slots
      if (!this.moveItemStackTo(rawStack, 1, 5, false)) {
        // If cannot move and in player inventory slot, try to move to hotbar
        if (quickMovedSlotIndex < 32) {
          if (!this.moveItemStackTo(rawStack, 32, 41, false)) {
            // If cannot move, no longer quick move
            return ItemStack.EMPTY;
          }
        }
        // Else try to move hotbar into player inventory slot
        else if (!this.moveItemStackTo(rawStack, 5, 32, false)) {
          // If cannot move, no longer quick move
          return ItemStack.EMPTY;
        }
      }
    }
    // Else if the quick move was performed on the data inventory input slots, try to move to player inventory/hotbar
    else if (!this.moveItemStackTo(rawStack, 5, 41, false)) {
      // If cannot move, no longer quick move
      return ItemStack.EMPTY;
    }

    if (rawStack.isEmpty()) {
      // If the raw stack has completely moved out of the slot, set the slot to the empty stack
      quickMovedSlot.set(ItemStack.EMPTY);
    } else {
      // Otherwise, notify the slot that that the stack count has changed
      quickMovedSlot.setChanged();
    }

    /*
    The following if statement and Slot#onTake call can be removed if the
    menu does not represent a container that can transform stacks (e.g.
    chests).
    */
    if (rawStack.getCount() == quickMovedStack.getCount()) {
      // If the raw stack was not able to be moved to another slot, no longer quick move
      return ItemStack.EMPTY;
    }
    // Execute logic on what to do post move with the remaining stack
    quickMovedSlot.onTake(player, rawStack);
  }

  return quickMovedStack; // Return the slot stack
}
```

--------------------------------

### Non-Item Logic: ExampleRecipe methods and manager usage

Source: https://docs.minecraftforge.net/en/1.21.x/resources/server/recipes/custom/

Shows how to add custom methods to a Recipe subclass for non-item recipes, and how to retrieve and filter recipes using RecipeManager#getAllRecipesFor.

```java
// In some Recipe subimplementation ExampleRecipe

// Checks the block at the position to see if it matches the stored data
boolean matches(Level level, BlockPos pos);

// Creates the block state to set the block at the specified position to
BlockState assemble(RegistryAccess access);

// In some manager class
public Optional<ExampleRecipe> getRecipeFor(Level level, BlockPos pos) {
  return level.getRecipeManager()
    .getAllRecipesFor(exampleRecipeType) // Gets all recipes
    .stream() // Looks through all recipes for types
    .filter(recipe -> recipe.matches(level, pos)) // Checks if the recipe inputs are valid
    .findFirst(); // Finds the first recipe whose inputs match
}
```

--------------------------------

### Encode and decode with NbtOps

Source: https://docs.minecraftforge.net/en/1.21.x/datastorage/codecs/

Shows how to use Codec#encodeStart and Codec#parse with NbtOps.INSTANCE to encode Java objects to Tag and decode back.

```java
// Let exampleCodec represent a Codec<ExampleJavaObject>
// Let exampleObject be a ExampleJavaObject
// Let exampleNbt be a Tag

// Encode Java object to Tag
exampleCodec.encodeStart(JsonOps.INSTANCE, exampleObject);

// Decode Tag into Java object
exampleCodec.parse(JsonOps.INSTANCE, exampleNbt);
```

--------------------------------

### Element-wise specification example

Source: https://docs.minecraftforge.net/en/1.21.x/rendering/modelextensions/transforms/

Example of the element-wise specification for root transforms. The entries are applied in the order translation, left_rotation, scale, right_rotation, and then moved to the specified origin. Here, origin is 'center', translation is [0, 0.5, 0], and rotation is 45 degrees around the Y axis.

```json
{
    "transform": {
        "origin": "center",
        "translation": [ 0, 0.5, 0 ],
        "rotation": { "y": 45 }
    },
    // ...
}
```

--------------------------------

### @ObjectHolder field injection example

Source: https://docs.minecraftforge.net/en/1.21.x/concepts/registries/

Shows valid and invalid uses of @ObjectHolder on fields. Valid fields require public static and explicit registryName and value. Missing registry or name causes a compile-time exception. The example includes a field without annotation that is ignored.

```java
class Holder {
  @ObjectHolder(registryName = "minecraft:enchantment", value = "minecraft:flame")
  public static final Enchantment flame = null;     // Annotation present. [public static] is required. [final] is optional.
                                                    // Registry name is explicitly defined: "minecraft:enchantment"
                                                    // Resource location is explicitly defined: "minecraft:flame"
                                                    // To inject: "minecraft:flame" from the [Enchantment] registry

  public static final Biome ice_flat = null;        // No annotation on the field.
                                                    // Therefore, the field is ignored.

  @ObjectHolder("minecraft:creeper")
  public static Entity creeper = null;              // Annotation present. [public static] is required.
                                                    // The registry has not been specified on the field.
                                                    // Therefore, THIS WILL PRODUCE A COMPILE-TIME EXCEPTION.

  @ObjectHolder(registryName = "potion")
  public static final Potion levitation = null;     // Annotation present. [public static] is required. [final] is optional.
                                                    // Registry name is explicitly defined: "minecraft:potion"
                                                    // Resource location is not specified on the field
                                                    // Therefore, THIS WILL PRODUCE A COMPILE-TIME EXCEPTION.
}
```

--------------------------------

### Level#getBlockState(BlockPos)

Source: https://docs.minecraftforge.net/en/1.21.x/blocks/states/

Gets the BlockState at the given position in the level.

```APIDOC
## Level#getBlockState(BlockPos)

### Description
Gets the BlockState at the given position in the level.

### Method
`getBlockState`

### Parameters
- **pos** (BlockPos) - Required - The position in the level to get the block state from.

### Returns
- (BlockState) - The BlockState at the given position.
```

--------------------------------

### Add chainable configuration methods

Source: https://docs.minecraftforge.net/en/1.21.x/datagen/client/modelproviders/

Shows how to add chainable methods for loader-specific configurations. Each method returns this to allow chaining.

```java
// In ExampleLoaderBuilder
public ExampleLoaderBuilder<T> exampleInt(int example) {
  // Set int
  return this;
}

public ExampleLoaderBuilder<T> exampleString(String example) {
  // Set string
  return this;
}
```

--------------------------------

### Open a menu with SimpleMenuProvider

Source: https://docs.minecraftforge.net/en/1.21.x/gui/menus/

Opens a menu on the server using ServerPlayer#openMenu with a SimpleMenuProvider. The provider takes a method reference to create the server menu and a translatable component for the title. Use the FriendlyByteBuf overload only if the menu type was created with an IContainerFactory.

```java
// In some implementation
serverPlayer.openMenu(new SimpleMenuProvider(
  (containerId, playerInventory, player) -> new MyMenu(containerId, playerInventory),
  Component.translatable("menu.title.examplemod.mymenu")
));
```

--------------------------------

### Example encoded value for default codec

Source: https://docs.minecraftforge.net/en/1.21.x/datastorage/codecs/

Shows that a non-integer value defaults to 0.

```javascript
// Not an integer, defaults to 0
"value"
```

--------------------------------

### Block#defaultBlockState()

Source: https://docs.minecraftforge.net/en/1.21.x/blocks/states/

Gets the default BlockState for a Block. This is the state with all properties set to their default values.

```APIDOC
## Block#defaultBlockState()

### Description
Gets the default BlockState for a Block. This is the state with all properties set to their default values.

### Method
`defaultBlockState`

### Parameters
None.

### Returns
- (BlockState) - The default BlockState for this block.
```

--------------------------------

### Screen init Method

Source: https://docs.minecraftforge.net/en/1.21.x/gui/screens/

Override the init method to add widgets and precompute values. Call super.init() first. Use addRenderableWidget to add interactive, narrated, and rendered widgets.

```java
// In some Screen subclass
@Override
protected void init() {
    super.init();

    // Add widgets and precomputed values
    this.addRenderableWidget(new EditBox(/* ... */));
}
```

--------------------------------

### LootTableSubProvider Implementation

Source: https://docs.minecraftforge.net/en/1.21.x/datagen/server/loottables/

Shows how to implement a LootTableSubProvider to generate loot tables.

```APIDOC
## LootTableSubProvider Implementation

### Description
Defines a custom LootTableSubProvider that generates loot tables using a writer BiConsumer.

### Method
generate(BiConsumer<ResourceLocation, LootTable.Builder> writer)

### Parameters
- **writer** (BiConsumer<ResourceLocation, LootTable.Builder>) - Required - The writer used to accept generated loot tables.

### Code Example
```java
public class ExampleSubProvider implements LootTableSubProvider {

  // Used to create a factory method for the wrapping Supplier
  public ExampleSubProvider() {}

  // The method used to generate the loot tables
  @Override
  public void generate(BiConsumer<ResourceLocation, LootTable.Builder> writer) {
    // Generate loot tables here by calling writer#accept
  }
}
```
```

--------------------------------

### EntityLootSubProvider Constructor

Source: https://docs.minecraftforge.net/en/1.21.x/datagen/server/loottables/

Constructor for an EntityLootSubProvider subclass. Takes a FeatureFlagSet to determine which entity types get loot tables.

```java
// In some EntityLootSubProvider subclass
public MyEntityLootSubProvider() {
  super(FeatureFlags.REGISTRY.allFlags());
}
```

--------------------------------

### Item exists condition forge:item_exists

Source: https://docs.minecraftforge.net/en/1.21.x/resources/server/conditional/

Returns true if the given item has been registered. The example checks for 'examplemod:example_item'.

```json
{
  "type": "forge:item_exists",
   // Returns true if 'examplemod:example_item' has been registered
  "item": "examplemod:example_item"
}
```

--------------------------------

### Create SimpleChannel instance

Source: https://docs.minecraftforge.net/en/1.21.x/networking/simpleimpl/

Creates a SimpleChannel using NetworkRegistry.newSimpleChannel with a protocol version string and equality predicates for client and server compatibility. The channel name is 'mymodid:main'. The version checker compares the PROTOCOL_VERSION field directly, so client and server versions must match or FML denies login.

```java
private static final String PROTOCOL_VERSION = "1";
public static final SimpleChannel INSTANCE = NetworkRegistry.newSimpleChannel(
  ResourceLocation.fromNamespaceAndPath("mymodid", "main"),
  () -> PROTOCOL_VERSION,
  PROTOCOL_VERSION::equals,
  PROTOCOL_VERSION::equals
);
```

--------------------------------

### Mod loaded condition forge:mod_loaded

Source: https://docs.minecraftforge.net/en/1.21.x/resources/server/conditional/

Returns true if the mod with the given 'modid' is loaded. The example checks for 'examplemod'.

```json
{
  "type": "forge:mod_loaded",
   // Returns true if 'examplemod' is loaded
  "modid": "examplemod"
}
```

--------------------------------

### Example Recipe record implementing Recipe<Container>

Source: https://docs.minecraftforge.net/en/1.21.x/resources/server/recipes/custom/

A record-based implementation of the Recipe interface for a custom recipe. It holds an Ingredient, an int data field, and an ItemStack output. The methods for matching and assembling are to be implemented. The container passed in should be treated as immutable; use ItemStack#copy for mutable operations.

```java
public record ExampleRecipe(Ingredient input, int data, ItemStack output) implements Recipe<Container> {
  // Implement methods here
}
```
Tokens:
Raw