Further API/documentation work

Author: 62832

src/main/java/gripe/_90/appliede/client/screen/TransmutationTerminalScreen.java

@@ -31,7 +31,7 @@ public class TransmutationTerminalScreen<C extends TransmutationTerminalMenu> ex
 
     public TransmutationTerminalScreen(C menu, Inventory playerInventory, Component title, ScreenStyle style) {
         super(menu, playerInventory, title, style);
-        toggleShiftButton = new ToggleButton(Icon.ARROW_LEFT, Icon.ARROW_UP, menu::setShiftToTransmute);
+        toggleShiftButton = new ToggleButton(Icon.ARROW_LEFT, Icon.ARROW_UP, b -> menu.toggleShiftToTransmute());
         toggleShiftButton.setTooltipOn(List.of(SHIFT_TRANSMUTING, TOGGLE_STORING));
         toggleShiftButton.setTooltipOff(List.of(SHIFT_STORING, TOGGLE_TRANSMUTING));
         widgets.add("toggleShiftToTransmute", toggleShiftButton);

src/main/java/gripe/_90/appliede/integration/ae2wtlib/WTTMenuHost.java

@@ -34,8 +34,8 @@ public boolean getShiftToTransmute() {
     }
 
     @Override
-    public void setShiftToTransmute(boolean shift) {
-        shiftToTransmute = shift;
+    public void toggleShiftToTransmute() {
+        shiftToTransmute = !shiftToTransmute;
         getItemStack().set(AppliedE.SHIFT_TO_TRANSMUTE.get(), shiftToTransmute);
     }
 }

src/main/java/gripe/_90/appliede/me/misc/TransmutationTerminalHost.java

@@ -3,8 +3,32 @@
 import appeng.api.networking.security.IActionHost;
 import appeng.api.storage.ITerminalHost;
 
+/**
+ * An extension of {@link ITerminalHost} for functionality specific to the {@linkplain
+ * gripe._90.appliede.menu.TransmutationTerminalMenu Transmutation Terminal menu}.
+ */
 public interface TransmutationTerminalHost extends ITerminalHost, IActionHost {
+    /**
+     * @return Whether "Shift to Transmute" mode is set for the menu, or in other words whether quick-moved
+     * (Shift+Click) item stacks should be sent to the "transmutation" slot and turned to EMC rather than deposited to
+     * the network's regular item storage.
+     */
     boolean getShiftToTransmute();
 
-    void setShiftToTransmute(boolean shift);
+    /**
+     * Toggles where quick-moved (Shift+Click) item stacks are sent within the Transmutation Terminal menu, i.e. whether
+     * these should be directly transmuted to EMC or sent to the network's regular item storage.
+     */
+    default void toggleShiftToTransmute() {
+        setShiftToTransmute(getShiftToTransmute());
+    }
+
+    /**
+     * Sets whether quick-moved (Shift+Click) item stacks should be directly transmuted to EMC or sent to the network's
+     * regular item storage.
+     *
+     * @deprecated Replaced by {@code toggleShiftToTransmute()}.
+     */
+    @Deprecated(forRemoval = true)
+    default void setShiftToTransmute(boolean shift) {}
 }

src/main/java/gripe/_90/appliede/me/service/KnowledgeService.java

@@ -4,6 +4,7 @@
 import java.util.Set;
 import java.util.UUID;
 
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Nullable;
 
 import appeng.api.networking.IGridService;
@@ -19,9 +20,11 @@
  * implements {@link gripe._90.appliede.me.misc.TransmutationCapable TransmutationCapable} as the "action source" for
  * these operations to be able to transmute items into / out of EMC.
  */
+@ApiStatus.NonExtendable
 public interface KnowledgeService extends IGridService {
     /**
-     * @param uuid The UUID for a given player's Minecraft profile
+     * @param uuid The UUID for a given player's Minecraft profile. Can be {@code null}, but the returned provider will
+     *             also be {@code null} as a result.
      * @return The {@link IKnowledgeProvider} for the (tracked) player with the given UUID (typically via player
      * {@linkplain net.neoforged.neoforge.capabilities.EntityCapability entity capabilities}), or {@code null} if the
      * UUID is not being tracked (i.e. the player with the given UUID does not have a Transmutation Module installed

src/main/java/gripe/_90/appliede/menu/TransmutationTerminalMenu.java

@@ -35,7 +35,7 @@ public class TransmutationTerminalMenu extends MEStorageMenu implements Transmut
     protected static final SlotSemantic TRANSMUTE = SlotSemantics.register("APPLIEDE_TRANSMUTE", false);
     protected static final SlotSemantic UNLEARN = SlotSemantics.register("APPLIEDE_UNLEARN", false);
 
-    private static final String ACTION_SET_SHIFT = "setShiftDestination";
+    private static final String ACTION_TOGGLE_SHIFT = "toggleShiftDestination";
     private static final String ACTION_HIDE_LEARNED = "hideLearnedText";
     private static final String ACTION_HIDE_UNLEARNED = "hideUnlearnedText";
 
@@ -65,7 +65,7 @@ public TransmutationTerminalMenu(
         this.host = host;
         transmutationSource = IActionSource.ofPlayer(getPlayer(), this);
 
-        registerClientAction(ACTION_SET_SHIFT, Boolean.class, host::setShiftToTransmute);
+        registerClientAction(ACTION_TOGGLE_SHIFT, host::toggleShiftToTransmute);
         registerClientAction(ACTION_HIDE_LEARNED, () -> learnedLabelTicks--);
         registerClientAction(ACTION_HIDE_UNLEARNED, () -> unlearnedLabelTicks--);
         addSlot(transmuteSlot, TRANSMUTE);
@@ -166,13 +166,13 @@ public void onLearn() {
         broadcastChanges();
     }
 
-    public void setShiftToTransmute(boolean transmute) {
+    public void toggleShiftToTransmute() {
         if (isClientSide()) {
-            sendClientAction(ACTION_SET_SHIFT, transmute);
+            sendClientAction(ACTION_TOGGLE_SHIFT);
             return;
         }
 
-        shiftToTransmute = transmute;
+        shiftToTransmute = !shiftToTransmute;
     }
 
     public void decrementLearnedTicks() {

src/main/java/gripe/_90/appliede/part/TransmutationTerminalPart.java

@@ -38,8 +38,8 @@ public boolean getShiftToTransmute() {
     }
 
     @Override
-    public void setShiftToTransmute(boolean shift) {
-        shiftToTransmute = shift;
+    public void toggleShiftToTransmute() {
+        shiftToTransmute = !shiftToTransmute;
         saveChanges();
     }