Merge PR #121 by @Avalancs - tutorial improvement.

Author: Cervator

main/src/org/destinationsol/game/SolGame.java

@@ -108,7 +108,7 @@ public SolGame(SolApplication cmp, boolean usePrevShip, TextureManager textureMa
     myDraMan = new DraMan(drawer);
     myCam = new SolCam(drawer.r);
     myScreens = new GameScreens(drawer.r, cmp);
-    myTutorialManager = tut ? new TutorialManager(commonDrawer.r, myScreens, cmp.isMobile(), cmp.getOptions()) : null;
+    myTutorialManager = tut ? new TutorialManager(commonDrawer.r, myScreens, cmp.isMobile(), cmp.getOptions(), this) : null;
     myTextureManager = textureManager;
     myFarBackgroundManagerOld = new FarBackgroundManagerOld(myTextureManager);
     myShipBuilder = new ShipBuilder();

main/src/org/destinationsol/game/screens/InventoryScreen.java

@@ -325,4 +325,22 @@ public InventoryOperations getOperations() {
   public int getPage() {
     return myPage;
   }
+
+  public List<SolUiControl> getEquippedItemUIControlsForTutorial(SolGame game) {
+    List<SolUiControl> controls = new ArrayList<>();
+    ItemContainer ic = myOperations.getItems(game);
+    if (ic == null) return controls;
+
+    for (int i = 0; i < itemCtrls.length; i++) {
+      int groupIdx = myPage * Const.ITEM_GROUPS_PER_PAGE + i;
+      int groupCount = ic.groupCount();
+      if (groupCount <= groupIdx) continue;
+      SolUiControl itemCtrl = itemCtrls[i];
+      List<SolItem> group = ic.getGroup(groupIdx);
+      SolItem item = group.get(0);
+      if (myOperations.isUsing(game, item))
+        controls.add(itemCtrl);
+    }
+    return controls;
+  }
 }

main/src/org/destinationsol/ui/TutorialManager.java

@@ -19,20 +19,20 @@
 import com.badlogic.gdx.math.Rectangle;
 import org.destinationsol.GameOptions;
 import org.destinationsol.common.SolColor;
-import org.destinationsol.game.screens.GameScreens;
-import org.destinationsol.game.screens.MainScreen;
-import org.destinationsol.game.screens.ShipKbControl;
-import org.destinationsol.game.screens.ShipMixedControl;
+import org.destinationsol.game.SolGame;
+import org.destinationsol.game.item.SolItem;
+import org.destinationsol.game.screens.*;
 
 import java.util.ArrayList;
+import java.util.List;
 
 public class TutorialManager {
   private final Rectangle myBg;
   private final ArrayList<Step> mySteps;
 
   private int myStepIdx;
 
-  public TutorialManager(float r, GameScreens screens, boolean mobile, GameOptions gameOptions) {
+  public TutorialManager(float r, GameScreens screens, boolean mobile, GameOptions gameOptions, SolGame game) {
     float bgW = r * .5f;
     float bgH = .2f;
     myBg = new Rectangle(r/2 - bgW/2, 1 - bgH, bgW, bgH);
@@ -127,10 +127,17 @@ public TutorialManager(float r, GameScreens screens, boolean mobile, GameOptions
               screens.inventoryScreen.showInventory.dropCtrl);
     }
 
+    // Extra step to make sure an equipped item is selected before asking player to unequip
+    if(screens.inventoryScreen.getSelectedItem() == null ||
+      (screens.inventoryScreen.getSelectedItem() != null && screens.inventoryScreen.getSelectedItem().isEquipped() == 0)) {
+        s(new SelectEquippedItemStep(
+          "Select an equipped item\n(note the text \"using\")", screens.inventoryScreen, game));
+    }
+
     if (mobile) {
-      s("Unequip some item\nthat is used now", screens.inventoryScreen.showInventory.eq1Ctrl);
+      s("Unequip the item\nthat is used now", screens.inventoryScreen.showInventory.eq1Ctrl);
     } else {
-      s("Unequip some item\nthat is used now (" + gameOptions.getKeyEquipName() + " key)",
+      s("Unequip the item\nthat is used now (" + gameOptions.getKeyEquipName() + " key)",
               screens.inventoryScreen.showInventory.eq1Ctrl);
     }
 
@@ -209,11 +216,14 @@ private void s(String text, SolUiControl ctrl) {
   private void s(String text, SolUiControl ctrl, boolean checkOn) {
     mySteps.add(new Step(text, ctrl, checkOn));
   }
+  private void s(Step step) {
+    mySteps.add(step);
+  }
 
   public void update() {
     Step step = mySteps.get(myStepIdx);
-    step.ctrl.enableWarn();
-    if (step.checkOn ? step.ctrl.isOn() : step.ctrl.isJustOff()) {
+    step.highlight();
+    if (step.canProgressToNextStep()) {
       myStepIdx++;
     }
   }
@@ -239,5 +249,45 @@ public Step(String text, SolUiControl ctrl, boolean checkOn) {
       this.ctrl = ctrl;
       this.checkOn = checkOn;
     }
+
+    // highlight control that needs to be pressed
+    public void highlight() {
+      if(ctrl != null) ctrl.enableWarn();
+    }
+
+    public boolean canProgressToNextStep() {
+      if(checkOn) {
+        return ctrl.isOn();
+      } else {
+        return ctrl.isJustOff();
+      }
+    }
+  }
+
+  public static class SelectEquippedItemStep extends Step {
+      InventoryScreen inventoryScreen;
+      SolGame game;
+
+      public SelectEquippedItemStep(String text, InventoryScreen inventoryScreen, SolGame game) {
+        super(text, null, true);
+        this.inventoryScreen = inventoryScreen;
+        this.game = game;
+      }
+
+      @Override
+      public boolean canProgressToNextStep() {
+        SolItem selected = inventoryScreen.getSelectedItem();
+        if(selected != null && selected.isEquipped() != 0) return true;
+        return false;
+      }
+
+      // Highlight all equipped items on opened inventory page
+      @Override
+      public void highlight() {
+        List<SolUiControl> equippedItemControls = inventoryScreen.getEquippedItemUIControlsForTutorial(game);
+        for(SolUiControl control : equippedItemControls) {
+          control.enableWarn();
+        }
+      }
   }
 }