Package com.minecolonies.core.colony.buildings.workerbuildings.plantation.modules.specific

Class KelpPlantModule

java.lang.Object

com.minecolonies.core.colony.buildingextensions.modules.AbstractBuildingExtensionModule

com.minecolonies.core.colony.buildings.workerbuildings.plantation.AbstractPlantationModule

com.minecolonies.core.colony.buildings.workerbuildings.plantation.modules.generic.UpwardsGrowingPlantModule

com.minecolonies.core.colony.buildings.workerbuildings.plantation.modules.specific.KelpPlantModule

All Implemented Interfaces:

IBuildingExtensionModule, IPlantationModule

public class KelpPlantModule
extends UpwardsGrowingPlantModule

Planter module for growing Items.KELP.
Requirements:

1. All requirements from UpwardsGrowingPlantModule
2. There must be an air block directly above the water at least MAX_HEIGHT + 1 from the working position block. This is where the AI will attempt to walk to.

Nested Class Summary

Nested classes/interfaces inherited from interface com.minecolonies.api.colony.buildingextensions.plantation.IPlantationModule

IPlantationModule.ActionToPerform, IPlantationModule.PlantationModuleResult, IPlantationModule.PlanterAIModuleResultResetState

Field Summary

Fields inherited from class com.minecolonies.core.colony.buildings.workerbuildings.plantation.modules.generic.UpwardsGrowingPlantModule

DEFAULT_MINIMUM_PLANT_LENGTH

Fields inherited from class com.minecolonies.core.colony.buildings.workerbuildings.plantation.AbstractPlantationModule

DEFAULT_MAX_PLANTS

Fields inherited from class com.minecolonies.core.colony.buildingextensions.modules.AbstractBuildingExtensionModule

extension

Constructor Summary

Constructors

Constructor	Description
KelpPlantModule(IBuildingExtension field, String fieldTag, String workTag, net.minecraft.world.item.Item item)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected @NotNull Integer	getMaximumPlantLength()	Get the maximum length this plant can grow.
protected int	getMinimumPlantLength()	Get the minimum length this plant should grow to before considered harvestable.
net.minecraft.core.BlockPos	getPositionToWalkTo(net.minecraft.world.level.Level world, net.minecraft.core.BlockPos workingPosition)	Determines where the planter should walk to, in order to most effectively work on the given working position.
net.minecraft.resources.ResourceLocation	getRequiredResearchEffect()	Get the required research effect for this module.
EquipmentTypeEntry	getRequiredTool()	Returns the requested tool type in order to work on this module.
protected boolean	isValidHarvestBlock(net.minecraft.world.level.block.state.BlockState blockState)	Check if the block is a correct block for harvesting.
protected boolean	isValidPlantingBlock(net.minecraft.world.level.block.state.BlockState blockState)	Check if the block is a correct block for planting.

Methods inherited from class com.minecolonies.core.colony.buildings.workerbuildings.plantation.modules.generic.UpwardsGrowingPlantModule

decideFieldWork, getActionLimit, getNextWorkingPosition, getRequiredItemsForOperation, isValidClearingBlock

Methods inherited from class com.minecolonies.core.colony.buildings.workerbuildings.plantation.AbstractPlantationModule

applyBonemeal, equals, getFieldTag, getItem, getMaxWorkingPositions, getPlantingBlockState, getPlantsToRequest, getValidBonemeal, getValidWorkingPositions, getWorkingPositions, getWorkTag, hashCode

Methods inherited from class com.minecolonies.core.colony.buildingextensions.modules.AbstractBuildingExtensionModule

getExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.minecolonies.api.colony.buildingextensions.modules.IBuildingExtensionModule

getExtension

Constructor Details

KelpPlantModule

public KelpPlantModule(IBuildingExtension field,
 String fieldTag,
 String workTag,
 net.minecraft.world.item.Item item)

Default constructor.

Parameters:

field - the field instance this module is working on.

fieldTag - the tag of the field anchor block.

workTag - the tag of the working positions.

item - the item which is harvested.

Method Details

isValidPlantingBlock

protected boolean isValidPlantingBlock(net.minecraft.world.level.block.state.BlockState blockState)

Description copied from class: UpwardsGrowingPlantModule

Check if the block is a correct block for planting. Defaults to being any air block.

Overrides:

isValidPlantingBlock in class UpwardsGrowingPlantModule

Parameters:

blockState - the block state.

Returns:

whether the block can be planted.

isValidHarvestBlock

protected boolean isValidHarvestBlock(net.minecraft.world.level.block.state.BlockState blockState)

Description copied from class: UpwardsGrowingPlantModule

Check if the block is a correct block for harvesting.

Specified by:

isValidHarvestBlock in class UpwardsGrowingPlantModule

Parameters:

blockState - the block state.

Returns:

whether the block can be harvested.

getMinimumPlantLength

protected int getMinimumPlantLength()

Description copied from class: UpwardsGrowingPlantModule

Get the minimum length this plant should grow to before considered harvestable. Defaults to UpwardsGrowingPlantModule.DEFAULT_MINIMUM_PLANT_LENGTH.

Overrides:

getMinimumPlantLength in class UpwardsGrowingPlantModule

Returns:

the minimum plant length

getMaximumPlantLength

@NotNull
protected @NotNull Integer getMaximumPlantLength()

Description copied from class: UpwardsGrowingPlantModule

Get the maximum length this plant can grow. Defaults to null.

Overrides:

getMaximumPlantLength in class UpwardsGrowingPlantModule

Returns:

the maximum plant length

getPositionToWalkTo

public net.minecraft.core.BlockPos getPositionToWalkTo(net.minecraft.world.level.Level world,
 net.minecraft.core.BlockPos workingPosition)

Description copied from interface: IPlantationModule

Determines where the planter should walk to, in order to most effectively work on the given working position. Defaults to the same block.

Specified by:

getPositionToWalkTo in interface IPlantationModule

Overrides:

getPositionToWalkTo in class UpwardsGrowingPlantModule

Parameters:

world - the world reference that can be used for block state lookups.

workingPosition - the original working position.

Returns:

the position for the planter to walk to.

getRequiredResearchEffect

public net.minecraft.resources.ResourceLocation getRequiredResearchEffect()

Description copied from interface: IPlantationModule

Get the required research effect for this module. Null if there is no research required for this field.

Specified by:

getRequiredResearchEffect in interface IPlantationModule

Overrides:

getRequiredResearchEffect in class AbstractPlantationModule

Returns:

the key of where to find the effect.

getRequiredTool

public EquipmentTypeEntry getRequiredTool()

Description copied from interface: IPlantationModule

Returns the requested tool type in order to work on this module.

Returns:

the tool to work on this module.