Clean up and serialize player history

Author: robotgryphon

src/main/java/dev/compactmods/machines/core/ModBusEvents.java

@@ -4,6 +4,7 @@
 import dev.compactmods.machines.advancement.AdvancementTriggers;
 import dev.compactmods.machines.compat.theoneprobe.TheOneProbeCompat;
 import dev.compactmods.machines.network.NetworkHandler;
+import dev.compactmods.machines.rooms.capability.CapabilityRoomHistory;
 import net.minecraftforge.eventbus.api.SubscribeEvent;
 import net.minecraftforge.fml.ModList;
 import net.minecraftforge.fml.common.Mod;
@@ -20,6 +21,9 @@ public static void setup(final FMLCommonSetupEvent event) {
 
         CompactMachines.LOGGER.trace("Registering advancement triggers.");
         AdvancementTriggers.init();
+
+        CompactMachines.LOGGER.trace("Registering capabilities.");
+        CapabilityRoomHistory.register();
     }
 
     @SubscribeEvent

src/main/java/dev/compactmods/machines/rooms/capability/CMRoomHistory.java

@@ -2,9 +2,16 @@
 
 import java.util.ArrayDeque;
 import java.util.Deque;
+import java.util.Optional;
+import com.mojang.serialization.DataResult;
+import dev.compactmods.machines.data.codec.NbtListCollector;
 import dev.compactmods.machines.rooms.history.IRoomHistoryItem;
+import dev.compactmods.machines.rooms.history.PlayerRoomHistoryItem;
+import net.minecraft.nbt.INBT;
+import net.minecraft.nbt.ListNBT;
+import net.minecraft.nbt.NBTDynamicOps;
 
