Interface GameRegistries

public interface GameRegistries

The server-wide registries: every data registry, with the vanilla entries and those plugins add, and the content defined in code (mobs, effects, items, recipes, permissions, redstone and farming behaviours).

Since:

0.1.0

See Also:

• Server.registries()

Method Summary

Modifier and Type	Method	Description
MobEffectRegistry	effects()	Gets the server-wide effect registry.
Enchantments	enchantments()	Gets the enchantment behaviours and helpers.
FarmingRegistry	farming()	Gets the server-wide farming registry.
ItemRegistry	items()	Gets the server-wide item registry.
MobRegistry	mobs()	Gets the server-wide mob registry.
PermissionRegistry	permissions()	Gets the server-wide permission registry.
RecipeRegistry	recipes()	Gets the server-wide recipe registry.
RedstoneRegistry	redstone()	Gets the server-wide redstone registry.
<T> Registry<T>	registry(RegistryKey<T> key)	Gets a registry.
<T> WritableRegistry<T>	writable(RegistryKey<T> key)	Gets a registry plugins can add entries to, such as RegistryKey.BIOME, RegistryKey.DIMENSION_TYPE, RegistryKey.CHAT_TYPE, RegistryKey.DIALOG or RegistryKey.ENCHANTMENT.

Method Details

registry

@Contract(pure=true)
<T> Registry<T> registry(RegistryKey<T> key)

Gets a registry.

Every RegistryKey has one, populated with the vanilla entries from the start.

Type Parameters:

T - the type of the values

Parameters:

key - the key of the registry

Returns:

the registry

Throws:

IllegalArgumentException - if the server has no such registry

Since:

0.1.0

writable

@Contract(pure=true)
<T> WritableRegistry<T> writable(RegistryKey<T> key)

Gets a registry plugins can add entries to, such as RegistryKey.BIOME, RegistryKey.DIMENSION_TYPE, RegistryKey.CHAT_TYPE, RegistryKey.DIALOG or RegistryKey.ENCHANTMENT.

Biomes registered there may be referenced by generators through GeneratedChunk.setBiome(int, int, int, TypedKey), and dimension types returned by WorldGenerator.dimensionType().

Type Parameters:

T - the type of the values

Parameters:

key - the key of the registry

Returns:

the registry

Throws:

IllegalArgumentException - if the registry is not writable

Since:

0.1.0

mobs

@Contract(pure=true)
MobRegistry mobs()

Gets the server-wide mob registry.

Where plugins attach behaviours to the built-in mobs, and register mobs of their own.

Returns:

the mob registry

Since:

0.1.0

effects

@Contract(pure=true)
MobEffectRegistry effects()

Gets the server-wide effect registry.

Where plugins create the effects they apply, give behaviour to vanilla effects and add effects of their own.

Returns:

the effect registry

Since:

0.1.0

enchantments

@Contract(pure=true)
Enchantments enchantments()

Gets the enchantment behaviours and helpers.

The enchantments themselves live in the RegistryKey.ENCHANTMENT registry. This is where plugins define enchantments and give behaviour to them, vanilla ones included.

Returns:

the enchantments

Since:

0.1.0

items

@Contract(pure=true)
ItemRegistry items()

Gets the server-wide item registry.

Where plugins register items of their own, rendered client-side as the vanilla item they name.

Returns:

the item registry

Since:

0.1.0

recipes

@Contract(pure=true)
RecipeRegistry recipes()

Gets the server-wide recipe registry.

Holds the vanilla crafting recipes, and where plugins register recipes of their own, including recipes that take several items from one grid slot.

Returns:

the recipe registry

Since:

0.1.0

redstone

@Contract(pure=true)
RedstoneRegistry redstone()

Gets the server-wide redstone registry.

Where each block type taking part in redstone gets its behaviour, and where plugins attach one to the blocks they add, or to vanilla ones.

Returns:

the redstone registry

Since:

0.1.0

farming

@Contract(pure=true)
FarmingRegistry farming()

Gets the server-wide farming registry.

Where each block type taking part in farming gets its behaviour, where plugins attach one to the plants they add, or to the built-in ones, and where they declare their seeds, fertilizers, hoes and tillable soils.

Returns:

the farming registry

Since:

0.1.0

permissions

@Contract(pure=true)
PermissionRegistry permissions()

Gets the server-wide permission registry.

Returns:

the permission registry

Since:

0.1.0