How to make an item that gives the player another item (Minecraft mod)
Giving the player an item takes two steps: add a stack to the inventory (player.addItem(stack), which returns false if it did not fit), then drop it on the ground (player.drop(stack, false)). Build the stack with new ItemStack(Items.DIAMOND, 3). Run it on the server so the inventory and the client stay in sync. On 1.12.2 the calls have other names (see its notes).
Works on Minecraft 1.20.1 to 26.3 on NeoForge; Minecraft 1.16.5 to 26.3 on Fabric; Minecraft 1.16.5 to 1.20.1 on Forge; Minecraft 1.12.2 on Forge. Each example was compiled against its loader and version before it shipped in Linen.
- Override use and work only on the server.
- Build the reward as new ItemStack(item, count).
- Try player.addItem; drop it when the inventory is full.
- Shrink the used item.
For each loader and version
Section titled “For each loader and version”The example mod is examplemod in the package com.example.examplemod. Use your own mod id and package.
Fabric and NeoForge 1.20.4 to 1.21.1, NeoForge 1.20.1 to 1.20.2, Forge 1.17.1 to 1.20.1, Fabric 1.17 to 1.20.3
Section titled “Fabric and NeoForge 1.20.4 to 1.21.1, NeoForge 1.20.1 to 1.20.2, Forge 1.17.1 to 1.20.1, Fabric 1.17 to 1.20.3”Uses:
Player.addItemPlayer.dropItemStack.shrink
src/main/java/com/example/examplemod/item/GiftBoxItem.java
package com.example.examplemod.item;
import net.minecraft.server.level.ServerLevel;import net.minecraft.core.BlockPos;import net.minecraft.network.chat.Component;import net.minecraft.world.InteractionHand;import net.minecraft.world.InteractionResult;import net.minecraft.world.InteractionResultHolder;import net.minecraft.world.entity.EntityType;import net.minecraft.world.entity.MobSpawnType;import net.minecraft.world.entity.player.Player;import net.minecraft.world.item.Item;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.context.UseOnContext;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.Blocks;import net.minecraft.world.phys.BlockHitResult;import net.minecraft.world.phys.HitResult;import net.minecraft.world.phys.Vec3;
// Gift Box: right-click to receive 3 diamonds and use up the item.public class GiftBoxItem extends Item { public GiftBoxItem(Item.Properties properties) { super(properties); }
@Override public InteractionResultHolder<ItemStack> use(Level level, Player player, InteractionHand hand) { ItemStack stack = player.getItemInHand(hand); if (!level.isClientSide()) { ItemStack reward = new ItemStack(net.minecraft.world.item.Items.DIAMOND, 3); if (!player.addItem(reward)) { player.drop(reward, false); } if (!player.getAbilities().instabuild) { stack.shrink(1); } } return InteractionResultHolder.sidedSuccess(player.getItemInHand(hand), level.isClientSide()); }}It’s registered like any other item, as GiftBoxItem: see a new item.
Fabric and NeoForge 1.21.2 to 26.2
Section titled “Fabric and NeoForge 1.21.2 to 26.2”Uses:
Player.addItemPlayer.dropItemStack.shrink
src/main/java/com/example/examplemod/item/GiftBoxItem.java
package com.example.examplemod.item;
import net.minecraft.server.level.ServerLevel;import net.minecraft.core.BlockPos;import net.minecraft.network.chat.Component;import net.minecraft.world.InteractionHand;import net.minecraft.world.InteractionResult;import net.minecraft.world.InteractionResult;import net.minecraft.world.entity.EntityType;import net.minecraft.world.entity.EntitySpawnReason;import net.minecraft.world.entity.player.Player;import net.minecraft.world.item.Item;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.context.UseOnContext;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.Blocks;import net.minecraft.world.phys.BlockHitResult;import net.minecraft.world.phys.HitResult;import net.minecraft.world.phys.Vec3;
// Gift Box: right-click to receive 3 diamonds and use up the item.public class GiftBoxItem extends Item { public GiftBoxItem(Item.Properties properties) { super(properties); }
@Override public InteractionResult use(Level level, Player player, InteractionHand hand) { ItemStack stack = player.getItemInHand(hand); if (!level.isClientSide()) { ItemStack reward = new ItemStack(net.minecraft.world.item.Items.DIAMOND, 3); if (!player.addItem(reward)) { player.drop(reward, false); } if (!player.getAbilities().instabuild) { stack.shrink(1); } } return InteractionResult.SUCCESS; }}It’s registered like any other item, as GiftBoxItem: see a new item.
Fabric and NeoForge 26.3
Section titled “Fabric and NeoForge 26.3”Uses:
Player.addItemPlayer.dropItemStack.shrink
Since 26.3 Player#drop takes a third argument, a Prediction; this code runs on the server only, so it passes Prediction.SERVER_ONLY.
src/main/java/com/example/examplemod/item/GiftBoxItem.java
package com.example.examplemod.item;
import net.minecraft.util.Prediction;import net.minecraft.world.InteractionHand;import net.minecraft.world.InteractionResult;import net.minecraft.world.entity.player.Player;import net.minecraft.world.item.Item;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.Items;import net.minecraft.world.level.Level;
// Gift Box: right-click to receive 3 diamonds and use up the item.public class GiftBoxItem extends Item { public GiftBoxItem(Item.Properties properties) { super(properties); }
@Override public InteractionResult use(Level level, Player player, InteractionHand hand) { ItemStack stack = player.getItemInHand(hand); if (!level.isClientSide()) { ItemStack reward = new ItemStack(Items.DIAMOND, 3); if (!player.addItem(reward)) { player.drop(reward, false, Prediction.SERVER_ONLY); } if (!player.getAbilities().instabuild) { stack.shrink(1); } } return InteractionResult.SUCCESS; }}It’s registered like any other item, as GiftBoxItem: see a new item.
Forge 1.16.5
Section titled “Forge 1.16.5”Uses:
PlayerEntity.addItemPlayerEntity.dropItemStack.shrink
src/main/java/com/example/examplemod/item/GiftBoxItem.java
package com.example.examplemod.item;
import net.minecraft.util.Hand;import net.minecraft.util.ActionResult;import net.minecraft.entity.player.PlayerEntity;import net.minecraft.item.Item;import net.minecraft.item.ItemStack;import net.minecraft.world.World;
// Gift Box: right-click to receive 3 diamonds and use up the item.public class GiftBoxItem extends Item { public GiftBoxItem(Item.Properties properties) { super(properties); }
@Override public ActionResult<ItemStack> use(World world, PlayerEntity player, Hand hand) { ItemStack stack = player.getItemInHand(hand); if (!world.isClientSide()) { ItemStack reward = new ItemStack(net.minecraft.item.Items.DIAMOND, 3); if (!player.addItem(reward)) { player.drop(reward, false); } if (!player.abilities.instabuild) { stack.shrink(1); } } return ActionResult.sidedSuccess(player.getItemInHand(hand), world.isClientSide()); }}It’s registered like any other item, as GiftBoxItem: see a new item.
Fabric 1.16.5
Section titled “Fabric 1.16.5”Uses:
Player.addItemPlayer.dropItemStack.shrink
src/main/java/com/example/examplemod/item/GiftBoxItem.java
package com.example.examplemod.item;
import net.minecraft.server.level.ServerLevel;import net.minecraft.core.BlockPos;import net.minecraft.network.chat.Component;import net.minecraft.world.InteractionHand;import net.minecraft.world.InteractionResult;import net.minecraft.world.InteractionResultHolder;import net.minecraft.world.entity.EntityType;import net.minecraft.world.entity.MobSpawnType;import net.minecraft.world.entity.player.Player;import net.minecraft.world.item.Item;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.context.UseOnContext;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.Blocks;import net.minecraft.world.phys.BlockHitResult;import net.minecraft.world.phys.HitResult;import net.minecraft.world.phys.Vec3;
// Gift Box: right-click to receive 3 diamonds and use up the item.public class GiftBoxItem extends Item { public GiftBoxItem(Item.Properties properties) { super(properties); }
@Override public InteractionResultHolder<ItemStack> use(Level level, Player player, InteractionHand hand) { ItemStack stack = player.getItemInHand(hand); if (!level.isClientSide()) { ItemStack reward = new ItemStack(net.minecraft.world.item.Items.DIAMOND, 3); if (!player.addItem(reward)) { player.drop(reward, false); } if (!player.abilities.instabuild) { stack.shrink(1); } } return InteractionResultHolder.sidedSuccess(player.getItemInHand(hand), level.isClientSide()); }}It’s registered like any other item, as GiftBoxItem: see a new item.
Forge 1.12.2
Section titled “Forge 1.12.2”Uses:
EntityPlayer.addItemEntityPlayer.dropItemStack.shrink
In 1.12.2 the calls are player.addItemStackToInventory(stack) and player.dropItem(stack, false).
src/main/java/com/example/examplemod/item/GiftBoxItem.java
package com.example.examplemod.item;
import net.minecraft.util.EnumActionResult;
import net.minecraft.util.EnumHand;import net.minecraft.util.ActionResult;import net.minecraft.entity.player.EntityPlayer;import net.minecraft.item.Item;import net.minecraft.item.ItemStack;import net.minecraft.world.World;
// Gift Box: right-click to receive 3 diamonds and use up the item.public class GiftBoxItem extends Item { @Override public ActionResult<ItemStack> onItemRightClick(World world, EntityPlayer player, EnumHand hand) { ItemStack stack = player.getHeldItem(hand); if (!world.isRemote) { ItemStack reward = new ItemStack(net.minecraft.init.Items.DIAMOND, 3); if (!player.addItemStackToInventory(reward)) { player.dropItem(reward, false); } if (!player.capabilities.isCreativeMode) { stack.shrink(1); } } return new ActionResult<>(EnumActionResult.SUCCESS, player.getHeldItem(hand)); }}It’s registered like any other item, as GiftBoxItem: see a new item.
Sources
Section titled “Sources”- https://docs.neoforged.net/docs/1.21.1/items/interactions
- https://docs.fabricmc.net/1.21.1/develop/items/first-item
Related how-tos
Section titled “Related how-tos”- An item that heals you when you use it
- An item that fills the hunger bar
- An item that launches you into the air
- An item that teleports you forward
- Show a message above the hotbar
In Linen
Section titled “In Linen”Linen’s How-tos library has this page too, with the example for your own mod’s loader and Minecraft version. Hover a name in your code and Linen points to the how-tos that explain it. Both are free. Download Linen.