Package com.blamejared.crafttweaker.impl.registry

Class CraftTweakerRegistry

java.lang.Object

com.blamejared.crafttweaker.impl.registry.CraftTweakerRegistry

All Implemented Interfaces:

ICraftTweakerRegistry

public final class CraftTweakerRegistry
extends Object
implements ICraftTweakerRegistry

Method Summary

Modifier and Type	Method	Description
IScriptLoader	findLoader(String name)	Attempts to find an IScriptLoader with the given name, if available.
IScriptLoadSource	findLoadSource(net.minecraft.resources.ResourceLocation id)	Attempts to find an IScriptLoadSource with the given id, if possible.
<T> IRecipeComponent<T>	findRecipeComponent(net.minecraft.resources.ResourceLocation id)	Obtains the IRecipeComponent with the given id, if available.
static ICraftTweakerRegistry	get()
Set<String>	getAllEnumStringsForEnumBracket(IScriptLoader loader)	Gets all bracket handler possibilities that can be queried under the given IScriptLoader.
Collection<IScriptLoader>	getAllLoaders()	Obtains a Collection of all IScriptLoaders known to CraftTweaker.
Collection<IRecipeComponent<?>>	getAllRecipeComponents()	Obtains a Collection of all IRecipeComponents known to CraftTweaker.
Map<String,IBracketDumperInfo>	getBracketDumpers(IScriptLoader loader)	Obtains a read-only Map of all bracket dumpers registered for the given IScriptLoader.
Map<String,BracketExpressionParser>	getBracketHandlers(IScriptLoader loader, String rootPackage)	Obtains a Map containing all known bracket handlers for the given IScriptLoader residing in the rootPackage.
IScriptRunModuleConfigurator	getConfiguratorFor(IScriptLoader loader)	Obtains the IScriptRunModuleConfigurator that has been registered for the given IScriptLoader.
<T extends Enum<T>> Optional<Class<T>>	getEnumBracketFor(IScriptLoader loader, net.minecraft.resources.ResourceLocation type)	Obtains the enumeration class that corresponds to the given id in the queried IScriptLoader.
<T extends Enum<T>> T	getEnumBracketValue(IScriptLoader loader, net.minecraft.resources.ResourceLocation type, String value)	Obtains the enumeration constant that corresponds to the given IScriptLoader, id, and value as if it were looked up from the <constant> bracket handler.
IEventRegistry	getEventRegistry()	Provides access to the global IEventRegistry.
List<IPreprocessor>	getPreprocessors()	Gets a read-only List of all known preprocessors.
<T extends net.minecraft.world.item.crafting.Recipe<?>> IRecipeHandler<T>	getRecipeHandlerFor(Class<T> recipeClazz)	Obtains the IRecipeHandler responsible for the given recipe class.
<T extends net.minecraft.world.item.crafting.Recipe<?>> IRecipeHandler<T>	getRecipeHandlerFor(T recipe)	Obtains the IRecipeHandler responsible for the given recipe.
IReplacerRegistry	getReplacerRegistry()	Offers access to the IReplacerRegistry.
<T> TagManagerFactory<T,? extends ITagManager<?>>	getTaggableElementFactory(net.minecraft.resources.ResourceKey<net.minecraft.core.Registry<T>> key)	Gets a TagManagerFactory for the given ResourceKey.
<T> Optional<Class<T>>	getTaggableElementFor(net.minecraft.resources.ResourceKey<T> key)	Tries to find a taggable element for the given ResourceKey.
IZenClassRegistry	getZenClassRegistry()	Gets the global IZenClassRegistry.
static IPluginRegistryAccess	pluginAccess(PluginManager.Req req)

Methods inherited from class java.lang.Object

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

Method Details

get

public static ICraftTweakerRegistry get()

pluginAccess

public static IPluginRegistryAccess pluginAccess(PluginManager.Req req)

findLoader

public IScriptLoader findLoader(String name)

Description copied from interface: ICraftTweakerRegistry

Attempts to find an IScriptLoader with the given name, if available.

This method can be called only after all registries have been successfully built: attempting to call this method before that might lead to undefined behavior. It is also illegal to attempt to query the global loader through this method.

Specified by:

findLoader in interface ICraftTweakerRegistry

Parameters:

name - The name of the loader that should be found. It cannot be the global loader.

Returns:

The IScriptLoader with the given name, if available.

getAllLoaders

public Collection<IScriptLoader> getAllLoaders()

Description copied from interface: ICraftTweakerRegistry

Obtains a Collection of all IScriptLoaders known to CraftTweaker.

Specified by:

getAllLoaders in interface ICraftTweakerRegistry

