Script API: add Dialog.CurrentDialog, ExecutedOption, AreOptionsDisplayed

Author: ivan-mogilko

Editor/AGS.Editor/Resources/agsdefns.sh

@@ -2193,6 +2193,14 @@ builtin managed struct Dialog {
   /// Gets the script name of this dialog.
   import readonly attribute String ScriptName;
 #endif
+#ifdef SCRIPT_API_v362
+  /// Gets the currently running dialog, returns null if no dialog is run
+  import static readonly attribute Dialog* CurrentDialog; // $AUTOCOMPLETESTATICONLY$
+  /// Gets the currently executed dialog option, or -1 if none is
+  import static readonly attribute int ExecutedOption; // $AUTOCOMPLETESTATICONLY$
+  /// Gets if the dialog options are currently displayed on screen
+  import static readonly attribute bool AreOptionsDisplayed; // $AUTOCOMPLETESTATICONLY$
+#endif
 
   int reserved[2];   // $AUTOCOMPLETEIGNORE$
 };

Engine/ac/dialog.cpp

@@ -54,6 +54,7 @@
 
 using namespace AGS::Common;
 using namespace AGS::Engine;
+struct DialogExec;
 
 extern GameSetupStruct game;
 extern int in_new_room;
@@ -66,6 +67,7 @@ extern IGraphicsDriver *gfxDriver;
 std::vector<DialogTopic> dialog;
 ScriptDialogOptionsRendering ccDialogOptionsRendering;
 ScriptDrawingSurface* dialogOptionsRenderingSurface;
+std::unique_ptr<DialogExec> dialogExec; // current running dialog
 
 int said_speech_line; // used while in dialog to track whether screen needs updating
 
@@ -119,7 +121,7 @@ int Dialog_HasOptionBeenChosen(ScriptDialog *sd, int option)
 {
   if ((option < 1) || (option > dialog[sd->id].numoptions))
     quit("!Dialog.HasOptionBeenChosen: Invalid option number specified");
-  option--;
+  option--;  // option id is 1-based in script, and 0 is entry point
 
   if (dialog[sd->id].optionflags[option] & DFLG_HASBEENCHOSEN)
     return 1;
@@ -132,7 +134,7 @@ void Dialog_SetHasOptionBeenChosen(ScriptDialog *sd, int option, bool chosen)
     {
         quit("!Dialog.HasOptionBeenChosen: Invalid option number specified");
     }
-    option--;
+    option--; // option id is 1-based in script, and 0 is entry point
     if (chosen)
     {
         dialog[sd->id].optionflags[option] |= DFLG_HASBEENCHOSEN;
@@ -158,7 +160,7 @@ const char* Dialog_GetOptionText(ScriptDialog *sd, int option)
   if ((option < 1) || (option > dialog[sd->id].numoptions))
     quit("!Dialog.GetOptionText: Invalid option number specified");
 
-  option--;
+  option--; // option id is 1-based in script, and 0 is entry point
 
   return CreateNewScriptString(get_translation(dialog[sd->id].optionnames[option]));
 }
@@ -1283,6 +1285,7 @@ int show_dialog_options(int dlgnum, bool runGameLoopsInBackground)
 }
 
 // Dialog execution state