-public class CMRoomHistory implements IRoomHistory{
+public class CMRoomHistory implements IRoomHistory {
 
     private final Deque<IRoomHistoryItem> history;
 
@@ -36,4 +43,25 @@ public IRoomHistoryItem pop() {
     public void addHistory(IRoomHistoryItem item) {
         history.add(item);
     }
+
+    @Override
+    public ListNBT serializeNBT() {
+        return history.stream()
+                .map(hi -> PlayerRoomHistoryItem.CODEC.encodeStart(NBTDynamicOps.INSTANCE, hi))
+                .map(DataResult::result)
+                .filter(Optional::isPresent)
+                .map(Optional::get)
+                .map(x -> x)
+                .collect(NbtListCollector.toNbtList());
+    }
+
+    @Override
+    public void deserializeNBT(ListNBT nbt) {
+        nbt.stream()
+                .map(it -> PlayerRoomHistoryItem.CODEC.parse(NBTDynamicOps.INSTANCE, it))
+                .map(DataResult::result)
+                .filter(Optional::isPresent)
+                .map(Optional::get)
+                .forEach(history::addLast);
+    }
 }

src/main/java/dev/compactmods/machines/rooms/capability/CapabilityRoomHistory.java

@@ -1,8 +1,8 @@
 package dev.compactmods.machines.rooms.capability;
 
 import javax.annotation.Nullable;
-import net.minecraft.nbt.CompoundNBT;
 import net.minecraft.nbt.INBT;
+import net.minecraft.nbt.ListNBT;
 import net.minecraft.util.Direction;
 import net.minecraftforge.common.capabilities.Capability;
 import net.minecraftforge.common.capabilities.CapabilityInject;
@@ -13,20 +13,21 @@ public class CapabilityRoomHistory {
     @CapabilityInject(IRoomHistory.class)
     public static Capability<IRoomHistory> HISTORY_CAPABILITY = null;
 
-    public static void setup() {
-        CapabilityManager.INSTANCE.register(
-                IRoomHistory.class,
-                new Capability.IStorage<IRoomHistory>() {
-                    @Nullable
-                    @Override
-                    public INBT writeNBT(Capability<IRoomHistory> capability, IRoomHistory instance, Direction side) {
-                        return new CompoundNBT();
-                    }
+    public static class CapabilityRoomHistoryStorage implements Capability.IStorage<IRoomHistory> {
+        @Nullable
+        @Override
+        public INBT writeNBT(Capability<IRoomHistory> capability, IRoomHistory instance, Direction side) {
+            return instance.serializeNBT();
+        }
 
-                    @Override
-                    public void readNBT(Capability<IRoomHistory> capability, IRoomHistory instance, Direction side, INBT nbt) {
+        @Override
+        public void readNBT(Capability<IRoomHistory> capability, IRoomHistory instance, Direction side, INBT nbt) {
+            if(nbt instanceof ListNBT)
+                instance.deserializeNBT((ListNBT) nbt);
+        }
+    }
 
-                    }
-                }, CMRoomHistory::new);
+    public static void register() {
+        CapabilityManager.INSTANCE.register(IRoomHistory.class, new CapabilityRoomHistoryStorage(), CMRoomHistory::new);
     }
 }

src/main/java/dev/compactmods/machines/rooms/capability/IRoomHistory.java

@@ -1,14 +1,15 @@
 package dev.compactmods.machines.rooms.capability;
 
 import dev.compactmods.machines.rooms.history.IRoomHistoryItem;
+import net.minecraft.nbt.ListNBT;
+import net.minecraftforge.common.util.INBTSerializable;
 
-public interface IRoomHistory {
+public interface IRoomHistory extends INBTSerializable<ListNBT> {
 
     void clear();
     boolean hasHistory();
     IRoomHistoryItem peek();
     IRoomHistoryItem pop();
 
     void addHistory(IRoomHistoryItem item);
-
 }

src/main/java/dev/compactmods/machines/rooms/capability/PlayerRoomHistoryCapProvider.java

@@ -3,12 +3,15 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import net.minecraft.entity.player.PlayerEntity;
+import net.minecraft.nbt.CompoundNBT;
 import net.minecraft.util.Direction;
 import net.minecraftforge.common.capabilities.Capability;
 import net.minecraftforge.common.capabilities.ICapabilityProvider;
+import net.minecraftforge.common.util.Constants;
+import net.minecraftforge.common.util.INBTSerializable;
 import net.minecraftforge.common.util.LazyOptional;
 
-public class PlayerRoomHistoryCapProvider implements ICapabilityProvider {
+public class PlayerRoomHistoryCapProvider implements ICapabilityProvider, INBTSerializable<CompoundNBT> {
 
     private final PlayerEntity player;
     private final CMRoomHistory history;
@@ -28,4 +31,19 @@ public <T> LazyOptional<T> getCapability(@Nonnull Capability<T> cap, @Nullable D
 
         return LazyOptional.empty();
     }
+
+    @Override
+    public CompoundNBT serializeNBT() {
+        CompoundNBT nbt = new CompoundNBT();
+        nbt.put("history", history.serializeNBT());
+        return nbt;
+    }
+
+    @Override
+    public void deserializeNBT(CompoundNBT nbt) {
+        if(nbt.contains("history")) {
+            history.clear();
+            history.deserializeNBT(nbt.getList("history", Constants.NBT.TAG_COMPOUND));
+        }
+    }
 }

src/main/java/dev/compactmods/machines/rooms/history/PlayerRoomHistoryItem.java

@@ -1,12 +1,19 @@
 package dev.compactmods.machines.rooms.history;
 
+import com.mojang.serialization.Codec;
+import com.mojang.serialization.codecs.RecordCodecBuilder;
 import dev.compactmods.machines.teleportation.DimensionalPosition;
 
 public class PlayerRoomHistoryItem implements IRoomHistoryItem {
 
     private final DimensionalPosition entry;
     private final int machine;
 
+    public static final Codec<IRoomHistoryItem> CODEC = RecordCodecBuilder.create(i -> i.group(
+            DimensionalPosition.CODEC.fieldOf("position").forGetter(IRoomHistoryItem::getEntryLocation),
+            Codec.INT.fieldOf("machine").forGetter(IRoomHistoryItem::getMachine)
+    ).apply(i, PlayerRoomHistoryItem::new));
+
     public PlayerRoomHistoryItem(DimensionalPosition entry, int machine) {
         this.entry = entry;
         this.machine = machine;