org.spongepowered.api

Interface GameRegistry

public interface GameRegistry

Provides an easy way to retrieve types from a Game.

Note that the registries may be in flux, especially during game initialization. These will be accurate for the time they are called, however they may change at a later point. Do not assume that the contents of a collection will be all the entries that will exist.

Some of the returned instances my become incorrect if they are later overwritten. However, this should occur prior to GameState.POST_INITIALIZATION.

Method Summary

Modifier and Type	Method and Description
<T extends ResettableBuilder<?,? super T>> T	createBuilder(Class<T> builderClass) Gets a builder of the desired class type, examples may include: ItemStack.Builder, etc.
<T extends CatalogType> Collection<T>	getAllFor(String pluginId, Class<T> typeClass) Gets a collection of all available found specific types of CatalogType requested.
default <T extends CatalogType> Collection<T>	getAllForMinecraft(Class<T> typeClass) Gets all CatalogType for Minecraft as a base mod.
default <T extends CatalogType> Collection<T>	getAllForSponge(Class<T> typeClass) Gets all CatalogType for Sponge as a base mod.
<T extends CatalogType> Collection<T>	getAllOf(Class<T> typeClass) Gets a collection of all available found specific types of CatalogType requested.
Optional<BlockStatistic>	getBlockStatistic(StatisticType statType, BlockType blockType) Gets the Statistic for the given StatisticType and BlockType.
CraftingRecipeRegistry	getCraftingRecipeRegistry() Retrieves the crafting RecipeRegistry for this GameRegistry.
Collection<String>	getDefaultGameRules() Gets a Collection of the default GameRules.
Optional<DisplaySlot>	getDisplaySlotForColor(TextColor color) Gets a DisplaySlot which displays only for teams with the provided color.
Optional<EntityStatistic>	getEntityStatistic(StatisticType statType, EntityType entityType) Gets the Statistic for the given StatisticType and EntityType.
ExtentBufferFactory	getExtentBufferFactory() Gets the ExtentBufferFactory for creating buffers to store extent data.
Optional<ItemStatistic>	getItemStatistic(StatisticType statType, ItemType itemType) Gets the Statistic for the given StatisticType and ItemType.
Optional<Criterion>	getKilledByTeamCriterionForColor(TextColor color) Gets a Criterion which causes an Objective to have a score for a player incremented when he has been killed by a member of the given colored team.
Locale	getLocale(String locale) Gets a locale for the specified locale code, e.g.
Optional<ResourcePack>	getResourcePackById(String id) Gets a ResourcePack that's already been created by its ID.
Optional<Rotation>	getRotationFromDegree(int degrees) Gets the Rotation with the provided degrees.
SelectorFactory	getSelectorFactory() Deprecated. Use the appropriate class in the selector package instead
SmeltingRecipeRegistry	getSmeltingRecipeRegistry() Retrieves the smelting RecipeRegistry for this GameRegistry.
Optional<Criterion>	getTeamKillCriterionForColor(TextColor color) Gets a Criterion which causes an Objective to have a score for a player incremented when he kills a member of the given colored team.
TextSerializerFactory	getTextSerializerFactory() Deprecated. Use TextSerializers instead
Optional<Translation>	getTranslationById(String id) Gets the Translation with the provided ID.
<T extends CatalogType> Optional<T>	getType(Class<T> typeClass, String id) Attempts to retrieve the specific type of CatalogType based on the string id given.
ValueFactory	getValueFactory() Gets the ValueFactory for creating values.
VillagerRegistry	getVillagerRegistry() Gets the VillagerRegistry for the register mappings of Careers to TradeOfferGenerators based on a level.
Favicon	loadFavicon(BufferedImage image) Loads a favicon from a specified BufferedImage.
Favicon	loadFavicon(InputStream in) Loads a favicon from a specified InputStream.
Favicon	loadFavicon(Path path) Loads a favicon from a specified Path.
Favicon	loadFavicon(String raw) Loads a Favicon from the specified encoded string.
Favicon	loadFavicon(URL url) Loads a favicon from a specified URL.
<T extends CatalogType> T	register(Class<T> type, T obj) Deprecated. Is scheduled to be removed in API 8, the GameRegistryEvent.Register should be used instead
AITaskType	registerAITaskType(Object plugin, String id, String name, Class<? extends AbstractAITask<? extends Agent>> aiClass) Registers a new AbstractAITask with an Agent as the owner.
<T> GameRegistry	registerBuilderSupplier(Class<T> builderClass, Supplier<? extends T> supplier) Registers a Supplier for creating the desired ResettableBuilder.
<T extends CatalogType> GameRegistry	registerModule(Class<T> catalogClass, CatalogRegistryModule<T> registryModule) Registers the CatalogRegistryModule for dummy registration and handling.
GameRegistry	registerModule(RegistryModule module) Registers the desired RegistryModule.

