feat: action system cleanup MTT-4244 (#701)

* Adjusted GameStateBehaviour class description

* Removed ClientBossRoomState

And renamed ServerBossRoomState to BossRoomState.
Added lifetime scopes to all the subscenes of BossRoom scene. These autoinject gameobjects that live under the "static network objects" groupings.

* Removed NetworkGameState and NetworkWinState

replaced with BufferedNetworkMessageChannel (an addition in this entry) - this message channel is identical to NetworkMessageChannel, but it inherits from a buffered message channel instead. This is used as a way to pass data that syncs from server to clients between different scenes without the need for SO variables, which are hard to understand.

* ClientMainMenuState renamed to MainMenuState

* Removed ClientPostGameState and renamed ServerPostGameState to PostGameState

also added auto-injected objects to the PostGameState-bearing game object.

* moving files to different subfolders for better organization

* Changelog and typo fixes

* nullref fix (was disposing of a subscription handle before it was returned from the method)

* Removed BufferedNetworkMessageChannel

Replaced it's usage with WinState with a NetworkWinState that's preserved by BossRoomState to survive onto the next scene, PostGameState, which then destroys that preserved gameobject/NetworkWinState when we exit PostGameState to whatever next state.

* actually setting win state

* #

* further folder adjustments

* Namespace and funtion name changes for Actions

Moved all Action-related code into .Actions namespace, adjusted the rest of the codebase accordingly.
Renamed Start and Update methods of Actions to be OnStart and OnUpdate (to avoid confusing overlap with MonoBehavior event calls).
Moved FXProjectile to GameplayObjects folder.

* Start renamed to OnStart in ActionVisualization

* moving new actions appropriately

* Restored Client/Server names for game states

these were accidentally overriden during merges

Author: pdeschain

Assets/Scripts/Gameplay/Action/ActionPlayers.meta

@@ -1,8 +1,9 @@
 using System.Collections.Generic;
+using Unity.Multiplayer.Samples.BossRoom.Server;
 using UnityEngine;
 using BlockingMode = Unity.Multiplayer.Samples.BossRoom.ActionDescription.BlockingModeType;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Server
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// Class responsible for playing back action inputs from user.
@@ -158,7 +159,7 @@ private void StartAction()
                 SynthesizeChaseIfNecessary(index);
 
                 m_Queue[0].TimeStarted = Time.time;
-                bool play = m_Queue[0].Start();
+                bool play = m_Queue[0].OnStart();
                 if (!play)
                 {
                     //actions that exited out in the "Start" method will not have their End method called, by design.
@@ -314,7 +315,7 @@ public void Update()
         /// <returns>true if the action is still active, false if it's dead</returns>
         private bool UpdateAction(Action action)
         {
-            bool keepGoing = action.Update();
+            bool keepGoing = action.OnUpdate();
             bool expirable = action.Description.DurationSeconds > 0f; //non-positive value is a sentinel indicating the duration is indefinite.
             var timeElapsed = Time.time - action.TimeStarted;
             bool timeExpired = expirable && timeElapsed >= action.Description.DurationSeconds;

Assets/Scripts/Gameplay/Action/ActionPlayer.cs renamed to Assets/Scripts/Gameplay/Action/ActionPlayers/ActionPlayer.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
+using Unity.Multiplayer.Samples.BossRoom.Visual;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Visual
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// This is a companion class to ClientCharacterVisualization that is specifically responsible for visualizing Actions. Action visualizations have lifetimes
@@ -23,13 +24,13 @@ public ActionVisualization(ClientCharacterVisualization parent)
             Parent = parent;
         }
 
-        public void Update()
+        public void OnUpdate()
         {
             //do a reverse-walk so we can safely remove inside the loop.
             for (int i = m_PlayingActions.Count - 1; i >= 0; --i)
             {
                 var action = m_PlayingActions[i];
-                bool keepGoing = action.Anticipated || action.Update(); // only call Update() on actions that are past anticipation
+                bool keepGoing = action.Anticipated || action.OnUpdate(); // only call OnUpdate() on actions that are past anticipation
                 bool expirable = action.Description.DurationSeconds > 0f; //non-positive value is a sentinel indicating the duration is indefinite.
                 bool timeExpired = expirable && action.TimeRunning >= action.Description.DurationSeconds;
                 bool timedOut = action.Anticipated && action.TimeRunning >= k_AnticipationTimeoutSeconds;
@@ -114,7 +115,7 @@ public void PlayAction(ref ActionRequestData data)
             var anticipatedActionIndex = FindAction(data.ActionTypeEnum, true);
 
             var actionFX = anticipatedActionIndex >= 0 ? m_PlayingActions[anticipatedActionIndex] : ActionFX.MakeActionFX(ref data, Parent);
-            if (actionFX.Start())
+            if (actionFX.OnStart())
             {
                 m_PlayingActions.Add(actionFX);
             }

Assets/Scripts/Gameplay/Action/ActionPlayer.cs.meta renamed to Assets/Scripts/Gameplay/Action/ActionPlayers/ActionPlayer.cs.meta

@@ -2,7 +2,7 @@
 using Unity.Netcode;
 using UnityEngine;
 
-namespace Unity.Multiplayer.Samples.BossRoom
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     public static class ActionUtils
     {

Assets/Scripts/Gameplay/Action/ActionVisualization.cs renamed to Assets/Scripts/Gameplay/Action/ActionPlayers/ActionVisualization.cs

@@ -1,7 +1,8 @@
+using Unity.Multiplayer.Samples.BossRoom.Server;
 using UnityEngine;
 using BlockingMode = Unity.Multiplayer.Samples.BossRoom.ActionDescription.BlockingModeType;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Server
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// The abstract parent class that all Actions derive from.
@@ -40,17 +41,17 @@ public Action(ServerCharacter parent, ref ActionRequestData data) : base(ref dat
         /// Called when the Action starts actually playing (which may be after it is created, because of queueing).
         /// </summary>
         /// <returns>false if the action decided it doesn't want to run after all, true otherwise. </returns>
-        public abstract bool Start();
+        public abstract bool OnStart();
 
 
         /// <summary>
         /// Called each frame while the action is running.
         /// </summary>
         /// <returns>true to keep running, false to stop. The Action will stop by default when its duration expires, if it has a duration set. </returns>
-        public abstract bool Update();
+        public abstract bool OnUpdate();
 
         /// <summary>
-        /// Called each frame (before Update()) for the active ("blocking") Action, asking if it should become a background Action.
+        /// Called each frame (before OnUpdate()) for the active ("blocking") Action, asking if it should become a background Action.
         /// </summary>
         /// <returns>true to become a non-blocking Action, false to remain a blocking Action</returns>
         public virtual bool ShouldBecomeNonBlocking()

Assets/Scripts/Gameplay/Action/ActionVisualization.cs.meta renamed to Assets/Scripts/Gameplay/Action/ActionPlayers/ActionVisualization.cs.meta

@@ -1,7 +1,7 @@
 using System.Collections.Generic;
 using UnityEngine;
 
-namespace Unity.Multiplayer.Samples.BossRoom
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// Abstract base class containing some common members shared by Action (server) and ActionFX (client visual)

Assets/Scripts/Gameplay/Action/ActionUtils.cs

@@ -1,8 +1,9 @@
 using UnityEngine;
 using System.Collections.Generic;
+using Unity.Multiplayer.Samples.BossRoom.Visual;
 using Unity.Netcode;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Visual
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// Abstract base class for playing back the visual feedback of an Action.
@@ -30,17 +31,17 @@ public ActionFX(ref ActionRequestData data, ClientCharacterVisualization parent)
         /// Starts the ActionFX. Derived classes may return false if they wish to end immediately without their Update being called.
         /// </summary>
         /// <remarks>
-        /// Derived class should be sure to call base.Start() in their implementation, but note that this resets "Anticipated" to false.
+        /// Derived class should be sure to call base.OnStart() in their implementation, but note that this resets "Anticipated" to false.
         /// </remarks>
         /// <returns>true to play, false to be immediately cleaned up.</returns>
-        public virtual bool Start()
+        public virtual bool OnStart()
         {
             Anticipated = false; //once you start for real you are no longer an anticipated action.
             TimeStarted = UnityEngine.Time.time;
             return true;
         }
 
-        public abstract bool Update();
+        public abstract bool OnUpdate();
 
         /// <summary>
         /// End is always called when the ActionFX finishes playing. This is a good place for derived classes to put

Assets/Scripts/Gameplay/Action/BaseTypes.meta

@@ -1,7 +1,8 @@
+using Unity.Multiplayer.Samples.BossRoom.Server;
 using Unity.Netcode;
 using UnityEngine;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Server
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// Area-of-effect attack Action. The attack is centered on a point provided by the client.
@@ -20,7 +21,7 @@ public class AoeAction : Action
         public AoeAction(ServerCharacter parent, ref ActionRequestData data)
             : base(parent, ref data) { }
 
-        public override bool Start()
+        public override bool OnStart()
         {
             float distanceAway = Vector3.Distance(m_Parent.physicsWrapper.Transform.position, Data.Position);
             if (distanceAway > Description.Range + k_MaxDistanceDivergence)
@@ -38,7 +39,7 @@ public override bool Start()
             return ActionConclusion.Continue;
         }
 
-        public override bool Update()
+        public override bool OnUpdate()
         {
             if (TimeRunning >= Description.ExecTimeSeconds && !m_DidAoE)
             {

Assets/Scripts/Gameplay/Action/Action.cs renamed to Assets/Scripts/Gameplay/Action/BaseTypes/Action.cs

@@ -1,4 +1,6 @@
-namespace Unity.Multiplayer.Samples.BossRoom.Visual
+using Unity.Multiplayer.Samples.BossRoom.Visual;
+
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// Used for simple Actions that only need to play a few animations (one at startup and optionally
@@ -8,7 +10,7 @@ public class AnimationOnlyActionFX : ActionFX
     {
         public AnimationOnlyActionFX(ref ActionRequestData data, ClientCharacterVisualization parent) : base(ref data, parent) { }
 
-        public override bool Update()
+        public override bool OnUpdate()
         {
             return ActionConclusion.Continue;
         }

Assets/Scripts/Gameplay/Action/Action.cs.meta renamed to Assets/Scripts/Gameplay/Action/BaseTypes/Action.cs.meta

@@ -1,22 +1,23 @@
 using System;
+using Unity.Multiplayer.Samples.BossRoom.Visual;
 using UnityEngine;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Visual
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// Final step in the AoE action flow. Please see AoEActionInput for the first step and more details on overall flow
     public class AoeActionFX : ActionFX
     {
         public AoeActionFX(ref ActionRequestData data, ClientCharacterVisualization parent)
             : base(ref data, parent) { }
 
-        public override bool Start()
+        public override bool OnStart()
         {
-            base.Start();
+            base.OnStart();
             GameObject.Instantiate(Description.Spawns[0], m_Data.Position, Quaternion.identity);
             return ActionConclusion.Stop;
         }
 
-        public override bool Update()
+        public override bool OnUpdate()
         {
             throw new Exception("This should not execute");
         }

Assets/Scripts/Gameplay/Action/ActionBase.cs renamed to Assets/Scripts/Gameplay/Action/BaseTypes/ActionBase.cs

@@ -1,7 +1,8 @@
+using Unity.Multiplayer.Samples.BossRoom.Server;
 using Unity.Netcode;
 using UnityEngine;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Server
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// A version of LaunchProjectileAction that can be "powered up" by holding down the attack key.
@@ -34,7 +35,7 @@ public class ChargedLaunchProjectileAction : LaunchProjectileAction
 
         public ChargedLaunchProjectileAction(ServerCharacter parent, ref ActionRequestData data) : base(parent, ref data) { }
 
-        public override bool Start()
+        public override bool OnStart()
         {
             // if we have an explicit target, make sure we're aimed at them.
             // (But if the player just clicked on an attack button, there won't be an explicit target, so we should stay facing however we're facing.)
@@ -64,7 +65,7 @@ public override bool Start()
             return true;
         }
 
-        public override bool Update()
+        public override bool OnUpdate()
         {
             if (m_StoppedChargingUpTime == 0 && GetPercentChargedUp() >= 1)
             {

Assets/Scripts/Gameplay/Action/ActionBase.cs.meta renamed to Assets/Scripts/Gameplay/Action/BaseTypes/ActionBase.cs.meta

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
+using Unity.Multiplayer.Samples.BossRoom.Visual;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Visual
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// The visual aspect of a ChargedLaunchProjectileAction.
@@ -23,15 +24,15 @@ public ChargedLaunchProjectileActionFX(ref ActionRequestData data, ClientCharact
 
         private bool m_ChargeEnded;
 
-        public override bool Start()
+        public override bool OnStart()
         {
-            base.Start();
+            base.OnStart();
 
             m_Graphics = InstantiateSpecialFXGraphics(m_Parent.transform, true);
             return true;
         }
 
-        public override bool Update()
+        public override bool OnUpdate()
         {
             return !m_ChargeEnded;
         }

Assets/Scripts/Gameplay/Action/ActionFX.cs renamed to Assets/Scripts/Gameplay/Action/BaseTypes/ActionFX.cs

@@ -1,7 +1,8 @@
+using Unity.Multiplayer.Samples.BossRoom.Server;
 using Unity.Netcode;
 using UnityEngine;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Server
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// A defensive action where the character becomes resistant to damage.
@@ -30,7 +31,7 @@ public class ChargedShieldAction : Action
         public ChargedShieldAction(ServerCharacter parent, ref ActionRequestData data)
             : base(parent, ref data) { }
 
-        public override bool Start()
+        public override bool OnStart()
         {
             if (m_Data.TargetIds != null && m_Data.TargetIds.Length > 0)
             {
@@ -60,7 +61,7 @@ private bool IsChargingUp()
             return m_StoppedChargingUpTime == 0;
         }
 
-        public override bool Update()
+        public override bool OnUpdate()
         {
             if (m_StoppedChargingUpTime == 0)
             {

Assets/Scripts/Gameplay/Action/ActionFX.cs.meta renamed to Assets/Scripts/Gameplay/Action/BaseTypes/ActionFX.cs.meta

@@ -1,7 +1,8 @@
+using Unity.Multiplayer.Samples.BossRoom.Visual;
 using UnityEngine;
 using UnityEngine.Assertions;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Visual
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     /// <summary>
     /// The visual aspect of a ChargedShieldAction. Shows "charge up particles" while the power is charging up.
@@ -28,11 +29,11 @@ public class ChargedShieldActionFX : ActionFX
 
         public ChargedShieldActionFX(ref ActionRequestData data, ClientCharacterVisualization parent) : base(ref data, parent) { }
 
-        public override bool Start()
+        public override bool OnStart()
         {
             Assert.IsTrue(Description.Spawns.Length == 2, $"Found {Description.Spawns.Length} spawns for action {Description.ActionTypeEnum}. Should be exactly 2: a charge-up particle and a fully-charged particle");
 
-            base.Start();
+            base.OnStart();
             m_ChargeGraphics = InstantiateSpecialFXGraphic(Description.Spawns[0], m_Parent.transform, true);
             return true;
         }
@@ -42,7 +43,7 @@ private bool IsChargingUp()
             return m_StoppedChargingUpTime == 0;
         }
 
-        public override bool Update()
+        public override bool OnUpdate()
         {
             return IsChargingUp() || (Time.time - m_StoppedChargingUpTime) < Description.EffectDurationSeconds;
         }

Assets/Scripts/Gameplay/Action/ConcreteActions.meta

@@ -1,7 +1,8 @@
+using Unity.Multiplayer.Samples.BossRoom.Server;
 using Unity.Netcode;
 using UnityEngine;
 
-namespace Unity.Multiplayer.Samples.BossRoom.Server
+namespace Unity.Multiplayer.Samples.BossRoom.Actions
 {
     public class ChaseAction : Action
     {
@@ -20,7 +21,7 @@ public ChaseAction(ServerCharacter parent, ref ActionRequestData data) : base(pa
         /// Called when the Action starts actually playing (which may be after it is created, because of queueing).
         /// </summary>
         /// <returns>false if the action decided it doesn't want to run after all, true otherwise. </returns>
-        public override bool Start()
+        public override bool OnStart()
         {
             if (!HasValidTarget())
             {
@@ -94,7 +95,7 @@ private bool StopIfDone()
         /// Called each frame while the action is running.
         /// </summary>
         /// <returns>true to keep running, false to stop. The Action will stop by default when its duration expires, if it has a duration set. </returns>
-        public override bool Update()
+        public override bool OnUpdate()
         {
             if (StopIfDone()) { return ActionConclusion.Stop; }