Package com.minecolonies.core.colony.jobs

Class AbstractJob<AI extends AbstractAISkeleton<J> & ITickingStateAI,J extends AbstractJob<AI,J>>

java.lang.Object

com.minecolonies.core.colony.jobs.AbstractJob<AI,J>

All Implemented Interfaces:

IJob<AI>, net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundTag>

Direct Known Subclasses:

AbstractJobCrafter, AbstractJobGuard, AbstractJobStructure, JobArcherTraining, JobBeekeeper, JobChickenHerder, JobCombatTraining, JobComposter, JobCook, JobCowboy, JobDeliveryman, JobFisherman, JobFlorist, JobHealer, JobPlaceholder, JobPupil, JobRabbitHerder, JobResearch, JobShepherd, JobSmelter, JobStablemaster, JobStudent, JobSwineHerder, JobTeacher

public abstract class AbstractJob<AI extends AbstractAISkeleton<J> & ITickingStateAI,J extends AbstractJob<AI,J>>
extends Object
implements IJob<AI>

Basic job information.

Suppressing Sonar Rule squid:S2390 This rule does "Classes should not access static members of their own subclasses during initialization" But in this case the rule does not apply because We are only mapping classes and that is reasonable

Field Summary

Fields

Modifier and Type	Field	Description
protected IBuilding	workBuilding	The work building
protected net.minecraft.core.BlockPos	workBuildingPos	Position of the work building
protected IAssignsJob	workModule	The work module we're assigned to

Constructor Summary

Constructors

Constructor	Description
AbstractJob(ICitizenData entity)	Initialize citizen data.

Method Summary

Modifier and Type	Method	Description
boolean	allowsAvoidance()	Method to check if the colony job allows avoidance.
boolean	assignTo(IAssignsJob module)	Assigns the job to its specific work module
boolean	canAIBeInterrupted()	Check if it is okay to eat
void	clearActionsDone()	Clear the actions done counter.
void	createAI()	Creates the work AI
void	deserializeNBT(net.minecraft.nbt.CompoundTag compound)
final boolean	equals(Object o)
int	getActionsDone()	Getter for the amount of actions done.
Set<IToken<?>>	getAsyncRequests()	Get a set of async requests connected to this job.
net.minecraft.core.BlockPos	getBuildingPos()	Gets the position of the building the job is assigned to
ICitizenData	getCitizen()	Get the CitizenData that this Job belongs to.
IColony	getColony()	Get the Colony that this Job is associated with (shortcut for getAssignedCitizen().getColonyByPosFromWorld()).
double	getDiseaseModifier()	Disease modifier of the job.
final JobEntry	getJobRegistryEntry()	The JobEntry for this job.
net.minecraft.resources.ResourceLocation	getModel()	Get the RenderBipedCitizen.Model to use when the Citizen performs this job role.
String	getNameTagDescription()	This method can be used to display the current status.
IBuilding	getWorkBuilding()	Gets the work building
AI	getWorkerAI()	Get the worker AI associated to this job
IAssignsJob	getWorkModule()	Gets the module this job is assigned to
boolean	hasCheckedForFoodToday()	Check if the citizen already checked for food in his chest today.
final int	hashCode()
boolean	ignoresDamage(@NotNull net.minecraft.world.damagesource.DamageSource damageSource)	Check if the particular job ignores a particular damage type.
void	incrementActionsDone()	Increase the actions done since the last reset by 1 Used for example to detect if and when the inventory has to be dumped.
void	incrementActionsDone(int numberOfActions)	Increase the actions done since the last reset by numberOfActions Used for example to detect if and when the inventory has to be dumped.
boolean	isIdling()	Check if the citizen is in an idle state.
void	markRequestSync(IToken<?> id)	Mark a request as a synchronous (blocking request).
void	onRemoval()	When job removed (death of citizen or job change).
boolean	onStackPickUp(@NotNull net.minecraft.world.item.ItemStack pickedUpStack)	Method called when a stack is pickup by the entity.
void	onWakeUp()	Executed every time the colony woke up.
boolean	pickupSuccess(@NotNull net.minecraft.world.item.ItemStack pickedUpStack)	If the worker can pick up the stack.
void	processOfflineTime(long time)	Process time the colony was offline.
void	resetAI()	Reset the AI.
net.minecraft.nbt.CompoundTag	serializeNBT()
void	serializeToView(net.minecraft.network.FriendlyByteBuf buffer)	Serialize the job to a buffer.
void	setCheckedForFood()	Sets that the citizen on this day already searched for food in his chest.
final void	setNameTag(String nameTag)	Used by the AI skeleton to change a citizens name.
void	setRegistryEntry(JobEntry jobEntry)	Set the registry entry of the job.
void	triggerDeathAchievement(net.minecraft.world.damagesource.DamageSource source, AbstractEntityCitizen citizen)	Override this to implement Job specific death achievements.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.minecolonies.api.colony.jobs.IJob

