forestry.api.arboriculture

Interface IFruitProvider

All Known Implementing Classes:

FruitProviderNone, FruitProviderPod, FruitProviderRipening

public interface IFruitProvider

Provides all information that is needed to spawn a fruit leaves / pod block in the world.

Method Summary

Modifier and Type	Method and Description
int	getColour(ITreeGenome genome, net.minecraft.world.IBlockAccess world, net.minecraft.util.math.BlockPos pos, int ripeningTime) Returns the color of the fruit spite based on the ripening time of the fruit.
int	getDecorativeColor() return the color to use for decorative leaves.
net.minecraft.util.ResourceLocation	getDecorativeSprite() return the ResourceLocation to display on decorative leaves
java.lang.String	getDescription()
IFruitFamily	getFamily()
default float	getFruitChance(ITreeGenome genome, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) The chance that this leaves contains fruits or the chance that a pod block spawns.
net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	getFruits(ITreeGenome genome, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int ripeningTime) Returns all drops of this block if you harvest it.
java.lang.String	getModelName()
java.lang.String	getModID()
java.util.Map<net.minecraft.item.ItemStack,java.lang.Float>	getProducts() A unmodifiable map that contains all products and their associated drop chances.
int	getRipeningPeriod()
java.util.Map<net.minecraft.item.ItemStack,java.lang.Float>	getSpecialty() A unmodifiable map that contains all specialties and their associated drop chances.
net.minecraft.util.ResourceLocation	getSprite(ITreeGenome genome, net.minecraft.world.IBlockAccess world, net.minecraft.util.math.BlockPos pos, int ripeningTime)
boolean	isFruitLeaf(ITreeGenome genome, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Determines if fruit block of this provider is considered a leaf block.
void	registerSprites() Can be used to register the sprite/s that can be returned with getSprite(ITreeGenome, IBlockAccess, BlockPos, int).
boolean	requiresFruitBlocks()
boolean	trySpawnFruitBlock(ITreeGenome genome, net.minecraft.world.World world, java.util.Random rand, net.minecraft.util.math.BlockPos pos) Tries to spawn a fruit block at the potential position when the tree generates.

Method Detail

getFamily

IFruitFamily getFamily()

Returns:

The fruit family of this fruit.

getColour

int getColour(ITreeGenome genome,
              net.minecraft.world.IBlockAccess world,
              net.minecraft.util.math.BlockPos pos,
              int ripeningTime)

Returns the color of the fruit spite based on the ripening time of the fruit.

Parameters:

genome - The genome of the tree of the pod / leaves block.

ripeningTime - The ripening time of the leaves / pod block. From 0 to getRipeningPeriod().

getDecorativeColor

int getDecorativeColor()

return the color to use for decorative leaves. Usually the ripe color.

isFruitLeaf

boolean isFruitLeaf(ITreeGenome genome,
                    net.minecraft.world.World world,
                    net.minecraft.util.math.BlockPos pos)

Determines if fruit block of this provider is considered a leaf block.

Parameters:

genome - The genome of the tree of the pod / leaves block.

world - The world in that the pod / leaves block is located.

pos - The position of the pod / leaves block.

Returns:

True if this provider provides a fruit leaf for the given genome at the given position.

getFruitChance

default float getFruitChance(ITreeGenome genome,
                             net.minecraft.world.World world,
                             net.minecraft.util.math.BlockPos pos)

The chance that this leaves contains fruits or the chance that a pod block spawns.

Parameters:

genome - The genome of the tree of the pod / leaves block.

Returns:

The chance that this leaves contains fruits or the chance that a pod block spawns.

getRipeningPeriod

int getRipeningPeriod()

Returns:

How many successful ripening block ticks a fruit needs to be ripe.

getProducts

java.util.Map<net.minecraft.item.ItemStack,java.lang.Float> getProducts()

A unmodifiable map that contains all products and their associated drop chances.

Returns:

A unmodifiable map that contains all products and their associated drop chances.

getSpecialty

java.util.Map<net.minecraft.item.ItemStack,java.lang.Float> getSpecialty()

A unmodifiable map that contains all specialties and their associated drop chances.

Returns:

A unmodifiable map that contains all products and their associated drop chances.

getFruits

net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> getFruits(ITreeGenome genome,
                                                                       net.minecraft.world.World world,
                                                                       net.minecraft.util.math.BlockPos pos,
                                                                       int ripeningTime)

Returns all drops of this block if you harvest it.

Parameters:

genome - The genome of the tree of the leaves / pod.

ripeningTime - The repining time of the block. From 0 to getRipeningPeriod().

getDescription

java.lang.String getDescription()

Returns:

Short, human-readable identifier used in the treealyzer.

getModelName

@Nullable
java.lang.String getModelName()

Returns:

The location of the pod model in the "modid:pods/" folder.

getModID

java.lang.String getModID()

Returns:

The mod id of that adds this fruit provider. Needed for the allele of this fruit.

getSprite

@Nullable
net.minecraft.util.ResourceLocation getSprite(ITreeGenome genome,
                                                        net.minecraft.world.IBlockAccess world,
                                                        net.minecraft.util.math.BlockPos pos,
                                                        int ripeningTime)

Parameters:

ripeningTime - Elapsed ripening time for the fruit.

Returns:

ResourceLocation of the texture to overlay on the leaf block.

getDecorativeSprite

@Nullable
net.minecraft.util.ResourceLocation getDecorativeSprite()

return the ResourceLocation to display on decorative leaves

requiresFruitBlocks

boolean requiresFruitBlocks()

Returns:

true if this fruit provider requires fruit blocks to spawn, false otherwise.

trySpawnFruitBlock

boolean trySpawnFruitBlock(ITreeGenome genome,
                           net.minecraft.world.World world,
                           java.util.Random rand,
                           net.minecraft.util.math.BlockPos pos)

Tries to spawn a fruit block at the potential position when the tree generates. Spawning a fruit has a random chance of success based on ITreeGenome.getSappiness()

Returns:

true if a fruit block was spawned, false otherwise.

registerSprites

void registerSprites()

Can be used to register the sprite/s that can be returned with getSprite(ITreeGenome, IBlockAccess, BlockPos, int).