forestry.api.farming

Interface IFarmable

All Known Implementing Classes:

FarmableAgingCrop, FarmableBase, FarmableBasicAgricraft, FarmableBasicIC2Crop, FarmableChorus, FarmableCocoa, FarmableDoubleCrop, FarmableGE, FarmableGourd, FarmableRusticGrape, FarmableRusticSapling, FarmableSapling, FarmableStacked, FarmableVanillaMushroom, FarmableVanillaSapling

public interface IFarmable

IFarmable describes a crop or other harvestable object and can be used to inspect item stacks and blocks for matches.

Method Summary

Modifier and Type	Method and Description
default void	addInformation(IFarmableInfo info)
ICrop	getCropAt(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.block.state.IBlockState blockState)
boolean	isGermling(net.minecraft.item.ItemStack itemstack)
default boolean	isSaplingAt(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Deprecated. Since Forestry 5.8. Use the version below. TODO Remove this method in 1.13
default boolean	isSaplingAt(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.block.state.IBlockState blockState)
default boolean	isWindfall(net.minecraft.item.ItemStack itemstack)
boolean	plantSaplingAt(net.minecraft.entity.player.EntityPlayer player, net.minecraft.item.ItemStack germling, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Plants a sapling by manipulating the world.

Method Detail

isSaplingAt

@Deprecated
default boolean isSaplingAt(net.minecraft.world.World world,
                                        net.minecraft.util.math.BlockPos pos)

Deprecated. Since Forestry 5.8. Use the version below. TODO Remove this method in 1.13

Returns:

true if the block at the given location is a "sapling" for this type, i.e. a non-harvestable immature version of the crop.

isSaplingAt

default boolean isSaplingAt(net.minecraft.world.World world,
                            net.minecraft.util.math.BlockPos pos,
                            net.minecraft.block.state.IBlockState blockState)

Returns:

true if the block at the given location is a "sapling" for this type, i.e. a non-harvestable immature version of the crop.

getCropAt

@Nullable
ICrop getCropAt(net.minecraft.world.World world,
                          net.minecraft.util.math.BlockPos pos,
                          net.minecraft.block.state.IBlockState blockState)

Returns:

ICrop if the block at the given location is a harvestable and mature crop, null otherwise.

isGermling

boolean isGermling(net.minecraft.item.ItemStack itemstack)

Returns:

true if the item is a valid germling (plantable sapling, seed, etc.) for this type.

addInformation

default void addInformation(IFarmableInfo info)

isWindfall

default boolean isWindfall(net.minecraft.item.ItemStack itemstack)

Returns:

true if the item is something that can drop from this type without actually being harvested as a crop. (Apples or sapling from decaying leaves.)

plantSaplingAt

boolean plantSaplingAt(net.minecraft.entity.player.EntityPlayer player,
                       net.minecraft.item.ItemStack germling,
                       net.minecraft.world.World world,
                       net.minecraft.util.math.BlockPos pos)

Plants a sapling by manipulating the world. The IFarmLogic should have verified the given location as valid. Called by the IFarmHousing which handles resources.

Returns:

true on success, false otherwise.