v2.1.9

Improved the documentation for scripted widgets and their APIs.

Added missing `widget-icon` values.

Corrected documented argument order for `object.set_progress_bar`.

Corrected description for the `player_skull` variant ID.

Widget position 11 is now listed as "Bottom Right (Meter Only)."

When creating a new variant from scratch, the main window's title bar should no longer display the internal Qt resource path for the "blank" variant files.

When creating a new variant from scratch and saving it via "Save As," the "Save" option should become available.

Fixed documentation generation: we now properly handle notes with IDs.

Regenerated the help manual.

Author: DavidJCobb

native/src/RVTDocumentationProcessor/content/base.cpp

@@ -39,7 +39,7 @@ namespace content {
          }
          has_any_named = true;
          //
-         bool has_id = note.id.isEmpty();
+         bool has_id = !note.id.isEmpty();
          out += QString("<h3>%1%2%3</h3>\n")
             .arg(has_id ? QString("<a name=\"%1\">").arg(note.id) : "")
             .arg(note.title)

native/src/ReachVariantTool/ReachVariantTool.rc

@@ -3,8 +3,8 @@ IDI_ICON1		ICON		DISCARDABLE	"ReachVariantTool.ico"
 // Edit these to control the embedded version information.
 #define VER_MAJOR 2
 #define VER_MINOR 1
-#define VER_PATCH 8
-#define VER_BUILD 2
+#define VER_PATCH 9
+#define VER_BUILD 0
 
 // No need to edit anything below here. :)
 

native/src/ReachVariantTool/docs/working - help docs/editor/script_window/script-widgets.xml

@@ -14,12 +14,20 @@
          two HUD widgets have the same position, they will not overlap; they will be 
          positioned adjacent to each other in an intelligent fashion. However, some 
          widget positions will overlap standard HUD elements such as the shield bar 
-         or motion tracker.
+         or motion tracker. Additionally, if a gametype tries to display more than two 
+         widgets to the same player at the same position, only two of them will actually 
+         be shown by the game, preferring ones earlier in the widget list.
       </p>
       <p>
          Most of the page is taken up by an image which displays where the HUD widget 
          will appear. This preview only shows the selected widget, and it assumes that 
          only the selected widget is showing.
       </p>
+      <p>
+         Note that the bottom-right widget position is only suitable for "meter" widgets 
+         &mdash; that is, those which use the "set_meter_params" function. Widgets in 
+         this position can display icons and meters, but not any text. The widget will 
+         appear below the hardcoded scoring UI.
+      </p>
    </body>
 </article>

native/src/ReachVariantTool/docs/working - help docs/script/api/object.xml

@@ -447,28 +447,28 @@
          </method>
          <method name="set_progress_bar" id="15">
             <args>
-               <arg name="who" type="player-set" />
                <arg name="timer">
                   The word <var>none</var>, or an integer constant indicating the index of an 
                   object.timer variable, or a relative alias of an object-timer variable 
                   prefixed with <code>object.</code> i.e. <code>object.alias_name</code>.
                </arg>
+               <arg name="who" type="player-set" />
             </args>
             <blurb>Set whether an object displays a progress bar, and who should be able to see it.</blurb>
             <example>
                for each object with label "koth_hill" do
-                  current_object.set_progress_bar(everyone, 3)
+                  current_object.set_progress_bar(3, everyone)
                end
 
                alias capture_timer = object.timer[0]
                for each object with label "territory" do
                   for each player do
-                     current_object.set_progress_bar(mod_player, current_player, 1, object.capture_timer)
+                     current_object.set_progress_bar(object.capture_timer, mod_player, current_player, 1)
                   end
                end
 
                for each object with label "ignore_me" do
-                  current_object.set_progress_bar(everyone, none)
+                  current_object.set_progress_bar(none, everyone)
                end
             </example>
             <category id="object-ui" />

native/src/ReachVariantTool/docs/working - help docs/script/api/variant-string-id.xml

