Package org.geysermc.geyser.api.item.custom.v2.component.geyser

Interface GeyserBlockPlacer

public interface GeyserBlockPlacer
Allows modifying items so these can place blocks or take on the icon of the block they place.
Since:
2.9.3

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    GeyserBlockPlacer.Builder
    Builder for the block placer component.

  • Method Summary

    Modifier and Type
    Method
    Description
    Identifier
    block()
    The block placed by the item, used by the Bedrock client to predict block placing.
    static GeyserBlockPlacer.Builder
    builder()
    Creates a builder for the block placer component.
    static GeyserBlockPlacer
    of(Identifier block, boolean useBlockIcon)
    Creates a block placer component.
    boolean
    useBlockIcon()
    Whether to use the block's rendering as the icon for the item.

  • Method Details

    • block

      Identifier block()
      The block placed by the item, used by the Bedrock client to predict block placing. This is a Bedrock edition block identifier.
      Returns:
      the identifier of the block to place
      Since:
      2.9.3

    • useBlockIcon

      boolean useBlockIcon()
      Whether to use the block's rendering as the icon for the item. Defaults to false.
      Returns:
      whether to use the 3d block rendering for the item icon
      Since:
      2.9.3

    • builder

      static GeyserBlockPlacer.Builder builder()
      Creates a builder for the block placer component.
      Returns:
      a new builder
      Since:
      2.9.3

    • of

      static GeyserBlockPlacer of(Identifier block, boolean useBlockIcon)
      Creates a block placer component.
      Parameters:
      block - the identifier of the block to place
      useBlockIcon - whether to use the 3d block rendering for the item icon
      Returns:
      the block placer component
      Since:
      2.9.3