Class TranslationUtils
-
- All Implemented Interfaces:
public class TranslationUtils
-
-
Constructor Summary
Constructors Constructor Description TranslationUtils()
-
Method Summary
Modifier and Type Method Description static String
getDisplayOrTranslationName(@NonNull() ItemStack itemStack)
根据物品获取显示名, 无显示名则返回翻译名. static BaseComponent
getDisplayOrTranslationComponent(@NonNull() ItemStack itemStack)
根据物品获取显示名, 无显示名则返回翻译键. static String
getDisplayName(@NonNull() ItemStack itemStack)
根据物品获取显示名, 无显示名则返回 null. static String
getDisplayNameFromCraftItemStack(@Nullable() ItemStack itemStack)
根据CraftItemStack获取显示名, 无显示名或物品为org.bukkit.inventory.ItemStack则返回 null, 仅适用于1.20.4及以下版本. static String
toLegacyText(@NonNull() String json)
将高版本json文本转化为传统文本(1.12.2不进行转换). static String
toJsonText(@NonNull() String json)
将传统文本转化为高版本json文本(1.12.2-1.16.4不进行转换). static String
fromJSONComponent(@Nullable() String jsonMessage)
适用于1.16.5+版本, 将高版本json文本转化为传统文本. static String
fromStringToJSON(String message)
适用于1.16.5+版本, 将传统文本转化为高版本json文本. static String
fromStringToJSON(String message, boolean keepNewlines)
适用于1.16.5+版本, 将传统文本转化为高版本json文本. static boolean
hasDisplayName(@NonNull() ItemStack itemStack)
检测物品是否包含自定义显示名. static String
getTranslationName(@NonNull() ItemStack itemStack)
根据物品获取翻译名. static BaseComponent
getTranslationComponent(@NonNull() ItemStack itemStack)
根据物品获取包含翻译键的 BaseComponent. static String
getDisplayOrTranslationName(@NonNull() Entity entity)
根据实体获取显示名, 无显示名则返回翻译名. static BaseComponent
getDisplayOrTranslationComponent(@NonNull() Entity entity)
根据实体获取显示名, 无显示名则返回翻译键. static String
getTranslationName(@NonNull() Entity entity)
根据实体获取翻译名. static BaseComponent
getTranslationComponent(@NonNull() Entity entity)
根据实体获取翻译键. static String
getDescriptionId(@NonNull() Entity entity)
根据实体获取对应的 DescriptionId. static String
getDescriptionId(@NonNull() Material material)
根据材质获取对应的 DescriptionId. -
-
Method Detail
-
getDisplayOrTranslationName
@NonNull() static String getDisplayOrTranslationName(@NonNull() ItemStack itemStack)
根据物品获取显示名, 无显示名则返回翻译名.
- Parameters:
itemStack
- 待获取物品.- Returns:
显示名或翻译名.
-
getDisplayOrTranslationComponent
@NonNull() static BaseComponent getDisplayOrTranslationComponent(@NonNull() ItemStack itemStack)
根据物品获取显示名, 无显示名则返回翻译键.
- Parameters:
itemStack
- 待获取物品.- Returns:
显示名或翻译键.
-
getDisplayName
@Nullable() static String getDisplayName(@NonNull() ItemStack itemStack)
根据物品获取显示名, 无显示名则返回 null.
- Parameters:
itemStack
- 待获取物品.- Returns:
显示名.
-
getDisplayNameFromCraftItemStack
@Nullable() static String getDisplayNameFromCraftItemStack(@Nullable() ItemStack itemStack)
根据CraftItemStack获取显示名, 无显示名或物品为org.bukkit.inventory.ItemStack则返回 null, 仅适用于1.20.4及以下版本.
- Parameters:
itemStack
- 待获取物品.- Returns:
显示名.
-
toLegacyText
@NonNull() static String toLegacyText(@NonNull() String json)
将高版本json文本转化为传统文本(1.12.2不进行转换).
- Parameters:
json
- 待转换json.- Returns:
传统文本.
-
toJsonText
@NonNull() static String toJsonText(@NonNull() String json)
将传统文本转化为高版本json文本(1.12.2-1.16.4不进行转换).
- Parameters:
json
- 待转换json.- Returns:
传统文本.
-
fromJSONComponent
@Nullable() static String fromJSONComponent(@Nullable() String jsonMessage)
适用于1.16.5+版本, 将高版本json文本转化为传统文本.
- Parameters:
jsonMessage
- 待转换json.- Returns:
传统文本.
-
fromStringToJSON
static String fromStringToJSON(String message)
适用于1.16.5+版本, 将传统文本转化为高版本json文本. keepNewlines 默认为 false.
- Parameters:
message
- 待转换传统文本.- Returns:
传统文本.
-
fromStringToJSON
static String fromStringToJSON(String message, boolean keepNewlines)
适用于1.16.5+版本, 将传统文本转化为高版本json文本.
- Parameters:
message
- 待转换传统文本.keepNewlines
- 此选项为 true 时, 将把文本中的换行符转化为 \n 文本, 为 false 时, 将于换行符处直接断开停止识别.- Returns:
传统文本.
-
hasDisplayName
static boolean hasDisplayName(@NonNull() ItemStack itemStack)
检测物品是否包含自定义显示名.
- Parameters:
itemStack
- 待检测物品.- Returns:
是否包含自定义显示名.
-
getTranslationName
@NonNull() static String getTranslationName(@NonNull() ItemStack itemStack)
根据物品获取翻译名.
- Parameters:
itemStack
- 待获取物品.- Returns:
翻译名.
-
getTranslationComponent
@NonNull() static BaseComponent getTranslationComponent(@NonNull() ItemStack itemStack)
根据物品获取包含翻译键的 BaseComponent.
- Parameters:
itemStack
- 待获取物品.- Returns:
包含翻译键的 BaseComponent.
-
getDisplayOrTranslationName
@NonNull() static String getDisplayOrTranslationName(@NonNull() Entity entity)
根据实体获取显示名, 无显示名则返回翻译名.
- Parameters:
entity
- 待获取实体.- Returns:
显示名或翻译名.
-
getDisplayOrTranslationComponent
@NonNull() static BaseComponent getDisplayOrTranslationComponent(@NonNull() Entity entity)
根据实体获取显示名, 无显示名则返回翻译键.
- Parameters:
entity
- 待获取实体.- Returns:
显示名或翻译键.
-
getTranslationName
@NonNull() static String getTranslationName(@NonNull() Entity entity)
根据实体获取翻译名.
- Parameters:
entity
- 待获取实体.- Returns:
翻译名.
-
getTranslationComponent
@NonNull() static BaseComponent getTranslationComponent(@NonNull() Entity entity)
根据实体获取翻译键.
- Parameters:
entity
- 待获取实体.- Returns:
翻译键.
-
getDescriptionId
@Nullable() static String getDescriptionId(@NonNull() Entity entity)
根据实体获取对应的 DescriptionId.
- Parameters:
entity
- 待检测实体.- Returns:
DescriptionId.
-
getDescriptionId
@Nullable() static String getDescriptionId(@NonNull() Material material)
根据材质获取对应的 DescriptionId. DescriptionId 与 "翻译键" 有很大的差别, 二者概念不可随意混淆.
- Parameters:
material
- 待检测材质.- Returns:
DescriptionId.
-
-
-
-