Package com.minecolonies.core.entity.ai.workers

Class AbstractEntityAIStructureWithWorkOrder<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

java.lang.Object

com.minecolonies.core.entity.ai.workers.AbstractAISkeleton<J>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIBasic<J,B>

com.minecolonies.core.entity.ai.workers.AbstractEntityAISkill<J,B>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIInteract<J,B>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIStructure<J,B>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIStructureWithWorkOrder<J,B>

All Implemented Interfaces:

ITickingStateAI

Direct Known Subclasses:

EntityAIQuarrier, EntityAIStructureBuilder, EntityAIStructureMiner

public abstract class AbstractEntityAIStructureWithWorkOrder<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>
extends AbstractEntityAIStructure<J,B>

AI class for the builder. Manages building and repairing buildings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	AbstractEntityAIStructureWithWorkOrder.RequestStage	Possible request stages

Nested classes/interfaces inherited from class com.minecolonies.core.entity.ai.workers.AbstractEntityAIStructure

AbstractEntityAIStructure.ItemCheckResult

Field Summary

Fields

Modifier and Type	Field	Description
protected net.minecraft.core.BlockPos	requestProgress	Request progress pos.
protected AbstractEntityAIStructureWithWorkOrder.RequestStage	requestState	The current request state (0 is solid

Fields inherited from class com.minecolonies.core.entity.ai.workers.AbstractEntityAIStructure

blockToMine, BUILD_BLOCK_DELAY, DONT_TOUCH_PREDICATE, gotoPos, limitReached, loadingBlueprint, prevBlockPosition, structurePlacer, workFrom

Fields inherited from class com.minecolonies.core.entity.ai.workers.AbstractEntityAIInteract

BLOCK_MINING_DELAY, RANGE_HORIZONTAL_PICKUP, RANGE_VERTICAL_PICKUP, RENDER_META_WORKING, XP_PER_BLOCK

Fields inherited from class com.minecolonies.core.entity.ai.workers.AbstractEntityAIBasic

building, currentWorkingLocation, needsCurrently, NO_TOOL, REQUEST_DELAY, STANDARD_DELAY, WALK_DELAY, walkTo, workPosIndex

Fields inherited from class com.minecolonies.core.entity.ai.workers.AbstractAISkeleton

job, worker, world

Constructor Summary

Constructors

Constructor	Description
AbstractEntityAIStructureWithWorkOrder(J job)	Initialize the builder and add all his tasks.

Method Summary

Modifier and Type	Method	Description
protected boolean	checkIfCanceled()	Check if the structure tusk has been canceled.
protected boolean	checkIfNeedsItem()	Check if
void	executeSpecificCompleteActions()	Execute specific actions on loading a structure.
Tuple<net.minecraft.core.BlockPos,BuildingProgressStage>	getProgressPos()	Get the current structure progress,
@Nullable net.minecraft.world.item.ItemStack	getTotalAmount(@Nullable net.minecraft.world.item.ItemStack stack)	Check how much of a certain stuck is actually required.
int	getTotalRequiredAmount(net.minecraft.world.item.ItemStack deliveredItemStack)	Get the total amount required for an itemStack.
void	handleSpecificCancelActions()	Specific actions to handle a cancellation of a structure.
protected boolean	isAlreadyCleared()	Let childs overwrite this if necessary.
IAIState	loadRequirements()	Takes the existing workorder, loads the structure and tests the worker order if it is valid.
void	reduceNeededResources(net.minecraft.world.item.ItemStack stack)	Reduces the needed resources by 1.
void	registerBlockAsNeeded(net.minecraft.world.item.ItemStack stack)	Register the block as needed at the building if possible.
boolean	requestMaterials()	Iterates through all the required resources and stores them in the building.
protected void	sendCompletionMessage(IWorkOrder wo)	Send a completion message to the colony if necessary.
void	storeProgressPos(net.minecraft.core.BlockPos blockPos, BuildingProgressStage stage)	Store the progressPos in the building if possible for the worker.

Methods inherited from class com.minecolonies.core.entity.ai.workers.AbstractEntityAIStructure

afterDump, afterRequestPickUp, afterStructureLoading, checkForExtraBuildingActions, completeBuild, doMining, getCurrentBuildingPosition, getCurrentWorkingPosition, getPlaceSpeedLevel, getPosToWorkAt, getSolidSubstitution, getStateAfterPickUp, getWorker, getWorkingPosition, goToNextStage, hasListOfResInInvOrRequest, isBlockFree, isDecoItem, isThereAStructureToBuild, loadStructure, pickUpMaterial, resetCurrentStructure, setStructurePlacer, shallReplaceSolidSubstitutionBlock, skipBuilding, skipClearing, startBuilding, startWorkingAtOwnBuilding, structureStep, walkToConstructionSite

Methods inherited from class com.minecolonies.core.entity.ai.workers.AbstractEntityAIInteract

fillItemsList, gatherItems, getBlockMiningTime, getBreakSpeedLevel, getItemsForPickUp, increaseBlockDrops, isItemWorthPickingUp, mineBlock, mineBlock, mineBlock, onBlockDropReception, resetGatheringItems, searchForItems, shouldSilkTouchBlock, triggerMinedBlock

Methods inherited from class com.minecolonies.core.entity.ai.workers.AbstractEntityAIBasic

cancelAsynchRequestForArmor, canGoIdle, checkAndTransferFromHut, checkForToolOrWeapon, checkForToolOrWeapon, checkForToolOrWeaponAsync, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForTagExistOrCreateAsync, getActionsDoneUntilDumping, getBuildingToDump, getEffectiveSkillLevel, getExceptionTimer, getExpectedBuildingClass, getFakePlayer, getInventory, getInvertedEffectiveSkillLevel, getModuleForJob, getMostEfficientTool, getPrimarySkillLevel, getSecondarySkillLevel, getWorkingPosition, hasNotDelayed, holdEfficientTool, incrementActionsDone, incrementActionsDone, incrementActionsDoneAndDecSaturation, inventoryNeedsDump, isAfterDumpPickupAllowed, itemsNiceToHave, onException, resetActionsDone, retrieveToolInHut, retrieveToolInTileEntity, setDelay, takeItemStackFromProvider, updateRenderMetaData, waitForRequests, walkToBuilding, walkToBuilding, walkToSafePos, walkToTaggedWorkPos, walkToUnSafePos, walkToUnSafePos, walkToWorkPos, walkWithProxy, walkWithProxy, wantInventoryDumped

Methods inherited from class com.minecolonies.core.entity.ai.workers.AbstractAISkeleton

canBeInterrupted, getState, getStateAI, getTickRate, onRemoval, registerGroupTarget, registerTarget, registerTargets, resetAI, setCurrentDelay, tick

Methods inherited from class java.lang.Object

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

Field Details

requestState

protected AbstractEntityAIStructureWithWorkOrder.RequestStage requestState

The current request state (0 is solid

requestProgress

protected net.minecraft.core.BlockPos requestProgress

Request progress pos.

Constructor Details

AbstractEntityAIStructureWithWorkOrder

public AbstractEntityAIStructureWithWorkOrder(@NotNull
 J job)

Initialize the builder and add all his tasks.

Parameters:

job - the job he has.

Method Details

storeProgressPos

public void storeProgressPos(net.minecraft.core.BlockPos blockPos,
 BuildingProgressStage stage)

Description copied from class: AbstractEntityAIStructure

Store the progressPos in the building if possible for the worker.

Overrides:

storeProgressPos in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Parameters:

blockPos - the progressResult.

stage - the current stage.

getProgressPos

public Tuple<net.minecraft.core.BlockPos,BuildingProgressStage> getProgressPos()

Description copied from class: AbstractEntityAIStructure

Get the current structure progress,

Specified by:

getProgressPos in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Returns:

the progress with the current stage.

loadRequirements

public IAIState loadRequirements()

Takes the existing workorder, loads the structure and tests the worker order if it is valid.

Overrides:

loadRequirements in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Returns:

the next state to go to.

checkIfNeedsItem

protected boolean checkIfNeedsItem()

Description copied from class: AbstractEntityAIBasic

Check if

Overrides:

checkIfNeedsItem in class AbstractEntityAIBasic<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Returns:

requestMaterials

public boolean requestMaterials()

Description copied from class: AbstractEntityAIStructure

Iterates through all the required resources and stores them in the building.

Overrides:

requestMaterials in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Returns:

true if finished.

registerBlockAsNeeded

public void registerBlockAsNeeded(net.minecraft.world.item.ItemStack stack)

Description copied from class: AbstractEntityAIStructure

Register the block as needed at the building if possible.

Overrides:

registerBlockAsNeeded in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Parameters:

stack - the stack.

getTotalRequiredAmount

public int getTotalRequiredAmount(net.minecraft.world.item.ItemStack deliveredItemStack)

Description copied from class: AbstractEntityAIBasic

Get the total amount required for an itemStack. Workers have to override this if they have more information.

Overrides:

getTotalRequiredAmount in class AbstractEntityAIBasic<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Parameters:

deliveredItemStack - the required stack.

Returns:

on default the size of the stack.

executeSpecificCompleteActions

public void executeSpecificCompleteActions()

Description copied from class: AbstractEntityAIStructure

Execute specific actions on loading a structure.

Specified by:

executeSpecificCompleteActions in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

sendCompletionMessage

protected void sendCompletionMessage(IWorkOrder wo)

Send a completion message to the colony if necessary.

Parameters:

wo - the completed workorder.

reduceNeededResources

public void reduceNeededResources(net.minecraft.world.item.ItemStack stack)

Description copied from class: AbstractEntityAIStructure

Reduces the needed resources by 1.

Overrides:

reduceNeededResources in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Parameters:

stack - the stack which has been used now.

checkIfCanceled

protected boolean checkIfCanceled()

Description copied from class: AbstractEntityAIStructure

Check if the structure tusk has been canceled.

Specified by:

checkIfCanceled in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Returns:

true if reset to idle.

isAlreadyCleared

protected boolean isAlreadyCleared()

Description copied from class: AbstractEntityAIStructure

Let childs overwrite this if necessary.

Overrides:

isAlreadyCleared in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Returns:

true if so.

getTotalAmount

@Nullable
public @Nullable net.minecraft.world.item.ItemStack getTotalAmount(@Nullable
 @Nullable net.minecraft.world.item.ItemStack stack)

Check how much of a certain stuck is actually required.

Overrides:

getTotalAmount in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>

Parameters:

stack - the stack to check.

Returns:

the new stack with the correct amount.

handleSpecificCancelActions

public void handleSpecificCancelActions()

Description copied from class: AbstractEntityAIStructure

Specific actions to handle a cancellation of a structure.

Overrides:

handleSpecificCancelActions in class AbstractEntityAIStructure<J extends AbstractJobStructure<?,J>,B extends AbstractBuildingStructureBuilder>