Package forestry.api.plugin

Interface IArboricultureRegistration

public interface IArboricultureRegistration
Register your tree species, fruits, and effects here.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    registerCharcoalPitWall(net.minecraft.world.level.block.Block block, int charcoal)
     
    void
    registerCharcoalPitWall(net.minecraft.world.level.block.state.BlockState state, int charcoal)
    Registers a material for use in a Log Pile charcoal pit.
    void
    registerFruit(net.minecraft.resources.ResourceLocation id, IFruit fruit)
    Register a new type of fruit.
    void
    registerRefractoryWaxable(net.minecraft.world.level.block.Block block, net.minecraft.world.level.block.Block waxedForm)
    Registers a block to be waxable with Refractory Wax.
    default ITreeSpeciesBuilder
    registerSpecies(net.minecraft.resources.ResourceLocation id, String genus, String species, boolean dominant, Color escritoireColor, IWoodType woodType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use the variant that accepts a TextColor
    ITreeSpeciesBuilder
    registerSpecies(net.minecraft.resources.ResourceLocation id, String genus, String species, boolean dominant, net.minecraft.network.chat.TextColor escritoireColor, IWoodType woodType)
    Register a new tree species.
    void
    registerTreeEffect(net.minecraft.resources.ResourceLocation id, ITreeEffect effect)
    Registers a tree effect.

  • Method Details

    • registerSpecies

      ITreeSpeciesBuilder registerSpecies(net.minecraft.resources.ResourceLocation id, String genus, String species, boolean dominant, net.minecraft.network.chat.TextColor escritoireColor, IWoodType woodType)
      Register a new tree species.
      Parameters:
      id - The unique ID of this species. The path must start with "tree_".
      genus - The genus of this species. See ForestryTaxa for examples.
      species - The species name of this species, used for scientific naming.
      dominant - Whether the allele for this species is dominant or recessive.
      escritoireColor - The primary color of this tree species. Used for pollen colors and tree leaf tinting.
      woodType - The wood type of this tree species.

    • registerSpecies

      @Deprecated(forRemoval=true) default ITreeSpeciesBuilder registerSpecies(net.minecraft.resources.ResourceLocation id, String genus, String species, boolean dominant, Color escritoireColor, IWoodType woodType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use the variant that accepts a TextColor

    • registerFruit

      void registerFruit(net.minecraft.resources.ResourceLocation id, IFruit fruit)
      Register a new type of fruit.
      Parameters:
      id - The unique ID of this fruit. See ForestryFruits for defaults.
      fruit - The fruit object to be wrapped in an allele for use in a tree genome.

    • registerTreeEffect

      void registerTreeEffect(net.minecraft.resources.ResourceLocation id, ITreeEffect effect)
      Registers a tree effect. There are no tree effects in base Forestry.
      Parameters:
      id - The unique ID of this tree effect.
      effect - The effect object to be wrapped in an allele for use in a tree genome.

    • registerRefractoryWaxable

      void registerRefractoryWaxable(net.minecraft.world.level.block.Block block, net.minecraft.world.level.block.Block waxedForm)
      Registers a block to be waxable with Refractory Wax. In base Forestry, all planks are registered to be waxed into their fireproof counterparts.
      Parameters:
      block - The unwaxed block, such as Oak Planks
      waxedForm - The waxed block, such as Oak Planks (Fireproof)
      Since:
      2.6.0

    • registerCharcoalPitWall

      void registerCharcoalPitWall(net.minecraft.world.level.block.state.BlockState state, int charcoal)
      Registers a material for use in a Log Pile charcoal pit.
      Parameters:
      state - The state used to surround a pit of burning Log Pile blocks when making charcoal.
      charcoal - The amount of charcoal produced when using this block.
      Since:
      2.6.0

    • registerCharcoalPitWall

      default void registerCharcoalPitWall(net.minecraft.world.level.block.Block block, int charcoal)
      Since:
      2.6.0