Package de.ellpeck.rockbottom.api

Class Registries

java.lang.Object

de.ellpeck.rockbottom.api.Registries

public final class Registries
extends Object

This class houses all of the game's default IRegistry objects. If you want to access a registry without directly accessing its object, use get(ResourceName, Class).

Field Summary

Fields

Modifier and Type	Field	Description
static final NameRegistry<ICompendiumRecipe>	ALL_RECIPES	The registry for all ICompendiumRecipe objects that are in the game.
static final NameRegistry<IAssetLoader>	ASSET_LOADER_REGISTRY	The registry for all IAssetLoader objects.
static final NameRegistry<BiomeLevel>	BIOME_LEVEL_REGISTRY	The registry for all BiomeLevel objects.
static final NameRegistry<Biome>	BIOME_REGISTRY	The registry for all Biome objects.
static final IndexRegistry<Class<? extends ChatComponent>>	CHAT_COMPONENT_REGISTRY	The registry for all ChatComponent objects.
static final NameRegistry<CombinerRecipe>	COMBINER_REGISTRY	The registry for all CombinerRecipe objects that can be combined in any kind of combiner.
static final NameRegistry<Command>	COMMAND_REGISTRY	The registry for all Command objects.
static final NameRegistry<CompendiumCategory>	COMPENDIUM_CATEGORY_REGISTRY	The registry for all CompendiumCategory objects that allow modders to add a custom tab to the compendium in the inventory, and an easy way to list recipes and their descriptions with it.
static final ParentedNameRegistry<ConstructionRecipe>	CONSTRUCTION_RECIPES	// TODO 0.4 A parent for Manual and Construction Table recipes.
static final ParentedNameRegistry<ConstructionRecipe>	CONSTRUCTION_TABLE_RECIPES	The recipe for all ConstructionRecipe objects which require a tool to be crafted.
static final NameRegistry<IContentLoader>	CONTENT_LOADER_REGISTRY	The registry for all IContentLoader objects.
static final NameRegistry<ICriterion>	CRITERIA_REGISTRY	The registry for all ICriterion objects.
static final NameRegistry<IEffect>	EFFECT_REGISTRY	The registry for all IEffect objects that can be applied to any entity.
static final NameRegistry<Entity.IFactory>	ENTITY_REGISTRY	The registry for all Entity types.
static final NameRegistry<FuelInput>	FUEL_REGISTRY	The registry for all FuelInput objects that determine which kinds of items burn for how long as furnace fuel.
static final NameRegistry<Information.IFactory>	INFORMATION_REGISTRY	The registry for all Information types.
static final NameRegistry<Item>	ITEM_REGISTRY	The registry for all Item objects.
static final NameRegistry<Keybind>	KEYBIND_REGISTRY	The registry for all Keybind objects.
static final IndexRegistry<IMainMenuTheme>	MAIN_MENU_THEMES	The list of all IMainMenuTheme objects.
static final ParentedNameRegistry<ConstructionRecipe>	MANUAL_CONSTRUCTION_RECIPES	The registry for all ConstructionRecipe objects that are displayed on the left side of the player's inventory.
static final ParentedNameRegistry<MortarRecipe>	MORTAR_RECIPES	The registry for all MortarRecipe objects that can be processed in a mortar.
static final DoubleRegistry<IPacket.IFactory>	PACKET_REGISTRY	The registry for all IPacket types.
static final IndexRegistry<IPartFactory<?>>	PART_REGISTRY	The registry for all DataPart types.
static final NameRegistry<IRegistry>	REGISTRIES	The registry containing all persistent IRegistry objects.
static final NameRegistry<SmeltingRecipe>	SMELTING_REGISTRY	The registry for all SmeltingRecipe objects that can be smelted in any kind of furnace.
static final ParentedNameRegistry<SmithingRecipe>	SMITHING_RECIPES	The registry for all SmithingRecipe objects that can be processed in a mortar.
static final NameRegistry<SpawnBehavior>	SPAWN_BEHAVIOR_REGISTRY	The registry for all SpawnBehavior objects that determine how and where entities can randomly appear in the world.
static final IndexRegistry<ISpecialCursor>	SPECIAL_CURSORS	The list of all ISpecialCursor instance.
static final NameRegistry<StatisticInitializer>	STATISTICS_REGISTRY	The registry for all StatisticInitializer objects that track certain things in the game.
static final NameRegistry<IStructure>	STRUCTURE_REGISTRY	The registry for all IStructure objects.
static final NameRegistry<SubWorldInitializer>	SUB_WORLD_INITIALIZER_REGISTRY	The registry for all SubWorldInitializer objects that can be used to initialize custom sub worlds for the main world.
static final NameRegistry<TileLayer>	TILE_LAYER_REGISTRY	The registry for all TileLayer objects.
static final NameRegistry<Tile>	TILE_REGISTRY	The registry for all Tile objects.
static final NameRegistry<TileState>	TILE_STATE_REGISTRY	The registry for all TileState objects.
static final NameRegistry<ToolProperty>	TOOL_PROPERTY_REGISTRY	The registry for all ToolProperty objects that determine what kind of tool an item is and what level it is.
static final NameRegistry<IWorldGenerator.IFactory>	WORLD_GENERATORS	The registry for all IWorldGenerator types.

