573 lines
22 KiB
C#
573 lines
22 KiB
C#
using FishNet.Connection;
|
|
using FishNet.Managing.Client;
|
|
using FishNet.Managing.Server;
|
|
using FishNet.Managing.Timing;
|
|
using FishNet.Managing.Transporting;
|
|
using UnityEngine;
|
|
using FishNet.Managing.Scened;
|
|
using FishNet.Authenticating;
|
|
using FishNet.Object;
|
|
using FishNet.Documenting;
|
|
using FishNet.Managing.Logging;
|
|
using System.Collections.Generic;
|
|
using System;
|
|
using FishNet.Managing.Observing;
|
|
using System.Linq;
|
|
using FishNet.Managing.Debugging;
|
|
using FishNet.Managing.Object;
|
|
using FishNet.Transporting;
|
|
using FishNet.Utility.Extension;
|
|
using FishNet.Managing.Statistic;
|
|
using FishNet.Utility.Performance;
|
|
using FishNet.Component.ColliderRollback;
|
|
using FishNet.Managing.Predicting;
|
|
using System.Runtime.CompilerServices;
|
|
#if UNITY_EDITOR
|
|
using FishNet.Editing.PrefabCollectionGenerator;
|
|
#endif
|
|
|
|
namespace FishNet.Managing
|
|
{
|
|
/// <summary>
|
|
/// Acts as a container for all things related to your networking session.
|
|
/// </summary>
|
|
[DefaultExecutionOrder(short.MinValue)]
|
|
[DisallowMultipleComponent]
|
|
[AddComponentMenu("FishNet/Manager/NetworkManager")]
|
|
public sealed partial class NetworkManager : MonoBehaviour
|
|
{
|
|
#region Types.
|
|
/// <summary>
|
|
/// Which socket to iterate data on first when as host.
|
|
/// </summary>
|
|
public enum HostIterationOrder
|
|
{
|
|
ServerFirst,
|
|
ClientFirst
|
|
}
|
|
/// <summary>
|
|
/// How to persist with multiple NetworkManagers.
|
|
/// </summary>
|
|
public enum PersistenceType
|
|
{
|
|
/// <summary>
|
|
/// Destroy any new NetworkManagers.
|
|
/// </summary>
|
|
DestroyNewest,
|
|
/// <summary>
|
|
/// Destroy previous NetworkManager when a new NetworkManager occurs.
|
|
/// </summary>
|
|
DestroyOldest,
|
|
/// <summary>
|
|
/// Allow multiple NetworkManagers, do not destroy any automatically.
|
|
/// </summary>
|
|
AllowMultiple
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Public.
|
|
/// <summary>
|
|
/// True if this instance of the NetworkManager is initialized.
|
|
/// </summary>
|
|
public bool Initialized { get; private set; }
|
|
/// <summary>
|
|
///
|
|
/// </summary>
|
|
private static List<NetworkManager> _instances = new List<NetworkManager>();
|
|
/// <summary>
|
|
/// Currently initialized NetworkManagers.
|
|
/// </summary>
|
|
public static IReadOnlyCollection<NetworkManager> Instances
|
|
{
|
|
get
|
|
{
|
|
/* Remove null instances of NetworkManager.
|
|
* This shouldn't happen because instances are removed
|
|
* OnDestroy but none the less something is causing
|
|
* it. */
|
|
for (int i = 0; i < _instances.Count; i++)
|
|
{
|
|
if (_instances[i] == null)
|
|
{
|
|
_instances.RemoveAt(i);
|
|
i--;
|
|
}
|
|
}
|
|
return _instances;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// True if server is active.
|
|
/// </summary>
|
|
public bool IsServer => ServerManager.Started;
|
|
/// <summary>
|
|
/// True if only the server is active.
|
|
/// </summary>
|
|
public bool IsServerOnly => (IsServer && !IsClient);
|
|
/// <summary>
|
|
/// True if the client is active and authenticated.
|
|
/// </summary>
|
|
public bool IsClient => (ClientManager.Started && ClientManager.Connection.Authenticated);
|
|
/// <summary>
|
|
/// True if only the client is active and authenticated.
|
|
/// </summary>
|
|
public bool IsClientOnly => (!IsServer && IsClient);
|
|
/// <summary>
|
|
/// True if client and server are active.
|
|
/// </summary>
|
|
public bool IsHost => (IsServer && IsClient);
|
|
/// <summary>
|
|
/// True if client nor server are active.
|
|
/// </summary>
|
|
public bool IsOffline => (!IsServer && !IsClient);
|
|
/// <summary>
|
|
/// PredictionManager for this NetworkManager.
|
|
/// </summary>
|
|
internal PredictionManager PredictionManager { get; private set; }
|
|
/// <summary>
|
|
/// ServerManager for this NetworkManager.
|
|
/// </summary>
|
|
public ServerManager ServerManager { get; private set; }
|
|
/// <summary>
|
|
/// ClientManager for this NetworkManager.
|
|
/// </summary>
|
|
public ClientManager ClientManager { get; private set; }
|
|
/// <summary>
|
|
/// TransportManager for this NetworkManager.
|
|
/// </summary>
|
|
public TransportManager TransportManager { get; private set; }
|
|
/// <summary>
|
|
/// TimeManager for this NetworkManager.
|
|
/// </summary>
|
|
public TimeManager TimeManager { get; private set; }
|
|
/// <summary>
|
|
/// SceneManager for this NetworkManager.
|
|
/// </summary>
|
|
public SceneManager SceneManager { get; private set; }
|
|
/// <summary>
|
|
/// ObserverManager for this NetworkManager.
|
|
/// </summary>
|
|
public ObserverManager ObserverManager { get; private set; }
|
|
/// <summary>
|
|
/// Authenticator for this NetworkManager. May be null if no Authenticator is used.
|
|
/// </summary>
|
|
[Obsolete("Use ServerManager.GetAuthenticator or ServerManager.SetAuthenticator instead.")] //Remove on 2023/06/01
|
|
public Authenticator Authenticator => ServerManager.Authenticator;
|
|
/// <summary>
|
|
/// DebugManager for this NetworkManager.
|
|
/// </summary>
|
|
public DebugManager DebugManager { get; private set; }
|
|
/// <summary>
|
|
/// StatisticsManager for this NetworkManager.
|
|
/// </summary>
|
|
public StatisticsManager StatisticsManager { get; private set; }
|
|
/// <summary>
|
|
/// An empty connection reference. Used when a connection cannot be found to prevent object creation.
|
|
/// </summary>
|
|
[APIExclude]
|
|
public static NetworkConnection EmptyConnection { get; private set; } = new NetworkConnection();
|
|
#endregion
|
|
|
|
#region Internal.
|
|
/// <summary>
|
|
/// Starting index for RpcLinks.
|
|
/// </summary>
|
|
internal static ushort StartingRpcLinkIndex;
|
|
#endregion
|
|
|
|
#region Serialized.
|
|
/// <summary>
|
|
/// True to refresh the DefaultPrefabObjects collection whenever the editor enters play mode. This is an attempt to alleviate the DefaultPrefabObjects scriptable object not refreshing when using multiple editor applications such as ParrelSync.
|
|
/// </summary>
|
|
[Tooltip("True to refresh the DefaultPrefabObjects collection whenever the editor enters play mode. This is an attempt to alleviate the DefaultPrefabObjects scriptable object not refreshing when using multiple editor applications such as ParrelSync.")]
|
|
[SerializeField]
|
|
private bool _refreshDefaultPrefabs = false;
|
|
/// <summary>
|
|
/// True to have your application run while in the background.
|
|
/// </summary>
|
|
[Tooltip("True to have your application run while in the background.")]
|
|
[SerializeField]
|
|
private bool _runInBackground = true;
|
|
/// <summary>
|
|
/// True to make this instance DontDestroyOnLoad. This is typical if you only want one NetworkManager.
|
|
/// </summary>
|
|
[Tooltip("True to make this instance DontDestroyOnLoad. This is typical if you only want one NetworkManager.")]
|
|
[SerializeField]
|
|
private bool _dontDestroyOnLoad = true;
|
|
/// <summary>
|
|
/// Object pool to use for this NetworkManager. Value may be null.
|
|
/// </summary>
|
|
[Tooltip("Object pool to use for this NetworkManager. Value may be null.")]
|
|
[SerializeField]
|
|
private ObjectPool _objectPool;
|
|
/// <summary>
|
|
/// How to persist when other NetworkManagers are introduced.
|
|
/// </summary>
|
|
[Tooltip("How to persist when other NetworkManagers are introduced.")]
|
|
[SerializeField]
|
|
private PersistenceType _persistence = PersistenceType.DestroyNewest;
|
|
#endregion
|
|
|
|
#region Private.
|
|
/// <summary>
|
|
/// True if this NetworkManager can persist after Awake checks.
|
|
/// </summary>
|
|
private bool _canPersist;
|
|
#endregion
|
|
|
|
#region Const.
|
|
/// <summary>
|
|
/// Maximum framerate allowed.
|
|
/// </summary>
|
|
internal const ushort MAXIMUM_FRAMERATE = 500;
|
|
#endregion
|
|
|
|
|
|
private void Awake()
|
|
{
|
|
InitializeLogging();
|
|
if (!ValidateSpawnablePrefabs(true))
|
|
return;
|
|
|
|
if (StartingRpcLinkIndex == 0)
|
|
StartingRpcLinkIndex = (ushort)(EnumFN.GetHighestValue<PacketId>() + 1);
|
|
|
|
bool isDefaultPrefabs = (SpawnablePrefabs != null && SpawnablePrefabs is DefaultPrefabObjects);
|
|
#if UNITY_EDITOR
|
|
/* If first instance then force
|
|
* default prefabs to repopulate.
|
|
* This is only done in editor because
|
|
* cloning tools sometimes don't synchronize
|
|
* scriptable object changes, which is what
|
|
* the default prefabs is. */
|
|
if (_refreshDefaultPrefabs && _instances.Count == 0 && isDefaultPrefabs)
|
|
{
|
|
Generator.IgnorePostProcess = true;
|
|
Debug.Log("DefaultPrefabCollection is being refreshed.");
|
|
Generator.GenerateFull();
|
|
Generator.IgnorePostProcess = false;
|
|
}
|
|
#endif
|
|
//If default prefabs then also make a new instance and sort them.
|
|
if (isDefaultPrefabs)
|
|
{
|
|
DefaultPrefabObjects originalDpo = (DefaultPrefabObjects)SpawnablePrefabs;
|
|
//If not editor then a new instance must be made and sorted.
|
|
DefaultPrefabObjects instancedDpo = ScriptableObject.CreateInstance<DefaultPrefabObjects>();
|
|
instancedDpo.AddObjects(originalDpo.Prefabs.ToList(), false);
|
|
instancedDpo.Sort();
|
|
SpawnablePrefabs = instancedDpo;
|
|
}
|
|
|
|
_canPersist = CanInitialize();
|
|
if (!_canPersist)
|
|
return;
|
|
|
|
if (TryGetComponent<NetworkObject>(out _))
|
|
LogError($"NetworkObject component found on the NetworkManager object {gameObject.name}. This is not allowed and will cause problems. Remove the NetworkObject component from this object.");
|
|
|
|
SpawnablePrefabs.InitializePrefabRange(0);
|
|
SpawnablePrefabs.SetCollectionId(0);
|
|
|
|
SetDontDestroyOnLoad();
|
|
SetRunInBackground();
|
|
DebugManager = GetOrCreateComponent<DebugManager>();
|
|
TransportManager = GetOrCreateComponent<TransportManager>();
|
|
|
|
ServerManager = GetOrCreateComponent<ServerManager>();
|
|
ClientManager = GetOrCreateComponent<ClientManager>();
|
|
TimeManager = GetOrCreateComponent<TimeManager>();
|
|
SceneManager = GetOrCreateComponent<SceneManager>();
|
|
ObserverManager = GetOrCreateComponent<ObserverManager>();
|
|
RollbackManager = GetOrCreateComponent<RollbackManager>();
|
|
PredictionManager = GetOrCreateComponent<PredictionManager>();
|
|
StatisticsManager = GetOrCreateComponent<StatisticsManager>();
|
|
if (_objectPool == null)
|
|
_objectPool = GetOrCreateComponent<DefaultObjectPool>();
|
|
|
|
InitializeComponents();
|
|
|
|
_instances.Add(this);
|
|
Initialized = true;
|
|
}
|
|
|
|
private void Start()
|
|
{
|
|
ServerManager.StartForHeadless();
|
|
}
|
|
|
|
private void OnDestroy()
|
|
{
|
|
_instances.Remove(this);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes components. To be called after all components are added.
|
|
/// </summary>
|
|
private void InitializeComponents()
|
|
{
|
|
TimeManager.InitializeOnce_Internal(this);
|
|
TimeManager.OnLateUpdate += TimeManager_OnLateUpdate;
|
|
SceneManager.InitializeOnce_Internal(this);
|
|
TransportManager.InitializeOnce_Internal(this);
|
|
ClientManager.InitializeOnce_Internal(this);
|
|
ServerManager.InitializeOnce_Internal(this);
|
|
ObserverManager.InitializeOnce_Internal(this);
|
|
RollbackManager.InitializeOnce_Internal(this);
|
|
PredictionManager.InitializeOnce_Internal(this);
|
|
StatisticsManager.InitializeOnce_Internal(this);
|
|
_objectPool.InitializeOnce(this);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Updates the frame rate based on server and client status.
|
|
/// </summary>
|
|
internal void UpdateFramerate()
|
|
{
|
|
bool clientStarted = ClientManager.Started;
|
|
bool serverStarted = ServerManager.Started;
|
|
|
|
int frameRate = 0;
|
|
//If both client and server are started then use whichever framerate is higher.
|
|
if (clientStarted && serverStarted)
|
|
frameRate = Math.Max(ServerManager.FrameRate, ClientManager.FrameRate);
|
|
else if (clientStarted)
|
|
frameRate = ClientManager.FrameRate;
|
|
else if (serverStarted)
|
|
frameRate = ServerManager.FrameRate;
|
|
|
|
/* Make sure framerate isn't set to max on server.
|
|
* If it is then default to tick rate. If framerate is
|
|
* less than tickrate then also set to tickrate. */
|
|
#if UNITY_SERVER
|
|
ushort minimumServerFramerate = (ushort)(TimeManager.TickRate + 1);
|
|
if (frameRate == MAXIMUM_FRAMERATE)
|
|
frameRate = minimumServerFramerate;
|
|
else if (frameRate < TimeManager.TickRate)
|
|
frameRate = minimumServerFramerate;
|
|
#endif
|
|
//If there is a framerate to set.
|
|
if (frameRate > 0)
|
|
Application.targetFrameRate = frameRate;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Called when MonoBehaviours call LateUpdate.
|
|
/// </summary>
|
|
private void TimeManager_OnLateUpdate()
|
|
{
|
|
/* Some reason runinbackground becomes unset
|
|
* or the setting goes ignored some times when it's set
|
|
* in awake. Rather than try to fix or care why Unity
|
|
* does this just set it in LateUpdate(or Update). */
|
|
SetRunInBackground();
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// Returns if this NetworkManager can initialize.
|
|
/// </summary>
|
|
/// <returns></returns>
|
|
private bool CanInitialize()
|
|
{
|
|
/* If allow multiple then any number of
|
|
* NetworkManagers are allowed. Don't
|
|
* automatically destroy any. */
|
|
if (_persistence == PersistenceType.AllowMultiple)
|
|
return true;
|
|
|
|
List<NetworkManager> instances = Instances.ToList();
|
|
//This is the first instance, it may initialize.
|
|
if (instances.Count == 0)
|
|
return true;
|
|
|
|
//First instance of NM.
|
|
NetworkManager firstInstance = instances[0];
|
|
|
|
//If to destroy the newest.
|
|
if (_persistence == PersistenceType.DestroyNewest)
|
|
{
|
|
Log($"NetworkManager on object {gameObject.name} is being destroyed due to persistence type {_persistence}. A NetworkManager instance already exist on {firstInstance.name}.");
|
|
Destroy(gameObject);
|
|
//This one is being destroyed because its the newest.
|
|
return false;
|
|
}
|
|
//If to destroy the oldest.
|
|
else if (_persistence == PersistenceType.DestroyOldest)
|
|
{
|
|
Log($"NetworkManager on object {firstInstance.name} is being destroyed due to persistence type {_persistence}. A NetworkManager instance has been created on {gameObject.name}.");
|
|
Destroy(firstInstance.gameObject);
|
|
//This being the new one will persist, allow initialization.
|
|
return true;
|
|
}
|
|
//Unhandled.
|
|
else
|
|
{
|
|
Log($"Persistance type of {_persistence} is unhandled on {gameObject.name}. Initialization will not proceed.");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Validates SpawnablePrefabs field and returns if validated successfully.
|
|
/// </summary>
|
|
/// <returns></returns>
|
|
private bool ValidateSpawnablePrefabs(bool print)
|
|
{
|
|
//If null and object is in a scene.
|
|
if (SpawnablePrefabs == null && !string.IsNullOrEmpty(gameObject.scene.name))
|
|
{
|
|
//Always throw an error as this would cause failure.
|
|
if (print)
|
|
Debug.LogError($"SpawnablePrefabs is null on {gameObject.name}. Select the NetworkManager in scene {gameObject.scene.name} and choose a prefabs file. Choosing DefaultPrefabObjects will automatically populate prefabs for you.");
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sets DontDestroyOnLoad if configured to.
|
|
/// </summary>
|
|
private void SetDontDestroyOnLoad()
|
|
{
|
|
if (_dontDestroyOnLoad)
|
|
DontDestroyOnLoad(this);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sets Application.runInBackground to runInBackground.
|
|
/// </summary>
|
|
private void SetRunInBackground()
|
|
{
|
|
Application.runInBackground = _runInBackground;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a component, creating and adding it if it does not exist.
|
|
/// </summary>
|
|
/// <param name="presetValue">Value which may already be set. When not null this is returned instead.</param>
|
|
private T GetOrCreateComponent<T>(T presetValue = null) where T : UnityEngine.Component
|
|
{
|
|
//If already set then return set value.
|
|
if (presetValue != null)
|
|
return presetValue;
|
|
|
|
if (gameObject.TryGetComponent<T>(out T result))
|
|
return result;
|
|
else
|
|
return gameObject.AddComponent<T>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Clears a client collection after disposing of the NetworkConnections.
|
|
/// </summary>
|
|
/// <param name="clients"></param>
|
|
internal void ClearClientsCollection(Dictionary<int, NetworkConnection> clients)
|
|
{
|
|
foreach (NetworkConnection conn in clients.Values)
|
|
conn.Dispose();
|
|
|
|
clients.Clear();
|
|
}
|
|
|
|
#region Object pool.
|
|
/// <summary>
|
|
/// Returns an instantiated copy of prefab.
|
|
/// </summary>
|
|
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
|
public NetworkObject GetPooledInstantiated(NetworkObject prefab, bool asServer)
|
|
{
|
|
return GetPooledInstantiated(prefab, 0, asServer);
|
|
}
|
|
/// <summary>
|
|
/// Returns an instantiated copy of prefab.
|
|
/// </summary>
|
|
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
|
public NetworkObject GetPooledInstantiated(NetworkObject prefab, ushort collectionId, bool asServer)
|
|
{
|
|
return GetPooledInstantiated(prefab.PrefabId, collectionId, asServer);
|
|
}
|
|
/// <summary>
|
|
/// Returns an instantiated copy of prefab.
|
|
/// </summary>
|
|
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
|
public NetworkObject GetPooledInstantiated(GameObject prefab, bool asServer)
|
|
{
|
|
return GetPooledInstantiated(prefab, 0, asServer);
|
|
}
|
|
/// <summary>
|
|
/// Returns an instantiated copy of prefab.
|
|
/// </summary>
|
|
public NetworkObject GetPooledInstantiated(GameObject prefab, ushort collectionId, bool asServer)
|
|
{
|
|
NetworkObject nob;
|
|
if (!prefab.TryGetComponent<NetworkObject>(out nob))
|
|
{
|
|
LogError($"NetworkObject was not found on {prefab}. An instantiated NetworkObject cannot be returned.");
|
|
return null;
|
|
}
|
|
else
|
|
{
|
|
return GetPooledInstantiated(nob.PrefabId, collectionId, asServer);
|
|
}
|
|
}
|
|
/// <summary>
|
|
/// Returns an instantiated object that has prefabId.
|
|
/// </summary>
|
|
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
|
public NetworkObject GetPooledInstantiated(int prefabId, bool asServer)
|
|
{
|
|
return GetPooledInstantiated(prefabId, 0, asServer);
|
|
}
|
|
/// <summary>
|
|
/// Returns an instantiated object that has prefabId.
|
|
/// </summary>
|
|
public NetworkObject GetPooledInstantiated(int prefabId, ushort collectionId, bool asServer)
|
|
{
|
|
return _objectPool.RetrieveObject(prefabId, collectionId, asServer);
|
|
}
|
|
/// <summary>
|
|
/// Stores an instantiated object.
|
|
/// </summary>
|
|
/// <param name="instantiated">Object which was instantiated.</param>
|
|
/// <param name="prefabId"></param>
|
|
/// <param name="asServer">True to store for the server.</param>
|
|
[Obsolete("Use StorePooledInstantiated(NetworkObject, bool)")] //Remove on 2023/06/01.
|
|
public void StorePooledInstantiated(NetworkObject instantiated, int prefabId, bool asServer)
|
|
{
|
|
StorePooledInstantiated(instantiated, asServer);
|
|
}
|
|
/// <summary>
|
|
/// Stores an instantied object.
|
|
/// </summary>
|
|
/// <param name="instantiated">Object which was instantiated.</param>
|
|
/// <param name="asServer">True to store for the server.</param>
|
|
public void StorePooledInstantiated(NetworkObject instantiated, bool asServer)
|
|
{
|
|
_objectPool.StoreObject(instantiated, asServer);
|
|
}
|
|
#endregion
|
|
|
|
#region Editor.
|
|
#if UNITY_EDITOR
|
|
private void OnValidate()
|
|
{
|
|
if (SpawnablePrefabs == null)
|
|
Reset();
|
|
}
|
|
private void Reset()
|
|
{
|
|
ValidateSpawnablePrefabs(true);
|
|
}
|
|
|
|
#endif
|
|
|
|
#endregion
|
|
|
|
}
|
|
|
|
|
|
} |