Returns:

A read-only collection of all known loaders.

findLoadSource

public IScriptLoadSource findLoadSource(net.minecraft.resources.ResourceLocation id)

Description copied from interface: ICraftTweakerRegistry

Attempts to find an IScriptLoadSource with the given id, if possible.

This method can be called only after all registries have been successfully built: attempting to call this method before that might lead to undefined behavior.

Specified by:

findLoadSource in interface ICraftTweakerRegistry

Parameters:

id - The id of the load source that should be found.

Returns:

The IScriptLoadSource with the given id, if available.

getZenClassRegistry

public IZenClassRegistry getZenClassRegistry()

Description copied from interface: ICraftTweakerRegistry

Gets the global IZenClassRegistry.

Specified by:

getZenClassRegistry in interface ICraftTweakerRegistry

Returns:

The global IZenClassRegistry.

getConfiguratorFor

public IScriptRunModuleConfigurator getConfiguratorFor(IScriptLoader loader)

Description copied from interface: ICraftTweakerRegistry

Obtains the IScriptRunModuleConfigurator that has been registered for the given IScriptLoader.

This method must be called only after all registries have been successfully built: earlier calls will result in undefined behavior.

Specified by:

getConfiguratorFor in interface ICraftTweakerRegistry

Parameters:

loader - The loader for which the configurator should be obtained for.

Returns:

The corresponding IScriptRunModuleConfigurator.

getBracketDumpers

public Map<String,IBracketDumperInfo> getBracketDumpers(IScriptLoader loader)

Description copied from interface: ICraftTweakerRegistry

Obtains a read-only Map of all bracket dumpers registered for the given IScriptLoader.

Each entry has a key representing the name of the bracket expression for which the dumper is for and a value corresponding to the IBracketDumperInfo for that bracket expression.

Specified by:

getBracketDumpers in interface ICraftTweakerRegistry

Parameters:

loader - The loader for which the bracket dumpers should be obtained.

Returns:

A Map containing the requested data.

getBracketHandlers

public Map<String,BracketExpressionParser> getBracketHandlers(IScriptLoader loader,
 String rootPackage)

Description copied from interface: ICraftTweakerRegistry

Obtains a Map containing all known bracket handlers for the given IScriptLoader residing in the rootPackage.

The concept of package used in this method corresponds to the ZenCode concept instead of the Java concept. This means that also bracket handlers in the various sub-packages will also be queried.

Specified by:

getBracketHandlers in interface ICraftTweakerRegistry

Parameters:

loader - The IScriptLoader for which bracket handlers should be queried.

rootPackage - The root package under which the bracket handlers should reside.

Returns:

A Map whose key represents the name of the bracket and the value the BracketExpressionParser responsible for resolution.

getPreprocessors

public List<IPreprocessor> getPreprocessors()

Description copied from interface: ICraftTweakerRegistry

Gets a read-only List of all known preprocessors.

Specified by:

getPreprocessors in interface ICraftTweakerRegistry

Returns:

All known preprocessors.

getRecipeHandlerFor

public <T extends net.minecraft.world.item.crafting.Recipe<?>>
IRecipeHandler<T> getRecipeHandlerFor(T recipe)

Description copied from interface: ICraftTweakerRegistry

Obtains the IRecipeHandler responsible for the given recipe.

Specified by:

getRecipeHandlerFor in interface ICraftTweakerRegistry

Type Parameters:

T - The type of the recipe whose handler should be identified.

Parameters:

recipe - The recipe whose handler should be identified.

Returns:

an IRecipeHandler that is able to deal with the given recipe.

getRecipeHandlerFor

public <T extends net.minecraft.world.item.crafting.Recipe<?>>
IRecipeHandler<T> getRecipeHandlerFor(Class<T> recipeClazz)

Description copied from interface: ICraftTweakerRegistry

Obtains the IRecipeHandler responsible for the given recipe class.

Specified by:

getRecipeHandlerFor in interface ICraftTweakerRegistry

Type Parameters:

T - The type of the recipe whose handler should be identified.

Parameters:

recipeClazz - The recipe class whose handler should be identified.

Returns:

an IRecipeHandler that is able to deal with the given recipe class.

findRecipeComponent

public <T> IRecipeComponent<T> findRecipeComponent(net.minecraft.resources.ResourceLocation id)

Description copied from interface: ICraftTweakerRegistry

Obtains the IRecipeComponent with the given id, if available.

This method can be called only after all registries have been successfully built: attempting to call this method before that might lead to undefined behavior.

