Add cooldown, itemmodel, and tooltipstyle to item meta

Author: PseudoKnight

src/main/java/com/laytonsmith/abstraction/MCCooldownComponent.java

@@ -0,0 +1,8 @@
+package com.laytonsmith.abstraction;
+
+public interface MCCooldownComponent extends AbstractionObject {
+	float getSeconds();
+	void setSeconds(float seconds);
+	String getCooldownGroup();
+	void setCooldownGroup(String cooldownGroup);
+}

src/main/java/com/laytonsmith/abstraction/MCItemMeta.java

@@ -202,4 +202,22 @@ public interface MCItemMeta extends AbstractionObject {
 
 	void setFood(MCFoodComponent component);
 
+	boolean hasItemModel();
+
+	String getItemModel();
+
+	void setItemModel(String key);
+
+	boolean hasTooltipStyle();
+
+	String getTooltipStyle();
+
+	void setTooltipStyle(String key);
+
+	boolean hasUseCooldown();
+
+	MCCooldownComponent getUseCooldown();
+
+	void setUseCooldown(MCCooldownComponent component);
+
 }

src/main/java/com/laytonsmith/abstraction/bukkit/BukkitMCCooldownComponent.java

@@ -0,0 +1,63 @@
+package com.laytonsmith.abstraction.bukkit;
+
+import com.laytonsmith.abstraction.MCCooldownComponent;
+import com.laytonsmith.commandhelper.CommandHelperPlugin;
+import org.bukkit.NamespacedKey;
+import org.bukkit.inventory.meta.components.UseCooldownComponent;
+
+public class BukkitMCCooldownComponent implements MCCooldownComponent {
+
+	private final UseCooldownComponent cooldownComponent;
+
+	public BukkitMCCooldownComponent(UseCooldownComponent foodComponent) {
+		this.cooldownComponent = foodComponent;
+	}
+
+	@Override
+	public float getSeconds() {
+		return cooldownComponent.getCooldownSeconds();
+	}
+
+	@Override
+	public void setSeconds(float seconds) {
+		cooldownComponent.setCooldownSeconds(seconds);
+	}
+
+	@Override
+	public String getCooldownGroup() {
+		NamespacedKey group = cooldownComponent.getCooldownGroup();
+		if(group == null) {
+			return null;
+		}
+		return group.toString();
+	}
+
+	@Override
+	public void setCooldownGroup(String cooldownGroup) {
+		if(cooldownGroup == null) {
+			cooldownComponent.setCooldownGroup(null);
+		} else {
+			cooldownComponent.setCooldownGroup(NamespacedKey.fromString(cooldownGroup, CommandHelperPlugin.self));
+		}
+	}
+
+	@Override
+	public Object getHandle() {
+		return cooldownComponent;
+	}
+
+	@Override
+	public String toString() {
+		return cooldownComponent.toString();
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		return o instanceof BukkitMCCooldownComponent && cooldownComponent.equals(((BukkitMCCooldownComponent) o).cooldownComponent);
+	}
+
+	@Override
+	public int hashCode() {
+		return cooldownComponent.hashCode();
+	}
+}

src/main/java/com/laytonsmith/abstraction/bukkit/BukkitMCItemMeta.java

@@ -6,6 +6,7 @@
 import com.laytonsmith.PureUtilities.Common.ReflectionUtils.ReflectionException;
 import com.laytonsmith.abstraction.AbstractionObject;
 import com.laytonsmith.abstraction.MCAttributeModifier;
+import com.laytonsmith.abstraction.MCCooldownComponent;
 import com.laytonsmith.abstraction.MCFoodComponent;
 import com.laytonsmith.abstraction.MCItemMeta;
 import com.laytonsmith.abstraction.MCItemStack;
@@ -50,6 +51,7 @@
 import org.bukkit.inventory.meta.Repairable;
 import org.bukkit.inventory.meta.components.FoodComponent;
 import org.bukkit.inventory.meta.components.JukeboxPlayableComponent;
