Package appeng.api.integrations.igtooltip

Interface TooltipProvider

@Experimental
@OverrideOnly
public interface TooltipProvider

Implement this in your addon to register additional block entity tooltips using AE2's abstraction over Jade/WTHIT/TOP.

AE2 uses the Java Service Loader mechanism to find your implementations.

In Short: Name a text-file META-INF/services/appeng.api.integrations.igtooltip.TooltipProvider and place a line in it that has the fully qualified name of your implementation class.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEBUG_PRIORITY
static final int	DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method	Description
default void	registerBlockEntityBaseClasses(BaseClassRegistration registration)	Allows an addon to register additional block entity base-classes that benefit from default AE2 tooltip providers.
default void	registerClient(ClientRegistration registration)	Called on clients to register providers that supply tooltip data.
default void	registerCommon(CommonRegistration registration)	Called on both dedicated servers and clients to register providers for server-data.

Field Details

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

See Also:

• Constant Field Values

DEBUG_PRIORITY

static final int DEBUG_PRIORITY

See Also:

• Constant Field Values

Method Details

registerCommon

default void registerCommon(CommonRegistration registration)

Called on both dedicated servers and clients to register providers for server-data.

registerClient

default void registerClient(ClientRegistration registration)

Called on clients to register providers that supply tooltip data.

registerBlockEntityBaseClasses

default void registerBlockEntityBaseClasses(BaseClassRegistration registration)

Allows an addon to register additional block entity base-classes that benefit from default AE2 tooltip providers.