separation of pickup and hold actions, can visualize drop on action bar

Author: fernando-cortez

Assets/GameData/Action/General/Drop.asset

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:233623c213dbc645c5c3a93da5963445fbb7028c9b8abaa24b684d5f90e3ee8b
+size 979

Assets/GameData/Action/General/Drop.asset.meta

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:d66a4c5142547c017fb54aa3d881abc43eca7d5f4b74bc800d4439b31b4081d5
-size 997
+oid sha256:912155f31fbc6d9317b07ef92e5c7affee747fba3c8bd711179339fec38ab44b
+size 1023

Assets/GameData/Action/General/PickUp.asset

@@ -220,17 +220,6 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 4a3a07abfb44d50469112a0db6a202b2, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
---- !u!114 &6009713983291384752 stripped
-MonoBehaviour:
-  m_CorrespondingSourceObject: {fileID: 4600110157238723777, guid: 0d2d836e2e83b754fa1a1c4022d6d65d, type: 3}
-  m_PrefabInstance: {fileID: 7831782662127126385}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 6009713983291384756}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: edb78c1621dad5149bb47b96120d3fbf, type: 3}
-  m_Name: 
-  m_EditorClassIdentifier: 
 --- !u!1 &6009713983291384756 stripped
 GameObject:
   m_CorrespondingSourceObject: {fileID: 4600110157238723781, guid: 0d2d836e2e83b754fa1a1c4022d6d65d, type: 3}
@@ -350,20 +339,6 @@ MonoBehaviour:
   m_Name: 
   m_EditorClassIdentifier: 
   m_PlayerAvatars: {fileID: 11400000, guid: 13c227b8a2f5f5f4a8c252835aaf648f, type: 2}
---- !u!114 &6387032110594377642
-MonoBehaviour:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 6009713983291384756}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 0e59f6113deae61408ad63553733ed77, type: 3}
-  m_Name: 
-  m_EditorClassIdentifier: 
-  m_NetworkLifeState: {fileID: 6173771494986166194}
-  m_NetworkCharacterState: {fileID: 6009713983291384752}
 --- !u!114 &6940323159316181846
 MonoBehaviour:
   m_ObjectHideFlags: 0

Assets/Prefabs/Character/PlayerAvatar.prefab

@@ -78,3 +78,4 @@ MonoBehaviour:
   - {fileID: 11400000, guid: f129c86376940384fb96b3512705c6e2, type: 2}
   - {fileID: 11400000, guid: 723a546f69cc50543b7b04f8277d26b5, type: 2}
   - {fileID: 11400000, guid: fc0a156ae5548e949a1b3dd3b5f27ad6, type: 2}
+  - {fileID: 11400000, guid: ab3f9292f9b310a4795d26885e92a5d1, type: 2}

Assets/Prefabs/GameDataSource.prefab

@@ -176,6 +176,7 @@ public static Action MakeAction(ServerCharacter parent, ref ActionRequestData da
                 case ActionLogic.DashAttack: return new DashAttackAction(parent, ref data);
                 case ActionLogic.ImpToss: return new TossAction(parent, ref data);
                 case ActionLogic.PickUp: return new PickUpAction(parent, ref data);
+                case ActionLogic.Drop: return new DropAction(parent, ref data);
                 default: throw new System.NotImplementedException();
             }
         }

Assets/Scripts/Gameplay/Action/Action.cs

@@ -79,6 +79,7 @@ public static ActionFX MakeActionFX(ref ActionRequestData data, ClientCharacterV
                 case ActionLogic.DashAttack: return new DashAttackActionFX(ref data, parent);
 
                 case ActionLogic.PickUp:
+                case ActionLogic.Drop:
                 case ActionLogic.Stunned:
                 case ActionLogic.LaunchProjectile:
                 case ActionLogic.Revive:

Assets/Scripts/Gameplay/Action/ActionFX.cs

@@ -43,7 +43,9 @@ public ActionPlayer(ServerCharacter parent)
         /// </summary>
         public void PlayAction(ref ActionRequestData action)
         {
-            if (!action.ShouldQueue && m_Queue.Count > 0 && m_Queue[0].Description.ActionInterruptible)
+            if (!action.ShouldQueue && m_Queue.Count > 0 &&
+                (m_Queue[0].Description.ActionInterruptible ||
+                    m_Queue[0].Description.IsInterruptableBy.Contains(action.ActionTypeEnum)));
             {
                 ClearActions(false);
             }

Assets/Scripts/Gameplay/Action/ActionPlayer.cs

@@ -35,7 +35,8 @@ public enum ActionType
         ArcherVolley,
         RogueDashAttack,
         ImpToss,
-        PickUp
+        PickUp,
+        Drop
     }
 
 
@@ -60,7 +61,8 @@ public enum ActionLogic
         StealthMode,
         DashAttack,
         ImpToss,
-        PickUp
+        PickUp,
+        Drop
         //O__O adding a new ActionLogic branch? Update Action.MakeAction!
     }
 

