forestry.lepidopterology.genetics.alleles

Class AlleleButterflySpecies

java.lang.Object

forestry.core.genetics.alleles.Allele

forestry.core.genetics.alleles.AlleleSpecies

forestry.lepidopterology.genetics.alleles.AlleleButterflySpecies

All Implemented Interfaces:

IAllele, IAlleleSpecies, IAlleleSpeciesBuilder, IAlleleButterflySpecies, IAlleleButterflySpeciesBuilder

public class AlleleButterflySpecies
extends AlleleSpecies
implements IAlleleButterflySpecies, IAlleleButterflySpeciesBuilder

Constructor Summary

Constructors

Constructor and Description
AlleleButterflySpecies(java.lang.String uid, java.lang.String unlocalizedName, java.lang.String authority, java.lang.String unlocalizedDescription, java.lang.String modID, java.lang.String texturePath, boolean isDominant, IClassification branch, java.lang.String binomial, java.awt.Color serumColour)

Method Summary

Modifier and Type	Method and Description
AlleleButterflySpecies	addSpawnBiome(net.minecraftforge.common.BiomeDictionary.Type biomeTag)
AlleleButterflySpecies	addSpawnBiomes(java.util.Set<net.minecraftforge.common.BiomeDictionary.Type> biomeTags)
IAlleleButterflySpecies	build()
java.util.Map<net.minecraft.item.ItemStack,java.lang.Float>	getButterflyLoot()
java.util.Map<net.minecraft.item.ItemStack,java.lang.Float>	getCaterpillarLoot()
int	getComplexity() Complexity determines the difficulty researching a species.
java.lang.String	getEntityTexture()
float	getFlightDistance()
java.lang.String	getItemTexture()
float	getRarity()
net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	getResearchBounty(net.minecraft.world.World world, com.mojang.authlib.GameProfile researcher, IIndividual individual, int bountyLevel)
float	getResearchSuitability(net.minecraft.item.ItemStack itemstack)
IButterflyRoot	getRoot()
java.util.Set<net.minecraftforge.common.BiomeDictionary.Type>	getSpawnBiomes() Allows butterflies to restrict random spawns beyond the restrictions set by getTemperature() and getHumidity().
int	getSpriteColour(int renderPass)
boolean	isNocturnal()
boolean	isSecret()
void	registerSprites()
AlleleButterflySpecies	setFlightDistance(float flightDistance)
AlleleButterflySpecies	setNocturnal()
AlleleButterflySpecies	setRarity(float rarity)
boolean	strictSpawnMatch()

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

getAuthority, getBinomial, getBranch, getDescription, getHumidity, getTemperature, hasEffect, isCounted, 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.IAlleleSpecies

getAuthority, getBinomial, getBranch, getDescription, getHumidity, getTemperature, hasEffect, isCounted

Methods inherited from interface forestry.api.genetics.IAllele

getAlleleName, getModID, getName, getUID, getUnlocalizedName, isDominant

Methods inherited from interface forestry.api.genetics.IAlleleSpeciesBuilder

setComplexity, setHasEffect, setHumidity, setIsNotCounted, setIsSecret, setTemperature

Constructor Detail

AlleleButterflySpecies

public AlleleButterflySpecies(java.lang.String uid,
                              java.lang.String unlocalizedName,
                              java.lang.String authority,
                              java.lang.String unlocalizedDescription,
                              java.lang.String modID,
                              java.lang.String texturePath,
                              boolean isDominant,
                              IClassification branch,
                              java.lang.String binomial,
                              java.awt.Color serumColour)

Method Detail

build

public IAlleleButterflySpecies build()

Specified by:

build in interface IAlleleSpeciesBuilder

Specified by:

build in interface IAlleleButterflySpeciesBuilder

getRoot

public IButterflyRoot getRoot()

Specified by:

getRoot in interface IAlleleSpecies

Specified by:

getRoot in interface IAlleleButterflySpecies

