DragDropCommon: updated to 3.6.0 features

* Allow customize representation's ZOrder;
* Added DragDropCommon.GhostOverlay redonly property;
* Overlays can have Transparency and ZOrder if it's AGS 3.6.0 or higher;

Author: ivan-mogilko

scripts/ui/DragDrop/DragDrop.ash

@@ -24,7 +24,7 @@
 #ifndef __MOUSE_DRAGDROP_MODULE__
 #define __MOUSE_DRAGDROP_MODULE__
 
-#define MOUSE_DRAGDROP_VERSION_00_01_01_00
+#define MOUSE_DRAGDROP_VERSION_00_01_02_00
 
 // Comment this line out to completely disable DragDrop during compilation
 #define ENABLE_MOUSE_DRAGDROP

scripts/ui/DragDrop/DragDropCommon.asc

@@ -9,7 +9,8 @@ struct DragDropSettings
   bool TestClickable;       // test Clickable property for AGS objects
   DragDropCommonMove Move;  // whether object is dragged itself, or overlay with object's image on it
   GUI* GhostGUI;            // GUI to use for dragged object representation
-  int  GhostTransparency;   // transparency value of the overlay
+  int  GhostZOrder;         // ZOrder to use for ghost representation
+  int  GhostTransparency;   // transparency value of the ghost representation
   bool GhostAlpha;          // keep alpha channel when creating translucent overlays
 };
 
@@ -54,6 +55,7 @@ void Reset(this DragDropSettings*)
   this.TestClickable = false;
   this.Move = eDDCmnMoveSelf;
   this.GhostGUI = null;
+  this.GhostZOrder = 1000; // max GUI zorder in 3.2.1, according to the manual
   this.GhostTransparency = 33;
   this.GhostAlpha = true;
 }
@@ -65,9 +67,11 @@ void Reset(this DragDropSettings*)
 //
 //===========================================================================
 int CreateRepresentation(this DragDropState*, DragDropCommonMove move, int x, int y, int offx, int offy,
-                         int slot, int trans, bool has_alpha)
+                         int slot, int trans, int zorder, bool has_alpha)
 {
   this.GhostGraphic = slot;
+#ifndef SCRIPT_API_v360
+  // NOTE: pre-3.6.0 did not support Overlay.Transparency
   if (move != eDDCmnMoveGhostGUI &&
       trans != 100 && trans != 0)
   {
@@ -78,11 +82,16 @@ int CreateRepresentation(this DragDropState*, DragDropCommonMove move, int x, in
     this.GhostDspr = spr;
     slot = spr.Graphic;
   }
+#endif
   this.OverlayOffX = offx;
   this.OverlayOffY = offy;
   if (move == eDDCmnMoveGhostOverlay)
   {
     this.GhostOverlay = Overlay.CreateGraphical(x + offx, y + offy, slot, true);
+#ifdef SCRIPT_API_v360
+    this.GhostOverlay.Transparency = trans;
+    this.GhostOverlay.ZOrder = zorder;
+#endif
   }
   else
   {
@@ -93,7 +102,7 @@ int CreateRepresentation(this DragDropState*, DragDropCommonMove move, int x, in
     this.GhostGUI.Y = y + offy;
     this.GhostGUI.Width = Game.SpriteWidth[slot];
     this.GhostGUI.Height = Game.SpriteHeight[slot];
-    this.GhostGUI.ZOrder = 1000; // max zorder, according to the manual
+    this.GhostGUI.ZOrder = zorder;
     this.GhostGUI.Visible = true;
   }
   this.Move = move;
@@ -168,7 +177,7 @@ static bool DragDropCommon::TryHookCharacter()
     if (vf != null)
       sprite = vf.Graphic;
     DDState.CreateRepresentation(DDSet.Move, c.x, c.y, 0, -Game.SpriteHeight[sprite], sprite,
-                                 DDSet.GhostTransparency, DDSet.GhostAlpha);
+                                 DDSet.GhostTransparency, DDSet.GhostZOrder, DDSet.GhostAlpha);
   }
   return true;
 }
@@ -190,6 +199,7 @@ static bool DragDropCommon::TryHookGUI()
     return false;
   DDState._GUI = g;
   DragDrop.HookObject(eDragDropGUI, g.X, g.Y);
+  // NOTE: GUIs may be only dragged on their own
   return true;
 }
 
@@ -211,6 +221,7 @@ static bool DragDropCommon::TryHookGUIControl()
     return false;
   DDState._GUIControl = gc;
   DragDrop.HookObject(eDragDropGUIControl, gc.X, gc.Y);
+  // NOTE: GUI Controls may be only dragged on their own
   return true;
 }
 