@@ -63,7 +63,8 @@
          <dt>emile</dt>
             <dd>A variant name for Spartan bipeds; produces a male Spartan with Noble 4 (Emile)'s armor.</dd>
          <dt>player_skull</dt>
-            <dd>A variant name for Spartan bipeds; produces a male Spartan with the Haunted helmet.</dd>
+            <dd>A variant name for Spartan bipeds; produces a male Spartan with the Hazop helmet and CBRN, CQC shoulders, trauma kit, 
+            and FJ/PARA knee guards. (Bungie used the name "player_skull" internally for the CQC shoulders and Hazop helmet.)</dd>
          <dt>kat</dt>
             <dd>A variant name for Spartan bipeds; produces a female Spartan with Noble 2 (Kat)'s armor.</dd>
          <dt>minor</dt>

native/src/ReachVariantTool/docs/working - help docs/script/api/waypoint-icon.xml

@@ -52,15 +52,16 @@
          <dt>territory_i</dt>
             <dd>Displays the number 9.</dd>
          <dt>supply</dt>
-            <dd>TBA</dd>
+            <dd>Line art depicting a cube.</dd>
          <dt>supply_health</dt>
-            <dd>TBA</dd>
+            <dd>A downward-pointing triangle outline with a circle drawn in the middle.</dd>
          <dt>supply_air_drop</dt>
             <dd>A small box suspended from a parachute.</dd>
          <dt>supply_ammo</dt>
-            <dd>TBA</dd>
+            <dd>Three bullets lined up horizontally in a row.</dd>
          <dt>arrow</dt>
-            <dd>TBA</dd>
+            <dd>An arrow pointing top-left. The "tail" of the arrow bends to form a circle 
+            wrapping around the arrow.</dd>
          <dt>defend</dt>
             <dd>An icon indicating that a location should be defended.</dd>
          <dt>ordnance</dt>

native/src/ReachVariantTool/docs/working - help docs/script/api/widget-icon.xml

@@ -45,45 +45,52 @@
             <dd>A soccer ball.</dd>
          <dt>headhunter</dt>
             <dd>The icon for the Headhunter gametype.</dd>
-         <!-- TODO: verify all below icons -->
          <dt>crosshair</dt>
-            <dd></dd>
+            <dd>A crosshair encircled by a spiky circular shape.</dd>
          <dt>wheel</dt>
-            <dd></dd>
+            <dd>A tire surrounded by feathers.</dd>
          <dt>swirl</dt>
             <dd>A swirl icon &mdash; the same icon used for what is called "Insane" in legacy Reach and "Action Sack" in MCC.</dd>
          <dt>bunker</dt>
-            <dd></dd>
+            <dd>...</dd>
          <dt>health_pack</dt>
-            <dd></dd>
+            <dd>...</dd>
          <dt>castle_defense</dt>
-            <dd></dd>
+            <dd>A filled-in shield shape, with the silhouette of a castle tower cut out of the middle.</dd>
          <dt>return</dt>
-            <dd></dd>
+            <dd>An arrow pointing bottom-left. The tail of the arrow bends to the left and then around 
+            the arrow, forming a box which encloses the arrow.</dd>
          <dt>shapes</dt>
             <dd>Line art of 3D geometric shapes.</dd>
          <dt>cartographer</dt>
             <dd>The insignia for the Silent Cartographer.</dd>
          <dt>eight_ball</dt>
-            <dd></dd>
+            <dd>A drawing of an eight ball, of the variety seen in billiards.</dd>
          <dt>noble</dt>
             <dd>The Noble Team insignia.</dd>
          <dt>covenant</dt>
             <dd>A Covenant insignia.</dd>
          <dt>attack</dt>
-            <dd></dd>
+            <dd>A rounded diamond shape, inside of which is a downward-pointing arrow. Beneath the 
+            arrow, between it and the diamond, is a bent line following the diamond's shape.</dd>
          <dt>defend</dt>
-            <dd></dd>
+            <dd>...</dd>
          <dt>ordnance</dt>
