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

Class AbstractBuildingModuleView

java.lang.Object

com.minecolonies.api.colony.buildings.modules.AbstractBuildingModuleView

All Implemented Interfaces:

IBuildingModuleView

Direct Known Subclasses:

BuildingResourcesModuleView, BuildingStatisticsModuleView, ColonyConnectionModuleView, CourierAssignmentModuleView, CraftingModuleView, EnchanterStationsModuleView, EntityListModuleView, ExpeditionLogModuleView, FieldsModuleView, GraveyardManagementModuleView, ItemListModuleView, LivingBuildingModuleView, MinerAssignmentModuleView, MinerGuardAssignModuleView, MinerLevelManagementModuleView, MinimumStockModuleView, RequestTaskModuleView, RestaurantMenuModuleView, SettingsModuleView, ToolModuleView, UniversityResearchModuleView, WarehouseOptionsModuleView, WorkerBuildingModuleView, WorkOrderListModuleView

public abstract class AbstractBuildingModuleView
extends Object
implements IBuildingModuleView

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 IBuildingView	buildingView	The building this module belongs to.
protected IColonyView	colonyView	The colony view.

Constructor Summary

Constructors

Constructor	Description
AbstractBuildingModuleView()

Method Summary

Modifier and Type	Method	Description
boolean	canBeHiredAs(JobEntry jobEntry)	Check if a worker from this module can be directly hired as a specific job.
IBuildingView	getBuildingView()	Get the building view to this.
IColonyView	getColony()	Get the colony view the module belongs to.
<M extends IBuildingModule, V extends IBuildingModuleView> BuildingEntry.ModuleProducer<M,V>	getProducer()	Get the producer of this module
IBuildingModuleView	setBuildingView(IBuildingView buildingView)	Set the building view of this module view.
IBuildingModuleView	setColonyView(IColonyView colonyView)
<M extends IBuildingModule, V extends IBuildingModuleView> IBuildingModuleView	setProducer(BuildingEntry.ModuleProducer<M,V> 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.IBuildingModuleView

deserialize, getDesc, getIcon, getIconResourceLocation, getWindow, isPageVisible

Field Details

buildingView

protected IBuildingView buildingView

The building this module belongs to.

colonyView

protected IColonyView colonyView

The colony view.

Constructor Details

AbstractBuildingModuleView

public AbstractBuildingModuleView()

Method Details

setBuildingView

public IBuildingModuleView setBuildingView(IBuildingView buildingView)

Description copied from interface: IBuildingModuleView

Set the building view of this module view.

Specified by:

setBuildingView in interface IBuildingModuleView

Parameters:

buildingView - the building view to set.

Returns:

this module itself.

setColonyView

public IBuildingModuleView setColonyView(IColonyView colonyView)

Specified by:

setColonyView in interface IBuildingModuleView

getColony

public IColonyView getColony()

Description copied from interface: IBuildingModuleView

Get the colony view the module belongs to.

Specified by:

getColony in interface IBuildingModuleView

Returns:

the colony view.

canBeHiredAs

public boolean canBeHiredAs(JobEntry jobEntry)

Check if a worker from this module can be directly hired as a specific job.

Parameters:

jobEntry - the job to check for.

Returns:

true if so. Defaults to false.

getBuildingView

public IBuildingView getBuildingView()

Description copied from interface: IBuildingModuleView

Get the building view to this.

Specified by:

getBuildingView in interface IBuildingModuleView

Returns:

the building view.

setProducer

public <M extends IBuildingModule,
V extends IBuildingModuleView>
IBuildingModuleView setProducer(BuildingEntry.ModuleProducer<M,V> moduleSet)

Description copied from interface: IBuildingModuleView

Set the producer of this module

Specified by:

setProducer in interface IBuildingModuleView

Parameters:

moduleSet -

Returns:

getProducer

public <M extends IBuildingModule,
V extends IBuildingModuleView>
BuildingEntry.ModuleProducer<M,V> getProducer()

Description copied from interface: IBuildingModuleView

Get the producer of this module

Specified by:

getProducer in interface IBuildingModuleView

Returns: