Story Arc Editor

MekHQ/resources/mekhq/resources/GUI.properties

@@ -1190,7 +1190,7 @@ btnNewCampaign.text=Start a New Campaign
 btnLoadCampaign.text=Load a Campaign
 btnLoadLastCampaign.text=Load Last Save
 btnLoadStoryArc.text=Load a Story Arc
-
+btnStoryArcEditor.text=Story Arc Editor
 
 ##### Panes
 #### RankSystemsPane Class

MekHQ/resources/mekhq/resources/StoryArcEditorGUI.properties

@@ -0,0 +1,4 @@
+fileMenu.text=File
+miNewArc.text=New Story Arc...
+miLoadArc.text=Load Story Arc...
+miSaveArc.text=Save Story Arc

MekHQ/src/mekhq/MekHQ.java

@@ -42,9 +42,11 @@
 import mekhq.campaign.mission.AtBContract;
 import mekhq.campaign.mission.AtBScenario;
 import mekhq.campaign.mission.Scenario;
+import mekhq.campaign.storyarc.StoryArc;
 import mekhq.campaign.stratcon.StratconRulesManager;
 import mekhq.campaign.unit.Unit;
 import mekhq.gui.CampaignGUI;
+import mekhq.gui.StoryArcEditorGUI;
 import mekhq.gui.dialog.ResolveScenarioWizardDialog;
 import mekhq.gui.dialog.RetirementDefectionDialog;
 import mekhq.gui.panels.StartupScreenPanel;
