forestry.arboriculture.genetics.alleles

Class AlleleTreeSpecies

java.lang.Object

forestry.core.genetics.alleles.Allele

forestry.core.genetics.alleles.AlleleSpecies

forestry.arboriculture.genetics.alleles.AlleleTreeSpecies

All Implemented Interfaces:

IAlleleTreeSpecies, IAlleleTreeSpeciesBuilder, IAllele, IAlleleProperty<IAlleleTreeSpecies>, IAlleleSpecies, IAlleleSpeciesBuilder, java.lang.Comparable<IAlleleTreeSpecies>

public class AlleleTreeSpecies
extends AlleleSpecies
implements IAlleleTreeSpeciesBuilder, IAlleleTreeSpecies

Constructor Summary

Constructors

Constructor and Description

AlleleTreeSpecies(java.lang.String uid, java.lang.String unlocalizedName, java.lang.String authority, java.lang.String unlocalizedDescription, boolean isDominant, IClassification branch, java.lang.String binomial, java.lang.String modID, ILeafSpriteProvider leafIconProvider, IGermlingModelProvider germlingModelProvider, IWoodProvider woodProvider, ITreeGenerator generator, ILeafProvider leafProvider)

Method Summary

Modifier and Type	Method and Description
AlleleTreeSpecies	addFruitFamily(IFruitFamily family) Add a fruit family for this tree.
IAlleleTreeSpecies	build()
int	compareTo(IAlleleTreeSpecies o) To compare the allele for the properties
ITreeGenerator	getGenerator()
int	getGermlingColour(EnumGermlingType type, int renderPass)
net.minecraft.client.renderer.block.model.ModelResourceLocation	getGermlingModel(EnumGermlingType type)
IGrowthProvider	getGrowthProvider()
ILeafProvider	getLeafProvider()
ILeafSpriteProvider	getLeafSpriteProvider()
net.minecraftforge.common.EnumPlantType	getPlantType()
float	getRarity()
float	getResearchSuitability(net.minecraft.item.ItemStack itemstack)
ITreeRoot	getRoot()
int	getSpriteColour(int renderPass)
java.util.List<IFruitFamily>	getSuitableFruit()
IWoodProvider	getWoodProvider()
void	registerModels(net.minecraft.item.Item item, IModelManager manager, EnumGermlingType type)
IAlleleTreeSpeciesBuilder	setGrowthProvider(IGrowthProvider growthProvider) Set the growth provider.
AlleleTreeSpecies	setPlantType(net.minecraftforge.common.EnumPlantType type) Set the minecraft plant type for this tree.
IAlleleTreeSpeciesBuilder	setRarity(float rarity) Set rarity of the species, will affect spawn rate in the world.

Methods inherited from class forestry.core.genetics.alleles.AlleleSpecies

getAuthority, getBinomial, getBranch, getComplexity, getDescription, getHumidity, getResearchBounty, getTemperature, hasEffect, isCounted, isSecret, setComplexity, setHasEffect, setHumidity, setIsNotCounted, setIsSecret, setTemperature

Methods inherited from class forestry.core.genetics.alleles.Allele

getAlleleName, getModID, getName, getUID, getUnlocalizedName, isDominant, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface forestry.api.genetics.IAlleleSpeciesBuilder

setComplexity, setHasEffect, setHumidity, setIsNotCounted, setIsSecret, setTemperature

Methods inherited from interface forestry.api.genetics.IAlleleSpecies

getAuthority, getBinomial, getBranch, getComplexity, getDescription, getHumidity, getResearchBounty, getTemperature, hasEffect, isCounted, isSecret

Methods inherited from interface forestry.api.genetics.IAllele

getAlleleName, getModID, getName, getUID, getUnlocalizedName, isDominant

Constructor Detail

AlleleTreeSpecies

public AlleleTreeSpecies(java.lang.String uid,
                         java.lang.String unlocalizedName,
                         java.lang.String authority,
                         java.lang.String unlocalizedDescription,
                         boolean isDominant,
                         IClassification branch,
                         java.lang.String binomial,
                         java.lang.String modID,
                         ILeafSpriteProvider leafIconProvider,
                         IGermlingModelProvider germlingModelProvider,
                         IWoodProvider woodProvider,
                         ITreeGenerator generator,
                         @Nullable
                         ILeafProvider leafProvider)

Method Detail

build

public IAlleleTreeSpecies build()

Specified by:

