Package com.blamejared.crafttweaker.api.plugin

Interface ICraftTweakerPlugin

All Known Implementing Classes:

BuiltinCraftTweakerPlugin, CraftTweakerPluginForge

public interface ICraftTweakerPlugin

Identifies a CraftTweaker Plugin.

Classes that implement this interface must be annotated with CraftTweakerPlugin to enable automatic discovery by CraftTweaker. Refer to the documentation of the annotation for more details on class structure.

All the methods will be invoked automatically by CraftTweaker as needed. Methods should not rely on global state when performing their tasks.

Since:

9.1.0

Method Summary

Modifier and Type	Method	Description
default void	initialize()	Manages plugin initialization tasks that might be required prior to the plugin lifecycle.
default void	manageJavaNativeIntegration(IJavaNativeIntegrationRegistrationHandler handler)	Manages the registration of all components required to integrate ZenCode scripts and Java.
default void	registerBracketParsers(IBracketParserRegistrationHandler handler)	Manages the registration of bracket expression parsers.
default void	registerCommands(ICommandRegistrationHandler handler)	Manages the registration of commands for the /ct main command.
default void	registerEvents(IEventRegistrationHandler handler)	Manages the registration of events and IEventBuses.
default void	registerListeners(IListenerRegistrationHandler handler)	Manages the registration of additional listeners invoked at specific points during CraftTweaker's lifecycle.
default void	registerLoaders(ILoaderRegistrationHandler handler)	Manages the registration of IScriptLoaders.
default void	registerLoadSource(IScriptLoadSourceRegistrationHandler handler)	Manages the registration of IScriptLoadSources.
default void	registerModuleConfigurators(IScriptRunModuleConfiguratorRegistrationHandler handler)	Manages the registration of IScriptRunModuleConfigurators.
default void	registerRecipeComponents(IRecipeComponentRegistrationHandler handler)	Manages the registration of IRecipeComponents.
default void	registerRecipeHandlers(IRecipeHandlerRegistrationHandler handler)	Manages the registration of IRecipeHandlers.
default void	registerReplacerComponents(IReplacerComponentRegistrationHandler handler)	Manages the registration of components tied to the Replacer system in CraftTweaker.
default void	registerTaggableElements(ITaggableElementRegistrationHandler handler)	Manages the registration of taggable elements and their tag managers.
default void	registerVillagerTradeConverters(IVillagerTradeRegistrationHandler handler)	Manages the registration of elements necessary to manipulate villager trades.

Method Details

initialize

default void initialize()

Manages plugin initialization tasks that might be required prior to the plugin lifecycle.

This method is guaranteed to be called before any other registration methods, but after all plugins have been discovered.

Since:

10.0

registerLoaders

default void registerLoaders(ILoaderRegistrationHandler handler)

Manages the registration of IScriptLoaders.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• ILoaderRegistrationHandler
• IScriptLoader

registerLoadSource

default void registerLoadSource(IScriptLoadSourceRegistrationHandler handler)

Manages the registration of IScriptLoadSources.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• IScriptLoadSourceRegistrationHandler
• IScriptLoadSource

registerModuleConfigurators

default void registerModuleConfigurators(IScriptRunModuleConfiguratorRegistrationHandler handler)

Manages the registration of IScriptRunModuleConfigurators.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• IScriptRunModuleConfiguratorRegistrationHandler
• IScriptRunModuleConfigurator

registerBracketParsers

default void registerBracketParsers(IBracketParserRegistrationHandler handler)

Manages the registration of bracket expression parsers.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• IBracketParserRegistrationHandler

registerRecipeComponents

default void registerRecipeComponents(IRecipeComponentRegistrationHandler handler)

Manages the registration of IRecipeComponents.

Parameters:

handler - The handler responsible for registration.

Since:

10.0

See Also:

• IRecipeComponentRegistrationHandler
• IRecipeComponent

registerRecipeHandlers

default void registerRecipeHandlers(IRecipeHandlerRegistrationHandler handler)

Manages the registration of IRecipeHandlers.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• IRecipeHandlerRegistrationHandler
• IRecipeHandler

manageJavaNativeIntegration

default void manageJavaNativeIntegration(IJavaNativeIntegrationRegistrationHandler handler)

Manages the registration of all components required to integrate ZenCode scripts and Java.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• IJavaNativeIntegrationRegistrationHandler

registerListeners

default void registerListeners(IListenerRegistrationHandler handler)

Manages the registration of additional listeners invoked at specific points during CraftTweaker's lifecycle.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• IListenerRegistrationHandler

registerVillagerTradeConverters

default void registerVillagerTradeConverters(IVillagerTradeRegistrationHandler handler)

Manages the registration of elements necessary to manipulate villager trades.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• IVillagerTradeRegistrationHandler

registerCommands

default void registerCommands(ICommandRegistrationHandler handler)

Manages the registration of commands for the /ct main command.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• ICommandRegistrationHandler

registerTaggableElements

default void registerTaggableElements(ITaggableElementRegistrationHandler handler)

Manages the registration of taggable elements and their tag managers.

Parameters:

handler - The handler responsible for registration.

Since:

9.1.0

See Also:

• ITaggableElementRegistrationHandler

registerReplacerComponents

default void registerReplacerComponents(IReplacerComponentRegistrationHandler handler)

Manages the registration of components tied to the Replacer system in CraftTweaker.

Parameters:

handler - The handler responsible for registration

Since:

10.0

See Also:

• IReplacerComponentRegistrationHandler

registerEvents

default void registerEvents(IEventRegistrationHandler handler)

Manages the registration of events and IEventBuses.

Parameters:

handler - The handler responsible for registration.

Since:

11.0.0

See Also:

• IEventRegistrationHandler