Package mcp.mobius.waila.api

Interface IClientRegistrar

All Known Subinterfaces:

IRegistrar

@ClientOnly
@NonExtendable
public interface IClientRegistrar

The registrar for client-sided objects.

Method Summary

Modifier and Type	Method	Description
default <T> void	body(IBlockComponentProvider provider, Class<T> clazz)	Registers an IBlockComponentProvider instance for appending Component to the tooltip.
<T> void	body(IBlockComponentProvider provider, Class<T> clazz, int priority)	Registers an IBlockComponentProvider instance for appending Component to the tooltip.
default <T> void	body(IEntityComponentProvider provider, Class<T> clazz)	Registers an IEntityComponentProvider instance with default priority for appending Component to the tooltip.
<T> void	body(IEntityComponentProvider provider, Class<T> clazz, int priority)	Registers an IEntityComponentProvider instance for appending Component to the tooltip.
<T> void	dataContext(IBlockComponentProvider provider, Class<T> clazz)	Registers an IBlockComponentProvider instance for appending data context that get sent to the server.
<T> void	dataContext(IEntityComponentProvider provider, Class<T> clazz)	Registers an IEntityComponentProvider instance for appending data context that get sent to the server.
default void	eventListener(IEventListener listener)	Adds an event listener
void	eventListener(IEventListener listener, int priority)	Adds an event listener
default <T> void	head(IBlockComponentProvider provider, Class<T> clazz)	Registers an IBlockComponentProvider instance for appending Component to the tooltip.
<T> void	head(IBlockComponentProvider provider, Class<T> clazz, int priority)	Registers an IBlockComponentProvider instance for appending Component to the tooltip.
default <T> void	head(IEntityComponentProvider provider, Class<T> clazz)	Registers an IEntityComponentProvider instance with default priority for appending Component to the tooltip.
<T> void	head(IEntityComponentProvider provider, Class<T> clazz, int priority)	Registers an IEntityComponentProvider instance for appending Component to the tooltip.
default <T> void	icon(IBlockComponentProvider provider, Class<T> clazz)	Registers an IBlockComponentProvider instance with default priority to allow overriding the displayed icon for a block via the IBlockComponentProvider.getIcon(IBlockAccessor, IPluginConfig) method.
<T> void	icon(IBlockComponentProvider provider, Class<T> clazz, int priority)	Registers an IBlockComponentProvider instance to allow overriding the displayed icon for a block via the IBlockComponentProvider.getIcon(IBlockAccessor, IPluginConfig) method.
default <T> void	icon(IEntityComponentProvider provider, Class<T> clazz)	Registers an IEntityComponentProvider instance with default priority to allow displaying an icon via the IEntityComponentProvider.getIcon(IEntityAccessor, IPluginConfig) method.
<T> void	icon(IEntityComponentProvider provider, Class<T> clazz, int priority)	Registers an IEntityComponentProvider instance to allow displaying an icon via the IEntityComponentProvider.getIcon(IEntityAccessor, IPluginConfig) method.
default <T> void	override(IBlockComponentProvider provider, Class<T> clazz)	Registers an IBlockComponentProvider instance with default priority to allow overriding the block being displayed.
<T> void	override(IBlockComponentProvider provider, Class<T> clazz, int priority)	Registers an IBlockComponentProvider instance to allow overriding the block being displayed.
default <T> void	override(IEntityComponentProvider provider, Class<T> clazz)	Registers an IEntityComponentProvider instance with default priority to allow overriding the entity being displayed.
<T> void	override(IEntityComponentProvider provider, Class<T> clazz, int priority)	Registers an IEntityComponentProvider instance to allow overriding the entity being displayed.
default void	rayCastVector(IRayCastVectorProvider provider)	Registers an IRayCastVectorProvider instance with default priority
void	rayCastVector(IRayCastVectorProvider provider, int priority)	Registers an IRayCastVectorProvider instance
default <T> void	redirect(IBlockComponentProvider provider, Class<T> clazz)	Registers an IBlockComponentProvider instance to allow redirecting the object being displayed.
<T> void	redirect(IBlockComponentProvider provider, Class<T> clazz, int priority)	Registers an IBlockComponentProvider instance to allow redirecting the object being displayed.
default <T> void	redirect(IEntityComponentProvider provider, Class<T> clazz)	Registers an IEntityComponentProvider instance to allow redirecting the object being displayed.
<T> void	redirect(IEntityComponentProvider provider, Class<T> clazz, int priority)	Registers an IEntityComponentProvider instance to allow redirecting the object being displayed.
default <T> void	tail(IBlockComponentProvider provider, Class<T> clazz)	Registers an IBlockComponentProvider instance for appending Component to the tooltip.
<T> void	tail(IBlockComponentProvider provider, Class<T> clazz, int priority)	Registers an IBlockComponentProvider instance for appending Component to the tooltip.
default <T> void	tail(IEntityComponentProvider provider, Class<T> clazz)	Registers an IEntityComponentProvider instance with default priority for appending Component to the tooltip.
<T> void	tail(IEntityComponentProvider provider, Class<T> clazz, int priority)	Registers an IEntityComponentProvider instance for appending Component to the tooltip.
<T extends ITheme> void	themeType(ResourceLocation id, IThemeType<T> type)	Registers an IThemeType instance.
void	toolType(ResourceLocation id, IToolType toolType)	Registers a tool type, to be used for the harvestability tooltip.

Method Details

eventListener

void eventListener(IEventListener listener,
 int priority)

Adds an event listener

eventListener

default void eventListener(IEventListener listener)

Adds an event listener

redirect

