Script API: implemented a number of global events for Dialogs

* eEventDialogStart
* eEventDialogStop
* eEventDialogRun
* eEventDialogOptionsOpen
* eEventDialogOptionsClose

Author: ivan-mogilko

Editor/AGS.Editor/Resources/agsdefns.sh

@@ -1720,6 +1720,13 @@ enum EventType {
   eEventLeaveRoomAfterFadeout = 11,
   eEventGameSaved = 12,
 #endif
+#ifdef SCRIPT_API_v362
+  eEventDialogStart = 13,
+  eEventDialogStop = 14,
+  eEventDialogRun = 15,
+  eEventDialogOptionsOpen = 16,
+  eEventDialogOptionsClose = 17,
+#endif
 };
 
 #ifdef SCRIPT_API_v350

Engine/ac/dialog.cpp

@@ -20,6 +20,7 @@
 #include "ac/dialogtopic.h"
 #include "ac/display.h"
 #include "ac/draw.h"
+#include "ac/event.h"
 #include "ac/gamestate.h"
 #include "ac/gamesetupstruct.h"
 #include "ac/global_character.h"
@@ -1197,7 +1198,8 @@ void DialogOptions::End()
 int run_dialog_entry(int dlgnum)
 {
     DialogTopic *dialog_topic = &dialog[dlgnum];
-    // Run global event kScriptEvent_DialogRun
+    // Run global event kScriptEvent_DialogRun for the startup entry (index 0)
+    run_on_event(kScriptEvent_DialogRun, RuntimeScriptValue().SetInt32(dlgnum), RuntimeScriptValue().SetInt32(0));
     return run_dialog_script(dlgnum, dialog_topic->startupentrypoint, 0);
 }
 
@@ -1208,6 +1210,9 @@ int run_dialog_option(int dlgnum, int dialog_choice, int sayChosenOption, bool r
     int &option_flags = dialog_topic->optionflags[dialog_choice];
     const char *option_name = dialog_topic->optionnames[dialog_choice];
 
+    // Run global event kScriptEvent_DialogRun for the new option
+    run_on_event(kScriptEvent_DialogRun, RuntimeScriptValue().SetInt32(dlgnum), RuntimeScriptValue().SetInt32(dialog_choice + 1));
+
     option_flags |= DFLG_HASBEENCHOSEN;
     bool sayTheOption = false;
     if (sayChosenOption == SAYCHOSEN_YES)
@@ -1265,9 +1270,14 @@ int show_dialog_options(int dlgnum, bool runGameLoopsInBackground)
     return last_opt; // only one choice, so select it
   }
 
+  // Run the global DialogOptionsOpen event
+  run_on_event(kScriptEvent_DialogOptionsOpen, RuntimeScriptValue().SetInt32(dlgnum));
+
   DialogOptions dlgopt(dtop, dlgnum, runGameLoopsInBackground);
   dlgopt.Show();
 
+  // Run the global DialogOptionsClose event
+  run_on_event(kScriptEvent_DialogOptionsClose, RuntimeScriptValue().SetInt32(dlgnum), RuntimeScriptValue().SetInt32(dlgopt.GetChosenOption()));
 
   return dlgopt.GetChosenOption();
 }
@@ -1375,6 +1385,9 @@ void do_conversation(int dlgnum)
     if (loaded_game_file_version <= kGameVersion_272)
         play.mouse_cursor_hidden = 0;
 
+    // Run the global DialogStart event
+    run_on_event(kScriptEvent_DialogStart, RuntimeScriptValue().SetInt32(dlgnum));
+
     DialogExec dlgexec(dlgnum);
     dlgexec.Run();
     // CHECKME: find out if this is safe to do always, regardless of number of iterations
@@ -1384,6 +1397,9 @@ void do_conversation(int dlgnum)
         remove_screen_overlay(OVER_COMPLETE);
         play.in_conversation--;
     }
+
+    // Run the global DialogStop event; NOTE: DlgNum may be different in the end
+    run_on_event(kScriptEvent_DialogStop, RuntimeScriptValue().SetInt32(dlgexec.DlgNum));
 }
 
 // end dialog manager

Engine/ac/event.cpp

@@ -107,10 +107,10 @@ void run_claimable_event(const String &tsname, bool includeRoom, int numParams,
 }
 
 // runs the global script on_event function
-void run_on_event(int evtype, RuntimeScriptValue &wparam)
+void run_on_event(AGSScriptEventType evtype, const RuntimeScriptValue &data1, const RuntimeScriptValue &data2)
 {
-    RuntimeScriptValue params[]{ evtype , wparam };
-    QueueScriptFunction(kScTypeGame, "on_event", 2, params);
+    RuntimeScriptValue params[]{ evtype , data1, data2 };
+    QueueScriptFunction(kScTypeGame, "on_event", 3, params);
 }
 
 void run_room_event(int id) {

Engine/ac/event.h

@@ -114,6 +114,11 @@ enum AGSScriptEventType
     kScriptEvent_RoomAfterFadein = 10, // enter after fade-in
     kScriptEvent_RoomAfterFadeout = 11, // after fade-out, right before unloading
     kScriptEvent_GameSaved      = 12,
+    kScriptEvent_DialogStart    = 13, // before game enters a "dialog" state
+    kScriptEvent_DialogStop     = 14, // after game returns from a "dialog" state
+    kScriptEvent_DialogRun      = 15, // a dialog option is run
+    kScriptEvent_DialogOptionsOpen = 16, // before dialog options are displayed on screen
+    kScriptEvent_DialogOptionsClose = 17, // after dialog options are removed from screen
 };
 
 
@@ -200,8 +205,8 @@ struct AGSEvent
 };
 
 void run_claimable_event(const AGS::Common::String &tsname, bool includeRoom, int numParams, const RuntimeScriptValue *params, bool *eventWasClaimed);
-// runs the global script on_event fnuction
-void run_on_event (int evtype, RuntimeScriptValue &wparam);
+// runs the global script on_event function
+void run_on_event(AGSScriptEventType evtype, const RuntimeScriptValue &data1 = RuntimeScriptValue(), const RuntimeScriptValue &data2 = RuntimeScriptValue());
 void run_room_event(int id);
 // event list functions
 void setevent(const AGSEvent &evt);

Engine/script/script.cpp

@@ -741,9 +741,10 @@ void post_script_cleanup() {
     for (const auto &script : copyof.ScFnQueue) {
         old_room_number = displayed_room;
         RunScriptFunctionAuto(script.ScType, script.Function, script.ParamCount, script.Params);
+        // FIXME: this is some bogus hack for "on_call" event handler
+        // don't use instance + param count, instead find a way to save actual callback name!
         if (script.ScType == kScTypeRoom && script.ParamCount == 1)
         {
-            // some bogus hack for "on_call" event handler
             play.roomscript_finished = 1;
         }