TooltipDataCallback to allow modders add their own tooltips to existing items #3403
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Juuxel
suggested changes
Nov 6, 2023
...ring-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/TooltipDataCallback.java
Show resolved
Hide resolved
...ring-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/TooltipDataCallback.java
Outdated
Show resolved
Hide resolved
...src/client/java/net/fabricmc/fabric/impl/client/rendering/tooltip/MultiTooltipComponent.java
Outdated
Show resolved
Hide resolved
...src/client/java/net/fabricmc/fabric/impl/client/rendering/tooltip/MultiTooltipComponent.java
Show resolved
Hide resolved
...src/client/java/net/fabricmc/fabric/impl/client/rendering/tooltip/MultiTooltipComponent.java
Outdated
Show resolved
Hide resolved
...dering-v1/src/client/java/net/fabricmc/fabric/mixin/client/rendering/HandledScreenMixin.java
Outdated
Show resolved
Hide resolved
...g-v1/src/client/java/net/fabricmc/fabric/impl/client/rendering/tooltip/MultiTooltipData.java
Outdated
Show resolved
Hide resolved
...v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/TooltipComponentCallback.java
Outdated
Show resolved
Hide resolved
...ring-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/TooltipDataCallback.java
Outdated
Show resolved
Hide resolved
...dering-v1/src/client/java/net/fabricmc/fabric/mixin/client/rendering/HandledScreenMixin.java
Show resolved
Hide resolved
Juuxel
added
the
priority:low
…ient/rendering/v1/TooltipComponentCallback.java Co-authored-by: Juuz <6596629+Juuxel@users.noreply.github.com>
…ient/rendering/v1/TooltipDataCallback.java Co-authored-by: Juuz <6596629+Juuxel@users.noreply.github.com>
It happened when only one tooltip data is added by event handlers I for some reason assumed that there is always original data in item
Juuxel
reviewed
Nov 6, 2023
...dering-v1/src/client/java/net/fabricmc/fabric/mixin/client/rendering/HandledScreenMixin.java
Outdated
Show resolved
Hide resolved
…client/rendering/HandledScreenMixin.java Co-authored-by: Juuz <6596629+Juuxel@users.noreply.github.com>
modmuss50
approved these changes
Dec 27, 2023
LlamaLad7
reviewed
Dec 27, 2023
|
|
||
| @Mixin(HandledScreen.class) | ||
| class HandledScreenMixin { | ||
| @Redirect(method = "drawMouseoverTooltip", at = @At(value = "INVOKE", target = "Lnet/minecraft/item/ItemStack;getTooltipData()Ljava/util/Optional;")) |
There was a problem hiding this comment.
Mixin extras avaliable only on loader 0.15+, this version is 0.14 compatible
Changing it for one small feature doesn't make much sense (for me)
Here is ME version for 1.20.4 #3486
Juuxel
approved these changes
Dec 29, 2023
modmuss50
reviewed
Jan 5, 2024
Comment on lines
+42
to
+44
| if (multiData.tooltipData().isEmpty()) { | ||
| return original; | ||
| } |
There was a problem hiding this comment.
Do we expect people to be allowed to remove the original?
| @Redirect(method = "drawMouseoverTooltip", at = @At(value = "INVOKE", target = "Lnet/minecraft/item/ItemStack;getTooltipData()Ljava/util/Optional;")) | ||
| Optional<TooltipData> addMultiData(ItemStack stack) { | ||
| Optional<TooltipData> original = stack.getTooltipData(); | ||
| var multiData = new MultiTooltipData(new ArrayList<>()); |
There was a problem hiding this comment.
Nit: No need to create MultiTooltipData here, just start with the list, and then create it later if the list > 1
| import net.fabricmc.api.ClientModInitializer; | ||
| import net.fabricmc.fabric.api.client.rendering.v1.TooltipComponentCallback; | ||
|
|
||
| public class MultiTooltipComponentRegister implements ClientModInitializer { |
There was a problem hiding this comment.
MultiTooltipComponentInitializer maybe, this class name is a little weird.
|
Remvoed from last call, there are breaking changes between the two PRs, it might just be best to have one and make sure that all the behaviour is tested/defined. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I recently was developing feature that added "sell" and "purchase" tooltips for blocks with that functionality. The problem is that these toolips were added by different mods, one for selling, one for purchasing. And to make these mods compatible i had to develop small separate library, and package it to both mods. And i haven't even tested compatibility with other mods that may change tooltips.
The only tooltip related events I found are for adding text lines to tooltip and registering tooltip component.
So I propose new event the Fabric API - TooltipDataCallback(ItemStack, List).
Also i added three example mods to showcase what this can add (Fabric discord message link)