generateAI, getIdleSeverity, getInactivityLimit, getSaturationFactor, initEntityValues, isGuard, onLevelUp, triggerActivityChangeAction

Field Details

workBuildingPos

protected net.minecraft.core.BlockPos workBuildingPos

Position of the work building

workBuilding

protected IBuilding workBuilding

The work building

workModule

protected IAssignsJob workModule

The work module we're assigned to

Constructor Details

AbstractJob

public AbstractJob(ICitizenData entity)

Initialize citizen data.

Parameters:

entity - the citizen data.

Method Details

pickupSuccess

public boolean pickupSuccess(@NotNull
 @NotNull net.minecraft.world.item.ItemStack pickedUpStack)

Description copied from interface: IJob

If the worker can pick up the stack.

Specified by:

pickupSuccess in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Parameters:

pickedUpStack - the stack to check.

Returns:

true if so.

getModel

public net.minecraft.resources.ResourceLocation getModel()

Description copied from interface: IJob

Get the RenderBipedCitizen.Model to use when the Citizen performs this job role.

Specified by:

getModel in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

Model of the citizen.

getColony

public IColony getColony()

Description copied from interface: IJob

Get the Colony that this Job is associated with (shortcut for getAssignedCitizen().getColonyByPosFromWorld()).

Specified by:

getColony in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

IColony of the citizen.

setRegistryEntry

public void setRegistryEntry(JobEntry jobEntry)

Description copied from interface: IJob

Set the registry entry of the job.

Specified by:

setRegistryEntry in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Parameters:

jobEntry - the job entry belonging to it.

getBuildingPos

public net.minecraft.core.BlockPos getBuildingPos()

Description copied from interface: IJob

Gets the position of the building the job is assigned to

Specified by:

getBuildingPos in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

getWorkBuilding

public IBuilding getWorkBuilding()

Description copied from interface: IJob

Gets the work building

Specified by:

getWorkBuilding in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

getWorkModule

public IAssignsJob getWorkModule()

Description copied from interface: IJob

Gets the module this job is assigned to

Specified by:

getWorkModule in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

assignTo

public boolean assignTo(IAssignsJob module)

Description copied from interface: IJob

Assigns the job to its specific work module

Specified by:

assignTo in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

getJobRegistryEntry

public final JobEntry getJobRegistryEntry()

Description copied from interface: IJob

The JobEntry for this job.

Specified by:

getJobRegistryEntry in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

The JobEntry.

serializeNBT

public net.minecraft.nbt.CompoundTag serializeNBT()

Specified by:

serializeNBT in interface net.minecraftforge.common.util.INBTSerializable<AI extends AbstractAISkeleton<J> & ITickingStateAI>

deserializeNBT

public void deserializeNBT(net.minecraft.nbt.CompoundTag compound)

Specified by:

deserializeNBT in interface net.minecraftforge.common.util.INBTSerializable<AI extends AbstractAISkeleton<J> & ITickingStateAI>

serializeToView

public void serializeToView(net.minecraft.network.FriendlyByteBuf buffer)

Description copied from interface: IJob

Serialize the job to a buffer.

Specified by:

serializeToView in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Parameters:

buffer - the buffer to serialize it to.

getAsyncRequests

public Set<IToken<?>> getAsyncRequests()

Get a set of async requests connected to this job.

Specified by:

getAsyncRequests in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

a set of ITokens.

markRequestSync

public void markRequestSync(IToken<?> id)

Description copied from interface: IJob

Mark a request as a synchronous (blocking request).

Specified by:

markRequestSync in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Parameters:

id - the id.

createAI

public void createAI()

Description copied from interface: IJob

Creates the work AI

Specified by:

createAI in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

hasCheckedForFoodToday

public boolean hasCheckedForFoodToday()

Description copied from interface: IJob