Assets/Scripts/Gameplay/Action/ActionRequestData.cs

@@ -0,0 +1,55 @@
+using System;
+using Unity.Netcode;
+using UnityEngine;
+
+namespace Unity.Multiplayer.Samples.BossRoom.Server
+{
+    /// <summary>
+    /// Action for dropping "Heavy" items.
+    /// </summary>
+    public class DropAction : Action
+    {
+        float m_ActionStartTime;
+
+        NetworkObject m_HeldNetworkObject;
+
+        public DropAction(ServerCharacter parent, ref ActionRequestData data) : base(parent, ref data)
+        {
+        }
+
+        public override bool Start()
+        {
+            m_ActionStartTime = Time.time;
+
+            // play animation of dropping a heavy object, if one is already held
+            if (NetworkManager.Singleton.SpawnManager.SpawnedObjects.TryGetValue(
+                    m_Parent.NetState.heldNetworkObject.Value, out var heldObject))
+            {
+                m_HeldNetworkObject = heldObject;
+
+                Data.TargetIds = null;
+
+                if (!string.IsNullOrEmpty(Description.Anim))
+                {
+                    m_Parent.serverAnimationHandler.NetworkAnimator.SetTrigger(Description.Anim);
+                }
+            }
+
+            return true;
+        }
+
+        public override bool Update()
+        {
+            if (Time.time > m_ActionStartTime + Description.ExecTimeSeconds)
+            {
+                // drop the pot in space
+                m_HeldNetworkObject.transform.SetParent(null);
+                m_Parent.NetState.heldNetworkObject.Value = 0;
+
+                return ActionConclusion.Stop;
+            }
+
+            return ActionConclusion.Continue;
+        }
+    }
+}

Assets/Scripts/Gameplay/Action/DropAction.cs

@@ -18,66 +18,42 @@ public class PickUpAction : Action
 
         const string k_NpcLayer = "NPCs";
 
-        const float k_PickUpWait = 0.6f;
-
         const string k_FailedPickupTrigger = "PickUpFailed";
 
-        float m_AnimationTimer;
+        float m_ActionStartTime;
 
         static RaycastHitComparer s_RaycastHitComparer;
 
+        NetworkLifeState m_NetworkLifeState;
+
+        bool m_AttemptedPickup;
+
         public PickUpAction(ServerCharacter parent, ref ActionRequestData data) : base(parent, ref data)
         {
             s_RaycastHitComparer ??= new RaycastHitComparer();
+
+            m_NetworkLifeState = m_Parent.NetState.NetworkLifeState;
         }
 
         public override bool Start()
         {
-            // play animation based on if a heavy object is already held and start timer
-            if (NetworkManager.Singleton.SpawnManager.SpawnedObjects.TryGetValue(m_Parent.NetState.heldNetworkObject.Value, out var heldObject))
-            {
-                Data.TargetIds = null;
+            m_ActionStartTime = Time.time;
 
-                if (!string.IsNullOrEmpty(Description.Anim))
-                {
-                    m_Parent.serverAnimationHandler.NetworkAnimator.ResetTrigger(Description.Anim);
-                }
-
-                // drop
-                if (!string.IsNullOrEmpty(Description.Anim2))
-                {
-                    m_Parent.serverAnimationHandler.NetworkAnimator.SetTrigger(Description.Anim2);
-                }
-            }
-            else
+            // play pickup animation based if a heavy object is not already held
+            if (!NetworkManager.Singleton.SpawnManager.SpawnedObjects.TryGetValue(
+                    m_Parent.NetState.heldNetworkObject.Value, out var heldObject))
             {
-                if (!string.IsNullOrEmpty(Description.Anim2))
-                {
-                    m_Parent.serverAnimationHandler.NetworkAnimator.ResetTrigger(Description.Anim2);
-                }
-
-                // pickup
                 if (!string.IsNullOrEmpty(Description.Anim))
                 {
                     m_Parent.serverAnimationHandler.NetworkAnimator.SetTrigger(Description.Anim);
                 }
             }
 
-            m_AnimationTimer = k_PickUpWait;
-
             return true;
         }
 