Take note that all recipe components have a type associated with them. This query does not attempt to verify that the component with the given id reflects the type specified in the type parameter. Care must be taken by the caller of this method to ensure correctness.

Specified by:

findRecipeComponent in interface ICraftTweakerRegistry

Type Parameters:

T - The type associated with the IRecipeComponent.

Parameters:

id - The name id of the recipe component.

Returns:

The IRecipeComponent with the given name, if available.

getAllRecipeComponents

public Collection<IRecipeComponent<?>> getAllRecipeComponents()

Description copied from interface: ICraftTweakerRegistry

Obtains a Collection of all IRecipeComponents known to CraftTweaker.

Specified by:

getAllRecipeComponents in interface ICraftTweakerRegistry

Returns:

A read-only collection of all known components.

getEnumBracketValue

public <T extends Enum<T>> T getEnumBracketValue(IScriptLoader loader,
 net.minecraft.resources.ResourceLocation type,
 String value)

Description copied from interface: ICraftTweakerRegistry

Obtains the enumeration constant that corresponds to the given IScriptLoader, id, and value as if it were looked up from the <constant> bracket handler.

Specified by:

getEnumBracketValue in interface ICraftTweakerRegistry

Type Parameters:

T - The type of the target enumeration.

Parameters:

loader - The IScriptLoader under which the enumeration should be queried.

type - The ResourceLocation that uniquely identifies the enumeration.

value - The value of the enumeration that should be obtained.

Returns:

The enumeration value that would be obtained by the bracket handler.

getEnumBracketFor

public <T extends Enum<T>> Optional<Class<T>> getEnumBracketFor(IScriptLoader loader,
 net.minecraft.resources.ResourceLocation type)

Description copied from interface: ICraftTweakerRegistry

Obtains the enumeration class that corresponds to the given id in the queried IScriptLoader.

Specified by:

getEnumBracketFor in interface ICraftTweakerRegistry

Type Parameters:

T - The type of the target enumeration.

Parameters:

loader - The IScriptLoader under which the enumeration should be queried.

type - The ResourceLocation that uniquely identifies the enumeration.

Returns:

An Optional wrapping the Class of the enumeration if it can be identified, an empty optional otherwise.

getTaggableElementFor

public <T> Optional<Class<T>> getTaggableElementFor(net.minecraft.resources.ResourceKey<T> key)

Description copied from interface: ICraftTweakerRegistry

Tries to find a taggable element for the given ResourceKey.

Specified by:

getTaggableElementFor in interface ICraftTweakerRegistry

Type Parameters:

T - The type of element to find.

Parameters:

key - The ResourceKey to get the element for.

Returns:

An Optional wrapping the Class of the taggable element if it can be found, an empty optional otherwise.

getTaggableElementFactory

public <T>
TagManagerFactory<T,? extends ITagManager<?>> getTaggableElementFactory(net.minecraft.resources.ResourceKey<net.minecraft.core.Registry<T>> key)

Description copied from interface: ICraftTweakerRegistry

Gets a TagManagerFactory for the given ResourceKey.

Note: If an element is known but does not have an explicit TagManagerFactory, then a factory for a KnownTagManager is returned. If an element is not known, then a factory for an UnknownTagManager is returned.

Specified by:

getTaggableElementFactory in interface ICraftTweakerRegistry

Type Parameters:

T - The type of element the factory deals with.

Parameters:

key - The ResourceKey to get the element factory for.

Returns:

A TagManagerFactory for the given ResourceKey.

getAllEnumStringsForEnumBracket

public Set<String> getAllEnumStringsForEnumBracket(IScriptLoader loader)

Description copied from interface: ICraftTweakerRegistry

Gets all bracket handler possibilities that can be queried under the given IScriptLoader.

The data of the returned set corresponds to strings of the form <constant:id:constant>, where id represents the unique identifier of the enumeration in the given loader and constant the name of the constant under that enumeration.

Specified by:

getAllEnumStringsForEnumBracket in interface ICraftTweakerRegistry

Parameters:

loader - The IScriptLoader for which all valid constant brackets should be queried.

Returns:

A Set of strings of the previously mentioned format.

getReplacerRegistry

public IReplacerRegistry getReplacerRegistry()

Description copied from interface: ICraftTweakerRegistry

Offers access to the IReplacerRegistry.

Specified by:

getReplacerRegistry in interface ICraftTweakerRegistry

Returns:

The IReplacerRegistry.

getEventRegistry

public IEventRegistry getEventRegistry()

Description copied from interface: ICraftTweakerRegistry

Provides access to the global IEventRegistry.

Specified by:

getEventRegistry in interface ICraftTweakerRegistry

Returns:

The IEventRegistry.