+import org.bukkit.inventory.meta.components.UseCooldownComponent;
 
 public class BukkitMCItemMeta implements MCItemMeta {
 
@@ -442,4 +444,50 @@ public MCFoodComponent getFood() {
 	public void setFood(MCFoodComponent component) {
 		im.setFood((FoodComponent) component.getHandle());
 	}
+
+	@Override
+	public boolean hasItemModel() {
+		return im.hasItemModel();
+	}
+
+	@Override
+	public String getItemModel() {
+		return im.getItemModel().toString();
+	}
+
+	@Override
+	public void setItemModel(String key) {
+		im.setItemModel(NamespacedKey.fromString(key));
+	}
+
+	@Override
+	public boolean hasTooltipStyle() {
+		return im.hasTooltipStyle();
+	}
+
+	@Override
+	public String getTooltipStyle() {
+		return im.getTooltipStyle().toString();
+	}
+
+	@Override
+	public void setTooltipStyle(String key) {
+		im.setTooltipStyle(NamespacedKey.fromString(key));
+	}
+
+	@Override
+	public boolean hasUseCooldown() {
+		return im.hasUseCooldown();
+	}
+
+	@Override
+	public MCCooldownComponent getUseCooldown() {
+		return new BukkitMCCooldownComponent(im.getUseCooldown());
+	}
+
+	@Override
+	public void setUseCooldown(MCCooldownComponent component) {
+		im.setUseCooldown((UseCooldownComponent) component.getHandle());
+	}
+
 }

src/main/java/com/laytonsmith/core/ObjectGenerator.java

@@ -12,6 +12,7 @@
 import com.laytonsmith.abstraction.MCColor;
 import com.laytonsmith.abstraction.MCColorableArmorMeta;
 import com.laytonsmith.abstraction.MCCompassMeta;
+import com.laytonsmith.abstraction.MCCooldownComponent;
 import com.laytonsmith.abstraction.MCCreatureSpawner;
 import com.laytonsmith.abstraction.MCCrossbowMeta;
 import com.laytonsmith.abstraction.MCEnchantmentStorageMeta;
@@ -549,6 +550,22 @@ public Construct itemMeta(MCItemStack is, Target t) {
 					if(meta.hasUseRemainder()) {
 						ma.set("remainder", item(meta.getUseRemainder(), t), t);
 					}
+					if(meta.hasUseCooldown()) {
+						MCCooldownComponent cooldownComponent = meta.getUseCooldown();
+						CArray cooldown = CArray.GetAssociativeArray(t);
+						cooldown.set("seconds", new CDouble(cooldownComponent.getSeconds(), t), t);
+						String group = cooldownComponent.getCooldownGroup();
+						if(group != null) {
+							cooldown.set("group", new CString(group, t), t);
+						}
+						ma.set("cooldown", cooldown, t);
+					}
+					if(meta.hasItemModel()) {
+						ma.set("itemmodel", new CString(meta.getItemModel(), t), t);
+					}
+					if(meta.hasTooltipStyle()) {
+						ma.set("tooltipstyle", new CString(meta.getTooltipStyle(), t), t);
+					}
 				}
 
 			} else { // versions before 1.20.6
@@ -1133,6 +1150,46 @@ public MCItemMeta itemMeta(Mixed c, MCMaterial mat, Target t) throws ConfigRunti
 							meta.setUseRemainder(item(remainder, t));
 						}
 					}
