Skip to content

chore: Better NetworkBehaviour index out of range message #2295

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
JesseOlmer merged 6 commits into from
Nov 3, 2022
Merged

chore: Better NetworkBehaviour index out of range message #2295

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8e71ee6
chore: Better NetworkBehaviour index out of range message
Nov 2, 2022
83e1ece
Merge branch 'develop' into chore/better-nbindex-error
Nov 2, 2022
be181d6
PR feedback
Nov 2, 2022
cc02a01
Merge remote-tracking branch 'origin/chore/better-nbindex-error' into…
Nov 2, 2022
876a15b
fix style issue
Nov 2, 2022
6eb7184
Merge branch 'develop' into chore/better-nbindex-error
NoelStephensUnity Nov 3, 2022
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
15 changes: 14 additions & 1 deletion 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 @@ -1051,7 +1051,20 @@ internal NetworkBehaviour GetNetworkBehaviourAtOrderIndex(ushort index)
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
{
NetworkLog.LogError($"Behaviour index was out of bounds. Did you mess up the order of your {nameof(NetworkBehaviour)}s?");
NetworkLog.LogError($"{nameof(NetworkBehaviour)} index {index} was out of bounds for {name}. NetworkBehaviours must be the same, and in the same order, between server and client.");
}

if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
Comment thread
JesseOlmer marked this conversation as resolved.
{
var currentKnownChildren = new System.Text.StringBuilder();
currentKnownChildren.Append($"Known child {nameof(NetworkBehaviour)}s:");
for(int i = 0; i < ChildNetworkBehaviours.Count; i++)
{
var childNetworkBehaviour = ChildNetworkBehaviours[i];
currentKnownChildren.Append($" [{i}] {childNetworkBehaviour.__getTypeName()}");
currentKnownChildren.Append(i < ChildNetworkBehaviours.Count - 1 ? "," : ".");
}
NetworkLog.LogInfo(currentKnownChildren.ToString());
}

return null;
Expand Down
20 changes: 8 additions & 12 deletions com.unity.netcode.gameobjects/Tests/Editor/NetworkObjectTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.Text.RegularExpressions;
using NUnit.Framework;
using UnityEngine;
using UnityEngine.TestTools;
Expand Down Expand Up @@ -31,19 +32,17 @@ public void NetworkManagerOverrideTest()
}

[Test]
public void GetBehaviourIndexNone()
[TestCase(0)]
[TestCase(1)]
[TestCase(2)]
public void GetBehaviourIndexNone(int index)
{
var gameObject = new GameObject(nameof(GetBehaviourIndexNone));
var networkObject = gameObject.AddComponent<NetworkObject>();

// TODO: Maybe not hardcode message?
LogAssert.Expect(LogType.Error, $"[Netcode] Behaviour index was out of bounds. Did you mess up the order of your {nameof(NetworkBehaviour)}s?");
LogAssert.Expect(LogType.Error, $"[Netcode] Behaviour index was out of bounds. Did you mess up the order of your {nameof(NetworkBehaviour)}s?");
LogAssert.Expect(LogType.Error, $"[Netcode] Behaviour index was out of bounds. Did you mess up the order of your {nameof(NetworkBehaviour)}s?");
LogAssert.Expect(LogType.Error, new Regex(".*out of bounds.*"));

Assert.That(networkObject.GetNetworkBehaviourAtOrderIndex(0), Is.Null);
Assert.That(networkObject.GetNetworkBehaviourAtOrderIndex(1), Is.Null);
Assert.That(networkObject.GetNetworkBehaviourAtOrderIndex(2), Is.Null);
Assert.That(networkObject.GetNetworkBehaviourAtOrderIndex((ushort)index), Is.Null);

// Cleanup
Object.DestroyImmediate(gameObject);
Expand All @@ -56,13 +55,10 @@ public void GetBehaviourIndexOne()
var networkObject = gameObject.AddComponent<NetworkObject>();
var networkBehaviour = gameObject.AddComponent<EmptyNetworkBehaviour>();

// TODO: Maybe not hardcode message?
LogAssert.Expect(LogType.Error, $"[Netcode] Behaviour index was out of bounds. Did you mess up the order of your {nameof(NetworkBehaviour)}s?");
LogAssert.Expect(LogType.Error, $"[Netcode] Behaviour index was out of bounds. Did you mess up the order of your {nameof(NetworkBehaviour)}s?");
LogAssert.Expect(LogType.Error, new Regex(".*out of bounds.*"));

Assert.That(networkObject.GetNetworkBehaviourAtOrderIndex(0), Is.EqualTo(networkBehaviour));
Assert.That(networkObject.GetNetworkBehaviourAtOrderIndex(1), Is.Null);
Assert.That(networkObject.GetNetworkBehaviourAtOrderIndex(2), Is.Null);

// Cleanup
Object.DestroyImmediate(gameObject);
Expand Down