8060718e04
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.3.1] - 2023-03-27 ### Added - Added detection and graceful handling of corrupt packets for additional safety. (#2419) ### Changed - The UTP component UI has been updated to be more user-friendly for new users by adding a simple toggle to switch between local-only (127.0.0.1) and remote (0.0.0.0) binding modes, using the toggle "Allow Remote Connections" (#2408) - Updated `UnityTransport` dependency on `com.unity.transport` to 1.3.3. (#2450) - `NetworkShow()` of `NetworkObject`s are delayed until the end of the frame to ensure consistency of delta-driven variables like `NetworkList`. - Dirty `NetworkObject` are reset at end-of-frame and not at serialization time. - `NetworkHide()` of an object that was just `NetworkShow()`n produces a warning, as remote clients will _not_ get a spawn/despawn pair. - Renamed the NetworkTransform.SetState parameter `shouldGhostsInterpolate` to `teleportDisabled` for better clarity of what that parameter does. (#2228) - Network prefabs are now stored in a ScriptableObject that can be shared between NetworkManagers, and have been exposed for public access. By default, a Default Prefabs List is created that contains all NetworkObject prefabs in the project, and new NetworkManagers will default to using that unless that option is turned off in the Netcode for GameObjects settings. Existing NetworkManagers will maintain their existing lists, which can be migrated to the new format via a button in their inspector. (#2322) ### Fixed - Fixed issue where changes to a layer's weight would not synchronize unless a state transition was occurring.(#2399) - Fixed issue where `NetworkManager.LocalClientId` was returning the `NetworkTransport.ServerClientId` as opposed to the `NetworkManager.m_LocalClientId`. (#2398) - Fixed issue where a dynamically spawned `NetworkObject` parented under an in-scene placed `NetworkObject` would have its `InScenePlaced` value changed to `true`. This would result in a soft synchronization error for late joining clients. (#2396) - Fixed a UTP test that was failing when you install Unity Transport package 2.0.0 or newer. (#2347) - Fixed issue where `NetcodeSettingsProvider` would throw an exception in Unity 2020.3.x versions. (#2345) - Fixed server side issue where, depending upon component ordering, some NetworkBehaviour components might not have their OnNetworkDespawn method invoked if the client side disconnected. (#2323) - Fixed a case where data corruption could occur when using UnityTransport when reaching a certain level of send throughput. (#2332) - Fixed an issue in `UnityTransport` where an exception would be thrown if starting a Relay host/server on WebGL. This exception should only be thrown if using direct connections (where WebGL can't act as a host/server). (#2321) - Fixed `NetworkAnimator` issue where it was not checking for `AnimatorStateTtansition.destinationStateMachine` and any possible sub-states defined within it. (#2309) - Fixed `NetworkAnimator` issue where the host client was receiving the ClientRpc animation updates when the host was the owner.(#2309) - Fixed `NetworkAnimator` issue with using pooled objects and when specific properties are cleaned during despawn and destroy.(#2309) - Fixed issue where `NetworkAnimator` was checking for animation changes when the associated `NetworkObject` was not spawned.(#2309) - Corrected an issue with the documentation for BufferSerializer (#2401)
411 lines
19 KiB
C#
411 lines
19 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using UnityEditor;
|
|
using UnityEngine;
|
|
using Unity.Netcode.Editor.Configuration;
|
|
|
|
namespace Unity.Netcode.Editor
|
|
{
|
|
/// <summary>
|
|
/// This <see cref="CustomEditor"/> handles the translation between the <see cref="NetworkConfig"/> and
|
|
/// the <see cref="NetworkManager"/> properties.
|
|
/// </summary>
|
|
[CustomEditor(typeof(NetworkManager), true)]
|
|
[CanEditMultipleObjects]
|
|
public class NetworkManagerEditor : UnityEditor.Editor
|
|
{
|
|
private static GUIStyle s_CenteredWordWrappedLabelStyle;
|
|
private static GUIStyle s_HelpBoxStyle;
|
|
|
|
// Properties
|
|
private SerializedProperty m_RunInBackgroundProperty;
|
|
private SerializedProperty m_LogLevelProperty;
|
|
|
|
// NetworkConfig
|
|
private SerializedProperty m_NetworkConfigProperty;
|
|
|
|
// NetworkConfig fields
|
|
private SerializedProperty m_PlayerPrefabProperty;
|
|
private SerializedProperty m_ProtocolVersionProperty;
|
|
private SerializedProperty m_NetworkTransportProperty;
|
|
private SerializedProperty m_TickRateProperty;
|
|
private SerializedProperty m_MaxObjectUpdatesPerTickProperty;
|
|
private SerializedProperty m_ClientConnectionBufferTimeoutProperty;
|
|
private SerializedProperty m_ConnectionApprovalProperty;
|
|
private SerializedProperty m_EnsureNetworkVariableLengthSafetyProperty;
|
|
private SerializedProperty m_ForceSamePrefabsProperty;
|
|
private SerializedProperty m_EnableSceneManagementProperty;
|
|
private SerializedProperty m_RecycleNetworkIdsProperty;
|
|
private SerializedProperty m_NetworkIdRecycleDelayProperty;
|
|
private SerializedProperty m_RpcHashSizeProperty;
|
|
private SerializedProperty m_LoadSceneTimeOutProperty;
|
|
private SerializedProperty m_PrefabsList;
|
|
|
|
private NetworkManager m_NetworkManager;
|
|
private bool m_Initialized;
|
|
|
|
private readonly List<Type> m_TransportTypes = new List<Type>();
|
|
private string[] m_TransportNames = { "Select transport..." };
|
|
|
|
private void ReloadTransports()
|
|
{
|
|
m_TransportTypes.Clear();
|
|
|
|
var assemblies = AppDomain.CurrentDomain.GetAssemblies();
|
|
|
|
foreach (var assembly in assemblies)
|
|
{
|
|
var types = assembly.GetTypes();
|
|
|
|
foreach (var type in types)
|
|
{
|
|
if (type.IsSubclassOf(typeof(NetworkTransport)) && !type.IsSubclassOf(typeof(TestingNetworkTransport)) && type != typeof(TestingNetworkTransport))
|
|
{
|
|
m_TransportTypes.Add(type);
|
|
}
|
|
}
|
|
}
|
|
|
|
m_TransportNames = new string[m_TransportTypes.Count + 1];
|
|
m_TransportNames[0] = "Select transport...";
|
|
|
|
for (int i = 0; i < m_TransportTypes.Count; i++)
|
|
{
|
|
m_TransportNames[i + 1] = m_TransportTypes[i].Name;
|
|
}
|
|
}
|
|
|
|
private void Initialize()
|
|
{
|
|
if (m_Initialized)
|
|
{
|
|
return;
|
|
}
|
|
|
|
m_Initialized = true;
|
|
m_NetworkManager = (NetworkManager)target;
|
|
|
|
// Base properties
|
|
m_RunInBackgroundProperty = serializedObject.FindProperty(nameof(NetworkManager.RunInBackground));
|
|
m_LogLevelProperty = serializedObject.FindProperty(nameof(NetworkManager.LogLevel));
|
|
m_NetworkConfigProperty = serializedObject.FindProperty(nameof(NetworkManager.NetworkConfig));
|
|
|
|
// NetworkConfig properties
|
|
m_PlayerPrefabProperty = m_NetworkConfigProperty.FindPropertyRelative(nameof(NetworkConfig.PlayerPrefab));
|
|
m_ProtocolVersionProperty = m_NetworkConfigProperty.FindPropertyRelative("ProtocolVersion");
|
|
m_NetworkTransportProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTransport");
|
|
m_TickRateProperty = m_NetworkConfigProperty.FindPropertyRelative("TickRate");
|
|
m_ClientConnectionBufferTimeoutProperty = m_NetworkConfigProperty.FindPropertyRelative("ClientConnectionBufferTimeout");
|
|
m_ConnectionApprovalProperty = m_NetworkConfigProperty.FindPropertyRelative("ConnectionApproval");
|
|
m_EnsureNetworkVariableLengthSafetyProperty = m_NetworkConfigProperty.FindPropertyRelative("EnsureNetworkVariableLengthSafety");
|
|
m_ForceSamePrefabsProperty = m_NetworkConfigProperty.FindPropertyRelative("ForceSamePrefabs");
|
|
m_EnableSceneManagementProperty = m_NetworkConfigProperty.FindPropertyRelative("EnableSceneManagement");
|
|
m_RecycleNetworkIdsProperty = m_NetworkConfigProperty.FindPropertyRelative("RecycleNetworkIds");
|
|
m_NetworkIdRecycleDelayProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkIdRecycleDelay");
|
|
m_RpcHashSizeProperty = m_NetworkConfigProperty.FindPropertyRelative("RpcHashSize");
|
|
m_LoadSceneTimeOutProperty = m_NetworkConfigProperty.FindPropertyRelative("LoadSceneTimeOut");
|
|
m_PrefabsList = m_NetworkConfigProperty
|
|
.FindPropertyRelative(nameof(NetworkConfig.Prefabs))
|
|
.FindPropertyRelative(nameof(NetworkPrefabs.NetworkPrefabsLists));
|
|
|
|
ReloadTransports();
|
|
}
|
|
|
|
private void CheckNullProperties()
|
|
{
|
|
// Base properties
|
|
m_RunInBackgroundProperty = serializedObject.FindProperty(nameof(NetworkManager.RunInBackground));
|
|
m_LogLevelProperty = serializedObject.FindProperty(nameof(NetworkManager.LogLevel));
|
|
m_NetworkConfigProperty = serializedObject.FindProperty(nameof(NetworkManager.NetworkConfig));
|
|
|
|
// NetworkConfig properties
|
|
m_PlayerPrefabProperty = m_NetworkConfigProperty.FindPropertyRelative(nameof(NetworkConfig.PlayerPrefab));
|
|
m_ProtocolVersionProperty = m_NetworkConfigProperty.FindPropertyRelative("ProtocolVersion");
|
|
m_NetworkTransportProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTransport");
|
|
m_TickRateProperty = m_NetworkConfigProperty.FindPropertyRelative("TickRate");
|
|
m_ClientConnectionBufferTimeoutProperty = m_NetworkConfigProperty.FindPropertyRelative("ClientConnectionBufferTimeout");
|
|
m_ConnectionApprovalProperty = m_NetworkConfigProperty.FindPropertyRelative("ConnectionApproval");
|
|
m_EnsureNetworkVariableLengthSafetyProperty = m_NetworkConfigProperty.FindPropertyRelative("EnsureNetworkVariableLengthSafety");
|
|
m_ForceSamePrefabsProperty = m_NetworkConfigProperty.FindPropertyRelative("ForceSamePrefabs");
|
|
m_EnableSceneManagementProperty = m_NetworkConfigProperty.FindPropertyRelative("EnableSceneManagement");
|
|
m_RecycleNetworkIdsProperty = m_NetworkConfigProperty.FindPropertyRelative("RecycleNetworkIds");
|
|
m_NetworkIdRecycleDelayProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkIdRecycleDelay");
|
|
m_RpcHashSizeProperty = m_NetworkConfigProperty.FindPropertyRelative("RpcHashSize");
|
|
m_LoadSceneTimeOutProperty = m_NetworkConfigProperty.FindPropertyRelative("LoadSceneTimeOut");
|
|
m_PrefabsList = m_NetworkConfigProperty
|
|
.FindPropertyRelative(nameof(NetworkConfig.Prefabs))
|
|
.FindPropertyRelative(nameof(NetworkPrefabs.NetworkPrefabsLists));
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public override void OnInspectorGUI()
|
|
{
|
|
Initialize();
|
|
CheckNullProperties();
|
|
|
|
#if !MULTIPLAYER_TOOLS
|
|
DrawInstallMultiplayerToolsTip();
|
|
#endif
|
|
|
|
if (!m_NetworkManager.IsServer && !m_NetworkManager.IsClient)
|
|
{
|
|
serializedObject.Update();
|
|
EditorGUILayout.PropertyField(m_RunInBackgroundProperty);
|
|
EditorGUILayout.PropertyField(m_LogLevelProperty);
|
|
EditorGUILayout.Space();
|
|
|
|
EditorGUILayout.PropertyField(m_PlayerPrefabProperty);
|
|
EditorGUILayout.Space();
|
|
|
|
if (m_NetworkManager.NetworkConfig.HasOldPrefabList())
|
|
{
|
|
EditorGUILayout.HelpBox("Network Prefabs serialized in old format. Migrate to new format to edit the list.", MessageType.Info);
|
|
if (GUILayout.Button(new GUIContent("Migrate Prefab List", "Converts the old format Network Prefab list to a new Scriptable Object")))
|
|
{
|
|
// Default directory
|
|
var directory = "Assets/";
|
|
var assetPath = AssetDatabase.GetAssetPath(m_NetworkManager);
|
|
if (assetPath == "")
|
|
{
|
|
assetPath = PrefabUtility.GetPrefabAssetPathOfNearestInstanceRoot(m_NetworkManager);
|
|
}
|
|
|
|
if (assetPath != "")
|
|
{
|
|
directory = Path.GetDirectoryName(assetPath);
|
|
}
|
|
else
|
|
{
|
|
#if UNITY_2021_1_OR_NEWER
|
|
var prefabStage = UnityEditor.SceneManagement.PrefabStageUtility.GetPrefabStage(m_NetworkManager.gameObject);
|
|
#else
|
|
var prefabStage = UnityEditor.Experimental.SceneManagement.PrefabStageUtility.GetPrefabStage(m_NetworkManager.gameObject);
|
|
#endif
|
|
if (prefabStage != null)
|
|
{
|
|
var prefabPath = prefabStage.assetPath;
|
|
if (!string.IsNullOrEmpty(prefabPath))
|
|
{
|
|
directory = Path.GetDirectoryName(prefabPath);
|
|
}
|
|
}
|
|
if (m_NetworkManager.gameObject.scene != null)
|
|
{
|
|
var scenePath = m_NetworkManager.gameObject.scene.path;
|
|
if (!string.IsNullOrEmpty(scenePath))
|
|
{
|
|
directory = Path.GetDirectoryName(scenePath);
|
|
}
|
|
}
|
|
}
|
|
var networkPrefabs = m_NetworkManager.NetworkConfig.MigrateOldNetworkPrefabsToNetworkPrefabsList();
|
|
string path = Path.Combine(directory, $"NetworkPrefabs-{m_NetworkManager.GetInstanceID()}.asset");
|
|
Debug.Log("Saving migrated Network Prefabs List to " + path);
|
|
AssetDatabase.CreateAsset(networkPrefabs, path);
|
|
EditorUtility.SetDirty(m_NetworkManager);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (m_NetworkManager.NetworkConfig.Prefabs.NetworkPrefabsLists.Count == 0)
|
|
{
|
|
EditorGUILayout.HelpBox("You have no prefab list selected. You will have to add your prefabs manually at runtime for netcode to work.", MessageType.Warning);
|
|
}
|
|
EditorGUILayout.PropertyField(m_PrefabsList);
|
|
}
|
|
EditorGUILayout.Space();
|
|
|
|
EditorGUILayout.LabelField("General", EditorStyles.boldLabel);
|
|
EditorGUILayout.PropertyField(m_ProtocolVersionProperty);
|
|
|
|
EditorGUILayout.PropertyField(m_NetworkTransportProperty);
|
|
|
|
if (m_NetworkTransportProperty.objectReferenceValue == null)
|
|
{
|
|
EditorGUILayout.HelpBox("You have no transport selected. A transport is required for netcode to work. Which one do you want?", MessageType.Warning);
|
|
|
|
int selection = EditorGUILayout.Popup(0, m_TransportNames);
|
|
|
|
if (selection > 0)
|
|
{
|
|
ReloadTransports();
|
|
|
|
var transportComponent = m_NetworkManager.gameObject.GetComponent(m_TransportTypes[selection - 1]);
|
|
|
|
if (transportComponent == null)
|
|
{
|
|
transportComponent = m_NetworkManager.gameObject.AddComponent(m_TransportTypes[selection - 1]);
|
|
}
|
|
|
|
m_NetworkTransportProperty.objectReferenceValue = transportComponent;
|
|
|
|
Repaint();
|
|
}
|
|
}
|
|
|
|
EditorGUILayout.PropertyField(m_TickRateProperty);
|
|
|
|
EditorGUILayout.LabelField("Performance", EditorStyles.boldLabel);
|
|
|
|
EditorGUILayout.PropertyField(m_EnsureNetworkVariableLengthSafetyProperty);
|
|
|
|
EditorGUILayout.LabelField("Connection", EditorStyles.boldLabel);
|
|
EditorGUILayout.PropertyField(m_ConnectionApprovalProperty);
|
|
|
|
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.ConnectionApproval))
|
|
{
|
|
EditorGUILayout.PropertyField(m_ClientConnectionBufferTimeoutProperty);
|
|
}
|
|
|
|
EditorGUILayout.LabelField("Spawning", EditorStyles.boldLabel);
|
|
EditorGUILayout.PropertyField(m_ForceSamePrefabsProperty);
|
|
|
|
|
|
EditorGUILayout.PropertyField(m_RecycleNetworkIdsProperty);
|
|
|
|
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.RecycleNetworkIds))
|
|
{
|
|
EditorGUILayout.PropertyField(m_NetworkIdRecycleDelayProperty);
|
|
}
|
|
|
|
EditorGUILayout.LabelField("Bandwidth", EditorStyles.boldLabel);
|
|
EditorGUILayout.PropertyField(m_RpcHashSizeProperty);
|
|
|
|
EditorGUILayout.LabelField("Scene Management", EditorStyles.boldLabel);
|
|
EditorGUILayout.PropertyField(m_EnableSceneManagementProperty);
|
|
|
|
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.EnableSceneManagement))
|
|
{
|
|
EditorGUILayout.PropertyField(m_LoadSceneTimeOutProperty);
|
|
}
|
|
|
|
serializedObject.ApplyModifiedProperties();
|
|
|
|
|
|
// Start buttons below
|
|
{
|
|
string buttonDisabledReasonSuffix = "";
|
|
|
|
if (!EditorApplication.isPlaying)
|
|
{
|
|
buttonDisabledReasonSuffix = ". This can only be done in play mode";
|
|
GUI.enabled = false;
|
|
}
|
|
|
|
if (GUILayout.Button(new GUIContent("Start Host", "Starts a host instance" + buttonDisabledReasonSuffix)))
|
|
{
|
|
m_NetworkManager.StartHost();
|
|
}
|
|
|
|
if (GUILayout.Button(new GUIContent("Start Server", "Starts a server instance" + buttonDisabledReasonSuffix)))
|
|
{
|
|
m_NetworkManager.StartServer();
|
|
}
|
|
|
|
if (GUILayout.Button(new GUIContent("Start Client", "Starts a client instance" + buttonDisabledReasonSuffix)))
|
|
{
|
|
m_NetworkManager.StartClient();
|
|
}
|
|
|
|
if (!EditorApplication.isPlaying)
|
|
{
|
|
GUI.enabled = true;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
string instanceType = string.Empty;
|
|
|
|
if (m_NetworkManager.IsHost)
|
|
{
|
|
instanceType = "Host";
|
|
}
|
|
else if (m_NetworkManager.IsServer)
|
|
{
|
|
instanceType = "Server";
|
|
}
|
|
else if (m_NetworkManager.IsClient)
|
|
{
|
|
instanceType = "Client";
|
|
}
|
|
|
|
EditorGUILayout.HelpBox("You cannot edit the NetworkConfig when a " + instanceType + " is running.", MessageType.Info);
|
|
|
|
if (GUILayout.Button(new GUIContent("Stop " + instanceType, "Stops the " + instanceType + " instance.")))
|
|
{
|
|
m_NetworkManager.Shutdown();
|
|
}
|
|
}
|
|
}
|
|
|
|
private static void DrawInstallMultiplayerToolsTip()
|
|
{
|
|
const string getToolsText = "Access additional tools for multiplayer development by installing the Multiplayer Tools package in the Package Manager.";
|
|
const string openDocsButtonText = "Open Docs";
|
|
const string dismissButtonText = "Dismiss";
|
|
const string targetUrl = "https://docs-multiplayer.unity3d.com/netcode/current/tools/install-tools";
|
|
const string infoIconName = "console.infoicon";
|
|
|
|
if (NetcodeForGameObjectsEditorSettings.GetNetcodeInstallMultiplayerToolTips() != 0)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (s_CenteredWordWrappedLabelStyle == null)
|
|
{
|
|
s_CenteredWordWrappedLabelStyle = new GUIStyle(GUI.skin.label);
|
|
s_CenteredWordWrappedLabelStyle.wordWrap = true;
|
|
s_CenteredWordWrappedLabelStyle.alignment = TextAnchor.MiddleLeft;
|
|
}
|
|
|
|
if (s_HelpBoxStyle == null)
|
|
{
|
|
s_HelpBoxStyle = new GUIStyle(EditorStyles.helpBox);
|
|
s_HelpBoxStyle.padding = new RectOffset(10, 10, 10, 10);
|
|
}
|
|
|
|
var openDocsButtonStyle = GUI.skin.button;
|
|
var dismissButtonStyle = EditorStyles.linkLabel;
|
|
|
|
GUILayout.BeginHorizontal();
|
|
GUILayout.FlexibleSpace();
|
|
GUILayout.BeginHorizontal(s_HelpBoxStyle, GUILayout.ExpandWidth(true), GUILayout.ExpandHeight(false), GUILayout.MaxWidth(800));
|
|
{
|
|
GUILayout.Label(new GUIContent(EditorGUIUtility.IconContent(infoIconName)), GUILayout.ExpandWidth(false), GUILayout.ExpandHeight(true));
|
|
GUILayout.Space(4);
|
|
GUILayout.Label(getToolsText, s_CenteredWordWrappedLabelStyle, GUILayout.ExpandHeight(true));
|
|
|
|
GUILayout.Space(4);
|
|
|
|
GUILayout.BeginVertical();
|
|
GUILayout.FlexibleSpace();
|
|
if (GUILayout.Button(openDocsButtonText, openDocsButtonStyle, GUILayout.Width(90), GUILayout.Height(30)))
|
|
{
|
|
Application.OpenURL(targetUrl);
|
|
}
|
|
GUILayout.FlexibleSpace();
|
|
GUILayout.EndVertical();
|
|
|
|
GUILayout.Space(4);
|
|
|
|
GUILayout.BeginVertical();
|
|
GUILayout.FlexibleSpace();
|
|
if (GUILayout.Button(dismissButtonText, dismissButtonStyle, GUILayout.ExpandWidth(false)))
|
|
{
|
|
NetcodeForGameObjectsEditorSettings.SetNetcodeInstallMultiplayerToolTips(1);
|
|
}
|
|
EditorGUIUtility.AddCursorRect(GUILayoutUtility.GetLastRect(), MouseCursor.Link);
|
|
GUILayout.FlexibleSpace();
|
|
GUILayout.EndVertical();
|
|
}
|
|
GUILayout.EndHorizontal();
|
|
GUILayout.FlexibleSpace();
|
|
GUILayout.EndHorizontal();
|
|
|
|
GUILayout.Space(10);
|
|
}
|
|
}
|
|
}
|