/
INbtRegistry.java
50 lines (44 loc) · 1.61 KB
/
INbtRegistry.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
package mezz.jei.api;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import net.minecraft.item.Item;
import net.minecraft.item.ItemStack;
import net.minecraft.nbt.NBTTagCompound;
/**
* Tell JEI how to interpret NBT tags are used when comparing and looking up items.
*
* Some items have subtypes, most of them use meta values for this.
* If your item has subtypes that depend on NBT, use this interface so JEI can tell those subtypes apart.
*
* Most items do not use nbt to differentiate subtypes, so this interface is being used instead of a blacklist.
* Replaces {@link INbtIgnoreList}.
*
* @since 3.6.0
*/
public interface INbtRegistry {
/**
* Tells JEI to treat all NBT as relevant to these items' subtypes.
*/
void useNbtForSubtypes(@Nonnull Item... items);
/**
* Add an nbt interpreter to turn nbt into data that can be used to compare item subtypes.
*
* @param item the item that uses nbt to tell subtypes apart.
* @param nbtInterpreter the nbt interpreter for the item.
*/
void registerNbtInterpreter(@Nonnull Item item, @Nonnull INbtInterpreter nbtInterpreter);
/**
* Get the data from an itemStack that is relevant to comparing and telling subtypes apart.
* Returns null if the itemStack has no NBT or the NBT is not used for subtypes.
*/
@Nullable
String getSubtypeInfoFromNbt(@Nonnull ItemStack itemStack);
interface INbtInterpreter {
/**
* Get the data from an itemStack that is relevant to telling subtypes apart.
* Returns null if the NBT has no data used for subtypes.
*/
@Nullable
String getSubtypeInfoFromNbt(@Nonnull NBTTagCompound nbtTagCompound);
}
}