Method Detail

getType

<T extends CatalogType> Optional<T> getType(Class<T> typeClass,
                                            String id)

Attempts to retrieve the specific type of CatalogType based on the string id given.

Some types may not be available for various reasons including but not restricted to: mods adding custom types, plugins providing custom types, game version changes.

Type Parameters:

T - The type of dummy type

Parameters:

typeClass - The class of the type of CatalogType

id - The case insensitive string id of the dummy type

Returns:

The found dummy type, if available

See Also:

CatalogType

getAllOf

<T extends CatalogType> Collection<T> getAllOf(Class<T> typeClass)

Gets a collection of all available found specific types of CatalogType requested.

The presented CatalogTypes may not exist in default catalogs due to various reasons including but not restricted to: mods, plugins, game changes.

Type Parameters:

T - The type of CatalogType

Parameters:

typeClass - The class of CatalogType

Returns:

A collection of all known types of the requested catalog type

getAllFor

<T extends CatalogType> Collection<T> getAllFor(String pluginId,
                                                Class<T> typeClass)

Gets a collection of all available found specific types of CatalogType requested.

Type Parameters:

T - The type of CatalogType

Parameters:

pluginId - The plugin id to check for types

typeClass - The class of CatalogType

Returns:

A collection of all known types of the requested catalog type

getAllForMinecraft

default <T extends CatalogType> Collection<T> getAllForMinecraft(Class<T> typeClass)

Gets all CatalogType for Minecraft as a base mod. Note that some CatalogTypes are not originally from the game itself, and may be provided by Sponge.

Type Parameters:

T - The type of catalog type

Parameters:

typeClass - The type of catalog type

Returns:

The collection of all known types of the requested catalog type

getAllForSponge

default <T extends CatalogType> Collection<T> getAllForSponge(Class<T> typeClass)

Gets all CatalogType for Sponge as a base mod. Note that some CatalogTypes are not originally from the game itself, and may be provided by Sponge.

Type Parameters:

T - The type of catalog type

Parameters:

typeClass - The type of catalog type

Returns:

The collection of all known types of the requested catalog type

registerModule

<T extends CatalogType> GameRegistry registerModule(Class<T> catalogClass,
                                                    CatalogRegistryModule<T> registryModule)
                                             throws IllegalArgumentException,
                                                    RegistryModuleAlreadyRegisteredException

Registers the CatalogRegistryModule for dummy registration and handling.

By default, the only supported modules that can be registered are dependent that plugins are not attempting to register new modules for API-provided CatalogTypes.

Type Parameters:

T - The type of dummy

Parameters:

catalogClass - The dummy class itself

registryModule - The registry module

Returns:

fluent interface

Throws:

IllegalArgumentException - If there is a module already registered

RegistryModuleAlreadyRegisteredException - If the registry module is already registered

UnsupportedOperationException - If an attempt is made to register a module for an API catalog

registerModule

GameRegistry registerModule(RegistryModule module)
                     throws RegistryModuleAlreadyRegisteredException

Registers the desired RegistryModule.

Parameters:

module - The module to register

Returns:

This registry, for chaining

Throws:

RegistryModuleAlreadyRegisteredException - if the specified registry module is already registered