build in interface IAlleleTreeSpeciesBuilder

Specified by:

build in interface IAlleleSpeciesBuilder

getRoot

public ITreeRoot getRoot()

Specified by:

getRoot in interface IAlleleTreeSpecies

Specified by:

getRoot in interface IAlleleSpecies

Returns:

the ISpeciesRoot associated with this species.

setPlantType

public AlleleTreeSpecies setPlantType(net.minecraftforge.common.EnumPlantType type)

Description copied from interface: IAlleleTreeSpeciesBuilder

Set the minecraft plant type for this tree. Default is Plains.

Specified by:

setPlantType in interface IAlleleTreeSpeciesBuilder

addFruitFamily

public AlleleTreeSpecies addFruitFamily(IFruitFamily family)

Description copied from interface: IAlleleTreeSpeciesBuilder

Add a fruit family for this tree. Trees can have multiple fruit families.

Specified by:

addFruitFamily in interface IAlleleTreeSpeciesBuilder

setRarity

public IAlleleTreeSpeciesBuilder setRarity(float rarity)

Description copied from interface: IAlleleTreeSpeciesBuilder

Set rarity of the species, will affect spawn rate in the world. Must be a float between 0 and 1. If it's 0, it will not spawn.

Specified by:

setRarity in interface IAlleleTreeSpeciesBuilder

getRarity

public float getRarity()

Specified by:

getRarity in interface IAlleleTreeSpecies

Returns:

Float between 0 and 1 representing the rarity of the species, will affect spawn rate. If it's 0, it will not spawn.

setGrowthProvider

public IAlleleTreeSpeciesBuilder setGrowthProvider(IGrowthProvider growthProvider)

Description copied from interface: IAlleleTreeSpeciesBuilder

Set the growth provider.

Specified by:

setGrowthProvider in interface IAlleleTreeSpeciesBuilder

getGrowthProvider

public IGrowthProvider getGrowthProvider()

Specified by:

getGrowthProvider in interface IAlleleTreeSpecies

getPlantType

public net.minecraftforge.common.EnumPlantType getPlantType()

Specified by:

getPlantType in interface IAlleleTreeSpecies

Returns:

Native plant type of this species.

getSuitableFruit

public java.util.List<IFruitFamily> getSuitableFruit()

Specified by:

getSuitableFruit in interface IAlleleTreeSpecies

Returns:

List of all IFruitFamilys which can grow on leaves generated by this species.

getGenerator

public ITreeGenerator getGenerator()

Specified by:

getGenerator in interface IAlleleTreeSpecies

Returns:

Tree generator for this species.

getLeafSpriteProvider

public ILeafSpriteProvider getLeafSpriteProvider()

Specified by:

getLeafSpriteProvider in interface IAlleleTreeSpecies

getSpriteColour

public int getSpriteColour(int renderPass)

Specified by:

getSpriteColour in interface IAlleleSpecies

Parameters:

renderPass - Render pass to get the colour for.

Returns:

Colour to use for the render pass.

getGermlingModel

public net.minecraft.client.renderer.block.model.ModelResourceLocation getGermlingModel(EnumGermlingType type)

Specified by:

getGermlingModel in interface IAlleleTreeSpecies

getGermlingColour

public int getGermlingColour(EnumGermlingType type,
                             int renderPass)

Specified by:

getGermlingColour in interface IAlleleTreeSpecies

registerModels

public void registerModels(net.minecraft.item.Item item,
                           IModelManager manager,
                           EnumGermlingType type)

Specified by:

registerModels in interface IAlleleTreeSpecies

getWoodProvider

public IWoodProvider getWoodProvider()

Specified by:

getWoodProvider in interface IAlleleTreeSpecies

getLeafProvider

public ILeafProvider getLeafProvider()

Specified by:

getLeafProvider in interface IAlleleTreeSpecies

getResearchSuitability

public float getResearchSuitability(net.minecraft.item.ItemStack itemstack)

Specified by:

getResearchSuitability in interface IAlleleSpecies

Overrides:

getResearchSuitability in class AlleleSpecies

Returns:

A float signifying the chance for the passed itemstack to yield a research success.

compareTo

public int compareTo(IAlleleTreeSpecies o)

Description copied from interface: IAlleleProperty

To compare the allele for the properties

Specified by:

compareTo in interface IAlleleProperty<IAlleleTreeSpecies>

Specified by:

compareTo in interface java.lang.Comparable<IAlleleTreeSpecies>