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

Class EntityAIQuarrier

java.lang.Object

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

com.minecolonies.core.entity.ai.workers.AbstractEntityAIBasic<JobQuarrier,BuildingMiner>

com.minecolonies.core.entity.ai.workers.AbstractEntityAISkill<JobQuarrier,BuildingMiner>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIInteract<JobQuarrier,BuildingMiner>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIStructureWithWorkOrder<JobQuarrier,BuildingMiner>

com.minecolonies.core.entity.ai.workers.production.EntityAIQuarrier

All Implemented Interfaces:

ITickingStateAI

public class EntityAIQuarrier
extends AbstractEntityAIStructureWithWorkOrder<JobQuarrier,BuildingMiner>

Class which handles the quarrier behaviour. The quarrier digs out a large hole and builds infrastructure around it.

Nested Class Summary

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

AbstractEntityAIStructureWithWorkOrder.RequestStage

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

AbstractEntityAIStructure.ItemCheckResult

Field Summary

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

requestProgress, requestState

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
EntityAIQuarrier(@NotNull JobQuarrier job)	Constructor for the Quarrier.

Method Summary

Modifier and Type	Method	Description
IAIState	afterStructureLoading()	The next state after structure loading.
protected boolean	checkIfCanceled()	Check if the structure tusk has been canceled.
IAIState	doMining()	Separate step for mining.
void	executeSpecificCompleteActions()	Execute specific actions on loading a structure.
protected int	getActionsDoneUntilDumping()	Calculates after how many actions the ai should dump it's inventory.
int	getBreakSpeedLevel()	Get the level that affects the break speed.
protected IBuilding	getBuildingToDump()	Get the building to dump the inventory into.
Class<BuildingMiner>	getExpectedBuildingClass()	Can be overridden in implementations to return the exact building type the worker expects.
int	getPlaceSpeedLevel()	Get the level that affects the place speed.
protected net.minecraft.core.BlockPos	getPosToWorkAt()	Get the position the citizen needs to walk to in order to build
net.minecraft.world.level.block.state.BlockState	getSolidSubstitution(net.minecraft.core.BlockPos worldPos, Function<net.minecraft.core.BlockPos,@Nullable net.minecraft.world.level.block.state.BlockState> virtualBlocks)	Searches a handy block to substitute a non-solid space which should be guaranteed solid.
net.minecraft.world.item.ItemStack	getTotalAmount(net.minecraft.world.item.ItemStack stack)	Check how much of a certain stuck is actually required.
protected boolean	goToNextStage(com.ldtteam.structurize.placement.StructurePhasePlacementResult result)	This method is called when a stage is finished, and it is needed to go to the next stage
IAIState	loadRequirements()	Takes the existing workorder, loads the structure and tests the worker order if it is valid.
void	loadStructure(@NotNull IBuilderWorkOrder workOrder, net.minecraft.core.BlockPos position, boolean removal)	Loads the structure given the name, rotation and position.
void	onBlockDropReception(List<net.minecraft.world.item.ItemStack> blockDrops)	Event triggered after receiving a list of block drops.
boolean	requestMaterials()	Iterates through all the required resources and stores them in the building.
void	setStructurePlacer(BuildingStructureHandler<JobQuarrier,BuildingMiner> structure)	Set the structure placer.
boolean	shallReplaceSolidSubstitutionBlock(net.minecraft.world.level.block.Block worldBlock, net.minecraft.world.level.block.state.BlockState worldMetadata)	Check if a solid substitution block should be overwritten in a specific case.
protected boolean	skipBuilding(com.ldtteam.structurize.util.BlueprintPositionInfo info, net.minecraft.core.BlockPos pos, com.ldtteam.structurize.placement.structure.IStructureHandler handler)	Checks wich blocks are skipped on building
protected boolean	skipClearing(com.ldtteam.structurize.util.BlueprintPositionInfo info, net.minecraft.core.BlockPos pos, com.ldtteam.structurize.placement.structure.IStructureHandler handler)	Checks which blocks are skipped on clearing
protected @NotNull IAIState	startWorkingAtOwnBuilding()	Start working at own building.
protected IAIState	structureStep()	The Structure step to execute the actual placement actions etc.
protected void	triggerMinedBlock(@NotNull net.minecraft.core.BlockPos position, @NotNull net.minecraft.world.level.block.state.BlockState blockToMine)	Trigger for miners if they want to do something specific per mined block.
protected void	updateRenderMetaData()	Can be overridden in implementations.
boolean	walkToConstructionSite(net.minecraft.core.BlockPos currentBlock)	Walk to the current construction site.

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

checkIfNeedsItem, getProgressPos, getTotalRequiredAmount, handleSpecificCancelActions, isAlreadyCleared, reduceNeededResources, registerBlockAsNeeded, sendCompletionMessage, storeProgressPos

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

afterDump, afterRequestPickUp, checkForExtraBuildingActions, completeBuild, getCurrentBuildingPosition, getCurrentWorkingPosition, getStateAfterPickUp, getWorker, getWorkingPosition, hasListOfResInInvOrRequest, isBlockFree, isDecoItem, isThereAStructureToBuild, pickUpMaterial, resetCurrentStructure, startBuilding

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