Check if the citizen already checked for food in his chest today.

Specified by:

hasCheckedForFoodToday in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

true if so.

setCheckedForFood

public void setCheckedForFood()

Description copied from interface: IJob

Sets that the citizen on this day already searched for food in his chest.

Specified by:

setCheckedForFood in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

getNameTagDescription

public String getNameTagDescription()

Description copied from interface: IJob

This method can be used to display the current status. That a citizen is having.

Specified by:

getNameTagDescription in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

Small string to display info in name tag

setNameTag

public final void setNameTag(String nameTag)

Description copied from interface: IJob

Used by the AI skeleton to change a citizens name. Mostly used to update debugging information.

Specified by:

setNameTag in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Parameters:

nameTag - The name tag to display.

triggerDeathAchievement

public void triggerDeathAchievement(net.minecraft.world.damagesource.DamageSource source,
 AbstractEntityCitizen citizen)

Description copied from interface: IJob

Override this to implement Job specific death achievements.

Specified by:

triggerDeathAchievement in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Parameters:

source - of the death

citizen - which just died

onStackPickUp

public boolean onStackPickUp(@NotNull
 @NotNull net.minecraft.world.item.ItemStack pickedUpStack)

Description copied from interface: IJob

Method called when a stack is pickup by the entity.

Specified by:

onStackPickUp in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Parameters:

pickedUpStack - The stack that is being picked up.

Returns:

true when the stack has been used to resolve a request, false when not.

getCitizen

public ICitizenData getCitizen()

Description copied from interface: IJob

Get the CitizenData that this Job belongs to.

Specified by:

getCitizen in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

CitizenData that owns this Job.

onWakeUp

public void onWakeUp()

Description copied from interface: IJob

Executed every time the colony woke up.

Specified by:

onWakeUp in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

canAIBeInterrupted

public boolean canAIBeInterrupted()

Description copied from interface: IJob

Check if it is okay to eat

Specified by:

canAIBeInterrupted in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

true if so.

getActionsDone

public int getActionsDone()

Description copied from interface: IJob

Getter for the amount of actions done.

Specified by:

getActionsDone in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

the quantity.

incrementActionsDone

public void incrementActionsDone()

Description copied from interface: IJob

Increase the actions done since the last reset by 1 Used for example to detect if and when the inventory has to be dumped.

Specified by:

incrementActionsDone in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

incrementActionsDone

public void incrementActionsDone(int numberOfActions)

Description copied from interface: IJob

Increase the actions done since the last reset by numberOfActions Used for example to detect if and when the inventory has to be dumped.

Specified by:

incrementActionsDone in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

clearActionsDone

public void clearActionsDone()

Description copied from interface: IJob

Clear the actions done counter. Call this when dumping into the chest.

Specified by:

clearActionsDone in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

getWorkerAI

public AI getWorkerAI()

Description copied from interface: IJob

Get the worker AI associated to this job

Specified by:

getWorkerAI in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

worker AI

isIdling

public boolean isIdling()

Description copied from interface: IJob

Check if the citizen is in an idle state.

Specified by:

isIdling in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

true if so.

resetAI

public void resetAI()

Description copied from interface: IJob

Reset the AI.

Specified by:

resetAI in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

allowsAvoidance

public boolean allowsAvoidance()

Description copied from interface: IJob

Method to check if the colony job allows avoidance.

Specified by:

allowsAvoidance in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

true if so.

getDiseaseModifier

public double getDiseaseModifier()

Description copied from interface: IJob

Disease modifier of the job.

Specified by:

getDiseaseModifier in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Returns:

the modifier of the job.

onRemoval

public void onRemoval()

Description copied from interface: IJob

When job removed (death of citizen or job change).

Specified by:

onRemoval in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

ignoresDamage

public boolean ignoresDamage(@NotNull
 @NotNull net.minecraft.world.damagesource.DamageSource damageSource)

Description copied from interface: IJob

Check if the particular job ignores a particular damage type.

Specified by:

ignoresDamage in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Parameters:

damageSource - the damage source to check.

Returns:

true if so.

processOfflineTime

public void processOfflineTime(long time)

Description copied from interface: IJob

Process time the colony was offline.

Specified by:

processOfflineTime in interface IJob<AI extends AbstractAISkeleton<J> & ITickingStateAI>

Parameters:

time - the time in seconds.

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object