registerBuilderSupplier

<T> GameRegistry registerBuilderSupplier(Class<T> builderClass,
                                         Supplier<? extends T> supplier)

Registers a Supplier for creating the desired ResettableBuilder.

Type Parameters:

T - The type of builder/supplier

Parameters:

builderClass - The builder class

supplier - The supplier

Returns:

This registry, for chaining

createBuilder

<T extends ResettableBuilder<?,? super T>> T createBuilder(Class<T> builderClass)
                                                    throws IllegalArgumentException

Gets a builder of the desired class type, examples may include: ItemStack.Builder, etc.

Type Parameters:

T - The type of builder

Parameters:

builderClass - The class of the builder

Returns:

The builder, if available

Throws:

IllegalArgumentException - If there is no supplier for the given builder class

register

@Deprecated
<T extends CatalogType> T register(Class<T> type,
                                                T obj)
                                         throws IllegalArgumentException,
                                                CatalogTypeAlreadyRegisteredException

Deprecated. Is scheduled to be removed in API 8, the GameRegistryEvent.Register should be used instead

Registers a new CatalogType instance if registration for that type is supported.

Note that this is intended only for registering new instances of already existing CatalogTypes, not for registering entirely new CatalogType classes.

Type Parameters:

T - dummy object type

Parameters:

type - The CatalogType class

obj - The dummy type instance

Returns:

The registered type

Throws:

IllegalArgumentException - If there is an id conflict with the given type and an existing type

UnsupportedOperationException - If registration for the given type is not supported

CatalogTypeAlreadyRegisteredException - if the type cannot be registered because a matching type was already registered

getDefaultGameRules

Collection<String> getDefaultGameRules()

Gets a Collection of the default GameRules.

Returns:

The default GameRules.

getEntityStatistic

Optional<EntityStatistic> getEntityStatistic(StatisticType statType,
                                             EntityType entityType)

Gets the Statistic for the given StatisticType and EntityType. If the statistic group is not a valid EntityStatistic group then Optional.empty() will be returned.

Parameters:

statType - The type of statistic to return

entityType - The entity type for the statistic to return

Returns:

The entity statistic or Optional.empty() if not found

getItemStatistic

Optional<ItemStatistic> getItemStatistic(StatisticType statType,
                                         ItemType itemType)

Gets the Statistic for the given StatisticType and ItemType. If the statistic group is not a valid ItemStatistic group then Optional.empty() will be returned.

Parameters:

statType - The type of statistic to return

itemType - The item type for the statistic to return

Returns:

The item statistic or Optional.empty() if not found

getBlockStatistic

Optional<BlockStatistic> getBlockStatistic(StatisticType statType,
                                           BlockType blockType)

Gets the Statistic for the given StatisticType and BlockType. If the statistic group is not a valid BlockStatistic group then Optional.empty() will be returned.

Parameters:

statType - The type of statistic to return

blockType - The block type for the statistic to return

Returns:

The block statistic or Optional.empty() if not found

getRotationFromDegree

Optional<Rotation> getRotationFromDegree(int degrees)

Gets the Rotation with the provided degrees.

Parameters:

degrees - The degrees of the rotation

Returns:

The Rotation with the given degrees or Optional.empty() if not found

loadFavicon

Favicon loadFavicon(String raw)
             throws IOException

Loads a Favicon from the specified encoded string. The format of the input depends on the implementation.

Parameters:

raw - The encoded favicon

Returns:

The loaded favicon

Throws:

IOException - If the favicon couldn't be loaded

loadFavicon

Favicon loadFavicon(Path path)
             throws IOException

Loads a favicon from a specified Path.

Parameters:

path - The path to the favicon

Returns:

The loaded favicon from the file

Throws:

IOException - If the favicon couldn't be loaded

FileNotFoundException - If the file doesn't exist

loadFavicon

Favicon loadFavicon(URL url)
             throws IOException

Loads a favicon from a specified URL.

Parameters:

url - The favicon URL

Returns:

The loaded favicon from the URL

