Package com.minecolonies.core.colony.buildings.modules

Class GuardBuildingModule

java.lang.Object

com.minecolonies.api.colony.buildings.modules.AbstractBuildingModule

com.minecolonies.core.colony.buildings.modules.AbstractAssignedCitizenModule

com.minecolonies.core.colony.buildings.modules.WorkerBuildingModule

com.minecolonies.core.colony.buildings.modules.WorkAtHomeBuildingModule

com.minecolonies.core.colony.buildings.modules.GuardBuildingModule

All Implemented Interfaces:

IBuildingWorkerModule, IAssignsCitizen, IAssignsJob, IBuildingEventsModule, IBuildingModule, ICreatesResolversModule, IPersistentModule, ITickingModule, IHasDirty

Direct Known Subclasses:

StableCavalryBuildingModule

public class GuardBuildingModule
extends WorkAtHomeBuildingModule
implements IBuildingEventsModule, ITickingModule, IPersistentModule, IBuildingWorkerModule, ICreatesResolversModule

Assignment module for guards.

Field Summary

Fields inherited from class com.minecolonies.core.colony.buildings.modules.AbstractAssignedCitizenModule

assignedCitizen

Fields inherited from class com.minecolonies.api.colony.buildings.modules.AbstractBuildingModule

building, isDirty

Constructor Summary

Constructors

Constructor	Description
GuardBuildingModule(GuardType type, boolean canWorkingDuringRain, Function<IBuilding,Integer> sizeLimit)
GuardBuildingModule(GuardType type, boolean canWorkingDuringRain, Function<IBuilding,Integer> sizeLimit, net.minecraft.resources.ResourceLocation researchRequirement)

Method Summary

Modifier and Type	Method	Description
boolean	isFull()	Check if we can fit additional citizens into the module.
void	onColonyTick(@NotNull IColony colony)	Colony tick hook.

Methods inherited from class com.minecolonies.core.colony.buildings.modules.WorkAtHomeBuildingModule

assignCitizen

Methods inherited from class com.minecolonies.core.colony.buildings.modules.WorkerBuildingModule

canWorkDuringTheRain, createJob, createResolvers, deserializeNBT, getJobDisplayName, getJobEntry, getModuleMax, getModuleSerializationIdentifier, getPrimarySkill, getSecondarySkill, onUpgradeComplete, serializeNBT, serializeToView

Methods inherited from class com.minecolonies.core.colony.buildings.modules.AbstractAssignedCitizenModule

getAssignedCitizen, getAssignedEntities, getFirstCitizen, getHiringMode, hasAssignedCitizen, hasAssignedCitizen, onDestroyed, removeCitizen, setHiringMode

Methods inherited from class com.minecolonies.api.colony.buildings.modules.AbstractBuildingModule

checkDirty, clearDirty, getBuilding, getProducer, markDirty, setBuilding, setProducer

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.IAssignsCitizen

getAssignedCitizen, getAssignedEntities, getHiringMode, getModuleMax, hasAssignedCitizen, removeCitizen, setHiringMode

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.IAssignsJob

hasAssignedCitizen

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.IBuildingEventsModule

onDestroyed, onPlayerEnterBuilding, onUpgradeComplete, onWakeUp

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.IBuildingModule

getBuilding, getProducer, serializeToView, serializeToView, setBuilding, setProducer

Methods inherited from interface com.minecolonies.api.colony.buildings.IBuildingWorkerModule

canWorkDuringTheRain, createJob, getJobEntry, getPrimarySkill, getSecondarySkill

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.ICreatesResolversModule

createResolvers

Methods inherited from interface com.minecolonies.api.util.IHasDirty

checkDirty, clearDirty, markDirty

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.IPersistentModule

deserializeNBT, serializeNBT

Constructor Details

GuardBuildingModule

public GuardBuildingModule(GuardType type,
 boolean canWorkingDuringRain,
 Function<IBuilding,Integer> sizeLimit)

GuardBuildingModule

public GuardBuildingModule(GuardType type,
 boolean canWorkingDuringRain,
 Function<IBuilding,Integer> sizeLimit,
 net.minecraft.resources.ResourceLocation researchRequirement)

Method Details

isFull

public boolean isFull()

Description copied from interface: IAssignsCitizen

Check if we can fit additional citizens into the module.

Specified by:

isFull in interface IAssignsCitizen

Overrides:

isFull in class AbstractAssignedCitizenModule

Returns:

true if so.

onColonyTick

public void onColonyTick(@NotNull
 @NotNull IColony colony)

Description copied from interface: ITickingModule

Colony tick hook.

Specified by:

onColonyTick in interface ITickingModule

Overrides:

onColonyTick in class WorkerBuildingModule

Parameters:

colony - the colony the tick is invoked from.