feat: OnAllClientsReady #755
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
These events forward the events from any individual SceneSwitchProgress to a single endpoint.
… the server recieves acknowledgement that all clients have successfully loaded the scene (or timed out)
|
|
…tsReady callback - this way we can know specifically, which users failed to load the scene before the transition timed out
…he client, switched it over so that the array of timedout client IDs is properly computed on the server.
…nity.multiplayer.mlapi into feature/onclientready-mtt588 # Conflicts: # com.unity.multiplayer.mlapi/Tests/Runtime/NetworkManagerHelper.cs # testproject/ProjectSettings/EditorBuildSettings.asset
| var timedOutClientIds = m_NetworkManager.ConnectedClients.Keys.Except(doneClientIds).ToArray(); | ||
|
|
||
| writer.WriteULongArray(doneClientIds, doneClientIds.Length); | ||
| writer.WriteULongArray(timedOutClientIds, timedOutClientIds.Length); |
There was a problem hiding this comment.
Nice! Both active and timed out clients!
Very useful!
| /// <returns>true if it was instantiated or is already instantiate otherwise false means it failed to instantiate</returns> | ||
| public static bool StartNetworkManager(out NetworkManager networkManager, NetworkManagerOperatingMode managerMode = NetworkManagerOperatingMode.Host) | ||
| public static bool StartNetworkManager(out NetworkManager networkManager, NetworkManagerOperatingMode managerMode = NetworkManagerOperatingMode.Host, NetworkConfig networkConfig = null) |
There was a problem hiding this comment.
Adding NetworkConfig will come in handy.
NoelStephensUnity
approved these changes
Apr 28, 2021
NoelStephensUnity
requested changes
Apr 28, 2021
trying to make Yamato like me
…t locates the full path to a scene for the Setup stage.
…ts/.. and in SceneManager list from the package dll on Yamato, the automated tests were removed and a manual test was created instead.
NoelStephensUnity
approved these changes
Apr 30, 2021
JesseOlmer
reviewed
Apr 30, 2021
com.unity.multiplayer.mlapi/Runtime/SceneManagement/NetworkSceneManager.cs
Outdated
Show resolved
Hide resolved
mattwalsh-unity
approved these changes
Apr 30, 2021
…andable at a glance
…nity.multiplayer.mlapi into feature/onclientready-mtt588 # Conflicts: # testproject/Assets/ManualTests/ManualTestsMenu.unity
NoelStephensUnity
approved these changes
May 3, 2021
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.
Summary:
Users need a simplified way to determine when all clients have finished transitioning to a newly loaded scene so net-code related logic (i.e. sending messages, detecting network variable states, etc) can safely begin.
Technical Notes:
On the server-side currently not much needed to be done - we already have
SceneSwitchProgressobject created for any scene switches. The only hindrance here is that the user has to cacheSceneSwitchProgressin order to be able to listen to it's events. We can capture these events inNetworkSceneManagerand provide a unified set of events one can listen to without needing to re-subscribe to the events any time a new scene is being loaded.Two events are added to the
NetworkSceneManagerthat forward theSceneSwitchProgressevents (those happen only on the server):On the client-side this can be accomplished by implementing a new internal MLAPI message event (NetworkConstants.ALL_CLIENTS_SWITCH_SCENE_COMPLETED).
This message is sent (along with lists of all connected and timed-out clients) to the clients as soon as the server knows that all clients have concluded their scene transitions. The message is then handled in
InternalMessageHandler.HandleAllClientsSwitchSceneCompleted, which triggersNetworkSceneManager.OnAllClientsReadyevent on all the clients.Acceptance Criteria:
Nothing should break - the change is purely additive.
It should be simpler to implement scene switching logic on the client and on the server and it should eliminate the need for custom messaging that the users will have to implement to achieve the same functionality.
Acceptance Tests: