Package com.minecolonies.api.colony.buildings.modules

Class AbstractBuildingModule

java.lang.Object

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

All Implemented Interfaces:

IBuildingModule, IHasDirty

Direct Known Subclasses:

AbstractAssignedCitizenModule, AbstractCraftingBuildingModule, AnimalHerdingModule, BedHandlingModule, BuildingExtensionsModule, BuildingResourcesModule, BuildingStatisticsModule, ColonyConnectionModule, EnchanterStationsModule, EntityListModule, ExpeditionLogModule, FurnaceUserModule, GraveyardManagementModule, HomeBuildingModule, ItemListModule, MinerLevelManagementModule, MinimumStockModule, RestaurantMenuModule, SettingsModule, TavernBuildingModule, WarehouseModule, WarehouseRequestQueueModule

public abstract class AbstractBuildingModule
extends Object
implements IBuildingModule

Abstract class for all modules. Has base methods for all the necessary methods that have to be called from the building.

Field Summary

Fields

Modifier and Type	Field	Description
protected IBuilding	building	The building this module belongs to.
boolean	isDirty	If the module is dirty.

Constructor Summary

Constructors

Constructor	Description
AbstractBuildingModule()

Method Summary

Modifier and Type	Method	Description
boolean	checkDirty()	Check if one of the modules is dirty.
void	clearDirty()	Clear the dirty setting of the module.
IBuilding	getBuilding()	Get the building of the module.
BuildingEntry.ModuleProducer	getProducer()	Get the producer of this module
void	markDirty()	Specific dirty marking of modules (separate from building dirty).
IBuildingModule	setBuilding(IBuilding building)	Set the building of the module.
IBuildingModule	setProducer(BuildingEntry.ModuleProducer moduleSet)	Set the producer of this module

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.IBuildingModule

serializeToView, serializeToView

Field Details

isDirty

public boolean isDirty

If the module is dirty.

building

protected IBuilding building

The building this module belongs to.

Constructor Details

AbstractBuildingModule

public AbstractBuildingModule()

Method Details

markDirty

public void markDirty()

Description copied from interface: IHasDirty

Specific dirty marking of modules (separate from building dirty).

Specified by:

markDirty in interface IHasDirty

clearDirty

public void clearDirty()

Description copied from interface: IHasDirty

Clear the dirty setting of the module.

Specified by:

clearDirty in interface IHasDirty

checkDirty

public boolean checkDirty()

Description copied from interface: IHasDirty

Check if one of the modules is dirty.

Specified by:

checkDirty in interface IHasDirty

Returns:

true if so.

getBuilding

public IBuilding getBuilding()

Description copied from interface: IBuildingModule

Get the building of the module.

Specified by:

getBuilding in interface IBuildingModule

Returns:

the building.

setBuilding

public IBuildingModule setBuilding(IBuilding building)

Description copied from interface: IBuildingModule

Set the building of the module.

Specified by:

setBuilding in interface IBuildingModule

Parameters:

building - the building to set.

Returns:

the module itself.

setProducer

public IBuildingModule setProducer(BuildingEntry.ModuleProducer moduleSet)

Description copied from interface: IBuildingModule

Set the producer of this module

Specified by:

setProducer in interface IBuildingModule

Parameters:

moduleSet -

Returns:

getProducer

public BuildingEntry.ModuleProducer getProducer()

Description copied from interface: IBuildingModule

Get the producer of this module

Specified by:

getProducer in interface IBuildingModule

Returns: