Package com.minecolonies.api.colony.buildingextensions.plantation

Class IPlantationModule.PlantationModuleResult

java.lang.Object

com.minecolonies.api.colony.buildingextensions.plantation.IPlantationModule.PlantationModuleResult

Enclosing interface:

IPlantationModule

public static class IPlantationModule.PlantationModuleResult
extends Object

Class containing possible states that the planter AI can be in.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IPlantationModule.PlantationModuleResult.Builder	Builder class for the IPlantationModule.PlantationModuleResult.

Field Summary

Fields

Modifier and Type	Field	Description
static final IPlantationModule.PlantationModuleResult.Builder	NONE	Simplest action, indicating no work was needed on the given position.

Method Summary

Modifier and Type	Method	Description
IPlantationModule.ActionToPerform	getAction()	What kind of action to perform.
@Nullable net.minecraft.core.BlockPos	getActionPosition()	Get the position to actually perform the action on.
IPlantationModule	getModule()	Get the plantation module this result was generated from.
net.minecraft.core.BlockPos	getWorkingPosition()	Get the working position.
boolean	shouldResetCurrentField()	Whether to reset the current field.
boolean	shouldResetWorkingPosition()	Whether to reset the current working position.

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final IPlantationModule.PlantationModuleResult.Builder NONE

Simplest action, indicating no work was needed on the given position.

Method Details

getModule

public IPlantationModule getModule()

Get the plantation module this result was generated from.

Returns:

the plantation module.

getWorkingPosition

public net.minecraft.core.BlockPos getWorkingPosition()

Get the working position.

Returns:

the working position.

getAction

public IPlantationModule.ActionToPerform getAction()

What kind of action to perform.

Returns:

the action type.

getActionPosition

@Nullable
public @Nullable net.minecraft.core.BlockPos getActionPosition()

Get the position to actually perform the action on.

Returns:

the position to actually perform the action on.

shouldResetWorkingPosition

public boolean shouldResetWorkingPosition()

Whether to reset the current working position.

Returns:

true if so.

shouldResetCurrentField

public boolean shouldResetCurrentField()

Whether to reset the current field.

Returns:

true if so.