Constructor Summary

Constructors

Constructor	Description
Registries()

Method Summary

Modifier and Type	Method	Description
static IRegistry	get(ResourceName name)
static <T extends IRegistry> T	get(ResourceName name, Class<T> type)

Methods inherited from class java.lang.Object

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

Field Details

REGISTRIES

@ApiInternal
public static final NameRegistry<IRegistry> REGISTRIES

The registry containing all persistent IRegistry objects. Use IRegistry.register() to register your own registry. This is useful both for outputting information on how full registries are, but also for mod interaction: Other mods can register to your registries without needing their object directly simply by getting them from this registry. To get a registry by name, use get(ResourceName, Class).

TILE_REGISTRY

@ApiInternal
public static final NameRegistry<Tile> TILE_REGISTRY

The registry for all Tile objects. Use Tile.register() to register it.

ITEM_REGISTRY

@ApiInternal
public static final NameRegistry<Item> ITEM_REGISTRY

The registry for all Item objects. Use Item.register() to register it.

ENTITY_REGISTRY

public static final NameRegistry<Entity.IFactory> ENTITY_REGISTRY

The registry for all Entity types. The ResourceName refers to the way the entity will be saved to disk when it is present in the world. Note that, to be able to be loaded back in when the game is started, an Entity needs to have a constructor containing only an IWorld.

PART_REGISTRY

@ApiInternal
public static final IndexRegistry<IPartFactory<?>> PART_REGISTRY

The registry for all DataPart types. Note that this registry should not be registered into without caution, as the index should not be automatically determined due to it having to persist on disk when a DataSet is stored. Either use an index that most likely no other mods will use, create a configuration file to be able to change it or only use existing DataParts.

PACKET_REGISTRY

public static final DoubleRegistry<IPacket.IFactory> PACKET_REGISTRY

The registry for all IPacket types. To register into this registry, you can use IndexRegistry.getNextFreeId() to determine an id for the packet, or directly register it using DoubleRegistry.registerNextFree(ResourceName, Object) )}.

COMMAND_REGISTRY

public static final NameRegistry<Command> COMMAND_REGISTRY

The registry for all Command objects. Use Command.register() to register it.

CRITERIA_REGISTRY

public static final NameRegistry<ICriterion> CRITERIA_REGISTRY

