1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Aikar <aikar@aikar.co>
Date: Fri, 22 Jun 2018 22:59:18 -0400
Subject: [PATCH] ItemStack API additions for quantity/flags/lore
diff --git a/src/main/java/org/bukkit/inventory/ItemStack.java b/src/main/java/org/bukkit/inventory/ItemStack.java
index cc065602db56c51b87d273a52d9ef82439fcaa7a..c6eca5a69cb8f5b161ff99ecad9475be64dcfed5 100644
--- a/src/main/java/org/bukkit/inventory/ItemStack.java
+++ b/src/main/java/org/bukkit/inventory/ItemStack.java
@@ -2,7 +2,9 @@ package org.bukkit.inventory;
import com.google.common.collect.ImmutableMap;
import java.util.LinkedHashMap;
+import java.util.List; // Paper
import java.util.Map;
+import java.util.Set; // Paper
import org.apache.commons.lang.Validate;
import org.bukkit.Bukkit;
import org.bukkit.Material;
@@ -635,5 +637,185 @@ public class ItemStack implements Cloneable, ConfigurationSerializable, net.kyor
// Requires access to NMS
return ensureServerConversions().getMaxItemUseDuration();
}
+
+ /**
+ * Clones the itemstack and returns it a single quantity.
+ * @return The new itemstack with 1 quantity
+ */
+ @NotNull
+ public ItemStack asOne() {
+ return asQuantity(1);
+ }
+
+ /**
+ * Clones the itemstack and returns it as the specified quantity
+ * @param qty The quantity of the cloned item
+ * @return The new itemstack with specified quantity
+ */
+ @NotNull
+ public ItemStack asQuantity(int qty) {
+ ItemStack clone = clone();
+ clone.setAmount(qty);
+ return clone;
+ }
+
+ /**
+ * Adds 1 to this itemstack. Will not go over the items max stack size.
+ * @return The same item (not a clone)
+ */
+ @NotNull
+ public ItemStack add() {
+ return add(1);
+ }
+
+ /**
+ * Adds quantity to this itemstack. Will not go over the items max stack size.
+ *
+ * @param qty The amount to add
+ * @return The same item (not a clone)
+ */
+ @NotNull
+ public ItemStack add(int qty) {
+ setAmount(Math.min(getMaxStackSize(), getAmount() + qty));
+ return this;
+ }
+
+ /**
+ * Subtracts 1 to this itemstack. Going to 0 or less will invalidate the item.
+ * @return The same item (not a clone)
+ */
+ @NotNull
+ public ItemStack subtract() {
+ return subtract(1);
+ }
+
+ /**
+ * Subtracts quantity to this itemstack. Going to 0 or less will invalidate the item.
+ *
+ * @param qty The amount to add
+ * @return The same item (not a clone)
+ */
+ @NotNull
+ public ItemStack subtract(int qty) {
+ setAmount(Math.max(0, getAmount() - qty));
+ return this;
+ }
+
+ /**
+ * If the item has lore, returns it, else it will return null
+ * @return The lore, or null
+ * @deprecated in favor of {@link #lore()}
+ */
+ @Deprecated
+ public @Nullable List<String> getLore() {
+ if (!hasItemMeta()) {
+ return null;
+ }
+ ItemMeta itemMeta = getItemMeta();
+ if (!itemMeta.hasLore()) {
+ return null;
+ }
+ return itemMeta.getLore();
+ }
+
+ /**
+ * If the item has lore, returns it, else it will return null
+ * @return The lore, or null
+ */
+ public @Nullable List<net.kyori.adventure.text.Component> lore() {
+ if (!this.hasItemMeta()) {
+ return null;
+ }
+ final ItemMeta itemMeta = getItemMeta();
+ if (!itemMeta.hasLore()) {
+ return null;
+ }
+ return itemMeta.lore();
+ }
+
+ /**
+ * Sets the lore for this item.
+ * Removes lore when given null.
+ *
+ * @param lore the lore that will be set
+ * @deprecated in favour of {@link #lore(List)}
+ */
+ @Deprecated
+ public void setLore(@Nullable List<String> lore) {
+ ItemMeta itemMeta = getItemMeta();
+ if (itemMeta == null) {
+ throw new IllegalStateException("Cannot set lore on " + getType());
+ }
+ itemMeta.setLore(lore);
+ setItemMeta(itemMeta);
+ }
+
+ /**
+ * Sets the lore for this item.
+ * Removes lore when given null.
+ *
+ * @param lore the lore that will be set
+ */
+ public void lore(@Nullable List<net.kyori.adventure.text.Component> lore) {
+ ItemMeta itemMeta = getItemMeta();
+ if (itemMeta == null) {
+ throw new IllegalStateException("Cannot set lore on " + getType());
+ }
+ itemMeta.lore(lore);
+ this.setItemMeta(itemMeta);
+ }
+
+ /**
+ * Set itemflags which should be ignored when rendering a ItemStack in the Client. This Method does silently ignore double set itemFlags.
+ *
+ * @param itemFlags The hideflags which shouldn't be rendered
+ */
+ public void addItemFlags(@NotNull ItemFlag... itemFlags) {
+ ItemMeta itemMeta = getItemMeta();
+ if (itemMeta == null) {
+ throw new IllegalStateException("Cannot add flags on " + getType());
+ }
+ itemMeta.addItemFlags(itemFlags);
+ setItemMeta(itemMeta);
+ }
+
+ /**
+ * Remove specific set of itemFlags. This tells the Client it should render it again. This Method does silently ignore double removed itemFlags.
+ *
+ * @param itemFlags Hideflags which should be removed
+ */
+ public void removeItemFlags(@NotNull ItemFlag... itemFlags) {
+ ItemMeta itemMeta = getItemMeta();
+ if (itemMeta == null) {
+ throw new IllegalStateException("Cannot remove flags on " + getType());
+ }
+ itemMeta.removeItemFlags(itemFlags);
+ setItemMeta(itemMeta);
+ }
+
+ /**
+ * Get current set itemFlags. The collection returned is unmodifiable.
+ *
+ * @return A set of all itemFlags set
+ */
+ @NotNull
+ public Set<ItemFlag> getItemFlags() {
+ ItemMeta itemMeta = getItemMeta();
+ if (itemMeta == null) {
+ return java.util.Collections.emptySet();
+ }
+ return itemMeta.getItemFlags();
+ }
+
+ /**
+ * Check if the specified flag is present on this item.
+ *
+ * @param flag the flag to check
+ * @return if it is present
+ */
+ public boolean hasItemFlag(@NotNull ItemFlag flag) {
+ ItemMeta itemMeta = getItemMeta();
+ return itemMeta != null && itemMeta.hasItemFlag(flag);
+ }
// Paper end
}
|
