Skip to content

Add Block Support to CustomTooltipProvider #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
calmilamsy merged 2 commits into from
Jun 1, 2025
Merged

Add Block Support to CustomTooltipProvider #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e5b8e9
Add Block support to CustomTooltipProvider
calmilamsy Apr 22, 2025
83437cc
Add some documentation to the interface
calmilamsy Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion ...n-items-v0/src/main/java/net/modificationstation/stationapi/api/client/TooltipHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import net.minecraft.client.gui.screen.ingame.HandledScreen;
import net.minecraft.entity.player.PlayerInventory;
import net.minecraft.item.BlockItem;
import net.minecraft.item.ItemStack;
import net.modificationstation.stationapi.api.StationAPI;
import net.modificationstation.stationapi.api.client.event.gui.screen.container.TooltipBuildEvent;
Expand All @@ -16,8 +17,16 @@ public class TooltipHelper {
*/
public static ArrayList<String> getTooltipForItemStack(String originalTooltip, ItemStack itemStack, PlayerInventory playerInventory, HandledScreen container) {
ArrayList<String> newTooltip;
CustomTooltipProvider provider = null;

if (itemStack.getItem() instanceof CustomTooltipProvider provider) {
if (itemStack.getItem() instanceof CustomTooltipProvider itemProvider) {
provider = itemProvider;
}
else if (itemStack.getItem() instanceof BlockItem blockItem && blockItem.getBlock() instanceof CustomTooltipProvider blockProvider) {
provider = blockProvider;
}

if (provider != null) {
newTooltip = new ArrayList<>(Arrays.asList(provider.getTooltip(itemStack, originalTooltip)));
}
else {
Expand Down
11 changes: 10 additions & 1 deletion ...c/main/java/net/modificationstation/stationapi/api/client/item/CustomTooltipProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
package net.modificationstation.stationapi.api.client.item;

import net.minecraft.item.ItemStack;
import org.jetbrains.annotations.NotNull;

/**
* Can be implemented on Items, BlockItems and Blocks.
* BlockItems take precedence over Blocks if both have this implemented.
*/
public interface CustomTooltipProvider {
String[] getTooltip(ItemStack stack, String originalTooltip);

/**
* @return An array of Strings, each new array entry is a new line. Supports formatting codes.
*/
@NotNull String[] getTooltip(ItemStack stack, String originalTooltip);
}