+// TODO: reform into GameState implementation, similar to DialogOptions!
 struct DialogExec
 {
     int DlgNum = -1;
@@ -1291,6 +1294,8 @@ struct DialogExec
     bool IsFirstEntry = true;
     // nested dialogs "stack"
     std::stack<int> TopicHist;
+    int ExecutedOption = -1; // option which is currently run (or -1)
+    bool AreOptionsDisplayed = false; // if dialog options are displayed on screen
 
     DialogExec(int start_dlgnum) : DlgNum(start_dlgnum) {}
     int HandleDialogResult(int res);
@@ -1331,8 +1336,10 @@ void DialogExec::Run()
         // If a new dialog topic: run dialog entry point
         if (DlgNum != DlgWas)
         {
+            ExecutedOption = 0;
             res = run_dialog_entry(DlgNum);
             DlgWas = DlgNum;
+            ExecutedOption = -1;
 
             // Handle the dialog entry's result
             res = HandleDialogResult(res);
@@ -1344,7 +1351,9 @@ void DialogExec::Run()
         }
 
         // Show current dialog's options
+        AreOptionsDisplayed = true;
         int chose = show_dialog_options(DlgNum, (game.options[OPT_RUNGAMEDLGOPTS] != 0));
+        AreOptionsDisplayed = false;
 
         if (chose == CHOSE_TEXTPARSER)
         {
@@ -1361,8 +1370,10 @@ void DialogExec::Run()
         }
         else if (chose >= 0)
         {
+            ExecutedOption = chose + 1; // option id is 1-based in script, and 0 is entry point
             // chose some option - handle it and run its script
             res = run_dialog_option(DlgNum, chose, SAYCHOSEN_USEFLAG, true /* run script */);
+            ExecutedOption = -1;
         }
         else
         {
@@ -1388,18 +1399,19 @@ void do_conversation(int dlgnum)
     // Run the global DialogStart event
     run_on_event(kScriptEvent_DialogStart, RuntimeScriptValue().SetInt32(dlgnum));
 
-    DialogExec dlgexec(dlgnum);
-    dlgexec.Run();
+    dialogExec.reset(new DialogExec(dlgnum));
+    dialogExec->Run();
     // CHECKME: find out if this is safe to do always, regardless of number of iterations
-    if (dlgexec.IsFirstEntry)
+    if (dialogExec->IsFirstEntry)
     {
         // bail out from first startup script
         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));
+    run_on_event(kScriptEvent_DialogStop, RuntimeScriptValue().SetInt32(dialogExec->DlgNum));
+    dialogExec = {};
 }
 
 // end dialog manager
@@ -1424,12 +1436,41 @@ ScriptDialog *Dialog_GetByName(const char *name)
     return static_cast<ScriptDialog*>(ccGetScriptObjectAddress(name, ccDynamicDialog.GetType()));
 }
 
+ScriptDialog *Dialog_GetCurrentDialog()
+{
+    return dialogExec ? &scrDialog[dialogExec->DlgNum] : nullptr;
+}
+
+int Dialog_GetExecutedOption()
+{
+    return dialogExec ? dialogExec->ExecutedOption : -1;
+}
+
+bool Dialog_GetAreOptionsDisplayed()
+{
+    return dialogExec ? dialogExec->AreOptionsDisplayed : false;
+}
 
 RuntimeScriptValue Sc_Dialog_GetByName(const RuntimeScriptValue *params, int32_t param_count)
 {
     API_SCALL_OBJ_POBJ(ScriptDialog, ccDynamicDialog, Dialog_GetByName, const char);
 }
 
+RuntimeScriptValue Sc_Dialog_GetCurrentDialog(const RuntimeScriptValue *params, int32_t param_count)
+{
+    API_SCALL_OBJ(ScriptDialog, ccDynamicDialog, Dialog_GetCurrentDialog);
+}
+
+RuntimeScriptValue Sc_Dialog_GetExecutedOption(const RuntimeScriptValue *params, int32_t param_count)
+{
+    API_SCALL_INT(Dialog_GetExecutedOption);
+}
+
+RuntimeScriptValue Sc_Dialog_GetAreOptionsDisplayed(const RuntimeScriptValue *params, int32_t param_count)
+{
+    API_SCALL_BOOL(Dialog_GetAreOptionsDisplayed);
+}
+
 // int (ScriptDialog *sd)
 RuntimeScriptValue Sc_Dialog_GetID(void *self, const RuntimeScriptValue *params, int32_t param_count)
 {
@@ -1498,6 +1539,9 @@ void RegisterDialogAPI()
 {
     ScFnRegister dialog_api[] = {
         { "Dialog::GetByName",            API_FN_PAIR(Dialog_GetByName) },
+        { "Dialog::get_CurrentDialog",    API_FN_PAIR(Dialog_GetCurrentDialog) },
+        { "Dialog::get_ExecutedOption",   API_FN_PAIR(Dialog_GetExecutedOption) },
+        { "Dialog::get_AreOptionsDisplayed", API_FN_PAIR(Dialog_GetAreOptionsDisplayed) },
         { "Dialog::get_ID",               API_FN_PAIR(Dialog_GetID) },
         { "Dialog::get_OptionCount",      API_FN_PAIR(Dialog_GetOptionCount) },
         { "Dialog::get_ScriptName",       API_FN_PAIR(Dialog_GetScriptName) },