Skip to content

refactor: Remove unnecessary exceptions and refactor logging on NetworkSpawnManager and NetworkObject #3933

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
noellie-velez merged 16 commits into from
Apr 16, 2026
Merged

refactor: Remove unnecessary exceptions and refactor logging on NetworkSpawnManager and NetworkObject #3933

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
88c6831
Start remove exception and comment cleanup
noellie-velez Mar 23, 2026
0103c74
Merge branch 'develop-2.0.0' into refactor/remove-exceptions-network-…
noellie-velez Apr 7, 2026
c3ce52e
Replace Debug by NetworkLog + remove exceptions
noellie-velez Apr 7, 2026
74dd16e
Move return call out of the log level check
noellie-velez Apr 7, 2026
d4bef43
Fix test + remove not reachable code
noellie-velez Apr 7, 2026
1e64764
Fix log level + revert internal log and EnableDistributeLogging
noellie-velez Apr 8, 2026
960000e
Update test to expect Log error instead of exception
noellie-velez Apr 8, 2026
445069f
Update Changelog
noellie-velez Apr 9, 2026
7fc428b
Add Netcode prefix to expected logs tests
noellie-velez Apr 10, 2026
f8c4d1b
Replace Debug by NeworkLog in NetworkObject
noellie-velez Apr 10, 2026
2b60fd1
networkManager vs Owner usage consistency
noellie-velez Apr 10, 2026
7892489
Fix test missing prefix
noellie-velez Apr 10, 2026
1c78a7a
Fix test failing when run in a batch due to not having the NetworkMan…
noellie-velez Apr 13, 2026
7cf31e1
remove empty space, comments and redudant else + add 1 missing log le…
noellie-velez Apr 13, 2026
99e4c37
Changelog update
noellie-velez Apr 14, 2026
d4dc951
Address review feedback
noellie-velez Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions com.unity.netcode.gameobjects/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,22 @@ Additional documentation and release notes are available at [Multiplayer Documen

### Changed

- Improve performance of `NetworkBehaviour`. (#3915)
- Improve performance of `NetworkTransform`. (#3907)
- Improve performance of `NetworkRigidbodyBase`. (#3906)
- Improve performance of `NetworkAnimator`. (#3905)
- Replaced Debug usage by NetcodeLog on `NetworkSpawnManager` and `NetworkObject`. (#3933)
- Improved performance of `NetworkBehaviour`. (#3915)
- Improved performance of `NetworkTransform`. (#3907)
- Improved performance of `NetworkRigidbodyBase`. (#3906)
- Improved performance of `NetworkAnimator`. (#3905)

### Deprecated


### Removed

- Removed un-needed exceptions on `NetworkSpawnManager`. (#3933)

### Fixed

- Early return when `ChangeOwnership` is called while not spawned. (#3933)
Comment thread
noellie-velez marked this conversation as resolved.
Outdated
- Fixed issue where attempts to use `NetworkLog` when there is no `NetworkManager` instance would result in an exception. (#3917)

### Security
Expand Down
116 changes: 64 additions & 52 deletions com.unity.netcode.gameobjects/Runtime/Core/NetworkObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ internal void OnValidate()
if (globalId.identifierType != k_SceneObjectType)
{
// This should never happen, but in the event it does throw and error.
Debug.LogError($"[{gameObject.name}] is detected as an in-scene placed object but its identifier is of type {globalId.identifierType}! **Report this error**");
NetworkLog.LogError($"[{gameObject.name}] is detected as an in-scene placed object but its identifier is of type {globalId.identifierType}! **Report this error**");
}

// If this is a prefab instance, then we want to mark it as having been updated in order for the udpated GlobalObjectIdHash value to be saved.
Expand Down Expand Up @@ -1778,7 +1778,10 @@ internal void SpawnInternal(bool destroyWithScene, ulong ownerClientId, bool pla
{
if (NetworkManagerOwner.LocalClient == null || !NetworkManagerOwner.IsConnectedClient || !NetworkManagerOwner.ConnectionManager.LocalClient.IsApproved)
{
Debug.LogError($"Cannot spawn {name} until the client is fully connected to the session!");
if (NetworkManagerOwner.LogLevel <= LogLevel.Error)
{
NetworkLog.LogError($"Cannot spawn {name} until the client is fully connected to the session!");
}
return;
}
if (NetworkManagerOwner.NetworkConfig.EnableSceneManagement)
Expand Down Expand Up @@ -1834,7 +1837,10 @@ internal void SpawnInternal(bool destroyWithScene, ulong ownerClientId, bool pla
}
else
{
NetworkLog.LogWarningServer($"[{name}] Ran into unknown conditional check during spawn when determining distributed authority mode or not");
if (NetworkManagerOwner.LogLevel <= LogLevel.Normal)
{
NetworkLog.LogWarningServer($"[{name}] Ran into unknown conditional check during spawn when determining distributed authority mode or not");
}
}
}

Expand All @@ -1856,7 +1862,10 @@ public static NetworkObject InstantiateAndSpawn(GameObject networkPrefab, Networ
var networkObject = networkPrefab.GetComponent<NetworkObject>();
if (networkObject == null)
{
Debug.LogError($"The {nameof(NetworkPrefab)} {networkPrefab.name} does not have a {nameof(NetworkObject)} component!");
if (networkManager.LogLevel <= LogLevel.Error)
{
NetworkLog.LogError($"The {nameof(NetworkPrefab)} {networkPrefab.name} does not have a {nameof(NetworkObject)} component!");
}
return null;
}
return networkObject.InstantiateAndSpawn(networkManager, ownerClientId, destroyWithScene, isPlayerObject, forceOverride, position, rotation);
Expand All @@ -1878,34 +1887,49 @@ public NetworkObject InstantiateAndSpawn(NetworkManager networkManager, ulong ow
{
if (networkManager == null)
{
Debug.LogError(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.NetworkManagerNull]);
if (NetworkManager.LogLevel <= LogLevel.Error)
{
NetworkLog.LogError(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.NetworkManagerNull]);
}
return null;
}

if (!networkManager.IsListening)
{
Debug.LogError(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.NoActiveSession]);
if (networkManager.LogLevel <= LogLevel.Error)
{
NetworkLog.LogError(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.NoActiveSession]);
}
return null;
}

ownerClientId = networkManager.DistributedAuthorityMode ? networkManager.LocalClientId : ownerClientId;
// We only need to check for authority when running in client-server mode
if (!networkManager.IsServer && !networkManager.DistributedAuthorityMode)
{
Debug.LogError(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.NotAuthority]);
if (networkManager.LogLevel <= LogLevel.Error)
{
NetworkLog.LogError(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.NotAuthority]);
}
return null;
}

if (networkManager.ShutdownInProgress)
{
Debug.LogWarning(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.InvokedWhenShuttingDown]);
if (networkManager.LogLevel <= LogLevel.Normal)
{
NetworkLog.LogWarning(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.InvokedWhenShuttingDown]);
}
return null;
}

// Verify it is actually a valid prefab
if (!networkManager.NetworkConfig.Prefabs.Contains(gameObject))
{
Debug.LogError(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.NotRegisteredNetworkPrefab]);
if (networkManager.LogLevel <= LogLevel.Error)
{
NetworkLog.LogError(NetworkSpawnManager.InstantiateAndSpawnErrors[NetworkSpawnManager.InstantiateAndSpawnErrorTypes.NotRegisteredNetworkPrefab]);
}
return null;
}

Expand Down Expand Up @@ -1961,7 +1985,6 @@ public void Despawn(bool destroy = true)
{
NetworkLog.LogErrorServer($"[{name}][Attempted despawn before {nameof(NetworkObject)} was spawned]");
}

return;
}

Expand Down Expand Up @@ -2011,10 +2034,8 @@ public void ChangeOwnership(ulong newOwnerClientId)
{
NetworkLog.LogErrorServer($"[{name}][Attempted ownership change before {nameof(NetworkObject)} was spawned]");
}

return;
}

NetworkManagerOwner.SpawnManager.ChangeOwnership(this, newOwnerClientId, HasAuthority);
}

Expand All @@ -2030,7 +2051,6 @@ internal void InvokeBehaviourOnOwnershipChanged(ulong originalOwnerClientId, ulo
{
NetworkLog.LogErrorServer($"[{name}][Attempted behavior invoke on ownership changed before {nameof(NetworkObject)} was spawned]");
}

return;
}

Expand Down Expand Up @@ -2061,10 +2081,12 @@ internal void InvokeBehaviourOnOwnershipChanged(ulong originalOwnerClientId, ulo
{
if (!childBehaviour.gameObject.activeInHierarchy)
{
Debug.LogWarning($"[{name}] {childBehaviour.gameObject.name} is disabled! Netcode for GameObjects does not support disabled NetworkBehaviours! The {childBehaviour.GetType().Name} component was skipped during ownership assignment!");
if (NetworkManagerOwner.LogLevel <= LogLevel.Normal)
{
NetworkLog.LogWarning($"[{name}] {childBehaviour.gameObject.name} is disabled! Netcode for GameObjects does not support disabled NetworkBehaviours! The {childBehaviour.GetType().Name} component was skipped during ownership assignment!");
}
continue;
}

childBehaviour.InternalOnGainedOwnership();
}
}
Expand All @@ -2080,7 +2102,10 @@ internal void InvokeOwnershipChanged(ulong previous, ulong next)
}
else
{
Debug.LogWarning($"[{name}] {ChildNetworkBehaviours[i].gameObject.name} is disabled! Netcode for GameObjects does not support disabled NetworkBehaviours! The {ChildNetworkBehaviours[i].GetType().Name} component was skipped during ownership assignment!");
if (NetworkManagerOwner.LogLevel <= LogLevel.Normal)
{
NetworkLog.LogWarning($"[{name}] {ChildNetworkBehaviours[i].gameObject.name} is disabled! Netcode for GameObjects does not support disabled NetworkBehaviours! The {ChildNetworkBehaviours[i].GetType().Name} component was skipped during ownership assignment!");
}
}
}
}
Expand Down Expand Up @@ -2291,7 +2316,7 @@ private void OnTransformParentChanged()
return;
}
transform.parent = m_CachedParent;
if (NetworkManagerOwner.LogLevel <= LogLevel.Error)
if (networkManager.LogLevel <= LogLevel.Error)
{
NetworkLog.LogError($"[{name}] {nameof(networkManager)} is not listening, start a server or host before re-parenting.");
}
Expand All @@ -2311,7 +2336,7 @@ private void OnTransformParentChanged()
else
{
transform.parent = m_CachedParent;
if (NetworkManagerOwner.LogLevel <= LogLevel.Error)
if (networkManager.LogLevel <= LogLevel.Error)
{
NetworkLog.LogErrorServer($"[{name}] {nameof(NetworkObject)} can only be re-parented after being spawned!");
}
Expand All @@ -2326,9 +2351,9 @@ private void OnTransformParentChanged()
if (!isParentingAuthority)
{
transform.parent = m_CachedParent;
if (networkManager.LogLevel <= LogLevel.Error)
if (NetworkManagerOwner.LogLevel <= LogLevel.Error)
{
if (networkManager.DistributedAuthorityMode)
if (NetworkManagerOwner.DistributedAuthorityMode)
{
NetworkLog.LogError($"[{name}][Not Owner] Only the owner-authority of child {gameObject.name}'s {nameof(NetworkObject)} component can re-parent it!");
}
Expand All @@ -2354,7 +2379,7 @@ private void OnTransformParentChanged()
}
return;
}
else if (!parentObject.IsSpawned)
if (!parentObject.IsSpawned)
{
transform.parent = m_CachedParent;
AuthorityAppliedParenting = false;
Expand Down Expand Up @@ -2399,28 +2424,28 @@ private void OnTransformParentChanged()
}

// If we're not the server, we should tell the server about this parent change
if (!networkManager.IsServer)
if (!NetworkManagerOwner.IsServer)
{
// Don't send a message in DA mode if we're the only observers of this object (we're the only authority).
if (networkManager.DistributedAuthorityMode && Observers.Count <= 1)
if (NetworkManagerOwner.DistributedAuthorityMode && Observers.Count <= 1)
{
return;
}

networkManager.ConnectionManager.SendMessage(ref message, MessageDeliveryType<ParentSyncMessage>.DefaultDelivery, NetworkManager.ServerClientId);
NetworkManagerOwner.ConnectionManager.SendMessage(ref message, MessageDeliveryType<ParentSyncMessage>.DefaultDelivery, NetworkManager.ServerClientId);
return;
}

// Otherwise we are a Server (client-server or DAHost). Send to all observers
foreach (var clientId in networkManager.ConnectionManager.ConnectedClientIds)
foreach (var clientId in NetworkManagerOwner.ConnectionManager.ConnectedClientIds)
{
if (clientId == NetworkManager.ServerClientId)
{
continue;
}
if (Observers.Contains(clientId))
{
networkManager.ConnectionManager.SendMessage(ref message, MessageDeliveryType<ParentSyncMessage>.DefaultDelivery, clientId);
NetworkManagerOwner.ConnectionManager.SendMessage(ref message, MessageDeliveryType<ParentSyncMessage>.DefaultDelivery, clientId);
}
}
}
Expand Down Expand Up @@ -2494,10 +2519,10 @@ internal bool ApplyNetworkParenting(bool removeParent = false, bool ignoreNotSpa
}
}

