Skip to content

feat: client scene synchronization mode #1171

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
merged 7 commits into from
Sep 13, 2021
Merged

feat: client scene synchronization mode #1171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8da97b1
refactor
NoelStephensUnity Sep 12, 2021
3d66f53
refactor and style
NoelStephensUnity Sep 12, 2021
ce3e093
style
NoelStephensUnity Sep 12, 2021
905755d
test
NoelStephensUnity Sep 13, 2021
0a66b5f
Merge branch 'develop' into refactor/client-scene-synchronization-mode
NoelStephensUnity Sep 13, 2021
2d591d1
test
NoelStephensUnity Sep 13, 2021
69bbc10
style
NoelStephensUnity Sep 13, 2021
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
48 changes: 45 additions & 3 deletions com.unity.netcode.gameobjects/Runtime/SceneManagement/NetworkSceneManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,22 @@ public class NetworkSceneManager : IDisposable

internal Scene DontDestroyOnLoadScene;

/// <summary>
/// LoadSceneMode.Single: All currently loaded scenes on the client will be unloaded and
/// the server's currently active scene will be loaded in single mode on the client
/// unless it was already loaded.
///
/// LoadSceneMode.Additive: All currently loaded scenes are left as they are and any newly loaded
/// scenes will be loaded additively. Users need to determine which scenes are valid to load via the
/// <see cref="VerifySceneBeforeLoading"/> method.
/// </summary>
public LoadSceneMode ClientSynchronizationMode { get; internal set; }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tests for Single & Additive to validate this works in both modes and gives us the results we expect on the client-side? 👀

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, for single mode it works already otherwise it wouldn't have passed the already existing tests.
I will add some additional passes in the existing tests which use additive ClientSynchronizationMode.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added to the scene loading tests. It now runs the tests with client synchronization set to both LoadSceneMode.Additive and LoadSceneMode.Single.


/// <summary>
/// When true, the <see cref="Debug.LogWarning(object)"/> messages will be turned off
/// </summary>
private bool m_DisableValidationWarningMessages;

/// <summary>
/// Handle NetworkSeneManager clean up
/// </summary>
Expand Down Expand Up @@ -239,6 +255,32 @@ internal void GenerateScenesInBuild()
}
}

/// <summary>
/// When set to true, this will disable the console warnings about
/// a scene being invalidated.
/// </summary>
/// <param name="disabled"></param>
public void DisableValidationWarnings(bool disabled)
{
m_DisableValidationWarningMessages = disabled;
}

/// <summary>
/// This will change how clients are initially synchronized.
/// LoadSceneMode.Single: All currently loaded scenes on the client will be unloaded and
/// the server's currently active scene will be loaded in single mode on the client
/// unless it was already loaded.
///
/// LoadSceneMode.Additive: All currently loaded scenes are left as they are and any newly loaded
/// scenes will be loaded additively. Users need to determine which scenes are valid to load via the
/// <see cref="VerifySceneBeforeLoading"/> method.
/// </summary>
/// <param name="mode"><see cref="LoadSceneMode"/> for initial client synchronization</param>
public void SetClientSynchronizationMode(LoadSceneMode mode)
{
ClientSynchronizationMode = mode;
}

