GeyserMC/Geyser
GeyserMC
/
Geyser
mirror of https://github.com/GeyserMC/Geyser.git
4
4
Fork 3
Code Issues 103 Projects Releases Wiki Activity

Fix uppercase item attribute modifier names (#3780) 

* Check for hide attributes flag, and "Name" -> "AttributeName"

* Operation tag is not required?

* Only process each modifier once

* Ignore `minecraft:` namespace if present

* No `Operation` is implicitly ADD, fix knockback_resistance check
This commit is contained in:
Konicai 2023-05-22 12:58:01 -04:00 committed by GitHub
parent 178fb2136f
commit ba4e37075d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 125 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

200
core/src/main/java/org/geysermc/geyser/translator/inventory/item/ItemTranslator.java
View File

@ -32,12 +32,14 @@ import com.github.steveice10.opennbt.tag.builtin.*;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.format.NamedTextColor;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.cloudburstmc.nbt.NbtList;
import org.cloudburstmc.nbt.NbtMap;
import org.cloudburstmc.nbt.NbtMapBuilder;
import org.cloudburstmc.nbt.NbtType;
import org.cloudburstmc.protocol.bedrock.data.defintions.ItemDefinition;
import org.cloudburstmc.protocol.bedrock.data.inventory.ItemData;
import org.geysermc.geyser.GeyserImpl;
import org.geysermc.geyser.inventory.GeyserItemStack;
import org.geysermc.geyser.item.type.Item;
import org.geysermc.geyser.registry.BlockRegistries;
@ -54,6 +56,14 @@ import java.text.DecimalFormat;
import java.util.*;
public final class ItemTranslator {
/**
* The order of these slots is their display order on Java Edition clients
*/
private static final String[] ALL_SLOTS = new String[]{"mainhand", "offhand", "feet", "legs", "chest", "head"};
private static final DecimalFormat ATTRIBUTE_FORMAT = new DecimalFormat("0.#####");
private static final byte HIDE_ATTRIBUTES_FLAG = 1 << 1;
private ItemTranslator() {
}
@ -118,7 +128,11 @@ public final class ItemTranslator {
nbt = translateDisplayProperties(session, nbt, bedrockItem);
if (nbt != null) {
addAttributes(nbt, javaItem, session.locale());
Tag hideFlags = nbt.get("HideFlags");
if (hideFlags == null || !hasFlagPresent(hideFlags, HIDE_ATTRIBUTES_FLAG)) {
// only add if the hide attribute modifiers flag is not present
addAttributeLore(nbt, session.locale());
}
}
if (session.isAdvancedTooltips()) {
@ -149,97 +163,119 @@ public final class ItemTranslator {
return builder;
}
private static CompoundTag addAttributes(CompoundTag nbt, Item item, String language) {
ListTag modifiers = nbt.get("AttributeModifiers");
if (modifiers == null) return nbt;
CompoundTag newNbt = nbt;
if (newNbt == null) {
newNbt = new CompoundTag("nbt");
CompoundTag display = new CompoundTag("display");
display.put(new ListTag("Lore"));
newNbt.put(display);
/**
* Bedrock Edition does not see attribute modifiers like Java Edition does,
* so we add them as lore instead.
*
* @param nbt the NBT of the ItemStack
* @param language the locale of the player
*/
private static void addAttributeLore(CompoundTag nbt, String language) {
ListTag attributeModifiers = nbt.get("AttributeModifiers");
if (attributeModifiers == null) {
return; // nothing to convert to lore
}
CompoundTag compoundTag = newNbt.get("display");
if (compoundTag == null) {
compoundTag = new CompoundTag("display");
}
ListTag listTag = compoundTag.get("Lore");
if (listTag == null) {
listTag = new ListTag("Lore");
CompoundTag displayTag = nbt.get("display");
if (displayTag == null) {
displayTag = new CompoundTag("display");
}
String[] allSlots = new String[]{"mainhand", "offhand", "feet", "legs", "chest", "head"};
DecimalFormat decimalFormat = new DecimalFormat("0.#####");
Map<String, List<Tag>> slotsToModifiers = new HashMap<>();
for (String slot : allSlots) {
slotsToModifiers.put(slot, new ArrayList<>());
ListTag lore = displayTag.get("Lore");
if (lore == null) {
lore = new ListTag("Lore");
}
for (Tag modifier : modifiers) {
Map<String, Tag> modifierValue = (Map) modifier.getValue();
String[] slots = allSlots;
if (modifierValue.get("Slot") != null) {
slots = new String[]{(String) modifierValue.get("Slot").getValue()};
// maps each slot to the modifiers applied when in such slot
Map<String, List<StringTag>> slotsToModifiers = new HashMap<>();
for (Tag modifier : attributeModifiers) {
CompoundTag modifierTag = (CompoundTag) modifier;
// convert the modifier tag to a lore entry
String loreEntry = attributeToLore(modifierTag, language);
if (loreEntry == null) {
continue; // invalid or failed
}
for (String slot : slots) {
List<Tag> list = slotsToModifiers.get(slot);
list.add(modifier);
slotsToModifiers.put(slot, list);
StringTag loreTag = new StringTag("", loreEntry);
StringTag slotTag = modifierTag.get("Slot");
if (slotTag == null) {
// modifier applies to all slots implicitly
for (String slot : ALL_SLOTS) {
slotsToModifiers.computeIfAbsent(slot, s -> new ArrayList<>()).add(loreTag);
}
} else {
// modifier applies to only the specified slot
slotsToModifiers.computeIfAbsent(slotTag.getValue(), s -> new ArrayList<>()).add(loreTag);
}
}
for (String slot : allSlots) {
List<Tag> modifiersList = slotsToModifiers.get(slot);
if (modifiersList.isEmpty()) continue;
// iterate through the small array, not the map, so that ordering matches Java Edition
for (String slot : ALL_SLOTS) {
List<StringTag> modifiers = slotsToModifiers.get(slot);
if (modifiers == null || modifiers.isEmpty()) {
continue;
}
// Declare the slot, e.g. "When in Main Hand"
Component slotComponent = Component.text()
.resetStyle()
.color(NamedTextColor.GRAY)
.append(Component.newline(), Component.translatable("item.modifiers." + slot))
.build();
listTag.add(new StringTag("", MessageTranslator.convertMessage(slotComponent, language)));
lore.add(new StringTag("", MessageTranslator.convertMessage(slotComponent, language)));
for (Tag modifier : modifiersList) {
Map<String, Tag> modifierValue = (Map) modifier.getValue();
double amount;
if (modifierValue.get("Amount") instanceof IntTag intTag) {
amount = (double) intTag.getValue();
} else if (modifierValue.get("Amount") instanceof DoubleTag doubleTag) {
amount = doubleTag.getValue();
} else {
continue;
}
if (amount == 0) {
continue;
}
ModifierOperation operation = ModifierOperation.from((int) modifierValue.get("Operation").getValue());
String operationTotal;
if (operation == ModifierOperation.ADD) {
if (modifierValue.get("Name").equals("knockback_resistance")) {
amount *= 10;
}
operationTotal = decimalFormat.format(amount);
} else if (operation == ModifierOperation.ADD_MULTIPLIED || operation == ModifierOperation.MULTIPLY) {
operationTotal = decimalFormat.format(amount * 100) + "%";
} else {
continue;
}
if (amount > 0) {
operationTotal = "+" + operationTotal;
}
Component attributeComponent = Component.text()
.resetStyle()
.color(amount > 0 ? NamedTextColor.BLUE : NamedTextColor.RED)
.append(Component.text(operationTotal), Component.text(" "), Component.translatable("attribute.name." + modifierValue.get("Name").getValue()))
.build();
listTag.add(new StringTag("", MessageTranslator.convertMessage(attributeComponent, language)));
// Then list all the modifiers when used in this slot
for (StringTag modifier : modifiers) {
lore.add(modifier);
}
}
compoundTag.put(listTag);
newNbt.put(compoundTag);
return newNbt;
displayTag.put(lore);
nbt.put(displayTag);
}
@Nullable
private static String attributeToLore(CompoundTag modifier, String language) {
Tag amountTag = modifier.get("Amount");
if (amountTag == null || !(amountTag.getValue() instanceof Number number)) {
return null;
}
double amount = number.doubleValue();
if (amount == 0) {
return null;
}
if (!(modifier.get("AttributeName") instanceof StringTag nameTag)) {
return null;
}
String name = nameTag.getValue().replace("minecraft:", "");
// the namespace does not need to be present, but if it is, the java client ignores it
String operationTotal;
Tag operationTag = modifier.get("Operation");
ModifierOperation operation;
if (operationTag == null || (operation = ModifierOperation.from((int) operationTag.getValue())) == ModifierOperation.ADD) {
if (name.equals("generic.knockback_resistance")) {
amount *= 10;
}
operationTotal = ATTRIBUTE_FORMAT.format(amount);
} else if (operation == ModifierOperation.ADD_MULTIPLIED || operation == ModifierOperation.MULTIPLY) {
operationTotal = ATTRIBUTE_FORMAT.format(amount * 100) + "%";
} else {
GeyserImpl.getInstance().getLogger().warning("Unhandled ModifierOperation while adding item attributes: " + operation);
return null;
}
if (amount > 0) {
operationTotal = "+" + operationTotal;
}
Component attributeComponent = Component.text()
.resetStyle()
.color(amount > 0 ? NamedTextColor.BLUE : NamedTextColor.RED)
.append(Component.text(operationTotal + " "), Component.translatable("attribute.name." + name))
.build();
return MessageTranslator.convertMessage(attributeComponent, language);
}
private static CompoundTag addAdvancedTooltips(CompoundTag nbt, Item item, String language) {
@ -519,4 +555,18 @@ public final class ItemTranslator {
builder.definition(definition);
}
}
/**
* Checks if the NBT of a Java item stack has the given hide flag.
*
* @param hideFlags the "HideFlags", which may not be null
* @param flagMask the flag to check for, as a bit mask
* @return true if the flag is present, false if not or if the tag value is not a number
*/
private static boolean hasFlagPresent(Tag hideFlags, byte flagMask) {
if (hideFlags.getValue() instanceof Number flags) {
return (flags.byteValue() & flagMask) == flagMask;
}
return false;
}
}