aha

Assets/Mirror/Examples/Basic/Scripts/BasicNetManager.cs

@@ -0,0 +1,30 @@
+using UnityEngine;
+
+namespace Mirror.Examples.Basic
+{
+    [AddComponentMenu("")]
+    public class BasicNetManager : NetworkManager
+    {
+        /// <summary>
+        /// Called on the server when a client adds a new player with NetworkClient.AddPlayer.
+        /// <para>The default implementation for this function creates a new player object from the playerPrefab.</para>
+        /// </summary>
+        /// <param name="conn">Connection from client.</param>
+        public override void OnServerAddPlayer(NetworkConnectionToClient conn)
+        {
+            base.OnServerAddPlayer(conn);
+            Player.ResetPlayerNumbers();
+        }
+
+        /// <summary>
+        /// Called on the server when a client disconnects.
+        /// <para>This is called on the Server when a Client disconnects from the Server. Use an override to decide what should happen when a disconnection is detected.</para>
+        /// </summary>
+        /// <param name="conn">Connection from client.</param>
+        public override void OnServerDisconnect(NetworkConnectionToClient conn)
+        {
+            base.OnServerDisconnect(conn);
+            Player.ResetPlayerNumbers();
+        }
+    }
+}

Assets/Mirror/Examples/Basic/Scripts/BasicNetManager.cs.meta

@@ -0,0 +1,18 @@
+fileFormatVersion: 2
+guid: 20460c43f0320ed4baf8c1dcf953eafa
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
+AssetOrigin:
+  serializedVersion: 1
+  productId: 129321
+  packageName: Mirror
+  packageVersion: 96.0.1
+  assetPath: Assets/Mirror/Examples/Basic/Scripts/BasicNetManager.cs
+  uploadId: 736421

Assets/Mirror/Examples/Basic/Scripts/CanvasUI.cs

@@ -0,0 +1,28 @@
+using UnityEngine;
+
+namespace Mirror.Examples.Basic
+{
+    public class CanvasUI : MonoBehaviour
+    {
+        [Tooltip("Assign Main Panel so it can be turned on from Player:OnStartClient")]
+        public RectTransform mainPanel;
+
+        [Tooltip("Assign Players Panel for instantiating PlayerUI as child")]
+        public RectTransform playersPanel;
+
+        // static instance that can be referenced from static methods below.
+        static CanvasUI instance;
+
+        void Awake()
+        {
+            instance = this;
+        }
+
+        public static void SetActive(bool active)
+        {
+            instance.mainPanel.gameObject.SetActive(active);
+        }
+
+        public static RectTransform GetPlayersPanel() => instance.playersPanel;
+    }
+}

Assets/Mirror/Examples/Basic/Scripts/CanvasUI.cs.meta

@@ -0,0 +1,18 @@
+fileFormatVersion: 2
+guid: 266fac335be17a243af86e88de84766d
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
+AssetOrigin:
+  serializedVersion: 1
+  productId: 129321
+  packageName: Mirror
+  packageVersion: 96.0.1
+  assetPath: Assets/Mirror/Examples/Basic/Scripts/CanvasUI.cs
+  uploadId: 736421

Assets/Mirror/Examples/Basic/Scripts/Player.cs

