forestry.api.genetics

Interface IBreedingTracker

All Known Subinterfaces:

IApiaristTracker, IArboristTracker, ILepidopteristTracker

All Known Implementing Classes:

ApiaristTracker, ArboristTracker, BreedingTracker, LepidopteristTracker

public interface IBreedingTracker

Keeps track of who bred, discovered, and researched which species in a world.

Method Summary

Modifier and Type	Method and Description
void	decodeFromNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)
void	encodeToNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)
default java.util.Collection<java.lang.String>	getDiscoveredSpecies()
java.lang.String	getModeName()
int	getSpeciesBred()
boolean	isDiscovered(IAlleleSpecies species) Queries the tracker for discovered species.
boolean	isDiscovered(IMutation mutation) Queries the tracker for discovered species.
boolean	isResearched(IMutation mutation)
void	registerBirth(IIndividual individual) Register the birth of an individual.
void	registerMutation(IMutation mutation) Register a successful mutation.
void	registerPickup(IIndividual individual) Register the pickup of an individual.
void	registerSpecies(IAlleleSpecies species) Marks a species as discovered.
void	researchMutation(IMutation mutation) Register a successfully researched mutation.
void	setModeName(java.lang.String name) Set the current IBeekeepingMode.
void	synchToPlayer(net.minecraft.entity.player.EntityPlayer player) Synchronizes the tracker to the client side.

Method Detail

getModeName

java.lang.String getModeName()

Returns:

Name of the current IBeekeepingMode.

setModeName

void setModeName(java.lang.String name)

Set the current IBeekeepingMode.

getSpeciesBred

int getSpeciesBred()

Returns:

Amount of species discovered.

registerBirth

void registerBirth(IIndividual individual)

Register the birth of an individual. Will mark it as discovered.

registerPickup

void registerPickup(IIndividual individual)

Register the pickup of an individual.

registerSpecies

void registerSpecies(IAlleleSpecies species)

Marks a species as discovered. Should only be called from registerIndividual normally.

registerMutation

void registerMutation(IMutation mutation)

Register a successful mutation. Will mark it as discovered.

isDiscovered

boolean isDiscovered(IMutation mutation)

Queries the tracker for discovered species.

Parameters:

mutation - Mutation to query for.

Returns:

true if the mutation has been discovered.

isDiscovered

boolean isDiscovered(IAlleleSpecies species)

Queries the tracker for discovered species.

Parameters:

species - Species to check.

Returns:

true if the species has been bred.

getDiscoveredSpecies

default java.util.Collection<java.lang.String> getDiscoveredSpecies()

Returns:

A collection that contains the IAllele.getUID()s of all discovered species.

researchMutation

void researchMutation(IMutation mutation)

Register a successfully researched mutation. Mutations are normally researched in the Escritoire. Researched mutations may have bonuses such as occurring at a higher rate. Researched mutations count as discovered.

isResearched

boolean isResearched(IMutation mutation)

Returns:

true if the mutation has been researched.

synchToPlayer

void synchToPlayer(net.minecraft.entity.player.EntityPlayer player)

Synchronizes the tracker to the client side. Before Forestry 4.2.1: Should be called before opening any gui needing that information. Since Forestry 4.2.1: Breeding tracker should be automatically synced, only Forestry should need to call this.

decodeFromNBT

void decodeFromNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)

encodeToNBT

void encodeToNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)