/// <summary>
/// Constructor
/// </summary>
Expand Down Expand Up @@ -299,7 +341,7 @@ internal bool ValidateSceneBeforeLoading(uint sceneIndex, LoadSceneMode loadScen
{
validated = VerifySceneBeforeLoading.Invoke((int)sceneIndex, sceneName, loadSceneMode);
}
if (!validated)
if (!validated && !m_DisableValidationWarningMessages)
{
var serverHostorClient = "Client";
if (m_NetworkManager.IsServer)
Expand Down Expand Up @@ -1139,7 +1181,7 @@ internal void SynchronizeNetworkObjects(ulong clientId)

ClientSynchEventData.InitializeForSynch();
ClientSynchEventData.TargetClientId = clientId;
ClientSynchEventData.LoadSceneMode = LoadSceneMode.Single;
ClientSynchEventData.LoadSceneMode = ClientSynchronizationMode;
var activeScene = SceneManager.GetActiveScene();
ClientSynchEventData.SceneEventType = SceneEventData.SceneEventTypes.S2C_Sync;

Expand All @@ -1158,7 +1200,7 @@ internal void SynchronizeNetworkObjects(ulong clientId)
// If we are the base scene, then we set the root scene index;
if (activeScene == scene)
{
if (!ValidateSceneBeforeLoading(sceneIndex, LoadSceneMode.Single))
if (!ValidateSceneBeforeLoading(sceneIndex, ClientSynchEventData.LoadSceneMode))
{
continue;
}
Expand Down
19 changes: 14 additions & 5 deletions testproject/Assets/Tests/Runtime/NetworkSceneManagerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ private class SceneTestInfo


[UnityTest]
public IEnumerator SceneLoadingAndNotifications()
public IEnumerator SceneLoadingAndNotifications([Values(LoadSceneMode.Single, LoadSceneMode.Additive)] LoadSceneMode clientSynchronizationMode)
{
m_ServerNetworkManager.SceneManager.OnSceneEvent += SceneManager_OnSceneEvent;
m_CurrentSceneName = "AdditiveScene1";
Expand Down Expand Up @@ -85,7 +85,7 @@ public IEnumerator SceneLoadingAndNotifications()


// Now prepare for the loading and unloading additive scene testing
InitializeSceneTestInfo();
InitializeSceneTestInfo(clientSynchronizationMode);

// Test loading additive scenes and the associated event messaging and notification pipelines
ResetWait();
Expand Down Expand Up @@ -139,12 +139,13 @@ public IEnumerator SceneLoadingAndNotifications()
/// <summary>
/// Initializes the m_ShouldWaitList
/// </summary>
private void InitializeSceneTestInfo(bool enableSceneVerification = false)
private void InitializeSceneTestInfo(LoadSceneMode clientSynchronizationMode, bool enableSceneVerification = false)
{
m_ShouldWaitList.Add(new SceneTestInfo() { ClientId = m_ServerNetworkManager.ServerClientId, ShouldWait = false });
if (enableSceneVerification)
{
m_ServerNetworkManager.SceneManager.VerifySceneBeforeLoading = ServerVerifySceneBeforeLoading;
m_ServerNetworkManager.SceneManager.SetClientSynchronizationMode(clientSynchronizationMode);
}

foreach (var manager in m_ClientNetworkManagers)
Expand All @@ -153,6 +154,7 @@ private void InitializeSceneTestInfo(bool enableSceneVerification = false)
if (enableSceneVerification)
{
manager.SceneManager.VerifySceneBeforeLoading = ClientVerifySceneBeforeLoading;
manager.SceneManager.SetClientSynchronizationMode(clientSynchronizationMode);
}
}
}
Expand Down Expand Up @@ -256,9 +258,16 @@ private void SceneManager_OnSceneEvent(SceneEvent sceneEvent)
{
switch (sceneEvent.SceneEventType)
{
case SceneEventData.SceneEventTypes.S2C_Sync:
{
// Verify that the Client Synchronization Mode set by the server is being received by the client (which means it is applied when loading the first scene)
Assert.AreEqual(m_ClientNetworkManagers.ToArray().Where(c => c.LocalClientId == sceneEvent.ClientId).First().SceneManager.ClientSynchronizationMode, sceneEvent.LoadSceneMode);
break;
}
case SceneEventData.SceneEventTypes.S2C_Load:
case SceneEventData.SceneEventTypes.S2C_Unload:
{

Assert.AreEqual(sceneEvent.SceneName, m_CurrentSceneName);
Assert.IsTrue(ContainsClient(sceneEvent.ClientId));
Assert.IsNotNull(sceneEvent.AsyncOperation);
Expand Down Expand Up @@ -342,13 +351,13 @@ private bool ClientVerifySceneBeforeLoading(int sceneIndex, string sceneName, Lo
/// </summary>
/// <returns></returns>
[UnityTest]
public IEnumerator SceneVerifyBeforeLoadTest()
public IEnumerator SceneVerifyBeforeLoadTest([Values(LoadSceneMode.Single, LoadSceneMode.Additive)] LoadSceneMode clientSynchronizationMode)
{
m_ServerNetworkManager.SceneManager.OnSceneEvent += SceneManager_OnSceneEvent;
m_CurrentSceneName = "AdditiveScene1";

// Now prepare for the loading and unloading additive scene testing
InitializeSceneTestInfo(true);
InitializeSceneTestInfo(clientSynchronizationMode, true);

// Test VerifySceneBeforeLoading with both server and client set to true
ResetWait();
Expand Down