@@ -0,0 +1,181 @@
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace Mirror.Examples.Basic
+{
+    [AddComponentMenu("")]
+    public class Player : NetworkBehaviour
+    {
+        // Events that the PlayerUI will subscribe to
+        public event System.Action<byte> OnPlayerNumberChanged;
+        public event System.Action<Color32> OnPlayerColorChanged;
+        public event System.Action<ushort> OnPlayerDataChanged;
+
+        // Players List to manage playerNumber
+        static readonly List<Player> playersList = new List<Player>();
+
+        [Header("Player UI")]
+        public GameObject playerUIPrefab;
+
+        GameObject playerUIObject;
+        PlayerUI playerUI = null;
+
+        #region SyncVars
+
+        [Header("SyncVars")]
+
+        /// <summary>
+        /// This is appended to the player name text, e.g. "Player 01"
+        /// </summary>
+        [SyncVar(hook = nameof(PlayerNumberChanged))]
+        public byte playerNumber = 0;
+
+        /// <summary>
+        /// Random color for the playerData text, assigned in OnStartServer
+        /// </summary>
+        [SyncVar(hook = nameof(PlayerColorChanged))]
+        public Color32 playerColor = Color.white;
+
+        /// <summary>
+        /// This is updated by UpdateData which is called from OnStartServer via InvokeRepeating
+        /// </summary>
+        [SyncVar(hook = nameof(PlayerDataChanged))]
+        public ushort playerData = 0;
+
+        // This is called by the hook of playerNumber SyncVar above
+        void PlayerNumberChanged(byte _, byte newPlayerNumber)
+        {
+            OnPlayerNumberChanged?.Invoke(newPlayerNumber);
+        }
+
+        // This is called by the hook of playerColor SyncVar above
+        void PlayerColorChanged(Color32 _, Color32 newPlayerColor)
+        {
+            OnPlayerColorChanged?.Invoke(newPlayerColor);
+        }
+
+        // This is called by the hook of playerData SyncVar above
+        void PlayerDataChanged(ushort _, ushort newPlayerData)
+        {
+            OnPlayerDataChanged?.Invoke(newPlayerData);
+        }
+
+        #endregion
+
+        #region Server
+
+        /// <summary>
+        /// This is invoked for NetworkBehaviour objects when they become active on the server.
+        /// <para>This could be triggered by NetworkServer.Listen() for objects in the scene, or by NetworkServer.Spawn() for objects that are dynamically created.</para>
+        /// <para>This will be called for objects on a "host" as well as for object on a dedicated server.</para>
+        /// </summary>
+        public override void OnStartServer()
+        {
+            base.OnStartServer();
+
+            // Add this to the static Players List
+            playersList.Add(this);
+
+            // set the Player Color SyncVar
+            playerColor = Random.ColorHSV(0f, 1f, 0.9f, 0.9f, 1f, 1f);
+
+            // set the initial player data
+            playerData = (ushort)Random.Range(100, 1000);
+
+            // Start generating updates
+            InvokeRepeating(nameof(UpdateData), 1, 1);
+        }
+
+        // This is called from BasicNetManager OnServerAddPlayer and OnServerDisconnect
+        // Player numbers are reset whenever a player joins / leaves
+        [ServerCallback]
+        internal static void ResetPlayerNumbers()
+        {
+            byte playerNumber = 0;
+            foreach (Player player in playersList)
+                player.playerNumber = playerNumber++;
+        }
+
+        // This only runs on the server, called from OnStartServer via InvokeRepeating
+        [ServerCallback]
+        void UpdateData()
+        {
+            playerData = (ushort)Random.Range(100, 1000);
+        }
+
+        /// <summary>
+        /// Invoked on the server when the object is unspawned
+        /// <para>Useful for saving object data in persistent storage</para>
+        /// </summary>
+        public override void OnStopServer()
+        {
+            CancelInvoke();
+            playersList.Remove(this);
+        }
+
+        #endregion
+
+        #region Client
+
+        /// <summary>
+        /// Called on every NetworkBehaviour when it is activated on a client.
+        /// <para>Objects on the host have this function called, as there is a local client on the host. The values of SyncVars on object are guaranteed to be initialized correctly with the latest state from the server when this function is called on the client.</para>
+        /// </summary>
+        public override void OnStartClient()
+        {
+            // Instantiate the player UI as child of the Players Panel
+            playerUIObject = Instantiate(playerUIPrefab, CanvasUI.GetPlayersPanel());
+            playerUI = playerUIObject.GetComponent<PlayerUI>();
+
+            // wire up all events to handlers in PlayerUI
+            OnPlayerNumberChanged = playerUI.OnPlayerNumberChanged;
+            OnPlayerColorChanged = playerUI.OnPlayerColorChanged;
+            OnPlayerDataChanged = playerUI.OnPlayerDataChanged;
+
+            // Invoke all event handlers with the initial data from spawn payload
+            OnPlayerNumberChanged.Invoke(playerNumber);
+            OnPlayerColorChanged.Invoke(playerColor);
+            OnPlayerDataChanged.Invoke(playerData);
+        }
+
+        /// <summary>
+        /// Called when the local player object has been set up.
+        /// <para>This happens after OnStartClient(), as it is triggered by an ownership message from the server. This is an appropriate place to activate components or functionality that should only be active for the local player, such as cameras and input.</para>
+        /// </summary>
+        public override void OnStartLocalPlayer()
+        {
+            // Set isLocalPlayer for this Player in UI for background shading
+            playerUI.SetLocalPlayer();
+
+            // Activate the main panel
+            CanvasUI.SetActive(true);
+        }
+
+        /// <summary>
+        /// Called when the local player object is being stopped.
+        /// <para>This happens before OnStopClient(), as it may be triggered by an ownership message from the server, or because the player object is being destroyed. This is an appropriate place to deactivate components or functionality that should only be active for the local player, such as cameras and input.</para>
+        /// </summary>
+        public override void OnStopLocalPlayer()
+        {
+            // Disable the main panel for local player
+            CanvasUI.SetActive(false);
+        }
+
+        /// <summary>
+        /// This is invoked on clients when the server has caused this object to be destroyed.
+        /// <para>This can be used as a hook to invoke effects or do client specific cleanup.</para>
+        /// </summary>
+        public override void OnStopClient()
+        {
+            // disconnect event handlers
+            OnPlayerNumberChanged = null;
+            OnPlayerColorChanged = null;
+            OnPlayerDataChanged = null;
+
+            // Remove this player's UI object
+            Destroy(playerUIObject);
+        }
+
+        #endregion
+    }
+}