// If we are removing the parent or our latest parent is not set, then remove the parent
// If we are removing the parent or our latest parent is not set, then remove the parent.
// removeParent is only set when:
// - The server-side NetworkObject.OnTransformParentChanged is invoked and the parent is being removed
// - The client-side when handling a ParentSyncMessage
// - The client-side is handling a ParentSyncMessage
// When clients are synchronizing only the m_LatestParent.HasValue will not have a value if there is no parent
// or a parent was removed prior to the client connecting (i.e. in-scene placed NetworkObjects)
if (removeParent || !m_LatestParent.HasValue)
Expand Down Expand Up @@ -2597,7 +2622,10 @@ internal void InvokeBehaviourNetworkSpawn()
{
if (!childBehaviour.gameObject.activeInHierarchy)
{
Debug.LogWarning($"{GenerateDisabledNetworkBehaviourWarning(childBehaviour)}");
if (NetworkManager.LogLevel <= LogLevel.Normal)
{
NetworkLog.LogWarning($"{GenerateDisabledNetworkBehaviourWarning(childBehaviour)}");
}
continue;
}
childBehaviour.NetworkSpawn();
Expand Down Expand Up @@ -2709,7 +2737,6 @@ internal List<NetworkBehaviour> ChildNetworkBehaviours
}
#endif
}