@Experimental
<T> void redirect(IBlockComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IBlockComponentProvider instance to allow redirecting the object being displayed. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

redirect

@Experimental
default <T> void redirect(IBlockComponentProvider provider,
 Class<T> clazz)

Registers an IBlockComponentProvider instance to allow redirecting the object being displayed. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

See Also:

• WailaConstants.DEFAULT_PRIORITY

override

<T> void override(IBlockComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IBlockComponentProvider instance to allow overriding the block being displayed. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

override

default <T> void override(IBlockComponentProvider provider,
 Class<T> clazz)

Registers an IBlockComponentProvider instance with default priority to allow overriding the block being displayed. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

See Also:

• WailaConstants.DEFAULT_PRIORITY

icon

<T> void icon(IBlockComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IBlockComponentProvider instance to allow overriding the displayed icon for a block via the IBlockComponentProvider.getIcon(IBlockAccessor, IPluginConfig) method. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

icon

default <T> void icon(IBlockComponentProvider provider,
 Class<T> clazz)

Registers an IBlockComponentProvider instance with default priority to allow overriding the displayed icon for a block via the IBlockComponentProvider.getIcon(IBlockAccessor, IPluginConfig) method. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

head

<T> void head(IBlockComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IBlockComponentProvider instance for appending Component to the tooltip. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

head

default <T> void head(IBlockComponentProvider provider,
 Class<T> clazz)

Registers an IBlockComponentProvider instance for appending Component to the tooltip. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

See Also:

• WailaConstants.DEFAULT_PRIORITY

body

<T> void body(IBlockComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IBlockComponentProvider instance for appending Component to the tooltip. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

body

default <T> void body(IBlockComponentProvider provider,
 Class<T> clazz)

Registers an IBlockComponentProvider instance for appending Component to the tooltip. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

See Also:

• WailaConstants.DEFAULT_PRIORITY

tail

<T> void tail(IBlockComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IBlockComponentProvider instance for appending Component to the tooltip. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

tail

default <T> void tail(IBlockComponentProvider provider,
 Class<T> clazz)

Registers an IBlockComponentProvider instance for appending Component to the tooltip. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

See Also:

• WailaConstants.DEFAULT_PRIORITY

dataContext

<T> void dataContext(IBlockComponentProvider provider,
 Class<T> clazz)

Registers an IBlockComponentProvider instance for appending data context that get sent to the server. A BlockEntity is also an acceptable class type.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

redirect

@Experimental
<T> void redirect(IEntityComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IEntityComponentProvider instance to allow redirecting the object being displayed.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

redirect

@Experimental
default <T> void redirect(IEntityComponentProvider provider,
 Class<T> clazz)

Registers an IEntityComponentProvider instance to allow redirecting the object being displayed.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

See Also:

• WailaConstants.DEFAULT_PRIORITY

override

<T> void override(IEntityComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IEntityComponentProvider instance to allow overriding the entity being displayed.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

override

default <T> void override(IEntityComponentProvider provider,
 Class<T> clazz)

Registers an IEntityComponentProvider instance with default priority to allow overriding the entity being displayed.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

See Also:

• WailaConstants.DEFAULT_PRIORITY

icon

<T> void icon(IEntityComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IEntityComponentProvider instance to allow displaying an icon via the IEntityComponentProvider.getIcon(IEntityAccessor, IPluginConfig) method.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

icon

default <T> void icon(IEntityComponentProvider provider,
 Class<T> clazz)

Registers an IEntityComponentProvider instance with default priority to allow displaying an icon via the IEntityComponentProvider.getIcon(IEntityAccessor, IPluginConfig) method.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

head

<T> void head(IEntityComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IEntityComponentProvider instance for appending Component to the tooltip.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

head

default <T> void head(IEntityComponentProvider provider,
 Class<T> clazz)

Registers an IEntityComponentProvider instance with default priority for appending Component to the tooltip.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

body

<T> void body(IEntityComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IEntityComponentProvider instance for appending Component to the tooltip.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

body

default <T> void body(IEntityComponentProvider provider,
 Class<T> clazz)

Registers an IEntityComponentProvider instance with default priority for appending Component to the tooltip.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

tail

<T> void tail(IEntityComponentProvider provider,
 Class<T> clazz,
 int priority)

Registers an IEntityComponentProvider instance for appending Component to the tooltip.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

priority - the priority of this provider 0 is the minimum, lower number will be called first

See Also:

• WailaConstants.DEFAULT_PRIORITY

tail

default <T> void tail(IEntityComponentProvider provider,
 Class<T> clazz)

Registers an IEntityComponentProvider instance with default priority for appending Component to the tooltip.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

dataContext

<T> void dataContext(IEntityComponentProvider provider,
 Class<T> clazz)

Registers an IEntityComponentProvider instance for appending data context that get sent to the server.

Parameters:

provider - the data provider instance

clazz - the highest level class to apply to

themeType

@Experimental
<T extends ITheme> void themeType(ResourceLocation id,
 IThemeType<T> type)

Registers an IThemeType instance.

Parameters:

id - the theme type id

type - the theme type

rayCastVector

@Experimental
void rayCastVector(IRayCastVectorProvider provider,
 int priority)

Registers an IRayCastVectorProvider instance

Parameters:

provider - the vector provider

priority - the priority of this provider 0 is the minimum, lower number will be called first

rayCastVector

@Experimental
default void rayCastVector(IRayCastVectorProvider provider)

Registers an IRayCastVectorProvider instance with default priority

Parameters:

provider - the vector provider

toolType

@Experimental
void toolType(ResourceLocation id,
 IToolType toolType)

Registers a tool type, to be used for the harvestability tooltip.

Parameters:

id - the tool type id, also used as the translation key as tooltip.waila.harvest.tool.[namespace].[path]

toolType - the tool type