fillItemsList, gatherItems, getBlockMiningTime, getItemsForPickUp, increaseBlockDrops, isItemWorthPickingUp, mineBlock, mineBlock, mineBlock, resetGatheringItems, searchForItems, shouldSilkTouchBlock

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, getEffectiveSkillLevel, getExceptionTimer, getFakePlayer, getInventory, getInvertedEffectiveSkillLevel, getModuleForJob, getMostEfficientTool, getPrimarySkillLevel, getSecondarySkillLevel, getWorkingPosition, hasNotDelayed, holdEfficientTool, incrementActionsDone, incrementActionsDone, incrementActionsDoneAndDecSaturation, inventoryNeedsDump, isAfterDumpPickupAllowed, itemsNiceToHave, onException, resetActionsDone, retrieveToolInHut, retrieveToolInTileEntity, setDelay, takeItemStackFromProvider, 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

Constructor Details

EntityAIQuarrier

public EntityAIQuarrier(@NotNull
 @NotNull JobQuarrier job)

Constructor for the Quarrier. Defines the tasks the miner executes.

Parameters:

job - a quarrier job to use.

Method Details

getExpectedBuildingClass

public Class<BuildingMiner> getExpectedBuildingClass()

Description copied from class: AbstractEntityAIBasic

Can be overridden in implementations to return the exact building type the worker expects.

Specified by:

getExpectedBuildingClass in class AbstractEntityAIBasic<JobQuarrier,BuildingMiner>

Returns:

the building type associated with this AI's worker.

startWorkingAtOwnBuilding

@NotNull
protected @NotNull IAIState startWorkingAtOwnBuilding()

Description copied from class: AbstractEntityAIStructure

Start working at own building. Override for worker specific implementations.

Overrides:

startWorkingAtOwnBuilding in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Returns:

next state.

loadRequirements

public IAIState loadRequirements()

Description copied from class: AbstractEntityAIStructureWithWorkOrder

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

Overrides:

loadRequirements in class AbstractEntityAIStructureWithWorkOrder<JobQuarrier,BuildingMiner>

Returns:

the next state to go to.

onBlockDropReception

public void onBlockDropReception(List<net.minecraft.world.item.ItemStack> blockDrops)

Description copied from class: AbstractEntityAIInteract

Event triggered after receiving a list of block drops.

Overrides:

onBlockDropReception in class AbstractEntityAIInteract<JobQuarrier,BuildingMiner>

Parameters:

blockDrops - the received items from the block.

loadStructure

public void loadStructure(@NotNull
 @NotNull IBuilderWorkOrder workOrder,
 net.minecraft.core.BlockPos position,
 boolean removal)

Description copied from class: AbstractEntityAIStructure

Loads the structure given the name, rotation and position.

Overrides:

loadStructure in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Parameters:

workOrder - the work order.

position - the position to set it.

removal - if removal step.

getBuildingToDump

protected IBuilding getBuildingToDump()

Description copied from class: AbstractEntityAIBasic

Get the building to dump the inventory into.

Overrides:

getBuildingToDump in class AbstractEntityAIBasic<JobQuarrier,BuildingMiner>

Returns:

its own building by default.

structureStep

protected IAIState structureStep()

Description copied from class: AbstractEntityAIStructure

The Structure step to execute the actual placement actions etc.

Overrides:

structureStep in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Returns:

the next step to go to.

getPosToWorkAt

protected net.minecraft.core.BlockPos getPosToWorkAt()

Description copied from class: AbstractEntityAIStructure

Get the position the citizen needs to walk to in order to build

Overrides:

getPosToWorkAt in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Returns:

the position to go to

goToNextStage

protected boolean goToNextStage(com.ldtteam.structurize.placement.StructurePhasePlacementResult result)

Description copied from class: AbstractEntityAIStructure

This method is called when a stage is finished, and it is needed to go to the next stage

Overrides:

goToNextStage in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Returns:

whether it succeeded, i.e. there was a next stage to go to.

skipBuilding

protected boolean skipBuilding(com.ldtteam.structurize.util.BlueprintPositionInfo info,
 net.minecraft.core.BlockPos pos,
 com.ldtteam.structurize.placement.structure.IStructureHandler handler)

Description copied from class: AbstractEntityAIStructure

Checks wich blocks are skipped on building

Overrides:

skipBuilding in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Parameters:

info -

pos -

handler -

Returns:

skipClearing

protected boolean skipClearing(com.ldtteam.structurize.util.BlueprintPositionInfo info,
 net.minecraft.core.BlockPos pos,
 com.ldtteam.structurize.placement.structure.IStructureHandler handler)

Description copied from class: AbstractEntityAIStructure

Checks which blocks are skipped on clearing

Overrides:

skipClearing in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Parameters:

info -

pos -

handler -

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 AbstractEntityAIStructureWithWorkOrder<JobQuarrier,BuildingMiner>

