forestry.api.lepidopterology

Interface IButterfly

All Superinterfaces:

IIndividual, IIndividualLiving, INbtWritable

All Known Implementing Classes:

Butterfly

public interface IButterfly
extends IIndividualLiving

Method Summary

Modifier and Type	Method and Description
boolean	canSpawn(net.minecraft.world.World world, double x, double y, double z)
boolean	canTakeFlight(net.minecraft.world.World world, double x, double y, double z)
IButterfly	copy() Create an exact copy of this butterfly.
java.util.Set<IErrorState>	getCanGrow(IButterflyNursery nursery, IButterflyCocoon cocoon) Determines whether the caterpillar can grow.
java.util.Set<IErrorState>	getCanSpawn(IButterflyNursery nursery, IButterflyCocoon cocoon) Determines whether the caterpillar can spawn.
net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	getCaterpillarDrop(IButterflyNursery nursery, boolean playerKill, int lootLevel)
net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	getCocoonDrop(IButterflyCocoon cocoon)
IButterflyGenome	getGenome()
net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	getLootDrop(IEntityButterfly entity, boolean playerKill, int lootLevel)
IButterflyGenome	getMate()
float	getSize()
boolean	isAcceptedEnvironment(net.minecraft.world.World world, double x, double y, double z)
IButterfly	spawnCaterpillar(net.minecraft.world.World world, IButterflyNursery nursery)

Methods inherited from interface forestry.api.genetics.IIndividualLiving

age, getHealth, getMaxHealth, isAlive, mate, setHealth

Methods inherited from interface forestry.api.genetics.IIndividual

addTooltip, analyze, getDisplayName, getIdent, hasEffect, isAnalyzed, isGeneticEqual, isPureBred, isSecret

Methods inherited from interface forestry.api.core.INbtWritable

writeToNBT

Method Detail

getGenome

IButterflyGenome getGenome()

Specified by:

getGenome in interface IIndividual

Returns:

The genetic data of this individual.

getMate

IButterflyGenome getMate()

Specified by:

getMate in interface IIndividualLiving

Returns:

Genetic information of the mate, null if unmated.

getSize

float getSize()

Returns:

Physical size of the butterfly.

canSpawn

boolean canSpawn(net.minecraft.world.World world,
                 double x,
                 double y,
                 double z)

Returns:

true if the butterfly can naturally spawn at the given location at this time. (Used to auto-spawn butterflies from tree leaves.)

canTakeFlight

boolean canTakeFlight(net.minecraft.world.World world,
                      double x,
                      double y,
                      double z)

Returns:

true if the butterfly can take flight at the given location at this time. (Used to auto-spawn butterflies from dropped items.)

isAcceptedEnvironment

boolean isAcceptedEnvironment(net.minecraft.world.World world,
                              double x,
                              double y,
                              double z)

Returns:

true if the environment (temperature, humidity) is valid for the butterfly at the given location.

spawnCaterpillar

@Nullable
IButterfly spawnCaterpillar(net.minecraft.world.World world,
                                      IButterflyNursery nursery)

Returns:

create a caterpillar with the two genome's from the nursery.

getCanGrow

java.util.Set<IErrorState> getCanGrow(IButterflyNursery nursery,
                                      @Nullable
                                      IButterflyCocoon cocoon)

Determines whether the caterpillar can grow.

Parameters:

cocoon - the IButterflyCocoon the caterpillar resides in.

nursery - the IButterflyNursery of the caterpillar.

Returns:

an empty set if the caterpillar can grow, a set of error states if the caterpillar can not grow

Since:

5.3.3

getCanSpawn

java.util.Set<IErrorState> getCanSpawn(IButterflyNursery nursery,
                                       @Nullable
                                       IButterflyCocoon cocoon)

Determines whether the caterpillar can spawn. (Used to auto-spawn butterflies out of a cocoon.)

Parameters:

cocoon - the IButterflyCocoon the caterpillar resides in.

nursery - the IButterflyNursery of the caterpillar.

Returns:

an empty set if the caterpillar can spawn, a set of error states if the caterpillar can not spawn

Since:

5.3.3

getLootDrop

net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> getLootDrop(IEntityButterfly entity,
                                                                         boolean playerKill,
                                                                         int lootLevel)

Parameters:

playerKill - Whether or not the butterfly was killed by a player.

lootLevel - Loot level according to the weapon used to kill the butterfly.

Returns:

Array of itemstacks to drop on death of the given entity.

getCaterpillarDrop

net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> getCaterpillarDrop(IButterflyNursery nursery,
                                                                                boolean playerKill,
                                                                                int lootLevel)

Parameters:

playerKill - Whether or not the nursery was broken by a player.

lootLevel - Fortune level.

Returns:

Array of itemstacks to drop on breaking of the nursery.

getCocoonDrop

net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> getCocoonDrop(IButterflyCocoon cocoon)

Returns:

itemstacks to drop on breaking of the cocoon.

copy

IButterfly copy()

Create an exact copy of this butterfly.

Specified by:

copy in interface IIndividual

Returns:

A deep copy of this individual.