Throws:

IOException - If the favicon couldn't be loaded

loadFavicon

Favicon loadFavicon(InputStream in)
             throws IOException

Loads a favicon from a specified InputStream.

Parameters:

in - The favicon input stream

Returns:

The loaded favicon from the input stream

Throws:

IOException - If the favicon couldn't be loaded

loadFavicon

Favicon loadFavicon(BufferedImage image)
             throws IOException

Loads a favicon from a specified BufferedImage.

Parameters:

image - The favicon image

Returns:

The loaded favicon from the image

Throws:

IOException - If the favicon couldn't be loaded

getCraftingRecipeRegistry

CraftingRecipeRegistry getCraftingRecipeRegistry()

Retrieves the crafting RecipeRegistry for this GameRegistry.

Returns:

The crafting recipe registry

getSmeltingRecipeRegistry

SmeltingRecipeRegistry getSmeltingRecipeRegistry()

Retrieves the smelting RecipeRegistry for this GameRegistry.

Returns:

The smelting recipe registry

getResourcePackById

Optional<ResourcePack> getResourcePackById(String id)

Gets a ResourcePack that's already been created by its ID.

Parameters:

id - The ID of the pack

Returns:

The ResourcePack with the specified ID, or Optional.empty() if none could be found

getTeamKillCriterionForColor

Optional<Criterion> getTeamKillCriterionForColor(TextColor color)

Gets a Criterion which causes an Objective to have a score for a player incremented when he kills a member of the given colored team.

Parameters:

color - The color for the criterion

Returns:

The team kill Criterion with the provided color, or Optional.empty() if not found

getKilledByTeamCriterionForColor

Optional<Criterion> getKilledByTeamCriterionForColor(TextColor color)

Gets a Criterion which causes an Objective to have a score for a player incremented when he has been killed by a member of the given colored team.

Parameters:

color - The color for the criterion

Returns:

The killed by team Criterion with the provided color, or Optional.empty() if not found

getDisplaySlotForColor

Optional<DisplaySlot> getDisplaySlotForColor(TextColor color)

Gets a DisplaySlot which displays only for teams with the provided color.

Parameters:

color - The color for the display slot

Returns:

The DisplaySlot with the provided color, or Optional.empty() if not found

registerAITaskType

AITaskType registerAITaskType(Object plugin,
                              String id,
                              String name,
                              Class<? extends AbstractAITask<? extends Agent>> aiClass)

Registers a new AbstractAITask with an Agent as the owner. The complete id will be in the format of PluginContainer.getId():id.

Parameters:

plugin - The plugin who owns it

id - The id that represents the task type

name - The name for the task

aiClass - The class of the task

Returns:

The type

getExtentBufferFactory

ExtentBufferFactory getExtentBufferFactory()

Gets the ExtentBufferFactory for creating buffers to store extent data.

Returns:

The extent buffer factory

getValueFactory

ValueFactory getValueFactory()

Gets the ValueFactory for creating values.

Returns:

The value factory

getVillagerRegistry

VillagerRegistry getVillagerRegistry()

Gets the VillagerRegistry for the register mappings of Careers to TradeOfferGenerators based on a level.

Returns:

The villager registry instance

getTextSerializerFactory

@Deprecated
TextSerializerFactory getTextSerializerFactory()

Deprecated. Use TextSerializers instead

Gets the internal TextSerializerFactory.

Returns:

The text serializer factory

getSelectorFactory

@Deprecated
SelectorFactory getSelectorFactory()

Deprecated. Use the appropriate class in the selector package instead

Gets the internal SelectorFactory.

Returns:

The selector factory

getLocale

Locale getLocale(String locale)

Gets a locale for the specified locale code, e.g. en_US.

Parameters:

locale - The locale to lookup (e.g. en_US).

Returns:

The locale

getTranslationById

Optional<Translation> getTranslationById(String id)

Gets the Translation with the provided ID.

Parameters:

id - The ID of the translation

Returns:

The Translation with the given ID or Optional.empty() if not found