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

Class LivingBuildingModule

java.lang.Object

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

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

com.minecolonies.core.colony.buildings.modules.LivingBuildingModule

All Implemented Interfaces:

IAssignsCitizen, IBuildingEventsModule, IBuildingModule, IPersistentModule, ITickingModule, IHasDirty

Direct Known Subclasses:

TavernLivingBuildingModule

public class LivingBuildingModule
extends AbstractAssignedCitizenModule
implements IAssignsCitizen, IBuildingEventsModule, ITickingModule, IPersistentModule

The living module for citizen to call their home.

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
LivingBuildingModule()

Method Summary

Modifier and Type	Method	Description
void	deserializeNBT(net.minecraft.nbt.CompoundTag compound)	Deserialize the module.
int	getModuleMax()	Get the max number of citizens this module supports.
protected String	getModuleSerializationIdentifier()	Get the identifier for unique serialization.
void	onColonyTick(@NotNull IColony colony)	Colony tick hook.
void	onUpgradeComplete(int newLevel)	Upgrade complete module hook.
void	serializeNBT(net.minecraft.nbt.CompoundTag compound)	Serialize the module from a compound.

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

assignCitizen, getAssignedCitizen, getAssignedEntities, getFirstCitizen, getHiringMode, hasAssignedCitizen, hasAssignedCitizen, isFull, onDestroyed, removeCitizen, serializeToView, 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

assignCitizen, getAssignedCitizen, getAssignedEntities, getHiringMode, hasAssignedCitizen, hasAssignedCitizen, isFull, removeCitizen, setHiringMode

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, serializeToView, setBuilding, setProducer

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

checkDirty, clearDirty, markDirty

Constructor Details

LivingBuildingModule

public LivingBuildingModule()

Method Details

deserializeNBT

public void deserializeNBT(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.

serializeNBT

public void serializeNBT(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.

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.

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.

getModuleSerializationIdentifier

protected String getModuleSerializationIdentifier()

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.