feat: client scene synchronization mode #1171
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows for two different types of client synchronization modes (ClientSynchronizationMode): 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. Uses need to determine which scenes are valid to load via the VerifySceneBeforeLoading method.
Added the ability to squelch the validation warning messages for ClientSynchronizationMode additive as it will throw warnings for every loaded scene you don't want to have the client synchronize. Updated the comments.
0xFA11
reviewed
Sep 13, 2021
| /// 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; } |
There was a problem hiding this comment.
tests for Single & Additive to validate this works in both modes and gives us the results we expect on the client-side? 👀
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Added to the scene loading tests. It now runs the tests with client synchronization set to both LoadSceneMode.Additive and LoadSceneMode.Single.
0xFA11
reviewed
Sep 13, 2021
| @@ -43,7 +43,7 @@ private class SceneTestInfo | |||
|
|
|||
|
|
|||
| [UnityTest] | |||
| public IEnumerator SceneLoadingAndNotifications() | |||
| public IEnumerator SceneLoadingAndNotifications([Values(LoadSceneMode.Single,LoadSceneMode.Additive)] LoadSceneMode clientSynchronizationMode) | |||
There was a problem hiding this comment.
so how we verify whether single or additive modes result into single or additive on the client-side?
I'm not seeing any checks or asserts — does this mean that "works fine" implicitly means "unit-tested"?
There was a problem hiding this comment.
Good point, will add verification that the SceneEventData on the client side reflects the clientSynchronization mode set.
NoelStephensUnity
changed the title
NoelStephensUnity
deleted the
refactor/client-scene-synchronization-mode
branch
SamuelBellomo
added a commit
that referenced
this pull request
Sep 16, 2021
…nsform * develop: feat: NetworkBehaviour.IsSpawned (#1190) feat: added tip to the network manager inspector that directs to install tools (MTT-1211) (#1182) refactor!: remove network dictionary & set, use native container in List, add tests (#1149) fix: Fixed remote disconnects not properly cleaning up (#1184) test: base changes to PR-1114 (#1165) test: verify do not destroy networkobjects on networkmanager shutdown (#1183) chore: removal of EnableNetworkVariable in NetworkConfig. It's always True now (#1179) fix: Fix DontDestroyWithOwner not returning ownership (#1181) test: Giving Android some more room as the connection tests are timing sensitive (#1178) fix: unitytransport connectionmode buttons (#1176) test: added min frames to multi-instance helper (#1170) chore: Add mobile tests to nightly trigger (#1161) feat: snapshot spawn pre-requisite (#1166) feat: Unity Transport + Relay (#887) feat: client scene synchronization mode (#1171) # Conflicts: # testproject/Assets/Scenes/SampleScene.unity
mollstam
pushed a commit
to Keepsake-Games/com.unity.netcode.gameobjects
that referenced
this pull request
Feb 13, 2023
* refactor This allows for two different types of client synchronization modes (ClientSynchronizationMode): 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. Uses need to determine which scenes are valid to load via the VerifySceneBeforeLoading method. * refactor and style Added the ability to squelch the validation warning messages for ClientSynchronizationMode additive as it will throw warnings for every loaded scene you don't want to have the client synchronize. Updated the comments. * style fixing spelling typo. * test added Values to the scene loading test that will run the scene loading tests with client synchronization set to both LoadSceneMode.Single and LoadSceneMode.Additive. * test Adding verification that the client synchronization mode used by the server when building the client synchronization SceneEventData message is the same value on the client side. * style fixing whitespace issue
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a very minor tweak to how clients are synchronized in order to support two different styles of scene loading during client synchronization. There is a new method, NetworkSceneManager.SetClientSynchronizationMode, that provides users with the ability to configure this feature.
When the ClientSynchronizationMode is set to LoadSceneMode.Single:
If the server's currently active scene is not already loaded on the client then it will be loaded in single mode. This means that all currently loaded scenes on the client will be unloaded.
When the ClientSynchronizationMode is set to LoadSceneMode.Additive:
All currently loaded scenes are left as they are on the client and any newly loaded scenes will be loaded additively. Users control which scenes are valid for the server to instruct the client to load via the method.
This update also includes the ability to squelch the VerifySceneBeforeLoading console messages which would commonly be used when ClientSynchronizationMode is set to LoadSceneMode.Additive.
The default ClientSynchronizationMode is LoadSceneMode.Single which behaves like the traditional MLAPI initial client synchronization loading pattern.