Returns:

the IButterflyRoot

setRarity

public AlleleButterflySpecies setRarity(float rarity)

Specified by:

setRarity in interface IAlleleButterflySpeciesBuilder

setFlightDistance

public AlleleButterflySpecies setFlightDistance(float flightDistance)

Specified by:

setFlightDistance in interface IAlleleButterflySpeciesBuilder

setNocturnal

public AlleleButterflySpecies setNocturnal()

Specified by:

setNocturnal in interface IAlleleButterflySpeciesBuilder

addSpawnBiomes

public AlleleButterflySpecies addSpawnBiomes(java.util.Set<net.minecraftforge.common.BiomeDictionary.Type> biomeTags)

addSpawnBiome

public AlleleButterflySpecies addSpawnBiome(net.minecraftforge.common.BiomeDictionary.Type biomeTag)

getEntityTexture

public java.lang.String getEntityTexture()

Specified by:

getEntityTexture in interface IAlleleButterflySpecies

Returns:

Path of the texture to use for entity rendering.

getItemTexture

public java.lang.String getItemTexture()

Specified by:

getItemTexture in interface IAlleleButterflySpecies

Returns:

Path of the texture to use for item model.

getSpawnBiomes

public java.util.Set<net.minecraftforge.common.BiomeDictionary.Type> getSpawnBiomes()

Description copied from interface: IAlleleButterflySpecies

Allows butterflies to restrict random spawns beyond the restrictions set by getTemperature() and getHumidity().

Specified by:

getSpawnBiomes in interface IAlleleButterflySpecies

Returns:

EnumSet of biome tags this butterfly species can be spawned in.

strictSpawnMatch

public boolean strictSpawnMatch()

Specified by:

strictSpawnMatch in interface IAlleleButterflySpecies

Returns:

true if a prospective spawn biome must not match a biome tag outside of getSpawnBiomes.

getComplexity

public int getComplexity()

Description copied from interface: IAlleleSpecies

Complexity determines the difficulty researching a species. The values of primary and secondary are added together (and rounded) to determine the amount of pairs needed for successful research.

Specified by:

getComplexity in interface IAlleleSpecies

Overrides:

getComplexity in class AlleleSpecies

Returns:

Values between 3 - 11 are useful.

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.

getResearchBounty

public net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> getResearchBounty(net.minecraft.world.World world,
                                                                                      com.mojang.authlib.GameProfile researcher,
                                                                                      IIndividual individual,
                                                                                      int bountyLevel)

Specified by:

getResearchBounty in interface IAlleleSpecies

Overrides:

getResearchBounty in class AlleleSpecies

Returns:

itemstacks representing the bounty for this research success.

isSecret

public boolean isSecret()

Specified by:

isSecret in interface IAlleleSpecies

Overrides:

isSecret in class AlleleSpecies

Returns:

true if the species should not be displayed in NEI or creative inventory.

getRarity

public float getRarity()

Specified by:

getRarity in interface IAlleleButterflySpecies

Returns:

Float between 0 and 1 representing the rarity of the species, will affect spawn rate.

getFlightDistance

public float getFlightDistance()

Specified by:

getFlightDistance in interface IAlleleButterflySpecies

Returns:

Float representing the distance below which this butterfly will take flight if it detects a player which is not sneaking.

isNocturnal

public boolean isNocturnal()

Specified by:

isNocturnal in interface IAlleleButterflySpecies

Returns:

true if this species is only active at night.

getButterflyLoot

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

Specified by:

getButterflyLoot in interface IAlleleButterflySpecies

Returns:

The loot that drops if you kill a butterfly.

getCaterpillarLoot

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

Specified by:

getCaterpillarLoot in interface IAlleleButterflySpecies

Returns:

The loot that drops if you destroy a leaf that contains a caterpillar.

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.

registerSprites

public void registerSprites()

Specified by:

registerSprites in interface IAlleleButterflySpecies