物品提示信息

物品提示信息

为耐久度、属性、物品/附魔描述提供高度可配置的提示框,并支持完整的提示框换行功能。

物品提示框

物品提示框(Item Tooltips)的目标,是成为满足玩家、整合包及模组开发者常见提示框需求的最全面解决方案。因此,本模组包含了多种多样的新提示框功能——从耐久度,到属性,到自定义物品描述,再到附魔描述等等。物品提示框高度重视可配置性,允许您通过自定义颜色、文本样式等方式,轻松为每项功能创建自定义视觉风格,其灵活程度往往是其他项目所不能及的,且每项功能均可单独调整。

哦,对了,我们还提供了可配置的文本换行功能,以配合上述各项功能。

耐久度与属性提示框

耐久度提示框

物品提示框提供了简单易配置的耐久度提示框,它会根据您选择的配置样式,显示当前耐久度和最大耐久度。提示框的颜色可以随意更改,而耐久度数字本身的颜色则直接取自原版耐久度条,以保持一致性。

挖掘速度

默认情况下,工具会额外显示一个绿色的挖掘速度属性提示框,与原版已有的攻击伤害和攻击速度提示框风格一致。虽然我们能够过滤掉大多数不应显示该提示框的物品,但还额外提供了一个物品标签(#item_tooltips:hidden_mining_speed),可用于将指定物品加入黑名单,禁止其显示挖掘速度。

物品描述

示例

添加物品描述

只需将您想要添加描述的任何方块/物品加入#item_tooltips:has_description标签即可。与其他现有的附魔描述模组一样,翻译键只需在原始物品名称末尾添加“.desc”即可。

例如,如果不死图腾被加入了#item_tooltips:has_description标签,其描述翻译键将是item.minecraft.totem_of_undying.desc。

需要注意的是,如果没有整合包或模组开发者自行使用,此功能本身不会生效——上面的GIF只是一个示例。

黑名单物品描述

任何被添加到#item_tooltips:util/description_blacklist物品标签中的物品,无论其他标签如何,都将被排除在拥有描述之外。这对整合包开发者尤其有用。

移除Shift提示

任何被添加到#item_tooltips:util/no_shift_notice物品标签中的物品,无论模组配置如何,都不会显示Shift按住提示。这对于为那些已被其他模组添加了Shift提示的物品添加提示框特别有用。

关于描述配置选项的详细信息,请参见下文。

在整合包中使用

物品提示框可以作为一个方便的实用模组用于整合包开发。只需将任何您想要的物品添加到标签中,编写翻译文本,就大功告成了!为此,我建议使用诸如简单资源加载器之类的模组来加载您的自定义数据/资源。

可以在此处找到示例数据包和资源包格式。

附魔描述

附魔描述

模组自带所有原版附魔的描述,并使用通用的enchantment.namespace.item_name.desc语言键,这意味着许多模组附魔也能开箱即用地显示描述。

与许多其他附魔描述模组不同,物品提示框会同时在物品提示框和附魔台界面中应用其提示框。

与本项目的所有其他模块一样,附魔描述也是完全可配置的,包括颜色、前缀等等。

文本换行

物品提示框添加了文本换行功能(移植自自适应提示框 / 更好的提示框),当文本过长时,会自动将描述移至下一行。

关于提示框配置选项的详细信息,请参见下文。

配置

物品提示框的配置文件位于config/item_tooltips.json5。

如果在Fabric上安装了模组菜单,您也可以在游戏内编辑配置文件。

物品

enum DurabilityTooltip {
  ALWAYS, // 始终显示提示框
  DAMAGED, // 仅在物品未满耐久时显示提示框
  HOLD_KEY, // 仅在按住指定按键时显示提示框
  NONE // 完全禁用此功能
}

durability.durability_tooltip - 默认为ALWAYS。根据DurabilityTooltip枚举,决定耐久度应如何显示。

durability.max_durability_tooltip - 默认为DAMAGED。根据DurabilityTooltip枚举,决定最大耐久度应如何显示。

durability.division_text - 默认为/。设置在当前与最大耐久度之间显示的文本。

durability.color - 默认为11184810。设置耐久度提示框使用的颜色——唯一例外是当前耐久度数字,它使用耐久度条的颜色。

mining_speed_tooltip - 是否显示挖掘速度提示框。其风格与原版的攻击伤害和攻击速度提示框相同。默认为true。

描述

add_descriptions - 默认为true。决定是否为打了标签的方块/物品添加物品描述。如果您只想要文本换行功能,可以禁用它。

require_key_hold - 默认为true。指明是否必须按住设置的按键才能显示物品描述。

key_hold_notice - 默认为true。指明对于带有描述的物品,是否显示一个提示玩家按住Shift键的提示框。

color - 显示提示框的小数颜色值。默认值为5592405。

prefix.text - 默认为空。此字符串的内容将添加在任何描述之前,例如,可以用它来为所有物品描述添加缩进或加号。

prefix.align_wrapped_text - 默认为true。指明换行的文本行是否应与设置的前缀对齐。

prefix.color - 显示提示框前缀的小数颜色值。默认值为13027014。

如果您需要帮助选择颜色,可以在此处找到一个好用的十六进制转十进制转换器。

附魔

enchantment_descriptions - 默认为true。决定是否为所有附魔物品添加附魔描述。

enchanting_table_descriptions - 默认为true。决定是否在附魔台界面中为附魔添加描述。这些描述无论玩家是否按住Shift键都会显示,且不受auto_disable选项的影响。

auto_disable - 默认为true。决定如果检测到另一个添加附魔描述的模组,是否应自动禁用物品的附魔描述。

require_key_hold - 默认为true。指明是否必须按住设置的按键才能显示附魔描述。

key_hold_notice - 默认为true。指明对于附魔物品,是否显示一个提示玩家按住Shift键的提示框。

color - 显示附魔提示框的小数颜色值。默认值为5592405。

prefix.text - 默认为一个简单的" "。此字符串的内容将添加在所有附魔描述之前。

prefix.align_wrapped_text - 默认为true。指明换行的文本行是否应与设置的前缀对齐。

prefix.color - 显示附魔提示框前缀的小数颜色值。默认值为13027014。

如果您需要帮助选择颜色,可以在此处找到一个好用的十六进制转十进制转换器。

提示框

required_key - 默认为SHIFT。决定必须按住哪个按键才能显示相关提示框。可以是SHIFT、ALT或CTRL。

wrap_text - 默认为true。是否应进行文本换行。如果您有其他模组处理文本换行,可以禁用此功能。

retain_empty_space - 是否应用一个修复程序以强制原版提示框空间不消失。默认为true。

length - 一个静态数值,决定提示框在换行前的最大长度。禁用时,换行完全依赖于长度上限。默认为-1。

length_cap - 提示框在换行前将覆盖游戏窗口的百分比长度。这也用于限制静态长度配置值,防止其过长。默认为50。

在模组中依赖

您可以在自己的项目中对物品提示框进行依赖/集成。请确保在您的gradle.properties中修改正确的版本号和模组加载器。

build.gradle

repositories {
    maven { url = "https://api.modrinth.com/maven" }
}
dependencies {
    modImplementation("maven.modrinth:item-tooltips:$tooltips_version")
}

gradle.properties

tooltips_version=26.1-r2.0-fabric