fishnet installed
This commit is contained in:
@ -0,0 +1,87 @@
|
||||
using FishNet.Managing.Logging;
|
||||
using FishNet.Managing.Object;
|
||||
using FishNet.Managing.Utility;
|
||||
using FishNet.Object;
|
||||
using FishNet.Object.Helping;
|
||||
using FishNet.Serializing;
|
||||
using FishNet.Transporting;
|
||||
using FishNet.Utility.Extension;
|
||||
using System.Collections.Generic;
|
||||
using System.Runtime.CompilerServices;
|
||||
using UnityEngine;
|
||||
|
||||
namespace FishNet.Managing.Client
|
||||
{
|
||||
/// <summary>
|
||||
/// Handles objects and information about objects for the local client. See ManagedObjects for inherited options.
|
||||
/// </summary>
|
||||
public partial class ClientObjects : ManagedObjects
|
||||
{
|
||||
|
||||
#region Private.
|
||||
/// <summary>
|
||||
/// RPCLinks of currently spawned objects.
|
||||
/// </summary>
|
||||
private Dictionary<ushort, RpcLink> _rpcLinks = new Dictionary<ushort, RpcLink>();
|
||||
#endregion
|
||||
|
||||
/// <summary>
|
||||
/// Parses a received RPCLink.
|
||||
/// </summary>
|
||||
/// <param name="reader"></param>
|
||||
/// <param name="index"></param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
internal void ParseRpcLink(PooledReader reader, ushort index, Channel channel)
|
||||
{
|
||||
int dataLength = Packets.GetPacketLength(ushort.MaxValue, reader, channel);
|
||||
|
||||
//Link index isn't stored.
|
||||
if (!_rpcLinks.TryGetValueIL2CPP(index, out RpcLink link))
|
||||
{
|
||||
SkipDataLength(index, reader, dataLength);
|
||||
return;
|
||||
}
|
||||
else
|
||||
//Found NetworkObject for link.
|
||||
if (Spawned.TryGetValueIL2CPP(link.ObjectId, out NetworkObject nob))
|
||||
{
|
||||
NetworkBehaviour nb = nob.NetworkBehaviours[link.ComponentIndex];
|
||||
if (link.RpcType == RpcType.Target)
|
||||
nb.OnTargetRpc(link.RpcHash, reader, channel);
|
||||
else if (link.RpcType == RpcType.Observers)
|
||||
nb.OnObserversRpc(link.RpcHash, reader, channel);
|
||||
else if (link.RpcType == RpcType.Reconcile)
|
||||
nb.OnReconcileRpc(link.RpcHash, reader, channel);
|
||||
}
|
||||
//Could not find NetworkObject.
|
||||
else
|
||||
{
|
||||
SkipDataLength(index, reader, dataLength, link.ObjectId);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets link to rpcLinks key linkIndex.
|
||||
/// </summary>
|
||||
/// <param name="linkIndex"></param>
|
||||
/// <param name="link"></param>
|
||||
internal void SetRpcLink(ushort linkIndex, RpcLink link)
|
||||
{
|
||||
_rpcLinks[linkIndex] = link;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Removes link index keys from rpcLinks.
|
||||
/// </summary>
|
||||
internal void RemoveLinkIndexes(List<ushort> values)
|
||||
{
|
||||
if (values == null)
|
||||
return;
|
||||
|
||||
for (int i = 0; i < values.Count; i++)
|
||||
_rpcLinks.Remove(values[i]);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 2a20cc3f399aa614c931c9b45205937b
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
688
Assets/FishNet/Runtime/Managing/Client/Object/ClientObjects.cs
Normal file
688
Assets/FishNet/Runtime/Managing/Client/Object/ClientObjects.cs
Normal file
@ -0,0 +1,688 @@
|
||||
using FishNet.Connection;
|
||||
using FishNet.Documenting;
|
||||
using FishNet.Managing.Logging;
|
||||
using FishNet.Managing.Object;
|
||||
using FishNet.Managing.Server;
|
||||
using FishNet.Managing.Utility;
|
||||
using FishNet.Object;
|
||||
using FishNet.Object.Helping;
|
||||
using FishNet.Serializing;
|
||||
using FishNet.Transporting;
|
||||
using FishNet.Utility.Extension;
|
||||
using FishNet.Utility.Performance;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Runtime.CompilerServices;
|
||||
using UnityEngine;
|
||||
using UnityEngine.SceneManagement;
|
||||
|
||||
namespace FishNet.Managing.Client
|
||||
{
|
||||
/// <summary>
|
||||
/// Handles objects and information about objects for the local client. See ManagedObjects for inherited options.
|
||||
/// </summary>
|
||||
public partial class ClientObjects : ManagedObjects
|
||||
{
|
||||
#region Private.
|
||||
/// <summary>
|
||||
/// NetworkObjects which are cached to be spawned or despawned.
|
||||
/// </summary>
|
||||
private ClientObjectCache _objectCache;
|
||||
#endregion
|
||||
|
||||
internal ClientObjects(NetworkManager networkManager)
|
||||
{
|
||||
base.Initialize(networkManager);
|
||||
_objectCache = new ClientObjectCache(this, networkManager);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Called when a connection state changes for the local server.
|
||||
/// </summary>
|
||||
internal void OnServerConnectionState(ServerConnectionStateArgs args)
|
||||
{
|
||||
//Nothing needs to be done if started.
|
||||
if (args.ConnectionState == LocalConnectionState.Started)
|
||||
return;
|
||||
|
||||
/* If not started and client is active then deinitialize
|
||||
* client objects first. This will let the deinit calls
|
||||
* perform before the server destroys them. Ideally this
|
||||
* would be done when the user shows intent to shutdown
|
||||
* the server, but realistically planning for server socket
|
||||
* drops is a much more universal solution.
|
||||
*
|
||||
* Calling StopConnection on the client will set it's local state
|
||||
* to Stopping which will result in a deinit. */
|
||||
if (NetworkManager.IsClient)
|
||||
base.NetworkManager.ClientManager.StopConnection();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Called when the connection state changes for the local client.
|
||||
/// </summary>
|
||||
/// <param name="args"></param>
|
||||
internal void OnClientConnectionState(ClientConnectionStateArgs args)
|
||||
{
|
||||
/* If new state is not started then reset
|
||||
* environment. */
|
||||
if (args.ConnectionState != LocalConnectionState.Started)
|
||||
{
|
||||
_objectCache.Reset();
|
||||
|
||||
//If not server then deinitialize normally.
|
||||
if (!base.NetworkManager.IsServer)
|
||||
{
|
||||
base.DespawnWithoutSynchronization(false);
|
||||
}
|
||||
//Otherwise invoke stop callbacks only for client side.
|
||||
else
|
||||
{
|
||||
foreach (NetworkObject n in Spawned.Values)
|
||||
n.InvokeStopCallbacks(false);
|
||||
}
|
||||
/* Clear spawned and scene objects as they will be rebuilt.
|
||||
* Spawned would have already be cleared if DespawnSpawned
|
||||
* was called but it won't hurt anything clearing an empty collection. */
|
||||
base.Spawned.Clear();
|
||||
base.SceneObjects.Clear();
|
||||
base.LocalClientSpawned.Clear();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Called when a scene is loaded.
|
||||
/// </summary>
|
||||
/// <param name="s"></param>
|
||||
/// <param name="arg1"></param>
|
||||
[APIExclude]
|
||||
protected internal override void SceneManager_sceneLoaded(Scene s, LoadSceneMode arg1)
|
||||
{
|
||||
base.SceneManager_sceneLoaded(s, arg1);
|
||||
|
||||
if (!base.NetworkManager.IsClient)
|
||||
return;
|
||||
/* When a scene first loads for a client it should disable
|
||||
* all network objects in that scene. The server will send
|
||||
* spawn messages once it's aware client has loaded the scene. */
|
||||
RegisterAndDespawnSceneObjects(s);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Sends a predicted spawn to the server.
|
||||
/// </summary>
|
||||
internal void PredictedSpawn(NetworkObject networkObject, NetworkConnection ownerConnection)
|
||||
{
|
||||
//No more Ids to use.
|
||||
Queue<int> predictedObjectIds = NetworkManager.ClientManager.Connection.PredictedObjectIds;
|
||||
if (predictedObjectIds.Count == 0)
|
||||
{
|
||||
NetworkManager.LogError($"Predicted spawn for object {networkObject.name} failed because no more predicted ObjectIds remain. This usually occurs when the client is spawning excessively before the server can respond. Increasing ReservedObjectIds within the ServerManager component or reducing spawn rate could prevent this problem.");
|
||||
return;
|
||||
}
|
||||
|
||||
networkObject.PreinitializePredictedObject_Client(base.NetworkManager, predictedObjectIds.Dequeue(), ownerConnection, base.NetworkManager.ClientManager.Connection);
|
||||
NetworkManager.ClientManager.Objects.AddToSpawned(networkObject, false);
|
||||
networkObject.Initialize(false, true);
|
||||
|
||||
PooledWriter writer = WriterPool.GetWriter();
|
||||
WriteSpawn(networkObject, writer);
|
||||
base.NetworkManager.TransportManager.SendToServer((byte)Channel.Reliable, writer.GetArraySegment());
|
||||
writer.Dispose();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Writes a predicted spawn.
|
||||
/// </summary>
|
||||
/// <param name="nob"></param>
|
||||
public void WriteSpawn(NetworkObject nob, Writer writer)
|
||||
{
|
||||
PooledWriter headerWriter = WriterPool.GetWriter();
|
||||
headerWriter.WritePacketId(PacketId.ObjectSpawn);
|
||||
headerWriter.WriteNetworkObjectForSpawn(nob);
|
||||
headerWriter.WriteNetworkConnection(nob.Owner);
|
||||
|
||||
bool sceneObject = nob.IsSceneObject;
|
||||
//Write type of spawn.
|
||||
SpawnType st = SpawnType.Unset;
|
||||
if (sceneObject)
|
||||
st |= SpawnType.Scene;
|
||||
else
|
||||
st |= (nob.IsGlobal) ? SpawnType.InstantiatedGlobal : SpawnType.Instantiated;
|
||||
headerWriter.WriteByte((byte)st);
|
||||
|
||||
//ComponentIndex for the nob. 0 is root but more appropriately there's a IsNested boolean as shown above.
|
||||
headerWriter.WriteByte(nob.ComponentIndex);
|
||||
//Properties on the transform which diff from serialized value.
|
||||
base.WriteChangedTransformProperties(nob, sceneObject, false, headerWriter);
|
||||
/* Writing a scene object. */
|
||||
if (sceneObject)
|
||||
{
|
||||
headerWriter.WriteUInt64(nob.SceneId, AutoPackType.Unpacked);
|
||||
}
|
||||
/* Writing a spawned object. */
|
||||
else
|
||||
{
|
||||
//Nested predicted spawning will be added later.
|
||||
headerWriter.WriteByte((byte)SpawnParentType.Unset);
|
||||
headerWriter.WriteNetworkObjectId(nob.PrefabId);
|
||||
}
|
||||
|
||||
writer.WriteBytes(headerWriter.GetBuffer(), 0, headerWriter.Length);
|
||||
|
||||
//If allowed to write synctypes.
|
||||
if (nob.AllowPredictedSyncTypes)
|
||||
{
|
||||
PooledWriter tempWriter = WriterPool.GetWriter();
|
||||
WriteSyncTypes(writer, tempWriter, SyncTypeWriteType.All);
|
||||
void WriteSyncTypes(Writer finalWriter, PooledWriter tWriter, SyncTypeWriteType writeType)
|
||||
{
|
||||
tWriter.Reset();
|
||||
foreach (NetworkBehaviour nb in nob.NetworkBehaviours)
|
||||
nb.WriteSyncTypesForSpawn(tWriter, writeType);
|
||||
finalWriter.WriteBytesAndSize(tWriter.GetBuffer(), 0, tWriter.Length);
|
||||
}
|
||||
tempWriter.Dispose();
|
||||
}
|
||||
|
||||
//Dispose of writers created in this method.
|
||||
headerWriter.Dispose();
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Sends a predicted despawn to the server.
|
||||
/// </summary>
|
||||
internal void PredictedDespawn(NetworkObject networkObject)
|
||||
{
|
||||
PooledWriter writer = WriterPool.GetWriter();
|
||||
WriteDepawn(networkObject, writer);
|
||||
base.NetworkManager.TransportManager.SendToServer((byte)Channel.Reliable, writer.GetArraySegment());
|
||||
writer.Dispose();
|
||||
|
||||
//Deinitialize after writing despawn so all the right data is sent.
|
||||
networkObject.DeinitializePredictedObject_Client();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Writes a predicted despawn.
|
||||
/// </summary>
|
||||
public void WriteDepawn(NetworkObject nob, Writer writer)
|
||||
{
|
||||
writer.WritePacketId(PacketId.ObjectDespawn);
|
||||
writer.WriteNetworkObject(nob);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Registers NetworkObjects in all scenes and despawns them.
|
||||
/// </summary>
|
||||
internal void RegisterAndDespawnSceneObjects()
|
||||
{
|
||||
for (int i = 0; i < SceneManager.sceneCount; i++)
|
||||
RegisterAndDespawnSceneObjects(SceneManager.GetSceneAt(i));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds NetworkObjects within s to SceneObjects, and despawns them.
|
||||
/// </summary>
|
||||
/// <param name="s"></param>
|
||||
private void RegisterAndDespawnSceneObjects(Scene s)
|
||||
{
|
||||
ListCache<NetworkObject> nobs;
|
||||
SceneFN.GetSceneNetworkObjects(s, false, out nobs);
|
||||
|
||||
for (int i = 0; i < nobs.Written; i++)
|
||||
{
|
||||
NetworkObject nob = nobs.Collection[i];
|
||||
if (!nob.IsSceneObject)
|
||||
continue;
|
||||
|
||||
base.UpdateNetworkBehavioursForSceneObject(nob, false);
|
||||
if (nob.IsNetworked && nob.IsNetworked)
|
||||
{
|
||||
base.AddToSceneObjects(nob);
|
||||
//Only run if not also server, as this already ran on server.
|
||||
if (!base.NetworkManager.IsServer)
|
||||
nob.gameObject.SetActive(false);
|
||||
}
|
||||
}
|
||||
|
||||
ListCaches.StoreCache(nobs);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Called when a NetworkObject runs Deactivate.
|
||||
/// </summary>
|
||||
/// <param name="nob"></param>
|
||||
internal override void NetworkObjectUnexpectedlyDestroyed(NetworkObject nob, bool asServer)
|
||||
{
|
||||
nob.RemoveClientRpcLinkIndexes();
|
||||
base.NetworkObjectUnexpectedlyDestroyed(nob, asServer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Parses an OwnershipChange packet.
|
||||
/// </summary>
|
||||
/// <param name="reader"></param>
|
||||
internal void ParseOwnershipChange(PooledReader reader)
|
||||
{
|
||||
NetworkObject nob = reader.ReadNetworkObject();
|
||||
NetworkConnection newOwner = reader.ReadNetworkConnection();
|
||||
if (nob != null)
|
||||
nob.GiveOwnership(newOwner, false);
|
||||
else
|
||||
NetworkManager.LogWarning($"NetworkBehaviour could not be found when trying to parse OwnershipChange packet.");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Parses a received syncVar.
|
||||
/// </summary>
|
||||
/// <param name="reader"></param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
internal void ParseSyncType(PooledReader reader, bool isSyncObject, Channel channel)
|
||||
{
|
||||
//cleanup this is unique to synctypes where length comes first.
|
||||
//this will change once I tidy up synctypes.
|
||||
ushort packetId = (isSyncObject) ? (ushort)PacketId.SyncObject : (ushort)PacketId.SyncVar;
|
||||
NetworkBehaviour nb = reader.ReadNetworkBehaviour();
|
||||
int dataLength = Packets.GetPacketLength(packetId, reader, channel);
|
||||
|
||||
if (nb != null)
|
||||
{
|
||||
/* Length of data to be read for syncvars.
|
||||
* This is important because syncvars are never
|
||||
* a set length and data must be read through completion.
|
||||
* The only way to know where completion of syncvar is, versus
|
||||
* when another packet starts is by including the length. */
|
||||
if (dataLength > 0)
|
||||
nb.OnSyncType(reader, dataLength, isSyncObject);
|
||||
}
|
||||
else
|
||||
{
|
||||
SkipDataLength(packetId, reader, dataLength);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Parses a
|
||||
/// </summary>
|
||||
/// <param name="reader"></param>
|
||||
internal void ParsePredictedSpawnResult(Reader reader)
|
||||
{
|
||||
int usedObjectId = reader.ReadNetworkObjectId();
|
||||
bool success = reader.ReadBoolean();
|
||||
if (success)
|
||||
{
|
||||
int nextObjectId = reader.ReadNetworkObjectId();
|
||||
if (nextObjectId != NetworkObject.UNSET_OBJECTID_VALUE)
|
||||
NetworkManager.ClientManager.Connection.PredictedObjectIds.Enqueue(nextObjectId);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Parses a ReconcileRpc.
|
||||
/// </summary>
|
||||
/// <param name="reader"></param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
internal void ParseReconcileRpc(PooledReader reader, Channel channel)
|
||||
{
|
||||
NetworkBehaviour nb = reader.ReadNetworkBehaviour();
|
||||
int dataLength = Packets.GetPacketLength((ushort)PacketId.Reconcile, reader, channel);
|
||||
|
||||
if (nb != null)
|
||||
nb.OnReconcileRpc(null, reader, channel);
|
||||
else
|
||||
SkipDataLength((ushort)PacketId.ObserversRpc, reader, dataLength);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Parses an ObserversRpc.
|
||||
/// </summary>
|
||||
/// <param name="reader"></param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
internal void ParseObserversRpc(PooledReader reader, Channel channel)
|
||||
{
|
||||
NetworkBehaviour nb = reader.ReadNetworkBehaviour();
|
||||
int dataLength = Packets.GetPacketLength((ushort)PacketId.ObserversRpc, reader, channel);
|
||||
|
||||
if (nb != null)
|
||||
nb.OnObserversRpc(null, reader, channel);
|
||||
else
|
||||
SkipDataLength((ushort)PacketId.ObserversRpc, reader, dataLength);
|
||||
}
|
||||
/// <summary>
|
||||
/// Parses a TargetRpc.
|
||||
/// </summary>
|
||||
/// <param name="reader"></param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
internal void ParseTargetRpc(PooledReader reader, Channel channel)
|
||||
{
|
||||
NetworkBehaviour nb = reader.ReadNetworkBehaviour();
|
||||
int dataLength = Packets.GetPacketLength((ushort)PacketId.TargetRpc, reader, channel);
|
||||
|
||||
if (nb != null)
|
||||
nb.OnTargetRpc(null, reader, channel);
|
||||
else
|
||||
SkipDataLength((ushort)PacketId.TargetRpc, reader, dataLength);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Caches a received spawn to be processed after all spawns and despawns are received for the tick.
|
||||
/// </summary>
|
||||
/// <param name="reader"></param>
|
||||
internal void CacheSpawn(PooledReader reader)
|
||||
{
|
||||
sbyte initializeOrder;
|
||||
ushort collectionId;
|
||||
int objectId = reader.ReadNetworkObjectForSpawn(out initializeOrder, out collectionId, out _);
|
||||
int ownerId = reader.ReadNetworkConnectionId();
|
||||
SpawnType st = (SpawnType)reader.ReadByte();
|
||||
byte componentIndex = reader.ReadByte();
|
||||
|
||||
//Read transform values which differ from serialized values.
|
||||
Vector3? localPosition;
|
||||
Quaternion? localRotation;
|
||||
Vector3? localScale;
|
||||
base.ReadTransformProperties(reader, out localPosition, out localRotation, out localScale);
|
||||
|
||||
bool nested = SpawnTypeEnum.Contains(st, SpawnType.Nested);
|
||||
int rootObjectId = (nested) ? reader.ReadNetworkObjectId() : 0;
|
||||
bool sceneObject = SpawnTypeEnum.Contains(st, SpawnType.Scene);
|
||||
|
||||
int? parentObjectId = null;
|
||||
byte? parentComponentIndex = null;
|
||||
int? prefabId = null;
|
||||
ulong sceneId = 0;
|
||||
|
||||
if (sceneObject)
|
||||
ReadSceneObject(reader, out sceneId);
|
||||
else
|
||||
ReadSpawnedObject(reader, out parentObjectId, out parentComponentIndex, out prefabId);
|
||||
|
||||
ArraySegment<byte> rpcLinks = reader.ReadArraySegmentAndSize();
|
||||
ArraySegment<byte> syncValues = reader.ReadArraySegmentAndSize();
|
||||
|
||||
/* If the objectId can be found as already spawned then check if it's predicted.
|
||||
* Should the spawn be predicted then no need to continue. Later on however
|
||||
* we may want to apply synctypes.
|
||||
*
|
||||
* Only check if not server, since if server the client doesnt need
|
||||
* to predicted spawn. */
|
||||
if (!base.NetworkManager.IsServerOnly && base.Spawned.TryGetValue(objectId, out NetworkObject nob))
|
||||
{
|
||||
//If not predicted the nob should not be in spawned.
|
||||
if (!nob.PredictedSpawner.IsValid)
|
||||
{
|
||||
NetworkManager.LogError($"Received a spawn objectId of {objectId} which was already found in spawned, and was not predicted.");
|
||||
}
|
||||
//Everything is proper, apply RPC links.
|
||||
else
|
||||
{
|
||||
PooledReader linkReader = ReaderPool.GetReader(rpcLinks, NetworkManager);
|
||||
ApplyRpcLinks(nob, linkReader);
|
||||
linkReader.Dispose();
|
||||
}
|
||||
//No further initialization needed when predicting.
|
||||
return;
|
||||
}
|
||||
|
||||
_objectCache.AddSpawn(base.NetworkManager, collectionId, objectId, initializeOrder, ownerId, st, componentIndex, rootObjectId, parentObjectId, parentComponentIndex, prefabId, localPosition, localRotation, localScale, sceneId, rpcLinks, syncValues);
|
||||
}
|
||||
/// <summary>
|
||||
/// Caches a received despawn to be processed after all spawns and despawns are received for the tick.
|
||||
/// </summary>
|
||||
/// <param name="reader"></param>
|
||||
internal void CacheDespawn(PooledReader reader)
|
||||
{
|
||||
DespawnType despawnType;
|
||||
int objectId = reader.ReadNetworkObjectForDepawn(out despawnType);
|
||||
_objectCache.AddDespawn(objectId, despawnType);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Iterates object cache which contains spawn and despawn messages.
|
||||
/// Parses the packets within the cache and ensures objects are spawned and despawned before their sync values are applied.
|
||||
/// This ensures there is no chance a sync value is referencing a spawned object which does not exist yet due to it normally being spawned later in the cache.
|
||||
/// </summary>
|
||||
internal void IterateObjectCache()
|
||||
{
|
||||
_objectCache.Iterate();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a nested NetworkObject within it's root.
|
||||
/// </summary>
|
||||
/// <param name="cnob"></param>
|
||||
/// <returns></returns>
|
||||
internal NetworkObject GetNestedNetworkObject(CachedNetworkObject cnob)
|
||||
{
|
||||
NetworkObject rootNob;
|
||||
int rootObjectId = cnob.RootObjectId;
|
||||
byte componentIndex = cnob.ComponentIndex;
|
||||
|
||||
/* Spawns are processed after all spawns come in,
|
||||
* this ensures no reference race conditions. Turns out because of this
|
||||
* the parentNob may be in cache and not actually spawned, if it was spawned the same packet
|
||||
* as this one. So when not found in the spawned collection try to
|
||||
* find it in Spawning before throwing. */
|
||||
rootNob = _objectCache.GetSpawnedObject(rootObjectId);
|
||||
//If still null, that's not good.
|
||||
if (rootNob == null)
|
||||
{
|
||||
NetworkManager.LogError($"Nested spawned object with componentIndex of {componentIndex} and a parentId of {rootObjectId} could not be spawned because parent was not found.");
|
||||
return null;
|
||||
}
|
||||
|
||||
NetworkObject nob = null;
|
||||
List<NetworkObject> childNobs = rootNob.ChildNetworkObjects;
|
||||
//Find nob with component index.
|
||||
for (int i = 0; i < childNobs.Count; i++)
|
||||
{
|
||||
if (childNobs[i].ComponentIndex == componentIndex)
|
||||
{
|
||||
nob = childNobs[i];
|
||||
break;
|
||||
}
|
||||
}
|
||||
//If child nob was not found.
|
||||
if (nob == null)
|
||||
{
|
||||
NetworkManager.LogError($"Nested spawned object with componentIndex of {componentIndex} could not be found as a child NetworkObject of {rootNob.name}.");
|
||||
return null;
|
||||
}
|
||||
|
||||
return nob;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Applies RPCLinks to a NetworkObject.
|
||||
/// </summary>
|
||||
internal void ApplyRpcLinks(NetworkObject nob, Reader reader)
|
||||
{
|
||||
List<ushort> rpcLinkIndexes = new List<ushort>();
|
||||
//Apply rpcLinks.
|
||||
foreach (NetworkBehaviour nb in nob.NetworkBehaviours)
|
||||
{
|
||||
int length = reader.ReadInt32();
|
||||
|
||||
int readerStart = reader.Position;
|
||||
while (reader.Position - readerStart < length)
|
||||
{
|
||||
//Index of RpcLink.
|
||||
ushort linkIndex = reader.ReadUInt16();
|
||||
RpcLink link = new RpcLink(nob.ObjectId, nb.ComponentIndex,
|
||||
//RpcHash.
|
||||
reader.ReadUInt16(),
|
||||
//ObserverRpc.
|
||||
(RpcType)reader.ReadByte());
|
||||
//Add to links.
|
||||
SetRpcLink(linkIndex, link);
|
||||
|
||||
rpcLinkIndexes.Add(linkIndex);
|
||||
}
|
||||
}
|
||||
nob.SetRpcLinkIndexes(rpcLinkIndexes);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Instantiates a NetworkObject if required and sets transform values.
|
||||
/// </summary>
|
||||
internal NetworkObject GetInstantiatedNetworkObject(CachedNetworkObject cnob)
|
||||
{
|
||||
if (cnob.PrefabId == null)
|
||||
{
|
||||
NetworkManager.LogError($"PrefabId for {cnob.ObjectId} is null. Object will not spawn.");
|
||||
return null;
|
||||
}
|
||||
|
||||
NetworkManager networkManager = base.NetworkManager;
|
||||
int prefabId = cnob.PrefabId.Value;
|
||||
NetworkObject result;
|
||||
|
||||
if (prefabId == NetworkObject.UNSET_OBJECTID_VALUE)
|
||||
{
|
||||
NetworkManager.LogError($"Spawned object has an invalid prefabId. Make sure all objects which are being spawned over the network are within SpawnableObjects on the NetworkManager.");
|
||||
return null;
|
||||
}
|
||||
|
||||
ushort collectionId = cnob.CollectionId;
|
||||
//PrefabObjects to get the prefab from.
|
||||
PrefabObjects prefabObjects = networkManager.GetPrefabObjects<PrefabObjects>(collectionId, false);
|
||||
//Not found for collectionId > 0. This means the user likely did not setup the collection on client.
|
||||
if (prefabObjects == null && collectionId > 0)
|
||||
{
|
||||
networkManager.LogError($"PrefabObjects collection is not found for CollectionId {collectionId}. Be sure to add your addressables NetworkObject prefabs to the collection on server and client before attempting to spawn them over the network.");
|
||||
return null;
|
||||
}
|
||||
|
||||
//Only instantiate if not host.
|
||||
if (!networkManager.IsHost)
|
||||
{
|
||||
Transform parentTransform = null;
|
||||
bool hasParent = (cnob.ParentObjectId != null);
|
||||
//Set parentTransform if there's a parent object.
|
||||
if (hasParent)
|
||||
{
|
||||
int objectId = cnob.ParentObjectId.Value;
|
||||
NetworkObject nob = _objectCache.GetSpawnedObject(objectId);
|
||||
|
||||
if (nob == null)
|
||||
{
|
||||
NetworkObject prefab = prefabObjects.GetObject(false, prefabId);
|
||||
networkManager.LogError($"NetworkObject not found for ObjectId {objectId}. Prefab {prefab.name} will be instantiated without parent synchronization.");
|
||||
}
|
||||
else
|
||||
{
|
||||
//If parent object is a network behaviour then find the component.
|
||||
if (cnob.ParentIsNetworkBehaviour)
|
||||
{
|
||||
byte componentIndex = cnob.ComponentIndex;
|
||||
NetworkBehaviour nb = nob.GetNetworkBehaviour(componentIndex, false);
|
||||
if (nb != null)
|
||||
{
|
||||
parentTransform = nb.transform;
|
||||
}
|
||||
else
|
||||
{
|
||||
NetworkObject prefab = prefabObjects.GetObject(false, prefabId);
|
||||
networkManager.LogError($"NetworkBehaviour on index {componentIndex} could nto be found within NetworkObject {nob.name} with ObjectId {objectId}. Prefab {prefab.name} will be instantiated without parent synchronization.");
|
||||
}
|
||||
}
|
||||
//The networkObject is the parent.
|
||||
else
|
||||
{
|
||||
parentTransform = nob.transform;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
result = networkManager.GetPooledInstantiated(prefabId, collectionId, false);
|
||||
Transform t = result.transform;
|
||||
t.SetParent(parentTransform, true);
|
||||
//Only need to set IsGlobal also if not host.
|
||||
bool isGlobal = SpawnTypeEnum.Contains(cnob.SpawnType, SpawnType.InstantiatedGlobal);
|
||||
result.SetIsGlobal(isGlobal);
|
||||
}
|
||||
//If host then find server instantiated object.
|
||||
else
|
||||
{
|
||||
ServerObjects so = networkManager.ServerManager.Objects;
|
||||
if (!so.Spawned.TryGetValueIL2CPP(cnob.ObjectId, out result))
|
||||
result = so.GetFromPending(cnob.ObjectId);
|
||||
|
||||
if (result == null)
|
||||
networkManager.LogError($"ObjectId {cnob.ObjectId} could not be found in Server spawned, nor Server pending despawn.");
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a NetworkObject from Spawned, or object cache.
|
||||
/// </summary>
|
||||
/// <param name="cnob"></param>
|
||||
/// <returns></returns>
|
||||
internal NetworkObject GetSpawnedNetworkObject(CachedNetworkObject cnob)
|
||||
{
|
||||
NetworkObject nob;
|
||||
//Try checking already spawned objects first.
|
||||
if (base.Spawned.TryGetValueIL2CPP(cnob.ObjectId, out nob))
|
||||
{
|
||||
return nob;
|
||||
}
|
||||
/* If not found in already spawned objects see if
|
||||
* the networkObject is in the objectCache. It's possible the despawn
|
||||
* came immediately or shortly after the spawn message, before
|
||||
* the object has been initialized. */
|
||||
else
|
||||
{
|
||||
nob = _objectCache.GetInCached(cnob.ObjectId, ClientObjectCache.CacheSearchType.Any);
|
||||
/* Nob may be null if it's a child object being despawned, and the
|
||||
* parent despawn already occurred. */
|
||||
return nob;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Finishes reading a scene object.
|
||||
/// </summary>
|
||||
private void ReadSceneObject(PooledReader reader, out ulong sceneId)
|
||||
{
|
||||
sceneId = reader.ReadUInt64(AutoPackType.Unpacked);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Finishes reading a spawned object, and instantiates the object.
|
||||
/// </summary>
|
||||
private void ReadSpawnedObject(PooledReader reader, out int? parentObjectId, out byte? parentComponentIndex, out int? prefabId)
|
||||
{
|
||||
//Parent.
|
||||
SpawnParentType spt = (SpawnParentType)reader.ReadByte();
|
||||
//Defaults.
|
||||
parentObjectId = null;
|
||||
parentComponentIndex = null;
|
||||
|
||||
if (spt == SpawnParentType.NetworkObject)
|
||||
{
|
||||
int objectId = reader.ReadNetworkObjectId();
|
||||
if (objectId != NetworkObject.UNSET_OBJECTID_VALUE)
|
||||
parentObjectId = objectId;
|
||||
}
|
||||
else if (spt == SpawnParentType.NetworkBehaviour)
|
||||
{
|
||||
reader.ReadNetworkBehaviour(out int objectId, out byte componentIndex);
|
||||
if (objectId != NetworkObject.UNSET_OBJECTID_VALUE)
|
||||
{
|
||||
parentObjectId = objectId;
|
||||
parentComponentIndex = componentIndex;
|
||||
}
|
||||
}
|
||||
|
||||
prefabId = (ushort)reader.ReadNetworkObjectId();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: da027fa27b0c0994ebfa317968862970
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
605
Assets/FishNet/Runtime/Managing/Client/Object/ObjectCaching.cs
Normal file
605
Assets/FishNet/Runtime/Managing/Client/Object/ObjectCaching.cs
Normal file
@ -0,0 +1,605 @@
|
||||
using FishNet.Connection;
|
||||
using FishNet.Managing.Logging;
|
||||
using FishNet.Managing.Object;
|
||||
using FishNet.Object;
|
||||
using FishNet.Object.Helping;
|
||||
using FishNet.Serializing;
|
||||
using FishNet.Utility.Extension;
|
||||
using FishNet.Utility.Performance;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using UnityEngine;
|
||||
using UnityEngine.Scripting;
|
||||
|
||||
namespace FishNet.Managing.Client
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// Information about cached network objects.
|
||||
/// </summary>
|
||||
internal class ClientObjectCache
|
||||
{
|
||||
#region Types.
|
||||
public enum CacheSearchType
|
||||
{
|
||||
Any = 0,
|
||||
Spawning = 1,
|
||||
Despawning = 2
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Internal.
|
||||
/// <summary>
|
||||
/// Objets which are being spawned during iteration.
|
||||
/// </summary>
|
||||
internal Dictionary<int, NetworkObject> SpawningObjects = new Dictionary<int, NetworkObject>();
|
||||
#endregion
|
||||
|
||||
#region Private.
|
||||
/// <summary>
|
||||
/// Cached objects buffer. Contains spawns and despawns.
|
||||
/// </summary>
|
||||
private ListCache<CachedNetworkObject> _cachedObjects = new ListCache<CachedNetworkObject>();
|
||||
/// <summary>
|
||||
/// NetworkObjects which have been spawned already during the current iteration.
|
||||
/// </summary>
|
||||
private HashSet<NetworkObject> _iteratedSpawns = new HashSet<NetworkObject>();
|
||||
/// <summary>
|
||||
/// Despawns which are occurring the same tick as their spawn.
|
||||
/// </summary>
|
||||
private HashSet<int> _conflictingDespawns = new HashSet<int>();
|
||||
/// <summary>
|
||||
/// ClientObjects reference.
|
||||
/// </summary>
|
||||
private ClientObjects _clientObjects;
|
||||
/// <summary>
|
||||
/// NetworkManager for this cache.
|
||||
/// </summary>
|
||||
private NetworkManager _networkManager;
|
||||
/// <summary>
|
||||
/// True if logged the warning about despawning on the same tick as the spawn.
|
||||
/// This exist to prevent excessive spam of the warning.
|
||||
/// </summary>
|
||||
private bool _loggedSameTickWarning;
|
||||
/// <summary>
|
||||
/// True if initializeOrder was not default for any spawned objects.
|
||||
/// </summary>
|
||||
private bool _initializeOrderChanged;
|
||||
#endregion
|
||||
|
||||
public ClientObjectCache(ClientObjects cobs, NetworkManager networkManager)
|
||||
{
|
||||
_clientObjects = cobs;
|
||||
_networkManager = networkManager;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a NetworkObject found in spawned cache using objectId.
|
||||
/// </summary>
|
||||
/// <param name="objectId"></param>
|
||||
/// <returns></returns>
|
||||
public NetworkObject GetInCached(int objectId, CacheSearchType searchType)
|
||||
{
|
||||
int count = _cachedObjects.Written;
|
||||
List<CachedNetworkObject> collection = _cachedObjects.Collection;
|
||||
for (int i = 0; i < count; i++)
|
||||
{
|
||||
CachedNetworkObject cnob = collection[i];
|
||||
if (cnob.ObjectId == objectId)
|
||||
{
|
||||
//Any condition always returns.
|
||||
if (searchType == CacheSearchType.Any)
|
||||
return cnob.NetworkObject;
|
||||
|
||||
bool spawning = (searchType == CacheSearchType.Spawning);
|
||||
bool spawnAction = (cnob.Action == CachedNetworkObject.ActionType.Spawn);
|
||||
if (spawning == spawnAction)
|
||||
return cnob.NetworkObject;
|
||||
else
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
//Fall through.
|
||||
return null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes for a spawned NetworkObject.
|
||||
/// </summary>
|
||||
/// <param name="nob"></param>
|
||||
/// <param name="syncValues"></param>
|
||||
/// <param name="manager"></param>
|
||||
public void AddSpawn(NetworkManager manager, ushort collectionId, int objectId, sbyte initializeOrder, int ownerId, SpawnType ost, byte componentIndex, int rootObjectId, int? parentObjectId, byte? parentComponentIndex
|
||||
, int? prefabId, Vector3? localPosition, Quaternion? localRotation, Vector3? localScale, ulong sceneId, ArraySegment<byte> rpcLinks, ArraySegment<byte> syncValues)
|
||||
{
|
||||
//Set if initialization order has changed.
|
||||
_initializeOrderChanged |= (initializeOrder != 0);
|
||||
|
||||
CachedNetworkObject cnob = null;
|
||||
//If order has not changed then add normally.
|
||||
if (!_initializeOrderChanged)
|
||||
{
|
||||
cnob = _cachedObjects.AddReference();
|
||||
}
|
||||
//Otherwise see if values need to be sorted.
|
||||
else
|
||||
{
|
||||
/* Spawns will be ordered at the end of their nearest order.
|
||||
* If spawns arrived with Id order of 5, 7, 2 then the result
|
||||
* would be as shown below...
|
||||
* Id 5 / order -5
|
||||
* Id 7 / order -5
|
||||
* Id 2 / order 0
|
||||
* Not as if the values were inserted first such as...
|
||||
* Id 7 / order -5
|
||||
* Id 5 / order -5
|
||||
* Id 2 / order 0
|
||||
* This is to prevent the likeliness of child nobs being out of order
|
||||
* as well to preserve user spawn order if they spawned multiple
|
||||
* objects the same which, with the same order. */
|
||||
|
||||
int written = _cachedObjects.Written;
|
||||
for (int i = 0; i < written; i++)
|
||||
{
|
||||
CachedNetworkObject item = _cachedObjects.Collection[i];
|
||||
/* If item order is larger then that means
|
||||
* initializeOrder has reached the last entry
|
||||
* of its value. Insert just before item index. */
|
||||
if (initializeOrder < item.InitializeOrder)
|
||||
{
|
||||
cnob = _cachedObjects.InsertReference(i);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
//If here and cnob is null then it was not inserted; add to end.
|
||||
if (cnob == null)
|
||||
cnob = _cachedObjects.AddReference();
|
||||
}
|
||||
|
||||
cnob.InitializeSpawn(manager, collectionId, objectId, initializeOrder, ownerId, ost, componentIndex, rootObjectId, parentObjectId, parentComponentIndex
|
||||
, prefabId, localPosition, localRotation, localScale, sceneId, rpcLinks, syncValues);
|
||||
}
|
||||
|
||||
public void AddDespawn(int objectId, DespawnType despawnType)
|
||||
{
|
||||
CachedNetworkObject cnob = _cachedObjects.AddReference();
|
||||
cnob.InitializeDespawn(objectId, despawnType);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Iterates any written objects.
|
||||
/// </summary>
|
||||
public void Iterate()
|
||||
{
|
||||
int written = _cachedObjects.Written;
|
||||
if (written == 0)
|
||||
return;
|
||||
|
||||
try
|
||||
{
|
||||
//Indexes which have already been processed.
|
||||
HashSet<int> processedIndexes = new HashSet<int>();
|
||||
List<CachedNetworkObject> collection = _cachedObjects.Collection;
|
||||
_conflictingDespawns.Clear();
|
||||
/* The next iteration will set rpclinks,
|
||||
* synctypes, and so on. */
|
||||
for (int i = 0; i < written; i++)
|
||||
{
|
||||
/* An index may already be processed if it was pushed ahead.
|
||||
* This can occur if a nested object spawn exists but the root
|
||||
* object has not spawned yet. In this situation the root spawn is
|
||||
* found and performed first. */
|
||||
if (processedIndexes.Contains(i))
|
||||
continue;
|
||||
CachedNetworkObject cnob = collection[i];
|
||||
bool spawn = (cnob.Action == CachedNetworkObject.ActionType.Spawn);
|
||||
|
||||
/* See if nested, and if so check if root is already spawned.
|
||||
* If parent is not spawned then find it and process the parent first. */
|
||||
if (spawn)
|
||||
{
|
||||
/* When an object is nested or has a parent it is
|
||||
* dependent upon either the root of nested, or the parent,
|
||||
* being spawned to setup properly.
|
||||
*
|
||||
* When either of these are true check spawned objects first
|
||||
* to see if the objects exist. If not check if they are appearing
|
||||
* later in the cache. Root or parent objects can appear later
|
||||
* in the cache depending on the order of which observers are rebuilt.
|
||||
* While it is possible to have the server ensure spawns always send
|
||||
* root/parents first, that's a giant can of worms that's not worth getting into.
|
||||
* Not only are there many scenarios to cover, but it also puts more work
|
||||
* on the server. It's more effective to have the client handle the sorting. */
|
||||
|
||||
//Nested.
|
||||
if (cnob.IsNested || cnob.HasParent)
|
||||
{
|
||||
bool nested = cnob.IsNested;
|
||||
//It's not possible to be nested and have a parent. Set the Id to look for based on if nested or parented.
|
||||
int targetObjectId = (nested) ? cnob.RootObjectId : cnob.ParentObjectId.Value;
|
||||
NetworkObject nob = GetSpawnedObject(targetObjectId);
|
||||
//If not spawned yet.
|
||||
if (nob == null)
|
||||
{
|
||||
bool found = false;
|
||||
string errMsg;
|
||||
for (int z = (i + 1); z < written; z++)
|
||||
{
|
||||
CachedNetworkObject zCnob = collection[z];
|
||||
if (zCnob.ObjectId == targetObjectId)
|
||||
{
|
||||
found = true;
|
||||
if (cnob.Action != CachedNetworkObject.ActionType.Spawn)
|
||||
{
|
||||
errMsg = (nested)
|
||||
? $"ObjectId {targetObjectId} was found for a nested spawn, but ActionType is not spawn. ComponentIndex {cnob.ComponentIndex} will not be spawned."
|
||||
: $"ObjectId {targetObjectId} was found for a parented spawn, but ActionType is not spawn. ObjectId {cnob.ObjectId} will not be spawned.";
|
||||
_networkManager.LogError(errMsg);
|
||||
break;
|
||||
}
|
||||
else
|
||||
{
|
||||
ProcessObject(zCnob, true, z);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//Root nob could not be found.
|
||||
if (!found)
|
||||
{
|
||||
errMsg = (nested)
|
||||
? $"ObjectId {targetObjectId} could not be found for a nested spawn. ComponentIndex {cnob.ComponentIndex} will not be spawned."
|
||||
: $"ObjectId {targetObjectId} was found for a parented spawn. ObjectId {cnob.ObjectId} will not be spawned.";
|
||||
_networkManager.LogError(errMsg);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
ProcessObject(cnob, spawn, i);
|
||||
}
|
||||
|
||||
void ProcessObject(CachedNetworkObject cnob, bool spawn, int index)
|
||||
{
|
||||
processedIndexes.Add(index);
|
||||
|
||||
if (spawn)
|
||||
{
|
||||
if (cnob.IsSceneObject)
|
||||
cnob.NetworkObject = _clientObjects.GetSceneNetworkObject(cnob.SceneId);
|
||||
else if (cnob.IsNested)
|
||||
cnob.NetworkObject = _clientObjects.GetNestedNetworkObject(cnob);
|
||||
else
|
||||
cnob.NetworkObject = _clientObjects.GetInstantiatedNetworkObject(cnob);
|
||||
|
||||
/* Apply transform changes but only if not host.
|
||||
* These would have already been applied server side. */
|
||||
if (!_networkManager.IsHost && cnob.NetworkObject != null)
|
||||
{
|
||||
Transform t = cnob.NetworkObject.transform;
|
||||
_clientObjects.GetTransformProperties(cnob.LocalPosition, cnob.LocalRotation, cnob.LocalScale, t, out Vector3 pos, out Quaternion rot, out Vector3 scale);
|
||||
t.SetLocalPositionRotationAndScale(pos, rot, scale);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
cnob.NetworkObject = _clientObjects.GetSpawnedNetworkObject(cnob);
|
||||
/* Do not log unless not nested. Nested nobs sometimes
|
||||
* could be destroyed if parent was first. */
|
||||
if (!_networkManager.IsHost && cnob.NetworkObject == null && !cnob.IsNested)
|
||||
_networkManager.Log($"NetworkObject for ObjectId of {cnob.ObjectId} was found null. Unable to despawn object. This may occur if a nested NetworkObject had it's parent object unexpectedly destroyed. This incident is often safe to ignore.");
|
||||
}
|
||||
NetworkObject nob = cnob.NetworkObject;
|
||||
//No need to error here, the other Gets above would have.
|
||||
if (nob == null)
|
||||
return;
|
||||
|
||||
if (spawn)
|
||||
{
|
||||
//If not also server then object also has to be preinitialized.
|
||||
if (!_networkManager.IsServer)
|
||||
{
|
||||
int ownerId = cnob.OwnerId;
|
||||
//If local client is owner then use localconnection reference.
|
||||
NetworkConnection localConnection = _networkManager.ClientManager.Connection;
|
||||
NetworkConnection owner;
|
||||
//If owner is self.
|
||||
if (ownerId == localConnection.ClientId)
|
||||
{
|
||||
owner = localConnection;
|
||||
}
|
||||
else
|
||||
{
|
||||
/* If owner cannot be found then share owners
|
||||
* is disabled */
|
||||
if (!_networkManager.ClientManager.Clients.TryGetValueIL2CPP(ownerId, out owner))
|
||||
owner = NetworkManager.EmptyConnection;
|
||||
}
|
||||
nob.Preinitialize_Internal(_networkManager, cnob.ObjectId, owner, false);
|
||||
}
|
||||
|
||||
_clientObjects.AddToSpawned(cnob.NetworkObject, false);
|
||||
SpawningObjects.Add(cnob.ObjectId, cnob.NetworkObject);
|
||||
|
||||
IterateSpawn(cnob);
|
||||
_iteratedSpawns.Add(cnob.NetworkObject);
|
||||
|
||||
/* Enable networkObject here if client only.
|
||||
* This is to ensure Awake fires in the same order
|
||||
* as InitializeOrder settings. There is no need
|
||||
* to perform this action if server because server
|
||||
* would have already spawned in order. */
|
||||
if (!_networkManager.IsServer && cnob.NetworkObject != null)
|
||||
cnob.NetworkObject.gameObject.SetActive(true);
|
||||
}
|
||||
else
|
||||
{
|
||||
/* If spawned already this iteration then the nob
|
||||
* must be initialized so that the start/stop cycles
|
||||
* complete normally. Otherwise, the despawn callbacks will
|
||||
* fire immediately while the start callbacks will run after all
|
||||
* spawns have been iterated.
|
||||
* The downside to this is that synctypes
|
||||
* for spawns later in this iteration will not be initialized
|
||||
* yet, and if the nob being spawned/despawned references
|
||||
* those synctypes the values will be default.
|
||||
*
|
||||
* The alternative is to delay the despawning until after
|
||||
* all spawns are iterated, but that will break the order
|
||||
* reliability. This is unfortunately a lose/lose situation so
|
||||
* the best we can do is let the user know the risk. */
|
||||
if (_iteratedSpawns.Contains(cnob.NetworkObject))
|
||||
{
|
||||
if (!_loggedSameTickWarning)
|
||||
{
|
||||
_loggedSameTickWarning = true;
|
||||
_networkManager.LogWarning($"NetworkObject {cnob.NetworkObject.name} is being despawned on the same tick it's spawned." +
|
||||
$" When this occurs SyncTypes will not be set on other objects during the time of this despawn." +
|
||||
$" In result, if NetworkObject {cnob.NetworkObject.name} is referencing a SyncType of another object being spawned this tick, the returned values will be default.");
|
||||
}
|
||||
|
||||
_conflictingDespawns.Add(cnob.ObjectId);
|
||||
cnob.NetworkObject.gameObject.SetActive(true);
|
||||
cnob.NetworkObject.Initialize(false, true);
|
||||
}
|
||||
//Now being initialized, despawn the object.
|
||||
IterateDespawn(cnob);
|
||||
}
|
||||
}
|
||||
|
||||
/* Activate the objects after all data
|
||||
* has been synchronized. This will apply synctypes. */
|
||||
for (int i = 0; i < written; i++)
|
||||
{
|
||||
CachedNetworkObject cnob = collection[i];
|
||||
if (cnob.Action == CachedNetworkObject.ActionType.Spawn && cnob.NetworkObject != null)
|
||||
{
|
||||
/* Apply syncTypes. It's very important to do this after all
|
||||
* spawns have been processed and added to the manager.Objects collection.
|
||||
* Otherwise, the synctype may reference an object spawning the same tick
|
||||
* and the result would be null due to said object not being in spawned.
|
||||
*
|
||||
* At this time the NetworkObject is not initialized so by calling
|
||||
* OnSyncType the changes are cached to invoke callbacks after initialization,
|
||||
* not during the time of this action. */
|
||||
foreach (NetworkBehaviour nb in cnob.NetworkObject.NetworkBehaviours)
|
||||
{
|
||||
PooledReader reader = cnob.SyncValuesReader;
|
||||
//SyncVars.
|
||||
int length = reader.ReadInt32();
|
||||
nb.OnSyncType(reader, length, false);
|
||||
//SyncObjects
|
||||
length = reader.ReadInt32();
|
||||
nb.OnSyncType(reader, length, true);
|
||||
}
|
||||
|
||||
/* Only continue with the initialization if it wasn't initialized
|
||||
* early to prevent a despawn conflict. */
|
||||
bool canInitialize = (!_conflictingDespawns.Contains(cnob.ObjectId) || !_iteratedSpawns.Contains(cnob.NetworkObject));
|
||||
if (canInitialize)
|
||||
cnob.NetworkObject.Initialize(false, false);
|
||||
}
|
||||
}
|
||||
//Invoke synctype callbacks.
|
||||
for (int i = 0; i < written; i++)
|
||||
{
|
||||
CachedNetworkObject cnob = collection[i];
|
||||
if (cnob.Action == CachedNetworkObject.ActionType.Spawn && cnob.NetworkObject != null)
|
||||
cnob.NetworkObject.InvokeSyncTypeCallbacks(false);
|
||||
}
|
||||
}
|
||||
finally
|
||||
{
|
||||
//Once all have been iterated reset.
|
||||
Reset();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes an object on clients and spawns the NetworkObject.
|
||||
/// </summary>
|
||||
/// <param name="cnob"></param>
|
||||
private void IterateSpawn(CachedNetworkObject cnob)
|
||||
{
|
||||
/* All nob spawns have been added to spawned before
|
||||
* they are processed. This ensures they will be found if
|
||||
* anything is referencing them before/after initialization. */
|
||||
/* However, they have to be added again here should an ItereteDespawn
|
||||
* had removed them. This can occur if an object is set to be spawned,
|
||||
* thus added to spawned before iterations, then a despawn runs which
|
||||
* removes it from spawn. */
|
||||
_clientObjects.AddToSpawned(cnob.NetworkObject, false);
|
||||
_clientObjects.ApplyRpcLinks(cnob.NetworkObject, cnob.RpcLinkReader);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Deinitializes an object on clients and despawns the NetworkObject.
|
||||
/// </summary>
|
||||
/// <param name="cnob"></param>
|
||||
private void IterateDespawn(CachedNetworkObject cnob)
|
||||
{
|
||||
_clientObjects.Despawn(cnob.NetworkObject, cnob.DespawnType, false);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a NetworkObject found in spawn cache, or Spawned.
|
||||
/// </summary>
|
||||
/// <param name="objectId"></param>
|
||||
internal NetworkObject GetSpawnedObject(int objectId)
|
||||
{
|
||||
NetworkObject result;
|
||||
//If not found in Spawning then check Spawned.
|
||||
if (!SpawningObjects.TryGetValue(objectId, out result))
|
||||
{
|
||||
Dictionary<int, NetworkObject> spawned = (_networkManager.IsHost) ?
|
||||
_networkManager.ServerManager.Objects.Spawned
|
||||
: _networkManager.ClientManager.Objects.Spawned;
|
||||
spawned.TryGetValue(objectId, out result);
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Resets cache.
|
||||
/// </summary>
|
||||
public void Reset()
|
||||
{
|
||||
_initializeOrderChanged = false;
|
||||
_cachedObjects.Reset();
|
||||
_iteratedSpawns.Clear();
|
||||
SpawningObjects.Clear();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A cached network object which exist in world but has not been Initialized yet.
|
||||
/// </summary>
|
||||
[Preserve]
|
||||
internal class CachedNetworkObject
|
||||
{
|
||||
#region Types.
|
||||
public enum ActionType
|
||||
{
|
||||
Unset = 0,
|
||||
Spawn = 1,
|
||||
Despawn = 2,
|
||||
}
|
||||
#endregion
|
||||
|
||||
/// <summary>
|
||||
/// True if cached object is nested.
|
||||
/// </summary>
|
||||
public bool IsNested => (ComponentIndex > 0);
|
||||
/// <summary>
|
||||
/// True if a scene object.
|
||||
/// </summary>
|
||||
public bool IsSceneObject => (SceneId > 0);
|
||||
/// <summary>
|
||||
/// True if this object has a parent.
|
||||
/// </summary>
|
||||
public bool HasParent => (ParentObjectId != null);
|
||||
/// <summary>
|
||||
/// True if the parent object is a NetworkBehaviour.
|
||||
/// </summary>
|
||||
public bool ParentIsNetworkBehaviour => (HasParent && (ParentComponentIndex != null));
|
||||
|
||||
public ushort CollectionId;
|
||||
public int ObjectId;
|
||||
public sbyte InitializeOrder;
|
||||
public int OwnerId;
|
||||
public SpawnType SpawnType;
|
||||
public DespawnType DespawnType;
|
||||
public byte ComponentIndex;
|
||||
public int RootObjectId;
|
||||
public int? ParentObjectId;
|
||||
public byte? ParentComponentIndex;
|
||||
public int? PrefabId;
|
||||
public Vector3? LocalPosition;
|
||||
public Quaternion? LocalRotation;
|
||||
public Vector3? LocalScale;
|
||||
public ulong SceneId;
|
||||
public ArraySegment<byte> RpcLinks;
|
||||
public ArraySegment<byte> SyncValues;
|
||||
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// True if spawning.
|
||||
/// </summary>
|
||||
public ActionType Action { get; private set; }
|
||||
/// <summary>
|
||||
/// Cached NetworkObject.
|
||||
/// </summary>
|
||||
#pragma warning disable 0649
|
||||
public NetworkObject NetworkObject;
|
||||
/// <summary>
|
||||
/// Reader containing rpc links for the network object.
|
||||
/// </summary>
|
||||
public PooledReader RpcLinkReader { get; private set; }
|
||||
/// <summary>
|
||||
/// Reader containing sync values for the network object.
|
||||
/// </summary>
|
||||
public PooledReader SyncValuesReader { get; private set; }
|
||||
#pragma warning restore 0649
|
||||
|
||||
public void InitializeSpawn(NetworkManager manager, ushort collectionId, int objectId, sbyte initializeOrder, int ownerId, SpawnType objectSpawnType, byte componentIndex, int rootObjectId, int? parentObjectId, byte? parentComponentIndex
|
||||
, int? prefabId, Vector3? localPosition, Quaternion? localRotation, Vector3? localScale, ulong sceneId, ArraySegment<byte> rpcLinks, ArraySegment<byte> syncValues)
|
||||
{
|
||||
ResetValues();
|
||||
Action = ActionType.Spawn;
|
||||
CollectionId = collectionId;
|
||||
ObjectId = objectId;
|
||||
InitializeOrder = initializeOrder;
|
||||
OwnerId = ownerId;
|
||||
SpawnType = objectSpawnType;
|
||||
ComponentIndex = componentIndex;
|
||||
RootObjectId = rootObjectId;
|
||||
ParentObjectId = parentObjectId;
|
||||
ParentComponentIndex = parentComponentIndex;
|
||||
PrefabId = prefabId;
|
||||
LocalPosition = localPosition;
|
||||
LocalRotation = localRotation;
|
||||
LocalScale = localScale;
|
||||
SceneId = sceneId;
|
||||
RpcLinks = rpcLinks;
|
||||
SyncValues = syncValues;
|
||||
|
||||
RpcLinkReader = ReaderPool.GetReader(rpcLinks, manager);
|
||||
SyncValuesReader = ReaderPool.GetReader(syncValues, manager);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes for a despawned NetworkObject.
|
||||
/// </summary>
|
||||
/// <param name="nob"></param>
|
||||
public void InitializeDespawn(int objectId, DespawnType despawnType)
|
||||
{
|
||||
ResetValues();
|
||||
Action = ActionType.Despawn;
|
||||
DespawnType = despawnType;
|
||||
ObjectId = objectId;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Resets values which could malform identify the cached object.
|
||||
/// </summary>
|
||||
private void ResetValues()
|
||||
{
|
||||
NetworkObject = null;
|
||||
}
|
||||
|
||||
~CachedNetworkObject()
|
||||
{
|
||||
if (RpcLinkReader != null)
|
||||
RpcLinkReader.Dispose();
|
||||
if (SyncValuesReader != null)
|
||||
SyncValuesReader.Dispose();
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 54cb2af8ab4557d479acb7fed98bd0c3
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
Reference in New Issue
Block a user