feat: removing bridge classes for game states MTT-4204 (#697)

* 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.

* 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

* #

* Changed some type names based on feedback

* Cleanup

* Update Assets/Scripts/Gameplay/GameState/ServerBossRoomState.cs

Co-authored-by: Fernando Cortez <[email protected]>

* Update Assets/Scripts/Gameplay/GameState/GameStateBehaviour.cs

Co-authored-by: Fernando Cortez <[email protected]>

* Update CHANGELOG.md

Co-authored-by: Sam Bellomo <[email protected]>

Co-authored-by: Fernando Cortez <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

Author: 3 people

Assets/GameData/Transforms.meta

@@ -10,7 +10,6 @@ GameObject:
   m_Component:
   - component: {fileID: 5655447013084909147}
   - component: {fileID: 3608714310874968837}
-  - component: {fileID: -1764033382396218637}
   - component: {fileID: 5762482089640033414}
   - component: {fileID: 1290852967062359934}
   m_Layer: 0
@@ -59,22 +58,6 @@ MonoBehaviour:
   AlwaysReplicateAsRoot: 0
   DontDestroyWithOwner: 0
   AutoObjectParentSync: 1
---- !u!114 &-1764033382396218637
-MonoBehaviour:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 297185343939699586}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 5e631ac38df479741af592cf6a1fb553, type: 3}
-  m_Name: 
-  m_EditorClassIdentifier: 
-  parentReference:
-    TypeName: Unity.Multiplayer.Samples.BossRoom.Shared.ApplicationController
-  autoRun: 1
-  autoInjectGameObjects: []
 --- !u!114 &5762482089640033414
 MonoBehaviour:
   m_ObjectHideFlags: 0

Assets/GameData/Transforms/NetworkGameState.asset

@@ -11,7 +11,6 @@ GameObject:
   - component: {fileID: 7475764267130300179}
   - component: {fileID: -1007214952234040975}
   - component: {fileID: 7475764267130300178}
-  - component: {fileID: 4223400095609434710}
   - component: {fileID: 6576822806953781696}
   m_Layer: 0
   m_Name: PostGameState
@@ -66,24 +65,10 @@ MonoBehaviour:
   parentReference:
     TypeName: Unity.Multiplayer.Samples.BossRoom.Shared.ApplicationController
   autoRun: 1
-  autoInjectGameObjects: []
+  autoInjectGameObjects:
+  - {fileID: 0}
+  - {fileID: 0}
   m_NetcodeHooks: {fileID: 6576822806953781696}
---- !u!114 &4223400095609434710
-MonoBehaviour:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 7475764267130300177}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 1cb58d1788f410740b05cace1af646d7, type: 3}
-  m_Name: 
-  m_EditorClassIdentifier: 
-  parentReference:
-    TypeName: Unity.Multiplayer.Samples.BossRoom.Shared.ApplicationController
-  autoRun: 1
-  autoInjectGameObjects: []
 --- !u!114 &6576822806953781696
 MonoBehaviour:
   m_ObjectHideFlags: 0

Assets/GameData/Transforms/NetworkGameState.asset.meta

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:e3f00d58c6349986e4c2ca3da5c3d980eeda05bd854d63e23d1f3ab33f034b71
-size 509756
+oid sha256:28e9292af276f5fdbe32dc931b3a6d824263b787d59fefe880f074fa5e7fad6e
+size 512114

Assets/Prefabs/Game/NetworkGameState.prefab

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:dc4d365307a7b5b33726c81e1712f9ab7bd560329a22eb58c7c47b4ef47efef5
-size 323941
+oid sha256:307baa6090b31634d2d893f38c607db1cf8a20b168e0a6685a8949e21a16f1bd
+size 341270

Assets/Prefabs/Game/NetworkGameState.prefab.meta

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:6204feb139a189133ac967d65ca2e1ecb98473d35b48374d869c978fded08b78
-size 23353
+oid sha256:57ac496744b0443b24010d960e533b4d87e8d4f80dd2392335230f5aaa340884
+size 32367

Assets/Prefabs/State/BossRoomState.prefab

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:18e051b0b22353028bda0afb8480efdcde0402832ca6037be7152f3d86b4472d
-size 19943
+oid sha256:b336bff4745a948e139a266ca62409cc84a3de1d78015e23b8c53b18ce346212
+size 24809

Assets/Prefabs/State/PostGameState.prefab

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:ddaaa366f8d07e0e8347f5cecd0d7bd6b71715365ad0458a45667ce3463f3672
-size 67888
+oid sha256:a83cc5f0506fee3971c22471b21a73080100af8bf903f60b0d265cf35b7a2a9b
+size 66255

Assets/Scenes/BossRoom.unity

@@ -60,10 +60,6 @@ public class ConnectionManager : MonoBehaviour
         NetworkManager m_NetworkManager;
         public NetworkManager NetworkManager => m_NetworkManager;
 
-        [SerializeField]
-        NetworkObject m_GameState;
-        public NetworkObject GameState => m_GameState;
-
         [Inject]
         IObjectResolver m_Resolver;
 

Assets/Scenes/BossRoom/DungeonBossRoom.unity

@@ -25,10 +25,6 @@ class HostingState : ConnectionState
 
         public override void Enter()
         {
-            var gameState = UnityEngine.Object.Instantiate(m_ConnectionManager.GameState);
-
-            gameState.Spawn();
-
             SceneLoaderWrapper.Instance.AddOnSceneEventCallback();
 
             //The "BossRoom" server always advances to CharSelect immediately on start. Different games

Assets/Scenes/BossRoom/DungeonEntrance.unity

@@ -16,7 +16,7 @@ public enum GameState
     }
 
     /// <summary>
-    /// A special kind of NetworkBehaviour that represents a discrete game state. The special feature it offers is
+    /// A special component that represents a discrete game state and its dependencies. The special feature it offers is
     /// that it provides some guarantees that only one such GameState will be running at a time.
     /// </summary>
     /// <remarks>
@@ -32,7 +32,7 @@ public enum GameState
     ///    with other networked prefabs).
     /// Q: If these are MonoBehaviours, how do you have a single state that persists across multiple scenes?
     /// A: Set your Persists property to true. If you transition to another scene that has the same gamestate, the
-    ///    current GameState object will live on, and the version in the new scene will suicide to make room for it.
+    ///    current GameState object will live on, and the version in the new scene will auto-destruct to make room for it.
     ///
     /// Important Note: We assume that every Scene has a GameState object. If not, then it's possible that a Persisting game state
     /// will outlast its lifetime (as there is no successor state to clean it up).

Assets/Scenes/BossRoom/DungeonTransition.unity

@@ -12,10 +12,12 @@ public enum WinState
     }
 
     /// <summary>
-    /// MonoBehaviour containing only one NetworkVariableBool to represent the game session's win state.
+    /// MonoBehaviour containing only one NetworkVariable<WinState> to represent the game session's win state.
     /// </summary>
-    public class NetworkWinState : NetworkBehaviour
+    public class PersistentGameState : NetworkBehaviour
     {
         public NetworkVariable<WinState> winState = new NetworkVariable<WinState>(WinState.Invalid);
+
+        public static PersistentGameState Instance;
     }
 }