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

Class QuarryModule

java.lang.Object

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

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

com.minecolonies.core.colony.buildings.modules.QuarryModule

All Implemented Interfaces:

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

public class QuarryModule
extends AbstractAssignedCitizenModule
implements IAssignsJob, IBuildingEventsModule, ITickingModule, IPersistentModule, ICreatesResolversModule, IAltersBuildingFootprint

The main data module for the quarry.

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
QuarryModule(int height)	Create a new quarry module.

Method Summary

Modifier and Type	Method	Description
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.
net.minecraft.util.Tuple<net.minecraft.core.BlockPos,net.minecraft.core.BlockPos>	getAdditionalCorners()	Get the additional corners into each direction.
JobEntry	getJobEntry()	Get the job entry of the module.
int	getModuleMax()	Get the max number of citizens this module supports.
protected String	getModuleSerializationIdentifier()	Get the identifier for unique serialization.
boolean	isFinished()	Check if the quarry was completed already.
void	onAssignment(ICitizenData citizen)
void	onColonyTick(@NotNull IColony colony)	Colony tick hook.
void	onRemoval(ICitizenData citizen)
void	serializeNBT(net.minecraft.core.HolderLookup.Provider provider, net.minecraft.nbt.CompoundTag compound)	Serialize the module from a compound.
void	setFinished()	Set the quarry as finished.

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, 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, 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.util.IHasDirty

checkDirty, clearDirty, markDirty

Constructor Details

QuarryModule

public QuarryModule(int height)

Create a new quarry module.

Parameters:

height - the height of the quarry.

Method Details

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.

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.

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.

onRemoval

public void onRemoval(ICitizenData citizen)

onAssignment

public void onAssignment(ICitizenData citizen)

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.

getJobEntry

public JobEntry getJobEntry()

Description copied from interface: IAssignsJob

Get the job entry of the module.

Specified by:

getJobEntry in interface IAssignsJob

Returns:

the job entry.

isFinished

public boolean isFinished()

Check if the quarry was completed already.

Returns:

true if so.

setFinished

public void setFinished()

Set the quarry as finished.

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.

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.

getAdditionalCorners

public net.minecraft.util.Tuple<net.minecraft.core.BlockPos,net.minecraft.core.BlockPos> getAdditionalCorners()

Description copied from interface: IAltersBuildingFootprint

Get the additional corners into each direction.

Specified by:

getAdditionalCorners in interface IAltersBuildingFootprint

Returns:

the positions.