Package com.minecolonies.api.colony.workorders

Interface IBuilderWorkOrder

All Superinterfaces:

IServerWorkOrder, IWorkOrder

All Known Implementing Classes:

AbstractWorkOrder, WorkOrderBuilding, WorkOrderDecoration, WorkOrderMiner, WorkOrderPlantationField

public interface IBuilderWorkOrder
extends IServerWorkOrder

Field Summary

Fields inherited from interface com.minecolonies.api.colony.workorders.IWorkOrder

WORK_ORDER_COMPARATOR

Method Summary

Modifier and Type	Method	Description
boolean	canBeResolved(IColony colony, int level)	Check if this workOrder can be resolved by an existing builder.
boolean	canBuildIgnoringDistance(@NotNull IBuilding building, @NotNull net.minecraft.core.BlockPos builderLocation, int builderLevel)	Checks if a builder may accept this workOrder while ignoring the distance to the builder.
int	getAmountOfResources()	Get the amount of resources this work order still requires.
String	getIteratorType()	Get the iterator type (method of construction) of the work order.
boolean	isCleared()	Whether the area of the work order has been cleared out or not.
boolean	isRequested()	Set whether the resources for this work order have been requested.
void	onCompleted(IColony colony, ICitizenData citizen)	Executed when a work order is completed.
void	onRemoved(IColony colony)	Executed when a work order is removed.
void	setAmountOfResources(int newQuantity)	Set the amount of resources this work order still requires.
void	setCleared(boolean cleared)	Set whether the area of the work order has been cleared out or not.
void	setIteratorType(String iteratorType)	Set the iterator type (method of construction) of the work order.
void	setRequested(boolean requested)	Set whether the building has been cleared.
void	setStage(BuildingProgressStage stage)	Sets the building stage of the workorder
boolean	tooFarFromAnyBuilder(IColony colony, int level)	Check if this workOrder can be resolved by an existing builder by distance.

Methods inherited from interface com.minecolonies.api.colony.workorders.IServerWorkOrder

canBuild, isDirty, isValid, onAdded, read, resetChange, serializeViewNetworkData, write

Methods inherited from interface com.minecolonies.api.colony.workorders.IWorkOrder

clearBlueprint, getBlueprint, getBoundingBox, getClaimedBy, getColony, getCurrentLevel, getDisplayName, getFileName, getID, getLocation, getPriority, getRotationMirror, getStage, getStructurePack, getStructurePath, getTargetLevel, getTranslationKey, getWorkOrderType, isClaimed, loadBlueprint, setBlueprint, setClaimedBy, setColony, setID, setPriority

Method Details

getAmountOfResources

int getAmountOfResources()

Get the amount of resources this work order still requires.

Returns:

the amount of resources.

setAmountOfResources

void setAmountOfResources(int newQuantity)

Set the amount of resources this work order still requires.

Parameters:

newQuantity - the new amount of resources.

getIteratorType

String getIteratorType()

Get the iterator type (method of construction) of the work order.

Returns:

the iterator type.

setIteratorType

void setIteratorType(String iteratorType)

Set the iterator type (method of construction) of the work order.

Parameters:

iteratorType - the new iterator type.

isCleared

boolean isCleared()

Whether the area of the work order has been cleared out or not.

Returns:

true if the area is cleared.

setCleared

void setCleared(boolean cleared)

Set whether the area of the work order has been cleared out or not.

Parameters:

cleared - the new cleared state.

setRequested

void setRequested(boolean requested)

Set whether the building has been cleared.

Parameters:

requested - true if the building has been cleared.

isRequested

boolean isRequested()

Set whether the resources for this work order have been requested.

Returns:

true when the resources are requested.

onCompleted

void onCompleted(IColony colony,
 ICitizenData citizen)

Executed when a work order is completed.

Override this when something need to be done when the work order is completed

Parameters:

colony - in which the work order exist

citizen - citizen that completed the work order

onRemoved

void onRemoved(IColony colony)

Executed when a work order is removed.

Override this when something need to be done when the work order is removed

Parameters:

colony - in which the work order exist

canBeResolved

boolean canBeResolved(IColony colony,
 int level)

Check if this workOrder can be resolved by an existing builder.

Parameters:

colony - the colony to check in.

level - the new level of the building.

Returns:

true if so.

tooFarFromAnyBuilder

boolean tooFarFromAnyBuilder(IColony colony,
 int level)

Check if this workOrder can be resolved by an existing builder by distance.

Parameters:

colony - the colony to check in.

level - the new level of the building.

Returns:

true if so.

canBuildIgnoringDistance

boolean canBuildIgnoringDistance(@NotNull
 @NotNull IBuilding building,
 @NotNull
 @NotNull net.minecraft.core.BlockPos builderLocation,
 int builderLevel)

Checks if a builder may accept this workOrder while ignoring the distance to the builder.

Parameters:

builderLocation - position of the builders own hut.

builderLevel - level of the builders hut.

Returns:

true if so.

setStage

void setStage(BuildingProgressStage stage)

Sets the building stage of the workorder

Parameters:

stage -