Skip to content

Commit f1a9ff4

Browse files
update
Updating documentation on SceneMigrationSynchronization
1 parent dd4a7a7 commit f1a9ff4

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

com.unity.netcode.gameobjects/Documentation~/components/core/networkobject.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,10 @@ Similar to [`NetworkObject.ActiveSceneSynchronization`](#active-scene-synchroniz
112112

113113
`NetworkObject.ActiveSceneSynchronization` can be used with `NetworkObject.SceneMigrationSynchronization` as long as you take into consideration that if you migrate a NetworkObject into a non-active scene via `SceneManager.MoveGameObjectToScene` and later change the active scene, then the NetworkObject instance will be automatically migrated to the newly set active scene.
114114

115-
:::warning
116-
Scene migration synchronization is enabled by default. For NetworkObjects that don't require it, such as those that generate static environmental objects like trees, it's recommended to disable scene migration synchronization to avoid additional processing overheads.
117-
:::
115+
> [!NOTE]
116+
> **Performance Check**
117+
> The `NetworkObject.SceneMigrationSynchronization` field is enabled by default! If your project can have many (600-1000+) spawned objects at any given time, this setting can cause performance issues. This setting only provides the ability to automatically synchronize the scene a NetworkObject is migrated to while it is spawned. If your `NetworkObject` does not change scenes and you have no need for automatic scene migration synchronization (_only applies when the integration scene management is enabled_), then it is recommended to disable this property to avoid additional processing overheads.
118+
118119

119120
## Additional resources
120121

0 commit comments

Comments
 (0)