charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 02:50:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Basic Example

Browse Source 
- Moved some code from PlayerUI to Player
- smaller data types
- organization
This commit is contained in:
MrGadget1024 2021-12-10 11:12:41 -05:00
parent abc521eebc
commit b11f8c5710
2 changed files with 47 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
Assets/Mirror/Examples/Basic/Scripts/Player.cs
View File

@ -6,16 +6,16 @@ namespace Mirror.Examples.Basic
public class Player : NetworkBehaviour
{
// Events that the PlayerUI will subscribe to
public event System.Action<int> OnPlayerNumberChanged;
public event System.Action<byte> OnPlayerNumberChanged;
public event System.Action<Color32> OnPlayerColorChanged;
public event System.Action<int> OnPlayerDataChanged;
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 playerUI;
GameObject playerUIObject;
#region SyncVars
@ -25,13 +25,7 @@ public class Player : NetworkBehaviour
/// This is appended to the player name text, e.g. "Player 01"
/// </summary>
[SyncVar(hook = nameof(PlayerNumberChanged))]
public int playerNumber = 0;
/// <summary>
/// This is updated by UpdateData which is called from OnStartServer via InvokeRepeating
/// </summary>
[SyncVar(hook = nameof(PlayerDataChanged))]
public int playerData = 0;
public byte playerNumber = 0;
/// <summary>
/// Random color for the playerData text, assigned in OnStartServer
@ -39,24 +33,30 @@ public class Player : NetworkBehaviour
[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(int _, int newPlayerNumber)
void PlayerNumberChanged(byte _, byte newPlayerNumber)
{
OnPlayerNumberChanged?.Invoke(newPlayerNumber);
}
// This is called by the hook of playerData SyncVar above
void PlayerDataChanged(int _, int newPlayerData)
{
OnPlayerDataChanged?.Invoke(newPlayerData);
}
// 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
@ -76,6 +76,9 @@ public override void OnStartServer()
// 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);
}
@ -85,7 +88,7 @@ public override void OnStartServer()
[ServerCallback]
internal static void ResetPlayerNumbers()
{
int playerNumber = 0;
byte playerNumber = 0;
foreach (Player player in playersList)
player.playerNumber = playerNumber++;
}
@ -94,7 +97,7 @@ internal static void ResetPlayerNumbers()
[ServerCallback]
void UpdateData()
{
playerData = Random.Range(100, 1000);
playerData = (ushort)Random.Range(100, 1000);
}
/// <summary>
@ -128,15 +131,22 @@ public override void OnStartLocalPlayer()
public override void OnStartClient()
{
// Instantiate the player UI as child of the Players Panel
playerUI = Instantiate(playerUIPrefab, CanvasUI.instance.playersPanel);
playerUIObject = Instantiate(playerUIPrefab, CanvasUI.instance.playersPanel);
PlayerUI playerUI = playerUIObject.GetComponent<PlayerUI>();
// Set this player object in PlayerUI to wire up event handlers
playerUI.GetComponent<PlayerUI>().SetPlayer(this, isLocalPlayer);
// wire up all events to handlers in PlayerUI
OnPlayerNumberChanged = playerUI.OnPlayerNumberChanged;
OnPlayerColorChanged = playerUI.OnPlayerColorChanged;
OnPlayerDataChanged = playerUI.OnPlayerDataChanged;
// Invoke all event handlers with the current data
OnPlayerNumberChanged?.Invoke(playerNumber);
OnPlayerColorChanged?.Invoke(playerColor);
OnPlayerDataChanged?.Invoke(playerData);
// Invoke all event handlers with the initial data from spawn payload
OnPlayerNumberChanged.Invoke(playerNumber);
OnPlayerColorChanged.Invoke(playerColor);
OnPlayerDataChanged.Invoke(playerData);
// Set isLocalPlayer for this Player in UI for background shading
if (isLocalPlayer)
playerUI.SetLocalPlayer();
}
/// <summary>
@ -145,8 +155,13 @@ public override void OnStartClient()
/// </summary>
public override void OnStopClient()
{
// disconnect event handlers
OnPlayerNumberChanged = null;
OnPlayerColorChanged = null;
OnPlayerDataChanged = null;
// Remove this player's UI object
Destroy(playerUI);
Destroy(playerUIObject);
// Disable the main panel for local player
if (isLocalPlayer)

28
Assets/Mirror/Examples/Basic/Scripts/PlayerUI.cs
View File

@ -12,49 +12,31 @@ public class PlayerUI : MonoBehaviour
public Text playerNameText;
public Text playerDataText;
Player player;
/// <summary>
/// Caches the controlling Player object, subscribes to its events
/// </summary>
/// <param name="player">Player object that controls this UI</param>
/// <param name="isLocalPlayer">true if the Player object is the Local Player</param>
public void SetPlayer(Player player, bool isLocalPlayer)
public void SetLocalPlayer()
{
// cache reference to the player that controls this UI object
this.player = player;
// subscribe to the events raised by SyncVar Hooks on the Player object
player.OnPlayerNumberChanged += OnPlayerNumberChanged;
player.OnPlayerColorChanged += OnPlayerColorChanged;
player.OnPlayerDataChanged += OnPlayerDataChanged;
// add a visual background for the local player in the UI
if (isLocalPlayer)
image.color = new Color(1f, 1f, 1f, 0.1f);
}
void OnDisable()
{
player.OnPlayerNumberChanged -= OnPlayerNumberChanged;
player.OnPlayerColorChanged -= OnPlayerColorChanged;
player.OnPlayerDataChanged -= OnPlayerDataChanged;
image.color = new Color(1f, 1f, 1f, 0.1f);
}
// This value can change as clients leave and join
void OnPlayerNumberChanged(int newPlayerNumber)
public void OnPlayerNumberChanged(byte newPlayerNumber)
{
playerNameText.text = string.Format("Player {0:00}", newPlayerNumber);
}
// Random color set by Player::OnStartServer
void OnPlayerColorChanged(Color32 newPlayerColor)
public void OnPlayerColorChanged(Color32 newPlayerColor)
{
playerNameText.color = newPlayerColor;
}
// This updates from Player::UpdateData via InvokeRepeating on server
void OnPlayerDataChanged(int newPlayerData)
public void OnPlayerDataChanged(ushort newPlayerData)
{
// Show the data in the UI
playerDataText.text = string.Format("Data: {0:000}", newPlayerData);