+					if(ma.containsKey("cooldown")) {
+						Mixed mixedCooldown =  ma.get("cooldown", t);
+						if(mixedCooldown instanceof CNull) {
+							// not yet supported
+						} else if(mixedCooldown.isInstanceOf(CArray.TYPE)) {
+							CArray cooldownArray = (CArray) mixedCooldown;
+							if(!cooldownArray.isAssociative()) {
+								throw new CREFormatException("Cooldown array must be associative.", t);
+							}
+							MCCooldownComponent cooldown = meta.getUseCooldown();
+							if(cooldownArray.containsKey("seconds")) {
+								cooldown.setSeconds(ArgumentValidation.getDouble32(cooldownArray.get("seconds", t), t));
+							}
+							if(cooldownArray.containsKey("group")) {
+								Mixed group = cooldownArray.get("group", t);
+								if(!(group instanceof CNull)) {
+									cooldown.setCooldownGroup(group.val());
+								}
+							}
+							meta.setUseCooldown(cooldown);
+						} else {
+							throw new CREFormatException("Expected an array for item cooldown.", t);
+						}
+					}
+					if(ma.containsKey("itemmodel")) {
+						Mixed itemmodel = ma.get("itemmodel", t);
+						if(itemmodel instanceof CNull) {
+							// not yet supported
+						} else {
+							meta.setItemModel(itemmodel.val());
+						}
+					}
+					if(ma.containsKey("tooltipstyle")) {
+						Mixed tooltipstyle = ma.get("tooltipstyle", t);
+						if(tooltipstyle instanceof CNull) {
+							// not yet supported
+						} else {
+							meta.setTooltipStyle(tooltipstyle.val());
+						}
+					}
 				}
 				if(ma.containsKey("damage")) {
 					Mixed damage = ma.get("damage", t);

src/main/resources/functionDocs/get_itemmeta

@@ -2,8 +2,9 @@ array {[player,] slot} Returns an associative array of known item data in the sl
 
 ----
 
+==== Basic Fields ====
 These fields exist for all items with meta.
-{| width="100%" cellspacing="1" cellpadding="1" border="1" class="wikitable"
+{| class="wikitable"
 |-
 ! scope="col" width="12%" | Field
 ! scope="col" width="15%" | Type
@@ -53,8 +54,9 @@ These fields exist for all items with meta.
 ** '''value''' : (mixed) A valid value for the given tag type.
 |}
 
+==== Optional Fields ====
 These fields optionally exist for any item type.
-{| width="100%" cellspacing="1" cellpadding="1" border="1" class="wikitable"
+{| class="wikitable"
 |-
 ! scope="col" width="12%" | Field
 ! scope="col" width="15%" | Type
@@ -106,10 +108,25 @@ These fields optionally exist for any item type.
 ! remainder
 | associative array
 | Overrides the remaining item when the quantity of this item decreases after use. (e.g. a bucket after drinking a milk bucket) (MC 1.21.3+)
+|-
+! cooldown
+| associative array
+| Overrides the item's cooldown on use. The cooldown temporarily prevents any right-click actions for items of the same type or with the same cooldown group, if set. Not all item types activate cooldowns on use. (MC 1.21.3+)
+* '''seconds''' : (double) The number of seconds the cooldown lasts when the item is used. (default: 1.0)
+* '''group''' : (string) If this namespaced id is present, it shares cooldowns with items with the same cooldown group instead of by item type. (optional)
+|-
+! itemmodel
+| string
+| Overrides the item's model using a namespaced resource location. (MC 1.21.3+)
+|-
+! tooltipstyle
+| string
+| Overrides the item's tooltip style using a namespaced resource location. (MC 1.21.3+)
 |}
 
+==== Type Specific Fields ====
 These fields only exist for specific item types.
-{| width="80%" cellspacing="1" cellpadding="1" border="1" class="wikitable"
+{| class="wikitable"
 |-
 ! scope="col" width="14%" | Item Type
 ! scope="col" width="86%" | Meta
@@ -324,10 +341,87 @@ These fields may be null on 1.21.5 due to a server API implementation bug.
 The entity's custom name is derived from the item "display" string. All other tropical fish data is not yet supported.
 |}
 
-Other data not yet supported in item meta:
-
-* MC 1.13.2 : "can_break" and "can_place_on" (Paper only)
-* MC 1.20.5 : "item_name", "intangible_projectile" (Paper 1.21.3 only), "instrument" (can only get custom definitions in Paper, not set), "tool" (cannot get tags in 'rules', can_destroy_blocks_in_creative field only in Paper), "hide_tooltip" (later integrated into "tooltip_display"), "lock" (can only set with server API)
-* MC 1.21.2 : "damage_resistant", "tooltip_style", "use_cooldown", "item_model", "death_protection" (Paper only), "repairable" (Paper only), "consumable" (added in Spigot 1.21.4 API, Paper API separate), "equippable" (added in Spigot 1.21.5 API)
-* MC 1.21.4 : "custom_model_data" (for anything other than a single float rounded down)
-* MC 1.21.5 : "weapon" (separate Paper/Spigot API), "blocks_attacks" (separate Paper/Spigot API), "break_sound" (separate Paper/Spigot API), "provides_banner_patterns" (Paper only), "provides_trim_material" (Paper only), "potion_duration_scale" (Paper only), "tooltip_display" (partially supported with "flags")
+==== Unsupported Fields ====
+Data components not yet supported in item meta:
+{| class="wikitable"
+|-
+! scope="col" width="20%" | Field
+! scope="col" width="10%" | MCVersion
+! scope="col" width="70%" | Notes
+|-
+! can_break
+| 1.13.2
+| Paper only
+|-
+! can_place_on
+| 1.13.2
+| Paper only
+|-
+! item_name
+| 1.20.5
+|
+|-
+! intangible_projectile
+| 1.20.5
+| Paper 1.21.3+ only
+|-
+! tool
+| 1.20.5
+| Cannot read tags in 'rules' field; 'can_destroy_blocks_in_creative' field only in Paper
+|-
+! lock
+| 1.20.5
+| Server API is write only
+|-
+! damage_resistant
+| 1.21.2
+|
+|-
+! death_protection
+| 1.21.2
+| Paper only
+|-
+! repairable
+| 1.21.2
+| Paper only
+|-
+! consumable
+| 1.21.2
+| Added in Spigot 1.21.4 API; Paper API separate
+|-
+! equippable
+| 1.21.2
+| Added in Spigot 1.21.5 API
+|-
+! custom_model_data
+| 1.21.4
+| Needed for anything other than a single float rounded down in the 'model' field
+|-
+! weapon
+| 1.21.5
+| Separate Paper/Spigot API
+|-
+! blocks_attacks
+| 1.21.5
+| Separate Paper/Spigot API
+|-
+! break_sound
+| 1.21.5
+| Separate Paper/Spigot API
+|-
+! provides_banner_patterns
+| 1.21.5
+| Paper only
+|-
+! provides_trim_material
+| 1.21.5
+| Paper only
+|-
+! potion_duration_scale
+| 1.21.5
+| Paper only
+|-
+! tooltip_display
+| 1.21.5
+| Partially supported with 'flags' field
+|}