Story Arc Editor

MekHQ/resources/mekhq/resources/GUI.properties

@@ -1196,7 +1196,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/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;
     }
@@ -246,6 +250,15 @@ public String toString() {
         return getTitle();
     }
 
+    public boolean isDuplicateName(String name) {
+        for(StoryPoint sp : getStoryPoints()) {
+            if(sp.getName().equals(name)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     //region EventHandlers
     @Subscribe
     public void handleScenarioResolved(ScenarioResolvedEvent ev) {

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

@@ -21,6 +21,7 @@
 package mekhq.campaign.storyarc;
 
 import megamek.Version;
+import mekhq.gui.StoryPointHyperLinkListener;
 import mekhq.utilities.MHQXMLUtility;
 import mekhq.campaign.Campaign;
 import org.apache.logging.log4j.LogManager;
@@ -61,6 +62,8 @@
  */
 public abstract class StoryPoint {
 
+    public final static String DEFAULT_OUTCOME = "DEFAULT";
+
     /** The story arc that this story point is a part of **/
     private StoryArc storyArc;
 
@@ -103,15 +106,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;
     }
 
@@ -125,6 +128,30 @@ public String getName() {
         return name;
     }
 
+    public void setName(String s) {
+        name = s;
+    }
+
+    public UUID getNextStoryPointId() {
+        return nextStoryPointId;
+    }
+
+    public void setNextStoryPointId(UUID nextStoryPointId) {
+        this.nextStoryPointId = nextStoryPointId;
+    }
+
+    public List<StoryOutcome> getStoryOutcomes() {
+        return new ArrayList<StoryOutcome>(storyOutcomes.values());
+    }
+
+    public List<StoryTrigger> getStoryTriggers() {
+        return storyTriggers;
+    }
+
+    public void setStoryTriggers(List<StoryTrigger> storyTriggers) {
+        this.storyTriggers = storyTriggers;
+    }
+
     /**
      * Do whatever needs to be done to start this story point. Specific story point types may need to override this
      */
@@ -206,6 +233,53 @@ public Campaign getCampaign() {
         return getStoryArc().getCampaign();
     }
 
+    public List<String> getAllPossibleResults() {
+        ArrayList<String> results = new ArrayList<>();
+        results.add(DEFAULT_OUTCOME);
+        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='%s:%s'>%s</a>", StoryPointHyperLinkListener.STORYPOINT, getId(), getName());
+    }
+
+    public StoryOutcome getStoryOutcome(String result) {
+        return storyOutcomes.get(result);
+    }
+
+    public void addStoryOutcome(String result, StoryOutcome outcome) {
+        storyOutcomes.put(result, outcome);
+    }
+
+    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);
 
@@ -294,5 +368,4 @@ public static StoryPoint generateInstanceFromXML(Node wn, Campaign c, Version ve
 
         return retVal;
     }
-
 }

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

@@ -21,12 +21,14 @@
 package mekhq.campaign.storyarc;
 
 import megamek.Version;
+import mekhq.gui.panels.storytriggerpanels.StoryTriggerPanel;
 import mekhq.utilities.MHQXMLUtility;
 import mekhq.campaign.Campaign;
 import org.apache.logging.log4j.LogManager;
 import org.w3c.dom.NamedNodeMap;
 import org.w3c.dom.Node;
 
+import javax.swing.*;
 import java.io.PrintWriter;
 import java.text.ParseException;
 
@@ -48,7 +50,7 @@ public void setStoryArc(StoryArc a) {
         this.arc = a;
     }
 
-    protected StoryArc getStoryArc() {
+    public StoryArc getStoryArc() {
         return arc;
     }
 
@@ -61,6 +63,10 @@ protected Campaign getCampaign() {
      */
     protected abstract void execute();
 
+    public abstract String getDescription();
+
+    public abstract StoryTriggerPanel getPanel(JFrame frame);
+
     //region I/O
     public abstract void writeToXml(PrintWriter pw1, int indent);
 

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

@@ -19,6 +19,7 @@
 package mekhq.campaign.storyarc.storypoint;
 
 import megamek.Version;
+import mekhq.campaign.storyarc.StoryArc;
 import mekhq.utilities.MHQXMLUtility;
 import mekhq.campaign.Campaign;
 import mekhq.campaign.mission.Mission;
@@ -29,6 +30,8 @@
 
 import java.io.PrintWriter;
 import java.text.ParseException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.UUID;
 
 /**
@@ -61,6 +64,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_OUTCOME);
+        return results;
+    }
+
     @Override
     public void start() {
         super.start();

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

@@ -21,6 +21,8 @@
 package mekhq.campaign.storyarc.storypoint;
 
 import megamek.Version;
+import mekhq.campaign.personnel.enums.PersonnelStatus;
+import mekhq.campaign.storyarc.StoryArc;
 import mekhq.utilities.MHQXMLUtility;
 import mekhq.campaign.Campaign;
 import mekhq.campaign.personnel.Person;
@@ -31,6 +33,8 @@
 
 import java.io.PrintWriter;
 import java.text.ParseException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.UUID;
 
 /**
@@ -62,6 +66,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_OUTCOME);
+        return results;
+    }
+
     @Override
     public void start() {
         super.start();

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

@@ -21,6 +21,9 @@
 package mekhq.campaign.storyarc.storypoint;
 
 import megamek.Version;
+import mekhq.campaign.storyarc.StoryArc;
+import mekhq.campaign.storyarc.StoryTrigger;
+import mekhq.campaign.storyarc.storytrigger.ChangeStringVariableStoryTrigger;
 import mekhq.utilities.MHQXMLUtility;
 import mekhq.campaign.Campaign;
 import mekhq.campaign.storyarc.StoryPoint;
@@ -30,6 +33,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 +62,33 @@ protected String getResult() {
         return getStoryArc().getCustomStringVariable(key);
     }
 
+    @Override
+    public List<String> getAllPossibleResults() {
+        // this one is complicated, but we can find all the triggers where this has been changed and collect
+        // all possibilities
+        List<String> results = new ArrayList<>();
+        for(StoryPoint sp : getStoryArc().getStoryPoints()) {
+            for(StoryTrigger trigger : sp.getStoryTriggers()) {
+                if(trigger instanceof ChangeStringVariableStoryTrigger) {
+                    if(!((ChangeStringVariableStoryTrigger)trigger).getKey().equals(key)) {
+                        continue;
+                    }
+                    String value = ((ChangeStringVariableStoryTrigger)trigger).getValue();
+                    if(!results.contains(value)) {
+                        results.add(value);
+                    }
+                }
+            }
+        }
+        // finally, check the current value of this variable and add it if not already there
+        String value = getStoryArc().getCustomStringVariable(key);
+        if(!results.contains(value)) {
+            results.add(value);
+        }
+        results.add(DEFAULT_OUTCOME);
+        return results;
+    }
+
     @Override
     public void start() {
         super.start();