@@ -247,7 +258,7 @@ static bool DragDropCommon::TryHookRoomObject()
       sprite = o.Graphic;
     }
     DDState.CreateRepresentation(DDSet.Move, o.X, o.Y, 0, -Game.SpriteHeight[sprite], sprite,
-                                 DDSet.GhostTransparency, DDSet.GhostAlpha);
+                                 DDSet.GhostTransparency, DDSet.GhostZOrder, DDSet.GhostAlpha);
   }
   return true;
 }
@@ -271,9 +282,10 @@ static bool DragDropCommon::TryHookInventoryItem()
   int i_x = DragDrop.DragStartX - (DragDrop.DragStartX - wnd.OwningGUI.X - wnd.X) % wnd.ItemWidth;
   int i_y = DragDrop.DragStartY - (DragDrop.DragStartY - wnd.OwningGUI.Y - wnd.Y) % wnd.ItemHeight;
   DragDrop.HookObject(eDragDropInvItem, i_x, i_y);
+  // NOTE: Inventory Items may be only dragged using representation
   int sprite = i.Graphic;
   DDState.CreateRepresentation(DDSet.Move, i_x, i_y, 0, 0, sprite,
-                                 DDSet.GhostTransparency, DDSet.GhostAlpha);
+                                 DDSet.GhostTransparency, DDSet.GhostZOrder, DDSet.GhostAlpha);
   return true;
 }
 
@@ -403,6 +415,21 @@ void set_GhostGUI(this DragDropCommon*, GUI* value)
   DDSet.GhostGUI = value;
 }
 
+//===========================================================================
+//
+// DragDropCommon::GhostZOrder property
+//
+//===========================================================================
+int get_GhostZOrder(this DragDropCommon*)
+{
+  return DDSet.GhostZOrder;
+}
+
+void set_GhostZOrder(this DragDropCommon*, int value)
+{
+  DDSet.GhostZOrder = value;
+}
+
 //===========================================================================
 //
 // DragDropCommon::GhostTransparency property
@@ -571,6 +598,16 @@ int get_ObjectHeight(this DragDropCommon*)
   return 0;
 }
 
+//===========================================================================
+//
+// DragDropCommon::GhostOverlay property
+//
+//===========================================================================
+Overlay* get_GhostOverlay(this DragDropCommon*)
+{
+  return DDState.GhostOverlay;
+}
+
 //===========================================================================
 //
 // DragDropCommon::UsedGhostGraphic property

scripts/ui/DragDrop/DragDropCommon.ash

@@ -28,7 +28,7 @@
 #error DragDropCommon requires DragDrop module
 #endif
 
-#define MOUSE_DRAGDROPCOMMON_VERSION_00_01_01_00
+#define MOUSE_DRAGDROPCOMMON_VERSION_00_01_02_00
 
 // Comment this line out to completely disable DragDropCommon during compilation
 #define ENABLE_MOUSE_DRAGDROPCOMMON
@@ -48,12 +48,15 @@ enum DragDropCommonMode
 // DragDropCommonMove enumeration determines the way hooked object is being dragged around
 enum DragDropCommonMove
 {
-  // drag actual object itself (position updates real-time)
+  // drag actual object itself (position updates real-time);
+  // this works for everything except inventory items (because they do not have
+  // actual position on screen on their own)
   eDDCmnMoveSelf,
   // drag overlay with object's image, while object stays in place until drag ends;
-  // this currently works only for characters and room objects!
+  // this works for everything except GUI and controls
   eDDCmnMoveGhostOverlay, 
-  // drag GUI with object's image; this is currently only way to drag inventory items
+  // drag GUI with object's image;
+  // this works for everything except GUI and controls
   eDDCmnMoveGhostGUI
 };
 
@@ -82,6 +85,9 @@ struct DragDropCommon
   import static attribute DragDropCommonMove DragMove;
   /// Get/set the GUI used to represent dragged object
   import static attribute GUI*  GhostGUI;
+  /// Get/set the wanted z-order of a ghost representation (GUI or Overlay);
+  /// please note that Overlays can have ZOrder only since AGS 3.6.0.
+  import static attribute int   GhostZOrder;
   /// Get/set whether representation should keep sprite's alpha channel
   import static attribute bool  GhostAlpha;
   /// Get/set transparency of a representation used when DragStyle is NOT eDragDropMoveSelf
@@ -111,6 +117,8 @@ struct DragDropCommon
   readonly import static attribute int          ObjectWidth;
   /// Gets current dragged object's or its representation height
   readonly import static attribute int          ObjectHeight;
+  /// Gets current Overlay representing the dragged object (only if drag style is eDDCmnMoveGhostOverlay)
+  readonly import static attribute Overlay*     GhostOverlay;
   /// Gets current dragged overlay's graphic (only if drag style is NOT eDragDropMoveSelf)
   readonly import static attribute int          UsedGhostGraphic;