return m_ChildNetworkBehaviours;
}
}
Expand Down Expand Up @@ -2876,9 +2903,7 @@ internal struct SerializedObject
public bool HasParent;
public bool IsSceneObject;
public bool HasTransform;

public bool IsLatestParentSet;

public bool WorldPositionStays;

/// <summary>
Expand All @@ -2888,15 +2913,10 @@ internal struct SerializedObject
/// to the current active scene when its scene is unloaded. (only for dynamically spawned)
/// </summary>
public bool DestroyWithScene;

public bool DontDestroyWithOwner;

public bool HasOwnershipFlags;

public bool SyncObservers;

public bool SpawnWithObservers;

public bool HasInstantiationData;

[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down Expand Up @@ -2988,9 +3008,6 @@ public struct TransformData : INetworkSerializeByMemcpy

public TransformData Transform;

//If(Metadata.IsReparented)

//If(IsLatestParentSet)
public ulong? LatestParent;

public NetworkObject OwnerObject;
Expand Down Expand Up @@ -3310,11 +3327,8 @@ internal static NetworkObject Deserialize(in SerializedObject serializedObject,
reader.ReadValueSafe(out instantiationData);
}


// Attempt to create a local NetworkObject
var networkObject = networkManager.SpawnManager.CreateLocalNetworkObject(serializedObject, instantiationData);


if (networkObject == null)
{
// Log the error that the NetworkObject failed to construct
Expand All @@ -3336,7 +3350,6 @@ internal static NetworkObject Deserialize(in SerializedObject serializedObject,
// We have nothing left to do here.
return null;
}

networkObject.NetworkManagerOwner = networkManager;

// This will get set again when the NetworkObject is spawned locally, but we set it here ahead of spawning
Expand All @@ -3356,7 +3369,10 @@ internal static NetworkObject Deserialize(in SerializedObject serializedObject,
// Ensure that the buffer is completely reset
if (reader.Position != endOfSynchronizationData)
{
Debug.LogWarning($"[Size mismatch] Expected: {endOfSynchronizationData} Currently At: {reader.Position}!");
if (networkManager.LogLevel <= LogLevel.Normal)
{
NetworkLog.LogWarning($"[Size mismatch] Expected: {endOfSynchronizationData} Currently At: {reader.Position}!");
}
Comment thread
noellie-velez marked this conversation as resolved.
Outdated
reader.Seek(endOfSynchronizationData);
}
}
Expand Down Expand Up @@ -3625,17 +3641,13 @@ internal uint CheckForGlobalObjectIdHashOverride()
{
return PrefabGlobalObjectIdHash;
}
else
// For legacy manual instantiation and spawning, check the OverrideToNetworkPrefab for a possible match
if (networkManager.NetworkConfig.Prefabs.OverrideToNetworkPrefab.ContainsKey(GlobalObjectIdHash))
{
// For legacy manual instantiation and spawning, check the OverrideToNetworkPrefab for a possible match
if (networkManager.NetworkConfig.Prefabs.OverrideToNetworkPrefab.ContainsKey(GlobalObjectIdHash))
{
return networkManager.NetworkConfig.Prefabs.OverrideToNetworkPrefab[GlobalObjectIdHash];
}
return networkManager.NetworkConfig.Prefabs.OverrideToNetworkPrefab[GlobalObjectIdHash];
}
}
}

return GlobalObjectIdHash;
}

Expand Down
Loading