Interface IBlockComponentProvider

Method Details

• redirect

  @Nullable @Experimental default ITargetRedirector.Result redirect(ITargetRedirector redirect, IBlockAccessor accessor, IPluginConfig config)

  Redirect the ray cast hit result to target other object.

  Parameters:

  redirect - the redirector

  accessor - contains most of the relevant information about the current environment. Note that IBlockAccessor.getData() will always be empty at this time

  config - current plugin configuration

  Returns:

  null if this method doesn't redirect to anything, any result from one of ITargetRedirector's methods otherwise

  See Also:

  • IClientRegistrar.redirect(IBlockComponentProvider, Class)

• appendDataContext

  default void appendDataContext(IDataWriter ctx, IBlockAccessor accessor, IPluginConfig config)

  Callback used to send additional context to IDataProviders.

  Parameters:

  ctx - the context writer

  accessor - contains most of the relevant information about the current environment. Note that IBlockAccessor.getData() will always be empty at this time

  config - current plugin configuration

  See Also:

  • IClientRegistrar.dataContext(IBlockComponentProvider, Class)

• getOverride

  @Nullable default @Nullable BlockState getOverride(IBlockAccessor accessor, IPluginConfig config)

  Callback used to override the default Waila lookup system.

  This method is only called on the client side. If you require data from the server, you should also implement IDataProvider and add the data there, which can then be read back using IBlockAccessor.getData(). If you rely on the client knowing the data you need, you are not guaranteed to have the proper values.

  Parameters:

  accessor - contains most of the relevant information about the current environment

  config - current plugin configuration

  Returns:

  null if override is not required, a BlockState otherwise

  See Also:

  • IClientRegistrar.override(IBlockComponentProvider, Class, int)
  • EMPTY_BLOCK_STATE

• getIcon

  @Nullable default @Nullable ITooltipComponent getIcon(IBlockAccessor accessor, IPluginConfig config)

  Callback used to set an icon to display in the tooltip.

  This method is only called on the client side. If you require data from the server, you should also implement IDataProvider and add the data there, which can then be read back using IBlockAccessor.getData(). If you rely on the client knowing the data you need, you are not guaranteed to have the proper values.

  Parameters:

  accessor - contains most of the relevant information about the current environment

  config - current plugin configuration

  Returns:

  the component to render or null if this provider doesn't decide it

  See Also:

  • IClientRegistrar.icon(IEntityComponentProvider, Class, int)

• appendHead

  default void appendHead(ITooltip tooltip, IBlockAccessor accessor, IPluginConfig config)

  Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).

  This method is only called on the client side. If you require data from the server, you should also implement IDataProvider and add the data there, which can then be read back using IBlockAccessor.getData(). If you rely on the client knowing the data you need, you are not guaranteed to have the proper values.

  Parameters:

  tooltip - current list of tooltip lines (might have been processed by other providers and might be processed by other providers), use ITooltip.setLine(net.minecraft.resources.ResourceLocation) with tags from WailaConstants to override built-in values

  accessor - contains most of the relevant information about the current environment

  config - current plugin configuration

  See Also:

  • IClientRegistrar.head(IBlockComponentProvider, Class, int)

• appendBody

  default void appendBody(ITooltip tooltip, IBlockAccessor accessor, IPluginConfig config)

  Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).

  This method is only called on the client side. If you require data from the server, you should also implement IDataProvider and add the data there, which can then be read back using IBlockAccessor.getData(). If you rely on the client knowing the data you need, you are not guaranteed to have the proper values.

  Parameters:

  tooltip - current list of tooltip lines (might have been processed by other providers and might be processed by other providers), use ITooltip.setLine(net.minecraft.resources.ResourceLocation) with tags from WailaConstants to override built-in values

  accessor - contains most of the relevant information about the current environment

  config - current plugin configuration

  See Also:

  • IClientRegistrar.body(IBlockComponentProvider, Class, int)

• appendTail

  default void appendTail(ITooltip tooltip, IBlockAccessor accessor, IPluginConfig config)

  Callback used to add lines to one of the three sections of the tooltip (Head, Body, Tail).

  This method is only called on the client side. If you require data from the server, you should also implement IDataProvider and add the data there, which can then be read back using IBlockAccessor.getData(). If you rely on the client knowing the data you need, you are not guaranteed to have the proper values.

  Parameters:

  tooltip - current list of tooltip lines (might have been processed by other providers and might be processed by other providers), use ITooltip.setLine(net.minecraft.resources.ResourceLocation) with tags from WailaConstants to override built-in values

  accessor - contains most of the relevant information about the current environment

  config - current plugin configuration

  See Also:

  • IClientRegistrar.tail(IBlockComponentProvider, Class, int)