@@ -95,6 +97,7 @@ public class MekHQ implements GameListener {
     // the actual campaign - this is where the good stuff is
     private CampaignController campaignController;
     private CampaignGUI campaignGUI;
+    private StoryArcEditorGUI storyArcEditorGUI;
 
     private IconPackage iconPackage = new IconPackage();
 
@@ -246,6 +249,10 @@ public void showNewView() {
         campaignGUI = new CampaignGUI(this);
     }
 
+    public void showNewStoryArcEditor(StoryArc arc) {
+        storyArcEditorGUI = new StoryArcEditorGUI(this, arc);
+    }
+
     /**
      * Main method launching the application.
      */

MekHQ/src/mekhq/StoryPointHyperLinkListener.java

@@ -0,0 +1,36 @@
+package mekhq;
+
+import mekhq.campaign.storyarc.StoryArc;
+import mekhq.gui.StoryArcEditorGUI;
+import org.apache.logging.log4j.LogManager;
+
+import javax.swing.event.HyperlinkEvent;
+import javax.swing.event.HyperlinkListener;
+import java.util.UUID;
+
+public class StoryPointHyperLinkListener implements HyperlinkListener {
+
+    private StoryArc storyArc;
+    private StoryArcEditorGUI editorGUI;
+
+    public static final String STORYPOINT = "STORYPOINT";
+
+    public StoryPointHyperLinkListener(final StoryArc arc, final StoryArcEditorGUI gui) {
+        this.storyArc = arc;
+        this.editorGUI = gui;
+    }
+
+    @Override
+    public void hyperlinkUpdate(HyperlinkEvent evt) {
+        if (evt.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
+            if (evt.getDescription().startsWith(STORYPOINT)) {
+                try {
+                    final UUID id = UUID.fromString(evt.getDescription().split(":")[1]);
+                    editorGUI.focusOnStoryPoint(id);
+                } catch (Exception e) {
+                    LogManager.getLogger().error("", e);
+                }
+            }
+        }
+    }
+}

MekHQ/src/mekhq/campaign/storyarc/StoryArc.java

@@ -155,6 +155,10 @@ private UUID getStartingPointId() {
         return startingPointId;
     }
 
+    public List<StoryPoint> getStoryPoints() {
+        return new ArrayList<StoryPoint>(storyPoints.values());
+    }
+
     public void setInitCampaignPath(String s) {
         this.initCampaignPath =s;
     }

MekHQ/src/mekhq/campaign/storyarc/StoryOutcome.java

@@ -48,22 +48,34 @@ public class StoryOutcome {
     /** A list of StoryTriggers to replace the defaults on this outcome */
     List<StoryTrigger> storyTriggers;
 
-    StoryOutcome()  {
+    public StoryOutcome()  {
         storyTriggers = new ArrayList<>();
     }
 
     public String getResult() {
         return result;
     }
 
+    public void setResult(String r) {
+        this.result = r;
+    }
+
     public UUID getNextStoryPointId() {
         return nextStoryPointId;
     }
 
+    public void setNextStoryPointId(UUID id) {
+        this.nextStoryPointId = id;
+    }
+
     public List<StoryTrigger> getStoryTriggers() {
         return storyTriggers;
     }
 
+    public void setStoryTriggers(List<StoryTrigger> triggers) {
+        this.storyTriggers = triggers;
+    }
+
     /**
      * Set the StoryArc on all StoryTriggers here
      * @param a a {@link StoryArc StoryArc}

MekHQ/src/mekhq/campaign/storyarc/StoryPoint.java

@@ -112,15 +112,15 @@ public void setStoryArc(StoryArc a) {
         }
     }
 
-    protected StoryArc getStoryArc() {
+    public StoryArc getStoryArc() {
         return storyArc;
     }
 
     public void setId(UUID id) {
         this.id = id;
     }
 
-    protected UUID getId() {
+    public UUID getId() {
         return id;
     }
 
@@ -134,13 +134,25 @@ public String getName() {
         return name;
     }
 
+    public UUID getNextStoryPointId() {
+        return nextStoryPointId;
+    }
+
     public Image getImage() {
         if(storySplash.isDefault()) {
             return null;
         }
         return storySplash.getImage();
     }
 
+    public List<StoryOutcome> getStoryOutcomes() {
+        return new ArrayList<StoryOutcome>(storyOutcomes.values());
+    }
+
+    public List<StoryTrigger> getStoryTriggers() {
+        return storyTriggers;
+    }
+
     /**
      * Do whatever needs to be done to start this story point. Specific story point types may need to override this
      */
@@ -234,6 +246,45 @@ public Campaign getCampaign() {
         return getStoryArc().getCampaign();
     }
 
+    public List<String> getAllPossibleResults() {
+        ArrayList<String> results = new ArrayList<>();
+        results.add("DEFAULT");
+        return results;
+    }
+
+    public List<StoryPoint> getLinkingStoryPoints() {
+        List previous = new ArrayList<StoryPoint>();
+        UUID nextId;
+        for (StoryPoint otherStoryPoint : storyArc.getStoryPoints()) {
+            nextId = otherStoryPoint.getNextStoryPointId();
+            if ((nextId != null) && (nextId.equals(getId()))) {
+                previous.add(otherStoryPoint);
+                continue;
+            }
+            for( StoryOutcome outcome : otherStoryPoint.getStoryOutcomes()) {
+                nextId = outcome.getNextStoryPointId();
+                if ((nextId != null) && (nextId.equals(getId()))) {
+                    previous.add(otherStoryPoint);
+                    continue;
+                }
+            }
+        }
+        return previous;
+    }
+
+    public String getHyperlinkedName() {
+        return String.format("<a href='STORYPOINT:%s'>%s</a>", getId(), getName());
+    }
+
+    public void removeStoryOutcome(String result) {
+        storyOutcomes.remove(result);
+    }
+
+    public void removeDefaultOutcome() {
+        nextStoryPointId = null;
+        storyTriggers = new ArrayList<>();
+    }
+
     //region I/O
     public abstract void writeToXml(PrintWriter pw1, int indent);
 

MekHQ/src/mekhq/campaign/storyarc/StoryTrigger.java

@@ -61,6 +61,8 @@ protected Campaign getCampaign() {
      */
     protected abstract void execute();
 
+    public abstract String getDescription();
+
     //region I/O
     public abstract void writeToXml(PrintWriter pw1, int indent);
 

MekHQ/src/mekhq/campaign/storyarc/storypoint/CheckMoreScenariosStoryPoint.java

@@ -29,6 +29,8 @@
 
 import java.io.PrintWriter;
 import java.text.ParseException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.UUID;
 
 /**
@@ -61,6 +63,15 @@ protected String getResult() {
         return "true";
     }
 
+    @Override
+    public List<String> getAllPossibleResults() {
+        ArrayList<String> results = new ArrayList<>();
+        results.add("true");
+        results.add("false");
+        results.add("DEFAULT");
+        return results;
+    }
+
     @Override
     public void start() {
         super.start();

MekHQ/src/mekhq/campaign/storyarc/storypoint/CheckPersonStatusStoryPoint.java

@@ -21,6 +21,7 @@
 package mekhq.campaign.storyarc.storypoint;
 
 import megamek.Version;
+import mekhq.campaign.personnel.enums.PersonnelStatus;
 import mekhq.utilities.MHQXMLUtility;
 import mekhq.campaign.Campaign;
 import mekhq.campaign.personnel.Person;
@@ -31,6 +32,8 @@
 
 import java.io.PrintWriter;
 import java.text.ParseException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.UUID;
 
 /**
@@ -62,6 +65,16 @@ protected String getResult() {
         }
     }
 
+    @Override
+    public List<String> getAllPossibleResults() {
+        ArrayList<String> results = new ArrayList<>();
+        for(PersonnelStatus status : PersonnelStatus.getImplementedStatuses()) {
+            results.add(status.name());
+        }
+        results.add("DEFAULT");
+        return results;
+    }
+
     @Override
     public void start() {
         super.start();

MekHQ/src/mekhq/campaign/storyarc/storypoint/CheckStringVariableStoryPoint.java

@@ -30,6 +30,8 @@
 
 import java.io.PrintWriter;
 import java.text.ParseException;
+import java.util.ArrayList;
+import java.util.List;
 
 /**
  * This StoryPoint checks the value of a stored string variable from the
@@ -57,6 +59,16 @@ protected String getResult() {
         return getStoryArc().getCustomStringVariable(key);
     }
 
+    @Override
+    public List<String> getAllPossibleResults() {
+        // we cannot know how many possibilities there are apriori, so we just use CUSTOM, which will allow
+        // the user to specify outcome matching result
+        List<String> results = new ArrayList<>();
+        results.add("CUSTOM");
+        results.add("DEFAULT");
+        return results;
+    }
+
     @Override
     public void start() {
         super.start();

MekHQ/src/mekhq/campaign/storyarc/storypoint/ChoiceStoryPoint.java

@@ -31,7 +31,9 @@
 
 import java.io.PrintWriter;
 import java.text.ParseException;
+import java.util.ArrayList;
 import java.util.LinkedHashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 
@@ -66,6 +68,13 @@ public Map<String, String> getChoices() {
         return choices;
     }
 
+    @Override
+    public List<String> getAllPossibleResults() {
+        List<String> results = new ArrayList<String>(choices.keySet());
+        results.add("DEFAULT");
+        return results;
+    }
+
     @Override
     public void start() {
         super.start();

MekHQ/src/mekhq/campaign/storyarc/storypoint/MissionStoryPoint.java

@@ -128,6 +128,15 @@ public String getObjective() {
         return "Complete " + mission.getName() + " mission";
     }
 
+    @Override
+    public List<String> getAllPossibleResults() {
+        ArrayList<String> results = new ArrayList<>();
+        results.add(MissionStatus.FAILED.name());
+        results.add(MissionStatus.SUCCESS.name());
+        results.add("DEFAULT");
+        return results;
+    }
+
     @Override
     public void writeToXml(PrintWriter pw1, int indent) {
         writeToXmlBegin(pw1, indent++);

MekHQ/src/mekhq/campaign/storyarc/storypoint/RollDiceStoryPoint.java

@@ -29,6 +29,8 @@
 
 import java.io.PrintWriter;
 import java.text.ParseException;
+import java.util.ArrayList;
+import java.util.List;
 
 /**
  * This StoryPoint rolls some dice and returns the result. It can be used when some randomization is required.
@@ -51,6 +53,7 @@
     @Override
     public void start() {
         super.start();
+        //index zero should contain the summed result
         value = Compute.individualDice(ndice, sides).get(0);
         complete();
     }
@@ -60,6 +63,16 @@
         return Integer.toString(value);
     }
 
+    public List<String> getAllPossibleResults() {
+        int min = ndice;
+        int max = ndice * sides;
+        List<String> results = new ArrayList<>();
+        for(int i = min; i <= max; i++) {
+            results.add(Integer.toString(i));
+        }
+        results.add("DEFAULT");
+        return results;
+    }
     @Override
     public void writeToXml(PrintWriter pw1, int indent) {
         writeToXmlBegin(pw1, indent++);