Index (common 5.2.13+1.21.10 API)

A B C D E F G H I K L M N O P R S T U V W Y
All Classes and Interfaces|All Packages

A

addTooltip(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider
addTooltip(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Adds lines the stack tooltip.

B

BLACK_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Black shulker box color.
BlockEntityPreviewProvider - Class in com.misterpemodder.shulkerboxtooltip.api.provider: A PreviewProvider that works on items that carries block entity data.
BlockEntityPreviewProvider(int, boolean) - Constructor for class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider: Creates a BlockEntityPreviewProvider instance.
BlockEntityPreviewProvider(int, boolean, int) - Constructor for class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider: Creates a BlockEntityPreviewProvider instance.
BlockEntityPreviewProvider(int, boolean, int, int) - Constructor for class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider: Creates a BlockEntityPreviewProvider instance.
BLUE_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Blue shulker box color.
BROWN_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Brown shulker box color.
build() - Method in interface com.misterpemodder.shulkerboxtooltip.api.PreviewContext.Builder: Builds the PreviewContext instance.
builder(ItemStack) - Static method in interface com.misterpemodder.shulkerboxtooltip.api.PreviewContext: Creates a new PreviewContext.Builder instance.

C

canUseLootTables() - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider: If true, previews will not be shown when the LootTable tag inside BlockEntityData is present.
categories() - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorRegistry: Access to all the registered categories.
category(ResourceLocation) - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorRegistry: Access to a category, the returned instance will only be registered if at least one color key is registered to it.
ColorKey - Interface in com.misterpemodder.shulkerboxtooltip.api.color: Player-customizable colors.
ColorRegistry - Interface in com.misterpemodder.shulkerboxtooltip.api.color: Provides a way to register custom color keys and categories to allow user-customization through the mod's config.
ColorRegistry.Category - Interface in com.misterpemodder.shulkerboxtooltip.api.color: A color category.
com.misterpemodder.shulkerboxtooltip.api - package com.misterpemodder.shulkerboxtooltip.api: The platform independent part of the ShulkerBoxTooltip API.
com.misterpemodder.shulkerboxtooltip.api.color - package com.misterpemodder.shulkerboxtooltip.api.color: ShulkerBoxTooltip preview colors customization API.
com.misterpemodder.shulkerboxtooltip.api.config - package com.misterpemodder.shulkerboxtooltip.api.config: Provides a view over the mod's configuration.
com.misterpemodder.shulkerboxtooltip.api.provider - package com.misterpemodder.shulkerboxtooltip.api.provider: Providers for item previews.
com.misterpemodder.shulkerboxtooltip.api.renderer - package com.misterpemodder.shulkerboxtooltip.api.renderer: ShulkerBoxTooltip's rendering API.
COMPACT - Enum constant in enum class com.misterpemodder.shulkerboxtooltip.api.PreviewType: Compact mode: similar items are grouped together and empty slots are not shown.
config() - Method in interface com.misterpemodder.shulkerboxtooltip.api.PreviewContext: Provides access to the configuration in use for this context.
copyOf(ColorKey) - Static method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Creates a ColorKey instance from an existing one.
CYAN_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Cyan shulker box color.

D

DEFAULT - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: The default inventory color.
defaultCategory() - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorRegistry: Access to the default category.
defaultMaxRowSize() - Method in interface com.misterpemodder.shulkerboxtooltip.api.config.PreviewConfiguration: The max number of items in a preview row.
defaultRgb() - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Gets the default value of this color key.
defaultRgbComponents() - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Gets the default value of this color key.
draw(int, int, int, int, GuiGraphics, Font, int, int) - Method in interface com.misterpemodder.shulkerboxtooltip.api.renderer.PreviewRenderer: Renders the preview at the given coordinates.
draw(int, int, GuiGraphics, Font, int, int) - Method in interface com.misterpemodder.shulkerboxtooltip.api.renderer.PreviewRenderer: Deprecated, for removal: This API element is subject to removal in a future version.
Use PreviewRenderer.draw(int, int, int, int, GuiGraphics, Font, int, int) instead.

E

EmptyPreviewProvider - Class in com.misterpemodder.shulkerboxtooltip.api.provider: A PreviewProvider that does nothing.
EmptyPreviewProvider() - Constructor for class com.misterpemodder.shulkerboxtooltip.api.provider.EmptyPreviewProvider: Default constructor.
ENDER_CHEST - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Color used by ender chest previews.

F

FIRST_ITEM - Enum constant in enum class com.misterpemodder.shulkerboxtooltip.api.config.ItemStackMergingStrategy: Merge regardless of component data but use the NBT of the first item stack.
FULL - Enum constant in enum class com.misterpemodder.shulkerboxtooltip.api.PreviewType: Full mode: all stacks are shown in their respective slots, empty slots are also displayed.

G

get(ResourceLocation) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Attempts to get the corresponding preview provider associated with the given item stack.
get(Item) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Gets the associated provider for the given item.
get(ItemStack) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Gets the associated provider for the given item stack.
getCompactMaxRowSize(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider
getCompactMaxRowSize(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: The maximum number of item stacks to be displayed in a row in compact preview mode.
getCurrentPreviewType(boolean) - Static method in interface com.misterpemodder.shulkerboxtooltip.api.ShulkerBoxTooltipApi: Returns the currently requested preview type.
getDefaultRendererInstance() - Static method in interface com.misterpemodder.shulkerboxtooltip.api.renderer.PreviewRenderer: Returns the default renderer instance, corresponds the return value of either PreviewRenderer.getModRendererInstance(), or PreviewRenderer.getVanillaRendererInstance() depending on the mod's configuration.
getFullTooltipHintLangKey(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: The translation key for a hint that tells the user how to enter full preview mode.
getHeight() - Method in interface com.misterpemodder.shulkerboxtooltip.api.renderer.PreviewRenderer: Gets the pixel height of the preview window.
getId(PreviewProvider) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Attempts to get the corresponding identifier associated with the given preview provider.
getIds() - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Gets the set of all the registered identifiers.
getInstance() - Static method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Gets the preview provider registry instance.
getInventory(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider
getInventory(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.EmptyPreviewProvider
getInventory(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Fetches the items to be displayed in the preview.
getInventoryMaxSize(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider
getInventoryMaxSize(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.EmptyPreviewProvider
getInventoryMaxSize(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Returns the maximum amount of slots this preview can display.
getItemCountTooltip(List<Component>, List<ItemStack>) - Static method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider: Adds the number of items to the passed tooltip, adds 'empty' if there is no items to count.
getItemListTooltip(List<Component>, List<ItemStack>, Style) - Static method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider: Adds the number of items to the passed tooltip, adds 'empty' if there is no items to count.
getItems(PreviewProvider) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Returns the set of items the given PreviewProvider works with.
getLockKeyTooltipHintLangKey(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: The translation key for a hint that tells the user how to lock the tooltip window.
getMaxRowSize(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider
getMaxRowSize(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: The maximum number of item stacks to be displayed in a row in full preview mode.
getModRendererInstance() - Static method in interface com.misterpemodder.shulkerboxtooltip.api.renderer.PreviewRenderer: Returns the instance of ShulkerBoxTooltip's default preview renderer.
getPreviewProviderForStack(ItemStack) - Static method in interface com.misterpemodder.shulkerboxtooltip.api.ShulkerBoxTooltipApi: Attempts to get the corresponding preview provider associated with the given item stack, ignoring data-driven overrides.
getPreviewProviderForStackWithOverrides(ItemStack) - Static method in interface com.misterpemodder.shulkerboxtooltip.api.ShulkerBoxTooltipApi: Attempts to get the corresponding preview provider associated with the given item stack using data-driven overrides if available.
getPriority() - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Priority of this preview provider, relative to other providers targeting the same item.
getProviders() - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Gets the set of all registered preview providers.
getRenderer() - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Get the renderer to use for this type of preview.
getTextureOverride(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Overrides the texture used to display the preview window.
getTooltipHintLangKey(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: The translation key for a hint that tells the user how to enter compact preview mode.
getVanillaRendererInstance() - Static method in interface com.misterpemodder.shulkerboxtooltip.api.renderer.PreviewRenderer: Returns an instance of ShulkerBoxTooltip's vanilla-style preview renderer.
getWidth() - Method in interface com.misterpemodder.shulkerboxtooltip.api.renderer.PreviewRenderer: Gets the pixel width of the preview window.
getWindowColorKey(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Which color the preview window should be in?
GRAY_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Gray shulker box color.
GREEN_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Green shulker box color.

H

hasModAvailable(ServerPlayer) - Static method in interface com.misterpemodder.shulkerboxtooltip.api.ShulkerBoxTooltipApi: Checks whether the given player has ShulkerBoxTooltip installed and enabled server integration.

I

IGNORE - Enum constant in enum class com.misterpemodder.shulkerboxtooltip.api.config.ItemStackMergingStrategy: Ignore component data when merging item stacks.
INSTANCE - Static variable in class com.misterpemodder.shulkerboxtooltip.api.provider.EmptyPreviewProvider: The EmptyPreviewProvider instance.
isFullPreviewAvailable(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Returns whether this provider supports full preview mode.
isPreviewAvailable(PreviewContext) - Static method in interface com.misterpemodder.shulkerboxtooltip.api.ShulkerBoxTooltipApi: Returns whether a preview is requested (see getCurrentPreviewType(boolean)) and a preview is available for the given context.
itemStackMergingStrategy() - Method in interface com.misterpemodder.shulkerboxtooltip.api.config.PreviewConfiguration: Controls the way items with the same ID but differing components should be merged.
ItemStackMergingStrategy - Enum Class in com.misterpemodder.shulkerboxtooltip.api.config: Provides a view over the mod's configuration

K

key(String) - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorRegistry.Category: Gets a color key registered to this category with the given id, or null if not found.
keys() - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorRegistry.Category: Access the all the color keys registered to this category.
keyUnlocalizedName(ColorKey) - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorRegistry.Category: Gets the localization key of the given color key.

L

LIGHT_BLUE_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Light blue shulker box color.
LIGHT_GRAY_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Light gray shulker box color.
LIME_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Lime shulker box color.

M

MAGENTA_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Magenta shulker box color.

N

NO_PREVIEW - Enum constant in enum class com.misterpemodder.shulkerboxtooltip.api.PreviewType: Preview is not present.

O

ofRgb(float[]) - Static method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Creates a ColorKey instance from three float RGB components, each channel can have values ranging from 0 to 1 (inclusive).
ofRgb(int) - Static method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Creates a ColorKey instance from an RGB integer.
onInventoryAccessStart(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: This method should be called every time the inventory of the stack starts being accessed (i.e.
ORANGE_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Orange shulker box color.
owner() - Method in interface com.misterpemodder.shulkerboxtooltip.api.PreviewContext: Gets the player associated with this context, or null if it does not exist.

P

PINK_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Pink shulker box color.
PreviewConfiguration - Interface in com.misterpemodder.shulkerboxtooltip.api.config: A read-only view of the preview configuration.
PreviewContext - Interface in com.misterpemodder.shulkerboxtooltip.api: Provides information for item previews, such as the item stack and player that owns the stack (if present).
PreviewContext.Builder - Interface in com.misterpemodder.shulkerboxtooltip.api: A builder for creating PreviewContext instances.
PreviewProvider - Interface in com.misterpemodder.shulkerboxtooltip.api.provider: Describes preview properties for a registered set of items.
PreviewProviderRegistry - Interface in com.misterpemodder.shulkerboxtooltip.api.provider: Provides a way to register preview providers for items and a way to access them.
PreviewRenderer - Interface in com.misterpemodder.shulkerboxtooltip.api.renderer: Renders a preview using a PreviewProvider.
PreviewType - Enum Class in com.misterpemodder.shulkerboxtooltip.api: The type of preview to draw.
PURPLE_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Purple shulker box color.

R

RED_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Red shulker box color.
register(ColorKey, String) - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorRegistry.Category: Registers a color key.
register(ColorKey, String, String) - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorRegistry.Category: Registers a color key.
register(ResourceLocation, PreviewProvider, Iterable<Item>) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Registers a PreviewProvider.
register(ResourceLocation, PreviewProvider, Item...) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProviderRegistry: Registers a PreviewProvider.
registerColors(ColorRegistry) - Method in interface com.misterpemodder.shulkerboxtooltip.api.ShulkerBoxTooltipApi: Called on each entrypoint to register color keys and categories.
registerProviders(PreviewProviderRegistry) - Method in interface com.misterpemodder.shulkerboxtooltip.api.ShulkerBoxTooltipApi: Called on each entrypoint to register preview providers.
registryLookup() - Method in interface com.misterpemodder.shulkerboxtooltip.api.PreviewContext: Returns the registry lookup for this context, if available.
rgb() - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Gets the value of this color key.
rgbComponents() - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Gets the value of this color key.

S

SEPARATE - Enum constant in enum class com.misterpemodder.shulkerboxtooltip.api.config.ItemStackMergingStrategy: Do not merge stacks that differ in component data.
setPreview(PreviewContext, PreviewProvider) - Method in interface com.misterpemodder.shulkerboxtooltip.api.renderer.PreviewRenderer: Sets the preview to use for the given context.
setPreviewType(PreviewType) - Method in interface com.misterpemodder.shulkerboxtooltip.api.renderer.PreviewRenderer: Sets the preview type.
setRgb(float[]) - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Changes the color of this key using three RGB float component.
setRgb(int) - Method in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Changes the color of this key using an RGB-encoded integer.
shortItemCounts() - Method in interface com.misterpemodder.shulkerboxtooltip.api.config.PreviewConfiguration: Whether to shorten large item counts using suffixes.
shouldDisplay(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider
shouldDisplay(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.EmptyPreviewProvider
shouldDisplay(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Queries if the preview window should be displayed for the given context.
showTooltipHints(PreviewContext) - Method in class com.misterpemodder.shulkerboxtooltip.api.provider.BlockEntityPreviewProvider
showTooltipHints(PreviewContext) - Method in interface com.misterpemodder.shulkerboxtooltip.api.provider.PreviewProvider: Should hint be shown in the item's tooltip?
SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Undyed shulker box color.
ShulkerBoxTooltipApi - Interface in com.misterpemodder.shulkerboxtooltip.api: Implement this interface and use this as your entrypoint.
stack() - Method in interface com.misterpemodder.shulkerboxtooltip.api.PreviewContext: Gets the item stack associated with this context.

T

toString() - Method in enum class com.misterpemodder.shulkerboxtooltip.api.config.ItemStackMergingStrategy

U

useColors() - Method in interface com.misterpemodder.shulkerboxtooltip.api.config.PreviewConfiguration: Whether to use colors when rendering the preview decoration, when false the renderer should use the default inventory color.

V

valueOf(String) - Static method in enum class com.misterpemodder.shulkerboxtooltip.api.config.ItemStackMergingStrategy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.misterpemodder.shulkerboxtooltip.api.PreviewType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.misterpemodder.shulkerboxtooltip.api.config.ItemStackMergingStrategy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.misterpemodder.shulkerboxtooltip.api.PreviewType: Returns an array containing the constants of this enum class, in the order they are declared.

W

WHITE_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: White shulker box color.
withOwner(Player) - Method in interface com.misterpemodder.shulkerboxtooltip.api.PreviewContext.Builder: Sets the owning player of the item stack.
withRegistryLookup(HolderLookup.Provider) - Method in interface com.misterpemodder.shulkerboxtooltip.api.PreviewContext.Builder: Sets the registry lookup to use for deserialization of the item stack.

Y

YELLOW_SHULKER_BOX - Static variable in interface com.misterpemodder.shulkerboxtooltip.api.color.ColorKey: Yellow shulker box color.

A B C D E F G H I K L M N O P R S T U V W Y
All Classes and Interfaces|All Packages