Merge pull request #2871 from ivan-mogilko/ags4--animatedoverlays

AGS 4: AnimatedOverlay

Author: ivan-mogilko

Editor/AGS.Editor/Resources/agsdefns.sh

@@ -669,6 +669,28 @@ enum StringSplitOptions {
 };
 #endif // SCRIPT_API_v400
 
+#ifdef SCRIPT_API_v350
+enum GUIPopupStyle {
+  eGUIPopupNormal = 0,
+  eGUIPopupMouseYPos = 1,
+  eGUIPopupModal = 2,
+  eGUIPopupPersistent = 3
+};
+#endif // SCRIPT_API_v350
+
+enum BlockingStyle {
+  eBlock = 919,
+  eNoBlock = 920
+};
+enum Direction {
+  eForwards = 1062,
+  eBackwards = 1063
+};
+enum WalkWhere {
+  eAnywhere = 304,
+  eWalkableAreas = 305
+};
+
 internalstring autoptr builtin managed struct String {
   /// Creates a formatted string using the supplied parameters.
   import static String Format(__format const string format, ...);    // $AUTOCOMPLETESTATICONLY$
@@ -1341,6 +1363,28 @@ builtin managed struct Overlay {
 #endif // SCRIPT_API_v400_18
 };
 
+#ifdef SCRIPT_API_v400_22
+builtin managed struct AnimatedOverlay extends Overlay
+{
+  /// Creates a AnimatedOverlay object on the screen layer, optionally using a initial sprite
+  import static AnimatedOverlay* CreateAnimated(int x, int y, int slot = 0, bool pauseWithGame = true); // $AUTOCOMPLETESTATICONLY$
+  /// Creates a AnimatedOverlay object on the room layer, optionally using a initial sprite
+  import static AnimatedOverlay* CreateRoomAnimated(int x, int y, int slot = 0, bool pauseWithGame = true); // $AUTOCOMPLETESTATICONLY$
+  /// Animates the overlay using the specified view loop.
+  import void Animate(int view, int loop, int delay, RepeatStyle=eOnce, BlockingStyle=eNoBlock, Direction=eForwards, int frame=0, int volume=100);
+  /// Gets whether the overlay is currently animating.
+  import readonly attribute bool Animating;
+  /// Gets the current frame number during an animation.
+  import readonly attribute int  Frame;
+  /// Gets the current loop number during an animation.
+  import readonly attribute int  Loop;
+  /// Gets whether the overlay's animation is paused when the game is paused.
+  import readonly attribute bool PauseWithGame;
+  /// Gets the current view number during an animation.
+  import readonly attribute int  View;
+};
+#endif // SCRIPT_API_v400_22
+
 #ifdef SCRIPT_API_v400
 enum ColorFormat
 {
@@ -1517,28 +1561,6 @@ import int  FindGUIID(const string);  // $AUTOCOMPLETEIGNORE$
 import void SkipCutscene();
 #endif // SCRIPT_API_v3507
 
-#ifdef SCRIPT_API_v350
-enum GUIPopupStyle {
-  eGUIPopupNormal = 0,
-  eGUIPopupMouseYPos = 1,
-  eGUIPopupModal = 2,
-  eGUIPopupPersistent = 3
-};
-#endif // SCRIPT_API_v350
-
-enum BlockingStyle {
-  eBlock = 919,
-  eNoBlock = 920
-};
-enum Direction {
-  eForwards = 1062,
-  eBackwards = 1063
-};
-enum WalkWhere {
-  eAnywhere = 304,
-  eWalkableAreas = 305
-};
-
 // forward-declare these so that they can be returned by GUIControl class
 builtin managed struct GUI;
 builtin managed struct Label;

Engine/ac/button.cpp

@@ -88,9 +88,9 @@ void Button_Animate(GUIButton *butt, int view, int loop, int speed, int repeat,
     abtn.anim = ViewAnimateParams(static_cast<AnimFlowStyle>(repeat), static_cast<AnimFlowDirection>(direction), speed, volume);
     abtn.frame = SetFirstAnimFrame(view, loop, sframe, static_cast<AnimFlowDirection>(direction));
     abtn.wait = abtn.anim.Delay + views[abtn.view].loops[abtn.loop].frames[abtn.frame].speed;
-    animbuts.push_back(abtn);
     // launch into the first frame, and play the first frame's sound
     ABut_CheckViewFrame(abtn);
+    animbuts.push_back(std::move(abtn));
 
     // Blocking animate
     if (blocking)

Engine/ac/dynobj/scriptoverlay.cpp

@@ -22,14 +22,19 @@
 
 using namespace AGS::Common;
 
+const char *ScriptOverlay::GetType()
+{
+    return "Overlay";
+}
+
 int ScriptOverlay::Dispose(void* /*address*/, bool force)
 {
     // since the managed object is being deleted, remove the
     // reference so it doesn't try and dispose something else
     // with that handle later
-    if (overlayId >= 0)
+    if (_overlayID >= 0)
     {
-        auto *over = get_overlay(overlayId);
+        auto *over = get_overlay(_overlayID);
         if (over)
         {
             over->DetachScriptObject();
@@ -48,37 +53,45 @@ int ScriptOverlay::Dispose(void* /*address*/, bool force)
     return 1;
 }
 
-const char *ScriptOverlay::GetType() {
-    return "Overlay";
-}
-
 size_t ScriptOverlay::CalcSerializeSize(const void* /*address*/)
 {
-    return sizeof(int32_t) * 4;
+    return sizeof(int32_t);
 }
 
-void ScriptOverlay::Serialize(const void* /*address*/, Stream *out) {
-    out->WriteInt32(overlayId);
-    out->WriteInt32(0); // unused (was text window x padding)
-    out->WriteInt32(0); // unused (was text window y padding)
-    out->WriteInt32(0); // unused (was internal ref flag)
+void ScriptOverlay::Serialize(const void* /*address*/, Stream *out)
+{
+    out->WriteInt32(_overlayID);
 }
 
-void ScriptOverlay::Unserialize(int index, Stream *in, size_t /*data_sz*/) {
-    overlayId = in->ReadInt32();
-    in->ReadInt32(); // unused (was text window x padding)
-    in->ReadInt32(); // unused (was text window y padding)
-    in->ReadInt32(); // unused (was internal ref flag)
+void ScriptOverlay::Unserialize(int index, Stream *in, size_t /*data_sz*/)
+{
+    _overlayID = in->ReadInt32();
+    // NOTE: some older formats had 3 more int32 here, which we exclude now
     ccRegisterUnserializedObject(index, this, this);
 }
 
-void ScriptOverlay::Remove() 
+void ScriptOverlay::Remove()
 {
-    if (overlayId < 0)
+    if (_overlayID < 0)
     {
         debug_script_warn("Overlay.Remove: overlay is invalid, could have been removed earlier.");
         return;
     }
-    remove_screen_overlay(overlayId);
-    overlayId = -1;
+    remove_screen_overlay(_overlayID);
+    _overlayID = -1;
+}
+
+const char *ScriptAnimatedOverlay::GetType()
+{
+    return "AnimatedOverlay";
+}
+
+int ScriptAnimatedOverlay::Dispose(void *address, bool force)
+{
+    if (!force && _overlayID >= 0)
+    {
+        RemoveAnimatedOverlay(_overlayID);
+    }
+
+    return ScriptOverlay::Dispose(address, force);
 }

Engine/ac/dynobj/scriptoverlay.h

@@ -16,22 +16,35 @@
 
 #include "ac/dynobj/cc_agsdynamicobject.h"
 
-struct ScriptOverlay final : AGSCCDynamicObject
+struct ScriptOverlay : AGSCCDynamicObject
 {
 public:
-    int overlayId = -1;
-
-    int Dispose(void *address, bool force) override;
+    ScriptOverlay() = default;
+    ScriptOverlay(int over_id) : _overlayID(over_id) {}
     const char *GetType() override;
+    int Dispose(void *address, bool force) override;
     void Unserialize(int index, AGS::Common::Stream *in, size_t data_sz) override;
     void Remove();
-    ScriptOverlay() = default;
+
+    int GetOverlayID() const { return _overlayID; }
+    void Invalidate() { _overlayID = -1; }
 
 protected:
     // Calculate and return required space for serialization, in bytes
     size_t CalcSerializeSize(const void *address) override;
     // Write object data into the provided stream
     void Serialize(const void *address, AGS::Common::Stream *out) override;
+
+    int _overlayID = -1;
+};
+
+struct ScriptAnimatedOverlay final : ScriptOverlay
+{
+public:
+    ScriptAnimatedOverlay() = default;
+    ScriptAnimatedOverlay(int over_id) : ScriptOverlay(over_id) {}
+    const char *GetType() override;
+    int Dispose(void *address, bool force) override;
 };
 
-#endif // __AC_SCRIPTOVERLAY_H
+#endif // __AC_SCRIPTOVERLAY_H