-
-
Notifications
You must be signed in to change notification settings - Fork 104
/
ItemRawNBT.java
393 lines (367 loc) · 15.4 KB
/
ItemRawNBT.java
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
package com.denizenscript.denizen.objects.properties.item;
import com.denizenscript.denizen.nms.NMSHandler;
import com.denizenscript.denizen.nms.util.jnbt.*;
import com.denizenscript.denizen.objects.ItemTag;
import com.denizenscript.denizencore.utilities.debugging.Debug;
import com.denizenscript.denizencore.objects.Mechanism;
import com.denizenscript.denizencore.objects.ObjectTag;
import com.denizenscript.denizencore.objects.core.ElementTag;
import com.denizenscript.denizencore.objects.core.ListTag;
import com.denizenscript.denizencore.objects.core.MapTag;
import com.denizenscript.denizencore.objects.properties.Property;
import com.denizenscript.denizencore.tags.Attribute;
import com.denizenscript.denizencore.tags.TagContext;
import com.denizenscript.denizencore.utilities.text.StringHolder;
import org.bukkit.Material;
import java.util.*;
public class ItemRawNBT implements Property {
public static boolean describes(ObjectTag item) {
// All items can have raw NBT
return item instanceof ItemTag && ((ItemTag) item).getBukkitMaterial() != Material.AIR;
}
public static ItemRawNBT getFrom(ObjectTag _item) {
if (!describes(_item)) {
return null;
}
else {
return new ItemRawNBT((ItemTag) _item);
}
}
public static final String[] handledTags = new String[] {
"raw_nbt", "all_raw_nbt"
};
public static final String[] handledMechs = new String[] {
"raw_nbt"
};
public ItemRawNBT(ItemTag _item) {
item = _item;
}
public static StringHolder[] defaultNbtKeys;
static {
String[] defaultNbtKeysRaw = new String[] {
// Denizen
"Denizen Item Script", "DenizenItemScript", "Denizen NBT", "Denizen",
// General
"Damage", "Unbreakable", "CanDestroy", "CustomModelData", "trim",
// Display data
"display", "HideFlags",
// Block
"CanPlaceOn", "BlockEntityTag", "BlockStateTag",
// Enchanting
"Enchantments", "StoredEnchantments", "RepairCost",
// Attributes
"AttributeModifiers",
// Potions
"CustomPotionEffects", "Potion", "CustomPotionColor",
// Crossbow specific
"ChargedProjectiles", "Charged",
// Book specific
"resolved", "generation", "author", "title", "pages",
// Player Head specific
"SkullOwner",
// Firework specific
"Explosion", "Fireworks",
//"EntityTag", // Special handling
// Bucket specific
//"BucketVariantTag", // Temporarily sent through as raw due to lack of property coverage
// Map specific
"map", "map_scale_direction",
//"Decorations", // Temporarily sent through due to apparent usage in certain vanilla cases not covered by properties
// Stew specific
"Effects",
// Lodestone compass specific
//"LodestoneDimension", "LodestonePos", // Temporarily sent through due to "Dimension" inconsistency, and compatibility with unloaded worlds
"LodestoneTracked",
// Bundle specific
"Items",
// Goat Horn specific
"instrument",
};
defaultNbtKeys = new StringHolder[defaultNbtKeysRaw.length];
for (int i = 0; i < defaultNbtKeysRaw.length; i++) {
defaultNbtKeys[i] = new StringHolder(defaultNbtKeysRaw[i]);
}
}
public MapTag getNonDefaultNBTMap() {
MapTag result = getFullNBTMap();
for (StringHolder key : defaultNbtKeys) {
result.map.remove(key);
}
if (item.getBukkitMaterial() == Material.ITEM_FRAME) {
MapTag entityMap = (MapTag) result.getObject("EntityTag");
if (entityMap != null) {
entityMap.putObject("Invisible", null);
if (entityMap.map.isEmpty()) {
result.putObject("EntityTag", null);
}
}
}
if (item.getBukkitMaterial() == Material.ARMOR_STAND) {
MapTag entityMap = (MapTag) result.getObject("EntityTag");
if (entityMap != null) {
entityMap.putObject("Pose", null);
entityMap.putObject("Small", null);
entityMap.putObject("NoBasePlate", null);
entityMap.putObject("Marker", null);
entityMap.putObject("Invisible", null);
entityMap.putObject("ShowArms", null);
if (entityMap.map.isEmpty()) {
result.putObject("EntityTag", null);
}
}
}
return result;
}
public MapTag getFullNBTMap() {
CompoundTag compoundTag = NMSHandler.itemHelper.getNbtData(item.getItemStack());
return (MapTag) jnbtTagToObject(compoundTag);
}
// <--[language]
// @name Raw NBT Encoding
// @group Useful Lists
// @description
// The item Raw_NBT property encodes and decodes raw NBT data.
// For the sake of inter-compatibility, a special standard format is used to preserve data types.
// This system exists in Denizen primarily for the sake of compatibility with external plugins.
// It should not be used in any scripts that don't rely on data from external plugins.
//
// NBT Tags are encoded as follows:
// CompoundTag: (a fully formed MapTag)
// ListTag: list:(NBT type-code):(a fully formed ListTag)
// ByteArrayTag: byte_array:(a pipe-separated list of numbers)
// IntArrayTag: int_array:(a pipe-separated list of numbers)
// ByteTag: byte:(#)
// ShortTag: short:(#)
// IntTag: int:(#)
// LongTag: long:(#)
// FloatTag: float:(#)
// DoubleTag: double:(#)
// StringTag: string:(text here)
// EndTag: end
//
// -->
public static Tag convertObjectToNbt(String object, TagContext context, String path) {
if (object.startsWith("map@")) {
MapTag map = MapTag.valueOf(object, context);
Map<String, Tag> result = new LinkedHashMap<>();
for (Map.Entry<StringHolder, ObjectTag> entry : map.map.entrySet()) {
try {
result.put(entry.getKey().str, convertObjectToNbt(entry.getValue().toString(), context, path + "." + entry.getKey().str));
}
catch (Exception ex) {
Debug.echoError("Object NBT interpretation failed for key '" + path + "." + entry.getKey().str + "'.");
Debug.echoError(ex);
return null;
}
}
return NMSHandler.instance.createCompoundTag(result);
}
else if (object.startsWith("list:")) {
int nextColonIndex = object.indexOf(':', "list:".length() + 1);
int typeCode = Integer.parseInt(object.substring("list:".length(), nextColonIndex));
String listValue = object.substring(nextColonIndex + 1);
List<Tag> result = new ArrayList<>();
ListTag listTag = ListTag.valueOf(listValue, context);
for (int i = 0; i < listTag.size(); i++) {
try {
result.add(convertObjectToNbt(listTag.get(i), context, path + "[" + i + "]"));
}
catch (Exception ex) {
Debug.echoError("Object NBT interpretation failed for list key '" + path + "' at index " + i + ".");
Debug.echoError(ex);
return null;
}
}
return new JNBTListTag(NBTUtils.getTypeClass(typeCode), result);
}
else if (object.startsWith("byte_array:")) {
ListTag numberStrings = ListTag.valueOf(object.substring("byte_array:".length()), context);
byte[] result = new byte[numberStrings.size()];
for (int i = 0; i < result.length; i++) {
result[i] = Byte.parseByte(numberStrings.get(i));
}
return new ByteArrayTag(result);
}
else if (object.startsWith("int_array:")) {
ListTag numberStrings = ListTag.valueOf(object.substring("int_array:".length()), context);
int[] result = new int[numberStrings.size()];
for (int i = 0; i < result.length; i++) {
result[i] = Integer.parseInt(numberStrings.get(i));
}
return new IntArrayTag(result);
}
else if (object.startsWith("byte:")) {
return new ByteTag(Byte.parseByte(object.substring("byte:".length())));
}
else if (object.startsWith("short:")) {
return new ShortTag(Short.parseShort(object.substring("short:".length())));
}
else if (object.startsWith("int:")) {
return new IntTag(Integer.parseInt(object.substring("int:".length())));
}
else if (object.startsWith("long:")) {
return new LongTag(Long.parseLong(object.substring("long:".length())));
}
else if (object.startsWith("float:")) {
return new FloatTag(Float.parseFloat(object.substring("float:".length())));
}
else if (object.startsWith("double:")) {
return new DoubleTag(Double.parseDouble(object.substring("double:".length())));
}
else if (object.startsWith("string:")) {
return new StringTag(object.substring("string:".length()));
}
else if (object.equals("end")) {
return new EndTag();
}
else {
if (context == null || context.showErrors()) {
Debug.echoError("Unknown raw NBT value: " + object);
}
return null;
}
}
public static ObjectTag jnbtTagToObject(Tag tag) {
if (tag instanceof CompoundTag) {
MapTag result = new MapTag();
for (Map.Entry<String, Tag> entry : ((CompoundTag) tag).getValue().entrySet()) {
result.putObject(entry.getKey(), jnbtTagToObject(entry.getValue()));
}
return result;
}
else if (tag instanceof JNBTListTag) {
ListTag result = new ListTag();
for (Tag entry : ((JNBTListTag) tag).getValue()) {
result.addObject(jnbtTagToObject(entry));
}
return new ElementTag("list:" + NBTUtils.getTypeCode(((JNBTListTag) tag).getType()) + ":" + result.identify());
}
else if (tag instanceof ByteArrayTag) {
byte[] data = ((ByteArrayTag) tag).getValue();
StringBuilder output = new StringBuilder(data.length * 4);
for (int i = 0; i < data.length; i++) {
output.append(data[i]).append("|");
}
return new ElementTag("byte_array:" + output);
}
else if (tag instanceof IntArrayTag) {
int[] data = ((IntArrayTag) tag).getValue();
StringBuilder output = new StringBuilder(data.length * 4);
for (int i = 0; i < data.length; i++) {
output.append(data[i]).append("|");
}
return new ElementTag("int_array:" + output);
}
else if (tag instanceof ByteTag) {
return new ElementTag("byte:" + ((ByteTag) tag).getValue());
}
else if (tag instanceof ShortTag) {
return new ElementTag("short:" + ((ShortTag) tag).getValue());
}
else if (tag instanceof IntTag) {
return new ElementTag("int:" + ((IntTag) tag).getValue());
}
else if (tag instanceof LongTag) {
return new ElementTag("long:" + ((LongTag) tag).getValue());
}
else if (tag instanceof FloatTag) {
return new ElementTag("float:" + ((FloatTag) tag).getValue());
}
else if (tag instanceof DoubleTag) {
return new ElementTag("double:" + ((DoubleTag) tag).getValue());
}
else if (tag instanceof StringTag) {
return new ElementTag("string:" + ((StringTag) tag).getValue());
}
else if (tag instanceof EndTag) {
return new ElementTag("end");
}
else {
return new ElementTag("unknown:" + tag.getValue());
}
}
ItemTag item;
@Override
public ObjectTag getObjectAttribute(Attribute attribute) {
if (attribute == null) {
return null;
}
// <--[tag]
// @attribute <ItemTag.raw_nbt>
// @returns MapTag
// @mechanism ItemTag.raw_nbt
// @group properties
// @description
// Returns a map of all non-default raw NBT on this item.
// Refer to format details at <@link language Raw NBT Encoding>.
// -->
if (attribute.startsWith("raw_nbt")) {
return getNonDefaultNBTMap().getObjectAttribute(attribute.fulfill(1));
}
// <--[tag]
// @attribute <ItemTag.all_raw_nbt>
// @returns MapTag
// @mechanism ItemTag.raw_nbt
// @group properties
// @description
// Returns a map of all raw NBT on this item, including default values.
// Refer to format details at <@link language Raw NBT Encoding>.
// -->
if (attribute.startsWith("all_raw_nbt")) {
return getFullNBTMap().getObjectAttribute(attribute.fulfill(1));
}
return null;
}
@Override
public String getPropertyString() {
MapTag nbt = getNonDefaultNBTMap();
if (!nbt.map.isEmpty()) {
return nbt.identify();
}
else {
return null;
}
}
@Override
public String getPropertyId() {
return "raw_nbt";
}
public void setFullNBT(ItemTag item, MapTag input, TagContext context, boolean retainOld) {
CompoundTag compoundTag = retainOld ? NMSHandler.itemHelper.getNbtData(item.getItemStack()) : null;
Map<String, Tag> result = compoundTag == null ? new LinkedHashMap<>() : new LinkedHashMap<>(compoundTag.getValue());
for (Map.Entry<StringHolder, ObjectTag> entry : input.map.entrySet()) {
try {
Tag tag = convertObjectToNbt(entry.getValue().toString(), context, "(item).");
if (tag != null) {
result.put(entry.getKey().str, tag);
}
}
catch (Exception ex) {
Debug.echoError("Raw_Nbt input failed for root key '" + entry.getKey().str + "'.");
Debug.echoError(ex);
return;
}
}
compoundTag = NMSHandler.instance.createCompoundTag(result);
item.setItemStack(NMSHandler.itemHelper.setNbtData(item.getItemStack(), compoundTag));
}
@Override
public void adjust(Mechanism mechanism) {
// <--[mechanism]
// @object ItemTag
// @name raw_nbt
// @input MapTag
// @description
// Sets the given map of raw NBT keys onto this item.
// Note that the input format must be strictly perfect.
// Refer to <@link language Raw NBT Encoding> for explanation of the input format.
// @tags
// <ItemTag.raw_nbt>
// <ItemTag.all_raw_nbt>
// -->
if (mechanism.matches("raw_nbt") && mechanism.requireObject(MapTag.class)) {
MapTag input = mechanism.valueAsType(MapTag.class);
setFullNBT(item, input, mechanism.context, true);
}
}
}