Changeset 76 in tmcsimulator-scriptbuilder for trunk/src/scriptbuilder/structures/SimulationScript.java

Timestamp:

08/25/2017 12:22:28 PM (9 years ago)

Author:

bmcguffin

Message:

Added javadoc for several files.

File:

• trunk/src/scriptbuilder/structures/SimulationScript.java (modified) (4 diffs)

trunk/src/scriptbuilder/structures/SimulationScript.java

@@ -50 +50 @@
     };
 
+    /**
+     * The file to which this script will be saved.
+     */
     public File saveFile = null;
 
+    /**
+     * The name of this script.
+     */
     public String title = "";
 
@@ -160 +166 @@
     }
 
+    /**
+     * Add a new incident to the script.
+     *
+     * @param sci the incident to be added.
+     * @return true if there was enough room to add this incident.
+     */
     public boolean addIncident(ScriptIncident sci)
     {
@@ -170 +182 @@
     }
 
+    /**
+     * Write this script, in proper XML format, to the file in question.
+     *
+     * @param f the destination savefile to be written.
+     */
     public void saveScriptToFile(File f)
     {
@@ -262 +279 @@
     }
 
+    /**
+     * Counts the number of incidents currently running.
+     *
+     * @return the number of non-null incidents currently in the script. A
+     * number between 0 and INCIDENT_FILL_COUNT, inclusive.
+     */
     public int incidentCount()
     {