[1.21] Add an Attribute formatting API for better control of attribute tooltips

[Shadows-of-Fire]

Description

This PR supplies an implementation of Apothic Attributes' IFormattibleAttribute API, which allows attributes to supply custom formatting logic for their attribute modifiers (and modifier values), as well as giving mods better control over what information is displayed when attribute modifier tooltips are added.

This PR supersedes #1371.

Features

1. Allows attributes to convert their own attribute modifiers and current values into MutableComponent(s), allowing attributes to map the raw numeric values to human-readable ones.
2. Abstracts the "Base Modifier ID" system that vanilla uses for Attack Damage and Attack Speed, allowing attributes to declare their own base modifier id which will be handled in tooltips.
3. Provides a single entrypoint for generating tooltips for attribute modifiers, which is also usable by mods that generate attribute modifiers for non-traditional slots.
4. Adds functionality to support merged attribute tooltips, which compresses multiple modifiers for a single attribute into one line.
   a. This functionality is disabled by default, and must be enabled by a mod calling NeoForgeMod.enableMergedAttributeTooltips().
5. Shows advanced debug information when F3+H is enabled to clarify the underlying modifier, regardless of customizations done by the attribute.

Examples

Images from current implementation of various modifiers:

Default Settings:

With Advanced Tooltips:

With Merged Tooltips:

With Merged Tooltips Holding Shift:

[neoforged-pr-publishing]

• Publish PR to GitHub Packages

Last commit published: ff9981d8b1511e67e5312d53cc1458df23d01862.

PR Publishing

The artifacts published by this PR:

• 📦 net.neoforged:neoforge:21.1.85-pr-1551-attr-tooltips
• 📦 net.neoforged:testframework:21.1.85-pr-1551-attr-tooltips

Repository Declaration

In order to use the artifacts published by the PR, add the following repository to your buildscript:

repositories {
    maven {
        name 'Maven for PR #1551' // https://github.com/neoforged/NeoForge/pull/1551
        url 'https://prmaven.neoforged.net/NeoForge/pr1551'
        content {
            includeModule('net.neoforged', 'neoforge')
            includeModule('net.neoforged', 'testframework')
        }
    }
}

MDK installation

In order to setup a MDK using the latest PR version, run the following commands in a terminal.
The script works on both *nix and Windows as long as you have the JDK bin folder on the path.
The script will clone the MDK in a folder named NeoForge-pr1551.
On Powershell you will need to remove the -L flag from the curl invocation.

mkdir NeoForge-pr1551
cd NeoForge-pr1551
curl -L https://prmaven.neoforged.net/NeoForge/pr1551/net/neoforged/neoforge/21.1.85-pr-1551-attr-tooltips/mdk-pr1551.zip -o mdk.zip
jar xf mdk.zip
rm mdk.zip || del mdk.zip

To test a production environment, you can download the installer from here.

[Shadows-of-Fire]

cc'ing potentially relevant mod authors for comment:
@pufmat (Pufferfish Skills)
@amoooooo (Alembic)
@Daripher (Passive Skill Tree)
@RobertSkalko (Mine & Slash)

[briarss]

cc'ing potentially relevant mod authors for comment: @pufmat (Pufferfish Skills) @amoooooo (Alembic) @Daripher (Passive Skill Tree) @RobertSkalko (Mine & Slash)

@dhyces also pulling in ratatosk, other main alembic dev

[KnightMiner]

In terms of how I use attributes, the main concern I have is the ability to conditionally suppress attributes from the tooltip. My mod has item tooltips where holding control or shift displays a different set of info, and want attributes to show in 2 out of 3 of those modes (one with full info like they normally show, one with just the stats when worn in the proper slot). I currently accomplish this using the item tooltip event to suppress tooltips based on their translation keys, though I suspect this PR would make that task much more difficult.

For my usecases, I ultimately need two things:

• The ability to conditionally disable the attributes from showing in the tooltip at all.
  • I believe the GatherSkippedAttributeTooltipsEvent would let me do this, if I just condition on my item type and the key that suppresses attributes. Mentioning this to ensure the functionality persists.
• The ability to display a subset of tooltips in my other tooltip mode
  • My current logic suppresses all slots except 1 (which is determined based on the item type) and suppresses certain attributes by UUID that I display in another form. The GatherSkippedAttributeTooltipsEvent lets me handle the latter, but I don't see a way at a glance to skip all attributes for a given equipment slot/that are not in a given equipment slot.
  • Worst case I could always entirely suppress the Neo logic then manually reimplement it in my item logic. In that case I suppose I'd need to call TooltipUtil.applyTextFor, though I'd really want to suppress the groupName logic there for my usecases. I left a comment of a possible solution there.

[Shadows-of-Fire]

The ability to conditionally disable the attributes from showing in the tooltip at all

The GatherSkippedAttributeTooltipsEvent should have you covered fully there via GatherSkippedAttributeTooltipsEvent#setSkipAll

The ability to display a subset of tooltips in my other tooltip mode

I may be able to add per-slot logic to the event, though I worry about imposing a limitation on mods supplying attributes for non-EquipmentSlot-backed attribute groups. I guess this functionality would just be unused in that case, rather than being a true limiting factor.

[RobertSkalko]

I'll skip commenting a lot here because I don't actually use vanilla attributes ever since the mod was created. My tooltips are so large I just hide the vanilla tooltip and give a keybind to not hide, to well show the vanilla tooltip without my mod replacing it.

I think this is more important for the other less overhaul-y rpg mod devs like Apotheosis.. Yeah you're the OP heh. I don't actaully know any other good rpg mods.

What my mod also does is cut blank lines in tooltip if the tooltip gets too big.. which it does, even when i cut off the entire vanilla tooltip. I think forge was missing a scrollable tooltip mod last time I checked. Just problems that happen when you have: base, implicit, prefix, suffix, corruption stats on one item.. and a few other things

I also have a system where pressing ALT, SHIFT, CTRL provide different functions to the tooltips. One makes my tooltips show stat ranges from the affix, one shows descriptions for stats, and the last one hides the tooltip and lets vanilla and mods do whatever.

That's it from me. I initially unfollowed the post but got pinged by the quote.. Not sure how helpful this will be

[lcy0x1]

I think it’s better to allow mods who need this feature to have an option to enable it from code instead of having it fully controlled by config.

For example, I have mods that need this merged tooltip to make my weapon tooltip look better. I think Apoth wants it as well.

What about making config to be a tri-state (on/default/off), while default allows mods to turn them on?

[lcy0x1]

All looks good

[pupnewfster]

Code looks good, for some reason my IDE isn't launching today and I don't feel like diagnosing it so I haven't actually tested it functions as advertised.

[Shadows-of-Fire]

I've validated all the functionality I can by porting Apothic Attributes over to the PR publish artifact - everything looks clean on my end. If someone runs into a weird edge case (which is almost certain to happen), we'll fix it when it occurs.

[neoforged-releases]

🚀 This PR has been released as NeoForge version 21.1.60.