-            <dd></dd>
+            <dd>...</dd>
          <dt>circle</dt>
-            <dd></dd>
+            <dd>A downward-pointing triangle outline with a small circle drawn inside.</dd>
          <dt>recon</dt>
-            <dd></dd>
+            <dd>A rounded rectangle, with a targeting reticle drawn inside: four corners of a 
+            non-rounded rectangle, and a plus symbol at the center.</dd>
          <dt>recover</dt>
-            <dd></dd>
+            <dd>...</dd>
          <dt>ammo</dt>
-            <dd></dd>
+            <dd>...</dd>
+         <dt>skull</dt>
+            <dd>A skull icon, of the variety seen in Campaign and Firefight.</dd>
+         <dt>forge</dt>
+            <dd>The icon for Forge: a hammer (more like a gavel, actually) slamming down onto 
+            an anvil, emitting stylized sparks.</dd>
       </dl>
    </description>
 </script-type>

native/src/ReachVariantTool/docs/working - help docs/script/api/widget.xml

@@ -19,9 +19,18 @@
                end
             </example>
             <note>
-               A HUD widget must display the same text to all players. If you may need to 
-               display different text to different players at the same time, you will need 
-               to define multiple widgets and manage their visibility and text appropriately.
+               <p>
+                  A HUD widget must display the same format string to all players. If you may 
+                  need to display completely different text to different players at the same 
+                  time, you will need to define multiple widgets and manage their visibility 
+                  and text appropriately.
+               </p>
+               <p>
+                  Some format string parameters make it possible to display different values 
+                  within a single string, for each player viewing the widget. The 
+                  <a href="script/api/ns_unnamed/hud_player">hud_player</a> variable is one 
+                  such parameter.
+               </p>
             </note>
          </method>
          <method name="set_value_text" id="47">
@@ -67,6 +76,13 @@
                <arg name="icon" type="widget-icon" />
             </args>
             <blurb>Set the HUD widget's icon.</blurb>
+            <description>
+               <p>
+                  This function sets what icon a HUD widget displays. Note that Halo: Reach will 
+                  only actually display a widget's icon if the widget is in the "Lower Center" 
+                  or "Meter Only" positions.
+               </p>
+            </description>
             <example>
                script_widget[0].set_icon(infection)
             </example>

native/src/ReachVariantTool/help/editor/script_window/script-widgets.html

@@ -188,13 +188,21 @@ <h1>Scripted HUD Widgets</h1>
          two HUD widgets have the same position, they will not overlap; they will be 
          positioned adjacent to each other in an intelligent fashion. However, some 
          widget positions will overlap standard HUD elements such as the shield bar 
-         or motion tracker.
+         or motion tracker. Additionally, if a gametype tries to display more than two 
+         widgets to the same player at the same position, only two of them will actually 
+         be shown by the game, preferring ones earlier in the widget list.
       </p>
       <p>
          Most of the page is taken up by an image which displays where the HUD widget 
          will appear. This preview only shows the selected widget, and it assumes that 
          only the selected widget is showing.
       </p>
+      <p>
+         Note that the bottom-right widget position is only suitable for "meter" widgets 
+         — that is, those which use the "set_meter_params" function. Widgets in 
+         this position can display icons and meters, but not any text. The widget will 
+         appear below the hardcoded scoring UI.
+      </p>
 
       </main>
       <script src="resources/sidebar.js"></script>

native/src/ReachVariantTool/help/index.html

@@ -201,7 +201,7 @@ <h1>Index</h1>
       <p>
          As an example, here's Minesweeper recreated in <i>Halo: Reach</i>:
       </p>
-      <iframe allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" width="560" frameborder="0" allowfullscreen="allowfullscreen" src="https://www.youtube.com/embed/-sP8ElrIdek" height="315"></iframe>
+      <iframe width="560" frameborder="0" src="https://www.youtube.com/embed/-sP8ElrIdek" height="315" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen="allowfullscreen"></iframe>
 
       </main>
       <script src="resources/sidebar.js"></script>