Package com.minecolonies.core.colony.jobs

Class AbstractJobGuard<J extends AbstractJobGuard<J>>

java.lang.Object

com.minecolonies.core.colony.jobs.AbstractJob<AbstractEntityAIGuard<J,? extends AbstractBuildingGuards>,J>

com.minecolonies.core.colony.jobs.AbstractJobGuard<J>

All Implemented Interfaces:

IJob<AbstractEntityAIGuard<J,? extends AbstractBuildingGuards>>, net.neoforged.neoforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundTag>

Direct Known Subclasses:

JobCavalry, JobDruid, JobKnight, JobRanger

public abstract class AbstractJobGuard<J extends AbstractJobGuard<J>>
extends AbstractJob<AbstractEntityAIGuard<J,? extends AbstractBuildingGuards>,J>

Abstract Class for Guard Jobs.

Field Summary

Fields inherited from class com.minecolonies.core.colony.jobs.AbstractJob

workBuilding, workBuildingPos, workModule

Constructor Summary

Constructors

Constructor	Description
AbstractJobGuard(ICitizenData entity)	Initialize citizen data.

Method Summary

Modifier and Type	Method	Description
boolean	allowsAvoidance()	Method to check if the colony job allows avoidance.
AbstractEntityAIGuard<J,? extends AbstractBuildingGuards>	generateAI()	Generate your AI class to register.
protected abstract AbstractEntityAIGuard<J,? extends AbstractBuildingGuards>	generateGuardAI()
double	getSaturationFactor()	Job saturation factor.
void	initEntityValues(AbstractEntityCitizen citizen)	Initizalizes values for an entity when the entity is spawned/assigned to the job
boolean	isAsleep()	Whether the guard is asleep.
boolean	isGuard()	Whether the job is a guard
void	triggerDeathAchievement(net.minecraft.world.damagesource.DamageSource source, AbstractEntityCitizen citizen)	Override this to implement Job specific death achievements.

Methods inherited from class com.minecolonies.core.colony.jobs.AbstractJob

assignTo, canAIBeInterrupted, clearActionsDone, createAI, deserializeNBT, equals, getActionsDone, getAsyncRequests, getBuildingPos, getCitizen, getColony, getDiseaseModifier, getJobRegistryEntry, getModel, getNameTagDescription, getWorkBuilding, getWorkerAI, getWorkModule, hasCheckedForFoodToday, hashCode, ignoresDamage, incrementActionsDone, incrementActionsDone, isIdling, markRequestSync, onRemoval, onStackPickUp, onWakeUp, pickupSuccess, processOfflineTime, resetAI, serializeNBT, serializeToView, setCheckedForFood, setNameTag, setRegistryEntry

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

getIdleSeverity, getInactivityLimit, onLevelUp, triggerActivityChangeAction

Constructor Details

AbstractJobGuard

public AbstractJobGuard(ICitizenData entity)

Initialize citizen data.

Parameters:

entity - the citizen data.

Method Details

generateGuardAI

protected abstract AbstractEntityAIGuard<J,? extends AbstractBuildingGuards> generateGuardAI()

generateAI

public AbstractEntityAIGuard<J,? extends AbstractBuildingGuards> generateAI()

Description copied from interface: IJob

Generate your AI class to register.

Suppressing Sonar Rule squid:S1452 This rule does "Generic wildcard types should not be used in return parameters" But in this case the rule does not apply because We are fine with all AbstractJob implementations and need generics only for java

Returns:

your personal AI instance.

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<J extends AbstractJobGuard<J>>

Overrides:

triggerDeathAchievement in class AbstractJob<AbstractEntityAIGuard<J extends AbstractJobGuard<J>,? extends AbstractBuildingGuards>,J extends AbstractJobGuard<J>>

Parameters:

source - of the death

citizen - which just died

allowsAvoidance

public boolean allowsAvoidance()

Description copied from interface: IJob

Method to check if the colony job allows avoidance.

Specified by:

allowsAvoidance in interface IJob<J extends AbstractJobGuard<J>>

Overrides:

allowsAvoidance in class AbstractJob<AbstractEntityAIGuard<J extends AbstractJobGuard<J>,? extends AbstractBuildingGuards>,J extends AbstractJobGuard<J>>

Returns:

true if so.

isGuard

public boolean isGuard()

Description copied from interface: IJob

Whether the job is a guard

Returns:

isAsleep

public boolean isAsleep()

Whether the guard is asleep.

Returns:

true if sleeping

initEntityValues

public void initEntityValues(AbstractEntityCitizen citizen)

Description copied from interface: IJob

Initizalizes values for an entity when the entity is spawned/assigned to the job

Parameters:

citizen -

getSaturationFactor

public double getSaturationFactor()

Description copied from interface: IJob

Job saturation factor.

Returns:

increase in saturation consumption based on job.