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

Class WorkerBuildingModule

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ChildrenBuildingModule, CraftingWorkerBuildingModule, DeliverymanAssignmentModule, HospitalAssignmentModule, MinerBuildingModule, NoPrivateCrafterWorkerModule, WorkAtHomeBuildingModule

public class WorkerBuildingModule
extends AbstractAssignedCitizenModule
implements IAssignsJob, IBuildingEventsModule, ITickingModule, IPersistentModule, IBuildingWorkerModule, ICreatesResolversModule

The worker module for citizen where they are assigned to if they work at it.

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
WorkerBuildingModule(JobEntry entry, Skill primary, Skill secondary, boolean canWorkingDuringRain, Function<IBuilding,Integer> sizeLimit)
WorkerBuildingModule(JobEntry entry, Skill primary, Skill secondary, boolean canWorkingDuringRain, Function<IBuilding,Integer> sizeLimit, net.minecraft.resources.ResourceLocation researchRequirement)

Method Summary

Modifier and Type	Method	Description
boolean	assignCitizen(ICitizenData citizen)	Specific citizen assignment hook for modules.
boolean	canWorkDuringTheRain()	Method which defines if a worker should be allowed to work during the rain.
@NotNull IJob<?>	createJob(ICitizenData citizen)	The abstract method which creates a job for the building.
List<IRequestResolver<?>>	createResolvers()	Get a list of resolvers for this building.
void	deserializeNBT(net.minecraft.core.HolderLookup.Provider provider, net.minecraft.nbt.CompoundTag compound)	Deserialize the module.
String	getJobDisplayName()	Get the Job DisplayName
JobEntry	getJobEntry()	Get the job entry of the module.
int	getModuleMax()	Get the max number of citizens this module supports.
protected String	getModuleSerializationIdentifier()	Deprecated.
@NotNull Skill	getPrimarySkill()	Primary skill getter.
@NotNull Skill	getSecondarySkill()	Secondary skill getter.
void	onColonyTick(@NotNull IColony colony)	Colony tick hook.
void	onUpgradeComplete(int newLevel)	Upgrade complete module hook.
void	serializeNBT(net.minecraft.core.HolderLookup.Provider provider, net.minecraft.nbt.CompoundTag compound)	Serialize the module from a compound.
void	serializeToView(@NotNull net.minecraft.network.RegistryFriendlyByteBuf buf)	Serialization method to send the module data to the client side.

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

getAssignedCitizen, getAssignedEntities, getFirstCitizen, getHiringMode, hasAssignedCitizen, hasAssignedCitizen, isFull, 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, hasAssignedCitizen, isFull, 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, onWakeUp

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

getBuilding, getProducer, serializeToView, setBuilding, setProducer

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

checkDirty, clearDirty, markDirty

Constructor Details

WorkerBuildingModule

public WorkerBuildingModule(JobEntry entry,
 Skill primary,
 Skill secondary,
 boolean canWorkingDuringRain,
 Function<IBuilding,Integer> sizeLimit)

WorkerBuildingModule

public WorkerBuildingModule(JobEntry entry,
 Skill primary,
 Skill secondary,
 boolean canWorkingDuringRain,
 Function<IBuilding,Integer> sizeLimit,
 net.minecraft.resources.ResourceLocation researchRequirement)

Method Details

assignCitizen

public boolean assignCitizen(ICitizenData citizen)

Description copied from interface: IAssignsCitizen

Specific citizen assignment hook for modules.

Specified by:

assignCitizen in interface IAssignsCitizen

Overrides:

assignCitizen in class AbstractAssignedCitizenModule

Parameters:

citizen - the added citizen.

Returns:

true if one was added.

deserializeNBT

public void deserializeNBT(@NotNull
 net.minecraft.core.HolderLookup.Provider provider,
 net.minecraft.nbt.CompoundTag compound)

Description copied from interface: IPersistentModule

Deserialize the module.

Specified by:

deserializeNBT in interface IPersistentModule

Overrides:

deserializeNBT in class AbstractAssignedCitizenModule

Parameters:

compound - the nbt compound.

onColonyTick

public void onColonyTick(@NotNull
 @NotNull IColony colony)

Description copied from interface: ITickingModule

Colony tick hook.

Specified by:

onColonyTick in interface ITickingModule

Parameters:

colony - the colony the tick is invoked from.

serializeNBT

public void serializeNBT(@NotNull
 net.minecraft.core.HolderLookup.Provider provider,
 net.minecraft.nbt.CompoundTag compound)

Description copied from interface: IPersistentModule

Serialize the module from a compound.

Specified by:

serializeNBT in interface IPersistentModule

Overrides:

serializeNBT in class AbstractAssignedCitizenModule

Parameters:

compound - the compound.

serializeToView

public void serializeToView(@NotNull
 @NotNull net.minecraft.network.RegistryFriendlyByteBuf buf)

Description copied from interface: IBuildingModule

Serialization method to send the module data to the client side.

Specified by:

serializeToView in interface IBuildingModule

Overrides:

serializeToView in class AbstractAssignedCitizenModule

Parameters:

buf - the buffer to write it to.

getModuleMax

public int getModuleMax()

Description copied from interface: IAssignsCitizen

Get the max number of citizens this module supports.

Specified by:

getModuleMax in interface IAssignsCitizen

Returns:

the modules max.

onUpgradeComplete

public void onUpgradeComplete(int newLevel)

Description copied from interface: IBuildingEventsModule

Upgrade complete module hook.

Specified by:

onUpgradeComplete in interface IBuildingEventsModule

Parameters:

newLevel - the new level.

getJobDisplayName

public String getJobDisplayName()

Get the Job DisplayName

createJob

@NotNull
public @NotNull IJob<?> createJob(ICitizenData citizen)

Description copied from interface: IBuildingWorkerModule

The abstract method which creates a job for the building.

Specified by:

createJob in interface IBuildingWorkerModule

Parameters:

citizen - the citizen to take the job.

Returns:

the Job.

canWorkDuringTheRain

public boolean canWorkDuringTheRain()

Description copied from interface: IBuildingWorkerModule

Method which defines if a worker should be allowed to work during the rain.

Specified by:

canWorkDuringTheRain in interface IBuildingWorkerModule

Returns:

true if so.

getPrimarySkill

@NotNull
public @NotNull Skill getPrimarySkill()

Description copied from interface: IBuildingWorkerModule

Primary skill getter.

Specified by:

getPrimarySkill in interface IBuildingWorkerModule

Returns:

the primary skill.

getSecondarySkill

@NotNull
public @NotNull Skill getSecondarySkill()

Description copied from interface: IBuildingWorkerModule

Secondary skill getter.

Specified by:

getSecondarySkill in interface IBuildingWorkerModule

Returns:

the secondary skill.

createResolvers

public List<IRequestResolver<?>> createResolvers()

Description copied from interface: ICreatesResolversModule

Get a list of resolvers for this building.

Specified by:

createResolvers in interface ICreatesResolversModule

Returns:

the list of resolvers.

getJobEntry

public JobEntry getJobEntry()

Description copied from interface: IAssignsJob

Get the job entry of the module.

Specified by:

getJobEntry in interface IAssignsJob

Specified by:

getJobEntry in interface IBuildingWorkerModule

Returns:

the job entry.

getModuleSerializationIdentifier

@Deprecated
protected String getModuleSerializationIdentifier()

Deprecated.

Description copied from class: AbstractAssignedCitizenModule

Get the identifier for unique serialization. Use for deserialize/serialize only!

Overrides:

getModuleSerializationIdentifier in class AbstractAssignedCitizenModule

Returns:

a string identifier.