-        void PickUpOrDrop()
+        bool TryPickUp()
         {
-            if (NetworkManager.Singleton.SpawnManager.SpawnedObjects.TryGetValue(m_Parent.NetState.heldNetworkObject.Value, out var heldObject))
-            {
-                // pickup object found inside of hierarchy; drop it
-                m_Parent.NetState.heldNetworkObject.Value = 0;
-                heldObject.transform.SetParent(null);
-                return;
-            }
-
             var numResults = Physics.RaycastNonAlloc(m_Parent.physicsWrapper.Transform.position,
                 m_Parent.physicsWrapper.Transform.forward,
                 m_RaycastHits,
@@ -86,28 +62,16 @@ void PickUpOrDrop()
 
             Array.Sort(m_RaycastHits, 0, numResults, s_RaycastHitComparer);
 
-            // collider must contain "Heavy" tag
+            // collider must contain "Heavy" tag, the heavy object must not be parented to another NetworkObject, and
+            // parenting attempt must be successful
             if (numResults == 0 || !m_RaycastHits[0].collider.TryGetComponent(out NetworkObject heavyNetworkObject) ||
-                !m_RaycastHits[0].collider.gameObject.CompareTag(k_HeavyTag))
-            {
-                m_Parent.serverAnimationHandler.NetworkAnimator.SetTrigger(k_FailedPickupTrigger);
-                return;
-            }
-
-            // found a suitable collider; make sure it is not already held by another player
-            if (heavyNetworkObject.transform.parent != null &&
-                heavyNetworkObject.transform.parent.TryGetComponent(out NetworkObject parentNetworkObject))
+                !m_RaycastHits[0].collider.gameObject.CompareTag(k_HeavyTag) ||
+                (heavyNetworkObject.transform.parent != null &&
+                    heavyNetworkObject.transform.parent.TryGetComponent(out NetworkObject parentNetworkObject)) ||
+                !heavyNetworkObject.TrySetParent(m_Parent.transform))
             {
-                // pot already parented; return for now
                 m_Parent.serverAnimationHandler.NetworkAnimator.SetTrigger(k_FailedPickupTrigger);
-                return;
-            }
-
-            // found a suitable collider; try to child this NetworkObject
-            if (!heavyNetworkObject.TrySetParent(m_Parent.transform))
-            {
-                m_Parent.serverAnimationHandler.NetworkAnimator.SetTrigger(k_FailedPickupTrigger);
-                return;
+                return false;
             }
 
             m_Parent.NetState.heldNetworkObject.Value = heavyNetworkObject.NetworkObjectId;
@@ -138,20 +102,35 @@ void PickUpOrDrop()
                     positionConstraint.constraintActive = true;
                 }
             }
+
+            return true;
         }
 
         public override bool Update()
         {
-            m_AnimationTimer -= Time.deltaTime;
-
-            if (m_AnimationTimer <= 0f)
+            if (!m_AttemptedPickup && Time.time > m_ActionStartTime + Description.ExecTimeSeconds)
             {
-                PickUpOrDrop();
-
-                return ActionConclusion.Stop;
+                m_AttemptedPickup = true;
+                if (!TryPickUp())
+                {
+                    // pickup attempt unsuccessful; action can be terminated
+                    return ActionConclusion.Stop;
+                }
             }
 
             return ActionConclusion.Continue;
         }
+
+        public override void Cancel()
+        {
+            if (m_NetworkLifeState.LifeState.Value == LifeState.Fainted)
+            {
+                if (NetworkManager.Singleton.SpawnManager.SpawnedObjects.TryGetValue(m_Parent.NetState.heldNetworkObject.Value, out var heavyNetworkObject))
+                {
+                    heavyNetworkObject.transform.SetParent(null);
+                }
+                m_Parent.NetState.heldNetworkObject.Value = 0;
+            }
+        }
     }
 }

Assets/Scripts/Gameplay/GameplayObjects/ServerDropItemOnFaint.cs.meta renamed to Assets/Scripts/Gameplay/Action/DropAction.cs.meta

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using UnityEngine;
 
 namespace Unity.Multiplayer.Samples.BossRoom
@@ -73,6 +74,9 @@ public class ActionDescription : ScriptableObject
         [Tooltip("Is this Action interruptible by other action-plays or by movement? (Implicitly stops movement when action starts.) Generally, actions with short exec times should not be interruptible in this way.")]
         public bool ActionInterruptible;
 
+        [Tooltip("This action is interrupted if an action of any of the following types is requested")]
+        public List<ActionType> IsInterruptableBy;
+
         [System.Serializable]
         public enum BlockingModeType
         {

Assets/Scripts/Gameplay/Action/PickUpAction.cs

@@ -235,8 +235,6 @@ void ReceiveHP(ServerCharacter inflicter, int HP)
             //that's handled by a separate function.
             if (NetState.HitPoints <= 0)
             {
-                m_ActionPlayer.ClearActions(false);
-
                 if (IsNpc)
                 {
                     if (m_KilledDestroyDelaySeconds >= 0.0f && NetState.LifeState != LifeState.Dead)
@@ -250,6 +248,8 @@ void ReceiveHP(ServerCharacter inflicter, int HP)
                 {
                     NetState.LifeState = LifeState.Fainted;
                 }
+
+                m_ActionPlayer.ClearActions(false);
             }
         }