Add get/setUpgrade to IPocketAccess

We have similar methods in ITurtleAccess, so makes sense for them to be here too.
cc-tweaked · Jul 26, 2024 · 6c8e64f · 6c8e64f
1 parent 7285c32
commit 6c8e64f
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 10 deletions.
diff --git a/projects/common-api/src/main/java/dan200/computercraft/api/pocket/IPocketAccess.java b/projects/common-api/src/main/java/dan200/computercraft/api/pocket/IPocketAccess.java
@@ -6,17 +6,20 @@
 
 import dan200.computercraft.api.peripheral.IPeripheral;
 import dan200.computercraft.api.upgrades.UpgradeBase;
+import dan200.computercraft.api.upgrades.UpgradeData;
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.entity.Entity;
 import net.minecraft.world.item.ItemStack;
+import org.jetbrains.annotations.ApiStatus;
 
 import javax.annotation.Nullable;
 import java.util.Map;
 
 /**
  * Wrapper class for pocket computers.
  */
+@ApiStatus.NonExtendable
 public interface IPocketAccess {
     /**
      * Gets the entity holding this item.
@@ -64,6 +67,26 @@ public interface IPocketAccess {
      */
     void setLight(int colour);
 
+    /**
+     * Get the currently equipped upgrade.
+     *
+     * @return The currently equipped upgrade.
+     * @see #getUpgradeNBTData()
+     * @see #setUpgrade(UpgradeData)
+     */
+    @Nullable
+    UpgradeData<IPocketUpgrade> getUpgrade();
+
+    /**
+     * Set the upgrade for this pocket computer, also updating the item stack.
+     * <p>
+     * Note this method is not thread safe - it must be called from the server thread.
+     *
+     * @param upgrade The new upgrade to set it to, may be {@code null}.
+     * @see #getUpgrade()
+     */
+    void setUpgrade(@Nullable UpgradeData<IPocketUpgrade> upgrade);
+
     /**
      * Get the upgrade-specific NBT.
      * <p>
@@ -73,6 +96,7 @@ public interface IPocketAccess {
      * @see #updateUpgradeNBTData()
      * @see UpgradeBase#getUpgradeItem(CompoundTag)
      * @see UpgradeBase#getUpgradeData(ItemStack)
+     * @see #getUpgrade()
      */
     CompoundTag getUpgradeNBTData();
 

diff --git a/projects/common/src/main/java/dan200/computercraft/shared/pocket/apis/PocketAPI.java b/projects/common/src/main/java/dan200/computercraft/shared/pocket/apis/PocketAPI.java
@@ -6,10 +6,10 @@
 
 import dan200.computercraft.api.lua.ILuaAPI;
 import dan200.computercraft.api.lua.LuaFunction;
+import dan200.computercraft.api.pocket.IPocketAccess;
 import dan200.computercraft.api.pocket.IPocketUpgrade;
 import dan200.computercraft.api.upgrades.UpgradeData;
 import dan200.computercraft.impl.PocketUpgrades;
-import dan200.computercraft.shared.pocket.core.PocketServerComputer;
 import net.minecraft.core.NonNullList;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.ItemStack;
@@ -34,10 +34,10 @@
  * @cc.module pocket
  */
 public class PocketAPI implements ILuaAPI {
-    private final PocketServerComputer computer;
+    private final IPocketAccess pocket;
 
-    public PocketAPI(PocketServerComputer computer) {
-        this.computer = computer;
+    public PocketAPI(IPocketAccess pocket) {
+        this.pocket = pocket;
     }
 
     @Override
@@ -56,10 +56,10 @@ public String[] getNames() {
      */
     @LuaFunction(mainThread = true)
     public final Object[] equipBack() {
-        var entity = computer.getEntity();
+        var entity = pocket.getEntity();
         if (!(entity instanceof Player player)) return new Object[]{ false, "Cannot find player" };
         var inventory = player.getInventory();
-        var previousUpgrade = computer.getUpgrade();
+        var previousUpgrade = pocket.getUpgrade();
 
         // Attempt to find the upgrade, starting in the main segment, and then looking in the opposite
         // one. We start from the position the item is currently in and loop round to the start.
@@ -73,7 +73,7 @@ public final Object[] equipBack() {
         if (previousUpgrade != null) storeItem(player, previousUpgrade.getUpgradeItem());
 
         // Set the new upgrade
-        computer.setUpgrade(newUpgrade);
+        pocket.setUpgrade(newUpgrade);
 
         return new Object[]{ true };
     }
@@ -87,13 +87,13 @@ public final Object[] equipBack() {
      */
     @LuaFunction(mainThread = true)
     public final Object[] unequipBack() {
-        var entity = computer.getEntity();
+        var entity = pocket.getEntity();
         if (!(entity instanceof Player player)) return new Object[]{ false, "Cannot find player" };
-        var previousUpgrade = computer.getUpgrade();
+        var previousUpgrade = pocket.getUpgrade();
 
         if (previousUpgrade == null) return new Object[]{ false, "Nothing to unequip" };
 
-        computer.setUpgrade(null);
+        pocket.setUpgrade(null);
 
         storeItem(player, previousUpgrade.getUpgradeItem());
 

diff --git a/...ts/common/src/main/java/dan200/computercraft/shared/pocket/core/PocketServerComputer.java b/...ts/common/src/main/java/dan200/computercraft/shared/pocket/core/PocketServerComputer.java
@@ -111,6 +111,7 @@ public Map<ResourceLocation, IPeripheral> getUpgrades() {
         return upgrade == null ? Map.of() : Collections.singletonMap(upgrade.getUpgradeID(), getPeripheral(ComputerSide.BACK));
     }
 
+    @Override
     public @Nullable UpgradeData<IPocketUpgrade> getUpgrade() {
         return upgrade == null ? null : UpgradeData.of(upgrade, getUpgradeNBTData());
     }
@@ -122,6 +123,7 @@ public Map<ResourceLocation, IPeripheral> getUpgrades() {
      *
      * @param upgrade The new upgrade to set it to, may be {@code null}.
      */
+    @Override
     public void setUpgrade(@Nullable UpgradeData<IPocketUpgrade> upgrade) {
         synchronized (this) {
             PocketComputerItem.setUpgrade(stack, upgrade);