forestry.api.genetics

Interface IFlowerRegistry

All Known Implementing Classes:

FlowerRegistry

public interface IFlowerRegistry

Method Summary

Modifier and Type	Method and Description
IBlockPosPredicate	createAcceptedFlowerPredicate(java.lang.String flowerType) Checks a single coordinate to see if it is an accepted flower.
java.util.List<net.minecraft.util.math.BlockPos>	getAcceptedFlowerCoordinates(IBeeHousing beeHousing, IBee bee, java.lang.String flowerType, int maxFlowers) Deprecated. since Forestry 5.5.2. Use getAreaIterator(IBeeHousing, IBee) and createAcceptedFlowerPredicate(String).
java.util.Iterator<net.minecraft.util.math.BlockPos.MutableBlockPos>	getAreaIterator(IBeeHousing beeHousing, IBee bee) Gets an iterator over the area a bee can travel from its beeHousing.
boolean	growFlower(java.lang.String flowerType, net.minecraft.world.World world, IIndividual individual, net.minecraft.util.math.BlockPos pos) Deprecated. since Forestry 5.5.4. Use growFlower(String, World, IIndividual, BlockPos, Collection)
boolean	growFlower(java.lang.String flowerType, net.minecraft.world.World world, IIndividual individual, net.minecraft.util.math.BlockPos pos, java.util.Collection<net.minecraft.block.state.IBlockState> potentialFlowers) Calls the appropriate IFlowerGrowthRule to grow a flower at a specified position.
boolean	isAcceptedFlower(java.lang.String flowerType, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Deprecated. since Forestry 5.5.2. Use createAcceptedFlowerPredicate(String).
void	registerAcceptableFlower(net.minecraft.block.Block block, java.lang.String... flowerTypes) Registers an accepted flower with any state.
void	registerAcceptableFlower(net.minecraft.block.state.IBlockState blockState, java.lang.String... flowerTypes) Registers an accepted flower with a particular state.
void	registerAcceptableFlowerRule(IFlowerAcceptableRule flowerAcceptableRule, java.lang.String... flowerTypes) Registers custom logic for accepted flowers.
void	registerGrowthRule(IFlowerGrowthRule rule, java.lang.String... flowerTypes) Register a new flower growth rule.
void	registerPlantableFlower(net.minecraft.block.state.IBlockState blockState, double weight, java.lang.String... flowerTypes) Registers a plantable flower.

Method Detail

registerGrowthRule

void registerGrowthRule(IFlowerGrowthRule rule,
                        java.lang.String... flowerTypes)

Register a new flower growth rule. This defines the flower planting logic for the specified flower types. Without a flower growth rule, no flowers of that type can be planted.

registerAcceptableFlower

void registerAcceptableFlower(net.minecraft.block.Block block,
                              java.lang.String... flowerTypes)

Registers an accepted flower with any state.

registerAcceptableFlower

void registerAcceptableFlower(net.minecraft.block.state.IBlockState blockState,
                              java.lang.String... flowerTypes)

Registers an accepted flower with a particular state.

registerAcceptableFlowerRule

void registerAcceptableFlowerRule(IFlowerAcceptableRule flowerAcceptableRule,
                                  java.lang.String... flowerTypes)

Registers custom logic for accepted flowers. These rules are inefficient compared to ones made with registerAcceptableFlower, but may be necessary for tile entity flowers. The flower types built into Forestry can not be used here.

Since:

Forestry 4.0.8

registerPlantableFlower

void registerPlantableFlower(net.minecraft.block.state.IBlockState blockState,
                             double weight,
                             java.lang.String... flowerTypes)

Registers a plantable flower. The distribution is based on its own weight and the total number of plants for this flowerType.

Parameters:

weight - Weight for the Flower (Vanilla = 1.0, Modded flowers < 1.0)

flowerTypes - See FlowerManager.FlowerTypeXXX

growFlower

boolean growFlower(java.lang.String flowerType,
                   net.minecraft.world.World world,
                   IIndividual individual,
                   net.minecraft.util.math.BlockPos pos,
                   java.util.Collection<net.minecraft.block.state.IBlockState> potentialFlowers)

Calls the appropriate IFlowerGrowthRule to grow a flower at a specified position.

Since:

Forestry 5.5.4

getAreaIterator

java.util.Iterator<net.minecraft.util.math.BlockPos.MutableBlockPos> getAreaIterator(IBeeHousing beeHousing,
                                                                                     IBee bee)

Gets an iterator over the area a bee can travel from its beeHousing. Starts at the bee housing and spirals outward.

Parameters:

beeHousing - The bee housing that will help determine the size of the area to check.

bee - The bee that will help determine the size of the area to check.

Returns:

an iterator over the area a bee can travel from its beeHousing.

Since:

Forestry 5.5.2

createAcceptedFlowerPredicate

IBlockPosPredicate createAcceptedFlowerPredicate(java.lang.String flowerType)

Checks a single coordinate to see if it is an accepted flower.

Since:

Forestry 5.5.2

getAcceptedFlowerCoordinates

@Deprecated
java.util.List<net.minecraft.util.math.BlockPos> getAcceptedFlowerCoordinates(IBeeHousing beeHousing,
                                                                                          IBee bee,
                                                                                          java.lang.String flowerType,
                                                                                          int maxFlowers)

Deprecated. since Forestry 5.5.2. Use getAreaIterator(IBeeHousing, IBee) and createAcceptedFlowerPredicate(String).

Parameters:

beeHousing - The bee housing that will help determine the size of the area to check.

bee - The bee that will help determine the size of the area to check.

flowerType - See FlowerManager.FlowerTypeXXX

maxFlowers - the largest number of flowers to check for before returning. Use 1 if you only need 1.

Returns:

the coordinates of nearby accepted flowers, with size from 0 to maxFlowers.

isAcceptedFlower

@Deprecated
boolean isAcceptedFlower(java.lang.String flowerType,
                                     net.minecraft.world.World world,
                                     net.minecraft.util.math.BlockPos pos)

Deprecated. since Forestry 5.5.2. Use createAcceptedFlowerPredicate(String).

Checks a single coordinate to see if it is an accepted flower.

growFlower

@Deprecated
boolean growFlower(java.lang.String flowerType,
                               net.minecraft.world.World world,
                               IIndividual individual,
                               net.minecraft.util.math.BlockPos pos)

Deprecated. since Forestry 5.5.4. Use growFlower(String, World, IIndividual, BlockPos, Collection)

Calls the appropriate IFlowerGrowthRule to grow a flower at a specified position.