Returns:

true if finished.

checkIfCanceled

protected boolean checkIfCanceled()

Description copied from class: AbstractEntityAIStructure

Check if the structure tusk has been canceled.

Overrides:

checkIfCanceled in class AbstractEntityAIStructureWithWorkOrder<JobQuarrier,BuildingMiner>

Returns:

true if reset to idle.

setStructurePlacer

public void setStructurePlacer(BuildingStructureHandler<JobQuarrier,BuildingMiner> structure)

Description copied from class: AbstractEntityAIStructure

Set the structure placer.

Overrides:

setStructurePlacer in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Parameters:

structure - the placer.

getBreakSpeedLevel

public int getBreakSpeedLevel()

Description copied from class: AbstractEntityAIInteract

Get the level that affects the break speed.

Overrides:

getBreakSpeedLevel in class AbstractEntityAIInteract<JobQuarrier,BuildingMiner>

Returns:

the level.

getPlaceSpeedLevel

public int getPlaceSpeedLevel()

Description copied from class: AbstractEntityAIStructure

Get the level that affects the place speed.

Specified by:

getPlaceSpeedLevel in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Returns:

the level.

getActionsDoneUntilDumping

protected int getActionsDoneUntilDumping()

Description copied from class: AbstractEntityAIBasic

Calculates after how many actions the ai should dump it's inventory.

Override this to change the value.

Overrides:

getActionsDoneUntilDumping in class AbstractEntityAIBasic<JobQuarrier,BuildingMiner>

Returns:

the number of actions done before item dump.

updateRenderMetaData

protected void updateRenderMetaData()

Description copied from class: AbstractEntityAIBasic

Can be overridden in implementations.

Here the AI can check if the chestBelt has to be re rendered and do it.

Overrides:

updateRenderMetaData in class AbstractEntityAIBasic<JobQuarrier,BuildingMiner>

doMining

public IAIState doMining()

Description copied from class: AbstractEntityAIStructure

Separate step for mining.

Overrides:

doMining in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Returns:

the next state to go to.

getTotalAmount

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

Description copied from class: AbstractEntityAIStructureWithWorkOrder

Check how much of a certain stuck is actually required.

Overrides:

getTotalAmount in class AbstractEntityAIStructureWithWorkOrder<JobQuarrier,BuildingMiner>

Parameters:

stack - the stack to check.

Returns:

the new stack with the correct amount.

afterStructureLoading

public IAIState afterStructureLoading()

Description copied from class: AbstractEntityAIStructure

The next state after structure loading.

Overrides:

afterStructureLoading in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Returns:

the next state.

executeSpecificCompleteActions

public void executeSpecificCompleteActions()

Description copied from class: AbstractEntityAIStructure

Execute specific actions on loading a structure.

Overrides:

executeSpecificCompleteActions in class AbstractEntityAIStructureWithWorkOrder<JobQuarrier,BuildingMiner>

shallReplaceSolidSubstitutionBlock

public boolean shallReplaceSolidSubstitutionBlock(net.minecraft.world.level.block.Block worldBlock,
 net.minecraft.world.level.block.state.BlockState worldMetadata)

Description copied from class: AbstractEntityAIStructure

Check if a solid substitution block should be overwritten in a specific case.

Specified by:

shallReplaceSolidSubstitutionBlock in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Parameters:

worldBlock - the worldblock.

worldMetadata - the world metadata.

Returns:

true if should be overwritten.

walkToConstructionSite

public boolean walkToConstructionSite(net.minecraft.core.BlockPos currentBlock)

Description copied from class: AbstractEntityAIStructure

Walk to the current construction site.

Calculates and caches the position where to walk to.

Specified by:

walkToConstructionSite in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Parameters:

currentBlock - the current block it is working on.

Returns:

true while walking to the site.

getSolidSubstitution

public net.minecraft.world.level.block.state.BlockState getSolidSubstitution(net.minecraft.core.BlockPos worldPos,
 Function<net.minecraft.core.BlockPos,@Nullable net.minecraft.world.level.block.state.BlockState> virtualBlocks)

Description copied from class: AbstractEntityAIStructure

Searches a handy block to substitute a non-solid space which should be guaranteed solid.

Overrides:

getSolidSubstitution in class AbstractEntityAIStructure<JobQuarrier,BuildingMiner>

Parameters:

worldPos - the location the block should be at.

virtualBlocks - blueprint blocks, fnc may return null if virtual block is not available (then use level instead for getting surrounding block states), pos argument is using world coords

Returns:

the Block.

triggerMinedBlock

protected void triggerMinedBlock(@NotNull
 @NotNull net.minecraft.core.BlockPos position,
 @NotNull
 @NotNull net.minecraft.world.level.block.state.BlockState blockToMine)

Description copied from class: AbstractEntityAIInteract

Trigger for miners if they want to do something specific per mined block.

Overrides:

triggerMinedBlock in class AbstractEntityAIInteract<JobQuarrier,BuildingMiner>

Parameters:

position - the position of the block.

blockToMine - the mined block.