Skip to content

Commit

Permalink
Migrate DataStorage fetch to new function names.
Browse files Browse the repository at this point in the history 
Primarily this will affect Quark, so the previous names have been left
in as deprecated.

The other functions were not used outside of `DataStorage`, as far as
I'm aware, so I'm happy with a breaking change being made here. Will
address in another update if necessary.

`id`, `ref_id` and `entity` pseudo-constructors were being overridden by
the future `unwrap` call (now known as `update`).

The update function will still continue to run but in theory now only
once, and only in one place. Now with added error-checking for instances
where data potentially changes what should be immutable fields but
cannot be due to previous poorly made decisions.
  • Loading branch information
@noobanidus
noobanidus committed Jan 22, 2024
1 parent d1654f5 commit fcd9d0f
Show file tree
Hide file tree
Showing 2 changed files with 116 additions and 142 deletions.
210 changes: 85 additions & 125 deletions src/main/java/noobanidus/mods/lootr/data/ChestData.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

import net.minecraft.core.BlockPos;
import net.minecraft.core.NonNullList;
import net.minecraft.core.Registry;
import net.minecraft.core.registries.Registries;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.nbt.ListTag;
Expand Down Expand Up @@ -43,14 +42,30 @@ public class ChestData extends SavedData {
private ResourceKey<Level> dimension;
private UUID uuid;
private Map<UUID, SpecialChestInventory> inventories = new HashMap<>();
private NonNullList<ItemStack> reference;
private boolean custom;
private boolean entity;
private NonNullList<ItemStack> reference = null;
private boolean custom = false;
private boolean entity = false;
private int size = -1;

protected ChestData(String key) {
this.key = key;
}

protected ChestData(UUID id) {
this(ID(id));
}

protected ChestData(UUID id, boolean entity) {
this(ID(id));
this.entity = entity;
}

protected ChestData(UUID id, NonNullList<ItemStack> base) {
this(id, false);
this.custom = true;
this.reference = base;
}

public BlockPos getPos() {
return pos;
}
Expand Down Expand Up @@ -78,48 +93,6 @@ public static String ID(UUID id) {
return "lootr/" + idString.charAt(0) + "/" + idString.substring(0, 2) + "/" + idString;
}

public static Supplier<ChestData> ref_id(ResourceKey<Level> dimension, BlockPos pos, UUID id, NonNullList<ItemStack> base) {
return () -> {
ChestData data = new ChestData(ID(id));
data.pos = pos;
data.dimension = dimension;
data.uuid = id;
data.reference = base;
data.custom = true;
data.entity = false;
if (data.reference == null) {
throw new IllegalArgumentException("Inventory reference cannot be null.");
}
return data;
};
}

public static Supplier<ChestData> id(ResourceKey<Level> dimension, BlockPos pos, UUID id) {
return () -> {
ChestData data = new ChestData(ID(id));
data.pos = pos;
data.dimension = dimension;
data.uuid = id;
data.reference = null;
data.custom = false;
data.entity = false;
return data;
};
}

public static Supplier<ChestData> entity(ResourceKey<Level> dimension, BlockPos pos, UUID entityId) {
return () -> {
ChestData data = new ChestData(ID(entityId));
data.pos = pos;
data.dimension = dimension;
data.uuid = entityId;
data.entity = true;
data.reference = null;
data.custom = false;
return data;
};
}

public LootFiller customInventory() {
return (player, inventory, table, seed) -> {
for (int i = 0; i < reference.size(); i++) {
Expand Down Expand Up @@ -152,7 +125,11 @@ public SpecialChestInventory createInventory(ServerPlayer player, LootFiller fil
return null;
}

NonNullList<ItemStack> items = NonNullList.withSize(sizeSupplier.getAsInt(), ItemStack.EMPTY);
if (this.size == -1) {
this.size = sizeSupplier.getAsInt();
}

NonNullList<ItemStack> items = NonNullList.withSize(this.size, ItemStack.EMPTY);
result = new SpecialChestInventory(this, items, displaySupplier.get());
filler.unpackLootTable(player, result, tableSupplier.get(), seedSupplier.getAsLong());
inventories.put(player.getUUID(), result);
Expand All @@ -175,7 +152,11 @@ public SpecialChestInventory createInventory(ServerPlayer player, LootFiller fil
return null;
}

NonNullList<ItemStack> items = NonNullList.withSize(blockEntity.getContainerSize(), ItemStack.EMPTY);
if (this.size == -1) {
this.size = blockEntity.getContainerSize();
}

NonNullList<ItemStack> items = NonNullList.withSize(size, ItemStack.EMPTY);
result = new SpecialChestInventory(this, items, blockEntity.getDisplayName());
filler.unpackLootTable(player, result, tableSupplier.get(), seedSupplier.getAsLong());
inventories.put(player.getUUID(), result);
Expand All @@ -193,25 +174,24 @@ public SpecialChestInventory createInventory(ServerPlayer player, LootFiller fil
if (!(initial instanceof LootrChestMinecartEntity cart)) {
return null;
}
NonNullList<ItemStack> items = NonNullList.withSize(cart.getContainerSize(), ItemStack.EMPTY);
if (this.size == -1) {
this.size = cart.getContainerSize();
}
NonNullList<ItemStack> items = NonNullList.withSize(this.size, ItemStack.EMPTY);
result = new SpecialChestInventory(this, items, cart.getDisplayName());
lootTable = cart.lootTable;
} else {
/* if (world.dimension() != dimension) {
MinecraftServer server = ServerLifecycleHooks.getCurrentServer();
if (server == null) {
return null;
}
world = server.getLevel(dimension);
}*/

if (/*world == null || */tile == null) {
if (tile == null) {
return null;
}

lootTable = ((ILootBlockEntity) tile).getTable();

NonNullList<ItemStack> items = NonNullList.withSize(tile.getContainerSize(), ItemStack.EMPTY);
if (this.size == -1) {
this.size = tile.getContainerSize();
}

NonNullList<ItemStack> items = NonNullList.withSize(this.size, ItemStack.EMPTY);
result = new SpecialChestInventory(this, items, tile.getDisplayName());
}
filler.unpackLootTable(player, result, lootTable, seed);
Expand All @@ -220,20 +200,29 @@ public SpecialChestInventory createInventory(ServerPlayer player, LootFiller fil
return result;
}

public static Function<CompoundTag, ChestData> loadWrapper(UUID id, ResourceKey<Level> dimension, BlockPos position) {
return (tag) -> {
ChestData result = ChestData.load(tag);
result.key = ID(id);
result.dimension = dimension;
result.pos = position;
return result;
};
}

public static ChestData unwrap(ChestData data, UUID id, ResourceKey<Level> dimension, BlockPos position) {
data.key = ID(id);
protected static ChestData update(ChestData data, UUID id, ResourceKey<Level> dimension, BlockPos position) {
// Check for UUID changes, unless null
if (data.uuid == null) {
data.uuid = id;
} else if (data.uuid != id) {
LootrAPI.LOG.error("ChestData UUID mismatch! Expected: '" + data.uuid + "' but got: '" + id + "' for chest: '" + data.key + "'!");
}
// Check for key changes, unless null
if (data.key == null) {
data.key = ID(id);
} else if (!data.key.equals(ID(id))) {
LootrAPI.LOG.error("ChestData key mismatch! Expected: '" + data.key + "' but got: '" + ID(id) + "' for chest: '" + data.key + "'!");
}
if (data.dimension != null && data.dimension != dimension) {
LootrAPI.LOG.error("ChestData dimension changed! Expected: '" + data.dimension + "' but got: '" + dimension + "' for chest: '" + data.uuid.toString() + "'!");
}
// Always update dimension regardless
data.dimension = dimension;
data.pos = position;

// Only update position if non-entity; position is not assured to be correct for entities.
if (!data.entity) {
data.pos = position;
}
return data;
}

Expand All @@ -242,68 +231,37 @@ public static ChestData load(CompoundTag compound) {
data.inventories.clear();
data.pos = null;
data.dimension = null;
// Migrated position from `asLong` to `NtUtils::XXXBlockPos`
if (compound.contains("position", Tag.TAG_LONG)) {
data.pos = BlockPos.of(compound.getLong("position"));
} else if (compound.contains("position", Tag.TAG_COMPOUND)) {
data.pos = NbtUtils.readBlockPos(compound.getCompound("position"));
}
if (compound.contains("dimension")) {
data.dimension = ResourceKey.create(Registries.DIMENSION, new ResourceLocation(compound.getString("dimension")));
}
boolean foundNewUUID = false;
if (compound.hasUUID("uuid")) {
data.uuid = compound.getUUID("uuid");
foundNewUUID = true;
}
boolean foundEntity = false;
if (compound.hasUUID("entityId")) {
if (data.uuid != null /* || foundNewUUID */) { // foundNewUUID is redundant here, if uuid isn't null
LootrAPI.LOG.error("Loaded an `entityId` from an already-migrated file: '" + data.key + "'");
}
data.uuid = compound.getUUID("entityId");
data.entity = true;
foundEntity = true;
}
if (compound.hasUUID("tileId")) {
if (data.uuid != null) {
if (foundEntity && !foundNewUUID) {
LootrAPI.LOG.error("Loaded a `tileId` from an unmigrated file that also has `entityId`: '" + data.key + "'");
} else if (foundEntity) {
LootrAPI.LOG.error("Loaded a `tileId` from an already-migrated file that also had an `entityId`: '" + data.key + "'");
} else if (foundNewUUID) {
LootrAPI.LOG.error("Loaded a `tileId` from an already-migrated file: '" + data.key + "'");
}
}
data.uuid = compound.getUUID("tileId");
data.entity = false;
}
if (compound.contains("custom")) {
data.custom = compound.getBoolean("custom");
}
if (compound.contains("entity")) {
data.entity = compound.getBoolean("entity");
}
if (compound.hasUUID("customId")) {
LootrAPI.LOG.error("Loaded a `customId` from an old file when this field was never used. File was '" + data.key + "'");
data.uuid = compound.getUUID("customId");
data.entity = false;
data.custom = true;
}
// Shim for pre-migration is irrelevant in this version
data.pos = NbtUtils.readBlockPos(compound.getCompound("position"));
// Dimension is now always stored
data.dimension = ResourceKey.create(Registries.DIMENSION, new ResourceLocation(compound.getString("dimension")));
// Shim for entityId, tileId, customId, etc, no longer required
data.uuid = compound.getUUID("uuid");
// Custom is always stored
data.custom = compound.getBoolean("custom");
// Entity is always stored
data.entity = compound.getBoolean("entity");

// Reference is optional
if (compound.contains("reference") && compound.contains("referenceSize")) {
int size = compound.getInt("referenceSize");
data.reference = NonNullList.withSize(size, ItemStack.EMPTY);
ContainerHelper.loadAllItems(compound.getCompound("reference"), data.reference);
}

// Size is new and currently an optional read but a required write
if (compound.contains("size")) {
data.size = compound.getInt("size");
}

// Inventories are non-optional
ListTag compounds = compound.getList("inventories", Tag.TAG_COMPOUND);
for (int i = 0; i < compounds.size(); i++) {
CompoundTag thisTag = compounds.getCompound(i);
CompoundTag items = thisTag.getCompound("chest");
String name = thisTag.getString("name");
int size;
if (thisTag.contains("size")) {
size = thisTag.getInt("size");
} else {
if (data.size == -1) {
int size = -1;
// No listed size, we'll have to guess
ListTag itemList = items.getList("Items", 10);
int maxSlot = 0;
Expand Down Expand Up @@ -334,9 +292,11 @@ public static ChestData load(CompoundTag compound) {
size = 54;
}
}
data.size = size;
}
UUID uuid = thisTag.getUUID("uuid");
data.inventories.put(uuid, new SpecialChestInventory(data, size, items, name));
// TODO: Possibly externalize size to `data`
data.inventories.put(uuid, new SpecialChestInventory(data, data.size, items, name));
}
return data;
}
Expand Down

0 comments on commit fcd9d0f

Please sign in to comment.