Assets/Mirror/Examples/Basic/Scripts/Player.cs.meta

@@ -0,0 +1,18 @@
+fileFormatVersion: 2
+guid: a472ac3ae1701d149861871cf416a46d
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
+AssetOrigin:
+  serializedVersion: 1
+  productId: 129321
+  packageName: Mirror
+  packageVersion: 96.0.1
+  assetPath: Assets/Mirror/Examples/Basic/Scripts/Player.cs
+  uploadId: 736421

Assets/Mirror/Examples/Basic/Scripts/PlayerUI.cs

@@ -0,0 +1,41 @@
+using UnityEngine;
+using UnityEngine.UI;
+
+namespace Mirror.Examples.Basic
+{
+    public class PlayerUI : MonoBehaviour
+    {
+        [Header("Player Components")]
+        public Image image;
+
+        [Header("Child Text Objects")]
+        public Text playerNameText;
+        public Text playerDataText;
+
+        // Sets a highlight color for the local player
+        public void SetLocalPlayer()
+        {
+            // add a visual background for the local player in the UI
+            image.color = new Color(1f, 1f, 1f, 0.1f);
+        }
+
+        // This value can change as clients leave and join
+        public void OnPlayerNumberChanged(byte newPlayerNumber)
+        {
+            playerNameText.text = string.Format("Player {0:00}", newPlayerNumber);
+        }
+
+        // Random color set by Player::OnStartServer
+        public void OnPlayerColorChanged(Color32 newPlayerColor)
+        {
+            playerNameText.color = newPlayerColor;
+        }
+
+        // This updates from Player::UpdateData via InvokeRepeating on server
+        public void OnPlayerDataChanged(ushort newPlayerData)
+        {
+            // Show the data in the UI
+            playerDataText.text = string.Format("Data: {0:000}", newPlayerData);
+        }
+    }
+}

Assets/Mirror/Examples/Basic/Scripts/PlayerUI.cs.meta

@@ -0,0 +1,18 @@
+fileFormatVersion: 2
+guid: 64acca8c87e5ceb44bcbd56ef21e2950
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
+AssetOrigin:
+  serializedVersion: 1
+  productId: 129321
+  packageName: Mirror
+  packageVersion: 96.0.1
+  assetPath: Assets/Mirror/Examples/Basic/Scripts/PlayerUI.cs
+  uploadId: 736421