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

Class EntityAIStructureBuilder

java.lang.Object

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

com.minecolonies.core.entity.ai.workers.AbstractEntityAIBasic<JobBuilder,BuildingBuilder>

com.minecolonies.core.entity.ai.workers.AbstractEntityAISkill<JobBuilder,BuildingBuilder>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIInteract<JobBuilder,BuildingBuilder>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIStructure<JobBuilder,BuildingBuilder>

com.minecolonies.core.entity.ai.workers.AbstractEntityAIStructureWithWorkOrder<JobBuilder,BuildingBuilder>

com.minecolonies.core.entity.ai.workers.builder.EntityAIStructureBuilder

All Implemented Interfaces:

ITickingStateAI

public class EntityAIStructureBuilder
extends AbstractEntityAIStructureWithWorkOrder<JobBuilder,BuildingBuilder>

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

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
EntityAIStructureBuilder(@NotNull JobBuilder job)	Initialize the builder and add all his tasks.

Method Summary

Modifier and Type	Method	Description
IAIState	afterDump()	State to go to after dumping.
IAIState	afterRequestPickUp()	What to do after picking up a request.
boolean	canGoIdle()	If the worker currently has work to do or could also just wander around.
void	checkForExtraBuildingActions()	Check for extra building options to do with each block.
protected int	getActionsDoneUntilDumping()	Calculates after how many actions the AI should dump its inventory.
int	getBlockMiningTime(@NotNull net.minecraft.world.level.block.state.BlockState state, @NotNull net.minecraft.core.BlockPos pos)	Calculate how long it takes to mine this block.
int	getBreakSpeedLevel()	Get the level that affects the break speed.
Class<BuildingBuilder>	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.
boolean	isAfterDumpPickupAllowed()	Checks whether automatic pickups after dumps are allowed.
protected boolean	mineBlock(@NotNull net.minecraft.core.BlockPos blockToMine, @NotNull net.minecraft.core.BlockPos safeStand)	Will simulate mining a block with particles ItemDrop etc.
protected void	sendCompletionMessage(IWorkOrder wo)	Send a completion message to the colony if necessary.
void	setStructurePlacer(BuildingStructureHandler<JobBuilder,BuildingBuilder> 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 IAIState	startWorkingAtOwnBuilding()	Start working at own building.
boolean	walkToConstructionSite(net.minecraft.core.BlockPos currentBlock)	Walk to the current construction site.

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

checkIfCanceled, checkIfNeedsItem, executeSpecificCompleteActions, getProgressPos, getTotalAmount, getTotalRequiredAmount, handleSpecificCancelActions, isAlreadyCleared, loadRequirements, reduceNeededResources, registerBlockAsNeeded, requestMaterials, storeProgressPos

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

afterStructureLoading, completeBuild, doMining, getCurrentBuildingPosition, getCurrentWorkingPosition, getPosToWorkAt, getSolidSubstitution, getStateAfterPickUp, getWorker, getWorkingPosition, goToNextStage, hasListOfResInInvOrRequest, isBlockFree, isDecoItem, isThereAStructureToBuild, loadStructure, pickUpMaterial, resetCurrentStructure, skipBuilding, skipClearing, startBuilding, structureStep

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

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

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

cancelAsynchRequestForArmor, checkAndTransferFromHut, checkForToolOrWeapon, checkForToolOrWeapon, checkForToolOrWeaponAsync, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreate, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForItemExistOrCreateAsync, checkIfRequestForTagExistOrCreateAsync, getBuildingToDump, getEffectiveSkillLevel, getExceptionTimer, getFakePlayer, getInventory, getInvertedEffectiveSkillLevel, getModuleForJob, getMostEfficientTool, getPrimarySkillLevel, getSecondarySkillLevel, getWorkingPosition, hasNotDelayed, holdEfficientTool, incrementActionsDone, incrementActionsDone, incrementActionsDoneAndDecSaturation, inventoryNeedsDump, 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

Constructor Details

EntityAIStructureBuilder

public EntityAIStructureBuilder(@NotNull
 @NotNull JobBuilder job)

Initialize the builder and add all his tasks.

Parameters:

job - the job he has.

Method Details

getBreakSpeedLevel

public int getBreakSpeedLevel()

Description copied from class: AbstractEntityAIInteract

Get the level that affects the break speed.

Overrides:

getBreakSpeedLevel in class AbstractEntityAIInteract<JobBuilder,BuildingBuilder>

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<JobBuilder,BuildingBuilder>

Returns:

the level.

getExpectedBuildingClass

public Class<BuildingBuilder> 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<JobBuilder,BuildingBuilder>

Returns:

the building type associated with this AI's worker.

setStructurePlacer

public void setStructurePlacer(BuildingStructureHandler<JobBuilder,BuildingBuilder> structure)

Description copied from class: AbstractEntityAIStructure

Set the structure placer.

Overrides:

setStructurePlacer in class AbstractEntityAIStructure<JobBuilder,BuildingBuilder>

Parameters:

structure - the placer.

isAfterDumpPickupAllowed

public boolean isAfterDumpPickupAllowed()

Description copied from class: AbstractEntityAIBasic

Checks whether automatic pickups after dumps are allowed. Usually we want this, but if the worker is currently crafting/building, he will handle deliveries/afterdumps in their resolvers, so we can disable automatic pickups in that time. Note that this is just a efficiency-thing. It doesn't hurt when the dman does a pickup during crafting, it's just a wasted run. Therefore, this flag is only considered for *automatic* pickups after dump. It is *ignored* for player-triggered forcePickups, and when the inventory is full.

Overrides:

isAfterDumpPickupAllowed in class AbstractEntityAIBasic<JobBuilder,BuildingBuilder>

Returns:

true if after-dump pickups are allowed currently.

startWorkingAtOwnBuilding

protected IAIState startWorkingAtOwnBuilding()

Description copied from class: AbstractEntityAIStructure

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

Overrides:

startWorkingAtOwnBuilding in class AbstractEntityAIStructure<JobBuilder,BuildingBuilder>

Returns:

next state.

checkForExtraBuildingActions

public void checkForExtraBuildingActions()

Description copied from class: AbstractEntityAIStructure

Check for extra building options to do with each block.

Overrides:

checkForExtraBuildingActions in class AbstractEntityAIStructure<JobBuilder,BuildingBuilder>

mineBlock

protected boolean mineBlock(@NotNull
 @NotNull net.minecraft.core.BlockPos blockToMine,
 @NotNull
 @NotNull net.minecraft.core.BlockPos safeStand)

Description copied from class: AbstractEntityAIInteract

Will simulate mining a block with particles ItemDrop etc. Attention: Because it simulates delay, it has to be called 2 times. So make sure the code path up to this function is reachable a second time. And make sure to immediately exit the update function when this returns false.

Overrides:

mineBlock in class AbstractEntityAIInteract<JobBuilder,BuildingBuilder>

Parameters:

blockToMine - the block that should be mined

safeStand - the block we want to stand on to do that

Returns:

true once we're done

afterRequestPickUp

public IAIState afterRequestPickUp()

Description copied from class: AbstractEntityAIBasic

What to do after picking up a request.

Overrides:

afterRequestPickUp in class AbstractEntityAIStructure<JobBuilder,BuildingBuilder>

Returns:

the next state to go to.

afterDump

public IAIState afterDump()

Description copied from class: AbstractEntityAIBasic

State to go to after dumping.

Overrides:

afterDump in class AbstractEntityAIStructure<JobBuilder,BuildingBuilder>

Returns:

the next state.

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<JobBuilder,BuildingBuilder>

Parameters:

currentBlock - the current block it is working on.

Returns:

true while walking to the site.

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<JobBuilder,BuildingBuilder>

Parameters:

worldBlock - the worldblock.

worldMetadata - the world metadata.

Returns:

true if should be overwritten.

getBlockMiningTime

public int getBlockMiningTime(@NotNull
 @NotNull net.minecraft.world.level.block.state.BlockState state,
 @NotNull
 @NotNull net.minecraft.core.BlockPos pos)

Description copied from class: AbstractEntityAIInteract

Calculate how long it takes to mine this block.

Overrides:

getBlockMiningTime in class AbstractEntityAIInteract<JobBuilder,BuildingBuilder>

Parameters:

state - the blockstate

pos - coordinate

Returns:

the delay in ticks

getActionsDoneUntilDumping

protected int getActionsDoneUntilDumping()

Calculates after how many actions the AI should dump its inventory.

Overrides:

getActionsDoneUntilDumping in class AbstractEntityAIBasic<JobBuilder,BuildingBuilder>

Returns:

the number of actions done before item dump.

sendCompletionMessage

protected void sendCompletionMessage(IWorkOrder wo)

Description copied from class: AbstractEntityAIStructureWithWorkOrder

Send a completion message to the colony if necessary.

Overrides:

sendCompletionMessage in class AbstractEntityAIStructureWithWorkOrder<JobBuilder,BuildingBuilder>

Parameters:

wo - the completed workorder.

canGoIdle

public boolean canGoIdle()

Description copied from class: AbstractEntityAIBasic

If the worker currently has work to do or could also just wander around.

Overrides:

canGoIdle in class AbstractEntityAIBasic<JobBuilder,BuildingBuilder>

Returns:

true if can go idle.