forestry.arboriculture

Class FruitProviderNone

java.lang.Object

forestry.arboriculture.FruitProviderNone

All Implemented Interfaces:

IFruitProvider

Direct Known Subclasses:

FruitProviderPod, FruitProviderRipening

public class FruitProviderNone
extends java.lang.Object
implements IFruitProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected int	ripeningPeriod

Constructor Summary

Constructors

Constructor and Description
FruitProviderNone(java.lang.String unlocalizedDescription, IFruitFamily family)

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()
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 IFruitProvider.getSprite(ITreeGenome, IBlockAccess, BlockPos, int).
boolean	requiresFruitBlocks()
IFruitProvider	setOverlay(java.lang.String ident)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface forestry.api.arboriculture.IFruitProvider

getFruitChance

Field Detail

ripeningPeriod

protected int ripeningPeriod

Constructor Detail

FruitProviderNone

public FruitProviderNone(java.lang.String unlocalizedDescription,
                         IFruitFamily family)

Method Detail

setOverlay

public IFruitProvider setOverlay(java.lang.String ident)

getFamily

public IFruitFamily getFamily()

Specified by:

getFamily in interface IFruitProvider

Returns:

The fruit family of this fruit.

getFruits

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

Description copied from interface: IFruitProvider

Returns all drops of this block if you harvest it.

Specified by:

getFruits in interface IFruitProvider

Parameters:

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

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

requiresFruitBlocks

public boolean requiresFruitBlocks()

Specified by:

requiresFruitBlocks in interface IFruitProvider

Returns:

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

trySpawnFruitBlock

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

Description copied from interface: IFruitProvider

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()

Specified by:

trySpawnFruitBlock in interface IFruitProvider

Returns:

true if a fruit block was spawned, false otherwise.

getColour

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

Description copied from interface: IFruitProvider

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

Specified by:

getColour in interface IFruitProvider

Parameters:

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

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

getDecorativeColor

public int getDecorativeColor()

Description copied from interface: IFruitProvider

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

Specified by:

getDecorativeColor in interface IFruitProvider

isFruitLeaf

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

Description copied from interface: IFruitProvider

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

Specified by:

isFruitLeaf in interface IFruitProvider

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.

getRipeningPeriod

public int getRipeningPeriod()

Specified by:

getRipeningPeriod in interface IFruitProvider

Returns:

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

getProducts

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

Description copied from interface: IFruitProvider

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

Specified by:

getProducts in interface IFruitProvider

Returns:

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

getSpecialty

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

Description copied from interface: IFruitProvider

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

Specified by:

getSpecialty in interface IFruitProvider

Returns:

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

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IFruitProvider

Returns:

Short, human-readable identifier used in the treealyzer.

getSprite

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

Specified by:

getSprite in interface IFruitProvider

ripeningTime - Elapsed ripening time for the fruit.

Returns:

ResourceLocation of the texture to overlay on the leaf block.

getDecorativeSprite

public net.minecraft.util.ResourceLocation getDecorativeSprite()

Description copied from interface: IFruitProvider

return the ResourceLocation to display on decorative leaves

Specified by:

getDecorativeSprite in interface IFruitProvider

registerSprites

public void registerSprites()

Description copied from interface: IFruitProvider

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

Specified by:

registerSprites in interface IFruitProvider

getModelName

@Nullable
public java.lang.String getModelName()

Specified by:

getModelName in interface IFruitProvider

Returns:

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

getModID

public java.lang.String getModID()

Specified by:

getModID in interface IFruitProvider

Returns:

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