org.spongepowered.api

Interface GameDictionary

public interface GameDictionary

A GameDictionary is a store of GameDictionary.Entrys.

Note that the GameDictionary's keys are different from Minecraft item ids. Minecraft item IDs are namespaces, e.g. minecraft:carrot while ItemDictionary keys are not, by design(e.g. carrot). This is mainly to keep supporting the existing Forge 'ore dictionary'.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GameDictionary.Entry

Method Summary

Modifier and Type	Method and Description
Set<GameDictionary.Entry>	get(String key) Retrieves the entries registered for the given key.
SetMultimap<String,GameDictionary.Entry>	getAll() Retrieves all entries registered in this game dictionary, mapped by their key.
void	register(String key, GameDictionary.Entry entry) Registers an GameDictionary.Entry in the dictionary with a String key.

Method Detail

register

void register(String key,
              GameDictionary.Entry entry)

Registers an GameDictionary.Entry in the dictionary with a String key. The stack size is ignored.

Parameters:

key - The key of the item as a String

entry - The item to register

get

Set<GameDictionary.Entry> get(String key)

Retrieves the entries registered for the given key. The stack sizes are set to 1.

Parameters:

key - The key of the entries as a String

Returns:

The entries registered for the given key

getAll

SetMultimap<String,GameDictionary.Entry> getAll()

Retrieves all entries registered in this game dictionary, mapped by their key.

Returns:

A map of all entries registered