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

Interface IAssignmentModuleView

All Superinterfaces:

IBuildingModuleView

All Known Implementing Classes:

ArcherSquireModuleView, CombinedHiringLimitModuleView, CourierAssignmentModuleView, KnightSquireBuildingModuleView, MinerAssignmentModuleView, PupilBuildingModuleView, StudentBuildingModuleView, WorkerBuildingModuleView

public interface IAssignmentModuleView
extends IBuildingModuleView

Assignment module view interface.

Method Summary

Modifier and Type	Method	Description
void	addCitizen(@NotNull ICitizenDataView id)	Add a citizen.
boolean	canAssign(ICitizenDataView data)	Check if citizens can be assigned.
List<Integer>	getAssignedCitizens()	Get the list of assigned people.
HiringMode	getHiringMode()	Get the hiring mode.
JobEntry	getJobEntry()	Get the job entry of the citizen to be assigned.
int	getMaxInhabitants()	Get the max number of inhabitants
default net.minecraft.resources.ResourceLocation	getResearchRequirement()	If unlocked by research it returns a research requirement.
boolean	isFull()	Check if the module is full.
void	removeCitizen(@NotNull ICitizenDataView id)	Remove a citizen.
void	setHiringMode(HiringMode hiringMode)	Set the hiring mode.

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

deserialize, getBuildingView, getColony, getDesc, getIcon, getIconResourceLocation, getProducer, getWindow, isPageVisible, setBuildingView, setColonyView, setProducer

Method Details

getAssignedCitizens

List<Integer> getAssignedCitizens()

Get the list of assigned people.

Returns:

the list

addCitizen

void addCitizen(@NotNull
 @NotNull ICitizenDataView id)

Add a citizen.

Parameters:

id - the citizen id.

removeCitizen

void removeCitizen(@NotNull
 @NotNull ICitizenDataView id)

Remove a citizen.

Parameters:

id - the citizen id/

getHiringMode

HiringMode getHiringMode()

Get the hiring mode.

Returns:

the set mode.

setHiringMode

void setHiringMode(HiringMode hiringMode)

Set the hiring mode.

Parameters:

hiringMode - the set mode.

canAssign

boolean canAssign(ICitizenDataView data)

Check if citizens can be assigned.

Parameters:

data - the data to check.

Returns:

true if so.

getMaxInhabitants

int getMaxInhabitants()

Get the max number of inhabitants

Returns:

max inhabitants

isFull

boolean isFull()

Check if the module is full.

Returns:

true if so.

getJobEntry

JobEntry getJobEntry()

Get the job entry of the citizen to be assigned.

Returns:

the entry.

getResearchRequirement

default net.minecraft.resources.ResourceLocation getResearchRequirement()

If unlocked by research it returns a research requirement.

Returns:

return null by default, otherwise String research effect key.