Script API: add GetTimerPos()

Author: ivan-mogilko

Editor/AGS.Editor/Resources/agsdefns.sh

@@ -1265,6 +1265,10 @@ import void SetSpeechStyle(eSpeechStyle);
 import void SetTimer(int timerID, int timeout);
 /// Returns true the first time this is called after the timer expires.
 import bool IsTimerExpired(int timerID);
+#ifdef SCRIPT_API_v362
+/// Returns the specified timer's time value; returns 0 if timer is not running, and 1 if it's expiring.
+import int  GetTimerPos(int timerID);
+#endif
 /// Sets whether the game can continue to run in the background if the player switches to another application.
 import void SetMultitaskingMode (int mode);
 /// Converts a floating point value to an integer.

Engine/ac/global_api.cpp

@@ -793,6 +793,11 @@ RuntimeScriptValue Sc_sc_GetTime(const RuntimeScriptValue *params, int32_t param
     API_SCALL_INT_PINT(sc_GetTime);
 }
 
+RuntimeScriptValue Sc_GetTimerPos(const RuntimeScriptValue *params, int32_t param_count)
+{
+    API_SCALL_INT_PINT(GetTimerPos);
+}
+
 // char * (const char *text)
 RuntimeScriptValue Sc_get_translation(const RuntimeScriptValue *params, int32_t param_count)
 {
@@ -1999,9 +2004,9 @@ RuntimeScriptValue Sc_SetTextWindowGUI(const RuntimeScriptValue *params, int32_t
 }
 
 // void (int tnum,int timeout)
-RuntimeScriptValue Sc_script_SetTimer(const RuntimeScriptValue *params, int32_t param_count)
+RuntimeScriptValue Sc_SetTimer(const RuntimeScriptValue *params, int32_t param_count)
 {
-    API_SCALL_VOID_PINT2(script_SetTimer);
+    API_SCALL_VOID_PINT2(SetTimer);
 }
 
 // void (int offsx,int offsy)
@@ -2453,6 +2458,7 @@ void RegisterGlobalAPI(ScriptAPIVersion base_api, ScriptAPIVersion /*compat_api*
         { "GetFontHeight",            API_FN_PAIR(GetFontHeight) },
         { "GetFontLineSpacing",       API_FN_PAIR(GetFontLineSpacing) },
         { "GetTime",                  API_FN_PAIR(sc_GetTime) },
+        { "GetTimerPos",              API_FN_PAIR(GetTimerPos) },
         { "GetTranslation",           API_FN_PAIR(get_translation) },
         { "GetTranslationName",       API_FN_PAIR(GetTranslationName) },
         { "GetViewportX",             API_FN_PAIR(GetViewportX) },
@@ -2659,7 +2665,7 @@ void RegisterGlobalAPI(ScriptAPIVersion base_api, ScriptAPIVersion /*compat_api*
         { "SetTextBoxText",           API_FN_PAIR(SetTextBoxText) },
         { "SetTextOverlay",           Sc_SetTextOverlay, ScPl_SetTextOverlay },
         { "SetTextWindowGUI",         API_FN_PAIR(SetTextWindowGUI) },
-        { "SetTimer",                 API_FN_PAIR(script_SetTimer) },
+        { "SetTimer",                 API_FN_PAIR(SetTimer) },
         { "SetViewport",              API_FN_PAIR(SetViewport) },
         { "SetVoiceMode",             API_FN_PAIR(SetVoiceMode) },
         { "SetWalkBehindBase",        API_FN_PAIR(SetWalkBehindBase) },

Engine/ac/global_timer.cpp

@@ -17,13 +17,22 @@
 #include "ac/gamestate.h"
 
 
-void script_SetTimer(int tnum,int timeout) {
+void SetTimer(int tnum,int timeout)
+{
     if ((tnum < 1) || (tnum >= MAX_TIMERS))
         quit("!StartTimer: invalid timer number");
     play.script_timers[tnum] = timeout;
 }
 
-int IsTimerExpired(int tnum) {
+int GetTimerPos(int tnum)
+{
+    if ((tnum < 1) || (tnum >= MAX_TIMERS))
+        quit("!IsTimerExpired: invalid timer number");
+    return play.script_timers[tnum];
+}
+
+int IsTimerExpired(int tnum)
+{
     if ((tnum < 1) || (tnum >= MAX_TIMERS))
         quit("!IsTimerExpired: invalid timer number");
     if (play.script_timers[tnum] == 1) {

Engine/ac/global_timer.h

@@ -12,13 +12,14 @@
 //
 //=============================================================================
 //
-//
+// Timer script API.
 //
 //=============================================================================
 #ifndef __AGS_EE_AC__GLOBALTIMER_H
 #define __AGS_EE_AC__GLOBALTIMER_H
 
-void script_SetTimer(int tnum,int timeout);
+void SetTimer(int tnum, int timeout);
+int  GetTimerPos(int tnum);
 int  IsTimerExpired(int tnum);
 
 #endif // __AGS_EE_AC__GLOBALTIMER_H