Package org.geysermc.geyser.api.block.custom

Interface CustomBlockData

All Known Subinterfaces:
NonVanillaCustomBlockData
public interface CustomBlockData
This class is used to store data for a custom block.

  • Method Details

    • name

      @NonNull String name()
      Gets the name of the custom block
      Returns:
      The name of the custom block.

    • identifier

      @NonNull String identifier()
      Gets the identifier of the custom block
      Returns:
      The identifier of the custom block.

    • includedInCreativeInventory

      boolean includedInCreativeInventory()
      Gets if the custom block is included in the creative inventory
      Returns:
      If the custom block is included in the creative inventory.

    • creativeCategory

      @Nullable CreativeCategory creativeCategory()
      Gets the block's creative category, or tab id.
      Returns:
      the block's creative category

    • creativeGroup

      @Nullable String creativeGroup()
      Gets the block's creative group.
      Returns:
      the block's creative group

    • components

      @Nullable CustomBlockComponents components()
      Gets the components of the custom block
      Returns:
      The components of the custom block.

    • properties

      @NonNull Map<String,CustomBlockProperty<?>> properties()
      Gets the custom block's map of block property names to CustomBlockProperty objects
      Returns:
      The custom block's map of block property names to CustomBlockProperty objects.

    • permutations

      @NonNull List<CustomBlockPermutation> permutations()
      Gets the list of the custom block's permutations
      Returns:
      The permutations of the custom block.

    • defaultBlockState

      @NonNull CustomBlockState defaultBlockState()
      Gets the custom block's default block state
      Returns:
      The default block state of the custom block.

    • blockStateBuilder

      @NonNull CustomBlockState.Builder blockStateBuilder()
      Gets a builder for a custom block state
      Returns:
      The builder for a custom block state.

    • builder

      static CustomBlockData.Builder builder()
      Create a Builder for CustomBlockData
      Returns:
      A CustomBlockData Builder