InnoLab/com.unity.netcode.gameobjects
Archived
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

com.unity.netcode.gameobjects@1.0.0-pre.7

Browse Source 
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com).

## [1.0.0-pre.7] - 2022-04-01

### Added

- Added editor only check prior to entering into play mode if the currently open and active scene is in the build list and if not displays a dialog box asking the user if they would like to automatically add it prior to entering into play mode. (#1828)
- Added `UnityTransport` implementation and `com.unity.transport` package dependency (#1823)
- Added `NetworkVariableWritePermission` to `NetworkVariableBase` and implemented `Owner` client writable netvars. (#1762)
- `UnityTransport` settings can now be set programmatically. (#1845)
- `FastBufferWriter` and Reader IsInitialized property. (#1859)

### Changed

- Updated `UnityTransport` dependency on `com.unity.transport` to 1.0.0 (#1849)

### Removed

- Removed `SnapshotSystem` (#1852)
- Removed `com.unity.modules.animation`, `com.unity.modules.physics` and `com.unity.modules.physics2d` dependencies from the package (#1812)
- Removed `com.unity.collections` dependency from the package (#1849)

### Fixed
- Fixed in-scene placed NetworkObjects not being found/ignored after a client disconnects and then reconnects. (#1850)
- Fixed issue where `UnityTransport` send queues were not flushed when calling `DisconnectLocalClient` or `DisconnectRemoteClient`. (#1847)
- Fixed NetworkBehaviour dependency verification check for an existing NetworkObject not searching from root parent transform relative GameObject. (#1841)
- Fixed issue where entries were not being removed from the NetworkSpawnManager.OwnershipToObjectsTable. (#1838)
- Fixed ClientRpcs would always send to all connected clients by default as opposed to only sending to the NetworkObject's Observers list by default. (#1836)
- Fixed clarity for NetworkSceneManager client side notification when it receives a scene hash value that does not exist in its local hash table. (#1828)
- Fixed client throws a key not found exception when it times out using UNet or UTP. (#1821)
- Fixed network variable updates are no longer limited to 32,768 bytes when NetworkConfig.EnsureNetworkVariableLengthSafety is enabled. The limits are now determined by what the transport can send in a message. (#1811)
- Fixed in-scene NetworkObjects get destroyed if a client fails to connect and shuts down the NetworkManager. (#1809)
- Fixed user never being notified in the editor that a NetworkBehaviour requires a NetworkObject to function properly. (#1808)
- Fixed PlayerObjects and dynamically spawned NetworkObjects not being added to the NetworkClient's OwnedObjects (#1801)
- Fixed issue where NetworkManager would continue starting even if the NetworkTransport selected failed. (#1780)
- Fixed issue when spawning new player if an already existing player exists it does not remove IsPlayer from the previous player (#1779)
- Fixed lack of notification that NetworkManager and NetworkObject cannot be added to the same GameObject with in-editor notifications (#1777)
- Fixed parenting warning printing for false positives (#1855)
This commit is contained in:
Unity Technologies
2022-04-01 00:00:00 +00:00
parent 5b4aaa8b59
commit 60e2dabef4
123 changed files with 5751 additions and 3419 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
Editor/NetworkAnimatorEditor.cs
View File

@@ -1,23 +0,0 @@
using Unity.Netcode.Components;
using UnityEditor;
using UnityEngine;
namespace Unity.Netcode.Editor
{
[CustomEditor(typeof(NetworkAnimator), true)]
[CanEditMultipleObjects]
public class NetworkAnimatorEditor : UnityEditor.Editor
{
public override void OnInspectorGUI()
{
serializedObject.Update();
EditorGUI.BeginChangeCheck();
var label = new GUIContent("Animator", "The Animator component to synchronize");
EditorGUILayout.PropertyField(serializedObject.FindProperty("m_Animator"), label);
EditorGUI.EndChangeCheck();
serializedObject.ApplyModifiedProperties();
}
}
}

86
Editor/NetworkBehaviourEditor.cs
View File

@@ -211,5 +211,91 @@ namespace Unity.Netcode.Editor
serializedObject.ApplyModifiedProperties();
EditorGUI.EndChangeCheck();
}
/// <summary>
/// Invoked once when a NetworkBehaviour component is
/// displayed in the inspector view.
/// </summary>
private void OnEnable()
{
// When we first add a NetworkBehaviour this editor will be enabled
// so we go ahead and check for an already existing NetworkObject here
CheckForNetworkObject((target as NetworkBehaviour).gameObject);
}
internal const string AutoAddNetworkObjectIfNoneExists = "AutoAdd-NetworkObject-When-None-Exist";
public static Transform GetRootParentTransform(Transform transform)
{
if (transform.parent == null || transform.parent == transform)
{
return transform;
}
return GetRootParentTransform(transform.parent);
}
/// <summary>
/// Used to determine if a GameObject has one or more NetworkBehaviours but
/// does not already have a NetworkObject component. If not it will notify
/// the user that NetworkBehaviours require a NetworkObject.
/// </summary>
public static void CheckForNetworkObject(GameObject gameObject, bool networkObjectRemoved = false)
{
// If there are no NetworkBehaviours or no gameObject, then exit early
if (gameObject == null || (gameObject.GetComponent<NetworkBehaviour>() == null && gameObject.GetComponentInChildren<NetworkBehaviour>() == null))
{
return;
}
// Now get the root parent transform to the current GameObject (or itself)
var rootTransform = GetRootParentTransform(gameObject.transform);
// Otherwise, check to see if there is any NetworkObject from the root GameObject down to all children.
// If not, notify the user that NetworkBehaviours require that the relative GameObject has a NetworkObject component.
var networkObject = rootTransform.GetComponent<NetworkObject>();
if (networkObject == null)
{
networkObject = rootTransform.GetComponentInChildren<NetworkObject>();
if (networkObject == null)
{
// If we are removing a NetworkObject but there is still one or more NetworkBehaviour components
// and the user has already turned "Auto-Add NetworkObject" on when first notified about the requirement
// then just send a reminder to the user why the NetworkObject they just deleted seemingly "re-appeared"
// again.
if (networkObjectRemoved && EditorPrefs.HasKey(AutoAddNetworkObjectIfNoneExists) && EditorPrefs.GetBool(AutoAddNetworkObjectIfNoneExists))
{
Debug.LogWarning($"{gameObject.name} still has {nameof(NetworkBehaviour)}s and Auto-Add NetworkObjects is enabled. A NetworkObject is being added back to {gameObject.name}.");
Debug.Log($"To reset Auto-Add NetworkObjects: Select the Netcode->General->Reset Auto-Add NetworkObject menu item.");
}
// Notify and provide the option to add it one time, always add a NetworkObject, or do nothing and let the user manually add it
if (EditorUtility.DisplayDialog($"{nameof(NetworkBehaviour)}s require a {nameof(NetworkObject)}",
$"{gameObject.name} does not have a {nameof(NetworkObject)} component. Would you like to add one now?", "Yes", "No (manually add it)",
DialogOptOutDecisionType.ForThisMachine, AutoAddNetworkObjectIfNoneExists))
{
gameObject.AddComponent<NetworkObject>();
var activeScene = UnityEngine.SceneManagement.SceneManager.GetActiveScene();
UnityEditor.SceneManagement.EditorSceneManager.MarkSceneDirty(activeScene);
UnityEditor.SceneManagement.EditorSceneManager.SaveScene(activeScene);
}
}
}
}
/// <summary>
/// This allows users to reset the Auto-Add NetworkObject preference
/// so the next time they add a NetworkBehaviour to a GameObject without
/// a NetworkObject it will display the dialog box again and not
/// automatically add a NetworkObject.
/// </summary>
[MenuItem("Netcode/General/Reset Auto-Add NetworkObject", false, 1)]
private static void ResetMultiplayerToolsTipStatus()
{
if (EditorPrefs.HasKey(AutoAddNetworkObjectIfNoneExists))
{
EditorPrefs.SetBool(AutoAddNetworkObjectIfNoneExists, false);
}
}
}
}

10
Editor/NetworkManagerEditor.cs
View File

@@ -135,9 +135,13 @@ namespace Unity.Netcode.Editor
m_NetworkPrefabsList = new ReorderableList(serializedObject, serializedObject.FindProperty(nameof(NetworkManager.NetworkConfig)).FindPropertyRelative(nameof(NetworkConfig.NetworkPrefabs)), true, true, true, true);
m_NetworkPrefabsList.elementHeightCallback = index =>
{
var networkPrefab = m_NetworkPrefabsList.serializedProperty.GetArrayElementAtIndex(index);
var networkOverrideProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.Override));
var networkOverrideInt = networkOverrideProp.enumValueIndex;
var networkOverrideInt = 0;
if (m_NetworkPrefabsList.count > 0)
{
var networkPrefab = m_NetworkPrefabsList.serializedProperty.GetArrayElementAtIndex(index);
var networkOverrideProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.Override));
networkOverrideInt = networkOverrideProp.enumValueIndex;
}
return 8 + (networkOverrideInt == 0 ? EditorGUIUtility.singleLineHeight : (EditorGUIUtility.singleLineHeight * 2) + 5);
};

91
Editor/NetworkManagerHelper.cs
View File

@@ -1,5 +1,7 @@
using System.Collections.Generic;
using System.Linq;
using UnityEngine;
using UnityEngine.SceneManagement;
using UnityEditor;
namespace Unity.Netcode.Editor
@@ -25,7 +27,6 @@ namespace Unity.Netcode.Editor
{
Singleton = new NetworkManagerHelper();
NetworkManager.NetworkManagerHelper = Singleton;
EditorApplication.playModeStateChanged -= EditorApplication_playModeStateChanged;
EditorApplication.hierarchyChanged -= EditorApplication_hierarchyChanged;
@@ -40,20 +41,106 @@ namespace Unity.Netcode.Editor
case PlayModeStateChange.ExitingEditMode:
{
s_LastKnownNetworkManagerParents.Clear();
ScenesInBuildActiveSceneCheck();
break;
}
}
}
/// <summary>
/// Detects if a user is trying to enter into play mode when both conditions are true:
/// - the currently active and open scene is not added to the scenes in build list
/// - an instance of a NetworkManager with scene management enabled can be found
/// If both conditions are met then the user is presented with a dialog box that
/// provides the user with the option to add the scene to the scenes in build list
/// before entering into play mode or the user can continue under those conditions.
///
/// ** When scene management is enabled the user should treat all scenes that need to
/// be synchronized using network scene management as if they were preparing for a build.
/// Any scene that needs to be loaded at run time has to be included in the scenes in
/// build list. **
/// </summary>
private static void ScenesInBuildActiveSceneCheck()
{
var scenesList = EditorBuildSettings.scenes.ToList();
var activeScene = SceneManager.GetActiveScene();
var isSceneInBuildSettings = scenesList.Where((c) => c.path == activeScene.path).Count() == 1;
var networkManager = Object.FindObjectOfType<NetworkManager>();
if (!isSceneInBuildSettings && networkManager != null)
{
if (networkManager.NetworkConfig != null && networkManager.NetworkConfig.EnableSceneManagement)
{
if (EditorUtility.DisplayDialog("Add Scene to Scenes in Build", $"The current scene was not found in the scenes" +
$" in build and a {nameof(NetworkManager)} instance was found with scene management enabled! Clients will not be able " +
$"to synchronize to this scene unless it is added to the scenes in build list.\n\nWould you like to add it now?",
"Yes", "No - Continue"))
{
scenesList.Add(new EditorBuildSettingsScene(activeScene.path, true));
EditorBuildSettings.scenes = scenesList.ToArray();
}
}
}
}
/// <summary>
/// Invoked only when the hierarchy changes
/// </summary>
private static void EditorApplication_hierarchyChanged()
{
var allNetworkManagers = Resources.FindObjectsOfTypeAll<NetworkManager>();
foreach (var networkManager in allNetworkManagers)
{
networkManager.NetworkManagerCheckForParent();
if (!networkManager.NetworkManagerCheckForParent())
{
Singleton.CheckAndNotifyUserNetworkObjectRemoved(networkManager);
}
}
}
/// <summary>
/// Handles notifying users that they cannot add a NetworkObject component
/// to a GameObject that also has a NetworkManager component. The NetworkObject
/// will always be removed.
/// GameObject + NetworkObject then NetworkManager = NetworkObject removed
/// GameObject + NetworkManager then NetworkObject = NetworkObject removed
/// Note: Since this is always invoked after <see cref="NetworkManagerCheckForParent"/>
/// we do not need to check for parent when searching for a NetworkObject component
/// </summary>
public void CheckAndNotifyUserNetworkObjectRemoved(NetworkManager networkManager, bool editorTest = false)
{
// Check for any NetworkObject at the same gameObject relative layer
var networkObject = networkManager.gameObject.GetComponent<NetworkObject>();
if (networkObject == null)
{
// if none is found, check to see if any children have a NetworkObject
networkObject = networkManager.gameObject.GetComponentInChildren<NetworkObject>();
if (networkObject == null)
{
return;
}
}
if (!EditorApplication.isUpdating)
{
Object.DestroyImmediate(networkObject);
if (!EditorApplication.isPlaying && !editorTest)
{
EditorUtility.DisplayDialog($"Removing {nameof(NetworkObject)}", NetworkManagerAndNetworkObjectNotAllowedMessage(), "OK");
}
else
{
Debug.LogError(NetworkManagerAndNetworkObjectNotAllowedMessage());
}
}
}
public string NetworkManagerAndNetworkObjectNotAllowedMessage()
{
return $"A {nameof(GameObject)} cannot have both a {nameof(NetworkManager)} and {nameof(NetworkObject)} assigned to it or any children under it.";
}
/// <summary>
/// Handles notifying the user, via display dialog window, that they have nested a NetworkManager.
/// When in edit mode it provides the option to automatically fix the issue

27
Editor/NetworkObjectEditor.cs
View File

@@ -100,5 +100,32 @@ namespace Unity.Netcode.Editor
GUI.enabled = guiEnabled;
}
}
// Saved for use in OnDestroy
private GameObject m_GameObject;
/// <summary>
/// Invoked once when a NetworkObject component is
/// displayed in the inspector view.
/// </summary>
private void OnEnable()
{
// We set the GameObject upon being enabled because when the
// NetworkObject component is removed (i.e. when OnDestroy is invoked)
// it is no longer valid/available.
m_GameObject = (target as NetworkObject).gameObject;
}
/// <summary>
/// Invoked once when a NetworkObject component is
/// no longer displayed in the inspector view.
/// </summary>
private void OnDestroy()
{
// Since this is also invoked when a NetworkObject component is removed
// from a GameObject, we go ahead and check for a NetworkObject when
// this custom editor is destroyed.
NetworkBehaviourEditor.CheckForNetworkObject(m_GameObject, true);
}
}
}

6
Editor/NetworkTransformEditor.cs
View File

@@ -4,7 +4,7 @@ using Unity.Netcode.Components;
namespace Unity.Netcode.Editor
{
[CustomEditor(typeof(NetworkTransform))]
[CustomEditor(typeof(NetworkTransform), true)]
public class NetworkTransformEditor : UnityEditor.Editor
{
private SerializedProperty m_SyncPositionXProperty;
@@ -112,6 +112,7 @@ namespace Unity.Netcode.Editor
EditorGUILayout.PropertyField(m_InLocalSpaceProperty);
EditorGUILayout.PropertyField(m_InterpolateProperty);
#if COM_UNITY_MODULES_PHYSICS
// if rigidbody is present but network rigidbody is not present
var go = ((NetworkTransform)target).gameObject;
if (go.TryGetComponent<Rigidbody>(out _) && go.TryGetComponent<NetworkRigidbody>(out _) == false)
@@ -119,12 +120,15 @@ namespace Unity.Netcode.Editor
EditorGUILayout.HelpBox("This GameObject contains a Rigidbody but no NetworkRigidbody.\n" +
"Add a NetworkRigidbody component to improve Rigidbody synchronization.", MessageType.Warning);
}
#endif // COM_UNITY_MODULES_PHYSICS
#if COM_UNITY_MODULES_PHYSICS2D
if (go.TryGetComponent<Rigidbody2D>(out _) && go.TryGetComponent<NetworkRigidbody2D>(out _) == false)
{
EditorGUILayout.HelpBox("This GameObject contains a Rigidbody2D but no NetworkRigidbody2D.\n" +
"Add a NetworkRigidbody2D component to improve Rigidbody2D synchronization.", MessageType.Warning);
}
#endif // COM_UNITY_MODULES_PHYSICS2D
serializedObject.ApplyModifiedProperties();
}

8
Editor/PackageChecker.meta Normal file
View File

@@ -0,0 +1,8 @@
fileFormatVersion: 2
guid: a325130169714440ba1b4878082e8956
folderAsset: yes
DefaultImporter:
externalObjects: {}
userData:
assetBundleName:
assetBundleVariant:

53
Editor/PackageChecker/UTPAdapterChecker.cs Normal file
View File

@@ -0,0 +1,53 @@
#if COM_UNITY_NETCODE_ADAPTER_UTP
using System.Linq;
using UnityEngine;
using UnityEditor;
using UnityEditor.PackageManager;
using UnityEditor.PackageManager.Requests;
namespace Unity.Netcode.Editor.PackageChecker
{
[InitializeOnLoad]
internal class UTPAdapterChecker
{
private const string k_UTPAdapterPackageName = "com.unity.netcode.adapter.utp";
private static ListRequest s_ListRequest = null;
static UTPAdapterChecker()
{
if (s_ListRequest == null)
{
s_ListRequest = Client.List();
EditorApplication.update += EditorUpdate;
}
}
private static void EditorUpdate()
{
if (!s_ListRequest.IsCompleted)
{
return;
}
EditorApplication.update -= EditorUpdate;
if (s_ListRequest.Status == StatusCode.Success)
{
if (s_ListRequest.Result.Any(p => p.name == k_UTPAdapterPackageName))
{
Debug.Log($"({nameof(UTPAdapterChecker)}) Found UTP Adapter package, it is no longer needed, `UnityTransport` is now directly integrated into the SDK therefore removing it from the project.");
Client.Remove(k_UTPAdapterPackageName);
}
}
else
{
var error = s_ListRequest.Error;
Debug.LogError($"({nameof(UTPAdapterChecker)}) Cannot check the list of packages -> error #{error.errorCode}: {error.message}");
}
s_ListRequest = null;
}
}
}
#endif // COM_UNITY_NETCODE_ADAPTER_UTP

2
Editor/NetworkAnimatorEditor.cs.meta → Editor/PackageChecker/UTPAdapterChecker.cs.meta
View File

@@ -1,5 +1,5 @@
fileFormatVersion: 2
guid: a32aeecf69a2542469927066f5b88005
guid: df5ed97df956b4aad91a221ba59fa304
MonoImporter:
externalObjects: {}
serializedVersion: 2

14
Editor/PackageChecker/com.unity.netcode.editor.packagechecker.asmdef Normal file
View File

@@ -0,0 +1,14 @@
{
"name": "Unity.Netcode.Editor.PackageChecker",
"rootNamespace": "Unity.Netcode.Editor.PackageChecker",
"includePlatforms": [
"Editor"
],
"versionDefines": [
{
"name": "com.unity.netcode.adapter.utp",
"expression": "",
"define": "COM_UNITY_NETCODE_ADAPTER_UTP"
}
]
}

7
Editor/PackageChecker/com.unity.netcode.editor.packagechecker.asmdef.meta Normal file
View File

@@ -0,0 +1,7 @@
fileFormatVersion: 2
guid: de64d7f9ca85d4bf59c8c24738bc1057
AssemblyDefinitionImporter:
externalObjects: {}
userData:
assetBundleName:
assetBundleVariant: