Package com.minecolonies.api.items

Interface IBlockOverlayItem

All Known Implementing Classes:
ItemScepterBeekeeper, ItemScepterLumberjack, ItemScepterPermission
public interface IBlockOverlayItem
An interface to be implemented by items that want to render overlays while the player is holding the item.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
    IBlockOverlayItem.OverlayBox
    Details about the overlay box to draw.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull List<IBlockOverlayItem.OverlayBox>
    getOverlayBoxes(@NotNull net.minecraft.world.level.Level world, @NotNull net.minecraft.world.entity.player.Player player, @NotNull net.minecraft.world.item.ItemStack stack)
    Called client-side only.

  • Method Details

    • getOverlayBoxes

      @NotNull @NotNull List<IBlockOverlayItem.OverlayBox> getOverlayBoxes(@NotNull @NotNull net.minecraft.world.level.Level world, @NotNull @NotNull net.minecraft.world.entity.player.Player player, @NotNull @NotNull net.minecraft.world.item.ItemStack stack)
      Called client-side only.
      Returns:
      a list of overlay boxes that should be rendered for this item.