Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
package com.denizenscript.denizen.paper.properties;

import com.denizenscript.denizen.nms.NMSHandler;
import com.denizenscript.denizen.nms.NMSVersion;
import com.denizenscript.denizen.objects.ItemTag;
import com.denizenscript.denizencore.objects.core.ElementTag;

public class PaperItemExtensions {

public static void register() {

// <--[tag]
// @attribute <ItemTag.rarity>
// @returns ElementTag
// @group paper
// @Plugin Paper
// @description
// Returns the rarity of an item, as "common", "uncommon", "rare", or "epic".
// -->
ItemTag.tagProcessor.registerTag(ElementTag.class, "rarity", (attribute, item) -> {
return new ElementTag(item.getItemStack().getRarity());
});
if (NMSHandler.getVersion().isAtMost(NMSVersion.v1_19)) {
ItemTag.tagProcessor.registerTag(ElementTag.class, "rarity", (attribute, item) -> {
return new ElementTag(item.getItemStack().getRarity());
});
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,9 @@ public static void registerMainProperties() {
registerItemProperty(ItemFireworkPower.class, "fireworks");
registerItemProperty(ItemFirework.class, "fireworks", "firework_explosion");
PropertyParser.registerProperty(ItemFlags.class, ItemTag.class);
if (NMSHandler.getVersion().isAtLeast(NMSVersion.v1_20)) {
registerItemProperty(ItemFood.class, "food");
}
PropertyParser.registerProperty(ItemFrameInvisible.class, ItemTag.class); // Special case handling in ItemComponentsPatch
PropertyParser.registerProperty(ItemHidden.class, ItemTag.class); // Relevant components control their own hiding internally
if (NMSHandler.getVersion().isAtLeast(NMSVersion.v1_19)) {
Expand All @@ -251,10 +254,18 @@ public static void registerMainProperties() {
registerItemProperty(ItemLodestoneTracked.class, "lodestone_tracker");
registerItemProperty(ItemLore.class, "lore");
registerItemProperty(ItemMap.class, "map_id");
if (NMSHandler.getVersion().isAtLeast(NMSVersion.v1_20)) {
registerItemProperty(ItemMaxDurability.class, "max_damage");
registerItemProperty(ItemMaxStackSize.class, "max_stack_size");
registerItemProperty(ItemModel.class, "item_model");
}
PropertyParser.registerProperty(ItemNBT.class, ItemTag.class);
registerItemProperty(ItemPatterns.class, "banner_patterns");
registerItemProperty(ItemPotion.class, "potion_contents");
PropertyParser.registerProperty(ItemQuantity.class, ItemTag.class);
if (NMSHandler.getVersion().isAtLeast(NMSVersion.v1_20)) {
registerItemProperty(ItemRarity.class, "rarity");
}
PropertyParser.registerProperty(ItemRawNBT.class, ItemTag.class);
registerItemProperty(ItemRepairCost.class, "repair_cost");
PropertyParser.registerProperty(ItemScript.class, ItemTag.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public static ItemDurability getFrom(ObjectTag _item) {
}

public static final String[] handledTags = new String[] {
"durability", "max_durability"
"durability"
};

public static final String[] handledMechs = new String[] {
Expand Down Expand Up @@ -58,19 +58,6 @@ public ObjectTag getObjectAttribute(Attribute attribute) {
.getObjectAttribute(attribute.fulfill(1));
}

// <--[tag]
// @attribute <ItemTag.max_durability>
// @returns ElementTag(Number)
// @group properties
// @description
// Returns the maximum durability (number of uses) of this item.
// For use with <@link tag ItemTag.durability> and <@link mechanism ItemTag.durability>.
// -->
if (attribute.startsWith("max_durability")) {
return new ElementTag(item.getMaterial().getMaterial().getMaxDurability())
.getObjectAttribute(attribute.fulfill(1));
}
Comment on lines -69 to -72
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this properly backsupported? from what I can see it's completely removed from here and the new property is 1.20+


return null;
}

Expand Down Expand Up @@ -101,7 +88,6 @@ public void adjust(Mechanism mechanism) {
// Changes the durability of damageable items.
// @tags
// <ItemTag.durability>
// <ItemTag.max_durability>
// <ItemTag.repairable>
// -->
if (mechanism.matches("durability") && mechanism.requireInteger()) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package com.denizenscript.denizen.objects.properties.item;

import com.denizenscript.denizen.objects.ItemTag;
import com.denizenscript.denizencore.objects.Mechanism;
import com.denizenscript.denizencore.objects.core.ElementTag;
import com.denizenscript.denizencore.objects.core.MapTag;
import org.bukkit.Material;
import org.bukkit.inventory.meta.ItemMeta;
import org.bukkit.inventory.meta.components.FoodComponent;

public class ItemFood extends ItemProperty<MapTag> {

// <--[property]
// @object ItemTag
// @name food
// @input MapTag
// @description
// Controls the food properties of the item.
// A food item has the 'nutrition', 'saturation', and 'can_always_eat' properties.
// The 'nutrition' is the amount of hunger points the food restores.
// The 'saturation' is the amount of saturation points the food restores.
// The 'can_always_eat' is a boolean indicating if the food can be eaten even when the player is not hungry.
// -->

public static boolean describes(ItemTag item) {
return item.getBukkitMaterial() != Material.AIR;
}

@Override
public MapTag getPropertyValue() {
if (getItemMeta().hasFood()) {
FoodComponent food = getItemMeta().getFood();
MapTag map = new MapTag();
map.putObject("nutrition", new ElementTag(food.getNutrition()));
map.putObject("saturation", new ElementTag(food.getSaturation()));
map.putObject("can_always_eat", new ElementTag(food.canAlwaysEat()));
return map;
}
return null;
}

@Override
public void setPropertyValue(MapTag map, Mechanism mechanism) {
FoodComponent food = getItemMeta().getFood();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this probably could be moved in the lamba and called from the lambda parameter (meta.getFood())

editMeta(ItemMeta.class, meta -> {
if (map.getElement("nutrition") != null) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should probably be Map#containsKey

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or alternatively

Object value = map.get(key);
if (value != null) {
    thing.set(value)
}

Comment on lines +43 to +46
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The property is registered with autoRegisterNullable, which means map can be null here (and should be handled by removing the food component)

food.setNutrition(map.getElement("nutrition").asInt());
}
if (map.getElement("saturation") != null) {
food.setSaturation(map.getElement("saturation").asFloat());
}
if (map.getElement("can_always_eat") != null) {
food.setCanAlwaysEat(map.getElement("can_always_eat").asBoolean());
}
meta.setFood(food);
});
}

@Override
public String getPropertyId() {
return "food";
}

public static void register() {
autoRegisterNullable("food", ItemFood.class, MapTag.class, false);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
package com.denizenscript.denizen.objects.properties.item;

import com.denizenscript.denizen.objects.ItemTag;
import com.denizenscript.denizencore.objects.Mechanism;
import com.denizenscript.denizencore.objects.core.ElementTag;
import org.bukkit.Material;
import org.bukkit.inventory.meta.Damageable;
import org.bukkit.inventory.meta.ItemMeta;

public class ItemMaxDurability extends ItemProperty<ElementTag> {

// <--[property]
// @object ItemTag
// @name max_durability
// @input ElementTag
// @description
// Controls the maximum durability of an item, if it can have durability.
// If the item cannot have durability (e.g. is not a tool or armor), this will return null.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is necessarily the case? with item components you should be able to give any item durability (also true for other properties here, the point of item components is that you can kinda give any item any component).

// If the item does not have a max durability item component set, this will return the default max durability for the item type.
// -->
Comment on lines +19 to +20
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is specific to the tag, and should be under @tag


public static boolean describes(ItemTag item) {
return item.getBukkitMaterial() != Material.AIR
&& item.getItemMeta() instanceof Damageable;
}

@Override
public ElementTag getPropertyValue() {
if (getItemMeta() instanceof Damageable damageable) {
if (damageable.hasMaxDamage()) {
return new ElementTag(damageable.getMaxDamage());
}
else {
return new ElementTag(getItemStack().getType().getMaxDurability());
}
}
return null;
}

@Override
public void setPropertyValue(ElementTag element, Mechanism mechanism) {
editMeta(ItemMeta.class, meta -> {
Comment on lines +41 to +42
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, needs to handle null

if (meta instanceof Damageable damageable) {
if (element == null) {
damageable.setMaxDamage((int) getItemStack().getType().getMaxDurability());
}
if (mechanism.requireInteger()) {
damageable.setMaxDamage(element.asInt());
}
}
});
}

@Override
public String getPropertyId() {
return "max_durability";
}

public static void register() {
autoRegisterNullable("max_durability", ItemMaxDurability.class, ElementTag.class, false);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package com.denizenscript.denizen.objects.properties.item;

import com.denizenscript.denizen.objects.ItemTag;
import com.denizenscript.denizencore.objects.Mechanism;
import com.denizenscript.denizencore.objects.core.ElementTag;
import org.bukkit.Material;
import org.bukkit.inventory.meta.ItemMeta;

public class ItemMaxStackSize extends ItemProperty<ElementTag> {

// <--[property]
// @object ItemTag
// @name max_stack_size
// @input ElementTag
// @description
// Controls the maximum stack size of the item.
// -->

public static boolean describes(ItemTag item) {
return item.getBukkitMaterial() != Material.AIR;
}

@Override
public ElementTag getPropertyValue() {
if (getItemMeta().hasMaxStackSize()) {
return new ElementTag(getItemMeta().getMaxStackSize());
}
return null;
}

@Override
public void setPropertyValue(ElementTag element, Mechanism mechanism) {
editMeta(ItemMeta.class, meta -> meta.setMaxStackSize(element.asInt()));
}

@Override
public String getPropertyId() {
return "max_stack_size";
}

public static void register() {
autoRegisterNullable("max_stack_size", ItemMaxStackSize.class, ElementTag.class, false);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package com.denizenscript.denizen.objects.properties.item;

import com.denizenscript.denizen.objects.ItemTag;
import com.denizenscript.denizen.utilities.Utilities;
import com.denizenscript.denizencore.objects.Mechanism;
import com.denizenscript.denizencore.objects.core.ElementTag;
import org.bukkit.Material;
import org.bukkit.inventory.meta.ItemMeta;

public class ItemModel extends ItemProperty<ElementTag> {

// <--[property]
// @object ItemTag
// @name item_model
// @input ElementTag
// @description
// Controls the item model of the item in namespaced key format.
// -->

public static boolean describes(ItemTag item) {
return item.getBukkitMaterial() != Material.AIR;
}

@Override
public ElementTag getPropertyValue() {
if (getItemMeta().hasItemModel()) {
return new ElementTag(Utilities.namespacedKeyToString(getItemMeta().getItemModel()));
}
return null;
}

@Override
public void setPropertyValue(ElementTag element, Mechanism mechanism) {
editMeta(ItemMeta.class, meta -> meta.setItemModel(Utilities.parseNamespacedKey(element.toString())));
}

@Override
public String getPropertyId() {
return "item_model";
}

public static void register() {
autoRegisterNullable("item_model", ItemModel.class, ElementTag.class, false);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package com.denizenscript.denizen.objects.properties.item;

import com.denizenscript.denizen.objects.ItemTag;
import com.denizenscript.denizen.utilities.Utilities;
import com.denizenscript.denizencore.objects.Mechanism;
import com.denizenscript.denizencore.objects.core.ElementTag;
import org.bukkit.Material;
import org.bukkit.inventory.meta.ItemMeta;

public class ItemRarity extends ItemProperty<ElementTag> {

// <--[property]
// @object ItemTag
// @name rarity
// @input ElementTag
// @description
// Controls the rarity of the item.
// Valid rarities are: 'COMMON', 'UNCOMMON', 'RARE', and 'EPIC'.
// -->

public static boolean describes(ItemTag item) {
return item.getBukkitMaterial() != Material.AIR;
}

@Override
public ElementTag getPropertyValue() {
if (getItemMeta().hasRarity()) {
return Utilities.enumlikeToElement(getItemMeta().getRarity());
}
return null;
}

@Override
public void setPropertyValue(ElementTag element, Mechanism mechanism) {
if (mechanism.requireEnum(org.bukkit.inventory.ItemRarity.class)) {
editMeta(ItemMeta.class, meta -> meta.setRarity(element.asEnum(org.bukkit.inventory.ItemRarity.class)));
}
}

@Override
public String getPropertyId() {
return "rarity";
}

public static void register() {
autoRegisterNullable("rarity", ItemRarity.class, ElementTag.class, false);
}
}