Implement a new event to receive notifications when an pickup alpha has changed.

source/Core.hpp

@@ -304,6 +304,7 @@ protected:
         Function        mOnClaimed;
         Function        mOnCollected;
         Function        mOnWorld;
+        Function        mOnAlpha;
     };
 
     /* --------------------------------------------------------------------------------------------
@@ -1013,6 +1014,7 @@ public:
     void EmitObjectWorld(Int32 object_id, Int32 old_world, Int32 new_world);
     void EmitObjectAlpha(Int32 object_id, Int32 old_alpha, Int32 new_alpha, Int32 time);
     void EmitPickupWorld(Int32 pickup_id, Int32 old_world, Int32 new_world);
+    void EmitPickupAlpha(Int32 pickup_id, Int32 old_alpha, Int32 new_alpha);
     void EmitObjectReport(Int32 object_id, bool old_status, bool new_status, bool touched);
     void EmitPlayerHealth(Int32 player_id, Float32 old_health, Float32 new_health);
     void EmitPlayerArmour(Int32 player_id, Float32 old_armour, Float32 new_armour);
@@ -1165,6 +1167,7 @@ private:
     Function    mOnPickupCollected;
     Function    mOnPickupRespawn;
     Function    mOnPickupWorld;
+    Function    mOnPickupAlpha;
     Function    mOnCheckpointEntered;
     Function    mOnCheckpointExited;
     Function    mOnCheckpointWorld;

source/CoreEvents.cpp

@@ -716,6 +716,14 @@ void Core::EmitPickupWorld(Int32 pickup_id, Int32 old_world, Int32 new_world)
     Emit(mOnPickupWorld, _pickup.mObj, old_world, new_world);
 }
 
+// ------------------------------------------------------------------------------------------------
+void Core::EmitPickupAlpha(Int32 pickup_id, Int32 old_alpha, Int32 new_alpha)
+{
+    PickupInst & _pickup = m_Pickups.at(pickup_id);
+    Emit(_pickup.mOnAlpha, old_alpha, new_alpha);
+    Emit(mOnPickupAlpha, _pickup.mObj, old_alpha, new_alpha);
+}
+
 // ------------------------------------------------------------------------------------------------
 void Core::EmitObjectReport(Int32 object_id, bool old_status, bool new_status, bool touched)
 {

source/CoreUtils.cpp

@@ -166,6 +166,7 @@ void Core::ResetFunc(PickupInst & inst)
     inst.mOnClaimed.ReleaseGently();
     inst.mOnCollected.ReleaseGently();
     inst.mOnWorld.ReleaseGently();
+    inst.mOnAlpha.ReleaseGently();
 }
 
 // ------------------------------------------------------------------------------------------------
@@ -354,6 +355,7 @@ void Core::ResetFunc()
     Core::Get().mOnPickupClaimed.ReleaseGently();
     Core::Get().mOnPickupCollected.ReleaseGently();
     Core::Get().mOnPickupWorld.ReleaseGently();
+    Core::Get().mOnPickupAlpha.ReleaseGently();
     Core::Get().mOnPickupRespawn.ReleaseGently();
     Core::Get().mOnCheckpointEntered.ReleaseGently();
     Core::Get().mOnCheckpointExited.ReleaseGently();
@@ -482,6 +484,7 @@ Function & Core::GetEvent(Int32 evid)
         case EVT_PICKUPCLAIMED:         return mOnPickupClaimed;
         case EVT_PICKUPCOLLECTED:       return mOnPickupCollected;
         case EVT_PICKUPWORLD:           return mOnPickupWorld;
+        case EVT_PICKUPALPHA:           return mOnPickupAlpha;
         case EVT_PICKUPRESPAWN:         return mOnPickupRespawn;
         case EVT_CHECKPOINTENTERED:     return mOnCheckpointEntered;
         case EVT_CHECKPOINTEXITED:      return mOnCheckpointExited;
@@ -602,6 +605,7 @@ Function & Core::GetPickupEvent(Int32 id, Int32 evid)
         case EVT_PICKUPCLAIMED:         return inst.mOnClaimed;
         case EVT_PICKUPCOLLECTED:       return inst.mOnCollected;
         case EVT_PICKUPWORLD:           return inst.mOnWorld;
+        case EVT_PICKUPWORLD:           return inst.mOnAlpha;
         default:                        return NullFunction();
     }
 }

source/Entity/Pickup.cpp

@@ -200,12 +200,27 @@ Int32 CPickup::GetAlpha() const
 }
 
 // ------------------------------------------------------------------------------------------------
-void CPickup::SetAlpha(Int32 alpha) const
+void CPickup::SetAlpha(Int32 alpha)
 {
     // Validate the managed identifier
     Validate();
-    // Perform the requested operation
+    // Grab the current value for this property
+    const Int32 current = _Func->GetPickupAlpha(m_ID);
+    // Don't even bother if it's the same value
+    if (current == alpha)
+    {
+        return;
+    }
+    // Avoid property unwind from a recursive call
     _Func->SetPickupAlpha(m_ID, alpha);
+    // Avoid infinite recursive event loops
+    if (!(m_CircularLocks & PICKUPCL_EMIT_PICKUP_ALPHA))
+    {
+        // Prevent this event from triggering while executed
+        BitGuardU32 bg(m_CircularLocks, PICKUPCL_EMIT_PICKUP_ALPHA);
+        // Now forward the event call
+        Core::Get().EmitPickupAlpha(m_ID, current, alpha);
+    }
 }
 
 // ------------------------------------------------------------------------------------------------

source/Entity/Pickup.hpp

@@ -12,7 +12,8 @@ namespace SqMod {
 */
 enum PickupCircularLocks
 {
-    PICKUPCL_EMIT_PICKUP_WORLD      = (1 << 0)
+    PICKUPCL_EMIT_PICKUP_WORLD      = (1 << 0),
+    PICKUPCL_EMIT_PICKUP_ALPHA      = (2 << 0)
 };
 
 /* ------------------------------------------------------------------------------------------------
@@ -211,7 +212,7 @@ public:
     /* --------------------------------------------------------------------------------------------
      * Mpdify the alpha of the managed pickup entity.
     */
-    void SetAlpha(Int32 alpha) const;
+    void SetAlpha(Int32 alpha);
 
     /* --------------------------------------------------------------------------------------------
      * See whether the managed pickup entity is automatic.

source/SqBase.hpp

@@ -368,6 +368,7 @@ enum EventType
     EVT_PICKUPCOLLECTED,
     EVT_PICKUPRESPAWN,
     EVT_PICKUPWORLD,
+    EVT_PICKUPALPHA,
     EVT_CHECKPOINTENTERED,
     EVT_CHECKPOINTEXITED,
     EVT_CHECKPOINTWORLD,