The registry for all ICriterion objects. Use {link ICriteria#register()} to register your criteria. These can be used in recipe json files.

ALL_RECIPES

public static final NameRegistry<ICompendiumRecipe> ALL_RECIPES

The registry for all ICompendiumRecipe objects that are in the game. If your mod includes its own registry for recipes, consider making it a ParentedNameRegistry and using this as the parent.

CONSTRUCTION_RECIPES

@ApiInternal
public static final ParentedNameRegistry<ConstructionRecipe> CONSTRUCTION_RECIPES

// TODO 0.4 A parent for Manual and Construction Table recipes.

CONSTRUCTION_TABLE_RECIPES

@ApiInternal
public static final ParentedNameRegistry<ConstructionRecipe> CONSTRUCTION_TABLE_RECIPES

The recipe for all ConstructionRecipe objects which require a tool to be crafted. These show up in a separate tab to manual recipes in the Compendium and can be crafted with the use of a tool in the ConstructionTable. Use ConstructionRecipe.registerConstructionTable() to register.

MANUAL_CONSTRUCTION_RECIPES

@ApiInternal
public static final ParentedNameRegistry<ConstructionRecipe> MANUAL_CONSTRUCTION_RECIPES

The registry for all ConstructionRecipe objects that are displayed on the left side of the player's inventory. Use ConstructionRecipe.registerManual() to register recipes into this registry. If you want to get a recipe instance by its name, use ConstructionRecipe.forName(ResourceName).

MORTAR_RECIPES

@ApiInternal
public static final ParentedNameRegistry<MortarRecipe> MORTAR_RECIPES

The registry for all MortarRecipe objects that can be processed in a mortar. To register something into this registry, please use MortarRecipe.register(). If you want to get a recipe instance by its name, use MortarRecipe.forName(ResourceName).

SMITHING_RECIPES

@ApiInternal
public static final ParentedNameRegistry<SmithingRecipe> SMITHING_RECIPES

The registry for all SmithingRecipe objects that can be processed in a mortar. To register something into this registry, please use SmithingRecipe.register(). If you want to get a recipe instance by its name, use MortarRecipe.forName(ResourceName).

WORLD_GENERATORS

public static final NameRegistry<IWorldGenerator.IFactory> WORLD_GENERATORS

The registry for all IWorldGenerator types. The ResourceName is used to save a generator to disk if it is a retroactive generator (IWorldGenerator.generatesRetroactively()) to mark that it has already generated in a certain chunk. However, a registry name needs to be supplied regardless if the generator is retroactive. Note that, to instantiate a world generator, it needs to contain a default constructor.

BIOME_REGISTRY

@ApiInternal
public static final NameRegistry<Biome> BIOME_REGISTRY

The registry for all Biome objects. Use Biome.register() to register biomes into this registry.

BIOME_LEVEL_REGISTRY

@ApiInternal
public static final NameRegistry<BiomeLevel> BIOME_LEVEL_REGISTRY

The registry for all BiomeLevel objects. Use BiomeLevel.register() to register biomes into this registry.

STRUCTURE_REGISTRY

@ApiInternal
public static final NameRegistry<IStructure> STRUCTURE_REGISTRY

The registry for all IStructure objects. Use the contents.json file to create a new structure and have it loaded through the content manager. If you want to get a structure by its name, use IStructure.forName(ResourceName) or if you want to get multiple structures with similar names, use IStructure.forNamePart(String).

TILE_STATE_REGISTRY

@ApiInternal
public static final NameRegistry<TileState> TILE_STATE_REGISTRY

The registry for all TileState objects. This registry automatically has objects registered into it by registering the associated Tile objects using Tile.register(). Do not manually register anything in it.

TILE_LAYER_REGISTRY

@ApiInternal
public static final NameRegistry<TileLayer> TILE_LAYER_REGISTRY

The registry for all TileLayer objects. Use TileLayer.register() to register a layer into this registry.

KEYBIND_REGISTRY

@ApiInternal
public static final NameRegistry<Keybind> KEYBIND_REGISTRY

The registry for all Keybind objects. Use Keybind.register() to register a keybind into this registry. This needs to be done before IMod.preInit(IGameInstance, IApiHandler, IEventHandler) as otherwise, the keybind's current value will not be loaded from the Settings file automatically.

CHAT_COMPONENT_REGISTRY

public static final IndexRegistry<Class<? extends ChatComponent>> CHAT_COMPONENT_REGISTRY

The registry for all ChatComponent objects. Use IndexRegistry.getNextFreeId() to determine the component's id. When registering custom chat components, note that, to send their information between the server and the client, they need to contain a default constructor.

MAIN_MENU_THEMES

public static final IndexRegistry<IMainMenuTheme> MAIN_MENU_THEMES

The list of all IMainMenuTheme objects. Adding themes into this list will give them a chance to be randomly chosen when the title screen of the game is loaded up. Do not clear this list as it will crash the game on startup.

INFORMATION_REGISTRY

public static final NameRegistry<Information.IFactory> INFORMATION_REGISTRY

The registry for all Information types. Note that, to save and load information from and to disk, they need to contain a constructor that takes an ResourceName similar to the one that Information provides.

ASSET_LOADER_REGISTRY

@ApiInternal
public static final NameRegistry<IAssetLoader> ASSET_LOADER_REGISTRY

The registry for all IAssetLoader objects. To register one into this registry, use IAssetLoader.register().

CONTENT_LOADER_REGISTRY

@ApiInternal
public static final NameRegistry<IContentLoader> CONTENT_LOADER_REGISTRY

The registry for all IContentLoader objects. To register one into this registry, use IContentLoader.register().

SPECIAL_CURSORS

public static final IndexRegistry<ISpecialCursor> SPECIAL_CURSORS

The list of all ISpecialCursor instance. Adding cursors into this list will allow them to be displayed in place of the regular cursor when their condition is met.

EFFECT_REGISTRY

@ApiInternal
public static final NameRegistry<IEffect> EFFECT_REGISTRY

The registry for all IEffect objects that can be applied to any entity. To register something into this registry, use IEffect.register().

STATISTICS_REGISTRY

@ApiInternal
public static final NameRegistry<StatisticInitializer> STATISTICS_REGISTRY

The registry for all StatisticInitializer objects that track certain things in the game. To registry something into this registry, use StatisticInitializer.register(). To get a statistic and/or modify its value, use IStatistics which you can obtain from any AbstractPlayerEntity.

FUEL_REGISTRY

@ApiInternal
public static final NameRegistry<FuelInput> FUEL_REGISTRY

The registry for all FuelInput objects that determine which kinds of items burn for how long as furnace fuel. To register something into this registry, please use FuelInput.register().

SMELTING_REGISTRY

@ApiInternal
public static final NameRegistry<SmeltingRecipe> SMELTING_REGISTRY

The registry for all SmeltingRecipe objects that can be smelted in any kind of furnace. To register something into this registry, please use SmeltingRecipe.register().

COMBINER_REGISTRY

@ApiInternal
public static final NameRegistry<CombinerRecipe> COMBINER_REGISTRY

The registry for all CombinerRecipe objects that can be combined in any kind of combiner. To register something into this registry, please use CombinerRecipe.register().

SPAWN_BEHAVIOR_REGISTRY

@ApiInternal
public static final NameRegistry<SpawnBehavior> SPAWN_BEHAVIOR_REGISTRY

The registry for all SpawnBehavior objects that determine how and where entities can randomly appear in the world. To register something into this registry, please use SpawnBehavior.register().

TOOL_PROPERTY_REGISTRY

@ApiInternal
public static final NameRegistry<ToolProperty> TOOL_PROPERTY_REGISTRY

The registry for all ToolProperty objects that determine what kind of tool an item is and what level it is. Use ToolProperty.register() to register a property.

SUB_WORLD_INITIALIZER_REGISTRY

@ApiInternal
public static final NameRegistry<SubWorldInitializer> SUB_WORLD_INITIALIZER_REGISTRY

The registry for all SubWorldInitializer objects that can be used to initialize custom sub worlds for the main world. To register a sub world initializer, please use SubWorldInitializer.register().

COMPENDIUM_CATEGORY_REGISTRY

@ApiInternal
public static final NameRegistry<CompendiumCategory> COMPENDIUM_CATEGORY_REGISTRY

The registry for all CompendiumCategory objects that allow modders to add a custom tab to the compendium in the inventory, and an easy way to list recipes and their descriptions with it. Use CompendiumCategory.register() to register a category.

Constructor Details

Registries

public Registries()

Method Details

get

public static <T extends IRegistry> T get(ResourceName name,
 Class<T> type)

get

public static IRegistry get(ResourceName name)