Implements IsShowBriefing to ScenarioClass, allowing the briefing statement to be shown before the mission start.

Author: CCHyper

src/extensions/scenario/scenarioext.cpp

@@ -42,7 +42,8 @@
  *  @author: CCHyper
  */
 ScenarioClassExtension::ScenarioClassExtension(const ScenarioClass *this_ptr) :
-    GlobalExtensionClass(this_ptr)
+    GlobalExtensionClass(this_ptr),
+    IsShowBriefing(false)
 {
     //if (this_ptr) EXT_DEBUG_TRACE("ScenarioClassExtension::ScenarioClassExtension - 0x%08X\n", (uintptr_t)(ThisPtr));
 
@@ -184,13 +185,17 @@ bool ScenarioClassExtension::Read_INI(CCINIClass &ini)
 {
     //EXT_DEBUG_TRACE("ScenarioClassExtension::Read_INI - 0x%08X\n", (uintptr_t)(This()));
 
+    static const char * const BASIC = "Basic";
+
     /**
      *  #issue-123
      * 
      *  Fetch additional tutorial message data (if present) from the scenario.
      */
     Read_Tutorial_INI(ini, true);
 
+    IsShowBriefing = ini.Get_Bool(BASIC, "ShowBriefing", IsShowBriefing);
+
     return true;
 }
 

src/extensions/scenario/scenarioext.h

@@ -56,5 +56,8 @@ class ScenarioClassExtension final : public GlobalExtensionClass<ScenarioClass>
         bool Read_Tutorial_INI(CCINIClass &ini, bool log = false);
 
     public:
-
+        /**
+         *  Should the mission briefing statement be shown before the mission starts?
+         */
+        bool IsShowBriefing;
 };

src/extensions/scenario/scenarioext_hooks.cpp

@@ -38,6 +38,8 @@
 #include "ccfile.h"
 #include "ccini.h"
 #include "addon.h"
+#include "wwmouse.h"
+#include "restate.h"
 #include "fatal.h"
 #include "debughandler.h"
 #include "asserthandler.h"
@@ -46,6 +48,66 @@
 #include "hooker_macros.h"
 
 
+/**
+ *  Show the mission briefing statement.
+ * 
+ *  @author: CCHyper
+ */
+static void Scenario_Show_Mission_Briefing()
+{
+    char buffer[25];
+
+    /**
+     *  If there's no briefing movie, restate the mission at the beginning.
+     */
+    if (Scen->BriefMovie != VQ_NONE) {
+        std::snprintf(buffer, sizeof(buffer), "%s.VQA", Movies[Scen->BriefMovie]);
+    }
+
+    /**
+     *  Briefings are only displayed in normal games when no briefing video is found.
+     * 
+     *  #issue-28
+     * 
+     *  Also, Show the briefing if the scenario has been flagged to show it.
+     */
+    if (Session.Type == GAME_NORMAL && (Scen->BriefMovie == VQ_NONE || !CCFileClass(buffer).Is_Available() || ScenExtension->IsShowBriefing)) {
+
+        /**
+         *  Make sure the mouse is visible before showing the restatement.
+         */
+        while (WWMouse->Get_Mouse_State()) {
+            WWMouse->Show_Mouse();
+        }
+
+        /**
+         *  Show the mission briefing screen.
+         */
+        Restate_Mission(Scen);
+    }
+}
+
+/**
+ *  This patch replaces the section of code in Start_Scenario() that shows
+ *  the mission briefing statement if no briefing video is found.
+ * 
+ *  @author: CCHyper
+ */
+DECLARE_PATCH(_Start_Scenario_BriefMovie_RestateMission_Patch)
+{
+    /**
+     *  Show the mission briefing statement.
+     */
+    Scenario_Show_Mission_Briefing();
+
+    /**
+     *  Continue to showing the Dropship Loadout menu (if enabled).
+     */
+    _asm { mov eax, 0x007E2438 } // Scen
+    JMP_REG(ecx, 0x005DB3B1);
+}
+
+
 /**
  *  Process additions to the Rules data from the input file.
  * 
@@ -178,4 +240,5 @@ void ScenarioClassExtension_Hooks()
     Patch_Jump(0x005DC9D4, &_Do_Win_Skip_MPlayer_Score_Screen_Patch);
     Patch_Jump(0x005DCD92, &_Do_Lose_Skip_MPlayer_Score_Screen_Patch);
     Patch_Jump(0x005DD8D5, &_Read_Scenario_INI_MPlayer_INI_Patch);
+    Patch_Jump(0x005DB37F, &_Start_Scenario_BriefMovie_RestateMission_Patch);
 }

src/extensions/scenario/scenarioext_init.cpp

@@ -42,9 +42,9 @@
 
 /**
  *  Patch for including the extended class members in the creation process.
- * 
+ *
  *  @warning: Do not touch this unless you know what you are doing!
- * 
+ *
  *  @author: CCHyper
  */
 DECLARE_PATCH(_ScenarioClass_Constructor_Patch)
@@ -77,9 +77,9 @@ DECLARE_PATCH(_ScenarioClass_Constructor_Patch)
 
 /**
  *  Patch for including the extended class members in the destruction process.
- * 
+ *
  *  @warning: Do not touch this unless you know what you are doing!
- * 
+ *
  *  @author: CCHyper
  */
 DECLARE_PATCH(_ScenarioClass_Destructor_Patch)
@@ -103,9 +103,9 @@ DECLARE_PATCH(_ScenarioClass_Destructor_Patch)
 
 /**
  *  Patch for including the extended class members when initialsing the scenario data.
- * 
+ *
  *  @warning: Do not touch this unless you know what you are doing!
- * 
+ *
  *  @author: CCHyper
  */
 DECLARE_PATCH(_ScenarioClass_Init_Clear_Patch)