forestry.core.genetics

Class BreedingTracker

java.lang.Object

net.minecraft.world.storage.WorldSavedData

forestry.core.genetics.BreedingTracker

All Implemented Interfaces:

IBreedingTracker, net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.NBTTagCompound>

Direct Known Subclasses:

ApiaristTracker, ArboristTracker, LepidopteristTracker

public abstract class BreedingTracker
extends net.minecraft.world.storage.WorldSavedData
implements IBreedingTracker

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_KEY

Fields inherited from class net.minecraft.world.storage.WorldSavedData

mapName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BreedingTracker(java.lang.String s, java.lang.String defaultModeName)

Method Summary

Modifier and Type	Method and Description
void	decodeFromNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)
void	encodeToNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)
protected abstract IBreedingTracker	getBreedingTracker(net.minecraft.entity.player.EntityPlayer player) Returns the common tracker
java.util.Set<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	readFromNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)
void	registerBirth(IIndividual individual) Register the birth of an individual.
void	registerMutation(IMutation mutation) Register a successful mutation.
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	setUsername(com.mojang.authlib.GameProfile username)
void	setWorld(net.minecraft.world.World world)
protected abstract java.lang.String	speciesRootUID() Tag stored in NBT to identify the type of the tracker being synced
void	synchToPlayer(net.minecraft.entity.player.EntityPlayer player) Synchronizes the tracker to the client side.
net.minecraft.nbt.NBTTagCompound	writeToNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)

Methods inherited from class net.minecraft.world.storage.WorldSavedData

deserializeNBT, isDirty, markDirty, serializeNBT, setDirty

Methods inherited from class java.lang.Object

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

Methods inherited from interface forestry.api.genetics.IBreedingTracker

registerPickup

Field Detail

TYPE_KEY

public static final java.lang.String TYPE_KEY

See Also:

Constant Field Values

Constructor Detail

BreedingTracker

protected BreedingTracker(java.lang.String s,
                          java.lang.String defaultModeName)

Method Detail

setUsername

public void setUsername(@Nullable
                        com.mojang.authlib.GameProfile username)

setWorld

public void setWorld(@Nullable
                     net.minecraft.world.World world)

getModeName

public java.lang.String getModeName()

Specified by:

getModeName in interface IBreedingTracker

Returns:

Name of the current IBeekeepingMode.

setModeName

public void setModeName(java.lang.String name)

Description copied from interface: IBreedingTracker

Set the current IBeekeepingMode.

Specified by:

setModeName in interface IBreedingTracker

getBreedingTracker

protected abstract IBreedingTracker getBreedingTracker(net.minecraft.entity.player.EntityPlayer player)

Returns the common tracker

Parameters:

player - used to get world

Returns:

common tracker for this breeding system

speciesRootUID

protected abstract java.lang.String speciesRootUID()

Tag stored in NBT to identify the type of the tracker being synced

synchToPlayer

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

Description copied from interface: IBreedingTracker

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.

Specified by:

synchToPlayer in interface IBreedingTracker

decodeFromNBT

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

Specified by:

decodeFromNBT in interface IBreedingTracker

encodeToNBT

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

Specified by:

encodeToNBT in interface IBreedingTracker

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)

Specified by:

readFromNBT in class net.minecraft.world.storage.WorldSavedData

writeToNBT

public net.minecraft.nbt.NBTTagCompound writeToNBT(net.minecraft.nbt.NBTTagCompound nbttagcompound)

Specified by:

writeToNBT in class net.minecraft.world.storage.WorldSavedData

registerMutation

public void registerMutation(IMutation mutation)

Description copied from interface: IBreedingTracker

Register a successful mutation. Will mark it as discovered.

Specified by:

registerMutation in interface IBreedingTracker

isDiscovered

public boolean isDiscovered(IMutation mutation)

Description copied from interface: IBreedingTracker

Queries the tracker for discovered species.

Specified by:

isDiscovered in interface IBreedingTracker

Parameters:

mutation - Mutation to query for.

Returns:

true if the mutation has been discovered.

isDiscovered

public boolean isDiscovered(IAlleleSpecies species)

Description copied from interface: IBreedingTracker

Queries the tracker for discovered species.

Specified by:

isDiscovered in interface IBreedingTracker

Parameters:

species - Species to check.

Returns:

true if the species has been bred.

getDiscoveredSpecies

public java.util.Set<java.lang.String> getDiscoveredSpecies()

Specified by:

getDiscoveredSpecies in interface IBreedingTracker

Returns:

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

getSpeciesBred

public int getSpeciesBred()

Specified by:

getSpeciesBred in interface IBreedingTracker

Returns:

Amount of species discovered.

registerBirth

public void registerBirth(IIndividual individual)

Description copied from interface: IBreedingTracker

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

Specified by:

registerBirth in interface IBreedingTracker

registerSpecies

public void registerSpecies(IAlleleSpecies species)

Description copied from interface: IBreedingTracker

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

Specified by:

registerSpecies in interface IBreedingTracker

researchMutation

public void researchMutation(IMutation mutation)

Description copied from interface: IBreedingTracker

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.

Specified by:

researchMutation in interface IBreedingTracker

isResearched

public boolean isResearched(IMutation mutation)

Specified by:

isResearched in interface IBreedingTracker

Returns:

true if the mutation has been researched.