Package com.misterpemodder.shulkerboxtooltip.api.provider

Class EmptyPreviewProvider

java.lang.Object

com.misterpemodder.shulkerboxtooltip.api.provider.EmptyPreviewProvider

All Implemented Interfaces:

PreviewProvider

public class EmptyPreviewProvider
extends Object
implements PreviewProvider

A PreviewProvider that does nothing.

Since:

1.3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final PreviewProvider	INSTANCE	The EmptyPreviewProvider instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EmptyPreviewProvider()	Default constructor.

Method Summary

Modifier and Type	Method	Description
List<net.minecraft.world.item.ItemStack>	getInventory(PreviewContext context)	Fetches the items to be displayed in the preview.
int	getInventoryMaxSize(PreviewContext context)	Returns the maximum amount of slots this preview can display.
boolean	shouldDisplay(PreviewContext context)	Queries if the preview window should be displayed for the given context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider

addTooltip, getCompactMaxRowSize, getFullTooltipHintLangKey, getLockKeyTooltipHintLangKey, getMaxRowSize, getPriority, getRenderer, getTextureOverride, getTooltipHintLangKey, getWindowColorKey, isFullPreviewAvailable, onInventoryAccessStart, showTooltipHints

Field Details

INSTANCE

public static final PreviewProvider INSTANCE

The EmptyPreviewProvider instance.

Since:

1.3.0

Constructor Details

EmptyPreviewProvider

protected EmptyPreviewProvider()

Default constructor.

Method Details

getInventoryMaxSize

public int getInventoryMaxSize(PreviewContext context)

Description copied from interface: PreviewProvider

Returns the maximum amount of slots this preview can display.

Specified by:

getInventoryMaxSize in interface PreviewProvider

Parameters:

context - The preview context.

Returns:

The maximum inventory size for the given stack.

shouldDisplay

public boolean shouldDisplay(PreviewContext context)

Description copied from interface: PreviewProvider

Queries if the preview window should be displayed for the given context. Should return false if the inventory is empty.

Specified by:

shouldDisplay in interface PreviewProvider

Parameters:

context - The preview context.

Returns:

Whether the preview should be displayed.

getInventory

public List<net.minecraft.world.item.ItemStack> getInventory(PreviewContext context)

Description copied from interface: PreviewProvider

Fetches the items to be displayed in the preview.

Specified by:

getInventory in interface PreviewProvider

Parameters:

context - The preview context.

Returns:

The list of items, may not be null or contain null elements.