Package com.minecolonies.api.colony.buildings.registry

Class BuildingEntry

java.lang.Object

com.minecolonies.api.colony.buildings.registry.BuildingEntry

public class BuildingEntry
extends Object

Entry for the IBuilding registry. Makes it possible to create a single registry for a IBuilding. Used to lookup how to create IBuilding and IBuildingView. Also links a given IBuilding to a given AbstractBlockHut.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BuildingEntry.Builder	A builder class for BuildingEntry.
static class	BuildingEntry.ModuleProducer<MODULECLASS extends IBuildingModule,VIEWCLASS extends IBuildingModuleView>	Set of servermodule and its view with ID, module or view might be null

Method Summary

Modifier and Type	Method	Description
static Map<String,BuildingEntry.ModuleProducer>	getALlModuleProducers()	Retreives all existing module producers and their IDs
AbstractColonyBlock<?>	getBuildingBlock()
List<BuildingEntry.ModuleProducer>	getModuleProducers()
static BuildingEntry.ModuleProducer	getProducer(int runtimeID)	get a producer by its runtime identity
static BuildingEntry.ModuleProducer	getProducer(String key)	Gets a producer by its string key identity
net.minecraft.resources.ResourceLocation	getRegistryName()	Get the assigned registry name.
String	getTranslationKey()
IBuilding	produceBuilding(net.minecraft.core.BlockPos position, IColony colony)
IBuildingView	produceBuildingView(net.minecraft.core.BlockPos position, IColonyView colony)
static @Nullable IBuildingModule	produceModuleWithoutBuilding(String key)	Produces a module without a respective building, mostly used for display or other purposes
static @Nullable IBuildingModuleView	produceViewWithoutBuilding(String key, IColonyView colony)	Produces a module view without a respective building, mostly used for display or other purposes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getTranslationKey

public String getTranslationKey()

getBuildingBlock

public AbstractColonyBlock<?> getBuildingBlock()

produceBuilding

public IBuilding produceBuilding(net.minecraft.core.BlockPos position,
 IColony colony)

produceBuildingView

public IBuildingView produceBuildingView(net.minecraft.core.BlockPos position,
 IColonyView colony)

getModuleProducers

public List<BuildingEntry.ModuleProducer> getModuleProducers()

getRegistryName

public net.minecraft.resources.ResourceLocation getRegistryName()

Get the assigned registry name.

Returns:

produceModuleWithoutBuilding

@Nullable
public static @Nullable IBuildingModule produceModuleWithoutBuilding(String key)

Produces a module without a respective building, mostly used for display or other purposes

Parameters:

key -

Returns:

produceViewWithoutBuilding

@Nullable
public static @Nullable IBuildingModuleView produceViewWithoutBuilding(String key,
 IColonyView colony)

Produces a module view without a respective building, mostly used for display or other purposes

Parameters:

key -

Returns:

getALlModuleProducers

public static Map<String,BuildingEntry.ModuleProducer> getALlModuleProducers()

Retreives all existing module producers and their IDs

Returns:

getProducer

public static BuildingEntry.ModuleProducer getProducer(String key)

Gets a producer by its string key identity

Parameters:

key -

Returns:

getProducer

public static BuildingEntry.ModuleProducer getProducer(int runtimeID)

get a producer by its runtime identity

Parameters:

runtimeID -

Returns: