From 2fd3011d31d6936104e1f86d7498e5548eeeeb81 Mon Sep 17 00:00:00 2001 From: Stedd Date: Sat, 2 Sep 2023 11:14:39 +0200 Subject: [PATCH] Added Mirror --- Assets/Mirror.meta | 8 + Assets/Mirror/Authenticators.meta | 8 + .../Authenticators/BasicAuthenticator.cs | 192 ++ .../Authenticators/BasicAuthenticator.cs.meta | 11 + .../Authenticators/DeviceAuthenticator.cs | 129 ++ .../DeviceAuthenticator.cs.meta | 11 + .../Mirror.Authenticators.asmdef | 16 + .../Mirror.Authenticators.asmdef.meta | 7 + .../Authenticators/TimeoutAuthenticator.cs | 70 + .../TimeoutAuthenticator.cs.meta | 11 + Assets/Mirror/CompilerSymbols.meta | 8 + .../Mirror.CompilerSymbols.asmdef | 14 + .../Mirror.CompilerSymbols.asmdef.meta | 7 + .../CompilerSymbols/PreprocessorDefine.cs | 43 + .../PreprocessorDefine.cs.meta | 11 + Assets/Mirror/Components.meta | 8 + Assets/Mirror/Components/AssemblyInfo.cs | 12 + Assets/Mirror/Components/AssemblyInfo.cs.meta | 11 + Assets/Mirror/Components/Discovery.meta | 8 + .../Components/Discovery/NetworkDiscovery.cs | 93 + .../Discovery/NetworkDiscovery.cs.meta | 11 + .../Discovery/NetworkDiscoveryBase.cs | 469 +++++ .../Discovery/NetworkDiscoveryBase.cs.meta | 11 + .../Discovery/NetworkDiscoveryHUD.cs | 132 ++ .../Discovery/NetworkDiscoveryHUD.cs.meta | 11 + .../Components/Discovery/ServerRequest.cs | 4 + .../Discovery/ServerRequest.cs.meta | 11 + .../Components/Discovery/ServerResponse.cs | 18 + .../Discovery/ServerResponse.cs.meta | 11 + Assets/Mirror/Components/Experimental.meta | 8 + .../Experimental/NetworkLerpRigidbody.cs | 90 + .../Experimental/NetworkLerpRigidbody.cs.meta | 11 + .../Experimental/NetworkRigidbody.cs | 347 +++ .../Experimental/NetworkRigidbody.cs.meta | 11 + .../Experimental/NetworkRigidbody2D.cs | 342 +++ .../Experimental/NetworkRigidbody2D.cs.meta | 11 + Assets/Mirror/Components/GUIConsole.cs | 115 + Assets/Mirror/Components/GUIConsole.cs.meta | 11 + .../Mirror/Components/InterestManagement.meta | 8 + .../InterestManagement/Distance.meta | 3 + .../Distance/DistanceInterestManagement.cs | 90 + .../DistanceInterestManagement.cs.meta | 11 + .../DistanceInterestManagementCustomRange.cs | 15 + ...tanceInterestManagementCustomRange.cs.meta | 11 + .../Components/InterestManagement/Match.meta | 3 + .../Match/MatchInterestManagement.cs | 174 ++ .../Match/MatchInterestManagement.cs.meta | 11 + .../InterestManagement/Match/NetworkMatch.cs | 15 + .../Match/NetworkMatch.cs.meta | 11 + .../Components/InterestManagement/Scene.meta | 3 + .../Scene/SceneInterestManagement.cs | 118 ++ .../Scene/SceneInterestManagement.cs.meta | 11 + .../InterestManagement/SpatialHashing.meta | 3 + .../SpatialHashing/Grid2D.cs | 104 + .../SpatialHashing/Grid2D.cs.meta | 11 + .../SpatialHashingInterestManagement.cs | 154 ++ .../SpatialHashingInterestManagement.cs.meta | 11 + .../Components/InterestManagement/Team.meta | 8 + .../InterestManagement/Team/NetworkTeam.cs | 17 + .../Team/NetworkTeam.cs.meta | 11 + .../Team/TeamInterestManagement.cs | 196 ++ .../Team/TeamInterestManagement.cs.meta | 11 + Assets/Mirror/Components/LagCompensation.meta | 8 + .../LagCompensation/HistoryCollider.cs | 107 + .../LagCompensation/HistoryCollider.cs.meta | 11 + .../Components/Mirror.Components.asmdef | 16 + .../Components/Mirror.Components.asmdef.meta | 7 + Assets/Mirror/Components/NetworkAnimator.cs | 619 ++++++ .../Mirror/Components/NetworkAnimator.cs.meta | 11 + .../Mirror/Components/NetworkLobbyManager.cs | 18 + .../Components/NetworkLobbyManager.cs.meta | 11 + .../Mirror/Components/NetworkLobbyPlayer.cs | 15 + .../Components/NetworkLobbyPlayer.cs.meta | 11 + .../Mirror/Components/NetworkPingDisplay.cs | 39 + .../Components/NetworkPingDisplay.cs.meta | 11 + .../Mirror/Components/NetworkRigidbody.meta | 3 + .../NetworkRigidbodyReliable.cs | 97 + .../NetworkRigidbodyReliable.cs.meta | 11 + .../NetworkRigidbodyReliable2D.cs | 97 + .../NetworkRigidbodyReliable2D.cs.meta | 11 + .../NetworkRigidbodyUnreliable.cs | 97 + .../NetworkRigidbodyUnreliable.cs.meta | 11 + .../NetworkRigidbodyUnreliable2D.cs | 97 + .../NetworkRigidbodyUnreliable2D.cs.meta | 11 + .../Mirror/Components/NetworkRoomManager.cs | 684 ++++++ .../Components/NetworkRoomManager.cs.meta | 11 + Assets/Mirror/Components/NetworkRoomPlayer.cs | 195 ++ .../Components/NetworkRoomPlayer.cs.meta | 11 + Assets/Mirror/Components/NetworkStatistics.cs | 194 ++ .../Components/NetworkStatistics.cs.meta | 11 + .../Mirror/Components/NetworkTransform.meta | 3 + .../NetworkTransform/NetworkTransform.cs | 8 + .../NetworkTransform/NetworkTransform.cs.meta | 11 + .../NetworkTransform/NetworkTransformBase.cs | 475 +++++ .../NetworkTransformBase.cs.meta | 11 + .../NetworkTransform/NetworkTransformChild.cs | 12 + .../NetworkTransformChild.cs.meta | 11 + .../NetworkTransformReliable.cs | 423 ++++ .../NetworkTransformReliable.cs.meta | 11 + .../NetworkTransformUnreliable.cs | 382 ++++ .../NetworkTransformUnreliable.cs.meta | 11 + .../NetworkTransform/TransformSnapshot.cs | 65 + .../TransformSnapshot.cs.meta | 11 + Assets/Mirror/Components/RemoteStatistics.cs | 441 ++++ .../Components/RemoteStatistics.cs.meta | 11 + Assets/Mirror/Core.meta | 8 + Assets/Mirror/Core/AssemblyInfo.cs | 12 + Assets/Mirror/Core/AssemblyInfo.cs.meta | 11 + Assets/Mirror/Core/Attributes.cs | 85 + Assets/Mirror/Core/Attributes.cs.meta | 11 + Assets/Mirror/Core/Batching.meta | 8 + Assets/Mirror/Core/Batching/Batcher.cs | 150 ++ Assets/Mirror/Core/Batching/Batcher.cs.meta | 11 + Assets/Mirror/Core/Batching/Unbatcher.cs | 129 ++ Assets/Mirror/Core/Batching/Unbatcher.cs.meta | 11 + Assets/Mirror/Core/ConnectionQuality.cs | 68 + Assets/Mirror/Core/ConnectionQuality.cs.meta | 11 + Assets/Mirror/Core/Empty.meta | 3 + Assets/Mirror/Core/Empty/ClientScene.cs | 1 + Assets/Mirror/Core/Empty/ClientScene.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud.meta | 8 + .../Mirror/Core/Empty/Cloud/ApiConnector.cs | 1 + .../Core/Empty/Cloud/ApiConnector.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/ApiUpdater.cs | 1 + .../Core/Empty/Cloud/ApiUpdater.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/Ball.cs | 1 + Assets/Mirror/Core/Empty/Cloud/Ball.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/BallManager.cs | 1 + .../Core/Empty/Cloud/BallManager.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/BaseApi.cs | 1 + .../Mirror/Core/Empty/Cloud/BaseApi.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/Events.cs | 1 + Assets/Mirror/Core/Empty/Cloud/Events.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/Extensions.cs | 1 + .../Core/Empty/Cloud/Extensions.cs.meta | 11 + .../Core/Empty/Cloud/ICoroutineRunner.cs | 1 + .../Core/Empty/Cloud/ICoroutineRunner.cs.meta | 11 + .../Core/Empty/Cloud/IRequestCreator.cs | 1 + .../Core/Empty/Cloud/IRequestCreator.cs.meta | 11 + .../Core/Empty/Cloud/IUnityEqualCheck.cs | 1 + .../Core/Empty/Cloud/IUnityEqualCheck.cs.meta | 11 + .../Empty/Cloud/InstantiateNetworkManager.cs | 1 + .../Cloud/InstantiateNetworkManager.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/JsonStructs.cs | 1 + .../Core/Empty/Cloud/JsonStructs.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/ListServer.cs | 1 + .../Core/Empty/Cloud/ListServer.cs.meta | 11 + .../Core/Empty/Cloud/ListServerBaseApi.cs | 1 + .../Empty/Cloud/ListServerBaseApi.cs.meta | 11 + .../Core/Empty/Cloud/ListServerClientApi.cs | 1 + .../Empty/Cloud/ListServerClientApi.cs.meta | 11 + .../Mirror/Core/Empty/Cloud/ListServerJson.cs | 1 + .../Core/Empty/Cloud/ListServerJson.cs.meta | 11 + .../Core/Empty/Cloud/ListServerServerApi.cs | 1 + .../Empty/Cloud/ListServerServerApi.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/Logger.cs | 1 + Assets/Mirror/Core/Empty/Cloud/Logger.cs.meta | 11 + .../Empty/Cloud/NetworkManagerListServer.cs | 1 + .../Cloud/NetworkManagerListServer.cs.meta | 11 + .../Cloud/NetworkManagerListServerPong.cs | 1 + .../NetworkManagerListServerPong.cs.meta | 11 + Assets/Mirror/Core/Empty/Cloud/Player.cs | 1 + Assets/Mirror/Core/Empty/Cloud/Player.cs.meta | 11 + .../Core/Empty/Cloud/QuickListServerDebug.cs | 1 + .../Empty/Cloud/QuickListServerDebug.cs.meta | 11 + .../Mirror/Core/Empty/Cloud/QuitButtonHUD.cs | 1 + .../Core/Empty/Cloud/QuitButtonHUD.cs.meta | 11 + .../Mirror/Core/Empty/Cloud/RequestCreator.cs | 1 + .../Core/Empty/Cloud/RequestCreator.cs.meta | 11 + .../Core/Empty/Cloud/ServerListManager.cs | 1 + .../Empty/Cloud/ServerListManager.cs.meta | 11 + .../Mirror/Core/Empty/Cloud/ServerListUI.cs | 1 + .../Core/Empty/Cloud/ServerListUI.cs.meta | 11 + .../Core/Empty/Cloud/ServerListUIItem.cs | 1 + .../Core/Empty/Cloud/ServerListUIItem.cs.meta | 11 + .../Mirror/Core/Empty/DotNetCompatibility.cs | 1 + .../Core/Empty/DotNetCompatibility.cs.meta | 11 + Assets/Mirror/Core/Empty/FallbackTransport.cs | 1 + .../Core/Empty/FallbackTransport.cs.meta | 11 + Assets/Mirror/Core/Empty/LogFactory.cs | 1 + Assets/Mirror/Core/Empty/LogFactory.cs.meta | 11 + Assets/Mirror/Core/Empty/LogFilter.cs | 1 + Assets/Mirror/Core/Empty/LogFilter.cs.meta | 11 + Assets/Mirror/Core/Empty/Logging.meta | 8 + .../Empty/Logging/ConsoleColorLogHandler.cs | 1 + .../Logging/ConsoleColorLogHandler.cs.meta | 11 + .../Empty/Logging/EditorLogSettingsLoader.cs | 1 + .../Logging/EditorLogSettingsLoader.cs.meta | 11 + .../Mirror/Core/Empty/Logging/LogFactory.cs | 1 + .../Core/Empty/Logging/LogFactory.cs.meta | 11 + .../Mirror/Core/Empty/Logging/LogSettings.cs | 2 + .../Core/Empty/Logging/LogSettings.cs.meta | 11 + .../Empty/Logging/NetworkHeadlessLogger.cs | 1 + .../Logging/NetworkHeadlessLogger.cs.meta | 11 + .../Core/Empty/Logging/NetworkLogSettings.cs | 1 + .../Empty/Logging/NetworkLogSettings.cs.meta | 11 + .../Mirror/Core/Empty/NetworkMatchChecker.cs | 1 + .../Core/Empty/NetworkMatchChecker.cs.meta | 11 + .../Mirror/Core/Empty/NetworkOwnerChecker.cs | 1 + .../Core/Empty/NetworkOwnerChecker.cs.meta | 11 + .../Core/Empty/NetworkProximityChecker.cs | 1 + .../Empty/NetworkProximityChecker.cs.meta | 11 + .../Mirror/Core/Empty/NetworkSceneChecker.cs | 1 + .../Core/Empty/NetworkSceneChecker.cs.meta | 11 + .../Mirror/Core/Empty/NetworkTransformBase.cs | 1 + .../Core/Empty/NetworkTransformBase.cs.meta | 11 + Assets/Mirror/Core/Empty/NetworkVisibility.cs | 1 + .../Core/Empty/NetworkVisibility.cs.meta | 11 + Assets/Mirror/Core/Empty/StringHash.cs | 1 + Assets/Mirror/Core/Empty/StringHash.cs.meta | 11 + Assets/Mirror/Core/Empty/SyncVar.cs | 1 + Assets/Mirror/Core/Empty/SyncVar.cs.meta | 11 + Assets/Mirror/Core/Empty/SyncVarGameObject.cs | 1 + .../Core/Empty/SyncVarGameObject.cs.meta | 11 + .../Core/Empty/SyncVarNetworkBehaviour.cs | 1 + .../Empty/SyncVarNetworkBehaviour.cs.meta | 11 + .../Core/Empty/SyncVarNetworkIdentity.cs | 1 + .../Core/Empty/SyncVarNetworkIdentity.cs.meta | 11 + Assets/Mirror/Core/HostMode.cs | 48 + Assets/Mirror/Core/HostMode.cs.meta | 11 + Assets/Mirror/Core/InterestManagement.cs | 146 ++ Assets/Mirror/Core/InterestManagement.cs.meta | 11 + Assets/Mirror/Core/InterestManagementBase.cs | 84 + .../Core/InterestManagementBase.cs.meta | 11 + Assets/Mirror/Core/LagCompensation.meta | 3 + Assets/Mirror/Core/LagCompensation/Capture.cs | 13 + .../Core/LagCompensation/Capture.cs.meta | 3 + .../Core/LagCompensation/HistoryBounds.cs | 139 ++ .../LagCompensation/HistoryBounds.cs.meta | 3 + .../Core/LagCompensation/LagCompensation.cs | 144 ++ .../LagCompensation/LagCompensation.cs.meta | 3 + .../LagCompensationSettings.cs | 19 + .../LagCompensationSettings.cs.meta | 3 + .../Core/LagCompensation/MinMaxBounds.cs | 61 + .../Core/LagCompensation/MinMaxBounds.cs.meta | 3 + Assets/Mirror/Core/LocalConnectionToClient.cs | 50 + .../Core/LocalConnectionToClient.cs.meta | 11 + Assets/Mirror/Core/LocalConnectionToServer.cs | 128 ++ .../Core/LocalConnectionToServer.cs.meta | 11 + Assets/Mirror/Core/Messages.cs | 122 ++ Assets/Mirror/Core/Messages.cs.meta | 11 + Assets/Mirror/Core/Mirror.asmdef | 16 + Assets/Mirror/Core/Mirror.asmdef.meta | 7 + Assets/Mirror/Core/NetworkAuthenticator.cs | 84 + .../Mirror/Core/NetworkAuthenticator.cs.meta | 11 + Assets/Mirror/Core/NetworkBehaviour.cs | 1361 ++++++++++++ Assets/Mirror/Core/NetworkBehaviour.cs.meta | 11 + Assets/Mirror/Core/NetworkBehaviourSyncVar.cs | 33 + .../Core/NetworkBehaviourSyncVar.cs.meta | 11 + Assets/Mirror/Core/NetworkClient.cs | 1725 +++++++++++++++ Assets/Mirror/Core/NetworkClient.cs.meta | 11 + .../Core/NetworkClient_TimeInterpolation.cs | 183 ++ .../NetworkClient_TimeInterpolation.cs.meta | 11 + Assets/Mirror/Core/NetworkConnection.cs | 206 ++ Assets/Mirror/Core/NetworkConnection.cs.meta | 11 + .../Mirror/Core/NetworkConnectionToClient.cs | 223 ++ .../Core/NetworkConnectionToClient.cs.meta | 11 + .../Mirror/Core/NetworkConnectionToServer.cs | 24 + .../Core/NetworkConnectionToServer.cs.meta | 11 + Assets/Mirror/Core/NetworkDiagnostics.cs | 63 + Assets/Mirror/Core/NetworkDiagnostics.cs.meta | 11 + Assets/Mirror/Core/NetworkIdentity.cs | 1384 ++++++++++++ Assets/Mirror/Core/NetworkIdentity.cs.meta | 11 + Assets/Mirror/Core/NetworkLoop.cs | 210 ++ Assets/Mirror/Core/NetworkLoop.cs.meta | 11 + Assets/Mirror/Core/NetworkManager.cs | 1467 +++++++++++++ Assets/Mirror/Core/NetworkManager.cs.meta | 11 + Assets/Mirror/Core/NetworkManagerHUD.cs | 155 ++ Assets/Mirror/Core/NetworkManagerHUD.cs.meta | 11 + Assets/Mirror/Core/NetworkMessage.cs | 4 + Assets/Mirror/Core/NetworkMessage.cs.meta | 11 + Assets/Mirror/Core/NetworkMessages.cs | 185 ++ Assets/Mirror/Core/NetworkMessages.cs.meta | 11 + Assets/Mirror/Core/NetworkReader.cs | 249 +++ Assets/Mirror/Core/NetworkReader.cs.meta | 11 + Assets/Mirror/Core/NetworkReaderExtensions.cs | 376 ++++ .../Core/NetworkReaderExtensions.cs.meta | 11 + Assets/Mirror/Core/NetworkReaderPool.cs | 45 + Assets/Mirror/Core/NetworkReaderPool.cs.meta | 11 + Assets/Mirror/Core/NetworkReaderPooled.cs | 15 + .../Mirror/Core/NetworkReaderPooled.cs.meta | 11 + Assets/Mirror/Core/NetworkServer.cs | 1864 +++++++++++++++++ Assets/Mirror/Core/NetworkServer.cs.meta | 11 + Assets/Mirror/Core/NetworkStartPosition.cs | 21 + .../Mirror/Core/NetworkStartPosition.cs.meta | 11 + Assets/Mirror/Core/NetworkTime.cs | 166 ++ Assets/Mirror/Core/NetworkTime.cs.meta | 11 + Assets/Mirror/Core/NetworkWriter.cs | 249 +++ Assets/Mirror/Core/NetworkWriter.cs.meta | 11 + Assets/Mirror/Core/NetworkWriterExtensions.cs | 415 ++++ .../Core/NetworkWriterExtensions.cs.meta | 11 + Assets/Mirror/Core/NetworkWriterPool.cs | 37 + Assets/Mirror/Core/NetworkWriterPool.cs.meta | 11 + Assets/Mirror/Core/NetworkWriterPooled.cs | 13 + .../Mirror/Core/NetworkWriterPooled.cs.meta | 11 + Assets/Mirror/Core/PortTransport.cs | 13 + Assets/Mirror/Core/PortTransport.cs.meta | 11 + Assets/Mirror/Core/RemoteCalls.cs | 138 ++ Assets/Mirror/Core/RemoteCalls.cs.meta | 11 + Assets/Mirror/Core/SnapshotInterpolation.meta | 8 + .../Core/SnapshotInterpolation/Snapshot.cs | 17 + .../SnapshotInterpolation/Snapshot.cs.meta | 11 + .../SnapshotInterpolation.cs | 390 ++++ .../SnapshotInterpolation.cs.meta | 11 + .../SnapshotInterpolationSettings.cs | 70 + .../SnapshotInterpolationSettings.cs.meta | 3 + .../SnapshotInterpolation/TimeSnapshot.cs | 15 + .../TimeSnapshot.cs.meta | 11 + Assets/Mirror/Core/SyncDictionary.cs | 326 +++ Assets/Mirror/Core/SyncDictionary.cs.meta | 11 + Assets/Mirror/Core/SyncList.cs | 420 ++++ Assets/Mirror/Core/SyncList.cs.meta | 11 + Assets/Mirror/Core/SyncObject.cs | 53 + Assets/Mirror/Core/SyncObject.cs.meta | 11 + Assets/Mirror/Core/SyncSet.cs | 352 ++++ Assets/Mirror/Core/SyncSet.cs.meta | 11 + Assets/Mirror/Core/Tools.meta | 3 + Assets/Mirror/Core/Tools/AccurateInterval.cs | 86 + .../Core/Tools/AccurateInterval.cs.meta | 11 + Assets/Mirror/Core/Tools/Compression.cs | 556 +++++ Assets/Mirror/Core/Tools/Compression.cs.meta | 11 + Assets/Mirror/Core/Tools/DeltaCompression.cs | 38 + .../Core/Tools/DeltaCompression.cs.meta | 11 + .../Core/Tools/ExponentialMovingAverage.cs | 53 + .../Tools/ExponentialMovingAverage.cs.meta | 11 + Assets/Mirror/Core/Tools/Extensions.cs | 64 + Assets/Mirror/Core/Tools/Extensions.cs.meta | 11 + Assets/Mirror/Core/Tools/Mathd.cs | 32 + Assets/Mirror/Core/Tools/Mathd.cs.meta | 11 + Assets/Mirror/Core/Tools/Pool.cs | 40 + Assets/Mirror/Core/Tools/Pool.cs.meta | 11 + Assets/Mirror/Core/Tools/Readme.txt | 1 + Assets/Mirror/Core/Tools/Readme.txt.meta | 3 + Assets/Mirror/Core/Tools/TimeSample.cs | 61 + Assets/Mirror/Core/Tools/TimeSample.cs.meta | 11 + Assets/Mirror/Core/Tools/Utils.cs | 188 ++ Assets/Mirror/Core/Tools/Utils.cs.meta | 11 + Assets/Mirror/Core/Tools/Vector3Long.cs | 125 ++ Assets/Mirror/Core/Tools/Vector3Long.cs.meta | 11 + Assets/Mirror/Core/Transport.cs | 191 ++ Assets/Mirror/Core/Transport.cs.meta | 11 + Assets/Mirror/Core/TransportError.cs | 17 + Assets/Mirror/Core/TransportError.cs.meta | 11 + Assets/Mirror/Core/WeaverFuse.cs | 22 + Assets/Mirror/Core/WeaverFuse.cs.meta | 3 + Assets/Mirror/Editor.meta | 8 + Assets/Mirror/Editor/AndroidManifestHelper.cs | 113 + .../Editor/AndroidManifestHelper.cs.meta | 11 + Assets/Mirror/Editor/EditorHelper.cs | 31 + Assets/Mirror/Editor/EditorHelper.cs.meta | 11 + Assets/Mirror/Editor/Empty.meta | 8 + .../Empty/EnterPlayModeSettingsCheck.cs | 1 + .../Empty/EnterPlayModeSettingsCheck.cs.meta | 11 + Assets/Mirror/Editor/Empty/LogLevelWindow.cs | 1 + .../Editor/Empty/LogLevelWindow.cs.meta | 11 + Assets/Mirror/Editor/Empty/Logging.meta | 8 + .../Editor/Empty/Logging/LogLevelWindow.cs | 1 + .../Empty/Logging/LogLevelWindow.cs.meta | 11 + .../Editor/Empty/Logging/LogLevelsGUI.cs | 1 + .../Editor/Empty/Logging/LogLevelsGUI.cs.meta | 11 + .../Editor/Empty/Logging/LogSettingsEditor.cs | 1 + .../Empty/Logging/LogSettingsEditor.cs.meta | 11 + .../Empty/Logging/NetworkLogSettingsEditor.cs | 1 + .../Logging/NetworkLogSettingsEditor.cs.meta | 11 + .../Editor/Empty/ScriptableObjectUtility.cs | 1 + .../Empty/ScriptableObjectUtility.cs.meta | 11 + Assets/Mirror/Editor/Empty/SyncVarDrawer.cs | 1 + .../Mirror/Editor/Empty/SyncVarDrawer.cs.meta | 3 + Assets/Mirror/Editor/Icon.meta | 8 + Assets/Mirror/Editor/Icon/MirrorIcon.png | Bin 0 -> 138247 bytes Assets/Mirror/Editor/Icon/MirrorIcon.png.meta | 110 + Assets/Mirror/Editor/InspectorHelper.cs | 77 + Assets/Mirror/Editor/InspectorHelper.cs.meta | 11 + Assets/Mirror/Editor/Mirror.Editor.asmdef | 19 + .../Mirror/Editor/Mirror.Editor.asmdef.meta | 7 + .../Editor/NetworkBehaviourInspector.cs | 104 + .../Editor/NetworkBehaviourInspector.cs.meta | 11 + .../Editor/NetworkInformationPreview.cs | 305 +++ .../Editor/NetworkInformationPreview.cs.meta | 11 + Assets/Mirror/Editor/NetworkManagerEditor.cs | 108 + .../Editor/NetworkManagerEditor.cs.meta | 11 + .../Mirror/Editor/NetworkScenePostProcess.cs | 98 + .../Editor/NetworkScenePostProcess.cs.meta | 11 + Assets/Mirror/Editor/SceneDrawer.cs | 47 + Assets/Mirror/Editor/SceneDrawer.cs.meta | 11 + .../Editor/SyncObjectCollectionsDrawer.cs | 83 + .../SyncObjectCollectionsDrawer.cs.meta | 3 + .../Mirror/Editor/SyncVarAttributeDrawer.cs | 28 + .../Editor/SyncVarAttributeDrawer.cs.meta | 11 + Assets/Mirror/Editor/Weaver.meta | 8 + Assets/Mirror/Editor/Weaver/AssemblyInfo.cs | 3 + .../Mirror/Editor/Weaver/AssemblyInfo.cs.meta | 11 + Assets/Mirror/Editor/Weaver/Empty.meta | 8 + .../Weaver/Empty/GenericArgumentResolver.cs | 1 + .../Empty/GenericArgumentResolver.cs.meta | 11 + .../Weaver/Empty/MessageClassProcessor.cs | 1 + .../Empty/MessageClassProcessor.cs.meta | 11 + Assets/Mirror/Editor/Weaver/Empty/Program.cs | 1 + .../Editor/Weaver/Empty/Program.cs.meta | 11 + .../Weaver/Empty/SyncDictionaryProcessor.cs | 1 + .../Empty/SyncDictionaryProcessor.cs.meta | 11 + .../Editor/Weaver/Empty/SyncEventProcessor.cs | 1 + .../Weaver/Empty/SyncEventProcessor.cs.meta | 11 + .../Editor/Weaver/Empty/SyncListProcessor.cs | 1 + .../Weaver/Empty/SyncListProcessor.cs.meta | 11 + Assets/Mirror/Editor/Weaver/EntryPoint.meta | 3 + .../EntryPoint/CompilationFinishedHook.cs | 188 ++ .../CompilationFinishedHook.cs.meta | 11 + .../EntryPoint/CompilationFinishedLogger.cs | 31 + .../CompilationFinishedLogger.cs.meta | 3 + .../Weaver/EntryPoint/EnterPlayModeHook.cs | 44 + .../EntryPoint/EnterPlayModeHook.cs.meta | 3 + .../Weaver/EntryPointILPostProcessor.meta | 3 + .../CompiledAssemblyFromFile.cs | 31 + .../CompiledAssemblyFromFile.cs.meta | 3 + .../ILPostProcessorAssemblyResolver.cs | 199 ++ .../ILPostProcessorAssemblyResolver.cs.meta | 3 + .../ILPostProcessorFromFile.cs | 53 + .../ILPostProcessorFromFile.cs.meta | 3 + .../ILPostProcessorHook.cs | 143 ++ .../ILPostProcessorHook.cs.meta | 3 + .../ILPostProcessorLogger.cs | 67 + .../ILPostProcessorLogger.cs.meta | 3 + .../ILPostProcessorReflectionImporter.cs | 36 + .../ILPostProcessorReflectionImporter.cs.meta | 3 + ...PostProcessorReflectionImporterProvider.cs | 16 + ...rocessorReflectionImporterProvider.cs.meta | 3 + Assets/Mirror/Editor/Weaver/Extensions.cs | 359 ++++ .../Mirror/Editor/Weaver/Extensions.cs.meta | 11 + Assets/Mirror/Editor/Weaver/Helpers.cs | 26 + Assets/Mirror/Editor/Weaver/Helpers.cs.meta | 11 + Assets/Mirror/Editor/Weaver/Logger.cs | 13 + Assets/Mirror/Editor/Weaver/Logger.cs.meta | 11 + Assets/Mirror/Editor/Weaver/Processors.meta | 8 + .../Weaver/Processors/CommandProcessor.cs | 130 ++ .../Processors/CommandProcessor.cs.meta | 11 + .../Weaver/Processors/MethodProcessor.cs | 139 ++ .../Weaver/Processors/MethodProcessor.cs.meta | 11 + .../Processors/MonoBehaviourProcessor.cs | 56 + .../Processors/MonoBehaviourProcessor.cs.meta | 11 + .../Processors/NetworkBehaviourProcessor.cs | 1041 +++++++++ .../NetworkBehaviourProcessor.cs.meta | 11 + .../Processors/ReaderWriterProcessor.cs | 216 ++ .../Processors/ReaderWriterProcessor.cs.meta | 11 + .../Editor/Weaver/Processors/RpcProcessor.cs | 104 + .../Weaver/Processors/RpcProcessor.cs.meta | 11 + .../ServerClientAttributeProcessor.cs | 163 ++ .../ServerClientAttributeProcessor.cs.meta | 11 + .../Processors/SyncObjectInitializer.cs | 39 + .../Processors/SyncObjectInitializer.cs.meta | 11 + .../Weaver/Processors/SyncObjectProcessor.cs | 90 + .../Processors/SyncObjectProcessor.cs.meta | 11 + .../SyncVarAttributeAccessReplacer.cs | 206 ++ .../SyncVarAttributeAccessReplacer.cs.meta | 11 + .../Processors/SyncVarAttributeProcessor.cs | 490 +++++ .../SyncVarAttributeProcessor.cs.meta | 11 + .../Weaver/Processors/TargetRpcProcessor.cs | 159 ++ .../Processors/TargetRpcProcessor.cs.meta | 11 + Assets/Mirror/Editor/Weaver/Readers.cs | 385 ++++ Assets/Mirror/Editor/Weaver/Readers.cs.meta | 11 + Assets/Mirror/Editor/Weaver/Resolvers.cs | 94 + Assets/Mirror/Editor/Weaver/Resolvers.cs.meta | 11 + .../Editor/Weaver/SyncVarAccessLists.cs | 32 + .../Editor/Weaver/SyncVarAccessLists.cs.meta | 3 + .../Editor/Weaver/TypeReferenceComparer.cs | 15 + .../Weaver/TypeReferenceComparer.cs.meta | 11 + .../Editor/Weaver/Unity.Mirror.CodeGen.asmdef | 21 + .../Weaver/Unity.Mirror.CodeGen.asmdef.meta | 7 + Assets/Mirror/Editor/Weaver/Weaver.cs | 269 +++ Assets/Mirror/Editor/Weaver/Weaver.cs.meta | 11 + .../Mirror/Editor/Weaver/WeaverExceptions.cs | 26 + .../Editor/Weaver/WeaverExceptions.cs.meta | 11 + Assets/Mirror/Editor/Weaver/WeaverTypes.cs | 171 ++ .../Mirror/Editor/Weaver/WeaverTypes.cs.meta | 3 + Assets/Mirror/Editor/Weaver/Writers.cs | 341 +++ Assets/Mirror/Editor/Weaver/Writers.cs.meta | 11 + Assets/Mirror/Editor/Welcome.cs | 23 + Assets/Mirror/Editor/Welcome.cs.meta | 11 + Assets/Mirror/Notice.txt | 123 ++ Assets/Mirror/Notice.txt.meta | 7 + Assets/Mirror/Plugins.meta | 8 + Assets/Mirror/Plugins/Mono.Cecil.meta | 8 + Assets/Mirror/Plugins/Mono.Cecil/License.txt | 25 + .../Plugins/Mono.Cecil/License.txt.meta | 7 + .../Plugins/Mono.Cecil/Mono.CecilX.Mdb.dll | Bin 0 -> 43520 bytes .../Mono.Cecil/Mono.CecilX.Mdb.dll.meta | 92 + .../Plugins/Mono.Cecil/Mono.CecilX.Pdb.dll | Bin 0 -> 87552 bytes .../Mono.Cecil/Mono.CecilX.Pdb.dll.meta | 92 + .../Plugins/Mono.Cecil/Mono.CecilX.Rocks.dll | Bin 0 -> 27648 bytes .../Mono.Cecil/Mono.CecilX.Rocks.dll.meta | 92 + .../Mirror/Plugins/Mono.Cecil/Mono.CecilX.dll | Bin 0 -> 340992 bytes .../Plugins/Mono.Cecil/Mono.CecilX.dll.meta | 94 + Assets/Mirror/Presets.meta | 8 + Assets/Mirror/Presets/NetworkTransform.meta | 8 + .../ClientAuth-Balanced.preset | 124 ++ .../ClientAuth-Balanced.preset.meta | 8 + .../ClientAuth-FastPaced.preset | 124 ++ .../ClientAuth-FastPaced.preset.meta | 8 + .../ClientAuth-VeryCasual.preset | 124 ++ .../ClientAuth-VeryCasual.preset.meta | 8 + Assets/Mirror/Readme.txt | 15 + Assets/Mirror/Readme.txt.meta | 7 + Assets/Mirror/Transports.meta | 8 + Assets/Mirror/Transports/KCP.meta | 8 + Assets/Mirror/Transports/KCP/KcpTransport.cs | 366 ++++ .../Transports/KCP/KcpTransport.cs.meta | 11 + Assets/Mirror/Transports/KCP/kcp2k.meta | 8 + Assets/Mirror/Transports/KCP/kcp2k/KCP.asmdef | 16 + .../Transports/KCP/kcp2k/KCP.asmdef.meta | 7 + .../Mirror/Transports/KCP/kcp2k/LICENSE.txt | 24 + .../Transports/KCP/kcp2k/LICENSE.txt.meta | 7 + .../Mirror/Transports/KCP/kcp2k/VERSION.txt | 238 +++ .../Transports/KCP/kcp2k/VERSION.txt.meta | 7 + Assets/Mirror/Transports/KCP/kcp2k/empty.meta | 3 + .../KCP/kcp2k/empty/KcpClientConnection.cs | 1 + .../kcp2k/empty/KcpClientConnection.cs.meta | 3 + .../empty/KcpClientConnectionNonAlloc.cs | 1 + .../empty/KcpClientConnectionNonAlloc.cs.meta | 3 + .../KCP/kcp2k/empty/KcpClientNonAlloc.cs | 1 + .../KCP/kcp2k/empty/KcpClientNonAlloc.cs.meta | 3 + .../empty/KcpServerConnectionNonAlloc.cs | 1 + .../empty/KcpServerConnectionNonAlloc.cs.meta | 3 + .../KCP/kcp2k/empty/KcpServerNonAlloc.cs | 1 + .../KCP/kcp2k/empty/KcpServerNonAlloc.cs.meta | 3 + .../Transports/KCP/kcp2k/highlevel.meta | 8 + .../Transports/KCP/kcp2k/highlevel/Common.cs | 75 + .../KCP/kcp2k/highlevel/Common.cs.meta | 3 + .../KCP/kcp2k/highlevel/ErrorCode.cs | 15 + .../KCP/kcp2k/highlevel/ErrorCode.cs.meta | 3 + .../KCP/kcp2k/highlevel/Extensions.cs | 166 ++ .../KCP/kcp2k/highlevel/Extensions.cs.meta | 3 + .../KCP/kcp2k/highlevel/KcpChannel.cs | 10 + .../KCP/kcp2k/highlevel/KcpChannel.cs.meta | 3 + .../KCP/kcp2k/highlevel/KcpClient.cs | 226 ++ .../KCP/kcp2k/highlevel/KcpClient.cs.meta | 3 + .../KCP/kcp2k/highlevel/KcpConfig.cs | 97 + .../KCP/kcp2k/highlevel/KcpConfig.cs.meta | 3 + .../KCP/kcp2k/highlevel/KcpHeader.cs | 19 + .../KCP/kcp2k/highlevel/KcpHeader.cs.meta | 3 + .../Transports/KCP/kcp2k/highlevel/KcpPeer.cs | 819 ++++++++ .../KCP/kcp2k/highlevel/KcpPeer.cs.meta | 3 + .../KCP/kcp2k/highlevel/KcpServer.cs | 377 ++++ .../KCP/kcp2k/highlevel/KcpServer.cs.meta | 3 + .../kcp2k/highlevel/KcpServerConnection.cs | 22 + .../highlevel/KcpServerConnection.cs.meta | 3 + .../Transports/KCP/kcp2k/highlevel/Log.cs | 14 + .../KCP/kcp2k/highlevel/Log.cs.meta | 11 + Assets/Mirror/Transports/KCP/kcp2k/kcp.meta | 8 + .../Transports/KCP/kcp2k/kcp/AckItem.cs | 8 + .../Transports/KCP/kcp2k/kcp/AckItem.cs.meta | 11 + .../Transports/KCP/kcp2k/kcp/AssemblyInfo.cs | 3 + .../KCP/kcp2k/kcp/AssemblyInfo.cs.meta | 3 + Assets/Mirror/Transports/KCP/kcp2k/kcp/Kcp.cs | 1118 ++++++++++ .../Transports/KCP/kcp2k/kcp/Kcp.cs.meta | 11 + .../Mirror/Transports/KCP/kcp2k/kcp/Pool.cs | 46 + .../Transports/KCP/kcp2k/kcp/Pool.cs.meta | 11 + .../Transports/KCP/kcp2k/kcp/Segment.cs | 78 + .../Transports/KCP/kcp2k/kcp/Segment.cs.meta | 11 + .../Mirror/Transports/KCP/kcp2k/kcp/Utils.cs | 76 + .../Transports/KCP/kcp2k/kcp/Utils.cs.meta | 11 + Assets/Mirror/Transports/Latency.meta | 8 + .../Transports/Latency/LatencySimulation.cs | 319 +++ .../Latency/LatencySimulation.cs.meta | 11 + Assets/Mirror/Transports/Middleware.meta | 8 + .../Middleware/MiddlewareTransport.cs | 61 + .../Middleware/MiddlewareTransport.cs.meta | 11 + .../Transports/Mirror.Transports.asmdef | 19 + .../Transports/Mirror.Transports.asmdef.meta | 7 + Assets/Mirror/Transports/Multiplex.meta | 8 + .../Multiplex/MultiplexTransport.cs | 331 +++ .../Multiplex/MultiplexTransport.cs.meta | 11 + Assets/Mirror/Transports/SimpleWeb.meta | 8 + .../Transports/SimpleWeb/SimpleWeb.meta | 8 + .../SimpleWeb/SimpleWeb/AssemblyInfo.cs | 7 + .../SimpleWeb/SimpleWeb/AssemblyInfo.cs.meta | 11 + .../SimpleWeb/SimpleWeb/CHANGELOG.md | 48 + .../SimpleWeb/SimpleWeb/CHANGELOG.md.meta | 7 + .../SimpleWeb/SimpleWeb/Client.meta | 8 + .../SimpleWeb/Client/SimpleWebClient.cs | 102 + .../SimpleWeb/Client/SimpleWebClient.cs.meta | 11 + .../SimpleWeb/Client/StandAlone.meta | 8 + .../Client/StandAlone/ClientHandshake.cs | 88 + .../Client/StandAlone/ClientHandshake.cs.meta | 11 + .../Client/StandAlone/ClientSslHelper.cs | 47 + .../Client/StandAlone/ClientSslHelper.cs.meta | 11 + .../StandAlone/WebSocketClientStandAlone.cs | 140 ++ .../WebSocketClientStandAlone.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Client/Webgl.meta | 8 + .../SimpleWeb/Client/Webgl/SimpleWebJSLib.cs | 34 + .../Client/Webgl/SimpleWebJSLib.cs.meta | 11 + .../Client/Webgl/WebSocketClientWebGl.cs | 144 ++ .../Client/Webgl/WebSocketClientWebGl.cs.meta | 11 + .../SimpleWeb/Client/Webgl/plugin.meta | 8 + .../Client/Webgl/plugin/SimpleWeb.jslib | 114 + .../Client/Webgl/plugin/SimpleWeb.jslib.meta | 37 + .../SimpleWeb/SimpleWeb/Common.meta | 8 + .../SimpleWeb/SimpleWeb/Common/BufferPool.cs | 249 +++ .../SimpleWeb/Common/BufferPool.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/Connection.cs | 133 ++ .../SimpleWeb/Common/Connection.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/Constants.cs | 77 + .../SimpleWeb/Common/Constants.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/EventType.cs | 10 + .../SimpleWeb/Common/EventType.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/Log.cs | 108 + .../SimpleWeb/SimpleWeb/Common/Log.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/Message.cs | 49 + .../SimpleWeb/Common/Message.cs.meta | 11 + .../SimpleWeb/Common/MessageProcessor.cs | 175 ++ .../SimpleWeb/Common/MessageProcessor.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/ReadHelper.cs | 123 ++ .../SimpleWeb/Common/ReadHelper.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/ReceiveLoop.cs | 254 +++ .../SimpleWeb/Common/ReceiveLoop.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/Request.cs | 26 + .../SimpleWeb/Common/Request.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/SendLoop.cs | 225 ++ .../SimpleWeb/Common/SendLoop.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/TcpConfig.cs | 26 + .../SimpleWeb/Common/TcpConfig.cs.meta | 11 + .../SimpleWeb/SimpleWeb/Common/Utils.cs | 13 + .../SimpleWeb/SimpleWeb/Common/Utils.cs.meta | 11 + .../Transports/SimpleWeb/SimpleWeb/LICENSE | 21 + .../SimpleWeb/SimpleWeb/LICENSE.meta | 7 + .../Transports/SimpleWeb/SimpleWeb/README.txt | 19 + .../SimpleWeb/SimpleWeb/README.txt.meta | 7 + .../SimpleWeb/SimpleWeb/Server.meta | 8 + .../SimpleWeb/Server/ServerHandshake.cs | 156 ++ .../SimpleWeb/Server/ServerHandshake.cs.meta | 11 + .../SimpleWeb/Server/ServerSslHelper.cs | 82 + .../SimpleWeb/Server/ServerSslHelper.cs.meta | 11 + .../SimpleWeb/Server/SimpleWebServer.cs | 117 ++ .../SimpleWeb/Server/SimpleWebServer.cs.meta | 11 + .../SimpleWeb/Server/WebSocketServer.cs | 264 +++ .../SimpleWeb/Server/WebSocketServer.cs.meta | 11 + .../SimpleWeb/SimpleWebTransport.asmdef | 14 + .../SimpleWeb/SimpleWebTransport.asmdef.meta | 7 + .../SimpleWeb/SimpleWeb/SslConfigLoader.cs | 49 + .../SimpleWeb/SslConfigLoader.cs.meta | 11 + .../SimpleWeb/SimpleWebTransport.cs | 304 +++ .../SimpleWeb/SimpleWebTransport.cs.meta | 11 + Assets/Mirror/Transports/Telepathy.meta | 8 + .../Transports/Telepathy/Telepathy.meta | 8 + .../Transports/Telepathy/Telepathy/Client.cs | 361 ++++ .../Telepathy/Telepathy/Client.cs.meta | 11 + .../Transports/Telepathy/Telepathy/Common.cs | 39 + .../Telepathy/Telepathy/Common.cs.meta | 11 + .../Telepathy/Telepathy/ConnectionState.cs | 35 + .../Telepathy/ConnectionState.cs.meta | 11 + .../Transports/Telepathy/Telepathy/Empty.meta | 8 + .../Telepathy/Telepathy/Empty/Logger.cs | 1 + .../Telepathy/Telepathy/Empty/Logger.cs.meta | 11 + .../Telepathy/Telepathy/Empty/Message.cs | 1 + .../Telepathy/Telepathy/Empty/Message.cs.meta | 11 + .../Telepathy/Telepathy/Empty/SafeQueue.cs | 1 + .../Telepathy/Empty/SafeQueue.cs.meta | 11 + .../Telepathy/Empty/ThreadExtensions.cs | 1 + .../Telepathy/Empty/ThreadExtensions.cs.meta | 11 + .../Telepathy/Telepathy/EventType.cs | 9 + .../Telepathy/Telepathy/EventType.cs.meta | 11 + .../Transports/Telepathy/Telepathy/LICENSE | 21 + .../Telepathy/Telepathy/LICENSE.meta | 7 + .../Transports/Telepathy/Telepathy/Log.cs | 15 + .../Telepathy/Telepathy/Log.cs.meta | 11 + .../Telepathy/MagnificentReceivePipe.cs | 222 ++ .../Telepathy/MagnificentReceivePipe.cs.meta | 11 + .../Telepathy/MagnificentSendPipe.cs | 165 ++ .../Telepathy/MagnificentSendPipe.cs.meta | 11 + .../Telepathy/NetworkStreamExtensions.cs | 67 + .../Telepathy/NetworkStreamExtensions.cs.meta | 11 + .../Transports/Telepathy/Telepathy/Pool.cs | 34 + .../Telepathy/Telepathy/Pool.cs.meta | 11 + .../Transports/Telepathy/Telepathy/Server.cs | 402 ++++ .../Telepathy/Telepathy/Server.cs.meta | 11 + .../Telepathy/Telepathy/Telepathy.asmdef | 12 + .../Telepathy/Telepathy/Telepathy.asmdef.meta | 7 + .../Telepathy/Telepathy/ThreadFunctions.cs | 244 +++ .../Telepathy/ThreadFunctions.cs.meta | 11 + .../Transports/Telepathy/Telepathy/Utils.cs | 23 + .../Telepathy/Telepathy/Utils.cs.meta | 11 + .../Transports/Telepathy/Telepathy/VERSION | 62 + .../Telepathy/Telepathy/VERSION.meta | 7 + .../Telepathy/TelepathyTransport.cs | 274 +++ .../Telepathy/TelepathyTransport.cs.meta | 11 + Assets/Mirror/Version.txt | 1 + Assets/Mirror/Version.txt.meta | 7 + 686 files changed, 43191 insertions(+) create mode 100644 Assets/Mirror.meta create mode 100644 Assets/Mirror/Authenticators.meta create mode 100644 Assets/Mirror/Authenticators/BasicAuthenticator.cs create mode 100644 Assets/Mirror/Authenticators/BasicAuthenticator.cs.meta create mode 100644 Assets/Mirror/Authenticators/DeviceAuthenticator.cs create mode 100644 Assets/Mirror/Authenticators/DeviceAuthenticator.cs.meta create mode 100644 Assets/Mirror/Authenticators/Mirror.Authenticators.asmdef create mode 100644 Assets/Mirror/Authenticators/Mirror.Authenticators.asmdef.meta create mode 100644 Assets/Mirror/Authenticators/TimeoutAuthenticator.cs create mode 100644 Assets/Mirror/Authenticators/TimeoutAuthenticator.cs.meta create mode 100644 Assets/Mirror/CompilerSymbols.meta create mode 100644 Assets/Mirror/CompilerSymbols/Mirror.CompilerSymbols.asmdef create mode 100644 Assets/Mirror/CompilerSymbols/Mirror.CompilerSymbols.asmdef.meta create mode 100644 Assets/Mirror/CompilerSymbols/PreprocessorDefine.cs create mode 100644 Assets/Mirror/CompilerSymbols/PreprocessorDefine.cs.meta create mode 100644 Assets/Mirror/Components.meta create mode 100644 Assets/Mirror/Components/AssemblyInfo.cs create mode 100644 Assets/Mirror/Components/AssemblyInfo.cs.meta create mode 100644 Assets/Mirror/Components/Discovery.meta create mode 100644 Assets/Mirror/Components/Discovery/NetworkDiscovery.cs create mode 100644 Assets/Mirror/Components/Discovery/NetworkDiscovery.cs.meta create mode 100644 Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs create mode 100644 Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs.meta create mode 100644 Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs create mode 100644 Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs.meta create mode 100644 Assets/Mirror/Components/Discovery/ServerRequest.cs create mode 100644 Assets/Mirror/Components/Discovery/ServerRequest.cs.meta create mode 100644 Assets/Mirror/Components/Discovery/ServerResponse.cs create mode 100644 Assets/Mirror/Components/Discovery/ServerResponse.cs.meta create mode 100644 Assets/Mirror/Components/Experimental.meta create mode 100644 Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs create mode 100644 Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs.meta create mode 100644 Assets/Mirror/Components/Experimental/NetworkRigidbody.cs create mode 100644 Assets/Mirror/Components/Experimental/NetworkRigidbody.cs.meta create mode 100644 Assets/Mirror/Components/Experimental/NetworkRigidbody2D.cs create mode 100644 Assets/Mirror/Components/Experimental/NetworkRigidbody2D.cs.meta create mode 100644 Assets/Mirror/Components/GUIConsole.cs create mode 100644 Assets/Mirror/Components/GUIConsole.cs.meta create mode 100644 Assets/Mirror/Components/InterestManagement.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Distance.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagement.cs create mode 100644 Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagement.cs.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagementCustomRange.cs create mode 100644 Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagementCustomRange.cs.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Match.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Match/MatchInterestManagement.cs create mode 100644 Assets/Mirror/Components/InterestManagement/Match/MatchInterestManagement.cs.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Match/NetworkMatch.cs create mode 100644 Assets/Mirror/Components/InterestManagement/Match/NetworkMatch.cs.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Scene.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Scene/SceneInterestManagement.cs create mode 100644 Assets/Mirror/Components/InterestManagement/Scene/SceneInterestManagement.cs.meta create mode 100644 Assets/Mirror/Components/InterestManagement/SpatialHashing.meta create mode 100644 Assets/Mirror/Components/InterestManagement/SpatialHashing/Grid2D.cs create mode 100644 Assets/Mirror/Components/InterestManagement/SpatialHashing/Grid2D.cs.meta create mode 100644 Assets/Mirror/Components/InterestManagement/SpatialHashing/SpatialHashingInterestManagement.cs create mode 100644 Assets/Mirror/Components/InterestManagement/SpatialHashing/SpatialHashingInterestManagement.cs.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Team.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Team/NetworkTeam.cs create mode 100644 Assets/Mirror/Components/InterestManagement/Team/NetworkTeam.cs.meta create mode 100644 Assets/Mirror/Components/InterestManagement/Team/TeamInterestManagement.cs create mode 100644 Assets/Mirror/Components/InterestManagement/Team/TeamInterestManagement.cs.meta create mode 100644 Assets/Mirror/Components/LagCompensation.meta create mode 100644 Assets/Mirror/Components/LagCompensation/HistoryCollider.cs create mode 100644 Assets/Mirror/Components/LagCompensation/HistoryCollider.cs.meta create mode 100644 Assets/Mirror/Components/Mirror.Components.asmdef create mode 100644 Assets/Mirror/Components/Mirror.Components.asmdef.meta create mode 100644 Assets/Mirror/Components/NetworkAnimator.cs create mode 100644 Assets/Mirror/Components/NetworkAnimator.cs.meta create mode 100644 Assets/Mirror/Components/NetworkLobbyManager.cs create mode 100644 Assets/Mirror/Components/NetworkLobbyManager.cs.meta create mode 100644 Assets/Mirror/Components/NetworkLobbyPlayer.cs create mode 100644 Assets/Mirror/Components/NetworkLobbyPlayer.cs.meta create mode 100644 Assets/Mirror/Components/NetworkPingDisplay.cs create mode 100644 Assets/Mirror/Components/NetworkPingDisplay.cs.meta create mode 100644 Assets/Mirror/Components/NetworkRigidbody.meta create mode 100644 Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable.cs create mode 100644 Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable.cs.meta create mode 100644 Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable2D.cs create mode 100644 Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable2D.cs.meta create mode 100644 Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable.cs create mode 100644 Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable.cs.meta create mode 100644 Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable2D.cs create mode 100644 Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable2D.cs.meta create mode 100644 Assets/Mirror/Components/NetworkRoomManager.cs create mode 100644 Assets/Mirror/Components/NetworkRoomManager.cs.meta create mode 100644 Assets/Mirror/Components/NetworkRoomPlayer.cs create mode 100644 Assets/Mirror/Components/NetworkRoomPlayer.cs.meta create mode 100644 Assets/Mirror/Components/NetworkStatistics.cs create mode 100644 Assets/Mirror/Components/NetworkStatistics.cs.meta create mode 100644 Assets/Mirror/Components/NetworkTransform.meta create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransform.cs create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransform.cs.meta create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs.meta create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransformChild.cs create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransformChild.cs.meta create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransformReliable.cs create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransformReliable.cs.meta create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransformUnreliable.cs create mode 100644 Assets/Mirror/Components/NetworkTransform/NetworkTransformUnreliable.cs.meta create mode 100644 Assets/Mirror/Components/NetworkTransform/TransformSnapshot.cs create mode 100644 Assets/Mirror/Components/NetworkTransform/TransformSnapshot.cs.meta create mode 100644 Assets/Mirror/Components/RemoteStatistics.cs create mode 100644 Assets/Mirror/Components/RemoteStatistics.cs.meta create mode 100644 Assets/Mirror/Core.meta create mode 100644 Assets/Mirror/Core/AssemblyInfo.cs create mode 100644 Assets/Mirror/Core/AssemblyInfo.cs.meta create mode 100644 Assets/Mirror/Core/Attributes.cs create mode 100644 Assets/Mirror/Core/Attributes.cs.meta create mode 100644 Assets/Mirror/Core/Batching.meta create mode 100644 Assets/Mirror/Core/Batching/Batcher.cs create mode 100644 Assets/Mirror/Core/Batching/Batcher.cs.meta create mode 100644 Assets/Mirror/Core/Batching/Unbatcher.cs create mode 100644 Assets/Mirror/Core/Batching/Unbatcher.cs.meta create mode 100644 Assets/Mirror/Core/ConnectionQuality.cs create mode 100644 Assets/Mirror/Core/ConnectionQuality.cs.meta create mode 100644 Assets/Mirror/Core/Empty.meta create mode 100644 Assets/Mirror/Core/Empty/ClientScene.cs create mode 100644 Assets/Mirror/Core/Empty/ClientScene.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ApiConnector.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ApiConnector.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ApiUpdater.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ApiUpdater.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/Ball.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/Ball.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/BallManager.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/BallManager.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/BaseApi.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/BaseApi.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/Events.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/Events.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/Extensions.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/Extensions.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ICoroutineRunner.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ICoroutineRunner.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/IRequestCreator.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/IRequestCreator.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/IUnityEqualCheck.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/IUnityEqualCheck.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/InstantiateNetworkManager.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/InstantiateNetworkManager.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/JsonStructs.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/JsonStructs.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServer.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServer.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServerBaseApi.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServerBaseApi.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServerClientApi.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServerClientApi.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServerJson.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServerJson.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServerServerApi.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ListServerServerApi.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/Logger.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/Logger.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServer.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServer.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServerPong.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServerPong.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/Player.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/Player.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/QuickListServerDebug.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/QuickListServerDebug.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/QuitButtonHUD.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/QuitButtonHUD.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/RequestCreator.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/RequestCreator.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ServerListManager.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ServerListManager.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ServerListUI.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ServerListUI.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Cloud/ServerListUIItem.cs create mode 100644 Assets/Mirror/Core/Empty/Cloud/ServerListUIItem.cs.meta create mode 100644 Assets/Mirror/Core/Empty/DotNetCompatibility.cs create mode 100644 Assets/Mirror/Core/Empty/DotNetCompatibility.cs.meta create mode 100644 Assets/Mirror/Core/Empty/FallbackTransport.cs create mode 100644 Assets/Mirror/Core/Empty/FallbackTransport.cs.meta create mode 100644 Assets/Mirror/Core/Empty/LogFactory.cs create mode 100644 Assets/Mirror/Core/Empty/LogFactory.cs.meta create mode 100644 Assets/Mirror/Core/Empty/LogFilter.cs create mode 100644 Assets/Mirror/Core/Empty/LogFilter.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Logging.meta create mode 100644 Assets/Mirror/Core/Empty/Logging/ConsoleColorLogHandler.cs create mode 100644 Assets/Mirror/Core/Empty/Logging/ConsoleColorLogHandler.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Logging/EditorLogSettingsLoader.cs create mode 100644 Assets/Mirror/Core/Empty/Logging/EditorLogSettingsLoader.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Logging/LogFactory.cs create mode 100644 Assets/Mirror/Core/Empty/Logging/LogFactory.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Logging/LogSettings.cs create mode 100644 Assets/Mirror/Core/Empty/Logging/LogSettings.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Logging/NetworkHeadlessLogger.cs create mode 100644 Assets/Mirror/Core/Empty/Logging/NetworkHeadlessLogger.cs.meta create mode 100644 Assets/Mirror/Core/Empty/Logging/NetworkLogSettings.cs create mode 100644 Assets/Mirror/Core/Empty/Logging/NetworkLogSettings.cs.meta create mode 100644 Assets/Mirror/Core/Empty/NetworkMatchChecker.cs create mode 100644 Assets/Mirror/Core/Empty/NetworkMatchChecker.cs.meta create mode 100644 Assets/Mirror/Core/Empty/NetworkOwnerChecker.cs create mode 100644 Assets/Mirror/Core/Empty/NetworkOwnerChecker.cs.meta create mode 100644 Assets/Mirror/Core/Empty/NetworkProximityChecker.cs create mode 100644 Assets/Mirror/Core/Empty/NetworkProximityChecker.cs.meta create mode 100644 Assets/Mirror/Core/Empty/NetworkSceneChecker.cs create mode 100644 Assets/Mirror/Core/Empty/NetworkSceneChecker.cs.meta create mode 100644 Assets/Mirror/Core/Empty/NetworkTransformBase.cs create mode 100644 Assets/Mirror/Core/Empty/NetworkTransformBase.cs.meta create mode 100644 Assets/Mirror/Core/Empty/NetworkVisibility.cs create mode 100644 Assets/Mirror/Core/Empty/NetworkVisibility.cs.meta create mode 100644 Assets/Mirror/Core/Empty/StringHash.cs create mode 100644 Assets/Mirror/Core/Empty/StringHash.cs.meta create mode 100644 Assets/Mirror/Core/Empty/SyncVar.cs create mode 100644 Assets/Mirror/Core/Empty/SyncVar.cs.meta create mode 100644 Assets/Mirror/Core/Empty/SyncVarGameObject.cs create mode 100644 Assets/Mirror/Core/Empty/SyncVarGameObject.cs.meta create mode 100644 Assets/Mirror/Core/Empty/SyncVarNetworkBehaviour.cs create mode 100644 Assets/Mirror/Core/Empty/SyncVarNetworkBehaviour.cs.meta create mode 100644 Assets/Mirror/Core/Empty/SyncVarNetworkIdentity.cs create mode 100644 Assets/Mirror/Core/Empty/SyncVarNetworkIdentity.cs.meta create mode 100644 Assets/Mirror/Core/HostMode.cs create mode 100644 Assets/Mirror/Core/HostMode.cs.meta create mode 100644 Assets/Mirror/Core/InterestManagement.cs create mode 100644 Assets/Mirror/Core/InterestManagement.cs.meta create mode 100644 Assets/Mirror/Core/InterestManagementBase.cs create mode 100644 Assets/Mirror/Core/InterestManagementBase.cs.meta create mode 100644 Assets/Mirror/Core/LagCompensation.meta create mode 100644 Assets/Mirror/Core/LagCompensation/Capture.cs create mode 100644 Assets/Mirror/Core/LagCompensation/Capture.cs.meta create mode 100644 Assets/Mirror/Core/LagCompensation/HistoryBounds.cs create mode 100644 Assets/Mirror/Core/LagCompensation/HistoryBounds.cs.meta create mode 100644 Assets/Mirror/Core/LagCompensation/LagCompensation.cs create mode 100644 Assets/Mirror/Core/LagCompensation/LagCompensation.cs.meta create mode 100644 Assets/Mirror/Core/LagCompensation/LagCompensationSettings.cs create mode 100644 Assets/Mirror/Core/LagCompensation/LagCompensationSettings.cs.meta create mode 100644 Assets/Mirror/Core/LagCompensation/MinMaxBounds.cs create mode 100644 Assets/Mirror/Core/LagCompensation/MinMaxBounds.cs.meta create mode 100644 Assets/Mirror/Core/LocalConnectionToClient.cs create mode 100644 Assets/Mirror/Core/LocalConnectionToClient.cs.meta create mode 100644 Assets/Mirror/Core/LocalConnectionToServer.cs create mode 100644 Assets/Mirror/Core/LocalConnectionToServer.cs.meta create mode 100644 Assets/Mirror/Core/Messages.cs create mode 100644 Assets/Mirror/Core/Messages.cs.meta create mode 100644 Assets/Mirror/Core/Mirror.asmdef create mode 100644 Assets/Mirror/Core/Mirror.asmdef.meta create mode 100644 Assets/Mirror/Core/NetworkAuthenticator.cs create mode 100644 Assets/Mirror/Core/NetworkAuthenticator.cs.meta create mode 100644 Assets/Mirror/Core/NetworkBehaviour.cs create mode 100644 Assets/Mirror/Core/NetworkBehaviour.cs.meta create mode 100644 Assets/Mirror/Core/NetworkBehaviourSyncVar.cs create mode 100644 Assets/Mirror/Core/NetworkBehaviourSyncVar.cs.meta create mode 100644 Assets/Mirror/Core/NetworkClient.cs create mode 100644 Assets/Mirror/Core/NetworkClient.cs.meta create mode 100644 Assets/Mirror/Core/NetworkClient_TimeInterpolation.cs create mode 100644 Assets/Mirror/Core/NetworkClient_TimeInterpolation.cs.meta create mode 100644 Assets/Mirror/Core/NetworkConnection.cs create mode 100644 Assets/Mirror/Core/NetworkConnection.cs.meta create mode 100644 Assets/Mirror/Core/NetworkConnectionToClient.cs create mode 100644 Assets/Mirror/Core/NetworkConnectionToClient.cs.meta create mode 100644 Assets/Mirror/Core/NetworkConnectionToServer.cs create mode 100644 Assets/Mirror/Core/NetworkConnectionToServer.cs.meta create mode 100644 Assets/Mirror/Core/NetworkDiagnostics.cs create mode 100644 Assets/Mirror/Core/NetworkDiagnostics.cs.meta create mode 100644 Assets/Mirror/Core/NetworkIdentity.cs create mode 100644 Assets/Mirror/Core/NetworkIdentity.cs.meta create mode 100644 Assets/Mirror/Core/NetworkLoop.cs create mode 100644 Assets/Mirror/Core/NetworkLoop.cs.meta create mode 100644 Assets/Mirror/Core/NetworkManager.cs create mode 100644 Assets/Mirror/Core/NetworkManager.cs.meta create mode 100644 Assets/Mirror/Core/NetworkManagerHUD.cs create mode 100644 Assets/Mirror/Core/NetworkManagerHUD.cs.meta create mode 100644 Assets/Mirror/Core/NetworkMessage.cs create mode 100644 Assets/Mirror/Core/NetworkMessage.cs.meta create mode 100644 Assets/Mirror/Core/NetworkMessages.cs create mode 100644 Assets/Mirror/Core/NetworkMessages.cs.meta create mode 100644 Assets/Mirror/Core/NetworkReader.cs create mode 100644 Assets/Mirror/Core/NetworkReader.cs.meta create mode 100644 Assets/Mirror/Core/NetworkReaderExtensions.cs create mode 100644 Assets/Mirror/Core/NetworkReaderExtensions.cs.meta create mode 100644 Assets/Mirror/Core/NetworkReaderPool.cs create mode 100644 Assets/Mirror/Core/NetworkReaderPool.cs.meta create mode 100644 Assets/Mirror/Core/NetworkReaderPooled.cs create mode 100644 Assets/Mirror/Core/NetworkReaderPooled.cs.meta create mode 100644 Assets/Mirror/Core/NetworkServer.cs create mode 100644 Assets/Mirror/Core/NetworkServer.cs.meta create mode 100644 Assets/Mirror/Core/NetworkStartPosition.cs create mode 100644 Assets/Mirror/Core/NetworkStartPosition.cs.meta create mode 100644 Assets/Mirror/Core/NetworkTime.cs create mode 100644 Assets/Mirror/Core/NetworkTime.cs.meta create mode 100644 Assets/Mirror/Core/NetworkWriter.cs create mode 100644 Assets/Mirror/Core/NetworkWriter.cs.meta create mode 100644 Assets/Mirror/Core/NetworkWriterExtensions.cs create mode 100644 Assets/Mirror/Core/NetworkWriterExtensions.cs.meta create mode 100644 Assets/Mirror/Core/NetworkWriterPool.cs create mode 100644 Assets/Mirror/Core/NetworkWriterPool.cs.meta create mode 100644 Assets/Mirror/Core/NetworkWriterPooled.cs create mode 100644 Assets/Mirror/Core/NetworkWriterPooled.cs.meta create mode 100644 Assets/Mirror/Core/PortTransport.cs create mode 100644 Assets/Mirror/Core/PortTransport.cs.meta create mode 100644 Assets/Mirror/Core/RemoteCalls.cs create mode 100644 Assets/Mirror/Core/RemoteCalls.cs.meta create mode 100644 Assets/Mirror/Core/SnapshotInterpolation.meta create mode 100644 Assets/Mirror/Core/SnapshotInterpolation/Snapshot.cs create mode 100644 Assets/Mirror/Core/SnapshotInterpolation/Snapshot.cs.meta create mode 100644 Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolation.cs create mode 100644 Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolation.cs.meta create mode 100644 Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolationSettings.cs create mode 100644 Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolationSettings.cs.meta create mode 100644 Assets/Mirror/Core/SnapshotInterpolation/TimeSnapshot.cs create mode 100644 Assets/Mirror/Core/SnapshotInterpolation/TimeSnapshot.cs.meta create mode 100644 Assets/Mirror/Core/SyncDictionary.cs create mode 100644 Assets/Mirror/Core/SyncDictionary.cs.meta create mode 100644 Assets/Mirror/Core/SyncList.cs create mode 100644 Assets/Mirror/Core/SyncList.cs.meta create mode 100644 Assets/Mirror/Core/SyncObject.cs create mode 100644 Assets/Mirror/Core/SyncObject.cs.meta create mode 100644 Assets/Mirror/Core/SyncSet.cs create mode 100644 Assets/Mirror/Core/SyncSet.cs.meta create mode 100644 Assets/Mirror/Core/Tools.meta create mode 100644 Assets/Mirror/Core/Tools/AccurateInterval.cs create mode 100644 Assets/Mirror/Core/Tools/AccurateInterval.cs.meta create mode 100644 Assets/Mirror/Core/Tools/Compression.cs create mode 100644 Assets/Mirror/Core/Tools/Compression.cs.meta create mode 100644 Assets/Mirror/Core/Tools/DeltaCompression.cs create mode 100644 Assets/Mirror/Core/Tools/DeltaCompression.cs.meta create mode 100644 Assets/Mirror/Core/Tools/ExponentialMovingAverage.cs create mode 100644 Assets/Mirror/Core/Tools/ExponentialMovingAverage.cs.meta create mode 100644 Assets/Mirror/Core/Tools/Extensions.cs create mode 100644 Assets/Mirror/Core/Tools/Extensions.cs.meta create mode 100644 Assets/Mirror/Core/Tools/Mathd.cs create mode 100644 Assets/Mirror/Core/Tools/Mathd.cs.meta create mode 100644 Assets/Mirror/Core/Tools/Pool.cs create mode 100644 Assets/Mirror/Core/Tools/Pool.cs.meta create mode 100644 Assets/Mirror/Core/Tools/Readme.txt create mode 100644 Assets/Mirror/Core/Tools/Readme.txt.meta create mode 100644 Assets/Mirror/Core/Tools/TimeSample.cs create mode 100644 Assets/Mirror/Core/Tools/TimeSample.cs.meta create mode 100644 Assets/Mirror/Core/Tools/Utils.cs create mode 100644 Assets/Mirror/Core/Tools/Utils.cs.meta create mode 100644 Assets/Mirror/Core/Tools/Vector3Long.cs create mode 100644 Assets/Mirror/Core/Tools/Vector3Long.cs.meta create mode 100644 Assets/Mirror/Core/Transport.cs create mode 100644 Assets/Mirror/Core/Transport.cs.meta create mode 100644 Assets/Mirror/Core/TransportError.cs create mode 100644 Assets/Mirror/Core/TransportError.cs.meta create mode 100644 Assets/Mirror/Core/WeaverFuse.cs create mode 100644 Assets/Mirror/Core/WeaverFuse.cs.meta create mode 100644 Assets/Mirror/Editor.meta create mode 100644 Assets/Mirror/Editor/AndroidManifestHelper.cs create mode 100644 Assets/Mirror/Editor/AndroidManifestHelper.cs.meta create mode 100644 Assets/Mirror/Editor/EditorHelper.cs create mode 100644 Assets/Mirror/Editor/EditorHelper.cs.meta create mode 100644 Assets/Mirror/Editor/Empty.meta create mode 100644 Assets/Mirror/Editor/Empty/EnterPlayModeSettingsCheck.cs create mode 100644 Assets/Mirror/Editor/Empty/EnterPlayModeSettingsCheck.cs.meta create mode 100644 Assets/Mirror/Editor/Empty/LogLevelWindow.cs create mode 100644 Assets/Mirror/Editor/Empty/LogLevelWindow.cs.meta create mode 100644 Assets/Mirror/Editor/Empty/Logging.meta create mode 100644 Assets/Mirror/Editor/Empty/Logging/LogLevelWindow.cs create mode 100644 Assets/Mirror/Editor/Empty/Logging/LogLevelWindow.cs.meta create mode 100644 Assets/Mirror/Editor/Empty/Logging/LogLevelsGUI.cs create mode 100644 Assets/Mirror/Editor/Empty/Logging/LogLevelsGUI.cs.meta create mode 100644 Assets/Mirror/Editor/Empty/Logging/LogSettingsEditor.cs create mode 100644 Assets/Mirror/Editor/Empty/Logging/LogSettingsEditor.cs.meta create mode 100644 Assets/Mirror/Editor/Empty/Logging/NetworkLogSettingsEditor.cs create mode 100644 Assets/Mirror/Editor/Empty/Logging/NetworkLogSettingsEditor.cs.meta create mode 100644 Assets/Mirror/Editor/Empty/ScriptableObjectUtility.cs create mode 100644 Assets/Mirror/Editor/Empty/ScriptableObjectUtility.cs.meta create mode 100644 Assets/Mirror/Editor/Empty/SyncVarDrawer.cs create mode 100644 Assets/Mirror/Editor/Empty/SyncVarDrawer.cs.meta create mode 100644 Assets/Mirror/Editor/Icon.meta create mode 100644 Assets/Mirror/Editor/Icon/MirrorIcon.png create mode 100644 Assets/Mirror/Editor/Icon/MirrorIcon.png.meta create mode 100644 Assets/Mirror/Editor/InspectorHelper.cs create mode 100644 Assets/Mirror/Editor/InspectorHelper.cs.meta create mode 100644 Assets/Mirror/Editor/Mirror.Editor.asmdef create mode 100644 Assets/Mirror/Editor/Mirror.Editor.asmdef.meta create mode 100644 Assets/Mirror/Editor/NetworkBehaviourInspector.cs create mode 100644 Assets/Mirror/Editor/NetworkBehaviourInspector.cs.meta create mode 100644 Assets/Mirror/Editor/NetworkInformationPreview.cs create mode 100644 Assets/Mirror/Editor/NetworkInformationPreview.cs.meta create mode 100644 Assets/Mirror/Editor/NetworkManagerEditor.cs create mode 100644 Assets/Mirror/Editor/NetworkManagerEditor.cs.meta create mode 100644 Assets/Mirror/Editor/NetworkScenePostProcess.cs create mode 100644 Assets/Mirror/Editor/NetworkScenePostProcess.cs.meta create mode 100644 Assets/Mirror/Editor/SceneDrawer.cs create mode 100644 Assets/Mirror/Editor/SceneDrawer.cs.meta create mode 100644 Assets/Mirror/Editor/SyncObjectCollectionsDrawer.cs create mode 100644 Assets/Mirror/Editor/SyncObjectCollectionsDrawer.cs.meta create mode 100644 Assets/Mirror/Editor/SyncVarAttributeDrawer.cs create mode 100644 Assets/Mirror/Editor/SyncVarAttributeDrawer.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver.meta create mode 100644 Assets/Mirror/Editor/Weaver/AssemblyInfo.cs create mode 100644 Assets/Mirror/Editor/Weaver/AssemblyInfo.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Empty.meta create mode 100644 Assets/Mirror/Editor/Weaver/Empty/GenericArgumentResolver.cs create mode 100644 Assets/Mirror/Editor/Weaver/Empty/GenericArgumentResolver.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Empty/MessageClassProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Empty/MessageClassProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Empty/Program.cs create mode 100644 Assets/Mirror/Editor/Weaver/Empty/Program.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Empty/SyncDictionaryProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Empty/SyncDictionaryProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Empty/SyncEventProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Empty/SyncEventProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Empty/SyncListProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Empty/SyncListProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPoint.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedHook.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedHook.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedLogger.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedLogger.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPoint/EnterPlayModeHook.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPoint/EnterPlayModeHook.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/CompiledAssemblyFromFile.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/CompiledAssemblyFromFile.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorAssemblyResolver.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorAssemblyResolver.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorFromFile.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorFromFile.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorHook.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorHook.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorLogger.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorLogger.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporter.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporter.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporterProvider.cs create mode 100644 Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporterProvider.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Extensions.cs create mode 100644 Assets/Mirror/Editor/Weaver/Extensions.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Helpers.cs create mode 100644 Assets/Mirror/Editor/Weaver/Helpers.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Logger.cs create mode 100644 Assets/Mirror/Editor/Weaver/Logger.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/CommandProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/CommandProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/MethodProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/MethodProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/MonoBehaviourProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/MonoBehaviourProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/ReaderWriterProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/ReaderWriterProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/ServerClientAttributeProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/ServerClientAttributeProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/SyncObjectInitializer.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/SyncObjectInitializer.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeAccessReplacer.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeAccessReplacer.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Processors/TargetRpcProcessor.cs create mode 100644 Assets/Mirror/Editor/Weaver/Processors/TargetRpcProcessor.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Readers.cs create mode 100644 Assets/Mirror/Editor/Weaver/Readers.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Resolvers.cs create mode 100644 Assets/Mirror/Editor/Weaver/Resolvers.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/SyncVarAccessLists.cs create mode 100644 Assets/Mirror/Editor/Weaver/SyncVarAccessLists.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/TypeReferenceComparer.cs create mode 100644 Assets/Mirror/Editor/Weaver/TypeReferenceComparer.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Unity.Mirror.CodeGen.asmdef create mode 100644 Assets/Mirror/Editor/Weaver/Unity.Mirror.CodeGen.asmdef.meta create mode 100644 Assets/Mirror/Editor/Weaver/Weaver.cs create mode 100644 Assets/Mirror/Editor/Weaver/Weaver.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/WeaverExceptions.cs create mode 100644 Assets/Mirror/Editor/Weaver/WeaverExceptions.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/WeaverTypes.cs create mode 100644 Assets/Mirror/Editor/Weaver/WeaverTypes.cs.meta create mode 100644 Assets/Mirror/Editor/Weaver/Writers.cs create mode 100644 Assets/Mirror/Editor/Weaver/Writers.cs.meta create mode 100644 Assets/Mirror/Editor/Welcome.cs create mode 100644 Assets/Mirror/Editor/Welcome.cs.meta create mode 100644 Assets/Mirror/Notice.txt create mode 100644 Assets/Mirror/Notice.txt.meta create mode 100644 Assets/Mirror/Plugins.meta create mode 100644 Assets/Mirror/Plugins/Mono.Cecil.meta create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/License.txt create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/License.txt.meta create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Mdb.dll create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Mdb.dll.meta create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Pdb.dll create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Pdb.dll.meta create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Rocks.dll create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Rocks.dll.meta create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.dll create mode 100644 Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.dll.meta create mode 100644 Assets/Mirror/Presets.meta create mode 100644 Assets/Mirror/Presets/NetworkTransform.meta create mode 100644 Assets/Mirror/Presets/NetworkTransform/ClientAuth-Balanced.preset create mode 100644 Assets/Mirror/Presets/NetworkTransform/ClientAuth-Balanced.preset.meta create mode 100644 Assets/Mirror/Presets/NetworkTransform/ClientAuth-FastPaced.preset create mode 100644 Assets/Mirror/Presets/NetworkTransform/ClientAuth-FastPaced.preset.meta create mode 100644 Assets/Mirror/Presets/NetworkTransform/ClientAuth-VeryCasual.preset create mode 100644 Assets/Mirror/Presets/NetworkTransform/ClientAuth-VeryCasual.preset.meta create mode 100644 Assets/Mirror/Readme.txt create mode 100644 Assets/Mirror/Readme.txt.meta create mode 100644 Assets/Mirror/Transports.meta create mode 100644 Assets/Mirror/Transports/KCP.meta create mode 100644 Assets/Mirror/Transports/KCP/KcpTransport.cs create mode 100644 Assets/Mirror/Transports/KCP/KcpTransport.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/KCP.asmdef create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/KCP.asmdef.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/LICENSE.txt create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/LICENSE.txt.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/VERSION.txt create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/VERSION.txt.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnection.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnection.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnectionNonAlloc.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnectionNonAlloc.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientNonAlloc.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientNonAlloc.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerConnectionNonAlloc.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerConnectionNonAlloc.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerNonAlloc.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerNonAlloc.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/Common.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/Common.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/ErrorCode.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/ErrorCode.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/Extensions.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/Extensions.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpChannel.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpChannel.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpClient.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpClient.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpConfig.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpConfig.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpHeader.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpHeader.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpPeer.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpPeer.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServer.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServer.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServerConnection.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServerConnection.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/Log.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/highlevel/Log.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/AckItem.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/AckItem.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/AssemblyInfo.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/AssemblyInfo.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/Kcp.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/Kcp.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/Pool.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/Pool.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/Segment.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/Segment.cs.meta create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/Utils.cs create mode 100644 Assets/Mirror/Transports/KCP/kcp2k/kcp/Utils.cs.meta create mode 100644 Assets/Mirror/Transports/Latency.meta create mode 100644 Assets/Mirror/Transports/Latency/LatencySimulation.cs create mode 100644 Assets/Mirror/Transports/Latency/LatencySimulation.cs.meta create mode 100644 Assets/Mirror/Transports/Middleware.meta create mode 100644 Assets/Mirror/Transports/Middleware/MiddlewareTransport.cs create mode 100644 Assets/Mirror/Transports/Middleware/MiddlewareTransport.cs.meta create mode 100644 Assets/Mirror/Transports/Mirror.Transports.asmdef create mode 100644 Assets/Mirror/Transports/Mirror.Transports.asmdef.meta create mode 100644 Assets/Mirror/Transports/Multiplex.meta create mode 100644 Assets/Mirror/Transports/Multiplex/MultiplexTransport.cs create mode 100644 Assets/Mirror/Transports/Multiplex/MultiplexTransport.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/AssemblyInfo.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/AssemblyInfo.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/CHANGELOG.md create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/CHANGELOG.md.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/SimpleWebClient.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/SimpleWebClient.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientHandshake.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientHandshake.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientSslHelper.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientSslHelper.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/WebSocketClientStandAlone.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/WebSocketClientStandAlone.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/SimpleWebJSLib.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/SimpleWebJSLib.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/WebSocketClientWebGl.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/WebSocketClientWebGl.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin/SimpleWeb.jslib create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin/SimpleWeb.jslib.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/BufferPool.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/BufferPool.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Connection.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Connection.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Constants.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Constants.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/EventType.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/EventType.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Log.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Log.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Message.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Message.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/MessageProcessor.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/MessageProcessor.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReadHelper.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReadHelper.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReceiveLoop.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReceiveLoop.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Request.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Request.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/SendLoop.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/SendLoop.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/TcpConfig.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/TcpConfig.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Utils.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Utils.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/LICENSE create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/LICENSE.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/README.txt create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/README.txt.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerHandshake.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerHandshake.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerSslHelper.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerSslHelper.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/SimpleWebServer.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/SimpleWebServer.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/WebSocketServer.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/WebSocketServer.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SimpleWebTransport.asmdef create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SimpleWebTransport.asmdef.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SslConfigLoader.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SslConfigLoader.cs.meta create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWebTransport.cs create mode 100644 Assets/Mirror/Transports/SimpleWeb/SimpleWebTransport.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Client.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Client.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Common.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Common.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/ConnectionState.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/ConnectionState.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Empty.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Logger.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Logger.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Message.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Message.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Empty/SafeQueue.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Empty/SafeQueue.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Empty/ThreadExtensions.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Empty/ThreadExtensions.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/EventType.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/EventType.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/LICENSE create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/LICENSE.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Log.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Log.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentReceivePipe.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentReceivePipe.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentSendPipe.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentSendPipe.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/NetworkStreamExtensions.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/NetworkStreamExtensions.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Pool.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Pool.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Server.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Server.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Telepathy.asmdef create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Telepathy.asmdef.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/ThreadFunctions.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/ThreadFunctions.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Utils.cs create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/Utils.cs.meta create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/VERSION create mode 100644 Assets/Mirror/Transports/Telepathy/Telepathy/VERSION.meta create mode 100644 Assets/Mirror/Transports/Telepathy/TelepathyTransport.cs create mode 100644 Assets/Mirror/Transports/Telepathy/TelepathyTransport.cs.meta create mode 100644 Assets/Mirror/Version.txt create mode 100644 Assets/Mirror/Version.txt.meta diff --git a/Assets/Mirror.meta b/Assets/Mirror.meta new file mode 100644 index 0000000..a7a3dd0 --- /dev/null +++ b/Assets/Mirror.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 5cf8eb36be0834b3da408c694a41cb88 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Authenticators.meta b/Assets/Mirror/Authenticators.meta new file mode 100644 index 0000000..644f4ec --- /dev/null +++ b/Assets/Mirror/Authenticators.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 1b2f9d254154cd942ba40b06b869b8f3 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Authenticators/BasicAuthenticator.cs b/Assets/Mirror/Authenticators/BasicAuthenticator.cs new file mode 100644 index 0000000..3c077c7 --- /dev/null +++ b/Assets/Mirror/Authenticators/BasicAuthenticator.cs @@ -0,0 +1,192 @@ +using System.Collections; +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror.Authenticators +{ + [AddComponentMenu("Network/ Authenticators/Basic Authenticator")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-authenticators/basic-authenticator")] + public class BasicAuthenticator : NetworkAuthenticator + { + [Header("Server Credentials")] + public string serverUsername; + public string serverPassword; + + [Header("Client Credentials")] + public string username; + public string password; + + readonly HashSet connectionsPendingDisconnect = new HashSet(); + + #region Messages + + public struct AuthRequestMessage : NetworkMessage + { + // use whatever credentials make sense for your game + // for example, you might want to pass the accessToken if using oauth + public string authUsername; + public string authPassword; + } + + public struct AuthResponseMessage : NetworkMessage + { + public byte code; + public string message; + } + + #endregion + + #region Server + + /// + /// Called on server from StartServer to initialize the Authenticator + /// Server message handlers should be registered in this method. + /// + public override void OnStartServer() + { + // register a handler for the authentication request we expect from client + NetworkServer.RegisterHandler(OnAuthRequestMessage, false); + } + + /// + /// Called on server from StopServer to reset the Authenticator + /// Server message handlers should be unregistered in this method. + /// + public override void OnStopServer() + { + // unregister the handler for the authentication request + NetworkServer.UnregisterHandler(); + } + + /// + /// Called on server from OnServerConnectInternal when a client needs to authenticate + /// + /// Connection to client. + public override void OnServerAuthenticate(NetworkConnectionToClient conn) + { + // do nothing...wait for AuthRequestMessage from client + } + + /// + /// Called on server when the client's AuthRequestMessage arrives + /// + /// Connection to client. + /// The message payload + public void OnAuthRequestMessage(NetworkConnectionToClient conn, AuthRequestMessage msg) + { + //Debug.Log($"Authentication Request: {msg.authUsername} {msg.authPassword}"); + + if (connectionsPendingDisconnect.Contains(conn)) return; + + // check the credentials by calling your web server, database table, playfab api, or any method appropriate. + if (msg.authUsername == serverUsername && msg.authPassword == serverPassword) + { + // create and send msg to client so it knows to proceed + AuthResponseMessage authResponseMessage = new AuthResponseMessage + { + code = 100, + message = "Success" + }; + + conn.Send(authResponseMessage); + + // Accept the successful authentication + ServerAccept(conn); + } + else + { + connectionsPendingDisconnect.Add(conn); + + // create and send msg to client so it knows to disconnect + AuthResponseMessage authResponseMessage = new AuthResponseMessage + { + code = 200, + message = "Invalid Credentials" + }; + + conn.Send(authResponseMessage); + + // must set NetworkConnection isAuthenticated = false + conn.isAuthenticated = false; + + // disconnect the client after 1 second so that response message gets delivered + StartCoroutine(DelayedDisconnect(conn, 1f)); + } + } + + IEnumerator DelayedDisconnect(NetworkConnectionToClient conn, float waitTime) + { + yield return new WaitForSeconds(waitTime); + + // Reject the unsuccessful authentication + ServerReject(conn); + + yield return null; + + // remove conn from pending connections + connectionsPendingDisconnect.Remove(conn); + } + + #endregion + + #region Client + + /// + /// Called on client from StartClient to initialize the Authenticator + /// Client message handlers should be registered in this method. + /// + public override void OnStartClient() + { + // register a handler for the authentication response we expect from server + NetworkClient.RegisterHandler(OnAuthResponseMessage, false); + } + + /// + /// Called on client from StopClient to reset the Authenticator + /// Client message handlers should be unregistered in this method. + /// + public override void OnStopClient() + { + // unregister the handler for the authentication response + NetworkClient.UnregisterHandler(); + } + + /// + /// Called on client from OnClientConnectInternal when a client needs to authenticate + /// + public override void OnClientAuthenticate() + { + AuthRequestMessage authRequestMessage = new AuthRequestMessage + { + authUsername = username, + authPassword = password + }; + + NetworkClient.Send(authRequestMessage); + } + + /// + /// Called on client when the server's AuthResponseMessage arrives + /// + /// The message payload + public void OnAuthResponseMessage(AuthResponseMessage msg) + { + if (msg.code == 100) + { + //Debug.Log($"Authentication Response: {msg.message}"); + + // Authentication has been accepted + ClientAccept(); + } + else + { + Debug.LogError($"Authentication Response: {msg.message}"); + + // Authentication has been rejected + ClientReject(); + } + } + + #endregion + } +} diff --git a/Assets/Mirror/Authenticators/BasicAuthenticator.cs.meta b/Assets/Mirror/Authenticators/BasicAuthenticator.cs.meta new file mode 100644 index 0000000..4765013 --- /dev/null +++ b/Assets/Mirror/Authenticators/BasicAuthenticator.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 28496b776660156428f00cf78289c1ec +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Authenticators/DeviceAuthenticator.cs b/Assets/Mirror/Authenticators/DeviceAuthenticator.cs new file mode 100644 index 0000000..5e0ea56 --- /dev/null +++ b/Assets/Mirror/Authenticators/DeviceAuthenticator.cs @@ -0,0 +1,129 @@ +using System; +using UnityEngine; + +namespace Mirror.Authenticators +{ + /// + /// An authenticator that identifies the user by their device. + /// A GUID is used as a fallback when the platform doesn't support SystemInfo.deviceUniqueIdentifier. + /// Note: deviceUniqueIdentifier can be spoofed, so security is not guaranteed. + /// See https://docs.unity3d.com/ScriptReference/SystemInfo-deviceUniqueIdentifier.html for details. + /// + [AddComponentMenu("Network/ Authenticators/Device Authenticator")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-authenticators/device-authenticator")] + public class DeviceAuthenticator : NetworkAuthenticator + { + #region Messages + + public struct AuthRequestMessage : NetworkMessage + { + public string clientDeviceID; + } + + public struct AuthResponseMessage : NetworkMessage { } + + #endregion + + #region Server + + /// + /// Called on server from StartServer to initialize the Authenticator + /// Server message handlers should be registered in this method. + /// + public override void OnStartServer() + { + // register a handler for the authentication request we expect from client + NetworkServer.RegisterHandler(OnAuthRequestMessage, false); + } + + /// + /// Called on server from StopServer to reset the Authenticator + /// Server message handlers should be registered in this method. + /// + public override void OnStopServer() + { + // unregister the handler for the authentication request + NetworkServer.UnregisterHandler(); + } + + /// + /// Called on server from OnServerConnectInternal when a client needs to authenticate + /// + /// Connection to client. + public override void OnServerAuthenticate(NetworkConnectionToClient conn) + { + // do nothing, wait for client to send his id + } + + void OnAuthRequestMessage(NetworkConnectionToClient conn, AuthRequestMessage msg) + { + Debug.Log($"connection {conn.connectionId} authenticated with id {msg.clientDeviceID}"); + + // Store the device id for later reference, e.g. when spawning the player + conn.authenticationData = msg.clientDeviceID; + + // Send a response to client telling it to proceed as authenticated + conn.Send(new AuthResponseMessage()); + + // Accept the successful authentication + ServerAccept(conn); + } + + #endregion + + #region Client + + /// + /// Called on client from StartClient to initialize the Authenticator + /// Client message handlers should be registered in this method. + /// + public override void OnStartClient() + { + // register a handler for the authentication response we expect from server + NetworkClient.RegisterHandler(OnAuthResponseMessage, false); + } + + /// + /// Called on client from StopClient to reset the Authenticator + /// Client message handlers should be unregistered in this method. + /// + public override void OnStopClient() + { + // unregister the handler for the authentication response + NetworkClient.UnregisterHandler(); + } + + /// + /// Called on client from OnClientConnectInternal when a client needs to authenticate + /// + public override void OnClientAuthenticate() + { + string deviceUniqueIdentifier = SystemInfo.deviceUniqueIdentifier; + + // Not all platforms support this, so we use a GUID instead + if (deviceUniqueIdentifier == SystemInfo.unsupportedIdentifier) + { + // Get the value from PlayerPrefs if it exists, new GUID if it doesn't + deviceUniqueIdentifier = PlayerPrefs.GetString("deviceUniqueIdentifier", Guid.NewGuid().ToString()); + + // Store the deviceUniqueIdentifier to PlayerPrefs (in case we just made a new GUID) + PlayerPrefs.SetString("deviceUniqueIdentifier", deviceUniqueIdentifier); + } + + // send the deviceUniqueIdentifier to the server + NetworkClient.Send(new AuthRequestMessage { clientDeviceID = deviceUniqueIdentifier } ); + } + + /// + /// Called on client when the server's AuthResponseMessage arrives + /// + /// The message payload + public void OnAuthResponseMessage(AuthResponseMessage msg) + { + Debug.Log("Authentication Success"); + ClientAccept(); + } + + #endregion + } +} diff --git a/Assets/Mirror/Authenticators/DeviceAuthenticator.cs.meta b/Assets/Mirror/Authenticators/DeviceAuthenticator.cs.meta new file mode 100644 index 0000000..9ca9f64 --- /dev/null +++ b/Assets/Mirror/Authenticators/DeviceAuthenticator.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 60960a6ba81a842deb2fdcdc93788242 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Authenticators/Mirror.Authenticators.asmdef b/Assets/Mirror/Authenticators/Mirror.Authenticators.asmdef new file mode 100644 index 0000000..70eacf3 --- /dev/null +++ b/Assets/Mirror/Authenticators/Mirror.Authenticators.asmdef @@ -0,0 +1,16 @@ +{ + "name": "Mirror.Authenticators", + "rootNamespace": "", + "references": [ + "GUID:30817c1a0e6d646d99c048fc403f5979" + ], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/Assets/Mirror/Authenticators/Mirror.Authenticators.asmdef.meta b/Assets/Mirror/Authenticators/Mirror.Authenticators.asmdef.meta new file mode 100644 index 0000000..2731701 --- /dev/null +++ b/Assets/Mirror/Authenticators/Mirror.Authenticators.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: e720aa64e3f58fb4880566a322584340 +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Authenticators/TimeoutAuthenticator.cs b/Assets/Mirror/Authenticators/TimeoutAuthenticator.cs new file mode 100644 index 0000000..711ee6e --- /dev/null +++ b/Assets/Mirror/Authenticators/TimeoutAuthenticator.cs @@ -0,0 +1,70 @@ +using System.Collections; +using UnityEngine; + +namespace Mirror.Authenticators +{ + /// + /// An authenticator that disconnects connections if they don't + /// authenticate within a specified time limit. + /// + [AddComponentMenu("Network/ Authenticators/Timeout Authenticator")] + public class TimeoutAuthenticator : NetworkAuthenticator + { + public NetworkAuthenticator authenticator; + + [Range(0, 600), Tooltip("Timeout to auto-disconnect in seconds. Set to 0 for no timeout.")] + public float timeout = 60; + + public void Awake() + { + authenticator.OnServerAuthenticated.AddListener(connection => OnServerAuthenticated.Invoke(connection)); + authenticator.OnClientAuthenticated.AddListener(OnClientAuthenticated.Invoke); + } + + public override void OnStartServer() + { + authenticator.OnStartServer(); + } + + public override void OnStopServer() + { + authenticator.OnStopServer(); + } + + public override void OnStartClient() + { + authenticator.OnStartClient(); + } + + public override void OnStopClient() + { + authenticator.OnStopClient(); + } + + public override void OnServerAuthenticate(NetworkConnectionToClient conn) + { + authenticator.OnServerAuthenticate(conn); + if (timeout > 0) + StartCoroutine(BeginAuthentication(conn)); + } + + public override void OnClientAuthenticate() + { + authenticator.OnClientAuthenticate(); + if (timeout > 0) + StartCoroutine(BeginAuthentication(NetworkClient.connection)); + } + + IEnumerator BeginAuthentication(NetworkConnection conn) + { + //Debug.Log($"Authentication countdown started {conn} {timeout}"); + yield return new WaitForSecondsRealtime(timeout); + + if (!conn.isAuthenticated) + { + Debug.LogError($"Authentication Timeout - Disconnecting {conn}"); + conn.Disconnect(); + } + } + } +} diff --git a/Assets/Mirror/Authenticators/TimeoutAuthenticator.cs.meta b/Assets/Mirror/Authenticators/TimeoutAuthenticator.cs.meta new file mode 100644 index 0000000..b19ddec --- /dev/null +++ b/Assets/Mirror/Authenticators/TimeoutAuthenticator.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 24d8269a07b8e4edfa374753a91c946e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/CompilerSymbols.meta b/Assets/Mirror/CompilerSymbols.meta new file mode 100644 index 0000000..4652ae1 --- /dev/null +++ b/Assets/Mirror/CompilerSymbols.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 1f8b918bcd89f5c488b06f5574f34760 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/CompilerSymbols/Mirror.CompilerSymbols.asmdef b/Assets/Mirror/CompilerSymbols/Mirror.CompilerSymbols.asmdef new file mode 100644 index 0000000..af25622 --- /dev/null +++ b/Assets/Mirror/CompilerSymbols/Mirror.CompilerSymbols.asmdef @@ -0,0 +1,14 @@ +{ + "name": "Mirror.CompilerSymbols", + "references": [], + "optionalUnityReferences": [], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [] +} \ No newline at end of file diff --git a/Assets/Mirror/CompilerSymbols/Mirror.CompilerSymbols.asmdef.meta b/Assets/Mirror/CompilerSymbols/Mirror.CompilerSymbols.asmdef.meta new file mode 100644 index 0000000..8b23823 --- /dev/null +++ b/Assets/Mirror/CompilerSymbols/Mirror.CompilerSymbols.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 325984b52e4128546bc7558552f8b1d2 +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/CompilerSymbols/PreprocessorDefine.cs b/Assets/Mirror/CompilerSymbols/PreprocessorDefine.cs new file mode 100644 index 0000000..b553d40 --- /dev/null +++ b/Assets/Mirror/CompilerSymbols/PreprocessorDefine.cs @@ -0,0 +1,43 @@ +using System.Collections.Generic; +using UnityEditor; + +namespace Mirror +{ + static class PreprocessorDefine + { + /// + /// Add define symbols as soon as Unity gets done compiling. + /// + [InitializeOnLoadMethod] + public static void AddDefineSymbols() + { + string currentDefines = PlayerSettings.GetScriptingDefineSymbolsForGroup(EditorUserBuildSettings.selectedBuildTargetGroup); + HashSet defines = new HashSet(currentDefines.Split(';')) + { + "MIRROR", + "MIRROR_57_0_OR_NEWER", + "MIRROR_58_0_OR_NEWER", + "MIRROR_65_0_OR_NEWER", + "MIRROR_66_0_OR_NEWER", + "MIRROR_2022_9_OR_NEWER", + "MIRROR_2022_10_OR_NEWER", + "MIRROR_70_0_OR_NEWER", + "MIRROR_71_0_OR_NEWER", + "MIRROR_73_OR_NEWER", + "MIRROR_78_OR_NEWER", + "MIRROR_79_OR_NEWER", + "MIRROR_81_OR_NEWER" + // Remove oldest when adding next month's symbol. + // Keep a rolling 12 months of symbols. + }; + + // only touch PlayerSettings if we actually modified it, + // otherwise it shows up as changed in git each time. + string newDefines = string.Join(";", defines); + if (newDefines != currentDefines) + { + PlayerSettings.SetScriptingDefineSymbolsForGroup(EditorUserBuildSettings.selectedBuildTargetGroup, newDefines); + } + } + } +} diff --git a/Assets/Mirror/CompilerSymbols/PreprocessorDefine.cs.meta b/Assets/Mirror/CompilerSymbols/PreprocessorDefine.cs.meta new file mode 100644 index 0000000..6306c16 --- /dev/null +++ b/Assets/Mirror/CompilerSymbols/PreprocessorDefine.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f1d66fe74ec6f42dd974cba37d25d453 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components.meta b/Assets/Mirror/Components.meta new file mode 100644 index 0000000..c2771d9 --- /dev/null +++ b/Assets/Mirror/Components.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 9bee879fbc8ef4b1a9a9f7088bfbf726 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/AssemblyInfo.cs b/Assets/Mirror/Components/AssemblyInfo.cs new file mode 100644 index 0000000..f342716 --- /dev/null +++ b/Assets/Mirror/Components/AssemblyInfo.cs @@ -0,0 +1,12 @@ +using System.Runtime.CompilerServices; + +[assembly: InternalsVisibleTo("Mirror.Tests.Common")] +[assembly: InternalsVisibleTo("Mirror.Tests")] +// need to use Unity.*.CodeGen assembly name to import Unity.CompilationPipeline +// for ILPostProcessor tests. +[assembly: InternalsVisibleTo("Unity.Mirror.Tests.CodeGen")] +[assembly: InternalsVisibleTo("Mirror.Tests.Generated")] +[assembly: InternalsVisibleTo("Mirror.Tests.Runtime")] +[assembly: InternalsVisibleTo("Mirror.Tests.Performance.Editor")] +[assembly: InternalsVisibleTo("Mirror.Tests.Performance.Runtime")] +[assembly: InternalsVisibleTo("Mirror.Editor")] diff --git a/Assets/Mirror/Components/AssemblyInfo.cs.meta b/Assets/Mirror/Components/AssemblyInfo.cs.meta new file mode 100644 index 0000000..f9af1fa --- /dev/null +++ b/Assets/Mirror/Components/AssemblyInfo.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a65b9283f7a724e70b8e17cb277f4c1e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Discovery.meta b/Assets/Mirror/Components/Discovery.meta new file mode 100644 index 0000000..d5bb0cb --- /dev/null +++ b/Assets/Mirror/Components/Discovery.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: b5dcf9618f5e14a4eb60bff5480284a6 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Discovery/NetworkDiscovery.cs b/Assets/Mirror/Components/Discovery/NetworkDiscovery.cs new file mode 100644 index 0000000..5fa9397 --- /dev/null +++ b/Assets/Mirror/Components/Discovery/NetworkDiscovery.cs @@ -0,0 +1,93 @@ +using System; +using System.Net; +using UnityEngine; +using UnityEngine.Events; + +namespace Mirror.Discovery +{ + [Serializable] + public class ServerFoundUnityEvent : UnityEvent {}; + + [DisallowMultipleComponent] + [AddComponentMenu("Network/Network Discovery")] + public class NetworkDiscovery : NetworkDiscoveryBase + { + #region Server + + /// + /// Process the request from a client + /// + /// + /// Override if you wish to provide more information to the clients + /// such as the name of the host player + /// + /// Request coming from client + /// Address of the client that sent the request + /// The message to be sent back to the client or null + protected override ServerResponse ProcessRequest(ServerRequest request, IPEndPoint endpoint) + { + // In this case we don't do anything with the request + // but other discovery implementations might want to use the data + // in there, This way the client can ask for + // specific game mode or something + + try + { + // this is an example reply message, return your own + // to include whatever is relevant for your game + return new ServerResponse + { + serverId = ServerId, + uri = transport.ServerUri() + }; + } + catch (NotImplementedException) + { + Debug.LogError($"Transport {transport} does not support network discovery"); + throw; + } + } + + #endregion + + #region Client + + /// + /// Create a message that will be broadcasted on the network to discover servers + /// + /// + /// Override if you wish to include additional data in the discovery message + /// such as desired game mode, language, difficulty, etc... + /// An instance of ServerRequest with data to be broadcasted + protected override ServerRequest GetRequest() => new ServerRequest(); + + /// + /// Process the answer from a server + /// + /// + /// A client receives a reply from a server, this method processes the + /// reply and raises an event + /// + /// Response that came from the server + /// Address of the server that replied + protected override void ProcessResponse(ServerResponse response, IPEndPoint endpoint) + { + // we received a message from the remote endpoint + response.EndPoint = endpoint; + + // although we got a supposedly valid url, we may not be able to resolve + // the provided host + // However we know the real ip address of the server because we just + // received a packet from it, so use that as host. + UriBuilder realUri = new UriBuilder(response.uri) + { + Host = response.EndPoint.Address.ToString() + }; + response.uri = realUri.Uri; + + OnServerFound.Invoke(response); + } + + #endregion + } +} diff --git a/Assets/Mirror/Components/Discovery/NetworkDiscovery.cs.meta b/Assets/Mirror/Components/Discovery/NetworkDiscovery.cs.meta new file mode 100644 index 0000000..c691a61 --- /dev/null +++ b/Assets/Mirror/Components/Discovery/NetworkDiscovery.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c761308e733c51245b2e8bb4201f46dc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs b/Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs new file mode 100644 index 0000000..8e13f01 --- /dev/null +++ b/Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs @@ -0,0 +1,469 @@ +using System; +using System.Net; +using System.Net.Sockets; +using System.Threading.Tasks; +using UnityEngine; + +// Based on https://github.com/EnlightenedOne/MirrorNetworkDiscovery +// forked from https://github.com/in0finite/MirrorNetworkDiscovery +// Both are MIT Licensed + +namespace Mirror.Discovery +{ + /// + /// Base implementation for Network Discovery. Extend this component + /// to provide custom discovery with game specific data + /// NetworkDiscovery for a sample implementation + /// + [DisallowMultipleComponent] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-discovery")] + public abstract class NetworkDiscoveryBase : MonoBehaviour + where Request : NetworkMessage + where Response : NetworkMessage + { + public static bool SupportedOnThisPlatform { get { return Application.platform != RuntimePlatform.WebGLPlayer; } } + + [SerializeField] + [Tooltip("If true, broadcasts a discovery request every ActiveDiscoveryInterval seconds")] + public bool enableActiveDiscovery = true; + + // broadcast address needs to be configurable on iOS: + // https://github.com/vis2k/Mirror/pull/3255 + [Tooltip("iOS may require LAN IP address here (e.g. 192.168.x.x), otherwise leave blank.")] + public string BroadcastAddress = ""; + + [SerializeField] + [Tooltip("The UDP port the server will listen for multi-cast messages")] + protected int serverBroadcastListenPort = 47777; + + [SerializeField] + [Tooltip("Time in seconds between multi-cast messages")] + [Range(1, 60)] + float ActiveDiscoveryInterval = 3; + + [Tooltip("Transport to be advertised during discovery")] + public Transport transport; + + [Tooltip("Invoked when a server is found")] + public ServerFoundUnityEvent OnServerFound; + + // Each game should have a random unique handshake, + // this way you can tell if this is the same game or not + [HideInInspector] + public long secretHandshake; + + public long ServerId { get; private set; } + + protected UdpClient serverUdpClient; + protected UdpClient clientUdpClient; + +#if UNITY_EDITOR + public virtual void OnValidate() + { + if (transport == null) + transport = GetComponent(); + + if (secretHandshake == 0) + { + secretHandshake = RandomLong(); + UnityEditor.Undo.RecordObject(this, "Set secret handshake"); + } + } +#endif + + /// + /// virtual so that inheriting classes' Start() can call base.Start() too + /// + public virtual void Start() + { + ServerId = RandomLong(); + + // active transport gets initialized in Awake + // so make sure we set it here in Start() after Awake + // Or just let the user assign it in the inspector + if (transport == null) + transport = Transport.active; + + // Server mode? then start advertising +#if UNITY_SERVER + AdvertiseServer(); +#endif + } + + public static long RandomLong() + { + int value1 = UnityEngine.Random.Range(int.MinValue, int.MaxValue); + int value2 = UnityEngine.Random.Range(int.MinValue, int.MaxValue); + return value1 + ((long)value2 << 32); + } + + // Ensure the ports are cleared no matter when Game/Unity UI exits + void OnApplicationQuit() + { + //Debug.Log("NetworkDiscoveryBase OnApplicationQuit"); + Shutdown(); + } + + void OnDisable() + { + //Debug.Log("NetworkDiscoveryBase OnDisable"); + Shutdown(); + } + + void OnDestroy() + { + //Debug.Log("NetworkDiscoveryBase OnDestroy"); + Shutdown(); + } + + void Shutdown() + { + EndpMulticastLock(); + if (serverUdpClient != null) + { + try + { + serverUdpClient.Close(); + } + catch (Exception) + { + // it is just close, swallow the error + } + + serverUdpClient = null; + } + + if (clientUdpClient != null) + { + try + { + clientUdpClient.Close(); + } + catch (Exception) + { + // it is just close, swallow the error + } + + clientUdpClient = null; + } + + CancelInvoke(); + } + + #region Server + + /// + /// Advertise this server in the local network + /// + public void AdvertiseServer() + { + if (!SupportedOnThisPlatform) + throw new PlatformNotSupportedException("Network discovery not supported in this platform"); + + StopDiscovery(); + + // Setup port -- may throw exception + serverUdpClient = new UdpClient(serverBroadcastListenPort) + { + EnableBroadcast = true, + MulticastLoopback = false + }; + + // listen for client pings + _ = ServerListenAsync(); + } + + public async Task ServerListenAsync() + { + BeginMulticastLock(); + while (true) + { + try + { + await ReceiveRequestAsync(serverUdpClient); + } + catch (ObjectDisposedException) + { + // socket has been closed + break; + } + catch (Exception) {} + } + } + + async Task ReceiveRequestAsync(UdpClient udpClient) + { + // only proceed if there is available data in network buffer, or otherwise Receive() will block + // average time for UdpClient.Available : 10 us + + UdpReceiveResult udpReceiveResult = await udpClient.ReceiveAsync(); + + using (NetworkReaderPooled networkReader = NetworkReaderPool.Get(udpReceiveResult.Buffer)) + { + long handshake = networkReader.ReadLong(); + if (handshake != secretHandshake) + { + // message is not for us + throw new ProtocolViolationException("Invalid handshake"); + } + + Request request = networkReader.Read(); + + ProcessClientRequest(request, udpReceiveResult.RemoteEndPoint); + } + } + + /// + /// Reply to the client to inform it of this server + /// + /// + /// Override if you wish to ignore server requests based on + /// custom criteria such as language, full server game mode or difficulty + /// + /// Request coming from client + /// Address of the client that sent the request + protected virtual void ProcessClientRequest(Request request, IPEndPoint endpoint) + { + Response info = ProcessRequest(request, endpoint); + + if (info == null) + return; + + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + try + { + writer.WriteLong(secretHandshake); + + writer.Write(info); + + ArraySegment data = writer.ToArraySegment(); + // signature matches + // send response + serverUdpClient.Send(data.Array, data.Count, endpoint); + } + catch (Exception ex) + { + Debug.LogException(ex, this); + } + } + } + + /// + /// Process the request from a client + /// + /// + /// Override if you wish to provide more information to the clients + /// such as the name of the host player + /// + /// Request coming from client + /// Address of the client that sent the request + /// The message to be sent back to the client or null + protected abstract Response ProcessRequest(Request request, IPEndPoint endpoint); + + // Android Multicast fix: https://github.com/vis2k/Mirror/pull/2887 +#if UNITY_ANDROID + AndroidJavaObject multicastLock; + bool hasMulticastLock; +#endif + + void BeginMulticastLock() + { +#if UNITY_ANDROID + if (hasMulticastLock) return; + + if (Application.platform == RuntimePlatform.Android) + { + using (AndroidJavaObject activity = new AndroidJavaClass("com.unity3d.player.UnityPlayer").GetStatic("currentActivity")) + { + using (var wifiManager = activity.Call("getSystemService", "wifi")) + { + multicastLock = wifiManager.Call("createMulticastLock", "lock"); + multicastLock.Call("acquire"); + hasMulticastLock = true; + } + } + } +#endif + } + + void EndpMulticastLock() + { +#if UNITY_ANDROID + if (!hasMulticastLock) return; + + multicastLock?.Call("release"); + hasMulticastLock = false; +#endif + } + +#endregion + + #region Client + + /// + /// Start Active Discovery + /// + public void StartDiscovery() + { + if (!SupportedOnThisPlatform) + throw new PlatformNotSupportedException("Network discovery not supported in this platform"); + + StopDiscovery(); + + try + { + // Setup port + clientUdpClient = new UdpClient(0) + { + EnableBroadcast = true, + MulticastLoopback = false + }; + } + catch (Exception) + { + // Free the port if we took it + //Debug.LogError("NetworkDiscoveryBase StartDiscovery Exception"); + Shutdown(); + throw; + } + + _ = ClientListenAsync(); + + if (enableActiveDiscovery) InvokeRepeating(nameof(BroadcastDiscoveryRequest), 0, ActiveDiscoveryInterval); + } + + /// + /// Stop Active Discovery + /// + public void StopDiscovery() + { + //Debug.Log("NetworkDiscoveryBase StopDiscovery"); + Shutdown(); + } + + /// + /// Awaits for server response + /// + /// ClientListenAsync Task + public async Task ClientListenAsync() + { + // while clientUpdClient to fix: + // https://github.com/vis2k/Mirror/pull/2908 + // + // If, you cancel discovery the clientUdpClient is set to null. + // However, nothing cancels ClientListenAsync. If we change the if(true) + // to check if the client is null. You can properly cancel the discovery, + // and kill the listen thread. + // + // Prior to this fix, if you cancel the discovery search. It crashes the + // thread, and is super noisy in the output. As well as causes issues on + // the quest. + while (clientUdpClient != null) + { + try + { + await ReceiveGameBroadcastAsync(clientUdpClient); + } + catch (ObjectDisposedException) + { + // socket was closed, no problem + return; + } + catch (Exception ex) + { + Debug.LogException(ex); + } + } + } + + /// + /// Sends discovery request from client + /// + public void BroadcastDiscoveryRequest() + { + if (clientUdpClient == null) + return; + + if (NetworkClient.isConnected) + { + StopDiscovery(); + return; + } + + IPEndPoint endPoint = new IPEndPoint(IPAddress.Broadcast, serverBroadcastListenPort); + + if (!string.IsNullOrWhiteSpace(BroadcastAddress)) + { + try + { + endPoint = new IPEndPoint(IPAddress.Parse(BroadcastAddress), serverBroadcastListenPort); + } + catch (Exception ex) + { + Debug.LogException(ex); + } + } + + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + writer.WriteLong(secretHandshake); + + try + { + Request request = GetRequest(); + + writer.Write(request); + + ArraySegment data = writer.ToArraySegment(); + + clientUdpClient.SendAsync(data.Array, data.Count, endPoint); + } + catch (Exception) + { + // It is ok if we can't broadcast to one of the addresses + } + } + } + + /// + /// Create a message that will be broadcasted on the network to discover servers + /// + /// + /// Override if you wish to include additional data in the discovery message + /// such as desired game mode, language, difficulty, etc... + /// An instance of ServerRequest with data to be broadcasted + protected virtual Request GetRequest() => default; + + async Task ReceiveGameBroadcastAsync(UdpClient udpClient) + { + // only proceed if there is available data in network buffer, or otherwise Receive() will block + // average time for UdpClient.Available : 10 us + + UdpReceiveResult udpReceiveResult = await udpClient.ReceiveAsync(); + + using (NetworkReaderPooled networkReader = NetworkReaderPool.Get(udpReceiveResult.Buffer)) + { + if (networkReader.ReadLong() != secretHandshake) + return; + + Response response = networkReader.Read(); + + ProcessResponse(response, udpReceiveResult.RemoteEndPoint); + } + } + + /// + /// Process the answer from a server + /// + /// + /// A client receives a reply from a server, this method processes the + /// reply and raises an event + /// + /// Response that came from the server + /// Address of the server that replied + protected abstract void ProcessResponse(Response response, IPEndPoint endpoint); + + #endregion + } +} diff --git a/Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs.meta b/Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs.meta new file mode 100644 index 0000000..fecf845 --- /dev/null +++ b/Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b9971d60ce61f4e39b07cd9e7e0c68fa +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs b/Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs new file mode 100644 index 0000000..e43c3d7 --- /dev/null +++ b/Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs @@ -0,0 +1,132 @@ +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror.Discovery +{ + [DisallowMultipleComponent] + [AddComponentMenu("Network/Network Discovery HUD")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-discovery")] + [RequireComponent(typeof(NetworkDiscovery))] + public class NetworkDiscoveryHUD : MonoBehaviour + { + readonly Dictionary discoveredServers = new Dictionary(); + Vector2 scrollViewPos = Vector2.zero; + + public NetworkDiscovery networkDiscovery; + +#if UNITY_EDITOR + void OnValidate() + { + if (networkDiscovery == null) + { + networkDiscovery = GetComponent(); + UnityEditor.Events.UnityEventTools.AddPersistentListener(networkDiscovery.OnServerFound, OnDiscoveredServer); + UnityEditor.Undo.RecordObjects(new Object[] { this, networkDiscovery }, "Set NetworkDiscovery"); + } + } +#endif + + void OnGUI() + { + if (NetworkManager.singleton == null) + return; + + if (!NetworkClient.isConnected && !NetworkServer.active && !NetworkClient.active) + DrawGUI(); + + if (NetworkServer.active || NetworkClient.active) + StopButtons(); + } + + void DrawGUI() + { + GUILayout.BeginArea(new Rect(10, 10, 300, 500)); + GUILayout.BeginHorizontal(); + + if (GUILayout.Button("Find Servers")) + { + discoveredServers.Clear(); + networkDiscovery.StartDiscovery(); + } + + // LAN Host + if (GUILayout.Button("Start Host")) + { + discoveredServers.Clear(); + NetworkManager.singleton.StartHost(); + networkDiscovery.AdvertiseServer(); + } + + // Dedicated server + if (GUILayout.Button("Start Server")) + { + discoveredServers.Clear(); + NetworkManager.singleton.StartServer(); + networkDiscovery.AdvertiseServer(); + } + + GUILayout.EndHorizontal(); + + // show list of found server + + GUILayout.Label($"Discovered Servers [{discoveredServers.Count}]:"); + + // servers + scrollViewPos = GUILayout.BeginScrollView(scrollViewPos); + + foreach (ServerResponse info in discoveredServers.Values) + if (GUILayout.Button(info.EndPoint.Address.ToString())) + Connect(info); + + GUILayout.EndScrollView(); + GUILayout.EndArea(); + } + + void StopButtons() + { + GUILayout.BeginArea(new Rect(10, 40, 100, 25)); + + // stop host if host mode + if (NetworkServer.active && NetworkClient.isConnected) + { + if (GUILayout.Button("Stop Host")) + { + NetworkManager.singleton.StopHost(); + networkDiscovery.StopDiscovery(); + } + } + // stop client if client-only + else if (NetworkClient.isConnected) + { + if (GUILayout.Button("Stop Client")) + { + NetworkManager.singleton.StopClient(); + networkDiscovery.StopDiscovery(); + } + } + // stop server if server-only + else if (NetworkServer.active) + { + if (GUILayout.Button("Stop Server")) + { + NetworkManager.singleton.StopServer(); + networkDiscovery.StopDiscovery(); + } + } + + GUILayout.EndArea(); + } + + void Connect(ServerResponse info) + { + networkDiscovery.StopDiscovery(); + NetworkManager.singleton.StartClient(info.uri); + } + + public void OnDiscoveredServer(ServerResponse info) + { + // Note that you can check the versioning to decide if you can connect to the server or not using this method + discoveredServers[info.serverId] = info; + } + } +} diff --git a/Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs.meta b/Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs.meta new file mode 100644 index 0000000..f93b275 --- /dev/null +++ b/Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 88c37d3deca7a834d80cfd8d3cfcc510 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Discovery/ServerRequest.cs b/Assets/Mirror/Components/Discovery/ServerRequest.cs new file mode 100644 index 0000000..647b619 --- /dev/null +++ b/Assets/Mirror/Components/Discovery/ServerRequest.cs @@ -0,0 +1,4 @@ +namespace Mirror.Discovery +{ + public struct ServerRequest : NetworkMessage {} +} diff --git a/Assets/Mirror/Components/Discovery/ServerRequest.cs.meta b/Assets/Mirror/Components/Discovery/ServerRequest.cs.meta new file mode 100644 index 0000000..a7e246c --- /dev/null +++ b/Assets/Mirror/Components/Discovery/ServerRequest.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ea7254bf7b9454da4adad881d94cd141 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Discovery/ServerResponse.cs b/Assets/Mirror/Components/Discovery/ServerResponse.cs new file mode 100644 index 0000000..7465783 --- /dev/null +++ b/Assets/Mirror/Components/Discovery/ServerResponse.cs @@ -0,0 +1,18 @@ +using System; +using System.Net; + +namespace Mirror.Discovery +{ + public struct ServerResponse : NetworkMessage + { + // The server that sent this + // this is a property so that it is not serialized, but the + // client fills this up after we receive it + public IPEndPoint EndPoint { get; set; } + + public Uri uri; + + // Prevent duplicate server appearance when a connection can be made via LAN on multiple NICs + public long serverId; + } +} \ No newline at end of file diff --git a/Assets/Mirror/Components/Discovery/ServerResponse.cs.meta b/Assets/Mirror/Components/Discovery/ServerResponse.cs.meta new file mode 100644 index 0000000..239b218 --- /dev/null +++ b/Assets/Mirror/Components/Discovery/ServerResponse.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 36f97227fdf2d7a4e902db5bfc43039c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Experimental.meta b/Assets/Mirror/Components/Experimental.meta new file mode 100644 index 0000000..57cce38 --- /dev/null +++ b/Assets/Mirror/Components/Experimental.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: bfbf2a1f2b300c5489dcab219ef2846e +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs b/Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs new file mode 100644 index 0000000..1b19ab7 --- /dev/null +++ b/Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs @@ -0,0 +1,90 @@ +using System; +using UnityEngine; + +namespace Mirror.Experimental +{ + [AddComponentMenu("Network/ Experimental/Network Lerp Rigidbody")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-lerp-rigidbody")] + [Obsolete("Use the new NetworkRigidbodyReliable/Unreliable component with Snapshot Interpolation instead.")] + public class NetworkLerpRigidbody : NetworkBehaviour + { + [Header("Settings")] + [SerializeField] internal Rigidbody target = null; + + [Tooltip("How quickly current velocity approaches target velocity")] + [SerializeField] float lerpVelocityAmount = 0.5f; + + [Tooltip("How quickly current position approaches target position")] + [SerializeField] float lerpPositionAmount = 0.5f; + + [Tooltip("Set to true if moves come from owner client, set to false if moves always come from server")] + [SerializeField] bool clientAuthority = false; + + double nextSyncTime; + + [SyncVar()] + Vector3 targetVelocity; + + [SyncVar()] + Vector3 targetPosition; + + /// + /// Ignore value if is host or client with Authority + /// + bool IgnoreSync => isServer || ClientWithAuthority; + + bool ClientWithAuthority => clientAuthority && isOwned; + + protected override void OnValidate() + { + base.OnValidate(); + if (target == null) + target = GetComponent(); + } + + void Update() + { + if (isServer) + SyncToClients(); + else if (ClientWithAuthority) + SendToServer(); + } + + void SyncToClients() + { + targetVelocity = target.velocity; + targetPosition = target.position; + } + + void SendToServer() + { + double now = NetworkTime.localTime; // Unity 2019 doesn't have Time.timeAsDouble yet + if (now > nextSyncTime) + { + nextSyncTime = now + syncInterval; + CmdSendState(target.velocity, target.position); + } + } + + [Command] + void CmdSendState(Vector3 velocity, Vector3 position) + { + target.velocity = velocity; + target.position = position; + targetVelocity = velocity; + targetPosition = position; + } + + void FixedUpdate() + { + if (IgnoreSync) { return; } + + target.velocity = Vector3.Lerp(target.velocity, targetVelocity, lerpVelocityAmount); + target.position = Vector3.Lerp(target.position, targetPosition, lerpPositionAmount); + // add velocity to position as position would have moved on server at that velocity + target.position += target.velocity * Time.fixedDeltaTime; + + // TODO does this also need to sync acceleration so and update velocity? + } + } +} diff --git a/Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs.meta b/Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs.meta new file mode 100644 index 0000000..35ef1fe --- /dev/null +++ b/Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 7f032128052c95a46afb0ddd97d994cc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Experimental/NetworkRigidbody.cs b/Assets/Mirror/Components/Experimental/NetworkRigidbody.cs new file mode 100644 index 0000000..0c2498d --- /dev/null +++ b/Assets/Mirror/Components/Experimental/NetworkRigidbody.cs @@ -0,0 +1,347 @@ +using System; +using UnityEngine; + +namespace Mirror.Experimental +{ + [AddComponentMenu("Network/ Experimental/Network Rigidbody")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-rigidbody")] + [Obsolete("Use the new NetworkRigidbodyReliable/Unreliable component with Snapshot Interpolation instead.")] + public class NetworkRigidbody : NetworkBehaviour + { + [Header("Settings")] + [SerializeField] internal Rigidbody target = null; + + [Tooltip("Set to true if moves come from owner client, set to false if moves always come from server")] + public bool clientAuthority = false; + + [Header("Velocity")] + [Tooltip("Syncs Velocity every SyncInterval")] + [SerializeField] bool syncVelocity = true; + + [Tooltip("Set velocity to 0 each frame (only works if syncVelocity is false")] + [SerializeField] bool clearVelocity = false; + + [Tooltip("Only Syncs Value if distance between previous and current is great than sensitivity")] + [SerializeField] float velocitySensitivity = 0.1f; + + [Header("Angular Velocity")] + [Tooltip("Syncs AngularVelocity every SyncInterval")] + [SerializeField] bool syncAngularVelocity = true; + + [Tooltip("Set angularVelocity to 0 each frame (only works if syncAngularVelocity is false")] + [SerializeField] bool clearAngularVelocity = false; + + [Tooltip("Only Syncs Value if distance between previous and current is great than sensitivity")] + [SerializeField] float angularVelocitySensitivity = 0.1f; + + /// + /// Values sent on client with authority after they are sent to the server + /// + readonly ClientSyncState previousValue = new ClientSyncState(); + + protected override void OnValidate() + { + base.OnValidate(); + if (target == null) + target = GetComponent(); + } + + #region Sync vars + + [SyncVar(hook = nameof(OnVelocityChanged))] + Vector3 velocity; + + [SyncVar(hook = nameof(OnAngularVelocityChanged))] + Vector3 angularVelocity; + + [SyncVar(hook = nameof(OnIsKinematicChanged))] + bool isKinematic; + + [SyncVar(hook = nameof(OnUseGravityChanged))] + bool useGravity; + + [SyncVar(hook = nameof(OnuDragChanged))] + float drag; + + [SyncVar(hook = nameof(OnAngularDragChanged))] + float angularDrag; + + /// + /// Ignore value if is host or client with Authority + /// + /// + bool IgnoreSync => isServer || ClientWithAuthority; + + bool ClientWithAuthority => clientAuthority && isOwned; + + void OnVelocityChanged(Vector3 _, Vector3 newValue) + { + if (IgnoreSync) + return; + + target.velocity = newValue; + } + + void OnAngularVelocityChanged(Vector3 _, Vector3 newValue) + { + if (IgnoreSync) + return; + + target.angularVelocity = newValue; + } + + void OnIsKinematicChanged(bool _, bool newValue) + { + if (IgnoreSync) + return; + + target.isKinematic = newValue; + } + + void OnUseGravityChanged(bool _, bool newValue) + { + if (IgnoreSync) + return; + + target.useGravity = newValue; + } + + void OnuDragChanged(float _, float newValue) + { + if (IgnoreSync) + return; + + target.drag = newValue; + } + + void OnAngularDragChanged(float _, float newValue) + { + if (IgnoreSync) + return; + + target.angularDrag = newValue; + } + + #endregion + + internal void Update() + { + if (isServer) + SyncToClients(); + else if (ClientWithAuthority) + SendToServer(); + } + + internal void FixedUpdate() + { + if (clearAngularVelocity && !syncAngularVelocity) + target.angularVelocity = Vector3.zero; + + if (clearVelocity && !syncVelocity) + target.velocity = Vector3.zero; + } + + /// + /// Updates sync var values on server so that they sync to the client + /// + [Server] + void SyncToClients() + { + // only update if they have changed more than Sensitivity + + Vector3 currentVelocity = syncVelocity ? target.velocity : default; + Vector3 currentAngularVelocity = syncAngularVelocity ? target.angularVelocity : default; + + bool velocityChanged = syncVelocity && ((previousValue.velocity - currentVelocity).sqrMagnitude > velocitySensitivity * velocitySensitivity); + bool angularVelocityChanged = syncAngularVelocity && ((previousValue.angularVelocity - currentAngularVelocity).sqrMagnitude > angularVelocitySensitivity * angularVelocitySensitivity); + + if (velocityChanged) + { + velocity = currentVelocity; + previousValue.velocity = currentVelocity; + } + + if (angularVelocityChanged) + { + angularVelocity = currentAngularVelocity; + previousValue.angularVelocity = currentAngularVelocity; + } + + // other rigidbody settings + isKinematic = target.isKinematic; + useGravity = target.useGravity; + drag = target.drag; + angularDrag = target.angularDrag; + } + + /// + /// Uses Command to send values to server + /// + [Client] + void SendToServer() + { + if (!isOwned) + { + Debug.LogWarning("SendToServer called without authority"); + return; + } + + SendVelocity(); + SendRigidBodySettings(); + } + + [Client] + void SendVelocity() + { + double now = NetworkTime.localTime; // Unity 2019 doesn't have Time.timeAsDouble yet + if (now < previousValue.nextSyncTime) + return; + + Vector3 currentVelocity = syncVelocity ? target.velocity : default; + Vector3 currentAngularVelocity = syncAngularVelocity ? target.angularVelocity : default; + + bool velocityChanged = syncVelocity && ((previousValue.velocity - currentVelocity).sqrMagnitude > velocitySensitivity * velocitySensitivity); + bool angularVelocityChanged = syncAngularVelocity && ((previousValue.angularVelocity - currentAngularVelocity).sqrMagnitude > angularVelocitySensitivity * angularVelocitySensitivity); + + // if angularVelocity has changed it is likely that velocity has also changed so just sync both values + // however if only velocity has changed just send velocity + if (angularVelocityChanged) + { + CmdSendVelocityAndAngular(currentVelocity, currentAngularVelocity); + previousValue.velocity = currentVelocity; + previousValue.angularVelocity = currentAngularVelocity; + } + else if (velocityChanged) + { + CmdSendVelocity(currentVelocity); + previousValue.velocity = currentVelocity; + } + + + // only update syncTime if either has changed + if (angularVelocityChanged || velocityChanged) + previousValue.nextSyncTime = now + syncInterval; + } + + [Client] + void SendRigidBodySettings() + { + // These shouldn't change often so it is ok to send in their own Command + if (previousValue.isKinematic != target.isKinematic) + { + CmdSendIsKinematic(target.isKinematic); + previousValue.isKinematic = target.isKinematic; + } + if (previousValue.useGravity != target.useGravity) + { + CmdSendUseGravity(target.useGravity); + previousValue.useGravity = target.useGravity; + } + if (previousValue.drag != target.drag) + { + CmdSendDrag(target.drag); + previousValue.drag = target.drag; + } + if (previousValue.angularDrag != target.angularDrag) + { + CmdSendAngularDrag(target.angularDrag); + previousValue.angularDrag = target.angularDrag; + } + } + + /// + /// Called when only Velocity has changed on the client + /// + [Command] + void CmdSendVelocity(Vector3 velocity) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.velocity = velocity; + target.velocity = velocity; + } + + /// + /// Called when angularVelocity has changed on the client + /// + [Command] + void CmdSendVelocityAndAngular(Vector3 velocity, Vector3 angularVelocity) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + if (syncVelocity) + { + this.velocity = velocity; + target.velocity = velocity; + } + + this.angularVelocity = angularVelocity; + target.angularVelocity = angularVelocity; + } + + [Command] + void CmdSendIsKinematic(bool isKinematic) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.isKinematic = isKinematic; + target.isKinematic = isKinematic; + } + + [Command] + void CmdSendUseGravity(bool useGravity) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.useGravity = useGravity; + target.useGravity = useGravity; + } + + [Command] + void CmdSendDrag(float drag) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.drag = drag; + target.drag = drag; + } + + [Command] + void CmdSendAngularDrag(float angularDrag) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.angularDrag = angularDrag; + target.angularDrag = angularDrag; + } + + /// + /// holds previously synced values + /// + public class ClientSyncState + { + /// + /// Next sync time that velocity will be synced, based on syncInterval. + /// + public double nextSyncTime; + public Vector3 velocity; + public Vector3 angularVelocity; + public bool isKinematic; + public bool useGravity; + public float drag; + public float angularDrag; + } + } +} diff --git a/Assets/Mirror/Components/Experimental/NetworkRigidbody.cs.meta b/Assets/Mirror/Components/Experimental/NetworkRigidbody.cs.meta new file mode 100644 index 0000000..1610f0a --- /dev/null +++ b/Assets/Mirror/Components/Experimental/NetworkRigidbody.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 83392ae5c1b731446909f252fd494ae4 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Experimental/NetworkRigidbody2D.cs b/Assets/Mirror/Components/Experimental/NetworkRigidbody2D.cs new file mode 100644 index 0000000..e3bdd29 --- /dev/null +++ b/Assets/Mirror/Components/Experimental/NetworkRigidbody2D.cs @@ -0,0 +1,342 @@ +using UnityEngine; + +namespace Mirror.Experimental +{ + [AddComponentMenu("Network/ Experimental/Network Rigidbody 2D")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-rigidbody")] + public class NetworkRigidbody2D : NetworkBehaviour + { + [Header("Settings")] + [SerializeField] internal Rigidbody2D target = null; + + [Tooltip("Set to true if moves come from owner client, set to false if moves always come from server")] + public bool clientAuthority = false; + + [Header("Velocity")] + [Tooltip("Syncs Velocity every SyncInterval")] + [SerializeField] bool syncVelocity = true; + + [Tooltip("Set velocity to 0 each frame (only works if syncVelocity is false")] + [SerializeField] bool clearVelocity = false; + + [Tooltip("Only Syncs Value if distance between previous and current is great than sensitivity")] + [SerializeField] float velocitySensitivity = 0.1f; + + [Header("Angular Velocity")] + [Tooltip("Syncs AngularVelocity every SyncInterval")] + [SerializeField] bool syncAngularVelocity = true; + + [Tooltip("Set angularVelocity to 0 each frame (only works if syncAngularVelocity is false")] + [SerializeField] bool clearAngularVelocity = false; + + [Tooltip("Only Syncs Value if distance between previous and current is great than sensitivity")] + [SerializeField] float angularVelocitySensitivity = 0.1f; + + /// + /// Values sent on client with authority after they are sent to the server + /// + readonly ClientSyncState previousValue = new ClientSyncState(); + + protected override void OnValidate() + { + base.OnValidate(); + if (target == null) + target = GetComponent(); + } + + #region Sync vars + + [SyncVar(hook = nameof(OnVelocityChanged))] + Vector2 velocity; + + [SyncVar(hook = nameof(OnAngularVelocityChanged))] + float angularVelocity; + + [SyncVar(hook = nameof(OnIsKinematicChanged))] + bool isKinematic; + + [SyncVar(hook = nameof(OnGravityScaleChanged))] + float gravityScale; + + [SyncVar(hook = nameof(OnuDragChanged))] + float drag; + + [SyncVar(hook = nameof(OnAngularDragChanged))] + float angularDrag; + + /// + /// Ignore value if is host or client with Authority + /// + bool IgnoreSync => isServer || ClientWithAuthority; + + bool ClientWithAuthority => clientAuthority && isOwned; + + void OnVelocityChanged(Vector2 _, Vector2 newValue) + { + if (IgnoreSync) + return; + + target.velocity = newValue; + } + + void OnAngularVelocityChanged(float _, float newValue) + { + if (IgnoreSync) + return; + + target.angularVelocity = newValue; + } + + void OnIsKinematicChanged(bool _, bool newValue) + { + if (IgnoreSync) + return; + + target.isKinematic = newValue; + } + + void OnGravityScaleChanged(float _, float newValue) + { + if (IgnoreSync) + return; + + target.gravityScale = newValue; + } + + void OnuDragChanged(float _, float newValue) + { + if (IgnoreSync) + return; + + target.drag = newValue; + } + + void OnAngularDragChanged(float _, float newValue) + { + if (IgnoreSync) + return; + + target.angularDrag = newValue; + } + + #endregion + + internal void Update() + { + if (isServer) + SyncToClients(); + else if (ClientWithAuthority) + SendToServer(); + } + + internal void FixedUpdate() + { + if (clearAngularVelocity && !syncAngularVelocity) + target.angularVelocity = 0f; + + if (clearVelocity && !syncVelocity) + target.velocity = Vector2.zero; + } + + /// + /// Updates sync var values on server so that they sync to the client + /// + [Server] + void SyncToClients() + { + // only update if they have changed more than Sensitivity + + Vector2 currentVelocity = syncVelocity ? target.velocity : default; + float currentAngularVelocity = syncAngularVelocity ? target.angularVelocity : default; + + bool velocityChanged = syncVelocity && ((previousValue.velocity - currentVelocity).sqrMagnitude > velocitySensitivity * velocitySensitivity); + bool angularVelocityChanged = syncAngularVelocity && ((previousValue.angularVelocity - currentAngularVelocity) > angularVelocitySensitivity); + + if (velocityChanged) + { + velocity = currentVelocity; + previousValue.velocity = currentVelocity; + } + + if (angularVelocityChanged) + { + angularVelocity = currentAngularVelocity; + previousValue.angularVelocity = currentAngularVelocity; + } + + // other rigidbody settings + isKinematic = target.isKinematic; + gravityScale = target.gravityScale; + drag = target.drag; + angularDrag = target.angularDrag; + } + + /// + /// Uses Command to send values to server + /// + [Client] + void SendToServer() + { + if (!isOwned) + { + Debug.LogWarning("SendToServer called without authority"); + return; + } + + SendVelocity(); + SendRigidBodySettings(); + } + + [Client] + void SendVelocity() + { + float now = Time.time; + if (now < previousValue.nextSyncTime) + return; + + Vector2 currentVelocity = syncVelocity ? target.velocity : default; + float currentAngularVelocity = syncAngularVelocity ? target.angularVelocity : default; + + bool velocityChanged = syncVelocity && ((previousValue.velocity - currentVelocity).sqrMagnitude > velocitySensitivity * velocitySensitivity); + bool angularVelocityChanged = syncAngularVelocity && previousValue.angularVelocity != currentAngularVelocity;//((previousValue.angularVelocity - currentAngularVelocity).sqrMagnitude > angularVelocitySensitivity * angularVelocitySensitivity); + + // if angularVelocity has changed it is likely that velocity has also changed so just sync both values + // however if only velocity has changed just send velocity + if (angularVelocityChanged) + { + CmdSendVelocityAndAngular(currentVelocity, currentAngularVelocity); + previousValue.velocity = currentVelocity; + previousValue.angularVelocity = currentAngularVelocity; + } + else if (velocityChanged) + { + CmdSendVelocity(currentVelocity); + previousValue.velocity = currentVelocity; + } + + // only update syncTime if either has changed + if (angularVelocityChanged || velocityChanged) + previousValue.nextSyncTime = now + syncInterval; + } + + [Client] + void SendRigidBodySettings() + { + // These shouldn't change often so it is ok to send in their own Command + if (previousValue.isKinematic != target.isKinematic) + { + CmdSendIsKinematic(target.isKinematic); + previousValue.isKinematic = target.isKinematic; + } + if (previousValue.gravityScale != target.gravityScale) + { + CmdChangeGravityScale(target.gravityScale); + previousValue.gravityScale = target.gravityScale; + } + if (previousValue.drag != target.drag) + { + CmdSendDrag(target.drag); + previousValue.drag = target.drag; + } + if (previousValue.angularDrag != target.angularDrag) + { + CmdSendAngularDrag(target.angularDrag); + previousValue.angularDrag = target.angularDrag; + } + } + + /// + /// Called when only Velocity has changed on the client + /// + [Command] + void CmdSendVelocity(Vector2 velocity) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.velocity = velocity; + target.velocity = velocity; + } + + /// + /// Called when angularVelocity has changed on the client + /// + [Command] + void CmdSendVelocityAndAngular(Vector2 velocity, float angularVelocity) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + if (syncVelocity) + { + this.velocity = velocity; + target.velocity = velocity; + } + this.angularVelocity = angularVelocity; + target.angularVelocity = angularVelocity; + } + + [Command] + void CmdSendIsKinematic(bool isKinematic) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.isKinematic = isKinematic; + target.isKinematic = isKinematic; + } + + [Command] + void CmdChangeGravityScale(float gravityScale) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.gravityScale = gravityScale; + target.gravityScale = gravityScale; + } + + [Command] + void CmdSendDrag(float drag) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.drag = drag; + target.drag = drag; + } + + [Command] + void CmdSendAngularDrag(float angularDrag) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + this.angularDrag = angularDrag; + target.angularDrag = angularDrag; + } + + /// + /// holds previously synced values + /// + public class ClientSyncState + { + /// + /// Next sync time that velocity will be synced, based on syncInterval. + /// + public float nextSyncTime; + public Vector2 velocity; + public float angularVelocity; + public bool isKinematic; + public float gravityScale; + public float drag; + public float angularDrag; + } + } +} diff --git a/Assets/Mirror/Components/Experimental/NetworkRigidbody2D.cs.meta b/Assets/Mirror/Components/Experimental/NetworkRigidbody2D.cs.meta new file mode 100644 index 0000000..df466bd --- /dev/null +++ b/Assets/Mirror/Components/Experimental/NetworkRigidbody2D.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ab2cbc52526ea384ba280d13cd1a57b9 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/GUIConsole.cs b/Assets/Mirror/Components/GUIConsole.cs new file mode 100644 index 0000000..c6acbb8 --- /dev/null +++ b/Assets/Mirror/Components/GUIConsole.cs @@ -0,0 +1,115 @@ +// People should be able to see and report errors to the developer very easily. +// +// Unity's Developer Console only works in development builds and it only shows +// errors. This class provides a console that works in all builds and also shows +// log and warnings in development builds. +// +// Note: we don't include the stack trace, because that can also be grabbed from +// the log files if needed. +// +// Note: there is no 'hide' button because we DO want people to see those errors +// and report them back to us. +// +// Note: normal Debug.Log messages can be shown by building in Debug/Development +// mode. +using UnityEngine; +using System.Collections.Generic; + +namespace Mirror +{ + struct LogEntry + { + public string message; + public LogType type; + + public LogEntry(string message, LogType type) + { + this.message = message; + this.type = type; + } + } + + public class GUIConsole : MonoBehaviour + { + public int height = 150; + + // only keep the recent 'n' entries. otherwise memory would grow forever + // and drawing would get slower and slower. + public int maxLogCount = 50; + + // log as queue so we can remove the first entry easily + Queue log = new Queue(); + + // hotkey to show/hide at runtime for easier debugging + // (sometimes we need to temporarily hide/show it) + // => F12 makes sense. nobody can find ^ in other games. + public KeyCode hotKey = KeyCode.F12; + + // GUI + bool visible; + Vector2 scroll = Vector2.zero; + + void Awake() + { + Application.logMessageReceived += OnLog; + } + + // OnLog logs everything, even Debug.Log messages in release builds + // => this makes a lot of things easier. e.g. addon initialization logs. + // => it's really better to have than not to have those + void OnLog(string message, string stackTrace, LogType type) + { + // is this important? + // => always show exceptions & errors + // => usually a good idea to show warnings too, otherwise it's too + // easy to miss OnDeserialize warnings etc. in builds + bool isImportant = type == LogType.Error || type == LogType.Exception || type == LogType.Warning; + + // use stack trace only if important + // (otherwise users would have to find and search the log file. + // seeing it in the console directly is way easier to deal with.) + // => only add \n if stack trace is available (only in debug builds) + if (isImportant && !string.IsNullOrWhiteSpace(stackTrace)) + message += $"\n{stackTrace}"; + + // add to queue + log.Enqueue(new LogEntry(message, type)); + + // respect max entries + if (log.Count > maxLogCount) + log.Dequeue(); + + // become visible if it was important + // (no need to become visible for regular log. let the user decide.) + if (isImportant) + visible = true; + + // auto scroll + scroll.y = float.MaxValue; + } + + void Update() + { + if (Input.GetKeyDown(hotKey)) + visible = !visible; + } + + void OnGUI() + { + if (!visible) return; + + scroll = GUILayout.BeginScrollView(scroll, "Box", GUILayout.Width(Screen.width), GUILayout.Height(height)); + foreach (LogEntry entry in log) + { + if (entry.type == LogType.Error || entry.type == LogType.Exception) + GUI.color = Color.red; + else if (entry.type == LogType.Warning) + GUI.color = Color.yellow; + + GUILayout.Label(entry.message); + GUI.color = Color.white; + } + GUILayout.EndScrollView(); + } + } +} diff --git a/Assets/Mirror/Components/GUIConsole.cs.meta b/Assets/Mirror/Components/GUIConsole.cs.meta new file mode 100644 index 0000000..5664216 --- /dev/null +++ b/Assets/Mirror/Components/GUIConsole.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 9021b6cc314944290986ab6feb48db79 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement.meta b/Assets/Mirror/Components/InterestManagement.meta new file mode 100644 index 0000000..9b1f746 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: c66f27e006ab94253b39a55a3b213651 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/Distance.meta b/Assets/Mirror/Components/InterestManagement/Distance.meta new file mode 100644 index 0000000..9847902 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Distance.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: fa4cbc6b9c584db4971985cb9f369077 +timeCreated: 1613110605 \ No newline at end of file diff --git a/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagement.cs b/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagement.cs new file mode 100644 index 0000000..0441558 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagement.cs @@ -0,0 +1,90 @@ +// straight forward Vector3.Distance based interest management. +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + [AddComponentMenu("Network/ Interest Management/ Distance/Distance Interest Management")] + public class DistanceInterestManagement : InterestManagement + { + [Tooltip("The maximum range that objects will be visible at. Add DistanceInterestManagementCustomRange onto NetworkIdentities for custom ranges.")] + public int visRange = 500; + + [Tooltip("Rebuild all every 'rebuildInterval' seconds.")] + public float rebuildInterval = 1; + double lastRebuildTime; + + // cache custom ranges to avoid runtime TryGetComponent lookups + readonly Dictionary CustomRanges = new Dictionary(); + + // helper function to get vis range for a given object, or default. + [ServerCallback] + int GetVisRange(NetworkIdentity identity) + { + return CustomRanges.TryGetValue(identity, out DistanceInterestManagementCustomRange custom) ? custom.visRange : visRange; + } + + [ServerCallback] + public override void Reset() + { + lastRebuildTime = 0D; + CustomRanges.Clear(); + } + + public override void OnSpawned(NetworkIdentity identity) + { + if (identity.TryGetComponent(out DistanceInterestManagementCustomRange custom)) + CustomRanges[identity] = custom; + } + + public override void OnDestroyed(NetworkIdentity identity) + { + CustomRanges.Remove(identity); + } + + public override bool OnCheckObserver(NetworkIdentity identity, NetworkConnectionToClient newObserver) + { + int range = GetVisRange(identity); + return Vector3.Distance(identity.transform.position, newObserver.identity.transform.position) < range; + } + + public override void OnRebuildObservers(NetworkIdentity identity, HashSet newObservers) + { + // cache range and .transform because both call GetComponent. + int range = GetVisRange(identity); + Vector3 position = identity.transform.position; + + // brute force distance check + // -> only player connections can be observers, so it's enough if we + // go through all connections instead of all spawned identities. + // -> compared to UNET's sphere cast checking, this one is orders of + // magnitude faster. if we have 10k monsters and run a sphere + // cast 10k times, we will see a noticeable lag even with physics + // layers. but checking to every connection is fast. + foreach (NetworkConnectionToClient conn in NetworkServer.connections.Values) + { + // authenticated and joined world with a player? + if (conn != null && conn.isAuthenticated && conn.identity != null) + { + // check distance + if (Vector3.Distance(conn.identity.transform.position, position) < range) + { + newObservers.Add(conn); + } + } + } + } + + // internal so we can update from tests + [ServerCallback] + internal void Update() + { + // rebuild all spawned NetworkIdentity's observers every interval + if (NetworkTime.localTime >= lastRebuildTime + rebuildInterval) + { + RebuildAll(); + lastRebuildTime = NetworkTime.localTime; + } + } + } +} diff --git a/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagement.cs.meta b/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagement.cs.meta new file mode 100644 index 0000000..1a575af --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagement.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8f60becab051427fbdd3c8ac9ab4712b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagementCustomRange.cs b/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagementCustomRange.cs new file mode 100644 index 0000000..12556e5 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagementCustomRange.cs @@ -0,0 +1,15 @@ +// add this to NetworkIdentities for custom range if needed. +// only works with DistanceInterestManagement. +using UnityEngine; + +namespace Mirror +{ + [DisallowMultipleComponent] + [AddComponentMenu("Network/ Interest Management/ Distance/Distance Custom Range")] + [HelpURL("https://mirror-networking.gitbook.io/docs/guides/interest-management")] + public class DistanceInterestManagementCustomRange : NetworkBehaviour + { + [Tooltip("The maximum range that objects will be visible at.")] + public int visRange = 100; + } +} diff --git a/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagementCustomRange.cs.meta b/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagementCustomRange.cs.meta new file mode 100644 index 0000000..406ca78 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Distance/DistanceInterestManagementCustomRange.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b2e242ee38a14076a39934172a19079b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/Match.meta b/Assets/Mirror/Components/InterestManagement/Match.meta new file mode 100644 index 0000000..e429883 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Match.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 5eca5245ae6bb460e9a92f7e14d5493a +timeCreated: 1622649517 \ No newline at end of file diff --git a/Assets/Mirror/Components/InterestManagement/Match/MatchInterestManagement.cs b/Assets/Mirror/Components/InterestManagement/Match/MatchInterestManagement.cs new file mode 100644 index 0000000..516cf55 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Match/MatchInterestManagement.cs @@ -0,0 +1,174 @@ +using System; +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + [AddComponentMenu("Network/ Interest Management/ Match/Match Interest Management")] + public class MatchInterestManagement : InterestManagement + { + readonly Dictionary> matchObjects = + new Dictionary>(); + + readonly Dictionary lastObjectMatch = + new Dictionary(); + + readonly HashSet dirtyMatches = new HashSet(); + + [ServerCallback] + public override void OnSpawned(NetworkIdentity identity) + { + if (!identity.TryGetComponent(out NetworkMatch networkMatch)) + return; + + Guid networkMatchId = networkMatch.matchId; + lastObjectMatch[identity] = networkMatchId; + + // Guid.Empty is never a valid matchId...do not add to matchObjects collection + if (networkMatchId == Guid.Empty) + return; + + // Debug.Log($"MatchInterestManagement.OnSpawned({identity.name}) currentMatch: {currentMatch}"); + if (!matchObjects.TryGetValue(networkMatchId, out HashSet objects)) + { + objects = new HashSet(); + matchObjects.Add(networkMatchId, objects); + } + + objects.Add(identity); + + // Match ID could have been set in NetworkBehaviour::OnStartServer on this object. + // Since that's after OnCheckObserver is called it would be missed, so force Rebuild here. + // Add the current match to dirtyMatches for Update to rebuild it. + dirtyMatches.Add(networkMatchId); + } + + [ServerCallback] + public override void OnDestroyed(NetworkIdentity identity) + { + // Don't RebuildSceneObservers here - that will happen in Update. + // Multiple objects could be destroyed in same frame and we don't + // want to rebuild for each one...let Update do it once. + // We must add the current match to dirtyMatches for Update to rebuild it. + if (lastObjectMatch.TryGetValue(identity, out Guid currentMatch)) + { + lastObjectMatch.Remove(identity); + if (currentMatch != Guid.Empty && matchObjects.TryGetValue(currentMatch, out HashSet objects) && objects.Remove(identity)) + dirtyMatches.Add(currentMatch); + } + } + + // internal so we can update from tests + [ServerCallback] + internal void Update() + { + // for each spawned: + // if match changed: + // add previous to dirty + // add new to dirty + foreach (NetworkIdentity identity in NetworkServer.spawned.Values) + { + // Ignore objects that don't have a NetworkMatch component + if (!identity.TryGetComponent(out NetworkMatch networkMatch)) + continue; + + Guid newMatch = networkMatch.matchId; + if (!lastObjectMatch.TryGetValue(identity, out Guid currentMatch)) + continue; + + // Guid.Empty is never a valid matchId + // Nothing to do if matchId hasn't changed + if (newMatch == Guid.Empty || newMatch == currentMatch) + continue; + + // Mark new/old matches as dirty so they get rebuilt + UpdateDirtyMatches(newMatch, currentMatch); + + // This object is in a new match so observers in the prior match + // and the new match need to rebuild their respective observers lists. + UpdateMatchObjects(identity, newMatch, currentMatch); + } + + // rebuild all dirty matches + foreach (Guid dirtyMatch in dirtyMatches) + RebuildMatchObservers(dirtyMatch); + + dirtyMatches.Clear(); + } + + void UpdateDirtyMatches(Guid newMatch, Guid currentMatch) + { + // Guid.Empty is never a valid matchId + if (currentMatch != Guid.Empty) + dirtyMatches.Add(currentMatch); + + dirtyMatches.Add(newMatch); + } + + void UpdateMatchObjects(NetworkIdentity netIdentity, Guid newMatch, Guid currentMatch) + { + // Remove this object from the hashset of the match it just left + // Guid.Empty is never a valid matchId + if (currentMatch != Guid.Empty) + matchObjects[currentMatch].Remove(netIdentity); + + // Set this to the new match this object just entered + lastObjectMatch[netIdentity] = newMatch; + + // Make sure this new match is in the dictionary + if (!matchObjects.ContainsKey(newMatch)) + matchObjects.Add(newMatch, new HashSet()); + + // Add this object to the hashset of the new match + matchObjects[newMatch].Add(netIdentity); + } + + void RebuildMatchObservers(Guid matchId) + { + foreach (NetworkIdentity netIdentity in matchObjects[matchId]) + if (netIdentity != null) + NetworkServer.RebuildObservers(netIdentity, false); + } + + public override bool OnCheckObserver(NetworkIdentity identity, NetworkConnectionToClient newObserver) + { + // Never observed if no NetworkMatch component + if (!identity.TryGetComponent(out NetworkMatch identityNetworkMatch)) + return false; + + // Guid.Empty is never a valid matchId + if (identityNetworkMatch.matchId == Guid.Empty) + return false; + + // Never observed if no NetworkMatch component + if (!newObserver.identity.TryGetComponent(out NetworkMatch newObserverNetworkMatch)) + return false; + + // Guid.Empty is never a valid matchId + if (newObserverNetworkMatch.matchId == Guid.Empty) + return false; + + return identityNetworkMatch.matchId == newObserverNetworkMatch.matchId; + } + + public override void OnRebuildObservers(NetworkIdentity identity, HashSet newObservers) + { + if (!identity.TryGetComponent(out NetworkMatch networkMatch)) + return; + + Guid matchId = networkMatch.matchId; + + // Guid.Empty is never a valid matchId + if (matchId == Guid.Empty) + return; + + if (!matchObjects.TryGetValue(matchId, out HashSet objects)) + return; + + // Add everything in the hashset for this object's current match + foreach (NetworkIdentity networkIdentity in objects) + if (networkIdentity != null && networkIdentity.connectionToClient != null) + newObservers.Add(networkIdentity.connectionToClient); + } + } +} diff --git a/Assets/Mirror/Components/InterestManagement/Match/MatchInterestManagement.cs.meta b/Assets/Mirror/Components/InterestManagement/Match/MatchInterestManagement.cs.meta new file mode 100644 index 0000000..605d215 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Match/MatchInterestManagement.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d09f5c8bf2f4747b7a9284ef5d9ce2a7 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/Match/NetworkMatch.cs b/Assets/Mirror/Components/InterestManagement/Match/NetworkMatch.cs new file mode 100644 index 0000000..f6689f2 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Match/NetworkMatch.cs @@ -0,0 +1,15 @@ +// simple component that holds match information +using System; +using UnityEngine; + +namespace Mirror +{ + [DisallowMultipleComponent] + [AddComponentMenu("Network/ Interest Management/ Match/Network Match")] + [HelpURL("https://mirror-networking.gitbook.io/docs/guides/interest-management")] + public class NetworkMatch : NetworkBehaviour + { + ///Set this to the same value on all networked objects that belong to a given match + public Guid matchId; + } +} diff --git a/Assets/Mirror/Components/InterestManagement/Match/NetworkMatch.cs.meta b/Assets/Mirror/Components/InterestManagement/Match/NetworkMatch.cs.meta new file mode 100644 index 0000000..47fc70a --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Match/NetworkMatch.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 5d17e718851449a6879986e45c458fb7 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/Scene.meta b/Assets/Mirror/Components/InterestManagement/Scene.meta new file mode 100644 index 0000000..28b469f --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Scene.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 7655d309a46a4bd4860edf964228b3f6 +timeCreated: 1622649517 \ No newline at end of file diff --git a/Assets/Mirror/Components/InterestManagement/Scene/SceneInterestManagement.cs b/Assets/Mirror/Components/InterestManagement/Scene/SceneInterestManagement.cs new file mode 100644 index 0000000..28e5eba --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Scene/SceneInterestManagement.cs @@ -0,0 +1,118 @@ +using System.Collections.Generic; +using UnityEngine; +using UnityEngine.SceneManagement; + +namespace Mirror +{ + [AddComponentMenu("Network/ Interest Management/ Scene/Scene Interest Management")] + public class SceneInterestManagement : InterestManagement + { + // Use Scene instead of string scene.name because when additively + // loading multiples of a subscene the name won't be unique + readonly Dictionary> sceneObjects = + new Dictionary>(); + + readonly Dictionary lastObjectScene = + new Dictionary(); + + HashSet dirtyScenes = new HashSet(); + + [ServerCallback] + public override void OnSpawned(NetworkIdentity identity) + { + Scene currentScene = identity.gameObject.scene; + lastObjectScene[identity] = currentScene; + // Debug.Log($"SceneInterestManagement.OnSpawned({identity.name}) currentScene: {currentScene}"); + if (!sceneObjects.TryGetValue(currentScene, out HashSet objects)) + { + objects = new HashSet(); + sceneObjects.Add(currentScene, objects); + } + + objects.Add(identity); + } + + [ServerCallback] + public override void OnDestroyed(NetworkIdentity identity) + { + // Don't RebuildSceneObservers here - that will happen in Update. + // Multiple objects could be destroyed in same frame and we don't + // want to rebuild for each one...let Update do it once. + // We must add the current scene to dirtyScenes for Update to rebuild it. + if (lastObjectScene.TryGetValue(identity, out Scene currentScene)) + { + lastObjectScene.Remove(identity); + if (sceneObjects.TryGetValue(currentScene, out HashSet objects) && objects.Remove(identity)) + dirtyScenes.Add(currentScene); + } + } + + // internal so we can update from tests + [ServerCallback] + internal void Update() + { + // for each spawned: + // if scene changed: + // add previous to dirty + // add new to dirty + foreach (NetworkIdentity identity in NetworkServer.spawned.Values) + { + if (!lastObjectScene.TryGetValue(identity, out Scene currentScene)) + continue; + + Scene newScene = identity.gameObject.scene; + if (newScene == currentScene) + continue; + + // Mark new/old scenes as dirty so they get rebuilt + dirtyScenes.Add(currentScene); + dirtyScenes.Add(newScene); + + // This object is in a new scene so observers in the prior scene + // and the new scene need to rebuild their respective observers lists. + + // Remove this object from the hashset of the scene it just left + sceneObjects[currentScene].Remove(identity); + + // Set this to the new scene this object just entered + lastObjectScene[identity] = newScene; + + // Make sure this new scene is in the dictionary + if (!sceneObjects.ContainsKey(newScene)) + sceneObjects.Add(newScene, new HashSet()); + + // Add this object to the hashset of the new scene + sceneObjects[newScene].Add(identity); + } + + // rebuild all dirty scenes + foreach (Scene dirtyScene in dirtyScenes) + RebuildSceneObservers(dirtyScene); + + dirtyScenes.Clear(); + } + + void RebuildSceneObservers(Scene scene) + { + foreach (NetworkIdentity netIdentity in sceneObjects[scene]) + if (netIdentity != null) + NetworkServer.RebuildObservers(netIdentity, false); + } + + public override bool OnCheckObserver(NetworkIdentity identity, NetworkConnectionToClient newObserver) + { + return identity.gameObject.scene == newObserver.identity.gameObject.scene; + } + + public override void OnRebuildObservers(NetworkIdentity identity, HashSet newObservers) + { + if (!sceneObjects.TryGetValue(identity.gameObject.scene, out HashSet objects)) + return; + + // Add everything in the hashset for this object's current scene + foreach (NetworkIdentity networkIdentity in objects) + if (networkIdentity != null && networkIdentity.connectionToClient != null) + newObservers.Add(networkIdentity.connectionToClient); + } + } +} diff --git a/Assets/Mirror/Components/InterestManagement/Scene/SceneInterestManagement.cs.meta b/Assets/Mirror/Components/InterestManagement/Scene/SceneInterestManagement.cs.meta new file mode 100644 index 0000000..9cc1ff5 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Scene/SceneInterestManagement.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b979f26c95d34324ba005bfacfa9c4fc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/SpatialHashing.meta b/Assets/Mirror/Components/InterestManagement/SpatialHashing.meta new file mode 100644 index 0000000..00f5cd6 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/SpatialHashing.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: cfa12b73503344d49b398b01bcb07967 +timeCreated: 1613110634 \ No newline at end of file diff --git a/Assets/Mirror/Components/InterestManagement/SpatialHashing/Grid2D.cs b/Assets/Mirror/Components/InterestManagement/SpatialHashing/Grid2D.cs new file mode 100644 index 0000000..d557713 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/SpatialHashing/Grid2D.cs @@ -0,0 +1,104 @@ +// Grid2D from uMMORPG: get/set values of type T at any point +// -> not named 'Grid' because Unity already has a Grid type. causes warnings. +// -> struct to avoid memory indirection. it's accessed a lot. +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + // struct to avoid memory indirection. it's accessed a lot. + public struct Grid2D + { + // the grid + // note that we never remove old keys. + // => over time, HashSets will be allocated for every possible + // grid position in the world + // => Clear() doesn't clear them so we don't constantly reallocate the + // entries when populating the grid in every Update() call + // => makes the code a lot easier too + // => this is FINE because in the worst case, every grid position in the + // game world is filled with a player anyway! + readonly Dictionary> grid; + + // cache a 9 neighbor grid of vector2 offsets so we can use them more easily + readonly Vector2Int[] neighbourOffsets; + + public Grid2D(int initialCapacity) + { + grid = new Dictionary>(initialCapacity); + + neighbourOffsets = new[] { + Vector2Int.up, + Vector2Int.up + Vector2Int.left, + Vector2Int.up + Vector2Int.right, + Vector2Int.left, + Vector2Int.zero, + Vector2Int.right, + Vector2Int.down, + Vector2Int.down + Vector2Int.left, + Vector2Int.down + Vector2Int.right + }; + } + + // helper function so we can add an entry without worrying + public void Add(Vector2Int position, T value) + { + // initialize set in grid if it's not in there yet + if (!grid.TryGetValue(position, out HashSet hashSet)) + { + // each grid entry may hold hundreds of entities. + // let's create the HashSet with a large initial capacity + // in order to avoid resizing & allocations. +#if !UNITY_2021_3_OR_NEWER + // Unity 2019 doesn't have "new HashSet(capacity)" yet + hashSet = new HashSet(); +#else + hashSet = new HashSet(128); +#endif + grid[position] = hashSet; + } + + // add to it + hashSet.Add(value); + } + + // helper function to get set at position without worrying + // -> result is passed as parameter to avoid allocations + // -> result is not cleared before. this allows us to pass the HashSet from + // GetWithNeighbours and avoid .UnionWith which is very expensive. + void GetAt(Vector2Int position, HashSet result) + { + // return the set at position + if (grid.TryGetValue(position, out HashSet hashSet)) + { + foreach (T entry in hashSet) + result.Add(entry); + } + } + + // helper function to get at position and it's 8 neighbors without worrying + // -> result is passed as parameter to avoid allocations + public void GetWithNeighbours(Vector2Int position, HashSet result) + { + // clear result first + result.Clear(); + + // add neighbours + foreach (Vector2Int offset in neighbourOffsets) + GetAt(position + offset, result); + } + + // clear: clears the whole grid + // IMPORTANT: we already allocated HashSets and don't want to do + // reallocate every single update when we rebuild the grid. + // => so simply remove each position's entries, but keep + // every position in there + // => see 'grid' comments above! + // => named ClearNonAlloc to make it more obvious! + public void ClearNonAlloc() + { + foreach (HashSet hashSet in grid.Values) + hashSet.Clear(); + } + } +} diff --git a/Assets/Mirror/Components/InterestManagement/SpatialHashing/Grid2D.cs.meta b/Assets/Mirror/Components/InterestManagement/SpatialHashing/Grid2D.cs.meta new file mode 100644 index 0000000..f1d3cf0 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/SpatialHashing/Grid2D.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 7c5232a4d2854116a35d52b80ec07752 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/SpatialHashing/SpatialHashingInterestManagement.cs b/Assets/Mirror/Components/InterestManagement/SpatialHashing/SpatialHashingInterestManagement.cs new file mode 100644 index 0000000..2986034 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/SpatialHashing/SpatialHashingInterestManagement.cs @@ -0,0 +1,154 @@ +// extremely fast spatial hashing interest management based on uMMORPG GridChecker. +// => 30x faster in initial tests +// => scales way higher +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + [AddComponentMenu("Network/ Interest Management/ Spatial Hash/Spatial Hashing Interest Management")] + public class SpatialHashingInterestManagement : InterestManagement + { + [Tooltip("The maximum range that objects will be visible at.")] + public int visRange = 30; + + // we use a 9 neighbour grid. + // so we always see in a distance of 2 grids. + // for example, our own grid and then one on top / below / left / right. + // + // this means that grid resolution needs to be distance / 2. + // so for example, for distance = 30 we see 2 cells = 15 * 2 distance. + // + // on first sight, it seems we need distance / 3 (we see left/us/right). + // but that's not the case. + // resolution would be 10, and we only see 1 cell far, so 10+10=20. + public int resolution => visRange / 2; + + [Tooltip("Rebuild all every 'rebuildInterval' seconds.")] + public float rebuildInterval = 1; + double lastRebuildTime; + + public enum CheckMethod + { + XZ_FOR_3D, + XY_FOR_2D + } + [Tooltip("Spatial Hashing supports 3D (XZ) and 2D (XY) games.")] + public CheckMethod checkMethod = CheckMethod.XZ_FOR_3D; + + // debugging + public bool showSlider; + + // the grid + // begin with a large capacity to avoid resizing & allocations. + Grid2D grid = new Grid2D(1024); + + // project 3d world position to grid position + Vector2Int ProjectToGrid(Vector3 position) => + checkMethod == CheckMethod.XZ_FOR_3D + ? Vector2Int.RoundToInt(new Vector2(position.x, position.z) / resolution) + : Vector2Int.RoundToInt(new Vector2(position.x, position.y) / resolution); + + public override bool OnCheckObserver(NetworkIdentity identity, NetworkConnectionToClient newObserver) + { + // calculate projected positions + Vector2Int projected = ProjectToGrid(identity.transform.position); + Vector2Int observerProjected = ProjectToGrid(newObserver.identity.transform.position); + + // distance needs to be at max one of the 8 neighbors, which is + // 1 for the direct neighbors + // 1.41 for the diagonal neighbors (= sqrt(2)) + // => use sqrMagnitude and '2' to avoid computations. same result. + return (projected - observerProjected).sqrMagnitude <= 2; + } + + public override void OnRebuildObservers(NetworkIdentity identity, HashSet newObservers) + { + // add everyone in 9 neighbour grid + // -> pass observers to GetWithNeighbours directly to avoid allocations + // and expensive .UnionWith computations. + Vector2Int current = ProjectToGrid(identity.transform.position); + grid.GetWithNeighbours(current, newObservers); + } + + [ServerCallback] + public override void Reset() + { + lastRebuildTime = 0D; + } + + // update everyone's position in the grid + // (internal so we can update from tests) + [ServerCallback] + internal void Update() + { + // NOTE: unlike Scene/MatchInterestManagement, this rebuilds ALL + // entities every INTERVAL. consider the other approach later. + + // IMPORTANT: refresh grid every update! + // => newly spawned entities get observers assigned via + // OnCheckObservers. this can happen any time and we don't want + // them broadcast to old (moved or destroyed) connections. + // => players do move all the time. we want them to always be in the + // correct grid position. + // => note that the actual 'rebuildall' doesn't need to happen all + // the time. + // NOTE: consider refreshing grid only every 'interval' too. but not + // for now. stability & correctness matter. + + // clear old grid results before we update everyone's position. + // (this way we get rid of destroyed connections automatically) + // + // NOTE: keeps allocated HashSets internally. + // clearing & populating every frame works without allocations + grid.ClearNonAlloc(); + + // put every connection into the grid at it's main player's position + // NOTE: player sees in a radius around him. NOT around his pet too. + foreach (NetworkConnectionToClient connection in NetworkServer.connections.Values) + { + // authenticated and joined world with a player? + if (connection.isAuthenticated && connection.identity != null) + { + // calculate current grid position + Vector2Int position = ProjectToGrid(connection.identity.transform.position); + + // put into grid + grid.Add(position, connection); + } + } + + // rebuild all spawned entities' observers every 'interval' + // this will call OnRebuildObservers which then returns the + // observers at grid[position] for each entity. + if (NetworkTime.localTime >= lastRebuildTime + rebuildInterval) + { + RebuildAll(); + lastRebuildTime = NetworkTime.localTime; + } + } + +// OnGUI allocates even if it does nothing. avoid in release. +#if UNITY_EDITOR || DEVELOPMENT_BUILD + // slider from dotsnet. it's nice to play around with in the benchmark + // demo. + void OnGUI() + { + if (!showSlider) return; + + // only show while server is running. not on client, etc. + if (!NetworkServer.active) return; + + int height = 30; + int width = 250; + GUILayout.BeginArea(new Rect(Screen.width / 2 - width / 2, Screen.height - height, width, height)); + GUILayout.BeginHorizontal("Box"); + GUILayout.Label("Radius:"); + visRange = Mathf.RoundToInt(GUILayout.HorizontalSlider(visRange, 0, 200, GUILayout.Width(150))); + GUILayout.Label(visRange.ToString()); + GUILayout.EndHorizontal(); + GUILayout.EndArea(); + } +#endif + } +} diff --git a/Assets/Mirror/Components/InterestManagement/SpatialHashing/SpatialHashingInterestManagement.cs.meta b/Assets/Mirror/Components/InterestManagement/SpatialHashing/SpatialHashingInterestManagement.cs.meta new file mode 100644 index 0000000..271e433 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/SpatialHashing/SpatialHashingInterestManagement.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 39adc6e09d5544ed955a50ce8600355a +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/Team.meta b/Assets/Mirror/Components/InterestManagement/Team.meta new file mode 100644 index 0000000..fe40aa4 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Team.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 2d418e60072433b4bbebbf5f3a7de1bb +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/Team/NetworkTeam.cs b/Assets/Mirror/Components/InterestManagement/Team/NetworkTeam.cs new file mode 100644 index 0000000..ee02a07 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Team/NetworkTeam.cs @@ -0,0 +1,17 @@ +// simple component that holds team information +using UnityEngine; + +namespace Mirror +{ + [DisallowMultipleComponent] + [AddComponentMenu("Network/ Interest Management/ Team/Network Team")] + [HelpURL("https://mirror-networking.gitbook.io/docs/guides/interest-management")] + public class NetworkTeam : NetworkBehaviour + { + [Tooltip("Set this to the same value on all networked objects that belong to a given team")] + [SyncVar] public string teamId = string.Empty; + + [Tooltip("When enabled this object is visible to all clients. Typically this would be true for player objects")] + [SyncVar] public bool forceShown; + } +} diff --git a/Assets/Mirror/Components/InterestManagement/Team/NetworkTeam.cs.meta b/Assets/Mirror/Components/InterestManagement/Team/NetworkTeam.cs.meta new file mode 100644 index 0000000..ca75a7a --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Team/NetworkTeam.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2576730625b1632468cbcbfe5e721f88 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/InterestManagement/Team/TeamInterestManagement.cs b/Assets/Mirror/Components/InterestManagement/Team/TeamInterestManagement.cs new file mode 100644 index 0000000..7701c38 --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Team/TeamInterestManagement.cs @@ -0,0 +1,196 @@ +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + [AddComponentMenu("Network/ Interest Management/ Team/Team Interest Management")] + public class TeamInterestManagement : InterestManagement + { + readonly Dictionary> teamObjects = new Dictionary>(); + readonly Dictionary lastObjectTeam = new Dictionary(); + readonly HashSet dirtyTeams = new HashSet(); + + [ServerCallback] + public override void OnSpawned(NetworkIdentity identity) + { + if (!identity.TryGetComponent(out NetworkTeam identityNetworkTeam)) + return; + + string networkTeamId = identityNetworkTeam.teamId; + lastObjectTeam[identity] = networkTeamId; + + // Null / Empty string is never a valid teamId...do not add to teamObjects collection + if (string.IsNullOrWhiteSpace(networkTeamId)) + return; + + //Debug.Log($"TeamInterestManagement.OnSpawned {identity.name} {networkTeamId}"); + + if (!teamObjects.TryGetValue(networkTeamId, out HashSet objects)) + { + objects = new HashSet(); + teamObjects.Add(networkTeamId, objects); + } + + objects.Add(identity); + + // Team ID could have been set in NetworkBehaviour::OnStartServer on this object. + // Since that's after OnCheckObserver is called it would be missed, so force Rebuild here. + // Add the current team to dirtyTeams for Update to rebuild it. + dirtyTeams.Add(networkTeamId); + } + + [ServerCallback] + public override void OnDestroyed(NetworkIdentity identity) + { + // Don't RebuildSceneObservers here - that will happen in Update. + // Multiple objects could be destroyed in same frame and we don't + // want to rebuild for each one...let Update do it once. + // We must add the current team to dirtyTeams for Update to rebuild it. + if (lastObjectTeam.TryGetValue(identity, out string currentTeam)) + { + lastObjectTeam.Remove(identity); + if (!string.IsNullOrWhiteSpace(currentTeam) && teamObjects.TryGetValue(currentTeam, out HashSet objects) && objects.Remove(identity)) + dirtyTeams.Add(currentTeam); + } + } + + // internal so we can update from tests + [ServerCallback] + internal void Update() + { + // for each spawned: + // if team changed: + // add previous to dirty + // add new to dirty + foreach (NetworkIdentity netIdentity in NetworkServer.spawned.Values) + { + // Ignore objects that don't have a NetworkTeam component + if (!netIdentity.TryGetComponent(out NetworkTeam identityNetworkTeam)) + continue; + + string networkTeamId = identityNetworkTeam.teamId; + if (!lastObjectTeam.TryGetValue(netIdentity, out string currentTeam)) + continue; + + // Null / Empty string is never a valid teamId + // Nothing to do if teamId hasn't changed + if (string.IsNullOrWhiteSpace(networkTeamId) || networkTeamId == currentTeam) + continue; + + // Mark new/old Teams as dirty so they get rebuilt + UpdateDirtyTeams(networkTeamId, currentTeam); + + // This object is in a new team so observers in the prior team + // and the new team need to rebuild their respective observers lists. + UpdateTeamObjects(netIdentity, networkTeamId, currentTeam); + } + + // rebuild all dirty teams + foreach (string dirtyTeam in dirtyTeams) + RebuildTeamObservers(dirtyTeam); + + dirtyTeams.Clear(); + } + + void UpdateDirtyTeams(string newTeam, string currentTeam) + { + // Null / Empty string is never a valid teamId + if (!string.IsNullOrWhiteSpace(currentTeam)) + dirtyTeams.Add(currentTeam); + + dirtyTeams.Add(newTeam); + } + + void UpdateTeamObjects(NetworkIdentity netIdentity, string newTeam, string currentTeam) + { + // Remove this object from the hashset of the team it just left + // string.Empty is never a valid teamId + if (!string.IsNullOrWhiteSpace(currentTeam)) + teamObjects[currentTeam].Remove(netIdentity); + + // Set this to the new team this object just entered + lastObjectTeam[netIdentity] = newTeam; + + // Make sure this new team is in the dictionary + if (!teamObjects.ContainsKey(newTeam)) + teamObjects.Add(newTeam, new HashSet()); + + // Add this object to the hashset of the new team + teamObjects[newTeam].Add(netIdentity); + } + + void RebuildTeamObservers(string teamId) + { + foreach (NetworkIdentity netIdentity in teamObjects[teamId]) + if (netIdentity != null) + NetworkServer.RebuildObservers(netIdentity, false); + } + + public override bool OnCheckObserver(NetworkIdentity identity, NetworkConnectionToClient newObserver) + { + // Always observed if no NetworkTeam component + if (!identity.TryGetComponent(out NetworkTeam identityNetworkTeam)) + return true; + + if (identityNetworkTeam.forceShown) + return true; + + // string.Empty is never a valid teamId + if (string.IsNullOrWhiteSpace(identityNetworkTeam.teamId)) + return false; + + // Always observed if no NetworkTeam component + if (!newObserver.identity.TryGetComponent(out NetworkTeam newObserverNetworkTeam)) + return true; + + // Null / Empty string is never a valid teamId + if (string.IsNullOrWhiteSpace(newObserverNetworkTeam.teamId)) + return false; + + //Debug.Log($"TeamInterestManagement.OnCheckObserver {identity.name} {identityNetworkTeam.teamId} | {newObserver.identity.name} {newObserverNetworkTeam.teamId}"); + + // Observed only if teamId's match + return identityNetworkTeam.teamId == newObserverNetworkTeam.teamId; + } + + public override void OnRebuildObservers(NetworkIdentity identity, HashSet newObservers) + { + // If this object doesn't have a NetworkTeam then it's visible to all clients + if (!identity.TryGetComponent(out NetworkTeam networkTeam)) + { + AddAllConnections(newObservers); + return; + } + + // If this object has NetworkTeam and forceShown == true then it's visible to all clients + if (networkTeam.forceShown) + { + AddAllConnections(newObservers); + return; + } + + // Null / Empty string is never a valid teamId + if (string.IsNullOrWhiteSpace(networkTeam.teamId)) + return; + + // Abort if this team hasn't been created yet by OnSpawned or UpdateTeamObjects + if (!teamObjects.TryGetValue(networkTeam.teamId, out HashSet objects)) + return; + + // Add everything in the hashset for this object's current team + foreach (NetworkIdentity networkIdentity in objects) + if (networkIdentity != null && networkIdentity.connectionToClient != null) + newObservers.Add(networkIdentity.connectionToClient); + } + + void AddAllConnections(HashSet newObservers) + { + foreach (NetworkConnectionToClient conn in NetworkServer.connections.Values) + { + // authenticated and joined world with a player? + if (conn != null && conn.isAuthenticated && conn.identity != null) + newObservers.Add(conn); + } + } + } +} diff --git a/Assets/Mirror/Components/InterestManagement/Team/TeamInterestManagement.cs.meta b/Assets/Mirror/Components/InterestManagement/Team/TeamInterestManagement.cs.meta new file mode 100644 index 0000000..6e8748a --- /dev/null +++ b/Assets/Mirror/Components/InterestManagement/Team/TeamInterestManagement.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: dceb9a7085758fd4590419ff5b14b636 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/LagCompensation.meta b/Assets/Mirror/Components/LagCompensation.meta new file mode 100644 index 0000000..669a5b8 --- /dev/null +++ b/Assets/Mirror/Components/LagCompensation.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 00ac1d0527f234939aba22b4d7cbf280 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/LagCompensation/HistoryCollider.cs b/Assets/Mirror/Components/LagCompensation/HistoryCollider.cs new file mode 100644 index 0000000..8e841a4 --- /dev/null +++ b/Assets/Mirror/Components/LagCompensation/HistoryCollider.cs @@ -0,0 +1,107 @@ +// Applies HistoryBounds to the physics world by projecting to a trigger Collider. +// This way we can use Physics.Raycast on it. +using UnityEngine; + +namespace Mirror +{ + public class HistoryCollider : MonoBehaviour + { + [Header("Components")] + [Tooltip("The object's actual collider. We need to know where it is, and how large it is.")] + public Collider actualCollider; + + [Tooltip("The helper collider that the history bounds are projected onto.\nNeeds to be added to a child GameObject to counter-rotate an axis aligned Bounding Box onto it.\nThis is only used by this component.")] + public BoxCollider boundsCollider; + + [Header("History")] + [Tooltip("Keep this many past bounds in the buffer. The larger this is, the further we can raycast into the past.\nMaximum time := historyAmount * captureInterval")] + public int boundsLimit = 8; + + [Tooltip("Gather N bounds at a time into a bucket for faster encapsulation. A factor of 2 will be twice as fast, etc.")] + public int boundsPerBucket = 2; + + [Tooltip("Capture bounds every 'captureInterval' seconds. Larger values will require fewer computations, but may not capture every small move.")] + public float captureInterval = 0.100f; // 100 ms + double lastCaptureTime = 0; + + [Header("Debug")] + public Color historyColor = new Color(1.0f, 0.5f, 0.0f, 1.0f); + public Color currentColor = Color.red; + + protected HistoryBounds history = null; + + protected virtual void Awake() + { + history = new HistoryBounds(boundsLimit, boundsPerBucket); + + // ensure colliders were set. + // bounds collider should always be a trigger. + if (actualCollider == null) Debug.LogError("HistoryCollider: actualCollider was not set."); + if (boundsCollider == null) Debug.LogError("HistoryCollider: boundsCollider was not set."); + if (boundsCollider.transform.parent != transform) Debug.LogError("HistoryCollider: boundsCollider must be a child of this GameObject."); + if (!boundsCollider.isTrigger) Debug.LogError("HistoryCollider: boundsCollider must be a trigger."); + } + + // capturing and projecting onto colliders should use physics update + protected virtual void FixedUpdate() + { + // capture current bounds every interval + if (NetworkTime.localTime >= lastCaptureTime + captureInterval) + { + lastCaptureTime = NetworkTime.localTime; + CaptureBounds(); + } + + // project bounds onto helper collider + ProjectBounds(); + } + + protected virtual void CaptureBounds() + { + // grab current collider bounds + // this is in world space coordinates, and axis aligned + // TODO double check + Bounds bounds = actualCollider.bounds; + + // insert into history + history.Insert(bounds); + } + + protected virtual void ProjectBounds() + { + // grab total collider encapsulating all of history + Bounds total = history.total; + + // don't assign empty bounds, this will throw a Unity warning + if (history.boundsCount == 0) return; + + // scale projection doesn't work yet. + // for now, don't allow scale changes. + if (transform.lossyScale != Vector3.one) + { + Debug.LogWarning($"HistoryCollider: {name}'s transform global scale must be (1,1,1)."); + return; + } + + // counter rotate the child collider against the gameobject's rotation. + // we need this to always be axis aligned. + boundsCollider.transform.localRotation = Quaternion.Inverse(transform.rotation); + + // project world space bounds to collider's local space + boundsCollider.center = boundsCollider.transform.InverseTransformPoint(total.center); + boundsCollider.size = total.size; // TODO projection? + } + + // TODO runtime drawing for debugging? + protected virtual void OnDrawGizmos() + { + // draw total bounds + Gizmos.color = historyColor; + Gizmos.DrawWireCube(history.total.center, history.total.size); + + // draw current bounds + Gizmos.color = currentColor; + Gizmos.DrawWireCube(actualCollider.bounds.center, actualCollider.bounds.size); + } + } +} diff --git a/Assets/Mirror/Components/LagCompensation/HistoryCollider.cs.meta b/Assets/Mirror/Components/LagCompensation/HistoryCollider.cs.meta new file mode 100644 index 0000000..6275ff1 --- /dev/null +++ b/Assets/Mirror/Components/LagCompensation/HistoryCollider.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f5f2158d9776d4b569858f793be4da60 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/Mirror.Components.asmdef b/Assets/Mirror/Components/Mirror.Components.asmdef new file mode 100644 index 0000000..90c360e --- /dev/null +++ b/Assets/Mirror/Components/Mirror.Components.asmdef @@ -0,0 +1,16 @@ +{ + "name": "Mirror.Components", + "rootNamespace": "", + "references": [ + "GUID:30817c1a0e6d646d99c048fc403f5979" + ], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": true, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/Assets/Mirror/Components/Mirror.Components.asmdef.meta b/Assets/Mirror/Components/Mirror.Components.asmdef.meta new file mode 100644 index 0000000..263b6f0 --- /dev/null +++ b/Assets/Mirror/Components/Mirror.Components.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 72872094b21c16e48b631b2224833d49 +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkAnimator.cs b/Assets/Mirror/Components/NetworkAnimator.cs new file mode 100644 index 0000000..9e9a929 --- /dev/null +++ b/Assets/Mirror/Components/NetworkAnimator.cs @@ -0,0 +1,619 @@ +using System.Linq; +using UnityEngine; +using UnityEngine.Serialization; + +namespace Mirror +{ + /// + /// A component to synchronize Mecanim animation states for networked objects. + /// + /// + /// The animation of game objects can be networked by this component. There are two models of authority for networked movement: + /// If the object has authority on the client, then it should be animated locally on the owning client. The animation state information will be sent from the owning client to the server, then broadcast to all of the other clients. This is common for player objects. + /// If the object has authority on the server, then it should be animated on the server and state information will be sent to all clients. This is common for objects not related to a specific client, such as an enemy unit. + /// The NetworkAnimator synchronizes all animation parameters of the selected Animator. It does not automatically synchronize triggers. The function SetTrigger can by used by an object with authority to fire an animation trigger on other clients. + /// + // [RequireComponent(typeof(NetworkIdentity))] disabled to allow child NetworkBehaviours + [AddComponentMenu("Network/Network Animator")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-animator")] + public class NetworkAnimator : NetworkBehaviour + { + [Header("Authority")] + [Tooltip("Set to true if animations come from owner client, set to false if animations always come from server")] + public bool clientAuthority; + + /// + /// The animator component to synchronize. + /// + [FormerlySerializedAs("m_Animator")] + [Header("Animator")] + [Tooltip("Animator that will have parameters synchronized")] + public Animator animator; + + /// + /// Syncs animator.speed + /// + [SyncVar(hook = nameof(OnAnimatorSpeedChanged))] + float animatorSpeed; + float previousSpeed; + + // Note: not an object[] array because otherwise initialization is real annoying + int[] lastIntParameters; + float[] lastFloatParameters; + bool[] lastBoolParameters; + AnimatorControllerParameter[] parameters; + + // multiple layers + int[] animationHash; + int[] transitionHash; + float[] layerWeight; + double nextSendTime; + + bool SendMessagesAllowed + { + get + { + if (isServer) + { + if (!clientAuthority) + return true; + + // This is a special case where we have client authority but we have not assigned the client who has + // authority over it, no animator data will be sent over the network by the server. + // + // So we check here for a connectionToClient and if it is null we will + // let the server send animation data until we receive an owner. + if (netIdentity != null && netIdentity.connectionToClient == null) + return true; + } + + return (isOwned && clientAuthority); + } + } + + void Awake() + { + // store the animator parameters in a variable - the "Animator.parameters" getter allocates + // a new parameter array every time it is accessed so we should avoid doing it in a loop + parameters = animator.parameters + .Where(par => !animator.IsParameterControlledByCurve(par.nameHash)) + .ToArray(); + lastIntParameters = new int[parameters.Length]; + lastFloatParameters = new float[parameters.Length]; + lastBoolParameters = new bool[parameters.Length]; + + animationHash = new int[animator.layerCount]; + transitionHash = new int[animator.layerCount]; + layerWeight = new float[animator.layerCount]; + } + + void FixedUpdate() + { + if (!SendMessagesAllowed) + return; + + if (!animator.enabled) + return; + + CheckSendRate(); + + for (int i = 0; i < animator.layerCount; i++) + { + int stateHash; + float normalizedTime; + if (!CheckAnimStateChanged(out stateHash, out normalizedTime, i)) + { + continue; + } + + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + WriteParameters(writer); + SendAnimationMessage(stateHash, normalizedTime, i, layerWeight[i], writer.ToArray()); + } + } + + CheckSpeed(); + } + + void CheckSpeed() + { + float newSpeed = animator.speed; + if (Mathf.Abs(previousSpeed - newSpeed) > 0.001f) + { + previousSpeed = newSpeed; + if (isServer) + { + animatorSpeed = newSpeed; + } + else if (isClient) + { + CmdSetAnimatorSpeed(newSpeed); + } + } + } + + void OnAnimatorSpeedChanged(float _, float value) + { + // skip if host or client with authority + // they will have already set the speed so don't set again + if (isServer || (isOwned && clientAuthority)) + return; + + animator.speed = value; + } + + bool CheckAnimStateChanged(out int stateHash, out float normalizedTime, int layerId) + { + bool change = false; + stateHash = 0; + normalizedTime = 0; + + float lw = animator.GetLayerWeight(layerId); + if (Mathf.Abs(lw - layerWeight[layerId]) > 0.001f) + { + layerWeight[layerId] = lw; + change = true; + } + + if (animator.IsInTransition(layerId)) + { + AnimatorTransitionInfo tt = animator.GetAnimatorTransitionInfo(layerId); + if (tt.fullPathHash != transitionHash[layerId]) + { + // first time in this transition + transitionHash[layerId] = tt.fullPathHash; + animationHash[layerId] = 0; + return true; + } + return change; + } + + AnimatorStateInfo st = animator.GetCurrentAnimatorStateInfo(layerId); + if (st.fullPathHash != animationHash[layerId]) + { + // first time in this animation state + if (animationHash[layerId] != 0) + { + // came from another animation directly - from Play() + stateHash = st.fullPathHash; + normalizedTime = st.normalizedTime; + } + transitionHash[layerId] = 0; + animationHash[layerId] = st.fullPathHash; + return true; + } + return change; + } + + void CheckSendRate() + { + double now = NetworkTime.localTime; + if (SendMessagesAllowed && syncInterval >= 0 && now > nextSendTime) + { + nextSendTime = now + syncInterval; + + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + if (WriteParameters(writer)) + SendAnimationParametersMessage(writer.ToArray()); + } + } + } + + void SendAnimationMessage(int stateHash, float normalizedTime, int layerId, float weight, byte[] parameters) + { + if (isServer) + { + RpcOnAnimationClientMessage(stateHash, normalizedTime, layerId, weight, parameters); + } + else if (isClient) + { + CmdOnAnimationServerMessage(stateHash, normalizedTime, layerId, weight, parameters); + } + } + + void SendAnimationParametersMessage(byte[] parameters) + { + if (isServer) + { + RpcOnAnimationParametersClientMessage(parameters); + } + else if (isClient) + { + CmdOnAnimationParametersServerMessage(parameters); + } + } + + void HandleAnimMsg(int stateHash, float normalizedTime, int layerId, float weight, NetworkReader reader) + { + if (isOwned && clientAuthority) + return; + + // usually transitions will be triggered by parameters, if not, play anims directly. + // NOTE: this plays "animations", not transitions, so any transitions will be skipped. + // NOTE: there is no API to play a transition(?) + if (stateHash != 0 && animator.enabled) + { + animator.Play(stateHash, layerId, normalizedTime); + } + + animator.SetLayerWeight(layerId, weight); + + ReadParameters(reader); + } + + void HandleAnimParamsMsg(NetworkReader reader) + { + if (isOwned && clientAuthority) + return; + + ReadParameters(reader); + } + + void HandleAnimTriggerMsg(int hash) + { + if (animator.enabled) + animator.SetTrigger(hash); + } + + void HandleAnimResetTriggerMsg(int hash) + { + if (animator.enabled) + animator.ResetTrigger(hash); + } + + ulong NextDirtyBits() + { + ulong dirtyBits = 0; + for (int i = 0; i < parameters.Length; i++) + { + AnimatorControllerParameter par = parameters[i]; + bool changed = false; + if (par.type == AnimatorControllerParameterType.Int) + { + int newIntValue = animator.GetInteger(par.nameHash); + changed = newIntValue != lastIntParameters[i]; + if (changed) + lastIntParameters[i] = newIntValue; + } + else if (par.type == AnimatorControllerParameterType.Float) + { + float newFloatValue = animator.GetFloat(par.nameHash); + changed = Mathf.Abs(newFloatValue - lastFloatParameters[i]) > 0.001f; + // only set lastValue if it was changed, otherwise value could slowly drift within the 0.001f limit each frame + if (changed) + lastFloatParameters[i] = newFloatValue; + } + else if (par.type == AnimatorControllerParameterType.Bool) + { + bool newBoolValue = animator.GetBool(par.nameHash); + changed = newBoolValue != lastBoolParameters[i]; + if (changed) + lastBoolParameters[i] = newBoolValue; + } + if (changed) + { + dirtyBits |= 1ul << i; + } + } + return dirtyBits; + } + + bool WriteParameters(NetworkWriter writer, bool forceAll = false) + { + ulong dirtyBits = forceAll ? (~0ul) : NextDirtyBits(); + writer.WriteULong(dirtyBits); + for (int i = 0; i < parameters.Length; i++) + { + if ((dirtyBits & (1ul << i)) == 0) + continue; + + AnimatorControllerParameter par = parameters[i]; + if (par.type == AnimatorControllerParameterType.Int) + { + int newIntValue = animator.GetInteger(par.nameHash); + writer.WriteInt(newIntValue); + } + else if (par.type == AnimatorControllerParameterType.Float) + { + float newFloatValue = animator.GetFloat(par.nameHash); + writer.WriteFloat(newFloatValue); + } + else if (par.type == AnimatorControllerParameterType.Bool) + { + bool newBoolValue = animator.GetBool(par.nameHash); + writer.WriteBool(newBoolValue); + } + } + return dirtyBits != 0; + } + + void ReadParameters(NetworkReader reader) + { + bool animatorEnabled = animator.enabled; + // need to read values from NetworkReader even if animator is disabled + + ulong dirtyBits = reader.ReadULong(); + for (int i = 0; i < parameters.Length; i++) + { + if ((dirtyBits & (1ul << i)) == 0) + continue; + + AnimatorControllerParameter par = parameters[i]; + if (par.type == AnimatorControllerParameterType.Int) + { + int newIntValue = reader.ReadInt(); + if (animatorEnabled) + animator.SetInteger(par.nameHash, newIntValue); + } + else if (par.type == AnimatorControllerParameterType.Float) + { + float newFloatValue = reader.ReadFloat(); + if (animatorEnabled) + animator.SetFloat(par.nameHash, newFloatValue); + } + else if (par.type == AnimatorControllerParameterType.Bool) + { + bool newBoolValue = reader.ReadBool(); + if (animatorEnabled) + animator.SetBool(par.nameHash, newBoolValue); + } + } + } + + public override void OnSerialize(NetworkWriter writer, bool initialState) + { + base.OnSerialize(writer, initialState); + if (initialState) + { + for (int i = 0; i < animator.layerCount; i++) + { + if (animator.IsInTransition(i)) + { + AnimatorStateInfo st = animator.GetNextAnimatorStateInfo(i); + writer.WriteInt(st.fullPathHash); + writer.WriteFloat(st.normalizedTime); + } + else + { + AnimatorStateInfo st = animator.GetCurrentAnimatorStateInfo(i); + writer.WriteInt(st.fullPathHash); + writer.WriteFloat(st.normalizedTime); + } + writer.WriteFloat(animator.GetLayerWeight(i)); + } + WriteParameters(writer, initialState); + } + } + + public override void OnDeserialize(NetworkReader reader, bool initialState) + { + base.OnDeserialize(reader, initialState); + if (initialState) + { + for (int i = 0; i < animator.layerCount; i++) + { + int stateHash = reader.ReadInt(); + float normalizedTime = reader.ReadFloat(); + animator.SetLayerWeight(i, reader.ReadFloat()); + animator.Play(stateHash, i, normalizedTime); + } + + ReadParameters(reader); + } + } + + /// + /// Causes an animation trigger to be invoked for a networked object. + /// If local authority is set, and this is called from the client, then the trigger will be invoked on the server and all clients. If not, then this is called on the server, and the trigger will be called on all clients. + /// + /// Name of trigger. + public void SetTrigger(string triggerName) + { + SetTrigger(Animator.StringToHash(triggerName)); + } + + /// + /// Causes an animation trigger to be invoked for a networked object. + /// + /// Hash id of trigger (from the Animator). + public void SetTrigger(int hash) + { + if (clientAuthority) + { + if (!isClient) + { + Debug.LogWarning("Tried to set animation in the server for a client-controlled animator"); + return; + } + + if (!isOwned) + { + Debug.LogWarning("Only the client with authority can set animations"); + return; + } + + if (isClient) + CmdOnAnimationTriggerServerMessage(hash); + + // call on client right away + HandleAnimTriggerMsg(hash); + } + else + { + if (!isServer) + { + Debug.LogWarning("Tried to set animation in the client for a server-controlled animator"); + return; + } + + HandleAnimTriggerMsg(hash); + RpcOnAnimationTriggerClientMessage(hash); + } + } + + /// + /// Causes an animation trigger to be reset for a networked object. + /// If local authority is set, and this is called from the client, then the trigger will be reset on the server and all clients. If not, then this is called on the server, and the trigger will be reset on all clients. + /// + /// Name of trigger. + public void ResetTrigger(string triggerName) + { + ResetTrigger(Animator.StringToHash(triggerName)); + } + + /// Causes an animation trigger to be reset for a networked object. + /// Hash id of trigger (from the Animator). + public void ResetTrigger(int hash) + { + if (clientAuthority) + { + if (!isClient) + { + Debug.LogWarning("Tried to reset animation in the server for a client-controlled animator"); + return; + } + + if (!isOwned) + { + Debug.LogWarning("Only the client with authority can reset animations"); + return; + } + + if (isClient) + CmdOnAnimationResetTriggerServerMessage(hash); + + // call on client right away + HandleAnimResetTriggerMsg(hash); + } + else + { + if (!isServer) + { + Debug.LogWarning("Tried to reset animation in the client for a server-controlled animator"); + return; + } + + HandleAnimResetTriggerMsg(hash); + RpcOnAnimationResetTriggerClientMessage(hash); + } + } + + #region server message handlers + + [Command] + void CmdOnAnimationServerMessage(int stateHash, float normalizedTime, int layerId, float weight, byte[] parameters) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + //Debug.Log($"OnAnimationMessage for netId {netId}"); + + // handle and broadcast + using (NetworkReaderPooled networkReader = NetworkReaderPool.Get(parameters)) + { + HandleAnimMsg(stateHash, normalizedTime, layerId, weight, networkReader); + RpcOnAnimationClientMessage(stateHash, normalizedTime, layerId, weight, parameters); + } + } + + [Command] + void CmdOnAnimationParametersServerMessage(byte[] parameters) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + // handle and broadcast + using (NetworkReaderPooled networkReader = NetworkReaderPool.Get(parameters)) + { + HandleAnimParamsMsg(networkReader); + RpcOnAnimationParametersClientMessage(parameters); + } + } + + [Command] + void CmdOnAnimationTriggerServerMessage(int hash) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + // handle and broadcast + // host should have already the trigger + bool isHostOwner = isClient && isOwned; + if (!isHostOwner) + { + HandleAnimTriggerMsg(hash); + } + + RpcOnAnimationTriggerClientMessage(hash); + } + + [Command] + void CmdOnAnimationResetTriggerServerMessage(int hash) + { + // Ignore messages from client if not in client authority mode + if (!clientAuthority) + return; + + // handle and broadcast + // host should have already the trigger + bool isHostOwner = isClient && isOwned; + if (!isHostOwner) + { + HandleAnimResetTriggerMsg(hash); + } + + RpcOnAnimationResetTriggerClientMessage(hash); + } + + [Command] + void CmdSetAnimatorSpeed(float newSpeed) + { + // set animator + animator.speed = newSpeed; + animatorSpeed = newSpeed; + } + + #endregion + + #region client message handlers + + [ClientRpc] + void RpcOnAnimationClientMessage(int stateHash, float normalizedTime, int layerId, float weight, byte[] parameters) + { + using (NetworkReaderPooled networkReader = NetworkReaderPool.Get(parameters)) + HandleAnimMsg(stateHash, normalizedTime, layerId, weight, networkReader); + } + + [ClientRpc] + void RpcOnAnimationParametersClientMessage(byte[] parameters) + { + using (NetworkReaderPooled networkReader = NetworkReaderPool.Get(parameters)) + HandleAnimParamsMsg(networkReader); + } + + [ClientRpc] + void RpcOnAnimationTriggerClientMessage(int hash) + { + // host/owner handles this before it is sent + if (isServer || (clientAuthority && isOwned)) return; + + HandleAnimTriggerMsg(hash); + } + + [ClientRpc] + void RpcOnAnimationResetTriggerClientMessage(int hash) + { + // host/owner handles this before it is sent + if (isServer || (clientAuthority && isOwned)) return; + + HandleAnimResetTriggerMsg(hash); + } + + #endregion + } +} diff --git a/Assets/Mirror/Components/NetworkAnimator.cs.meta b/Assets/Mirror/Components/NetworkAnimator.cs.meta new file mode 100644 index 0000000..211ce78 --- /dev/null +++ b/Assets/Mirror/Components/NetworkAnimator.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 7f6f3bf89aa97405989c802ba270f815 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkLobbyManager.cs b/Assets/Mirror/Components/NetworkLobbyManager.cs new file mode 100644 index 0000000..3dcd4ea --- /dev/null +++ b/Assets/Mirror/Components/NetworkLobbyManager.cs @@ -0,0 +1,18 @@ +using System; +using UnityEngine; + +namespace Mirror +{ + /// + /// This is a specialized NetworkManager that includes a networked lobby. + /// + /// + /// The lobby has slots that track the joined players, and a maximum player count that is enforced. It requires that the NetworkLobbyPlayer component be on the lobby player objects. + /// NetworkLobbyManager is derived from NetworkManager, and so it implements many of the virtual functions provided by the NetworkManager class. To avoid accidentally replacing functionality of the NetworkLobbyManager, there are new virtual functions on the NetworkLobbyManager that begin with "OnLobby". These should be used on classes derived from NetworkLobbyManager instead of the virtual functions on NetworkManager. + /// The OnLobby*() functions have empty implementations on the NetworkLobbyManager base class, so the base class functions do not have to be called. + /// + [AddComponentMenu("Network/Network Lobby Manager")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-room-manager")] + [Obsolete("Use / inherit from NetworkRoomManager instead")] + public class NetworkLobbyManager : NetworkRoomManager {} +} diff --git a/Assets/Mirror/Components/NetworkLobbyManager.cs.meta b/Assets/Mirror/Components/NetworkLobbyManager.cs.meta new file mode 100644 index 0000000..a32c8c7 --- /dev/null +++ b/Assets/Mirror/Components/NetworkLobbyManager.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a4c96e6dd99826849ab1431f94547141 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkLobbyPlayer.cs b/Assets/Mirror/Components/NetworkLobbyPlayer.cs new file mode 100644 index 0000000..95ffbbc --- /dev/null +++ b/Assets/Mirror/Components/NetworkLobbyPlayer.cs @@ -0,0 +1,15 @@ +using System; +using UnityEngine; + +namespace Mirror +{ + /// + /// This component works in conjunction with the NetworkLobbyManager to make up the multiplayer lobby system. + /// The LobbyPrefab object of the NetworkLobbyManager must have this component on it. This component holds basic lobby player data required for the lobby to function. Game specific data for lobby players can be put in other components on the LobbyPrefab or in scripts derived from NetworkLobbyPlayer. + /// + [DisallowMultipleComponent] + [AddComponentMenu("Network/Network Lobby Player")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-room-player")] + [Obsolete("Use / inherit from NetworkRoomPlayer instead")] + public class NetworkLobbyPlayer : NetworkRoomPlayer {} +} diff --git a/Assets/Mirror/Components/NetworkLobbyPlayer.cs.meta b/Assets/Mirror/Components/NetworkLobbyPlayer.cs.meta new file mode 100644 index 0000000..7a21eec --- /dev/null +++ b/Assets/Mirror/Components/NetworkLobbyPlayer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 777a368af85f2e84da7ea5666581921b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkPingDisplay.cs b/Assets/Mirror/Components/NetworkPingDisplay.cs new file mode 100644 index 0000000..11f55f4 --- /dev/null +++ b/Assets/Mirror/Components/NetworkPingDisplay.cs @@ -0,0 +1,39 @@ +using System; +using UnityEngine; + +namespace Mirror +{ + /// + /// Component that will display the clients ping in milliseconds + /// + [DisallowMultipleComponent] + [AddComponentMenu("Network/Network Ping Display")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-ping-display")] + public class NetworkPingDisplay : MonoBehaviour + { + public Color color = Color.white; + public int padding = 2; + public int width = 180; + public int height = 25; + + void OnGUI() + { + // only while client is active + if (!NetworkClient.active) return; + + // show stats in bottom right corner, right aligned + GUI.color = color; + Rect rect = new Rect(Screen.width - width - padding, Screen.height - height - padding, width, height); + GUILayout.BeginArea(rect); + GUIStyle style = GUI.skin.GetStyle("Label"); + style.alignment = TextAnchor.MiddleRight; + GUILayout.BeginHorizontal(style); + GUILayout.Label($"RTT: {Math.Round(NetworkTime.rtt * 1000)}ms"); + GUI.color = NetworkClient.connectionQuality.ColorCode(); + GUILayout.Label($"Q: {NetworkClient.connectionQuality}"); + GUILayout.EndHorizontal(); + GUILayout.EndArea(); + GUI.color = Color.white; + } + } +} diff --git a/Assets/Mirror/Components/NetworkPingDisplay.cs.meta b/Assets/Mirror/Components/NetworkPingDisplay.cs.meta new file mode 100644 index 0000000..221a745 --- /dev/null +++ b/Assets/Mirror/Components/NetworkPingDisplay.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: bc654f29862fc2643b948f772ebb9e68 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkRigidbody.meta b/Assets/Mirror/Components/NetworkRigidbody.meta new file mode 100644 index 0000000..a67178e --- /dev/null +++ b/Assets/Mirror/Components/NetworkRigidbody.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 80106690aef541a5b8e2f8fb3d5949ad +timeCreated: 1686733778 \ No newline at end of file diff --git a/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable.cs b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable.cs new file mode 100644 index 0000000..cec7477 --- /dev/null +++ b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable.cs @@ -0,0 +1,97 @@ +using UnityEngine; + +namespace Mirror +{ + // [RequireComponent(typeof(Rigidbody))] <- OnValidate ensures this is on .target + public class NetworkRigidbodyReliable : NetworkTransformReliable + { + new bool clientAuthority => + syncDirection == SyncDirection.ClientToServer; + + Rigidbody rb; + bool wasKinematic; + + // cach Rigidbody and original isKinematic setting + protected override void Awake() + { + // we can't overwrite .target to be a Rigidbody. + // but we can use its Rigidbody component. + rb = target.GetComponent(); + if (rb == null) + { + Debug.LogError($"{name}'s NetworkRigidbody.target {target.name} is missing a Rigidbody", this); + return; + } + wasKinematic = rb.isKinematic; + base.Awake(); + } + + // reset forced isKinematic flag to original. + // otherwise the overwritten value would remain between sessions forever. + // for example, a game may run as client, set rigidbody.iskinematic=true, + // then run as server, where .iskinematic isn't touched and remains at + // the overwritten=true, even though the user set it to false originally. + public override void OnStopServer() => rb.isKinematic = wasKinematic; + public override void OnStopClient() => rb.isKinematic = wasKinematic; + + // overwriting Construct() and Apply() to set Rigidbody.MovePosition + // would give more jittery movement. + + // FixedUpdate for physics + void FixedUpdate() + { + // who ever has authority moves the Rigidbody with physics. + // everyone else simply sets it to kinematic. + // so that only the Transform component is synced. + + // host mode + if (isServer && isClient) + { + // in host mode, we own it it if: + // clientAuthority is disabled (hence server / we own it) + // clientAuthority is enabled and we have authority over this object. + bool owned = !clientAuthority || IsClientWithAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + // client only + else if (isClient) + { + // on the client, we own it only if clientAuthority is enabled, + // and we have authority over this object. + bool owned = IsClientWithAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + // server only + else if (isServer) + { + // on the server, we always own it if clientAuthority is disabled. + bool owned = !clientAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + } + + protected override void OnValidate() + { + base.OnValidate(); + + // we can't overwrite .target to be a Rigidbody. + // but we can ensure that .target has a Rigidbody, and use it. + if (target.GetComponent() == null) + { + Debug.LogWarning($"{name}'s NetworkRigidbody.target {target.name} is missing a Rigidbody", this); + } + } + } +} diff --git a/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable.cs.meta b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable.cs.meta new file mode 100644 index 0000000..b3b61c9 --- /dev/null +++ b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: cb803efbe62c34d7baece46c9ffebad9 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable2D.cs b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable2D.cs new file mode 100644 index 0000000..3530c8c --- /dev/null +++ b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable2D.cs @@ -0,0 +1,97 @@ +using UnityEngine; + +namespace Mirror +{ + // [RequireComponent(typeof(Rigidbody))] <- OnValidate ensures this is on .target + public class NetworkRigidbodyReliable2D : NetworkTransformReliable + { + new bool clientAuthority => + syncDirection == SyncDirection.ClientToServer; + + Rigidbody2D rb; + bool wasKinematic; + + // cach Rigidbody and original isKinematic setting + protected override void Awake() + { + // we can't overwrite .target to be a Rigidbody. + // but we can use its Rigidbody component. + rb = target.GetComponent(); + if (rb == null) + { + Debug.LogError($"{name}'s NetworkRigidbody2D.target {target.name} is missing a Rigidbody2D", this); + return; + } + wasKinematic = rb.isKinematic; + base.Awake(); + } + + // reset forced isKinematic flag to original. + // otherwise the overwritten value would remain between sessions forever. + // for example, a game may run as client, set rigidbody.iskinematic=true, + // then run as server, where .iskinematic isn't touched and remains at + // the overwritten=true, even though the user set it to false originally. + public override void OnStopServer() => rb.isKinematic = wasKinematic; + public override void OnStopClient() => rb.isKinematic = wasKinematic; + + // overwriting Construct() and Apply() to set Rigidbody.MovePosition + // would give more jittery movement. + + // FixedUpdate for physics + void FixedUpdate() + { + // who ever has authority moves the Rigidbody with physics. + // everyone else simply sets it to kinematic. + // so that only the Transform component is synced. + + // host mode + if (isServer && isClient) + { + // in host mode, we own it it if: + // clientAuthority is disabled (hence server / we own it) + // clientAuthority is enabled and we have authority over this object. + bool owned = !clientAuthority || IsClientWithAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + // client only + else if (isClient) + { + // on the client, we own it only if clientAuthority is enabled, + // and we have authority over this object. + bool owned = IsClientWithAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + // server only + else if (isServer) + { + // on the server, we always own it if clientAuthority is disabled. + bool owned = !clientAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + } + + protected override void OnValidate() + { + base.OnValidate(); + + // we can't overwrite .target to be a Rigidbody. + // but we can ensure that .target has a Rigidbody, and use it. + if (target.GetComponent() == null) + { + Debug.LogWarning($"{name}'s NetworkRigidbody2D.target {target.name} is missing a Rigidbody2D", this); + } + } + } +} diff --git a/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable2D.cs.meta b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable2D.cs.meta new file mode 100644 index 0000000..172c8a4 --- /dev/null +++ b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable2D.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 7ec4f7556ca1e4b55a3381fc6a02b1bc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable.cs b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable.cs new file mode 100644 index 0000000..7f8b9f7 --- /dev/null +++ b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable.cs @@ -0,0 +1,97 @@ +using UnityEngine; + +namespace Mirror +{ + // [RequireComponent(typeof(Rigidbody))] <- OnValidate ensures this is on .target + public class NetworkRigidbodyUnreliable : NetworkTransformUnreliable + { + new bool clientAuthority => + syncDirection == SyncDirection.ClientToServer; + + Rigidbody rb; + bool wasKinematic; + + // cach Rigidbody and original isKinematic setting + protected override void Awake() + { + // we can't overwrite .target to be a Rigidbody. + // but we can use its Rigidbody component. + rb = target.GetComponent(); + if (rb == null) + { + Debug.LogError($"{name}'s NetworkRigidbody.target {target.name} is missing a Rigidbody", this); + return; + } + wasKinematic = rb.isKinematic; + base.Awake(); + } + + // reset forced isKinematic flag to original. + // otherwise the overwritten value would remain between sessions forever. + // for example, a game may run as client, set rigidbody.iskinematic=true, + // then run as server, where .iskinematic isn't touched and remains at + // the overwritten=true, even though the user set it to false originally. + public override void OnStopServer() => rb.isKinematic = wasKinematic; + public override void OnStopClient() => rb.isKinematic = wasKinematic; + + // overwriting Construct() and Apply() to set Rigidbody.MovePosition + // would give more jittery movement. + + // FixedUpdate for physics + void FixedUpdate() + { + // who ever has authority moves the Rigidbody with physics. + // everyone else simply sets it to kinematic. + // so that only the Transform component is synced. + + // host mode + if (isServer && isClient) + { + // in host mode, we own it it if: + // clientAuthority is disabled (hence server / we own it) + // clientAuthority is enabled and we have authority over this object. + bool owned = !clientAuthority || IsClientWithAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + // client only + else if (isClient) + { + // on the client, we own it only if clientAuthority is enabled, + // and we have authority over this object. + bool owned = IsClientWithAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + // server only + else if (isServer) + { + // on the server, we always own it if clientAuthority is disabled. + bool owned = !clientAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + } + + protected override void OnValidate() + { + base.OnValidate(); + + // we can't overwrite .target to be a Rigidbody. + // but we can ensure that .target has a Rigidbody, and use it. + if (target.GetComponent() == null) + { + Debug.LogWarning($"{name}'s NetworkRigidbody.target {target.name} is missing a Rigidbody", this); + } + } + } +} diff --git a/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable.cs.meta b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable.cs.meta new file mode 100644 index 0000000..2dfb14b --- /dev/null +++ b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 3b20dc110904e47f8a154cdcf6433eae +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable2D.cs b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable2D.cs new file mode 100644 index 0000000..ead771f --- /dev/null +++ b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable2D.cs @@ -0,0 +1,97 @@ +using UnityEngine; + +namespace Mirror +{ + // [RequireComponent(typeof(Rigidbody))] <- OnValidate ensures this is on .target + public class NetworkRigidbodyUnreliable2D : NetworkTransformUnreliable + { + new bool clientAuthority => + syncDirection == SyncDirection.ClientToServer; + + Rigidbody2D rb; + bool wasKinematic; + + // cach Rigidbody and original isKinematic setting + protected override void Awake() + { + // we can't overwrite .target to be a Rigidbody. + // but we can use its Rigidbody component. + rb = target.GetComponent(); + if (rb == null) + { + Debug.LogError($"{name}'s NetworkRigidbody2D.target {target.name} is missing a Rigidbody2D", this); + return; + } + wasKinematic = rb.isKinematic; + base.Awake(); + } + + // reset forced isKinematic flag to original. + // otherwise the overwritten value would remain between sessions forever. + // for example, a game may run as client, set rigidbody.iskinematic=true, + // then run as server, where .iskinematic isn't touched and remains at + // the overwritten=true, even though the user set it to false originally. + public override void OnStopServer() => rb.isKinematic = wasKinematic; + public override void OnStopClient() => rb.isKinematic = wasKinematic; + + // overwriting Construct() and Apply() to set Rigidbody.MovePosition + // would give more jittery movement. + + // FixedUpdate for physics + void FixedUpdate() + { + // who ever has authority moves the Rigidbody with physics. + // everyone else simply sets it to kinematic. + // so that only the Transform component is synced. + + // host mode + if (isServer && isClient) + { + // in host mode, we own it it if: + // clientAuthority is disabled (hence server / we own it) + // clientAuthority is enabled and we have authority over this object. + bool owned = !clientAuthority || IsClientWithAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + // client only + else if (isClient) + { + // on the client, we own it only if clientAuthority is enabled, + // and we have authority over this object. + bool owned = IsClientWithAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + // server only + else if (isServer) + { + // on the server, we always own it if clientAuthority is disabled. + bool owned = !clientAuthority; + + // only set to kinematic if we don't own it + // otherwise don't touch isKinematic. + // the authority owner might use it either way. + if (!owned) rb.isKinematic = true; + } + } + + protected override void OnValidate() + { + base.OnValidate(); + + // we can't overwrite .target to be a Rigidbody. + // but we can ensure that .target has a Rigidbody, and use it. + if (target.GetComponent() == null) + { + Debug.LogWarning($"{name}'s NetworkRigidbody2D.target {target.name} is missing a Rigidbody2D", this); + } + } + } +} diff --git a/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable2D.cs.meta b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable2D.cs.meta new file mode 100644 index 0000000..8a19149 --- /dev/null +++ b/Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable2D.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1c7e12ad9b9ae443c9fdf37e9f5ecd36 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkRoomManager.cs b/Assets/Mirror/Components/NetworkRoomManager.cs new file mode 100644 index 0000000..e210e73 --- /dev/null +++ b/Assets/Mirror/Components/NetworkRoomManager.cs @@ -0,0 +1,684 @@ +using System.Collections.Generic; +using System.Linq; +using UnityEngine; +using UnityEngine.SceneManagement; +using UnityEngine.Serialization; + +namespace Mirror +{ + /// + /// This is a specialized NetworkManager that includes a networked room. + /// + /// + /// The room has slots that track the joined players, and a maximum player count that is enforced. It requires that the NetworkRoomPlayer component be on the room player objects. + /// NetworkRoomManager is derived from NetworkManager, and so it implements many of the virtual functions provided by the NetworkManager class. To avoid accidentally replacing functionality of the NetworkRoomManager, there are new virtual functions on the NetworkRoomManager that begin with "OnRoom". These should be used on classes derived from NetworkRoomManager instead of the virtual functions on NetworkManager. + /// The OnRoom*() functions have empty implementations on the NetworkRoomManager base class, so the base class functions do not have to be called. + /// + [AddComponentMenu("Network/Network Room Manager")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-room-manager")] + public class NetworkRoomManager : NetworkManager + { + public struct PendingPlayer + { + public NetworkConnectionToClient conn; + public GameObject roomPlayer; + } + + [Header("Room Settings")] + [FormerlySerializedAs("m_ShowRoomGUI")] + [SerializeField] + [Tooltip("This flag controls whether the default UI is shown for the room")] + public bool showRoomGUI = true; + + [FormerlySerializedAs("m_MinPlayers")] + [SerializeField] + [Tooltip("Minimum number of players to auto-start the game")] + public int minPlayers = 1; + + [FormerlySerializedAs("m_RoomPlayerPrefab")] + [SerializeField] + [Tooltip("Prefab to use for the Room Player")] + public NetworkRoomPlayer roomPlayerPrefab; + + /// + /// The scene to use for the room. This is similar to the offlineScene of the NetworkManager. + /// + [Scene] + public string RoomScene; + + /// + /// The scene to use for the playing the game from the room. This is similar to the onlineScene of the NetworkManager. + /// + [Scene] + public string GameplayScene; + + /// + /// List of players that are in the Room + /// + [FormerlySerializedAs("m_PendingPlayers")] + public List pendingPlayers = new List(); + + [Header("Diagnostics")] + /// + /// True when all players have submitted a Ready message + /// + [Tooltip("Diagnostic flag indicating all players are ready to play")] + [FormerlySerializedAs("allPlayersReady")] + [SerializeField] bool _allPlayersReady; + + /// + /// These slots track players that enter the room. + /// The slotId on players is global to the game - across all players. + /// + [Tooltip("List of Room Player objects")] + public List roomSlots = new List(); + + public bool allPlayersReady + { + get => _allPlayersReady; + set + { + bool wasReady = _allPlayersReady; + bool nowReady = value; + + if (wasReady != nowReady) + { + _allPlayersReady = value; + + if (nowReady) + { + OnRoomServerPlayersReady(); + } + else + { + OnRoomServerPlayersNotReady(); + } + } + } + } + + public override void OnValidate() + { + base.OnValidate(); + + // always <= maxConnections + minPlayers = Mathf.Min(minPlayers, maxConnections); + + // always >= 0 + minPlayers = Mathf.Max(minPlayers, 0); + + if (roomPlayerPrefab != null) + { + NetworkIdentity identity = roomPlayerPrefab.GetComponent(); + if (identity == null) + { + roomPlayerPrefab = null; + Debug.LogError("RoomPlayer prefab must have a NetworkIdentity component."); + } + } + } + + void SceneLoadedForPlayer(NetworkConnectionToClient conn, GameObject roomPlayer) + { + Debug.Log($"NetworkRoom SceneLoadedForPlayer scene: {SceneManager.GetActiveScene().path} {conn}"); + + if (Utils.IsSceneActive(RoomScene)) + { + // cant be ready in room, add to ready list + PendingPlayer pending; + pending.conn = conn; + pending.roomPlayer = roomPlayer; + pendingPlayers.Add(pending); + return; + } + + GameObject gamePlayer = OnRoomServerCreateGamePlayer(conn, roomPlayer); + if (gamePlayer == null) + { + // get start position from base class + Transform startPos = GetStartPosition(); + gamePlayer = startPos != null + ? Instantiate(playerPrefab, startPos.position, startPos.rotation) + : Instantiate(playerPrefab, Vector3.zero, Quaternion.identity); + } + + if (!OnRoomServerSceneLoadedForPlayer(conn, roomPlayer, gamePlayer)) + return; + + // replace room player with game player + NetworkServer.ReplacePlayerForConnection(conn, gamePlayer, true); + } + + internal void CallOnClientEnterRoom() + { + OnRoomClientEnter(); + foreach (NetworkRoomPlayer player in roomSlots) + if (player != null) + { + player.OnClientEnterRoom(); + } + } + + internal void CallOnClientExitRoom() + { + OnRoomClientExit(); + foreach (NetworkRoomPlayer player in roomSlots) + if (player != null) + { + player.OnClientExitRoom(); + } + } + + /// + /// CheckReadyToBegin checks all of the players in the room to see if their readyToBegin flag is set. + /// If all of the players are ready, then the server switches from the RoomScene to the PlayScene, essentially starting the game. This is called automatically in response to NetworkRoomPlayer.CmdChangeReadyState. + /// + public void CheckReadyToBegin() + { + if (!Utils.IsSceneActive(RoomScene)) + return; + + int numberOfReadyPlayers = NetworkServer.connections.Count(conn => + conn.Value != null && + conn.Value.identity != null && + conn.Value.identity.TryGetComponent(out NetworkRoomPlayer nrp) && + nrp.readyToBegin); + + bool enoughReadyPlayers = minPlayers <= 0 || numberOfReadyPlayers >= minPlayers; + if (enoughReadyPlayers) + { + pendingPlayers.Clear(); + allPlayersReady = true; + } + else + allPlayersReady = false; + } + + #region server handlers + + /// + /// Called on the server when a new client connects. + /// Unity calls this on the Server when a Client connects to the Server. Use an override to tell the NetworkManager what to do when a client connects to the server. + /// + /// Connection from client. + public override void OnServerConnect(NetworkConnectionToClient conn) + { + // cannot join game in progress + if (!Utils.IsSceneActive(RoomScene)) + { + Debug.Log($"Not in Room scene...disconnecting {conn}"); + conn.Disconnect(); + return; + } + + base.OnServerConnect(conn); + OnRoomServerConnect(conn); + } + + /// + /// Called on the server when a client disconnects. + /// This is called on the Server when a Client disconnects from the Server. Use an override to decide what should happen when a disconnection is detected. + /// + /// Connection from client. + public override void OnServerDisconnect(NetworkConnectionToClient conn) + { + if (conn.identity != null) + { + NetworkRoomPlayer roomPlayer = conn.identity.GetComponent(); + + if (roomPlayer != null) + roomSlots.Remove(roomPlayer); + + foreach (NetworkIdentity clientOwnedObject in conn.owned) + { + roomPlayer = clientOwnedObject.GetComponent(); + if (roomPlayer != null) + roomSlots.Remove(roomPlayer); + } + } + + allPlayersReady = false; + + foreach (NetworkRoomPlayer player in roomSlots) + { + if (player != null) + player.GetComponent().readyToBegin = false; + } + + if (Utils.IsSceneActive(RoomScene)) + RecalculateRoomPlayerIndices(); + + OnRoomServerDisconnect(conn); + base.OnServerDisconnect(conn); + +#if UNITY_SERVER + if (numPlayers < 1) + StopServer(); +#endif + } + + // Sequential index used in round-robin deployment of players into instances and score positioning + public int clientIndex; + + /// + /// Called on the server when a client is ready. + /// The default implementation of this function calls NetworkServer.SetClientReady() to continue the network setup process. + /// + /// Connection from client. + public override void OnServerReady(NetworkConnectionToClient conn) + { + Debug.Log($"NetworkRoomManager OnServerReady {conn}"); + base.OnServerReady(conn); + + if (conn != null && conn.identity != null) + { + GameObject roomPlayer = conn.identity.gameObject; + + // if null or not a room player, don't replace it + if (roomPlayer != null && roomPlayer.GetComponent() != null) + SceneLoadedForPlayer(conn, roomPlayer); + } + } + + /// + /// Called on the server when a client adds a new player with NetworkClient.AddPlayer. + /// The default implementation for this function creates a new player object from the playerPrefab. + /// + /// Connection from client. + public override void OnServerAddPlayer(NetworkConnectionToClient conn) + { + // increment the index before adding the player, so first player starts at 1 + clientIndex++; + + if (Utils.IsSceneActive(RoomScene)) + { + allPlayersReady = false; + + //Debug.Log("NetworkRoomManager.OnServerAddPlayer playerPrefab: {roomPlayerPrefab.name}"); + + GameObject newRoomGameObject = OnRoomServerCreateRoomPlayer(conn); + if (newRoomGameObject == null) + newRoomGameObject = Instantiate(roomPlayerPrefab.gameObject, Vector3.zero, Quaternion.identity); + + NetworkServer.AddPlayerForConnection(conn, newRoomGameObject); + } + else + { + // Late joiners not supported...should've been kicked by OnServerDisconnect + Debug.Log($"Not in Room scene...disconnecting {conn}"); + conn.Disconnect(); + } + } + + [Server] + public void RecalculateRoomPlayerIndices() + { + if (roomSlots.Count > 0) + { + for (int i = 0; i < roomSlots.Count; i++) + { + roomSlots[i].index = i; + } + } + } + + /// + /// This causes the server to switch scenes and sets the networkSceneName. + /// Clients that connect to this server will automatically switch to this scene. This is called automatically if onlineScene or offlineScene are set, but it can be called from user code to switch scenes again while the game is in progress. This automatically sets clients to be not-ready. The clients must call NetworkClient.Ready() again to participate in the new scene. + /// + /// + public override void ServerChangeScene(string newSceneName) + { + if (newSceneName == RoomScene) + { + foreach (NetworkRoomPlayer roomPlayer in roomSlots) + { + if (roomPlayer == null) + continue; + + // find the game-player object for this connection, and destroy it + NetworkIdentity identity = roomPlayer.GetComponent(); + + if (NetworkServer.active) + { + // re-add the room object + roomPlayer.GetComponent().readyToBegin = false; + NetworkServer.ReplacePlayerForConnection(identity.connectionToClient, roomPlayer.gameObject); + } + } + + allPlayersReady = false; + } + + base.ServerChangeScene(newSceneName); + } + + /// + /// Called on the server when a scene is completed loaded, when the scene load was initiated by the server with ServerChangeScene(). + /// + /// The name of the new scene. + public override void OnServerSceneChanged(string sceneName) + { + if (sceneName != RoomScene) + { + // call SceneLoadedForPlayer on any players that become ready while we were loading the scene. + foreach (PendingPlayer pending in pendingPlayers) + SceneLoadedForPlayer(pending.conn, pending.roomPlayer); + + pendingPlayers.Clear(); + } + + OnRoomServerSceneChanged(sceneName); + } + + /// + /// This is invoked when a server is started - including when a host is started. + /// StartServer has multiple signatures, but they all cause this hook to be called. + /// + public override void OnStartServer() + { + if (string.IsNullOrWhiteSpace(RoomScene)) + { + Debug.LogError("NetworkRoomManager RoomScene is empty. Set the RoomScene in the inspector for the NetworkRoomManager"); + return; + } + + if (string.IsNullOrWhiteSpace(GameplayScene)) + { + Debug.LogError("NetworkRoomManager PlayScene is empty. Set the PlayScene in the inspector for the NetworkRoomManager"); + return; + } + + OnRoomStartServer(); + } + + /// + /// This is invoked when a host is started. + /// StartHost has multiple signatures, but they all cause this hook to be called. + /// + public override void OnStartHost() + { + OnRoomStartHost(); + } + + /// + /// This is called when a server is stopped - including when a host is stopped. + /// + public override void OnStopServer() + { + roomSlots.Clear(); + OnRoomStopServer(); + } + + /// + /// This is called when a host is stopped. + /// + public override void OnStopHost() + { + OnRoomStopHost(); + } + + #endregion + + #region client handlers + + /// + /// This is invoked when the client is started. + /// + public override void OnStartClient() + { + if (roomPlayerPrefab == null || roomPlayerPrefab.gameObject == null) + Debug.LogError("NetworkRoomManager no RoomPlayer prefab is registered. Please add a RoomPlayer prefab."); + else + NetworkClient.RegisterPrefab(roomPlayerPrefab.gameObject); + + if (playerPrefab == null) + Debug.LogError("NetworkRoomManager no GamePlayer prefab is registered. Please add a GamePlayer prefab."); + + OnRoomStartClient(); + } + + /// + /// Called on the client when connected to a server. + /// The default implementation of this function sets the client as ready and adds a player. Override the function to dictate what happens when the client connects. + /// + public override void OnClientConnect() + { + OnRoomClientConnect(); + base.OnClientConnect(); + } + + /// + /// Called on clients when disconnected from a server. + /// This is called on the client when it disconnects from the server. Override this function to decide what happens when the client disconnects. + /// + public override void OnClientDisconnect() + { + OnRoomClientDisconnect(); + base.OnClientDisconnect(); + } + + /// + /// This is called when a client is stopped. + /// + public override void OnStopClient() + { + OnRoomStopClient(); + CallOnClientExitRoom(); + roomSlots.Clear(); + } + + /// + /// Called on clients when a scene has completed loaded, when the scene load was initiated by the server. + /// Scene changes can cause player objects to be destroyed. The default implementation of OnClientSceneChanged in the NetworkManager is to add a player object for the connection if no player object exists. + /// + public override void OnClientSceneChanged() + { + if (Utils.IsSceneActive(RoomScene)) + { + if (NetworkClient.isConnected) + CallOnClientEnterRoom(); + } + else + CallOnClientExitRoom(); + + base.OnClientSceneChanged(); + OnRoomClientSceneChanged(); + } + + #endregion + + #region room server virtuals + + /// + /// This is called on the host when a host is started. + /// + public virtual void OnRoomStartHost() {} + + /// + /// This is called on the host when the host is stopped. + /// + public virtual void OnRoomStopHost() {} + + /// + /// This is called on the server when the server is started - including when a host is started. + /// + public virtual void OnRoomStartServer() {} + + /// + /// This is called on the server when the server is started - including when a host is stopped. + /// + public virtual void OnRoomStopServer() {} + + /// + /// This is called on the server when a new client connects to the server. + /// + /// The new connection. + public virtual void OnRoomServerConnect(NetworkConnectionToClient conn) {} + + /// + /// This is called on the server when a client disconnects. + /// + /// The connection that disconnected. + public virtual void OnRoomServerDisconnect(NetworkConnectionToClient conn) {} + + /// + /// This is called on the server when a networked scene finishes loading. + /// + /// Name of the new scene. + public virtual void OnRoomServerSceneChanged(string sceneName) {} + + /// + /// This allows customization of the creation of the room-player object on the server. + /// By default the roomPlayerPrefab is used to create the room-player, but this function allows that behaviour to be customized. + /// + /// The connection the player object is for. + /// The new room-player object. + public virtual GameObject OnRoomServerCreateRoomPlayer(NetworkConnectionToClient conn) + { + return null; + } + + /// + /// This allows customization of the creation of the GamePlayer object on the server. + /// By default the gamePlayerPrefab is used to create the game-player, but this function allows that behaviour to be customized. The object returned from the function will be used to replace the room-player on the connection. + /// + /// The connection the player object is for. + /// The room player object for this connection. + /// A new GamePlayer object. + public virtual GameObject OnRoomServerCreateGamePlayer(NetworkConnectionToClient conn, GameObject roomPlayer) + { + return null; + } + + /// + /// This allows customization of the creation of the GamePlayer object on the server. + /// This is only called for subsequent GamePlay scenes after the first one. + /// See OnRoomServerCreateGamePlayer(NetworkConnection, GameObject) to customize the player object for the initial GamePlay scene. + /// + /// The connection the player object is for. + public virtual void OnRoomServerAddPlayer(NetworkConnectionToClient conn) + { + base.OnServerAddPlayer(conn); + } + + // for users to apply settings from their room player object to their in-game player object + /// + /// This is called on the server when it is told that a client has finished switching from the room scene to a game player scene. + /// When switching from the room, the room-player is replaced with a game-player object. This callback function gives an opportunity to apply state from the room-player to the game-player object. + /// + /// The connection of the player + /// The room player object. + /// The game player object. + /// False to not allow this player to replace the room player. + public virtual bool OnRoomServerSceneLoadedForPlayer(NetworkConnectionToClient conn, GameObject roomPlayer, GameObject gamePlayer) + { + return true; + } + + /// + /// This is called on server from NetworkRoomPlayer.CmdChangeReadyState when client indicates change in Ready status. + /// + public virtual void ReadyStatusChanged() + { + int CurrentPlayers = 0; + int ReadyPlayers = 0; + + foreach (NetworkRoomPlayer item in roomSlots) + { + if (item != null) + { + CurrentPlayers++; + if (item.readyToBegin) + ReadyPlayers++; + } + } + + if (CurrentPlayers == ReadyPlayers) + CheckReadyToBegin(); + else + allPlayersReady = false; + } + + /// + /// This is called on the server when all the players in the room are ready. + /// The default implementation of this function uses ServerChangeScene() to switch to the game player scene. By implementing this callback you can customize what happens when all the players in the room are ready, such as adding a countdown or a confirmation for a group leader. + /// + public virtual void OnRoomServerPlayersReady() + { + // all players are readyToBegin, start the game + ServerChangeScene(GameplayScene); + } + + /// + /// This is called on the server when CheckReadyToBegin finds that players are not ready + /// May be called multiple times while not ready players are joining + /// + public virtual void OnRoomServerPlayersNotReady() {} + + #endregion + + #region room client virtuals + + /// + /// This is a hook to allow custom behaviour when the game client enters the room. + /// + public virtual void OnRoomClientEnter() {} + + /// + /// This is a hook to allow custom behaviour when the game client exits the room. + /// + public virtual void OnRoomClientExit() {} + + /// + /// This is called on the client when it connects to server. + /// + public virtual void OnRoomClientConnect() {} + + /// + /// This is called on the client when disconnected from a server. + /// + public virtual void OnRoomClientDisconnect() {} + + /// + /// This is called on the client when a client is started. + /// + public virtual void OnRoomStartClient() {} + + /// + /// This is called on the client when the client stops. + /// + public virtual void OnRoomStopClient() {} + + /// + /// This is called on the client when the client is finished loading a new networked scene. + /// + public virtual void OnRoomClientSceneChanged() {} + + #endregion + + #region optional UI + + /// + /// virtual so inheriting classes can roll their own + /// + public virtual void OnGUI() + { + if (!showRoomGUI) + return; + + if (NetworkServer.active && Utils.IsSceneActive(GameplayScene)) + { + GUILayout.BeginArea(new Rect(Screen.width - 150f, 10f, 140f, 30f)); + if (GUILayout.Button("Return to Room")) + ServerChangeScene(RoomScene); + GUILayout.EndArea(); + } + + if (Utils.IsSceneActive(RoomScene)) + GUI.Box(new Rect(10f, 180f, 520f, 150f), "PLAYERS"); + } + + #endregion + } +} diff --git a/Assets/Mirror/Components/NetworkRoomManager.cs.meta b/Assets/Mirror/Components/NetworkRoomManager.cs.meta new file mode 100644 index 0000000..76e7d42 --- /dev/null +++ b/Assets/Mirror/Components/NetworkRoomManager.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 615e6c6589cf9e54cad646b5a11e0529 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkRoomPlayer.cs b/Assets/Mirror/Components/NetworkRoomPlayer.cs new file mode 100644 index 0000000..28e5051 --- /dev/null +++ b/Assets/Mirror/Components/NetworkRoomPlayer.cs @@ -0,0 +1,195 @@ +using UnityEngine; + +namespace Mirror +{ + /// + /// This component works in conjunction with the NetworkRoomManager to make up the multiplayer room system. + /// The RoomPrefab object of the NetworkRoomManager must have this component on it. This component holds basic room player data required for the room to function. Game specific data for room players can be put in other components on the RoomPrefab or in scripts derived from NetworkRoomPlayer. + /// + [DisallowMultipleComponent] + [AddComponentMenu("Network/Network Room Player")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-room-player")] + public class NetworkRoomPlayer : NetworkBehaviour + { + /// + /// This flag controls whether the default UI is shown for the room player. + /// As this UI is rendered using the old GUI system, it is only recommended for testing purposes. + /// + [Tooltip("This flag controls whether the default UI is shown for the room player")] + public bool showRoomGUI = true; + + [Header("Diagnostics")] + + /// + /// Diagnostic flag indicating whether this player is ready for the game to begin. + /// Invoke CmdChangeReadyState method on the client to set this flag. + /// When all players are ready to begin, the game will start. This should not be set directly, CmdChangeReadyState should be called on the client to set it on the server. + /// + [Tooltip("Diagnostic flag indicating whether this player is ready for the game to begin")] + [SyncVar(hook = nameof(ReadyStateChanged))] + public bool readyToBegin; + + /// + /// Diagnostic index of the player, e.g. Player1, Player2, etc. + /// + [Tooltip("Diagnostic index of the player, e.g. Player1, Player2, etc.")] + [SyncVar(hook = nameof(IndexChanged))] + public int index; + + #region Unity Callbacks + + /// + /// Do not use Start - Override OnStartHost / OnStartClient instead! + /// + public virtual void Start() + { + if (NetworkManager.singleton is NetworkRoomManager room) + { + // NetworkRoomPlayer object must be set to DontDestroyOnLoad along with NetworkRoomManager + // in server and all clients, otherwise it will be respawned in the game scene which would + // have undesirable effects. + if (room.dontDestroyOnLoad) + DontDestroyOnLoad(gameObject); + + room.roomSlots.Add(this); + + if (NetworkServer.active) + room.RecalculateRoomPlayerIndices(); + + if (NetworkClient.active) + room.CallOnClientEnterRoom(); + } + else Debug.LogError("RoomPlayer could not find a NetworkRoomManager. The RoomPlayer requires a NetworkRoomManager object to function. Make sure that there is one in the scene."); + } + + public virtual void OnDisable() + { + if (NetworkClient.active && NetworkManager.singleton is NetworkRoomManager room) + { + // only need to call this on client as server removes it before object is destroyed + room.roomSlots.Remove(this); + + room.CallOnClientExitRoom(); + } + } + + #endregion + + #region Commands + + [Command] + public void CmdChangeReadyState(bool readyState) + { + readyToBegin = readyState; + NetworkRoomManager room = NetworkManager.singleton as NetworkRoomManager; + if (room != null) + { + room.ReadyStatusChanged(); + } + } + + #endregion + + #region SyncVar Hooks + + /// + /// This is a hook that is invoked on clients when the index changes. + /// + /// The old index value + /// The new index value + public virtual void IndexChanged(int oldIndex, int newIndex) {} + + /// + /// This is a hook that is invoked on clients when a RoomPlayer switches between ready or not ready. + /// This function is called when the a client player calls CmdChangeReadyState. + /// + /// New Ready State + public virtual void ReadyStateChanged(bool oldReadyState, bool newReadyState) {} + + #endregion + + #region Room Client Virtuals + + /// + /// This is a hook that is invoked on clients for all room player objects when entering the room. + /// Note: isLocalPlayer is not guaranteed to be set until OnStartLocalPlayer is called. + /// + public virtual void OnClientEnterRoom() {} + + /// + /// This is a hook that is invoked on clients for all room player objects when exiting the room. + /// + public virtual void OnClientExitRoom() {} + + #endregion + + #region Optional UI + + /// + /// Render a UI for the room. Override to provide your own UI + /// + public virtual void OnGUI() + { + if (!showRoomGUI) + return; + + NetworkRoomManager room = NetworkManager.singleton as NetworkRoomManager; + if (room) + { + if (!room.showRoomGUI) + return; + + if (!Utils.IsSceneActive(room.RoomScene)) + return; + + DrawPlayerReadyState(); + DrawPlayerReadyButton(); + } + } + + void DrawPlayerReadyState() + { + GUILayout.BeginArea(new Rect(20f + (index * 100), 200f, 90f, 130f)); + + GUILayout.Label($"Player [{index + 1}]"); + + if (readyToBegin) + GUILayout.Label("Ready"); + else + GUILayout.Label("Not Ready"); + + if (((isServer && index > 0) || isServerOnly) && GUILayout.Button("REMOVE")) + { + // This button only shows on the Host for all players other than the Host + // Host and Players can't remove themselves (stop the client instead) + // Host can kick a Player this way. + GetComponent().connectionToClient.Disconnect(); + } + + GUILayout.EndArea(); + } + + void DrawPlayerReadyButton() + { + if (NetworkClient.active && isLocalPlayer) + { + GUILayout.BeginArea(new Rect(20f, 300f, 120f, 20f)); + + if (readyToBegin) + { + if (GUILayout.Button("Cancel")) + CmdChangeReadyState(false); + } + else + { + if (GUILayout.Button("Ready")) + CmdChangeReadyState(true); + } + + GUILayout.EndArea(); + } + } + + #endregion + } +} diff --git a/Assets/Mirror/Components/NetworkRoomPlayer.cs.meta b/Assets/Mirror/Components/NetworkRoomPlayer.cs.meta new file mode 100644 index 0000000..0299bea --- /dev/null +++ b/Assets/Mirror/Components/NetworkRoomPlayer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 79874ac94d5b1314788ecf0e86bd23fd +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkStatistics.cs b/Assets/Mirror/Components/NetworkStatistics.cs new file mode 100644 index 0000000..c00bb19 --- /dev/null +++ b/Assets/Mirror/Components/NetworkStatistics.cs @@ -0,0 +1,194 @@ +using System; +using UnityEngine; + +namespace Mirror +{ + /// + /// Shows Network messages and bytes sent and received per second. + /// + /// + /// Add this component to the same object as Network Manager. + /// + [AddComponentMenu("Network/Network Statistics")] + [DisallowMultipleComponent] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-statistics")] + public class NetworkStatistics : MonoBehaviour + { + // update interval + double intervalStartTime; + + // --------------------------------------------------------------------- + + // CLIENT (public fields for other components to grab statistics) + // long bytes to support >2GB + [HideInInspector] public int clientIntervalReceivedPackets; + [HideInInspector] public long clientIntervalReceivedBytes; + [HideInInspector] public int clientIntervalSentPackets; + [HideInInspector] public long clientIntervalSentBytes; + + // results from last interval + // long bytes to support >2GB + [HideInInspector] public int clientReceivedPacketsPerSecond; + [HideInInspector] public long clientReceivedBytesPerSecond; + [HideInInspector] public int clientSentPacketsPerSecond; + [HideInInspector] public long clientSentBytesPerSecond; + + // --------------------------------------------------------------------- + + // SERVER (public fields for other components to grab statistics) + // capture interval + // long bytes to support >2GB + [HideInInspector] public int serverIntervalReceivedPackets; + [HideInInspector] public long serverIntervalReceivedBytes; + [HideInInspector] public int serverIntervalSentPackets; + [HideInInspector] public long serverIntervalSentBytes; + + // results from last interval + // long bytes to support >2GB + [HideInInspector] public int serverReceivedPacketsPerSecond; + [HideInInspector] public long serverReceivedBytesPerSecond; + [HideInInspector] public int serverSentPacketsPerSecond; + [HideInInspector] public long serverSentBytesPerSecond; + + // NetworkManager sets Transport.active in Awake(). + // so let's hook into it in Start(). + void Start() + { + // find available transport + Transport transport = Transport.active; + if (transport != null) + { + transport.OnClientDataReceived += OnClientReceive; + transport.OnClientDataSent += OnClientSend; + transport.OnServerDataReceived += OnServerReceive; + transport.OnServerDataSent += OnServerSend; + } + else Debug.LogError($"NetworkStatistics: no available or active Transport found on this platform: {Application.platform}"); + } + + void OnDestroy() + { + // remove transport hooks + Transport transport = Transport.active; + if (transport != null) + { + transport.OnClientDataReceived -= OnClientReceive; + transport.OnClientDataSent -= OnClientSend; + transport.OnServerDataReceived -= OnServerReceive; + transport.OnServerDataSent -= OnServerSend; + } + } + + void OnClientReceive(ArraySegment data, int channelId) + { + ++clientIntervalReceivedPackets; + clientIntervalReceivedBytes += data.Count; + } + + void OnClientSend(ArraySegment data, int channelId) + { + ++clientIntervalSentPackets; + clientIntervalSentBytes += data.Count; + } + + void OnServerReceive(int connectionId, ArraySegment data, int channelId) + { + ++serverIntervalReceivedPackets; + serverIntervalReceivedBytes += data.Count; + } + + void OnServerSend(int connectionId, ArraySegment data, int channelId) + { + ++serverIntervalSentPackets; + serverIntervalSentBytes += data.Count; + } + + void Update() + { + // calculate results every second + if (NetworkTime.localTime >= intervalStartTime + 1) + { + if (NetworkClient.active) UpdateClient(); + if (NetworkServer.active) UpdateServer(); + + intervalStartTime = NetworkTime.localTime; + } + } + + void UpdateClient() + { + clientReceivedPacketsPerSecond = clientIntervalReceivedPackets; + clientReceivedBytesPerSecond = clientIntervalReceivedBytes; + clientSentPacketsPerSecond = clientIntervalSentPackets; + clientSentBytesPerSecond = clientIntervalSentBytes; + + clientIntervalReceivedPackets = 0; + clientIntervalReceivedBytes = 0; + clientIntervalSentPackets = 0; + clientIntervalSentBytes = 0; + } + + void UpdateServer() + { + serverReceivedPacketsPerSecond = serverIntervalReceivedPackets; + serverReceivedBytesPerSecond = serverIntervalReceivedBytes; + serverSentPacketsPerSecond = serverIntervalSentPackets; + serverSentBytesPerSecond = serverIntervalSentBytes; + + serverIntervalReceivedPackets = 0; + serverIntervalReceivedBytes = 0; + serverIntervalSentPackets = 0; + serverIntervalSentBytes = 0; + } + + void OnGUI() + { + // only show if either server or client active + if (NetworkClient.active || NetworkServer.active) + { + // create main GUI area + // 120 is below NetworkManager HUD in all cases. + GUILayout.BeginArea(new Rect(10, 120, 215, 300)); + + // show client / server stats if active + if (NetworkClient.active) OnClientGUI(); + if (NetworkServer.active) OnServerGUI(); + + // end of GUI area + GUILayout.EndArea(); + } + } + + void OnClientGUI() + { + // background + GUILayout.BeginVertical("Box"); + GUILayout.Label("Client Statistics"); + + // sending ("msgs" instead of "packets" to fit larger numbers) + GUILayout.Label($"Send: {clientSentPacketsPerSecond} msgs @ {Utils.PrettyBytes(clientSentBytesPerSecond)}/s"); + + // receiving ("msgs" instead of "packets" to fit larger numbers) + GUILayout.Label($"Recv: {clientReceivedPacketsPerSecond} msgs @ {Utils.PrettyBytes(clientReceivedBytesPerSecond)}/s"); + + // end background + GUILayout.EndVertical(); + } + + void OnServerGUI() + { + // background + GUILayout.BeginVertical("Box"); + GUILayout.Label("Server Statistics"); + + // sending ("msgs" instead of "packets" to fit larger numbers) + GUILayout.Label($"Send: {serverSentPacketsPerSecond} msgs @ {Utils.PrettyBytes(serverSentBytesPerSecond)}/s"); + + // receiving ("msgs" instead of "packets" to fit larger numbers) + GUILayout.Label($"Recv: {serverReceivedPacketsPerSecond} msgs @ {Utils.PrettyBytes(serverReceivedBytesPerSecond)}/s"); + + // end background + GUILayout.EndVertical(); + } + } +} diff --git a/Assets/Mirror/Components/NetworkStatistics.cs.meta b/Assets/Mirror/Components/NetworkStatistics.cs.meta new file mode 100644 index 0000000..0bf4251 --- /dev/null +++ b/Assets/Mirror/Components/NetworkStatistics.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6d7da4e566d24ea7b0e12178d934b648 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkTransform.meta b/Assets/Mirror/Components/NetworkTransform.meta new file mode 100644 index 0000000..1b6770d --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 36de72d9255741659bcbd1971ed29822 +timeCreated: 1668358590 \ No newline at end of file diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransform.cs b/Assets/Mirror/Components/NetworkTransform/NetworkTransform.cs new file mode 100644 index 0000000..8a1a24a --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransform.cs @@ -0,0 +1,8 @@ +using System; + +namespace Mirror +{ + // DEPRECATED 2023-06-15 + [Obsolete("NetworkTransform was renamed to NetworkTransformUnreliable.\nYou can easily swap the component's script by going into the Unity Inspector debug mode:\n1. Click the vertical dots on the top right in the Inspector tab.\n2. Find your NetworkTransform component\n3. Drag NetworkTransformUnreliable into the 'Script' field in the Inspector.\n4. Find the three dots and return to Normal mode.")] + public class NetworkTransform : NetworkTransformUnreliable {} +} diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransform.cs.meta b/Assets/Mirror/Components/NetworkTransform/NetworkTransform.cs.meta new file mode 100644 index 0000000..a569990 --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransform.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2f74aedd71d9a4f55b3ce499326d45fb +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs b/Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs new file mode 100644 index 0000000..5a6b9da --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs @@ -0,0 +1,475 @@ +// Snapshot Interpolation: https://gafferongames.com/post/snapshot_interpolation/ +// +// Base class for NetworkTransform and NetworkTransformChild. +// => simple unreliable sync without any interpolation for now. +// => which means we don't need teleport detection either +// +// NOTE: several functions are virtual in case someone needs to modify a part. +// +// Channel: uses UNRELIABLE at all times. +// -> out of order packets are dropped automatically +// -> it's better than RELIABLE for several reasons: +// * head of line blocking would add delay +// * resending is mostly pointless +// * bigger data race: +// -> if we use a Cmd() at position X over reliable +// -> client gets Cmd() and X at the same time, but buffers X for bufferTime +// -> for unreliable, it would get X before the reliable Cmd(), still +// buffer for bufferTime but end up closer to the original time +using System; +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + public enum CoordinateSpace { Local, World } + + public abstract class NetworkTransformBase : NetworkBehaviour + { + // target transform to sync. can be on a child. + // TODO this field is kind of unnecessary since we now support child NetworkBehaviours + [Header("Target")] + [Tooltip("The Transform component to sync. May be on on this GameObject, or on a child.")] + public Transform target; + + // TODO SyncDirection { ClientToServer, ServerToClient } is easier? + // Deprecated 2022-10-25 + [Obsolete("NetworkTransform clientAuthority was replaced with syncDirection. To enable client authority, set SyncDirection to ClientToServer in the Inspector.")] + [Header("[Obsolete]")] // Unity doesn't show obsolete warning for fields. do it manually. + [Tooltip("Obsolete: NetworkTransform clientAuthority was replaced with syncDirection. To enable client authority, set SyncDirection to ClientToServer in the Inspector.")] + public bool clientAuthority; + // Is this a client with authority over this transform? + // This component could be on the player object or any object that has been assigned authority to this client. + protected bool IsClientWithAuthority => isClient && authority; + + // snapshots with initial capacity to avoid early resizing & allocations: see NetworkRigidbodyBenchmark example. + public readonly SortedList clientSnapshots = new SortedList(16); + public readonly SortedList serverSnapshots = new SortedList(16); + + // selective sync ////////////////////////////////////////////////////// + [Header("Selective Sync\nDon't change these at Runtime")] + public bool syncPosition = true; // do not change at runtime! + public bool syncRotation = true; // do not change at runtime! + public bool syncScale = false; // do not change at runtime! rare. off by default. + + // interpolation is on by default, but can be disabled to jump to + // the destination immediately. some projects need this. + [Header("Interpolation")] + [Tooltip("Set to false to have a snap-like effect on position movement.")] + public bool interpolatePosition = true; + [Tooltip("Set to false to have a snap-like effect on rotations.")] + public bool interpolateRotation = true; + [Tooltip("Set to false to remove scale smoothing. Example use-case: Instant flipping of sprites that use -X and +X for direction.")] + public bool interpolateScale = true; + + // CoordinateSpace /////////////////////////////////////////////////////////// + [Header("Coordinate Space")] + [Tooltip("Local by default. World may be better when changing hierarchy, or non-NetworkTransforms root position/rotation/scale values.")] + public CoordinateSpace coordinateSpace = CoordinateSpace.Local; + + [Header("Send Interval Multiplier")] + [Tooltip("Check/Sync every multiple of Network Manager send interval (= 1 / NM Send Rate), instead of every send interval.\n(30 NM send rate, and 3 interval, is a send every 0.1 seconds)\nA larger interval means less network sends, which has a variety of upsides. The drawbacks are delays and lower accuracy, you should find a nice balance between not sending too much, but the results looking good for your particular scenario.")] + [Range(1, 120)] + public uint sendIntervalMultiplier = 1; + + [Header("Timeline Offset")] + [Tooltip("Add a small timeline offset to account for decoupled arrival of NetworkTime and NetworkTransform snapshots.\nfixes: https://github.com/MirrorNetworking/Mirror/issues/3427")] + public bool timelineOffset = false; + + // Ninja's Notes on offset & mulitplier: + // + // In a no multiplier scenario: + // 1. Snapshots are sent every frame (frame being 1 NM send interval). + // 2. Time Interpolation is set to be 'behind' by 2 frames times. + // In theory where everything works, we probably have around 2 snapshots before we need to interpolate snapshots. From NT perspective, we should always have around 2 snapshots ready, so no stutter. + // + // In a multiplier scenario: + // 1. Snapshots are sent every 10 frames. + // 2. Time Interpolation remains 'behind by 2 frames'. + // When everything works, we are receiving NT snapshots every 10 frames, but start interpolating after 2. + // Even if I assume we had 2 snapshots to begin with to start interpolating (which we don't), by the time we reach 13th frame, we are out of snapshots, and have to wait 7 frames for next snapshot to come. This is the reason why we absolutely need the timestamp adjustment. We are starting way too early to interpolate. + // + protected double timeStampAdjustment => NetworkServer.sendInterval * (sendIntervalMultiplier - 1); + protected double offset => timelineOffset ? NetworkServer.sendInterval * sendIntervalMultiplier : 0; + + // debugging /////////////////////////////////////////////////////////// + [Header("Debug")] + public bool showGizmos; + public bool showOverlay; + public Color overlayColor = new Color(0, 0, 0, 0.5f); + + // initialization ////////////////////////////////////////////////////// + // make sure to call this when inheriting too! + protected virtual void Awake() { } + + protected override void OnValidate() + { + base.OnValidate(); + + // set target to self if none yet + if (target == null) target = transform; + + // time snapshot interpolation happens globally. + // value (transform) happens in here. + // both always need to be on the same send interval. + // force the setting to '0' in OnValidate to make it obvious that we + // actually use NetworkServer.sendInterval. + syncInterval = 0; + + // Unity doesn't support setting world scale. + // OnValidate force disables syncScale in world mode. + if (coordinateSpace == CoordinateSpace.World) syncScale = false; + + // obsolete clientAuthority compatibility: + // if it was used, then set the new SyncDirection automatically. + // if it wasn't used, then don't touch syncDirection. +#pragma warning disable CS0618 + if (clientAuthority) + { + syncDirection = SyncDirection.ClientToServer; + Debug.LogWarning($"{name}'s NetworkTransform component has obsolete .clientAuthority enabled. Please disable it and set SyncDirection to ClientToServer instead."); + } +#pragma warning restore CS0618 + } + + // snapshot functions ////////////////////////////////////////////////// + // get local/world position + protected Vector3 GetPosition() => + coordinateSpace == CoordinateSpace.Local ? target.localPosition : target.position; + + // get local/world rotation + protected Quaternion GetRotation() => + coordinateSpace == CoordinateSpace.Local ? target.localRotation : target.rotation; + + // get local/world scale + protected Vector3 GetScale() => + coordinateSpace == CoordinateSpace.Local ? target.localScale : target.lossyScale; + + // set local/world position + protected void SetPosition(Vector3 position) + { + if (coordinateSpace == CoordinateSpace.Local) + target.localPosition = position; + else + target.position = position; + } + + // set local/world rotation + protected void SetRotation(Quaternion rotation) + { + if (coordinateSpace == CoordinateSpace.Local) + target.localRotation = rotation; + else + target.rotation = rotation; + } + + // set local/world position + protected void SetScale(Vector3 scale) + { + if (coordinateSpace == CoordinateSpace.Local) + target.localScale = scale; + // Unity doesn't support setting world scale. + // OnValidate disables syncScale in world mode. + // else + // target.lossyScale = scale; // TODO + } + + // construct a snapshot of the current state + // => internal for testing + protected virtual TransformSnapshot Construct() + { + // NetworkTime.localTime for double precision until Unity has it too + return new TransformSnapshot( + // our local time is what the other end uses as remote time + NetworkTime.localTime, // Unity 2019 doesn't have timeAsDouble yet + 0, // the other end fills out local time itself + GetPosition(), + GetRotation(), + GetScale() + ); + } + + protected void AddSnapshot(SortedList snapshots, double timeStamp, Vector3? position, Quaternion? rotation, Vector3? scale) + { + // position, rotation, scale can have no value if same as last time. + // saves bandwidth. + // but we still need to feed it to snapshot interpolation. we can't + // just have gaps in there if nothing has changed. for example, if + // client sends snapshot at t=0 + // client sends nothing for 10s because not moved + // client sends snapshot at t=10 + // then the server would assume that it's one super slow move and + // replay it for 10 seconds. + + if (!position.HasValue) position = snapshots.Count > 0 ? snapshots.Values[snapshots.Count - 1].position : GetPosition(); + if (!rotation.HasValue) rotation = snapshots.Count > 0 ? snapshots.Values[snapshots.Count - 1].rotation : GetRotation(); + if (!scale.HasValue) scale = snapshots.Count > 0 ? snapshots.Values[snapshots.Count - 1].scale : GetScale(); + + // insert transform snapshot + SnapshotInterpolation.InsertIfNotExists( + snapshots, + NetworkClient.snapshotSettings.bufferLimit, + new TransformSnapshot( + timeStamp, // arrival remote timestamp. NOT remote time. + NetworkTime.localTime, // Unity 2019 doesn't have timeAsDouble yet + position.Value, + rotation.Value, + scale.Value + ) + ); + } + + // apply a snapshot to the Transform. + // -> start, end, interpolated are all passed in caes they are needed + // -> a regular game would apply the 'interpolated' snapshot + // -> a board game might want to jump to 'goal' directly + // (it's easier to always interpolate and then apply selectively, + // instead of manually interpolating x, y, z, ... depending on flags) + // => internal for testing + // + // NOTE: stuck detection is unnecessary here. + // we always set transform.position anyway, we can't get stuck. + protected virtual void Apply(TransformSnapshot interpolated, TransformSnapshot endGoal) + { + // local position/rotation for VR support + // + // if syncPosition/Rotation/Scale is disabled then we received nulls + // -> current position/rotation/scale would've been added as snapshot + // -> we still interpolated + // -> but simply don't apply it. if the user doesn't want to sync + // scale, then we should not touch scale etc. + + // interpolate parts + if (syncPosition) SetPosition(interpolatePosition ? interpolated.position : endGoal.position); + if (syncRotation) SetRotation(interpolateRotation ? interpolated.rotation : endGoal.rotation); + if (syncScale) SetScale(interpolateScale ? interpolated.scale : endGoal.scale); + } + + // client->server teleport to force position without interpolation. + // otherwise it would interpolate to a (far away) new position. + // => manually calling Teleport is the only 100% reliable solution. + [Command] + public void CmdTeleport(Vector3 destination) + { + // client can only teleport objects that it has authority over. + if (syncDirection != SyncDirection.ClientToServer) return; + + // TODO what about host mode? + OnTeleport(destination); + + // if a client teleports, we need to broadcast to everyone else too + // TODO the teleported client should ignore the rpc though. + // otherwise if it already moved again after teleporting, + // the rpc would come a little bit later and reset it once. + // TODO or not? if client ONLY calls Teleport(pos), the position + // would only be set after the rpc. unless the client calls + // BOTH Teleport(pos) and target.position=pos + RpcTeleport(destination); + } + + // client->server teleport to force position and rotation without interpolation. + // otherwise it would interpolate to a (far away) new position. + // => manually calling Teleport is the only 100% reliable solution. + [Command] + public void CmdTeleport(Vector3 destination, Quaternion rotation) + { + // client can only teleport objects that it has authority over. + if (syncDirection != SyncDirection.ClientToServer) return; + + // TODO what about host mode? + OnTeleport(destination, rotation); + + // if a client teleports, we need to broadcast to everyone else too + // TODO the teleported client should ignore the rpc though. + // otherwise if it already moved again after teleporting, + // the rpc would come a little bit later and reset it once. + // TODO or not? if client ONLY calls Teleport(pos), the position + // would only be set after the rpc. unless the client calls + // BOTH Teleport(pos) and target.position=pos + RpcTeleport(destination, rotation); + } + + // server->client teleport to force position without interpolation. + // otherwise it would interpolate to a (far away) new position. + // => manually calling Teleport is the only 100% reliable solution. + [ClientRpc] + public void RpcTeleport(Vector3 destination) + { + // NOTE: even in client authority mode, the server is always allowed + // to teleport the player. for example: + // * CmdEnterPortal() might teleport the player + // * Some people use client authority with server sided checks + // so the server should be able to reset position if needed. + + // TODO what about host mode? + OnTeleport(destination); + } + + // server->client teleport to force position and rotation without interpolation. + // otherwise it would interpolate to a (far away) new position. + // => manually calling Teleport is the only 100% reliable solution. + [ClientRpc] + public void RpcTeleport(Vector3 destination, Quaternion rotation) + { + // NOTE: even in client authority mode, the server is always allowed + // to teleport the player. for example: + // * CmdEnterPortal() might teleport the player + // * Some people use client authority with server sided checks + // so the server should be able to reset position if needed. + + // TODO what about host mode? + OnTeleport(destination, rotation); + } + + [ClientRpc] + void RpcReset() + { + Reset(); + } + + // common Teleport code for client->server and server->client + protected virtual void OnTeleport(Vector3 destination) + { + // reset any in-progress interpolation & buffers + Reset(); + + // set the new position. + // interpolation will automatically continue. + target.position = destination; + + // TODO + // what if we still receive a snapshot from before the interpolation? + // it could easily happen over unreliable. + // -> maybe add destination as first entry? + } + + // common Teleport code for client->server and server->client + protected virtual void OnTeleport(Vector3 destination, Quaternion rotation) + { + // reset any in-progress interpolation & buffers + Reset(); + + // set the new position. + // interpolation will automatically continue. + target.position = destination; + target.rotation = rotation; + + // TODO + // what if we still receive a snapshot from before the interpolation? + // it could easily happen over unreliable. + // -> maybe add destination as first entry? + } + + public virtual void Reset() + { + // disabled objects aren't updated anymore. + // so let's clear the buffers. + serverSnapshots.Clear(); + clientSnapshots.Clear(); + } + + protected virtual void OnEnable() + { + Reset(); + + if (NetworkServer.active) + NetworkIdentity.clientAuthorityCallback += OnClientAuthorityChanged; + } + + protected virtual void OnDisable() + { + Reset(); + + if (NetworkServer.active) + NetworkIdentity.clientAuthorityCallback -= OnClientAuthorityChanged; + } + + [ServerCallback] + void OnClientAuthorityChanged(NetworkConnectionToClient conn, NetworkIdentity identity, bool authorityState) + { + if (identity != netIdentity) return; + + // If server gets authority or syncdirection is server to client, + // we don't reset buffers. + // This is because if syncdirection is S to C, we will never have + // snapshot issues since there is only ever 1 source. + + if (syncDirection == SyncDirection.ClientToServer) + { + Reset(); + RpcReset(); + } + } + + // OnGUI allocates even if it does nothing. avoid in release. +#if UNITY_EDITOR || DEVELOPMENT_BUILD + // debug /////////////////////////////////////////////////////////////// + protected virtual void OnGUI() + { + if (!showOverlay) return; + if (!Camera.main) return; + + // show data next to player for easier debugging. this is very useful! + // IMPORTANT: this is basically an ESP hack for shooter games. + // DO NOT make this available with a hotkey in release builds + if (!Debug.isDebugBuild) return; + + // project position to screen + Vector3 point = Camera.main.WorldToScreenPoint(target.position); + + // enough alpha, in front of camera and in screen? + if (point.z >= 0 && Utils.IsPointInScreen(point)) + { + GUI.color = overlayColor; + GUILayout.BeginArea(new Rect(point.x, Screen.height - point.y, 200, 100)); + + // always show both client & server buffers so it's super + // obvious if we accidentally populate both. + GUILayout.Label($"Server Buffer:{serverSnapshots.Count}"); + GUILayout.Label($"Client Buffer:{clientSnapshots.Count}"); + + GUILayout.EndArea(); + GUI.color = Color.white; + } + } + + protected virtual void DrawGizmos(SortedList buffer) + { + // only draw if we have at least two entries + if (buffer.Count < 2) return; + + // calculate threshold for 'old enough' snapshots + double threshold = NetworkTime.localTime - NetworkClient.bufferTime; + Color oldEnoughColor = new Color(0, 1, 0, 0.5f); + Color notOldEnoughColor = new Color(0.5f, 0.5f, 0.5f, 0.3f); + + // draw the whole buffer for easier debugging. + // it's worth seeing how much we have buffered ahead already + for (int i = 0; i < buffer.Count; ++i) + { + // color depends on if old enough or not + TransformSnapshot entry = buffer.Values[i]; + bool oldEnough = entry.localTime <= threshold; + Gizmos.color = oldEnough ? oldEnoughColor : notOldEnoughColor; + Gizmos.DrawWireCube(entry.position, Vector3.one); + } + + // extra: lines between start<->position<->goal + Gizmos.color = Color.green; + Gizmos.DrawLine(buffer.Values[0].position, target.position); + Gizmos.color = Color.white; + Gizmos.DrawLine(target.position, buffer.Values[1].position); + } + + protected virtual void OnDrawGizmos() + { + // This fires in edit mode but that spams NRE's so check isPlaying + if (!Application.isPlaying) return; + if (!showGizmos) return; + + if (isServer) DrawGizmos(serverSnapshots); + if (isClient) DrawGizmos(clientSnapshots); + } +#endif + } +} diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs.meta b/Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs.meta new file mode 100644 index 0000000..ef58471 --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 7c44135fde488424eaf28566206ce473 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransformChild.cs b/Assets/Mirror/Components/NetworkTransform/NetworkTransformChild.cs new file mode 100644 index 0000000..a844d9d --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransformChild.cs @@ -0,0 +1,12 @@ +// A component to synchronize the position of child transforms of networked objects. +// There must be a NetworkTransform on the root object of the hierarchy. There can be multiple NetworkTransformChild components on an object. This does not use physics for synchronization, it simply synchronizes the localPosition and localRotation of the child transform and lerps towards the recieved values. +using System; +using UnityEngine; + +namespace Mirror +{ + // Deprecated 2022-10-25 + [AddComponentMenu("")] + [Obsolete("NetworkTransformChild is not needed anymore. The .target is now exposed in NetworkTransform itself. Note you can open the Inspector in debug view and replace the source script instead of reassigning everything.")] + public class NetworkTransformChild : NetworkTransform {} +} diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransformChild.cs.meta b/Assets/Mirror/Components/NetworkTransform/NetworkTransformChild.cs.meta new file mode 100644 index 0000000..ae36756 --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransformChild.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 734b48bea0b204338958ee3d885e11f0 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransformReliable.cs b/Assets/Mirror/Components/NetworkTransform/NetworkTransformReliable.cs new file mode 100644 index 0000000..f3d4afd --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransformReliable.cs @@ -0,0 +1,423 @@ +// NetworkTransform V3 (reliable) by mischa (2022-10) +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using UnityEngine; + +namespace Mirror +{ + [AddComponentMenu("Network/Network Transform (Reliable)")] + public class NetworkTransformReliable : NetworkTransformBase + { + [Header("Sync Only If Changed")] + [Tooltip("When true, changes are not sent unless greater than sensitivity values below.")] + public bool onlySyncOnChange = true; + + uint sendIntervalCounter = 0; + double lastSendIntervalTime = double.MinValue; + + [Tooltip("If we only sync on change, then we need to correct old snapshots if more time than sendInterval * multiplier has elapsed.\n\nOtherwise the first move will always start interpolating from the last move sequence's time, which will make it stutter when starting every time.")] + public float onlySyncOnChangeCorrectionMultiplier = 2; + + [Header("Rotation")] + [Tooltip("Sensitivity of changes needed before an updated state is sent over the network")] + public float rotationSensitivity = 0.01f; + [Tooltip("Apply smallest-three quaternion compression. This is lossy, you can disable it if the small rotation inaccuracies are noticeable in your project.")] + public bool compressRotation = false; + + // delta compression is capable of detecting byte-level changes. + // if we scale float position to bytes, + // then small movements will only change one byte. + // this gives optimal bandwidth. + // benchmark with 0.01 precision: 130 KB/s => 60 KB/s + // benchmark with 0.1 precision: 130 KB/s => 30 KB/s + [Header("Precision")] + [Tooltip("Position is rounded in order to drastically minimize bandwidth.\n\nFor example, a precision of 0.01 rounds to a centimeter. In other words, sub-centimeter movements aren't synced until they eventually exceeded an actual centimeter.\n\nDepending on how important the object is, a precision of 0.01-0.10 (1-10 cm) is recommended.\n\nFor example, even a 1cm precision combined with delta compression cuts the Benchmark demo's bandwidth in half, compared to sending every tiny change.")] + [Range(0.00_01f, 1f)] // disallow 0 division. 1mm to 1m precision is enough range. + public float positionPrecision = 0.01f; // 1 cm + [Range(0.00_01f, 1f)] // disallow 0 division. 1mm to 1m precision is enough range. + public float scalePrecision = 0.01f; // 1 cm + + // delta compression needs to remember 'last' to compress against + protected Vector3Long lastSerializedPosition = Vector3Long.zero; + protected Vector3Long lastDeserializedPosition = Vector3Long.zero; + + protected Vector3Long lastSerializedScale = Vector3Long.zero; + protected Vector3Long lastDeserializedScale = Vector3Long.zero; + + // Used to store last sent snapshots + protected TransformSnapshot last; + + protected int lastClientCount = 1; + + // update ////////////////////////////////////////////////////////////// + void Update() + { + // if server then always sync to others. + if (isServer) UpdateServer(); + // 'else if' because host mode shouldn't send anything to server. + // it is the server. don't overwrite anything there. + else if (isClient) UpdateClient(); + } + + void LateUpdate() + { + // set dirty to trigger OnSerialize. either always, or only if changed. + // It has to be checked in LateUpdate() for onlySyncOnChange to avoid + // the possibility of Update() running first before the object's movement + // script's Update(), which then causes NT to send every alternate frame + // instead. + if (isServer || (IsClientWithAuthority && NetworkClient.ready)) + { + if (sendIntervalCounter == sendIntervalMultiplier && (!onlySyncOnChange || Changed(Construct()))) + SetDirty(); + + CheckLastSendTime(); + } + } + + protected virtual void UpdateServer() + { + // apply buffered snapshots IF client authority + // -> in server authority, server moves the object + // so no need to apply any snapshots there. + // -> don't apply for host mode player objects either, even if in + // client authority mode. if it doesn't go over the network, + // then we don't need to do anything. + // -> connectionToClient is briefly null after scene changes: + // https://github.com/MirrorNetworking/Mirror/issues/3329 + if (syncDirection == SyncDirection.ClientToServer && + connectionToClient != null && + !isOwned) + { + if (serverSnapshots.Count > 0) + { + // step the transform interpolation without touching time. + // NetworkClient is responsible for time globally. + SnapshotInterpolation.StepInterpolation( + serverSnapshots, + connectionToClient.remoteTimeline, + out TransformSnapshot from, + out TransformSnapshot to, + out double t); + + // interpolate & apply + TransformSnapshot computed = TransformSnapshot.Interpolate(from, to, t); + Apply(computed, to); + } + } + } + + protected virtual void UpdateClient() + { + // client authority, and local player (= allowed to move myself)? + if (!IsClientWithAuthority) + { + // only while we have snapshots + if (clientSnapshots.Count > 0) + { + // step the interpolation without touching time. + // NetworkClient is responsible for time globally. + SnapshotInterpolation.StepInterpolation( + clientSnapshots, + NetworkTime.time, // == NetworkClient.localTimeline from snapshot interpolation + out TransformSnapshot from, + out TransformSnapshot to, + out double t); + + // interpolate & apply + TransformSnapshot computed = TransformSnapshot.Interpolate(from, to, t); + Apply(computed, to); + } + + lastClientCount = clientSnapshots.Count; + } + } + + protected virtual void CheckLastSendTime() + { + // timeAsDouble not available in older Unity versions. + if (AccurateInterval.Elapsed(NetworkTime.localTime, NetworkServer.sendInterval, ref lastSendIntervalTime)) + { + if (sendIntervalCounter == sendIntervalMultiplier) + sendIntervalCounter = 0; + sendIntervalCounter++; + } + } + + // check if position / rotation / scale changed since last sync + protected virtual bool Changed(TransformSnapshot current) => + // position is quantized and delta compressed. + // only consider it changed if the quantized representation is changed. + // careful: don't use 'serialized / deserialized last'. as it depends on sync mode etc. + QuantizedChanged(last.position, current.position, positionPrecision) || + // rotation isn't quantized / delta compressed. + // check with sensitivity. + Quaternion.Angle(last.rotation, current.rotation) > rotationSensitivity || + // scale is quantized and delta compressed. + // only consider it changed if the quantized representation is changed. + // careful: don't use 'serialized / deserialized last'. as it depends on sync mode etc. + QuantizedChanged(last.scale, current.scale, scalePrecision); + + // helper function to compare quantized representations of a Vector3 + [MethodImpl(MethodImplOptions.AggressiveInlining)] + protected bool QuantizedChanged(Vector3 u, Vector3 v, float precision) + { + Compression.ScaleToLong(u, precision, out Vector3Long uQuantized); + Compression.ScaleToLong(v, precision, out Vector3Long vQuantized); + return uQuantized != vQuantized; + } + + // NT may be used on client/server/host to Owner/Observers with + // ServerToClient or ClientToServer. + // however, OnSerialize should always delta against last. + public override void OnSerialize(NetworkWriter writer, bool initialState) + { + // get current snapshot for broadcasting. + TransformSnapshot snapshot = Construct(); + + // ClientToServer optimization: + // for interpolated client owned identities, + // always broadcast the latest known snapshot so other clients can + // interpolate immediately instead of catching up too + + // TODO dirty mask? [compression is very good w/o it already] + // each vector's component is delta compressed. + // an unchanged component would still require 1 byte. + // let's use a dirty bit mask to filter those out as well. + + // initial + if (initialState) + { + // If there is a last serialized snapshot, we use it. + // This prevents the new client getting a snapshot that is different + // from what the older clients last got. If this happens, and on the next + // regular serialisation the delta compression will get wrong values. + // Notes: + // 1. Interestingly only the older clients have it wrong, because at the end + // of this function, last = snapshot which is the initial state's snapshot + // 2. Regular NTR gets by this bug because it sends every frame anyway so initialstate + // snapshot constructed would have been the same as the last anyway. + if (last.remoteTime > 0) snapshot = last; + if (syncPosition) writer.WriteVector3(snapshot.position); + if (syncRotation) + { + // (optional) smallest three compression for now. no delta. + if (compressRotation) + writer.WriteUInt(Compression.CompressQuaternion(snapshot.rotation)); + else + writer.WriteQuaternion(snapshot.rotation); + } + if (syncScale) writer.WriteVector3(snapshot.scale); + } + // delta + else + { + // int before = writer.Position; + + if (syncPosition) + { + // quantize -> delta -> varint + Compression.ScaleToLong(snapshot.position, positionPrecision, out Vector3Long quantized); + DeltaCompression.Compress(writer, lastSerializedPosition, quantized); + } + if (syncRotation) + { + // (optional) smallest three compression for now. no delta. + if (compressRotation) + writer.WriteUInt(Compression.CompressQuaternion(snapshot.rotation)); + else + writer.WriteQuaternion(snapshot.rotation); + } + if (syncScale) + { + // quantize -> delta -> varint + Compression.ScaleToLong(snapshot.scale, scalePrecision, out Vector3Long quantized); + DeltaCompression.Compress(writer, lastSerializedScale, quantized); + } + } + + // save serialized as 'last' for next delta compression + if (syncPosition) Compression.ScaleToLong(snapshot.position, positionPrecision, out lastSerializedPosition); + if (syncScale) Compression.ScaleToLong(snapshot.scale, scalePrecision, out lastSerializedScale); + + // set 'last' + last = snapshot; + } + + public override void OnDeserialize(NetworkReader reader, bool initialState) + { + Vector3? position = null; + Quaternion? rotation = null; + Vector3? scale = null; + + // initial + if (initialState) + { + if (syncPosition) position = reader.ReadVector3(); + if (syncRotation) + { + // (optional) smallest three compression for now. no delta. + if (compressRotation) + rotation = Compression.DecompressQuaternion(reader.ReadUInt()); + else + rotation = reader.ReadQuaternion(); + } + if (syncScale) scale = reader.ReadVector3(); + } + // delta + else + { + // varint -> delta -> quantize + if (syncPosition) + { + Vector3Long quantized = DeltaCompression.Decompress(reader, lastDeserializedPosition); + position = Compression.ScaleToFloat(quantized, positionPrecision); + } + if (syncRotation) + { + // (optional) smallest three compression for now. no delta. + if (compressRotation) + rotation = Compression.DecompressQuaternion(reader.ReadUInt()); + else + rotation = reader.ReadQuaternion(); + } + if (syncScale) + { + Vector3Long quantized = DeltaCompression.Decompress(reader, lastDeserializedScale); + scale = Compression.ScaleToFloat(quantized, scalePrecision); + } + } + + // handle depending on server / client / host. + // server has priority for host mode. + if (isServer) OnClientToServerSync(position, rotation, scale); + else if (isClient) OnServerToClientSync(position, rotation, scale); + + // save deserialized as 'last' for next delta compression + if (syncPosition) Compression.ScaleToLong(position.Value, positionPrecision, out lastDeserializedPosition); + if (syncScale) Compression.ScaleToLong(scale.Value, scalePrecision, out lastDeserializedScale); + } + + // sync //////////////////////////////////////////////////////////////// + + // local authority client sends sync message to server for broadcasting + protected virtual void OnClientToServerSync(Vector3? position, Quaternion? rotation, Vector3? scale) + { + // only apply if in client authority mode + if (syncDirection != SyncDirection.ClientToServer) return; + + // protect against ever growing buffer size attacks + if (serverSnapshots.Count >= connectionToClient.snapshotBufferSizeLimit) return; + + // 'only sync on change' needs a correction on every new move sequence. + if (onlySyncOnChange && + NeedsCorrection(serverSnapshots, connectionToClient.remoteTimeStamp, NetworkServer.sendInterval * sendIntervalMultiplier, onlySyncOnChangeCorrectionMultiplier)) + { + RewriteHistory( + serverSnapshots, + connectionToClient.remoteTimeStamp, + NetworkTime.localTime, // arrival remote timestamp. NOT remote timeline. + NetworkServer.sendInterval * sendIntervalMultiplier, // Unity 2019 doesn't have timeAsDouble yet + GetPosition(), + GetRotation(), + GetScale()); + } + + // add a small timeline offset to account for decoupled arrival of + // NetworkTime and NetworkTransform snapshots. + // needs to be sendInterval. half sendInterval doesn't solve it. + // https://github.com/MirrorNetworking/Mirror/issues/3427 + // remove this after LocalWorldState. + AddSnapshot(serverSnapshots, connectionToClient.remoteTimeStamp + timeStampAdjustment + offset, position, rotation, scale); + } + + // server broadcasts sync message to all clients + protected virtual void OnServerToClientSync(Vector3? position, Quaternion? rotation, Vector3? scale) + { + // don't apply for local player with authority + if (IsClientWithAuthority) return; + + // 'only sync on change' needs a correction on every new move sequence. + if (onlySyncOnChange && + NeedsCorrection(clientSnapshots, NetworkClient.connection.remoteTimeStamp, NetworkClient.sendInterval * sendIntervalMultiplier, onlySyncOnChangeCorrectionMultiplier)) + { + RewriteHistory( + clientSnapshots, + NetworkClient.connection.remoteTimeStamp, // arrival remote timestamp. NOT remote timeline. + NetworkTime.localTime, // Unity 2019 doesn't have timeAsDouble yet + NetworkClient.sendInterval * sendIntervalMultiplier, + GetPosition(), + GetRotation(), + GetScale()); + } + + // add a small timeline offset to account for decoupled arrival of + // NetworkTime and NetworkTransform snapshots. + // needs to be sendInterval. half sendInterval doesn't solve it. + // https://github.com/MirrorNetworking/Mirror/issues/3427 + // remove this after LocalWorldState. + AddSnapshot(clientSnapshots, NetworkClient.connection.remoteTimeStamp + timeStampAdjustment + offset, position, rotation, scale); + } + + // only sync on change ///////////////////////////////////////////////// + // snap interp. needs a continous flow of packets. + // 'only sync on change' interrupts it while not changed. + // once it restarts, snap interp. will interp from the last old position. + // this will cause very noticeable stutter for the first move each time. + // the fix is quite simple. + + // 1. detect if the remaining snapshot is too old from a past move. + static bool NeedsCorrection( + SortedList snapshots, + double remoteTimestamp, + double bufferTime, + double toleranceMultiplier) => + snapshots.Count == 1 && + remoteTimestamp - snapshots.Keys[0] >= bufferTime * toleranceMultiplier; + + // 2. insert a fake snapshot at current position, + // exactly one 'sendInterval' behind the newly received one. + static void RewriteHistory( + SortedList snapshots, + // timestamp of packet arrival, not interpolated remote time! + double remoteTimeStamp, + double localTime, + double sendInterval, + Vector3 position, + Quaternion rotation, + Vector3 scale) + { + // clear the previous snapshot + snapshots.Clear(); + + // insert a fake one at where we used to be, + // 'sendInterval' behind the new one. + SnapshotInterpolation.InsertIfNotExists( + snapshots, + NetworkClient.snapshotSettings.bufferLimit, + new TransformSnapshot( + remoteTimeStamp - sendInterval, // arrival remote timestamp. NOT remote time. + localTime - sendInterval, // Unity 2019 doesn't have timeAsDouble yet + position, + rotation, + scale + ) + ); + } + + public override void Reset() + { + base.Reset(); + + // reset delta + lastSerializedPosition = Vector3Long.zero; + lastDeserializedPosition = Vector3Long.zero; + + lastSerializedScale = Vector3Long.zero; + lastDeserializedScale = Vector3Long.zero; + + // reset 'last' for delta too + last = new TransformSnapshot(0, 0, Vector3.zero, Quaternion.identity, Vector3.zero); + } + } +} diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransformReliable.cs.meta b/Assets/Mirror/Components/NetworkTransform/NetworkTransformReliable.cs.meta new file mode 100644 index 0000000..ece9c7d --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransformReliable.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8ff3ba0becae47b8b9381191598957c8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransformUnreliable.cs b/Assets/Mirror/Components/NetworkTransform/NetworkTransformUnreliable.cs new file mode 100644 index 0000000..29c0369 --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransformUnreliable.cs @@ -0,0 +1,382 @@ +// NetworkTransform V2 by mischa (2021-07) +// comment out the below line to quickly revert the onlySyncOnChange feature +#define onlySyncOnChange_BANDWIDTH_SAVING +using UnityEngine; + +namespace Mirror +{ + [AddComponentMenu("Network/Network Transform (Unreliable)")] + public class NetworkTransformUnreliable : NetworkTransformBase + { + // only sync when changed hack ///////////////////////////////////////// +#if onlySyncOnChange_BANDWIDTH_SAVING + [Header("Sync Only If Changed")] + [Tooltip("When true, changes are not sent unless greater than sensitivity values below.")] + public bool onlySyncOnChange = true; + + uint sendIntervalCounter = 0; + double lastSendIntervalTime = double.MinValue; + + // Testing under really bad network conditions, 2%-5% packet loss and 250-1200ms ping, 5 proved to eliminate any twitching, however this should not be the default as it is a rare case Developers may want to cover. + [Tooltip("How much time, as a multiple of send interval, has passed before clearing buffers.\nA larger buffer means more delay, but results in smoother movement.\nExample: 1 for faster responses minimal smoothing, 5 covers bad pings but has noticable delay, 3 is recommended for balanced results,.")] + public float bufferResetMultiplier = 3; + + [Header("Sensitivity"), Tooltip("Sensitivity of changes needed before an updated state is sent over the network")] + public float positionSensitivity = 0.01f; + public float rotationSensitivity = 0.01f; + public float scaleSensitivity = 0.01f; + + protected bool positionChanged; + protected bool rotationChanged; + protected bool scaleChanged; + + // Used to store last sent snapshots + protected TransformSnapshot lastSnapshot; + protected bool cachedSnapshotComparison; + protected bool hasSentUnchangedPosition; +#endif + + // update ////////////////////////////////////////////////////////////// + // Update applies interpolation + void Update() + { + if (isServer) UpdateServerInterpolation(); + // for all other clients (and for local player if !authority), + // we need to apply snapshots from the buffer. + // 'else if' because host mode shouldn't interpolate client + else if (isClient && !IsClientWithAuthority) UpdateClientInterpolation(); + } + + // LateUpdate broadcasts. + // movement scripts may change positions in Update. + // use LateUpdate to ensure changes are detected in the same frame. + // otherwise this may run before user update, delaying detection until next frame. + // this could cause visible jitter. + void LateUpdate() + { + // if server then always sync to others. + if (isServer) UpdateServerBroadcast(); + // client authority, and local player (= allowed to move myself)? + // 'else if' because host mode shouldn't send anything to server. + // it is the server. don't overwrite anything there. + else if (isClient && IsClientWithAuthority) UpdateClientBroadcast(); + } + + protected virtual void CheckLastSendTime() + { + // We check interval every frame, and then send if interval is reached. + // So by the time sendIntervalCounter == sendIntervalMultiplier, data is sent, + // thus we reset the counter here. + // This fixes previous issue of, if sendIntervalMultiplier = 1, we send every frame, + // because intervalCounter is always = 1 in the previous version. + + if (sendIntervalCounter == sendIntervalMultiplier) + sendIntervalCounter = 0; + + // timeAsDouble not available in older Unity versions. + if (AccurateInterval.Elapsed(NetworkTime.localTime, NetworkServer.sendInterval, ref lastSendIntervalTime)) + sendIntervalCounter++; + } + + void UpdateServerBroadcast() + { + // broadcast to all clients each 'sendInterval' + // (client with authority will drop the rpc) + // NetworkTime.localTime for double precision until Unity has it too + // + // IMPORTANT: + // snapshot interpolation requires constant sending. + // DO NOT only send if position changed. for example: + // --- + // * client sends first position at t=0 + // * ... 10s later ... + // * client moves again, sends second position at t=10 + // --- + // * server gets first position at t=0 + // * server gets second position at t=10 + // * server moves from first to second within a time of 10s + // => would be a super slow move, instead of a wait & move. + // + // IMPORTANT: + // DO NOT send nulls if not changed 'since last send' either. we + // send unreliable and don't know which 'last send' the other end + // received successfully. + // + // Checks to ensure server only sends snapshots if object is + // on server authority(!clientAuthority) mode because on client + // authority mode snapshots are broadcasted right after the authoritative + // client updates server in the command function(see above), OR, + // since host does not send anything to update the server, any client + // authoritative movement done by the host will have to be broadcasted + // here by checking IsClientWithAuthority. + // TODO send same time that NetworkServer sends time snapshot? + CheckLastSendTime(); + + if (sendIntervalCounter == sendIntervalMultiplier && // same interval as time interpolation! + (syncDirection == SyncDirection.ServerToClient || IsClientWithAuthority)) + { + // send snapshot without timestamp. + // receiver gets it from batch timestamp to save bandwidth. + TransformSnapshot snapshot = Construct(); +#if onlySyncOnChange_BANDWIDTH_SAVING + cachedSnapshotComparison = CompareSnapshots(snapshot); + if (cachedSnapshotComparison && hasSentUnchangedPosition && onlySyncOnChange) { return; } +#endif + +#if onlySyncOnChange_BANDWIDTH_SAVING + RpcServerToClientSync( + // only sync what the user wants to sync + syncPosition && positionChanged ? snapshot.position : default(Vector3?), + syncRotation && rotationChanged ? snapshot.rotation : default(Quaternion?), + syncScale && scaleChanged ? snapshot.scale : default(Vector3?) + ); +#else + RpcServerToClientSync( + // only sync what the user wants to sync + syncPosition ? snapshot.position : default(Vector3?), + syncRotation ? snapshot.rotation : default(Quaternion?), + syncScale ? snapshot.scale : default(Vector3?) + ); +#endif + +#if onlySyncOnChange_BANDWIDTH_SAVING + if (cachedSnapshotComparison) + { + hasSentUnchangedPosition = true; + } + else + { + hasSentUnchangedPosition = false; + lastSnapshot = snapshot; + } +#endif + } + } + + void UpdateServerInterpolation() + { + // apply buffered snapshots IF client authority + // -> in server authority, server moves the object + // so no need to apply any snapshots there. + // -> don't apply for host mode player objects either, even if in + // client authority mode. if it doesn't go over the network, + // then we don't need to do anything. + // -> connectionToClient is briefly null after scene changes: + // https://github.com/MirrorNetworking/Mirror/issues/3329 + if (syncDirection == SyncDirection.ClientToServer && + connectionToClient != null && + !isOwned) + { + if (serverSnapshots.Count == 0) return; + + // step the transform interpolation without touching time. + // NetworkClient is responsible for time globally. + SnapshotInterpolation.StepInterpolation( + serverSnapshots, + connectionToClient.remoteTimeline, + out TransformSnapshot from, + out TransformSnapshot to, + out double t); + + // interpolate & apply + TransformSnapshot computed = TransformSnapshot.Interpolate(from, to, t); + Apply(computed, to); + } + } + + void UpdateClientBroadcast() + { + // https://github.com/vis2k/Mirror/pull/2992/ + if (!NetworkClient.ready) return; + + // send to server each 'sendInterval' + // NetworkTime.localTime for double precision until Unity has it too + // + // IMPORTANT: + // snapshot interpolation requires constant sending. + // DO NOT only send if position changed. for example: + // --- + // * client sends first position at t=0 + // * ... 10s later ... + // * client moves again, sends second position at t=10 + // --- + // * server gets first position at t=0 + // * server gets second position at t=10 + // * server moves from first to second within a time of 10s + // => would be a super slow move, instead of a wait & move. + // + // IMPORTANT: + // DO NOT send nulls if not changed 'since last send' either. we + // send unreliable and don't know which 'last send' the other end + // received successfully. + CheckLastSendTime(); + if (sendIntervalCounter == sendIntervalMultiplier) // same interval as time interpolation! + { + // send snapshot without timestamp. + // receiver gets it from batch timestamp to save bandwidth. + TransformSnapshot snapshot = Construct(); +#if onlySyncOnChange_BANDWIDTH_SAVING + cachedSnapshotComparison = CompareSnapshots(snapshot); + if (cachedSnapshotComparison && hasSentUnchangedPosition && onlySyncOnChange) { return; } +#endif + +#if onlySyncOnChange_BANDWIDTH_SAVING + CmdClientToServerSync( + // only sync what the user wants to sync + syncPosition && positionChanged ? snapshot.position : default(Vector3?), + syncRotation && rotationChanged ? snapshot.rotation : default(Quaternion?), + syncScale && scaleChanged ? snapshot.scale : default(Vector3?) + ); +#else + CmdClientToServerSync( + // only sync what the user wants to sync + syncPosition ? snapshot.position : default(Vector3?), + syncRotation ? snapshot.rotation : default(Quaternion?), + syncScale ? snapshot.scale : default(Vector3?) + ); +#endif + +#if onlySyncOnChange_BANDWIDTH_SAVING + if (cachedSnapshotComparison) + { + hasSentUnchangedPosition = true; + } + else + { + hasSentUnchangedPosition = false; + lastSnapshot = snapshot; + } +#endif + } + } + + void UpdateClientInterpolation() + { + // only while we have snapshots + if (clientSnapshots.Count == 0) return; + + // step the interpolation without touching time. + // NetworkClient is responsible for time globally. + SnapshotInterpolation.StepInterpolation( + clientSnapshots, + NetworkTime.time, // == NetworkClient.localTimeline from snapshot interpolation + out TransformSnapshot from, + out TransformSnapshot to, + out double t); + + // interpolate & apply + TransformSnapshot computed = TransformSnapshot.Interpolate(from, to, t); + Apply(computed, to); + } + + public override void OnSerialize(NetworkWriter writer, bool initialState) + { + // sync target component's position on spawn. + // fixes https://github.com/vis2k/Mirror/pull/3051/ + // (Spawn message wouldn't sync NTChild positions either) + if (initialState) + { + if (syncPosition) writer.WriteVector3(GetPosition()); + if (syncRotation) writer.WriteQuaternion(GetRotation()); + if (syncScale) writer.WriteVector3(GetScale()); + } + } + + public override void OnDeserialize(NetworkReader reader, bool initialState) + { + // sync target component's position on spawn. + // fixes https://github.com/vis2k/Mirror/pull/3051/ + // (Spawn message wouldn't sync NTChild positions either) + if (initialState) + { + if (syncPosition) SetPosition(reader.ReadVector3()); + if (syncRotation) SetRotation(reader.ReadQuaternion()); + if (syncScale) SetScale(reader.ReadVector3()); + } + } + +#if onlySyncOnChange_BANDWIDTH_SAVING + // Returns true if position, rotation AND scale are unchanged, within given sensitivity range. + protected virtual bool CompareSnapshots(TransformSnapshot currentSnapshot) + { + positionChanged = Vector3.SqrMagnitude(lastSnapshot.position - currentSnapshot.position) > positionSensitivity * positionSensitivity; + rotationChanged = Quaternion.Angle(lastSnapshot.rotation, currentSnapshot.rotation) > rotationSensitivity; + scaleChanged = Vector3.SqrMagnitude(lastSnapshot.scale - currentSnapshot.scale) > scaleSensitivity * scaleSensitivity; + + return (!positionChanged && !rotationChanged && !scaleChanged); + } +#endif + // cmd ///////////////////////////////////////////////////////////////// + // only unreliable. see comment above of this file. + [Command(channel = Channels.Unreliable)] + void CmdClientToServerSync(Vector3? position, Quaternion? rotation, Vector3? scale) + { + OnClientToServerSync(position, rotation, scale); + //For client authority, immediately pass on the client snapshot to all other + //clients instead of waiting for server to send its snapshots. + if (syncDirection == SyncDirection.ClientToServer) + RpcServerToClientSync(position, rotation, scale); + } + + // local authority client sends sync message to server for broadcasting + protected virtual void OnClientToServerSync(Vector3? position, Quaternion? rotation, Vector3? scale) + { + // only apply if in client authority mode + if (syncDirection != SyncDirection.ClientToServer) return; + + // protect against ever growing buffer size attacks + if (serverSnapshots.Count >= connectionToClient.snapshotBufferSizeLimit) return; + + // only player owned objects (with a connection) can send to + // server. we can get the timestamp from the connection. + double timestamp = connectionToClient.remoteTimeStamp; +#if onlySyncOnChange_BANDWIDTH_SAVING + if (onlySyncOnChange) + { + double timeIntervalCheck = bufferResetMultiplier * sendIntervalMultiplier * NetworkClient.sendInterval; + + if (serverSnapshots.Count > 0 && serverSnapshots.Values[serverSnapshots.Count - 1].remoteTime + timeIntervalCheck < timestamp) + Reset(); + } +#endif + AddSnapshot(serverSnapshots, connectionToClient.remoteTimeStamp + timeStampAdjustment + offset, position, rotation, scale); + } + + // rpc ///////////////////////////////////////////////////////////////// + // only unreliable. see comment above of this file. + [ClientRpc(channel = Channels.Unreliable)] + void RpcServerToClientSync(Vector3? position, Quaternion? rotation, Vector3? scale) => + OnServerToClientSync(position, rotation, scale); + + // server broadcasts sync message to all clients + protected virtual void OnServerToClientSync(Vector3? position, Quaternion? rotation, Vector3? scale) + { + // in host mode, the server sends rpcs to all clients. + // the host client itself will receive them too. + // -> host server is always the source of truth + // -> we can ignore any rpc on the host client + // => otherwise host objects would have ever growing clientBuffers + // (rpc goes to clients. if isServer is true too then we are host) + if (isServer) return; + + // don't apply for local player with authority + if (IsClientWithAuthority) return; + + // on the client, we receive rpcs for all entities. + // not all of them have a connectionToServer. + // but all of them go through NetworkClient.connection. + // we can get the timestamp from there. + double timestamp = NetworkClient.connection.remoteTimeStamp; +#if onlySyncOnChange_BANDWIDTH_SAVING + if (onlySyncOnChange) + { + double timeIntervalCheck = bufferResetMultiplier * sendIntervalMultiplier * NetworkServer.sendInterval; + + if (clientSnapshots.Count > 0 && clientSnapshots.Values[clientSnapshots.Count - 1].remoteTime + timeIntervalCheck < timestamp) + Reset(); + } +#endif + AddSnapshot(clientSnapshots, NetworkClient.connection.remoteTimeStamp + timeStampAdjustment + offset, position, rotation, scale); + } + } +} diff --git a/Assets/Mirror/Components/NetworkTransform/NetworkTransformUnreliable.cs.meta b/Assets/Mirror/Components/NetworkTransform/NetworkTransformUnreliable.cs.meta new file mode 100644 index 0000000..3a4a75a --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/NetworkTransformUnreliable.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a553cb17010b2403e8523b558bffbc14 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/NetworkTransform/TransformSnapshot.cs b/Assets/Mirror/Components/NetworkTransform/TransformSnapshot.cs new file mode 100644 index 0000000..912b10d --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/TransformSnapshot.cs @@ -0,0 +1,65 @@ +// snapshot for snapshot interpolation +// https://gafferongames.com/post/snapshot_interpolation/ +// position, rotation, scale for compatibility for now. +using UnityEngine; + +namespace Mirror +{ + // NetworkTransform Snapshot + public struct TransformSnapshot : Snapshot + { + // time or sequence are needed to throw away older snapshots. + // + // glenn fiedler starts with a 16 bit sequence number. + // supposedly this is meant as a simplified example. + // in the end we need the remote timestamp for accurate interpolation + // and buffering over time. + // + // note: in theory, IF server sends exactly(!) at the same interval then + // the 16 bit ushort timestamp would be enough to calculate the + // remote time (sequence * sendInterval). but Unity's update is + // not guaranteed to run on the exact intervals / do catchup. + // => remote timestamp is better for now + // + // [REMOTE TIME, NOT LOCAL TIME] + // => DOUBLE for long term accuracy & batching gives us double anyway + public double remoteTime { get; set; } + + // the local timestamp (when we received it) + // used to know if the first two snapshots are old enough to start. + public double localTime { get; set; } + + public Vector3 position; + public Quaternion rotation; + public Vector3 scale; + + public TransformSnapshot(double remoteTime, double localTime, Vector3 position, Quaternion rotation, Vector3 scale) + { + this.remoteTime = remoteTime; + this.localTime = localTime; + this.position = position; + this.rotation = rotation; + this.scale = scale; + } + + public static TransformSnapshot Interpolate(TransformSnapshot from, TransformSnapshot to, double t) + { + // NOTE: + // Vector3 & Quaternion components are float anyway, so we can + // keep using the functions with 't' as float instead of double. + return new TransformSnapshot( + // interpolated snapshot is applied directly. don't need timestamps. + 0, 0, + // lerp position/rotation/scale unclamped in case we ever need + // to extrapolate. atm SnapshotInterpolation never does. + Vector3.LerpUnclamped(from.position, to.position, (float)t), + // IMPORTANT: LerpUnclamped(0, 60, 1.5) extrapolates to ~86. + // SlerpUnclamped(0, 60, 1.5) extrapolates to 90! + // (0, 90, 1.5) is even worse. for Lerp. + // => Slerp works way better for our euler angles. + Quaternion.SlerpUnclamped(from.rotation, to.rotation, (float)t), + Vector3.LerpUnclamped(from.scale, to.scale, (float)t) + ); + } + } +} diff --git a/Assets/Mirror/Components/NetworkTransform/TransformSnapshot.cs.meta b/Assets/Mirror/Components/NetworkTransform/TransformSnapshot.cs.meta new file mode 100644 index 0000000..f43458f --- /dev/null +++ b/Assets/Mirror/Components/NetworkTransform/TransformSnapshot.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d3dae77b43dc4e1dbb2012924b2da79c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Components/RemoteStatistics.cs b/Assets/Mirror/Components/RemoteStatistics.cs new file mode 100644 index 0000000..aa18815 --- /dev/null +++ b/Assets/Mirror/Components/RemoteStatistics.cs @@ -0,0 +1,441 @@ +// remote statistics panel from Mirror II to show connections, load, etc. +// server syncs statistics to clients if authenticated. +// +// attach this to a player. +// requires NetworkStatistics component on the Network object. +// +// Unity's OnGUI is the easiest to use solution at the moment. +// * playfab is super complex to set up +// * http servers would be nice, but still need to open ports, live refresh, etc +// +// for safety reasons, let's keep this read-only. +// at least until there's safe authentication. +using System; +using System.IO; +using UnityEngine; + +namespace Mirror +{ + // server -> client + struct Stats + { + // general + public int connections; + public double uptime; + public int configuredTickRate; + public int actualTickRate; + + // traffic + public long sentBytesPerSecond; + public long receiveBytesPerSecond; + + // cpu + public float serverTickInterval; + public double fullUpdateAvg; + public double serverEarlyAvg; + public double serverLateAvg; + public double transportEarlyAvg; + public double transportLateAvg; + + // C# boilerplate + public Stats( + // general + int connections, + double uptime, + int configuredTickRate, + int actualTickRate, + // traffic + long sentBytesPerSecond, + long receiveBytesPerSecond, + // cpu + float serverTickInterval, + double fullUpdateAvg, + double serverEarlyAvg, + double serverLateAvg, + double transportEarlyAvg, + double transportLateAvg + ) + { + // general + this.connections = connections; + this.uptime = uptime; + this.configuredTickRate = configuredTickRate; + this.actualTickRate = actualTickRate; + + // traffic + this.sentBytesPerSecond = sentBytesPerSecond; + this.receiveBytesPerSecond = receiveBytesPerSecond; + + // cpu + this.serverTickInterval = serverTickInterval; + this.fullUpdateAvg = fullUpdateAvg; + this.serverEarlyAvg = serverEarlyAvg; + this.serverLateAvg = serverLateAvg; + this.transportEarlyAvg = transportEarlyAvg; + this.transportLateAvg = transportLateAvg; + } + } + + // [RequireComponent(typeof(NetworkStatistics))] <- needs to be on Network GO, not on NI + public class RemoteStatistics : NetworkBehaviour + { + // components ("fake statics" for similar API) + protected NetworkStatistics NetworkStatistics; + + // broadcast to client. + // stats are quite huge, let's only send every few seconds via TargetRpc. + // instead of sending multiple times per second via NB.OnSerialize. + [Tooltip("Send stats every 'interval' seconds to client.")] + public float sendInterval = 1; + double lastSendTime; + + [Header("GUI")] + public bool showGui; + public KeyCode hotKey = KeyCode.F11; + Rect windowRect = new Rect(0, 0, 400, 400); + + // password can't be stored in code or in Unity project. + // it would be available in clients otherwise. + // this is not perfectly secure. that's why RemoteStatistics is read-only. + [Header("Authentication")] + public string passwordFile = "remote_statistics.txt"; + protected bool serverAuthenticated; // client needs to authenticate + protected bool clientAuthenticated; // show GUI until authenticated + protected string serverPassword = null; // null means not found, auth impossible + protected string clientPassword = ""; // for GUI + + // statistics synced to client + Stats stats; + + void LoadPassword() + { + // TODO only load once, not for all players? + // let's avoid static state for now. + + // load the password + string path = Path.GetFullPath(passwordFile); + if (File.Exists(path)) + { + // don't spam the server logs for every player's loaded file + // Debug.Log($"RemoteStatistics: loading password file: {path}"); + try + { + serverPassword = File.ReadAllText(path); + } + catch (Exception exception) + { + Debug.LogWarning($"RemoteStatistics: failed to read password file: {exception}"); + } + } + else + { + Debug.LogWarning($"RemoteStatistics: password file has not been created. Authentication will be impossible. Please save the password in: {path}"); + } + } + + protected override void OnValidate() + { + base.OnValidate(); + syncMode = SyncMode.Owner; + } + + // make sure to call base function when overwriting! + // public so it can also be called from tests (and be overwritten by users) + public override void OnStartServer() + { + NetworkStatistics = NetworkManager.singleton.GetComponent(); + if (NetworkStatistics == null) throw new Exception($"RemoteStatistics requires a NetworkStatistics component on {NetworkManager.singleton.name}!"); + + // server needs to load the password + LoadPassword(); + } + + public override void OnStartLocalPlayer() + { + // center the window initially + windowRect.x = Screen.width / 2 - windowRect.width / 2; + windowRect.y = Screen.height / 2 - windowRect.height / 2; + } + + [TargetRpc] + void TargetRpcSync(Stats v) + { + // store stats and flag as authenticated + clientAuthenticated = true; + stats = v; + } + + [Command] + public void CmdAuthenticate(string v) + { + // was a valid password loaded on the server, + // and did the client send the correct one? + if (!string.IsNullOrWhiteSpace(serverPassword) && + serverPassword.Equals(v)) + { + serverAuthenticated = true; + Debug.Log($"RemoteStatistics: connectionId {connectionToClient.connectionId} authenticated with player {name}"); + } + } + + void UpdateServer() + { + // only sync if client has authenticated on the server + if (!serverAuthenticated) return; + + // NetworkTime.localTime has defines for 2019 / 2020 compatibility + if (NetworkTime.localTime >= lastSendTime + sendInterval) + { + lastSendTime = NetworkTime.localTime; + + // target rpc to owner client + TargetRpcSync(new Stats( + // general + NetworkServer.connections.Count, + NetworkTime.time, + NetworkServer.tickRate, + NetworkServer.actualTickRate, + + // traffic + NetworkStatistics.serverSentBytesPerSecond, + NetworkStatistics.serverReceivedBytesPerSecond, + + // cpu + NetworkServer.tickInterval, + NetworkServer.fullUpdateDuration.average, + NetworkServer.earlyUpdateDuration.average, + NetworkServer.lateUpdateDuration.average, + 0, // TODO ServerTransport.earlyUpdateDuration.average, + 0 // TODO ServerTransport.lateUpdateDuration.average + )); + } + } + + void UpdateClient() + { + if (Input.GetKeyDown(hotKey)) + showGui = !showGui; + } + + void Update() + { + if (isServer) UpdateServer(); + if (isLocalPlayer) UpdateClient(); + } + + void OnGUI() + { + if (!isLocalPlayer) return; + if (!showGui) return; + + windowRect = GUILayout.Window(0, windowRect, OnWindow, "Remote Statistics"); + windowRect = Utils.KeepInScreen(windowRect); + } + + // Text: value + void GUILayout_TextAndValue(string text, string value) + { + GUILayout.BeginHorizontal(); + GUILayout.Label(text); + GUILayout.FlexibleSpace(); + GUILayout.Label(value); + GUILayout.EndHorizontal(); + } + + // fake a progress bar via horizontal scroll bar with ratio as width + void GUILayout_ProgressBar(double ratio, int width) + { + // clamp ratio, otherwise >1 would make it extremely large + ratio = Mathd.Clamp01(ratio); + GUILayout.HorizontalScrollbar(0, (float)ratio, 0, 1, GUILayout.Width(width)); + } + + // need to specify progress bar & caption width, + // otherwise differently sized captions would always misalign the + // progress bars. + void GUILayout_TextAndProgressBar(string text, double ratio, int progressbarWidth, string caption, int captionWidth, Color captionColor) + { + GUILayout.BeginHorizontal(); + GUILayout.Label(text); + GUILayout.FlexibleSpace(); + GUILayout_ProgressBar(ratio, progressbarWidth); + + // coloring the caption is enough. otherwise it's too much. + GUI.color = captionColor; + GUILayout.Label(caption, GUILayout.Width(captionWidth)); + GUI.color = Color.white; + + GUILayout.EndHorizontal(); + } + + void GUI_Authenticate() + { + GUILayout.BeginVertical("Box"); // start general + GUILayout.Label("Authentication"); + + // warning if insecure connection + // if (ClientTransport.IsEncrypted()) + // { + // GUILayout.Label("Connection is encrypted!"); + // } + // else + // { + GUILayout.Label("Connection is not encrypted. Use with care!"); + // } + + // input + clientPassword = GUILayout.PasswordField(clientPassword, '*'); + + // button + GUI.enabled = !string.IsNullOrWhiteSpace(clientPassword); + if (GUILayout.Button("Authenticate")) + { + CmdAuthenticate(clientPassword); + } + GUI.enabled = true; + + GUILayout.EndVertical(); // end general + } + + void GUI_General( + int connections, + double uptime, + int configuredTickRate, + int actualTickRate) + { + GUILayout.BeginVertical("Box"); // start general + GUILayout.Label("General"); + + // connections + GUILayout_TextAndValue("Connections:", $"{connections}"); + + // uptime + GUILayout_TextAndValue("Uptime:", $"{Utils.PrettySeconds(uptime)}"); // TODO + + // tick rate + // might be lower under heavy load. + // might be higher in editor if targetFrameRate can't be set. + GUI.color = actualTickRate < configuredTickRate ? Color.red : Color.green; + GUILayout_TextAndValue("Tick Rate:", $"{actualTickRate} Hz / {configuredTickRate} Hz"); + GUI.color = Color.white; + + GUILayout.EndVertical(); // end general + } + + void GUI_Traffic( + long serverSentBytesPerSecond, + long serverReceivedBytesPerSecond) + { + GUILayout.BeginVertical("Box"); + GUILayout.Label("Network"); + + GUILayout_TextAndValue("Outgoing:", $"{Utils.PrettyBytes(serverSentBytesPerSecond) }/s"); + GUILayout_TextAndValue("Incoming:", $"{Utils.PrettyBytes(serverReceivedBytesPerSecond)}/s"); + + GUILayout.EndVertical(); + } + + void GUI_Cpu( + float serverTickInterval, + double fullUpdateAvg, + double serverEarlyAvg, + double serverLateAvg, + double transportEarlyAvg, + double transportLateAvg) + { + const int barWidth = 120; + const int captionWidth = 90; + + GUILayout.BeginVertical("Box"); + GUILayout.Label("CPU"); + + // unity update + // happens every 'tickInterval'. progress bar shows it in relation. + // <= 90% load is green, otherwise red + double fullRatio = fullUpdateAvg / serverTickInterval; + GUILayout_TextAndProgressBar( + "World Update Avg:", + fullRatio, + barWidth, $"{fullUpdateAvg * 1000:F1} ms", + captionWidth, + fullRatio <= 0.9 ? Color.green : Color.red); + + // server update + // happens every 'tickInterval'. progress bar shows it in relation. + // <= 90% load is green, otherwise red + double serverRatio = (serverEarlyAvg + serverLateAvg) / serverTickInterval; + GUILayout_TextAndProgressBar( + "Server Update Avg:", + serverRatio, + barWidth, $"{serverEarlyAvg * 1000:F1} + {serverLateAvg * 1000:F1} ms", + captionWidth, + serverRatio <= 0.9 ? Color.green : Color.red); + + // transport: early + late update milliseconds. + // for threaded transport, this is the thread's update time. + // happens every 'tickInterval'. progress bar shows it in relation. + // <= 90% load is green, otherwise red + // double transportRatio = (transportEarlyAvg + transportLateAvg) / serverTickInterval; + // GUILayout_TextAndProgressBar( + // "Transport Avg:", + // transportRatio, + // barWidth, + // $"{transportEarlyAvg * 1000:F1} + {transportLateAvg * 1000:F1} ms", + // captionWidth, + // transportRatio <= 0.9 ? Color.green : Color.red); + + GUILayout.EndVertical(); + } + + void GUI_Notice() + { + // for security reasons, let's keep this read-only for now. + + // single line keeps input & visuals simple + // GUILayout.BeginVertical("Box"); + // GUILayout.Label("Global Notice"); + // notice = GUILayout.TextField(notice); + // if (GUILayout.Button("Send")) + // { + // // TODO + // } + // GUILayout.EndVertical(); + } + + void OnWindow(int windowID) + { + if (!clientAuthenticated) + { + GUI_Authenticate(); + } + else + { + GUI_General( + stats.connections, + stats.uptime, + stats.configuredTickRate, + stats.actualTickRate + ); + + GUI_Traffic( + stats.sentBytesPerSecond, + stats.receiveBytesPerSecond + ); + + GUI_Cpu( + stats.serverTickInterval, + stats.fullUpdateAvg, + stats.serverEarlyAvg, + stats.serverLateAvg, + stats.transportEarlyAvg, + stats.transportLateAvg + ); + + GUI_Notice(); + } + + // dragable window in any case + GUI.DragWindow(new Rect(0, 0, 10000, 10000)); + } + } +} diff --git a/Assets/Mirror/Components/RemoteStatistics.cs.meta b/Assets/Mirror/Components/RemoteStatistics.cs.meta new file mode 100644 index 0000000..4c4d043 --- /dev/null +++ b/Assets/Mirror/Components/RemoteStatistics.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ba360e4ff6b44fc6898f56322b90c6c8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core.meta b/Assets/Mirror/Core.meta new file mode 100644 index 0000000..85ee3eb --- /dev/null +++ b/Assets/Mirror/Core.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 9f4328ccc5f724e45afe2215d275b5d5 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/AssemblyInfo.cs b/Assets/Mirror/Core/AssemblyInfo.cs new file mode 100644 index 0000000..f342716 --- /dev/null +++ b/Assets/Mirror/Core/AssemblyInfo.cs @@ -0,0 +1,12 @@ +using System.Runtime.CompilerServices; + +[assembly: InternalsVisibleTo("Mirror.Tests.Common")] +[assembly: InternalsVisibleTo("Mirror.Tests")] +// need to use Unity.*.CodeGen assembly name to import Unity.CompilationPipeline +// for ILPostProcessor tests. +[assembly: InternalsVisibleTo("Unity.Mirror.Tests.CodeGen")] +[assembly: InternalsVisibleTo("Mirror.Tests.Generated")] +[assembly: InternalsVisibleTo("Mirror.Tests.Runtime")] +[assembly: InternalsVisibleTo("Mirror.Tests.Performance.Editor")] +[assembly: InternalsVisibleTo("Mirror.Tests.Performance.Runtime")] +[assembly: InternalsVisibleTo("Mirror.Editor")] diff --git a/Assets/Mirror/Core/AssemblyInfo.cs.meta b/Assets/Mirror/Core/AssemblyInfo.cs.meta new file mode 100644 index 0000000..50cc028 --- /dev/null +++ b/Assets/Mirror/Core/AssemblyInfo.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: e28d5f410e25b42e6a76a2ffc10e4675 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Attributes.cs b/Assets/Mirror/Core/Attributes.cs new file mode 100644 index 0000000..39b06fd --- /dev/null +++ b/Assets/Mirror/Core/Attributes.cs @@ -0,0 +1,85 @@ +using System; +using UnityEngine; + +namespace Mirror +{ + /// + /// SyncVars are used to synchronize a variable from the server to all clients automatically. + /// Value must be changed on server, not directly by clients. Hook parameter allows you to define a client-side method to be invoked when the client gets an update from the server. + /// + [AttributeUsage(AttributeTargets.Field)] + public class SyncVarAttribute : PropertyAttribute + { + public string hook; + } + + /// + /// Call this from a client to run this function on the server. + /// Make sure to validate input etc. It's not possible to call this from a server. + /// + [AttributeUsage(AttributeTargets.Method)] + public class CommandAttribute : Attribute + { + public int channel = Channels.Reliable; + public bool requiresAuthority = true; + } + + /// + /// The server uses a Remote Procedure Call (RPC) to run this function on clients. + /// + [AttributeUsage(AttributeTargets.Method)] + public class ClientRpcAttribute : Attribute + { + public int channel = Channels.Reliable; + public bool includeOwner = true; + } + + /// + /// The server uses a Remote Procedure Call (RPC) to run this function on a specific client. + /// + [AttributeUsage(AttributeTargets.Method)] + public class TargetRpcAttribute : Attribute + { + public int channel = Channels.Reliable; + } + + /// + /// Prevents clients from running this method. + /// Prints a warning if a client tries to execute this method. + /// + [AttributeUsage(AttributeTargets.Method)] + public class ServerAttribute : Attribute {} + + /// + /// Prevents clients from running this method. + /// No warning is thrown. + /// + [AttributeUsage(AttributeTargets.Method)] + public class ServerCallbackAttribute : Attribute {} + + /// + /// Prevents the server from running this method. + /// Prints a warning if the server tries to execute this method. + /// + [AttributeUsage(AttributeTargets.Method)] + public class ClientAttribute : Attribute {} + + /// + /// Prevents the server from running this method. + /// No warning is printed. + /// + [AttributeUsage(AttributeTargets.Method)] + public class ClientCallbackAttribute : Attribute {} + + /// + /// Converts a string property into a Scene property in the inspector + /// + public class SceneAttribute : PropertyAttribute {} + + /// + /// Used to show private SyncList in the inspector, + /// Use instead of SerializeField for non Serializable types + /// + [AttributeUsage(AttributeTargets.Field)] + public class ShowInInspectorAttribute : Attribute {} +} diff --git a/Assets/Mirror/Core/Attributes.cs.meta b/Assets/Mirror/Core/Attributes.cs.meta new file mode 100644 index 0000000..c50a489 --- /dev/null +++ b/Assets/Mirror/Core/Attributes.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c04c722ee2ffd49c8a56ab33667b10b0 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Batching.meta b/Assets/Mirror/Core/Batching.meta new file mode 100644 index 0000000..bf23600 --- /dev/null +++ b/Assets/Mirror/Core/Batching.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 1c38e1bebe9947f8b842a8a57aa2b71c +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Batching/Batcher.cs b/Assets/Mirror/Core/Batching/Batcher.cs new file mode 100644 index 0000000..5e30f08 --- /dev/null +++ b/Assets/Mirror/Core/Batching/Batcher.cs @@ -0,0 +1,150 @@ +// batching functionality encapsulated into one class. +// -> less complexity +// -> easy to test +// +// IMPORTANT: we use THRESHOLD batching, not MAXED SIZE batching. +// see threshold comments below. +// +// includes timestamp for tick batching. +// -> allows NetworkTransform etc. to use timestamp without including it in +// every single message +using System; +using System.Collections.Generic; + +namespace Mirror +{ + public class Batcher + { + // batching threshold instead of max size. + // -> small messages are fit into threshold sized batches + // -> messages larger than threshold are single batches + // + // in other words, we fit up to 'threshold' but still allow larger ones + // for two reasons: + // 1.) data races: skipping batching for larger messages would send a + // large spawn message immediately, while others are batched and + // only flushed at the end of the frame + // 2) timestamp batching: if each batch is expected to contain a + // timestamp, then large messages have to be a batch too. otherwise + // they would not contain a timestamp + readonly int threshold; + + // TimeStamp header size. each batch has one. + public const int TimestampSize = sizeof(double); + + // Message header size. each message has one. + public static int MessageHeaderSize(int messageSize) => + Compression.VarUIntSize((ulong)messageSize); + + // maximum overhead for a single message. + // useful for the outside to calculate max message sizes. + public static int MaxMessageOverhead(int messageSize) => + TimestampSize + MessageHeaderSize(messageSize); + + // full batches ready to be sent. + // DO NOT queue NetworkMessage, it would box. + // DO NOT queue each serialization separately. + // it would allocate too many writers. + // https://github.com/vis2k/Mirror/pull/3127 + // => best to build batches on the fly. + readonly Queue batches = new Queue(); + + // current batch in progress + NetworkWriterPooled batch; + + public Batcher(int threshold) + { + this.threshold = threshold; + } + + // add a message for batching + // we allow any sized messages. + // caller needs to make sure they are within max packet size. + public void AddMessage(ArraySegment message, double timeStamp) + { + // predict the needed size, which is varint(size) + content + int headerSize = Compression.VarUIntSize((ulong)message.Count); + int neededSize = headerSize + message.Count; + + // when appending to a batch in progress, check final size. + // if it expands beyond threshold, then we should finalize it first. + // => less than or exactly threshold is fine. + // GetBatch() will finalize it. + // => see unit tests. + if (batch != null && + batch.Position + neededSize > threshold) + { + batches.Enqueue(batch); + batch = null; + } + + // initialize a new batch if necessary + if (batch == null) + { + // borrow from pool. we return it in GetBatch. + batch = NetworkWriterPool.Get(); + + // write timestamp first. + // -> double precision for accuracy over long periods of time + // -> batches are per-frame, it doesn't matter which message's + // timestamp we use. + batch.WriteDouble(timeStamp); + } + + // add serialization to current batch. even if > threshold. + // -> we do allow > threshold sized messages as single batch + // -> WriteBytes instead of WriteSegment because the latter + // would add a size header. we want to write directly. + // + // include size prefix as varint! + // -> fixes NetworkMessage serialization mismatch corrupting the + // next message in a batch. + // -> a _lot_ of time was wasted debugging corrupt batches. + // no easy way to figure out which NetworkMessage has a mismatch. + // -> this is worth everyone's sanity. + // -> varint means we prefix with 1 byte most of the time. + // -> the same issue in NetworkIdentity was why Mirror started! + Compression.CompressVarUInt(batch, (ulong)message.Count); + batch.WriteBytes(message.Array, message.Offset, message.Count); + } + + // helper function to copy a batch to writer and return it to pool + static void CopyAndReturn(NetworkWriterPooled batch, NetworkWriter writer) + { + // make sure the writer is fresh to avoid uncertain situations + if (writer.Position != 0) + throw new ArgumentException($"GetBatch needs a fresh writer!"); + + // copy to the target writer + ArraySegment segment = batch.ToArraySegment(); + writer.WriteBytes(segment.Array, segment.Offset, segment.Count); + + // return batch to pool for reuse + NetworkWriterPool.Return(batch); + } + + // get the next batch which is available for sending (if any). + // TODO safely get & return a batch instead of copying to writer? + // TODO could return pooled writer & use GetBatch in a 'using' statement! + public bool GetBatch(NetworkWriter writer) + { + // get first batch from queue (if any) + if (batches.TryDequeue(out NetworkWriterPooled first)) + { + CopyAndReturn(first, writer); + return true; + } + + // if queue was empty, we can send the batch in progress. + if (batch != null) + { + CopyAndReturn(batch, writer); + batch = null; + return true; + } + + // nothing was written + return false; + } + } +} diff --git a/Assets/Mirror/Core/Batching/Batcher.cs.meta b/Assets/Mirror/Core/Batching/Batcher.cs.meta new file mode 100644 index 0000000..a774908 --- /dev/null +++ b/Assets/Mirror/Core/Batching/Batcher.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 0afaaa611a2142d48a07bdd03b68b2b3 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Batching/Unbatcher.cs b/Assets/Mirror/Core/Batching/Unbatcher.cs new file mode 100644 index 0000000..6b2c405 --- /dev/null +++ b/Assets/Mirror/Core/Batching/Unbatcher.cs @@ -0,0 +1,129 @@ +// un-batching functionality encapsulated into one class. +// -> less complexity +// -> easy to test +// +// includes timestamp for tick batching. +// -> allows NetworkTransform etc. to use timestamp without including it in +// every single message +using System; +using System.Collections.Generic; + +namespace Mirror +{ + public class Unbatcher + { + // supporting adding multiple batches before GetNextMessage is called. + // just in case. + readonly Queue batches = new Queue(); + + public int BatchesCount => batches.Count; + + // NetworkReader is only created once, + // then pointed to the first batch. + readonly NetworkReader reader = new NetworkReader(new byte[0]); + + // timestamp that was written into the batch remotely. + // for the batch that our reader is currently pointed at. + double readerRemoteTimeStamp; + + // helper function to start reading a batch. + void StartReadingBatch(NetworkWriterPooled batch) + { + // point reader to it + reader.SetBuffer(batch.ToArraySegment()); + + // read remote timestamp (double) + // -> AddBatch quarantees that we have at least 8 bytes to read + readerRemoteTimeStamp = reader.ReadDouble(); + } + + // add a new batch. + // returns true if valid. + // returns false if not, in which case the connection should be disconnected. + public bool AddBatch(ArraySegment batch) + { + // IMPORTANT: ArraySegment is only valid until returning. we copy it! + // + // NOTE: it's not possible to create empty ArraySegments, so we + // don't need to check against that. + + // make sure we have at least 8 bytes to read for tick timestamp + if (batch.Count < Batcher.TimestampSize) + return false; + + // put into a (pooled) writer + // -> WriteBytes instead of WriteSegment because the latter + // would add a size header. we want to write directly. + // -> will be returned to pool when sending! + NetworkWriterPooled writer = NetworkWriterPool.Get(); + writer.WriteBytes(batch.Array, batch.Offset, batch.Count); + + // first batch? then point reader there + if (batches.Count == 0) + StartReadingBatch(writer); + + // add batch + batches.Enqueue(writer); + //Debug.Log($"Adding Batch {BitConverter.ToString(batch.Array, batch.Offset, batch.Count)} => batches={batches.Count} reader={reader}"); + return true; + } + + // get next message, unpacked from batch (if any) + // message ArraySegment is only valid until the next call. + // timestamp is the REMOTE time when the batch was created remotely. + public bool GetNextMessage(out ArraySegment message, out double remoteTimeStamp) + { + message = default; + remoteTimeStamp = 0; + + // do nothing if we don't have any batches. + // otherwise the below queue.Dequeue() would throw an + // InvalidOperationException if operating on empty queue. + if (batches.Count == 0) + return false; + + // was our reader pointed to anything yet? + if (reader.Capacity == 0) + return false; + + // no more data to read? + if (reader.Remaining == 0) + { + // retire the batch + NetworkWriterPooled writer = batches.Dequeue(); + NetworkWriterPool.Return(writer); + + // do we have another batch? + if (batches.Count > 0) + { + // point reader to the next batch. + // we'll return the reader below. + NetworkWriterPooled next = batches.Peek(); + StartReadingBatch(next); + } + // otherwise there's nothing more to read + else return false; + } + + // use the current batch's remote timestamp + // AFTER potentially moving to the next batch ABOVE! + remoteTimeStamp = readerRemoteTimeStamp; + + // enough data to read the size prefix? + if (reader.Remaining == 0) + return false; + + // read the size prefix as varint + // see Batcher.AddMessage comments for explanation. + int size = (int)Compression.DecompressVarUInt(reader); + + // validate size prefix, in case attackers send malicious data + if (reader.Remaining < size) + return false; + + // return the message of size + message = reader.ReadBytesSegment(size); + return true; + } + } +} diff --git a/Assets/Mirror/Core/Batching/Unbatcher.cs.meta b/Assets/Mirror/Core/Batching/Unbatcher.cs.meta new file mode 100644 index 0000000..26038b0 --- /dev/null +++ b/Assets/Mirror/Core/Batching/Unbatcher.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 328562d71e1c45c58581b958845aa7a4 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/ConnectionQuality.cs b/Assets/Mirror/Core/ConnectionQuality.cs new file mode 100644 index 0000000..25bd793 --- /dev/null +++ b/Assets/Mirror/Core/ConnectionQuality.cs @@ -0,0 +1,68 @@ +// standalone, Unity-independent connection-quality algorithm & enum. +// don't need to use this directly, it's built into Mirror's NetworkClient. +using UnityEngine; + +namespace Mirror +{ + public enum ConnectionQuality : byte + { + EXCELLENT, // ideal experience for high level competitors + GOOD, // very playable for everyone but high level competitors + FAIR, // very noticeable latency, not very enjoyable anymore + POOR, // unplayable + ESTIMATING, // still estimating + } + + // provide different heuristics for users to choose from. + // simple heuristics to get started. + // this will be iterated on over time based on user feedback. + public static class ConnectionQualityHeuristics + { + // convenience extension to color code Connection Quality + public static Color ColorCode(this ConnectionQuality quality) + { + switch (quality) + { + case ConnectionQuality.EXCELLENT: return Color.green; + case ConnectionQuality.GOOD: return Color.yellow; + case ConnectionQuality.FAIR: return new Color(1.0f, 0.647f, 0.0f); + case ConnectionQuality.POOR: return Color.red; + default: return Color.gray; + } + } + + // straight forward estimation + // rtt: average round trip time in seconds. + // jitter: average latency variance. + public static ConnectionQuality Simple(double rtt, double jitter) + { + if (rtt <= 0.100 && jitter <= 0.10) return ConnectionQuality.EXCELLENT; + if (rtt <= 0.200 && jitter <= 0.20) return ConnectionQuality.GOOD; + if (rtt <= 0.400 && jitter <= 0.50) return ConnectionQuality.FAIR; + return ConnectionQuality.POOR; + } + + // snapshot interpolation based estimation. + // snap. interp. adjusts buffer time based on connection quality. + // based on this, we can measure how far away we are from the ideal. + // the returned quality will always directly correlate with gameplay. + // => requires SnapshotInterpolation dynamicAdjustment to be enabled! + public static ConnectionQuality Pragmatic(double targetBufferTime, double currentBufferTime) + { + // buffer time is set by the game developer. + // estimating in multiples is a great way to be game independent. + // for example, a fast paced shooter and a slow paced RTS will both + // have poor connection if the multiplier is >10. + double multiplier = currentBufferTime / targetBufferTime; + + // empirically measured with Tanks demo + LatencySimulation. + // it's not obvious to estimate on paper. + if (multiplier <= 1.15) return ConnectionQuality.EXCELLENT; + if (multiplier <= 1.25) return ConnectionQuality.GOOD; + if (multiplier <= 1.50) return ConnectionQuality.FAIR; + + // anything else is poor + return ConnectionQuality.POOR; + } + } +} diff --git a/Assets/Mirror/Core/ConnectionQuality.cs.meta b/Assets/Mirror/Core/ConnectionQuality.cs.meta new file mode 100644 index 0000000..1712ffe --- /dev/null +++ b/Assets/Mirror/Core/ConnectionQuality.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ff663b880e33e4606b545c8b497041c2 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty.meta b/Assets/Mirror/Core/Empty.meta new file mode 100644 index 0000000..e702402 --- /dev/null +++ b/Assets/Mirror/Core/Empty.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: a99666a026b14cf6ba1a2b65946b1b27 +timeCreated: 1615288671 \ No newline at end of file diff --git a/Assets/Mirror/Core/Empty/ClientScene.cs b/Assets/Mirror/Core/Empty/ClientScene.cs new file mode 100644 index 0000000..0d1b96e --- /dev/null +++ b/Assets/Mirror/Core/Empty/ClientScene.cs @@ -0,0 +1 @@ +// moved into NetworkClient on 2021-03-07 diff --git a/Assets/Mirror/Core/Empty/ClientScene.cs.meta b/Assets/Mirror/Core/Empty/ClientScene.cs.meta new file mode 100644 index 0000000..82b617e --- /dev/null +++ b/Assets/Mirror/Core/Empty/ClientScene.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 96fc7967f813e4960b9119d7c2118494 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud.meta b/Assets/Mirror/Core/Empty/Cloud.meta new file mode 100644 index 0000000..e2c44de --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 73a9bb2dacafa8141bce8feef34e33a7 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ApiConnector.cs b/Assets/Mirror/Core/Empty/Cloud/ApiConnector.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ApiConnector.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ApiConnector.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ApiConnector.cs.meta new file mode 100644 index 0000000..9279c0c --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ApiConnector.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8bdb99a29e179d14cb0acc43f175d9ad +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ApiUpdater.cs b/Assets/Mirror/Core/Empty/Cloud/ApiUpdater.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ApiUpdater.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ApiUpdater.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ApiUpdater.cs.meta new file mode 100644 index 0000000..98a4c11 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ApiUpdater.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1f6e5d5acb5879f45a2235ae0f44dc92 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/Ball.cs b/Assets/Mirror/Core/Empty/Cloud/Ball.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Ball.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/Ball.cs.meta b/Assets/Mirror/Core/Empty/Cloud/Ball.cs.meta new file mode 100644 index 0000000..a6fc272 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Ball.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b4e9cc0829b13e54594a80883836bda7 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/BallManager.cs b/Assets/Mirror/Core/Empty/Cloud/BallManager.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/BallManager.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/BallManager.cs.meta b/Assets/Mirror/Core/Empty/Cloud/BallManager.cs.meta new file mode 100644 index 0000000..b914a33 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/BallManager.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 9cc796972dc396a42ba3686bd952e329 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/BaseApi.cs b/Assets/Mirror/Core/Empty/Cloud/BaseApi.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/BaseApi.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/BaseApi.cs.meta b/Assets/Mirror/Core/Empty/Cloud/BaseApi.cs.meta new file mode 100644 index 0000000..f66b84e --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/BaseApi.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 70f563b7a7210ae43bbcde5cb7721a94 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/Events.cs b/Assets/Mirror/Core/Empty/Cloud/Events.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Events.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/Events.cs.meta b/Assets/Mirror/Core/Empty/Cloud/Events.cs.meta new file mode 100644 index 0000000..150d85b --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Events.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c7c472a3ea1bc4348bd5a0b05bf7cc3b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/Extensions.cs b/Assets/Mirror/Core/Empty/Cloud/Extensions.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Extensions.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/Extensions.cs.meta b/Assets/Mirror/Core/Empty/Cloud/Extensions.cs.meta new file mode 100644 index 0000000..6bf6291 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Extensions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 97501e783fc67a4459b15d10e6c63563 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ICoroutineRunner.cs b/Assets/Mirror/Core/Empty/Cloud/ICoroutineRunner.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ICoroutineRunner.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ICoroutineRunner.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ICoroutineRunner.cs.meta new file mode 100644 index 0000000..f1149a9 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ICoroutineRunner.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 43472c60a7c72e54eafe559290dd0fc6 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/IRequestCreator.cs b/Assets/Mirror/Core/Empty/Cloud/IRequestCreator.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/IRequestCreator.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/IRequestCreator.cs.meta b/Assets/Mirror/Core/Empty/Cloud/IRequestCreator.cs.meta new file mode 100644 index 0000000..966c503 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/IRequestCreator.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b80b95532a9d6e8418aa676a261e4f69 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/IUnityEqualCheck.cs b/Assets/Mirror/Core/Empty/Cloud/IUnityEqualCheck.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/IUnityEqualCheck.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/IUnityEqualCheck.cs.meta b/Assets/Mirror/Core/Empty/Cloud/IUnityEqualCheck.cs.meta new file mode 100644 index 0000000..7cb2a59 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/IUnityEqualCheck.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 05185b973ba389a4588fc8a99c75a4f6 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/InstantiateNetworkManager.cs b/Assets/Mirror/Core/Empty/Cloud/InstantiateNetworkManager.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/InstantiateNetworkManager.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/InstantiateNetworkManager.cs.meta b/Assets/Mirror/Core/Empty/Cloud/InstantiateNetworkManager.cs.meta new file mode 100644 index 0000000..4b7219b --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/InstantiateNetworkManager.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: dbabb497385c20346a3c8bda4ae69508 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/JsonStructs.cs b/Assets/Mirror/Core/Empty/Cloud/JsonStructs.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/JsonStructs.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/JsonStructs.cs.meta b/Assets/Mirror/Core/Empty/Cloud/JsonStructs.cs.meta new file mode 100644 index 0000000..2c04009 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/JsonStructs.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 0688c0fdae5376e4ea74d5c3904eed17 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServer.cs b/Assets/Mirror/Core/Empty/Cloud/ListServer.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServer.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServer.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ListServer.cs.meta new file mode 100644 index 0000000..519876d --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6f0311899162c5b49a3c11fa9bd9c133 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServerBaseApi.cs b/Assets/Mirror/Core/Empty/Cloud/ListServerBaseApi.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServerBaseApi.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServerBaseApi.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ListServerBaseApi.cs.meta new file mode 100644 index 0000000..a9d32ea --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServerBaseApi.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b6838f9df45594d48873518cbb75b329 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServerClientApi.cs b/Assets/Mirror/Core/Empty/Cloud/ListServerClientApi.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServerClientApi.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServerClientApi.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ListServerClientApi.cs.meta new file mode 100644 index 0000000..306bf7c --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServerClientApi.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d49649fb32cb96b46b10f013b38a4b50 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServerJson.cs b/Assets/Mirror/Core/Empty/Cloud/ListServerJson.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServerJson.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServerJson.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ListServerJson.cs.meta new file mode 100644 index 0000000..7e206f1 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServerJson.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a963606335eae0f47abe7ecb5fd028ea +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServerServerApi.cs b/Assets/Mirror/Core/Empty/Cloud/ListServerServerApi.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServerServerApi.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ListServerServerApi.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ListServerServerApi.cs.meta new file mode 100644 index 0000000..82e23fd --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ListServerServerApi.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 675f0d0fd4e82b04290c4d30c8d78ede +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/Logger.cs b/Assets/Mirror/Core/Empty/Cloud/Logger.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Logger.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/Logger.cs.meta b/Assets/Mirror/Core/Empty/Cloud/Logger.cs.meta new file mode 100644 index 0000000..5984ce3 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Logger.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 457ba2df6cb6e1542996c17c715ee81b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServer.cs b/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServer.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServer.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServer.cs.meta b/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServer.cs.meta new file mode 100644 index 0000000..86775df --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 95bebb8e810e2954485291a26324f7d5 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServerPong.cs b/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServerPong.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServerPong.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServerPong.cs.meta b/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServerPong.cs.meta new file mode 100644 index 0000000..5c4294f --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/NetworkManagerListServerPong.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 068feff770f710141afa4a90063a5e6c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/Player.cs b/Assets/Mirror/Core/Empty/Cloud/Player.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Player.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/Player.cs.meta b/Assets/Mirror/Core/Empty/Cloud/Player.cs.meta new file mode 100644 index 0000000..1c85828 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/Player.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2b6cfd54b79bb464dbc6ae7f331ed45f +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/QuickListServerDebug.cs b/Assets/Mirror/Core/Empty/Cloud/QuickListServerDebug.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/QuickListServerDebug.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/QuickListServerDebug.cs.meta b/Assets/Mirror/Core/Empty/Cloud/QuickListServerDebug.cs.meta new file mode 100644 index 0000000..4a22565 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/QuickListServerDebug.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 07d1ea5260bc06e4d831c4b61d494bff +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/QuitButtonHUD.cs b/Assets/Mirror/Core/Empty/Cloud/QuitButtonHUD.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/QuitButtonHUD.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/QuitButtonHUD.cs.meta b/Assets/Mirror/Core/Empty/Cloud/QuitButtonHUD.cs.meta new file mode 100644 index 0000000..67341ea --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/QuitButtonHUD.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 76dab753e7255254687cd57985d8d675 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/RequestCreator.cs b/Assets/Mirror/Core/Empty/Cloud/RequestCreator.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/RequestCreator.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/RequestCreator.cs.meta b/Assets/Mirror/Core/Empty/Cloud/RequestCreator.cs.meta new file mode 100644 index 0000000..eb139af --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/RequestCreator.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: cfaa626443cc7c94eae138a2e3a04d7c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ServerListManager.cs b/Assets/Mirror/Core/Empty/Cloud/ServerListManager.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ServerListManager.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ServerListManager.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ServerListManager.cs.meta new file mode 100644 index 0000000..74c6a0f --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ServerListManager.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: bfc354d4a7f63ca45a653bf5d479afa0 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ServerListUI.cs b/Assets/Mirror/Core/Empty/Cloud/ServerListUI.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ServerListUI.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ServerListUI.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ServerListUI.cs.meta new file mode 100644 index 0000000..f7fe4f2 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ServerListUI.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ed11184fcffcdc04c9850d82c8014926 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Cloud/ServerListUIItem.cs b/Assets/Mirror/Core/Empty/Cloud/ServerListUIItem.cs new file mode 100644 index 0000000..2f11787 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ServerListUIItem.cs @@ -0,0 +1 @@ +// removed 2021-05-13 diff --git a/Assets/Mirror/Core/Empty/Cloud/ServerListUIItem.cs.meta b/Assets/Mirror/Core/Empty/Cloud/ServerListUIItem.cs.meta new file mode 100644 index 0000000..d8857e8 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Cloud/ServerListUIItem.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c67eda1b451338a428df87fda1e3a7c9 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/DotNetCompatibility.cs b/Assets/Mirror/Core/Empty/DotNetCompatibility.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Core/Empty/DotNetCompatibility.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Core/Empty/DotNetCompatibility.cs.meta b/Assets/Mirror/Core/Empty/DotNetCompatibility.cs.meta new file mode 100644 index 0000000..8742197 --- /dev/null +++ b/Assets/Mirror/Core/Empty/DotNetCompatibility.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b307f850ccbbe450295acf24d70e5c28 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/FallbackTransport.cs b/Assets/Mirror/Core/Empty/FallbackTransport.cs new file mode 100644 index 0000000..57f3344 --- /dev/null +++ b/Assets/Mirror/Core/Empty/FallbackTransport.cs @@ -0,0 +1 @@ +// removed 2021-05-13 \ No newline at end of file diff --git a/Assets/Mirror/Core/Empty/FallbackTransport.cs.meta b/Assets/Mirror/Core/Empty/FallbackTransport.cs.meta new file mode 100644 index 0000000..509a58f --- /dev/null +++ b/Assets/Mirror/Core/Empty/FallbackTransport.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 330c9aab13d2d42069c6ebbe582b73ca +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/LogFactory.cs b/Assets/Mirror/Core/Empty/LogFactory.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Core/Empty/LogFactory.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Core/Empty/LogFactory.cs.meta b/Assets/Mirror/Core/Empty/LogFactory.cs.meta new file mode 100644 index 0000000..0715501 --- /dev/null +++ b/Assets/Mirror/Core/Empty/LogFactory.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 353c7c9e14e82f349b1679112050b196 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/LogFilter.cs b/Assets/Mirror/Core/Empty/LogFilter.cs new file mode 100644 index 0000000..391c5bd --- /dev/null +++ b/Assets/Mirror/Core/Empty/LogFilter.cs @@ -0,0 +1 @@ +// removed 2021-03-08 diff --git a/Assets/Mirror/Core/Empty/LogFilter.cs.meta b/Assets/Mirror/Core/Empty/LogFilter.cs.meta new file mode 100644 index 0000000..aab4fa0 --- /dev/null +++ b/Assets/Mirror/Core/Empty/LogFilter.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f6928b080072948f7b2909b4025fcc79 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Logging.meta b/Assets/Mirror/Core/Empty/Logging.meta new file mode 100644 index 0000000..867da74 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 63d647500ca1bfa4a845bc1f4cff9dcc +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Logging/ConsoleColorLogHandler.cs b/Assets/Mirror/Core/Empty/Logging/ConsoleColorLogHandler.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/ConsoleColorLogHandler.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Core/Empty/Logging/ConsoleColorLogHandler.cs.meta b/Assets/Mirror/Core/Empty/Logging/ConsoleColorLogHandler.cs.meta new file mode 100644 index 0000000..329c6eb --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/ConsoleColorLogHandler.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2a9618569c20a504aa86feb5913c70e9 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Logging/EditorLogSettingsLoader.cs b/Assets/Mirror/Core/Empty/Logging/EditorLogSettingsLoader.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/EditorLogSettingsLoader.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Core/Empty/Logging/EditorLogSettingsLoader.cs.meta b/Assets/Mirror/Core/Empty/Logging/EditorLogSettingsLoader.cs.meta new file mode 100644 index 0000000..81b33e9 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/EditorLogSettingsLoader.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a39aa1e48aa54eb4e964f0191c1dcdce +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Logging/LogFactory.cs b/Assets/Mirror/Core/Empty/Logging/LogFactory.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/LogFactory.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Core/Empty/Logging/LogFactory.cs.meta b/Assets/Mirror/Core/Empty/Logging/LogFactory.cs.meta new file mode 100644 index 0000000..acf3b63 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/LogFactory.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d06522432d5a44e1587967a4731cd279 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Logging/LogSettings.cs b/Assets/Mirror/Core/Empty/Logging/LogSettings.cs new file mode 100644 index 0000000..264a1cd --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/LogSettings.cs @@ -0,0 +1,2 @@ +// removed 2021-02-16 + diff --git a/Assets/Mirror/Core/Empty/Logging/LogSettings.cs.meta b/Assets/Mirror/Core/Empty/Logging/LogSettings.cs.meta new file mode 100644 index 0000000..90c4e4d --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/LogSettings.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 633889a39717fde4fa28dd6b948dfac7 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Logging/NetworkHeadlessLogger.cs b/Assets/Mirror/Core/Empty/Logging/NetworkHeadlessLogger.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/NetworkHeadlessLogger.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Core/Empty/Logging/NetworkHeadlessLogger.cs.meta b/Assets/Mirror/Core/Empty/Logging/NetworkHeadlessLogger.cs.meta new file mode 100644 index 0000000..221a61b --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/NetworkHeadlessLogger.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c7627623f2b9fad4484082517cd73e67 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/Logging/NetworkLogSettings.cs b/Assets/Mirror/Core/Empty/Logging/NetworkLogSettings.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/NetworkLogSettings.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Core/Empty/Logging/NetworkLogSettings.cs.meta b/Assets/Mirror/Core/Empty/Logging/NetworkLogSettings.cs.meta new file mode 100644 index 0000000..2f7ecdf --- /dev/null +++ b/Assets/Mirror/Core/Empty/Logging/NetworkLogSettings.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ac6e8eccf4b6f4dc7b24c276ef47fde8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/NetworkMatchChecker.cs b/Assets/Mirror/Core/Empty/NetworkMatchChecker.cs new file mode 100644 index 0000000..3797620 --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkMatchChecker.cs @@ -0,0 +1 @@ +// removed 2022-01-06 diff --git a/Assets/Mirror/Core/Empty/NetworkMatchChecker.cs.meta b/Assets/Mirror/Core/Empty/NetworkMatchChecker.cs.meta new file mode 100644 index 0000000..7c7d6cf --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkMatchChecker.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1020a74962faada4b807ac5dc053a4cf +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/NetworkOwnerChecker.cs b/Assets/Mirror/Core/Empty/NetworkOwnerChecker.cs new file mode 100644 index 0000000..712833c --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkOwnerChecker.cs @@ -0,0 +1 @@ +// removed 2022-01-06 diff --git a/Assets/Mirror/Core/Empty/NetworkOwnerChecker.cs.meta b/Assets/Mirror/Core/Empty/NetworkOwnerChecker.cs.meta new file mode 100644 index 0000000..fee7725 --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkOwnerChecker.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 25fd0c51bbe07c140bc30978b91e9182 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/NetworkProximityChecker.cs b/Assets/Mirror/Core/Empty/NetworkProximityChecker.cs new file mode 100644 index 0000000..3797620 --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkProximityChecker.cs @@ -0,0 +1 @@ +// removed 2022-01-06 diff --git a/Assets/Mirror/Core/Empty/NetworkProximityChecker.cs.meta b/Assets/Mirror/Core/Empty/NetworkProximityChecker.cs.meta new file mode 100644 index 0000000..c5aa112 --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkProximityChecker.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1731d8de2d0c84333b08ebe1e79f4118 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/NetworkSceneChecker.cs b/Assets/Mirror/Core/Empty/NetworkSceneChecker.cs new file mode 100644 index 0000000..3797620 --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkSceneChecker.cs @@ -0,0 +1 @@ +// removed 2022-01-06 diff --git a/Assets/Mirror/Core/Empty/NetworkSceneChecker.cs.meta b/Assets/Mirror/Core/Empty/NetworkSceneChecker.cs.meta new file mode 100644 index 0000000..b451655 --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkSceneChecker.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b7fdb599e1359924bad6255660370252 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/NetworkTransformBase.cs b/Assets/Mirror/Core/Empty/NetworkTransformBase.cs new file mode 100644 index 0000000..79e858f --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkTransformBase.cs @@ -0,0 +1 @@ +// removed 2022-10-24 diff --git a/Assets/Mirror/Core/Empty/NetworkTransformBase.cs.meta b/Assets/Mirror/Core/Empty/NetworkTransformBase.cs.meta new file mode 100644 index 0000000..ab649d9 --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkTransformBase.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2e77294d8ccbc4e7cb8ca2bd0d3e99ea +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/NetworkVisibility.cs b/Assets/Mirror/Core/Empty/NetworkVisibility.cs new file mode 100644 index 0000000..3797620 --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkVisibility.cs @@ -0,0 +1 @@ +// removed 2022-01-06 diff --git a/Assets/Mirror/Core/Empty/NetworkVisibility.cs.meta b/Assets/Mirror/Core/Empty/NetworkVisibility.cs.meta new file mode 100644 index 0000000..f71b7be --- /dev/null +++ b/Assets/Mirror/Core/Empty/NetworkVisibility.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c08f1a030234d49d391d7223a8592f15 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/StringHash.cs b/Assets/Mirror/Core/Empty/StringHash.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Core/Empty/StringHash.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Core/Empty/StringHash.cs.meta b/Assets/Mirror/Core/Empty/StringHash.cs.meta new file mode 100644 index 0000000..6198581 --- /dev/null +++ b/Assets/Mirror/Core/Empty/StringHash.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 733f020f9b76d453da841089579fd7a7 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/SyncVar.cs b/Assets/Mirror/Core/Empty/SyncVar.cs new file mode 100644 index 0000000..aaa3b9d --- /dev/null +++ b/Assets/Mirror/Core/Empty/SyncVar.cs @@ -0,0 +1 @@ +// removed 2022-11-03 diff --git a/Assets/Mirror/Core/Empty/SyncVar.cs.meta b/Assets/Mirror/Core/Empty/SyncVar.cs.meta new file mode 100644 index 0000000..fffb472 --- /dev/null +++ b/Assets/Mirror/Core/Empty/SyncVar.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 5e87cb681af8459fbbb1f467e1c7632c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/SyncVarGameObject.cs b/Assets/Mirror/Core/Empty/SyncVarGameObject.cs new file mode 100644 index 0000000..aaa3b9d --- /dev/null +++ b/Assets/Mirror/Core/Empty/SyncVarGameObject.cs @@ -0,0 +1 @@ +// removed 2022-11-03 diff --git a/Assets/Mirror/Core/Empty/SyncVarGameObject.cs.meta b/Assets/Mirror/Core/Empty/SyncVarGameObject.cs.meta new file mode 100644 index 0000000..4e924f0 --- /dev/null +++ b/Assets/Mirror/Core/Empty/SyncVarGameObject.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 84da90dae05442e3a149753c9b25ae98 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/SyncVarNetworkBehaviour.cs b/Assets/Mirror/Core/Empty/SyncVarNetworkBehaviour.cs new file mode 100644 index 0000000..aaa3b9d --- /dev/null +++ b/Assets/Mirror/Core/Empty/SyncVarNetworkBehaviour.cs @@ -0,0 +1 @@ +// removed 2022-11-03 diff --git a/Assets/Mirror/Core/Empty/SyncVarNetworkBehaviour.cs.meta b/Assets/Mirror/Core/Empty/SyncVarNetworkBehaviour.cs.meta new file mode 100644 index 0000000..0ceab50 --- /dev/null +++ b/Assets/Mirror/Core/Empty/SyncVarNetworkBehaviour.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c0fff77f1a624ba8ad6e4bdef6c14a8b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Empty/SyncVarNetworkIdentity.cs b/Assets/Mirror/Core/Empty/SyncVarNetworkIdentity.cs new file mode 100644 index 0000000..aaa3b9d --- /dev/null +++ b/Assets/Mirror/Core/Empty/SyncVarNetworkIdentity.cs @@ -0,0 +1 @@ +// removed 2022-11-03 diff --git a/Assets/Mirror/Core/Empty/SyncVarNetworkIdentity.cs.meta b/Assets/Mirror/Core/Empty/SyncVarNetworkIdentity.cs.meta new file mode 100644 index 0000000..53271d4 --- /dev/null +++ b/Assets/Mirror/Core/Empty/SyncVarNetworkIdentity.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1f9a6d4d2741477999ad9588261870fe +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/HostMode.cs b/Assets/Mirror/Core/HostMode.cs new file mode 100644 index 0000000..e5bb2c0 --- /dev/null +++ b/Assets/Mirror/Core/HostMode.cs @@ -0,0 +1,48 @@ +// host mode related helper functions. +// usually they set up both server & client. +// it's cleaner to keep them in one place, instead of only in server / client. +using System; + +namespace Mirror +{ + public static class HostMode + { + // keep the local connections setup in one function. + // makes host setup easier to follow. + internal static void SetupConnections() + { + // create local connections pair, both are connected + Utils.CreateLocalConnections( + out LocalConnectionToClient connectionToClient, + out LocalConnectionToServer connectionToServer); + + // set client connection + NetworkClient.connection = connectionToServer; + + // set server connection + NetworkServer.SetLocalConnection(connectionToClient); + } + + // call OnConnected on server & client. + // public because NetworkClient.ConnectLocalServer was public before too. + public static void InvokeOnConnected() + { + // call server OnConnected with server's connection to client + NetworkServer.OnConnected(NetworkServer.localConnection); + + // call client OnConnected with client's connection to server + // => previously we used to send a ConnectMessage to + // NetworkServer.localConnection. this would queue the message + // until NetworkClient.Update processes it. + // => invoking the client's OnConnected event directly here makes + // tests fail. so let's do it exactly the same order as before by + // queueing the event for next Update! + //OnConnectedEvent?.Invoke(connection); + ((LocalConnectionToServer)NetworkClient.connection).QueueConnectedEvent(); + } + + // DEPRECATED 2023-01-28 + [Obsolete("ActivateHostScene did nothing, since identities all had .isClient set in NetworkServer.SpawnObjects.")] + public static void ActivateHostScene() {} + } +} diff --git a/Assets/Mirror/Core/HostMode.cs.meta b/Assets/Mirror/Core/HostMode.cs.meta new file mode 100644 index 0000000..bf6faed --- /dev/null +++ b/Assets/Mirror/Core/HostMode.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d27175a08d5341fc97645b49ee533d5a +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/InterestManagement.cs b/Assets/Mirror/Core/InterestManagement.cs new file mode 100644 index 0000000..3516339 --- /dev/null +++ b/Assets/Mirror/Core/InterestManagement.cs @@ -0,0 +1,146 @@ +// interest management component for custom solutions like +// distance based, spatial hashing, raycast based, etc. + +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + [DisallowMultipleComponent] + [HelpURL("https://mirror-networking.gitbook.io/docs/guides/interest-management")] + public abstract class InterestManagement : InterestManagementBase + { + // allocate newObservers helper HashSet + readonly HashSet newObservers = + new HashSet(); + + // rebuild observers for the given NetworkIdentity. + // Server will automatically spawn/despawn added/removed ones. + // newObservers: cached hashset to put the result into + // initialize: true if being rebuilt for the first time + // + // IMPORTANT: + // => global rebuild would be more simple, BUT + // => local rebuild is way faster for spawn/despawn because we can + // simply rebuild a select NetworkIdentity only + // => having both .observers and .observing is necessary for local + // rebuilds + // + // in other words, this is the perfect solution even though it's not + // completely simple (due to .observers & .observing). + // + // Mirror maintains .observing automatically in the background. best of + // both worlds without any worrying now! + public abstract void OnRebuildObservers(NetworkIdentity identity, HashSet newObservers); + + // helper function to trigger a full rebuild. + // most implementations should call this in a certain interval. + // some might call this all the time, or only on team changes or + // scene changes and so on. + // + // IMPORTANT: check if NetworkServer.active when using Update()! + [ServerCallback] + protected void RebuildAll() + { + foreach (NetworkIdentity identity in NetworkServer.spawned.Values) + { + NetworkServer.RebuildObservers(identity, false); + } + } + + public override void Rebuild(NetworkIdentity identity, bool initialize) + { + // clear newObservers hashset before using it + newObservers.Clear(); + + // not force hidden? + if (identity.visible != Visibility.ForceHidden) + { + OnRebuildObservers(identity, newObservers); + } + + // IMPORTANT: AFTER rebuilding add own player connection in any case + // to ensure player always sees himself no matter what. + // -> OnRebuildObservers might clear observers, so we need to add + // the player's own connection AFTER. 100% fail safe. + // -> fixes https://github.com/vis2k/Mirror/issues/692 where a + // player might teleport out of the ProximityChecker's cast, + // losing the own connection as observer. + if (identity.connectionToClient != null) + { + newObservers.Add(identity.connectionToClient); + } + + bool changed = false; + + // add all newObservers that aren't in .observers yet + foreach (NetworkConnectionToClient conn in newObservers) + { + // only add ready connections. + // otherwise the player might not be in the world yet or anymore + if (conn != null && conn.isReady) + { + if (initialize || !identity.observers.ContainsKey(conn.connectionId)) + { + // new observer + conn.AddToObserving(identity); + // Debug.Log($"New Observer for {gameObject} {conn}"); + changed = true; + } + } + } + + // remove all old .observers that aren't in newObservers anymore + foreach (NetworkConnectionToClient conn in identity.observers.Values) + { + if (!newObservers.Contains(conn)) + { + // removed observer + conn.RemoveFromObserving(identity, false); + // Debug.Log($"Removed Observer for {gameObject} {conn}"); + changed = true; + } + } + + // copy new observers to observers + if (changed) + { + identity.observers.Clear(); + foreach (NetworkConnectionToClient conn in newObservers) + { + if (conn != null && conn.isReady) + identity.observers.Add(conn.connectionId, conn); + } + } + + // special case for host mode: we use SetHostVisibility to hide + // NetworkIdentities that aren't in observer range from host. + // this is what games like Dota/Counter-Strike do too, where a host + // does NOT see all players by default. they are in memory, but + // hidden to the host player. + // + // this code is from UNET, it's a bit strange but it works: + // * it hides newly connected identities in host mode + // => that part was the intended behaviour + // * it hides ALL NetworkIdentities in host mode when the host + // connects but hasn't selected a character yet + // => this only works because we have no .localConnection != null + // check. at this stage, localConnection is null because + // StartHost starts the server first, then calls this code, + // then starts the client and sets .localConnection. so we can + // NOT add a null check without breaking host visibility here. + // * it hides ALL NetworkIdentities in server-only mode because + // observers never contain the 'null' .localConnection + // => that was not intended, but let's keep it as it is so we + // don't break anything in host mode. it's way easier than + // iterating all identities in a special function in StartHost. + if (initialize) + { + if (!newObservers.Contains(NetworkServer.localConnection)) + { + SetHostVisibility(identity, false); + } + } + } + } +} diff --git a/Assets/Mirror/Core/InterestManagement.cs.meta b/Assets/Mirror/Core/InterestManagement.cs.meta new file mode 100644 index 0000000..bfabf6b --- /dev/null +++ b/Assets/Mirror/Core/InterestManagement.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 41d809934003479f97e992eebb7ed6af +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/InterestManagementBase.cs b/Assets/Mirror/Core/InterestManagementBase.cs new file mode 100644 index 0000000..aef7a65 --- /dev/null +++ b/Assets/Mirror/Core/InterestManagementBase.cs @@ -0,0 +1,84 @@ +// interest management component for custom solutions like +// distance based, spatial hashing, raycast based, etc. +// low level base class allows for low level spatial hashing etc., which is 3-5x faster. +using UnityEngine; + +namespace Mirror +{ + [DisallowMultipleComponent] + [HelpURL("https://mirror-networking.gitbook.io/docs/guides/interest-management")] + public abstract class InterestManagementBase : MonoBehaviour + { + // Configures InterestManagementBase in NetworkServer/Client + // Do NOT check for active server or client here. + // OnEnable must always set the static aoi references. + // make sure to call base.OnEnable when overwriting! + // Previously used Awake() + protected virtual void OnEnable() + { + if (NetworkServer.aoi == null) + { + NetworkServer.aoi = this; + } + else Debug.LogError($"Only one InterestManagement component allowed. {NetworkServer.aoi.GetType()} has been set up already."); + + if (NetworkClient.aoi == null) + { + NetworkClient.aoi = this; + } + else Debug.LogError($"Only one InterestManagement component allowed. {NetworkClient.aoi.GetType()} has been set up already."); + } + + [ServerCallback] + public virtual void Reset() {} + + // Callback used by the visibility system to determine if an observer + // (player) can see the NetworkIdentity. If this function returns true, + // the network connection will be added as an observer. + // conn: Network connection of a player. + // returns True if the player can see this object. + public abstract bool OnCheckObserver(NetworkIdentity identity, NetworkConnectionToClient newObserver); + + + // Callback used by the visibility system for objects on a host. + // Objects on a host (with a local client) cannot be disabled or + // destroyed when they are not visible to the local client. So this + // function is called to allow custom code to hide these objects. A + // typical implementation will disable renderer components on the + // object. This is only called on local clients on a host. + // => need the function in here and virtual so people can overwrite! + // => not everyone wants to hide renderers! + [ServerCallback] + public virtual void SetHostVisibility(NetworkIdentity identity, bool visible) + { + foreach (Renderer rend in identity.GetComponentsInChildren()) + rend.enabled = visible; + } + + /// Called on the server when a new networked object is spawned. + // (useful for 'only rebuild if changed' interest management algorithms) + [ServerCallback] + public virtual void OnSpawned(NetworkIdentity identity) {} + + /// Called on the server when a networked object is destroyed. + // (useful for 'only rebuild if changed' interest management algorithms) + [ServerCallback] + public virtual void OnDestroyed(NetworkIdentity identity) {} + + public abstract void Rebuild(NetworkIdentity identity, bool initialize); + + /// Adds the specified connection to the observers of identity + protected void AddObserver(NetworkConnectionToClient connection, NetworkIdentity identity) + { + connection.AddToObserving(identity); + identity.observers.Add(connection.connectionId, connection); + } + + /// Removes the specified connection from the observers of identity + protected void RemoveObserver(NetworkConnectionToClient connection, NetworkIdentity identity) + { + connection.RemoveFromObserving(identity, false); + identity.observers.Remove(connection.connectionId); + } + } +} diff --git a/Assets/Mirror/Core/InterestManagementBase.cs.meta b/Assets/Mirror/Core/InterestManagementBase.cs.meta new file mode 100644 index 0000000..b2b5ad6 --- /dev/null +++ b/Assets/Mirror/Core/InterestManagementBase.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 18bd2ffe65a444f3b13d59bdac7f2228 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/LagCompensation.meta b/Assets/Mirror/Core/LagCompensation.meta new file mode 100644 index 0000000..b5583ef --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: d2656015ded44e83a24f4c4776bafd40 +timeCreated: 1687920405 \ No newline at end of file diff --git a/Assets/Mirror/Core/LagCompensation/Capture.cs b/Assets/Mirror/Core/LagCompensation/Capture.cs new file mode 100644 index 0000000..e4fdabe --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/Capture.cs @@ -0,0 +1,13 @@ +namespace Mirror +{ + public interface Capture + { + // server timestamp at time of capture. + double timestamp { get; set; } + + // optional gizmo drawing for visual debugging. + // history is only known on the server, which usually doesn't render. + // showing Gizmos in the Editor is enough. + void DrawGizmo(); + } +} diff --git a/Assets/Mirror/Core/LagCompensation/Capture.cs.meta b/Assets/Mirror/Core/LagCompensation/Capture.cs.meta new file mode 100644 index 0000000..2d5a41d --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/Capture.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 347e831952e943a49095cadd39a5aeb2 +timeCreated: 1687921461 \ No newline at end of file diff --git a/Assets/Mirror/Core/LagCompensation/HistoryBounds.cs b/Assets/Mirror/Core/LagCompensation/HistoryBounds.cs new file mode 100644 index 0000000..29ebc2e --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/HistoryBounds.cs @@ -0,0 +1,139 @@ +// HistoryBounds keeps a bounding box of all the object's bounds in the past N seconds. +// useful to decide which objects to rollback, instead of rolling back all of them. +// https://www.youtube.com/watch?v=zrIY0eIyqmI (37:00) +// standalone C# implementation to be engine (and language) agnostic. + +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + // FakeByte: gather bounds in smaller buckets. + // for example, bucket(t0,t1,t2), bucket(t3,t4,t5), ... + // instead of removing old bounds t0, t1, ... + // we remove a whole bucket every 3 times: bucket(t0,t1,t2) + // and when building total bounds, we encapsulate a few larger buckets + // instead of many smaller bounds. + // + // => a bucket is encapsulate(bounds0, bounds1, bounds2) so we don't + // need a custom struct, simply reuse bounds but remember that each + // entry includes N timestamps. + // + // => note that simply reducing capture interval is _not_ the same. + // we want to capture in detail in case players run in zig-zag. + // but still grow larger buckets internally. + public class HistoryBounds + { + // mischa: use MinMaxBounds to avoid Unity Bounds.Encapsulate conversions. + readonly int boundsPerBucket; + readonly Queue fullBuckets; + + // full bucket limit. older ones will be removed. + readonly int bucketLimit; + + // bucket in progress, contains 0..boundsPerBucket bounds encapsulated. + MinMaxBounds? currentBucket; + int currentBucketSize; + + // amount of total bounds, including bounds in full buckets + current + public int boundsCount { get; private set; } + + // total bounds encapsulating all of the bounds history. + // totalMinMax is used for internal calculations. + // public total is used for Unity representation. + MinMaxBounds totalMinMax; + public Bounds total + { + get + { + Bounds bounds = new Bounds(); + bounds.SetMinMax(totalMinMax.min, totalMinMax.max); + return bounds; + } + } + + public HistoryBounds(int boundsLimit, int boundsPerBucket) + { + // bucketLimit via '/' cuts off remainder. + // that's what we want, since we always have a 'currentBucket'. + this.boundsPerBucket = boundsPerBucket; + this.bucketLimit = (boundsLimit / boundsPerBucket); + + // initialize queue with maximum capacity to avoid runtime resizing + // capacity +1 because it makes the code easier if we insert first, and then remove. + fullBuckets = new Queue(bucketLimit + 1); + } + + // insert new bounds into history. calculates new total bounds. + // Queue.Dequeue() always has the oldest bounds. + public void Insert(Bounds bounds) + { + // convert to MinMax representation for faster .Encapsulate() + MinMaxBounds minmax = new MinMaxBounds + { + min = bounds.min, + max = bounds.max + }; + + // initialize 'total' if not initialized yet. + // we don't want to call (0,0).Encapsulate(bounds). + if (boundsCount == 0) + { + totalMinMax = minmax; + } + + // add to current bucket: + // either initialize new one, or encapsulate into existing one + if (currentBucket == null) + { + currentBucket = minmax; + } + else + { + currentBucket.Value.Encapsulate(minmax); + } + + // current bucket has one more bounds. + // total bounds increased as well. + currentBucketSize += 1; + boundsCount += 1; + + // always encapsulate into total immediately. + // this is free. + totalMinMax.Encapsulate(minmax); + + // current bucket full? + if (currentBucketSize == boundsPerBucket) + { + // move it to full buckets + fullBuckets.Enqueue(currentBucket.Value); + currentBucket = null; + currentBucketSize = 0; + + // full bucket capacity reached? + if (fullBuckets.Count > bucketLimit) + { + // remove oldest bucket + fullBuckets.Dequeue(); + boundsCount -= boundsPerBucket; + + // recompute total bounds + // instead of iterating N buckets, we iterate N / boundsPerBucket buckets. + // TODO technically we could reuse 'currentBucket' before clearing instead of encapsulating again + totalMinMax = minmax; + foreach (MinMaxBounds bucket in fullBuckets) + totalMinMax.Encapsulate(bucket); + } + } + } + + public void Reset() + { + fullBuckets.Clear(); + currentBucket = null; + currentBucketSize = 0; + boundsCount = 0; + totalMinMax = new MinMaxBounds(); + } + } +} diff --git a/Assets/Mirror/Core/LagCompensation/HistoryBounds.cs.meta b/Assets/Mirror/Core/LagCompensation/HistoryBounds.cs.meta new file mode 100644 index 0000000..373d8ea --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/HistoryBounds.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: ca9ea58b98a34f73801b162cd5de724e +timeCreated: 1690172331 \ No newline at end of file diff --git a/Assets/Mirror/Core/LagCompensation/LagCompensation.cs b/Assets/Mirror/Core/LagCompensation/LagCompensation.cs new file mode 100644 index 0000000..ae37a3f --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/LagCompensation.cs @@ -0,0 +1,144 @@ +// standalone lag compensation algorithm +// based on the Valve Networking Model: +// https://developer.valvesoftware.com/wiki/Source_Multiplayer_Networking +using System.Collections.Generic; + +namespace Mirror +{ + public static class LagCompensation + { + // history is of . + // Queue allows for fast 'remove first' and 'append last'. + // + // make sure to always insert in order. + // inserting out of order like [1,2,4,3] would cause issues. + // can't safeguard this because Queue doesn't have .Last access. + public static void Insert( + Queue> history, + int historyLimit, + double timestamp, + T capture) + where T : Capture + { + // make space according to history limit. + // do this before inserting, to avoid resizing past capacity. + if (history.Count >= historyLimit) + history.Dequeue(); + + // insert + history.Enqueue(new KeyValuePair(timestamp, capture)); + } + + // get the two snapshots closest to a given timestamp. + // those can be used to interpolate the exact snapshot at that time. + // if timestamp is newer than the newest history entry, then we extrapolate. + // 't' will be between 1 and 2, before is second last, after is last. + // callers should Lerp(before, after, t=1.5) to extrapolate the hit. + // see comments below for extrapolation. + public static bool Sample( + Queue> history, + double timestamp, // current server time + double interval, // capture interval + out T before, + out T after, + out double t) // interpolation factor + where T : Capture + { + before = default; + after = default; + t = 0; + + // can't sample an empty history + // interpolation needs at least one entry. + // extrapolation needs at least two entries. + // can't Lerp(A, A, 1.5). dist(A, A) * 1.5 is always 0. + if(history.Count < 2) { + return false; + } + + // older than oldest + if (timestamp < history.Peek().Key) { + return false; + } + + // iterate through the history + // TODO faster version: guess start index by how many 'intervals' we are behind. + // search around that area. + // should be O(1) most of the time, unless sampling was off. + KeyValuePair prev = new KeyValuePair(); + KeyValuePair prevPrev = new KeyValuePair(); + foreach(KeyValuePair entry in history) { + // exact match? + if (timestamp == entry.Key) { + before = entry.Value; + after = entry.Value; + t = Mathd.InverseLerp(before.timestamp, after.timestamp, timestamp); + return true; + } + + // did we check beyond timestamp? then return the previous two. + if (entry.Key > timestamp) { + before = prev.Value; + after = entry.Value; + t = Mathd.InverseLerp(before.timestamp, after.timestamp, timestamp); + return true; + } + + // remember the last two for extrapolation. + // Queue doesn't have access to .Last. + prevPrev = prev; + prev = entry; + } + + // newer than newest: extrapolate up to one interval. + // let's say we capture every 100 ms: + // 100, 200, 300, 400 + // and the server is at 499 + // if a client sends CmdFire at time 480, then there's no history entry. + // => adding the current entry every time would be too expensive. + // worst case we would capture at 401, 402, 403, 404, ... 100 times + // => not extrapolating isn't great. low latency clients would be + // punished by missing their targets since no entry at 'time' was found. + // => extrapolation is the best solution. make sure this works as + // expected and within limits. + if (prev.Key < timestamp && timestamp <= prev.Key + interval) { + // return the last two valid snapshots. + // can't just return (after, after) because we can't extrapolate + // if their distance is 0. + before = prevPrev.Value; + after = prev.Value; + + // InverseLerp will give [after, after+interval]. + // but we return [before, after, t]. + // so add +1 for the distance from before->after + t = 1 + Mathd.InverseLerp(after.timestamp, after.timestamp + interval, timestamp); + return true; + } + + return false; + } + + // never trust the client. + // we estimate when a message was sent. + // don't trust the client to tell us the time. + // https://developer.valvesoftware.com/wiki/Source_Multiplayer_Networking + // Command Execution Time = Current Server Time - Packet Latency - Client View Interpolation + // => lag compensation demo estimation is off by only ~6ms + public static double EstimateTime(double serverTime, double rtt, double bufferTime) + { + // packet latency is one trip from client to server, so rtt / 2 + // client view interpolation is the snapshot interpolation buffer time + double latency = rtt / 2; + return serverTime - latency - bufferTime; + } + + // convenience function to draw all history gizmos. + // this should be called from OnDrawGizmos. + public static void DrawGizmos(Queue> history) + where T : Capture + { + foreach (KeyValuePair entry in history) + entry.Value.DrawGizmo(); + } + } +} diff --git a/Assets/Mirror/Core/LagCompensation/LagCompensation.cs.meta b/Assets/Mirror/Core/LagCompensation/LagCompensation.cs.meta new file mode 100644 index 0000000..f85a6c3 --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/LagCompensation.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: ad53cc7d12144d0ba3a8b0a4515e5d17 +timeCreated: 1687921483 \ No newline at end of file diff --git a/Assets/Mirror/Core/LagCompensation/LagCompensationSettings.cs b/Assets/Mirror/Core/LagCompensation/LagCompensationSettings.cs new file mode 100644 index 0000000..a7ec944 --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/LagCompensationSettings.cs @@ -0,0 +1,19 @@ +// snapshot interpolation settings struct. +// can easily be exposed in Unity inspectors. +using System; +using UnityEngine; + +namespace Mirror +{ + // class so we can define defaults easily + [Serializable] + public class LagCompensationSettings + { + [Header("Buffering")] + [Tooltip("Keep this many past snapshots in the buffer. The larger this is, the further we can rewind into the past.\nMaximum rewind time := historyAmount * captureInterval")] + public int historyLimit = 6; + + [Tooltip("Capture state every 'captureInterval' seconds. Larger values will space out the captures more, which gives a longer history but with possible gaps inbetween.\nSmaller values will have fewer gaps, with shorter history.")] + public float captureInterval = 0.100f; // 100 ms + } +} diff --git a/Assets/Mirror/Core/LagCompensation/LagCompensationSettings.cs.meta b/Assets/Mirror/Core/LagCompensation/LagCompensationSettings.cs.meta new file mode 100644 index 0000000..c5b9c47 --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/LagCompensationSettings.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: fa80bec245f94bf8a28ec78777992a1c +timeCreated: 1687920412 \ No newline at end of file diff --git a/Assets/Mirror/Core/LagCompensation/MinMaxBounds.cs b/Assets/Mirror/Core/LagCompensation/MinMaxBounds.cs new file mode 100644 index 0000000..3cf6991 --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/MinMaxBounds.cs @@ -0,0 +1,61 @@ +// Unity's Bounds struct is represented as (center, extents). +// HistoryBounds make heavy use of .Encapsulate(), which has to convert +// Unity's (center, extents) to (min, max) every time, and then convert back. +// +// It's faster to use a (min, max) representation directly instead. +using System; +using System.Runtime.CompilerServices; +using UnityEngine; + +namespace Mirror +{ + public struct MinMaxBounds: IEquatable + { + public Vector3 min; + public Vector3 max; + + // encapsulate a single point + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void Encapsulate(Vector3 point) + { + min = Vector3.Min(this.min, point); + max = Vector3.Max(this.max, point); + } + + // encapsulate another bounds + public void Encapsulate(MinMaxBounds bounds) + { + Encapsulate(bounds.min); + Encapsulate(bounds.max); + } + + // convenience comparison with Unity's bounds, for unit tests etc. + public static bool operator ==(MinMaxBounds lhs, Bounds rhs) => + lhs.min == rhs.min && + lhs.max == rhs.max; + + public static bool operator !=(MinMaxBounds lhs, Bounds rhs) => + !(lhs == rhs); + + public override bool Equals(object obj) => + obj is MinMaxBounds other && + min == other.min && + max == other.max; + + public bool Equals(MinMaxBounds other) => + min.Equals(other.min) && max.Equals(other.max); + + public bool Equals(Bounds other) => + min.Equals(other.min) && max.Equals(other.max); + +#if UNITY_2021_3_OR_NEWER + // Unity 2019/2020 don't have HashCode.Combine yet. + // this is only to avoid reflection. without defining, it works too. + // default generated by rider + public override int GetHashCode() => HashCode.Combine(min, max); +#endif + + // tostring + public override string ToString() => $"({min}, {max})"; + } +} diff --git a/Assets/Mirror/Core/LagCompensation/MinMaxBounds.cs.meta b/Assets/Mirror/Core/LagCompensation/MinMaxBounds.cs.meta new file mode 100644 index 0000000..8b189f2 --- /dev/null +++ b/Assets/Mirror/Core/LagCompensation/MinMaxBounds.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 4372b1e1a1cc4c669cc7bf0925f59d29 +timeCreated: 1690367013 \ No newline at end of file diff --git a/Assets/Mirror/Core/LocalConnectionToClient.cs b/Assets/Mirror/Core/LocalConnectionToClient.cs new file mode 100644 index 0000000..5b62122 --- /dev/null +++ b/Assets/Mirror/Core/LocalConnectionToClient.cs @@ -0,0 +1,50 @@ +using System; + +namespace Mirror +{ + // a server's connection TO a LocalClient. + // sending messages on this connection causes the client's handler function to be invoked directly + public class LocalConnectionToClient : NetworkConnectionToClient + { + internal LocalConnectionToServer connectionToServer; + + public LocalConnectionToClient() : base(LocalConnectionId) {} + + public override string address => "localhost"; + + // Send stage two: serialized NetworkMessage as ArraySegment + internal override void Send(ArraySegment segment, int channelId = Channels.Reliable) + { + // get a writer to copy the message into since the segment is only + // valid until returning. + // => pooled writer will be returned to pool when dequeuing. + // => WriteBytes instead of WriteArraySegment because the latter + // includes a 4 bytes header. we just want to write raw. + //Debug.Log($"Enqueue {BitConverter.ToString(segment.Array, segment.Offset, segment.Count)}"); + NetworkWriterPooled writer = NetworkWriterPool.Get(); + writer.WriteBytes(segment.Array, segment.Offset, segment.Count); + connectionToServer.queue.Enqueue(writer); + } + + // true because local connections never timeout + internal override bool IsAlive(float timeout) => true; + + // don't ping host client in host mode + protected override void UpdatePing() {} + + internal void DisconnectInternal() + { + // set not ready and handle clientscene disconnect in any case + // (might be client or host mode here) + isReady = false; + RemoveFromObservingsObservers(); + } + + /// Disconnects this connection. + public override void Disconnect() + { + DisconnectInternal(); + connectionToServer.DisconnectInternal(); + } + } +} diff --git a/Assets/Mirror/Core/LocalConnectionToClient.cs.meta b/Assets/Mirror/Core/LocalConnectionToClient.cs.meta new file mode 100644 index 0000000..a4f2d2c --- /dev/null +++ b/Assets/Mirror/Core/LocalConnectionToClient.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a88758df7db2043d6a9d926e0b6d4191 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/LocalConnectionToServer.cs b/Assets/Mirror/Core/LocalConnectionToServer.cs new file mode 100644 index 0000000..dff12a4 --- /dev/null +++ b/Assets/Mirror/Core/LocalConnectionToServer.cs @@ -0,0 +1,128 @@ +using System; +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + // a localClient's connection TO a server. + // send messages on this connection causes the server's handler function to be invoked directly. + public class LocalConnectionToServer : NetworkConnectionToServer + { + internal LocalConnectionToClient connectionToClient; + + // packet queue + internal readonly Queue queue = new Queue(); + + // Deprecated 2023-02-23 + [Obsolete("Use LocalConnectionToClient.address instead.")] + public string address => "localhost"; + + // see caller for comments on why we need this + bool connectedEventPending; + bool disconnectedEventPending; + internal void QueueConnectedEvent() => connectedEventPending = true; + internal void QueueDisconnectedEvent() => disconnectedEventPending = true; + + // Send stage two: serialized NetworkMessage as ArraySegment + internal override void Send(ArraySegment segment, int channelId = Channels.Reliable) + { + if (segment.Count == 0) + { + Debug.LogError("LocalConnection.SendBytes cannot send zero bytes"); + return; + } + + // OnTransportData assumes batching. + // so let's make a batch with proper timestamp prefix. + Batcher batcher = GetBatchForChannelId(channelId); + batcher.AddMessage(segment, NetworkTime.localTime); + + // flush it to the server's OnTransportData immediately. + // local connection to server always invokes immediately. + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + // make a batch with our local time (double precision) + if (batcher.GetBatch(writer)) + { + NetworkServer.OnTransportData(connectionId, writer.ToArraySegment(), channelId); + } + else Debug.LogError("Local connection failed to make batch. This should never happen."); + } + } + + internal override void Update() + { + base.Update(); + + // should we still process a connected event? + if (connectedEventPending) + { + connectedEventPending = false; + NetworkClient.OnConnectedEvent?.Invoke(); + } + + // process internal messages so they are applied at the correct time + while (queue.Count > 0) + { + // call receive on queued writer's content, return to pool + NetworkWriterPooled writer = queue.Dequeue(); + ArraySegment message = writer.ToArraySegment(); + + // OnTransportData assumes a proper batch with timestamp etc. + // let's make a proper batch and pass it to OnTransportData. + Batcher batcher = GetBatchForChannelId(Channels.Reliable); + batcher.AddMessage(message, NetworkTime.localTime); + + using (NetworkWriterPooled batchWriter = NetworkWriterPool.Get()) + { + // make a batch with our local time (double precision) + if (batcher.GetBatch(batchWriter)) + { + NetworkClient.OnTransportData(batchWriter.ToArraySegment(), Channels.Reliable); + } + } + + NetworkWriterPool.Return(writer); + } + + // should we still process a disconnected event? + if (disconnectedEventPending) + { + disconnectedEventPending = false; + NetworkClient.OnDisconnectedEvent?.Invoke(); + } + } + + /// Disconnects this connection. + internal void DisconnectInternal() + { + // set not ready and handle clientscene disconnect in any case + // (might be client or host mode here) + // TODO remove redundant state. have one source of truth for .ready! + isReady = false; + NetworkClient.ready = false; + } + + /// Disconnects this connection. + public override void Disconnect() + { + connectionToClient.DisconnectInternal(); + DisconnectInternal(); + + // simulate what a true remote connection would do: + // first, the server should remove it: + // TODO should probably be in connectionToClient.DisconnectInternal + // because that's the NetworkServer's connection! + NetworkServer.RemoveLocalConnection(); + + // then call OnTransportDisconnected for proper disconnect handling, + // callbacks & cleanups. + // => otherwise OnClientDisconnected() is never called! + // => see NetworkClientTests.DisconnectCallsOnClientDisconnect_HostMode() + NetworkClient.OnTransportDisconnected(); + } + + // true because local connections never timeout + internal override bool IsAlive(float timeout) => true; + } +} diff --git a/Assets/Mirror/Core/LocalConnectionToServer.cs.meta b/Assets/Mirror/Core/LocalConnectionToServer.cs.meta new file mode 100644 index 0000000..856b255 --- /dev/null +++ b/Assets/Mirror/Core/LocalConnectionToServer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: cdfff390c3504158a269e8b8662e2a40 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Messages.cs b/Assets/Mirror/Core/Messages.cs new file mode 100644 index 0000000..38cd14c --- /dev/null +++ b/Assets/Mirror/Core/Messages.cs @@ -0,0 +1,122 @@ +using System; +using UnityEngine; + +namespace Mirror +{ + // need to send time every sendInterval. + // batching automatically includes remoteTimestamp. + // all we need to do is ensure that an empty message is sent. + // and react to it. + // => we don't want to insert a snapshot on every batch. + // => do it exactly every sendInterval on every TimeSnapshotMessage. + public struct TimeSnapshotMessage : NetworkMessage {} + + public struct ReadyMessage : NetworkMessage {} + + public struct NotReadyMessage : NetworkMessage {} + + public struct AddPlayerMessage : NetworkMessage {} + + public struct SceneMessage : NetworkMessage + { + public string sceneName; + // Normal = 0, LoadAdditive = 1, UnloadAdditive = 2 + public SceneOperation sceneOperation; + public bool customHandling; + } + + public enum SceneOperation : byte + { + Normal, + LoadAdditive, + UnloadAdditive + } + + public struct CommandMessage : NetworkMessage + { + public uint netId; + public byte componentIndex; + public ushort functionHash; + // the parameters for the Cmd function + // -> ArraySegment to avoid unnecessary allocations + public ArraySegment payload; + } + + public struct RpcMessage : NetworkMessage + { + public uint netId; + public byte componentIndex; + public ushort functionHash; + // the parameters for the Cmd function + // -> ArraySegment to avoid unnecessary allocations + public ArraySegment payload; + } + + public struct SpawnMessage : NetworkMessage + { + // netId of new or existing object + public uint netId; + public bool isLocalPlayer; + // Sets hasAuthority on the spawned object + public bool isOwner; + public ulong sceneId; + // If sceneId != 0 then it is used instead of assetId + public uint assetId; + // Local position + public Vector3 position; + // Local rotation + public Quaternion rotation; + // Local scale + public Vector3 scale; + // serialized component data + // ArraySegment to avoid unnecessary allocations + public ArraySegment payload; + } + + public struct ChangeOwnerMessage : NetworkMessage + { + public uint netId; + public bool isOwner; + public bool isLocalPlayer; + } + + public struct ObjectSpawnStartedMessage : NetworkMessage {} + + public struct ObjectSpawnFinishedMessage : NetworkMessage {} + + public struct ObjectDestroyMessage : NetworkMessage + { + public uint netId; + } + + public struct ObjectHideMessage : NetworkMessage + { + public uint netId; + } + + public struct EntityStateMessage : NetworkMessage + { + public uint netId; + // the serialized component data + // -> ArraySegment to avoid unnecessary allocations + public ArraySegment payload; + } + + // whoever wants to measure rtt, sends this to the other end. + public struct NetworkPingMessage : NetworkMessage + { + public double localTime; + + public NetworkPingMessage(double value) + { + localTime = value; + } + } + + // the other end responds with this message. + // we can use this to calculate rtt. + public struct NetworkPongMessage : NetworkMessage + { + public double localTime; + } +} diff --git a/Assets/Mirror/Core/Messages.cs.meta b/Assets/Mirror/Core/Messages.cs.meta new file mode 100644 index 0000000..5d119e2 --- /dev/null +++ b/Assets/Mirror/Core/Messages.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 938f6f28a6c5b48a0bbd7782342d763b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Mirror.asmdef b/Assets/Mirror/Core/Mirror.asmdef new file mode 100644 index 0000000..2fa8d95 --- /dev/null +++ b/Assets/Mirror/Core/Mirror.asmdef @@ -0,0 +1,16 @@ +{ + "name": "Mirror", + "rootNamespace": "", + "references": [ + "GUID:325984b52e4128546bc7558552f8b1d2" + ], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": true, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/Assets/Mirror/Core/Mirror.asmdef.meta b/Assets/Mirror/Core/Mirror.asmdef.meta new file mode 100644 index 0000000..202009b --- /dev/null +++ b/Assets/Mirror/Core/Mirror.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 30817c1a0e6d646d99c048fc403f5979 +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkAuthenticator.cs b/Assets/Mirror/Core/NetworkAuthenticator.cs new file mode 100644 index 0000000..aa1e7f7 --- /dev/null +++ b/Assets/Mirror/Core/NetworkAuthenticator.cs @@ -0,0 +1,84 @@ +using System; +using UnityEngine; +using UnityEngine.Events; + +namespace Mirror +{ + [Serializable] public class UnityEventNetworkConnection : UnityEvent {} + + /// Base class for implementing component-based authentication during the Connect phase + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-authenticators")] + public abstract class NetworkAuthenticator : MonoBehaviour + { + /// Notify subscribers on the server when a client is authenticated + [Header("Event Listeners (optional)")] + [Tooltip("Mirror has an internal subscriber to this event. You can add your own here.")] + public UnityEventNetworkConnection OnServerAuthenticated = new UnityEventNetworkConnection(); + + /// Notify subscribers on the client when the client is authenticated + [Tooltip("Mirror has an internal subscriber to this event. You can add your own here.")] + public UnityEvent OnClientAuthenticated = new UnityEvent(); + + /// Called when server starts, used to register message handlers if needed. + public virtual void OnStartServer() {} + + /// Called when server stops, used to unregister message handlers if needed. + public virtual void OnStopServer() {} + + /// Called on server from OnServerConnectInternal when a client needs to authenticate + public virtual void OnServerAuthenticate(NetworkConnectionToClient conn) {} + + protected void ServerAccept(NetworkConnectionToClient conn) + { + OnServerAuthenticated.Invoke(conn); + } + + protected void ServerReject(NetworkConnectionToClient conn) + { + conn.Disconnect(); + } + + /// Called when client starts, used to register message handlers if needed. + public virtual void OnStartClient() {} + + /// Called when client stops, used to unregister message handlers if needed. + public virtual void OnStopClient() {} + + /// Called on client from OnClientConnectInternal when a client needs to authenticate + public virtual void OnClientAuthenticate() {} + + protected void ClientAccept() + { + OnClientAuthenticated.Invoke(); + } + + protected void ClientReject() + { + // Set this on the client for local reference + NetworkClient.connection.isAuthenticated = false; + + // disconnect the client + NetworkClient.connection.Disconnect(); + } + + // Reset() instead of OnValidate(): + // Any NetworkAuthenticator assigns itself to the NetworkManager, this is fine on first adding it, + // but if someone intentionally sets Authenticator to null on the NetworkManager again then the + // Authenticator will reassign itself if a value in the inspector is changed. + // My change switches OnValidate to Reset since Reset is only called when the component is first + // added (or reset is pressed). + void Reset() + { +#if UNITY_EDITOR + // automatically assign authenticator field if we add this to NetworkManager + NetworkManager manager = GetComponent(); + if (manager != null && manager.authenticator == null) + { + // undo has to be called before the change happens + UnityEditor.Undo.RecordObject(manager, "Assigned NetworkManager authenticator"); + manager.authenticator = this; + } +#endif + } + } +} diff --git a/Assets/Mirror/Core/NetworkAuthenticator.cs.meta b/Assets/Mirror/Core/NetworkAuthenticator.cs.meta new file mode 100644 index 0000000..d37db68 --- /dev/null +++ b/Assets/Mirror/Core/NetworkAuthenticator.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 407fc95d4a8257f448799f26cdde0c2a +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkBehaviour.cs b/Assets/Mirror/Core/NetworkBehaviour.cs new file mode 100644 index 0000000..affca80 --- /dev/null +++ b/Assets/Mirror/Core/NetworkBehaviour.cs @@ -0,0 +1,1361 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Runtime.CompilerServices; +using UnityEngine; + +namespace Mirror +{ + // SyncMode decides if a component is synced to all observers, or only owner + public enum SyncMode { Observers, Owner } + + // SyncDirection decides if a component is synced from: + // * server to all clients + // * owner client, to server, to all other clients + // + // naming: 'ClientToServer' etc. instead of 'ClientAuthority', because + // that wouldn't be accurate. server's OnDeserialize can still validate + // client data before applying. it's really about direction, not authority. + public enum SyncDirection { ServerToClient, ClientToServer } + + /// Base class for networked components. + // [RequireComponent(typeof(NetworkIdentity))] disabled to allow child NetworkBehaviours + [AddComponentMenu("")] + [HelpURL("https://mirror-networking.gitbook.io/docs/guides/networkbehaviour")] + public abstract class NetworkBehaviour : MonoBehaviour + { + /// Sync direction for OnSerialize. ServerToClient by default. ClientToServer for client authority. + [Tooltip("Server Authority calls OnSerialize on the server and syncs it to clients.\n\nClient Authority calls OnSerialize on the owning client, syncs it to server, which then broadcasts it to all other clients.\n\nUse server authority for cheat safety.")] + [HideInInspector] public SyncDirection syncDirection = SyncDirection.ServerToClient; + + /// sync mode for OnSerialize + // hidden because NetworkBehaviourInspector shows it only if has OnSerialize. + [Tooltip("By default synced data is sent from the server to all Observers of the object.\nChange this to Owner to only have the server update the client that has ownership authority for this object")] + [HideInInspector] public SyncMode syncMode = SyncMode.Observers; + + /// sync interval for OnSerialize (in seconds) + // hidden because NetworkBehaviourInspector shows it only if has OnSerialize. + // [0,2] should be enough. anything >2s is too laggy anyway. + // + // NetworkServer & NetworkClient broadcast() are behind a sendInterval timer now. + // it makes sense to keep every component's syncInterval setting at '0' by default. + // otherwise, the overlapping timers could introduce unexpected latency. + // careful: default of '0.1' may + [Tooltip("Time in seconds until next change is synchronized to the client. '0' means send immediately if changed. '0.5' means only send changes every 500ms.\n(This is for state synchronization like SyncVars, SyncLists, OnSerialize. Not for Cmds, Rpcs, etc.)")] + [Range(0, 2)] + [HideInInspector] public float syncInterval = 0; + internal double lastSyncTime; + + /// True if this object is on the server and has been spawned. + // This is different from NetworkServer.active, which is true if the + // server itself is active rather than this object being active. + public bool isServer => netIdentity.isServer; + + /// True if this object is on the client and has been spawned by the server. + public bool isClient => netIdentity.isClient; + + /// True if this object is the the client's own local player. + public bool isLocalPlayer => netIdentity.isLocalPlayer; + + /// True if this object is on the server-only, not host. + public bool isServerOnly => netIdentity.isServerOnly; + + /// True if this object is on the client-only, not host. + public bool isClientOnly => netIdentity.isClientOnly; + + /// isOwned is true on the client if this NetworkIdentity is one of the .owned entities of our connection on the server. + // for example: main player & pets are owned. monsters & npcs aren't. + public bool isOwned => netIdentity.isOwned; + + // Deprecated 2022-10-13 + [Obsolete(".hasAuthority was renamed to .isOwned. This is easier to understand and prepares for SyncDirection, where there is a difference betwen isOwned and authority.")] + public bool hasAuthority => isOwned; + + /// authority is true if we are allowed to modify this component's state. On server, it's true if SyncDirection is ServerToClient. On client, it's true if SyncDirection is ClientToServer and(!) if this object is owned by the client. + // on the client: if owned and if clientAuthority sync direction + // on the server: if serverAuthority sync direction + // + // for example, NetworkTransform: + // client may modify position if ClientAuthority mode and owned + // server may modify position only if server authority + // + // note that in original Mirror, hasAuthority only meant 'isOwned'. + // there was no syncDirection to check. + // + // also note that this is a per-NetworkBehaviour flag. + // another component may not be client authoritative, etc. + public bool authority => + isClient + ? syncDirection == SyncDirection.ClientToServer && isOwned + : syncDirection == SyncDirection.ServerToClient; + + /// The unique network Id of this object (unique at runtime). + public uint netId => netIdentity.netId; + + /// Client's network connection to the server. This is only valid for player objects on the client. + // TODO change to NetworkConnectionToServer, but might cause some breaking + public NetworkConnection connectionToServer => netIdentity.connectionToServer; + + /// Server's network connection to the client. This is only valid for player objects on the server. + public NetworkConnectionToClient connectionToClient => netIdentity.connectionToClient; + + // SyncLists, SyncSets, etc. + protected readonly List syncObjects = new List(); + + // NetworkBehaviourInspector needs to know if we have SyncObjects + internal bool HasSyncObjects() => syncObjects.Count > 0; + + // NetworkIdentity based values set from NetworkIdentity.Awake(), + // which is way more simple and way faster than trying to figure out + // component index from in here by searching all NetworkComponents. + + /// Returns the NetworkIdentity of this object + public NetworkIdentity netIdentity { get; internal set; } + + /// Returns the index of the component on this object + public byte ComponentIndex { get; internal set; } + + // to avoid fully serializing entities every time, we have two options: + // * run a delta compression algorithm + // -> for fixed size types this is as easy as varint(b-a) for all + // -> for dynamically sized types like strings this is not easy. + // algorithms need to detect inserts/deletions, i.e. Myers Diff. + // those are very cpu intensive and barely fast enough for large + // scale multiplayer games (in Unity) + // * or we use dirty bits as meta data about which fields have changed + // -> spares us from running delta algorithms + // -> still supports dynamically sized types + // + // 64 bit mask, tracking up to 64 SyncVars. + protected ulong syncVarDirtyBits { get; private set; } + // 64 bit mask, tracking up to 64 sync collections (internal for tests). + // internal for tests, field for faster access (instead of property) + // TODO 64 SyncLists are too much. consider smaller mask later. + internal ulong syncObjectDirtyBits; + + // Weaver replaces '[SyncVar] int health' with 'Networkhealth' property. + // setter calls the hook if value changed. + // if we then modify the [SyncVar] from inside the setter, + // the setter would call the hook and we deadlock. + // hook guard prevents that. + ulong syncVarHookGuard; + + // USED BY WEAVER to set syncvars in host mode without deadlocking + protected bool GetSyncVarHookGuard(ulong dirtyBit) => + (syncVarHookGuard & dirtyBit) != 0UL; + + // USED BY WEAVER to set syncvars in host mode without deadlocking + protected void SetSyncVarHookGuard(ulong dirtyBit, bool value) + { + // set the bit + if (value) + syncVarHookGuard |= dirtyBit; + // clear the bit + else + syncVarHookGuard &= ~dirtyBit; + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + void SetSyncObjectDirtyBit(ulong dirtyBit) + { + syncObjectDirtyBits |= dirtyBit; + } + + /// Set as dirty so that it's synced to clients again. + // these are masks, not bit numbers, ie. 110011b not '2' for 2nd bit. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void SetSyncVarDirtyBit(ulong dirtyBit) + { + syncVarDirtyBits |= dirtyBit; + } + + /// Set as dirty to trigger OnSerialize & send. Dirty bits are cleared after the send. + // previously one had to use SetSyncVarDirtyBit(1), which is confusing. + // simply reuse SetSyncVarDirtyBit for now. + // instead of adding another field. + // syncVarDirtyBits does trigger OnSerialize as well. + // + // it's important to set _all_ bits as dirty. + // for example, server needs to broadcast ClientToServer components. + // if we only set the first bit, only that SyncVar would be broadcast. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void SetDirty() => SetSyncVarDirtyBit(ulong.MaxValue); + + // true if syncInterval elapsed and any SyncVar or SyncObject is dirty + // OR both bitmasks. != 0 if either was dirty. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public bool IsDirty() => + // check bits first. this is basically free. + (syncVarDirtyBits | syncObjectDirtyBits) != 0UL && + // only check time if bits were dirty. this is more expensive. + NetworkTime.localTime - lastSyncTime >= syncInterval; + + /// Clears all the dirty bits that were set by SetSyncVarDirtyBit() (formally SetDirtyBits) + // automatically invoked when an update is sent for this object, but can + // be called manually as well. + public void ClearAllDirtyBits() + { + lastSyncTime = NetworkTime.localTime; + syncVarDirtyBits = 0L; + syncObjectDirtyBits = 0L; + + // clear all unsynchronized changes in syncobjects + // (Linq allocates, use for instead) + for (int i = 0; i < syncObjects.Count; ++i) + { + syncObjects[i].ClearChanges(); + } + } + + // this gets called in the constructor by the weaver + // for every SyncObject in the component (e.g. SyncLists). + // We collect all of them and we synchronize them with OnSerialize/OnDeserialize + protected void InitSyncObject(SyncObject syncObject) + { + if (syncObject == null) + { + Debug.LogError("Uninitialized SyncObject. Manually call the constructor on your SyncList, SyncSet, SyncDictionary or SyncField"); + return; + } + + // add it, remember the index in list (if Count=0, index=0 etc.) + int index = syncObjects.Count; + syncObjects.Add(syncObject); + + // OnDirty needs to set nth bit in our dirty mask + ulong nthBit = 1UL << index; + syncObject.OnDirty = () => SetSyncObjectDirtyBit(nthBit); + + // who is allowed to modify SyncList/SyncSet/etc.: + // on client: only if owned ClientToserver + // on server: only if ServerToClient. + // but also for initial state when spawning. + // need to set a lambda because 'isClient' isn't available in + // InitSyncObject yet, which is called from the constructor. + syncObject.IsWritable = () => + { + // carefully check each mode separately to ensure correct results. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3342 + + // normally we would check isServer / isClient here. + // users may add to SyncLists before the object was spawned. + // isServer / isClient would still be false. + // so we need to check NetworkServer/Client.active here instead. + + // host mode: any ServerToClient and any local client owned + if (NetworkServer.active && NetworkClient.active) + return syncDirection == SyncDirection.ServerToClient || isOwned; + + // server only: any ServerToClient + if (NetworkServer.active) + return syncDirection == SyncDirection.ServerToClient; + + // client only: only ClientToServer and owned + if (NetworkClient.active) + { + // spawned: only ClientToServer and owned + if (netId != 0) return syncDirection == SyncDirection.ClientToServer && isOwned; + + // not spawned (character selection previews, etc.): always allow + // fixes https://github.com/MirrorNetworking/Mirror/issues/3343 + return true; + } + + // undefined behaviour should throw to make it very obvious + throw new Exception("InitSyncObject: IsWritable: neither NetworkServer nor NetworkClient are active."); + }; + + // when do we record changes: + // on client: only if owned ClientToServer + // on server: only if we have observers. + // prevents ever growing .changes lists: + // if a monster has no observers but we keep modifing a SyncObject, + // then the changes would never be flushed and keep growing, + // because OnSerialize isn't called without observers. + syncObject.IsRecording = () => + { + // carefully check each mode separately to ensure correct results. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3342 + + // host mode: only if observed + if (isServer && isClient) return netIdentity.observers.Count > 0; + + // server only: only if observed + if (isServer) return netIdentity.observers.Count > 0; + + // client only: only ClientToServer and owned + if (isClient) return syncDirection == SyncDirection.ClientToServer && isOwned; + + // users may add to SyncLists before the object was spawned. + // isServer / isClient would still be false. + // in that case, allow modifying but don't record changes yet. + return false; + }; + } + + protected virtual void OnValidate() + { + // we now allow child NetworkBehaviours. + // we can not [RequireComponent(typeof(NetworkIdentity))] anymore. + // instead, we need to ensure a NetworkIdentity is somewhere in the + // parents. + // only run this in Editor. don't add more runtime overhead. + + // GetComponentInParent(includeInactive) is needed because Prefabs are not + // considered active, so this check requires to scan inactive. +#if UNITY_EDITOR +#if UNITY_2021_3_OR_NEWER // 2021 has GetComponentInParents(active) + if (GetComponent() == null && + GetComponentInParent(true) == null) + { + Debug.LogError($"{GetType()} on {name} requires a NetworkIdentity. Please add a NetworkIdentity component to {name} or it's parents."); + } +#elif UNITY_2020_3_OR_NEWER // 2020 only has GetComponentsInParents(active), we can use this too + NetworkIdentity[] parentsIds = GetComponentsInParent(true); + int parentIdsCount = parentsIds != null ? parentsIds.Length : 0; + if (GetComponent() == null && parentIdsCount == 0) + { + Debug.LogError($"{GetType()} on {name} requires a NetworkIdentity. Please add a NetworkIdentity component to {name} or it's parents."); + } +#endif +#endif + } + + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + protected void SendCommandInternal(string functionFullName, int functionHashCode, NetworkWriter writer, int channelId, bool requiresAuthority = true) + { + // this was in Weaver before + // NOTE: we could remove this later to allow calling Cmds on Server + // to avoid Wrapper functions. a lot of people requested this. + if (!NetworkClient.active) + { + Debug.LogError($"Command {functionFullName} called on {name} without an active client.", gameObject); + return; + } + + // previously we used NetworkClient.readyConnection. + // now we check .ready separately. + if (!NetworkClient.ready) + { + // Unreliable Cmds from NetworkTransform may be generated, + // or client may have been set NotReady intentionally, so + // only warn if on the reliable channel. + if (channelId == Channels.Reliable) + Debug.LogWarning($"Command {functionFullName} called on {name} while NetworkClient is not ready.\nThis may be ignored if client intentionally set NotReady.", gameObject); + return; + } + + // local players can always send commands, regardless of authority, + // other objects must have authority. + if (!(!requiresAuthority || isLocalPlayer || isOwned)) + { + Debug.LogWarning($"Command {functionFullName} called on {name} without authority.", gameObject); + return; + } + + // IMPORTANT: can't use .connectionToServer here because calling + // a command on other objects is allowed if requireAuthority is + // false. other objects don't have a .connectionToServer. + // => so we always need to use NetworkClient.connection instead. + // => see also: https://github.com/vis2k/Mirror/issues/2629 + if (NetworkClient.connection == null) + { + Debug.LogError($"Command {functionFullName} called on {name} with no client running.", gameObject); + return; + } + + // construct the message + CommandMessage message = new CommandMessage + { + netId = netId, + componentIndex = ComponentIndex, + // type+func so Inventory.RpcUse != Equipment.RpcUse + functionHash = (ushort)functionHashCode, + // segment to avoid reader allocations + payload = writer.ToArraySegment() + }; + + // IMPORTANT: can't use .connectionToServer here because calling + // a command on other objects is allowed if requireAuthority is + // false. other objects don't have a .connectionToServer. + // => so we always need to use NetworkClient.connection instead. + // => see also: https://github.com/vis2k/Mirror/issues/2629 + // This bypasses the null check in NetworkClient.Send but we have + // a null check above with a detailed error log. + NetworkClient.connection.Send(message, channelId); + } + + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + protected void SendRPCInternal(string functionFullName, int functionHashCode, NetworkWriter writer, int channelId, bool includeOwner) + { + // this was in Weaver before + if (!NetworkServer.active) + { + Debug.LogError($"RPC Function {functionFullName} called without an active server.", gameObject); + return; + } + + // This cannot use NetworkServer.active, as that is not specific to this object. + if (!isServer) + { + Debug.LogWarning($"ClientRpc {functionFullName} called on un-spawned object: {name}", gameObject); + return; + } + + // construct the message + RpcMessage message = new RpcMessage + { + netId = netId, + componentIndex = ComponentIndex, + // type+func so Inventory.RpcUse != Equipment.RpcUse + functionHash = (ushort)functionHashCode, + // segment to avoid reader allocations + payload = writer.ToArraySegment() + }; + + // serialize it to each ready observer's connection's rpc buffer. + // send them all at once, instead of sending one message per rpc. + // NetworkServer.SendToReadyObservers(netIdentity, message, includeOwner, channelId); + + // safety check used to be in SendToReadyObservers. keep it for now. + if (netIdentity.observers == null || netIdentity.observers.Count == 0) + return; + + // serialize the message only once + using (NetworkWriterPooled serialized = NetworkWriterPool.Get()) + { + serialized.Write(message); + + // send to every observer. + // batching buffers this automatically. + foreach (NetworkConnectionToClient conn in netIdentity.observers.Values) + { + bool isOwner = conn == netIdentity.connectionToClient; + if ((!isOwner || includeOwner) && conn.isReady) + { + conn.Send(message, channelId); + } + } + } + } + + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + protected void SendTargetRPCInternal(NetworkConnection conn, string functionFullName, int functionHashCode, NetworkWriter writer, int channelId) + { + if (!NetworkServer.active) + { + Debug.LogError($"TargetRPC {functionFullName} was called on {name} when server not active.", gameObject); + return; + } + + if (!isServer) + { + Debug.LogWarning($"TargetRpc {functionFullName} called on {name} but that object has not been spawned or has been unspawned.", gameObject); + return; + } + + // connection parameter is optional. assign if null. + if (conn is null) + { + conn = connectionToClient; + } + + // if still null + if (conn is null) + { + Debug.LogError($"TargetRPC {functionFullName} can't be sent because it was given a null connection. Make sure {name} is owned by a connection, or if you pass a connection manually then make sure it's not null. For example, TargetRpcs can be called on Player/Pet which are owned by a connection. However, they can not be called on Monsters/Npcs which don't have an owner connection.", gameObject); + return; + } + + // TODO change conn type to NetworkConnectionToClient to begin with. + if (!(conn is NetworkConnectionToClient connToClient)) + { + Debug.LogError($"TargetRPC {functionFullName} called on {name} requires a NetworkConnectionToClient but was given {conn.GetType().Name}", gameObject); + return; + } + + // construct the message + RpcMessage message = new RpcMessage + { + netId = netId, + componentIndex = ComponentIndex, + // type+func so Inventory.RpcUse != Equipment.RpcUse + functionHash = (ushort)functionHashCode, + // segment to avoid reader allocations + payload = writer.ToArraySegment() + }; + + // send it to the connection. + // batching buffers this automatically. + conn.Send(message, channelId); + } + + // move the [SyncVar] generated property's .set into C# to avoid much IL + // + // public int health = 42; + // + // public int Networkhealth + // { + // get + // { + // return health; + // } + // [param: In] + // set + // { + // if (!NetworkBehaviour.SyncVarEqual(value, ref health)) + // { + // int oldValue = health; + // SetSyncVar(value, ref health, 1uL); + // if (NetworkServer.activeHost && !GetSyncVarHookGuard(1uL)) + // { + // SetSyncVarHookGuard(1uL, value: true); + // OnChanged(oldValue, value); + // SetSyncVarHookGuard(1uL, value: false); + // } + // } + // } + // } + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void GeneratedSyncVarSetter(T value, ref T field, ulong dirtyBit, Action OnChanged) + { + if (!SyncVarEqual(value, ref field)) + { + T oldValue = field; + SetSyncVar(value, ref field, dirtyBit); + + // call hook (if any) + if (OnChanged != null) + { + // in host mode, setting a SyncVar calls the hook directly. + // in client-only mode, OnDeserialize would call it. + // we use hook guard to protect against deadlock where hook + // changes syncvar, calling hook again. + if (NetworkServer.activeHost && !GetSyncVarHookGuard(dirtyBit)) + { + SetSyncVarHookGuard(dirtyBit, true); + OnChanged(oldValue, value); + SetSyncVarHookGuard(dirtyBit, false); + } + } + } + } + + // GameObject needs custom handling for persistence via netId. + // has one extra parameter. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void GeneratedSyncVarSetter_GameObject(GameObject value, ref GameObject field, ulong dirtyBit, Action OnChanged, ref uint netIdField) + { + if (!SyncVarGameObjectEqual(value, netIdField)) + { + GameObject oldValue = field; + SetSyncVarGameObject(value, ref field, dirtyBit, ref netIdField); + + // call hook (if any) + if (OnChanged != null) + { + // in host mode, setting a SyncVar calls the hook directly. + // in client-only mode, OnDeserialize would call it. + // we use hook guard to protect against deadlock where hook + // changes syncvar, calling hook again. + if (NetworkServer.activeHost && !GetSyncVarHookGuard(dirtyBit)) + { + SetSyncVarHookGuard(dirtyBit, true); + OnChanged(oldValue, value); + SetSyncVarHookGuard(dirtyBit, false); + } + } + } + } + + // NetworkIdentity needs custom handling for persistence via netId. + // has one extra parameter. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void GeneratedSyncVarSetter_NetworkIdentity(NetworkIdentity value, ref NetworkIdentity field, ulong dirtyBit, Action OnChanged, ref uint netIdField) + { + if (!SyncVarNetworkIdentityEqual(value, netIdField)) + { + NetworkIdentity oldValue = field; + SetSyncVarNetworkIdentity(value, ref field, dirtyBit, ref netIdField); + + // call hook (if any) + if (OnChanged != null) + { + // in host mode, setting a SyncVar calls the hook directly. + // in client-only mode, OnDeserialize would call it. + // we use hook guard to protect against deadlock where hook + // changes syncvar, calling hook again. + if (NetworkServer.activeHost && !GetSyncVarHookGuard(dirtyBit)) + { + SetSyncVarHookGuard(dirtyBit, true); + OnChanged(oldValue, value); + SetSyncVarHookGuard(dirtyBit, false); + } + } + } + } + + // NetworkBehaviour needs custom handling for persistence via netId. + // has one extra parameter. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void GeneratedSyncVarSetter_NetworkBehaviour(T value, ref T field, ulong dirtyBit, Action OnChanged, ref NetworkBehaviourSyncVar netIdField) + where T : NetworkBehaviour + { + if (!SyncVarNetworkBehaviourEqual(value, netIdField)) + { + T oldValue = field; + SetSyncVarNetworkBehaviour(value, ref field, dirtyBit, ref netIdField); + + // call hook (if any) + if (OnChanged != null) + { + // in host mode, setting a SyncVar calls the hook directly. + // in client-only mode, OnDeserialize would call it. + // we use hook guard to protect against deadlock where hook + // changes syncvar, calling hook again. + if (NetworkServer.activeHost && !GetSyncVarHookGuard(dirtyBit)) + { + SetSyncVarHookGuard(dirtyBit, true); + OnChanged(oldValue, value); + SetSyncVarHookGuard(dirtyBit, false); + } + } + } + } + + // helper function for [SyncVar] GameObjects. + // needs to be public so that tests & NetworkBehaviours from other + // assemblies both find it + [EditorBrowsable(EditorBrowsableState.Never)] + public static bool SyncVarGameObjectEqual(GameObject newGameObject, uint netIdField) + { + uint newNetId = 0; + if (newGameObject != null) + { + if (newGameObject.TryGetComponent(out NetworkIdentity identity)) + { + newNetId = identity.netId; + if (newNetId == 0) + { + Debug.LogWarning($"SetSyncVarGameObject GameObject {newGameObject} has a zero netId. Maybe it is not spawned yet?"); + } + } + } + + return newNetId == netIdField; + } + + // helper function for [SyncVar] GameObjects. + // dirtyBit is a mask like 00010 + protected void SetSyncVarGameObject(GameObject newGameObject, ref GameObject gameObjectField, ulong dirtyBit, ref uint netIdField) + { + if (GetSyncVarHookGuard(dirtyBit)) + return; + + uint newNetId = 0; + if (newGameObject != null) + { + if (newGameObject.TryGetComponent(out NetworkIdentity identity)) + { + newNetId = identity.netId; + if (newNetId == 0) + { + Debug.LogWarning($"SetSyncVarGameObject GameObject {newGameObject} has a zero netId. Maybe it is not spawned yet?"); + } + } + } + + //Debug.Log($"SetSyncVar GameObject {GetType().Name} bit:{dirtyBit} netfieldId:{netIdField} -> {newNetId}"); + SetSyncVarDirtyBit(dirtyBit); + // assign new one on the server, and in case we ever need it on client too + gameObjectField = newGameObject; + netIdField = newNetId; + } + + // helper function for [SyncVar] GameObjects. + // -> ref GameObject as second argument makes OnDeserialize processing easier + protected GameObject GetSyncVarGameObject(uint netId, ref GameObject gameObjectField) + { + // server always uses the field + // if neither, fallback to original field + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3447 + if (isServer || !isClient) + { + return gameObjectField; + } + + // client always looks up based on netId because objects might get in and out of range + // over and over again, which shouldn't null them forever + if (NetworkClient.spawned.TryGetValue(netId, out NetworkIdentity identity) && identity != null) + return gameObjectField = identity.gameObject; + return null; + } + + // helper function for [SyncVar] NetworkIdentities. + // needs to be public so that tests & NetworkBehaviours from other + // assemblies both find it + [EditorBrowsable(EditorBrowsableState.Never)] + public static bool SyncVarNetworkIdentityEqual(NetworkIdentity newIdentity, uint netIdField) + { + uint newNetId = 0; + if (newIdentity != null) + { + newNetId = newIdentity.netId; + if (newNetId == 0) + { + Debug.LogWarning($"SetSyncVarNetworkIdentity NetworkIdentity {newIdentity} has a zero netId. Maybe it is not spawned yet?"); + } + } + + // netId changed? + return newNetId == netIdField; + } + + // move the [SyncVar] generated OnDeserialize C# to avoid much IL. + // + // before: + // public override void DeserializeSyncVars(NetworkReader reader, bool initialState) + // { + // base.DeserializeSyncVars(reader, initialState); + // if (initialState) + // { + // int num = health; + // Networkhealth = reader.ReadInt(); + // if (!NetworkBehaviour.SyncVarEqual(num, ref health)) + // { + // OnChanged(num, health); + // } + // return; + // } + // long num2 = (long)reader.ReadULong(); + // if ((num2 & 1L) != 0L) + // { + // int num3 = health; + // Networkhealth = reader.ReadInt(); + // if (!NetworkBehaviour.SyncVarEqual(num3, ref health)) + // { + // OnChanged(num3, health); + // } + // } + // } + // + // after: + // + // public override void DeserializeSyncVars(NetworkReader reader, bool initialState) + // { + // base.DeserializeSyncVars(reader, initialState); + // if (initialState) + // { + // GeneratedSyncVarDeserialize(reader, ref health, null, reader.ReadInt()); + // return; + // } + // long num = (long)reader.ReadULong(); + // if ((num & 1L) != 0L) + // { + // GeneratedSyncVarDeserialize(reader, ref health, null, reader.ReadInt()); + // } + // } + public void GeneratedSyncVarDeserialize(ref T field, Action OnChanged, T value) + { + T previous = field; + field = value; + + // any hook? then call if changed. + if (OnChanged != null && !SyncVarEqual(previous, ref field)) + { + OnChanged(previous, field); + } + } + + // move the [SyncVar] generated OnDeserialize C# to avoid much IL. + // + // before: + // public override void DeserializeSyncVars(NetworkReader reader, bool initialState) + // { + // base.DeserializeSyncVars(reader, initialState); + // if (initialState) + // { + // uint __targetNetId = ___targetNetId; + // GameObject networktarget = Networktarget; + // ___targetNetId = reader.ReadUInt(); + // if (!NetworkBehaviour.SyncVarEqual(__targetNetId, ref ___targetNetId)) + // { + // OnChangedNB(networktarget, Networktarget); + // } + // return; + // } + // long num = (long)reader.ReadULong(); + // if ((num & 1L) != 0L) + // { + // uint __targetNetId2 = ___targetNetId; + // GameObject networktarget2 = Networktarget; + // ___targetNetId = reader.ReadUInt(); + // if (!NetworkBehaviour.SyncVarEqual(__targetNetId2, ref ___targetNetId)) + // { + // OnChangedNB(networktarget2, Networktarget); + // } + // } + // } + // + // after: + // public override void DeserializeSyncVars(NetworkReader reader, bool initialState) + // { + // base.DeserializeSyncVars(reader, initialState); + // if (initialState) + // { + // GeneratedSyncVarDeserialize_GameObject(reader, ref target, OnChangedNB, ref ___targetNetId); + // return; + // } + // long num = (long)reader.ReadULong(); + // if ((num & 1L) != 0L) + // { + // GeneratedSyncVarDeserialize_GameObject(reader, ref target, OnChangedNB, ref ___targetNetId); + // } + // } + public void GeneratedSyncVarDeserialize_GameObject(ref GameObject field, Action OnChanged, NetworkReader reader, ref uint netIdField) + { + uint previousNetId = netIdField; + GameObject previousGameObject = field; + netIdField = reader.ReadUInt(); + + // get the new GameObject now that netId field is set + field = GetSyncVarGameObject(netIdField, ref field); + + // any hook? then call if changed. + if (OnChanged != null && !SyncVarEqual(previousNetId, ref netIdField)) + { + OnChanged(previousGameObject, field); + } + } + + // move the [SyncVar] generated OnDeserialize C# to avoid much IL. + // + // before: + // public override void DeserializeSyncVars(NetworkReader reader, bool initialState) + // { + // base.DeserializeSyncVars(reader, initialState); + // if (initialState) + // { + // uint __targetNetId = ___targetNetId; + // NetworkIdentity networktarget = Networktarget; + // ___targetNetId = reader.ReadUInt(); + // if (!NetworkBehaviour.SyncVarEqual(__targetNetId, ref ___targetNetId)) + // { + // OnChangedNI(networktarget, Networktarget); + // } + // return; + // } + // long num = (long)reader.ReadULong(); + // if ((num & 1L) != 0L) + // { + // uint __targetNetId2 = ___targetNetId; + // NetworkIdentity networktarget2 = Networktarget; + // ___targetNetId = reader.ReadUInt(); + // if (!NetworkBehaviour.SyncVarEqual(__targetNetId2, ref ___targetNetId)) + // { + // OnChangedNI(networktarget2, Networktarget); + // } + // } + // } + // + // after: + // + // public override void DeserializeSyncVars(NetworkReader reader, bool initialState) + // { + // base.DeserializeSyncVars(reader, initialState); + // if (initialState) + // { + // GeneratedSyncVarDeserialize_NetworkIdentity(reader, ref target, OnChangedNI, ref ___targetNetId); + // return; + // } + // long num = (long)reader.ReadULong(); + // if ((num & 1L) != 0L) + // { + // GeneratedSyncVarDeserialize_NetworkIdentity(reader, ref target, OnChangedNI, ref ___targetNetId); + // } + // } + public void GeneratedSyncVarDeserialize_NetworkIdentity(ref NetworkIdentity field, Action OnChanged, NetworkReader reader, ref uint netIdField) + { + uint previousNetId = netIdField; + NetworkIdentity previousIdentity = field; + netIdField = reader.ReadUInt(); + + // get the new NetworkIdentity now that netId field is set + field = GetSyncVarNetworkIdentity(netIdField, ref field); + + // any hook? then call if changed. + if (OnChanged != null && !SyncVarEqual(previousNetId, ref netIdField)) + { + OnChanged(previousIdentity, field); + } + } + + // move the [SyncVar] generated OnDeserialize C# to avoid much IL. + // + // before: + // + // public override void DeserializeSyncVars(NetworkReader reader, bool initialState) + // { + // base.DeserializeSyncVars(reader, initialState); + // if (initialState) + // { + // NetworkBehaviourSyncVar __targetNetId = ___targetNetId; + // Tank networktarget = Networktarget; + // ___targetNetId = reader.ReadNetworkBehaviourSyncVar(); + // if (!NetworkBehaviour.SyncVarEqual(__targetNetId, ref ___targetNetId)) + // { + // OnChangedNB(networktarget, Networktarget); + // } + // return; + // } + // long num = (long)reader.ReadULong(); + // if ((num & 1L) != 0L) + // { + // NetworkBehaviourSyncVar __targetNetId2 = ___targetNetId; + // Tank networktarget2 = Networktarget; + // ___targetNetId = reader.ReadNetworkBehaviourSyncVar(); + // if (!NetworkBehaviour.SyncVarEqual(__targetNetId2, ref ___targetNetId)) + // { + // OnChangedNB(networktarget2, Networktarget); + // } + // } + // } + // + // after: + // + // public override void DeserializeSyncVars(NetworkReader reader, bool initialState) + // { + // base.DeserializeSyncVars(reader, initialState); + // if (initialState) + // { + // GeneratedSyncVarDeserialize_NetworkBehaviour(reader, ref target, OnChangedNB, ref ___targetNetId); + // return; + // } + // long num = (long)reader.ReadULong(); + // if ((num & 1L) != 0L) + // { + // GeneratedSyncVarDeserialize_NetworkBehaviour(reader, ref target, OnChangedNB, ref ___targetNetId); + // } + // } + public void GeneratedSyncVarDeserialize_NetworkBehaviour(ref T field, Action OnChanged, NetworkReader reader, ref NetworkBehaviourSyncVar netIdField) + where T : NetworkBehaviour + { + NetworkBehaviourSyncVar previousNetId = netIdField; + T previousBehaviour = field; + netIdField = reader.ReadNetworkBehaviourSyncVar(); + + // get the new NetworkBehaviour now that netId field is set + field = GetSyncVarNetworkBehaviour(netIdField, ref field); + + // any hook? then call if changed. + if (OnChanged != null && !SyncVarEqual(previousNetId, ref netIdField)) + { + OnChanged(previousBehaviour, field); + } + } + + // helper function for [SyncVar] NetworkIdentities. + // dirtyBit is a mask like 00010 + protected void SetSyncVarNetworkIdentity(NetworkIdentity newIdentity, ref NetworkIdentity identityField, ulong dirtyBit, ref uint netIdField) + { + if (GetSyncVarHookGuard(dirtyBit)) + return; + + uint newNetId = 0; + if (newIdentity != null) + { + newNetId = newIdentity.netId; + if (newNetId == 0) + { + Debug.LogWarning($"SetSyncVarNetworkIdentity NetworkIdentity {newIdentity} has a zero netId. Maybe it is not spawned yet?"); + } + } + + //Debug.Log($"SetSyncVarNetworkIdentity NetworkIdentity {GetType().Name} bit:{dirtyBit} netIdField:{netIdField} -> {newNetId}"); + SetSyncVarDirtyBit(dirtyBit); + netIdField = newNetId; + // assign new one on the server, and in case we ever need it on client too + identityField = newIdentity; + } + + // helper function for [SyncVar] NetworkIdentities. + // -> ref GameObject as second argument makes OnDeserialize processing easier + protected NetworkIdentity GetSyncVarNetworkIdentity(uint netId, ref NetworkIdentity identityField) + { + // server always uses the field + // if neither, fallback to original field + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3447 + if (isServer || !isClient) + { + return identityField; + } + + // client always looks up based on netId because objects might get in and out of range + // over and over again, which shouldn't null them forever + NetworkClient.spawned.TryGetValue(netId, out identityField); + return identityField; + } + + protected static bool SyncVarNetworkBehaviourEqual(T newBehaviour, NetworkBehaviourSyncVar syncField) where T : NetworkBehaviour + { + uint newNetId = 0; + byte newComponentIndex = 0; + if (newBehaviour != null) + { + newNetId = newBehaviour.netId; + newComponentIndex = newBehaviour.ComponentIndex; + if (newNetId == 0) + { + Debug.LogWarning($"SetSyncVarNetworkIdentity NetworkIdentity {newBehaviour} has a zero netId. Maybe it is not spawned yet?"); + } + } + + // netId changed? + return syncField.Equals(newNetId, newComponentIndex); + } + + // helper function for [SyncVar] NetworkIdentities. + // dirtyBit is a mask like 00010 + protected void SetSyncVarNetworkBehaviour(T newBehaviour, ref T behaviourField, ulong dirtyBit, ref NetworkBehaviourSyncVar syncField) where T : NetworkBehaviour + { + if (GetSyncVarHookGuard(dirtyBit)) + return; + + uint newNetId = 0; + byte componentIndex = 0; + if (newBehaviour != null) + { + newNetId = newBehaviour.netId; + componentIndex = newBehaviour.ComponentIndex; + if (newNetId == 0) + { + Debug.LogWarning($"{nameof(SetSyncVarNetworkBehaviour)} NetworkIdentity {newBehaviour} has a zero netId. Maybe it is not spawned yet?"); + } + } + + syncField = new NetworkBehaviourSyncVar(newNetId, componentIndex); + + SetSyncVarDirtyBit(dirtyBit); + + // assign new one on the server, and in case we ever need it on client too + behaviourField = newBehaviour; + + // Debug.Log($"SetSyncVarNetworkBehaviour NetworkIdentity {GetType().Name} bit [{dirtyBit}] netIdField:{oldField}->{syncField}"); + } + + // helper function for [SyncVar] NetworkIdentities. + // -> ref GameObject as second argument makes OnDeserialize processing easier + protected T GetSyncVarNetworkBehaviour(NetworkBehaviourSyncVar syncNetBehaviour, ref T behaviourField) where T : NetworkBehaviour + { + // server always uses the field + // if neither, fallback to original field + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3447 + if (isServer || !isClient) + { + return behaviourField; + } + + // client always looks up based on netId because objects might get in and out of range + // over and over again, which shouldn't null them forever + if (!NetworkClient.spawned.TryGetValue(syncNetBehaviour.netId, out NetworkIdentity identity)) + { + return null; + } + + behaviourField = identity.NetworkBehaviours[syncNetBehaviour.componentIndex] as T; + return behaviourField; + } + + protected static bool SyncVarEqual(T value, ref T fieldValue) + { + // newly initialized or changed value? + // value.Equals(fieldValue) allocates without 'where T : IEquatable' + // seems like we use EqualityComparer to avoid allocations, + // because not all SyncVars are IEquatable + return EqualityComparer.Default.Equals(value, fieldValue); + } + + // dirtyBit is a mask like 00010 + protected void SetSyncVar(T value, ref T fieldValue, ulong dirtyBit) + { + //Debug.Log($"SetSyncVar {GetType().Name} bit:{dirtyBit} fieldValue:{value}"); + SetSyncVarDirtyBit(dirtyBit); + fieldValue = value; + } + + /// Override to do custom serialization (instead of SyncVars/SyncLists). Use OnDeserialize too. + // if a class has syncvars, then OnSerialize/OnDeserialize are added + // automatically. + // + // initialState is true for full spawns, false for delta syncs. + // note: SyncVar hooks are only called when inital=false + public virtual void OnSerialize(NetworkWriter writer, bool initialState) + { + SerializeSyncObjects(writer, initialState); + SerializeSyncVars(writer, initialState); + } + + /// Override to do custom deserialization (instead of SyncVars/SyncLists). Use OnSerialize too. + public virtual void OnDeserialize(NetworkReader reader, bool initialState) + { + DeserializeSyncObjects(reader, initialState); + DeserializeSyncVars(reader, initialState); + } + + void SerializeSyncObjects(NetworkWriter writer, bool initialState) + { + // if initialState: write all SyncVars. + // otherwise write dirtyBits+dirty SyncVars + if (initialState) + SerializeObjectsAll(writer); + else + SerializeObjectsDelta(writer); + } + + void DeserializeSyncObjects(NetworkReader reader, bool initialState) + { + if (initialState) + { + DeserializeObjectsAll(reader); + } + else + { + DeserializeObjectsDelta(reader); + } + } + + // USED BY WEAVER + protected virtual void SerializeSyncVars(NetworkWriter writer, bool initialState) + { + // SyncVar are written here in subclass + + // if initialState + // write all SyncVars + // else + // write syncVarDirtyBits + // write dirty SyncVars + } + + // USED BY WEAVER + protected virtual void DeserializeSyncVars(NetworkReader reader, bool initialState) + { + // SyncVars are read here in subclass + + // if initialState + // read all SyncVars + // else + // read syncVarDirtyBits + // read dirty SyncVars + } + + public void SerializeObjectsAll(NetworkWriter writer) + { + for (int i = 0; i < syncObjects.Count; i++) + { + SyncObject syncObject = syncObjects[i]; + syncObject.OnSerializeAll(writer); + } + } + + public void SerializeObjectsDelta(NetworkWriter writer) + { + // write the mask + writer.WriteULong(syncObjectDirtyBits); + + // serializable objects, such as synclists + for (int i = 0; i < syncObjects.Count; i++) + { + // check dirty mask at nth bit + SyncObject syncObject = syncObjects[i]; + if ((syncObjectDirtyBits & (1UL << i)) != 0) + { + syncObject.OnSerializeDelta(writer); + } + } + } + + internal void DeserializeObjectsAll(NetworkReader reader) + { + for (int i = 0; i < syncObjects.Count; i++) + { + SyncObject syncObject = syncObjects[i]; + syncObject.OnDeserializeAll(reader); + } + } + + internal void DeserializeObjectsDelta(NetworkReader reader) + { + ulong dirty = reader.ReadULong(); + for (int i = 0; i < syncObjects.Count; i++) + { + // check dirty mask at nth bit + SyncObject syncObject = syncObjects[i]; + if ((dirty & (1UL << i)) != 0) + { + syncObject.OnDeserializeDelta(reader); + } + } + } + + // safely serialize each component in a way that one reading too much or + // too few bytes will show obvious, easy to resolve error messages. + // + // prevents the original UNET bug which started Mirror: + // https://github.com/vis2k/Mirror/issues/2617 + // where one component would read too much, and then all following reads + // on other entities would be mismatched, causing the weirdest errors. + // + // reads <> for 100% safety. + internal void Serialize(NetworkWriter writer, bool initialState) + { + // reserve length header to ensure the correct amount will be read. + // originally we used a 4 byte header (too bandwidth heavy). + // instead, let's "& 0xFF" the size. + // + // this is cleaner than barriers at the end of payload, because: + // - ensures the correct safety is read _before_ payload. + // - it's quite hard to break the check. + // a component would need to read/write the intented amount + // multiplied by 255 in order to miss the check. + // with barriers, reading 1 byte too much may still succeed if the + // next component's first byte matches the expected barrier. + // - we can still attempt to correct the invalid position via the + // safety length byte (we know that one is correct). + // + // it's just overall cleaner, and still low on bandwidth. + + // write placeholder length byte + // (jumping back later is WAY faster than allocating a temporary + // writer for the payload, then writing payload.size, payload) + int headerPosition = writer.Position; + writer.WriteByte(0); + int contentPosition = writer.Position; + + // write payload + try + { + // note this may not write anything if no syncIntervals elapsed + OnSerialize(writer, initialState); + } + catch (Exception e) + { + // show a detailed error and let the user know what went wrong + Debug.LogError($"OnSerialize failed for: object={name} component={GetType()} sceneId={netIdentity.sceneId:X}\n\n{e}"); + } + int endPosition = writer.Position; + + // fill in length hash as the last byte of the 4 byte length + writer.Position = headerPosition; + int size = endPosition - contentPosition; + byte safety = (byte)(size & 0xFF); + writer.WriteByte(safety); + writer.Position = endPosition; + + //Debug.Log($"OnSerializeSafely written for object {name} component:{GetType()} sceneId:{sceneId:X} header:{headerPosition} content:{contentPosition} end:{endPosition} contentSize:{endPosition - contentPosition}"); + } + + // correct the read size with the 1 byte length hash (by mischa). + // -> the component most likely read a few too many/few bytes. + // -> we know the correct last byte of the expected size (=the safety). + // -> attempt to reconstruct the size via safety byte. + // it will be correct unless someone wrote way way too much, + // as in > 255 bytes worth too much. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + internal static int ErrorCorrection(int size, byte safety) + { + // clear the last byte which most likely contains the error + uint cleared = (uint)size & 0xFFFFFF00; + + // insert the safety which we know to be correct + return (int)(cleared | safety); + } + + // returns false in case of errors. + // server needs to know in order to disconnect on error. + internal bool Deserialize(NetworkReader reader, bool initialState) + { + // detect errors, but attempt to correct before returning + bool result = true; + + // read 1 byte length hash safety & capture beginning for size check + byte safety = reader.ReadByte(); + int chunkStart = reader.Position; + + // call OnDeserialize and wrap it in a try-catch block so there's no + // way to mess up another component's deserialization + try + { + //Debug.Log($"OnDeserializeSafely: {name} component:{GetType()} sceneId:{sceneId:X} length:{contentSize}"); + OnDeserialize(reader, initialState); + } + catch (Exception e) + { + // show a detailed error and let the user know what went wrong + Debug.LogError($"OnDeserialize failed Exception={e.GetType()} (see below) object={name} component={GetType()} netId={netId}. Possible Reasons:\n" + + $" * Do {GetType()}'s OnSerialize and OnDeserialize calls write the same amount of data? \n" + + $" * Was there an exception in {GetType()}'s OnSerialize/OnDeserialize code?\n" + + $" * Are the server and client the exact same project?\n" + + $" * Maybe this OnDeserialize call was meant for another GameObject? The sceneIds can easily get out of sync if the Hierarchy was modified only in the client OR the server. Try rebuilding both.\n\n" + + $"Exception {e}"); + result = false; + } + + // compare bytes read with length hash + int size = reader.Position - chunkStart; + byte sizeHash = (byte)(size & 0xFF); + if (sizeHash != safety) + { + // warn the user. + Debug.LogWarning($"{name} (netId={netId}): {GetType()} OnDeserialize size mismatch. It read {size} bytes, which caused a size hash mismatch of {sizeHash:X2} vs. {safety:X2}. Make sure that OnSerialize and OnDeserialize write/read the same amount of data in all cases."); + + // attempt to fix the position, so the following components + // don't all fail. this is very likely to work, unless the user + // read more than 255 bytes too many / too few. + // + // see test: SerializationSizeMismatch. + int correctedSize = ErrorCorrection(size, safety); + reader.Position = chunkStart + correctedSize; + result = false; + } + + return result; + } + + internal void ResetSyncObjects() + { + foreach (SyncObject syncObject in syncObjects) + { + syncObject.Reset(); + } + } + + /// Like Start(), but only called on server and host. + public virtual void OnStartServer() {} + + /// Stop event, only called on server and host. + public virtual void OnStopServer() {} + + /// Like Start(), but only called on client and host. + public virtual void OnStartClient() {} + + /// Stop event, only called on client and host. + public virtual void OnStopClient() {} + + /// Like Start(), but only called on client and host for the local player object. + public virtual void OnStartLocalPlayer() {} + + /// Stop event, but only called on client and host for the local player object. + public virtual void OnStopLocalPlayer() {} + + /// Like Start(), but only called for objects the client has authority over. + public virtual void OnStartAuthority() {} + + /// Stop event, only called for objects the client has authority over. + public virtual void OnStopAuthority() {} + + // Weaver injects this into inheriting classes to return true. + // allows runtime & tests to check if a type was weaved. + [EditorBrowsable(EditorBrowsableState.Never)] + public virtual bool Weaved() => false; + } +} diff --git a/Assets/Mirror/Core/NetworkBehaviour.cs.meta b/Assets/Mirror/Core/NetworkBehaviour.cs.meta new file mode 100644 index 0000000..f0bc195 --- /dev/null +++ b/Assets/Mirror/Core/NetworkBehaviour.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 655ee8cba98594f70880da5cc4dc442d +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkBehaviourSyncVar.cs b/Assets/Mirror/Core/NetworkBehaviourSyncVar.cs new file mode 100644 index 0000000..e9ed726 --- /dev/null +++ b/Assets/Mirror/Core/NetworkBehaviourSyncVar.cs @@ -0,0 +1,33 @@ +using System; + +namespace Mirror +{ + // backing field for sync NetworkBehaviour + public struct NetworkBehaviourSyncVar : IEquatable + { + public uint netId; + // limited to 255 behaviours per identity + public byte componentIndex; + + public NetworkBehaviourSyncVar(uint netId, int componentIndex) : this() + { + this.netId = netId; + this.componentIndex = (byte)componentIndex; + } + + public bool Equals(NetworkBehaviourSyncVar other) + { + return other.netId == netId && other.componentIndex == componentIndex; + } + + public bool Equals(uint netId, int componentIndex) + { + return this.netId == netId && this.componentIndex == componentIndex; + } + + public override string ToString() + { + return $"[netId:{netId} compIndex:{componentIndex}]"; + } + } +} diff --git a/Assets/Mirror/Core/NetworkBehaviourSyncVar.cs.meta b/Assets/Mirror/Core/NetworkBehaviourSyncVar.cs.meta new file mode 100644 index 0000000..47e3893 --- /dev/null +++ b/Assets/Mirror/Core/NetworkBehaviourSyncVar.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b04fe7518657486089dfaf811db0b3ea +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkClient.cs b/Assets/Mirror/Core/NetworkClient.cs new file mode 100644 index 0000000..83b67b9 --- /dev/null +++ b/Assets/Mirror/Core/NetworkClient.cs @@ -0,0 +1,1725 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Mirror.RemoteCalls; +using UnityEngine; + +namespace Mirror +{ + public enum ConnectState + { + None, + // connecting between Connect() and OnTransportConnected() + Connecting, + Connected, + // disconnecting between Disconnect() and OnTransportDisconnected() + Disconnecting, + Disconnected + } + + /// NetworkClient with connection to server. + public static partial class NetworkClient + { + // time & value snapshot interpolation are separate. + // -> time is interpolated globally on NetworkClient / NetworkConnection + // -> value is interpolated per-component, i.e. NetworkTransform. + // however, both need to be on the same send interval. + // + // additionally, server & client need to use the same send interval. + // otherwise it's too easy to accidentally cause interpolation issues if + // a component sends with client.interval but interpolates with + // server.interval, etc. + public static int sendRate => NetworkServer.sendRate; + public static float sendInterval => sendRate < int.MaxValue ? 1f / sendRate : 0; // for 30 Hz, that's 33ms + static double lastSendTime; + + // message handlers by messageId + internal static readonly Dictionary handlers = + new Dictionary(); + + /// All spawned NetworkIdentities by netId. + // client sees OBSERVED spawned ones. + public static readonly Dictionary spawned = + new Dictionary(); + + /// Client's NetworkConnection to server. + public static NetworkConnection connection { get; internal set; } + + /// True if client is ready (= joined world). + // TODO redundant state. point it to .connection.isReady instead (& test) + // TODO OR remove NetworkConnection.isReady? unless it's used on server + // + // TODO maybe ClientState.Connected/Ready/AddedPlayer/etc.? + // way better for security if we can check states in callbacks + public static bool ready; + + /// NetworkIdentity of the localPlayer + public static NetworkIdentity localPlayer { get; internal set; } + + // NetworkClient state + internal static ConnectState connectState = ConnectState.None; + + /// active is true while a client is connecting/connected either as standalone or as host client. + // (= while the network is active) + public static bool active => connectState == ConnectState.Connecting || + connectState == ConnectState.Connected; + + /// active is true while the client is connected in host mode. + // naming consistent with NetworkServer.activeHost. + public static bool activeHost => connection is LocalConnectionToServer; + + /// Check if client is connecting (before connected). + public static bool isConnecting => connectState == ConnectState.Connecting; + + /// Check if client is connected (after connecting). + public static bool isConnected => connectState == ConnectState.Connected; + + // Deprecated 2022-12-12 + [Obsolete("NetworkClient.isHostClient was renamed to .activeHost to be more obvious")] + public static bool isHostClient => activeHost; + + // OnConnected / OnDisconnected used to be NetworkMessages that were + // invoked. this introduced a bug where external clients could send + // Connected/Disconnected messages over the network causing undefined + // behaviour. + // => public so that custom NetworkManagers can hook into it + public static Action OnConnectedEvent; + public static Action OnDisconnectedEvent; + public static Action OnErrorEvent; + + /// Registered spawnable prefabs by assetId. + public static readonly Dictionary prefabs = + new Dictionary(); + + // custom spawn / unspawn handlers by assetId. + // useful to support prefab pooling etc.: + // https://mirror-networking.gitbook.io/docs/guides/gameobjects/custom-spawnfunctions + internal static readonly Dictionary spawnHandlers = + new Dictionary(); + internal static readonly Dictionary unspawnHandlers = + new Dictionary(); + + // spawning + // internal for tests + internal static bool isSpawnFinished; + + // Disabled scene objects that can be spawned again, by sceneId. + internal static readonly Dictionary spawnableObjects = + new Dictionary(); + + internal static Unbatcher unbatcher = new Unbatcher(); + + // interest management component (optional) + // only needed for SetHostVisibility + public static InterestManagementBase aoi; + + // scene loading + public static bool isLoadingScene; + + // connection quality + // this is set by a virtual function in NetworkManager, + // which allows users to overwrite it with their own estimations. + public static ConnectionQuality connectionQuality = ConnectionQuality.ESTIMATING; + + // initialization ////////////////////////////////////////////////////// + static void AddTransportHandlers() + { + // community Transports may forget to call OnDisconnected. + // which could cause handlers to be added twice with +=. + // ensure we always clear the old ones first. + // fixes: https://github.com/vis2k/Mirror/issues/3152 + RemoveTransportHandlers(); + + // += so that other systems can also hook into it (i.e. statistics) + Transport.active.OnClientConnected += OnTransportConnected; + Transport.active.OnClientDataReceived += OnTransportData; + Transport.active.OnClientDisconnected += OnTransportDisconnected; + Transport.active.OnClientError += OnTransportError; + } + + static void RemoveTransportHandlers() + { + // -= so that other systems can also hook into it (i.e. statistics) + Transport.active.OnClientConnected -= OnTransportConnected; + Transport.active.OnClientDataReceived -= OnTransportData; + Transport.active.OnClientDisconnected -= OnTransportDisconnected; + Transport.active.OnClientError -= OnTransportError; + } + + // connect ///////////////////////////////////////////////////////////// + // initialize is called before every connect + static void Initialize(bool hostMode) + { + // safety: ensure Weaving succeded. + // if it silently failed, we would get lots of 'writer not found' + // and other random errors at runtime instead. this is cleaner. + if (!WeaverFuse.Weaved()) + { + // if it failed, throw an exception to early exit all Connect calls. + throw new Exception("NetworkClient won't start because Weaving failed or didn't run."); + } + + // Debug.Log($"Client Connect: {address}"); + Debug.Assert(Transport.active != null, "There was no active transport when calling NetworkClient.Connect, If you are calling Connect manually then make sure to set 'Transport.active' first"); + + // reset unbatcher in case any batches from last session remain. + // need to do this in Initialize() so it runs for the host as well. + // fixes host mode scene transition receiving data from previous scene. + // credits: BigBoxVR + unbatcher = new Unbatcher(); + + // reset time interpolation on every new connect. + // ensures last sessions' state is cleared before starting again. + InitTimeInterpolation(); + + RegisterMessageHandlers(hostMode); + Transport.active.enabled = true; + } + + /// Connect client to a NetworkServer by address. + public static void Connect(string address) + { + Initialize(false); + + AddTransportHandlers(); + connectState = ConnectState.Connecting; + Transport.active.ClientConnect(address); + connection = new NetworkConnectionToServer(); + } + + /// Connect client to a NetworkServer by Uri. + public static void Connect(Uri uri) + { + Initialize(false); + + AddTransportHandlers(); + connectState = ConnectState.Connecting; + Transport.active.ClientConnect(uri); + connection = new NetworkConnectionToServer(); + } + + // TODO why are there two connect host methods? + // called from NetworkManager.FinishStartHost() + public static void ConnectHost() + { + Initialize(true); + connectState = ConnectState.Connected; + HostMode.SetupConnections(); + } + + // Deprecated 2022-12-12 + [Obsolete("NetworkClient.ConnectLocalServer was moved to HostMode.InvokeOnConnected")] + public static void ConnectLocalServer() => HostMode.InvokeOnConnected(); + + // disconnect ////////////////////////////////////////////////////////// + /// Disconnect from server. + public static void Disconnect() + { + // only if connected or connecting. + // don't disconnect() again if already in the process of + // disconnecting or fully disconnected. + if (connectState != ConnectState.Connecting && + connectState != ConnectState.Connected) + return; + + // we are disconnecting until OnTransportDisconnected is called. + // setting state to Disconnected would stop OnTransportDisconnected + // from calling cleanup code because it would think we are already + // disconnected fully. + // TODO move to 'cleanup' code below if safe + connectState = ConnectState.Disconnecting; + ready = false; + + // call Disconnect on the NetworkConnection + connection?.Disconnect(); + + // IMPORTANT: do NOT clear connection here yet. + // we still need it in OnTransportDisconnected for callbacks. + // connection = null; + } + + // transport events //////////////////////////////////////////////////// + // called by Transport + static void OnTransportConnected() + { + if (connection != null) + { + // reset network time stats + NetworkTime.ResetStatics(); + + // the handler may want to send messages to the client + // thus we should set the connected state before calling the handler + connectState = ConnectState.Connected; + NetworkTime.UpdateClient(); + OnConnectedEvent?.Invoke(); + } + else Debug.LogError("Skipped Connect message handling because connection is null."); + } + + // helper function + static bool UnpackAndInvoke(NetworkReader reader, int channelId) + { + if (NetworkMessages.UnpackId(reader, out ushort msgType)) + { + // try to invoke the handler for that message + if (handlers.TryGetValue(msgType, out NetworkMessageDelegate handler)) + { + handler.Invoke(connection, reader, channelId); + + // message handler may disconnect client, making connection = null + // therefore must check for null to avoid NRE. + if (connection != null) + connection.lastMessageTime = Time.time; + + return true; + } + else + { + // message in a batch are NOT length prefixed to save bandwidth. + // every message needs to be handled and read until the end. + // otherwise it would overlap into the next message. + // => need to warn and disconnect to avoid undefined behaviour. + // => WARNING, not error. can happen if attacker sends random data. + Debug.LogWarning($"Unknown message id: {msgType}. This can happen if no handler was registered for this message."); + // simply return false. caller is responsible for disconnecting. + //connection.Disconnect(); + return false; + } + } + else + { + // => WARNING, not error. can happen if attacker sends random data. + Debug.LogWarning("Invalid message header."); + // simply return false. caller is responsible for disconnecting. + //connection.Disconnect(); + return false; + } + } + + // called by Transport + internal static void OnTransportData(ArraySegment data, int channelId) + { + if (connection != null) + { + // server might batch multiple messages into one packet. + // feed it to the Unbatcher. + // NOTE: we don't need to associate a channelId because we + // always process all messages in the batch. + if (!unbatcher.AddBatch(data)) + { + Debug.LogWarning($"NetworkClient: failed to add batch, disconnecting."); + connection.Disconnect(); + return; + } + + // process all messages in the batch. + // only while NOT loading a scene. + // if we get a scene change message, then we need to stop + // processing. otherwise we might apply them to the old scene. + // => fixes https://github.com/vis2k/Mirror/issues/2651 + // + // NOTE: is scene starts loading, then the rest of the batch + // would only be processed when OnTransportData is called + // the next time. + // => consider moving processing to NetworkEarlyUpdate. + while (!isLoadingScene && + unbatcher.GetNextMessage(out ArraySegment message, out double remoteTimestamp)) + { + using (NetworkReaderPooled reader = NetworkReaderPool.Get(message)) + { + // enough to read at least header size? + if (reader.Remaining >= NetworkMessages.IdSize) + { + // make remoteTimeStamp available to the user + connection.remoteTimeStamp = remoteTimestamp; + + // handle message + if (!UnpackAndInvoke(reader, channelId)) + { + // warn, disconnect and return if failed + // -> warning because attackers might send random data + // -> messages in a batch aren't length prefixed. + // failing to read one would cause undefined + // behaviour for every message afterwards. + // so we need to disconnect. + // -> return to avoid the below unbatches.count error. + // we already disconnected and handled it. + Debug.LogWarning($"NetworkClient: failed to unpack and invoke message. Disconnecting."); + connection.Disconnect(); + return; + } + } + // otherwise disconnect + else + { + // WARNING, not error. can happen if attacker sends random data. + Debug.LogWarning($"NetworkClient: received Message was too short (messages should start with message id)"); + connection.Disconnect(); + return; + } + } + } + + // if we weren't interrupted by a scene change, + // then all batched messages should have been processed now. + // if not, we need to log an error to avoid debugging hell. + // otherwise batches would silently grow. + // we need to log an error to avoid debugging hell. + // + // EXAMPLE: https://github.com/vis2k/Mirror/issues/2882 + // -> UnpackAndInvoke silently returned because no handler for id + // -> Reader would never be read past the end + // -> Batch would never be retired because end is never reached + // + // NOTE: prefixing every message in a batch with a length would + // avoid ever not reading to the end. for extra bandwidth. + // + // IMPORTANT: always keep this check to detect memory leaks. + // this took half a day to debug last time. + if (!isLoadingScene && unbatcher.BatchesCount > 0) + { + Debug.LogError($"Still had {unbatcher.BatchesCount} batches remaining after processing, even though processing was not interrupted by a scene change. This should never happen, as it would cause ever growing batches.\nPossible reasons:\n* A message didn't deserialize as much as it serialized\n*There was no message handler for a message id, so the reader wasn't read until the end."); + } + } + else Debug.LogError("Skipped Data message handling because connection is null."); + } + + // called by Transport + // IMPORTANT: often times when disconnecting, we call this from Mirror + // too because we want to remove the connection and handle + // the disconnect immediately. + // => which is fine as long as we guarantee it only runs once + // => which we do by setting the state to Disconnected! + internal static void OnTransportDisconnected() + { + // StopClient called from user code triggers Disconnected event + // from transport which calls StopClient again, so check here + // and short circuit running the Shutdown process twice. + if (connectState == ConnectState.Disconnected) return; + + // Raise the event before changing ConnectState + // because 'active' depends on this during shutdown + // + // previously OnDisconnected was only invoked if connection != null. + // however, if DNS resolve fails in Transport.Connect(), + // OnDisconnected would never be called because 'connection' is only + // created after the Transport.Connect() call. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3365 + OnDisconnectedEvent?.Invoke(); + + connectState = ConnectState.Disconnected; + ready = false; + snapshots.Clear(); + localTimeline = 0; + + // now that everything was handled, clear the connection. + // previously this was done in Disconnect() already, but we still + // need it for the above OnDisconnectedEvent. + connection = null; + + // transport handlers are only added when connecting. + // so only remove when actually disconnecting. + RemoveTransportHandlers(); + } + + // transport errors are forwarded to high level + static void OnTransportError(TransportError error, string reason) + { + // transport errors will happen. logging a warning is enough. + // make sure the user does not panic. + Debug.LogWarning($"Client Transport Error: {error}: {reason}. This is fine."); + OnErrorEvent?.Invoke(error, reason); + } + + // send //////////////////////////////////////////////////////////////// + /// Send a NetworkMessage to the server over the given channel. + public static void Send(T message, int channelId = Channels.Reliable) + where T : struct, NetworkMessage + { + if (connection != null) + { + if (connectState == ConnectState.Connected) + { + connection.Send(message, channelId); + } + else Debug.LogError("NetworkClient Send when not connected to a server"); + } + else Debug.LogError("NetworkClient Send with no connection"); + } + + // message handlers //////////////////////////////////////////////////// + internal static void RegisterMessageHandlers(bool hostMode) + { + // host mode client / remote client react to some messages differently. + // but we still need to add handlers for all of them to avoid + // 'message id not found' errors. + if (hostMode) + { + RegisterHandler(OnHostClientObjectDestroy); + RegisterHandler(OnHostClientObjectHide); + RegisterHandler(_ => { }, false); + RegisterHandler(OnHostClientSpawn); + // host mode doesn't need spawning + RegisterHandler(_ => { }); + // host mode doesn't need spawning + RegisterHandler(_ => { }); + // host mode doesn't need state updates + RegisterHandler(_ => { }); + } + else + { + RegisterHandler(OnObjectDestroy); + RegisterHandler(OnObjectHide); + RegisterHandler(NetworkTime.OnClientPong, false); + RegisterHandler(NetworkTime.OnClientPing, false); + RegisterHandler(OnSpawn); + RegisterHandler(OnObjectSpawnStarted); + RegisterHandler(OnObjectSpawnFinished); + RegisterHandler(OnEntityStateMessage); + } + + // These handlers are the same for host and remote clients + RegisterHandler(OnTimeSnapshotMessage); + RegisterHandler(OnChangeOwner); + RegisterHandler(OnRPCMessage); + } + + /// Register a handler for a message type T. Most should require authentication. + public static void RegisterHandler(Action handler, bool requireAuthentication = true) + where T : struct, NetworkMessage + { + ushort msgType = NetworkMessageId.Id; + if (handlers.ContainsKey(msgType)) + { + Debug.LogWarning($"NetworkClient.RegisterHandler replacing handler for {typeof(T).FullName}, id={msgType}. If replacement is intentional, use ReplaceHandler instead to avoid this warning."); + } + + // register Id <> Type in lookup for debugging. + NetworkMessages.Lookup[msgType] = typeof(T); + + // we use the same WrapHandler function for server and client. + // so let's wrap it to ignore the NetworkConnection parameter. + // it's not needed on client. it's always NetworkClient.connection. + void HandlerWrapped(NetworkConnection _, T value) => handler(value); + handlers[msgType] = NetworkMessages.WrapHandler((Action)HandlerWrapped, requireAuthentication); + } + + /// Replace a handler for a particular message type. Should require authentication by default. + // RegisterHandler throws a warning (as it should) if a handler is assigned twice + // Use of ReplaceHandler makes it clear the user intended to replace the handler + public static void ReplaceHandler(Action handler, bool requireAuthentication = true) + where T : struct, NetworkMessage + { + ushort msgType = NetworkMessageId.Id; + handlers[msgType] = NetworkMessages.WrapHandler(handler, requireAuthentication); + } + + /// Replace a handler for a particular message type. Should require authentication by default. + // RegisterHandler throws a warning (as it should) if a handler is assigned twice + // Use of ReplaceHandler makes it clear the user intended to replace the handler + public static void ReplaceHandler(Action handler, bool requireAuthentication = true) + where T : struct, NetworkMessage + { + ReplaceHandler((NetworkConnection _, T value) => { handler(value); }, requireAuthentication); + } + + /// Unregister a message handler of type T. + public static bool UnregisterHandler() + where T : struct, NetworkMessage + { + // use int to minimize collisions + ushort msgType = NetworkMessageId.Id; + return handlers.Remove(msgType); + } + + // spawnable prefabs /////////////////////////////////////////////////// + /// Find the registered prefab for this asset id. + // Useful for debuggers + public static bool GetPrefab(uint assetId, out GameObject prefab) + { + prefab = null; + return assetId != 0 && + prefabs.TryGetValue(assetId, out prefab) && + prefab != null; + } + + /// Validates Prefab then adds it to prefabs dictionary. + static void RegisterPrefabIdentity(NetworkIdentity prefab) + { + if (prefab.assetId == 0) + { + Debug.LogError($"Can not Register '{prefab.name}' because it had empty assetid. If this is a scene Object use RegisterSpawnHandler instead"); + return; + } + + if (prefab.sceneId != 0) + { + Debug.LogError($"Can not Register '{prefab.name}' because it has a sceneId, make sure you are passing in the original prefab and not an instance in the scene."); + return; + } + + // disallow child NetworkIdentities. + // TODO likely not necessary anymore due to the new check in + // NetworkIdentity.OnValidate. + NetworkIdentity[] identities = prefab.GetComponentsInChildren(); + if (identities.Length > 1) + { + Debug.LogError($"Prefab '{prefab.name}' has multiple NetworkIdentity components. There should only be one NetworkIdentity on a prefab, and it must be on the root object."); + } + + if (prefabs.ContainsKey(prefab.assetId)) + { + GameObject existingPrefab = prefabs[prefab.assetId]; + Debug.LogWarning($"Replacing existing prefab with assetId '{prefab.assetId}'. Old prefab '{existingPrefab.name}', New prefab '{prefab.name}'"); + } + + if (spawnHandlers.ContainsKey(prefab.assetId) || unspawnHandlers.ContainsKey(prefab.assetId)) + { + Debug.LogWarning($"Adding prefab '{prefab.name}' with assetId '{prefab.assetId}' when spawnHandlers with same assetId already exists. If you want to use custom spawn handling, then remove the prefab from NetworkManager's registered prefabs first."); + } + + // Debug.Log($"Registering prefab '{prefab.name}' as asset:{prefab.assetId}"); + + prefabs[prefab.assetId] = prefab.gameObject; + } + + /// Register spawnable prefab with custom assetId. + // Note: newAssetId can not be set on GameObjects that already have an assetId + // Note: registering with assetId is useful for assetbundles etc. a lot + // of people use this. + public static void RegisterPrefab(GameObject prefab, uint newAssetId) + { + if (prefab == null) + { + Debug.LogError("Could not register prefab because it was null"); + return; + } + + if (newAssetId == 0) + { + Debug.LogError($"Could not register '{prefab.name}' with new assetId because the new assetId was empty"); + return; + } + + if (!prefab.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError($"Could not register '{prefab.name}' since it contains no NetworkIdentity component"); + return; + } + + if (identity.assetId != 0 && identity.assetId != newAssetId) + { + Debug.LogError($"Could not register '{prefab.name}' to {newAssetId} because it already had an AssetId, Existing assetId {identity.assetId}"); + return; + } + + identity.assetId = newAssetId; + + RegisterPrefabIdentity(identity); + } + + /// Register spawnable prefab. + public static void RegisterPrefab(GameObject prefab) + { + if (prefab == null) + { + Debug.LogError("Could not register prefab because it was null"); + return; + } + + if (!prefab.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError($"Could not register '{prefab.name}' since it contains no NetworkIdentity component"); + return; + } + + RegisterPrefabIdentity(identity); + } + + /// Register a spawnable prefab with custom assetId and custom spawn/unspawn handlers. + // Note: newAssetId can not be set on GameObjects that already have an assetId + // Note: registering with assetId is useful for assetbundles etc. a lot + // of people use this. + // TODO why do we have one with SpawnDelegate and one with SpawnHandlerDelegate? + public static void RegisterPrefab(GameObject prefab, uint newAssetId, SpawnDelegate spawnHandler, UnSpawnDelegate unspawnHandler) + { + // We need this check here because we don't want a null handler in the lambda expression below + if (spawnHandler == null) + { + Debug.LogError($"Can not Register null SpawnHandler for {newAssetId}"); + return; + } + + RegisterPrefab(prefab, newAssetId, msg => spawnHandler(msg.position, msg.assetId), unspawnHandler); + } + + /// Register a spawnable prefab with custom spawn/unspawn handlers. + // TODO why do we have one with SpawnDelegate and one with SpawnHandlerDelegate? + public static void RegisterPrefab(GameObject prefab, SpawnDelegate spawnHandler, UnSpawnDelegate unspawnHandler) + { + if (prefab == null) + { + Debug.LogError("Could not register handler for prefab because the prefab was null"); + return; + } + + if (!prefab.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError($"Could not register handler for '{prefab.name}' since it contains no NetworkIdentity component"); + return; + } + + if (identity.sceneId != 0) + { + Debug.LogError($"Can not Register '{prefab.name}' because it has a sceneId, make sure you are passing in the original prefab and not an instance in the scene."); + return; + } + + if (identity.assetId == 0) + { + Debug.LogError($"Can not Register handler for '{prefab.name}' because it had empty assetid. If this is a scene Object use RegisterSpawnHandler instead"); + return; + } + + // We need this check here because we don't want a null handler in the lambda expression below + if (spawnHandler == null) + { + Debug.LogError($"Can not Register null SpawnHandler for {identity.assetId}"); + return; + } + + RegisterPrefab(prefab, msg => spawnHandler(msg.position, msg.assetId), unspawnHandler); + } + + /// Register a spawnable prefab with custom assetId and custom spawn/unspawn handlers. + // Note: newAssetId can not be set on GameObjects that already have an assetId + // Note: registering with assetId is useful for assetbundles etc. a lot + // of people use this. + // TODO why do we have one with SpawnDelegate and one with SpawnHandlerDelegate? + public static void RegisterPrefab(GameObject prefab, uint newAssetId, SpawnHandlerDelegate spawnHandler, UnSpawnDelegate unspawnHandler) + { + if (newAssetId == 0) + { + Debug.LogError($"Could not register handler for '{prefab.name}' with new assetId because the new assetId was empty"); + return; + } + + if (prefab == null) + { + Debug.LogError("Could not register handler for prefab because the prefab was null"); + return; + } + + if (!prefab.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError($"Could not register handler for '{prefab.name}' since it contains no NetworkIdentity component"); + return; + } + + if (identity.assetId != 0 && identity.assetId != newAssetId) + { + Debug.LogError($"Could not register Handler for '{prefab.name}' to {newAssetId} because it already had an AssetId, Existing assetId {identity.assetId}"); + return; + } + + if (identity.sceneId != 0) + { + Debug.LogError($"Can not Register '{prefab.name}' because it has a sceneId, make sure you are passing in the original prefab and not an instance in the scene."); + return; + } + + identity.assetId = newAssetId; + uint assetId = identity.assetId; + + if (spawnHandler == null) + { + Debug.LogError($"Can not Register null SpawnHandler for {assetId}"); + return; + } + + if (unspawnHandler == null) + { + Debug.LogError($"Can not Register null UnSpawnHandler for {assetId}"); + return; + } + + if (spawnHandlers.ContainsKey(assetId) || unspawnHandlers.ContainsKey(assetId)) + { + Debug.LogWarning($"Replacing existing spawnHandlers for prefab '{prefab.name}' with assetId '{assetId}'"); + } + + if (prefabs.ContainsKey(assetId)) + { + // this is error because SpawnPrefab checks prefabs before handler + Debug.LogError($"assetId '{assetId}' is already used by prefab '{prefabs[assetId].name}', unregister the prefab first before trying to add handler"); + } + + NetworkIdentity[] identities = prefab.GetComponentsInChildren(); + if (identities.Length > 1) + { + Debug.LogError($"Prefab '{prefab.name}' has multiple NetworkIdentity components. There should only be one NetworkIdentity on a prefab, and it must be on the root object."); + } + + //Debug.Log($"Registering custom prefab {prefab.name} as asset:{assetId} {spawnHandler.GetMethodName()}/{unspawnHandler.GetMethodName()}"); + + spawnHandlers[assetId] = spawnHandler; + unspawnHandlers[assetId] = unspawnHandler; + } + + /// Register a spawnable prefab with custom spawn/unspawn handlers. + // TODO why do we have one with SpawnDelegate and one with SpawnHandlerDelegate? + public static void RegisterPrefab(GameObject prefab, SpawnHandlerDelegate spawnHandler, UnSpawnDelegate unspawnHandler) + { + if (prefab == null) + { + Debug.LogError("Could not register handler for prefab because the prefab was null"); + return; + } + + if (!prefab.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError($"Could not register handler for '{prefab.name}' since it contains no NetworkIdentity component"); + return; + } + + if (identity.sceneId != 0) + { + Debug.LogError($"Can not Register '{prefab.name}' because it has a sceneId, make sure you are passing in the original prefab and not an instance in the scene."); + return; + } + + uint assetId = identity.assetId; + + if (assetId == 0) + { + Debug.LogError($"Can not Register handler for '{prefab.name}' because it had empty assetid. If this is a scene Object use RegisterSpawnHandler instead"); + return; + } + + if (spawnHandler == null) + { + Debug.LogError($"Can not Register null SpawnHandler for {assetId}"); + return; + } + + if (unspawnHandler == null) + { + Debug.LogError($"Can not Register null UnSpawnHandler for {assetId}"); + return; + } + + if (spawnHandlers.ContainsKey(assetId) || unspawnHandlers.ContainsKey(assetId)) + { + Debug.LogWarning($"Replacing existing spawnHandlers for prefab '{prefab.name}' with assetId '{assetId}'"); + } + + if (prefabs.ContainsKey(assetId)) + { + // this is error because SpawnPrefab checks prefabs before handler + Debug.LogError($"assetId '{assetId}' is already used by prefab '{prefabs[assetId].name}', unregister the prefab first before trying to add handler"); + } + + NetworkIdentity[] identities = prefab.GetComponentsInChildren(); + if (identities.Length > 1) + { + Debug.LogError($"Prefab '{prefab.name}' has multiple NetworkIdentity components. There should only be one NetworkIdentity on a prefab, and it must be on the root object."); + } + + //Debug.Log($"Registering custom prefab {prefab.name} as asset:{assetId} {spawnHandler.GetMethodName()}/{unspawnHandler.GetMethodName()}"); + + spawnHandlers[assetId] = spawnHandler; + unspawnHandlers[assetId] = unspawnHandler; + } + + /// Removes a registered spawn prefab that was setup with NetworkClient.RegisterPrefab. + public static void UnregisterPrefab(GameObject prefab) + { + if (prefab == null) + { + Debug.LogError("Could not unregister prefab because it was null"); + return; + } + + if (!prefab.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError($"Could not unregister '{prefab.name}' since it contains no NetworkIdentity component"); + return; + } + + uint assetId = identity.assetId; + + prefabs.Remove(assetId); + spawnHandlers.Remove(assetId); + unspawnHandlers.Remove(assetId); + } + + // spawn handlers ////////////////////////////////////////////////////// + /// This is an advanced spawning function that registers a custom assetId with the spawning system. + // This can be used to register custom spawning methods for an assetId - + // instead of the usual method of registering spawning methods for a + // prefab. This should be used when no prefab exists for the spawned + // objects - such as when they are constructed dynamically at runtime + // from configuration data. + public static void RegisterSpawnHandler(uint assetId, SpawnDelegate spawnHandler, UnSpawnDelegate unspawnHandler) + { + // We need this check here because we don't want a null handler in the lambda expression below + if (spawnHandler == null) + { + Debug.LogError($"Can not Register null SpawnHandler for {assetId}"); + return; + } + + RegisterSpawnHandler(assetId, msg => spawnHandler(msg.position, msg.assetId), unspawnHandler); + } + + /// This is an advanced spawning function that registers a custom assetId with the spawning system. + // This can be used to register custom spawning methods for an assetId - + // instead of the usual method of registering spawning methods for a + // prefab. This should be used when no prefab exists for the spawned + // objects - such as when they are constructed dynamically at runtime + // from configuration data. + public static void RegisterSpawnHandler(uint assetId, SpawnHandlerDelegate spawnHandler, UnSpawnDelegate unspawnHandler) + { + if (spawnHandler == null) + { + Debug.LogError($"Can not Register null SpawnHandler for {assetId}"); + return; + } + + if (unspawnHandler == null) + { + Debug.LogError($"Can not Register null UnSpawnHandler for {assetId}"); + return; + } + + if (assetId == 0) + { + Debug.LogError("Can not Register SpawnHandler for empty assetId"); + return; + } + + if (spawnHandlers.ContainsKey(assetId) || unspawnHandlers.ContainsKey(assetId)) + { + Debug.LogWarning($"Replacing existing spawnHandlers for {assetId}"); + } + + if (prefabs.ContainsKey(assetId)) + { + // this is error because SpawnPrefab checks prefabs before handler + Debug.LogError($"assetId '{assetId}' is already used by prefab '{prefabs[assetId].name}'"); + } + + // Debug.Log("RegisterSpawnHandler asset {assetId} {spawnHandler.GetMethodName()}/{unspawnHandler.GetMethodName()}"); + + spawnHandlers[assetId] = spawnHandler; + unspawnHandlers[assetId] = unspawnHandler; + } + + /// Removes a registered spawn handler function that was registered with NetworkClient.RegisterHandler(). + public static void UnregisterSpawnHandler(uint assetId) + { + spawnHandlers.Remove(assetId); + unspawnHandlers.Remove(assetId); + } + + /// This clears the registered spawn prefabs and spawn handler functions for this client. + public static void ClearSpawners() + { + prefabs.Clear(); + spawnHandlers.Clear(); + unspawnHandlers.Clear(); + } + + internal static bool InvokeUnSpawnHandler(uint assetId, GameObject obj) + { + if (unspawnHandlers.TryGetValue(assetId, out UnSpawnDelegate handler) && handler != null) + { + handler(obj); + return true; + } + return false; + } + + // ready /////////////////////////////////////////////////////////////// + /// Sends Ready message to server, indicating that we loaded the scene, ready to enter the game. + // This could be for example when a client enters an ongoing game and + // has finished loading the current scene. The server should respond to + // the SYSTEM_READY event with an appropriate handler which instantiates + // the players object for example. + public static bool Ready() + { + // Debug.Log($"NetworkClient.Ready() called with connection {conn}"); + if (ready) + { + Debug.LogError("NetworkClient is already ready. It shouldn't be called twice."); + return false; + } + + // need a valid connection to become ready + if (connection == null) + { + Debug.LogError("Ready() called with invalid connection object: conn=null"); + return false; + } + + // Set these before sending the ReadyMessage, otherwise host client + // will fail in InternalAddPlayer with null readyConnection. + // TODO this is redundant. have one source of truth for .ready + ready = true; + connection.isReady = true; + + // Tell server we're ready to have a player object spawned + connection.Send(new ReadyMessage()); + return true; + } + + // add player ////////////////////////////////////////////////////////// + // called from message handler for Owner message + internal static void InternalAddPlayer(NetworkIdentity identity) + { + //Debug.Log("NetworkClient.InternalAddPlayer"); + + // NOTE: It can be "normal" when changing scenes for the player to be destroyed and recreated. + // But, the player structures are not cleaned up, we'll just replace the old player + localPlayer = identity; + + // NOTE: we DONT need to set isClient=true here, because OnStartClient + // is called before OnStartLocalPlayer, hence it's already set. + // localPlayer.isClient = true; + + // TODO this check might not be necessary + //if (readyConnection != null) + if (ready && connection != null) + { + connection.identity = identity; + } + else Debug.LogWarning("NetworkClient can't AddPlayer before being ready. Please call NetworkClient.Ready() first. Clients are considered ready after joining the game world."); + } + + /// Sends AddPlayer message to the server, indicating that we want to join the world. + public static bool AddPlayer() + { + // ensure valid ready connection + if (connection == null) + { + Debug.LogError("AddPlayer requires a valid NetworkClient.connection."); + return false; + } + + // UNET checked 'if readyConnection != null'. + // in other words, we need a connection and we need to be ready. + if (!ready) + { + Debug.LogError("AddPlayer requires a ready NetworkClient."); + return false; + } + + if (connection.identity != null) + { + Debug.LogError("NetworkClient.AddPlayer: a PlayerController was already added. Did you call AddPlayer twice?"); + return false; + } + + // Debug.Log($"NetworkClient.AddPlayer() called with connection {readyConnection}"); + connection.Send(new AddPlayerMessage()); + return true; + } + + // spawning //////////////////////////////////////////////////////////// + internal static void ApplySpawnPayload(NetworkIdentity identity, SpawnMessage message) + { + if (message.assetId != 0) + identity.assetId = message.assetId; + + if (!identity.gameObject.activeSelf) + { + identity.gameObject.SetActive(true); + } + + // apply local values for VR support + identity.transform.localPosition = message.position; + identity.transform.localRotation = message.rotation; + identity.transform.localScale = message.scale; + + // configure flags + // the below DeserializeClient call invokes SyncVarHooks. + // flags always need to be initialized before that. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3259 + identity.isOwned = message.isOwner; + identity.netId = message.netId; + + if (message.isLocalPlayer) + InternalAddPlayer(identity); + + // configure isClient/isLocalPlayer flags. + // => after InternalAddPlayer. can't initialize .isLocalPlayer + // before InternalAddPlayer sets .localPlayer + // => before DeserializeClient, otherwise SyncVar hooks wouldn't + // have isClient/isLocalPlayer set yet. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3259 + InitializeIdentityFlags(identity); + + // deserialize components if any payload + // (Count is 0 if there were no components) + if (message.payload.Count > 0) + { + using (NetworkReaderPooled payloadReader = NetworkReaderPool.Get(message.payload)) + { + identity.DeserializeClient(payloadReader, true); + } + } + + spawned[message.netId] = identity; + if (identity.isOwned) connection?.owned.Add(identity); + + // the initial spawn with OnObjectSpawnStarted/Finished calls all + // object's OnStartClient/OnStartLocalPlayer after they were all + // spawned. + // this only happens once though. + // for all future spawns, we need to call OnStartClient/LocalPlayer + // here immediately since there won't be another OnObjectSpawnFinished. + if (isSpawnFinished) + { + InvokeIdentityCallbacks(identity); + } + } + + // Finds Existing Object with NetId or spawns a new one using AssetId or sceneId + internal static bool FindOrSpawnObject(SpawnMessage message, out NetworkIdentity identity) + { + // was the object already spawned? + identity = GetExistingObject(message.netId); + + // if found, return early + if (identity != null) + { + return true; + } + + if (message.assetId == 0 && message.sceneId == 0) + { + Debug.LogError($"OnSpawn message with netId '{message.netId}' has no AssetId or sceneId"); + return false; + } + + identity = message.sceneId == 0 ? SpawnPrefab(message) : SpawnSceneObject(message.sceneId); + + if (identity == null) + { + Debug.LogError($"Could not spawn assetId={message.assetId} scene={message.sceneId:X} netId={message.netId}"); + return false; + } + + return true; + } + + static NetworkIdentity GetExistingObject(uint netid) + { + spawned.TryGetValue(netid, out NetworkIdentity identity); + return identity; + } + + static NetworkIdentity SpawnPrefab(SpawnMessage message) + { + // custom spawn handler for this prefab? (for prefab pools etc.) + // + // IMPORTANT: look for spawn handlers BEFORE looking for registered + // prefabs. Unspawning also looks for unspawn handlers + // before falling back to regular Destroy. this needs to + // be consistent. + // https://github.com/vis2k/Mirror/issues/2705 + if (spawnHandlers.TryGetValue(message.assetId, out SpawnHandlerDelegate handler)) + { + GameObject obj = handler(message); + if (obj == null) + { + Debug.LogError($"Spawn Handler returned null, Handler assetId '{message.assetId}'"); + return null; + } + + if (!obj.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError($"Object Spawned by handler did not have a NetworkIdentity, Handler assetId '{message.assetId}'"); + return null; + } + + return identity; + } + + // otherwise look in NetworkManager registered prefabs + if (GetPrefab(message.assetId, out GameObject prefab)) + { + GameObject obj = GameObject.Instantiate(prefab, message.position, message.rotation); + //Debug.Log($"Client spawn handler instantiating [netId{message.netId} asset ID:{message.assetId} pos:{message.position} rotation:{message.rotation}]"); + return obj.GetComponent(); + } + + Debug.LogError($"Failed to spawn server object, did you forget to add it to the NetworkManager? assetId={message.assetId} netId={message.netId}"); + return null; + } + + static NetworkIdentity SpawnSceneObject(ulong sceneId) + { + NetworkIdentity identity = GetAndRemoveSceneObject(sceneId); + if (identity == null) + { + Debug.LogError($"Spawn scene object not found for {sceneId:X}. Make sure that client and server use exactly the same project. This only happens if the hierarchy gets out of sync."); + + // dump the whole spawnable objects dict for easier debugging + //foreach (KeyValuePair kvp in spawnableObjects) + // Debug.Log($"Spawnable: SceneId={kvp.Key:X} name={kvp.Value.name}"); + } + //else Debug.Log($"Client spawn for [netId:{msg.netId}] [sceneId:{msg.sceneId:X}] obj:{identity}"); + return identity; + } + + static NetworkIdentity GetAndRemoveSceneObject(ulong sceneId) + { + if (spawnableObjects.TryGetValue(sceneId, out NetworkIdentity identity)) + { + spawnableObjects.Remove(sceneId); + return identity; + } + return null; + } + + /// Call this after loading/unloading a scene in the client after connection to register the spawnable objects + public static void PrepareToSpawnSceneObjects() + { + // remove existing items, they will be re-added below + spawnableObjects.Clear(); + + // finds all NetworkIdentity currently loaded by unity (includes disabled objects) + NetworkIdentity[] allIdentities = Resources.FindObjectsOfTypeAll(); + foreach (NetworkIdentity identity in allIdentities) + { + // add all unspawned NetworkIdentities to spawnable objects + // need to check netId to make sure object is not spawned + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3541 + // PrepareToSpawnSceneObjects may be called multiple times in case + // the ObjectSpawnStarted message is received multiple times. + if (Utils.IsSceneObject(identity) && + identity.netId == 0) + { + if (spawnableObjects.TryGetValue(identity.sceneId, out NetworkIdentity existingIdentity)) + { + string msg = $"NetworkClient: Duplicate sceneId {identity.sceneId} detected on {identity.gameObject.name} and {existingIdentity.gameObject.name}\n" + + $"This can happen if a networked object is persisted in DontDestroyOnLoad through loading / changing to the scene where it originated,\n" + + $"otherwise you may need to open and re-save the {identity.gameObject.scene} to reset scene id's."; + Debug.LogWarning(msg, identity.gameObject); + } + else + { + spawnableObjects.Add(identity.sceneId, identity); + } + } + } + } + + internal static void OnObjectSpawnStarted(ObjectSpawnStartedMessage _) + { + // Debug.Log("SpawnStarted"); + PrepareToSpawnSceneObjects(); + isSpawnFinished = false; + } + + internal static void OnObjectSpawnFinished(ObjectSpawnFinishedMessage _) + { + // paul: Initialize the objects in the same order as they were + // initialized in the server. This is important if spawned objects + // use data from scene objects + foreach (NetworkIdentity identity in spawned.Values.OrderBy(uv => uv.netId)) + { + // NetworkIdentities should always be removed from .spawned when + // they are destroyed. for safety, let's double check here. + if (identity != null) + { + BootstrapIdentity(identity); + } + else Debug.LogWarning("Found null entry in NetworkClient.spawned. This is unexpected. Was the NetworkIdentity not destroyed properly?"); + } + isSpawnFinished = true; + } + + // host mode callbacks ///////////////////////////////////////////////// + static void OnHostClientObjectDestroy(ObjectDestroyMessage message) + { + //Debug.Log($"NetworkClient.OnLocalObjectObjDestroy netId:{message.netId}"); + + // remove from owned (if any) + if (spawned.TryGetValue(message.netId, out NetworkIdentity identity)) + connection.owned.Remove(identity); + + spawned.Remove(message.netId); + } + + static void OnHostClientObjectHide(ObjectHideMessage message) + { + //Debug.Log($"ClientScene::OnLocalObjectObjHide netId:{message.netId}"); + if (spawned.TryGetValue(message.netId, out NetworkIdentity identity) && + identity != null) + { + if (aoi != null) + aoi.SetHostVisibility(identity, false); + } + } + + internal static void OnHostClientSpawn(SpawnMessage message) + { + // on host mode, the object already exist in NetworkServer.spawned. + // simply add it to NetworkClient.spawned too. + if (NetworkServer.spawned.TryGetValue(message.netId, out NetworkIdentity identity) && identity != null) + { + spawned[message.netId] = identity; + if (message.isOwner) connection.owned.Add(identity); + + // now do the actual 'spawning' on host mode + if (message.isLocalPlayer) + InternalAddPlayer(identity); + + // set visibility before invoking OnStartClient etc. callbacks + if (aoi != null) + aoi.SetHostVisibility(identity, true); + + identity.isOwned = message.isOwner; + BootstrapIdentity(identity); + } + } + + // client-only mode callbacks ////////////////////////////////////////// + static void OnEntityStateMessage(EntityStateMessage message) + { + // Debug.Log($"NetworkClient.OnUpdateVarsMessage {msg.netId}"); + if (spawned.TryGetValue(message.netId, out NetworkIdentity identity) && identity != null) + { + using (NetworkReaderPooled reader = NetworkReaderPool.Get(message.payload)) + identity.DeserializeClient(reader, false); + } + else Debug.LogWarning($"Did not find target for sync message for {message.netId}. Were all prefabs added to the NetworkManager's spawnable list?\nNote: this can be completely normal because UDP messages may arrive out of order, so this message might have arrived after a Destroy message."); + } + + static void OnRPCMessage(RpcMessage message) + { + // Debug.Log($"NetworkClient.OnRPCMessage hash:{message.functionHash} netId:{message.netId}"); + if (spawned.TryGetValue(message.netId, out NetworkIdentity identity)) + { + using (NetworkReaderPooled reader = NetworkReaderPool.Get(message.payload)) + identity.HandleRemoteCall(message.componentIndex, message.functionHash, RemoteCallType.ClientRpc, reader); + } + // Rpcs often can't be applied if interest management unspawned them + } + + static void OnObjectHide(ObjectHideMessage message) => DestroyObject(message.netId); + + internal static void OnObjectDestroy(ObjectDestroyMessage message) => DestroyObject(message.netId); + + internal static void OnSpawn(SpawnMessage message) + { + // Debug.Log($"Client spawn handler instantiating netId={msg.netId} assetID={msg.assetId} sceneId={msg.sceneId:X} pos={msg.position}"); + if (FindOrSpawnObject(message, out NetworkIdentity identity)) + { + ApplySpawnPayload(identity, message); + } + } + + internal static void OnChangeOwner(ChangeOwnerMessage message) + { + NetworkIdentity identity = GetExistingObject(message.netId); + + if (identity != null) + ChangeOwner(identity, message); + else + Debug.LogError($"OnChangeOwner: Could not find object with netId {message.netId}"); + } + + // ChangeOwnerMessage contains new 'owned' and new 'localPlayer' + // that we need to apply to the identity. + internal static void ChangeOwner(NetworkIdentity identity, ChangeOwnerMessage message) + { + // local player before, but not anymore? + // call OnStopLocalPlayer before setting new values. + if (identity.isLocalPlayer && !message.isLocalPlayer) + { + identity.OnStopLocalPlayer(); + } + + // set ownership flag (aka authority) + identity.isOwned = message.isOwner; + + // Add / Remove to client's connectionToServer.owned hashset. + if (identity.isOwned) + connection?.owned.Add(identity); + else + connection?.owned.Remove(identity); + + // Call OnStartAuthority / OnStopAuthority + identity.NotifyAuthority(); + + // set localPlayer flag + identity.isLocalPlayer = message.isLocalPlayer; + + // identity is now local player. set our static helper field to it. + if (identity.isLocalPlayer) + { + localPlayer = identity; + identity.connectionToServer = connection; + identity.OnStartLocalPlayer(); + } + // identity's isLocalPlayer was set to false. + // clear our static localPlayer IF (and only IF) it was that one before. + else if (localPlayer == identity) + { + localPlayer = null; + // TODO set .connectionToServer to null for old local player? + // since we set it in the above 'if' case too. + } + } + + // set up NetworkIdentity flags on the client. + // needs to be separate from invoking callbacks. + // cleaner, and some places need to set flags first. + static void InitializeIdentityFlags(NetworkIdentity identity) + { + // initialize flags before invoking callbacks. + // this way isClient/isLocalPlayer is correct during callbacks. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3362 + identity.isClient = true; + identity.isLocalPlayer = localPlayer == identity; + + // .connectionToServer is only available for local players. + // set it here, before invoking any callbacks. + // this way it's available in _all_ callbacks. + if (identity.isLocalPlayer) + identity.connectionToServer = connection; + } + + // invoke NetworkIdentity callbacks on the client. + // needs to be separate from configuring flags. + // cleaner, and some places need to set flags first. + static void InvokeIdentityCallbacks(NetworkIdentity identity) + { + // invoke OnStartAuthority + identity.NotifyAuthority(); + + // invoke OnStartClient + identity.OnStartClient(); + + // invoke OnStartLocalPlayer + if (identity.isLocalPlayer) + identity.OnStartLocalPlayer(); + } + + // configure flags & invoke callbacks + static void BootstrapIdentity(NetworkIdentity identity) + { + InitializeIdentityFlags(identity); + InvokeIdentityCallbacks(identity); + } + + // broadcast /////////////////////////////////////////////////////////// + static void BroadcastTimeSnapshot() + { + Send(new TimeSnapshotMessage(), Channels.Unreliable); + } + + // make sure Broadcast() is only called every sendInterval. + // calling it every update() would require too much bandwidth. + static void Broadcast() + { + // joined the world yet? + if (!connection.isReady) return; + + // nothing to do in host mode. server already knows the state. + if (NetworkServer.active) return; + + // send time snapshot every sendInterval. + BroadcastTimeSnapshot(); + + // for each entity that the client owns + foreach (NetworkIdentity identity in connection.owned) + { + // make sure it's not null or destroyed. + // (which can happen if someone uses + // GameObject.Destroy instead of + // NetworkServer.Destroy) + if (identity != null) + { + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + // get serialization for this entity viewed by this connection + // (if anything was serialized this time) + identity.SerializeClient(writer); + if (writer.Position > 0) + { + // send state update message + EntityStateMessage message = new EntityStateMessage + { + netId = identity.netId, + payload = writer.ToArraySegment() + }; + Send(message); + } + } + } + // spawned list should have no null entries because we + // always call Remove in OnObjectDestroy everywhere. + // if it does have null then we missed something. + else Debug.LogWarning($"Found 'null' entry in owned list for client. This is unexpected behaviour."); + } + } + + // update ////////////////////////////////////////////////////////////// + // NetworkEarlyUpdate called before any Update/FixedUpdate + // (we add this to the UnityEngine in NetworkLoop) + internal static void NetworkEarlyUpdate() + { + // process all incoming messages first before updating the world + if (Transport.active != null) + Transport.active.ClientEarlyUpdate(); + + // time snapshot interpolation + UpdateTimeInterpolation(); + } + + // NetworkLateUpdate called after any Update/FixedUpdate/LateUpdate + // (we add this to the UnityEngine in NetworkLoop) + internal static void NetworkLateUpdate() + { + // broadcast ClientToServer components while active + if (active) + { + // broadcast every sendInterval. + // AccurateInterval to avoid update frequency inaccuracy issues: + // https://github.com/vis2k/Mirror/pull/3153 + // + // for example, host mode server doesn't set .targetFrameRate. + // Broadcast() would be called every tick. + // snapshots might be sent way too often, etc. + // + // during tests, we always call Broadcast() though. + // + // also important for syncInterval=0 components like + // NetworkTransform, so they can sync on same interval as time + // snapshots _but_ not every single tick. + // + // Unity 2019 doesn't have Time.timeAsDouble yet + if (!Application.isPlaying || + AccurateInterval.Elapsed(NetworkTime.localTime, sendInterval, ref lastSendTime)) + { + Broadcast(); + } + } + + // update connections to flush out messages _after_ broadcast + // local connection? + if (connection is LocalConnectionToServer localConnection) + { + localConnection.Update(); + } + // remote connection? + else if (connection is NetworkConnectionToServer remoteConnection) + { + // only update things while connected + if (active && connectState == ConnectState.Connected) + { + // update NetworkTime + NetworkTime.UpdateClient(); + + // update connection to flush out batched messages + remoteConnection.Update(); + } + } + + // process all outgoing messages after updating the world + if (Transport.active != null) + Transport.active.ClientLateUpdate(); + } + + // destroy ///////////////////////////////////////////////////////////// + /// Destroys all networked objects on the client. + // Note: NetworkServer.CleanupNetworkIdentities does the same on server. + public static void DestroyAllClientObjects() + { + // user can modify spawned lists which causes InvalidOperationException + // list can modified either in UnSpawnHandler or in OnDisable/OnDestroy + // we need the Try/Catch so that the rest of the shutdown does not get stopped + try + { + foreach (NetworkIdentity identity in spawned.Values) + { + if (identity != null && identity.gameObject != null) + { + if (identity.isLocalPlayer) + identity.OnStopLocalPlayer(); + + identity.OnStopClient(); + + // NetworkClient.Shutdown calls DestroyAllClientObjects. + // which destroys all objects in NetworkClient.spawned. + // => NC.spawned contains owned & observed objects + // => in host mode, we CAN NOT destroy observed objects. + // => that would destroy them other connection's objects + // on the host server, making them disconnect. + // https://github.com/vis2k/Mirror/issues/2954 + bool hostOwned = identity.connectionToServer is LocalConnectionToServer; + bool shouldDestroy = !identity.isServer || hostOwned; + if (shouldDestroy) + { + bool wasUnspawned = InvokeUnSpawnHandler(identity.assetId, identity.gameObject); + + // unspawned objects should be reset for reuse later. + if (wasUnspawned) + { + identity.Reset(); + } + // without unspawn handler, we need to disable/destroy. + else + { + // scene objects are reset and disabled. + // they always stay in the scene, we don't destroy them. + if (identity.sceneId != 0) + { + identity.Reset(); + identity.gameObject.SetActive(false); + } + // spawned objects are destroyed + else + { + GameObject.Destroy(identity.gameObject); + } + } + } + } + } + spawned.Clear(); + connection?.owned.Clear(); + } + catch (InvalidOperationException e) + { + Debug.LogException(e); + Debug.LogError("Could not DestroyAllClientObjects because spawned list was modified during loop, make sure you are not modifying NetworkIdentity.spawned by calling NetworkServer.Destroy or NetworkServer.Spawn in OnDestroy or OnDisable."); + } + } + + static void DestroyObject(uint netId) + { + // Debug.Log($"NetworkClient.OnObjDestroy netId: {netId}"); + if (spawned.TryGetValue(netId, out NetworkIdentity identity) && identity != null) + { + if (identity.isLocalPlayer) + identity.OnStopLocalPlayer(); + + identity.OnStopClient(); + + // custom unspawn handler for this prefab? (for prefab pools etc.) + if (InvokeUnSpawnHandler(identity.assetId, identity.gameObject)) + { + // reset object after user's handler + identity.Reset(); + } + // otherwise fall back to default Destroy + else if (identity.sceneId == 0) + { + // don't call reset before destroy so that values are still set in OnDestroy + GameObject.Destroy(identity.gameObject); + } + // scene object.. disable it in scene instead of destroying + else + { + identity.gameObject.SetActive(false); + spawnableObjects[identity.sceneId] = identity; + // reset for scene objects + identity.Reset(); + } + + // remove from dictionary no matter how it is unspawned + connection.owned.Remove(identity); // if any + spawned.Remove(netId); + } + //else Debug.LogWarning($"Did not find target for destroy message for {netId}"); + } + + // shutdown //////////////////////////////////////////////////////////// + /// Shutdown the client. + // RuntimeInitializeOnLoadMethod -> fast playmode without domain reload + [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] + public static void Shutdown() + { + //Debug.Log("Shutting down client."); + + // objects need to be destroyed before spawners are cleared + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3334 + DestroyAllClientObjects(); + + // calls prefabs.Clear(); + // calls spawnHandlers.Clear(); + // calls unspawnHandlers.Clear(); + ClearSpawners(); + + spawned.Clear(); + connection?.owned.Clear(); + handlers.Clear(); + spawnableObjects.Clear(); + + // IMPORTANT: do NOT call NetworkIdentity.ResetStatics() here! + // calling StopClient() in host mode would reset nextNetId to 1, + // causing next connection to have a duplicate netId accidentally. + // => see also: https://github.com/vis2k/Mirror/issues/2954 + //NetworkIdentity.ResetStatics(); + // => instead, reset only the client sided statics. + NetworkIdentity.ResetClientStatics(); + + // disconnect the client connection. + // we do NOT call Transport.Shutdown, because someone only called + // NetworkClient.Shutdown. we can't assume that the server is + // supposed to be shut down too! + if (Transport.active != null) + Transport.active.ClientDisconnect(); + + // reset statics + connectState = ConnectState.None; + connection = null; + localPlayer = null; + ready = false; + isSpawnFinished = false; + isLoadingScene = false; + lastSendTime = 0; + + unbatcher = new Unbatcher(); + + // clear events. someone might have hooked into them before, but + // we don't want to use those hooks after Shutdown anymore. + OnConnectedEvent = null; + OnDisconnectedEvent = null; + OnErrorEvent = null; + } + + // GUI ///////////////////////////////////////////////////////////////// + // called from NetworkManager to display timeline interpolation status. + // useful to indicate catchup / slowdown / dynamic adjustment etc. + public static void OnGUI() + { + // only if in world + if (!ready) return; + + GUILayout.BeginArea(new Rect(10, 5, 800, 50)); + + GUILayout.BeginHorizontal("Box"); + GUILayout.Label("Snapshot Interp.:"); + // color while catching up / slowing down + if (localTimescale > 1) GUI.color = Color.green; // green traffic light = go fast + else if (localTimescale < 1) GUI.color = Color.red; // red traffic light = go slow + else GUI.color = Color.white; + GUILayout.Box($"timeline: {localTimeline:F2}"); + GUILayout.Box($"buffer: {snapshots.Count}"); + GUILayout.Box($"DriftEMA: {NetworkClient.driftEma.Value:F2}"); + GUILayout.Box($"DelTimeEMA: {NetworkClient.deliveryTimeEma.Value:F2}"); + GUILayout.Box($"timescale: {localTimescale:F2}"); + GUILayout.Box($"BTM: {NetworkClient.bufferTimeMultiplier:F2}"); // current dynamically adjusted multiplier + GUILayout.Box($"RTT: {NetworkTime.rtt * 1000:F0}ms"); + GUILayout.EndHorizontal(); + + GUILayout.EndArea(); + } + } +} diff --git a/Assets/Mirror/Core/NetworkClient.cs.meta b/Assets/Mirror/Core/NetworkClient.cs.meta new file mode 100644 index 0000000..20cb211 --- /dev/null +++ b/Assets/Mirror/Core/NetworkClient.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: abe6be14204d94224a3e7cd99dd2ea73 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkClient_TimeInterpolation.cs b/Assets/Mirror/Core/NetworkClient_TimeInterpolation.cs new file mode 100644 index 0000000..963ec2b --- /dev/null +++ b/Assets/Mirror/Core/NetworkClient_TimeInterpolation.cs @@ -0,0 +1,183 @@ +using System; +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + public static partial class NetworkClient + { + // snapshot interpolation settings ///////////////////////////////////// + // TODO expose the settings to the user later. + // via NetMan or NetworkClientConfig or NetworkClient as component etc. + public static SnapshotInterpolationSettings snapshotSettings = new SnapshotInterpolationSettings(); + + // obsolete snapshot settings access + // DEPRECATED 2023-03-11 + // [Obsolete("NetworkClient snapshot interpolation settings were moved to NetworkClient.snapshotSettings.*")] + // public static double bufferTimeMultiplier => currentBufferTimeMultiplier; + [Obsolete("NetworkClient snapshot interpolation settings were moved to NetworkClient.snapshotSettings.*")] + public static float catchupNegativeThreshold => snapshotSettings.catchupNegativeThreshold; + [Obsolete("NetworkClient snapshot interpolation settings were moved to NetworkClient.snapshotSettings.*")] + public static float catchupPositiveThreshold => snapshotSettings.catchupPositiveThreshold; + [Obsolete("NetworkClient snapshot interpolation settings were moved to NetworkClient.snapshotSettings.*")] + public static double catchupSpeed => snapshotSettings.catchupSpeed; + [Obsolete("NetworkClient snapshot interpolation settings were moved to NetworkClient.snapshotSettings.*")] + public static double slowdownSpeed => snapshotSettings.slowdownSpeed; + [Obsolete("NetworkClient snapshot interpolation settings were moved to NetworkClient.snapshotSettings.*")] + public static int driftEmaDuration => snapshotSettings.driftEmaDuration; + + // snapshot interpolation runtime data ///////////////////////////////// + // buffer time is dynamically adjusted. + // store the current multiplier here, without touching the original in settings. + // this way we can easily reset to or compare with original where needed. + public static double bufferTimeMultiplier; + + // original buffer time based on the settings + // dynamically adjusted buffer time based on dynamically adjusted multiplier + public static double initialBufferTime => NetworkServer.sendInterval * snapshotSettings.bufferTimeMultiplier; + public static double bufferTime => NetworkServer.sendInterval * bufferTimeMultiplier; + + // + public static SortedList snapshots = new SortedList(); + + // for smooth interpolation, we need to interpolate along server time. + // any other time (arrival on client, client local time, etc.) is not + // going to give smooth results. + // in other words, this is the remote server's time, but adjusted. + // + // internal for use from NetworkTime. + // double for long running servers, see NetworkTime comments. + internal static double localTimeline; + + // catchup / slowdown adjustments are applied to timescale, + // to be adjusted in every update instead of when receiving messages. + internal static double localTimescale = 1; + + // catchup ///////////////////////////////////////////////////////////// + + + // we use EMA to average the last second worth of snapshot time diffs. + // manually averaging the last second worth of values with a for loop + // would be the same, but a moving average is faster because we only + // ever add one value. + static ExponentialMovingAverage driftEma; + + // dynamic buffer time adjustment ////////////////////////////////////// + // dynamically adjusts bufferTimeMultiplier for smooth results. + // to understand how this works, try this manually: + // + // - disable dynamic adjustment + // - set jitter = 0.2 (20% is a lot!) + // - notice some stuttering + // - disable interpolation to see just how much jitter this really is(!) + // - enable interpolation again + // - manually increase bufferTimeMultiplier to 3-4 + // ... the cube slows down (blue) until it's smooth + // - with dynamic adjustment enabled, it will set 4 automatically + // ... the cube slows down (blue) until it's smooth as well + // + // note that 20% jitter is extreme. + // for this to be perfectly smooth, set the safety tolerance to '2'. + // but realistically this is not necessary, and '1' is enough. + [Header("Snapshot Interpolation: Dynamic Adjustment")] + [Tooltip("Automatically adjust bufferTimeMultiplier for smooth results.\nSets a low multiplier on stable connections, and a high multiplier on jittery connections.")] + public static bool dynamicAdjustment = true; + + [Tooltip("Safety buffer that is always added to the dynamic bufferTimeMultiplier adjustment.")] + public static float dynamicAdjustmentTolerance = 1; // 1 is realistically just fine, 2 is very very safe even for 20% jitter. can be half a frame too. (see above comments) + + [Tooltip("Dynamic adjustment is computed over n-second exponential moving average standard deviation.")] + public static int deliveryTimeEmaDuration = 2; // 1-2s recommended to capture average delivery time + static ExponentialMovingAverage deliveryTimeEma; // average delivery time (standard deviation gives average jitter) + + // OnValidate: see NetworkClient.cs + // add snapshot & initialize client interpolation time if needed + + // initialization called from Awake + static void InitTimeInterpolation() + { + // reset timeline, localTimescale & snapshots from last session (if any) + bufferTimeMultiplier = snapshotSettings.bufferTimeMultiplier; + localTimeline = 0; + localTimescale = 1; + snapshots.Clear(); + + // initialize EMA with 'emaDuration' seconds worth of history. + // 1 second holds 'sendRate' worth of values. + // multiplied by emaDuration gives n-seconds. + driftEma = new ExponentialMovingAverage(NetworkServer.sendRate * snapshotSettings.driftEmaDuration); + deliveryTimeEma = new ExponentialMovingAverage(NetworkServer.sendRate * snapshotSettings.deliveryTimeEmaDuration); + } + + // server sends TimeSnapshotMessage every sendInterval. + // batching already includes the remoteTimestamp. + // we simply insert it on-message here. + // => only for reliable channel. unreliable would always arrive earlier. + static void OnTimeSnapshotMessage(TimeSnapshotMessage _) + { + // insert another snapshot for snapshot interpolation. + // before calling OnDeserialize so components can use + // NetworkTime.time and NetworkTime.timeStamp. + + // Unity 2019 doesn't have Time.timeAsDouble yet + OnTimeSnapshot(new TimeSnapshot(connection.remoteTimeStamp, NetworkTime.localTime)); + } + + // see comments at the top of this file + public static void OnTimeSnapshot(TimeSnapshot snap) + { + // Debug.Log($"NetworkClient: OnTimeSnapshot @ {snap.remoteTime:F3}"); + + // (optional) dynamic adjustment + if (snapshotSettings.dynamicAdjustment) + { + // set bufferTime on the fly. + // shows in inspector for easier debugging :) + bufferTimeMultiplier = SnapshotInterpolation.DynamicAdjustment( + NetworkServer.sendInterval, + deliveryTimeEma.StandardDeviation, + snapshotSettings.dynamicAdjustmentTolerance + ); + } + + // insert into the buffer & initialize / adjust / catchup + SnapshotInterpolation.InsertAndAdjust( + snapshots, + snapshotSettings.bufferLimit, + snap, + ref localTimeline, + ref localTimescale, + NetworkServer.sendInterval, + bufferTime, + snapshotSettings.catchupSpeed, + snapshotSettings.slowdownSpeed, + ref driftEma, + snapshotSettings.catchupNegativeThreshold, + snapshotSettings.catchupPositiveThreshold, + ref deliveryTimeEma); + + // Debug.Log($"inserted TimeSnapshot remote={snap.remoteTime:F2} local={snap.localTime:F2} total={snapshots.Count}"); + } + + // call this from early update, so the timeline is safe to use in update + static void UpdateTimeInterpolation() + { + // only while we have snapshots. + // timeline starts when the first snapshot arrives. + if (snapshots.Count > 0) + { + // progress local timeline. + // NetworkTime uses unscaled time and ignores Time.timeScale. + // fixes Time.timeScale getting server & client time out of sync: + // https://github.com/MirrorNetworking/Mirror/issues/3409 + SnapshotInterpolation.StepTime(Time.unscaledDeltaTime, ref localTimeline, localTimescale); + + // progress local interpolation. + // TimeSnapshot doesn't interpolate anything. + // this is merely to keep removing older snapshots. + SnapshotInterpolation.StepInterpolation(snapshots, localTimeline, out _, out _, out double t); + // Debug.Log($"NetworkClient SnapshotInterpolation @ {localTimeline:F2} t={t:F2}"); + } + } + } +} diff --git a/Assets/Mirror/Core/NetworkClient_TimeInterpolation.cs.meta b/Assets/Mirror/Core/NetworkClient_TimeInterpolation.cs.meta new file mode 100644 index 0000000..3c52ae1 --- /dev/null +++ b/Assets/Mirror/Core/NetworkClient_TimeInterpolation.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ad039071a9cc487b9f7831d28bbe8e83 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkConnection.cs b/Assets/Mirror/Core/NetworkConnection.cs new file mode 100644 index 0000000..4827548 --- /dev/null +++ b/Assets/Mirror/Core/NetworkConnection.cs @@ -0,0 +1,206 @@ +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using UnityEngine; + +namespace Mirror +{ + /// Base NetworkConnection class for server-to-client and client-to-server connection. + public abstract class NetworkConnection + { + public const int LocalConnectionId = 0; + + /// Unique identifier for this connection that is assigned by the transport layer. + // assigned by transport, this id is unique for every connection on server. + // clients don't know their own id and they don't know other client's ids. + public readonly int connectionId; + + /// Flag that indicates the client has been authenticated. + public bool isAuthenticated; + + /// General purpose object to hold authentication data, character selection, tokens, etc. + public object authenticationData; + + /// A server connection is ready after joining the game world. + // TODO move this to ConnectionToClient so the flag only lives on server + // connections? clients could use NetworkClient.ready to avoid redundant + // state. + public bool isReady; + + /// Last time a message was received for this connection. Includes system and user messages. + public float lastMessageTime; + + /// This connection's main object (usually the player object). + public NetworkIdentity identity { get; internal set; } + + /// All NetworkIdentities owned by this connection. Can be main player, pets, etc. + // .owned is now valid both on server and on client. + // IMPORTANT: this needs to be , not . + // fixes a bug where DestroyOwnedObjects wouldn't find the + // netId anymore: https://github.com/vis2k/Mirror/issues/1380 + // Works fine with NetworkIdentity pointers though. + public readonly HashSet owned = new HashSet(); + + // batching from server to client & client to server. + // fewer transport calls give us significantly better performance/scale. + // + // for a 64KB max message transport and 64 bytes/message on average, we + // reduce transport calls by a factor of 1000. + // + // depending on the transport, this can give 10x performance. + // + // Dictionary because we have multiple channels. + protected Dictionary batches = new Dictionary(); + + /// last batch's remote timestamp. not interpolated. useful for NetworkTransform etc. + // for any given NetworkMessage/Rpc/Cmd/OnSerialize, this was the time + // on the REMOTE END when it was sent. + // + // NOTE: this is NOT in NetworkTime, it needs to be per-connection + // because the server receives different batch timestamps from + // different connections. + public double remoteTimeStamp { get; internal set; } + + internal NetworkConnection() + { + // set lastTime to current time when creating connection to make + // sure it isn't instantly kicked for inactivity + lastMessageTime = Time.time; + } + + internal NetworkConnection(int networkConnectionId) : this() + { + connectionId = networkConnectionId; + } + + // TODO if we only have Reliable/Unreliable, then we could initialize + // two batches and avoid this code + protected Batcher GetBatchForChannelId(int channelId) + { + // get existing or create new writer for the channelId + Batcher batch; + if (!batches.TryGetValue(channelId, out batch)) + { + // get max batch size for this channel + int threshold = Transport.active.GetBatchThreshold(channelId); + + // create batcher + batch = new Batcher(threshold); + batches[channelId] = batch; + } + return batch; + } + + // Send stage one: NetworkMessage + /// Send a NetworkMessage to this connection over the given channel. + public void Send(T message, int channelId = Channels.Reliable) + where T : struct, NetworkMessage + { + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + // pack message + NetworkMessages.Pack(message, writer); + + // validate packet size immediately. + // we know how much can fit into one batch at max. + // if it's larger, log an error immediately with the type . + // previously we only logged in Update() when processing batches, + // but there we don't have type information anymore. + int max = NetworkMessages.MaxMessageSize(channelId); + if (writer.Position > max) + { + Debug.LogError($"NetworkConnection.Send: message of type {typeof(T)} with a size of {writer.Position} bytes is larger than the max allowed message size in one batch: {max}.\nThe message was dropped, please make it smaller."); + return; + } + + // send allocation free + NetworkDiagnostics.OnSend(message, channelId, writer.Position, 1); + Send(writer.ToArraySegment(), channelId); + } + } + + // Send stage two: serialized NetworkMessage as ArraySegment + // internal because no one except Mirror should send bytes directly to + // the client. they would be detected as a message. send messages instead. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + internal virtual void Send(ArraySegment segment, int channelId = Channels.Reliable) + { + //Debug.Log($"ConnectionSend {this} bytes:{BitConverter.ToString(segment.Array, segment.Offset, segment.Count)}"); + + // add to batch no matter what. + // batching will try to fit as many as possible into MTU. + // but we still allow > MTU, e.g. kcp max packet size 144kb. + // those are simply sent as single batches. + // + // IMPORTANT: do NOT send > batch sized messages directly: + // - data race: large messages would be sent directly. small + // messages would be sent in the batch at the end of frame + // - timestamps: if batching assumes a timestamp, then large + // messages need that too. + // + // NOTE: we ALWAYS batch. it's not optional, because the + // receiver needs timestamps for NT etc. + // + // NOTE: we do NOT ValidatePacketSize here yet. the final packet + // will be the full batch, including timestamp. + GetBatchForChannelId(channelId).AddMessage(segment, NetworkTime.localTime); + } + + // Send stage three: hand off to transport + protected abstract void SendToTransport(ArraySegment segment, int channelId = Channels.Reliable); + + // flush batched messages at the end of every Update. + internal virtual void Update() + { + // go through batches for all channels + // foreach ((int key, Batcher batcher) in batches) // Unity 2020 doesn't support deconstruct yet + foreach (KeyValuePair kvp in batches) + { + // make and send as many batches as necessary from the stored + // messages. + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + // make a batch with our local time (double precision) + while (kvp.Value.GetBatch(writer)) + { + // message size is validated in Send, with test coverage. + // we can send directly without checking again. + ArraySegment segment = writer.ToArraySegment(); + + // send to transport + SendToTransport(segment, kvp.Key); + //UnityEngine.Debug.Log($"sending batch of {writer.Position} bytes for channel={kvp.Key} connId={connectionId}"); + + // reset writer for each new batch + writer.Position = 0; + } + } + } + } + + /// Check if we received a message within the last 'timeout' seconds. + internal virtual bool IsAlive(float timeout) => Time.time - lastMessageTime < timeout; + + /// Disconnects this connection. + // for future reference, here is how Disconnects work in Mirror. + // + // first, there are two types of disconnects: + // * voluntary: the other end simply disconnected + // * involuntary: server disconnects a client by itself + // + // UNET had special (complex) code to handle both cases differently. + // + // Mirror handles both cases the same way: + // * Disconnect is called from TOP to BOTTOM + // NetworkServer/Client -> NetworkConnection -> Transport.Disconnect() + // * Disconnect is handled from BOTTOM to TOP + // Transport.OnDisconnected -> ... + // + // in other words, calling Disconnect() does no cleanup whatsoever. + // it simply asks the transport to disconnect. + // then later the transport events will do the clean up. + public abstract void Disconnect(); + + public override string ToString() => $"connection({connectionId})"; + } +} diff --git a/Assets/Mirror/Core/NetworkConnection.cs.meta b/Assets/Mirror/Core/NetworkConnection.cs.meta new file mode 100644 index 0000000..32c4ba2 --- /dev/null +++ b/Assets/Mirror/Core/NetworkConnection.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 11ea41db366624109af1f0834bcdde2f +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkConnectionToClient.cs b/Assets/Mirror/Core/NetworkConnectionToClient.cs new file mode 100644 index 0000000..b6ff49a --- /dev/null +++ b/Assets/Mirror/Core/NetworkConnectionToClient.cs @@ -0,0 +1,223 @@ +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using UnityEngine; + +namespace Mirror +{ + public class NetworkConnectionToClient : NetworkConnection + { + // rpcs are collected in a buffer, and then flushed out together. + // this way we don't need one NetworkMessage per rpc. + // => prepares for LocalWorldState as well. + // ensure max size when adding! + readonly NetworkWriter reliableRpcs = new NetworkWriter(); + readonly NetworkWriter unreliableRpcs = new NetworkWriter(); + + public virtual string address => Transport.active.ServerGetClientAddress(connectionId); + + /// NetworkIdentities that this connection can see + // TODO move to server's NetworkConnectionToClient? + public readonly HashSet observing = new HashSet(); + + // Deprecated 2022-10-13 + [Obsolete(".clientOwnedObjects was renamed to .owned :)")] + public HashSet clientOwnedObjects => owned; + + // unbatcher + public Unbatcher unbatcher = new Unbatcher(); + + // server runs a time snapshot interpolation for each client's local time. + // this is necessary for client auth movement to still be smooth on the + // server for host mode. + // TODO move them along server's timeline in the future. + // perhaps with an offset. + // for now, keep compatibility by manually constructing a timeline. + ExponentialMovingAverage driftEma; + ExponentialMovingAverage deliveryTimeEma; // average delivery time (standard deviation gives average jitter) + public double remoteTimeline; + public double remoteTimescale; + double bufferTimeMultiplier = 2; + double bufferTime => NetworkServer.sendInterval * bufferTimeMultiplier; + + // + readonly SortedList snapshots = new SortedList(); + + // Snapshot Buffer size limit to avoid ever growing list memory consumption attacks from clients. + public int snapshotBufferSizeLimit = 64; + + // ping for rtt (round trip time) + // useful for statistics, lag compensation, etc. + double lastPingTime = 0; + internal ExponentialMovingAverage _rtt = new ExponentialMovingAverage(NetworkTime.PingWindowSize); + + /// Round trip time (in seconds) that it takes a message to go server->client->server. + public double rtt => _rtt.Value; + + public NetworkConnectionToClient(int networkConnectionId) + : base(networkConnectionId) + { + // initialize EMA with 'emaDuration' seconds worth of history. + // 1 second holds 'sendRate' worth of values. + // multiplied by emaDuration gives n-seconds. + driftEma = new ExponentialMovingAverage(NetworkServer.sendRate * NetworkClient.snapshotSettings.driftEmaDuration); + deliveryTimeEma = new ExponentialMovingAverage(NetworkServer.sendRate * NetworkClient.snapshotSettings.deliveryTimeEmaDuration); + + // buffer limit should be at least multiplier to have enough in there + snapshotBufferSizeLimit = Mathf.Max((int)NetworkClient.snapshotSettings.bufferTimeMultiplier, snapshotBufferSizeLimit); + } + + public void OnTimeSnapshot(TimeSnapshot snapshot) + { + // protect against ever growing buffer size attacks + if (snapshots.Count >= snapshotBufferSizeLimit) return; + + // (optional) dynamic adjustment + if (NetworkClient.snapshotSettings.dynamicAdjustment) + { + // set bufferTime on the fly. + // shows in inspector for easier debugging :) + bufferTimeMultiplier = SnapshotInterpolation.DynamicAdjustment( + NetworkServer.sendInterval, + deliveryTimeEma.StandardDeviation, + NetworkClient.snapshotSettings.dynamicAdjustmentTolerance + ); + // Debug.Log($"[Server]: {name} delivery std={serverDeliveryTimeEma.StandardDeviation} bufferTimeMult := {bufferTimeMultiplier} "); + } + + // insert into the server buffer & initialize / adjust / catchup + SnapshotInterpolation.InsertAndAdjust( + snapshots, + NetworkClient.snapshotSettings.bufferLimit, + snapshot, + ref remoteTimeline, + ref remoteTimescale, + NetworkServer.sendInterval, + bufferTime, + NetworkClient.snapshotSettings.catchupSpeed, + NetworkClient.snapshotSettings.slowdownSpeed, + ref driftEma, + NetworkClient.snapshotSettings.catchupNegativeThreshold, + NetworkClient.snapshotSettings.catchupPositiveThreshold, + ref deliveryTimeEma + ); + } + + public void UpdateTimeInterpolation() + { + // timeline starts when the first snapshot arrives. + if (snapshots.Count > 0) + { + // progress local timeline. + SnapshotInterpolation.StepTime(Time.unscaledDeltaTime, ref remoteTimeline, remoteTimescale); + + // progress local interpolation. + // TimeSnapshot doesn't interpolate anything. + // this is merely to keep removing older snapshots. + SnapshotInterpolation.StepInterpolation(snapshots, remoteTimeline, out _, out _, out _); + // Debug.Log($"NetworkClient SnapshotInterpolation @ {localTimeline:F2} t={t:F2}"); + } + } + + // Send stage three: hand off to transport + [MethodImpl(MethodImplOptions.AggressiveInlining)] + protected override void SendToTransport(ArraySegment segment, int channelId = Channels.Reliable) => + Transport.active.ServerSend(connectionId, segment, channelId); + + protected virtual void UpdatePing() + { + // localTime (double) instead of Time.time for accuracy over days + if (NetworkTime.localTime >= lastPingTime + NetworkTime.PingInterval) + { + // TODO it would be safer for the server to store the last N + // messages' timestamp and only send a message number. + // This way client's can't just modify the timestamp. + NetworkPingMessage pingMessage = new NetworkPingMessage(NetworkTime.localTime); + Send(pingMessage, Channels.Unreliable); + lastPingTime = NetworkTime.localTime; + } + } + + internal override void Update() + { + UpdatePing(); + base.Update(); + } + + /// Disconnects this connection. + public override void Disconnect() + { + // set not ready and handle clientscene disconnect in any case + // (might be client or host mode here) + isReady = false; + reliableRpcs.Position = 0; + unreliableRpcs.Position = 0; + Transport.active.ServerDisconnect(connectionId); + + // IMPORTANT: NetworkConnection.Disconnect() is NOT called for + // voluntary disconnects from the other end. + // -> so all 'on disconnect' cleanup code needs to be in + // OnTransportDisconnect, where it's called for both voluntary + // and involuntary disconnects! + } + + internal void AddToObserving(NetworkIdentity netIdentity) + { + observing.Add(netIdentity); + + // spawn identity for this conn + NetworkServer.ShowForConnection(netIdentity, this); + } + + internal void RemoveFromObserving(NetworkIdentity netIdentity, bool isDestroyed) + { + observing.Remove(netIdentity); + + if (!isDestroyed) + { + // hide identity for this conn + NetworkServer.HideForConnection(netIdentity, this); + } + } + + internal void RemoveFromObservingsObservers() + { + foreach (NetworkIdentity netIdentity in observing) + { + netIdentity.RemoveObserver(this); + } + observing.Clear(); + } + + internal void AddOwnedObject(NetworkIdentity obj) + { + owned.Add(obj); + } + + internal void RemoveOwnedObject(NetworkIdentity obj) + { + owned.Remove(obj); + } + + internal void DestroyOwnedObjects() + { + // create a copy because the list might be modified when destroying + HashSet tmp = new HashSet(owned); + foreach (NetworkIdentity netIdentity in tmp) + { + if (netIdentity != null) + { + // unspawn scene objects, destroy instantiated objects. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3538 + if (netIdentity.sceneId != 0) + NetworkServer.UnSpawn(netIdentity.gameObject); + else + NetworkServer.Destroy(netIdentity.gameObject); + } + } + + // clear the hashset because we destroyed them all + owned.Clear(); + } + } +} diff --git a/Assets/Mirror/Core/NetworkConnectionToClient.cs.meta b/Assets/Mirror/Core/NetworkConnectionToClient.cs.meta new file mode 100644 index 0000000..6001a71 --- /dev/null +++ b/Assets/Mirror/Core/NetworkConnectionToClient.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: bb2195f8b29d24f0680a57fde2e9fd09 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkConnectionToServer.cs b/Assets/Mirror/Core/NetworkConnectionToServer.cs new file mode 100644 index 0000000..496813d --- /dev/null +++ b/Assets/Mirror/Core/NetworkConnectionToServer.cs @@ -0,0 +1,24 @@ +using System; +using System.Runtime.CompilerServices; + +namespace Mirror +{ + public class NetworkConnectionToServer : NetworkConnection + { + // Send stage three: hand off to transport + [MethodImpl(MethodImplOptions.AggressiveInlining)] + protected override void SendToTransport(ArraySegment segment, int channelId = Channels.Reliable) => + Transport.active.ClientSend(segment, channelId); + + /// Disconnects this connection. + public override void Disconnect() + { + // set not ready and handle clientscene disconnect in any case + // (might be client or host mode here) + // TODO remove redundant state. have one source of truth for .ready! + isReady = false; + NetworkClient.ready = false; + Transport.active.ClientDisconnect(); + } + } +} diff --git a/Assets/Mirror/Core/NetworkConnectionToServer.cs.meta b/Assets/Mirror/Core/NetworkConnectionToServer.cs.meta new file mode 100644 index 0000000..3424b58 --- /dev/null +++ b/Assets/Mirror/Core/NetworkConnectionToServer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 761977cbf38a34ded9dd89de45445675 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkDiagnostics.cs b/Assets/Mirror/Core/NetworkDiagnostics.cs new file mode 100644 index 0000000..1cdc96f --- /dev/null +++ b/Assets/Mirror/Core/NetworkDiagnostics.cs @@ -0,0 +1,63 @@ +using System; + +namespace Mirror +{ + /// Profiling statistics for tool to subscribe to (profiler etc.) + public static class NetworkDiagnostics + { + /// Describes an outgoing message + public readonly struct MessageInfo + { + /// The message being sent + public readonly NetworkMessage message; + /// channel through which the message was sent + public readonly int channel; + /// how big was the message (does not include transport headers) + public readonly int bytes; + /// How many connections was the message sent to. + public readonly int count; + + internal MessageInfo(NetworkMessage message, int channel, int bytes, int count) + { + this.message = message; + this.channel = channel; + this.bytes = bytes; + this.count = count; + } + } + + /// Event for when Mirror sends a message. Can be subscribed to. + public static event Action OutMessageEvent; + + /// Event for when Mirror receives a message. Can be subscribed to. + public static event Action InMessageEvent; + + // RuntimeInitializeOnLoadMethod -> fast playmode without domain reload + [UnityEngine.RuntimeInitializeOnLoadMethod] + static void ResetStatics() + { + InMessageEvent = null; + OutMessageEvent = null; + } + + internal static void OnSend(T message, int channel, int bytes, int count) + where T : struct, NetworkMessage + { + if (count > 0 && OutMessageEvent != null) + { + MessageInfo outMessage = new MessageInfo(message, channel, bytes, count); + OutMessageEvent?.Invoke(outMessage); + } + } + + internal static void OnReceive(T message, int channel, int bytes) + where T : struct, NetworkMessage + { + if (InMessageEvent != null) + { + MessageInfo inMessage = new MessageInfo(message, channel, bytes, 1); + InMessageEvent?.Invoke(inMessage); + } + } + } +} diff --git a/Assets/Mirror/Core/NetworkDiagnostics.cs.meta b/Assets/Mirror/Core/NetworkDiagnostics.cs.meta new file mode 100644 index 0000000..fe37316 --- /dev/null +++ b/Assets/Mirror/Core/NetworkDiagnostics.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c3754b39e5f8740fd93f3337b2c4274e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkIdentity.cs b/Assets/Mirror/Core/NetworkIdentity.cs new file mode 100644 index 0000000..a1d7397 --- /dev/null +++ b/Assets/Mirror/Core/NetworkIdentity.cs @@ -0,0 +1,1384 @@ +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using Mirror.RemoteCalls; +using UnityEngine; +using UnityEngine.Serialization; + +#if UNITY_EDITOR +using UnityEditor; + +#if UNITY_2021_2_OR_NEWER +using UnityEditor.SceneManagement; +#else +using UnityEditor.Experimental.SceneManagement; +#endif +#endif + +namespace Mirror +{ + // Default = use interest management + // ForceHidden = useful to hide monsters while they respawn etc. + // ForceShown = useful to have score NetworkIdentities that always broadcast + // to everyone etc. + public enum Visibility { Default, ForceHidden, ForceShown } + + public struct NetworkIdentitySerialization + { + // IMPORTANT: int tick avoids floating point inaccuracy over days/weeks + public int tick; + public NetworkWriter ownerWriter; + public NetworkWriter observersWriter; + } + + /// NetworkIdentity identifies objects across the network. + [DisallowMultipleComponent] + // NetworkIdentity.Awake initializes all NetworkComponents. + // let's make sure it's always called before their Awake's. + [DefaultExecutionOrder(-1)] + [AddComponentMenu("Network/Network Identity")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-identity")] + public sealed class NetworkIdentity : MonoBehaviour + { + /// Returns true if running as a client and this object was spawned by a server. + // + // IMPORTANT: + // OnStartClient sets it to true. we NEVER set it to false after. + // otherwise components like Skillbars couldn't use OnDestroy() + // for saving, etc. since isClient may have been reset before + // OnDestroy was called. + // + // we also DO NOT make it dependent on NetworkClient.active or similar. + // we set it, then never change it. that's the user's expectation too. + // + // => fixes https://github.com/vis2k/Mirror/issues/1475 + public bool isClient { get; internal set; } + + /// Returns true if NetworkServer.active and server is not stopped. + // + // IMPORTANT: + // OnStartServer sets it to true. we NEVER set it to false after. + // otherwise components like Skillbars couldn't use OnDestroy() + // for saving, etc. since isServer may have been reset before + // OnDestroy was called. + // + // we also DO NOT make it dependent on NetworkServer.active or similar. + // we set it, then never change it. that's the user's expectation too. + // + // => fixes https://github.com/vis2k/Mirror/issues/1484 + // => fixes https://github.com/vis2k/Mirror/issues/2533 + public bool isServer { get; internal set; } + + /// Return true if this object represents the player on the local machine. + // + // IMPORTANT: + // OnStartLocalPlayer sets it to true. we NEVER set it to false after. + // otherwise components like Skillbars couldn't use OnDestroy() + // for saving, etc. since isLocalPlayer may have been reset before + // OnDestroy was called. + // + // we also DO NOT make it dependent on NetworkClient.localPlayer or similar. + // we set it, then never change it. that's the user's expectation too. + // + // => fixes https://github.com/vis2k/Mirror/issues/2615 + public bool isLocalPlayer { get; internal set; } + + /// True if this object only exists on the server + public bool isServerOnly => isServer && !isClient; + + /// True if this object exists on a client that is not also acting as a server. + public bool isClientOnly => isClient && !isServer; + + /// isOwned is true on the client if this NetworkIdentity is one of the .owned entities of our connection on the server. + // for example: main player & pets are owned. monsters & npcs aren't. + public bool isOwned { get; internal set; } + + // Deprecated 2022-10-13 + [Obsolete(".hasAuthority was renamed to .isOwned. This is easier to understand and prepares for SyncDirection, where there is a difference betwen isOwned and authority.")] + public bool hasAuthority => isOwned; + + /// The set of network connections (players) that can see this object. + public readonly Dictionary observers = + new Dictionary(); + + /// The unique network Id of this object (unique at runtime). + public uint netId { get; internal set; } + + /// Unique identifier for NetworkIdentity objects within a scene, used for spawning scene objects. + // persistent scene id (see AssignSceneID comments) + [FormerlySerializedAs("m_SceneId"), HideInInspector] + public ulong sceneId; + + // assetId used to spawn prefabs across the network. + // originally a Guid, but a 4 byte uint is sufficient + // (as suggested by james) + // + // it's also easier to work with for serialization etc. + // serialized and visible in inspector for easier debugging + [SerializeField] uint _assetId; + + // The AssetId trick: + // Ideally we would have a serialized 'Guid m_AssetId' but Unity can't + // serialize it because Guid's internal bytes are private + // + // Using just the Guid string would work, but it's 32 chars long and + // would then be sent over the network as 64 instead of 16 bytes + // + // => The solution is to serialize the string internally here and then + // use the real 'Guid' type for everything else via .assetId + public uint assetId + { + get + { +#if UNITY_EDITOR + // old UNET comment: + // This is important because sometimes OnValidate does not run + // (like when adding NetworkIdentity to prefab with no child links) + if (_assetId == 0) + SetupIDs(); +#endif + return _assetId; + } + // assetId is set internally when creating or duplicating a prefab + internal set + { + // should never be empty + if (value == 0) + { + Debug.LogError($"Can not set AssetId to empty guid on NetworkIdentity '{name}', old assetId '{_assetId}'"); + return; + } + + // always set it otherwise. + // for new prefabs, it will set from 0 to N. + // for duplicated prefabs, it will set from N to M. + // either way, it's always set to a valid GUID. + _assetId = value; + // Debug.Log($"Setting AssetId on NetworkIdentity '{name}', new assetId '{value:X4}'"); + } + } + + /// Make this object only exist when the game is running as a server (or host). + [FormerlySerializedAs("m_ServerOnly")] + [Tooltip("Prevents this object from being spawned / enabled on clients")] + public bool serverOnly; + + // Set before Destroy is called so that OnDestroy doesn't try to destroy + // the object again + internal bool destroyCalled; + + /// Client's network connection to the server. This is only valid for player objects on the client. + // TODO change to NetworkConnectionToServer, but might cause some breaking + public NetworkConnection connectionToServer { get; internal set; } + + /// Server's network connection to the client. This is only valid for client-owned objects (including the Player object) on the server. + public NetworkConnectionToClient connectionToClient + { + get => _connectionToClient; + internal set + { + _connectionToClient?.RemoveOwnedObject(this); + _connectionToClient = value; + _connectionToClient?.AddOwnedObject(this); + } + } + NetworkConnectionToClient _connectionToClient; + + // get all NetworkBehaviour components + public NetworkBehaviour[] NetworkBehaviours { get; private set; } + + // to save bandwidth, we send one 64 bit dirty mask + // instead of 1 byte index per dirty component. + // which means we can't allow > 64 components (it's enough). + const int MaxNetworkBehaviours = 64; + + // current visibility + // + // Default = use interest management + // ForceHidden = useful to hide monsters while they respawn etc. + // ForceShown = useful to have score NetworkIdentities that always broadcast + // to everyone etc. + // + // TODO rename to 'visibility' after removing .visibility some day! + [Tooltip("Visibility can overwrite interest management. ForceHidden can be useful to hide monsters while they respawn. ForceShown can be useful for score NetworkIdentities that should always broadcast to everyone in the world.")] + public Visibility visible = Visibility.Default; + + // broadcasting serializes all entities around a player for each player. + // we don't want to serialize one entity twice in the same tick. + // so we cache the last serialization and remember the timestamp so we + // know which Update it was serialized. + // (timestamp is the same while inside Update) + // => this way we don't need to pool thousands of writers either. + // => way easier to store them per object + NetworkIdentitySerialization lastSerialization = new NetworkIdentitySerialization + { + ownerWriter = new NetworkWriter(), + observersWriter = new NetworkWriter() + }; + + // Keep track of all sceneIds to detect scene duplicates + static readonly Dictionary sceneIds = + new Dictionary(); + + // Helper function to handle Command/Rpc + internal void HandleRemoteCall(byte componentIndex, ushort functionHash, RemoteCallType remoteCallType, NetworkReader reader, NetworkConnectionToClient senderConnection = null) + { + // check if unity object has been destroyed + if (this == null) + { + Debug.LogWarning($"{remoteCallType} [{functionHash}] received for deleted object [netId={netId}]"); + return; + } + + // find the right component to invoke the function on + if (componentIndex >= NetworkBehaviours.Length) + { + Debug.LogWarning($"Component [{componentIndex}] not found for [netId={netId}]"); + return; + } + + NetworkBehaviour invokeComponent = NetworkBehaviours[componentIndex]; + if (!RemoteProcedureCalls.Invoke(functionHash, remoteCallType, reader, invokeComponent, senderConnection)) + { + Debug.LogError($"Found no receiver for incoming {remoteCallType} [{functionHash}] on {gameObject.name}, the server and client should have the same NetworkBehaviour instances [netId={netId}]."); + } + } + + // RuntimeInitializeOnLoadMethod -> fast playmode without domain reload + // internal so it can be called from NetworkServer & NetworkClient + [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] + internal static void ResetStatics() + { + // reset ALL statics + ResetClientStatics(); + ResetServerStatics(); + } + + // reset only client sided statics. + // don't touch server statics when calling StopClient in host mode. + // https://github.com/vis2k/Mirror/issues/2954 + internal static void ResetClientStatics() + { + previousLocalPlayer = null; + clientAuthorityCallback = null; + } + + internal static void ResetServerStatics() + { + nextNetworkId = 1; + } + + /// Gets the NetworkIdentity from the sceneIds dictionary with the corresponding id + public static NetworkIdentity GetSceneIdentity(ulong id) => sceneIds[id]; + + static uint nextNetworkId = 1; + internal static uint GetNextNetworkId() => nextNetworkId++; + + /// Resets nextNetworkId = 1 + public static void ResetNextNetworkId() => nextNetworkId = 1; + + /// The delegate type for the clientAuthorityCallback. + public delegate void ClientAuthorityCallback(NetworkConnectionToClient conn, NetworkIdentity identity, bool authorityState); + + /// A callback that can be populated to be notified when the client-authority state of objects changes. + public static event ClientAuthorityCallback clientAuthorityCallback; + + // hasSpawned should always be false before runtime + [SerializeField, HideInInspector] bool hasSpawned; + public bool SpawnedFromInstantiate { get; private set; } + + // NetworkBehaviour components are initialized in Awake once. + // Changing them at runtime would get client & server out of sync. + // BUT internal so tests can add them after creating the NetworkIdentity + internal void InitializeNetworkBehaviours() + { + // Get all NetworkBehaviour components, including children. + // Some users need NetworkTransform on child bones, etc. + // => Deterministic: https://forum.unity.com/threads/getcomponentsinchildren.4582/#post-33983 + // => Never null. GetComponents returns [] if none found. + // => Include inactive. We need all child components. + NetworkBehaviours = GetComponentsInChildren(true); + ValidateComponents(); + + // initialize each one + for (int i = 0; i < NetworkBehaviours.Length; ++i) + { + NetworkBehaviour component = NetworkBehaviours[i]; + component.netIdentity = this; + component.ComponentIndex = (byte)i; + } + } + + void ValidateComponents() + { + if (NetworkBehaviours == null) + { + Debug.LogError($"NetworkBehaviours array is null on {gameObject.name}!\n" + + $"Typically this can happen when a networked object is a child of a " + + $"non-networked parent that's disabled, preventing Awake on the networked object " + + $"from being invoked, where the NetworkBehaviours array is initialized.", gameObject); + } + else if (NetworkBehaviours.Length > MaxNetworkBehaviours) + { + Debug.LogError($"NetworkIdentity {name} has too many NetworkBehaviour components: only {MaxNetworkBehaviours} NetworkBehaviour components are allowed in order to save bandwidth.", this); + } + } + + // Awake is only called in Play mode. + // internal so we can call it during unit tests too. + internal void Awake() + { + // initialize NetworkBehaviour components. + // Awake() is called immediately after initialization. + // no one can overwrite it because NetworkIdentity is sealed. + // => doing it here is the fastest and easiest solution. + InitializeNetworkBehaviours(); + + if (hasSpawned) + { + Debug.LogError($"{name} has already spawned. Don't call Instantiate for NetworkIdentities that were in the scene since the beginning (aka scene objects). Otherwise the client won't know which object to use for a SpawnSceneObject message."); + SpawnedFromInstantiate = true; + Destroy(gameObject); + } + hasSpawned = true; + } + + void OnValidate() + { + // OnValidate is not called when using Instantiate, so we can use + // it to make sure that hasSpawned is false + hasSpawned = false; + +#if UNITY_EDITOR + DisallowChildNetworkIdentities(); + SetupIDs(); +#endif + } + + // expose our AssetId Guid to uint mapping code in case projects need to map Guids to uint as well. + // this way their projects won't break if we change our mapping algorithm. + // needs to be available at runtime / builds, don't wrap in #if UNITY_EDITOR + public static uint AssetGuidToUint(Guid guid) => (uint)guid.GetHashCode(); // deterministic + +#if UNITY_EDITOR + // child NetworkIdentities are not supported. + // Disallow them and show an error for the user to fix. + // This needs to work for Prefabs & Scene objects, so the previous check + // in NetworkClient.RegisterPrefab is not enough. + void DisallowChildNetworkIdentities() + { +#if UNITY_2020_3_OR_NEWER + NetworkIdentity[] identities = GetComponentsInChildren(true); +#else + NetworkIdentity[] identities = GetComponentsInChildren(); +#endif + if (identities.Length > 1) + { + // always log the next child component so it's easy to fix. + // if there are multiple, then after removing it'll log the next. + Debug.LogError($"'{name}' has another NetworkIdentity component on '{identities[1].name}'. There should only be one NetworkIdentity, and it must be on the root object. Please remove the other one."); + } + } + + void AssignAssetID(string path) + { + // only set if not empty. fixes https://github.com/vis2k/Mirror/issues/2765 + if (!string.IsNullOrWhiteSpace(path)) + { + // if we generate the assetId then we MUST be sure to set dirty + // in order to save the prefab object properly. otherwise it + // would be regenerated every time we reopen the prefab. + // -> Undo.RecordObject is the new EditorUtility.SetDirty! + // -> we need to call it before changing. + // + // to verify this, duplicate a prefab and double click to open it. + // add a log message if "_assetId != before_". + // without RecordObject, it'll log every time because it's not saved. + Undo.RecordObject(this, "Assigned AssetId"); + + // uint before = _assetId; + Guid guid = new Guid(AssetDatabase.AssetPathToGUID(path)); + assetId = AssetGuidToUint(guid); + // if (_assetId != before) Debug.Log($"Assigned assetId={assetId} to {name}"); + } + } + + void AssignAssetID(GameObject prefab) => AssignAssetID(AssetDatabase.GetAssetPath(prefab)); + + // persistent sceneId assignment + // (because scene objects have no persistent unique ID in Unity) + // + // original UNET used OnPostProcessScene to assign an index based on + // FindObjectOfType order. + // -> this didn't work because FindObjectOfType order isn't deterministic. + // -> one workaround is to sort them by sibling paths, but it can still + // get out of sync when we open scene2 in editor and we have + // DontDestroyOnLoad objects that messed with the sibling index. + // + // we absolutely need a persistent id. challenges: + // * it needs to be 0 for prefabs + // => we set it to 0 in SetupIDs() if prefab! + // * it needs to be only assigned in edit time, not at runtime because + // only the objects that were in the scene since beginning should have + // a scene id. + // => Application.isPlaying check solves that + // * it needs to detect duplicated sceneIds after duplicating scene + // objects + // => sceneIds dict takes care of that + // * duplicating the whole scene file shouldn't result in duplicate + // scene objects + // => buildIndex is shifted into sceneId for that. + // => if we have no scenes in build index then it doesn't matter + // because by definition a build can't switch to other scenes + // => if we do have scenes in build index then it will be != -1 + // note: the duplicated scene still needs to be opened once for it to + // be set properly + // * scene objects need the correct scene index byte even if the scene's + // build index was changed or a duplicated scene wasn't opened yet. + // => OnPostProcessScene is the only function that gets called for + // each scene before runtime, so this is where we set the scene + // byte. + // * disabled scenes in build settings should result in same scene index + // in editor and in build + // => .gameObject.scene.buildIndex filters out disabled scenes by + // default + // * generated sceneIds absolutely need to set scene dirty and force the + // user to resave. + // => Undo.RecordObject does that perfectly. + // * sceneIds should never be generated temporarily for unopened scenes + // when building, otherwise editor and build get out of sync + // => BuildPipeline.isBuildingPlayer check solves that + void AssignSceneID() + { + // we only ever assign sceneIds at edit time, never at runtime. + // by definition, only the original scene objects should get one. + // -> if we assign at runtime then server and client would generate + // different random numbers! + if (Application.isPlaying) + return; + + // no valid sceneId yet, or duplicate? + bool duplicate = sceneIds.TryGetValue(sceneId, out NetworkIdentity existing) && existing != null && existing != this; + if (sceneId == 0 || duplicate) + { + // clear in any case, because it might have been a duplicate + sceneId = 0; + + // if a scene was never opened and we are building it, then a + // sceneId would be assigned to build but not saved in editor, + // resulting in them getting out of sync. + // => don't ever assign temporary ids. they always need to be + // permanent + // => throw an exception to cancel the build and let the user + // know how to fix it! + if (BuildPipeline.isBuildingPlayer) + throw new InvalidOperationException($"Scene {gameObject.scene.path} needs to be opened and resaved before building, because the scene object {name} has no valid sceneId yet."); + + // if we generate the sceneId then we MUST be sure to set dirty + // in order to save the scene object properly. otherwise it + // would be regenerated every time we reopen the scene, and + // upgrading would be very difficult. + // -> Undo.RecordObject is the new EditorUtility.SetDirty! + // -> we need to call it before changing. + Undo.RecordObject(this, "Generated SceneId"); + + // generate random sceneId part (0x00000000FFFFFFFF) + uint randomId = Utils.GetTrueRandomUInt(); + + // only assign if not a duplicate of an existing scene id + // (small chance, but possible) + duplicate = sceneIds.TryGetValue(randomId, out existing) && existing != null && existing != this; + if (!duplicate) + { + sceneId = randomId; + //Debug.Log($"{name} in scene {gameObject.scene.name} sceneId assigned to:{sceneId:X}"); + } + } + + // add to sceneIds dict no matter what + // -> even if we didn't generate anything new, because we still need + // existing sceneIds in there to check duplicates + sceneIds[sceneId] = this; + } + + // copy scene path hash into sceneId for scene objects. + // this is the only way for scene file duplication to not contain + // duplicate sceneIds as it seems. + // -> sceneId before: 0x00000000AABBCCDD + // -> then we clear the left 4 bytes, so that our 'OR' uses 0x00000000 + // -> then we OR the hash into the 0x00000000 part + // -> buildIndex is not enough, because Editor and Build have different + // build indices if there are disabled scenes in build settings, and + // if no scene is in build settings then Editor and Build have + // different indices too (Editor=0, Build=-1) + // => ONLY USE THIS FROM POSTPROCESSSCENE! + public void SetSceneIdSceneHashPartInternal() + { + // Use `ToLower` to that because BuildPipeline.BuildPlayer is case insensitive but hash is case sensitive + // If the scene in the project is `forest.unity` but `Forest.unity` is given to BuildPipeline then the + // BuildPipeline will use `Forest.unity` for the build and create a different hash than the editor will. + // Using ToLower will mean the hash will be the same for these 2 paths + // Assets/Scenes/Forest.unity + // Assets/Scenes/forest.unity + string scenePath = gameObject.scene.path.ToLower(); + + // get deterministic scene hash + uint pathHash = (uint)scenePath.GetStableHashCode(); + + // shift hash from 0x000000FFFFFFFF to 0xFFFFFFFF00000000 + ulong shiftedHash = (ulong)pathHash << 32; + + // OR into scene id + sceneId = (sceneId & 0xFFFFFFFF) | shiftedHash; + + // log it. this is incredibly useful to debug sceneId issues. + //Debug.Log($"{name} in scene {gameObject.scene.name} scene index hash {pathHash:X} copied into sceneId {sceneId:X}"); + } + + void SetupIDs() + { + // is this a prefab? + if (Utils.IsPrefab(gameObject)) + { + // force 0 for prefabs + sceneId = 0; + AssignAssetID(gameObject); + } + // are we currently in prefab editing mode? aka prefab stage + // => check prefabstage BEFORE SceneObjectWithPrefabParent + // (fixes https://github.com/vis2k/Mirror/issues/976) + // => if we don't check GetCurrentPrefabStage and only check + // GetPrefabStage(gameObject), then the 'else' case where we + // assign a sceneId and clear the assetId would still be + // triggered for prefabs. in other words: if we are in prefab + // stage, do not bother with anything else ever! + else if (PrefabStageUtility.GetCurrentPrefabStage() != null) + { + // when modifying a prefab in prefab stage, Unity calls + // OnValidate for that prefab and for all scene objects based on + // that prefab. + // + // is this GameObject the prefab that we modify, and not just a + // scene object based on the prefab? + // * GetCurrentPrefabStage = 'are we editing ANY prefab?' + // * GetPrefabStage(go) = 'are we editing THIS prefab?' + if (PrefabStageUtility.GetPrefabStage(gameObject) != null) + { + // force 0 for prefabs + sceneId = 0; + //Debug.Log($"{name} scene:{gameObject.scene.name} sceneid reset to 0 because CurrentPrefabStage={PrefabStageUtility.GetCurrentPrefabStage()} PrefabStage={PrefabStageUtility.GetPrefabStage(gameObject)}"); + + // get path from PrefabStage for this prefab +#if UNITY_2020_1_OR_NEWER + string path = PrefabStageUtility.GetPrefabStage(gameObject).assetPath; +#else + string path = PrefabStageUtility.GetPrefabStage(gameObject).prefabAssetPath; +#endif + + AssignAssetID(path); + } + } + // is this a scene object with prefab parent? + else if (Utils.IsSceneObjectWithPrefabParent(gameObject, out GameObject prefab)) + { + AssignSceneID(); + AssignAssetID(prefab); + } + else + { + AssignSceneID(); + + // IMPORTANT: DO NOT clear assetId at runtime! + // => fixes a bug where clicking any of the NetworkIdentity + // properties (like ServerOnly/ForceHidden) at runtime would + // call OnValidate + // => OnValidate gets into this else case here because prefab + // connection isn't known at runtime + // => then we would clear the previously assigned assetId + // => and NetworkIdentity couldn't be spawned on other clients + // anymore because assetId was cleared + if (!EditorApplication.isPlaying) + { + _assetId = 0; + } + // don't log. would show a lot when pressing play in uMMORPG/uSurvival/etc. + //else Debug.Log($"Avoided clearing assetId at runtime for {name} after (probably) clicking any of the NetworkIdentity properties."); + } + } +#endif + + // OnDestroy is called for all SPAWNED NetworkIdentities + // => scene objects aren't destroyed. it's not called for them. + // + // Note: Unity will Destroy all networked objects on Scene Change, so we + // have to handle that here silently. That means we cannot have any + // warning or logging in this method. + void OnDestroy() + { + // Objects spawned from Instantiate are not allowed so are destroyed right away + // we don't want to call NetworkServer.Destroy if this is the case + if (SpawnedFromInstantiate) + return; + + // If false the object has already been unspawned + // if it is still true, then we need to unspawn it + // if destroy is already called don't call it again + if (isServer && !destroyCalled) + { + // Do not add logging to this (see above) + NetworkServer.Destroy(gameObject); + } + + if (isLocalPlayer) + { + // previously there was a bug where isLocalPlayer was + // false in OnDestroy because it was dynamically defined as: + // isLocalPlayer => NetworkClient.localPlayer == this + // we fixed it by setting isLocalPlayer manually and never + // resetting it. + // + // BUT now we need to be aware of a possible data race like in + // our rooms example: + // => GamePlayer is in world + // => player returns to room + // => GamePlayer is destroyed + // => NetworkClient.localPlayer is set to RoomPlayer + // => GamePlayer.OnDestroy is called 1 frame later + // => GamePlayer.OnDestroy 'isLocalPlayer' is true, so here we + // are trying to clear NetworkClient.localPlayer + // => which would overwrite the new RoomPlayer local player + // + // FIXED by simply only clearing if NetworkClient.localPlayer + // still points to US! + // => see also: https://github.com/vis2k/Mirror/issues/2635 + if (NetworkClient.localPlayer == this) + NetworkClient.localPlayer = null; + } + + if (isClient) + { + // ServerChangeScene doesn't send destroy messages. + // some identities may persist in DDOL. + // some are destroyed by scene change. + // if an identity is still in .owned remove it. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3308 + if (NetworkClient.connection != null) + NetworkClient.connection.owned.Remove(this); + + // if an identity is still in .spawned, remove it too. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3324 + NetworkClient.spawned.Remove(netId); + } + } + + internal void OnStartServer() + { + foreach (NetworkBehaviour comp in NetworkBehaviours) + { + // an exception in OnStartServer should be caught, so that one + // component's exception doesn't stop all other components from + // being initialized + // => this is what Unity does for Start() etc. too. + // one exception doesn't stop all the other Start() calls! + try + { + comp.OnStartServer(); + } + catch (Exception e) + { + Debug.LogException(e, comp); + } + } + } + + internal void OnStopServer() + { + foreach (NetworkBehaviour comp in NetworkBehaviours) + { + // an exception in OnStartServer should be caught, so that one + // component's exception doesn't stop all other components from + // being initialized + // => this is what Unity does for Start() etc. too. + // one exception doesn't stop all the other Start() calls! + try + { + comp.OnStopServer(); + } + catch (Exception e) + { + Debug.LogException(e, comp); + } + } + } + + bool clientStarted; + internal void OnStartClient() + { + if (clientStarted) return; + + clientStarted = true; + + // Debug.Log($"OnStartClient {gameObject} netId:{netId}"); + foreach (NetworkBehaviour comp in NetworkBehaviours) + { + // an exception in OnStartClient should be caught, so that one + // component's exception doesn't stop all other components from + // being initialized + // => this is what Unity does for Start() etc. too. + // one exception doesn't stop all the other Start() calls! + try + { + // user implemented startup + comp.OnStartClient(); + } + catch (Exception e) + { + Debug.LogException(e, comp); + } + } + } + + internal void OnStopClient() + { + // In case this object was destroyed already don't call + // OnStopClient if OnStartClient hasn't been called. + if (!clientStarted) return; + + foreach (NetworkBehaviour comp in NetworkBehaviours) + { + // an exception in OnStopClient should be caught, so that + // one component's exception doesn't stop all other components + // from being initialized + // => this is what Unity does for Start() etc. too. + // one exception doesn't stop all the other Start() calls! + try + { + comp.OnStopClient(); + } + catch (Exception e) + { + Debug.LogException(e, comp); + } + } + } + + internal static NetworkIdentity previousLocalPlayer = null; + internal void OnStartLocalPlayer() + { + // ensure OnStartLocalPlayer is only called once. + // Room demo would call it multiple times: + // - once from ApplySpawnPayload + // - once from OnObjectSpawnFinished + // + // to reproduce: + // - open room demo, add the 3 scenes to build settings + // - add OnStartLocalPlayer log to RoomPlayer prefab + // - build, run server-only + // - in editor, connect, press ready + // - in server, start game + // - notice multiple OnStartLocalPlayer logs in editor client + // + // explanation: + // we send the spawn message multiple times. Whenever an object changes + // authority, we send the spawn message again for the object. This is + // necessary because we need to reinitialize all variables when + // ownership change due to sync to owner feature. + // Without this static, the second time we get the spawn message we + // would call OnStartLocalPlayer again on the same object + if (previousLocalPlayer == this) + return; + previousLocalPlayer = this; + + foreach (NetworkBehaviour comp in NetworkBehaviours) + { + // an exception in OnStartLocalPlayer should be caught, so that + // one component's exception doesn't stop all other components + // from being initialized + // => this is what Unity does for Start() etc. too. + // one exception doesn't stop all the other Start() calls! + try + { + comp.OnStartLocalPlayer(); + } + catch (Exception e) + { + Debug.LogException(e, comp); + } + } + } + + internal void OnStopLocalPlayer() + { + foreach (NetworkBehaviour comp in NetworkBehaviours) + { + // an exception in OnStopLocalPlayer should be caught, so that + // one component's exception doesn't stop all other components + // from being initialized + // => this is what Unity does for Start() etc. too. + // one exception doesn't stop all the other Start() calls! + try + { + comp.OnStopLocalPlayer(); + } + catch (Exception e) + { + Debug.LogException(e, comp); + } + } + } + + // build dirty mask for server owner & observers (= all dirty components). + // faster to do it in one iteration instead of iterating separately. + (ulong, ulong) ServerDirtyMasks(bool initialState) + { + ulong ownerMask = 0; + ulong observerMask = 0; + + NetworkBehaviour[] components = NetworkBehaviours; + for (int i = 0; i < components.Length; ++i) + { + NetworkBehaviour component = components[i]; + + bool dirty = component.IsDirty(); + ulong nthBit = (1u << i); + + // owner needs to be considered for both SyncModes, because + // Observers mode always includes the Owner. + // + // for initial, it should always sync owner. + // for delta, only for ServerToClient and only if dirty. + // ClientToServer comes from the owner client. + if (initialState || (component.syncDirection == SyncDirection.ServerToClient && dirty)) + ownerMask |= nthBit; + + // observers need to be considered only in Observers mode + // + // for initial, it should always sync to observers. + // for delta, only if dirty. + // SyncDirection is irrelevant, as both are broadcast to + // observers which aren't the owner. + if (component.syncMode == SyncMode.Observers && (initialState || dirty)) + observerMask |= nthBit; + } + + return (ownerMask, observerMask); + } + + // build dirty mask for client. + // server always knows initialState, so we don't need it here. + ulong ClientDirtyMask() + { + ulong mask = 0; + + NetworkBehaviour[] components = NetworkBehaviours; + for (int i = 0; i < components.Length; ++i) + { + // on the client, we need to consider different sync scenarios: + // + // ServerToClient SyncDirection: + // do nothing. + // ClientToServer SyncDirection: + // serialize only if owned. + + // on client, only consider owned components with SyncDirection to server + NetworkBehaviour component = components[i]; + if (isOwned && component.syncDirection == SyncDirection.ClientToServer) + { + // set the n-th bit if dirty + // shifting from small to large numbers is varint-efficient. + if (component.IsDirty()) mask |= (1u << i); + } + } + + return mask; + } + + // check if n-th component is dirty. + // in other words, if it has the n-th bit set in the dirty mask. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + internal static bool IsDirty(ulong mask, int index) + { + ulong nthBit = (ulong)(1 << index); + return (mask & nthBit) != 0; + } + + // serialize components into writer on the server. + // check ownerWritten/observersWritten to know if anything was written + // We pass dirtyComponentsMask into this function so that we can check + // if any Components are dirty before creating writers + internal void SerializeServer(bool initialState, NetworkWriter ownerWriter, NetworkWriter observersWriter) + { + // ensure NetworkBehaviours are valid before usage + ValidateComponents(); + NetworkBehaviour[] components = NetworkBehaviours; + + // check which components are dirty for owner / observers. + // this is quite complicated with SyncMode + SyncDirection. + // see the function for explanation. + // + // instead of writing a 1 byte index per component, + // we limit components to 64 bits and write one ulong instead. + // the ulong is also varint compressed for minimum bandwidth. + (ulong ownerMask, ulong observerMask) = ServerDirtyMasks(initialState); + + // if nothing dirty, then don't even write the mask. + // otherwise, every unchanged object would send a 1 byte dirty mask! + if (ownerMask != 0) Compression.CompressVarUInt(ownerWriter, ownerMask); + if (observerMask != 0) Compression.CompressVarUInt(observersWriter, observerMask); + + // serialize all components + // perf: only iterate if either dirty mask has dirty bits. + if ((ownerMask | observerMask) != 0) + { + for (int i = 0; i < components.Length; ++i) + { + NetworkBehaviour comp = components[i]; + + // is the component dirty for anyone (owner or observers)? + // may be serialized to owner, observer, both, or neither. + // + // OnSerialize should only be called once. + // this is faster, and it cleaner because it may set + // internal state, counters, logs, etc. + // + // previously we always serialized to owner and then copied + // the serialization to observers. however, since + // SyncDirection it's not guaranteed to be in owner anymore. + // so we need to serialize to temporary writer first. + // and then copy as needed. + bool ownerDirty = IsDirty(ownerMask, i); + bool observersDirty = IsDirty(observerMask, i); + if (ownerDirty || observersDirty) + { + // serialize into helper writer + using (NetworkWriterPooled temp = NetworkWriterPool.Get()) + { + comp.Serialize(temp, initialState); + ArraySegment segment = temp.ToArraySegment(); + + // copy to owner / observers as needed + if (ownerDirty) ownerWriter.WriteBytes(segment.Array, segment.Offset, segment.Count); + if (observersDirty) observersWriter.WriteBytes(segment.Array, segment.Offset, segment.Count); + } + + // clear dirty bits for the components that we serialized. + // do not clear for _all_ components, only the ones that + // were dirty and had their syncInterval elapsed. + // + // we don't want to clear bits before the syncInterval + // was elapsed, as then they wouldn't be synced. + // + // only clear for delta, not for full (spawn messages). + // otherwise if a player joins, we serialize monster, + // and shouldn't clear dirty bits not yet synced to + // other players. + if (!initialState) comp.ClearAllDirtyBits(); + } + } + } + } + + // serialize components into writer on the client. + internal void SerializeClient(NetworkWriter writer) + { + // ensure NetworkBehaviours are valid before usage + ValidateComponents(); + NetworkBehaviour[] components = NetworkBehaviours; + + // check which components are dirty. + // this is quite complicated with SyncMode + SyncDirection. + // see the function for explanation. + // + // instead of writing a 1 byte index per component, + // we limit components to 64 bits and write one ulong instead. + // the ulong is also varint compressed for minimum bandwidth. + ulong dirtyMask = ClientDirtyMask(); + + // varint compresses the mask to 1 byte in most cases. + // instead of writing an 8 byte ulong. + // 7 components fit into 1 byte. (previously 7 bytes) + // 11 components fit into 2 bytes. (previously 11 bytes) + // 16 components fit into 3 bytes. (previously 16 bytes) + // TODO imer: server knows amount of comps, write N bytes instead + + // if nothing dirty, then don't even write the mask. + // otherwise, every unchanged object would send a 1 byte dirty mask! + if (dirtyMask != 0) Compression.CompressVarUInt(writer, dirtyMask); + + // serialize all components + // perf: only iterate if dirty mask has dirty bits. + if (dirtyMask != 0) + { + // serialize all components + for (int i = 0; i < components.Length; ++i) + { + NetworkBehaviour comp = components[i]; + + // is this component dirty? + // reuse the mask instead of calling comp.IsDirty() again here. + if (IsDirty(dirtyMask, i)) + // if (isOwned && component.syncDirection == SyncDirection.ClientToServer) + { + // serialize into writer. + // server always knows initialState, we never need to send it + comp.Serialize(writer, false); + + // clear dirty bits for the components that we serialized. + // do not clear for _all_ components, only the ones that + // were dirty and had their syncInterval elapsed. + // + // we don't want to clear bits before the syncInterval + // was elapsed, as then they wouldn't be synced. + comp.ClearAllDirtyBits(); + } + } + } + } + + // deserialize components from the client on the server. + // there's no 'initialState'. server always knows the initial state. + internal bool DeserializeServer(NetworkReader reader) + { + // ensure NetworkBehaviours are valid before usage + ValidateComponents(); + NetworkBehaviour[] components = NetworkBehaviours; + + // first we deserialize the varinted dirty mask + ulong mask = Compression.DecompressVarUInt(reader); + + // now deserialize every dirty component + for (int i = 0; i < components.Length; ++i) + { + // was this one dirty? + if (IsDirty(mask, i)) + { + NetworkBehaviour comp = components[i]; + + // safety check to ensure clients can only modify their own + // ClientToServer components, nothing else. + if (comp.syncDirection == SyncDirection.ClientToServer) + { + // deserialize this component + // server always knows the initial state (initial=false) + // disconnect if failed, to prevent exploits etc. + if (!comp.Deserialize(reader, false)) return false; + + // server received state from the owner client. + // set dirty so it's broadcast to other clients too. + // + // note that we set the _whole_ component as dirty. + // everything will be broadcast to others. + // SetSyncVarDirtyBits() would be nicer, but not all + // components use [SyncVar]s. + comp.SetDirty(); + } + } + } + + // successfully deserialized everything + return true; + } + + // deserialize components from server on the client. + internal void DeserializeClient(NetworkReader reader, bool initialState) + { + // ensure NetworkBehaviours are valid before usage + ValidateComponents(); + NetworkBehaviour[] components = NetworkBehaviours; + + // first we deserialize the varinted dirty mask + ulong mask = Compression.DecompressVarUInt(reader); + + // now deserialize every dirty component + for (int i = 0; i < components.Length; ++i) + { + // was this one dirty? + if (IsDirty(mask, i)) + { + // deserialize this component + NetworkBehaviour comp = components[i]; + comp.Deserialize(reader, initialState); + } + } + } + + // get cached serialization for this tick (or serialize if none yet). + // IMPORTANT: int tick avoids floating point inaccuracy over days/weeks. + // calls SerializeServer, so this function is to be called on server. + internal NetworkIdentitySerialization GetServerSerializationAtTick(int tick) + { + // only rebuild serialization once per tick. reuse otherwise. + // except for tests, where Time.frameCount never increases. + // so during tests, we always rebuild. + // (otherwise [SyncVar] changes would never be serialized in tests) + // + // NOTE: != instead of < because int.max+1 overflows at some point. + if (lastSerialization.tick != tick +#if UNITY_EDITOR + || !Application.isPlaying +#endif + ) + { + // reset + lastSerialization.ownerWriter.Position = 0; + lastSerialization.observersWriter.Position = 0; + + // serialize + SerializeServer(false, + lastSerialization.ownerWriter, + lastSerialization.observersWriter); + + // set tick + lastSerialization.tick = tick; + //Debug.Log($"{name} (netId={netId}) serialized for tick={tickTimeStamp}"); + } + + // return it + return lastSerialization; + } + + internal void AddObserver(NetworkConnectionToClient conn) + { + if (observers.ContainsKey(conn.connectionId)) + { + // if we try to add a connectionId that was already added, then + // we may have generated one that was already in use. + return; + } + + // Debug.Log($"Added observer: {conn.address} added for {gameObject}"); + + // if we previously had no observers, then clear all dirty bits once. + // a monster's health may have changed while it had no observers. + // but that change (= the dirty bits) don't matter as soon as the + // first observer comes. + // -> first observer gets full spawn packet + // -> afterwards it gets delta packet + // => if we don't clear previous dirty bits, observer would get + // the health change because the bit was still set. + // => ultimately this happens because spawn doesn't reset dirty + // bits + // => which happens because spawn happens separately, instead of + // in Broadcast() (which will be changed in the future) + // + // NOTE that NetworkServer.Broadcast previously cleared dirty bits + // for ALL SPAWNED that don't have observers. that was super + // expensive. doing it when adding the first observer has the + // same result, without the O(N) iteration in Broadcast(). + // + // TODO remove this after moving spawning into Broadcast()! + if (observers.Count == 0) + { + ClearAllComponentsDirtyBits(); + } + + observers[conn.connectionId] = conn; + conn.AddToObserving(this); + } + + // clear all component's dirty bits no matter what + internal void ClearAllComponentsDirtyBits() + { + foreach (NetworkBehaviour comp in NetworkBehaviours) + { + comp.ClearAllDirtyBits(); + } + } + + // this is used when a connection is destroyed, since the "observers" property is read-only + internal void RemoveObserver(NetworkConnection conn) + { + observers.Remove(conn.connectionId); + } + + /// Assign control of an object to a client via the client's NetworkConnection. + // This causes hasAuthority to be set on the client that owns the object, + // and NetworkBehaviour.OnStartAuthority will be called on that client. + // This object then will be in the NetworkConnection.clientOwnedObjects + // list for the connection. + // + // Authority can be removed with RemoveClientAuthority. Only one client + // can own an object at any time. This does not need to be called for + // player objects, as their authority is setup automatically. + public bool AssignClientAuthority(NetworkConnectionToClient conn) + { + if (!isServer) + { + Debug.LogError("AssignClientAuthority can only be called on the server for spawned objects."); + return false; + } + + if (conn == null) + { + Debug.LogError($"AssignClientAuthority for {gameObject} owner cannot be null. Use RemoveClientAuthority() instead."); + return false; + } + + if (connectionToClient != null && conn != connectionToClient) + { + Debug.LogError($"AssignClientAuthority for {gameObject} already has an owner. Use RemoveClientAuthority() first."); + return false; + } + + SetClientOwner(conn); + + // The client will match to the existing object + NetworkServer.SendChangeOwnerMessage(this, conn); + + clientAuthorityCallback?.Invoke(conn, this, true); + + return true; + } + + // used when adding players + internal void SetClientOwner(NetworkConnectionToClient conn) + { + // do nothing if it already has an owner + if (connectionToClient != null && conn != connectionToClient) + { + Debug.LogError($"Object {this} netId={netId} already has an owner. Use RemoveClientAuthority() first", this); + return; + } + + // otherwise set the owner connection + connectionToClient = conn; + } + + /// Removes ownership for an object. + // Applies to objects that had authority set by AssignClientAuthority, + // or NetworkServer.Spawn with a NetworkConnection parameter included. + // Authority cannot be removed for player objects. + public void RemoveClientAuthority() + { + if (!isServer) + { + Debug.LogError("RemoveClientAuthority can only be called on the server for spawned objects."); + return; + } + + if (connectionToClient?.identity == this) + { + Debug.LogError("RemoveClientAuthority cannot remove authority for a player object"); + return; + } + + if (connectionToClient != null) + { + clientAuthorityCallback?.Invoke(connectionToClient, this, false); + NetworkConnectionToClient previousOwner = connectionToClient; + connectionToClient = null; + NetworkServer.SendChangeOwnerMessage(this, previousOwner); + } + } + + // Reset is called when the user hits the Reset button in the + // Inspector's context menu or when adding the component the first time. + // This function is only called in editor mode. + // + // Reset() seems to be called only for Scene objects. + // we can't destroy them (they are always in the scene). + // instead we disable them and call Reset(). + // + // Do not reset SyncObjects from Reset + // - Unspawned objects need to retain their list contents + // - They may be respawned, especially players, but others as well. + // + // OLD COMMENT: + // Marks the identity for future reset, this is because we cant reset + // the identity during destroy as people might want to be able to read + // the members inside OnDestroy(), and we have no way of invoking reset + // after OnDestroy is called. + internal void Reset() + { + hasSpawned = false; + clientStarted = false; + isClient = false; + isServer = false; + //isLocalPlayer = false; <- cleared AFTER ClearLocalPlayer below! + + // remove authority flag. This object may be unspawned, not destroyed, on client. + isOwned = false; + NotifyAuthority(); + + netId = 0; + connectionToServer = null; + connectionToClient = null; + + ClearObservers(); + + // clear local player if it was the local player, + // THEN reset isLocalPlayer AFTERWARDS + if (isLocalPlayer) + { + // only clear NetworkClient.localPlayer IF IT POINTS TO US! + // see OnDestroy() comments. it does the same. + // (https://github.com/vis2k/Mirror/issues/2635) + if (NetworkClient.localPlayer == this) + NetworkClient.localPlayer = null; + } + + previousLocalPlayer = null; + isLocalPlayer = false; + } + + bool hadAuthority; + internal void NotifyAuthority() + { + if (!hadAuthority && isOwned) + OnStartAuthority(); + if (hadAuthority && !isOwned) + OnStopAuthority(); + hadAuthority = isOwned; + } + + internal void OnStartAuthority() + { + foreach (NetworkBehaviour comp in NetworkBehaviours) + { + // an exception in OnStartAuthority should be caught, so that one + // component's exception doesn't stop all other components from + // being initialized + // => this is what Unity does for Start() etc. too. + // one exception doesn't stop all the other Start() calls! + try + { + comp.OnStartAuthority(); + } + catch (Exception e) + { + Debug.LogException(e, comp); + } + } + } + + internal void OnStopAuthority() + { + foreach (NetworkBehaviour comp in NetworkBehaviours) + { + // an exception in OnStopAuthority should be caught, so that one + // component's exception doesn't stop all other components from + // being initialized + // => this is what Unity does for Start() etc. too. + // one exception doesn't stop all the other Start() calls! + try + { + comp.OnStopAuthority(); + } + catch (Exception e) + { + Debug.LogException(e, comp); + } + } + } + + // Called when NetworkIdentity is destroyed + internal void ClearObservers() + { + foreach (NetworkConnectionToClient conn in observers.Values) + { + conn.RemoveFromObserving(this, true); + } + observers.Clear(); + } + } +} diff --git a/Assets/Mirror/Core/NetworkIdentity.cs.meta b/Assets/Mirror/Core/NetworkIdentity.cs.meta new file mode 100644 index 0000000..7b96521 --- /dev/null +++ b/Assets/Mirror/Core/NetworkIdentity.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 9b91ecbcc199f4492b9a91e820070131 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkLoop.cs b/Assets/Mirror/Core/NetworkLoop.cs new file mode 100644 index 0000000..968bc00 --- /dev/null +++ b/Assets/Mirror/Core/NetworkLoop.cs @@ -0,0 +1,210 @@ +// our ideal update looks like this: +// transport.process_incoming() +// update_world() +// transport.process_outgoing() +// +// this way we avoid unnecessary latency for low-ish server tick rates. +// for example, if we were to use this tick: +// transport.process_incoming/outgoing() +// update_world() +// +// then anything sent in update_world wouldn't be actually sent out by the +// transport until the next frame. if server runs at 60Hz, then this can add +// 16ms latency for every single packet. +// +// => instead we process incoming, update world, process_outgoing in the same +// frame. it's more clear (no race conditions) and lower latency. +// => we need to add custom Update functions to the Unity engine: +// NetworkEarlyUpdate before Update()/FixedUpdate() +// NetworkLateUpdate after LateUpdate() +// this way the user can update the world in Update/FixedUpdate/LateUpdate +// and networking still runs before/after those functions no matter what! +// => see also: https://docs.unity3d.com/Manual/ExecutionOrder.html +// => update order: +// * we add to the end of EarlyUpdate so it runs after any Unity initializations +// * we add to the end of PreLateUpdate so it runs after LateUpdate(). adding +// to the beginning of PostLateUpdate doesn't actually work. +using System; +using UnityEngine; +using UnityEngine.LowLevel; +using UnityEngine.PlayerLoop; + +namespace Mirror +{ + public static class NetworkLoop + { + // helper enum to add loop to begin/end of subSystemList + internal enum AddMode { Beginning, End } + + // callbacks for others to hook into if they need Early/LateUpdate. + public static Action OnEarlyUpdate; + public static Action OnLateUpdate; + + // RuntimeInitializeOnLoadMethod -> fast playmode without domain reload + [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] + static void ResetStatics() + { + OnEarlyUpdate = null; + OnLateUpdate = null; + } + + // helper function to find an update function's index in a player loop + // type. this is used for testing to guarantee our functions are added + // at the beginning/end properly. + internal static int FindPlayerLoopEntryIndex(PlayerLoopSystem.UpdateFunction function, PlayerLoopSystem playerLoop, Type playerLoopSystemType) + { + // did we find the type? e.g. EarlyUpdate/PreLateUpdate/etc. + if (playerLoop.type == playerLoopSystemType) + return Array.FindIndex(playerLoop.subSystemList, (elem => elem.updateDelegate == function)); + + // recursively keep looking + if (playerLoop.subSystemList != null) + { + for (int i = 0; i < playerLoop.subSystemList.Length; ++i) + { + int index = FindPlayerLoopEntryIndex(function, playerLoop.subSystemList[i], playerLoopSystemType); + if (index != -1) return index; + } + } + return -1; + } + + // MODIFIED AddSystemToPlayerLoopList from Unity.Entities.ScriptBehaviourUpdateOrder (ECS) + // + // => adds an update function to the Unity internal update type. + // => Unity has different update loops: + // https://medium.com/@thebeardphantom/unity-2018-and-playerloop-5c46a12a677 + // EarlyUpdate + // FixedUpdate + // PreUpdate + // Update + // PreLateUpdate + // PostLateUpdate + // + // function: the custom update function to add + // IMPORTANT: according to a comment in Unity.Entities.ScriptBehaviourUpdateOrder, + // the UpdateFunction can not be virtual because + // Mono 4.6 has problems invoking virtual methods + // as delegates from native! + // ownerType: the .type to fill in so it's obvious who the new function + // belongs to. seems to be mostly for debugging. pass any. + // addMode: prepend or append to update list + internal static bool AddToPlayerLoop(PlayerLoopSystem.UpdateFunction function, Type ownerType, ref PlayerLoopSystem playerLoop, Type playerLoopSystemType, AddMode addMode) + { + // did we find the type? e.g. EarlyUpdate/PreLateUpdate/etc. + if (playerLoop.type == playerLoopSystemType) + { + // debugging + //Debug.Log($"Found playerLoop of type {playerLoop.type} with {playerLoop.subSystemList.Length} Functions:"); + //foreach (PlayerLoopSystem sys in playerLoop.subSystemList) + // Debug.Log($" ->{sys.type}"); + + // make sure the function wasn't added yet. + // with domain reload disabled, it would otherwise be added twice: + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3392 + if (Array.FindIndex(playerLoop.subSystemList, (s => s.updateDelegate == function)) != -1) + { + // loop contains the function, so return true. + return true; + } + + // resize & expand subSystemList to fit one more entry + int oldListLength = (playerLoop.subSystemList != null) ? playerLoop.subSystemList.Length : 0; + Array.Resize(ref playerLoop.subSystemList, oldListLength + 1); + + // IMPORTANT: always insert a FRESH PlayerLoopSystem! + // We CAN NOT resize and then OVERWRITE an entry's type/loop. + // => PlayerLoopSystem has native IntPtr loop members + // => forgetting to clear those would cause undefined behaviour! + // see also: https://github.com/vis2k/Mirror/pull/2652 + PlayerLoopSystem system = new PlayerLoopSystem { + type = ownerType, + updateDelegate = function + }; + + // prepend our custom loop to the beginning + if (addMode == AddMode.Beginning) + { + // shift to the right, write into first array element + Array.Copy(playerLoop.subSystemList, 0, playerLoop.subSystemList, 1, playerLoop.subSystemList.Length - 1); + playerLoop.subSystemList[0] = system; + } + // append our custom loop to the end + else if (addMode == AddMode.End) + { + // simply write into last array element + playerLoop.subSystemList[oldListLength] = system; + } + + // debugging + //Debug.Log($"New playerLoop of type {playerLoop.type} with {playerLoop.subSystemList.Length} Functions:"); + //foreach (PlayerLoopSystem sys in playerLoop.subSystemList) + // Debug.Log($" ->{sys.type}"); + + return true; + } + + // recursively keep looking + if (playerLoop.subSystemList != null) + { + for (int i = 0; i < playerLoop.subSystemList.Length; ++i) + { + if (AddToPlayerLoop(function, ownerType, ref playerLoop.subSystemList[i], playerLoopSystemType, addMode)) + return true; + } + } + return false; + } + + // hook into Unity runtime to actually add our custom functions + [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] + static void RuntimeInitializeOnLoad() + { + //Debug.Log("Mirror: adding Network[Early/Late]Update to Unity..."); + + // get loop + // 2019 has GetCURRENTPlayerLoop which is safe to use without + // breaking other custom system's custom loops. + // see also: https://github.com/vis2k/Mirror/pull/2627/files + PlayerLoopSystem playerLoop = PlayerLoop.GetCurrentPlayerLoop(); + + // add NetworkEarlyUpdate to the end of EarlyUpdate so it runs after + // any Unity initializations but before the first Update/FixedUpdate + AddToPlayerLoop(NetworkEarlyUpdate, typeof(NetworkLoop), ref playerLoop, typeof(EarlyUpdate), AddMode.End); + + // add NetworkLateUpdate to the end of PreLateUpdate so it runs after + // LateUpdate(). adding to the beginning of PostLateUpdate doesn't + // actually work. + AddToPlayerLoop(NetworkLateUpdate, typeof(NetworkLoop), ref playerLoop, typeof(PreLateUpdate), AddMode.End); + + // set the new loop + PlayerLoop.SetPlayerLoop(playerLoop); + } + + static void NetworkEarlyUpdate() + { + // loop functions run in edit mode and in play mode. + // however, we only want to call NetworkServer/Client in play mode. + if (!Application.isPlaying) return; + + //Debug.Log($"NetworkEarlyUpdate {Time.time}"); + NetworkServer.NetworkEarlyUpdate(); + NetworkClient.NetworkEarlyUpdate(); + // invoke event after mirror has done it's early updating. + OnEarlyUpdate?.Invoke(); + } + + static void NetworkLateUpdate() + { + // loop functions run in edit mode and in play mode. + // however, we only want to call NetworkServer/Client in play mode. + if (!Application.isPlaying) return; + + //Debug.Log($"NetworkLateUpdate {Time.time}"); + // invoke event before mirror does its final late updating. + OnLateUpdate?.Invoke(); + NetworkServer.NetworkLateUpdate(); + NetworkClient.NetworkLateUpdate(); + } + } +} diff --git a/Assets/Mirror/Core/NetworkLoop.cs.meta b/Assets/Mirror/Core/NetworkLoop.cs.meta new file mode 100644 index 0000000..52b6e6a --- /dev/null +++ b/Assets/Mirror/Core/NetworkLoop.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2c6cec4e279774b919386e05545317b8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkManager.cs b/Assets/Mirror/Core/NetworkManager.cs new file mode 100644 index 0000000..98ec25d --- /dev/null +++ b/Assets/Mirror/Core/NetworkManager.cs @@ -0,0 +1,1467 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using UnityEngine; +using UnityEngine.SceneManagement; +using UnityEngine.Serialization; + +namespace Mirror +{ + public enum PlayerSpawnMethod { Random, RoundRobin } + public enum NetworkManagerMode { Offline, ServerOnly, ClientOnly, Host } + + [DisallowMultipleComponent] + [AddComponentMenu("Network/Network Manager")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-manager")] + public class NetworkManager : MonoBehaviour + { + /// Enable to keep NetworkManager alive when changing scenes. + // This should be set if your game has a single NetworkManager that exists for the lifetime of the process. If there is a NetworkManager in each scene, then this should not be set. + [Header("Configuration")] + [FormerlySerializedAs("m_DontDestroyOnLoad")] + [Tooltip("Should the Network Manager object be persisted through scene changes?")] + public bool dontDestroyOnLoad = true; + + /// Multiplayer games should always run in the background so the network doesn't time out. + [FormerlySerializedAs("m_RunInBackground")] + [Tooltip("Multiplayer games should always run in the background so the network doesn't time out.")] + public bool runInBackground = true; + + /// Should the server auto-start when 'Server Build' is checked in build settings + [Header("Headless Builds")] + [Tooltip("Should the server auto-start when 'Server Build' is checked in build settings")] + [FormerlySerializedAs("startOnHeadless")] + public bool autoStartServerBuild = true; + + [Tooltip("Automatically connect the client in headless builds. Useful for CCU tests with bot clients.\n\nAddress may be passed as command line argument.\n\nMake sure that only 'autostartServer' or 'autoconnectClient' is enabled, not both!")] + public bool autoConnectClientBuild; + + /// Server Update frequency, per second. Use around 60Hz for fast paced games like Counter-Strike to minimize latency. Use around 30Hz for games like WoW to minimize computations. Use around 1-10Hz for slow paced games like EVE. + [Tooltip("Server & Client send rate per second. Use 60-100Hz for fast paced games like Counter-Strike to minimize latency. Use around 30Hz for games like WoW to minimize computations. Use around 1-10Hz for slow paced games like EVE.")] + [FormerlySerializedAs("serverTickRate")] + public int sendRate = 60; + + // Deprecated 2022-10-31 + [Obsolete("NetworkManager.serverTickRate was renamed to sendRate because that's what it configures for both server & client now.")] + public int serverTickRate => sendRate; + + // tick rate is in Hz. + // convert to interval in seconds for convenience where needed. + // + // send interval is 1 / sendRate. + // but for tests we need a way to set it to exactly 0. + // 1 / int.max would not be exactly 0, so handel that manually. + // Deprecated 2022-10-06 + [Obsolete("NetworkManager.serverTickInterval was moved to NetworkServer.tickInterval for consistency.")] + public float serverTickInterval => NetworkServer.tickInterval; + + // client send rate follows server send rate to avoid errors for now + /// Client Update frequency, per second. Use around 60Hz for fast paced games like Counter-Strike to minimize latency. Use around 30Hz for games like WoW to minimize computations. Use around 1-10Hz for slow paced games like EVE. + // [Tooltip("Client broadcasts 'sendRate' times per second. Use around 60Hz for fast paced games like Counter-Strike to minimize latency. Use around 30Hz for games like WoW to minimize computations. Use around 1-10Hz for slow paced games like EVE.")] + // public int clientSendRate = 30; // 33 ms + + /// Automatically switch to this scene upon going offline (on start / on disconnect / on shutdown). + [Header("Scene Management")] + [Scene] + [FormerlySerializedAs("m_OfflineScene")] + [Tooltip("Scene that Mirror will switch to when the client or server is stopped")] + public string offlineScene = ""; + + /// Automatically switch to this scene upon going online (after connect/startserver). + [Scene] + [FormerlySerializedAs("m_OnlineScene")] + [Tooltip("Scene that Mirror will switch to when the server is started. Clients will recieve a Scene Message to load the server's current scene when they connect.")] + public string onlineScene = ""; + + // transport layer + [Header("Network Info")] + [Tooltip("Transport component attached to this object that server and client will use to connect")] + public Transport transport; + + /// Server's address for clients to connect to. + [FormerlySerializedAs("m_NetworkAddress")] + [Tooltip("Network Address where the client should connect to the server. Server does not use this for anything.")] + public string networkAddress = "localhost"; + + /// The maximum number of concurrent network connections to support. + [FormerlySerializedAs("m_MaxConnections")] + [Tooltip("Maximum number of concurrent connections.")] + public int maxConnections = 100; + + // Mirror global disconnect inactive option, independent of Transport. + // not all Transports do this properly, and it's easiest to configure this just once. + // this is very useful for some projects, keep it. + [Tooltip("When enabled, the server automatically disconnects inactive connections after the configured timeout.")] + public bool disconnectInactiveConnections; + + [Tooltip("Timeout in seconds for server to automatically disconnect inactive connections if 'disconnectInactiveConnections' is enabled.")] + public float disconnectInactiveTimeout = 60f; + + [Header("Authentication")] + [Tooltip("Authentication component attached to this object")] + public NetworkAuthenticator authenticator; + + /// The default prefab to be used to create player objects on the server. + // Player objects are created in the default handler for AddPlayer() on + // the server. Implementing OnServerAddPlayer overrides this behaviour. + [Header("Player Object")] + [FormerlySerializedAs("m_PlayerPrefab")] + [Tooltip("Prefab of the player object. Prefab must have a Network Identity component. May be an empty game object or a full avatar.")] + public GameObject playerPrefab; + + /// Enable to automatically create player objects on connect and on scene change. + [FormerlySerializedAs("m_AutoCreatePlayer")] + [Tooltip("Should Mirror automatically spawn the player after scene change?")] + public bool autoCreatePlayer = true; + + /// Where to spawn players. + [FormerlySerializedAs("m_PlayerSpawnMethod")] + [Tooltip("Round Robin or Random order of Start Position selection")] + public PlayerSpawnMethod playerSpawnMethod; + + /// Prefabs that can be spawned over the network need to be registered here. + [FormerlySerializedAs("m_SpawnPrefabs"), HideInInspector] + public List spawnPrefabs = new List(); + + /// List of transforms populated by NetworkStartPositions + public static List startPositions = new List(); + public static int startPositionIndex; + + [Header("Snapshot Interpolation")] + public SnapshotInterpolationSettings snapshotSettings = new SnapshotInterpolationSettings(); + + [Header("Connection Quality")] + public float connectionQualityInterval = 3; + double lastConnectionQualityUpdate; + ConnectionQuality lastConnectionQuality = ConnectionQuality.ESTIMATING; + + [Header("Debug")] + public bool timeInterpolationGui = false; + + /// The one and only NetworkManager + public static NetworkManager singleton { get; internal set; } + + /// Number of active player objects across all connections on the server. + public int numPlayers => NetworkServer.connections.Count(kv => kv.Value.identity != null); + + /// True if the server is running or client is connected/connecting. + public bool isNetworkActive => NetworkServer.active || NetworkClient.active; + + // TODO remove this + // internal for tests + internal static NetworkConnection clientReadyConnection; + + /// True if the client loaded a new scene when connecting to the server. + // This is set before OnClientConnect is called, so it can be checked + // there to perform different logic if a scene load occurred. + protected bool clientLoadedScene; + + // helper enum to know if we started the networkmanager as server/client/host. + // -> this is necessary because when StartHost changes server scene to + // online scene, FinishLoadScene is called and the host client isn't + // connected yet (no need to connect it before server was fully set up). + // in other words, we need this to know which mode we are running in + // during FinishLoadScene. + public NetworkManagerMode mode { get; private set; } + + // virtual so that inheriting classes' OnValidate() can call base.OnValidate() too + public virtual void OnValidate() + { + // always >= 0 + maxConnections = Mathf.Max(maxConnections, 0); + + if (playerPrefab != null && !playerPrefab.TryGetComponent(out NetworkIdentity _)) + { + Debug.LogError("NetworkManager - Player Prefab must have a NetworkIdentity."); + playerPrefab = null; + } + + // This avoids the mysterious "Replacing existing prefab with assetId ... Old prefab 'Player', New prefab 'Player'" warning. + if (playerPrefab != null && spawnPrefabs.Contains(playerPrefab)) + { + Debug.LogWarning("NetworkManager - Player Prefab should not be added to Registered Spawnable Prefabs list...removed it."); + spawnPrefabs.Remove(playerPrefab); + } + } + + // virtual so that inheriting classes' Reset() can call base.Reset() too + // Reset only gets called when the component is added or the user resets the component + // Thats why we validate these things that only need to be validated on adding the NetworkManager here + // If we would do it in OnValidate() then it would run this everytime a value changes + public virtual void Reset() + { + // make sure someone doesn't accidentally add another NetworkManager + // need transform.root because when adding to a child, the parent's + // Reset isn't called. + foreach (NetworkManager manager in transform.root.GetComponentsInChildren()) + { + if (manager != this) + { + Debug.LogError($"{name} detected another component of type {typeof(NetworkManager)} in its hierarchy on {manager.name}. There can only be one, please remove one of them."); + // return early so that transport component isn't auto-added + // to the duplicate NetworkManager. + return; + } + } + } + + // virtual so that inheriting classes' Awake() can call base.Awake() too + public virtual void Awake() + { + // Don't allow collision-destroyed second instance to continue. + if (!InitializeSingleton()) return; + + // Apply configuration in Awake once already + ApplyConfiguration(); + + // Set the networkSceneName to prevent a scene reload + // if client connection to server fails. + networkSceneName = offlineScene; + + // setup OnSceneLoaded callback + SceneManager.sceneLoaded += OnSceneLoaded; + } + + // virtual so that inheriting classes' Start() can call base.Start() too + public virtual void Start() + { + // headless mode? then start the server + // can't do this in Awake because Awake is for initialization. + // some transports might not be ready until Start. + // + // (tick rate is applied in StartServer!) +#if UNITY_SERVER + if (autoStartServerBuild) + { + StartServer(); + } + // only start server or client, never both + else if (autoConnectClientBuild) + { + StartClient(); + } +#endif + } + + // make sure to call base.Update() when overwriting + public virtual void Update() + { + ApplyConfiguration(); + } + + // virtual so that inheriting classes' LateUpdate() can call base.LateUpdate() too + public virtual void LateUpdate() + { + UpdateScene(); + UpdateConnectionQuality(); + } + + // Connection Quality ////////////////////////////////////////////////// + // uses 'pragmatic' version based on snapshot interpolation by default. + void UpdateConnectionQuality() + { + if (!NetworkClient.active) return; + + // only recalculate every few seconds + // we don't want to fire Good->Bad->Good->Bad hundreds of times per second. + if (NetworkTime.time < lastConnectionQualityUpdate + connectionQualityInterval) return; + lastConnectionQualityUpdate = NetworkTime.time; + + // recaclulate connection quality + CalculateConnectionQuality(); + + // call event if changed + if (NetworkClient.connectionQuality != lastConnectionQuality) + { + OnConnectionQualityChanged(lastConnectionQuality, NetworkClient.connectionQuality); + lastConnectionQuality = NetworkClient.connectionQuality; + } + } + + // users can overwrite this to run their own connection quality estimation. + protected virtual void CalculateConnectionQuality() + { + // NetworkClient.connectionQuality = ConnectionQualityHeuristics.Pragmatic(NetworkClient.initialBufferTime, NetworkClient.bufferTime); + NetworkClient.connectionQuality = ConnectionQualityHeuristics.Simple(NetworkTime.rtt, NetworkTime.rttVariance); + } + + // users can overwrite this to display connection quality warnings, etc. + protected virtual void OnConnectionQualityChanged(ConnectionQuality previous, ConnectionQuality current) + { + Debug.Log($"[Mirror] Connection Quality changed from {previous} to {current}"); + } + + //////////////////////////////////////////////////////////////////////// + + // keep the online scene change check in a separate function. + // only change scene if the requested online scene is not blank, and is not already loaded. + bool IsServerOnlineSceneChangeNeeded() => + !string.IsNullOrWhiteSpace(onlineScene) && + !Utils.IsSceneActive(onlineScene) && + onlineScene != offlineScene; + + // Deprecated 2022-12-12 + [Obsolete("NetworkManager.IsSceneActive moved to Utils.IsSceneActive")] + public static bool IsSceneActive(string scene) => Utils.IsSceneActive(scene); + + // NetworkManager exposes some NetworkServer/Client configuration. + // we apply it every Update() in order to avoid two sources of truth. + // fixes issues where NetworkServer.sendRate was never set because + // NetworkManager.StartServer was never called, etc. + // => all exposed settings should be applied at all times if NM exists. + void ApplyConfiguration() + { + NetworkServer.tickRate = sendRate; + NetworkClient.snapshotSettings = snapshotSettings; + } + + // full server setup code, without spawning objects yet + void SetupServer() + { + // Debug.Log("NetworkManager SetupServer"); + InitializeSingleton(); + + if (runInBackground) + Application.runInBackground = true; + + if (authenticator != null) + { + authenticator.OnStartServer(); + authenticator.OnServerAuthenticated.AddListener(OnServerAuthenticated); + } + + ConfigureHeadlessFrameRate(); + + NetworkServer.disconnectInactiveConnections = disconnectInactiveConnections; + NetworkServer.disconnectInactiveTimeout = disconnectInactiveTimeout; + + // start listening to network connections + NetworkServer.Listen(maxConnections); + + // this must be after Listen(), since that registers the default message handlers + RegisterServerMessages(); + + // do not call OnStartServer here yet. + // this is up to the caller. different for server-only vs. host mode. + } + + /// Starts the server, listening for incoming connections. + public void StartServer() + { + if (NetworkServer.active) + { + Debug.LogWarning("Server already started."); + return; + } + + mode = NetworkManagerMode.ServerOnly; + + // StartServer is inherently ASYNCHRONOUS (=doesn't finish immediately) + // + // Here is what it does: + // Listen + // if onlineScene: + // LoadSceneAsync + // ... + // FinishLoadSceneServerOnly + // SpawnObjects + // else: + // SpawnObjects + // + // there is NO WAY to make it synchronous because both LoadSceneAsync + // and LoadScene do not finish loading immediately. as long as we + // have the onlineScene feature, it will be asynchronous! + + SetupServer(); + + // call OnStartServer AFTER Listen, so that NetworkServer.active is + // true and we can call NetworkServer.Spawn in OnStartServer + // overrides. + // (useful for loading & spawning stuff from database etc.) + // + // note: there is no risk of someone connecting after Listen() and + // before OnStartServer() because this all runs in one thread + // and we don't start processing connects until Update. + OnStartServer(); + + // scene change needed? then change scene and spawn afterwards. + if (IsServerOnlineSceneChangeNeeded()) + { + ServerChangeScene(onlineScene); + } + // otherwise spawn directly + else + { + NetworkServer.SpawnObjects(); + } + } + + void SetupClient() + { + InitializeSingleton(); + + if (runInBackground) + Application.runInBackground = true; + + if (authenticator != null) + { + authenticator.OnStartClient(); + authenticator.OnClientAuthenticated.AddListener(OnClientAuthenticated); + } + + // NetworkClient.sendRate = clientSendRate; + } + + /// Starts the client, connects it to the server with networkAddress. + public void StartClient() + { + if (NetworkClient.active) + { + Debug.LogWarning("Client already started."); + return; + } + + mode = NetworkManagerMode.ClientOnly; + + SetupClient(); + + // In case this is a headless client... + ConfigureHeadlessFrameRate(); + + RegisterClientMessages(); + + if (string.IsNullOrWhiteSpace(networkAddress)) + { + Debug.LogError("Must set the Network Address field in the manager"); + return; + } + // Debug.Log($"NetworkManager StartClient address:{networkAddress}"); + + NetworkClient.Connect(networkAddress); + + OnStartClient(); + } + + /// Starts the client, connects it to the server via Uri + public void StartClient(Uri uri) + { + if (NetworkClient.active) + { + Debug.LogWarning("Client already started."); + return; + } + + mode = NetworkManagerMode.ClientOnly; + + SetupClient(); + + RegisterClientMessages(); + + // Debug.Log($"NetworkManager StartClient address:{uri}"); + networkAddress = uri.Host; + + NetworkClient.Connect(uri); + + OnStartClient(); + } + + /// Starts a network "host" - a server and client in the same application. + public void StartHost() + { + if (NetworkServer.active || NetworkClient.active) + { + Debug.LogWarning("Server or Client already started."); + return; + } + + mode = NetworkManagerMode.Host; + + // StartHost is inherently ASYNCHRONOUS (=doesn't finish immediately) + // + // Here is what it does: + // Listen + // ConnectHost + // if onlineScene: + // LoadSceneAsync + // ... + // FinishLoadSceneHost + // FinishStartHost + // SpawnObjects + // StartHostClient <= not guaranteed to happen after SpawnObjects if onlineScene is set! + // ClientAuth + // success: server sends changescene msg to client + // else: + // FinishStartHost + // + // there is NO WAY to make it synchronous because both LoadSceneAsync + // and LoadScene do not finish loading immediately. as long as we + // have the onlineScene feature, it will be asynchronous! + + // setup server first + SetupServer(); + + // scene change needed? then change scene and spawn afterwards. + // => BEFORE host client connects. if client auth succeeds then the + // server tells it to load 'onlineScene'. we can't do that if + // server is still in 'offlineScene'. so load on server first. + if (IsServerOnlineSceneChangeNeeded()) + { + // call FinishStartHost after changing scene. + finishStartHostPending = true; + ServerChangeScene(onlineScene); + } + // otherwise call FinishStartHost directly + else + { + FinishStartHost(); + } + } + + // This may be set true in StartHost and is evaluated in FinishStartHost + bool finishStartHostPending; + + // FinishStartHost is guaranteed to be called after the host server was + // fully started and all the asynchronous StartHost magic is finished + // (= scene loading), or immediately if there was no asynchronous magic. + // + // note: we don't really need FinishStartClient/FinishStartServer. the + // host version is enough. + void FinishStartHost() + { + // ConnectHost needs to be called BEFORE SpawnObjects: + // https://github.com/vis2k/Mirror/pull/1249/ + // -> this sets NetworkServer.localConnection. + // -> localConnection needs to be set before SpawnObjects because: + // -> SpawnObjects calls OnStartServer in all NetworkBehaviours + // -> OnStartServer might spawn an object and set [SyncVar(hook="OnColorChanged")] object.color = green; + // -> this calls SyncVar.set (generated by Weaver), which has + // a custom case for host mode (because host mode doesn't + // get OnDeserialize calls, where SyncVar hooks are usually + // called): + // + // if (!SyncVarEqual(value, ref color)) + // { + // if (NetworkServer.localClientActive && !getSyncVarHookGuard(1uL)) + // { + // setSyncVarHookGuard(1uL, value: true); + // OnColorChangedHook(value); + // setSyncVarHookGuard(1uL, value: false); + // } + // SetSyncVar(value, ref color, 1uL); + // } + // + // -> localClientActive needs to be true, otherwise the hook + // isn't called in host mode! + // + // TODO call this after spawnobjects and worry about the syncvar hook fix later? + NetworkClient.ConnectHost(); + + // invoke user callbacks AFTER ConnectHost has set .activeHost. + // this way initialization can properly handle host mode. + // + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3302 + // where [SyncVar] hooks wouldn't be called for objects spawned in + // NetworkManager.OnStartServer, because .activeHost was still false. + // + // TODO is there a risk of someone connecting between Listen() and FinishStartHost()? + OnStartServer(); + + // call OnStartHost AFTER SetupServer. this way we can use + // NetworkServer.Spawn etc. in there too. just like OnStartServer + // is called after the server is actually properly started. + OnStartHost(); + + // server scene was loaded. now spawn all the objects + NetworkServer.SpawnObjects(); + + // connect client and call OnStartClient AFTER server scene was + // loaded and all objects were spawned. + // DO NOT do this earlier. it would cause race conditions where a + // client will do things before the server is even fully started. + //Debug.Log("StartHostClient called"); + SetupClient(); + + networkAddress = "localhost"; + RegisterClientMessages(); + + // call OnConencted needs to be called AFTER RegisterClientMessages + // (https://github.com/vis2k/Mirror/pull/1249/) + HostMode.InvokeOnConnected(); + + OnStartClient(); + } + + /// This stops both the client and the server that the manager is using. + public void StopHost() + { + OnStopHost(); + StopClient(); + StopServer(); + } + + /// Stops the server from listening and simulating the game. + public void StopServer() + { + // return if already stopped to avoid recursion deadlock + if (!NetworkServer.active) + return; + + if (authenticator != null) + { + authenticator.OnServerAuthenticated.RemoveListener(OnServerAuthenticated); + authenticator.OnStopServer(); + } + + // Get Network Manager out of DDOL before going to offline scene + // to avoid collision and let a fresh Network Manager be created. + // IMPORTANT: .gameObject can be null if StopClient is called from + // OnApplicationQuit or from tests! + if (gameObject != null + && gameObject.scene.name == "DontDestroyOnLoad" + && !string.IsNullOrWhiteSpace(offlineScene) + && SceneManager.GetActiveScene().path != offlineScene) + SceneManager.MoveGameObjectToScene(gameObject, SceneManager.GetActiveScene()); + + OnStopServer(); + + //Debug.Log("NetworkManager StopServer"); + NetworkServer.Shutdown(); + + // set offline mode BEFORE changing scene so that FinishStartScene + // doesn't think we need initialize anything. + mode = NetworkManagerMode.Offline; + + if (!string.IsNullOrWhiteSpace(offlineScene)) + { + ServerChangeScene(offlineScene); + } + + startPositionIndex = 0; + + networkSceneName = ""; + } + + /// Stops and disconnects the client. + public void StopClient() + { + if (mode == NetworkManagerMode.Offline) + return; + + // For Host client, call OnServerDisconnect before NetworkClient.Disconnect + // because we need NetworkServer.localConnection to not be null + // NetworkClient.Disconnect will set it null. + if (mode == NetworkManagerMode.Host) + OnServerDisconnect(NetworkServer.localConnection); + + // ask client -> transport to disconnect. + // handle voluntary and involuntary disconnects in OnClientDisconnect. + // + // StopClient + // NetworkClient.Disconnect + // Transport.Disconnect + // ... + // Transport.OnClientDisconnect + // NetworkClient.OnTransportDisconnect + // NetworkManager.OnClientDisconnect + NetworkClient.Disconnect(); + + // UNET invoked OnDisconnected cleanup immediately. + // let's keep it for now, in case any projects depend on it. + // TODO simply remove this in the future. + OnClientDisconnectInternal(); + } + + // called when quitting the application by closing the window / pressing + // stop in the editor. virtual so that inheriting classes' + // OnApplicationQuit() can call base.OnApplicationQuit() too + public virtual void OnApplicationQuit() + { + // stop client first + // (we want to send the quit packet to the server instead of waiting + // for a timeout) + if (NetworkClient.isConnected) + { + StopClient(); + //Debug.Log("OnApplicationQuit: stopped client"); + } + + // stop server after stopping client (for proper host mode stopping) + if (NetworkServer.active) + { + StopServer(); + //Debug.Log("OnApplicationQuit: stopped server"); + } + + // Call ResetStatics to reset statics and singleton + ResetStatics(); + } + + /// Set the frame rate for a headless builds. Override to disable or modify. + // useful for dedicated servers. + // useful for headless benchmark clients. + public virtual void ConfigureHeadlessFrameRate() + { +#if UNITY_SERVER + Application.targetFrameRate = sendRate; + // Debug.Log($"Server Tick Rate set to {Application.targetFrameRate} Hz."); +#endif + } + + bool InitializeSingleton() + { + if (singleton != null && singleton == this) + return true; + + if (dontDestroyOnLoad) + { + if (singleton != null) + { + Debug.LogWarning("Multiple NetworkManagers detected in the scene. Only one NetworkManager can exist at a time. The duplicate NetworkManager will be destroyed."); + Destroy(gameObject); + + // Return false to not allow collision-destroyed second instance to continue. + return false; + } + //Debug.Log("NetworkManager created singleton (DontDestroyOnLoad)"); + singleton = this; + if (Application.isPlaying) + { + // Force the object to scene root, in case user made it a child of something + // in the scene since DDOL is only allowed for scene root objects + transform.SetParent(null); + DontDestroyOnLoad(gameObject); + } + } + else + { + //Debug.Log("NetworkManager created singleton (ForScene)"); + singleton = this; + } + + // set active transport AFTER setting singleton. + // so only if we didn't destroy ourselves. + + // This tries to avoid missing transport errors and more clearly tells user what to fix. + if (transport == null) + if (TryGetComponent(out Transport newTransport)) + { + Debug.LogWarning($"No Transport assigned to Network Manager - Using {newTransport} found on same object."); + transport = newTransport; + } + else + { + Debug.LogError("No Transport on Network Manager...add a transport and assign it."); + return false; + } + + Transport.active = transport; + return true; + } + + void RegisterServerMessages() + { + NetworkServer.OnConnectedEvent = OnServerConnectInternal; + NetworkServer.OnDisconnectedEvent = OnServerDisconnect; + NetworkServer.OnErrorEvent = OnServerError; + NetworkServer.RegisterHandler(OnServerAddPlayerInternal); + + // Network Server initially registers its own handler for this, so we replace it here. + NetworkServer.ReplaceHandler(OnServerReadyMessageInternal); + } + + void RegisterClientMessages() + { + NetworkClient.OnConnectedEvent = OnClientConnectInternal; + NetworkClient.OnDisconnectedEvent = OnClientDisconnectInternal; + NetworkClient.OnErrorEvent = OnClientError; + NetworkClient.RegisterHandler(OnClientNotReadyMessageInternal); + NetworkClient.RegisterHandler(OnClientSceneInternal, false); + + if (playerPrefab != null) + NetworkClient.RegisterPrefab(playerPrefab); + + foreach (GameObject prefab in spawnPrefabs.Where(t => t != null)) + NetworkClient.RegisterPrefab(prefab); + } + + // This is the only way to clear the singleton, so another instance can be created. + // RuntimeInitializeOnLoadMethod -> fast playmode without domain reload + [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] + public static void ResetStatics() + { + // call StopHost if we have a singleton + if (singleton) + singleton.StopHost(); + + // reset all statics + startPositions.Clear(); + startPositionIndex = 0; + clientReadyConnection = null; + loadingSceneAsync = null; + networkSceneName = string.Empty; + + // and finally (in case it isn't null already)... + singleton = null; + } + + // virtual so that inheriting classes' OnDestroy() can call base.OnDestroy() too + public virtual void OnDestroy() + { + //Debug.Log("NetworkManager destroyed"); + } + + /// The name of the current network scene. + // set by NetworkManager when changing the scene. + // new clients will automatically load this scene. + // Loading a scene manually won't set it. + public static string networkSceneName { get; protected set; } = ""; + + public static AsyncOperation loadingSceneAsync; + + /// Change the server scene and all client's scenes across the network. + // Called automatically if onlineScene or offlineScene are set, but it + // can be called from user code to switch scenes again while the game is + // in progress. This automatically sets clients to be not-ready during + // the change and ready again to participate in the new scene. + public virtual void ServerChangeScene(string newSceneName) + { + if (string.IsNullOrWhiteSpace(newSceneName)) + { + Debug.LogError("ServerChangeScene empty scene name"); + return; + } + + if (NetworkServer.isLoadingScene && newSceneName == networkSceneName) + { + Debug.LogError($"Scene change is already in progress for {newSceneName}"); + return; + } + + // Debug.Log($"ServerChangeScene {newSceneName}"); + NetworkServer.SetAllClientsNotReady(); + networkSceneName = newSceneName; + + // Let server prepare for scene change + OnServerChangeScene(newSceneName); + + // set server flag to stop processing messages while changing scenes + // it will be re-enabled in FinishLoadScene. + NetworkServer.isLoadingScene = true; + + loadingSceneAsync = SceneManager.LoadSceneAsync(newSceneName); + + // ServerChangeScene can be called when stopping the server + // when this happens the server is not active so does not need to tell clients about the change + if (NetworkServer.active) + { + // notify all clients about the new scene + NetworkServer.SendToAll(new SceneMessage + { + sceneName = newSceneName + }); + } + + startPositionIndex = 0; + startPositions.Clear(); + } + + // This is only set in ClientChangeScene below...never on server. + // We need to check this in OnClientSceneChanged called from FinishLoadSceneClientOnly + // to prevent AddPlayer message after loading/unloading additive scenes + SceneOperation clientSceneOperation = SceneOperation.Normal; + + internal void ClientChangeScene(string newSceneName, SceneOperation sceneOperation = SceneOperation.Normal, bool customHandling = false) + { + if (string.IsNullOrWhiteSpace(newSceneName)) + { + Debug.LogError("ClientChangeScene empty scene name"); + return; + } + + //Debug.Log($"ClientChangeScene newSceneName: {newSceneName} networkSceneName{networkSceneName}"); + + // Let client prepare for scene change + OnClientChangeScene(newSceneName, sceneOperation, customHandling); + + // After calling OnClientChangeScene, exit if server since server is already doing + // the actual scene change, and we don't need to do it for the host client + if (NetworkServer.active) + return; + + // set client flag to stop processing messages while loading scenes. + // otherwise we would process messages and then lose all the state + // as soon as the load is finishing, causing all kinds of bugs + // because of missing state. + // (client may be null after StopClient etc.) + // Debug.Log("ClientChangeScene: pausing handlers while scene is loading to avoid data loss after scene was loaded."); + NetworkClient.isLoadingScene = true; + + // Cache sceneOperation so we know what was requested by the + // Scene message in OnClientChangeScene and OnClientSceneChanged + clientSceneOperation = sceneOperation; + + // scene handling will happen in overrides of OnClientChangeScene and/or OnClientSceneChanged + // Do not call FinishLoadScene here. Custom handler will assign loadingSceneAsync and we need + // to wait for that to finish. UpdateScene already checks for that to be not null and isDone. + if (customHandling) + return; + + switch (sceneOperation) + { + case SceneOperation.Normal: + loadingSceneAsync = SceneManager.LoadSceneAsync(newSceneName); + break; + case SceneOperation.LoadAdditive: + // Ensure additive scene is not already loaded on client by name or path + // since we don't know which was passed in the Scene message + if (!SceneManager.GetSceneByName(newSceneName).IsValid() && !SceneManager.GetSceneByPath(newSceneName).IsValid()) + loadingSceneAsync = SceneManager.LoadSceneAsync(newSceneName, LoadSceneMode.Additive); + else + { + Debug.LogWarning($"Scene {newSceneName} is already loaded"); + + // Reset the flag that we disabled before entering this switch + NetworkClient.isLoadingScene = false; + } + break; + case SceneOperation.UnloadAdditive: + // Ensure additive scene is actually loaded on client by name or path + // since we don't know which was passed in the Scene message + if (SceneManager.GetSceneByName(newSceneName).IsValid() || SceneManager.GetSceneByPath(newSceneName).IsValid()) + loadingSceneAsync = SceneManager.UnloadSceneAsync(newSceneName, UnloadSceneOptions.UnloadAllEmbeddedSceneObjects); + else + { + Debug.LogWarning($"Cannot unload {newSceneName} with UnloadAdditive operation"); + + // Reset the flag that we disabled before entering this switch + NetworkClient.isLoadingScene = false; + } + break; + } + + // don't change the client's current networkSceneName when loading additive scene content + if (sceneOperation == SceneOperation.Normal) + networkSceneName = newSceneName; + } + + // support additive scene loads: + // NetworkScenePostProcess disables all scene objects on load, and + // * NetworkServer.SpawnObjects enables them again on the server when + // calling OnStartServer + // * NetworkClient.PrepareToSpawnSceneObjects enables them again on the + // client after the server sends ObjectSpawnStartedMessage to client + // in SpawnObserversForConnection. this is only called when the + // client joins, so we need to rebuild scene objects manually again + // TODO merge this with FinishLoadScene()? + void OnSceneLoaded(Scene scene, LoadSceneMode mode) + { + if (mode == LoadSceneMode.Additive) + { + if (NetworkServer.active) + { + // TODO only respawn the server objects from that scene later! + NetworkServer.SpawnObjects(); + // Debug.Log($"Respawned Server objects after additive scene load: {scene.name}"); + } + if (NetworkClient.active) + { + NetworkClient.PrepareToSpawnSceneObjects(); + // Debug.Log($"Rebuild Client spawnableObjects after additive scene load: {scene.name}"); + } + } + } + + void UpdateScene() + { + if (loadingSceneAsync != null && loadingSceneAsync.isDone) + { + //Debug.Log($"ClientChangeScene done readyConn {clientReadyConnection}"); + + // try-finally to guarantee loadingSceneAsync being cleared. + // fixes https://github.com/vis2k/Mirror/issues/2517 where if + // FinishLoadScene throws an exception, loadingSceneAsync would + // never be cleared and this code would run every Update. + try + { + FinishLoadScene(); + } + finally + { + loadingSceneAsync.allowSceneActivation = true; + loadingSceneAsync = null; + } + } + } + + protected void FinishLoadScene() + { + // NOTE: this cannot use NetworkClient.allClients[0] - that client may be for a completely different purpose. + + // process queued messages that we received while loading the scene + //Debug.Log("FinishLoadScene: resuming handlers after scene was loading."); + NetworkServer.isLoadingScene = false; + NetworkClient.isLoadingScene = false; + + // host mode? + if (mode == NetworkManagerMode.Host) + { + FinishLoadSceneHost(); + } + // server-only mode? + else if (mode == NetworkManagerMode.ServerOnly) + { + FinishLoadSceneServerOnly(); + } + // client-only mode? + else if (mode == NetworkManagerMode.ClientOnly) + { + FinishLoadSceneClientOnly(); + } + // otherwise we called it after stopping when loading offline scene. + // do nothing then. + } + + // finish load scene part for host mode. makes code easier and is + // necessary for FinishStartHost later. + // (the 3 things have to happen in that exact order) + void FinishLoadSceneHost() + { + // debug message is very important. if we ever break anything then + // it's very obvious to notice. + //Debug.Log("Finished loading scene in host mode."); + + if (clientReadyConnection != null) + { + clientLoadedScene = true; + clientReadyConnection = null; + } + + // do we need to finish a StartHost() call? + // then call FinishStartHost and let it take care of spawning etc. + if (finishStartHostPending) + { + finishStartHostPending = false; + FinishStartHost(); + + // call OnServerSceneChanged + OnServerSceneChanged(networkSceneName); + + // DO NOT call OnClientSceneChanged here. + // the scene change happened because StartHost loaded the + // server's online scene. it has nothing to do with the client. + // this was not meant as a client scene load, so don't call it. + // + // otherwise AddPlayer would be called twice: + // -> once for client OnConnected + // -> once in OnClientSceneChanged + } + // otherwise we just changed a scene in host mode + else + { + // spawn server objects + NetworkServer.SpawnObjects(); + + // call OnServerSceneChanged + OnServerSceneChanged(networkSceneName); + + if (NetworkClient.isConnected) + OnClientSceneChanged(); + } + } + + // finish load scene part for server-only. . makes code easier and is + // necessary for FinishStartServer later. + void FinishLoadSceneServerOnly() + { + // debug message is very important. if we ever break anything then + // it's very obvious to notice. + //Debug.Log("Finished loading scene in server-only mode."); + + NetworkServer.SpawnObjects(); + OnServerSceneChanged(networkSceneName); + } + + // finish load scene part for client-only. makes code easier and is + // necessary for FinishStartClient later. + void FinishLoadSceneClientOnly() + { + // debug message is very important. if we ever break anything then + // it's very obvious to notice. + //Debug.Log("Finished loading scene in client-only mode."); + + if (clientReadyConnection != null) + { + clientLoadedScene = true; + clientReadyConnection = null; + } + + if (NetworkClient.isConnected) + OnClientSceneChanged(); + } + + /// + /// Registers the transform of a game object as a player spawn location. + /// This is done automatically by NetworkStartPosition components, but can be done manually from user script code. + /// + /// Transform to register. + // Static because it's called from NetworkStartPosition::Awake + // and singleton may not exist yet + public static void RegisterStartPosition(Transform start) + { + // Debug.Log($"RegisterStartPosition: {start.gameObject.name} {start.position}"); + startPositions.Add(start); + + // reorder the list so that round-robin spawning uses the start positions + // in hierarchy order. This assumes all objects with NetworkStartPosition + // component are siblings, either in the scene root or together as children + // under a single parent in the scene. + startPositions = startPositions.OrderBy(transform => transform.GetSiblingIndex()).ToList(); + } + + /// Unregister a Transform from start positions. + // Static because it's called from NetworkStartPosition::OnDestroy + // and singleton may not exist yet + public static void UnRegisterStartPosition(Transform start) + { + //Debug.Log($"UnRegisterStartPosition: {start.name} {start.position}"); + startPositions.Remove(start); + } + + /// Get the next NetworkStartPosition based on the selected PlayerSpawnMethod. + public virtual Transform GetStartPosition() + { + // first remove any dead transforms + startPositions.RemoveAll(t => t == null); + + if (startPositions.Count == 0) + return null; + + if (playerSpawnMethod == PlayerSpawnMethod.Random) + { + return startPositions[UnityEngine.Random.Range(0, startPositions.Count)]; + } + else + { + Transform startPosition = startPositions[startPositionIndex]; + startPositionIndex = (startPositionIndex + 1) % startPositions.Count; + return startPosition; + } + } + + void OnServerConnectInternal(NetworkConnectionToClient conn) + { + //Debug.Log("NetworkManager.OnServerConnectInternal"); + + if (authenticator != null) + { + // we have an authenticator - let it handle authentication + authenticator.OnServerAuthenticate(conn); + } + else + { + // authenticate immediately + OnServerAuthenticated(conn); + } + } + + // called after successful authentication + // TODO do the NetworkServer.OnAuthenticated thing from x branch + void OnServerAuthenticated(NetworkConnectionToClient conn) + { + //Debug.Log("NetworkManager.OnServerAuthenticated"); + + // set connection to authenticated + conn.isAuthenticated = true; + + // proceed with the login handshake by calling OnServerConnect + if (networkSceneName != "" && networkSceneName != offlineScene) + { + SceneMessage msg = new SceneMessage() + { + sceneName = networkSceneName + }; + conn.Send(msg); + } + + OnServerConnect(conn); + } + + void OnServerReadyMessageInternal(NetworkConnectionToClient conn, ReadyMessage msg) + { + //Debug.Log("NetworkManager.OnServerReadyMessageInternal"); + OnServerReady(conn); + } + + void OnServerAddPlayerInternal(NetworkConnectionToClient conn, AddPlayerMessage msg) + { + //Debug.Log("NetworkManager.OnServerAddPlayer"); + + if (autoCreatePlayer && playerPrefab == null) + { + Debug.LogError("The PlayerPrefab is empty on the NetworkManager. Please setup a PlayerPrefab object."); + return; + } + + if (autoCreatePlayer && !playerPrefab.TryGetComponent(out NetworkIdentity _)) + { + Debug.LogError("The PlayerPrefab does not have a NetworkIdentity. Please add a NetworkIdentity to the player prefab."); + return; + } + + if (conn.identity != null) + { + Debug.LogError("There is already a player for this connection."); + return; + } + + OnServerAddPlayer(conn); + } + + void OnClientConnectInternal() + { + //Debug.Log("NetworkManager.OnClientConnectInternal"); + + if (authenticator != null) + { + // we have an authenticator - let it handle authentication + authenticator.OnClientAuthenticate(); + } + else + { + // authenticate immediately + OnClientAuthenticated(); + } + } + + // called after successful authentication + void OnClientAuthenticated() + { + //Debug.Log("NetworkManager.OnClientAuthenticated"); + + // set connection to authenticated + NetworkClient.connection.isAuthenticated = true; + + // Set flag to wait for scene change? + if (string.IsNullOrWhiteSpace(onlineScene) || onlineScene == offlineScene || Utils.IsSceneActive(onlineScene)) + { + clientLoadedScene = false; + } + else + { + // Scene message expected from server. + clientLoadedScene = true; + clientReadyConnection = NetworkClient.connection; + } + + // Call virtual method regardless of whether a scene change is expected or not. + OnClientConnect(); + } + + // Transport callback, invoked after client fully disconnected. + // the call order should always be: + // Disconnect() -> ask Transport -> Transport.OnDisconnected -> Cleanup + void OnClientDisconnectInternal() + { + //Debug.Log("NetworkManager.OnClientDisconnectInternal"); + + // Only let this run once. StopClient in Host mode changes to ServerOnly + if (mode == NetworkManagerMode.ServerOnly || mode == NetworkManagerMode.Offline) + return; + + // user callback + OnClientDisconnect(); + + if (authenticator != null) + { + authenticator.OnClientAuthenticated.RemoveListener(OnClientAuthenticated); + authenticator.OnStopClient(); + } + + // set mode BEFORE changing scene so FinishStartScene doesn't re-initialize anything. + // set mode BEFORE NetworkClient.Disconnect so StopClient only runs once. + // set mode BEFORE OnStopClient so StopClient only runs once. + // If we got here from StopClient in Host mode, change to ServerOnly. + // - If StopHost was called, StopServer will put us in Offline mode. + if (mode == NetworkManagerMode.Host) + mode = NetworkManagerMode.ServerOnly; + else + mode = NetworkManagerMode.Offline; + + //Debug.Log("NetworkManager StopClient"); + OnStopClient(); + + // shutdown client + NetworkClient.Shutdown(); + + // Exit here if we're now in ServerOnly mode (StopClient called in Host mode). + if (mode == NetworkManagerMode.ServerOnly) return; + + // Get Network Manager out of DDOL before going to offline scene + // to avoid collision and let a fresh Network Manager be created. + // IMPORTANT: .gameObject can be null if StopClient is called from + // OnApplicationQuit or from tests! + if (gameObject != null + && gameObject.scene.name == "DontDestroyOnLoad" + && !string.IsNullOrWhiteSpace(offlineScene) + && SceneManager.GetActiveScene().path != offlineScene) + SceneManager.MoveGameObjectToScene(gameObject, SceneManager.GetActiveScene()); + + // If StopHost called in Host mode, StopServer will change scenes after this. + // Check loadingSceneAsync to ensure we don't double-invoke the scene change. + // Check if NetworkServer.active because we can get here via Disconnect before server has started to change scenes. + if (!string.IsNullOrWhiteSpace(offlineScene) && !Utils.IsSceneActive(offlineScene) && loadingSceneAsync == null && !NetworkServer.active) + { + ClientChangeScene(offlineScene, SceneOperation.Normal); + } + + networkSceneName = ""; + } + + void OnClientNotReadyMessageInternal(NotReadyMessage msg) + { + //Debug.Log("NetworkManager.OnClientNotReadyMessageInternal"); + NetworkClient.ready = false; + OnClientNotReady(); + + // NOTE: clientReadyConnection is not set here! don't want OnClientConnect to be invoked again after scene changes. + } + + void OnClientSceneInternal(SceneMessage msg) + { + //Debug.Log("NetworkManager.OnClientSceneInternal"); + + // This needs to run for host client too. NetworkServer.active is checked there + if (NetworkClient.isConnected) + { + ClientChangeScene(msg.sceneName, msg.sceneOperation, msg.customHandling); + } + } + + /// Called on the server when a new client connects. + public virtual void OnServerConnect(NetworkConnectionToClient conn) { } + + /// Called on the server when a client disconnects. + // Called by NetworkServer.OnTransportDisconnect! + public virtual void OnServerDisconnect(NetworkConnectionToClient conn) + { + // by default, this function destroys the connection's player. + // can be overwritten for cases like delayed logouts in MMOs to + // avoid players escaping from PvP situations by logging out. + NetworkServer.DestroyPlayerForConnection(conn); + //Debug.Log("OnServerDisconnect: Client disconnected."); + } + + /// Called on the server when a client is ready (= loaded the scene) + public virtual void OnServerReady(NetworkConnectionToClient conn) + { + if (conn.identity == null) + { + // this is now allowed (was not for a while) + //Debug.Log("Ready with no player object"); + } + NetworkServer.SetClientReady(conn); + } + + /// Called on server when a client requests to add the player. Adds playerPrefab by default. Can be overwritten. + // The default implementation for this function creates a new player object from the playerPrefab. + public virtual void OnServerAddPlayer(NetworkConnectionToClient conn) + { + Transform startPos = GetStartPosition(); + GameObject player = startPos != null + ? Instantiate(playerPrefab, startPos.position, startPos.rotation) + : Instantiate(playerPrefab); + + // instantiating a "Player" prefab gives it the name "Player(clone)" + // => appending the connectionId is WAY more useful for debugging! + player.name = $"{playerPrefab.name} [connId={conn.connectionId}]"; + NetworkServer.AddPlayerForConnection(conn, player); + } + + /// Called on server when transport raises an exception. NetworkConnection may be null. + public virtual void OnServerError(NetworkConnectionToClient conn, TransportError error, string reason) { } + + /// Called from ServerChangeScene immediately before SceneManager.LoadSceneAsync is executed + public virtual void OnServerChangeScene(string newSceneName) { } + + /// Called on server after a scene load with ServerChangeScene() is completed. + public virtual void OnServerSceneChanged(string sceneName) { } + + /// Called on the client when connected to a server. By default it sets client as ready and adds a player. + public virtual void OnClientConnect() + { + // OnClientConnect by default calls AddPlayer but it should not do + // that when we have online/offline scenes. so we need the + // clientLoadedScene flag to prevent it. + if (!clientLoadedScene) + { + // Ready/AddPlayer is usually triggered by a scene load completing. + // if no scene was loaded, then Ready/AddPlayer it here instead. + if (!NetworkClient.ready) + NetworkClient.Ready(); + + if (autoCreatePlayer) + NetworkClient.AddPlayer(); + } + } + + /// Called on clients when disconnected from a server. + public virtual void OnClientDisconnect() { } + + /// Called on client when transport raises an exception. + public virtual void OnClientError(TransportError error, string reason) { } + + /// Called on clients when a servers tells the client it is no longer ready, e.g. when switching scenes. + public virtual void OnClientNotReady() { } + + /// Called from ClientChangeScene immediately before SceneManager.LoadSceneAsync is executed + // customHandling: indicates if scene loading will be handled through overrides + public virtual void OnClientChangeScene(string newSceneName, SceneOperation sceneOperation, bool customHandling) { } + + /// Called on clients when a scene has completed loaded, when the scene load was initiated by the server. + // Scene changes can cause player objects to be destroyed. The default + // implementation of OnClientSceneChanged in the NetworkManager is to + // add a player object for the connection if no player object exists. + public virtual void OnClientSceneChanged() + { + // always become ready. + if (NetworkClient.connection.isAuthenticated && !NetworkClient.ready) NetworkClient.Ready(); + + // Only call AddPlayer for normal scene changes, not additive load/unload + if (NetworkClient.connection.isAuthenticated && clientSceneOperation == SceneOperation.Normal && autoCreatePlayer && NetworkClient.localPlayer == null) + { + // add player if existing one is null + NetworkClient.AddPlayer(); + } + } + + // Since there are multiple versions of StartServer, StartClient and + // StartHost, to reliably customize their functionality, users would + // need override all the versions. Instead these callbacks are invoked + // from all versions, so users only need to implement this one case. + + /// This is invoked when a host is started. + public virtual void OnStartHost() { } + + /// This is invoked when a server is started - including when a host is started. + public virtual void OnStartServer() { } + + /// This is invoked when the client is started. + public virtual void OnStartClient() { } + + /// This is called when a server is stopped - including when a host is stopped. + public virtual void OnStopServer() { } + + /// This is called when a client is stopped. + public virtual void OnStopClient() { } + + /// This is called when a host is stopped. + public virtual void OnStopHost() { } + + // keep OnGUI even in builds. useful to debug snap interp. + void OnGUI() + { + if (!timeInterpolationGui) return; + NetworkClient.OnGUI(); + } + } +} diff --git a/Assets/Mirror/Core/NetworkManager.cs.meta b/Assets/Mirror/Core/NetworkManager.cs.meta new file mode 100644 index 0000000..0a7564a --- /dev/null +++ b/Assets/Mirror/Core/NetworkManager.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8aab4c8111b7c411b9b92cf3dbc5bd4e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkManagerHUD.cs b/Assets/Mirror/Core/NetworkManagerHUD.cs new file mode 100644 index 0000000..0a267fb --- /dev/null +++ b/Assets/Mirror/Core/NetworkManagerHUD.cs @@ -0,0 +1,155 @@ +// vis2k: GUILayout instead of spacey += ...; removed Update hotkeys to avoid +// confusion if someone accidentally presses one. +using UnityEngine; + +namespace Mirror +{ + /// Shows NetworkManager controls in a GUI at runtime. + [DisallowMultipleComponent] + [AddComponentMenu("Network/Network Manager HUD")] + [RequireComponent(typeof(NetworkManager))] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-manager-hud")] + public class NetworkManagerHUD : MonoBehaviour + { + NetworkManager manager; + + public int offsetX; + public int offsetY; + + void Awake() + { + manager = GetComponent(); + } + + void OnGUI() + { + GUILayout.BeginArea(new Rect(10 + offsetX, 40 + offsetY, 250, 9999)); + if (!NetworkClient.isConnected && !NetworkServer.active) + { + StartButtons(); + } + else + { + StatusLabels(); + } + + // client ready + if (NetworkClient.isConnected && !NetworkClient.ready) + { + if (GUILayout.Button("Client Ready")) + { + NetworkClient.Ready(); + if (NetworkClient.localPlayer == null) + { + NetworkClient.AddPlayer(); + } + } + } + + StopButtons(); + + GUILayout.EndArea(); + } + + void StartButtons() + { + if (!NetworkClient.active) + { + // Server + Client + if (Application.platform != RuntimePlatform.WebGLPlayer) + { + if (GUILayout.Button("Host (Server + Client)")) + { + manager.StartHost(); + } + } + + // Client + IP + GUILayout.BeginHorizontal(); + if (GUILayout.Button("Client")) + { + manager.StartClient(); + } + // This updates networkAddress every frame from the TextField + manager.networkAddress = GUILayout.TextField(manager.networkAddress); + GUILayout.EndHorizontal(); + + // Server Only + if (Application.platform == RuntimePlatform.WebGLPlayer) + { + // cant be a server in webgl build + GUILayout.Box("( WebGL cannot be server )"); + } + else + { + if (GUILayout.Button("Server Only")) manager.StartServer(); + } + } + else + { + // Connecting + GUILayout.Label($"Connecting to {manager.networkAddress}.."); + if (GUILayout.Button("Cancel Connection Attempt")) + { + manager.StopClient(); + } + } + } + + void StatusLabels() + { + // host mode + // display separately because this always confused people: + // Server: ... + // Client: ... + if (NetworkServer.active && NetworkClient.active) + { + GUILayout.Label($"Host: running via {Transport.active}"); + } + // server only + else if (NetworkServer.active) + { + GUILayout.Label($"Server: running via {Transport.active}"); + } + // client only + else if (NetworkClient.isConnected) + { + GUILayout.Label($"Client: connected to {manager.networkAddress} via {Transport.active}"); + } + } + + void StopButtons() + { + // stop host if host mode + if (NetworkServer.active && NetworkClient.isConnected) + { + GUILayout.BeginHorizontal(); + if (GUILayout.Button("Stop Host")) + { + manager.StopHost(); + } + if (GUILayout.Button("Stop Client")) + { + manager.StopClient(); + } + GUILayout.EndHorizontal(); + } + // stop client if client-only + else if (NetworkClient.isConnected) + { + if (GUILayout.Button("Stop Client")) + { + manager.StopClient(); + } + } + // stop server if server-only + else if (NetworkServer.active) + { + if (GUILayout.Button("Stop Server")) + { + manager.StopServer(); + } + } + } + } +} diff --git a/Assets/Mirror/Core/NetworkManagerHUD.cs.meta b/Assets/Mirror/Core/NetworkManagerHUD.cs.meta new file mode 100644 index 0000000..a720b9c --- /dev/null +++ b/Assets/Mirror/Core/NetworkManagerHUD.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6442dc8070ceb41f094e44de0bf87274 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkMessage.cs b/Assets/Mirror/Core/NetworkMessage.cs new file mode 100644 index 0000000..7fc387a --- /dev/null +++ b/Assets/Mirror/Core/NetworkMessage.cs @@ -0,0 +1,4 @@ +namespace Mirror +{ + public interface NetworkMessage {} +} diff --git a/Assets/Mirror/Core/NetworkMessage.cs.meta b/Assets/Mirror/Core/NetworkMessage.cs.meta new file mode 100644 index 0000000..73d3d8f --- /dev/null +++ b/Assets/Mirror/Core/NetworkMessage.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: eb04e4848a2e4452aa2dbd7adb801c51 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkMessages.cs b/Assets/Mirror/Core/NetworkMessages.cs new file mode 100644 index 0000000..034e877 --- /dev/null +++ b/Assets/Mirror/Core/NetworkMessages.cs @@ -0,0 +1,185 @@ +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Text; +using UnityEngine; + +namespace Mirror +{ + // for performance, we (ab)use c# generics to cache the message id in a static field + // this is significantly faster than doing the computation at runtime or looking up cached results via Dictionary + // generic classes have separate static fields per type specification + public static class NetworkMessageId where T : struct, NetworkMessage + { + // automated message id from type hash. + // platform independent via stable hashcode. + // => convenient so we don't need to track messageIds across projects + // => addons can work with each other without knowing their ids before + // => 2 bytes is enough to avoid collisions. + // registering a messageId twice will log a warning anyway. + public static readonly ushort Id = + (ushort)(typeof(T).FullName.GetStableHashCode()); + } + + // message packing all in one place, instead of constructing headers in all + // kinds of different places + // + // MsgType (2 bytes) + // Content (ContentSize bytes) + public static class NetworkMessages + { + // size of message id header in bytes + public const int IdSize = sizeof(ushort); + + // Id <> Type lookup for debugging, profiler, etc. + // important when debugging messageId errors! + public static readonly Dictionary Lookup = + new Dictionary(); + + // dump all types for debugging + public static void LogTypes() + { + StringBuilder builder = new StringBuilder(); + builder.AppendLine("NetworkMessageIds:"); + foreach (KeyValuePair kvp in Lookup) + { + builder.AppendLine($" Id={kvp.Key} = {kvp.Value}"); + } + Debug.Log(builder.ToString()); + } + + // max message content size (without header) calculation for convenience + // -> Transport.GetMaxPacketSize is the raw maximum + // -> Every message gets serialized into <> + // -> Every serialized message get put into a batch with one timestamp per batch + // -> Every message in a batch has a varuint size header. + // use the worst case VarUInt size for the largest possible + // message size = int.max. + public static int MaxContentSize(int channelId) + { + // calculate the max possible size that can fit in a batch + int transportMax = Transport.active.GetMaxPacketSize(channelId); + return transportMax - IdSize - Batcher.MaxMessageOverhead(transportMax); + } + + // max message size which includes header + content. + public static int MaxMessageSize(int channelId) => + MaxContentSize(channelId) + IdSize; + + // automated message id from type hash. + // platform independent via stable hashcode. + // => convenient so we don't need to track messageIds across projects + // => addons can work with each other without knowing their ids before + // => 2 bytes is enough to avoid collisions. + // registering a messageId twice will log a warning anyway. + // keep this for convenience. easier to use than NetworkMessageId.Id. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static ushort GetId() where T : struct, NetworkMessage => + NetworkMessageId.Id; + + // pack message before sending + // -> NetworkWriter passed as arg so that we can use .ToArraySegment + // and do an allocation free send before recycling it. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void Pack(T message, NetworkWriter writer) + where T : struct, NetworkMessage + { + writer.WriteUShort(NetworkMessageId.Id); + writer.Write(message); + } + + // read only the message id. + // common function in case we ever change the header size. + public static bool UnpackId(NetworkReader reader, out ushort messageId) + { + // read message type + try + { + messageId = reader.ReadUShort(); + return true; + } + catch (System.IO.EndOfStreamException) + { + messageId = 0; + return false; + } + } + + // version for handlers with channelId + // inline! only exists for 20-30 messages and they call it all the time. + internal static NetworkMessageDelegate WrapHandler(Action handler, bool requireAuthentication) + where T : struct, NetworkMessage + where C : NetworkConnection + => (conn, reader, channelId) => + { + // protect against DOS attacks if attackers try to send invalid + // data packets to crash the server/client. there are a thousand + // ways to cause an exception in data handling: + // - invalid headers + // - invalid message ids + // - invalid data causing exceptions + // - negative ReadBytesAndSize prefixes + // - invalid utf8 strings + // - etc. + // + // let's catch them all and then disconnect that connection to avoid + // further attacks. + T message = default; + // record start position for NetworkDiagnostics because reader might contain multiple messages if using batching + int startPos = reader.Position; + try + { + if (requireAuthentication && !conn.isAuthenticated) + { + // message requires authentication, but the connection was not authenticated + Debug.LogWarning($"Disconnecting connection: {conn}. Received message {typeof(T)} that required authentication, but the user has not authenticated yet"); + conn.Disconnect(); + return; + } + + //Debug.Log($"ConnectionRecv {conn} msgType:{typeof(T)} content:{BitConverter.ToString(reader.buffer.Array, reader.buffer.Offset, reader.buffer.Count)}"); + + // if it is a value type, just use default(T) + // otherwise allocate a new instance + message = reader.Read(); + } + catch (Exception exception) + { + Debug.LogError($"Disconnecting connection: {conn}. This can happen if the other side accidentally (or an attacker intentionally) sent invalid data. Reason: {exception}"); + conn.Disconnect(); + return; + } + finally + { + int endPos = reader.Position; + // TODO: Figure out the correct channel + NetworkDiagnostics.OnReceive(message, channelId, endPos - startPos); + } + + // user handler exception should not stop the whole server + try + { + // user implemented handler + handler((C)conn, message, channelId); + } + catch (Exception e) + { + Debug.LogError($"Disconnecting connId={conn.connectionId} to prevent exploits from an Exception in MessageHandler: {e.GetType().Name} {e.Message}\n{e.StackTrace}"); + conn.Disconnect(); + } + }; + + // version for handlers without channelId + // TODO obsolete this some day to always use the channelId version. + // all handlers in this version are wrapped with 1 extra action. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + internal static NetworkMessageDelegate WrapHandler(Action handler, bool requireAuthentication) + where T : struct, NetworkMessage + where C : NetworkConnection + { + // wrap action as channelId version, call original + void Wrapped(C conn, T msg, int _) => handler(conn, msg); + return WrapHandler((Action)Wrapped, requireAuthentication); + } + } +} diff --git a/Assets/Mirror/Core/NetworkMessages.cs.meta b/Assets/Mirror/Core/NetworkMessages.cs.meta new file mode 100644 index 0000000..910b75c --- /dev/null +++ b/Assets/Mirror/Core/NetworkMessages.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2db134099f0df4d96a84ae7a0cd9b4bc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkReader.cs b/Assets/Mirror/Core/NetworkReader.cs new file mode 100644 index 0000000..82fb7cd --- /dev/null +++ b/Assets/Mirror/Core/NetworkReader.cs @@ -0,0 +1,249 @@ +using System; +using System.IO; +using System.Runtime.CompilerServices; +using System.Text; +using Unity.Collections.LowLevel.Unsafe; +using UnityEngine; + +namespace Mirror +{ + /// Network Reader for most simple types like floats, ints, buffers, structs, etc. Use NetworkReaderPool.GetReader() to avoid allocations. + // Note: This class is intended to be extremely pedantic, + // and throw exceptions whenever stuff is going slightly wrong. + // The exceptions will be handled in NetworkServer/NetworkClient. + // + // Note that NetworkWriter can be passed in constructor thanks to implicit + // ArraySegment conversion: + // NetworkReader reader = new NetworkReader(writer); + public class NetworkReader + { + // internal buffer + // byte[] pointer would work, but we use ArraySegment to also support + // the ArraySegment constructor + internal ArraySegment buffer; + + /// Next position to read from the buffer + // 'int' is the best type for .Position. 'short' is too small if we send >32kb which would result in negative .Position + // -> converting long to int is fine until 2GB of data (MAX_INT), so we don't have to worry about overflows here + public int Position; + + /// Remaining bytes that can be read, for convenience. + public int Remaining => buffer.Count - Position; + + /// Total buffer capacity, independent of reader position. + public int Capacity => buffer.Count; + + // cache encoding for ReadString instead of creating it with each time + // 1000 readers before: 1MB GC, 30ms + // 1000 readers after: 0.8MB GC, 18ms + // member(!) to avoid static state. + // + // throwOnInvalidBytes is true. + // if false, it would silently ignore the invalid bytes but continue + // with the valid ones, creating strings like "a�������". + // instead, we want to catch it manually and return String.Empty. + // this is safer. see test: ReadString_InvalidUTF8(). + internal readonly UTF8Encoding encoding = new UTF8Encoding(false, true); + + // while allocation free ReadArraySegment is encouraged, + // some functions can allocate a new byte[], List, Texture, etc. + // we should keep a reasonable allocation size limit: + // -> server won't accidentally allocate 2GB on a mobile device + // -> client won't allocate 2GB on server for ClientToServer [SyncVar]s + // -> unlike max string length of 64 KB, we need a larger limit here. + // large enough to not break existing projects, + // small enough to reasonably limit allocation attacks. + // -> we don't know the exact size of ReadList etc. because is + // managed. instead, this is considered a 'collection length' limit. + public const int AllocationLimit = 1024 * 1024 * 16; // 16 MB * sizeof(T) + + public NetworkReader(ArraySegment segment) + { + buffer = segment; + } + +#if !UNITY_2021_3_OR_NEWER + // Unity 2019 doesn't have the implicit byte[] to segment conversion yet + public NetworkReader(byte[] bytes) + { + buffer = new ArraySegment(bytes, 0, bytes.Length); + } +#endif + + // sometimes it's useful to point a reader on another buffer instead of + // allocating a new reader (e.g. NetworkReaderPool) + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void SetBuffer(ArraySegment segment) + { + buffer = segment; + Position = 0; + } + +#if !UNITY_2021_3_OR_NEWER + // Unity 2019 doesn't have the implicit byte[] to segment conversion yet + public void SetBuffer(byte[] bytes) + { + buffer = new ArraySegment(bytes, 0, bytes.Length); + Position = 0; + } +#endif + + // ReadBlittable from DOTSNET + // this is extremely fast, but only works for blittable types. + // => private to make sure nobody accidentally uses it for non-blittable + // + // Benchmark: see NetworkWriter.WriteBlittable! + // + // Note: + // ReadBlittable assumes same endianness for server & client. + // All Unity 2018+ platforms are little endian. + // + // This is not safe to expose to random structs. + // * StructLayout.Sequential is the default, which is safe. + // if the struct contains a reference type, it is converted to Auto. + // but since all structs here are unmanaged blittable, it's safe. + // see also: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.layoutkind?view=netframework-4.8#system-runtime-interopservices-layoutkind-sequential + // * StructLayout.Pack depends on CPU word size. + // this may be different 4 or 8 on some ARM systems, etc. + // this is not safe, and would cause bytes/shorts etc. to be padded. + // see also: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.structlayoutattribute.pack?view=net-6.0 + // * If we force pack all to '1', they would have no padding which is + // great for bandwidth. but on some android systems, CPU can't read + // unaligned memory. + // see also: https://github.com/vis2k/Mirror/issues/3044 + // * The only option would be to force explicit layout with multiples + // of word size. but this requires lots of weaver checking and is + // still questionable (IL2CPP etc.). + // + // Note: inlining ReadBlittable is enough. don't inline ReadInt etc. + // we don't want ReadBlittable to be copied in place everywhere. + internal unsafe T ReadBlittable() + where T : unmanaged + { + // check if blittable for safety +#if UNITY_EDITOR + if (!UnsafeUtility.IsBlittable(typeof(T))) + { + throw new ArgumentException($"{typeof(T)} is not blittable!"); + } +#endif + + // calculate size + // sizeof(T) gets the managed size at compile time. + // Marshal.SizeOf gets the unmanaged size at runtime (slow). + // => our 1mio writes benchmark is 6x slower with Marshal.SizeOf + // => for blittable types, sizeof(T) is even recommended: + // https://docs.microsoft.com/en-us/dotnet/standard/native-interop/best-practices + int size = sizeof(T); + + // ensure remaining + if (Remaining < size) + { + throw new EndOfStreamException($"ReadBlittable<{typeof(T)}> not enough data in buffer to read {size} bytes: {ToString()}"); + } + + // read blittable + T value; + fixed (byte* ptr = &buffer.Array[buffer.Offset + Position]) + { +#if UNITY_ANDROID + // on some android systems, reading *(T*)ptr throws a NRE if + // the ptr isn't aligned (i.e. if Position is 1,2,3,5, etc.). + // here we have to use memcpy. + // + // => we can't get a pointer of a struct in C# without + // marshalling allocations + // => instead, we stack allocate an array of type T and use that + // => stackalloc avoids GC and is very fast. it only works for + // value types, but all blittable types are anyway. + // + // this way, we can still support blittable reads on android. + // see also: https://github.com/vis2k/Mirror/issues/3044 + // (solution discovered by AIIO, FakeByte, mischa) + T* valueBuffer = stackalloc T[1]; + UnsafeUtility.MemCpy(valueBuffer, ptr, size); + value = valueBuffer[0]; +#else + // cast buffer to a T* pointer and then read from it. + value = *(T*)ptr; +#endif + } + Position += size; + return value; + } + + // blittable'?' template for code reuse + // note: bool isn't blittable. need to read as byte. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + internal T? ReadBlittableNullable() + where T : unmanaged => + ReadByte() != 0 ? ReadBlittable() : default(T?); + + public byte ReadByte() => ReadBlittable(); + + /// Read 'count' bytes into the bytes array + // NOTE: returns byte[] because all reader functions return something. + public byte[] ReadBytes(byte[] bytes, int count) + { + // user may call ReadBytes(ReadInt()). ensure positive count. + if (count < 0) throw new ArgumentOutOfRangeException("ReadBytes requires count >= 0"); + + // check if passed byte array is big enough + if (count > bytes.Length) + { + throw new EndOfStreamException($"ReadBytes can't read {count} + bytes because the passed byte[] only has length {bytes.Length}"); + } + // ensure remaining + if (Remaining < count) + { + throw new EndOfStreamException($"ReadBytesSegment can't read {count} bytes because it would read past the end of the stream. {ToString()}"); + } + + Array.Copy(buffer.Array, buffer.Offset + Position, bytes, 0, count); + Position += count; + return bytes; + } + + /// Read 'count' bytes allocation-free as ArraySegment that points to the internal array. + public ArraySegment ReadBytesSegment(int count) + { + // user may call ReadBytes(ReadInt()). ensure positive count. + if (count < 0) throw new ArgumentOutOfRangeException("ReadBytesSegment requires count >= 0"); + + // ensure remaining + if (Remaining < count) + { + throw new EndOfStreamException($"ReadBytesSegment can't read {count} bytes because it would read past the end of the stream. {ToString()}"); + } + + // return the segment + ArraySegment result = new ArraySegment(buffer.Array, buffer.Offset + Position, count); + Position += count; + return result; + } + + /// Reads any data type that mirror supports. Uses weaver populated Reader(T).read + public T Read() + { + Func readerDelegate = Reader.read; + if (readerDelegate == null) + { + Debug.LogError($"No reader found for {typeof(T)}. Use a type supported by Mirror or define a custom reader extension for {typeof(T)}."); + return default; + } + return readerDelegate(this); + } + + // print the full buffer with position / capacity. + public override string ToString() => + $"[{buffer.ToHexString()} @ {Position}/{Capacity}]"; + } + + /// Helper class that weaver populates with all reader types. + // Note that c# creates a different static variable for each type + // -> Weaver.ReaderWriterProcessor.InitializeReaderAndWriters() populates it + public static class Reader + { + public static Func read; + } +} diff --git a/Assets/Mirror/Core/NetworkReader.cs.meta b/Assets/Mirror/Core/NetworkReader.cs.meta new file mode 100644 index 0000000..65ad3f0 --- /dev/null +++ b/Assets/Mirror/Core/NetworkReader.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 1610f05ec5bd14d6882e689f7372596a +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkReaderExtensions.cs b/Assets/Mirror/Core/NetworkReaderExtensions.cs new file mode 100644 index 0000000..bb6ca31 --- /dev/null +++ b/Assets/Mirror/Core/NetworkReaderExtensions.cs @@ -0,0 +1,376 @@ +using System; +using System.Collections.Generic; +using System.IO; +using UnityEngine; + +namespace Mirror +{ + // Mirror's Weaver automatically detects all NetworkReader function types, + // but they do all need to be extensions. + public static class NetworkReaderExtensions + { + public static byte ReadByte(this NetworkReader reader) => reader.ReadBlittable(); + public static byte? ReadByteNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static sbyte ReadSByte(this NetworkReader reader) => reader.ReadBlittable(); + public static sbyte? ReadSByteNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + // bool is not blittable. read as ushort. + public static char ReadChar(this NetworkReader reader) => (char)reader.ReadBlittable(); + public static char? ReadCharNullable(this NetworkReader reader) => (char?)reader.ReadBlittableNullable(); + + // bool is not blittable. read as byte. + public static bool ReadBool(this NetworkReader reader) => reader.ReadBlittable() != 0; + public static bool? ReadBoolNullable(this NetworkReader reader) + { + byte? value = reader.ReadBlittableNullable(); + return value.HasValue ? (value.Value != 0) : default(bool?); + } + + public static short ReadShort(this NetworkReader reader) => (short)reader.ReadUShort(); + public static short? ReadShortNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static ushort ReadUShort(this NetworkReader reader) => reader.ReadBlittable(); + public static ushort? ReadUShortNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static int ReadInt(this NetworkReader reader) => reader.ReadBlittable(); + public static int? ReadIntNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static uint ReadUInt(this NetworkReader reader) => reader.ReadBlittable(); + public static uint? ReadUIntNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static long ReadLong(this NetworkReader reader) => reader.ReadBlittable(); + public static long? ReadLongNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static ulong ReadULong(this NetworkReader reader) => reader.ReadBlittable(); + public static ulong? ReadULongNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static float ReadFloat(this NetworkReader reader) => reader.ReadBlittable(); + public static float? ReadFloatNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static double ReadDouble(this NetworkReader reader) => reader.ReadBlittable(); + public static double? ReadDoubleNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static decimal ReadDecimal(this NetworkReader reader) => reader.ReadBlittable(); + public static decimal? ReadDecimalNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + /// if an invalid utf8 string is sent + public static string ReadString(this NetworkReader reader) + { + // read number of bytes + ushort size = reader.ReadUShort(); + + // null support, see NetworkWriter + if (size == 0) + return null; + + ushort realSize = (ushort)(size - 1); + + // make sure it's within limits to avoid allocation attacks etc. + if (realSize > NetworkWriter.MaxStringLength) + throw new EndOfStreamException($"NetworkReader.ReadString - Value too long: {realSize} bytes. Limit is: {NetworkWriter.MaxStringLength} bytes"); + + ArraySegment data = reader.ReadBytesSegment(realSize); + + // convert directly from buffer to string via encoding + // throws in case of invalid utf8. + // see test: ReadString_InvalidUTF8() + return reader.encoding.GetString(data.Array, data.Offset, data.Count); + } + + /// if count is invalid + public static byte[] ReadBytesAndSize(this NetworkReader reader) + { + // count = 0 means the array was null + // otherwise count -1 is the length of the array + uint count = reader.ReadUInt(); + // Use checked() to force it to throw OverflowException if data is invalid + return count == 0 ? null : reader.ReadBytes(checked((int)(count - 1u))); + } + + public static byte[] ReadBytes(this NetworkReader reader, int count) + { + // prevent allocation attacks with a reasonable limit. + // server shouldn't allocate too much on client devices. + // client shouldn't allocate too much on server in ClientToServer [SyncVar]s. + if (count > NetworkReader.AllocationLimit) + { + // throw EndOfStream for consistency with ReadBlittable when out of data + throw new EndOfStreamException($"NetworkReader attempted to allocate {count} bytes, which is larger than the allowed limit of {NetworkReader.AllocationLimit} bytes."); + } + + byte[] bytes = new byte[count]; + reader.ReadBytes(bytes, count); + return bytes; + } + + /// if count is invalid + public static ArraySegment ReadBytesAndSizeSegment(this NetworkReader reader) + { + // count = 0 means the array was null + // otherwise count - 1 is the length of the array + uint count = reader.ReadUInt(); + // Use checked() to force it to throw OverflowException if data is invalid + return count == 0 ? default : reader.ReadBytesSegment(checked((int)(count - 1u))); + } + + public static Vector2 ReadVector2(this NetworkReader reader) => reader.ReadBlittable(); + public static Vector2? ReadVector2Nullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static Vector3 ReadVector3(this NetworkReader reader) => reader.ReadBlittable(); + public static Vector3? ReadVector3Nullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static Vector4 ReadVector4(this NetworkReader reader) => reader.ReadBlittable(); + public static Vector4? ReadVector4Nullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static Vector2Int ReadVector2Int(this NetworkReader reader) => reader.ReadBlittable(); + public static Vector2Int? ReadVector2IntNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static Vector3Int ReadVector3Int(this NetworkReader reader) => reader.ReadBlittable(); + public static Vector3Int? ReadVector3IntNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static Color ReadColor(this NetworkReader reader) => reader.ReadBlittable(); + public static Color? ReadColorNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static Color32 ReadColor32(this NetworkReader reader) => reader.ReadBlittable(); + public static Color32? ReadColor32Nullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static Quaternion ReadQuaternion(this NetworkReader reader) => reader.ReadBlittable(); + public static Quaternion? ReadQuaternionNullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + // Rect is a struct with properties instead of fields + public static Rect ReadRect(this NetworkReader reader) => new Rect(reader.ReadVector2(), reader.ReadVector2()); + public static Rect? ReadRectNullable(this NetworkReader reader) => reader.ReadBool() ? ReadRect(reader) : default(Rect?); + + // Plane is a struct with properties instead of fields + public static Plane ReadPlane(this NetworkReader reader) => new Plane(reader.ReadVector3(), reader.ReadFloat()); + public static Plane? ReadPlaneNullable(this NetworkReader reader) => reader.ReadBool() ? ReadPlane(reader) : default(Plane?); + + // Ray is a struct with properties instead of fields + public static Ray ReadRay(this NetworkReader reader) => new Ray(reader.ReadVector3(), reader.ReadVector3()); + public static Ray? ReadRayNullable(this NetworkReader reader) => reader.ReadBool() ? ReadRay(reader) : default(Ray?); + + public static Matrix4x4 ReadMatrix4x4(this NetworkReader reader) => reader.ReadBlittable(); + public static Matrix4x4? ReadMatrix4x4Nullable(this NetworkReader reader) => reader.ReadBlittableNullable(); + + public static Guid ReadGuid(this NetworkReader reader) + { +#if !UNITY_2021_3_OR_NEWER + // Unity 2019 doesn't have Span yet + return new Guid(reader.ReadBytes(16)); +#else + // ReadBlittable(Guid) isn't safe. see ReadBlittable comments. + // Guid is Sequential, but we can't guarantee packing. + if (reader.Remaining >= 16) + { + ReadOnlySpan span = new ReadOnlySpan(reader.buffer.Array, reader.buffer.Offset + reader.Position, 16); + reader.Position += 16; + return new Guid(span); + } + throw new EndOfStreamException($"ReadGuid out of range: {reader}"); +#endif + } + public static Guid? ReadGuidNullable(this NetworkReader reader) => reader.ReadBool() ? ReadGuid(reader) : default(Guid?); + + public static NetworkIdentity ReadNetworkIdentity(this NetworkReader reader) + { + uint netId = reader.ReadUInt(); + if (netId == 0) + return null; + + // NOTE: a netId not being in spawned is common. + // for example, "[SyncVar] NetworkIdentity target" netId would not + // be known on client if the monster walks out of proximity for a + // moment. no need to log any error or warning here. + return Utils.GetSpawnedInServerOrClient(netId); + } + + public static NetworkBehaviour ReadNetworkBehaviour(this NetworkReader reader) + { + // read netId first. + // + // IMPORTANT: if netId != 0, writer always writes componentIndex. + // reusing ReadNetworkIdentity() might return a null NetworkIdentity + // even if netId was != 0 but the identity disappeared on the client, + // resulting in unequal amounts of data being written / read. + // https://github.com/vis2k/Mirror/issues/2972 + uint netId = reader.ReadUInt(); + if (netId == 0) + return null; + + // read component index in any case, BEFORE searching the spawned + // NetworkIdentity by netId. + byte componentIndex = reader.ReadByte(); + + // NOTE: a netId not being in spawned is common. + // for example, "[SyncVar] NetworkIdentity target" netId would not + // be known on client if the monster walks out of proximity for a + // moment. no need to log any error or warning here. + NetworkIdentity identity = Utils.GetSpawnedInServerOrClient(netId); + + return identity != null + ? identity.NetworkBehaviours[componentIndex] + : null; + } + + public static T ReadNetworkBehaviour(this NetworkReader reader) where T : NetworkBehaviour + { + return reader.ReadNetworkBehaviour() as T; + } + + public static NetworkBehaviourSyncVar ReadNetworkBehaviourSyncVar(this NetworkReader reader) + { + uint netId = reader.ReadUInt(); + byte componentIndex = default; + + // if netId is not 0, then index is also sent to read before returning + if (netId != 0) + { + componentIndex = reader.ReadByte(); + } + + return new NetworkBehaviourSyncVar(netId, componentIndex); + } + + public static Transform ReadTransform(this NetworkReader reader) + { + // Don't use null propagation here as it could lead to MissingReferenceException + NetworkIdentity networkIdentity = reader.ReadNetworkIdentity(); + return networkIdentity != null ? networkIdentity.transform : null; + } + + public static GameObject ReadGameObject(this NetworkReader reader) + { + // Don't use null propagation here as it could lead to MissingReferenceException + NetworkIdentity networkIdentity = reader.ReadNetworkIdentity(); + return networkIdentity != null ? networkIdentity.gameObject : null; + } + + // while SyncList is recommended for NetworkBehaviours, + // structs may have .List members which weaver needs to be able to + // fully serialize for NetworkMessages etc. + // note that Weaver/Readers/GenerateReader() handles this manually. + public static List ReadList(this NetworkReader reader) + { + int length = reader.ReadInt(); + + // 'null' is encoded as '-1' + if (length < 0) return null; + + // prevent allocation attacks with a reasonable limit. + // server shouldn't allocate too much on client devices. + // client shouldn't allocate too much on server in ClientToServer [SyncVar]s. + if (length > NetworkReader.AllocationLimit) + { + // throw EndOfStream for consistency with ReadBlittable when out of data + throw new EndOfStreamException($"NetworkReader attempted to allocate a List<{typeof(T)}> {length} elements, which is larger than the allowed limit of {NetworkReader.AllocationLimit}."); + } + + List result = new List(length); + for (int i = 0; i < length; i++) + { + result.Add(reader.Read()); + } + return result; + } + + // while SyncSet is recommended for NetworkBehaviours, + // structs may have .Set members which weaver needs to be able to + // fully serialize for NetworkMessages etc. + // note that Weaver/Readers/GenerateReader() handles this manually. + // TODO writer not found. need to adjust weaver first. see tests. + /* + public static HashSet ReadHashSet(this NetworkReader reader) + { + int length = reader.ReadInt(); + if (length < 0) + return null; + HashSet result = new HashSet(); + for (int i = 0; i < length; i++) + { + result.Add(reader.Read()); + } + return result; + } + */ + + public static T[] ReadArray(this NetworkReader reader) + { + int length = reader.ReadInt(); + + // 'null' is encoded as '-1' + if (length < 0) return null; + + // prevent allocation attacks with a reasonable limit. + // server shouldn't allocate too much on client devices. + // client shouldn't allocate too much on server in ClientToServer [SyncVar]s. + if (length > NetworkReader.AllocationLimit) + { + // throw EndOfStream for consistency with ReadBlittable when out of data + throw new EndOfStreamException($"NetworkReader attempted to allocate an Array<{typeof(T)}> with {length} elements, which is larger than the allowed limit of {NetworkReader.AllocationLimit}."); + } + + // we can't check if reader.Remaining < length, + // because we don't know sizeof(T) since it's a managed type. + // if (length > reader.Remaining) throw new EndOfStreamException($"Received array that is too large: {length}"); + + T[] result = new T[length]; + for (int i = 0; i < length; i++) + { + result[i] = reader.Read(); + } + return result; + } + + public static Uri ReadUri(this NetworkReader reader) + { + string uriString = reader.ReadString(); + return (string.IsNullOrWhiteSpace(uriString) ? null : new Uri(uriString)); + } + + public static Texture2D ReadTexture2D(this NetworkReader reader) + { + // support 'null' textures for [SyncVar]s etc. + // https://github.com/vis2k/Mirror/issues/3144 + short width = reader.ReadShort(); + if (width == -1) return null; + + // read height + short height = reader.ReadShort(); + + // prevent allocation attacks with a reasonable limit. + // server shouldn't allocate too much on client devices. + // client shouldn't allocate too much on server in ClientToServer [SyncVar]s. + // log an error and return default. + // we don't want attackers to be able to trigger exceptions. + int totalSize = width * height; + if (totalSize > NetworkReader.AllocationLimit) + { + Debug.LogWarning($"NetworkReader attempted to allocate a Texture2D with total size (width * height) of {totalSize}, which is larger than the allowed limit of {NetworkReader.AllocationLimit}."); + return null; + } + + Texture2D texture2D = new Texture2D(width, height); + + // read pixel content + Color32[] pixels = reader.ReadArray(); + texture2D.SetPixels32(pixels); + texture2D.Apply(); + return texture2D; + } + + public static Sprite ReadSprite(this NetworkReader reader) + { + // support 'null' textures for [SyncVar]s etc. + // https://github.com/vis2k/Mirror/issues/3144 + Texture2D texture = reader.ReadTexture2D(); + if (texture == null) return null; + + // otherwise create a valid sprite + return Sprite.Create(texture, reader.ReadRect(), reader.ReadVector2()); + } + + public static DateTime ReadDateTime(this NetworkReader reader) => DateTime.FromOADate(reader.ReadDouble()); + public static DateTime? ReadDateTimeNullable(this NetworkReader reader) => reader.ReadBool() ? ReadDateTime(reader) : default(DateTime?); + } +} diff --git a/Assets/Mirror/Core/NetworkReaderExtensions.cs.meta b/Assets/Mirror/Core/NetworkReaderExtensions.cs.meta new file mode 100644 index 0000000..66536c9 --- /dev/null +++ b/Assets/Mirror/Core/NetworkReaderExtensions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 364a9f7ccd5541e19aa2ae0b81f0b3cf +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkReaderPool.cs b/Assets/Mirror/Core/NetworkReaderPool.cs new file mode 100644 index 0000000..d50258a --- /dev/null +++ b/Assets/Mirror/Core/NetworkReaderPool.cs @@ -0,0 +1,45 @@ +// API consistent with Microsoft's ObjectPool. +using System; +using System.Runtime.CompilerServices; + +namespace Mirror +{ + /// Pool of NetworkReaders to avoid allocations. + public static class NetworkReaderPool + { + // reuse Pool + // we still wrap it in NetworkReaderPool.Get/Recyle so we can reset the + // position and array before reusing. + static readonly Pool Pool = new Pool( + // byte[] will be assigned in GetReader + () => new NetworkReaderPooled(new byte[]{}), + // initial capacity to avoid allocations in the first few frames + 1000 + ); + + /// Get the next reader in the pool. If pool is empty, creates a new Reader + public static NetworkReaderPooled Get(byte[] bytes) + { + // grab from pool & set buffer + NetworkReaderPooled reader = Pool.Get(); + reader.SetBuffer(bytes); + return reader; + } + + /// Get the next reader in the pool. If pool is empty, creates a new Reader + public static NetworkReaderPooled Get(ArraySegment segment) + { + // grab from pool & set buffer + NetworkReaderPooled reader = Pool.Get(); + reader.SetBuffer(segment); + return reader; + } + + /// Returns a reader to the pool. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void Return(NetworkReaderPooled reader) + { + Pool.Return(reader); + } + } +} diff --git a/Assets/Mirror/Core/NetworkReaderPool.cs.meta b/Assets/Mirror/Core/NetworkReaderPool.cs.meta new file mode 100644 index 0000000..2c94768 --- /dev/null +++ b/Assets/Mirror/Core/NetworkReaderPool.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2bacff63613ad634a98f9e4d15d29dbf +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkReaderPooled.cs b/Assets/Mirror/Core/NetworkReaderPooled.cs new file mode 100644 index 0000000..5348904 --- /dev/null +++ b/Assets/Mirror/Core/NetworkReaderPooled.cs @@ -0,0 +1,15 @@ +// "NetworkReaderPooled" instead of "PooledNetworkReader" to group files, for +// easier IDE workflow and more elegant code. +using System; + +namespace Mirror +{ + /// Pooled NetworkReader, automatically returned to pool when using 'using' + // TODO make sealed again after removing obsolete NetworkReaderPooled! + public class NetworkReaderPooled : NetworkReader, IDisposable + { + internal NetworkReaderPooled(byte[] bytes) : base(bytes) {} + internal NetworkReaderPooled(ArraySegment segment) : base(segment) {} + public void Dispose() => NetworkReaderPool.Return(this); + } +} diff --git a/Assets/Mirror/Core/NetworkReaderPooled.cs.meta b/Assets/Mirror/Core/NetworkReaderPooled.cs.meta new file mode 100644 index 0000000..4eb6e9d --- /dev/null +++ b/Assets/Mirror/Core/NetworkReaderPooled.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: faafa97c32e44adf8e8888de817a370a +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkServer.cs b/Assets/Mirror/Core/NetworkServer.cs new file mode 100644 index 0000000..b3acb46 --- /dev/null +++ b/Assets/Mirror/Core/NetworkServer.cs @@ -0,0 +1,1864 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Mirror.RemoteCalls; +using UnityEngine; + +namespace Mirror +{ + /// NetworkServer handles remote connections and has a local connection for a local client. + public static partial class NetworkServer + { + static bool initialized; + public static int maxConnections; + + /// Server Update frequency, per second. Use around 60Hz for fast paced games like Counter-Strike to minimize latency. Use around 30Hz for games like WoW to minimize computations. Use around 1-10Hz for slow paced games like EVE. + // overwritten by NetworkManager (if any) + public static int tickRate = 60; + + // tick rate is in Hz. + // convert to interval in seconds for convenience where needed. + // + // send interval is 1 / sendRate. + // but for tests we need a way to set it to exactly 0. + // 1 / int.max would not be exactly 0, so handel that manually. + public static float tickInterval => tickRate < int.MaxValue ? 1f / tickRate : 0; // for 30 Hz, that's 33ms + + // time & value snapshot interpolation are separate. + // -> time is interpolated globally on NetworkClient / NetworkConnection + // -> value is interpolated per-component, i.e. NetworkTransform. + // however, both need to be on the same send interval. + public static int sendRate => tickRate; + public static float sendInterval => sendRate < int.MaxValue ? 1f / sendRate : 0; // for 30 Hz, that's 33ms + static double lastSendTime; + + /// Connection to host mode client (if any) + public static LocalConnectionToClient localConnection { get; private set; } + + /// Dictionary of all server connections, with connectionId as key + public static Dictionary connections = + new Dictionary(); + + /// Message Handlers dictionary, with messageId as key + internal static Dictionary handlers = + new Dictionary(); + + /// All spawned NetworkIdentities by netId. + // server sees ALL spawned ones. + public static readonly Dictionary spawned = + new Dictionary(); + + /// Single player mode can use dontListen to not accept incoming connections + // see also: https://github.com/vis2k/Mirror/pull/2595 + public static bool dontListen; + + // Deprecated 2022-12-12 + [Obsolete("NetworkServer.localClientActive was renamed to .activeHost to be more obvious")] + public static bool localClientActive => activeHost; + + /// active checks if the server has been started either has standalone or as host server. + public static bool active { get; internal set; } + + /// active checks if the server has been started in host mode. + // naming consistent with NetworkClient.activeHost. + public static bool activeHost => localConnection != null; + + // scene loading + public static bool isLoadingScene; + + // interest management component (optional) + // by default, everyone observes everyone + public static InterestManagementBase aoi; + + // Mirror global disconnect inactive option, independent of Transport. + // not all Transports do this properly, and it's easiest to configure this just once. + // this is very useful for some projects, keep it. + public static bool disconnectInactiveConnections; + public static float disconnectInactiveTimeout = 60; + + // OnConnected / OnDisconnected used to be NetworkMessages that were + // invoked. this introduced a bug where external clients could send + // Connected/Disconnected messages over the network causing undefined + // behaviour. + // => public so that custom NetworkManagers can hook into it + public static Action OnConnectedEvent; + public static Action OnDisconnectedEvent; + public static Action OnErrorEvent; + + // keep track of actual achieved tick rate. + // might become lower under heavy load. + // very useful for profiling etc. + // measured over 1s each, same as frame rate. no EMA here. + public static int actualTickRate; + static double actualTickRateStart; // start time when counting + static int actualTickRateCounter; // current counter since start + + // profiling + // includes transport update time, because transport calls handlers etc. + // averaged over 1s by passing 'tickRate' to constructor. + public static TimeSample earlyUpdateDuration; + public static TimeSample lateUpdateDuration; + + // capture full Unity update time from before Early- to after LateUpdate + public static TimeSample fullUpdateDuration; + + /// Starts server and listens to incoming connections with max connections limit. + public static void Listen(int maxConns) + { + Initialize(); + maxConnections = maxConns; + + // only start server if we want to listen + if (!dontListen) + { + Transport.active.ServerStart(); + //Debug.Log("Server started listening"); + } + + active = true; + RegisterMessageHandlers(); + } + + // initialization / shutdown /////////////////////////////////////////// + static void Initialize() + { + if (initialized) + return; + + // safety: ensure Weaving succeded. + // if it silently failed, we would get lots of 'writer not found' + // and other random errors at runtime instead. this is cleaner. + if (!WeaverFuse.Weaved()) + { + // if it failed, throw an exception to early exit all Listen calls. + throw new Exception("NetworkServer won't start because Weaving failed or didn't run."); + } + + // Debug.Log($"NetworkServer Created version {Version.Current}"); + + //Make sure connections are cleared in case any old connections references exist from previous sessions + connections.Clear(); + + // reset Interest Management so that rebuild intervals + // start at 0 when starting again. + if (aoi != null) aoi.Reset(); + + // reset NetworkTime + NetworkTime.ResetStatics(); + + Debug.Assert(Transport.active != null, "There was no active transport when calling NetworkServer.Listen, If you are calling Listen manually then make sure to set 'Transport.active' first"); + AddTransportHandlers(); + + initialized = true; + + // profiling + earlyUpdateDuration = new TimeSample(sendRate); + lateUpdateDuration = new TimeSample(sendRate); + fullUpdateDuration = new TimeSample(sendRate); + } + + static void AddTransportHandlers() + { + // += so that other systems can also hook into it (i.e. statistics) + Transport.active.OnServerConnected += OnTransportConnected; + Transport.active.OnServerDataReceived += OnTransportData; + Transport.active.OnServerDisconnected += OnTransportDisconnected; + Transport.active.OnServerError += OnTransportError; + } + + /// Shuts down the server and disconnects all clients + // RuntimeInitializeOnLoadMethod -> fast playmode without domain reload + [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] + public static void Shutdown() + { + if (initialized) + { + DisconnectAll(); + + // stop the server. + // we do NOT call Transport.Shutdown, because someone only + // called NetworkServer.Shutdown. we can't assume that the + // client is supposed to be shut down too! + // + // NOTE: stop no matter what, even if 'dontListen': + // someone might enabled dontListen at runtime. + // but we still need to stop the server. + // fixes https://github.com/vis2k/Mirror/issues/2536 + Transport.active.ServerStop(); + + // transport handlers are hooked into when initializing. + // so only remove them when shutting down. + RemoveTransportHandlers(); + + initialized = false; + } + + // Reset all statics here.... + dontListen = false; + isLoadingScene = false; + lastSendTime = 0; + actualTickRate = 0; + + localConnection = null; + + connections.Clear(); + connectionsCopy.Clear(); + handlers.Clear(); + + // destroy all spawned objects, _then_ set inactive. + // make sure .active is still true before calling this. + // otherwise modifying SyncLists in OnStopServer would throw + // because .IsWritable() check checks if NetworkServer.active. + // https://github.com/MirrorNetworking/Mirror/issues/3344 + CleanupSpawned(); + active = false; + + // sets nextNetworkId to 1 + // sets clientAuthorityCallback to null + // sets previousLocalPlayer to null + NetworkIdentity.ResetStatics(); + + // clear events. someone might have hooked into them before, but + // we don't want to use those hooks after Shutdown anymore. + OnConnectedEvent = null; + OnDisconnectedEvent = null; + OnErrorEvent = null; + + if (aoi != null) aoi.Reset(); + } + + static void RemoveTransportHandlers() + { + // -= so that other systems can also hook into it (i.e. statistics) + Transport.active.OnServerConnected -= OnTransportConnected; + Transport.active.OnServerDataReceived -= OnTransportData; + Transport.active.OnServerDisconnected -= OnTransportDisconnected; + Transport.active.OnServerError -= OnTransportError; + } + + // Note: NetworkClient.DestroyAllClientObjects does the same on client. + static void CleanupSpawned() + { + // iterate a COPY of spawned. + // DestroyObject removes them from the original collection. + // removing while iterating is not allowed. + foreach (NetworkIdentity identity in spawned.Values.ToList()) + { + if (identity != null) + { + // scene object + if (identity.sceneId != 0) + { + // spawned scene objects are unspawned and reset. + // afterwards we disable them again. + // (they always stay in the scene, we don't destroy them) + DestroyObject(identity, DestroyMode.Reset); + identity.gameObject.SetActive(false); + } + // spawned prefabs + else + { + // spawned prefabs are unspawned and destroyed. + DestroyObject(identity, DestroyMode.Destroy); + } + } + } + + spawned.Clear(); + } + + internal static void RegisterMessageHandlers() + { + RegisterHandler(OnClientReadyMessage); + RegisterHandler(OnCommandMessage); + RegisterHandler(NetworkTime.OnServerPing, false); + RegisterHandler(NetworkTime.OnServerPong, false); + RegisterHandler(OnEntityStateMessage, true); + RegisterHandler(OnTimeSnapshotMessage, true); + } + + // remote calls //////////////////////////////////////////////////////// + // Handle command from specific player, this could be one of multiple + // players on a single client + // default ready handler. + static void OnClientReadyMessage(NetworkConnectionToClient conn, ReadyMessage msg) + { + // Debug.Log($"Default handler for ready message from {conn}"); + SetClientReady(conn); + } + + static void OnCommandMessage(NetworkConnectionToClient conn, CommandMessage msg, int channelId) + { + if (!conn.isReady) + { + // Clients may be set NotReady due to scene change or other game logic by user, e.g. respawning. + // Ignore commands that may have been in flight before client received NotReadyMessage message. + // Unreliable messages may be out of order, so don't spam warnings for those. + if (channelId == Channels.Reliable) + Debug.LogWarning("Command received while client is not ready.\nThis may be ignored if client intentionally set NotReady."); + return; + } + + if (!spawned.TryGetValue(msg.netId, out NetworkIdentity identity)) + { + // over reliable channel, commands should always come after spawn. + // over unreliable, they might come in before the object was spawned. + // for example, NetworkTransform. + // let's not spam the console for unreliable out of order messages. + if (channelId == Channels.Reliable) + Debug.LogWarning($"Spawned object not found when handling Command message [netId={msg.netId}]"); + return; + } + + // Commands can be for player objects, OR other objects with client-authority + // -> so if this connection's controller has a different netId then + // only allow the command if clientAuthorityOwner + bool requiresAuthority = RemoteProcedureCalls.CommandRequiresAuthority(msg.functionHash); + if (requiresAuthority && identity.connectionToClient != conn) + { + Debug.LogWarning($"Command for object without authority [netId={msg.netId}]"); + return; + } + + // Debug.Log($"OnCommandMessage for netId:{msg.netId} conn:{conn}"); + + using (NetworkReaderPooled networkReader = NetworkReaderPool.Get(msg.payload)) + identity.HandleRemoteCall(msg.componentIndex, msg.functionHash, RemoteCallType.Command, networkReader, conn); + } + + // client to server broadcast ////////////////////////////////////////// + // for client's owned ClientToServer components. + static void OnEntityStateMessage(NetworkConnectionToClient connection, EntityStateMessage message) + { + // need to validate permissions carefully. + // an attacker may attempt to modify a not-owned or not-ClientToServer component. + + // valid netId? + if (spawned.TryGetValue(message.netId, out NetworkIdentity identity) && identity != null) + { + // owned by the connection? + if (identity.connectionToClient == connection) + { + using (NetworkReaderPooled reader = NetworkReaderPool.Get(message.payload)) + { + // DeserializeServer checks permissions internally. + // failure to deserialize disconnects to prevent exploits. + if (!identity.DeserializeServer(reader)) + { + Debug.LogWarning($"Server failed to deserialize client state for {identity.name} with netId={identity.netId}, Disconnecting."); + connection.Disconnect(); + } + } + } + // An attacker may attempt to modify another connection's entity + // This could also be a race condition of message in flight when + // RemoveClientAuthority is called, so not malicious. + // Don't disconnect, just log the warning. + else + Debug.LogWarning($"EntityStateMessage from {connection} for {identity} without authority."); + } + // no warning. don't spam server logs. + // else Debug.LogWarning($"Did not find target for sync message for {message.netId} . Note: this can be completely normal because UDP messages may arrive out of order, so this message might have arrived after a Destroy message."); + } + + // client sends TimeSnapshotMessage every sendInterval. + // batching already includes the remoteTimestamp. + // we simply insert it on-message here. + // => only for reliable channel. unreliable would always arrive earlier. + static void OnTimeSnapshotMessage(NetworkConnectionToClient connection, TimeSnapshotMessage _) + { + // insert another snapshot for snapshot interpolation. + // before calling OnDeserialize so components can use + // NetworkTime.time and NetworkTime.timeStamp. + + // TODO validation? + // maybe we shouldn't allow timeline to deviate more than a certain %. + // for now, this is only used for client authority movement. + + // Unity 2019 doesn't have Time.timeAsDouble yet + // + // NetworkTime uses unscaled time and ignores Time.timeScale. + // fixes Time.timeScale getting server & client time out of sync: + // https://github.com/MirrorNetworking/Mirror/issues/3409 + connection.OnTimeSnapshot(new TimeSnapshot(connection.remoteTimeStamp, NetworkTime.localTime)); + } + + // connections ///////////////////////////////////////////////////////// + /// Add a connection and setup callbacks. Returns true if not added yet. + public static bool AddConnection(NetworkConnectionToClient conn) + { + if (!connections.ContainsKey(conn.connectionId)) + { + // connection cannot be null here or conn.connectionId + // would throw NRE + connections[conn.connectionId] = conn; + return true; + } + // already a connection with this id + return false; + } + + /// Removes a connection by connectionId. Returns true if removed. + public static bool RemoveConnection(int connectionId) => + connections.Remove(connectionId); + + // called by LocalClient to add itself. don't call directly. + // TODO consider internal setter instead? + internal static void SetLocalConnection(LocalConnectionToClient conn) + { + if (localConnection != null) + { + Debug.LogError("Local Connection already exists"); + return; + } + + localConnection = conn; + } + + // removes local connection to client + internal static void RemoveLocalConnection() + { + if (localConnection != null) + { + localConnection.Disconnect(); + localConnection = null; + } + RemoveConnection(0); + } + + /// True if we have external connections (that are not host) + public static bool HasExternalConnections() + { + // any connections? + if (connections.Count > 0) + { + // only host connection? + if (connections.Count == 1 && localConnection != null) + return false; + + // otherwise we have real external connections + return true; + } + return false; + } + + // send //////////////////////////////////////////////////////////////// + /// Send a message to all clients, even those that haven't joined the world yet (non ready) + public static void SendToAll(T message, int channelId = Channels.Reliable, bool sendToReadyOnly = false) + where T : struct, NetworkMessage + { + if (!active) + { + Debug.LogWarning("Can not send using NetworkServer.SendToAll(T msg) because NetworkServer is not active"); + return; + } + + // Debug.Log($"Server.SendToAll {typeof(T)}"); + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + // pack message only once + NetworkMessages.Pack(message, writer); + ArraySegment segment = writer.ToArraySegment(); + + // filter and then send to all internet connections at once + // -> makes code more complicated, but is HIGHLY worth it to + // avoid allocations, allow for multicast, etc. + int count = 0; + foreach (NetworkConnectionToClient conn in connections.Values) + { + if (sendToReadyOnly && !conn.isReady) + continue; + + count++; + conn.Send(segment, channelId); + } + + NetworkDiagnostics.OnSend(message, channelId, segment.Count, count); + } + } + + /// Send a message to all clients which have joined the world (are ready). + // TODO put rpcs into NetworkServer.Update WorldState packet, then finally remove SendToReady! + public static void SendToReady(T message, int channelId = Channels.Reliable) + where T : struct, NetworkMessage + { + if (!active) + { + Debug.LogWarning("Can not send using NetworkServer.SendToReady(T msg) because NetworkServer is not active"); + return; + } + + SendToAll(message, channelId, true); + } + + // this is like SendToReadyObservers - but it doesn't check the ready flag on the connection. + // this is used for ObjectDestroy messages. + static void SendToObservers(NetworkIdentity identity, T message, int channelId = Channels.Reliable) + where T : struct, NetworkMessage + { + // Debug.Log($"Server.SendToObservers {typeof(T)}"); + if (identity == null || identity.observers.Count == 0) + return; + + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + // pack message into byte[] once + NetworkMessages.Pack(message, writer); + ArraySegment segment = writer.ToArraySegment(); + + foreach (NetworkConnectionToClient conn in identity.observers.Values) + { + conn.Send(segment, channelId); + } + + NetworkDiagnostics.OnSend(message, channelId, segment.Count, identity.observers.Count); + } + } + + /// Send a message to only clients which are ready with option to include the owner of the object identity + // TODO obsolete this later. it's not used anymore + public static void SendToReadyObservers(NetworkIdentity identity, T message, bool includeOwner = true, int channelId = Channels.Reliable) + where T : struct, NetworkMessage + { + // Debug.Log($"Server.SendToReady {typeof(T)}"); + if (identity == null || identity.observers.Count == 0) + return; + + using (NetworkWriterPooled writer = NetworkWriterPool.Get()) + { + // pack message only once + NetworkMessages.Pack(message, writer); + ArraySegment segment = writer.ToArraySegment(); + + int count = 0; + foreach (NetworkConnectionToClient conn in identity.observers.Values) + { + bool isOwner = conn == identity.connectionToClient; + if ((!isOwner || includeOwner) && conn.isReady) + { + count++; + conn.Send(segment, channelId); + } + } + + NetworkDiagnostics.OnSend(message, channelId, segment.Count, count); + } + } + + /// Send a message to only clients which are ready including the owner of the NetworkIdentity + // TODO obsolete this later. it's not used anymore + public static void SendToReadyObservers(NetworkIdentity identity, T message, int channelId) + where T : struct, NetworkMessage + { + SendToReadyObservers(identity, message, true, channelId); + } + + // transport events //////////////////////////////////////////////////// + // called by transport + static void OnTransportConnected(int connectionId) + { + // Debug.Log($"Server accepted client:{connectionId}"); + + // connectionId needs to be != 0 because 0 is reserved for local player + // note that some transports like kcp generate connectionId by + // hashing which can be < 0 as well, so we need to allow < 0! + if (connectionId == 0) + { + Debug.LogError($"Server.HandleConnect: invalid connectionId: {connectionId} . Needs to be != 0, because 0 is reserved for local player."); + Transport.active.ServerDisconnect(connectionId); + return; + } + + // connectionId not in use yet? + if (connections.ContainsKey(connectionId)) + { + Transport.active.ServerDisconnect(connectionId); + // Debug.Log($"Server connectionId {connectionId} already in use...kicked client"); + return; + } + + // are more connections allowed? if not, kick + // (it's easier to handle this in Mirror, so Transports can have + // less code and third party transport might not do that anyway) + // (this way we could also send a custom 'tooFull' message later, + // Transport can't do that) + if (connections.Count < maxConnections) + { + // add connection + NetworkConnectionToClient conn = new NetworkConnectionToClient(connectionId); + OnConnected(conn); + } + else + { + // kick + Transport.active.ServerDisconnect(connectionId); + // Debug.Log($"Server full, kicked client {connectionId}"); + } + } + + internal static void OnConnected(NetworkConnectionToClient conn) + { + // Debug.Log($"Server accepted client:{conn}"); + + // add connection and invoke connected event + AddConnection(conn); + OnConnectedEvent?.Invoke(conn); + } + + static bool UnpackAndInvoke(NetworkConnectionToClient connection, NetworkReader reader, int channelId) + { + if (NetworkMessages.UnpackId(reader, out ushort msgType)) + { + // try to invoke the handler for that message + if (handlers.TryGetValue(msgType, out NetworkMessageDelegate handler)) + { + handler.Invoke(connection, reader, channelId); + connection.lastMessageTime = Time.time; + return true; + } + else + { + // message in a batch are NOT length prefixed to save bandwidth. + // every message needs to be handled and read until the end. + // otherwise it would overlap into the next message. + // => need to warn and disconnect to avoid undefined behaviour. + // => WARNING, not error. can happen if attacker sends random data. + Debug.LogWarning($"Unknown message id: {msgType} for connection: {connection}. This can happen if no handler was registered for this message."); + // simply return false. caller is responsible for disconnecting. + //connection.Disconnect(); + return false; + } + } + else + { + // => WARNING, not error. can happen if attacker sends random data. + Debug.LogWarning($"Invalid message header for connection: {connection}."); + // simply return false. caller is responsible for disconnecting. + //connection.Disconnect(); + return false; + } + } + + // called by transport + internal static void OnTransportData(int connectionId, ArraySegment data, int channelId) + { + if (connections.TryGetValue(connectionId, out NetworkConnectionToClient connection)) + { + // client might batch multiple messages into one packet. + // feed it to the Unbatcher. + // NOTE: we don't need to associate a channelId because we + // always process all messages in the batch. + if (!connection.unbatcher.AddBatch(data)) + { + Debug.LogWarning($"NetworkServer: received Message was too short (messages should start with message id)"); + connection.Disconnect(); + return; + } + + // process all messages in the batch. + // only while NOT loading a scene. + // if we get a scene change message, then we need to stop + // processing. otherwise we might apply them to the old scene. + // => fixes https://github.com/vis2k/Mirror/issues/2651 + // + // NOTE: if scene starts loading, then the rest of the batch + // would only be processed when OnTransportData is called + // the next time. + // => consider moving processing to NetworkEarlyUpdate. + while (!isLoadingScene && + connection.unbatcher.GetNextMessage(out ArraySegment message, out double remoteTimestamp)) + { + using (NetworkReaderPooled reader = NetworkReaderPool.Get(message)) + { + // enough to read at least header size? + if (reader.Remaining >= NetworkMessages.IdSize) + { + // make remoteTimeStamp available to the user + connection.remoteTimeStamp = remoteTimestamp; + + // handle message + if (!UnpackAndInvoke(connection, reader, channelId)) + { + // warn, disconnect and return if failed + // -> warning because attackers might send random data + // -> messages in a batch aren't length prefixed. + // failing to read one would cause undefined + // behaviour for every message afterwards. + // so we need to disconnect. + // -> return to avoid the below unbatches.count error. + // we already disconnected and handled it. + Debug.LogWarning($"NetworkServer: failed to unpack and invoke message. Disconnecting {connectionId}."); + connection.Disconnect(); + return; + } + } + // otherwise disconnect + else + { + // WARNING, not error. can happen if attacker sends random data. + Debug.LogWarning($"NetworkServer: received Message was too short (messages should start with message id). Disconnecting {connectionId}"); + connection.Disconnect(); + return; + } + } + } + + // if we weren't interrupted by a scene change, + // then all batched messages should have been processed now. + // otherwise batches would silently grow. + // we need to log an error to avoid debugging hell. + // + // EXAMPLE: https://github.com/vis2k/Mirror/issues/2882 + // -> UnpackAndInvoke silently returned because no handler for id + // -> Reader would never be read past the end + // -> Batch would never be retired because end is never reached + // + // NOTE: prefixing every message in a batch with a length would + // avoid ever not reading to the end. for extra bandwidth. + // + // IMPORTANT: always keep this check to detect memory leaks. + // this took half a day to debug last time. + if (!isLoadingScene && connection.unbatcher.BatchesCount > 0) + { + Debug.LogError($"Still had {connection.unbatcher.BatchesCount} batches remaining after processing, even though processing was not interrupted by a scene change. This should never happen, as it would cause ever growing batches.\nPossible reasons:\n* A message didn't deserialize as much as it serialized\n*There was no message handler for a message id, so the reader wasn't read until the end."); + } + } + else Debug.LogError($"HandleData Unknown connectionId:{connectionId}"); + } + + // called by transport + // IMPORTANT: often times when disconnecting, we call this from Mirror + // too because we want to remove the connection and handle + // the disconnect immediately. + // => which is fine as long as we guarantee it only runs once + // => which we do by removing the connection! + internal static void OnTransportDisconnected(int connectionId) + { + // Debug.Log($"Server disconnect client:{connectionId}"); + if (connections.TryGetValue(connectionId, out NetworkConnectionToClient conn)) + { + RemoveConnection(connectionId); + // Debug.Log($"Server lost client:{connectionId}"); + + // NetworkManager hooks into OnDisconnectedEvent to make + // DestroyPlayerForConnection(conn) optional, e.g. for PvP MMOs + // where players shouldn't be able to escape combat instantly. + if (OnDisconnectedEvent != null) + { + OnDisconnectedEvent.Invoke(conn); + } + // if nobody hooked into it, then simply call DestroyPlayerForConnection + else + { + DestroyPlayerForConnection(conn); + } + } + } + + // transport errors are forwarded to high level + static void OnTransportError(int connectionId, TransportError error, string reason) + { + // transport errors will happen. logging a warning is enough. + // make sure the user does not panic. + Debug.LogWarning($"Server Transport Error for connId={connectionId}: {error}: {reason}. This is fine."); + // try get connection. passes null otherwise. + connections.TryGetValue(connectionId, out NetworkConnectionToClient conn); + OnErrorEvent?.Invoke(conn, error, reason); + } + + /// Destroys all of the connection's owned objects on the server. + // This is used when a client disconnects, to remove the players for + // that client. This also destroys non-player objects that have client + // authority set for this connection. + public static void DestroyPlayerForConnection(NetworkConnectionToClient conn) + { + // destroy all objects owned by this connection, including the player object + conn.DestroyOwnedObjects(); + // remove connection from all of its observing entities observers + // fixes https://github.com/vis2k/Mirror/issues/2737 + // -> cleaning those up in NetworkConnection.Disconnect is NOT enough + // because voluntary disconnects from the other end don't call + // NetworkConnection.Disconnect() + conn.RemoveFromObservingsObservers(); + conn.identity = null; + } + + // message handlers //////////////////////////////////////////////////// + /// Register a handler for message type T. Most should require authentication. + // TODO obsolete this some day to always use the channelId version. + // all handlers in this version are wrapped with 1 extra action. + public static void RegisterHandler(Action handler, bool requireAuthentication = true) + where T : struct, NetworkMessage + { + ushort msgType = NetworkMessageId.Id; + if (handlers.ContainsKey(msgType)) + { + Debug.LogWarning($"NetworkServer.RegisterHandler replacing handler for {typeof(T).FullName}, id={msgType}. If replacement is intentional, use ReplaceHandler instead to avoid this warning."); + } + + // register Id <> Type in lookup for debugging. + NetworkMessages.Lookup[msgType] = typeof(T); + + handlers[msgType] = NetworkMessages.WrapHandler(handler, requireAuthentication); + } + + /// Register a handler for message type T. Most should require authentication. + // This version passes channelId to the handler. + public static void RegisterHandler(Action handler, bool requireAuthentication = true) + where T : struct, NetworkMessage + { + ushort msgType = NetworkMessageId.Id; + if (handlers.ContainsKey(msgType)) + { + Debug.LogWarning($"NetworkServer.RegisterHandler replacing handler for {typeof(T).FullName}, id={msgType}. If replacement is intentional, use ReplaceHandler instead to avoid this warning."); + } + + // register Id <> Type in lookup for debugging. + NetworkMessages.Lookup[msgType] = typeof(T); + + handlers[msgType] = NetworkMessages.WrapHandler(handler, requireAuthentication); + } + + /// Replace a handler for message type T. Most should require authentication. + public static void ReplaceHandler(Action handler, bool requireAuthentication = true) + where T : struct, NetworkMessage + { + ReplaceHandler((_, value) => { handler(value); }, requireAuthentication); + } + + /// Replace a handler for message type T. Most should require authentication. + public static void ReplaceHandler(Action handler, bool requireAuthentication = true) + where T : struct, NetworkMessage + { + ushort msgType = NetworkMessageId.Id; + handlers[msgType] = NetworkMessages.WrapHandler(handler, requireAuthentication); + } + + /// Unregister a handler for a message type T. + public static void UnregisterHandler() + where T : struct, NetworkMessage + { + ushort msgType = NetworkMessageId.Id; + handlers.Remove(msgType); + } + + /// Clears all registered message handlers. + public static void ClearHandlers() => handlers.Clear(); + + internal static bool GetNetworkIdentity(GameObject go, out NetworkIdentity identity) + { + if (!go.TryGetComponent(out identity)) + { + Debug.LogError($"GameObject {go.name} doesn't have NetworkIdentity."); + return false; + } + return true; + } + + // disconnect ////////////////////////////////////////////////////////// + /// Disconnect all connections, including the local connection. + // synchronous: handles disconnect events and cleans up fully before returning! + public static void DisconnectAll() + { + // disconnect and remove all connections. + // we can not use foreach here because if + // conn.Disconnect -> Transport.ServerDisconnect calls + // OnDisconnect -> NetworkServer.OnDisconnect(connectionId) + // immediately then OnDisconnect would remove the connection while + // we are iterating here. + // see also: https://github.com/vis2k/Mirror/issues/2357 + // this whole process should be simplified some day. + // until then, let's copy .Values to avoid InvalidOperationException. + // note that this is only called when stopping the server, so the + // copy is no performance problem. + foreach (NetworkConnectionToClient conn in connections.Values.ToList()) + { + // disconnect via connection->transport + conn.Disconnect(); + + // we want this function to be synchronous: handle disconnect + // events and clean up fully before returning. + // -> OnTransportDisconnected can safely be called without + // waiting for the Transport's callback. + // -> it has checks to only run once. + + // call OnDisconnected unless local player in host mod + // TODO unnecessary check? + if (conn.connectionId != NetworkConnection.LocalConnectionId) + OnTransportDisconnected(conn.connectionId); + } + + // cleanup + connections.Clear(); + localConnection = null; + // this used to set active=false. + // however, then Shutdown can't properly destroy objects: + // https://github.com/MirrorNetworking/Mirror/issues/3344 + // "DisconnectAll" should only disconnect all, not set inactive. + // active = false; + } + + // add/remove/replace player /////////////////////////////////////////// + /// Called by server after AddPlayer message to add the player for the connection. + // When a player is added for a connection, the client for that + // connection is made ready automatically. The player object is + // automatically spawned, so you do not need to call NetworkServer.Spawn + // for that object. This function is used for "adding" a player, not for + // "replacing" the player on a connection. If there is already a player + // on this playerControllerId for this connection, this will fail. + public static bool AddPlayerForConnection(NetworkConnectionToClient conn, GameObject player, uint assetId) + { + if (GetNetworkIdentity(player, out NetworkIdentity identity)) + { + identity.assetId = assetId; + } + return AddPlayerForConnection(conn, player); + } + + /// Called by server after AddPlayer message to add the player for the connection. + // When a player is added for a connection, the client for that + // connection is made ready automatically. The player object is + // automatically spawned, so you do not need to call NetworkServer.Spawn + // for that object. This function is used for "adding" a player, not for + // "replacing" the player on a connection. If there is already a player + // on this playerControllerId for this connection, this will fail. + public static bool AddPlayerForConnection(NetworkConnectionToClient conn, GameObject player) + { + if (!player.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogWarning($"AddPlayer: playerGameObject has no NetworkIdentity. Please add a NetworkIdentity to {player}"); + return false; + } + + // cannot have a player object in "Add" version + if (conn.identity != null) + { + Debug.Log("AddPlayer: player object already exists"); + return false; + } + + // make sure we have a controller before we call SetClientReady + // because the observers will be rebuilt only if we have a controller + conn.identity = identity; + + // Set the connection on the NetworkIdentity on the server, NetworkIdentity.SetLocalPlayer is not called on the server (it is on clients) + identity.SetClientOwner(conn); + + // special case, we are in host mode, set hasAuthority to true so that all overrides see it + if (conn is LocalConnectionToClient) + { + identity.isOwned = true; + NetworkClient.InternalAddPlayer(identity); + } + + // set ready if not set yet + SetClientReady(conn); + + // Debug.Log($"Adding new playerGameObject object netId: {identity.netId} asset ID: {identity.assetId}"); + + Respawn(identity); + return true; + } + + /// Replaces connection's player object. The old object is not destroyed. + // This does NOT change the ready state of the connection, so it can + // safely be used while changing scenes. + public static bool ReplacePlayerForConnection(NetworkConnectionToClient conn, GameObject player, bool keepAuthority = false) + { + if (!player.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError($"ReplacePlayer: playerGameObject has no NetworkIdentity. Please add a NetworkIdentity to {player}"); + return false; + } + + if (identity.connectionToClient != null && identity.connectionToClient != conn) + { + Debug.LogError($"Cannot replace player for connection. New player is already owned by a different connection{player}"); + return false; + } + + //NOTE: there can be an existing player + //Debug.Log("NetworkServer ReplacePlayer"); + + NetworkIdentity previousPlayer = conn.identity; + + conn.identity = identity; + + // Set the connection on the NetworkIdentity on the server, NetworkIdentity.SetLocalPlayer is not called on the server (it is on clients) + identity.SetClientOwner(conn); + + // special case, we are in host mode, set hasAuthority to true so that all overrides see it + if (conn is LocalConnectionToClient) + { + identity.isOwned = true; + NetworkClient.InternalAddPlayer(identity); + } + + // add connection to observers AFTER the playerController was set. + // by definition, there is nothing to observe if there is no player + // controller. + // + // IMPORTANT: do this in AddPlayerForConnection & ReplacePlayerForConnection! + SpawnObserversForConnection(conn); + + //Debug.Log($"Replacing playerGameObject object netId:{player.GetComponent().netId} asset ID {player.GetComponent().assetId}"); + + Respawn(identity); + + if (keepAuthority) + { + // This needs to be sent to clear isLocalPlayer on + // client while keeping hasAuthority true + SendChangeOwnerMessage(previousPlayer, conn); + } + else + { + // This clears both isLocalPlayer and hasAuthority on client + previousPlayer.RemoveClientAuthority(); + } + + return true; + } + + /// Replaces connection's player object. The old object is not destroyed. + // This does NOT change the ready state of the connection, so it can + // safely be used while changing scenes. + public static bool ReplacePlayerForConnection(NetworkConnectionToClient conn, GameObject player, uint assetId, bool keepAuthority = false) + { + if (GetNetworkIdentity(player, out NetworkIdentity identity)) + { + identity.assetId = assetId; + } + return ReplacePlayerForConnection(conn, player, keepAuthority); + } + + /// Removes the player object from the connection + // destroyServerObject: Indicates whether the server object should be destroyed + public static void RemovePlayerForConnection(NetworkConnection conn, bool destroyServerObject) + { + if (conn.identity != null) + { + if (destroyServerObject) + Destroy(conn.identity.gameObject); + else + UnSpawn(conn.identity.gameObject); + + conn.identity = null; + } + //else Debug.Log($"Connection {conn} has no identity"); + } + + // ready /////////////////////////////////////////////////////////////// + /// Flags client connection as ready (=joined world). + // When a client has signaled that it is ready, this method tells the + // server that the client is ready to receive spawned objects and state + // synchronization updates. This is usually called in a handler for the + // SYSTEM_READY message. If there is not specific action a game needs to + // take for this message, relying on the default ready handler function + // is probably fine, so this call wont be needed. + public static void SetClientReady(NetworkConnectionToClient conn) + { + // Debug.Log($"SetClientReadyInternal for conn:{conn}"); + + // set ready + conn.isReady = true; + + // client is ready to start spawning objects + if (conn.identity != null) + SpawnObserversForConnection(conn); + } + + static void SpawnObserversForConnection(NetworkConnectionToClient conn) + { + //Debug.Log($"Spawning {spawned.Count} objects for conn {conn}"); + + if (!conn.isReady) + { + // client needs to finish initializing before we can spawn objects + // otherwise it would not find them. + return; + } + + // let connection know that we are about to start spawning... + conn.Send(new ObjectSpawnStartedMessage()); + + // add connection to each nearby NetworkIdentity's observers, which + // internally sends a spawn message for each one to the connection. + foreach (NetworkIdentity identity in spawned.Values) + { + // try with far away ones in ummorpg! + if (identity.gameObject.activeSelf) //TODO this is different + { + //Debug.Log($"Sending spawn message for current server objects name:{identity.name} netId:{identity.netId} sceneId:{identity.sceneId:X}"); + + // we need to support three cases: + // - legacy system (identity has .visibility) + // - new system (networkserver has .aoi) + // - default case: no .visibility and no .aoi means add all + // connections by default) + // + // ForceHidden/ForceShown overwrite all systems so check it + // first! + + // ForceShown: add no matter what + if (identity.visible == Visibility.ForceShown) + { + identity.AddObserver(conn); + } + // ForceHidden: don't show no matter what + else if (identity.visible == Visibility.ForceHidden) + { + // do nothing + } + // default: legacy system / new system / no system support + else if (identity.visible == Visibility.Default) + { + // aoi system + if (aoi != null) + { + // call OnCheckObserver + if (aoi.OnCheckObserver(identity, conn)) + identity.AddObserver(conn); + } + // no system: add all observers by default + else + { + identity.AddObserver(conn); + } + } + } + } + + // let connection know that we finished spawning, so it can call + // OnStartClient on each one (only after all were spawned, which + // is how Unity's Start() function works too) + conn.Send(new ObjectSpawnFinishedMessage()); + } + + /// Marks the client of the connection to be not-ready. + // Clients that are not ready do not receive spawned objects or state + // synchronization updates. They client can be made ready again by + // calling SetClientReady(). + public static void SetClientNotReady(NetworkConnectionToClient conn) + { + conn.isReady = false; + conn.RemoveFromObservingsObservers(); + conn.Send(new NotReadyMessage()); + } + + /// Marks all connected clients as no longer ready. + // All clients will no longer be sent state synchronization updates. The + // player's clients can call ClientManager.Ready() again to re-enter the + // ready state. This is useful when switching scenes. + public static void SetAllClientsNotReady() + { + foreach (NetworkConnectionToClient conn in connections.Values) + { + SetClientNotReady(conn); + } + } + + // show / hide for connection ////////////////////////////////////////// + internal static void ShowForConnection(NetworkIdentity identity, NetworkConnection conn) + { + if (conn.isReady) + SendSpawnMessage(identity, conn); + } + + internal static void HideForConnection(NetworkIdentity identity, NetworkConnection conn) + { + ObjectHideMessage msg = new ObjectHideMessage + { + netId = identity.netId + }; + conn.Send(msg); + } + + // spawning //////////////////////////////////////////////////////////// + internal static void SendSpawnMessage(NetworkIdentity identity, NetworkConnection conn) + { + if (identity.serverOnly) return; + + //Debug.Log($"Server SendSpawnMessage: name:{identity.name} sceneId:{identity.sceneId:X} netid:{identity.netId}"); + + // one writer for owner, one for observers + using (NetworkWriterPooled ownerWriter = NetworkWriterPool.Get(), observersWriter = NetworkWriterPool.Get()) + { + bool isOwner = identity.connectionToClient == conn; + ArraySegment payload = CreateSpawnMessagePayload(isOwner, identity, ownerWriter, observersWriter); + SpawnMessage message = new SpawnMessage + { + netId = identity.netId, + isLocalPlayer = conn.identity == identity, + isOwner = isOwner, + sceneId = identity.sceneId, + assetId = identity.assetId, + // use local values for VR support + position = identity.transform.localPosition, + rotation = identity.transform.localRotation, + scale = identity.transform.localScale, + payload = payload + }; + conn.Send(message); + } + } + + static ArraySegment CreateSpawnMessagePayload(bool isOwner, NetworkIdentity identity, NetworkWriterPooled ownerWriter, NetworkWriterPooled observersWriter) + { + // Only call SerializeAll if there are NetworkBehaviours + if (identity.NetworkBehaviours.Length == 0) + { + return default; + } + + // serialize all components with initialState = true + // (can be null if has none) + identity.SerializeServer(true, ownerWriter, observersWriter); + + // convert to ArraySegment to avoid reader allocations + // if nothing was written, .ToArraySegment returns an empty segment. + ArraySegment ownerSegment = ownerWriter.ToArraySegment(); + ArraySegment observersSegment = observersWriter.ToArraySegment(); + + // use owner segment if 'conn' owns this identity, otherwise + // use observers segment + ArraySegment payload = isOwner ? ownerSegment : observersSegment; + + return payload; + } + + internal static void SendChangeOwnerMessage(NetworkIdentity identity, NetworkConnectionToClient conn) + { + // Don't send if identity isn't spawned or only exists on server + if (identity.netId == 0 || identity.serverOnly) return; + + // Don't send if conn doesn't have the identity spawned yet + // May be excluded from the client by interest management + if (!conn.observing.Contains(identity)) return; + + //Debug.Log($"Server SendChangeOwnerMessage: name={identity.name} netid={identity.netId}"); + + conn.Send(new ChangeOwnerMessage + { + netId = identity.netId, + isOwner = identity.connectionToClient == conn, + isLocalPlayer = conn.identity == identity + }); + } + + // check NetworkIdentity parent before spawning it. + // - without parent, they are spawned + // - with parent, only if the parent is active in hierarchy + // + // note that active parents may have inactive parents of their own. + // we need to check .activeInHierarchy. + // + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3330 + // https://github.com/vis2k/Mirror/issues/2778 + static bool ValidParent(NetworkIdentity identity) => + identity.transform.parent == null || + identity.transform.parent.gameObject.activeInHierarchy; + + /// Spawns NetworkIdentities in the scene on the server. + // NetworkIdentity objects in a scene are disabled by default. Calling + // SpawnObjects() causes these scene objects to be enabled and spawned. + // It is like calling NetworkServer.Spawn() for each of them. + public static bool SpawnObjects() + { + // only if server active + if (!active) + return false; + + // find all NetworkIdentities in the scene. + // all of them are disabled because of NetworkScenePostProcess. + NetworkIdentity[] identities = Resources.FindObjectsOfTypeAll(); + + // first pass: activate all scene objects + foreach (NetworkIdentity identity in identities) + { + // only spawn scene objects which haven't been spawned yet. + // SpawnObjects may be called multiple times for additive scenes. + // https://github.com/MirrorNetworking/Mirror/issues/3318 + // + // note that we even activate objects under inactive parents. + // while they are not spawned, they do need to be activated + // in order to be spawned later. so here, we don't check parents. + // https://github.com/MirrorNetworking/Mirror/issues/3330 + if (Utils.IsSceneObject(identity) && identity.netId == 0) + { + // Debug.Log($"SpawnObjects sceneId:{identity.sceneId:X} name:{identity.gameObject.name}"); + identity.gameObject.SetActive(true); + } + } + + // second pass: spawn all scene objects + foreach (NetworkIdentity identity in identities) + { + // scene objects may be children of inactive parents. + // users would put them under disabled parents to 'deactivate' them. + // those should not be used by Mirror at all. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3330 + // https://github.com/vis2k/Mirror/issues/2778 + if (Utils.IsSceneObject(identity) && identity.netId == 0 && ValidParent(identity)) + { + // pass connection so that authority is not lost when server loads a scene + // https://github.com/vis2k/Mirror/pull/2987 + Spawn(identity.gameObject, identity.connectionToClient); + } + } + + return true; + } + + /// Spawns an object and also assigns Client Authority to the specified client. + // This is the same as calling NetworkIdentity.AssignClientAuthority on the spawned object. + public static void Spawn(GameObject obj, GameObject ownerPlayer) + { + if (!ownerPlayer.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError("Player object has no NetworkIdentity"); + return; + } + + if (identity.connectionToClient == null) + { + Debug.LogError("Player object is not a player."); + return; + } + + Spawn(obj, identity.connectionToClient); + } + + static void Respawn(NetworkIdentity identity) + { + if (identity.netId == 0) + { + // If the object has not been spawned, then do a full spawn and update observers + Spawn(identity.gameObject, identity.connectionToClient); + } + else + { + // otherwise just replace his data + SendSpawnMessage(identity, identity.connectionToClient); + } + } + + /// Spawn the given game object on all clients which are ready. + // This will cause a new object to be instantiated from the registered + // prefab, or from a custom spawn function. + public static void Spawn(GameObject obj, NetworkConnection ownerConnection = null) + { + SpawnObject(obj, ownerConnection); + } + + /// Spawns an object and also assigns Client Authority to the specified client. + // This is the same as calling NetworkIdentity.AssignClientAuthority on the spawned object. + public static void Spawn(GameObject obj, uint assetId, NetworkConnection ownerConnection = null) + { + if (GetNetworkIdentity(obj, out NetworkIdentity identity)) + { + identity.assetId = assetId; + } + SpawnObject(obj, ownerConnection); + } + + static void SpawnObject(GameObject obj, NetworkConnection ownerConnection) + { + // verify if we can spawn this + if (Utils.IsPrefab(obj)) + { + Debug.LogError($"GameObject {obj.name} is a prefab, it can't be spawned. Instantiate it first.", obj); + return; + } + + if (!active) + { + Debug.LogError($"SpawnObject for {obj}, NetworkServer is not active. Cannot spawn objects without an active server.", obj); + return; + } + + if (!obj.TryGetComponent(out NetworkIdentity identity)) + { + Debug.LogError($"SpawnObject {obj} has no NetworkIdentity. Please add a NetworkIdentity to {obj}", obj); + return; + } + + if (identity.SpawnedFromInstantiate) + { + // Using Instantiate on SceneObject is not allowed, so stop spawning here + // NetworkIdentity.Awake already logs error, no need to log a second error here + return; + } + + // Spawn should only be called once per netId. + // calling it twice would lead to undefined behaviour. + // https://github.com/MirrorNetworking/Mirror/pull/3205 + if (spawned.ContainsKey(identity.netId)) + { + Debug.LogWarning($"{identity} with netId={identity.netId} was already spawned.", identity.gameObject); + return; + } + + identity.connectionToClient = (NetworkConnectionToClient)ownerConnection; + + // special case to make sure hasAuthority is set + // on start server in host mode + if (ownerConnection is LocalConnectionToClient) + identity.isOwned = true; + + // only call OnStartServer if not spawned yet. + // check used to be in NetworkIdentity. may not be necessary anymore. + if (!identity.isServer && identity.netId == 0) + { + // configure NetworkIdentity + // this may be called in host mode, so we need to initialize + // isLocalPlayer/isClient flags too. + identity.isLocalPlayer = NetworkClient.localPlayer == identity; + identity.isClient = NetworkClient.active; + identity.isServer = true; + identity.netId = NetworkIdentity.GetNextNetworkId(); + + // add to spawned (after assigning netId) + spawned[identity.netId] = identity; + + // callback after all fields were set + identity.OnStartServer(); + } + + // Debug.Log($"SpawnObject instance ID {identity.netId} asset ID {identity.assetId}"); + + if (aoi) + { + // This calls user code which might throw exceptions + // We don't want this to leave us in bad state + try + { + aoi.OnSpawned(identity); + } + catch (Exception e) + { + Debug.LogException(e); + } + } + + RebuildObservers(identity, true); + } + + /// This takes an object that has been spawned and un-spawns it. + // The object will be removed from clients that it was spawned on, or + // the custom spawn handler function on the client will be called for + // the object. + // Unlike when calling NetworkServer.Destroy(), on the server the object + // will NOT be destroyed. This allows the server to re-use the object, + // even spawn it again later. + public static void UnSpawn(GameObject obj) => DestroyObject(obj, DestroyMode.Reset); + + // destroy ///////////////////////////////////////////////////////////// + // sometimes we want to GameObject.Destroy it. + // sometimes we want to just unspawn on clients and .Reset() it on server. + // => 'bool destroy' isn't obvious enough. it's really destroy OR reset! + enum DestroyMode { Destroy, Reset } + + /// Destroys this object and corresponding objects on all clients. + // In some cases it is useful to remove an object but not delete it on + // the server. For that, use NetworkServer.UnSpawn() instead of + // NetworkServer.Destroy(). + public static void Destroy(GameObject obj) => DestroyObject(obj, DestroyMode.Destroy); + + static void DestroyObject(GameObject obj, DestroyMode mode) + { + if (obj == null) + { + Debug.Log("NetworkServer DestroyObject is null"); + return; + } + + if (GetNetworkIdentity(obj, out NetworkIdentity identity)) + { + DestroyObject(identity, mode); + } + } + + static void DestroyObject(NetworkIdentity identity, DestroyMode mode) + { + // Debug.Log($"DestroyObject instance:{identity.netId}"); + + // only call OnRebuildObservers while active, + // not while shutting down + // (https://github.com/vis2k/Mirror/issues/2977) + if (active && aoi) + { + // This calls user code which might throw exceptions + // We don't want this to leave us in bad state + try + { + aoi.OnDestroyed(identity); + } + catch (Exception e) + { + Debug.LogException(e); + } + } + + // remove from NetworkServer (this) dictionary + spawned.Remove(identity.netId); + + identity.connectionToClient?.RemoveOwnedObject(identity); + + // send object destroy message to all observers, clear observers + SendToObservers(identity, new ObjectDestroyMessage + { + netId = identity.netId + }); + identity.ClearObservers(); + + // in host mode, call OnStopClient/OnStopLocalPlayer manually + if (NetworkClient.active && activeHost) + { + if (identity.isLocalPlayer) + identity.OnStopLocalPlayer(); + + identity.OnStopClient(); + // The object may have been spawned with host client ownership, + // e.g. a pet so we need to clear hasAuthority and call + // NotifyAuthority which invokes OnStopAuthority if hasAuthority. + identity.isOwned = false; + identity.NotifyAuthority(); + + // remove from NetworkClient dictionary + NetworkClient.connection.owned.Remove(identity); + NetworkClient.spawned.Remove(identity.netId); + } + + // we are on the server. call OnStopServer. + identity.OnStopServer(); + + // are we supposed to GameObject.Destroy() it completely? + if (mode == DestroyMode.Destroy) + { + identity.destroyCalled = true; + + // Destroy if application is running + if (Application.isPlaying) + { + UnityEngine.Object.Destroy(identity.gameObject); + } + // Destroy can't be used in Editor during tests. use DestroyImmediate. + else + { + GameObject.DestroyImmediate(identity.gameObject); + } + } + // otherwise simply .Reset() and set inactive again + else if (mode == DestroyMode.Reset) + { + identity.Reset(); + } + } + + // interest management ///////////////////////////////////////////////// + + // Helper function to add all server connections as observers. + // This is used if none of the components provides their own + // OnRebuildObservers function. + // rebuild observers default method (no AOI) - adds all connections + static void RebuildObserversDefault(NetworkIdentity identity, bool initialize) + { + // only add all connections when rebuilding the first time. + // second time we just keep them without rebuilding anything. + if (initialize) + { + // not force hidden? + if (identity.visible != Visibility.ForceHidden) + { + AddAllReadyServerConnectionsToObservers(identity); + } + } + } + + internal static void AddAllReadyServerConnectionsToObservers(NetworkIdentity identity) + { + // add all server connections + foreach (NetworkConnectionToClient conn in connections.Values) + { + // only if authenticated (don't send to people during logins) + if (conn.isReady) + identity.AddObserver(conn); + } + + // add local host connection (if any) + if (localConnection != null && localConnection.isReady) + { + identity.AddObserver(localConnection); + } + } + + // RebuildObservers does a local rebuild for the NetworkIdentity. + // This causes the set of players that can see this object to be rebuild. + // + // IMPORTANT: + // => global rebuild would be more simple, BUT + // => local rebuild is way faster for spawn/despawn because we can + // simply rebuild a select NetworkIdentity only + // => having both .observers and .observing is necessary for local + // rebuilds + // + // in other words, this is the perfect solution even though it's not + // completely simple (due to .observers & .observing) + // + // Mirror maintains .observing automatically in the background. best of + // both worlds without any worrying now! + public static void RebuildObservers(NetworkIdentity identity, bool initialize) + { + // if there is no interest management system, + // or if 'force shown' then add all connections + if (aoi == null || identity.visible == Visibility.ForceShown) + { + RebuildObserversDefault(identity, initialize); + } + // otherwise let interest management system rebuild + else + { + aoi.Rebuild(identity, initialize); + } + } + + + // broadcasting //////////////////////////////////////////////////////// + // helper function to get the right serialization for a connection + static NetworkWriter SerializeForConnection(NetworkIdentity identity, NetworkConnectionToClient connection) + { + // get serialization for this entity (cached) + // IMPORTANT: int tick avoids floating point inaccuracy over days/weeks + NetworkIdentitySerialization serialization = identity.GetServerSerializationAtTick(Time.frameCount); + + // is this entity owned by this connection? + bool owned = identity.connectionToClient == connection; + + // send serialized data + // owner writer if owned + if (owned) + { + // was it dirty / did we actually serialize anything? + if (serialization.ownerWriter.Position > 0) + return serialization.ownerWriter; + } + // observers writer if not owned + else + { + // was it dirty / did we actually serialize anything? + if (serialization.observersWriter.Position > 0) + return serialization.observersWriter; + } + + // nothing was serialized + return null; + } + + // helper function to broadcast the world to a connection + static void BroadcastToConnection(NetworkConnectionToClient connection) + { + // for each entity that this connection is seeing + foreach (NetworkIdentity identity in connection.observing) + { + // make sure it's not null or destroyed. + // (which can happen if someone uses + // GameObject.Destroy instead of + // NetworkServer.Destroy) + if (identity != null) + { + // get serialization for this entity viewed by this connection + // (if anything was serialized this time) + NetworkWriter serialization = SerializeForConnection(identity, connection); + if (serialization != null) + { + EntityStateMessage message = new EntityStateMessage + { + netId = identity.netId, + payload = serialization.ToArraySegment() + }; + connection.Send(message); + } + } + // spawned list should have no null entries because we + // always call Remove in OnObjectDestroy everywhere. + // if it does have null then someone used + // GameObject.Destroy instead of NetworkServer.Destroy. + else Debug.LogWarning($"Found 'null' entry in observing list for connectionId={connection.connectionId}. Please call NetworkServer.Destroy to destroy networked objects. Don't use GameObject.Destroy."); + } + } + + // helper function to check a connection for inactivity and disconnect if necessary + // returns true if disconnected + static bool DisconnectIfInactive(NetworkConnectionToClient connection) + { + // check for inactivity + if (disconnectInactiveConnections && + !connection.IsAlive(disconnectInactiveTimeout)) + { + Debug.LogWarning($"Disconnecting {connection} for inactivity!"); + connection.Disconnect(); + return true; + } + return false; + } + + // NetworkLateUpdate called after any Update/FixedUpdate/LateUpdate + // (we add this to the UnityEngine in NetworkLoop) + // internal for tests + internal static readonly List connectionsCopy = + new List(); + + static void Broadcast() + { + // copy all connections into a helper collection so that + // OnTransportDisconnected can be called while iterating. + // -> OnTransportDisconnected removes from the collection + // -> which would throw 'can't modify while iterating' errors + // => see also: https://github.com/vis2k/Mirror/issues/2739 + // (copy nonalloc) + // TODO remove this when we move to 'lite' transports with only + // socket send/recv later. + connectionsCopy.Clear(); + connections.Values.CopyTo(connectionsCopy); + + // go through all connections + foreach (NetworkConnectionToClient connection in connectionsCopy) + { + // check for inactivity. disconnects if necessary. + if (DisconnectIfInactive(connection)) + continue; + + // has this connection joined the world yet? + // for each READY connection: + // pull in UpdateVarsMessage for each entity it observes + if (connection.isReady) + { + // send time for snapshot interpolation every sendInterval. + // BroadcastToConnection() may not send if nothing is new. + // + // sent over unreliable. + // NetworkTime / Transform both use unreliable. + // + // make sure Broadcast() is only called every sendInterval, + // even if targetFrameRate isn't set in host mode (!) + // (done via AccurateInterval) + connection.Send(new TimeSnapshotMessage(), Channels.Unreliable); + + // broadcast world state to this connection + BroadcastToConnection(connection); + } + + // update connection to flush out batched messages + connection.Update(); + } + + // TODO this is way too slow because we iterate ALL spawned :/ + // TODO this is way too complicated :/ + // to understand what this tries to prevent, consider this example: + // monster has health=100 + // we change health=200, dirty bit is set + // player comes in range, gets full serialization spawn packet. + // next Broadcast(), player gets the health=200 change because dirty bit was set. + // + // this code clears all dirty bits if no players are around to prevent it. + // BUT there are two issues: + // 1. what if a playerB was around the whole time? + // 2. why don't we handle broadcast and spawn packets both HERE? + // handling spawn separately is why we need this complex magic + // + // see test: DirtyBitsAreClearedForSpawnedWithoutObservers() + // see test: SyncObjectChanges_DontGrowWithoutObservers() + // + // PAUL: we also do this to avoid ever growing SyncList .changes + //ClearSpawnedDirtyBits(); + // + // this was moved to NetworkIdentity.AddObserver! + // same result, but no more O(N) loop in here! + // TODO remove this comment after moving spawning into Broadcast()! + } + + // update ////////////////////////////////////////////////////////////// + // NetworkEarlyUpdate called before any Update/FixedUpdate + // (we add this to the UnityEngine in NetworkLoop) + internal static void NetworkEarlyUpdate() + { + // measure update time for profiling. + if (active) + { + earlyUpdateDuration.Begin(); + fullUpdateDuration.Begin(); + } + + // process all incoming messages first before updating the world + if (Transport.active != null) + Transport.active.ServerEarlyUpdate(); + + // step each connection's local time interpolation in early update. + foreach (NetworkConnectionToClient connection in connections.Values) + connection.UpdateTimeInterpolation(); + + if (active) earlyUpdateDuration.End(); + } + + internal static void NetworkLateUpdate() + { + if (active) + { + // measure update time for profiling. + lateUpdateDuration.Begin(); + + // only broadcast world if active + // broadcast every sendInterval. + // AccurateInterval to avoid update frequency inaccuracy issues: + // https://github.com/vis2k/Mirror/pull/3153 + // + // for example, host mode server doesn't set .targetFrameRate. + // Broadcast() would be called every tick. + // snapshots might be sent way too often, etc. + // + // during tests, we always call Broadcast() though. + // + // also important for syncInterval=0 components like + // NetworkTransform, so they can sync on same interval as time + // snapshots _but_ not every single tick. + // Unity 2019 doesn't have Time.timeAsDouble yet + if (!Application.isPlaying || AccurateInterval.Elapsed(NetworkTime.localTime, sendInterval, ref lastSendTime)) + Broadcast(); + } + + // process all outgoing messages after updating the world + // (even if not active. still want to process disconnects etc.) + if (Transport.active != null) + Transport.active.ServerLateUpdate(); + + // measure actual tick rate every second. + if (active) + { + ++actualTickRateCounter; + + // NetworkTime.localTime has defines for 2019 / 2020 compatibility + if (NetworkTime.localTime >= actualTickRateStart + 1) + { + // calculate avg by exact elapsed time. + // assuming 1s wouldn't be accurate, usually a few more ms passed. + float elapsed = (float)(NetworkTime.localTime - actualTickRateStart); + actualTickRate = Mathf.RoundToInt(actualTickRateCounter / elapsed); + actualTickRateStart = NetworkTime.localTime; + actualTickRateCounter = 0; + } + + // measure total update time. including transport. + // because in early update, transport update calls handlers. + lateUpdateDuration.End(); + fullUpdateDuration.End(); + } + } + + // calls OnStartClient for all SERVER objects in host mode once. + // client doesn't get spawn messages for those, so need to call manually. + // Deprecated 2022-12-12 + [Obsolete("NetworkServer.ActivateHostScene was moved to HostMode.ActivateHostScene")] + public static void ActivateHostScene() => HostMode.ActivateHostScene(); + } +} diff --git a/Assets/Mirror/Core/NetworkServer.cs.meta b/Assets/Mirror/Core/NetworkServer.cs.meta new file mode 100644 index 0000000..9861342 --- /dev/null +++ b/Assets/Mirror/Core/NetworkServer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a5f5ec068f5604c32b160bc49ee97b75 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkStartPosition.cs b/Assets/Mirror/Core/NetworkStartPosition.cs new file mode 100644 index 0000000..e11029b --- /dev/null +++ b/Assets/Mirror/Core/NetworkStartPosition.cs @@ -0,0 +1,21 @@ +using UnityEngine; + +namespace Mirror +{ + /// Start position for player spawning, automatically registers itself in the NetworkManager. + [DisallowMultipleComponent] + [AddComponentMenu("Network/Network Start Position")] + [HelpURL("https://mirror-networking.gitbook.io/docs/components/network-start-position")] + public class NetworkStartPosition : MonoBehaviour + { + public void Awake() + { + NetworkManager.RegisterStartPosition(transform); + } + + public void OnDestroy() + { + NetworkManager.UnRegisterStartPosition(transform); + } + } +} diff --git a/Assets/Mirror/Core/NetworkStartPosition.cs.meta b/Assets/Mirror/Core/NetworkStartPosition.cs.meta new file mode 100644 index 0000000..ae9ab89 --- /dev/null +++ b/Assets/Mirror/Core/NetworkStartPosition.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 41f84591ce72545258ea98cb7518d8b9 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkTime.cs b/Assets/Mirror/Core/NetworkTime.cs new file mode 100644 index 0000000..bea4982 --- /dev/null +++ b/Assets/Mirror/Core/NetworkTime.cs @@ -0,0 +1,166 @@ +// NetworkTime now uses NetworkClient's snapshot interpolated timeline. +// this gives ideal results & ensures everything is on the same timeline. +// previously, NetworkTransforms were on separate timelines. +// +// however, some of the old NetworkTime code remains for ping time (rtt). +// some users may still be using that. +using System; +using System.Runtime.CompilerServices; +using UnityEngine; +#if !UNITY_2020_3_OR_NEWER +using Stopwatch = System.Diagnostics.Stopwatch; +#endif + +namespace Mirror +{ + /// Synchronizes server time to clients. + public static class NetworkTime + { + /// Ping message interval, used to calculate network time and RTT + public static float PingInterval = 2; + + // DEPRECATED 2023-07-06 + [Obsolete("NetworkTime.PingFrequency was renamed to PingInterval, because we use it as seconds, not as Hz. Please rename all usages, but keep using it just as before.")] + public static float PingFrequency + { + get => PingInterval; + set => PingInterval = value; + } + + /// Average out the last few results from Ping + public static int PingWindowSize = 6; + + static double lastPingTime; + + static ExponentialMovingAverage _rtt = new ExponentialMovingAverage(PingWindowSize); + + /// Returns double precision clock time _in this system_, unaffected by the network. +#if UNITY_2020_3_OR_NEWER + public static double localTime + { + // NetworkTime uses unscaled time and ignores Time.timeScale. + // fixes Time.timeScale getting server & client time out of sync: + // https://github.com/MirrorNetworking/Mirror/issues/3409 + [MethodImpl(MethodImplOptions.AggressiveInlining)] + get => Time.unscaledTimeAsDouble; + } +#else + // need stopwatch for older Unity versions, but it's quite slow. + // CAREFUL: unlike Time.time, this is not a FRAME time. + // it changes during the frame too. + static readonly Stopwatch stopwatch = new Stopwatch(); + static NetworkTime() => stopwatch.Start(); + public static double localTime => stopwatch.Elapsed.TotalSeconds; +#endif + + /// The time in seconds since the server started. + // via global NetworkClient snapshot interpolated timeline (if client). + // on server, this is simply Time.timeAsDouble. + // + // I measured the accuracy of float and I got this: + // for the same day, accuracy is better than 1 ms + // after 1 day, accuracy goes down to 7 ms + // after 10 days, accuracy is 61 ms + // after 30 days , accuracy is 238 ms + // after 60 days, accuracy is 454 ms + // in other words, if the server is running for 2 months, + // and you cast down to float, then the time will jump in 0.4s intervals. + public static double time + { + [MethodImpl(MethodImplOptions.AggressiveInlining)] + get => NetworkServer.active + ? localTime + : NetworkClient.localTimeline; + } + + /// Clock difference in seconds between the client and the server. Always 0 on server. + // original implementation used 'client - server' time. keep it this way. + // TODO obsolete later. people shouldn't worry about this. + public static double offset => localTime - time; + + /// Round trip time (in seconds) that it takes a message to go client->server->client. + public static double rtt => _rtt.Value; + + /// Round trip time variance aka jitter, in seconds. + // "rttVariance" instead of "rttVar" for consistency with older versions. + public static double rttVariance => _rtt.Variance; + + // RuntimeInitializeOnLoadMethod -> fast playmode without domain reload + [RuntimeInitializeOnLoadMethod] + public static void ResetStatics() + { + PingInterval = 2; + PingWindowSize = 6; + lastPingTime = 0; + _rtt = new ExponentialMovingAverage(PingWindowSize); +#if !UNITY_2020_3_OR_NEWER + stopwatch.Restart(); +#endif + } + + internal static void UpdateClient() + { + // localTime (double) instead of Time.time for accuracy over days + if (localTime >= lastPingTime + PingInterval) + { + NetworkPingMessage pingMessage = new NetworkPingMessage(localTime); + NetworkClient.Send(pingMessage, Channels.Unreliable); + lastPingTime = localTime; + } + } + + // client rtt calculation ////////////////////////////////////////////// + // executed at the server when we receive a ping message + // reply with a pong containing the time from the client + // and time from the server + internal static void OnServerPing(NetworkConnectionToClient conn, NetworkPingMessage message) + { + // Debug.Log($"OnServerPing conn:{conn}"); + NetworkPongMessage pongMessage = new NetworkPongMessage + { + localTime = message.localTime, + }; + conn.Send(pongMessage, Channels.Unreliable); + } + + // Executed at the client when we receive a Pong message + // find out how long it took since we sent the Ping + // and update time offset + internal static void OnClientPong(NetworkPongMessage message) + { + // prevent attackers from sending timestamps which are in the future + if (message.localTime > localTime) return; + + // how long did this message take to come back + double newRtt = localTime - message.localTime; + _rtt.Add(newRtt); + } + + // server rtt calculation ////////////////////////////////////////////// + // Executed at the client when we receive a ping message from the server. + // in other words, this is for server sided ping + rtt calculation. + // reply with a pong containing the time from the server + internal static void OnClientPing(NetworkPingMessage message) + { + // Debug.Log($"OnClientPing conn:{conn}"); + NetworkPongMessage pongMessage = new NetworkPongMessage + { + localTime = message.localTime, + }; + NetworkClient.Send(pongMessage, Channels.Unreliable); + } + + // Executed at the server when we receive a Pong message back. + // find out how long it took since we sent the Ping + // and update time offset + internal static void OnServerPong(NetworkConnectionToClient conn, NetworkPongMessage message) + { + // prevent attackers from sending timestamps which are in the future + if (message.localTime > localTime) return; + + // how long did this message take to come back + double newRtt = localTime - message.localTime; + conn._rtt.Add(newRtt); + } + } +} diff --git a/Assets/Mirror/Core/NetworkTime.cs.meta b/Assets/Mirror/Core/NetworkTime.cs.meta new file mode 100644 index 0000000..1dc9e0a --- /dev/null +++ b/Assets/Mirror/Core/NetworkTime.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 09a0c241fc4a5496dbf4a0ab6e9a312c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkWriter.cs b/Assets/Mirror/Core/NetworkWriter.cs new file mode 100644 index 0000000..7ecf126 --- /dev/null +++ b/Assets/Mirror/Core/NetworkWriter.cs @@ -0,0 +1,249 @@ +using System; +using System.Runtime.CompilerServices; +using System.Text; +using Unity.Collections.LowLevel.Unsafe; +using UnityEngine; + +namespace Mirror +{ + /// Network Writer for most simple types like floats, ints, buffers, structs, etc. Use NetworkWriterPool.GetReader() to avoid allocations. + public class NetworkWriter + { + // the limit of ushort is so we can write string size prefix as only 2 bytes. + // -1 so we can still encode 'null' into it too. + public const ushort MaxStringLength = ushort.MaxValue - 1; + + // create writer immediately with it's own buffer so no one can mess with it and so that we can resize it. + // note: BinaryWriter allocates too much, so we only use a MemoryStream + // => 1500 bytes by default because on average, most packets will be <= MTU + public const int DefaultCapacity = 1500; + internal byte[] buffer = new byte[DefaultCapacity]; + + /// Next position to write to the buffer + public int Position; + + /// Current capacity. Automatically resized if necessary. + public int Capacity => buffer.Length; + + // cache encoding for WriteString instead of creating it each time. + // 1000 readers before: 1MB GC, 30ms + // 1000 readers after: 0.8MB GC, 18ms + // not(!) static for thread safety. + // + // throwOnInvalidBytes is true. + // writer should throw and user should fix if this ever happens. + // unlike reader, which needs to expect it to happen from attackers. + internal readonly UTF8Encoding encoding = new UTF8Encoding(false, true); + + /// Reset both the position and length of the stream + // Leaves the capacity the same so that we can reuse this writer without + // extra allocations + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void Reset() + { + Position = 0; + } + + // NOTE that our runtime resizing comes at no extra cost because: + // 1. 'has space' checks are necessary even for fixed sized writers. + // 2. all writers will eventually be large enough to stop resizing. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + internal void EnsureCapacity(int value) + { + if (buffer.Length < value) + { + int capacity = Math.Max(value, buffer.Length * 2); + Array.Resize(ref buffer, capacity); + } + } + + /// Copies buffer until 'Position' to a new array. + // Try to use ToArraySegment instead to avoid allocations! + public byte[] ToArray() + { + byte[] data = new byte[Position]; + Array.ConstrainedCopy(buffer, 0, data, 0, Position); + return data; + } + + /// Returns allocation-free ArraySegment until 'Position'. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public ArraySegment ToArraySegment() => + new ArraySegment(buffer, 0, Position); + + // implicit conversion for convenience + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static implicit operator ArraySegment(NetworkWriter w) => + w.ToArraySegment(); + + // WriteBlittable from DOTSNET. + // this is extremely fast, but only works for blittable types. + // + // Benchmark: + // WriteQuaternion x 100k, Macbook Pro 2015 @ 2.2Ghz, Unity 2018 LTS (debug mode) + // + // | Median | Min | Max | Avg | Std | (ms) + // before | 30.35 | 29.86 | 48.99 | 32.54 | 4.93 | + // blittable* | 5.69 | 5.52 | 27.51 | 7.78 | 5.65 | + // + // * without IsBlittable check + // => 4-6x faster! + // + // WriteQuaternion x 100k, Macbook Pro 2015 @ 2.2Ghz, Unity 2020.1 (release mode) + // + // | Median | Min | Max | Avg | Std | (ms) + // before | 9.41 | 8.90 | 23.02 | 10.72 | 3.07 | + // blittable* | 1.48 | 1.40 | 16.03 | 2.60 | 2.71 | + // + // * without IsBlittable check + // => 6x faster! + // + // Note: + // WriteBlittable assumes same endianness for server & client. + // All Unity 2018+ platforms are little endian. + // => run NetworkWriterTests.BlittableOnThisPlatform() to verify! + // + // This is not safe to expose to random structs. + // * StructLayout.Sequential is the default, which is safe. + // if the struct contains a reference type, it is converted to Auto. + // but since all structs here are unmanaged blittable, it's safe. + // see also: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.layoutkind?view=netframework-4.8#system-runtime-interopservices-layoutkind-sequential + // * StructLayout.Pack depends on CPU word size. + // this may be different 4 or 8 on some ARM systems, etc. + // this is not safe, and would cause bytes/shorts etc. to be padded. + // see also: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.structlayoutattribute.pack?view=net-6.0 + // * If we force pack all to '1', they would have no padding which is + // great for bandwidth. but on some android systems, CPU can't read + // unaligned memory. + // see also: https://github.com/vis2k/Mirror/issues/3044 + // * The only option would be to force explicit layout with multiples + // of word size. but this requires lots of weaver checking and is + // still questionable (IL2CPP etc.). + // + // Note: inlining WriteBlittable is enough. don't inline WriteInt etc. + // we don't want WriteBlittable to be copied in place everywhere. + internal unsafe void WriteBlittable(T value) + where T : unmanaged + { + // check if blittable for safety +#if UNITY_EDITOR + if (!UnsafeUtility.IsBlittable(typeof(T))) + { + Debug.LogError($"{typeof(T)} is not blittable!"); + return; + } +#endif + // calculate size + // sizeof(T) gets the managed size at compile time. + // Marshal.SizeOf gets the unmanaged size at runtime (slow). + // => our 1mio writes benchmark is 6x slower with Marshal.SizeOf + // => for blittable types, sizeof(T) is even recommended: + // https://docs.microsoft.com/en-us/dotnet/standard/native-interop/best-practices + int size = sizeof(T); + + // ensure capacity + // NOTE that our runtime resizing comes at no extra cost because: + // 1. 'has space' checks are necessary even for fixed sized writers. + // 2. all writers will eventually be large enough to stop resizing. + EnsureCapacity(Position + size); + + // write blittable + fixed (byte* ptr = &buffer[Position]) + { +#if UNITY_ANDROID + // on some android systems, assigning *(T*)ptr throws a NRE if + // the ptr isn't aligned (i.e. if Position is 1,2,3,5, etc.). + // here we have to use memcpy. + // + // => we can't get a pointer of a struct in C# without + // marshalling allocations + // => instead, we stack allocate an array of type T and use that + // => stackalloc avoids GC and is very fast. it only works for + // value types, but all blittable types are anyway. + // + // this way, we can still support blittable reads on android. + // see also: https://github.com/vis2k/Mirror/issues/3044 + // (solution discovered by AIIO, FakeByte, mischa) + T* valueBuffer = stackalloc T[1]{value}; + UnsafeUtility.MemCpy(ptr, valueBuffer, size); +#else + // cast buffer to T* pointer, then assign value to the area + *(T*)ptr = value; +#endif + } + Position += size; + } + + // blittable'?' template for code reuse + [MethodImpl(MethodImplOptions.AggressiveInlining)] + internal void WriteBlittableNullable(T? value) + where T : unmanaged + { + // bool isn't blittable. write as byte. + WriteByte((byte)(value.HasValue ? 0x01 : 0x00)); + + // only write value if exists. saves bandwidth. + if (value.HasValue) + WriteBlittable(value.Value); + } + + public void WriteByte(byte value) => WriteBlittable(value); + + // for byte arrays with consistent size, where the reader knows how many to read + // (like a packet opcode that's always the same) + public void WriteBytes(byte[] array, int offset, int count) + { + EnsureCapacity(Position + count); + Array.ConstrainedCopy(array, offset, this.buffer, Position, count); + Position += count; + } + // write an unsafe byte* array. + // useful for bit tree compression, etc. + public unsafe bool WriteBytes(byte* ptr, int offset, int size) + { + EnsureCapacity(Position + size); + + fixed (byte* destination = &buffer[Position]) + { + // write 'size' bytes at position + // 10 mio writes: 868ms + // Array.Copy(value.Array, value.Offset, buffer, Position, value.Count); + // 10 mio writes: 775ms + // Buffer.BlockCopy(value.Array, value.Offset, buffer, Position, value.Count); + // 10 mio writes: 637ms + UnsafeUtility.MemCpy(destination, ptr + offset, size); + } + + Position += size; + return true; + } + + /// Writes any type that mirror supports. Uses weaver populated Writer(T).write. + public void Write(T value) + { + Action writeDelegate = Writer.write; + if (writeDelegate == null) + { + Debug.LogError($"No writer found for {typeof(T)}. This happens either if you are missing a NetworkWriter extension for your custom type, or if weaving failed. Try to reimport a script to weave again."); + } + else + { + writeDelegate(this, value); + } + } + + // print with buffer content for easier debugging. + // [content, position / capacity]. + // showing "position / space" would be too confusing. + public override string ToString() => + $"[{ToArraySegment().ToHexString()} @ {Position}/{Capacity}]"; + } + + /// Helper class that weaver populates with all writer types. + // Note that c# creates a different static variable for each type + // -> Weaver.ReaderWriterProcessor.InitializeReaderAndWriters() populates it + public static class Writer + { + public static Action write; + } +} diff --git a/Assets/Mirror/Core/NetworkWriter.cs.meta b/Assets/Mirror/Core/NetworkWriter.cs.meta new file mode 100644 index 0000000..c938496 --- /dev/null +++ b/Assets/Mirror/Core/NetworkWriter.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 48d2207bcef1f4477b624725f075f9bd +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkWriterExtensions.cs b/Assets/Mirror/Core/NetworkWriterExtensions.cs new file mode 100644 index 0000000..c4de17c --- /dev/null +++ b/Assets/Mirror/Core/NetworkWriterExtensions.cs @@ -0,0 +1,415 @@ +using System; +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror +{ + // Mirror's Weaver automatically detects all NetworkWriter function types, + // but they do all need to be extensions. + public static class NetworkWriterExtensions + { + public static void WriteByte(this NetworkWriter writer, byte value) => writer.WriteBlittable(value); + public static void WriteByteNullable(this NetworkWriter writer, byte? value) => writer.WriteBlittableNullable(value); + + public static void WriteSByte(this NetworkWriter writer, sbyte value) => writer.WriteBlittable(value); + public static void WriteSByteNullable(this NetworkWriter writer, sbyte? value) => writer.WriteBlittableNullable(value); + + // char is not blittable. convert to ushort. + public static void WriteChar(this NetworkWriter writer, char value) => writer.WriteBlittable((ushort)value); + public static void WriteCharNullable(this NetworkWriter writer, char? value) => writer.WriteBlittableNullable((ushort?)value); + + // bool is not blittable. convert to byte. + public static void WriteBool(this NetworkWriter writer, bool value) => writer.WriteBlittable((byte)(value ? 1 : 0)); + public static void WriteBoolNullable(this NetworkWriter writer, bool? value) => writer.WriteBlittableNullable(value.HasValue ? ((byte)(value.Value ? 1 : 0)) : new byte?()); + + public static void WriteShort(this NetworkWriter writer, short value) => writer.WriteBlittable(value); + public static void WriteShortNullable(this NetworkWriter writer, short? value) => writer.WriteBlittableNullable(value); + + public static void WriteUShort(this NetworkWriter writer, ushort value) => writer.WriteBlittable(value); + public static void WriteUShortNullable(this NetworkWriter writer, ushort? value) => writer.WriteBlittableNullable(value); + + public static void WriteInt(this NetworkWriter writer, int value) => writer.WriteBlittable(value); + public static void WriteIntNullable(this NetworkWriter writer, int? value) => writer.WriteBlittableNullable(value); + + public static void WriteUInt(this NetworkWriter writer, uint value) => writer.WriteBlittable(value); + public static void WriteUIntNullable(this NetworkWriter writer, uint? value) => writer.WriteBlittableNullable(value); + + public static void WriteLong(this NetworkWriter writer, long value) => writer.WriteBlittable(value); + public static void WriteLongNullable(this NetworkWriter writer, long? value) => writer.WriteBlittableNullable(value); + + public static void WriteULong(this NetworkWriter writer, ulong value) => writer.WriteBlittable(value); + public static void WriteULongNullable(this NetworkWriter writer, ulong? value) => writer.WriteBlittableNullable(value); + + public static void WriteFloat(this NetworkWriter writer, float value) => writer.WriteBlittable(value); + public static void WriteFloatNullable(this NetworkWriter writer, float? value) => writer.WriteBlittableNullable(value); + + public static void WriteDouble(this NetworkWriter writer, double value) => writer.WriteBlittable(value); + public static void WriteDoubleNullable(this NetworkWriter writer, double? value) => writer.WriteBlittableNullable(value); + + public static void WriteDecimal(this NetworkWriter writer, decimal value) => writer.WriteBlittable(value); + public static void WriteDecimalNullable(this NetworkWriter writer, decimal? value) => writer.WriteBlittableNullable(value); + + public static void WriteString(this NetworkWriter writer, string value) + { + // write 0 for null support, increment real size by 1 + // (note: original HLAPI would write "" for null strings, but if a + // string is null on the server then it should also be null + // on the client) + if (value == null) + { + writer.WriteUShort(0); + return; + } + + // WriteString copies into the buffer manually. + // need to ensure capacity here first, manually. + int maxSize = writer.encoding.GetMaxByteCount(value.Length); + writer.EnsureCapacity(writer.Position + 2 + maxSize); // 2 bytes position + N bytes encoding + + // encode it into the buffer first. + // reserve 2 bytes for header after we know how much was written. + int written = writer.encoding.GetBytes(value, 0, value.Length, writer.buffer, writer.Position + 2); + + // check if within max size, otherwise Reader can't read it. + if (written > NetworkWriter.MaxStringLength) + throw new IndexOutOfRangeException($"NetworkWriter.WriteString - Value too long: {written} bytes. Limit: {NetworkWriter.MaxStringLength} bytes"); + + // .Position is unchanged, so fill in the size header now. + // we already ensured that max size fits into ushort.max-1. + writer.WriteUShort(checked((ushort)(written + 1))); // Position += 2 + + // now update position by what was written above + writer.Position += written; + } + + public static void WriteBytesAndSizeSegment(this NetworkWriter writer, ArraySegment buffer) + { + writer.WriteBytesAndSize(buffer.Array, buffer.Offset, buffer.Count); + } + + // Weaver needs a write function with just one byte[] parameter + // (we don't name it .Write(byte[]) because it's really a WriteBytesAndSize since we write size / null info too) + + public static void WriteBytesAndSize(this NetworkWriter writer, byte[] buffer) + { + // buffer might be null, so we can't use .Length in that case + writer.WriteBytesAndSize(buffer, 0, buffer != null ? buffer.Length : 0); + } + + // for byte arrays with dynamic size, where the reader doesn't know how many will come + // (like an inventory with different items etc.) + + public static void WriteBytesAndSize(this NetworkWriter writer, byte[] buffer, int offset, int count) + { + // null is supported because [SyncVar]s might be structs with null byte[] arrays + // write 0 for null array, increment normal size by 1 to save bandwidth + // (using size=-1 for null would limit max size to 32kb instead of 64kb) + if (buffer == null) + { + writer.WriteUInt(0u); + return; + } + writer.WriteUInt(checked((uint)count) + 1u); + writer.WriteBytes(buffer, offset, count); + } + + public static void WriteArraySegment(this NetworkWriter writer, ArraySegment segment) + { + int length = segment.Count; + writer.WriteInt(length); + for (int i = 0; i < length; i++) + { + writer.Write(segment.Array[segment.Offset + i]); + } + } + + public static void WriteVector2(this NetworkWriter writer, Vector2 value) => writer.WriteBlittable(value); + public static void WriteVector2Nullable(this NetworkWriter writer, Vector2? value) => writer.WriteBlittableNullable(value); + + public static void WriteVector3(this NetworkWriter writer, Vector3 value) => writer.WriteBlittable(value); + public static void WriteVector3Nullable(this NetworkWriter writer, Vector3? value) => writer.WriteBlittableNullable(value); + + public static void WriteVector4(this NetworkWriter writer, Vector4 value) => writer.WriteBlittable(value); + public static void WriteVector4Nullable(this NetworkWriter writer, Vector4? value) => writer.WriteBlittableNullable(value); + + public static void WriteVector2Int(this NetworkWriter writer, Vector2Int value) => writer.WriteBlittable(value); + public static void WriteVector2IntNullable(this NetworkWriter writer, Vector2Int? value) => writer.WriteBlittableNullable(value); + + public static void WriteVector3Int(this NetworkWriter writer, Vector3Int value) => writer.WriteBlittable(value); + public static void WriteVector3IntNullable(this NetworkWriter writer, Vector3Int? value) => writer.WriteBlittableNullable(value); + + public static void WriteColor(this NetworkWriter writer, Color value) => writer.WriteBlittable(value); + public static void WriteColorNullable(this NetworkWriter writer, Color? value) => writer.WriteBlittableNullable(value); + + public static void WriteColor32(this NetworkWriter writer, Color32 value) => writer.WriteBlittable(value); + public static void WriteColor32Nullable(this NetworkWriter writer, Color32? value) => writer.WriteBlittableNullable(value); + + public static void WriteQuaternion(this NetworkWriter writer, Quaternion value) => writer.WriteBlittable(value); + public static void WriteQuaternionNullable(this NetworkWriter writer, Quaternion? value) => writer.WriteBlittableNullable(value); + + // Rect is a struct with properties instead of fields + public static void WriteRect(this NetworkWriter writer, Rect value) + { + writer.WriteVector2(value.position); + writer.WriteVector2(value.size); + } + public static void WriteRectNullable(this NetworkWriter writer, Rect? value) + { + writer.WriteBool(value.HasValue); + if (value.HasValue) + writer.WriteRect(value.Value); + } + + // Plane is a struct with properties instead of fields + public static void WritePlane(this NetworkWriter writer, Plane value) + { + writer.WriteVector3(value.normal); + writer.WriteFloat(value.distance); + } + public static void WritePlaneNullable(this NetworkWriter writer, Plane? value) + { + writer.WriteBool(value.HasValue); + if (value.HasValue) + writer.WritePlane(value.Value); + } + + // Ray is a struct with properties instead of fields + public static void WriteRay(this NetworkWriter writer, Ray value) + { + writer.WriteVector3(value.origin); + writer.WriteVector3(value.direction); + } + public static void WriteRayNullable(this NetworkWriter writer, Ray? value) + { + writer.WriteBool(value.HasValue); + if (value.HasValue) + writer.WriteRay(value.Value); + } + + public static void WriteMatrix4x4(this NetworkWriter writer, Matrix4x4 value) => writer.WriteBlittable(value); + public static void WriteMatrix4x4Nullable(this NetworkWriter writer, Matrix4x4? value) => writer.WriteBlittableNullable(value); + + public static void WriteGuid(this NetworkWriter writer, Guid value) + { +#if !UNITY_2021_3_OR_NEWER + // Unity 2019 doesn't have Span yet + byte[] data = value.ToByteArray(); + writer.WriteBytes(data, 0, data.Length); +#else + // WriteBlittable(Guid) isn't safe. see WriteBlittable comments. + // Guid is Sequential, but we can't guarantee packing. + // TryWriteBytes is safe and allocation free. + writer.EnsureCapacity(writer.Position + 16); + value.TryWriteBytes(new Span(writer.buffer, writer.Position, 16)); + writer.Position += 16; +#endif + } + public static void WriteGuidNullable(this NetworkWriter writer, Guid? value) + { + writer.WriteBool(value.HasValue); + if (value.HasValue) + writer.WriteGuid(value.Value); + } + + public static void WriteNetworkIdentity(this NetworkWriter writer, NetworkIdentity value) + { + if (value == null) + { + writer.WriteUInt(0); + return; + } + + // users might try to use unspawned / prefab GameObjects in + // rpcs/cmds/syncvars/messages. they would be null on the other + // end, and it might not be obvious why. let's make it obvious. + // https://github.com/vis2k/Mirror/issues/2060 + // + // => warning (instead of exception) because we also use a warning + // if a GameObject doesn't have a NetworkIdentity component etc. + if (value.netId == 0) + Debug.LogWarning($"Attempted to serialize unspawned GameObject: {value.name}. Prefabs and unspawned GameObjects would always be null on the other side. Please spawn it before using it in [SyncVar]s/Rpcs/Cmds/NetworkMessages etc."); + + writer.WriteUInt(value.netId); + } + + public static void WriteNetworkBehaviour(this NetworkWriter writer, NetworkBehaviour value) + { + if (value == null) + { + writer.WriteUInt(0); + return; + } + + // users might try to use unspawned / prefab NetworkBehaviours in + // rpcs/cmds/syncvars/messages. they would be null on the other + // end, and it might not be obvious why. let's make it obvious. + // https://github.com/vis2k/Mirror/issues/2060 + // and more recently https://github.com/MirrorNetworking/Mirror/issues/3399 + // + // => warning (instead of exception) because we also use a warning + // when writing an unspawned NetworkIdentity + if (value.netId == 0) + { + Debug.LogWarning($"Attempted to serialize unspawned NetworkBehaviour: of type {value.GetType()} on GameObject {value.name}. Prefabs and unspawned GameObjects would always be null on the other side. Please spawn it before using it in [SyncVar]s/Rpcs/Cmds/NetworkMessages etc."); + writer.WriteUInt(0); + return; + } + + writer.WriteUInt(value.netId); + writer.WriteByte(value.ComponentIndex); + } + + public static void WriteTransform(this NetworkWriter writer, Transform value) + { + if (value == null) + { + writer.WriteUInt(0); + return; + } + if (value.TryGetComponent(out NetworkIdentity identity)) + { + writer.WriteUInt(identity.netId); + } + else + { + Debug.LogWarning($"NetworkWriter {value} has no NetworkIdentity"); + writer.WriteUInt(0); + } + } + + public static void WriteGameObject(this NetworkWriter writer, GameObject value) + { + if (value == null) + { + writer.WriteUInt(0); + return; + } + + // warn if the GameObject doesn't have a NetworkIdentity, + if (!value.TryGetComponent(out NetworkIdentity identity)) + Debug.LogWarning($"NetworkWriter {value} has no NetworkIdentity"); + + // serialize the correct amount of data in any case to make sure + // that the other end can read the expected amount of data too. + writer.WriteNetworkIdentity(identity); + } + + // while SyncList is recommended for NetworkBehaviours, + // structs may have .List members which weaver needs to be able to + // fully serialize for NetworkMessages etc. + // note that Weaver/Writers/GenerateWriter() handles this manually. + public static void WriteList(this NetworkWriter writer, List list) + { + // 'null' is encoded as '-1' + if (list is null) + { + writer.WriteInt(-1); + return; + } + + // check if within max size, otherwise Reader can't read it. + if (list.Count > NetworkReader.AllocationLimit) + throw new IndexOutOfRangeException($"NetworkWriter.WriteList - List<{typeof(T)}> too big: {list.Count} elements. Limit: {NetworkReader.AllocationLimit}"); + + writer.WriteInt(list.Count); + for (int i = 0; i < list.Count; i++) + writer.Write(list[i]); + } + + // while SyncSet is recommended for NetworkBehaviours, + // structs may have .Set members which weaver needs to be able to + // fully serialize for NetworkMessages etc. + // note that Weaver/Writers/GenerateWriter() handles this manually. + // TODO writer not found. need to adjust weaver first. see tests. + /* + public static void WriteHashSet(this NetworkWriter writer, HashSet hashSet) + { + if (hashSet is null) + { + writer.WriteInt(-1); + return; + } + writer.WriteInt(hashSet.Count); + foreach (T item in hashSet) + writer.Write(item); + } + */ + + public static void WriteArray(this NetworkWriter writer, T[] array) + { + // 'null' is encoded as '-1' + if (array is null) + { + writer.WriteInt(-1); + return; + } + + // check if within max size, otherwise Reader can't read it. + if (array.Length > NetworkReader.AllocationLimit) + throw new IndexOutOfRangeException($"NetworkWriter.WriteArray - Array<{typeof(T)}> too big: {array.Length} elements. Limit: {NetworkReader.AllocationLimit}"); + + writer.WriteInt(array.Length); + for (int i = 0; i < array.Length; i++) + writer.Write(array[i]); + } + + public static void WriteUri(this NetworkWriter writer, Uri uri) + { + writer.WriteString(uri?.ToString()); + } + + public static void WriteTexture2D(this NetworkWriter writer, Texture2D texture2D) + { + // TODO allocation protection when sending textures to server. + // currently can allocate 32k x 32k x 4 byte = 3.8 GB + + // support 'null' textures for [SyncVar]s etc. + // https://github.com/vis2k/Mirror/issues/3144 + // simply send -1 for width. + if (texture2D == null) + { + writer.WriteShort(-1); + return; + } + + // check if within max size, otherwise Reader can't read it. + int totalSize = texture2D.width * texture2D.height; + if (totalSize > NetworkReader.AllocationLimit) + throw new IndexOutOfRangeException($"NetworkWriter.WriteTexture2D - Texture2D total size (width*height) too big: {totalSize}. Limit: {NetworkReader.AllocationLimit}"); + + // write dimensions first so reader can create the texture with size + // 32k x 32k short is more than enough + writer.WriteShort((short)texture2D.width); + writer.WriteShort((short)texture2D.height); + writer.WriteArray(texture2D.GetPixels32()); + } + + public static void WriteSprite(this NetworkWriter writer, Sprite sprite) + { + // support 'null' textures for [SyncVar]s etc. + // https://github.com/vis2k/Mirror/issues/3144 + // simply send a 'null' for texture content. + if (sprite == null) + { + writer.WriteTexture2D(null); + return; + } + + writer.WriteTexture2D(sprite.texture); + writer.WriteRect(sprite.rect); + writer.WriteVector2(sprite.pivot); + } + + public static void WriteDateTime(this NetworkWriter writer, DateTime dateTime) + { + writer.WriteDouble(dateTime.ToOADate()); + } + + public static void WriteDateTimeNullable(this NetworkWriter writer, DateTime? dateTime) + { + writer.WriteBool(dateTime.HasValue); + if (dateTime.HasValue) + writer.WriteDouble(dateTime.Value.ToOADate()); + } + } +} diff --git a/Assets/Mirror/Core/NetworkWriterExtensions.cs.meta b/Assets/Mirror/Core/NetworkWriterExtensions.cs.meta new file mode 100644 index 0000000..9bbdaf0 --- /dev/null +++ b/Assets/Mirror/Core/NetworkWriterExtensions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 94259792df2a404892c3e2377f58d0cb +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkWriterPool.cs b/Assets/Mirror/Core/NetworkWriterPool.cs new file mode 100644 index 0000000..5eefa2a --- /dev/null +++ b/Assets/Mirror/Core/NetworkWriterPool.cs @@ -0,0 +1,37 @@ +// API consistent with Microsoft's ObjectPool. +using System.Runtime.CompilerServices; + +namespace Mirror +{ + /// Pool of NetworkWriters to avoid allocations. + public static class NetworkWriterPool + { + // reuse Pool + // we still wrap it in NetworkWriterPool.Get/Recycle so we can reset the + // position before reusing. + // this is also more consistent with NetworkReaderPool where we need to + // assign the internal buffer before reusing. + static readonly Pool Pool = new Pool( + () => new NetworkWriterPooled(), + // initial capacity to avoid allocations in the first few frames + // 1000 * 1200 bytes = around 1 MB. + 1000 + ); + + /// Get a writer from the pool. Creates new one if pool is empty. + public static NetworkWriterPooled Get() + { + // grab from pool & reset position + NetworkWriterPooled writer = Pool.Get(); + writer.Reset(); + return writer; + } + + /// Return a writer to the pool. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void Return(NetworkWriterPooled writer) + { + Pool.Return(writer); + } + } +} diff --git a/Assets/Mirror/Core/NetworkWriterPool.cs.meta b/Assets/Mirror/Core/NetworkWriterPool.cs.meta new file mode 100644 index 0000000..19d2bb7 --- /dev/null +++ b/Assets/Mirror/Core/NetworkWriterPool.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 3f34b53bea38e4f259eb8dc211e4fdb6 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/NetworkWriterPooled.cs b/Assets/Mirror/Core/NetworkWriterPooled.cs new file mode 100644 index 0000000..5ac371d --- /dev/null +++ b/Assets/Mirror/Core/NetworkWriterPooled.cs @@ -0,0 +1,13 @@ +// "NetworkWriterPooled" instead of "PooledNetworkWriter" to group files, for +// easier IDE workflow and more elegant code. +using System; + +namespace Mirror +{ + /// Pooled NetworkWriter, automatically returned to pool when using 'using' + // TODO make sealed again after removing obsolete NetworkWriterPooled! + public class NetworkWriterPooled : NetworkWriter, IDisposable + { + public void Dispose() => NetworkWriterPool.Return(this); + } +} diff --git a/Assets/Mirror/Core/NetworkWriterPooled.cs.meta b/Assets/Mirror/Core/NetworkWriterPooled.cs.meta new file mode 100644 index 0000000..5571d6f --- /dev/null +++ b/Assets/Mirror/Core/NetworkWriterPooled.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a9fab936bf3c4716a452d94ad5ecbebe +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/PortTransport.cs b/Assets/Mirror/Core/PortTransport.cs new file mode 100644 index 0000000..19a7dfd --- /dev/null +++ b/Assets/Mirror/Core/PortTransport.cs @@ -0,0 +1,13 @@ +// convenience interface for transports which use a port. +// useful for cases where someone wants to 'just set the port' independent of +// which transport it is. +// +// note that not all transports have ports, but most do. + +namespace Mirror +{ + public interface PortTransport + { + ushort Port { get; set; } + } +} diff --git a/Assets/Mirror/Core/PortTransport.cs.meta b/Assets/Mirror/Core/PortTransport.cs.meta new file mode 100644 index 0000000..3f96d30 --- /dev/null +++ b/Assets/Mirror/Core/PortTransport.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f7c7c2820d7974cb28c7bfe9aae890a0 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/RemoteCalls.cs b/Assets/Mirror/Core/RemoteCalls.cs new file mode 100644 index 0000000..ffae3a0 --- /dev/null +++ b/Assets/Mirror/Core/RemoteCalls.cs @@ -0,0 +1,138 @@ +using System; +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror.RemoteCalls +{ + // invoke type for Cmd/Rpc + public enum RemoteCallType { Command, ClientRpc } + + // remote call function delegate + public delegate void RemoteCallDelegate(NetworkBehaviour obj, NetworkReader reader, NetworkConnectionToClient senderConnection); + + class Invoker + { + // GameObjects might have multiple components of TypeA.CommandA(). + // when invoking, we check if 'TypeA' is an instance of the type. + // the hash itself isn't enough because we wouldn't know which component + // to invoke it on if there are multiple of the same type. + public Type componentType; + public RemoteCallType callType; + public RemoteCallDelegate function; + public bool cmdRequiresAuthority; + + public bool AreEqual(Type componentType, RemoteCallType remoteCallType, RemoteCallDelegate invokeFunction) => + this.componentType == componentType && + this.callType == remoteCallType && + this.function == invokeFunction; + } + + /// Used to help manage remote calls for NetworkBehaviours + public static class RemoteProcedureCalls + { + // one lookup for all remote calls. + // allows us to easily add more remote call types without duplicating code. + // note: do not clear those with [RuntimeInitializeOnLoad] + // + // IMPORTANT: cmd/rpc functions are identified via **HASHES**. + // an index would requires half the bandwidth, but introduces issues + // where static constructors are lazily called, so index order isn't + // guaranteed. keep hashes to avoid: + // https://github.com/vis2k/Mirror/pull/3135 + // https://github.com/vis2k/Mirror/issues/3138 + // BUT: 2 byte hash is enough if we check for collisions. that's what we + // do for NetworkMessage as well. + static readonly Dictionary remoteCallDelegates = new Dictionary(); + + static bool CheckIfDelegateExists(Type componentType, RemoteCallType remoteCallType, RemoteCallDelegate func, ushort functionHash) + { + if (remoteCallDelegates.ContainsKey(functionHash)) + { + // something already registered this hash. + // it's okay if it was the same function. + Invoker oldInvoker = remoteCallDelegates[functionHash]; + if (oldInvoker.AreEqual(componentType, remoteCallType, func)) + { + return true; + } + + // otherwise notify user. there is a rare chance of string + // hash collisions. + Debug.LogError($"Function {oldInvoker.componentType}.{oldInvoker.function.GetMethodName()} and {componentType}.{func.GetMethodName()} have the same hash. Please rename one of them. To save bandwidth, we only use 2 bytes for the hash, which has a small chance of collisions."); + } + + return false; + } + + // pass full function name to avoid ClassA.Func & ClassB.Func collisions + internal static ushort RegisterDelegate(Type componentType, string functionFullName, RemoteCallType remoteCallType, RemoteCallDelegate func, bool cmdRequiresAuthority = true) + { + // type+func so Inventory.RpcUse != Equipment.RpcUse + ushort hash = (ushort)(functionFullName.GetStableHashCode() & 0xFFFF); + + if (CheckIfDelegateExists(componentType, remoteCallType, func, hash)) + return hash; + + remoteCallDelegates[hash] = new Invoker + { + callType = remoteCallType, + componentType = componentType, + function = func, + cmdRequiresAuthority = cmdRequiresAuthority + }; + return hash; + } + + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + // need to pass componentType to support invoking on GameObjects with + // multiple components of same type with same remote call. + public static void RegisterCommand(Type componentType, string functionFullName, RemoteCallDelegate func, bool requiresAuthority) => + RegisterDelegate(componentType, functionFullName, RemoteCallType.Command, func, requiresAuthority); + + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + // need to pass componentType to support invoking on GameObjects with + // multiple components of same type with same remote call. + public static void RegisterRpc(Type componentType, string functionFullName, RemoteCallDelegate func) => + RegisterDelegate(componentType, functionFullName, RemoteCallType.ClientRpc, func); + + // to clean up tests + internal static void RemoveDelegate(ushort hash) => + remoteCallDelegates.Remove(hash); + + // note: no need to throw an error if not found. + // an attacker might just try to call a cmd with an rpc's hash etc. + // returning false is enough. + static bool GetInvokerForHash(ushort functionHash, RemoteCallType remoteCallType, out Invoker invoker) => + remoteCallDelegates.TryGetValue(functionHash, out invoker) && + invoker != null && + invoker.callType == remoteCallType; + + // InvokeCmd/Rpc Delegate can all use the same function here + internal static bool Invoke(ushort functionHash, RemoteCallType remoteCallType, NetworkReader reader, NetworkBehaviour component, NetworkConnectionToClient senderConnection = null) + { + // IMPORTANT: we check if the message's componentIndex component is + // actually of the right type. prevents attackers trying + // to invoke remote calls on wrong components. + if (GetInvokerForHash(functionHash, remoteCallType, out Invoker invoker) && + invoker.componentType.IsInstanceOfType(component)) + { + // invoke function on this component + invoker.function(component, reader, senderConnection); + return true; + } + return false; + } + + // check if the command 'requiresAuthority' which is set in the attribute + internal static bool CommandRequiresAuthority(ushort cmdHash) => + GetInvokerForHash(cmdHash, RemoteCallType.Command, out Invoker invoker) && + invoker.cmdRequiresAuthority; + + /// Gets the handler function by hash. Useful for profilers and debuggers. + public static RemoteCallDelegate GetDelegate(ushort functionHash) => + remoteCallDelegates.TryGetValue(functionHash, out Invoker invoker) + ? invoker.function + : null; + } +} + diff --git a/Assets/Mirror/Core/RemoteCalls.cs.meta b/Assets/Mirror/Core/RemoteCalls.cs.meta new file mode 100644 index 0000000..62b3288 --- /dev/null +++ b/Assets/Mirror/Core/RemoteCalls.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d2cdbcbd1e377d6408a91acbec31ba16 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/SnapshotInterpolation.meta b/Assets/Mirror/Core/SnapshotInterpolation.meta new file mode 100644 index 0000000..85ac9a9 --- /dev/null +++ b/Assets/Mirror/Core/SnapshotInterpolation.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 4468e736f87964eaebb9d55fc3e132f7 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/SnapshotInterpolation/Snapshot.cs b/Assets/Mirror/Core/SnapshotInterpolation/Snapshot.cs new file mode 100644 index 0000000..6b8ba8a --- /dev/null +++ b/Assets/Mirror/Core/SnapshotInterpolation/Snapshot.cs @@ -0,0 +1,17 @@ +// Snapshot interface so we can reuse it for all kinds of systems. +// for example, NetworkTransform, NetworkRigidbody, CharacterController etc. +// NOTE: we use '' and 'where T : Snapshot' to avoid boxing. +// List would cause allocations through boxing. +namespace Mirror +{ + public interface Snapshot + { + // the remote timestamp (when it was sent by the remote) + double remoteTime { get; set; } + + // the local timestamp (when it was received on our end) + // technically not needed for basic snapshot interpolation. + // only for dynamic buffer time adjustment. + double localTime { get; set; } + } +} diff --git a/Assets/Mirror/Core/SnapshotInterpolation/Snapshot.cs.meta b/Assets/Mirror/Core/SnapshotInterpolation/Snapshot.cs.meta new file mode 100644 index 0000000..24eedd7 --- /dev/null +++ b/Assets/Mirror/Core/SnapshotInterpolation/Snapshot.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 12afea28fdb94154868a0a3b7a9df55b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolation.cs b/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolation.cs new file mode 100644 index 0000000..2d1a2fc --- /dev/null +++ b/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolation.cs @@ -0,0 +1,390 @@ +// snapshot interpolation V2 by mischa +// +// Unity independent to be engine agnostic & easy to test. +// boxing: in C#, uses does not box! passing the interface would box! +// +// credits: +// glenn fiedler: https://gafferongames.com/post/snapshot_interpolation/ +// fholm: netcode streams +// fakebyte: standard deviation for dynamic adjustment +// ninjakicka: math & debugging +using System.Collections.Generic; +using System.Runtime.CompilerServices; + +namespace Mirror +{ + public static class SortedListExtensions + { + // removes the first 'amount' elements from the sorted list + public static void RemoveRange(this SortedList list, int amount) + { + // remove the first element 'amount' times. + // handles -1 and > count safely. + for (int i = 0; i < amount && i < list.Count; ++i) + list.RemoveAt(0); + } + } + + public static class SnapshotInterpolation + { + // calculate timescale for catch-up / slow-down + // note that negative threshold should be <0. + // caller should verify (i.e. Unity OnValidate). + // improves branch prediction. + public static double Timescale( + double drift, // how far we are off from bufferTime + double catchupSpeed, // in % [0,1] + double slowdownSpeed, // in % [0,1] + double absoluteCatchupNegativeThreshold, // in seconds (careful, we may run out of snapshots) + double absoluteCatchupPositiveThreshold) // in seconds + { + // if the drift time is too large, it means we are behind more time. + // so we need to speed up the timescale. + // note the threshold should be sendInterval * catchupThreshold. + if (drift > absoluteCatchupPositiveThreshold) + { + // localTimeline += 0.001; // too simple, this would ping pong + return 1 + catchupSpeed; // n% faster + } + + // if the drift time is too small, it means we are ahead of time. + // so we need to slow down the timescale. + // note the threshold should be sendInterval * catchupThreshold. + if (drift < absoluteCatchupNegativeThreshold) + { + // localTimeline -= 0.001; // too simple, this would ping pong + return 1 - slowdownSpeed; // n% slower + } + + // keep constant timescale while within threshold. + // this way we have perfectly smooth speed most of the time. + return 1; + } + + // calculate dynamic buffer time adjustment + public static double DynamicAdjustment( + double sendInterval, + double jitterStandardDeviation, + double dynamicAdjustmentTolerance) + { + // jitter is equal to delivery time standard variation. + // delivery time is made up of 'sendInterval+jitter'. + // .Average would be dampened by the constant sendInterval + // .StandardDeviation is the changes in 'jitter' that we want + // so add it to send interval again. + double intervalWithJitter = sendInterval + jitterStandardDeviation; + + // how many multiples of sendInterval is that? + // we want to convert to bufferTimeMultiplier later. + double multiples = intervalWithJitter / sendInterval; + + // add the tolerance + double safezone = multiples + dynamicAdjustmentTolerance; + // UnityEngine.Debug.Log($"sendInterval={sendInterval:F3} jitter std={jitterStandardDeviation:F3} => that is ~{multiples:F1} x sendInterval + {dynamicAdjustmentTolerance} => dynamic bufferTimeMultiplier={safezone}"); + return safezone; + } + + // helper function to insert a snapshot if it doesn't exist yet. + // extra function so we can use it for both cases: + // NetworkClient global timeline insertions & adjustments via Insert. + // NetworkBehaviour local insertion without any time adjustments. + public static bool InsertIfNotExists( + SortedList buffer, // snapshot buffer + int bufferLimit, // don't grow infinitely + T snapshot) // the newly received snapshot + where T : Snapshot + { + // slow clients may not be able to process incoming snapshots fast enough. + // infinitely growing snapshots would make it even worse. + // for example, run NetworkRigidbodyBenchmark while deep profiling client. + // the client just grows and reallocates the buffer forever. + if (buffer.Count >= bufferLimit) return false; + + // SortedList does not allow duplicates. + // we don't need to check ContainsKey (which is expensive). + // simply add and compare count before/after for the return value. + + //if (buffer.ContainsKey(snapshot.remoteTime)) return false; // too expensive + // buffer.Add(snapshot.remoteTime, snapshot); // throws if key exists + + int before = buffer.Count; + buffer[snapshot.remoteTime] = snapshot; // overwrites if key exists + return buffer.Count > before; + } + + // clamp timeline for cases where it gets too far behind. + // for example, a client app may go into the background and get updated + // with 1hz for a while. by the time it's back it's at least 30 frames + // behind, possibly more if the transport also queues up. In this + // scenario, at 1% catch up it took around 20+ seconds to finally catch + // up. For these kinds of scenarios it will be better to snap / clamp. + // + // to reproduce, try snapshot interpolation demo and press the button to + // simulate the client timeline at multiple seconds behind. it'll take + // a long time to catch up if the timeline is a long time behind. + public static double TimelineClamp( + double localTimeline, + double bufferTime, + double latestRemoteTime) + { + // we want local timeline to always be 'bufferTime' behind remote. + double targetTime = latestRemoteTime - bufferTime; + + // we define a boundary of 'bufferTime' around the target time. + // this is where catchup / slowdown will happen. + // outside of the area, we clamp. + double lowerBound = targetTime - bufferTime; // how far behind we can get + double upperBound = targetTime + bufferTime; // how far ahead we can get + return Mathd.Clamp(localTimeline, lowerBound, upperBound); + } + + // call this for every received snapshot. + // adds / inserts it to the list & initializes local time if needed. + public static void InsertAndAdjust( + SortedList buffer, // snapshot buffer + int bufferLimit, // don't grow infinitely + T snapshot, // the newly received snapshot + ref double localTimeline, // local interpolation time based on server time + ref double localTimescale, // timeline multiplier to apply catchup / slowdown over time + float sendInterval, // for debugging + double bufferTime, // offset for buffering + double catchupSpeed, // in % [0,1] + double slowdownSpeed, // in % [0,1] + ref ExponentialMovingAverage driftEma, // for catchup / slowdown + float catchupNegativeThreshold, // in % of sendInteral (careful, we may run out of snapshots) + float catchupPositiveThreshold, // in % of sendInterval + ref ExponentialMovingAverage deliveryTimeEma) // for dynamic buffer time adjustment + where T : Snapshot + { + // first snapshot? + // initialize local timeline. + // we want it to be behind by 'offset'. + // + // note that the first snapshot may be a lagging packet. + // so we would always be behind by that lag. + // this requires catchup later. + if (buffer.Count == 0) + localTimeline = snapshot.remoteTime - bufferTime; + + // insert into the buffer. + // + // note that we might insert it between our current interpolation + // which is fine, it adds another data point for accuracy. + // + // note that insert may be called twice for the same key. + // by default, this would throw. + // need to handle it silently. + if (InsertIfNotExists(buffer, bufferLimit, snapshot)) + { + // dynamic buffer adjustment needs delivery interval jitter + if (buffer.Count >= 2) + { + // note that this is not entirely accurate for scrambled inserts. + // + // we always use the last two, not what we just inserted + // even if we were to use the diff for what we just inserted, + // a scrambled insert would still not be 100% accurate: + // => assume a buffer of AC, with delivery time C-A + // => we then insert B, with delivery time B-A + // => but then technically the first C-A wasn't correct, + // as it would have to be C-B + // + // in practice, scramble is rare and won't make much difference + double previousLocalTime = buffer.Values[buffer.Count - 2].localTime; + double lastestLocalTime = buffer.Values[buffer.Count - 1].localTime; + + // this is the delivery time since last snapshot + double localDeliveryTime = lastestLocalTime - previousLocalTime; + + // feed the local delivery time to the EMA. + // this is what the original stream did too. + // our final dynamic buffer adjustment is different though. + // we use standard deviation instead of average. + deliveryTimeEma.Add(localDeliveryTime); + } + + // adjust timescale to catch up / slow down after each insertion + // because that is when we add new values to our EMA. + + // we want localTimeline to be about 'bufferTime' behind. + // for that, we need the delivery time EMA. + // snapshots may arrive out of order, we can not use last-timeline. + // we need to use the inserted snapshot's time - timeline. + double latestRemoteTime = snapshot.remoteTime; + + // ensure timeline stays within a reasonable bound behind/ahead. + localTimeline = TimelineClamp(localTimeline, bufferTime, latestRemoteTime); + + // calculate timediff after localTimeline override changes + double timeDiff = latestRemoteTime - localTimeline; + + // next, calculate average of a few seconds worth of timediffs. + // this gives smoother results. + // + // to calculate the average, we could simply loop through the + // last 'n' seconds worth of timediffs, but: + // - our buffer may only store a few snapshots (bufferTime) + // - looping through seconds worth of snapshots every time is + // expensive + // + // to solve this, we use an exponential moving average. + // https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average + // which is basically fancy math to do the same but faster. + // additionally, it allows us to look at more timeDiff values + // than we sould have access to in our buffer :) + driftEma.Add(timeDiff); + + // timescale depends on driftEma. + // driftEma only changes when inserting. + // therefore timescale only needs to be calculated when inserting. + // saves CPU cycles in Update. + + // next up, calculate how far we are currently away from bufferTime + double drift = driftEma.Value - bufferTime; + + // convert relative thresholds to absolute values based on sendInterval + double absoluteNegativeThreshold = sendInterval * catchupNegativeThreshold; + double absolutePositiveThreshold = sendInterval * catchupPositiveThreshold; + + // next, set localTimescale to catchup consistently in Update(). + // we quantize between default/catchup/slowdown, + // this way we have 'default' speed most of the time(!). + // and only catch up / slow down for a little bit occasionally. + // a consistent multiplier would never be exactly 1.0. + localTimescale = Timescale(drift, catchupSpeed, slowdownSpeed, absoluteNegativeThreshold, absolutePositiveThreshold); + + // debug logging + // UnityEngine.Debug.Log($"sendInterval={sendInterval:F3} bufferTime={bufferTime:F3} drift={drift:F3} driftEma={driftEma.Value:F3} timescale={localTimescale:F3} deliveryIntervalEma={deliveryTimeEma.Value:F3}"); + } + } + + // sample snapshot buffer to find the pair around the given time. + // returns indices so we can use it with RemoveRange to clear old snaps. + // make sure to use use buffer.Values[from/to], not buffer[from/to]. + // make sure to only call this is we have > 0 snapshots. + public static void Sample( + SortedList buffer, // snapshot buffer + double localTimeline, // local interpolation time based on server time + out int from, // the snapshot <= time + out int to, // the snapshot >= time + out double t) // interpolation factor + where T : Snapshot + { + from = -1; + to = -1; + t = 0; + + // sample from [0,count-1] so we always have two at 'i' and 'i+1'. + for (int i = 0; i < buffer.Count - 1; ++i) + { + // is local time between these two? + T first = buffer.Values[i]; + T second = buffer.Values[i + 1]; + if (localTimeline >= first.remoteTime && + localTimeline <= second.remoteTime) + { + // use these two snapshots + from = i; + to = i + 1; + t = Mathd.InverseLerp(first.remoteTime, second.remoteTime, localTimeline); + return; + } + } + + // didn't find two snapshots around local time. + // so pick either the first or last, depending on which is closer. + + // oldest snapshot ahead of local time? + if (buffer.Values[0].remoteTime > localTimeline) + { + from = to = 0; + t = 0; + } + // otherwise initialize both to the last one + else + { + from = to = buffer.Count - 1; + t = 0; + } + } + + // progress local timeline every update. + // + // ONLY CALL IF SNAPSHOTS.COUNT > 0! + // + // decoupled from Step for easier testing and so we can progress + // time only once in NetworkClient, while stepping for each component. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void StepTime( + double deltaTime, // engine delta time (unscaled) + ref double localTimeline, // local interpolation time based on server time + double localTimescale) // catchup / slowdown is applied to time every update) + { + // move local forward in time, scaled with catchup / slowdown applied + localTimeline += deltaTime * localTimescale; + } + + // sample, clear old. + // call this every update. + // + // ONLY CALL IF SNAPSHOTS.COUNT > 0! + // + // returns true if there is anything to apply (requires at least 1 snap) + // from/to/t are out parameters instead of an interpolated 'computed'. + // this allows us to store from/to/t globally (i.e. in NetworkClient) + // and have each component apply the interpolation manually. + // besides, passing "Func Interpolate" would allocate anyway. + public static void StepInterpolation( + SortedList buffer, // snapshot buffer + double localTimeline, // local interpolation time based on server time + out T fromSnapshot, // we interpolate 'from' this snapshot + out T toSnapshot, // 'to' this snapshot + out double t) // at ratio 't' [0,1] + where T : Snapshot + { + // check this in caller: + // nothing to do if there are no snapshots at all yet + // if (buffer.Count == 0) return false; + + // sample snapshot buffer at local interpolation time + Sample(buffer, localTimeline, out int from, out int to, out t); + + // save from/to + fromSnapshot = buffer.Values[from]; + toSnapshot = buffer.Values[to]; + + // remove older snapshots that we definitely don't need anymore. + // after(!) using the indices. + // + // if we have 3 snapshots and we are between 2nd and 3rd: + // from = 1, to = 2 + // then we need to remove the first one, which is exactly 'from'. + // because 'from-1' = 0 would remove none. + buffer.RemoveRange(from); + } + + // update time, sample, clear old. + // call this every update. + // + // ONLY CALL IF SNAPSHOTS.COUNT > 0! + // + // returns true if there is anything to apply (requires at least 1 snap) + // from/to/t are out parameters instead of an interpolated 'computed'. + // this allows us to store from/to/t globally (i.e. in NetworkClient) + // and have each component apply the interpolation manually. + // besides, passing "Func Interpolate" would allocate anyway. + public static void Step( + SortedList buffer, // snapshot buffer + double deltaTime, // engine delta time (unscaled) + ref double localTimeline, // local interpolation time based on server time + double localTimescale, // catchup / slowdown is applied to time every update + out T fromSnapshot, // we interpolate 'from' this snapshot + out T toSnapshot, // 'to' this snapshot + out double t) // at ratio 't' [0,1] + where T : Snapshot + { + StepTime(deltaTime, ref localTimeline, localTimescale); + StepInterpolation(buffer, localTimeline, out fromSnapshot, out toSnapshot, out t); + } + } +} diff --git a/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolation.cs.meta b/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolation.cs.meta new file mode 100644 index 0000000..244c5fb --- /dev/null +++ b/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolation.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 72c16070d85334011853813488ab1431 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolationSettings.cs b/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolationSettings.cs new file mode 100644 index 0000000..74feae4 --- /dev/null +++ b/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolationSettings.cs @@ -0,0 +1,70 @@ +// snapshot interpolation settings struct. +// can easily be exposed in Unity inspectors. +using System; +using UnityEngine; + +namespace Mirror +{ + // class so we can define defaults easily + [Serializable] + public class SnapshotInterpolationSettings + { + // decrease bufferTime at runtime to see the catchup effect. + // increase to see slowdown. + // 'double' so we can have very precise dynamic adjustment without rounding + [Header("Buffering")] + [Tooltip("Local simulation is behind by sendInterval * multiplier seconds.\n\nThis guarantees that we always have enough snapshots in the buffer to mitigate lags & jitter.\n\nIncrease this if the simulation isn't smooth. By default, it should be around 2.")] + public double bufferTimeMultiplier = 2; + + [Tooltip("If a client can't process snapshots fast enough, don't store too many.")] + public int bufferLimit = 32; + + // catchup ///////////////////////////////////////////////////////////// + // catchup thresholds in 'frames'. + // half a frame might be too aggressive. + [Header("Catchup / Slowdown")] + [Tooltip("Slowdown begins when the local timeline is moving too fast towards remote time. Threshold is in frames worth of snapshots.\n\nThis needs to be negative.\n\nDon't modify unless you know what you are doing.")] + public float catchupNegativeThreshold = -1; // careful, don't want to run out of snapshots + + [Tooltip("Catchup begins when the local timeline is moving too slow and getting too far away from remote time. Threshold is in frames worth of snapshots.\n\nThis needs to be positive.\n\nDon't modify unless you know what you are doing.")] + public float catchupPositiveThreshold = 1; + + [Tooltip("Local timeline acceleration in % while catching up.")] + [Range(0, 1)] + public double catchupSpeed = 0.02f; // see snap interp demo. 1% is too slow. + + [Tooltip("Local timeline slowdown in % while slowing down.")] + [Range(0, 1)] + public double slowdownSpeed = 0.04f; // slow down a little faster so we don't encounter empty buffer (= jitter) + + [Tooltip("Catchup/Slowdown is adjusted over n-second exponential moving average.")] + public int driftEmaDuration = 1; // shouldn't need to modify this, but expose it anyway + + // dynamic buffer time adjustment ////////////////////////////////////// + // dynamically adjusts bufferTimeMultiplier for smooth results. + // to understand how this works, try this manually: + // + // - disable dynamic adjustment + // - set jitter = 0.2 (20% is a lot!) + // - notice some stuttering + // - disable interpolation to see just how much jitter this really is(!) + // - enable interpolation again + // - manually increase bufferTimeMultiplier to 3-4 + // ... the cube slows down (blue) until it's smooth + // - with dynamic adjustment enabled, it will set 4 automatically + // ... the cube slows down (blue) until it's smooth as well + // + // note that 20% jitter is extreme. + // for this to be perfectly smooth, set the safety tolerance to '2'. + // but realistically this is not necessary, and '1' is enough. + [Header("Dynamic Adjustment")] + [Tooltip("Automatically adjust bufferTimeMultiplier for smooth results.\nSets a low multiplier on stable connections, and a high multiplier on jittery connections.")] + public bool dynamicAdjustment = true; + + [Tooltip("Safety buffer that is always added to the dynamic bufferTimeMultiplier adjustment.")] + public float dynamicAdjustmentTolerance = 1; // 1 is realistically just fine, 2 is very very safe even for 20% jitter. can be half a frame too. (see above comments) + + [Tooltip("Dynamic adjustment is computed over n-second exponential moving average standard deviation.")] + public int deliveryTimeEmaDuration = 2; // 1-2s recommended to capture average delivery time + } +} diff --git a/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolationSettings.cs.meta b/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolationSettings.cs.meta new file mode 100644 index 0000000..5cc16e4 --- /dev/null +++ b/Assets/Mirror/Core/SnapshotInterpolation/SnapshotInterpolationSettings.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: f955b76b7956417088c03992b3622dc9 +timeCreated: 1678507210 \ No newline at end of file diff --git a/Assets/Mirror/Core/SnapshotInterpolation/TimeSnapshot.cs b/Assets/Mirror/Core/SnapshotInterpolation/TimeSnapshot.cs new file mode 100644 index 0000000..5bfdd3a --- /dev/null +++ b/Assets/Mirror/Core/SnapshotInterpolation/TimeSnapshot.cs @@ -0,0 +1,15 @@ +namespace Mirror +{ + // empty snapshot that is only used to progress client's local timeline. + public struct TimeSnapshot : Snapshot + { + public double remoteTime { get; set; } + public double localTime { get; set; } + + public TimeSnapshot(double remoteTime, double localTime) + { + this.remoteTime = remoteTime; + this.localTime = localTime; + } + } +} diff --git a/Assets/Mirror/Core/SnapshotInterpolation/TimeSnapshot.cs.meta b/Assets/Mirror/Core/SnapshotInterpolation/TimeSnapshot.cs.meta new file mode 100644 index 0000000..5e37981 --- /dev/null +++ b/Assets/Mirror/Core/SnapshotInterpolation/TimeSnapshot.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: afe2b5ed49634971a2aec720ad74e5cd +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/SyncDictionary.cs b/Assets/Mirror/Core/SyncDictionary.cs new file mode 100644 index 0000000..f0f0521 --- /dev/null +++ b/Assets/Mirror/Core/SyncDictionary.cs @@ -0,0 +1,326 @@ +using System.Collections; +using System.Collections.Generic; + +namespace Mirror +{ + public class SyncIDictionary : SyncObject, IDictionary, IReadOnlyDictionary + { + public delegate void SyncDictionaryChanged(Operation op, TKey key, TValue item); + + protected readonly IDictionary objects; + + public int Count => objects.Count; + public bool IsReadOnly => !IsWritable(); + public event SyncDictionaryChanged Callback; + + public enum Operation : byte + { + OP_ADD, + OP_CLEAR, + OP_REMOVE, + OP_SET + } + + struct Change + { + internal Operation operation; + internal TKey key; + internal TValue item; + } + + // list of changes. + // -> insert/delete/clear is only ONE change + // -> changing the same slot 10x caues 10 changes. + // -> note that this grows until next sync(!) + // TODO Dictionary to avoid ever growing changes / redundant changes! + readonly List changes = new List(); + + // how many changes we need to ignore + // this is needed because when we initialize the list, + // we might later receive changes that have already been applied + // so we need to skip them + int changesAhead; + + public override void Reset() + { + changes.Clear(); + changesAhead = 0; + objects.Clear(); + } + + public ICollection Keys => objects.Keys; + + public ICollection Values => objects.Values; + + IEnumerable IReadOnlyDictionary.Keys => objects.Keys; + + IEnumerable IReadOnlyDictionary.Values => objects.Values; + + // throw away all the changes + // this should be called after a successful sync + public override void ClearChanges() => changes.Clear(); + + public SyncIDictionary(IDictionary objects) + { + this.objects = objects; + } + + void AddOperation(Operation op, TKey key, TValue item, bool checkAccess) + { + if (checkAccess && IsReadOnly) + { + throw new System.InvalidOperationException("SyncDictionaries can only be modified by the owner."); + } + + Change change = new Change + { + operation = op, + key = key, + item = item + }; + + if (IsRecording()) + { + changes.Add(change); + OnDirty?.Invoke(); + } + + Callback?.Invoke(op, key, item); + } + + public override void OnSerializeAll(NetworkWriter writer) + { + // if init, write the full list content + writer.WriteUInt((uint)objects.Count); + + foreach (KeyValuePair syncItem in objects) + { + writer.Write(syncItem.Key); + writer.Write(syncItem.Value); + } + + // all changes have been applied already + // thus the client will need to skip all the pending changes + // or they would be applied again. + // So we write how many changes are pending + writer.WriteUInt((uint)changes.Count); + } + + public override void OnSerializeDelta(NetworkWriter writer) + { + // write all the queued up changes + writer.WriteUInt((uint)changes.Count); + + for (int i = 0; i < changes.Count; i++) + { + Change change = changes[i]; + writer.WriteByte((byte)change.operation); + + switch (change.operation) + { + case Operation.OP_ADD: + case Operation.OP_SET: + writer.Write(change.key); + writer.Write(change.item); + break; + case Operation.OP_REMOVE: + writer.Write(change.key); + break; + case Operation.OP_CLEAR: + break; + } + } + } + + public override void OnDeserializeAll(NetworkReader reader) + { + // if init, write the full list content + int count = (int)reader.ReadUInt(); + + objects.Clear(); + changes.Clear(); + + for (int i = 0; i < count; i++) + { + TKey key = reader.Read(); + TValue obj = reader.Read(); + objects.Add(key, obj); + } + + // We will need to skip all these changes + // the next time the list is synchronized + // because they have already been applied + changesAhead = (int)reader.ReadUInt(); + } + + public override void OnDeserializeDelta(NetworkReader reader) + { + int changesCount = (int)reader.ReadUInt(); + + for (int i = 0; i < changesCount; i++) + { + Operation operation = (Operation)reader.ReadByte(); + + // apply the operation only if it is a new change + // that we have not applied yet + bool apply = changesAhead == 0; + TKey key = default; + TValue item = default; + + switch (operation) + { + case Operation.OP_ADD: + case Operation.OP_SET: + key = reader.Read(); + item = reader.Read(); + if (apply) + { + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + if (ContainsKey(key)) + { + objects[key] = item; // assign after ContainsKey check + AddOperation(Operation.OP_SET, key, item, false); + } + else + { + objects[key] = item; // assign after ContainsKey check + AddOperation(Operation.OP_ADD, key, item, false); + } + } + break; + + case Operation.OP_CLEAR: + if (apply) + { + objects.Clear(); + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + AddOperation(Operation.OP_CLEAR, default, default, false); + } + break; + + case Operation.OP_REMOVE: + key = reader.Read(); + if (apply) + { + if (objects.TryGetValue(key, out item)) + { + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + objects.Remove(key); + AddOperation(Operation.OP_REMOVE, key, item, false); + } + } + break; + } + + if (!apply) + { + // we just skipped this change + changesAhead--; + } + } + } + + public void Clear() + { + objects.Clear(); + AddOperation(Operation.OP_CLEAR, default, default, true); + } + + public bool ContainsKey(TKey key) => objects.ContainsKey(key); + + public bool Remove(TKey key) + { + if (objects.TryGetValue(key, out TValue item) && objects.Remove(key)) + { + AddOperation(Operation.OP_REMOVE, key, item, true); + return true; + } + return false; + } + + public TValue this[TKey i] + { + get => objects[i]; + set + { + if (ContainsKey(i)) + { + objects[i] = value; + AddOperation(Operation.OP_SET, i, value, true); + } + else + { + objects[i] = value; + AddOperation(Operation.OP_ADD, i, value, true); + } + } + } + + public bool TryGetValue(TKey key, out TValue value) => objects.TryGetValue(key, out value); + + public void Add(TKey key, TValue value) + { + objects.Add(key, value); + AddOperation(Operation.OP_ADD, key, value, true); + } + + public void Add(KeyValuePair item) => Add(item.Key, item.Value); + + public bool Contains(KeyValuePair item) + { + return TryGetValue(item.Key, out TValue val) && EqualityComparer.Default.Equals(val, item.Value); + } + + public void CopyTo(KeyValuePair[] array, int arrayIndex) + { + if (arrayIndex < 0 || arrayIndex > array.Length) + { + throw new System.ArgumentOutOfRangeException(nameof(arrayIndex), "Array Index Out of Range"); + } + if (array.Length - arrayIndex < Count) + { + throw new System.ArgumentException("The number of items in the SyncDictionary is greater than the available space from arrayIndex to the end of the destination array"); + } + + int i = arrayIndex; + foreach (KeyValuePair item in objects) + { + array[i] = item; + i++; + } + } + + public bool Remove(KeyValuePair item) + { + bool result = objects.Remove(item.Key); + if (result) + { + AddOperation(Operation.OP_REMOVE, item.Key, item.Value, true); + } + return result; + } + + public IEnumerator> GetEnumerator() => objects.GetEnumerator(); + + IEnumerator IEnumerable.GetEnumerator() => objects.GetEnumerator(); + } + + public class SyncDictionary : SyncIDictionary + { + public SyncDictionary() : base(new Dictionary()) {} + public SyncDictionary(IEqualityComparer eq) : base(new Dictionary(eq)) {} + public SyncDictionary(IDictionary d) : base(new Dictionary(d)) {} + public new Dictionary.ValueCollection Values => ((Dictionary)objects).Values; + public new Dictionary.KeyCollection Keys => ((Dictionary)objects).Keys; + public new Dictionary.Enumerator GetEnumerator() => ((Dictionary)objects).GetEnumerator(); + } +} diff --git a/Assets/Mirror/Core/SyncDictionary.cs.meta b/Assets/Mirror/Core/SyncDictionary.cs.meta new file mode 100644 index 0000000..1c20b57 --- /dev/null +++ b/Assets/Mirror/Core/SyncDictionary.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 4b346c49cfdb668488a364c3023590e2 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/SyncList.cs b/Assets/Mirror/Core/SyncList.cs new file mode 100644 index 0000000..8b70eed --- /dev/null +++ b/Assets/Mirror/Core/SyncList.cs @@ -0,0 +1,420 @@ +using System; +using System.Collections; +using System.Collections.Generic; + +namespace Mirror +{ + public class SyncList : SyncObject, IList, IReadOnlyList + { + public delegate void SyncListChanged(Operation op, int itemIndex, T oldItem, T newItem); + + readonly IList objects; + readonly IEqualityComparer comparer; + + public int Count => objects.Count; + public bool IsReadOnly => !IsWritable(); + public event SyncListChanged Callback; + + public enum Operation : byte + { + OP_ADD, + OP_CLEAR, + OP_INSERT, + OP_REMOVEAT, + OP_SET + } + + struct Change + { + internal Operation operation; + internal int index; + internal T item; + } + + // list of changes. + // -> insert/delete/clear is only ONE change + // -> changing the same slot 10x caues 10 changes. + // -> note that this grows until next sync(!) + readonly List changes = new List(); + + // how many changes we need to ignore + // this is needed because when we initialize the list, + // we might later receive changes that have already been applied + // so we need to skip them + int changesAhead; + + public SyncList() : this(EqualityComparer.Default) {} + + public SyncList(IEqualityComparer comparer) + { + this.comparer = comparer ?? EqualityComparer.Default; + objects = new List(); + } + + public SyncList(IList objects, IEqualityComparer comparer = null) + { + this.comparer = comparer ?? EqualityComparer.Default; + this.objects = objects; + } + + // throw away all the changes + // this should be called after a successful sync + public override void ClearChanges() => changes.Clear(); + + public override void Reset() + { + changes.Clear(); + changesAhead = 0; + objects.Clear(); + } + + void AddOperation(Operation op, int itemIndex, T oldItem, T newItem, bool checkAccess) + { + if (checkAccess && IsReadOnly) + { + throw new InvalidOperationException("Synclists can only be modified by the owner."); + } + + Change change = new Change + { + operation = op, + index = itemIndex, + item = newItem + }; + + if (IsRecording()) + { + changes.Add(change); + OnDirty?.Invoke(); + } + + Callback?.Invoke(op, itemIndex, oldItem, newItem); + } + + public override void OnSerializeAll(NetworkWriter writer) + { + // if init, write the full list content + writer.WriteUInt((uint)objects.Count); + + for (int i = 0; i < objects.Count; i++) + { + T obj = objects[i]; + writer.Write(obj); + } + + // all changes have been applied already + // thus the client will need to skip all the pending changes + // or they would be applied again. + // So we write how many changes are pending + writer.WriteUInt((uint)changes.Count); + } + + public override void OnSerializeDelta(NetworkWriter writer) + { + // write all the queued up changes + writer.WriteUInt((uint)changes.Count); + + for (int i = 0; i < changes.Count; i++) + { + Change change = changes[i]; + writer.WriteByte((byte)change.operation); + + switch (change.operation) + { + case Operation.OP_ADD: + writer.Write(change.item); + break; + + case Operation.OP_CLEAR: + break; + + case Operation.OP_REMOVEAT: + writer.WriteUInt((uint)change.index); + break; + + case Operation.OP_INSERT: + case Operation.OP_SET: + writer.WriteUInt((uint)change.index); + writer.Write(change.item); + break; + } + } + } + + public override void OnDeserializeAll(NetworkReader reader) + { + // if init, write the full list content + int count = (int)reader.ReadUInt(); + + objects.Clear(); + changes.Clear(); + + for (int i = 0; i < count; i++) + { + T obj = reader.Read(); + objects.Add(obj); + } + + // We will need to skip all these changes + // the next time the list is synchronized + // because they have already been applied + changesAhead = (int)reader.ReadUInt(); + } + + public override void OnDeserializeDelta(NetworkReader reader) + { + int changesCount = (int)reader.ReadUInt(); + + for (int i = 0; i < changesCount; i++) + { + Operation operation = (Operation)reader.ReadByte(); + + // apply the operation only if it is a new change + // that we have not applied yet + bool apply = changesAhead == 0; + int index = 0; + T oldItem = default; + T newItem = default; + + switch (operation) + { + case Operation.OP_ADD: + newItem = reader.Read(); + if (apply) + { + index = objects.Count; + objects.Add(newItem); + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + AddOperation(Operation.OP_ADD, objects.Count - 1, default, newItem, false); + } + break; + + case Operation.OP_CLEAR: + if (apply) + { + objects.Clear(); + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + AddOperation(Operation.OP_CLEAR, 0, default, default, false); + } + break; + + case Operation.OP_INSERT: + index = (int)reader.ReadUInt(); + newItem = reader.Read(); + if (apply) + { + objects.Insert(index, newItem); + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + AddOperation(Operation.OP_INSERT, index, default, newItem, false); + } + break; + + case Operation.OP_REMOVEAT: + index = (int)reader.ReadUInt(); + if (apply) + { + oldItem = objects[index]; + objects.RemoveAt(index); + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + AddOperation(Operation.OP_REMOVEAT, index, oldItem, default, false); + } + break; + + case Operation.OP_SET: + index = (int)reader.ReadUInt(); + newItem = reader.Read(); + if (apply) + { + oldItem = objects[index]; + objects[index] = newItem; + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + AddOperation(Operation.OP_SET, index, oldItem, newItem, false); + } + break; + } + + if (!apply) + { + // we just skipped this change + changesAhead--; + } + } + } + + public void Add(T item) + { + objects.Add(item); + AddOperation(Operation.OP_ADD, objects.Count - 1, default, item, true); + } + + public void AddRange(IEnumerable range) + { + foreach (T entry in range) + { + Add(entry); + } + } + + public void Clear() + { + objects.Clear(); + AddOperation(Operation.OP_CLEAR, 0, default, default, true); + } + + public bool Contains(T item) => IndexOf(item) >= 0; + + public void CopyTo(T[] array, int index) => objects.CopyTo(array, index); + + public int IndexOf(T item) + { + for (int i = 0; i < objects.Count; ++i) + if (comparer.Equals(item, objects[i])) + return i; + return -1; + } + + public int FindIndex(Predicate match) + { + for (int i = 0; i < objects.Count; ++i) + if (match(objects[i])) + return i; + return -1; + } + + public T Find(Predicate match) + { + int i = FindIndex(match); + return (i != -1) ? objects[i] : default; + } + + public List FindAll(Predicate match) + { + List results = new List(); + for (int i = 0; i < objects.Count; ++i) + if (match(objects[i])) + results.Add(objects[i]); + return results; + } + + public void Insert(int index, T item) + { + objects.Insert(index, item); + AddOperation(Operation.OP_INSERT, index, default, item, true); + } + + public void InsertRange(int index, IEnumerable range) + { + foreach (T entry in range) + { + Insert(index, entry); + index++; + } + } + + public bool Remove(T item) + { + int index = IndexOf(item); + bool result = index >= 0; + if (result) + { + RemoveAt(index); + } + return result; + } + + public void RemoveAt(int index) + { + T oldItem = objects[index]; + objects.RemoveAt(index); + AddOperation(Operation.OP_REMOVEAT, index, oldItem, default, true); + } + + public int RemoveAll(Predicate match) + { + List toRemove = new List(); + for (int i = 0; i < objects.Count; ++i) + if (match(objects[i])) + toRemove.Add(objects[i]); + + foreach (T entry in toRemove) + { + Remove(entry); + } + + return toRemove.Count; + } + + public T this[int i] + { + get => objects[i]; + set + { + if (!comparer.Equals(objects[i], value)) + { + T oldItem = objects[i]; + objects[i] = value; + AddOperation(Operation.OP_SET, i, oldItem, value, true); + } + } + } + + public Enumerator GetEnumerator() => new Enumerator(this); + + IEnumerator IEnumerable.GetEnumerator() => new Enumerator(this); + + IEnumerator IEnumerable.GetEnumerator() => new Enumerator(this); + + // default Enumerator allocates. we need a custom struct Enumerator to + // not allocate on the heap. + // (System.Collections.Generic.List source code does the same) + // + // benchmark: + // uMMORPG with 800 monsters, Skills.GetHealthBonus() which runs a + // foreach on skills SyncList: + // before: 81.2KB GC per frame + // after: 0KB GC per frame + // => this is extremely important for MMO scale networking + public struct Enumerator : IEnumerator + { + readonly SyncList list; + int index; + public T Current { get; private set; } + + public Enumerator(SyncList list) + { + this.list = list; + index = -1; + Current = default; + } + + public bool MoveNext() + { + if (++index >= list.Count) + { + return false; + } + Current = list[index]; + return true; + } + + public void Reset() => index = -1; + object IEnumerator.Current => Current; + public void Dispose() {} + } + } +} diff --git a/Assets/Mirror/Core/SyncList.cs.meta b/Assets/Mirror/Core/SyncList.cs.meta new file mode 100644 index 0000000..088ef1e --- /dev/null +++ b/Assets/Mirror/Core/SyncList.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 744fc71f748fe40d5940e04bf42b29f3 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/SyncObject.cs b/Assets/Mirror/Core/SyncObject.cs new file mode 100644 index 0000000..405e240 --- /dev/null +++ b/Assets/Mirror/Core/SyncObject.cs @@ -0,0 +1,53 @@ +using System; + +namespace Mirror +{ + /// SyncObjects sync state between server and client. E.g. SyncLists. + // SyncObject should be a class (instead of an interface) for a few reasons: + // * NetworkBehaviour stores SyncObjects in a list. structs would be a copy + // and OnSerialize would use the copy instead of the original struct. + // * Obsolete functions like Flush() don't need to be defined by each type + // * OnDirty/IsRecording etc. default functions can be defined once here + // for example, handling 'OnDirty wasn't initialized' with a default + // function that throws an exception will be useful for SyncVar + public abstract class SyncObject + { + /// Used internally to set owner NetworkBehaviour's dirty mask bit when changed. + public Action OnDirty; + + /// Used internally to check if we are currently tracking changes. + // prevents ever growing .changes lists: + // if a monster has no observers but we keep modifying a SyncObject, + // then the changes would never be flushed and keep growing, + // because OnSerialize isn't called without observers. + // => Func so we can set it to () => observers.Count > 0 + // without depending on NetworkComponent/NetworkIdentity here. + // => virtual so it simply always records by default + public Func IsRecording = () => true; + + // SyncList/Set/etc. shouldn't be modifiable if not owned. + // otherwise they would silently get out of sync. + // need a lambda because InitSyncObject is called in ctor, when + // 'isClient' etc. aren't initialized yet. + public Func IsWritable = () => true; + + /// Discard all the queued changes + // Consider the object fully synchronized with clients + public abstract void ClearChanges(); + + /// Write a full copy of the object + public abstract void OnSerializeAll(NetworkWriter writer); + + /// Write the changes made to the object since last sync + public abstract void OnSerializeDelta(NetworkWriter writer); + + /// Reads a full copy of the object + public abstract void OnDeserializeAll(NetworkReader reader); + + /// Reads the changes made to the object since last sync + public abstract void OnDeserializeDelta(NetworkReader reader); + + /// Resets the SyncObject so that it can be re-used + public abstract void Reset(); + } +} diff --git a/Assets/Mirror/Core/SyncObject.cs.meta b/Assets/Mirror/Core/SyncObject.cs.meta new file mode 100644 index 0000000..736c651 --- /dev/null +++ b/Assets/Mirror/Core/SyncObject.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ae226d17a0c844041aa24cc2c023dd49 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/SyncSet.cs b/Assets/Mirror/Core/SyncSet.cs new file mode 100644 index 0000000..13d4302 --- /dev/null +++ b/Assets/Mirror/Core/SyncSet.cs @@ -0,0 +1,352 @@ +using System; +using System.Collections; +using System.Collections.Generic; + +namespace Mirror +{ + public class SyncSet : SyncObject, ISet + { + public delegate void SyncSetChanged(Operation op, T item); + + protected readonly ISet objects; + + public int Count => objects.Count; + public bool IsReadOnly => !IsWritable(); + public event SyncSetChanged Callback; + + public enum Operation : byte + { + OP_ADD, + OP_CLEAR, + OP_REMOVE + } + + struct Change + { + internal Operation operation; + internal T item; + } + + // list of changes. + // -> insert/delete/clear is only ONE change + // -> changing the same slot 10x caues 10 changes. + // -> note that this grows until next sync(!) + // TODO Dictionary to avoid ever growing changes / redundant changes! + readonly List changes = new List(); + + // how many changes we need to ignore + // this is needed because when we initialize the list, + // we might later receive changes that have already been applied + // so we need to skip them + int changesAhead; + + public SyncSet(ISet objects) + { + this.objects = objects; + } + + public override void Reset() + { + changes.Clear(); + changesAhead = 0; + objects.Clear(); + } + + // throw away all the changes + // this should be called after a successful sync + public override void ClearChanges() => changes.Clear(); + + void AddOperation(Operation op, T item, bool checkAccess) + { + if (checkAccess && IsReadOnly) + { + throw new InvalidOperationException("SyncSets can only be modified by the owner."); + } + + Change change = new Change + { + operation = op, + item = item + }; + + if (IsRecording()) + { + changes.Add(change); + OnDirty?.Invoke(); + } + + Callback?.Invoke(op, item); + } + + void AddOperation(Operation op, bool checkAccess) => AddOperation(op, default, checkAccess); + + public override void OnSerializeAll(NetworkWriter writer) + { + // if init, write the full list content + writer.WriteUInt((uint)objects.Count); + + foreach (T obj in objects) + { + writer.Write(obj); + } + + // all changes have been applied already + // thus the client will need to skip all the pending changes + // or they would be applied again. + // So we write how many changes are pending + writer.WriteUInt((uint)changes.Count); + } + + public override void OnSerializeDelta(NetworkWriter writer) + { + // write all the queued up changes + writer.WriteUInt((uint)changes.Count); + + for (int i = 0; i < changes.Count; i++) + { + Change change = changes[i]; + writer.WriteByte((byte)change.operation); + + switch (change.operation) + { + case Operation.OP_ADD: + writer.Write(change.item); + break; + + case Operation.OP_CLEAR: + break; + + case Operation.OP_REMOVE: + writer.Write(change.item); + break; + } + } + } + + public override void OnDeserializeAll(NetworkReader reader) + { + // if init, write the full list content + int count = (int)reader.ReadUInt(); + + objects.Clear(); + changes.Clear(); + + for (int i = 0; i < count; i++) + { + T obj = reader.Read(); + objects.Add(obj); + } + + // We will need to skip all these changes + // the next time the list is synchronized + // because they have already been applied + changesAhead = (int)reader.ReadUInt(); + } + + public override void OnDeserializeDelta(NetworkReader reader) + { + int changesCount = (int)reader.ReadUInt(); + + for (int i = 0; i < changesCount; i++) + { + Operation operation = (Operation)reader.ReadByte(); + + // apply the operation only if it is a new change + // that we have not applied yet + bool apply = changesAhead == 0; + T item = default; + + switch (operation) + { + case Operation.OP_ADD: + item = reader.Read(); + if (apply) + { + objects.Add(item); + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + AddOperation(Operation.OP_ADD, item, false); + } + break; + + case Operation.OP_CLEAR: + if (apply) + { + objects.Clear(); + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + AddOperation(Operation.OP_CLEAR, false); + } + break; + + case Operation.OP_REMOVE: + item = reader.Read(); + if (apply) + { + objects.Remove(item); + // add dirty + changes. + // ClientToServer needs to set dirty in server OnDeserialize. + // no access check: server OnDeserialize can always + // write, even for ClientToServer (for broadcasting). + AddOperation(Operation.OP_REMOVE, item, false); + } + break; + } + + if (!apply) + { + // we just skipped this change + changesAhead--; + } + } + } + + public bool Add(T item) + { + if (objects.Add(item)) + { + AddOperation(Operation.OP_ADD, item, true); + return true; + } + return false; + } + + void ICollection.Add(T item) + { + if (objects.Add(item)) + { + AddOperation(Operation.OP_ADD, item, true); + } + } + + public void Clear() + { + objects.Clear(); + AddOperation(Operation.OP_CLEAR, true); + } + + public bool Contains(T item) => objects.Contains(item); + + public void CopyTo(T[] array, int index) => objects.CopyTo(array, index); + + public bool Remove(T item) + { + if (objects.Remove(item)) + { + AddOperation(Operation.OP_REMOVE, item, true); + return true; + } + return false; + } + + public IEnumerator GetEnumerator() => objects.GetEnumerator(); + + IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); + + public void ExceptWith(IEnumerable other) + { + if (other == this) + { + Clear(); + return; + } + + // remove every element in other from this + foreach (T element in other) + { + Remove(element); + } + } + + public void IntersectWith(IEnumerable other) + { + if (other is ISet otherSet) + { + IntersectWithSet(otherSet); + } + else + { + HashSet otherAsSet = new HashSet(other); + IntersectWithSet(otherAsSet); + } + } + + void IntersectWithSet(ISet otherSet) + { + List elements = new List(objects); + + foreach (T element in elements) + { + if (!otherSet.Contains(element)) + { + Remove(element); + } + } + } + + public bool IsProperSubsetOf(IEnumerable other) => objects.IsProperSubsetOf(other); + + public bool IsProperSupersetOf(IEnumerable other) => objects.IsProperSupersetOf(other); + + public bool IsSubsetOf(IEnumerable other) => objects.IsSubsetOf(other); + + public bool IsSupersetOf(IEnumerable other) => objects.IsSupersetOf(other); + + public bool Overlaps(IEnumerable other) => objects.Overlaps(other); + + public bool SetEquals(IEnumerable other) => objects.SetEquals(other); + + // custom implementation so we can do our own Clear/Add/Remove for delta + public void SymmetricExceptWith(IEnumerable other) + { + if (other == this) + { + Clear(); + } + else + { + foreach (T element in other) + { + if (!Remove(element)) + { + Add(element); + } + } + } + } + + // custom implementation so we can do our own Clear/Add/Remove for delta + public void UnionWith(IEnumerable other) + { + if (other != this) + { + foreach (T element in other) + { + Add(element); + } + } + } + } + + public class SyncHashSet : SyncSet + { + public SyncHashSet() : this(EqualityComparer.Default) {} + public SyncHashSet(IEqualityComparer comparer) : base(new HashSet(comparer ?? EqualityComparer.Default)) {} + + // allocation free enumerator + public new HashSet.Enumerator GetEnumerator() => ((HashSet)objects).GetEnumerator(); + } + + public class SyncSortedSet : SyncSet + { + public SyncSortedSet() : this(Comparer.Default) {} + public SyncSortedSet(IComparer comparer) : base(new SortedSet(comparer ?? Comparer.Default)) {} + + // allocation free enumerator + public new SortedSet.Enumerator GetEnumerator() => ((SortedSet)objects).GetEnumerator(); + } +} diff --git a/Assets/Mirror/Core/SyncSet.cs.meta b/Assets/Mirror/Core/SyncSet.cs.meta new file mode 100644 index 0000000..6eeef1c --- /dev/null +++ b/Assets/Mirror/Core/SyncSet.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8a31599d9f9dd4ef9999f7b9707c832c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools.meta b/Assets/Mirror/Core/Tools.meta new file mode 100644 index 0000000..8319cae --- /dev/null +++ b/Assets/Mirror/Core/Tools.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: d9c73cc2749d43268600b80df0b55c4d +timeCreated: 1667486812 \ No newline at end of file diff --git a/Assets/Mirror/Core/Tools/AccurateInterval.cs b/Assets/Mirror/Core/Tools/AccurateInterval.cs new file mode 100644 index 0000000..9d2ce0e --- /dev/null +++ b/Assets/Mirror/Core/Tools/AccurateInterval.cs @@ -0,0 +1,86 @@ +// accurate interval from Mirror II. +// for sync / send intervals where it matters. +// does not(!) do catch-up. +// +// first, let's understand the problem. +// say we need an interval of 10 Hz, so every 100ms in Update we do: +// if (Time.time >= lastTime + interval) +// { +// lastTime = Time.time; +// ... +// } +// +// this seems fine, but actually Time.time will always be a few ms beyond +// the interval. but since lastTime is reset to Time.time, the remainder +// is always ignored away. +// with fixed tickRate servers (say 30 Hz), the remainder is significant! +// +// in practice if we have a 30 Hz tickRate server with a 30 Hz sendRate, +// the above way to measure the interval would result in a 18-19 Hz sendRate! +// => this is not just a little off. this is _way_ off, by almost half. +// => displaying actual + target tick/send rate will show this very easily. +// +// we need an accurate way to measure intervals for where it matters. +// and it needs to be testable to guarantee results. +using System.Runtime.CompilerServices; + +namespace Mirror +{ + public static class AccurateInterval + { + // static func instead of storing interval + lastTime struct. + // + don't need to initialize struct ctor with interval in Awake + // + allows for interval changes at runtime too + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool Elapsed(double time, double interval, ref double lastTime) + { + // enough time elapsed? + if (time < lastTime + interval) + return false; + + // naive implementation: + //lastTime = time; + + // accurate but doesn't handle heavy load situations: + //lastTime += interval; + + // heavy load edge case: + // * interval is 100ms + // * server is under heavy load, Updates slow down to 1/s + // * Elapsed(1.000) returns true. + // technically 10 intervals have elapsed. + // * server recovers to normal, Updates are every 10ms again + // * Elapsed(1.010) should return false again until 1.100. + // + // increasing lastTime by interval would require 10 more calls + // to ever catch up again: + // lastTime += interval + // + // as result, the next 10 calls to Elapsed would return true. + // Elapsed(1.001) => true + // Elapsed(1.002) => true + // Elapsed(1.003) => true + // ... + // even though technically the delta was not >= interval. + // + // this would keep the server under heavy load, and it may never + // catch-up. this is not ideal for large virtual worlds. + // + // instead, we want to skip multiples of 'interval' and only + // keep the remainder. + // + // see also: AccurateIntervalTests.Slowdown() + + // easy to understand: + //double elapsed = time - lastTime; + //double remainder = elapsed % interval; + //lastTime = time - remainder; + + // easier: set to rounded multiples of interval (fholm). + // long to match double time. + long multiplier = (long)(time / interval); + lastTime = multiplier * interval; + return true; + } + } +} diff --git a/Assets/Mirror/Core/Tools/AccurateInterval.cs.meta b/Assets/Mirror/Core/Tools/AccurateInterval.cs.meta new file mode 100644 index 0000000..a58184d --- /dev/null +++ b/Assets/Mirror/Core/Tools/AccurateInterval.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c1b18064e25046f28b88db65a4012ec1 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools/Compression.cs b/Assets/Mirror/Core/Tools/Compression.cs new file mode 100644 index 0000000..d04b566 --- /dev/null +++ b/Assets/Mirror/Core/Tools/Compression.cs @@ -0,0 +1,556 @@ +// Quaternion compression from DOTSNET +using System; +using System.Runtime.CompilerServices; +using UnityEngine; + +namespace Mirror +{ + /// Functions to Compress Quaternions and Floats + public static class Compression + { + // divide by precision (functions backported from Mirror II) + // for example, 0.1 cm precision converts '5.0f' float to '50' long. + // + // 'long' instead of 'int' to allow for large enough worlds. + // value / precision exceeds int.max range too easily. + // Convert.ToInt32/64 would throw. + // https://github.com/vis2k/DOTSNET/issues/59 + // + // 'long' and 'int' will result in the same bandwidth though. + // for example, ScaleToLong(10.5, 0.1) = 105. + // int: 0x00000069 + // long: 0x0000000000000069 + // delta compression will reduce both to 1 byte. + // + // returns + // 'true' if scaling was possible within 'long' bounds. + // 'false' if clamping was necessary. + // never throws. checking result is optional. + public static bool ScaleToLong(float value, float precision, out long result) + { + // user might try to pass precision = 0 to disable rounding. + // this is not supported. + // throw to make the user fix this immediately. + // otherwise we would have to reinterpret-cast if ==0 etc. + // this function should be kept simple. + // if rounding isn't wanted, this function shouldn't be called. + if (precision == 0) throw new DivideByZeroException($"ScaleToLong: precision=0 would cause null division. If rounding isn't wanted, don't call this function."); + + // catch OverflowException if value/precision > long.max. + // attackers should never be able to throw exceptions. + try + { + result = Convert.ToInt64(value / precision); + return true; + } + // clamp to .max/.min. + // returning '0' would make far away entities reset to origin. + // returning 'max' would keep them stuck at the end of the world. + // the latter is much easier to debug. + catch (OverflowException) + { + result = value > 0 ? long.MaxValue : long.MinValue; + return false; + } + } + + // returns + // 'true' if scaling was possible within 'long' bounds. + // 'false' if clamping was necessary. + // never throws. checking result is optional. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool ScaleToLong(Vector3 value, float precision, out long x, out long y, out long z) + { + // attempt to convert every component. + // do not return early if one conversion returned 'false'. + // the return value is optional. always attempt to convert all. + bool result = true; + result &= ScaleToLong(value.x, precision, out x); + result &= ScaleToLong(value.y, precision, out y); + result &= ScaleToLong(value.z, precision, out z); + return result; + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool ScaleToLong(Vector3 value, float precision, out Vector3Long quantized) + { + quantized = Vector3Long.zero; + return ScaleToLong(value, precision, out quantized.x, out quantized.y, out quantized.z); + } + + // multiple by precision. + // for example, 0.1 cm precision converts '50' long to '5.0f' float. + public static float ScaleToFloat(long value, float precision) + { + // user might try to pass precision = 0 to disable rounding. + // this is not supported. + // throw to make the user fix this immediately. + // otherwise we would have to reinterpret-cast if ==0 etc. + // this function should be kept simple. + // if rounding isn't wanted, this function shouldn't be called. + if (precision == 0) throw new DivideByZeroException($"ScaleToLong: precision=0 would cause null division. If rounding isn't wanted, don't call this function."); + + return value * precision; + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Vector3 ScaleToFloat(long x, long y, long z, float precision) + { + Vector3 v; + v.x = ScaleToFloat(x, precision); + v.y = ScaleToFloat(y, precision); + v.z = ScaleToFloat(z, precision); + return v; + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Vector3 ScaleToFloat(Vector3Long value, float precision) => + ScaleToFloat(value.x, value.y, value.z, precision); + + // scale a float within min/max range to an ushort between min/max range + // note: can also use this for byte range from byte.MinValue to byte.MaxValue + public static ushort ScaleFloatToUShort(float value, float minValue, float maxValue, ushort minTarget, ushort maxTarget) + { + // note: C# ushort - ushort => int, hence so many casts + // max ushort - min ushort only fits into something bigger + int targetRange = maxTarget - minTarget; + float valueRange = maxValue - minValue; + float valueRelative = value - minValue; + return (ushort)(minTarget + (ushort)(valueRelative / valueRange * targetRange)); + } + + // scale an ushort within min/max range to a float between min/max range + // note: can also use this for byte range from byte.MinValue to byte.MaxValue + public static float ScaleUShortToFloat(ushort value, ushort minValue, ushort maxValue, float minTarget, float maxTarget) + { + // note: C# ushort - ushort => int, hence so many casts + float targetRange = maxTarget - minTarget; + ushort valueRange = (ushort)(maxValue - minValue); + ushort valueRelative = (ushort)(value - minValue); + return minTarget + (valueRelative / (float)valueRange * targetRange); + } + + // quaternion compression ////////////////////////////////////////////// + // smallest three: https://gafferongames.com/post/snapshot_compression/ + // compresses 16 bytes quaternion into 4 bytes + + // helper function to find largest absolute element + // returns the index of the largest one + public static int LargestAbsoluteComponentIndex(Vector4 value, out float largestAbs, out Vector3 withoutLargest) + { + // convert to abs + Vector4 abs = new Vector4(Mathf.Abs(value.x), Mathf.Abs(value.y), Mathf.Abs(value.z), Mathf.Abs(value.w)); + + // set largest to first abs (x) + largestAbs = abs.x; + withoutLargest = new Vector3(value.y, value.z, value.w); + int largestIndex = 0; + + // compare to the others, starting at second value + // performance for 100k calls + // for-loop: 25ms + // manual checks: 22ms + if (abs.y > largestAbs) + { + largestIndex = 1; + largestAbs = abs.y; + withoutLargest = new Vector3(value.x, value.z, value.w); + } + if (abs.z > largestAbs) + { + largestIndex = 2; + largestAbs = abs.z; + withoutLargest = new Vector3(value.x, value.y, value.w); + } + if (abs.w > largestAbs) + { + largestIndex = 3; + largestAbs = abs.w; + withoutLargest = new Vector3(value.x, value.y, value.z); + } + + return largestIndex; + } + + const float QuaternionMinRange = -0.707107f; + const float QuaternionMaxRange = 0.707107f; + const ushort TenBitsMax = 0b11_1111_1111; + + // note: assumes normalized quaternions + public static uint CompressQuaternion(Quaternion q) + { + // note: assuming normalized quaternions is enough. no need to force + // normalize here. we already normalize when decompressing. + + // find the largest component index [0,3] + value + int largestIndex = LargestAbsoluteComponentIndex(new Vector4(q.x, q.y, q.z, q.w), out float _, out Vector3 withoutLargest); + + // from here on, we work with the 3 components without largest! + + // "You might think you need to send a sign bit for [largest] in + // case it is negative, but you don’t, because you can make + // [largest] always positive by negating the entire quaternion if + // [largest] is negative. in quaternion space (x,y,z,w) and + // (-x,-y,-z,-w) represent the same rotation." + if (q[largestIndex] < 0) + withoutLargest = -withoutLargest; + + // put index & three floats into one integer. + // => index is 2 bits (4 values require 2 bits to store them) + // => the three floats are between [-0.707107,+0.707107] because: + // "If v is the absolute value of the largest quaternion + // component, the next largest possible component value occurs + // when two components have the same absolute value and the + // other two components are zero. The length of that quaternion + // (v,v,0,0) is 1, therefore v^2 + v^2 = 1, 2v^2 = 1, + // v = 1/sqrt(2). This means you can encode the smallest three + // components in [-0.707107,+0.707107] instead of [-1,+1] giving + // you more precision with the same number of bits." + // => the article recommends storing each float in 9 bits + // => our uint has 32 bits, so we might as well store in (32-2)/3=10 + // 10 bits max value: 1023=0x3FF (use OSX calc to flip 10 bits) + ushort aScaled = ScaleFloatToUShort(withoutLargest.x, QuaternionMinRange, QuaternionMaxRange, 0, TenBitsMax); + ushort bScaled = ScaleFloatToUShort(withoutLargest.y, QuaternionMinRange, QuaternionMaxRange, 0, TenBitsMax); + ushort cScaled = ScaleFloatToUShort(withoutLargest.z, QuaternionMinRange, QuaternionMaxRange, 0, TenBitsMax); + + // now we just need to pack them into one integer + // -> index is 2 bit and needs to be shifted to 31..32 + // -> a is 10 bit and needs to be shifted 20..30 + // -> b is 10 bit and needs to be shifted 10..20 + // -> c is 10 bit and needs to be at 0..10 + return (uint)(largestIndex << 30 | aScaled << 20 | bScaled << 10 | cScaled); + } + + // Quaternion normalizeSAFE from ECS math.normalizesafe() + // => useful to produce valid quaternions even if client sends invalid + // data + [MethodImpl(MethodImplOptions.AggressiveInlining)] + static Quaternion QuaternionNormalizeSafe(Quaternion value) + { + // The smallest positive normal number representable in a float. + const float FLT_MIN_NORMAL = 1.175494351e-38F; + + Vector4 v = new Vector4(value.x, value.y, value.z, value.w); + float length = Vector4.Dot(v, v); + return length > FLT_MIN_NORMAL + ? value.normalized + : Quaternion.identity; + } + + // note: gives normalized quaternions + public static Quaternion DecompressQuaternion(uint data) + { + // get cScaled which is at 0..10 and ignore the rest + ushort cScaled = (ushort)(data & TenBitsMax); + + // get bScaled which is at 10..20 and ignore the rest + ushort bScaled = (ushort)((data >> 10) & TenBitsMax); + + // get aScaled which is at 20..30 and ignore the rest + ushort aScaled = (ushort)((data >> 20) & TenBitsMax); + + // get 2 bit largest index, which is at 31..32 + int largestIndex = (int)(data >> 30); + + // scale back to floats + float a = ScaleUShortToFloat(aScaled, 0, TenBitsMax, QuaternionMinRange, QuaternionMaxRange); + float b = ScaleUShortToFloat(bScaled, 0, TenBitsMax, QuaternionMinRange, QuaternionMaxRange); + float c = ScaleUShortToFloat(cScaled, 0, TenBitsMax, QuaternionMinRange, QuaternionMaxRange); + + // calculate the omitted component based on a²+b²+c²+d²=1 + float d = Mathf.Sqrt(1 - a*a - b*b - c*c); + + // reconstruct based on largest index + Vector4 value; + switch (largestIndex) + { + case 0: value = new Vector4(d, a, b, c); break; + case 1: value = new Vector4(a, d, b, c); break; + case 2: value = new Vector4(a, b, d, c); break; + default: value = new Vector4(a, b, c, d); break; + } + + // ECS Rotation only works with normalized quaternions. + // make sure that's always the case here to avoid ECS bugs where + // everything stops moving if the quaternion isn't normalized. + // => NormalizeSafe returns a normalized quaternion even if we pass + // in NaN from deserializing invalid values! + return QuaternionNormalizeSafe(new Quaternion(value.x, value.y, value.z, value.w)); + } + + // varint compression ////////////////////////////////////////////////// + // helper function to predict varint size for a given number. + // useful when checking if a message + size header will fit, etc. + public static int VarUIntSize(ulong value) + { + if (value <= 240) + return 1; + if (value <= 2287) + return 2; + if (value <= 67823) + return 3; + if (value <= 16777215) + return 4; + if (value <= 4294967295) + return 5; + if (value <= 1099511627775) + return 6; + if (value <= 281474976710655) + return 7; + if (value <= 72057594037927935) + return 8; + return 9; + } + + // helper function to predict varint size for a given number. + // useful when checking if a message + size header will fit, etc. + public static int VarIntSize(long value) + { + // CompressVarInt zigzags it first + ulong zigzagged = (ulong)((value >> 63) ^ (value << 1)); + return VarUIntSize(zigzagged); + } + + // compress ulong varint. + // same result for ulong, uint, ushort and byte. only need one function. + // NOT an extension. otherwise weaver might accidentally use it. + public static void CompressVarUInt(NetworkWriter writer, ulong value) + { + // straight forward implementation: + // keep this for understanding & debugging. + /* + if (value <= 240) + { + writer.WriteByte((byte)value); + return; + } + if (value <= 2287) + { + writer.WriteByte((byte)(((value - 240) >> 8) + 241)); + writer.WriteByte((byte)((value - 240) & 0xFF)); + return; + } + if (value <= 67823) + { + writer.WriteByte((byte)249); + writer.WriteByte((byte)((value - 2288) >> 8)); + writer.WriteByte((byte)((value - 2288) & 0xFF)); + return; + } + if (value <= 16777215) + { + writer.WriteByte((byte)250); + writer.WriteByte((byte)(value & 0xFF)); + writer.WriteByte((byte)((value >> 8) & 0xFF)); + writer.WriteByte((byte)((value >> 16) & 0xFF)); + return; + } + if (value <= 4294967295) + { + writer.WriteByte((byte)251); + writer.WriteByte((byte)(value & 0xFF)); + writer.WriteByte((byte)((value >> 8) & 0xFF)); + writer.WriteByte((byte)((value >> 16) & 0xFF)); + writer.WriteByte((byte)((value >> 24) & 0xFF)); + return; + } + if (value <= 1099511627775) + { + writer.WriteByte((byte)252); + writer.WriteByte((byte)(value & 0xFF)); + writer.WriteByte((byte)((value >> 8) & 0xFF)); + writer.WriteByte((byte)((value >> 16) & 0xFF)); + writer.WriteByte((byte)((value >> 24) & 0xFF)); + writer.WriteByte((byte)((value >> 32) & 0xFF)); + return; + } + if (value <= 281474976710655) + { + writer.WriteByte((byte)253); + writer.WriteByte((byte)(value & 0xFF)); + writer.WriteByte((byte)((value >> 8) & 0xFF)); + writer.WriteByte((byte)((value >> 16) & 0xFF)); + writer.WriteByte((byte)((value >> 24) & 0xFF)); + writer.WriteByte((byte)((value >> 32) & 0xFF)); + writer.WriteByte((byte)((value >> 40) & 0xFF)); + return; + } + if (value <= 72057594037927935) + { + writer.WriteByte((byte)254); + writer.WriteByte((byte)(value & 0xFF)); + writer.WriteByte((byte)((value >> 8) & 0xFF)); + writer.WriteByte((byte)((value >> 16) & 0xFF)); + writer.WriteByte((byte)((value >> 24) & 0xFF)); + writer.WriteByte((byte)((value >> 32) & 0xFF)); + writer.WriteByte((byte)((value >> 40) & 0xFF)); + writer.WriteByte((byte)((value >> 48) & 0xFF)); + return; + } + + // all others + { + writer.WriteByte((byte)255); + writer.WriteByte((byte)(value & 0xFF)); + writer.WriteByte((byte)((value >> 8) & 0xFF)); + writer.WriteByte((byte)((value >> 16) & 0xFF)); + writer.WriteByte((byte)((value >> 24) & 0xFF)); + writer.WriteByte((byte)((value >> 32) & 0xFF)); + writer.WriteByte((byte)((value >> 40) & 0xFF)); + writer.WriteByte((byte)((value >> 48) & 0xFF)); + writer.WriteByte((byte)((value >> 56) & 0xFF)); + } + */ + + // faster implementation writes multiple bytes at once. + // avoids extra Space, WriteBlittable overhead. + // VarInt is in hot path, performance matters here. + if (value <= 240) + { + byte a = (byte)value; + writer.WriteByte(a); + return; + } + if (value <= 2287) + { + byte a = (byte)(((value - 240) >> 8) + 241); + byte b = (byte)((value - 240) & 0xFF); + writer.WriteUShort((ushort)(b << 8 | a)); + return; + } + if (value <= 67823) + { + byte a = (byte)249; + byte b = (byte)((value - 2288) >> 8); + byte c = (byte)((value - 2288) & 0xFF); + writer.WriteByte(a); + writer.WriteUShort((ushort)(c << 8 | b)); + return; + } + if (value <= 16777215) + { + byte a = (byte)250; + uint b = (uint)(value << 8); + writer.WriteUInt(b | a); + return; + } + if (value <= 4294967295) + { + byte a = (byte)251; + uint b = (uint)value; + writer.WriteByte(a); + writer.WriteUInt(b); + return; + } + if (value <= 1099511627775) + { + byte a = (byte)252; + byte b = (byte)(value & 0xFF); + uint c = (uint)(value >> 8); + writer.WriteUShort((ushort)(b << 8 | a)); + writer.WriteUInt(c); + return; + } + if (value <= 281474976710655) + { + byte a = (byte)253; + byte b = (byte)(value & 0xFF); + byte c = (byte)((value >> 8) & 0xFF); + uint d = (uint)(value >> 16); + writer.WriteByte(a); + writer.WriteUShort((ushort)(c << 8 | b)); + writer.WriteUInt(d); + return; + } + if (value <= 72057594037927935) + { + byte a = 254; + ulong b = value << 8; + writer.WriteULong(b | a); + return; + } + + // all others + { + writer.WriteByte(255); + writer.WriteULong(value); + } + } + + // zigzag encoding https://gist.github.com/mfuerstenau/ba870a29e16536fdbaba + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void CompressVarInt(NetworkWriter writer, long i) + { + ulong zigzagged = (ulong)((i >> 63) ^ (i << 1)); + CompressVarUInt(writer, zigzagged); + } + + // NOT an extension. otherwise weaver might accidentally use it. + public static ulong DecompressVarUInt(NetworkReader reader) + { + byte a0 = reader.ReadByte(); + if (a0 < 241) + { + return a0; + } + + byte a1 = reader.ReadByte(); + if (a0 <= 248) + { + return 240 + ((a0 - (ulong)241) << 8) + a1; + } + + byte a2 = reader.ReadByte(); + if (a0 == 249) + { + return 2288 + ((ulong)a1 << 8) + a2; + } + + byte a3 = reader.ReadByte(); + if (a0 == 250) + { + return a1 + (((ulong)a2) << 8) + (((ulong)a3) << 16); + } + + byte a4 = reader.ReadByte(); + if (a0 == 251) + { + return a1 + (((ulong)a2) << 8) + (((ulong)a3) << 16) + (((ulong)a4) << 24); + } + + byte a5 = reader.ReadByte(); + if (a0 == 252) + { + return a1 + (((ulong)a2) << 8) + (((ulong)a3) << 16) + (((ulong)a4) << 24) + (((ulong)a5) << 32); + } + + byte a6 = reader.ReadByte(); + if (a0 == 253) + { + return a1 + (((ulong)a2) << 8) + (((ulong)a3) << 16) + (((ulong)a4) << 24) + (((ulong)a5) << 32) + (((ulong)a6) << 40); + } + + byte a7 = reader.ReadByte(); + if (a0 == 254) + { + return a1 + (((ulong)a2) << 8) + (((ulong)a3) << 16) + (((ulong)a4) << 24) + (((ulong)a5) << 32) + (((ulong)a6) << 40) + (((ulong)a7) << 48); + } + + byte a8 = reader.ReadByte(); + if (a0 == 255) + { + return a1 + (((ulong)a2) << 8) + (((ulong)a3) << 16) + (((ulong)a4) << 24) + (((ulong)a5) << 32) + (((ulong)a6) << 40) + (((ulong)a7) << 48) + (((ulong)a8) << 56); + } + + throw new IndexOutOfRangeException($"DecompressVarInt failure: {a0}"); + } + + // zigzag decoding https://gist.github.com/mfuerstenau/ba870a29e16536fdbaba + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static long DecompressVarInt(NetworkReader reader) + { + ulong data = DecompressVarUInt(reader); + return ((long)(data >> 1)) ^ -((long)data & 1); + } + } +} diff --git a/Assets/Mirror/Core/Tools/Compression.cs.meta b/Assets/Mirror/Core/Tools/Compression.cs.meta new file mode 100644 index 0000000..e35474b --- /dev/null +++ b/Assets/Mirror/Core/Tools/Compression.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 5c28963f9c4b97e418252a55500fb91e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools/DeltaCompression.cs b/Assets/Mirror/Core/Tools/DeltaCompression.cs new file mode 100644 index 0000000..a59370a --- /dev/null +++ b/Assets/Mirror/Core/Tools/DeltaCompression.cs @@ -0,0 +1,38 @@ +// manual delta compression for some types. +// varint(b-a) +// Mirror can't use Mirror II's bit-tree delta compression. +using System.Runtime.CompilerServices; + +namespace Mirror +{ + public static class DeltaCompression + { + // delta (usually small), then zigzag varint to support +- changes + // parameter order: (last, current) makes most sense (Q3 does this too). + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void Compress(NetworkWriter writer, long last, long current) => + Compression.CompressVarInt(writer, current - last); + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static long Decompress(NetworkReader reader, long last) => + last + Compression.DecompressVarInt(reader); + + // delta (usually small), then zigzag varint to support +- changes + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void Compress(NetworkWriter writer, Vector3Long last, Vector3Long current) + { + Compress(writer, last.x, current.x); + Compress(writer, last.y, current.y); + Compress(writer, last.z, current.z); + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Vector3Long Decompress(NetworkReader reader, Vector3Long last) + { + long x = Decompress(reader, last.x); + long y = Decompress(reader, last.y); + long z = Decompress(reader, last.z); + return new Vector3Long(x, y, z); + } + } +} diff --git a/Assets/Mirror/Core/Tools/DeltaCompression.cs.meta b/Assets/Mirror/Core/Tools/DeltaCompression.cs.meta new file mode 100644 index 0000000..a7b2c8b --- /dev/null +++ b/Assets/Mirror/Core/Tools/DeltaCompression.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6b8f3fffcb4754c15bc5ed4c33e2497b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools/ExponentialMovingAverage.cs b/Assets/Mirror/Core/Tools/ExponentialMovingAverage.cs new file mode 100644 index 0000000..674abb8 --- /dev/null +++ b/Assets/Mirror/Core/Tools/ExponentialMovingAverage.cs @@ -0,0 +1,53 @@ +// N-day EMA implementation from Mirror with a few changes (struct etc.) +// it calculates an exponential moving average roughly equivalent to the last n observations +// https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average +using System; + +namespace Mirror +{ + public struct ExponentialMovingAverage + { + readonly double alpha; + bool initialized; + + public double Value; + public double Variance; + public double StandardDeviation; // absolute value, see test + + public ExponentialMovingAverage(int n) + { + // standard N-day EMA alpha calculation + alpha = 2.0 / (n + 1); + initialized = false; + Value = 0; + Variance = 0; + StandardDeviation = 0; + } + + public void Add(double newValue) + { + // simple algorithm for EMA described here: + // https://en.wikipedia.org/wiki/Moving_average#Exponentially_weighted_moving_variance_and_standard_deviation + if (initialized) + { + double delta = newValue - Value; + Value += alpha * delta; + Variance = (1 - alpha) * (Variance + alpha * delta * delta); + StandardDeviation = Math.Sqrt(Variance); + } + else + { + Value = newValue; + initialized = true; + } + } + + public void Reset() + { + initialized = false; + Value = 0; + Variance = 0; + StandardDeviation = 0; + } + } +} diff --git a/Assets/Mirror/Core/Tools/ExponentialMovingAverage.cs.meta b/Assets/Mirror/Core/Tools/ExponentialMovingAverage.cs.meta new file mode 100644 index 0000000..d0d8210 --- /dev/null +++ b/Assets/Mirror/Core/Tools/ExponentialMovingAverage.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 05e858cbaa54b4ce4a48c8c7f50c1914 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools/Extensions.cs b/Assets/Mirror/Core/Tools/Extensions.cs new file mode 100644 index 0000000..02407e0 --- /dev/null +++ b/Assets/Mirror/Core/Tools/Extensions.cs @@ -0,0 +1,64 @@ +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; + +namespace Mirror +{ + public static class Extensions + { + public static string ToHexString(this ArraySegment segment) => + BitConverter.ToString(segment.Array, segment.Offset, segment.Count); + + // string.GetHashCode is not guaranteed to be the same on all + // machines, but we need one that is the same on all machines. + // NOTE: Do not call this from hot path because it's slow O(N) for long method names. + // - As of 2012-02-16 There are 2 design-time callers (weaver) and 1 runtime caller that caches. + public static int GetStableHashCode(this string text) + { + unchecked + { + int hash = 23; + foreach (char c in text) + hash = hash * 31 + c; + + //UnityEngine.Debug.Log($"Created stable hash {(ushort)hash} for {text}"); + return hash; + } + } + + // previously in DotnetCompatibility.cs + // leftover from the UNET days. supposedly for windows store? + internal static string GetMethodName(this Delegate func) + { +#if NETFX_CORE + return func.GetMethodInfo().Name; +#else + return func.Method.Name; +#endif + } + + // helper function to copy to List + // C# only provides CopyTo(T[]) + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void CopyTo(this IEnumerable source, List destination) + { + // foreach allocates. use AddRange. + destination.AddRange(source); + } + +#if !UNITY_2021_OR_NEWER + // Unity 2020 and earlier doesn't have Queue.TryDequeue which we need for batching. + public static bool TryDequeue(this Queue source, out T element) + { + if (source.Count > 0) + { + element = source.Dequeue(); + return true; + } + + element = default; + return false; + } +#endif + } +} diff --git a/Assets/Mirror/Core/Tools/Extensions.cs.meta b/Assets/Mirror/Core/Tools/Extensions.cs.meta new file mode 100644 index 0000000..c2a18b7 --- /dev/null +++ b/Assets/Mirror/Core/Tools/Extensions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: decf32fd053744d18f35712b7a6f5116 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools/Mathd.cs b/Assets/Mirror/Core/Tools/Mathd.cs new file mode 100644 index 0000000..374471a --- /dev/null +++ b/Assets/Mirror/Core/Tools/Mathd.cs @@ -0,0 +1,32 @@ +// 'double' precision variants for some of Unity's Mathf functions. +using System.Runtime.CompilerServices; + +namespace Mirror +{ + public static class Mathd + { + // Unity 2020 doesn't have Math.Clamp yet. + /// Clamps value between 0 and 1 and returns value. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static double Clamp(double value, double min, double max) + { + if (value < min) return min; + if (value > max) return max; + return value; + } + + /// Clamps value between 0 and 1 and returns value. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static double Clamp01(double value) => Clamp(value, 0, 1); + + /// Calculates the linear parameter t that produces the interpolant value within the range [a, b]. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static double InverseLerp(double a, double b, double value) => + a != b ? Clamp01((value - a) / (b - a)) : 0; + + /// Linearly interpolates between a and b by t with no limit to t. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static double LerpUnclamped(double a, double b, double t) => + a + (b - a) * t; + } +} diff --git a/Assets/Mirror/Core/Tools/Mathd.cs.meta b/Assets/Mirror/Core/Tools/Mathd.cs.meta new file mode 100644 index 0000000..927c55a --- /dev/null +++ b/Assets/Mirror/Core/Tools/Mathd.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 5f74084b91c74df2839b426c4a381373 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools/Pool.cs b/Assets/Mirror/Core/Tools/Pool.cs new file mode 100644 index 0000000..e204575 --- /dev/null +++ b/Assets/Mirror/Core/Tools/Pool.cs @@ -0,0 +1,40 @@ +// Pool to avoid allocations (from libuv2k) +// API consistent with Microsoft's ObjectPool. +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; + +namespace Mirror +{ + public class Pool + { + // Mirror is single threaded, no need for concurrent collections. + // stack increases the chance that a reused writer remains in cache. + readonly Stack objects = new Stack(); + + // some types might need additional parameters in their constructor, so + // we use a Func generator + readonly Func objectGenerator; + + public Pool(Func objectGenerator, int initialCapacity) + { + this.objectGenerator = objectGenerator; + + // allocate an initial pool so we have fewer (if any) + // allocations in the first few frames (or seconds). + for (int i = 0; i < initialCapacity; ++i) + objects.Push(objectGenerator()); + } + + // take an element from the pool, or create a new one if empty + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public T Get() => objects.Count > 0 ? objects.Pop() : objectGenerator(); + + // return an element to the pool + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public void Return(T item) => objects.Push(item); + + // count to see how many objects are in the pool. useful for tests. + public int Count => objects.Count; + } +} diff --git a/Assets/Mirror/Core/Tools/Pool.cs.meta b/Assets/Mirror/Core/Tools/Pool.cs.meta new file mode 100644 index 0000000..7d12a20 --- /dev/null +++ b/Assets/Mirror/Core/Tools/Pool.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 845bb05fa349344c3811022f4f15dfbc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools/Readme.txt b/Assets/Mirror/Core/Tools/Readme.txt new file mode 100644 index 0000000..09bd920 --- /dev/null +++ b/Assets/Mirror/Core/Tools/Readme.txt @@ -0,0 +1 @@ +Standalone algorithms & structs to help build Mirror. \ No newline at end of file diff --git a/Assets/Mirror/Core/Tools/Readme.txt.meta b/Assets/Mirror/Core/Tools/Readme.txt.meta new file mode 100644 index 0000000..5536ca7 --- /dev/null +++ b/Assets/Mirror/Core/Tools/Readme.txt.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: da033671de7d49e0838223a997c56bf1 +timeCreated: 1667486850 \ No newline at end of file diff --git a/Assets/Mirror/Core/Tools/TimeSample.cs b/Assets/Mirror/Core/Tools/TimeSample.cs new file mode 100644 index 0000000..111e971 --- /dev/null +++ b/Assets/Mirror/Core/Tools/TimeSample.cs @@ -0,0 +1,61 @@ +// TimeSample from Mirror II. +// simple profiling sample, averaged for display in statistics. +// usable in builds without unitiy profiler overhead etc. +// +// .average may safely be called from main thread while Begin/End is in another. +// i.e. worker threads, transport, etc. +using System.Diagnostics; +using System.Threading; + +namespace Mirror +{ + public struct TimeSample + { + // UnityEngine.Time isn't thread safe. use stopwatch instead. + readonly Stopwatch watch; + + // remember when Begin was called + double beginTime; + + // keep accumulating times over the given interval. + // (not readonly. we modify its contents.) + ExponentialMovingAverage ema; + + // average in seconds. + // code often runs in sub-millisecond time. float is more precise. + // + // set with Interlocked for thread safety. + // can be read from main thread while sampling happens in other thread. + public double average; // THREAD SAFE + + // average over N begin/end captures + public TimeSample(int n) + { + watch = new Stopwatch(); + watch.Start(); + ema = new ExponentialMovingAverage(n); + beginTime = 0; + average = 0; + } + + // begin is called before the code to be sampled + public void Begin() + { + // remember when Begin was called. + // keep StopWatch running so we can average over the given interval. + beginTime = watch.Elapsed.TotalSeconds; + // Debug.Log($"Begin @ {beginTime:F4}"); + } + + // end is called after the code to be sampled + public void End() + { + // add duration in seconds to accumulated durations + double elapsed = watch.Elapsed.TotalSeconds - beginTime; + ema.Add(elapsed); + + // expose new average thread safely + Interlocked.Exchange(ref average, ema.Value); + } + } +} diff --git a/Assets/Mirror/Core/Tools/TimeSample.cs.meta b/Assets/Mirror/Core/Tools/TimeSample.cs.meta new file mode 100644 index 0000000..83e5ede --- /dev/null +++ b/Assets/Mirror/Core/Tools/TimeSample.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 26c32f6429554546a88d800c846c74ed +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools/Utils.cs b/Assets/Mirror/Core/Tools/Utils.cs new file mode 100644 index 0000000..2ed8dff --- /dev/null +++ b/Assets/Mirror/Core/Tools/Utils.cs @@ -0,0 +1,188 @@ +using System; +using System.Runtime.CompilerServices; +using System.Security.Cryptography; +using UnityEngine; +using UnityEngine.SceneManagement; + +namespace Mirror +{ + // Handles network messages on client and server + public delegate void NetworkMessageDelegate(NetworkConnection conn, NetworkReader reader, int channelId); + + // Handles requests to spawn objects on the client + public delegate GameObject SpawnDelegate(Vector3 position, uint assetId); + + public delegate GameObject SpawnHandlerDelegate(SpawnMessage msg); + + // Handles requests to unspawn objects on the client + public delegate void UnSpawnDelegate(GameObject spawned); + + // channels are const ints instead of an enum so people can add their own + // channels (can't extend an enum otherwise). + // + // note that Mirror is slowly moving towards quake style networking which + // will only require reliable for handshake, and unreliable for the rest. + // so eventually we can change this to an Enum and transports shouldn't + // add custom channels anymore. + public static class Channels + { + public const int Reliable = 0; // ordered + public const int Unreliable = 1; // unordered + } + + public static class Utils + { + public static uint GetTrueRandomUInt() + { + // use Crypto RNG to avoid having time based duplicates + using (RNGCryptoServiceProvider rng = new RNGCryptoServiceProvider()) + { + byte[] bytes = new byte[4]; + rng.GetBytes(bytes); + return BitConverter.ToUInt32(bytes, 0); + } + } + + public static bool IsPrefab(GameObject obj) + { +#if UNITY_EDITOR + return UnityEditor.PrefabUtility.IsPartOfPrefabAsset(obj); +#else + return false; +#endif + } + + // simplified IsSceneObject check from Mirror II + public static bool IsSceneObject(NetworkIdentity identity) + { + // original UNET / Mirror still had the IsPersistent check. + // it never fires though. even for Prefabs dragged to the Scene. + // (see Scene Objects example scene.) + // #if UNITY_EDITOR + // if (UnityEditor.EditorUtility.IsPersistent(identity.gameObject)) + // return false; + // #endif + + return identity.gameObject.hideFlags != HideFlags.NotEditable && + identity.gameObject.hideFlags != HideFlags.HideAndDontSave && + identity.sceneId != 0; + } + + public static bool IsSceneObjectWithPrefabParent(GameObject gameObject, out GameObject prefab) + { + prefab = null; + +#if UNITY_EDITOR + if (!UnityEditor.PrefabUtility.IsPartOfPrefabInstance(gameObject)) + { + return false; + } + prefab = UnityEditor.PrefabUtility.GetCorrespondingObjectFromSource(gameObject); +#endif + + if (prefab == null) + { + Debug.LogError($"Failed to find prefab parent for scene object [name:{gameObject.name}]"); + return false; + } + return true; + } + + // is a 2D point in screen? (from ummorpg) + // (if width = 1024, then indices from 0..1023 are valid (=1024 indices) + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool IsPointInScreen(Vector2 point) => + 0 <= point.x && point.x < Screen.width && + 0 <= point.y && point.y < Screen.height; + + // pretty print bytes as KB/MB/GB/etc. from DOTSNET + // long to support > 2GB + // divides by floats to return "2.5MB" etc. + public static string PrettyBytes(long bytes) + { + // bytes + if (bytes < 1024) + return $"{bytes} B"; + // kilobytes + else if (bytes < 1024L * 1024L) + return $"{(bytes / 1024f):F2} KB"; + // megabytes + else if (bytes < 1024 * 1024L * 1024L) + return $"{(bytes / (1024f * 1024f)):F2} MB"; + // gigabytes + return $"{(bytes / (1024f * 1024f * 1024f)):F2} GB"; + } + + // pretty print seconds as hours:minutes:seconds(.milliseconds/100)s. + // double for long running servers. + public static string PrettySeconds(double seconds) + { + TimeSpan t = TimeSpan.FromSeconds(seconds); + string res = ""; + if (t.Days > 0) res += $"{t.Days}d"; + if (t.Hours > 0) res += $"{(res.Length > 0 ? " " : "")}{t.Hours}h"; + if (t.Minutes > 0) res += $"{(res.Length > 0 ? " " : "")}{t.Minutes}m"; + // 0.5s, 1.5s etc. if any milliseconds. 1s, 2s etc. if any seconds + if (t.Milliseconds > 0) res += $"{(res.Length > 0 ? " " : "")}{t.Seconds}.{(t.Milliseconds / 100)}s"; + else if (t.Seconds > 0) res += $"{(res.Length > 0 ? " " : "")}{t.Seconds}s"; + // if the string is still empty because the value was '0', then at least + // return the seconds instead of returning an empty string + return res != "" ? res : "0s"; + } + + // universal .spawned function + public static NetworkIdentity GetSpawnedInServerOrClient(uint netId) + { + // server / host mode: use the one from server. + // host mode has access to all spawned. + if (NetworkServer.active) + { + NetworkServer.spawned.TryGetValue(netId, out NetworkIdentity entry); + return entry; + } + + // client + if (NetworkClient.active) + { + NetworkClient.spawned.TryGetValue(netId, out NetworkIdentity entry); + return entry; + } + + return null; + } + + // keep a GUI window in screen. + // for example. if it's at x=1000 and screen is resized to w=500, + // it won't get lost in the invisible area etc. + public static Rect KeepInScreen(Rect rect) + { + // ensure min + rect.x = Math.Max(rect.x, 0); + rect.y = Math.Max(rect.y, 0); + + // ensure max + rect.x = Math.Min(rect.x, Screen.width - rect.width); + rect.y = Math.Min(rect.y, Screen.width - rect.height); + + return rect; + } + + // create local connections pair and connect them + public static void CreateLocalConnections( + out LocalConnectionToClient connectionToClient, + out LocalConnectionToServer connectionToServer) + { + connectionToServer = new LocalConnectionToServer(); + connectionToClient = new LocalConnectionToClient(); + connectionToServer.connectionToClient = connectionToClient; + connectionToClient.connectionToServer = connectionToServer; + } + + public static bool IsSceneActive(string scene) + { + Scene activeScene = SceneManager.GetActiveScene(); + return activeScene.path == scene || + activeScene.name == scene; + } + } +} diff --git a/Assets/Mirror/Core/Tools/Utils.cs.meta b/Assets/Mirror/Core/Tools/Utils.cs.meta new file mode 100644 index 0000000..7cf1557 --- /dev/null +++ b/Assets/Mirror/Core/Tools/Utils.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b530ce39098b54374a29ad308c8e4554 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Tools/Vector3Long.cs b/Assets/Mirror/Core/Tools/Vector3Long.cs new file mode 100644 index 0000000..d54a46c --- /dev/null +++ b/Assets/Mirror/Core/Tools/Vector3Long.cs @@ -0,0 +1,125 @@ +#pragma warning disable CS0659 // 'Vector3Long' overrides Object.Equals(object o) but does not override Object.GetHashCode() +#pragma warning disable CS0661 // 'Vector3Long' defines operator == or operator != but does not override Object.GetHashCode() + +// Vector3Long by mischa (based on game engine project) +using System; +using System.Runtime.CompilerServices; + +namespace Mirror +{ + public struct Vector3Long + { + public long x; + public long y; + public long z; + + public static readonly Vector3Long zero = new Vector3Long(0, 0, 0); + public static readonly Vector3Long one = new Vector3Long(1, 1, 1); + public static readonly Vector3Long forward = new Vector3Long(0, 0, 1); + public static readonly Vector3Long back = new Vector3Long(0, 0, -1); + public static readonly Vector3Long left = new Vector3Long(-1, 0, 0); + public static readonly Vector3Long right = new Vector3Long(1, 0, 0); + public static readonly Vector3Long up = new Vector3Long(0, 1, 0); + public static readonly Vector3Long down = new Vector3Long(0, -1, 0); + + // constructor ///////////////////////////////////////////////////////// + public Vector3Long(long x, long y, long z) + { + this.x = x; + this.y = y; + this.z = z; + } + + // operators /////////////////////////////////////////////////////////// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Vector3Long operator +(Vector3Long a, Vector3Long b) => + new Vector3Long(a.x + b.x, a.y + b.y, a.z + b.z); + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Vector3Long operator -(Vector3Long a, Vector3Long b) => + new Vector3Long(a.x - b.x, a.y - b.y, a.z - b.z); + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Vector3Long operator -(Vector3Long v) => + new Vector3Long(-v.x, -v.y, -v.z); + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Vector3Long operator *(Vector3Long a, long n) => + new Vector3Long(a.x * n, a.y * n, a.z * n); + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Vector3Long operator *(long n, Vector3Long a) => + new Vector3Long(a.x * n, a.y * n, a.z * n); + + // == returns true if approximately equal (with epsilon). + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool operator ==(Vector3Long a, Vector3Long b) => + a.x == b.x && + a.y == b.y && + a.z == b.z; + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool operator !=(Vector3Long a, Vector3Long b) => !(a == b); + + // NO IMPLICIT System.Numerics.Vector3Long conversion because double<->float + // would silently lose precision in large worlds. + + // [i] component index. useful for iterating all components etc. + public long this[int index] + { + [MethodImpl(MethodImplOptions.AggressiveInlining)] + get + { + switch (index) + { + case 0: return x; + case 1: return y; + case 2: return z; + default: throw new IndexOutOfRangeException($"Vector3Long[{index}] out of range."); + } + } + [MethodImpl(MethodImplOptions.AggressiveInlining)] + set + { + switch (index) + { + case 0: + x = value; + break; + case 1: + y = value; + break; + case 2: + z = value; + break; + default: throw new IndexOutOfRangeException($"Vector3Long[{index}] out of range."); + } + } + } + + // instance functions ////////////////////////////////////////////////// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public override string ToString() => $"({x} {y} {z})"; + + // equality //////////////////////////////////////////////////////////// + // implement Equals & HashCode explicitly for performance. + // calling .Equals (instead of "==") checks for exact equality. + // (API compatibility) + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public bool Equals(Vector3Long other) => + x == other.x && y == other.y && z == other.z; + + // Equals(object) can reuse Equals(Vector4) + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public override bool Equals(object other) => + other is Vector3Long vector4 && Equals(vector4); + +#if UNITY_2021_3_OR_NEWER + // Unity 2019/2020 don't have HashCode.Combine yet. + // this is only to avoid reflection. without defining, it works too. + // default generated by rider + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public override int GetHashCode() => HashCode.Combine(x, y, z); +#endif + } +} diff --git a/Assets/Mirror/Core/Tools/Vector3Long.cs.meta b/Assets/Mirror/Core/Tools/Vector3Long.cs.meta new file mode 100644 index 0000000..2239765 --- /dev/null +++ b/Assets/Mirror/Core/Tools/Vector3Long.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 18efa4e349254185ad257401dd24628b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/Transport.cs b/Assets/Mirror/Core/Transport.cs new file mode 100644 index 0000000..7e0716d --- /dev/null +++ b/Assets/Mirror/Core/Transport.cs @@ -0,0 +1,191 @@ +// For future reference, here is what Transports need to do in Mirror: +// +// Connecting: +// * Transports are responsible to call either OnConnected || OnDisconnected +// in a certain time after a Connect was called. It can not end in limbo. +// +// Disconnecting: +// * Connections might disconnect voluntarily by the other end. +// * Connections might be disconnect involuntarily by the server. +// * Either way, Transports need to detect it and call OnDisconnected. +// +// Timeouts: +// * Transports should expose a configurable timeout +// * Transports are responsible for calling OnDisconnected after a timeout +// +// Channels: +// * Default channel is Reliable, as in reliable ordered (OR DISCONNECT) +// * Where possible, Unreliable should be supported (unordered, no guarantee) +// +// Other: +// * Transports functions are all bound to the main thread. +// (Transports can use other threads in the background if they manage them) +// * Transports should only process messages while the component is enabled. +// +using System; +using UnityEngine; + +namespace Mirror +{ + /// Abstract transport layer component + public abstract class Transport : MonoBehaviour + { + /// The current transport used by Mirror. + public static Transport active; + + /// Is this transport available in the current platform? + public abstract bool Available(); + + // client ////////////////////////////////////////////////////////////// + /// Called by Transport when the client connected to the server. + public Action OnClientConnected; + + /// Called by Transport when the client received a message from the server. + public Action, int> OnClientDataReceived; + + /// Called by Transport when the client sent a message to the server. + // Transports are responsible for calling it because: + // - groups it together with OnReceived responsibility + // - allows transports to decide if anything was sent or not + // - allows transports to decide the actual used channel (i.e. tcp always sending reliable) + public Action, int> OnClientDataSent; + + /// Called by Transport when the client encountered an error. + public Action OnClientError; + + /// Called by Transport when the client disconnected from the server. + public Action OnClientDisconnected; + + // server ////////////////////////////////////////////////////////////// + /// Called by Transport when a new client connected to the server. + public Action OnServerConnected; + + /// Called by Transport when the server received a message from a client. + public Action, int> OnServerDataReceived; + + /// Called by Transport when the server sent a message to a client. + // Transports are responsible for calling it because: + // - groups it together with OnReceived responsibility + // - allows transports to decide if anything was sent or not + // - allows transports to decide the actual used channel (i.e. tcp always sending reliable) + public Action, int> OnServerDataSent; + + /// Called by Transport when a server's connection encountered a problem. + /// If a Disconnect will also be raised, raise the Error first. + public Action OnServerError; + + /// Called by Transport when a client disconnected from the server. + public Action OnServerDisconnected; + + // client functions //////////////////////////////////////////////////// + /// True if the client is currently connected to the server. + public abstract bool ClientConnected(); + + /// Connects the client to the server at the address. + public abstract void ClientConnect(string address); + + /// Connects the client to the server at the Uri. + public virtual void ClientConnect(Uri uri) + { + // By default, to keep backwards compatibility, just connect to the host + // in the uri + ClientConnect(uri.Host); + } + + /// Sends a message to the server over the given channel. + // The ArraySegment is only valid until returning. Copy if needed. + public abstract void ClientSend(ArraySegment segment, int channelId = Channels.Reliable); + + /// Disconnects the client from the server + public abstract void ClientDisconnect(); + + // server functions //////////////////////////////////////////////////// + /// Returns server address as Uri. + // Useful for NetworkDiscovery. + public abstract Uri ServerUri(); + + /// True if the server is currently listening for connections. + public abstract bool ServerActive(); + + /// Start listening for connections. + public abstract void ServerStart(); + + /// Send a message to a client over the given channel. + public abstract void ServerSend(int connectionId, ArraySegment segment, int channelId = Channels.Reliable); + + /// Disconnect a client from the server. + public abstract void ServerDisconnect(int connectionId); + + /// Get a client's address on the server. + // Can be useful for Game Master IP bans etc. + public abstract string ServerGetClientAddress(int connectionId); + + /// Stop listening and disconnect all connections. + public abstract void ServerStop(); + + /// Maximum message size for the given channel. + // Different channels often have different sizes, ranging from MTU to + // several megabytes. + // + // Needs to return a value at all times, even if the Transport isn't + // running or available because it's needed for initializations. + public abstract int GetMaxPacketSize(int channelId = Channels.Reliable); + + /// Recommended Batching threshold for this transport. + // Uses GetMaxPacketSize by default. + // Some transports like kcp support large max packet sizes which should + // not be used for batching all the time because they end up being too + // slow (head of line blocking etc.). + public virtual int GetBatchThreshold(int channelId = Channels.Reliable) + { + return GetMaxPacketSize(channelId); + } + + // block Update & LateUpdate to show warnings if Transports still use + // them instead of using + // Client/ServerEarlyUpdate: to process incoming messages + // Client/ServerLateUpdate: to process outgoing messages + // those are called by NetworkClient/Server at the right time. + // + // allows transports to implement the proper network update order of: + // process_incoming() + // update_world() + // process_outgoing() + // + // => see NetworkLoop.cs for detailed explanations! +#pragma warning disable UNT0001 // Empty Unity message + public void Update() {} + public void LateUpdate() {} +#pragma warning restore UNT0001 // Empty Unity message + + /// + /// NetworkLoop NetworkEarly/LateUpdate were added for a proper network + /// update order. the goal is to: + /// process_incoming() + /// update_world() + /// process_outgoing() + /// in order to avoid unnecessary latency and data races. + /// + // => split into client and server parts so that we can cleanly call + // them from NetworkClient/Server + // => VIRTUAL for now so we can take our time to convert transports + // without breaking anything. + public virtual void ClientEarlyUpdate() {} + public virtual void ServerEarlyUpdate() {} + public virtual void ClientLateUpdate() {} + public virtual void ServerLateUpdate() {} + + /// Shut down the transport, both as client and server + public abstract void Shutdown(); + + /// Called by Unity when quitting. Inheriting Transports should call base for proper Shutdown. + public virtual void OnApplicationQuit() + { + // stop transport (e.g. to shut down threads) + // (when pressing Stop in the Editor, Unity keeps threads alive + // until we press Start again. so if Transports use threads, we + // really want them to end now and not after next start) + Shutdown(); + } + } +} diff --git a/Assets/Mirror/Core/Transport.cs.meta b/Assets/Mirror/Core/Transport.cs.meta new file mode 100644 index 0000000..55072e1 --- /dev/null +++ b/Assets/Mirror/Core/Transport.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: cfffcac25d6d64ced9de620159e221b8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/TransportError.cs b/Assets/Mirror/Core/TransportError.cs new file mode 100644 index 0000000..b452015 --- /dev/null +++ b/Assets/Mirror/Core/TransportError.cs @@ -0,0 +1,17 @@ +// Mirror transport error code enum. +// most transport implementations should use a subset of this, +// and then translate the transport error codes to mirror error codes. +namespace Mirror +{ + public enum TransportError : byte + { + DnsResolve, // failed to resolve a host name + Refused, // connection refused by other end. server full etc. + Timeout, // ping timeout or dead link + Congestion, // more messages than transport / network can process + InvalidReceive, // recv invalid packet (possibly intentional attack) + InvalidSend, // user tried to send invalid data + ConnectionClosed, // connection closed voluntarily or lost involuntarily + Unexpected // unexpected error / exception, requires fix. + } +} diff --git a/Assets/Mirror/Core/TransportError.cs.meta b/Assets/Mirror/Core/TransportError.cs.meta new file mode 100644 index 0000000..d1d0fa0 --- /dev/null +++ b/Assets/Mirror/Core/TransportError.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ce162bdedd704db9b8c35d163f0c1d54 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Core/WeaverFuse.cs b/Assets/Mirror/Core/WeaverFuse.cs new file mode 100644 index 0000000..f850323 --- /dev/null +++ b/Assets/Mirror/Core/WeaverFuse.cs @@ -0,0 +1,22 @@ +// safety fuse for weaver to flip. +// runtime can check this to ensure weaving succeded. +// otherwise running server/client would give lots of random 'writer not found' etc. errors. +// this is much cleaner. +// +// note that ILPostProcessor errors already block entering playmode. +// however, issues could still stop the weaving from running at all. +// WeaverFuse can check if it actually ran. +namespace Mirror +{ + public static class WeaverFuse + { + // this trick only works for ILPostProcessor. + // CompilationFinishedHook can't weaver Mirror.dll. + public static bool Weaved() => +#if UNITY_2020_3_OR_NEWER + false; +#else + true; +#endif + } +} diff --git a/Assets/Mirror/Core/WeaverFuse.cs.meta b/Assets/Mirror/Core/WeaverFuse.cs.meta new file mode 100644 index 0000000..282920a --- /dev/null +++ b/Assets/Mirror/Core/WeaverFuse.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 4de3dfbcbd2e41fcac947c04bcac52c9 +timeCreated: 1686319660 \ No newline at end of file diff --git a/Assets/Mirror/Editor.meta b/Assets/Mirror/Editor.meta new file mode 100644 index 0000000..f679511 --- /dev/null +++ b/Assets/Mirror/Editor.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 2539267b6934a4026a505690a1e1eda2 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/AndroidManifestHelper.cs b/Assets/Mirror/Editor/AndroidManifestHelper.cs new file mode 100644 index 0000000..c76359a --- /dev/null +++ b/Assets/Mirror/Editor/AndroidManifestHelper.cs @@ -0,0 +1,113 @@ +// Android NetworkDiscovery Multicast fix +// https://github.com/vis2k/Mirror/pull/2887 +using UnityEditor; +using UnityEngine; +using UnityEditor.Build; +using UnityEditor.Build.Reporting; +using System.Xml; +using System.IO; +#if UNITY_ANDROID +using UnityEditor.Android; +#endif + + +[InitializeOnLoad] +public class AndroidManifestHelper : IPreprocessBuildWithReport, IPostprocessBuildWithReport +#if UNITY_ANDROID + , IPostGenerateGradleAndroidProject +#endif +{ + public int callbackOrder { get { return 99999; } } + +#if UNITY_ANDROID + public void OnPostGenerateGradleAndroidProject(string path) + { + string manifestFolder = Path.Combine(path, "src/main"); + string sourceFile = manifestFolder + "/AndroidManifest.xml"; + // Load android manifest file + XmlDocument doc = new XmlDocument(); + doc.Load(sourceFile); + + string androidNamepsaceURI; + XmlElement element = (XmlElement)doc.SelectSingleNode("/manifest"); + if (element == null) + { + UnityEngine.Debug.LogError("Could not find manifest tag in android manifest."); + return; + } + + // Get android namespace URI from the manifest + androidNamepsaceURI = element.GetAttribute("xmlns:android"); + if (string.IsNullOrEmpty(androidNamepsaceURI)) + { + UnityEngine.Debug.LogError("Could not find Android Namespace in manifest."); + return; + } + AddOrRemoveTag(doc, + androidNamepsaceURI, + "/manifest", + "uses-permission", + "android.permission.CHANGE_WIFI_MULTICAST_STATE", + true, + false); + AddOrRemoveTag(doc, + androidNamepsaceURI, + "/manifest", + "uses-permission", + "android.permission.INTERNET", + true, + false); + doc.Save(sourceFile); + } +#endif + + static void AddOrRemoveTag(XmlDocument doc, string @namespace, string path, string elementName, string name, bool required, bool modifyIfFound, params string[] attrs) // name, value pairs + { + var nodes = doc.SelectNodes(path + "/" + elementName); + XmlElement element = null; + foreach (XmlElement e in nodes) + { + if (name == null || name == e.GetAttribute("name", @namespace)) + { + element = e; + break; + } + } + + if (required) + { + if (element == null) + { + var parent = doc.SelectSingleNode(path); + element = doc.CreateElement(elementName); + element.SetAttribute("name", @namespace, name); + parent.AppendChild(element); + } + + for (int i = 0; i < attrs.Length; i += 2) + { + if (modifyIfFound || string.IsNullOrEmpty(element.GetAttribute(attrs[i], @namespace))) + { + if (attrs[i + 1] != null) + { + element.SetAttribute(attrs[i], @namespace, attrs[i + 1]); + } + else + { + element.RemoveAttribute(attrs[i], @namespace); + } + } + } + } + else + { + if (element != null && modifyIfFound) + { + element.ParentNode.RemoveChild(element); + } + } + } + + public void OnPostprocessBuild(BuildReport report) {} + public void OnPreprocessBuild(BuildReport report) {} +} diff --git a/Assets/Mirror/Editor/AndroidManifestHelper.cs.meta b/Assets/Mirror/Editor/AndroidManifestHelper.cs.meta new file mode 100644 index 0000000..1281aea --- /dev/null +++ b/Assets/Mirror/Editor/AndroidManifestHelper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 80cc70189403d7444bbffd185ca28462 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/EditorHelper.cs b/Assets/Mirror/Editor/EditorHelper.cs new file mode 100644 index 0000000..b10c7b0 --- /dev/null +++ b/Assets/Mirror/Editor/EditorHelper.cs @@ -0,0 +1,31 @@ +using System.IO; +using UnityEditor; +using UnityEngine; + +namespace Mirror +{ + public static class EditorHelper + { + public static string FindPath() + { + string typeName = typeof(T).Name; + + string[] guidsFound = AssetDatabase.FindAssets($"t:Script {typeName}"); + if (guidsFound.Length >= 1 && !string.IsNullOrWhiteSpace(guidsFound[0])) + { + if (guidsFound.Length > 1) + { + Debug.LogWarning($"Found more than one{typeName}"); + } + + string path = AssetDatabase.GUIDToAssetPath(guidsFound[0]); + return Path.GetDirectoryName(path); + } + else + { + Debug.LogError($"Could not find path of {typeName}"); + return string.Empty; + } + } + } +} diff --git a/Assets/Mirror/Editor/EditorHelper.cs.meta b/Assets/Mirror/Editor/EditorHelper.cs.meta new file mode 100644 index 0000000..a1cd814 --- /dev/null +++ b/Assets/Mirror/Editor/EditorHelper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: dba787f167ff29c4288532af1ec3584c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty.meta b/Assets/Mirror/Editor/Empty.meta new file mode 100644 index 0000000..ee87976 --- /dev/null +++ b/Assets/Mirror/Editor/Empty.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 62c8dc5bb12bbc6428bb66ccbac57000 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty/EnterPlayModeSettingsCheck.cs b/Assets/Mirror/Editor/Empty/EnterPlayModeSettingsCheck.cs new file mode 100644 index 0000000..18ab111 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/EnterPlayModeSettingsCheck.cs @@ -0,0 +1 @@ +// removed 2021-12-12 diff --git a/Assets/Mirror/Editor/Empty/EnterPlayModeSettingsCheck.cs.meta b/Assets/Mirror/Editor/Empty/EnterPlayModeSettingsCheck.cs.meta new file mode 100644 index 0000000..79a200d --- /dev/null +++ b/Assets/Mirror/Editor/Empty/EnterPlayModeSettingsCheck.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b15a0d2ca0909400eb53dd6fe894cddd +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty/LogLevelWindow.cs b/Assets/Mirror/Editor/Empty/LogLevelWindow.cs new file mode 100644 index 0000000..82e5275 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/LogLevelWindow.cs @@ -0,0 +1 @@ +// File moved to Mirror/Editor/Logging/LogLevelWindow.cs \ No newline at end of file diff --git a/Assets/Mirror/Editor/Empty/LogLevelWindow.cs.meta b/Assets/Mirror/Editor/Empty/LogLevelWindow.cs.meta new file mode 100644 index 0000000..b8cbaeb --- /dev/null +++ b/Assets/Mirror/Editor/Empty/LogLevelWindow.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f28def2148ed5194abe70af012a4e3e0 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty/Logging.meta b/Assets/Mirror/Editor/Empty/Logging.meta new file mode 100644 index 0000000..257467f --- /dev/null +++ b/Assets/Mirror/Editor/Empty/Logging.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 4d97731cd74ac8b4b8aad808548ef9cd +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty/Logging/LogLevelWindow.cs b/Assets/Mirror/Editor/Empty/Logging/LogLevelWindow.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/Logging/LogLevelWindow.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Editor/Empty/Logging/LogLevelWindow.cs.meta b/Assets/Mirror/Editor/Empty/Logging/LogLevelWindow.cs.meta new file mode 100644 index 0000000..832876f --- /dev/null +++ b/Assets/Mirror/Editor/Empty/Logging/LogLevelWindow.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c3dbf48190d77d243b87962a82c3b164 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty/Logging/LogLevelsGUI.cs b/Assets/Mirror/Editor/Empty/Logging/LogLevelsGUI.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/Logging/LogLevelsGUI.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Editor/Empty/Logging/LogLevelsGUI.cs.meta b/Assets/Mirror/Editor/Empty/Logging/LogLevelsGUI.cs.meta new file mode 100644 index 0000000..3214b08 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/Logging/LogLevelsGUI.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 9d6ce9d62a2d2ec4d8cef8a0d22b8dd2 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty/Logging/LogSettingsEditor.cs b/Assets/Mirror/Editor/Empty/Logging/LogSettingsEditor.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/Logging/LogSettingsEditor.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Editor/Empty/Logging/LogSettingsEditor.cs.meta b/Assets/Mirror/Editor/Empty/Logging/LogSettingsEditor.cs.meta new file mode 100644 index 0000000..2c1fac4 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/Logging/LogSettingsEditor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8f4ecb3d81ce9ff44b91f311ee46d4ea +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty/Logging/NetworkLogSettingsEditor.cs b/Assets/Mirror/Editor/Empty/Logging/NetworkLogSettingsEditor.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/Logging/NetworkLogSettingsEditor.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Editor/Empty/Logging/NetworkLogSettingsEditor.cs.meta b/Assets/Mirror/Editor/Empty/Logging/NetworkLogSettingsEditor.cs.meta new file mode 100644 index 0000000..b4c277d --- /dev/null +++ b/Assets/Mirror/Editor/Empty/Logging/NetworkLogSettingsEditor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 37fb96d5bbf965d47acfc5c8589a1b71 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty/ScriptableObjectUtility.cs b/Assets/Mirror/Editor/Empty/ScriptableObjectUtility.cs new file mode 100644 index 0000000..39b95f7 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/ScriptableObjectUtility.cs @@ -0,0 +1 @@ +// removed 2021-02-16 diff --git a/Assets/Mirror/Editor/Empty/ScriptableObjectUtility.cs.meta b/Assets/Mirror/Editor/Empty/ScriptableObjectUtility.cs.meta new file mode 100644 index 0000000..a1a0af3 --- /dev/null +++ b/Assets/Mirror/Editor/Empty/ScriptableObjectUtility.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 4d54a29ddd5b52b4eaa07ed39c0e3e83 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Empty/SyncVarDrawer.cs b/Assets/Mirror/Editor/Empty/SyncVarDrawer.cs new file mode 100644 index 0000000..aaa3b9d --- /dev/null +++ b/Assets/Mirror/Editor/Empty/SyncVarDrawer.cs @@ -0,0 +1 @@ +// removed 2022-11-03 diff --git a/Assets/Mirror/Editor/Empty/SyncVarDrawer.cs.meta b/Assets/Mirror/Editor/Empty/SyncVarDrawer.cs.meta new file mode 100644 index 0000000..0ee91aa --- /dev/null +++ b/Assets/Mirror/Editor/Empty/SyncVarDrawer.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 874812594431423b84f763b987ff9681 +timeCreated: 1632553007 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Icon.meta b/Assets/Mirror/Editor/Icon.meta new file mode 100644 index 0000000..7338187 --- /dev/null +++ b/Assets/Mirror/Editor/Icon.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: b5f1356ad059a1243910a4e82cd68c5f +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Icon/MirrorIcon.png b/Assets/Mirror/Editor/Icon/MirrorIcon.png new file mode 100644 index 0000000000000000000000000000000000000000..1be896157a63edfe96735948eeb145381697d551 GIT binary patch literal 138247 zcmV(;K-<5GP)DP*7-ZbZ>KLZ*U+1wS zIWubl&Q%31NtvJmA*ETsC=CJK?JnEG+HSTj(#Ax$)3du{r?cak+42*vh>6AK$qG-F$t-cfv#E0^q)q^) zU9U_->Lk!R6~k+>IO+j_u7dQWa%`(y$XX@Us5-8UwflhW|G8$}=AzzOU}Z2fx)<08 ziPxqpxxGLiBu?6u{3!4QB(Bam`-WTbT|dm0f%TAF*PI#80Gl8=SXH~nBc7zHHwPEv zcMsRcUI11>@>_3ec%)T(*$xIKfpw6)TbDycpa(R|35Uj_T5XqVlt&_6tvW4pd7u}x zH)k4q%Mqvcc`!GcU*tSo9~f@o=U=JpDFNM}{U+T)InvVp@xxN92hroX!^KETv-z^oR-t?qumdB%fy|1G3g@{uxNpHNx zug|eBQ9;sR3W<%!9W2Te$YSB6Xi&w$rGUgkqL8@loXt!j37A3QFo(n?KvF`YT9qBX z8WNA|C>(4CdOoI!MV&wJsK@dKsMExwwhT|y%Z(OKL#!5Qu}!4K4p9_4#dgt;C7u<} ziCrQm(xPANXxElv6Is-_(dK!TCK8J>`^a(@myilBzv9s#SlX52-OY`iould{$G&jv zX3Q&xfSH(EaYsiUujyCx`A&xZvp%oS>sRiXrSTt^<)SBVRq*;khJEy?Aluxg%BYcy|Z2FC4omUmw0b%+cNsn*J&MXZlk5 z{q#ra-?ewN&$O?#)7lr>c`WUWc2@gF`%e2r`!aS`%ip2)*^`O&E%BE0TH=~nbB+19 znKRd#PnyLJpSjxHVh)-c%$&KVeQt5RxO)y0xNU!y){63CHz4saGdRn(rvBlV9WIC$G1|w(m8yk%LJ-5?d zW>Oi-gCW2`!#|{)T0OM3rqj<@8Q*uMHRRcSy;j9_E#=heVPGj4NHr&?``AA*X+@v( zTV)bJV%3EX7CsL<{{roY4mR0@lL4%Ls)KFphDY9mQ%~DXHMjVWO?(eQb=%hHX=N7l zUltZ_t%uaxaObUsg}*;oSh({cX!CH!{THY-d{(d^JqZ8+03c&XQcVB=ZI}Q6bB+K2 z@_PUPgxUZAZj=B3|t><+d2(H)=z(G|_ zY!Mv+ik;Z2@z2O+n)TSC34m5_Pwhcc6hTq|{WG$r`P3jQYa*)3In6Q~fi@eJbK*g& zp~|KtiX=c2;Js0UbN2q;wN}J>zr*D7*dl>@&)NI?-e#?cSP}R?|6l%3B;)uGB7(gC zFA>1~{|v5wp#FvR4+elpf93Xbc=zva|NQRvtiR*<_sh?^eV+V(uRk+?mg)B`AM^G# zc>mXM{O|O;uAl4p`PZM9fB*WsnSN*ftjBY``&sqxQ-0^=@rpl}e}Dfo{rl&iH~b9T ze-801>t}195xoD==)VKYgKYnv`tJFDn%{eV zuWijPk0AZM+wVmAyYAh%=Ww@H?|yE59(~WNXI?+^@xRw+SpSDJt|0#X zw1&&)iHP<<(|hS_uYMM_H~QyA`fdzHaQRv7@G)zAJ)7DBJN6IKS#Rw;ZtNb1q zyq$SrzoY)=?9cD|pxbA!?od@oRW0o9|2x&@&x`8ryOg5m_Tx}KvshEOe-EhN8RGk14?1o(PuR=$45B-Y^_USe{4! zuKn|K{gcbVsn$5vuFPiv>lvV*t^apnE((-AgLWx1>T{caZY>h?c^8|{h_Wx-1-yJ7 z_9mn5(PPa-YGBra@3uC9TQR8jYF{(G;4I%5eLeQgqSgt-8F`#DwXst7OfM8doW)0R zw!W^qhK~Xvf8X0XCWn25<$iR}mg#>3Xzw!>TIGz4`W{g3W^tEXztg3CSfW)r`q0>H z3?45#|2*C<$aSIS2SxD(dUd7`EQ&%PABetVhS``Xe~)r=0Mmv))783P3D)%Bl%hsRis-dNeRdAL* z)G0O}^Ut&0HWSLwFG$=jz*Lb62s2fw23pGpH3hmNI%YsV+jIfMvS{l9EsH1@VG7kL z2O&aK{Nh$xzZ=~JstccE!*MxKDLQ%e%vcU#$O8fCd#G-MW$og4Q>l=;oe~Dk@x??f zhDlW@z(CHT$l?r#>cbYT%k~HHy4JZIaAArfh>q*rp|2{8{A_WeyLTOWENISJj6rmk z2fVK9>we})K#DP}kKSYi91PqG`dxAB5RZDftc4gE@=Va{12@{Czpu4IW$Iudi!pT( z*8&*w8D0y}X^rG}kA(Onnu`6sEgGF2>Nhw<4zj=@k9~j9(9t;< zZG}bUBCFj|R7kBZF8Iquo)Ik7HmxSW!-&uY5DH%{Us~-paH9HMI~tVFSPw&rI~MKW zsj%!?NlHp%fF&Ekg7Ue=K?rOLgP0Cd1-GFg7M&uXfW=p&1Oi@!fbcdvoIs@N?@Z5` z;h|X4Zhm(M>owOex9d7+T?COhO9#t$F5Dp|SZIf}u-fg>I8n4gJPUn3X=KuLuUopS z@-vS6r?_-z=sgxnBpQ^giY68;I=vT0xxgS`d6w=OrO+#96f_#>khOYtUVk6On)Jw; zKJ(f32TTzV15Kiu09yK?cI4^;1*T%YG$j!4ak+FW!gl;`3iJ&PiKx1>+jdOvWO^>F z6adAg4pW7PfGVS0LJ%Cx0TJD}KSDsUJQh7Wx04RH(k12v$F!-n9$-QgY6sglI&PP( z6JFGfPRVPji=e?@3!RcLy}~Uo{B#nj@St+mix{B}iY$1BR`=G^!8O4r-2L;z|u@;N{xy_=e<#2*Vn-m&MfZaPX|9(Ldj{_$*NKQxe z`k{*bUx%Y91`QDV`tOB_raUHECN~uB>_$27rpp0iv1QMHPM4hd-Ha1=i$lcxh1M_Y zyf?I%ctSg(Q+}bE-2T}Pm3@8ZY{;P6qf#7na#F1 z|IN*TFK8KPcsBn`HO@C(5C|=j+!Yo=n2A~tIMuM@bSvUS3GwPNE(Iw^n~uq!NkNP= z4K&hoPzP4Oupm&qUaYFgiDOoWj1$ExCB)u~eYS&79b#PfEDmh(dhj3Pw@RP1E8du( z`$%g0p)kMwZU;+WVcbp^b>zi#&7AfRMYH7hT!xhExl~1jq9&KWQx~j2UQdvFrvEH9 zZB2*%)`kR1k_lveudYR((=Vt!C(?m@a)BvWjV04YbGFocC1BU`f7d#gwh*BI( ze*jvZ$_6((HE)Ny`>b?+$nx3+B@d=Lh-q}pO*`CP+UD?3Xv3-qt=~P^DDw~9hQ9?T@badz2kFI!noKr!fM=C2}jQqdw$5^nuP2Yrc1I;A7q#mn{I*zzETf*9UVgB5%QeuKm)Mz(cPG*!cJWg%1N~y zeWU8?AH6$b7^EOtm7LGfI_DmS|BE6@;-(|*+=b*y=_wP$hMu*Jf>^N_%EVaI zRJ0^tGHRUbtU9}nqeU4XjD~#mOL~V8)#W>(4DP_KJg7pUC}2v29vMB_cM6Y)b?^64 zNDd!=QotKDOI*OmNbL&W!*cmLG@aw*gaRIAbG)nz&K& zi5ja#9y_uLz4w)%_@XwA?y~ZSoRyQuhr2%Le!)WgEH*LWs=RG48pRZ8 zRI$#BD8py_%CEzJ8*YyU(D0Q9l>7pt7F{x~Sgifhx*^V*XXvg=(T)flH5Sqko4(9w!6T{J{@HT38kU%N#?JbVQaX3ocp6?U|P?gn)Swu;{TNRl=D7+uKDaQy}< z9$>0owRWU~+!Zrt-3&a&r&jGIbSKYPf7r;k5r;Uz^^gW)?nh+R=X5bsGLD7ibT zz6+89L51GMMJt=h>Kh>nY-YtjfOcUjzA}pk4@62|R@4ZQ96N+wbL3zfzI2iB2$vR* zp>v^BhuS&eoGT0uXE#-}z^pM-ytAS_$`2%lLO^rG2cI5>)`EcSqxh4sxJ;S`&NdC5 z=EE7P7_m7YSNfqN(HR*yM4@`U)r|;N(xDy42tUSXF)Y~RL%aq=s}Bn7`)jJhdArX*p>4gC}QGy zieNey&Y&nE|L&Bhp}KG2jODFrrq(sU)~ITPZT{Zfz$`b%s2ucioyC#L z3*~4aF1p%OoQAHd{{>yOt0X0J$Om%%wS}!{xV}3?bKSI5qoneU9g~A@-vrj^&^Fru{ zU<_0$^>Nsfa`?^mI!9I}ELB&k!Xz1O&2Lh_nW486us_(hr}IX3ocqZlcToh zSZ5cljz>A5#6b)P`{~7`=IArzq12xoDq%N1rm_P#APeC;&=E>>cAz}9=qhwOxBYDV zT163bU`6kERi(H><=%x$7aLvNvR?GuZYB+hy5F^W{ZnWSj>(AY8ASVTDZ9AbJ-T=2 z#&-(;IbMtu?+uzpLljsVwrI@VESviIrV{`RRH@Oqb-G6vchxWpvJjQ)bU-PN^`7ZD zT03nIsXH6vJdUi#)M^9cDS>5gk>=pfYa0?7g`pXcFP^FaK%az?9tM-ckFDnO&F@KXX$?=&i4osb`{QYh{m#A&pm^j_UR0cHt1BV$WavURRHBFjs6|8qFfg1&(S!gdrmgUuHm6!k(TJJ)1P86r+x3rhsq5b|7vJR>7SKf|MO~4_DFOLq{F2 z3g?`D2QzKa^Q659sUOrH;czd^N5#hp!Iu%+M@LUOckFP;$cJ3+GOq8p=g9X1QA3~l zu-a#@cT*-NG$HfVlpBB53se_2HFHntXn5_!ITUUhbx<9!_GK5e9L|VycW`S+h!%*U zL)P}o&Y%bbw7W+_``%UQdmfdm%@!rqw2Q)4=dwe3_4Ez;Ie^-nxKOm-5ISmr^fBvI z1LF$^8Y*CM8O3B2HFe}Q69c7$j?rPZJ{&JpMtG-Ewh`$|zreR zw@USnYFT+4vFGfSaRj9gzpKEf2cEgX(&3qLDCeU97$IJ}Se-}zl&>B}G*W|!l-rcH z1f4rNw#!Hb*Izq!6xiPz{-{~?3|(r-PNNtVS?CtRy<$GoDcUvDf=22-sox z&e6rih%;n`i5OWbSp%l&g+m} zdEJ9~ybr>|Ko{ZHG&oFZa5det6`s<*Z#y9=;Z*AqV+7LGbP z2U>VSr=!u#nXBA}%9eBlLU)f#XOza(au7<7iOxl$E(p-zR0Y=`T{J~!>Ml}j;N%HK zFgf(XOI@8tIV}>h);HdFmZ6c%K_o;AGc_!5aX>Bg@MVHUW z+R;Ozcr~6jOvmmne*KQrIBPF(yn0;85rG}29CEEDp|R0#Rr-O}!L!e<=Z0q&SfuZ% zECyxF!BEU+-YE2TQ${@?EW`Zu?qH~x?HLh`2fVN2F1f6ScI&+9a8nIO}d(Lq90)H*$`dDrOSqpzB?fGBfgp)nupK z4}$BZs^GI+N$F>&E|m`Z-hcM+Ba@m2!oE9$_u1}TUoQaj*p?qR)17<`Vv3>SpNwI; z)1A_f=z=>bPti>CLi%i zX%9N`P4!|XE!3on6v?#}F%6Ux8`R8kPq*suK2xEfF3VgLF&Q!GXIPu{tX9o%VCD8` z@b78-t9B}oqfee+RsR!7JlYGx<@d2BiA8(Im26<61R4*`=-e^P*|_8N!Fut3dlCSuX{U`CJbe@8P3>*h9fz1I=h8iK_! zv9dQH^^9u;tPt1cnQ~pESNq+%c3f^kYDU=it6URGL|LXws@?QWGviEsBn{QSQ&;$_ zGvApX?M9CgItZ_SC%F&N&quY-J1q-Qd_|*&=Rm$(c)%vy!ZZhmmhFss6Zrt z%}|hZ42x*c{~YLXba}ZUm_(!yGw1a^^mMpxM1_U(s>sZaGYgp^(ftcFWZF6T9?sDZ z)V+CDohVs_m^$r|g&PffAgSM{z4BS$X2@dD`Ja>G(-EfGaDpi=4uq2zd_^ondJAk7 z*A`W}-h(joTgd?wxduJ-=Xwq9&J=9WlG<_W)VpdBqr3KlLi1yfwUN*?M)v8Tv2H)8 zDGeY_>wQk2#Hhi@1+5-&g=m&2DM;5CJNMg)sP)E+wn$&^v`jBMRJ)%k>od44(~O%7 zLO~DvF`Ettu3fa!8i>t+2xZctN9d+hsgTfi_Z_FnCO`gtA5UV5N>ve^70RvZ=I~sU zh;m(>ZhGYK+L`9jt-3js5Golyv3pOie(vdDwF{4>^X72iQH(5A^kr}T?7RS`j)uiE zAe!m% zDySSlYZDPAt{bH>^K;{>2$&lNmk3yjMb0Ql4xbs4L7^|bbUCq7Om0;9c#oPwqls>h zbf)zTkFd1PD2}tiIl8$}F~&NA*gZ$r*m2X8Anb_t`n%{0$RpRlBM7Rnr?YTDzniC+ z`$`{Fm)lGJ62mwf&?@-unwC|W(LtLthadRBOQ5?x$|-i5j6s~tYQxT_-{!rjs;`3*g|sNwRc z)ofCf1$GpIy{TYcFA8P4g2fPOH>cl|M*W;VgwAL{12ab#D%H;0zq)`c$fhOx4eBxN z9&_&fK_~;098v@E-?eW;*MXpTY3P}F%`#d;ljG2jy*FocFnVOR_6}Irul5?4 z{9hEhQ}#Hz^|fwL^7^^>u9)^qH3cfnysj{ySs$*huu=Sx8RrxoeIA)X+i@Lg1atFoiI+oMJJokL9UOVhLPZ-?Rn1RZ> zm8lEK==9MHsfzbET11P#k4O}gP7}8c%slG0BBCsEeO{jvX?*@QhK3g5Ma3^!$Z?bopG@t3tAFzb>bD0Vq_B&b()H2%JKAU}&@Q>;;8$ z-LHxQ&<=5GOmvz^P~1OE*R&#bGpLk`2`EHQp*y<6TXQJ<5>-U%NhH9!csc~9`*nET zNvB%Qt@ASuivALuMR_q$9zD+@)3Umo)na1p+kdQQ;RjLHkT!a9XRDqL>EUK)Xft#K zgcGovy?D-uRxj#9N(U!1UR5i~b+g^(uVpNze*jqwvYWxjKoz)k$MJH>+~`^~zz8;C ztX4Y&>AQ=WpYQOR*E#Hhc&5)kVDD47^`t*Z0JX*U*h2ZSN zYkFa?rVv!ZA+RqFfGMD@d`_r$rPn87juG}0v?^*Nlz{u7R5ZnLE%LKhOEo>CrE2B= z=dypA#s|d|4{H{H`oDd)ef?li!n7tzGMr;wY&AuV>>UfVm1sgRpyC~AAe`PM?X7kV z?2QFgq4UfA7?6kA+jCiLa*qh-I02D|I1F9aSbe>-*-MYk>@-o< zx#TI@Wme7CjzP;w`aiq@Udjq1$Q9_8Q<9(->o2ShE)&ie)@6m)2 z<-jlUOfsiNDbtVSY(LyH2uvp)1Fe9L;+-9Jw3AAhk&m@Vca%q0@rR*HQ~|RTWGBrE zBto<9dB&+mPc;jdeN|H}S$7u;BSku|ZxeB90Y)%bD1a%~*dq)15+i#TO__ydwK(LG zlTr7jr?Gm`y9z~{avrK6?$poi_uaQtw9moiJCuTHMa7UC3q46u&zLB*#B>&*b&+-Q zqK!#g_`aVDeVwTFI-L``h+X0J$p-sKi4^BZ`R9O!Vocra1G^Rxoz;;lM{F-#iZG{S^-Vb3}f z=k#Ypa&Zm4fq?z%MHm~?p24cQ9?xH4T zGNaNN`7*CX1(xCm%GMh$#(Rgj9A^jMMP;j{>ooVAi>eS8WxwnYAz@RCY}&0gxiE@z zq>Q|>o>!zPh}C*l0%&ZJ%2rceAMh%vFc#>?I?iIYJhnL{{jEi02x?=xq}0ABni;C| z2Ewg!dPYkFDJO>3hGwRh6dJPJo}0T!8MIB28?aIxCrVgPq6hoy@6b+CsQkDG<@An{8 z+teF6BC20~+IS->DQ!#(`PCx z7yh+?n^OusjNYGpx6VB%v+V261vP{j$BX88*i#ahb8JIdweIOg+MWv&>Dq&C@vG8D zbMXREoS{*rJ4;*(XRGhdNkEqy6>{gR!q9pjh-hUR6zf`5lr|6R?7EFQcuto(c zT;xB$N*z-NYj=+9zoYVL&TjhP09EJ|Wru$cohf)Y7U#=T94$}4=@C7m*DImdV4gnG zGl@FIUMLz1B{+0wPM_(9DDJM~o;lbDwwRBi^VyrQsQ;}-%#>F_-sjX1J~iS&_KP?} z&+3^KeM+38&<^qDStA@h(grCDFDZEiE(W^pr&EB{6bj2I_Ur(tGd~pN=6H3VvdF1u zA%%^zDiVc`tL()tMs*g%Vb*6}|5bmZ{b}mjU8wX}=qVXsREkO{#KcYH#3}+b{F~zE zs62>iM;l;A*eV~*4KE4FEoE*5*^?cvS~s06)!by9Sg5W`ozl^qCSnTynW1!8n`Be~ zrz}d!OM8Or>mhe4&$=95G^0A1kAr7ppf>7oSRlHfi(x-c7k@!^!HR0?4w6%0IJTI* zcs8SWx`696o!45x*t<@!Erw2a?dCR7$IW8)>=;@1gwKlh9XfLEBG%?R3c?kWE2E)| zG7rjYC<}Z$%-mi25I!)50|XsWN6$1ZM={z~&^9T|9mIRgRAlAD)wE4@t+Yv)sYqeF z%ho+Tr4wp8)lEw2^RP~6O!tdB&q;;!&JzeAJ?NXVd^ zdu@UivUDJ2vC-vhpQ+f+8^E|o*;?882+pvu(++}G{E#jxIy9bzdSOzy&^mY>rlS)N zlM7%$hN`KP&VcX*)cU@$d?)0{z(w3E_)ptCDKv|w;6&=SwbkjmPQ3t9T}mA?WPdtS zfyJ7kfN^aB3bn#%#G{8Uxv39G)I%RmPJlLD{OUs1`=h3Z0=;l!DTI{zU(s{=P^awj zR^eAKoFIA<=K!}0Im=_+syOVU-;Q2e(K3b`6Lx+h`TVX8pMuh2(LOUMh4l@ygyotWp5cE{OReb2;SM zy3=3M=$*srIF@|!6^xAr_vdOY1~`}7s#;fZH0n&pSGsPbjxObkT2nQ;Ao3F$Fd6Z? zPO4w_{qyivTxHifF|tIp*|-#%F&xxrMMLkHVtXJth?m^Wolm+5hjJ-2fdyVyYsF7P zxM`AF5a(QSGJJgW6i%|&*e#lXbdY)}7CGF3q+iC_q-PfeseA8SU+)_yO z|JUPus|E2i$~QkdNM}GfJlH0(WSeftXw$e?v;khf}jfKQDGl%UTH##LNmfn zm$mcgK-YD10MkfMuWT*SBQ?6D(F-mA^}-Pbj}r@~a$hk#U?tAUYE$im$Kp+1J9+`Z zr8w&%RDpv0T-0k{fHV+T??xIrLWjyIUZ0!y%*`PI!Aq(6U^8N5 zke*(MqC8W5Ap2}^ruR^vCl`;33ghoC6qgg=UE0F>%bDYrQn1Vc+nXyYD**m#TU zfXj!tI&*qWPapZE5i@rqE{!0Dr7(0-A4~yBQ|RGF1*-E?3y9I^=}!05B0FEw6^(G& z8C`Hk5wU#;`pBv1$odVmhK?r@N@sO__gyc+qO3*UT#AR7D=BO?ONcLM7DSziWmuRE zI+N0Lm|Z~Ss0+V|S)eXRKC^*h%#o5k_I6kDVXOqR;YU&UZ!Y&L*5uZy>KtX!g@*co zUsdMaKOZAS;V&lroRTGNf$_6$Vm%Nh{Q^(H)(BPfmJ9HNUG_Qu356bLANZ~`$J_t_ zMIh{G1(=^XT&z+duFS7$HBSr4W^K{#*+Q8A#DLHUnv8C3^a9f9mr|1hfg(_Kqp|!u z^&N^pkC3pri=&-ADng(bZv5J>WmOQ%Zo26RU=hR#8D6JguAOw{;d_yh$ELM2Z5>C) zfJ{?aClgvpd>f&>|(KR|>Lx8*P9*CX%$N8V(Jh_oeAj4q9!HsyKS!eJQop`wz!>4mtYoQt;(_Krqo8tV|QqX z$eFP@N)9tUJ9NHOMrv-+n90jwH$vGj+MGhbxw-r*D*BMU z=NdD_Bp95~qg)JzC~|2FyVd7q9=DFBlFxD*ha?}UZci!QMKn*Ys5SRvji`rdHk7rr zY83LjzSKinS2%(*jj9aYjYMz@9q-bi*tj1QJ6{E_bhrhZDo@8|LUL5uiyEi+)fLvs zTCLvQKOX(Q&3hPMNEhW`*ToKP`wDW10**T zilG!zHNFeF$%m~nWU6j(4U)H01e2J{g@CBPPdnyD*8Q&NtR4JYI7d0ATFw)@X3RxY z($m)G>zR~ew5v}y^uk_iY}{=BIWLn*=r@b)I9^~H?X2CW7Qt$WJHPKkqmmc=x{lU0 z)6a&PLey}&MqNmy>YuuD3V6QL8$D*b7nQZBO`Z2CD`qV80T1)NsRcYiN1toTj-Pkw ze9Lv`;^Z%h#TuAJQ5~U!7ZevMeg|3n*Zrs#gis})U1DJ*_)Nj#9g_DVF=YqK5i+gF z0YcNinU@N|r73aP5Kcj!tm4mDyu$qc5=wH;U9}?(!nV^z4);pFyuWaM**n2wY!3BF z4V*_H^CpJOA*Z-`*0rY!22H7Hs%I4mDhIN-CsI zc;NR?7ene|wO^ncbPjI6E2M-&p(VO$#0K^2V%9FI4AZ@Hpvb~RJ4c~IcJ7+@8h{GF z=m&8GJjb-?Q)%3g?c-FLNDrs0_&I*t8^Rp(SEUY2rtL3LvFIdngNKaK-nORw~dfV?&! zLv{KL?-__aPqnD@ud~t8E|pKLU3mLuCBA|+C{*^bZpsAafTKX~LKGVtw1E_(!9{sa zL*3AKylCAtjTb{N>gM<6RqxtBXDUoFB)ICZo-^amehpF1&ujB1H6`Nc7Ow@6h4QV+ zqW3W|QzbeXGKS9$iOyz7sEBY`@@U`?Sfugk9LMg?!R}L_8}0R@(B8?H-Zi25KC276 z?|tX^1$zkTLn_RLN6~?4JOSq&DsVO zt+dC|J!gosx;tvlm8F=i*4Y$@-A+e9A*kfA&Xh(bALt!1#6V?aLi zt`yhx^Y`~Gkivzwq3paPA!3TQ>nK=nE~dy^P}5qS1~QPpq~lCMOFzO~N0f73g9VYp z1;lkvl3IL3v{YIt!s~hh{d^`Nw3Vrco8ke`938uOk@DP6G_XY?A<>GuuWR#i>839< zn|M+^P9EPOphLyIRMl^Vll395a<$h7(lrZ;0-)e=cPVkO(2rAhEBMb>@I29FMfmZ! zl5)8G**PCwRKv}H2V&%84f@FQ`!{v)NgkjU1C9@!ps>33H20@B+-&Tl^4ZN8Q$rvq zpm&`nXbBSf3&1$&a&W-|A#4Q$kT2LG6aPW+7aSym>5XI$y+{cy~(+Yuit6B_) znlKhJmr;i(v4m~FpQ34m&M#tM=ULzrwXR~fiWp@RC52u%{*4<%MimvF+pj{SXyZy; zaf<$KI8k8k5WxPTu?}dv5S#kGu}QC-=ovIFxQU3-Ibda_s?ghN4z+UZZoIEI5y~H) zx9$s~xUJ7^wy|Ao#OW>*LGO$f-0mDz*2j6h(Vk1r$+P^kG3vQDVD9qLP(CdJrp2F= zI58J$)#Xy}Z*2&q?}KcEUC|#B=A4T$UA7}PwIJ!*t$sGZAO{em!zc}0{yUchD?__Y z&5mMAmkDP*8FE9;m9&8!EjbCZd7P+3SC_5>nY$6?weJ*vS=sChig`?Ga`@8T_fuh| zT*p?f6rm>@&Z*GXqEW{3!XGdSb`D7wxEb^U@mfvFWb8vZ`=8da;t8czMEDVqhTG$? zmN#@wdfk34>)COKUO6jUp6JLq7SKM7NPLdcZRKeKELS0glOF6r--UTI46ZjP;+&sE zK`2?ox`vkMql_h&A>1-%0R@guwOufk_Tz!U))0!mkcrLeG4w;6V>Z@Pk4oD$%=!2(ND zBy@2)>{Rv6q3Y!c2tV}Zg^F8Md@U`#RJ)p8ut#?ai_ofibE!vFf|~%RP>Og8*fxgF zbSTPTY-HJad>z-TJr8nmB`&liW~v?V9^LE6Bph}UQdM2D2-LxRAYj96y-W+#qC?vp zSOxshMJCHwM`KPDS$^-?SO#fr%=X}_K-0!xj^_3H4h+*0h^?zEJcp>c{|V`WIiqM0 zw#kK1Wvqyc9S&`w*q07bn6)GQ9MA9VqIn$W-_GK?6+@RhjVo1Q5W4GD^p5J*(J}_u zQyn%C3oAma;~i}3Gyo9Fcwfa`#Y!#!XRP|RupvZ2h=!o#*>9L)qG|wWJg6(gsH#oc z1$un6Sxe%J@v3*&JR@TO;|;HzDqj^CPDF%ZEwOcY&L(vdIC_oElnu_%K~ieOjux3{ z0=5WKxTsE%rTIkb*jr&F#jwg}UUkpA^;LsxD97jKqS%Ycy5LVCUl`B@MNJm8tkNzN zUEQ$OjWbjh7{DBx6jgs~ytHrI4;->#*EaS)SoE ze^6H2+^W#-mnh;~a#x5--%{%4CKJ;Y@^Crl#jx^(dKTA*ecC1rrM43c$XB_r^&gctdpU$2*FaRdiGS$ewZxUbW#@wlK=yRjuID1XZ5>l-zd102xmU##^^AZU+h(- zu~>!DK;-Ko`jGqr%4pdfFyku*!10d?Hq-EKdoJu7L7Sqes45r;TSL3;z?BVD*&LV+ zXY_M`C@gvfPNEbC`e3PW=S~5gyJJ_IP4nT(FiIyb_Nfqou)!VX?!fQwB4>wlLp9(8 zRD7LueHT<_p)M6pDUwG)7l0_w=w37s)J0T_I5x zduFXNpTtu}p8#jx(-DvBUQ;pMmCn>5NnU)c&z&B@tU5|>p&YSwp|s*HMQ=Ghib8PR zNG450Is`Qe!F{_Ti26O-kR)s(k`;yJ{T%>htxRc-quyoLFu92+6`m#XAY=ij@6J1~ z2wwpE#=XbePrfaeUiq5^RN%ZmPafs~uXC&uyuwXDhQ55po z!0t0lXDAINHqoW*g)e5IX!db&=c1XGQDddzp2}2`FnYtG%|bY&DLvk~Fy;;+g!xwt zFMh6PiY`try?a6QdB%KzR)I~QtE}*;SNC`BD@-L=bbQh z(3HqaN40icx3|aDLc0(JqVCfA1d$RLQ$qOqeJZP9)xlCnx0fledTFQg0}dhFAv|o3 ziCTEPE4C;Qn9eaKvpLl7qQ~=Es857QhsDr%)X#T(7JEVxGUp@2UdZBTqXTk(udP*m zXplE6UAEu&P;qYN7YK83=^~&9 znwUduCG!cKiXrH(ni{4!Q-64~L4kGTi>Epn zCwN;r5p)xyK1Qml@?8i?5h*eZr0Om)5rK`+Vyq$(4LiHffzD8c5r?82F`Gy+vU1!B zJ<*ssUyz3Q4E>oam%Zr%ntUc2)kQDNTbr!C>Yu~C=wRe&&YZGHxkXZMFY>jKra9{v zlNper0TNBX$(b;pMKZB>LV37H-+aTloVirUaSWrrLg7E&EgO#)!Xx7~p%xRBc(Ve| zcE8ofSJP>nHRfUd9?@_+X(2{g7 z^F8#I*9&8w=J3y#s^}~HHxTyoKo%zsy-?Z@M^&i9D6g5(FJ4S%s1!wasM1b3z+7a0 z{VLBAHGOMwXER5+iNIF?DQ>i6X&Z2UqD7gQ-mpm7a z=vKKLVJJTqQY+80X`v48s+-idANA>1Z*p(gFqts;!z^1sYMSCYj?@nTnjn!WJ(1>T z6i5d<+5n;FqbGRF@z9gmjewxjg&P8mVG&Z6uG`Ly8;A?}@48s!xr;XIno~6ZPe8E0 z?cz#9zcZ66Rz+p24+D%9n|}7bOHaSM)M+ahn=~*d5I!{sq$6G@&e90ROw9C(1h}~3 zhPFaeJ2mG)&;8f5NaOfxR=&j99RhtYV#p3HQBgWb@ zrZ;_cWbQy2b%JC+cf4K#;w)75@m;*@EuBp!flTM5DSq{Nqqa#Md5>Yz>7sCsvmqP` zqVE+c7i&Vr!Kyh%mEPv6>>YGAC6d8HhdjlXdNZ94oiTPCf9Bu317a6Vi!m}chGWqR z2fbrc(YuQ#&*`=~e8#{dA|1$x43CrhF2fZq$Go_kHJv+iwranuV?u74)^V^AmU zX>?M(CKxClA&q~AVvojMucstt6FbHn4CJR?oVKS=d+4$F2&K=ugzdJv4e2g4Bwu7} zcP?NU!w(&XLr0~O7AtW-zSrlxt5tD_ncP9o0j_fw-4vOr(w?xpWh`W4yA3JSs}`Va zkg*@#*?->-ftyQ#-TbKuj>NCZ8V?SaQn?6(j-iTrRzX(pFc~t;XGPrD3oE}5Aao6z zuDsC&=!Kz}yPmqsSx1mBjdh>+L&O!LS3@56TswRT-~`GkxPAnl`E~! zmLt96H9Zki_|+a2a0fY}TN3wY?3)5j=}8keDYVwjP)Au6qLI5zB_7=K-dQK2etvHl zL!NKhbD-MX>+xThe4Acm?&#c=R=GMEs-h@Lf+LO7EINCTP~lZf*lm`t_vhuf8Tt?R zmEL5htN+fiS$C!(Qw0=51$R9lc3~W|kP4{ET}5kP%XK+}2H$yM!=vF4>u@R#st67x zi(6No`7n)55v0}t!wZl4SPc>dG%KA~CpT4jdqH01Pti&A#J4U#r{<4~?=98l%FR-k zYiYO2+7+3LY^3Ar;flidI$A|dDNF^SN}zLvFFYR$XQRyWPCWhC=lWIdgWqNMZVvR^Rt}PT!52?kEofTc___ z^*&vP=1x|2_T8XXN=ZUb=;k<|%j*BNV34 zgkB*s9a`B4hSrvLHTY=_vVr=~L##^AkhK%sMrpdv)`^3(V%H-L(NLCoQlNH~Y9M+- zI-=rT>B8;>Muq13L8?0}3=U|tTq4B9c%8g-QwKe9O9c_l-B>Fw>UdQ-Y^soST9+xB zIL;suu1FAvDvH9oph#H*fs|yoI>627Q0Z>O!Rn2?LNpYMHLgHTRA7sBwRVRsIIh{= z)z+>ZryGZQDMH?FZcUo!EtBRdau&l`GTH5-)z$h^rKBCYp^_69sp>=!R=X=+|QXWVU7?y@1Jas?}?&e*|p>o`muYmCBMtsGjuAgTe5Q=(U| zc5a|#gcs1|0G+xaoM5JREiiOah9|YK$W*{hlhAV{@`0;tX?If`ev^0MVD-dT8RfL= z&|d%WMXjQ6QU_{BHMLs5&cN&BH+tJzS-dg2P!Zygblwi407n$m>F9)yj-N)i(AT>( zOcVJ9J+FbyXeOb0>+{B3xb>X+7@l=4M!G23CCtqYU+x!x{1G6xCiRwH)?C zLP`x~>IYu5>ixE;O_ZUJ)*T!W zct$@cI$&|&EuDcjMuG=*$=)GuUVK!e&zN5(;^%~~KEK`#YDq^*B9|I8$D zrc0>8*6e8JE-h3E=7122@f~^)WqxMq+7W8L1ZvJU{fdhvn;5@qS z-xq7yzkxB?Hhbl}htid+myTAg<^ha3jOKVRzW&p&<1Cg_hzsp{(RRaOI_z>7LX9n{ zcSiw@Qb3w$9b@f;dr%6CSrj*1B!{9d%D$)Z9XKP@%?YN}m9N|OhAB!7T_%2(_9Hoo zBBl84T{A(^5OMKX(EBQfpK+iWcUlo%b=l<|;arg=OpWwDWK0HWeQe#q@}(ek37qBk zsCZXuO#X&P|m>`Yr zLI-)5la2#E78gpoTo%IUQLTEp&-S{yduy5vyM(%`O$9(RUvvuPz-N8?FrEG+PHV@$jmM@X++y?PkA)8N^ThI$7#ZR-uzLsYS7#%`v&= zwwLoczOJXLMc}}JJLGn4_Ikpob5kTk+k{g+&j>wX*9)uu_ad|@o-=W)!BsK~Kvg>Z zq1ExU$tcEkoAS#s%!gNen#xcPSrz9Bi_6*Vs>E_AKsYIJMH^NqQuB^Avb2w$=*!q& z$xDU>19B)T~XQYYoUe;reEDVW+m zT8-$)vLW zi2`v&bwWHPMbV+vTC`n9Aj$gvxfCbP3&7v26-n^uW7QSRZmkna$P-eNG;S#oqA-^f zh2F(@g%}a=G}V=jp%{9+)tQ8Ip(Z`;>+Il3gXCCLuzr@hw)*orN5e&IM_-OKKorNX z9JSlKUvcWnD*MblI}JqX3W})h|9BxN0~QZAbNH-IJSVEOHa_OPz<0EVx&XS<)#TW? zi??h5?DF2xl=%8xECS6^=&^SAWXxlxUT1Rs9TjP-QFGD&+Wg5 zp`hmuUHbfbw^nIs742FHd3g7+C&a^iDzKqSVz{I|Ez#lH4eZa!_k4}s-XFf&$A9g* zV?#UD*>#vAGDg_8i|3|;UTJz91=&T@ow`A3cKZ3=z3<)ST*u+qC@k;a(5H$ZrWzRD zFsch}5y~D~t+NaY`tMxP4oz2IvvA5Cz-le83oa&?p=#%?45h@`gp2@PrjBbXvKzRT zgA-CStGTjTRh1Psu3`}1B~pqNefQw1Ufduz-Tk4!S+UU{>^i*sb^4~Ac|ZkWY6U&T zcn8Y7a~;#mbO>v7Zw-!t>&A5#zg~KbU1fXxM8$*UX#g6|D?hI;u7mHe1rnz1JIjT| zXlP7Es?J=d>*ZvOK$>R8AqP{&`gKGSw?j$)9PI<)O-qh7e;_{)2-U`656Y5vm;=Z4 zdlV{)ng-~6aBR+uegUXl_Bwgc&Z1%LQJ-HZh+_WpUQ8>fu5jx4u#-$4DRD)1E<$RE zPFS>%Nj#dTPRhjEa)EL{Ju>~M3s} z5n5QLUE(wZe}zV;%_g#z#eNzZ|BGw#l3LXVG;+=~5k zra(m1nB1k9@-}f$g{pV1xs<$#n>N5W zArzQ$NR&(Bx$(rlK0-Di=}eH((lIs)AyCwYKwa0+2}F5C-rJrYr|}$;evBBdd;ik? z;9V^5kZMPV74s)%x0e5f@mRVDG z2%YYyv&q-dgs_J~9@B&9n!1;?rcG2g1zBwAgSe`)5q`E>@x+jZIrR{5CLg&g^aYH9 zCT~&KhMwy2#k*pqpkau4gO>xx^M?I79>^C@a>HT|p0K^9qDtschFW#9z`Yy_mi^Sh z{F%GQfTMl@A7s-Tl=2zJ$rF`3u}d|rXaFsh&{3?6(5bzCbo*D4xDqcyu9qAxfKV`vUwPx1OtX{+wNWOheX{HvNGa$wh^}1G6A+7#%aX-k- zFzUlfWSfs=Hpa`cUrwrvLCKa@u$BJ&D&rtm*-DKs#A5QGnFCw2vfED)94S|oOAc|^ zn~ewUP_;s#&EnGv&eZJqnMAZBhhATLlixu^c6TdB(pEfJ-Ow`UI*%eE6`$2sxsRp| zzUw1@-uY3>3o?c$_lxtPK#w$6e^a-+l;zM5_MvM;C;2LbL(32QMs~3NHtH12?pS2<~TGbNt72!0dbNr73`mP;S zpLwkCI|U`cbTMb|?1&l+qj-32&TzImR)=yCR7Uou)>?qo61ecKRGc*j%ijzIuigp% zz3;QIuLc*hb+22jG*B2!ccGAqQZcXJ>xQ%_OV55mX!_Ifdg=g$K?oEwRUq65L(jPm zf&-kdKaUF4x*-zwz^eP68$@VTr6YV$l0wED<>ZPH7LMO5?sbA>={iX{db@*XXBwic z(J&}Noy?Mo;uR9F#hXVXBqwgZ6D<;>ETc1Wu}{Zbn^FpWhFkwIm;KHpu8Is5LKMx< z#uq#cH>U28K!);PStqO%k`D1ReIZzj#*3;5bslsycreekyK%QD)ua;jMO1Sa9jt@K z=j7R9C(zg@oH;R!x;S$+>XH$oAR6`X>Mku(@!Ku{=Y0@i$B_`$R~%-+Xl^V-ENK}@ zX;5iIzxA`Co?=eDa(jI)HiV<1GHBrdZ@U8o;mnPC5h)T9Wnv>F65%Fb#*T`+7}DZ0 z7+OET_MTw)VoF%F6&kisjuYK|M;!IIVlAq=)w7D7bwN4(GilLoLn4uVM%FW{TlFG( zUPpy;_xbR(L!Ep^@;YT3XL9+CS_(-ez)m_r>Jm`05d;ZdvUWMWFb}Zz0v3>WIB$UD<}upog0L4%6Cyts{3xg z-;F)6Ef<~2Dn0~)L5sq!>3{)7E=_kolhCIMQLur|i;Xa23+HafE*YT>wjt(s!*F(GVT%hAh3~9_nzb75 zpHqhMzrXre`eBuEn9QLww>=fF8p`6zk=!F8~K| z-7rE+C%jbMtl*L1gtfYBla0r%0Gwg>Or_=jTZ<9K98ui-CnDrn?MkI-PQL&AE|64i zgZ&*rj3MjdYo3i%^xt})YpYpxHmNgLJF=#qCxp74Z`T6cJA`4WPLO}m7&|T3#<8~4 z8PQG3T;UWOgyalOx=zHP6bS_}gDzM`*x zbEg%ptE!i`cF0pADRsbVLzEiK(hqrr4m0wKWo7));ppY_qQl@f_`L8*I*~4l>53bR zTg^CPsHSxXkL#x1Yzov(n|R|T%bt{ntnT<~c#7&OmxEQ-ZHO!cbJnxjAx%(=EPUKi2|i?XE`Jx5I{8Ku-jPI z5UN7Ap-@m_{E!Wy3@>_a`V_`IvE{pY9cMciV2xH|gx0$3)-3y7L%mkh@1R0@45}r) zWSEL(ZJMLUhJBQEMa5`QlT0Anv-G2yj=au|V38hn5bHahzkw z#o=dCnfS8o!F_BthIt4k5^?p7KEg`8$jtk4*KTvCLlAtgxUCR0-40A8pHUP{+6@_+ zQy1R^iAIN%fCN8Ej{??$Cx#AS*CADC&fBQ!1ENEx>i48IQl~=zTWI*gG$drKEq!y^ zoA%LJCnGx7+3yb*al9&;)p~Zq(Fmy-X%h>vDb&@Wx1tM>bXi6r*6uzwG*Exe?p-#7 zltX96{iUnTvyk3lFPLJ(VQWfNCY}!OFQaA|nW=?SA1Osl<9WVJG;4q~jp;}*7Y-p=VLW5FkC!cbu z5l5I)4|t)h6my3r-R`!wzab#?by7epN!6j(1$*AcRdcB^bZy?>+kcKT@RHf=3mjUr z2KuyxI&2_AT>8bWFT~rQPMoK>O#I!oz==Da9JXi(LO`6@bmg^MjuWxeVdu=XfGmu$ z2gf5-{p_sma$W&Dm$-wD7t?ls&>oK6OQfQKzIf5p(SdB$ zBBGvo9*X7w*Xs*gn^bY*zY-d0z)TguIp(2f1vrGJq7eO_^PYnn+Ru=t7^ZWUhwi$*D8-9)(R8OmuNJSxLGFxbVK48| zF1ierG$#=rr9W7xgCu?w-w3&bUl(#ys3XtzV>KT#St@cKA0gIT0c*Jm#FXkC5?03m zm#Y!HW4%&Z&USr6?k+m)On(5k=cEE=dZgKPi;0 z!e<0$KlZBU)t&G&(q(xj6Jh0`&y2*)-Q}P`iW=fo#gG{-vc)o#MRi6|l(Cj-JUHk& z*2ro4gm>&71o*w+OoSZAm1Hm7|pA(X@iOhi2&a zRWH+hrQR=Ficw6Z?&ijpxxWYP1U8LnG0_~|$fS%xm60lK_Z)@OU8o`>u<-@ZI+Djw zzUzwSa5P54i49xsDr%>!6O7)E_`MAj&Q*g8ulV5UNde+Guj7SL76p0%@q-z zrm6p|J6M@2a^jE6!A${cdB?5Z$#htmg_5aNf#TH4!9vwJ-#=r9paAO6uBvv1_vcr| z3gif-cq66=)_(kl-erm&&7xB!D(e?;^dgY%5JYHu(>e?NkVCPKigl!D?!H}P60OMZ z{H;R@j1~wkyFOx<3!;m|UeM9zF;JWbC#gS7O_)1>>xIdNW@Ov+2t7eU)1|7Sk^*7E zse2-t8zYDF8||Hu-GnWpIy$IqYCvcq`{Ka!;?W1SSZ zUf8wM)evK~m@IC33xC=-Z-uASh+Twsv0`*rNA>=?floUCP!1M`vGH^lR@um$*7DHR z({r&s*vE03FrDx6cgxSCPz_IoxVHMb$!tk%#4)iC-o$4UZ34BpB;(H(-M;(e<|?j z?}55@8)b?Kx$KwstzaiM6tF(8)hMDy2r|O7CIh;{MCu#3He7{{i)jQNoyOx80YH6W zY>7#S60-jiZaJni4t6lkYD}HQYzTzHEh)#W*~&JF{#Y+PeUQv>CJo=GxuN|y6$FgD z^7S76IyNCT5c3jO39Y8BqhX}N@hrf<{5|J5i2~I+1uQox2rL&zI`QVNIPKls%H4J6 zJXcgZcz=3_u3nxx^?m@YkZ+}1_FemA--`PT0vKn|`*m)MUDtuSLw&X+ua}HMeY88F zu+wh#ywQtcNne?HWLNyHHgodJd5wXq-$ZK=*>aXWxeb}<>N}bYkQD6@J-`fg?5_&`C{YvbSbO&zE`9?lsGO}D z3@W?H9O%*?q!R?vKveqDVjKBEIP(?-!PEtP^@7(k#0r|%%Ge$%5z$R)x>!=r?9&Lc zxJVGzVqgxR@JL7Y4%e4K=3JHMJX5#f;xd=M6o@LM(eI~!ZVfkcgy2;n)H})k_ikv% z1|3<=OVqyu1k94Clc7*<2gUsXfSpEQ#Ykg`ch1jQN5}F3MG?jSgzom(Ior$v)bTz_ z#HG@Z-7!tiZUf!8MHTh#pLP0=GI)#@s#P8+-3mDeV}&_S_D$F5rOzpgq6?w(xTHc~ zU4ci@4NuOT2u6tY9o6AC(3_L!{j(UfIozl{-g-qgIj^54-o?rQduI}Z<~*Y3#K(Dn=6t8~@7 zp+$ETgiqll#-Z4BBY)x@qXcj5VrXU1QHQlN^`T8r6q4XmXjzIi42OM(JhM}$=iYN?JH@&*l3)jD7xPKGFS7K3e{9dnXKp3lJp1dx>h^)B&1vu2BU9izqm@| zGIf=g#ZwX0tG;jk=|B`ssoW%N9j&K3VvCsMwL){4AynF9t?e)*QD5{k3~vst*cDmShl+d`oDY4Y3(=yhqmfrSW<|NKlwC%nI*O{tPSMamZRF;k z@4DA}gW(GHtcmc#H`P#b)1a?(Na-)TwjI( z9gAwcyb_$9l9BWW)M;!qUnr-nNtZd%sn5wx{b8)%L3{Hv$F4(9H)yvyVZ>oaRye*` z8?i|mh+7GqxanSx!$752&2g6y_NVIEuPe3ZJ=CR>XVuRf`r2EPtd3#2d#h_o^Y+pH zeKt)xeAhE1Jr%i|ZqvHaZQyu1j2wUKqrZZct5%ZwDtrc*%m**H|p%O}!Kt=X5Lql!Ij4x8WS{Ut7k zN|QpA)k7>Yhi0m&pt#7-e9&ABXqYo%-Ui+ShDGi5p;k1=m;WeljZ%UyOHF2RXD;b2~)=`e*3 zlTI)V!{>X^FvjU=4#MWiWJ&D-C47#>{A@!9#Xzsx>N9jpmK5$kxB7PFwd zN5}u}ghVWdq~_%8{3|xxS$VUFu#gk2P)c1c+N`8M&ogl3#`Fjo=0lqs zJ~P4<%`+f7;?>w+lZSxtP(9~&04Vg}?B$>)EatI2-QmoI*e(VX$d`XRkZg_$42?k3 z)xrD>ho(%nvue7f3SXyjQV4plcT658M#~*pT~7V`QpM}ed%-ba3N@G}t~4Sz75UL( zbO*Dqm`1C+Epp$+RSy8`Xo%#74!JKH-O9dpvduM46!aYSv5DYb?gnGeMSN^)IGU05*iY9E*K;SMeogJuqwmYS$V z$5AwhDwQFjMM@6vVNhOmXv>v3Meze$dU4B{ugPrH1G_5WVG5DC>zzFsN?KsMI8{)` zWG=!^e~{s3>Bq=jGh*pQYvrIpNNCrO2&#?gFE#BM&^v2aylKm9*g^<^5$00RPmA3$ z`ree|eC=X@y?{C)Tg}F%bE_K=Wlpt!x7DA%Be8B$fN?6#@aG!Kb%h2y_*pwuaUtq+ zq8Qq=xNQhmS4hORHX&PgROtXX6`&K$u2N)oR13uK^L`_1fwL1K>I+?n&aLw$m%>pr z##`eun4&L#?u+#qC&er`+lTB!JyK3=P4-xtdK7>ERvUvdkAN=x(qAQEX8_VciGax#1no ziw=3I+4KyR8a9ek1^?D7@;<-sc=dU#P;^XEiL6l=`Fo7sMZx-+-$z2vBr-0G8{7s| z$~BcmU7L~GBrGIl(XPBS{Ds65bR5Eu%DU&+i{9$>QJnyfAA@l{tWdG`(V0d|Yaz}u zIm8m;lU4pb(>@iI=xCBe`a*EG$b2g@54b)Uxx4kN)_`cBAQ8xH#NW z*lQHe6?4-ip^=_$nAHz^1-Wxrr>SU07u)42j{d!M4%QJH>-IL148IqIv-dtXluw46 zn{BS0n2ONCyO^7xWgmn08h;9Vce?2=3>4qAo;;P4FKveQk8o7Z#`!NqV-wxSz>B`a z+yOQ43&ZGX_-2ew)TsA;F9tC-G?y8onKP$7T&KET#dn}Alq&WbrUuwA#2JQGnbHxv zS@Csbs(D~Xl+i+3>SOYh4uP~N(FRc0gSSG>V?%82gcEPsEAu>B$Kl}AZhpsx)e*80 z+U!Sl60nEe@ZJ7ZF-_ks5_UF#VT`+SLd z`N9_QT@r<%PJk&uAug7OP`Nae1jIV+qRZOll5X!*=)C5hWX}qxz(*N<%o-9QfJKNq zu6!nGn+)NlvGWMoIDf9s9-XSaa1hmX$SHI8Bn_WqMyp7Lf(%tu9+#*;PeS?>yb?KA zS%#PF@b;mBsN;FZ|JglH@jO~$6p~$QR+Ua;Vw6OS>L8Kw*Hw4yL{8KrGvm6MFV`UQ-mAcy3?E#2OrXvQcN?RGvc%fOhL}fZ4m)~ojOD=@d z`fi7n^NDxRC4|UmfzYt5|&pYUS-|0p2TA8&b zS{SWtgZ+2a;YC`Jk48yo>MTM|Lx2LFMlr-Hk?DXfjI!@W2n4B%?CNK~qA1=KC@ls&3Som%)%dpcKePm`D-BKYw zXH@P;4tw=7%X#AN@}8)c-bu&+jqQI*!Nx)dq3bhtNR&DhnxBKDpL+MNFEW-nZwSRsf*I-Tu;+x~mf* z%%wFe=0)WNb*c5>2(J+3{k-Nfx`&N$NKO%S1@9Vcqj|Dg{no-R3ZFGy;0glAmVfG& z%we9J@B@%cs^&X;Q8wvCb{Pd4qH_pO<*JiQU_+TaXIh{8*>OaOPEq z@eYgY-W+Xf1@b=YT(7&>9A1hNRZR(QW#; za5CpBbn&%73^&h7chuh1GrL)$P)t!01Vf^Ks{5|yR^0?DENZDonOO>0*Xi$y(e%U#Zq0ON=Rhl zQ;p4P>L^AEunR@I0aevCWN(UDVAjKRrTJvL=~0ZjHJ|(dzgyZ9n0{6iB2! zGZsBfaC4us^a?(2VmBp~5ix{z8_l2N(kmhQi^6PjU!jXmT&Cyk>_MyF0EH^~P-)ls zO6_Q<;qb0ThUfx1tpRvL7Bw1HMKyZ-61Sm4EiBS5jh<`7;tTE<)oSE1je0d|$C{#W zfG16*jXnn13pvJ_QNrW-&xhFlvvC}E+0=!Li zK+`3Z!dho86%vu~A+v1yk&CaGCk~=>n@(J`Dn4uCQ|_M7l$pMu=#iAF+Nq+%Hd{^V zg@S5JN+VQKn@W3=_ZNiQs9sH6QyUTniRkOGD!Qi%p0@ky$y69Pzx)omuekAHaH?im zguz@g(F&gwQLLN`$tI5JO6Zw3>RqAZ>AZPNEtqnle4LJw_r4xX*j+HHn1w&cRuHDm z;j0UM)meC9m!9x|uw&JieO-eREtAyG@@{1J=hH*8`{0TWMpKHrL_b352b6=JK$_t9 z{xLNoP)kFvtfEdp8IHNx!_fDWvlIz2aj zU-d6=W&JFy+J*zI=uTiE7b3^YI7Xw8J`e9M^nS>!K_e@lPt_qKjNiK7xC#x*FC#44 zG8@fAax&wVatg~0t|FkFUpO};={$xf;OTNPcH^vx1MO=`8=vTjguHL(kgOc)<2ikK z@oogJ>hObnrW`JP1K%5efhNdg=Bgn>B$Z~z!`$6;tEPndIsEqENHcDSfy&%XG`Qld z^ZLp?vp)k*31e8h^^&Y-i?<8rc!o@OQ`1VwCMr*89A5hnL2A29ml?sV6kSEa`v|g{ zf`A;;%cxSO~o$R^DF9BG-Mwv3G0~#WZP^bN6S32*cb`%(QFHLiXZo!fi^WwVj zK;pgE`D}zA8B*L`WO^?MvI{;y|8EsNPhu{Zq_4X9NiPM%Viu!KJ5@y z`-O$V%pMk#FZ^}FCwKT$msSz8DLcMedgrz1MXrU}l3owkG%Zm=h$=)|vrLqN5hYSO zEWO0hIzx^9!6Fx}C@U&_+qkjPz5PxA)|ASrfOq5Cnrd7v!S`0i9{ud71Z=0DEr!oG zoAyuL>=brZ?+Yn~;uljJ0ej|i9RpNwWLEPY&^Bz5w#LnkDkIKks((*32+)BNB)zC7m z#b@34y83pVWQSMPi6)eAl#muqibyQr?5`ghb(TbEjSE83xon+Pdf1~!m0<>$Gsp~|O2@x#eD zCU^YPc-}sTL|-=DQ^ie~i2X?K^PrlCuIvxH(^+`kc4C`wz`O>H^E1@*ALd1~40O zy)ZHIRWvy^6?(yhuDQ$SU09mk?v_DuO z_#35I)*KkcqDQSvq6#b+JLfDZsuQCo6n4XRhmW3aXyYZ&og`DG&*lvP#K=X}IoM;& z#3_r1B7l`E>(8L`*E6hDpIvf#lZGl44poZWtDw^qnt<4N)eF3Ip$B$rJ`;rzi7U1a z1Cqm3s3S{^{O)@f$C#Zt1(iY-AT^JbN$A`{rmjZfFixgA7Rcu;(r5=7h~li#$Rf?Y z2@?`@?evdeP~WZl&M|Ybdao=O=yC?EIUGL3=4=9@^Qt&eV6%tg9D-J_$S0%ZDD1~e zYr&`}p+23(b{YF;p$cq2vZtqpuFpk#xXfCGC0Gv88n+d(UG0gxmx{j=ymRewCtiAp z1I+&xaCPD`b(eC?&7K(*93bAPm-^7H$yBaM0otpye&*NE2<-~kLuPiOHFb$je+SLa zdQwuaw9R$XI4fZtzT-B_%CjjY`~JJ?14o!?R98ZVdEOKwohN^X=<0MNbHDgwnRQp4 zgLK%F2M$I)SqJI}^n+2>W{vZ8MnH^RcKS-+=oCLe5sB=KUM#sV8$YI61-PkUf$CB< zz2Tu~@31&S+P;|W`w=H8f?Wd@Lq@$1ORA!_7MJ4BqHqdb_!W!jXBkCo+;Uj1jwO$vWiN@W zhOJ45(PN~8$8>PHBIl-KEwlynd(nq#4G%gJ`@rcyJ`Ryp&{{`8Jp>=-pkZ-qgDg<8 z5GPD5tT;V^7*?Uo=mcd0o#F{<5tDZwdf@Y3na+1md zU7h3HMIDvjoLujw(Hzr78Nc-2o$icCdUxE%wO9@(q<_~{$P_3Ag?LUGv=ll7s>Amx zbH|3w`(OoZe*d~psJtEOZ+&oJkb=||x)zJA@Km5_XU4TZ ztcFQ|r)zZKTmSDI=T7Mpe>P;RzsHp#w4=4`Fg47dJx1|dfiEEZsQCpB*+FrV0LQw9OI z`_GB2w$~{t4Z%64)|e7iL0nS5r!F7*kd(9GXOWaC3=Kn*65GX-bva?)3k;2*+!eVL zV>u*e-4A3h9M{GoQxUu8v-`ddA~+P? z>A23nR)x?Ox@APqhoGQT>MH+w3BeJjJhgh$2USl#)KZzT9^?%Ww5}YH8kjxQ~y)b6i_aQ5Ep|#{HtZR z_r>rz_Nx%qx{8kQ{<=5RrL1_@36-lC)6@)cOGUY2wVH-a-SQ0kPnwm^3kyjs6ll!jgiS!s((d51tHJi^gL>x=j_`!+;O0&zXY-kXCK`Gzy76PhOQhQThAI{$r!uIdPe54*Xd9W*95YsklJuUSqC zOd&BHvacTgSy?@A)MNG+11H!a_rpS2c!ish#!5RJwNZ^073MMv5|Wg{DqsX5I-U?4 zazGw<1~v{;X&VtGcj$vzi{e1fYewuh)*{)_WE5X#UkulUiPMx-$O1$byX!k>!C6A6 zTjb|7on0TT+ZhN&fvOiszrfeYl!+?LY;S<3z2p-n99pmqIcBZTz%s+nhLOsuDH7SgSgDe6BXfM@mniu1>5=u>I8@C@aN(B);1TUSx$OR*u^bk zxX`$XlSF|;GwL#l*}Bu7?qa*DxsKHIv_tDc#(pU1(Uw6yjh%5$%pDf?Ip?yNO7rsN zfEgiP(-o)Z(MM}xFNzq@h6r!SpjCE#fYjprq~j>M>?oBwLS2<}+8Md7^4O^lqu2y>|Dc zrt1LLbyGAfyzOB%Z8p@Zr65}oR4mjP#9h_t!ID2#Lg91+c{D7Da{+w2^VE&qXAhd| zXSvLscx<{7j%}k0$-GyXV*mZpQUZ5Rgsqqwx;Q# zE3is&CT8*V_pY5Ca+AY_1VJx=`}2Uggik~PH)ON#qdYA^1HZ#6-@WrE?3&M)nZJCq zUjt;5b2K6|8mWsTAC{IgMxvOIP17;Pc+OH~6;*|yj%I|dpL>dG>T5msfC4!uY8F6c z(N>YcYU;uJ_}(bpyK4B=W#@SH9E{TykGT+V*~?xK16lp);$xbNt*TT9D{H={hA5p4 zl7QUkVSF60cRCz+T9$t=(Sl-|Sv#~^*y(8i7N}aleyCaUYqz(2S0YY@K-#qdbHJWS zanw-aie>@xIG3}^)hJy#WCiyLX=kb-)8t4w!qaZNDr|w`4#lkar!Dx?854ROSW%ai z@9$B~Q+Fl4H^ujr$)jDrFwzT*@%dRA0PegCiPo*If_>jp6h!@~SR-t)&0SC;T+h0# zmnDTgZ|&~)_Q|wOO>Rh##&&xq$M6ohqv+=6GwY%jid9nBKBOq%fA)&5Tyk{b>f9tY z2%rx=o|&zV$?2BRK*5_2^kOUD}ymu!t8c zU$$xkdIuOCHdH7IF~Zao?`wtB*ARW0@)9LQTZ7ln zV<~_nj^Qr1S!}f8cVB1I6@SVCRq%vet%hnMdV1FM&@?m-M@k>vu?^7Rb8@YToC3^IG zVYVvo>*9KOnnEU29{sFmp`iN|!qg{ErZpP^b#VqhC2+0vn2OE`m_v_!gtW~u( z1zOeDN-%>YQu5&x>*?>oKDB(ClX?PDPxOieu)f?xJ^F&HyR;`hdFpv8ZxXO64>P%UiuV zeeYUiXYC9k3sOtx#3@Y7I3kjb?rRC3_ZLuX{6qTLs3){KJ($0vA0eYeg3>c1 zDD+aiteQDb+wC(HoKrpjJ4&L*fFQZvl-N~@2{c+l&9#;eh&4)78QyfbdTy57I3{dW z$z;q^FCPut>!dB!x$0S1Cp?tgQKhxgpQP<6h!lF>OrhzI=l;>!(wzm`| zjL1_5aV-ESE6c4P|=50gfuOEA5g++1z>KRE|j(NZE_Px$)&Lz7Mg>(%$)s0@wxJC{9=v**pQo=02#K_v~^C z!WNvfmwm)ufYrAhz*_@2`8PmvV-SdgD}KF7yl0AZ<@Z(HuZj-Jy&63Avo!0kspVTopj}U841HEh=@?f`k@so{b~8;p=v3W>qn)7E2L%Ey66t zYbkN$+DVgLC{#PMnX9gdOxVte^vc!xdC#CE?eatI*kLv+3{6%48Co~M5+z*=hw3XZ zJ5R#U8TvCepMHc1HgX59@|`f3F0^lbrlj2H*<2{;&w!YxXu=n4j8V%{VPv*A@W}=? zYkRb)w$I+{Ih?vPYi&3%jbzp{T+GUk>vVU19-r`- zP^jOVR-{;)*2AN~o7nA(Qk+6h8;a4!gEg`j(CB3Sd+Rysrnx!|9!W&4D2VzwF6qTU z1&h@G&CsJY5jDGbs@Pq1z8>b+aYOln=sM22@madcdQtBo{ZUW^M4n$~JE$}4f}wjW zPFXE=s~^@rqXA~lKFXwr%Pfxs{dv#$-Rvym49(=7z4W>{xK)lYHyi&sb)xhvm<)xA z)=}CB<2LH0-M-w#Npk2)qai+h|6<$WdfI^vby(d8bD@U0$Qug;^>=oiS6J1*(}L_r zydW-}rO0k#XNOWE`LyeK^oTmW(~V?Q&PCnRRSTq3N^j3bJkOror?X8~w5U>->l70g zbReU`?p;6>-Vlj;)B0ibi5ti>OO0Wxz@?0kC|?KU>*SP!Kmc$OjkZC0b}x(UD$w0GnCjWid>G zNuJ`MoZdlo1stA_|BP7}#b*4sZk*XfgfUyLmd}MrOw-|9<*3MH29tkB^^v$kW6DSn zxroxL=0xzEW=zR;x19JsRdD;mP969fN`#;Trdjfi5cSyFe#zJOf8*^9tx{q3c3B9W z2*+pQ1)2N8;|ztkX2v@aog3FhIcv_CMyYVK=$f15yQ|Cfc1BadPTr`f$JbU^x*{iR zqDfnLw+R3YlR`=a&AjG$hSqfmi>6d|P_264xND+hR2t(TQKF#w&DdROl(K%|AB4HX4(K+qFG*W_eq$%@? zKtB{Fi`=9aV7}m5uD0~%U#oXlEU0E76mCsw&IAR0bYe23`v z)afEIu3{D*9osxeuCKo%t%EttpehGHP$rnUN*8~vg-(OO7Y9Y*3iocNr3w*|t~p$4 z+GjwSQQa%iPiTI&L1nR_9$J$CLz5U}$odwr6l4&FV0q-wHzk~-tfeMH(Ik`jEF{%5 zA$GMmm!d-z0%g#yKKZlf%JaTZISQ(YjE2DW6id^4)&%aqh6= ztlgoXlUH!PJS3Cu=mqZ@VjXdO4m(@qJf0S2Q&DDE zth`qjXbE(yC6962c~59kPaShK+fL!EPz*MI|8}93i(BPDxFD^g*w5ol>(s&e`?ET{ z##7f0*c*8DDGu+VsEW^qGz|?@4F&7LVVkb8J>$4_*IK-ZPQgN5qAc`+7Lrvlsn(s) zAPAGlkd_u)CuaZ`s->WKfieOEiao^`M?rdhkWieO+6jp;+={$%U#Y^8(?ppla@u)S z1oM|+_&&Xi-T^{ZTMo+Xe+KFB%l`N^LpeGWYON3{AbkZ>!7Km>lOC7~86rs$=7G;J zSidZGISOoE_=;bnz2plb)A9+{f3CF#YcNRf-nE!YT_Qc6S-U?r(HEz&u2opcc0pSn zFASU+J~1MW%9G5 z$znkG2E+kYLQm3>iEc$ms;KS9tw2r${m_a1sI@l2^{i&uA8Q}Q)Ws>GA&~`l zF#3_oj@r~>RTsm{`a~wFQZo_G*a%I*ovFr(j%n)7QXHHM7nh;Yi>-{*WN~ue50$fS zVP|mbzZ#hNVzVPDVa|?Sjk#33Hh%LAs*;W+eX77x6xq zyu-cf??VKPgs6D;(T%sCce)bn0TyeHBxTi_fk z94vTok7mtXWQT$)yuqf}t!v7uJ-6?1>414H6QDm$z3Z=8X)a@fGP5?2i-bX-i1}V;Hw&q?0unavybnR-%Z;$!aGBc zx6Vm_-B&>I)61S~!7X_&B4V)qc2o+DLR?V+`CM2j+N1bXmqrZhPe!@Q(eLX1HyI+a zAX%ADrw~aFx`%MhM0Rtml%hV<)F?8yW5q5v0wTk@)5Z0{l%^nQUD&iWeH|O>24u84`h;{cvC_CaTyewpCxlSSSFB%WZ+=3*|VUFDAg|dg>JCy^h$y(2Xq3U`_g5 zCc>b`LMIqr?OWQSMNMke{gfxc#B*u%wV!g(hDC+uvir~(GgbYWE>v`ZUH@p;IKi9^ z7X^)OUAYD*q+f2i!&LtK{W8`b^FBmEd7`VLMEE$bm*zCXPpy3Ihqi+8^1|xYtSef< z@tJp1jG3!d-(8Oy9sl{+&)$ij{Fk?)j#D;1v(1EaKn@mqLkQe}W$lrh3%+br=CGqa z=>TawRSl19H9!6bh3#eNi3MfisoMR-9;+| zc-8%IEO`8g?5a_lr*{szVVW+{&D|x?yG|u^W3B82MD99Vt(sI7mySHu5NUT%_is^@)&rs{@e^E(&{CJ5fiaE>b6rI%HaJP(jw;Lea}*;L}4J^%c3@$@e~9Y6WW zPYvf>g*-~!cl~TM@3$tc#rWs+VF#Oh24iu0T{AVXX9^O^e)*xh4(@_y%y+;Q$}Tap z>(77~h6M!YTg{C^6rU#`;q>>b8PuS#KjEr*M$h8YBkw;yU@lDe_t);9y2*jFcNH{J z8YPGD8Bra&ns6y&)YK>hP2x zIU);}`T_2WiFy1&UG!F|*?8a%@%0fyiVNkwo)Uoy3A(aSlZH~NTGZJ61@I?wNc36?7-g@i5L>`B7f=OZUQxw2y zjg{`4?LtQxrwjdVl0E0Fc$Lwf0%6GMeK?h|KEd$EEIY)(9^zt{VEiyv(kz`oXDUL|NsMZvZHo#!AATbHLIsGCaxE!Qtc7Wv^(q`5|xSR^N_NOTUcV0jU%Ndv8ZoEd#p4N`2j%TS5 znfwXKX&eiJ@5b^`AOue69siKH<*QD&acO2;J0dU}YdF=m;uQ0SaPhr;)9pe;vfL}r z%SZgelTXIK_!s{oKKHrL#?wzf9Y6WWPm)ktz_ZH_MkZH z3yszH1?>I04=h7y*T7?9YBvFP$sD`-jsBN(j?B{o^~EZ+E(W1fudY}Q%w=QRV3q7< zc-<70!%>+A4sxwYhNFqkx{0M?8DpWc9%Q{cUIC1S?*n|d%8rOcFdjdC6qm~r@z4MH zKabCS_7CEjr=Phi0-`1kLeNHP-rYSL2WRg7Q-6mlutL))*2}*iGDm<)$OB&1KnhIf z4&GL3>j7q>8n=DM{CQZ+qZl!GQ-nosvkBc9}V9#k6Y(W9Tm+wZ&`ue@@1`9Jf_v+?NBqv6tY zHpvmAr+^$yo}P8-$VGE9J9SQLDdZV1-4IXYLO3l-EeJY2EE?8Ubn`@!BMNfFiDG2+ zT2M22xq)8N00;9KIi{DP`X1RD&D|-@W0I{(><|o_qOmGEjTMIvmT%4aR5)m@Bj1Pk3aZ>KZs|ZemdTI>nED3 zQ8TnH8@uy%Sd2t+kVnKk2kZid%H}hhElo_+S#_M@t67SnTF5Bwx)wrN#3$(FM-sKaUI=DD+IlC7CiG(=JA5H(Dw)*;E~{3w6`e= z@ffam#%1r_t~~a+L{$pKD^NsWC{U@MVb^8{yGl=V_fq{`otKU-#N|1!BZqyABqY@0 zRL=QxF}cCDmzL(em3?dx9SI)mR&X?BEX=dl2ifKFMEw5m|9*V#4?Y*qJab0}td~MP z(A&>}K7@e~9^I|E~pd!hIYSnfVXHvhuNEi>Yjz_HSo`I4U2BQ(`i{+*^i z+(&@}XT>^L3fi*AA3c5?Z@=^Q{pJ5!JoC)61A-d*f{R`NubP9d-_ixiwb)DU*cM%x zI`J6p0KKD(>FRmFsHH317{-&$nLWzaUms7D#(83=M*L2F0N=r zVg0?nTb?b0CoXw!Hsb!b83DD1R~oj=?sOsi9dZX-{pfXedKli)=~((+ZF{+DB5qrh zri+b6@da48ZwGUGPFGJ^sMmwxaL-5(hh{+2M_RFd(coW ztY?cZK2XwS@BZAS8}VohS!Ly0A85`d)|Zu=^uXE4O{3pZqeY!#O zVYwTnJl2(yTjl$XGmzoc#^utc;DV*%KQ_-o8Ea%D;153g2l31^&)m}i+zQdOy#m_> zLT)%mtRpU+ike5_D%Z_nqs0TCS8NJg|6{I5*fGvpFImWgP@xb9%zO?_$QcB^P+ol* z)`^*F9ecR>mEU7{OTEv_pJhcFRYZ3w8mK7-g!a5x8yVF(-io3XWubdsG~X!(#3}?t z?uD;4HIuyK{NH)!?Re$ogY(yCbXEJKAXv+vWfWu^u7qd6Y=|3 zB;c86;wL}(FR>lfvT>FyoYijDHHue#7|0T*xJ6yqbqH_$nJf{kdJIs{BiDpBotqIu z5vh3SmA079qycr{E}FI%p1a)fs&>B?(kd+Mc&2E^H$A;Aj8_9Bn$sH%*Hy;$`|0U| zT5N=fhh>-nGFIp+d%*|U`z+ZLy-;fT#;%}zfuij^`4y1+$CXW@1(V6_3A8sWdx!?+$o zm1k`*Byt9L4;l#pu`5`z+wkVZG0Ltkzay9ZUemIwlaqeHw|@uq-5s=PDnhCdkBByk zrqbG=ZCmAtjT_yu&>Y+U<1htsx%@)>{_p*MeC~695YImIO#I|0Z*8hmo{nxkoa>+` z)@~3N%H<3JRc3h4=N-_Dm8xfT#@r@0lvejPsA92h1r1Xu(?Xba=3X6s+MTmUDX)4H zre`+H-7^eoAx1^9Zy>VH#*2I@OtrE{2O7F}{jS~Ui}&{I^b`|fKnS(Jgr}{%QlCpD zc{k_(_D%5TIsY)CR!CY^?O95?Ma7}_%XuCJU7riYS>P?C>z+`VB*`82s$p>AaXA85 z4V`L;)P%5cYtOAN>RwDJBs7Ks*i!?YV!k&5YR+byu?r88I->;_D6=zJfribbm2ejD zIhavSp;&_jJ`9%%)wRbarH+#JkQv}ZtgTF%a)v$VJk}m5C`iENiTJ(W``!5L=RO4q<^f7-2eBL{-WHI=p1+J~T2g#e#-KimsQ2zNod8t`3cI&$<_dIa6Gj z0cV5mA`< zU^ME@t>q~y{TMgZ?{6)3uAKiXN$|(m+uO3Ad(h`HT%x>Q7s7Mw$;nW4q@ecb1(`}@)tDf98Egl<@8gY#kUe28}= zYO76Wn+spj2Gq-IxA5{sLLTM}Qc)kmIA$Edq2Qfe`rR=ecsLhEI@E8;Yd{Jv(YzPJ z3s)wGG+H>a`>5+pbipsg@BQBI$LIdw598VAp1UgoMvndbq2W`x==n7`0UV?vqw-@) zY^CP2yE9l=xSos?qnWS}bmggYVeE>)h#a7#lRDe;MHEU#akMG{Z+H0a{)}6r)7oKs zUlT8{Ix2;Vtf&W!h_Cw%%pJDRFwsqca;CffyGM_H7Vo@$o%641|2-Ey7lJ#k*#*I= zb3!#^%GduoO3LkpEuVe(akz95Q~PXqn7^jPXM-94&NH~$lOB7X08ekcC$bDz5_0^WKn_QoE$t93aK zvM@0rI5Nf+yFevp76g$Q?usWyS1<1``W^h&P%~E$%Y;D-f)OovrXol%sKsQO_bMsU~t$#P`)3!KTD3bM*e^N{^SeKzpkAZiyjGG_5Tt_TTm)_RrdO82T9lz? zV6~A-R^mg#N4c))FlwGanC538pwNgOh!o+&FN#4CdE(%Th_I^Y# z#zQF^VfcvSc5o~eZ5>4e={p>GFu93`3A#HjzZzNHH)=VoL^bZmRW&No3*#xa7iInQ zSlPPA(ijm|J{X}#f7QF4tYuw+v7;0jhq0PQ8G0iDK{Y86C?zD_&pxJboB$-;| z{xgSmSqne=*`s^TUtRv2#tl=#VOH+f^-}+PTCXjo(1Z&$J(=)*pfI1c$e*LQSegRo z|L+>xFf;>dCbvlr#jvg?J9^zb&$It1h#-XaWwI$=4VA$#+lYQj;K zq?4Uy7Z);F|GExh=Xw_-CwTW)Fz`8yIcl<0;{o%>APhI66f77z?6pIqD3T7Bv)*yB znZ%rf6B)pL5%7nfkLR9yZYctq^H1d5@Esz8P`V5h(PUl&xrl*48s=~pF8&geA&Y)K z(?rB^kzz}M_(G2&HO_TpSO^e3-dpd9o*%x7PV{JO=D+g@t~4u>7ng^!dsnw6IMxEc z6iVB|NI#qHT)66@U7BR!Rp#lSg^mawqkie~p9IJKva4Pi&TmDHNV?nsM^Sm&5Vw** z(GUFs#vAC#<(usf6*q*Y`bO9c^YMfNu6ZKG> z5oO2b7uh`Sm!tBAAWn3)4>m3R5pmm%)G`UgKAS4GW+r48EhW}6UJT(!*LtU`5S_ECU$-{apL>bl z{q5h4&;Q});<@LZkGJlT09Q0=PFO5*rK+{#WjUy&kAlK-*4h2;#An{XxxV96#h>Gq zYxm~Xl{%c%`(H1w7?F}*XlGLqtwpE@7#i~7FV((}CV{dxe(^|<)-@?D2kf#x5QubaNbYIVjd^gM!94bUdPfLZcwnj@{WkIRb`E`UPAy$8dyL~hWbrGTw>w6TK z*I!MqOcaPs8NF!$7&T4Jx&NsOc1?d$%K9#3hlHQ9E7j7?Y>aof<$QgIgEdx^it7z~ zc;8TiZRRw#++RCT*$o?fI7XC(*(>x_{hU1;3Iv5S$iVQJJ*grP&ixQ#(LKEYUbGQsE94ZAwSxsaCiK-GVS=^}LSb1CbymeqrLNU_3xu0RbTbIfw z#B;FZIXgy-=}z_e)M}UP(Ef2b@#LYX(VM%wo)VJV zcThal$wfSlz$JeBw|@H`33yMu_10U*yRd5|Ze9i3|5#dqo5Nqh$WGX)-y@sbo#&_Z zc$I^gxy;7vDFjt)AN8RSdWq;_xL8v{*!3>LD3dEc`K7nRR_Ke=1p?d6?k;#(J&v1@ z*-aa5DvrpeQXFZOdhuKx{(kz-JNG6(&feFJY||Y0%X>wPG{PG3?P*?DpiVHhcW3nH zmkLNiLBTKPT@2 zM(mxvssRtigR%PttTDG3_JKkl^fU}@^zg1zgzeyVj%K@=|K=_VXD-8GZdp`*s5ZQ` z)S%<|8#;qsvEla~P#TYx%@9dLvA&l(wf|3xxBspvi8v?H)y>x09E?U%p`y?Ad!+Sf z;Xw7QW1~6bTte6~QI&5W$hE{i*d|jNY zhW-+xM|FiKICg{DL2CWbrK3XSzx&{o9|qDiKURWBr1uFs<>kME0s--^%w;pgM|YY{*-gWd}~75&>f z-|hQzAw3Y$vfUb(a&)Phkf?)Y(#G_Hsan5=-Fx?gyj7*@}x|p zNsoF#*J23r{OIs}54%EM)lM+Fl=j!64sy!uM9>pLAe>QrP$KqLxm^eb+&lceeGT?e z-u{!B3k=05{ybH16pW4gBtFH7GgDSp;$1-4GjnV@R)09Iq5vKT~*aL z(K)rZ7yRwJBMO}Ygy(q8w^x@`4U^d+lP(4_e}9aZR196GgADuHxfTJhe*TIC{3K64 z>|&NVy(dVwx_+oJcGkCD1gg*(NK~PViaft~EgY*MQ|JFUnhT`@lo|!|Zij=m1EOFr zmcM!p&hDQY9rDDbvC~0G%D>&J@sWfcJba>-Cc8Y z*App2#2)VoIelI*{Ac%*bx|5?2%+GW0>HGmRCt0b4k$!H%S%D@l&O}Grs604@9QuQ z)8(2iE~k+YZZ-#!P!L6#J}HvB$csab0RboNF8J#7q@eJKtSFyHKFQs<(bPft=L%fn zw|?`E4tU{(7vinAev*El8u!wE*$XVW4cs{(yS)B-A$rVkb8}FJp>@s`kbth%DI={> z*4x@ct7vI`Ff^rdOZ*G5hkdaGlR}m)`q5zVBlOD`_S)7v7t04d=sfqM(MVdA?V#9o zngOvYtJQm+yXUHR;2r1x(>vJzU%&o(JoC&mL&0;VNil^2`o(;mL$9&OcYlPYXyFOk zZ%;_{cxD$ZtedQZGV|+3=Y;fzGp9@%<0qT)sSEqb^1eRLj5rF~nf2a)q$+_<=W3d2 z4M)2BFBjd}!bCQjDtzE5b@erELWnQFhoHNmLO-)SppfSL&8XB$$W%o&+F2no(eKiyr5jzZ&(;3*ckLYTf=?VGZ2(>zTOaIKt z#@8Wr!mSYQU3==NcA~2JQ17ZjzmFb0j-S4L@9qEk>+$s1`A=)>OmuA+&n}!p2}c79!m2 z25YPu0L8mcFD)8>>C?ryaAvCG48zkZv6`}-R0jb>)Z~u4!g!b+Hj^>HtF#D3hp{qD zBn2OZ>r^Hx93kiFVwzyE>Ec(n)_>v0k2 z>@W3()EMh!eF^7LrOu(F@$jx_BHdb2&n<>Az$GLrD52-|yXQhrtD|#=e3-mwC?5?u zVnS}2p9{S>Fn!;4Xs;u`;xa1J29EAqof<9kF%|(FIyq-Jl+V>W!Qb`r|MH^t-(CD? zC@g_|Nl~%TvtW}tSB%T{hy*rq(INNzh?2JD&m7(EK6y*|n@qK$t$*EEJ*?nT@O||s za8onu`L?2^byRsplJovlp=x*k=MoS2k509U!p~k`W>>p**TKngN-vnh+{7<>IZ}k| z7O1+II#+*iih5CYzXOIE9V2zsd_X|OEv;=JRg|fmhPg}Vx{EwRro(_HyGz78k34aW z*COE6c;P)Slp-KMx782A8&maXt-TYpPQ!b3^91y#Iz)eHw`!fV5v*M+q7KUJx>q6n ze(|&D4#azFONmiEG&1bE7UeYJSSKiSbceG#)d#koFgTt=D&z#sne!3K`j?jo2XwHa zdF$mrjr#2nH5epr;+fgHbrN!nmYciRIgZXIJ+pW`e_YpH_wTByd!9J2SdbhQG^VSL zdj2?V)mjkOhG80g)FZJFD7QGYZwFN8~@ z)~>}+JXT9_ZW^C7o69luXD0W_9`H)A$QY)kS%*_A!;~Vxue`G>q$f0G!~2WwVKYUoV_$OUfN* zixWKLnc{IN0$zPJUU>0^#V6qK^UqF=YAx!*)ge~xa%d@A*c`$xg%O2aSgEKG?6f*?Q0=GxF5y1B6hvLe)RG8%a_k|yUt62MyO^YhHYO`^ZCB4awx#dgT^ZZjWAbC4@ z*Ra@z1ns(jhm2I-7XhF7XYqymBH+z8-yGJ>{Cg`Bl_x=>1jVb78An;D(IUmMoq$2p zMZEITkO+hahQ_Jh9sk1j1#PAHLZYuCIs8yrC?&jd?@$k-#wB!US`R?qe&W)C%yF`O+$3 z7htgqmB~?%wd=_b1Gf6zgN@wqdS^SEyq^BqXa3opFz~%sVc<1oY-j&EsL|m%TJ`>Q zQPDlb)rQUpN~c57kR6phK2c-ci<~i!ATr$aiv0QVK;9Mhnp?b{#CnW#TF3j*L*3rw zDGx?1tXyI2B7I$fsrQol4v!xFEPi?)>6<(MbMB?OqkQL4a_B%J*ZqiH$`rxRH{=Ye#Etd&~ zX@28&gLvr8!6In^Qf~-vq)<0bHfJH@1Vp{NpiI$2gq{{a_}ufm0|~$YANS9v>@8h) z>O1Un3o?(MaCk;;Dr6F9#ff6z4hi_p&)f+EUwrR-j8w6VrGrxTFaXCU|sqq4Nc7|BR0wJ&L#Ac_&_Z`Q`gL|7XK{aGW!#@^JG&U)GdO zI9u%986xbI(J3E?2CNi7E@U&zv=+sCJ9 zT$rY4hpJIv8+ri) z%yV|sV*#kR9N<)urnMV)om(H{Ar%+D@|&=fLhc42EP{7X`&kci^}II=8~1d;=U+CAF^y9c#pn8GqopP3&G&-ty>aR+UY%#_QtXp22i%#l_9wNj$im%6yAI016ydAH+ ze5dw*dK~rRK%LR-|A&Njl|2$7URx;0&lNqCXc@Ms#7rZ2tw4k}RqL0u)_UbX3pko* ze!eI%zMR%NhJuX_eGZF~Ch(aN+9)g*6!>=0$RqDEAIxh+@1*)xFClY&z57z4B>iP_ zwbwZ--H9{2sFAJFRbzGdcB zjuZKWDdZZ!Dh|G|ml;fwA_O(mzcaoy0zZTCv`<&_819qApi^U9ougr<13vTeEAi^9pO0VqrT4~LZ@now!q)v4 z(;gdoW5uQ%c+lNpy*ZNVyN7@XQ3RnwAddcZC=8BD&C5SCTcS>M0Gi-wAAICHC*Ae; z@!DL7VJK|5Oy)R2%1YGoYk=G8tn7(edqt|v(MlEyT=3Cp~J4u#dEv0>!Xu3 zI+&?VJw1hSLM%Cp4*O##@<#O3!kmi|p@p0?53z~%F;4U3`{`0QcwQg}r%_uXV5)9P=gmq9s7!2@msMtj%{Z8LQ#&qYZ%)xK zZe9KJlz^;(&Ip-OrGJ+WlxU?;MeK}5LV3++A9VG*X};F(0DY)e`9r!M#AjalOuYJq zSL2s{>6hZiKYlZm+0$gk(K~C-mk884aTf_gO_toAGr1`aCW9wmm{jcyqh6dPFQYvV z7yk=+sHwF)M{}#LltWk9st)_Rfco!`Vyd29Iz=-d^!tRn9rbry{y+WcPwy}PYv=#a z3w@frdC1r;3sj~cy0CJ*Y7V$iVHa4O5knVAlIm~;lIt#O<%{un?Q#OGiAe7x^{zZ7r2`BpEMu>`(Y7@Zp^TYW|$z(aS#+ZQ-RAArop z>TyuDuh6*KEI86eLQxL-9spKDS@g5XdpP2pC2WO&A@+YXO05SM=>joRl%?=WJ{&o! zxI?0u0?7`HUXR23IsbRwxmWuq*nhfA&d_B)Pw_mVSz)Nx{CreIZ$EP#5*poCWSFV1 zzndjIt%V24^L{M`j44=inCw$A>XNNybCk%}F1{J&?8TD3Q1*61)v=`d`Jklh+HF(M zR7tXo%bD&jRa4b>8LAsXQB`-ShQ__FA2RzYx$?WmL#m4)kJaVrY+smSl+ zq%h`NY9vn^0!`lPlh#G2?!}TGtL>4ebp}kGJ`K!#_wOG+ejIPV^V4|wrEBNE!v4EU z`ym$E3UNJCKrCsPqBEb?@6S)|x%amBT*xuN-q)hp-&<`&2>L;5e!4Hrl*qWtSLu^V zWP~>)ixa=oH0sWC2eBXzSM(x3lMC4`Y}1A3#;uA-LgiiOxWj&6GE|3FyzNP0lAz&y z{c`JNK&>2ireB+l?=y~w{yLL3Hn|JKoBd?1Y7Uj}NNhE%A^~2znA6(W5B64nk z8+#4g+1Ep0PJe`OBXkGXY#+M2c*gcjz!)F>N%4l5im+aP(NdT=U2}E zm6u7*Oe!68p#YTN!@*Qe)OK_qdgP({ z7w11(F0ZwUGMi!TT54_pLz!Hl3BObTOSNEBGpmrDoO6oeaBwQ?QRm^!$S!K45MhZm zHU8GtZyS?Q#~IFkDvWlaI=dp{?$5vc(#!FMS6_|yzwdp^h@f7R>D@478sPDmFX0loipC8Uc4qQw`tt|+ohN>{$$sfV z?;Zvf=Df=VWHql+nk!&>Mr&bWC{yN6nA}ZVtVo{tvr~S;LIJYC>0zAyoPbs9$tF#g zDLM+Re0}Dy&Fb-tFTHc($O-vFK3@jcx#cr_R*L?Gvmo$N3_}~e?Gvd5i(G=T!ceuX%(#!FMFT5J> zf8YD>ZG$V+oDrq8X+_8sWM`lz379zdqYKq$Rw`9dCoYCS+sfGIsDwYhFG7nzRi{%$ zU~_TCc0sE{U%Kqs?pOc$RY+Ms8(UY8)E#N_7^7d3pG_Au>;HW8=w~;RpYx-BaRNHt znZNMl&vlM*lTL`CbIbi-Zj}S1xM#f1l|{^ktk!FvNk^ z2qGE;Aw=3*h>nBp)8ZNh2*?`cVxJF++r?)U{U{6ncy1&IY>VD) zVr)+bxFQ7c(n~ML7ryZM_`nA~5O2QuW_tFsX2bnD#yRf-7lDk~u*P1Bsvu(*?$x#1 zVuEvQ@;c*P*I_Cwr1iF1C(5T_4>9j3nR;n?zx0W#4|xEt9e)zB6;WBwGjKvZ#Ls?q zT>h{9(aQOALyPUYc5Wz4YzhK|8-uQbFrT#7_wC(UgMpg62+zf=391i8~mtNnGN?GHGHg&|L zC#dO&UoztH<45t%()r)P{)~qS{C3^@be1!3qmUwvXL$vma=J~E1q546jxL#%pX6eG0Ers)lpnfN7YA4XA=hos%pEWF~ z=8Xd20JjO~OeQ2nJ9K+hGhGO!YQz9Noj3p|-hJi7cw%v2?EcXpXH|^Miq93gXG7s> zXpQWQDCmLK^|9#!V5Qb)0!VnGGoB8{Gr}k5o_9wFeEQR$jxSz?fp5N<4UlkFvCQG~ z!P?y_NM5dWsiD<&*L@AmqSm!|X6XR#R*uN&C=jBW{hkDCT@%wSNKv09Tn9>v7~G*) z-pco?J4#~KbsRTA(msCnx@L5I_TA68bNG9Ene%`C1kFHsPV@_VGA`RG{vTQd7G!fH zFg`A)6LdqIT<79IB)R#{E`W%qD6A@=^VAfJ&9(7EkOp1ZSSdFiu_+e b}aI>P^u z$Y`DUaOrT$WPPZJQ#0lONEql$wzQwc)}3$f3}U+=@;ajCSFPWGGPuA1RmB4ii`^KA zMi%M?k3T{UBu9=F%nlykdkPMCdIvKg8h zd5myoZ=OERYkn5HDJo}&B-VSTqR9IG>WwQ!BrqD?qGQjm4u!i6mQ+Yl zdCi1CcBixV?$KRBW*MtZwjO$lck(ZkjPN6SM!dlR9w&;hD=bH}o8brMF^r>H?uSa8 zP*?i`LU(bgz#+v*VqZX=8|@4Cm~*dQ1)|V`o0Z*%p`82AZf4gVfUy7W)Bp6P_|g}@ z5FdE|`{T#g6hS$6>s`S#T^06F$pWfA_Eb%-x)7*5J37TXnVjZ zHoCY^1$5iqYqWhv@@fIBL;7};eEmCL>LJh(OcnkSCT?&o<~8J?a>&)+*BuBAVo)9o z`WMy@GJGM^#8J9S?iDXL@UmCddd`f3OHx_&%5r&zsEuJeskV77y! zan`-|m;GMKy+hMNKk$3*?Z1+ZXfVpg|MUxIGlb&3o-aIDO}}s9r}Ft$Ghm8z#x%2? zTKS8F89kYL7S9_2;SfV-(R_P{ST$9-uN&nbS5qu`8}h~OaV*FwP3Ft*5-vox1Ispr z0|1w>4HQPr1ua$5IcvUcCoSi-GoWN0#?(<#5dKQI3-(i`Fz7qxgRtt0A0C5>u7zEb z5(g*&r5fRk>g3@_ZEH^|8K+vL>i*~O(>nkzy+?^s5Iv#y_jLx!od99)z1DdRMQeN) zN#oh2?rE)DK(~E!t7wdGL>*V9)XX)}P#DtVkpmrGXr{yWLCu`t#`rKj<|)q&abpRY zSDxEeB)E~sJGa40{hFVm(nX2QSR5VH2iy`qV*)W3xq*_c$S`3ntHikove0Y2%Ft2J z)pP7J&3seWy8b0MT2ZLDdr-Qd;kfqGHAmTGb&nRtkAYz=M)H#M3rmz@Ds2c&FEf!7 zU=`|@Fa9U=x-igLxG)f&`@{-D|3u2{L#pyKElUbDKr+jdlM4SbRmiyjQFbB)3S~x|+7pksa*$PH+@&L=kAf2AnR%8!y zl^FDkfTXeRWw+@JJ`T5(+-IbymgxIn!?@Q|Z6M~XxzRdy*ssIKc1FKp{mg%L>Eq9r7F&;Lp43GIi(gn8^+_8BHXtZ zG1D`;9CA*#+4hX^$kbbXMX9H+=WCvpmC zXn1S`vKXgc(7}cS(IXtdEsM;jUYf)e0PwzI*19?ISYDGP!0rUf6uKvYU+Om~+$Jt9 zbQs~+#2kS4={9R46d1>5g>!|G9{#^zhq_J7jE|^-wX6D~b+V3W|zdB=}%eR*Dm;ZeB6;7BP{>OU3NpLL%V(S0HM?BZ^s+xVY(Q7Morc zl}i@VuBuRaLCQFUiP%l-bKrvmsc@xv zNe;_HU-mV z?sCs*GFW;}(KrVNA@k;et)8)rfhP5AY(&q$axylRb7cEdRp!pk@(8CI96h}A7aX>3 zEF?s>O)Dmn1eVceBcK z6Rb1L;@(5blk{6WjuW~*>J!LBR>@=dzyTV1Wv_9Fp{cpXhmCJ%nbULDwCo3PQ%ZM6 z-kdJEqCrouT46&o@^|hLWB%I1zGd#YCC$wH144Vx_@$kZuPX@+HmZvPd% z&Mr&lR)+{{-VG66@%8&pvq0l(&LQmM}N@s0^d6vsV#i@Wy~ub zG#{#8O9%;lL{f=abjou_zG`Ze}ofY$dDPJXYk6I02;Pz?_o;P(;gGm{HI zHxV?9FPZxt*nk<2)-PfK7b2H>XL6`41n3d6aVMARZIY`etontHb* z_=n%^3bU!*(iM!q7y2#5nN1%1hu@T+NS&DD&Pj6Rv3DRi_V~p3SwT1tvuBy9KO1*<3EoH$G0An_{&$_sAj#@nlv;w|$ zD#h(V=dQ`zsX@`qBCvr&c`(dX^g7$xiob`@r<5qxsZ{+VbN+tcdvoJz;dl2t=nW_;9sxqF zpov{2vVs+^pB*V}WF1_w@~{pU^W3;??&dL7xzP3B^1 zVtms}S}EfJ(prvCZ#9}M_-Cn2PNulTBp%;b7dhmU@0G^ln7U}Xbz;_mP zJ>X|mz;$7V-sA`Q7!&v(tn`7QCm3d(mV?(|b2Vze(9Gf>gVkCT1xe5Ik(|Ayk)QT7 zet*bi9?L>y+7CK9_;?(1!^Ye6Jub@4j%L8-0DHD+h+B zeQ70Milb$T{y2vVYW_2x4LB_Mc?Mnf-Y~;4*vRdt)EAt!+3xS1i76AL$WYmC(e%WGqg3mdXX zoBk9p;a~rXsw_zv;FJU|k(~EPRYYBNz*F=Z2t|xIXuCS7F|N_ExcLXr(ycgn?@Gs- zCWe&(A_lx~_ewTapm(h#*gy4a-@~Jyau&drwo(n4DqLEvtO_}@NWE;?^|%czY9_gm zH0Xf=QBHQDp62JJ|Bx0;7Fu5CtbDD&s$3WA*PKVKP3*Pck-&cLwv1tko zL%l>ddz2qqH-52fW_HrRR-Z1tuwy_VS9GL3g>XhsU;j#deZQt!bgU2G|1jN3fwKOC z&i-TXx+OTr)j`$>`%=n(|K^D%qt}ZkUte%i;X@|9uJ%REW~KGSWcmrC3uIygOu_&^Tuz2j57QLjT7FjtXZ*?r7yl5*sj$1x_18WC@!rBe%siguplIdlcv0iAz$eM^CcxW~SFW z!Lw-Tvxt7Q>Edm9vg2UQ+QCLNgN4jr0drLW#ts#Fpe$|EQ9+`ZInUQgK%C6D z7+wP3E35lWepy^wED`3A204X@B08+{ct6e-_Ur_(WCqE-TiH$ z>6O{iO2XeCWwjoAS>J5uA8(1|K~=fo2Fo6<$4gt#b~Joh<$k@Jkb`J0JxYh-Bh$Nj zzhd62p5N$eW6B^|XFjtR#^06|q;h?Hes;b2TU*t>^eDq|scU0=`drd6V8+KdbVRK2 z-oM%}yi2s)t__-cE2|qDRxnjuu!*$Lk-q$=4=%+eakR#fCE$a|+tdogl>sEp3H%}k ztTtEOY`HZUMIXcx{GjuaU9DD*_Aceyh8SlbL@RI-0J7!A87oshKF5Xj+%V*hvShTQS4g?21sm@=T`pElinZPV0anmg z_3M5sci6ISp@S{y;iJ8J%oW)e`_@pNe*Elj-`*9yQ(!BMt{>&d;--32;z_g1kg(lb z_qJ$;rtXXWu0O-Qw>er^I2GD0>jtsg^!)3Rh8|Wtf9AE50*qThZns5OV-H%F)aEa+ zy~AjuH@W;C)d?e2fMJBYrJWY&1I@R<>XER7lh%?;iFjHeNkRd_RC)XpG|SVT!wY;V z#9aVx0(IPd&yQ|fe4VhRZ8)ih@iEP1?IKXDr1+IRK5ymeFAplfwsh*j5h$GPtxegn zBvg`|oH!~p7`q%FzShg1&OO)Y{pyW@lANf44R)jY-v|4}WpV0Tzs4ksPCwdAqFERJ zY0sbAuK&>C49!0^7a?_ZIS-|>+UMZ)__r@}h(RK(&nAHw2ggwU)vKj2A1{D**y+U% zBzX?8Qq3S&A`DQVCCVug7!&u{_xrKQ_q=7B!b;hF(3i9h&Mr>qD zHbLajgQq6{<+RGg3!~E)Yc5xCMH+gDu17!8Lom_Ts%~e$M3Y);JgP zH-r;k#eFMgGFdhIOZ)JrM(HF`xl~qk_$6d!9J^IV;vt)4zx{r3mYHWm<#%NdV*=E( z*4w)39@xtN$7kxa7Re%&^mt-g%RxygE3>-it5I6Tx{m)kJr-B2Zv(8{Rh;y|mOYIL z%w^gDn*1|TuLPane|)!B)&SYr);c{sH!Ee+3 z@CR)41`EguAwJCAoHSj!^P2DUzT3cM#@F`PI&U<mH(ENNHKo&5pgdylI;vRWSp!Xx*S z4PrU6f%{^((Ra&tcuZBGu6pmP3z2Z|ZX-Hhv={L#^WmUkPC5MY%#Pf0Aa}^M&|OU# zQxA+C`X~{^5lqgNM~7)W*TZx^L8s%_a$X0pon}oj)l9Wnzp9t5{oQMVCYW{lsBO zPz*C*d{`ObE2W+eS{b~7-qg*kV^zD<&i$f{>GYv(uvss90=r$J967$LKQsBb;uZO8 zK}_;Ish0rcKw25?@Qd*ptMmDhb+_S!COH#;?;<7#9pj_qS2sICFQ~i*d&*<$!B01s zck<&ItFXX@FFLmVagbAU0xZibSUGvf8lGAiZm#qGp!^>HOa*Zl?vrl&)Ca3k z>PWqYr4A;3s-gS-A^-M1Qj&V;^nW>nIIJZGoc`0-`AXRv%$oR|)H(ysDUEY@XOK|( zs@ybs4?7G~bI?Edw6QE6=195pcm0k#YwLI8knatrBgX&cy!*r9z35dK+~-0c+&rtx zU?)v_;ALsYC+IX+iAgWMLX9)cyarRDSa((U2vLr)Acc_r6 z*~)_*=57|6FVA@69E~zN?ccG5rCUpg0TQUsI-WV`{;e;_Ggv+dc4?HR1>LSuZ&ZNq z9Hr0y2;tG}{F|6`7eDA{!e@pR(nuTJA>vmUaaV4RA?wxXGrs{5T?n`RuS~bmgDMD{ z*T_Jf^tfqCZlk7$fu93$OFcPp(wBT;rQe2S3g<6Y4q~k-j!0PQpr0Cidm9^X0n{Aq zO#_Uw)U5ZJ=wpXqOM@HY`>1s)LkX>(lt-}QdeH^R0(x?L+ef6Zc1|1 zg+QiR8t&UDghM4zbbfycFKERCtM83 z08X!=oZ!1#Y(m@RMCt^d8EbPCc;gWJ6}!jNhu^Tad?~4_Qf@b-cX>&kVI{LgW#8B$ zzk>Ui!ph$GMU+Avr`gNQcVD?Q=tIKi7R#Fn`d{wOsH>9HdS9PjK_6Q}?}tLpR~Um} zb&}kHFu4M8L@lK4fVyIGjcNl zX2qFx)$DC2(-Ha1#&-g7-yS7f_nA(0J^Mjs5Y{VDG2|&tE5GsW!&uzs5_yTaRZpU= z>!<4)m$^e&$AUZTU=+D;jHRf_7)J+*`-p2ZgWjF|={r(Bur?wt*@j*r;-S(xephqI zD@bdABA$nJ41oaNVlh(dK;nGk5{FWec`8?2rhdRZnE%F>Dtyl^PqZ5H^wnfS1$mz@ z3aQt8KUu$#Vr&^V1BP{?X~Vl#s$RQxw$<|KJAKx9=Oy*fsw96dpQ#Tdr4$tNI+RkH zU}|-dv3}dOrIImJc8NO0X*U~+v!;5Ka829!Dp}N6XT0>od+YlfwzC;#ndhN4Zq_a# zD(P$#7AC?*?H>|540(@-E~6{XDDS_`kgF|JQ_+ZVK&A}QQ}g2Rf5s*Ug12eOS20U! zCT#>pYlbS8aav!J!h;2y1eW!YKzhEQy(`t(ENWx%Be%wGYN$7uKpOMO|BOC2M${pq z>B~BipmZT?THcBb=WZan4}?Z|Up3loyj{8R@;@;m*uCUP^LQ+hr>wCyb!c{Q+vg&` zC$rX82+Z>`T)B|48h1qK=<_!Eqc~I`T@IDZI_tGI9pfPm0dMf~6Wf+S2vmF@Mhp z1}|yIa26nt5?t@X8=Qvdf`iQGgq!1nWdH2s3Y8LP!}7{Aw|OWi?{@mbbCTws{d62z z^yrpWezup*r(U1oapcA&{vz_+V5o)hG#_`2-O}RF@uL5+-^&;ap^5|f5-l!!t{)M$ z5na#5>b%8!UTSs8e0aqOlhD6>Qqnl#V6+gu!a?Q&ywvrZ8|ol+^!AhCZ~+sbR>MIt z)d80k2-G>ehyOjTi;AIa2L=gpx#=r*TXvws4uj(Zu<3IAzjUF8UZz6p7;wiW31dXp z?Yfh?dhzz-H#X%O+K?AG_B`y|wjhQF$n%3N2TIb*#|V=Jb6O zjvIe-ZT<%uM!gr6_Bn>}`L^Deld}xDpG+)B!e#j_E}T!M$#<|+IlCgacXPUvo0xvn z|8!}44l@7XcccP-Xk}-AWZ?yNZPy)b@|PRf4pQ~Q-LCj3381dL(C|E~{@BQT7y+Pj z5d(}x2Sq|b3qL`dAee-MEQzTpW>F9Otj?kG{tc1*m(WZ;p?4dd@}qw3`&{0x9f^2v#F(|S{ey+vq-4sQ-?|K1m7uB8h<<*w z`bSv(v&8e=916TzrWQ-%+<@lm|7qu|%*&GW`T8~{$V55F(4=o%tW|e!jaT>M);Qx{ zpX9<@gDbtn##(W@u0K2Iqmx-GrBCmNrT3QLQj+bO+=n;%a7Blb)?=AfApLyS=SS0S zjQ-S)jhGc?0_+p0W96Q!6@6LV=MI+q}!vFJ=5A`_-1c}-oL!xoSdcH7?N?1&Ys)v3K&@CBZNLd1ipUVjJ;s{a8 zLe_Q_BhIX?vP2DS#RJVBVLX+z8q3Y&P81xAd{Lrqt0W6*bf4@3DqhU#k7WrZ>r}Y$ zrvB2^ZCNz_p)^vf=rjv_ILrXA;Ss)`#06oa(l^tFsPjIS!JZgdbfkFdM0i@5KTHEU zqo)PWVOMLxQm3JZ8;C=9csHcg-I!oef=CegU}PshdVcY18(FzM)$!T#x3`ww<=Xo$ zF0ekx-76__H~olO;!m*ypEJJsqP&CeowG3n^~W(KS>y|>FENU1D4)t34iD*Ag9G^4 z|Bn>n+vr}!u_iIK{}fHcdo9xBxHoh^`^dm3M)`GUkcG$or@sIh(#gKk9fVT2y@TY~ z%ajNQ!2*33?P24(cPwn7wuJsK@yg$MQXL<)i7!^}1~6Ajt-7Ym6OG>t2kJL* zC6!wqHEV<;Q<7Fi9D9bK-_e~R84Kd-=l2Ju$URrJeNT{Etpuhu+aLFjWJE zg_t9%1MUwHIoHyhoI1+wtf}oCW4rRAGc`9B^go(}=4m+ZcKbGNc5>sLmsALHDPqfy zWTA~|&TwhFh67a89VnIR$NbGlk+SjusYkQRLf-6PY{BNAuLlBRt#jtZ4%{3W{Hr(SXSR|=<(#f8LtAPhliH=xOU{TqT% zcT6Ue;!h6l=rCEQuu}KDR&n{P0iiTnqEA+vNqkfj-uANM`|AeoHIm;N$<#RhmEXvG zu>BKvgoAEeV#IAw#cO3c@mZ5WAmRg1?;$PZO!I&jc0HL@EH;NF%yDo;O?=>!94NXG zISOf`hu$zlQ=)>h=^!nqlehM_Y}8vmA6E{!op@iDIRxWq9}&yN25|4uNY+b6lAi<~ zXRn?d!Sve37giXJq-)?eIKI2X%9sR_RndbhO}2a>n*ob1l_%L`SnXcHyeZe@wpY&# zgAiwzM`S^9k4G>fXs_7(&Rr>Nb&K3c|FwmSX&$J)_IUu^ zxzCqce;IXe62CRa^@CaI0lt_iagogcN~Y3uG+9tws`#pf?Pog}c=hsXA!~&7(L!PA zOzwgG*8@x|Gw!YMgs_~&mMy0(^-%TLkLSmxwSA_7oP>ROuCn=!wE6r0%8ZAC8`6_N z5M(L&jJ%EYCx{rw)zctFAy0SZ@~E1{U@rrC&l=zN`ac2Y|8*l4{uWHQb{;r(1Qys& zwu2?j`cqj5_+J!qM(^Z;IPgzGgRMDQ_K^m0(O0K{uL@ccty;{lpES|!w5*YB^-DkA zAC`SN|4f%abq9k4P8gG+8y>SjbTO=H;6hJo*eRUrjnoUrTOhrR(PNyh^l&D^X`V~L zf6F(ZVXe0w)v0&j^ij6Fopj)7STF$#eIqbbQ7HSi~Y7ke7VxMilxaqif0o!G?a zf3N;;hLB4M@qr5{Tq3*P2 z!_^bHoqX`ZIX(J&j(ThVapy)0L(3i?zgGPlbv?P8E_fXJYghVJ=T^vD+Ec7Bvb#_A zwuavPGsTP1?voSA+a=WH@z~|*kt!oV_fYnZcdF32R2SZ#G68FRZ9P3om>B5HH$LU- z^6_B-Be{{C3-Mjs`RD@T49hM}1;5q5_p+99T?gneAIF?ZALgET-$gn`%$lNZYfFl8 zs|bT~y!4KJ%$DLP9~qB$3IO)zFBtiQuT}WzpTuju*IWEvQnNsr)E5%TV*&K8tv1Vh zkRmoj=S69pd>p&rwo0p|t*!dyL^&vG!}Hh5Ay+Y%Tl(sw=vaGyNcd9=)luEDuXPHr zgP?os+@u*V-9;5cOQvs42Jv@kvio$>3eQ!v=iZmIH@Myh4E{Ftj5@|i$p#3+-YjS-De&0oaj z9XD|<1EjkGhOK`@xSs4g{cs4CdNf0xyHU%;n|I8VTEVi&PCDj@lhN?7WAsU4B#S?h z7q5*WCEL;3Z&G%LFtxb9rKkk$sCl_KacSDpylbY(DBS0g%w`59g1t@@FnkZ0!_+by z>%B6Xu&AI#?DfeGzU!UYXc2C0V88|GK(+*e04={XTo)KAV2z)`POqi% zcUf`Q(qDghrmWj7fkBIkbkb`jViwt*ISA#%awmMt2eJfL37e@TEVJLimQK5(j$}R8 z-{|S7*fT!bVw3RM`(Hq&M?b_b{qENs9J*K`n#oKC` z1u%PKQ;H{{0C{o0mW5zX;}TTmrm&W9%YS2(LgV6i)J)yQ!-%ROZ_ou49m`V92W|U& zmaGaBGwNV!a*?FU7$QVKpm+6%SZ9CU|4$Fuv+*QikM6)Hr6x{<})NZ?=pF zx7upgmL$}*(PwtWK@B$$7(tKdt9DSl@+s>-vTKs|+)#FQ!`-Ue>-x?dTB&%{m5&q8 zhuNWKn86jT3$u8M_4N}jil(}aHy;h@j;q=?)MB%Wn67E)gfjh(duK8%fxNmMn7G_VeIz zg;o94i;>&jwhC)Gkr!6SAssBI8`cLOD3Zq|T^DZfKDS(N8?dgm`@aIs%f=T7`t9FT zdP%p6v1jOhS&|uh$tE~37S5FNBBt31ORvB7w@rBORRgYJbUSUr9Z^D_Mk`naBuF6e4}Yiq=!KjxYJK+SjVOYSWD zI2K(V&oLFjPS0>RhI6cbxD|#1qdl6hu*TGj=O>Zp3XP&4-xWCXZRE08U1xJ*v^9Rk zM`uUJ);vMK489F09$)sp$L1L)iWm9wX#zdlhqskAGZz-rJ z@{#biZKmf^V#qC*Xa4dttyFG$CVigQS|@2k@{NolR7(L$>fbjuIWHMTaACIjtf5s3Ds)1XqScN7ao3m`2M)u@wd(P9v03!fnuE3 zb=nZI-Ya*3k7ZG7@t=UROCQ?l!#~U_^no`KK|>{&MQjdfqqcG}TkG_{h?3rqk4fW2 z(c%$(>os9U7|aKWE{$HaEwR|h?o!QSwvcBZtCzrNyXfX{k4-Au75Ph8|3>c4TsNtp zbpatC`x+WHEz-VpS6RC;wWq_1-i?EVhcwV){n^U}3?oyxRWZ%2nz6V>O|M?&)G)F9 zvMW%bOIERU!(_t8HK)2>*)J1GGh2Khvzj-6MWx_P8=az^6hB&~drgCle*r>lhl8bP zGYsHg`9xDUhQIO&2x+D=ez{AU5DC5Xt4i#aZ0@(Xn&slAFJGs^v=02&nUAcXwfr{@ zRwAz3Fad})YA7;T_kK>>;r1H#r>+)**qunBLe`!HilNuxnCCgZGx}X-Q|}De1hZ_9 zOPpd03fsSJG-?W8kJhr(eYw3D~cs(jAYC3n0YEn1BD&F(m&W z=VjQsK*A+U;(X+OJl|%g;yem8h!{JR(D~#F_2H z$5ZNp60|0aOuJKumU8dWD=01hLT+4o5F39&5ozm^g{7TJrDjZ7n@ntv33h-MFUHVwU-Gum8!Q{@o4!h`omE$IT_${-tZQ=ab|D=vut5=}IwO%&|fN*zKxN&v5u~~AD?9D|xG-L2j;;Aub;X0l5)B{BA zk-4saD{}oeTX;~soHuIC$aTMUsg?UtO46}{@_kJv{wUY??W#PwRM}r@aE?py%5uI) z62Rs$MX8oiGhjcN9BAMXs^qD@T(qvBQ` zk$bz2VybBsCSJ;KnLB7`uD4r0&i;qOfNymqpGK+U`xPYYm$Qm+^ulRgh*d51`G)-! z{Pz-yKeV$*CA~Q+A!DyOW(s{krg9GP4?yt$?%<_ zG&EQnI|82XSIJV+FFjpiQkP=`E%|Y+pkJ>vbh0o9;MO)&Nr+P)BKHVgBOfrDhYMpx z?@ivd?STcy^oz=f|HR%5wi@4Yo7+?-Fh&2GO*k^1-s>MY+N8I|gk&NpOo%2_-J@ zL(ZF1)r}rzaKuUAwG@I`gZ9@0N69Tc89RD7nOOK?GogXlH}Z&m*l{fM7=6fi1>Gx3 zT?dQJLLrGg+cHOdGNWYsUiNa`fsVG-;o_Y9!^DAniG;enI4z8@+N>horY^ZtJAIa( z%0SIjm&WcQd~h0{Ape_v4X7$umxPPA87ZA11!l&b-ezPE2%(d0vikc>*{E1Ms6iO# zpW>@<@DchCi4Ncy8yyjhDxrk_^qu>B(BjJa~x2;Ib#;w-j~~A4uoU`onW+3d%1zUvZuk7B*JTUZZ_^xBo5GtqW z!-xp1IlX_QERGRf zri-5s1sFsq0i%La*2M*9fV1x8%5Ye&D>!apY*?t?6j!BW<)PL zqJ!F>OZFn4x`%_!gGttlusgj9JMH45re(H_4r1PbMN(PqSy^4hBh7aWf6Lk@#uO&Y zMTWczDxmMq_nf)Gy!fAvX-N{5?dsOOU9iH9Z)bp!CbavwG&~B!sToq8EyRHdeA*#E z_KB3(34Wd)zx?g>%|vM)PY*|dA^$#Wclta<@C7hklmB-sDu@=<;m;VOB8y@^}qO#hnE2BjF)S$?8f{hHvfGebhKLS}f7Vek($Ua4m!vktM_eef&*Y z|6!JVa`D%9JF-aKmj3ia5GI?7%*xo@p|%?4+iGr8v6rq%LlM1w)nKo~zL_V$v?-DC z)KkMG?0Oh-LQW}R^$X5a@U}RCGpcyT>(Y)UJ`5??Xl0-#sGVQ)k<#phH^GuhE2S@IGR_KKOGIs%23dmDlDkr!=XDirhM?!vy5VT+NO7b%UE(T z?CDgeqrh_LvI=7xE7p$rPx`de%0?ikFkw4EpMW0P$MPlfOCW)cq=;>&R8`6gJM=edT`Q!)PlfzrS{Fl_RInU44*(1gakW^f} zvVOO;Hrn*}jb%{G0~s_rdmaOvI>DOFZE5{DQB+D7SB3T$xIhNVAr0yS5JoGnG{}PSANOHfe5`uwe7GruSw{0dCB!vSXSa*kA!!N&8RQWo%w%N}Rlcc`r zU4ZkCW2-j%tjB@n6-rr$v+ismV>SiqC!5GyxHY_aqc2C+o`XZAg;znZoXJJ{8EU#wc zbrt5`$?sQX>;}v&_#W)LSA;w}sQ!&Y%@ZZ_qs}@#_Djhtq z9UR~RqrqTV zrp^dq%vKxL{LdM^lIi5~N`212oFB8SxECaTd56iw#xioo5-NkG$U$E&qY#;A&(*UD z(#IN3!;jZH zKrGV^v4dE_bU-;VlNb~z((dn_snk0mr|FG!hVek7Z~7u}#cSiKmfLCWG`@vvYVnN(lxj{~z>bSG`uh5zGtzQH&GpAM4WGnW_b-gD zjR+@43Od6gGhs7m(1VjYK61%fBZO&R$RqwZePiE)j}LjVeF%NqsS*mybHXleX+sHP z_(t9Dk8!rYJ`g|9;^YUGidyV%U~AZa$u|TJ{9nkP{ueS0Jri=73?TDk!>4{^S&eEA zc^bvJm%HN|upvxQMLmXXj~$=znG6h|5VXdslEq#ZO=+VK8d}=I%)tX+q5Cih%ma|$ zj$M~>-|U^y;aFVu+qH`oa^_|xjP&^@)Z7TeNoK(AZCwz+;+ye^~5=^sZV zR9-xIaI6gIdGgFL)s7q1Sn9SPXm!W$J-}=DtCBk>Yh@S z+f}Z*Ej>i-s)8ap(K8sgg>y`LW({2D@5+c60G2r5WYDGcEp}vA6MEc+8sfyRV`_VV z*%rfSDJdxmOFLY@@82IBsp=E z^hR>f0sTbYcZWKWT&ABr?KoxV{p7l_yk z+sK>@h>6#T^&HL@$lDwxv80Z*Is58$TA;>N+7t5tKa1200*QdZV8~vvR@xJ91kZmR z9R(?C%}%{$%Dsm~_|587+ey<#-@{uFW&$I%e19yqZig9N0d54ne)540?CCx9(f@*K zKMLnRK7ZgL3VL&dINsh5PvT9>MjbibJ3SZLcqMU69?g5xc2!Z`=Zv0qelU=GOp*Oq z5RN_(#c(uP>0n9~C#RC|e`=i|M9$TGgWuZC&WKNC3bOsNjf4lWD(_8+ANB8ub3Rd1 zgr8ap%lN3(;(G4*c6rtZtF8Nj6i4 zn0g4L2_gENzUkciI%9JHm+DaWT>xa}+5-Y%hFm*GJNq9UAl7>n{ZAD+7auN&lWxG| z0#%wH<)q_yz1|bR!|DuTkqa|CRuaiV98EbJj1Pt(sQK7u;vPM0Z~QemKxmPTa1g2* zA=Gwug{)ITE<9>qLV1cVNQaFc(uC|hH0lPUSBVkx2iTZl{hpNx*3szC{Q1aQ1=;;O zD|eM*TK(?^*BfIk55BywRJ@B^q)YJ(?0Fs+67lxKKL=T7=4sc5uusF2k%3VN9r^ED zSD`;c_l|c3pS?Y1qfX7VKeI`va0{QJ`sqWAL2zJD~uii}~6+~QK()BiDOySfzpce^;7Mn2yAdu9lq6D+nV z3XY!Qj>hrCL9aD1r_eYt?5(qI2R(KM#o~L#xykHq!u&2X@<>@eWfIfIf5KqSz-W!; z`&6jJ@_pOSURn5~?jtM24$V3;<_DCI8-$MIM6KTa7rGv2%&2qUqYm^FXo@1vP9y}n zeJ7~&5pv~L(%@C#F@i6ZTs;u_uP`h^zQ!PZrX8923>EbgD7#&dP_TE98^9J!M6^5^ zWHJ$FZ0e>Jaboz=ilL9|p|b*SXFbVdlXDwF?g|{EXbTP+;!XqLd8=TV?cd!>Pa&xT ztXiPPnwOu0=+W$>7Fl|7rP7y4ml7rAwE?N3r7Fpe^<5T!9_rQO|7@jKUfaL}X&cs4 zB_gt~%_N^=XMWgn(ud{L)_MO|$I$)Z+Fs#y(QrVbi`d)cy*4aM&5h%3z-7;@oPq?Fy73O?qmVlPP^d?jHKFHr^DI46xi){ z9oOrZ-~gGx14!VVp7_@E%?StoyU8BWEBAojoWke%B;MtXDMsqbmI1VyM!->dX_>qu zyuwN54;6d?)N7+Hp0RJAR4k@{;Eedn^?-LH?nRZ)>UVenvj{!gr2Ffc3Iqv@0%@(s z$CRo@y>T)b6+<_aj$p-QJM#Vvm3KF6Ik51YFWs0>>%pMyc7bl!i3-2&3x-QCU5LpL+uJn#1l?zQ&1&pCTv z`wCS(5Ym_OH)nLTF;5>>_>0{Nm_h{h1i)Nb6f*I`cfuXkT^W6&U_w>^S|AeYeJZlJ#8CG<^q)8e`Jaa zJa!lIy#PbEy{=a6VCNEg5AH`wX>Myf6%7PL$~QFpYQz?@z_HK%^gG~Uy~N0S&FPCK z-prod7IlDMza3;5UBojWR~*MGF#i@qHN!%Bf&M32R_AmuanX`EJ%+8_y4cE8@}wCf zUA3Qxz(}Cd@HPsDQ$@2!5iR;B2{Ou!vC{D?#WR{@zQJ$LOp>V$e5vpzIa^D5e`M*u zzc^H*y?jqBhyu~#9{OeJT;=X`CcS$F2_BA+s($<^e6nC_OBgpXyvJqu2}bW&+x<_( zA|%uv2HULkWmG@gGmvCVx;1gvvsVHp#Z(fSsJB7BZdC7;Nr}R^MT+)eNe=%h0Q#{A zEpl?6(x6m_uHu>Aoo&Kzs97scpC^fg7l7{JFvPy?zv2vlUnd=95Y?|$8rUYiLpTRM zsANvnZ)psjSb-p1(x(-9UuxwD4L!%?-c}~k05N;|dqvr6NHdlF=96nYZ#NM)!y9Q6 zfCk}0`&b?yw(@-wO3Rkd#Z5TXQx|oFole&+_8Z65YrjT4%C}LRH5P0b z-_W)yZ~h1~VUG!_B2C?Lre;<32fHEiO{`jiDc9%`2|XNjbO-nhT(TD+@A9y1VeUZS zU(1wD*r#D=yC*5SRLI=ZMr=3_?hjYVHQwCh#v-gz-G~%(h8J01Hynn%#o>uy8oVTI za@gs+q=2ZmUv+ihz|6Zu+oBNoisR8Le#4)teGzqo=rlq<_0B%D$l3AYs!t7{tGS>| zE2AyPe&~F70}t52ng>|SgBNwSDxHsUru>#36y5=Cu>LikC@v0{p=zy6=bPr5k!P05 znBP+IS8jTB1e5dW3XXY6_@Vb{V_=qvIUQPe8`uYA?5B~dLOvN-e*FG#qSn;72`~F& zKxiu1Vnpgq!a0O~sUfg{Lk91UOAN7t8nM_uPG3zvb z*$}whkj=^6ox%iiowB!cAn_mdK?JqzV)FrC)$P(c^IQKH+SF&S>WGkQB-e&{BoFIT z*n&7)FA$S{SlwW}oGCB(=Ki(*Y|*lGtjup>^o1-KhCapJy*$$uk4Y8*jQ7(mtB5Yw;`t#`8uUH{%Ba-!UE>OuYdNny2aPVf7bY^4wSwj#D0c!4lTnZ7@Qr7ja#f0FHgng5t$`T$;+Zl1uAh z>iDP873U9{Gq>niAQTJI!wwUdc(}i=PeHR7Xtx;{5(fU+K0R(xtUy#ap(Yjf(6Zb$ zx??82pN!erG#FfO?Y<&iFCE~)3Roy;*9(lbrC(H>)+NY3r@LFJs?u-#6D`9DZbRsA zmF{S8Ri0I=q|##mmE3 zz(2)^K&=u#^MCI9Xj$IB&)UZ?bAI~~qm{9s@_&<{C(<&ry*2#wY|$YAHa`ThR82-5LV4w!stwKwQz+or2!2T99bZEdU2Q+v8&`({1+N$1tU)h{ubEPQ029i0$hI z7;>R;-R1b;+cA|E)XIsIF^RxKD{lvXX8+(?LcxG0tmA$E z&0|=<)T+GqAW6yo`AO*uK&9J`xlxcoTFss`z_~on^TKOmB#p%(fMLw|Bt;QRnlZxD zj3g`>8*9Vn;#<(B{7)Hgo!=iiqFtw(39spbZ@s*qx~eZ^51jLq)VKjr3#pJ&shs@k4l*=udLh zPJ9;A(fPu!u`Al8{}9>rhy@EndRy89`9eUr9A9|-Up#kUqJpE72iQwS!EO)zi&VF{ zkS(B-@^0#c?v-m-^aN}O)3v=tdfYX@h#6flaiLOpTiY}>fV0P$93bT0|F51h_R@gW zYL14k_n?}Hcd`G)_Rx^?)i9&lV4a9$@>5f3v~rf{WSczuEr^CuPh+=OLKgo5L9Pu)&ly7Kh_GR5$}nvQMNpP*!`g z3^pD@IIu6Q19-}TwtV84K8@Akz!lMZhJ4wC+?S+5r(QqLC5xnJI1SDZ;+RhfMb`JX z1YbUEfCpJ>IzEEmHnt1|fK4Rj@pm0x=85mR>KSL!%;7WOv1Ud9QLTGhcn<%3o)(Pm ztZ4!0&fAscRJ>~vt;>Ar`bFA;L;YL{()Jkv+KL%%>!62C{-wl0uc+JnpSB0Ji45#y z^toaF+<9#g%y?L{t;P!dfHcqB|52^ISv$nOrlm=Yy`vokB1C)8Pn zhF;y9_;TIPctHS^ryIuiX|!&GlD6U~B_A;R-Me03?9K+Ay@$=0Hh%^1D?x@ZL${pq z1FNT_4Bue5%dxaKfx}_$UQT3Gfo=_U-dB{~)NQ7nfz4^dkv`!@Mg6ZjW+D^ZsvKqn zGinx6rdqPDdx_dUpBt%m<(xeD3ZY#5# zC%wIf2`fDo$0K^K{|XYwA3_z}mXvIMoNO*cs_V~jXomjA-T^dFcw%&D}4#?h+8m zSB;H}CJ!F=9a;|f{+x$a#hLXTzm_&-z86sdMFQQGcx9aF**<$jPc_Z9a#!4M7OQ3* zSNB%V{rk{Cm+#>ik`oX};phXoxw^c>{!cpFE2w>uz{N9QoQbgvIJe)EA$&D~5K(&~beKp%BB$zdmPLu&JZf8(tGz33^%k=u*K(NPJ@ZO`yt2Cw2$q>}C9YN!#uGGbm|O$Jp2^z0!UG%$+=(^1|0#{JqpKbJAQg!Af9p zuKmB3hq2+ms{6C{iHP^kKjm%leVBL@J@R z)Ip}|*DUHF7bW^T+{S*vuc2xQbc)HLmxtu8S%n`dI@71tQPC0$P~`5JSVFQ$_vB>t zXgVQT?QBV|1m*ZWm9gj1qQz|N%E(*F^am(q_hXR=s2-=Vs$5fv+#Rb7-srS7XU$}- zVZ}~>H(e8MKrg{2FmJCr6X@Mz8+1+|krV{7J-hke@Ui539u2#Vh-YZhYo~}e-i!j= zIUOCgoiM^MVLSULxAy0giYrIxdDjP8Pm^KYMgfL<*MCHAV>uNf!->H?#FAmSHb1gD z*PVOwgSu>8EPIV&YB5$l{3cQhlgS7C!q&igOPT(EFJCw~!H6zNLQA}JF;hA^L>+5P zXrrS@V#bk-qs-EWoM9Xo)usL};04fux_DD1q*d`R{fB$4Zr300f4rZEcB*&YEI61D zSOk_?S(X_3St8~|2jK7TLf8B22;{wjUz_RA)SU2zP_YD7jKctTq;%~_`T=Zc>rz%b z?@L`}UE|su-D_U6itq2XOtKF<9Xsx{|HJNbp3X{W9N+h=-nHSZq;-3TV24ZqQV;h} zbG+se9=(8I@K8pD-dY*lC#pfT(x)A|KfddWXgcZmG>Dih&9@*ROX|6QQ+V@jOsqar5R?ciiAQ% z5&lzC2_jcNP)Q!Ko*TCc5vgkpD~-m^7YA%rUWC8jg89l z$Kzi+8hMPKbEngwRIQzNpG{T-jh0i^KG2^aXkZsnmuZ<(iYM-%t%oG`#3{^}H9Wp# z-5_@{993U`_rR<@`W{RFjZ_Dn`)h9xhD08V5xzVP3l}sdK(~3ko6S8|syoARKydRa z=5ZV#LN>)I;)LpSa>lor1?ub84``u}?Rt0sQu)4ZfIF$+V9e9l-Twhh_f4X$&u>-# zK+sI{@8&*zy+a@Yi162AI?vdgmvgW;i?Pq$!sDCh<6HLuZc3XMS;2g>iyB0*iHVCK zn1RH_^&avzKdWAdz8f#7w6Q@H8Jrt zB80pmlDMvGG}T=M{ydAJq?a+I7~c8r@1mKNdJ<4qOnKiRFpCM`i$EekQ|Hw#nhx7ba zCksU(H-LY-4n1cPnXKUIWo0TvMIIpG;^}0R`YKpD%?a^%G7Th zY8mC|1c!(VIwm|@nE7xCv*h^qa$M$Pr8`G!xaib04vhYlIY*HgFUuyrb&U0Qlk~T0 zF0|^u6Jzl?>2t_)YyLVjtVo7Ht8GRqX|;3GFJB%n>#4(-O!>TX=3orD3|Tfk6723A zb0t9_F|X|0Pd=}Jjz5|HmV(E2e|WfRnd%^BH*Tj9d1#p$w3NIPD(d<&+%rF-6x0H0 zhUFYRJwP{Ua4%ILBcghyK%HMgI)M-ju8z6X)VLs1FpkE@Xp>AFt=O^z%G47>WpqlSU1&S| z$!1&XrmX)@_+NtmlzG{WPv0GGWr-pzr0F=i=l=XK|JFbE(eKfm)s`2TR@A1^#qR-0 zNTkw-c30en8}c2KGHbB6Q>TcwT3_4=KxuZJ@1lXtVPIW zBM4knn-V}WBU{IU+n8=NK@$!7sESwi+)^6vp|YfuG2dLtBA+o8Mid#_3I;NMQ1935 zr>cqt2vHQdn@f|85}>9nN^j>yyO53_GNU_lQ`b7nl%G5=;PjS$9W*S2M#Jpxy^ z=O(60MP;PMVL((8*bjlfxgT}_HIrI{xXqYX*+L4@@MWEq-`adFERA?GiRXR4f7!jb zz;#b)gIz(Qcvx8Muq02>CRF7q)K?9{VLkw){`8MT_YKL&6ByFgMGVqC07NEll+VX} z5Y=0FR@U%|aeRAf+C8YK>8I!fVhmnjgCf7nXj*Rm0kK3A3#oL{H~ z9+``y3{*|aUR0-g!?q{o-xxZYNZpq{m+mlo~ zp3@n_(_C=E%J0^Z_}Wcz&X3+}#ZkUm^|d%~6Mi3xt@=Ap43~9e8S)8EGg_g)37PI1 zQL(Nk%I44`3lI1VOYwkpiXQdR2*vTr9TIKuSNsWmBBfarN`}yzM82-2nh1Q@4TGO} z0;T7BIV%lR8G%miChM3CQoxc6#>#W#S*2tB85lfEa_%Mx9O@8!F@G11+qABGuAMMj z8yl!~Zrb$BVkx>f*h-eM1{Eb+q#bd_^P;DII1Q1sHv1Q*b^XX8EwKf_xT+Atv3>1H zeSpyX=*UWhDZsLy*s(@i~G{tGzI$`EIREHWd;z#F;$J*29OrC!4<+d^sA6``Pd z&?9E#dE>!o9@Y)dmxz*Kv6~ELIQpnFQZsJPto`!i3nYDb}X&i2ysN@&9X)hjz*GS*j8X}+l zB~w4nxw>CIJ^Ayzhe`ZJ3BQj%NQ`|{zWBQ}I4^`cb=5(KPoy;U$K-ahMO#ZO+J@mCJ1@vkWfLjO%^=jrLKs0{6R?sXGB zRUfZjg`IfN6-3m3=bq>i_=h}=!{pV^7)f`16?I+KR_Xh$i5|oO)6nA~YA*h;JB730 zn;~A|2-O!3zyPLfON23u8-Mnp#aT!)p& zhZ%-1_Z#E@Z!8(^NhL@*H&^K2!a8zgF@8dCUCcFvUb&!YvUP2eB{@C3T~E;-PbVx_ zL%{2y?^7m%Qg!R6A~Mw=|Jic-CjS?X15aRRJuth^(@G3<`=CB(L)?(z{ZZ0gkzma{ zXsU%cyhx3zeV~m5!Or5}1=e2&DZ@m-Jx(~D(nfpLV)Uq_2>12iwSDquh6!$sPaZ>$ zx9U4Ln>#OK1}Sg?AXD7ypFDrk+85i)mxB7~a$P`2$Sn*xW^cZ#_^|Tnchmo{8$RXzaW>ZM zSDYy5|0^=e0=qscO@Rm-^@9mS7a=h!o!o0xAx<|Cw}F{7_^;Q?7<3!zBiDoB?rPm)yYX!&#k2>-_UE zP-(miPhWkxf4 zuRhabU2YUjWy6O`?D!+X7^qj_D&Ai=uXd?mCeZBt{B%unuMF?|M^@FZK;X3RTaeUkt>TfR{{E{Rl5{p(a zTu}1~0g!#g=6?=(a@g_`SL$CEjv(t$eeWv5;E$#!>L@hBDltyd9KpW&nLy$OE%NWt zlv1KK|7PFjw+nvCp_>fpV4OeL!^h(X$Z8APo&@kGFPZ3?suf4{1rhUa2is+X$Y`zU z?0tDc!AHgHqY>IYY&uA+8)>T5{N;V~WXfP<9^4!$dAr9@&K2-j7BnQUGe(L+kgPk+h(s^Jd zj&ykd>_c)GVo&44#7n5VdHEt6&M)E`x|!A0n8S8awfGpTDtJn+H|=!AsQK|9l`WO_ z&MoO&wNqdulDA3Q#gPS>%Ha&9B~1gQUc@ST=c)Czi5<6XSwFeaN(_kE|C-<0>H6LB zt9mVlf;!JESwQTOIj>#*R&Bw6)ZQqnsWbwS)OD@9qR;JL^hR%3pamao1Rtk6auRd4 z27u6c(q`y`R$tfI_UPxRf71B1tC7#vF8Fq?-0@b?36dmCYmc*-Me)GR>lv#nl4F8x^ zq+1^KFCLo~KP&H3az8_(uRYb{p1IeEHiqqYhelC_Z@=Gw+<=o%13Hb>-rRIc#xNnV z%MWIL-^k+H%v%@mP^^8>)Z1JMg55kKr`K}!=9xY_+RWq*?+=AZ`>wm4t(5LvT;MoE zj)p|ZvDj;*x(_7%+$z1Z{dz5K05t7wyTr8cQz!v!KfwX7;T)TOn*WnAhw6~;sz7hw zBtTv7zsLGjmKH^^lL{=N*z6wUoF~ms;RgW@3P9Ag-1K#yCrXW60Lf(RA;qfPG59nQ zirNk+<+Ae&K5?IAm}26n_q9rvHtpTC`j6M$*d!RlKu+k0Dj2A)?o!E1x2B0L!jo)2 zZ{WLC8^TObJ^*jKeSKQ2wK$nl4--E)ya3o{Dp^d@v6sv`APH8YfxEiP0tiG(fv-Xo zE5$CVN9*ufvI8S&l!C85!t*GJVKqo_il9Aah?X0ng=yufCyRUGHBw<9Ww9Rb#KAaH z_!e4OI?52By{jvBY=ce&1_TWBjfKM8LOV4F;pPOEvh9n3%9)C#(9g!VC&bw+*r~0W zLKd$jf$K}1kOdEqCu}gZ8+q3mxdj9y6Si{YH;TJ|bNKi2XJrQm#3w08RcurOEDnpv z8w)OVFODDcr5U98qmYj?p~Dlb@kwEwE4IGl)d|QAe>$WC0tfC=?-y6y(AC9;e>pTG zNL$^Y@DX*Mt8lTRFryINa}H~`Z9x0{n)vX}st1;Z_|s+wKZo*N#9m(wN>`-;SCbMS+3DLCUv)wZ$CU0qntrprI!hMTgBRb|*4mqOH4GJ@y?Ufg zmqmpXUaZ7a2W;Ty%4V|%nPX=kC*7vtMUNTOUe6+&%hw9uDGSE#o2ipOEwxO&?ghbe zT5fs=%KGs3dt-x5SUJnw<<-|V>tV+!m=DeS)v^XC;LDQKHB6q500%Jw#?)42^2hQY z8;6s-_12#TT2?DVoxk^zv;Xa4l%lk0v(dWx>#3zNym=zuk#M&dLmc@FuvJ@=vP(%} zRZn&2r4}J6KY>)!ubcRT-Vojv5!YO-=X~2Xk!nI-dq8(MVB6Upw)c5?9F`FwscFBK zhnW$Yh{Oj?(RbC4U)M|ZVoq)mPkw1<*(R>rn*UG{aD;2}vZ}N9-y7|Z<$d}7g(83{ z4yhm=nWCS4lc%ut!Y8VL;6tzq>T47Vjtc$#1|zan6kPbfa|@$`VaBBL>YFN5BRW9T z;kRo=b6d^pRC98I(-%HRo#Xt*A&gqrK&IFbT_7t5@;X-!D@X?w#f){G?apkHWL-wp zc!EesaUcJ#mpml7+nr6fw)tj3J}W&;=0|izw0V>pZ&D$R#Hr!X$Ye~uMH(fOXyE#b zvKMXWV*O6L-bibQQ#+Uw)oB+=F&yX9u66Y#i&sl;2vHQ*Nf%6R>D1B|36pa4U5&D^ z!(7VVoX7PcZNg`uUo%rH)T+h$ZG{a61VRQFnNOHc_1p-(# zhgytYLsQhh=MZW|>+zq-al8nJvPcS8Hos(2MVbI+_X5mq5cvLhMP8aq0p!Yj=YLiv z)wr`j1zD@>$ef~%uDi<9&a*k}t}6>Dv{=stAb0hKpF{5SnfKLtm>q40WLf`!nR(}v zuc;yT|K#pu%Zd^?eqp#}rlvG|7Asu%#+=2$-5t#3mDxjj-4JtN*Xhx!syyuuU=2P`%H|J@TMBrmLL_U3~Yi5TWCC2nXgZRVdC z64ZtEK+Z?>6i_gXU83IZeL(deqfq3B@jBK3(b;g_SeodD*hzkSMuTOlTaDi_?iTUW z1t;#VAQ|?Xagv-8o&3puezPXC8CzFQL(4bW8mwC8^P#(0{5B}5cNTr+9DCgPD zt>yQRm60Kw1@9an%353>G*T_$8Uwe>Haj3cQ*IS3LXI0sIQmXnWKkBGx_Ts@nKvr0 z2iB3UPDntBT>;~O;fiMkbk7ZrO9}ErIXcMxzBbIZNm_*E$3_-E$XvDx`Gk|+^_^Laf>-{_B`QXsc@40Go z$O>HevA;jmmG|7aHr|Q?dzLp7o-AwZzSATO{Ie#jc;&b@VzAH_XYUg!@witcXiT@n~ zs6fxNMJWXQNlM@0!y#gl%84Pym;cF^NK3D`PBN^WKppA!B0c>c07|?24gx%s;{7Cq zB^@E}?!fR3nC4&j{uvq(Kb6X3Vg<8Iqut%;2su6}=I9CXurW(#2RrXh$bpi#WYMKwIgj&bK*IIc=E4{xKDts!d@Ob>{A{A>_1%q&2&eXJ4^0 zGobT{xtnoJ3N56SoX$gGd(_W_&ar{^;{2hG<*Sm{07PnV`a3{(Mo;!4Nbj~advOH3 zKd_lrgPgjLS~#FJ@r8ywbu9Poy*5?MohO3XxJK)VP8OZpLSqTgVMsZ`ubln%?scCy zU7!TN0LL9Jb_@papl;*-uefh_^e6J;LrH5_NR(O=ucZSov4xx_ zno6A1FuqRWfK*cNV;D;V|M1=?`}nL^ue(RiSZ_Pba&uT93~EymT%tF3PZQy%e>96L z5quy6x{2x`t|B6SY(EjuFv&1B{RbScmZ5 z;EA32H#@u;^LMR@rUW4aQ-L3Q<{16R zl@<&u(!V!^OC7Tm>=_aUwONO)b`d434$FUI1ckLB&ftv+0NvR`;_2LP6jN~DYhZZ@ zH^+9(MN>PFhf9T5Q+zS*Qi=r*y=0n>*aC!H)#twy%?vhE!=;ST!Mx=lT*jTSX5`dhi>rW8 z=6S8kOKC%h=h6iOZjdgOQ{GuHV~yY*YToYs^i||F9t)W*?Bzv}AO6g)g9r_SULD|I zUF@oc(t)Z!Z%%G;9P2281emE-+P-1CHF>eE|U`l`GxSZzsYx1 zX!Km{zk`4CF|*nb>#%m|Ohqx;W4jV4Icp?k8oBDz3~JVvDU-g$VBNjb>iK~7B*T^L z9S)09iZ*y0Myg%)zuOM5oGuL5Dm0oNlKU$r1mJ7|N&0r^sqlanVx-wqt&A6)lh zr-Q8})otzduRj+swQQAfP5@ZZt%VCOi3(2 z1>;=K;hA1>PJrnT%#KY(m1Z9;eQu+ht`a69X0_Dw%>CtsCPsaW=r{h6TCM^(&jLA0 zZxxzp1snr@E{Lx}emU&d^E3f%Y%w!Cv+q6R_>Dw6}?U;+c zpmrTE%DinD8u2eFuM0({_`smt##&@m~D@6s4Wps|XkT>_2xoVcd81@G z@gZg_3q)nu`eSS6S1}{nziRIyiEmnrTY~8bSpoS*U+?w@5u%nxdMALChdWwJ?+`}2 zcOC|;-s`~=5UNubWZ_h0)dZ#++Q_j)31*nl4XZ?i2qyU2LIs^PK=|zKV;yDI#X^3*Z%xjVf+3!Mn7TaQQx!wB_N_OpNTj$cX9nunY(AtB-?mV4kNUv5T!8;sR3F&Y#yEQmbymv$f3c zYpED~EGr?(?%Ve6(Z1_Fxa|1)dFa2X9EFB>@+oIE};o!7#u7-Q*?XXt4Lo8a>tCKFTToMu|A7 zThv>0^@z*odK6b5>p^-0USSsBwGU3J_YPObpLI3<-mO7^i)q+ z5{Cj%GOBBx_tH?gReJ$%;Fl12Ui@#vT{=6qsRX^5?(zumN%7{B8l$5kPU4=8?`mH}%hYFRLm1^GYVNBx>=Ul&CZgI}cbKA|iNzDlaqsG9u2{Z2e%a42 zcyj?%;+T2ko6G&huqo_CGiX^DdOmYI6hbO;PUa{!-=|DVFiPxQEdC+%?ZXF&A9MR) z*U#{fZLCc~b`vkU|Lmzk0bQpL9bgo#ge`&(Fh=tO$_Q+i!TBHhOabj@a5xGLsVd0_ zv~=xn>xQRhVOj)6k!CrZ|MBU0&NR1opFo z7A>w}B@w}KSD}^d;8#bVnj9OBv#-5Qj{E$FlBJQH6Ly_6+V+ar9QiLN8jW|L5&}HCj<#7P`ji)bD7Rds?b% zByw39_vq7$2ctpsv*L5P>+#?lw6@q@kc_*P}ZKiF% zYdsVSObmZG9pgm`eEY&FZWRB+m*Up2xw?|Ht}Q}z`Yq?}f=L4Jxb;#-0fTz-^3W@y zMcs;hHgj~R_JVkq)0J-M z6ZQ=|zHAO&7w1S~+Z&OSJgHWa^-pycH6PoAo3&*_^SCz(gbVd9^ZN7%m+alORn+RO`97Dvn~R zUvoEuRmL@}PqxHDG^}d#x`GTP@(ceyfHgpU*u*PZNn4mM~-;)1cSjasSE5)+JtfSb@tk} zpbpkzv7Ec?pvn7ja-CDx&N#1|iK&6UK8tHn0bo=_CW)&SW8tQvTD{?facF#X^g##n z`2&-uXcJ26qODeKorI8go#B%}Yu=cp?#2O&%V#37nsLzeDvd50zpNxHdPUy5Sd}j5 zs>k1$&<)wpAEYwZna^>=SPi}Yc;&fqQPt!6ZBG}gsa<%8v&%B;K1n|O7TEbdi3|g6 zEoeAZV4Hn0SCeoQE;k&714mXSo7@7utxQ~JH5Zb1Jqs>9v|9o-$mV)4(-nrjM~W7{lc1mDqW(0V&3&8Kxl$v`gE5r!OpCmPal7GbP2X^kYfdtID%AS=A@ zgZtjye=jslY_{|Eb+UU;G`blBIVi8QMnM^p^Q^hPwJ~(y47dQw6c$S|Kk=8kO9y`m zGDs{35B@l`UTAq9a;x9wOU9UtZlC<Fu9(_`-p{@|W^1>~g5nCJJvEVja{G)9H zI_i@ip}tmuPQ%@J@r@ZbpLL~%rIsUp;fJ@BRK-3`F^fhRF7-jPK*IIy9WuaWkyxS^cNDZ&v|O4 z+`@(+m^%SX+u{Xty)cP|=@Q$Vl%q=C56Bt5@8dHgLAn)uI?RCGCWKg5WiU2I<7Vm5 z*TIG}9yj&V+?htk*EcP2yL;S8wY7))gSRZ$^gz)rB-erwUJTkm5Y#TbU!x(pJ!uyrH39bF3iv(s= z-P}Z}Du8Q%?~Ir-@(#%NTWZ#8m{nETN{KbIniUkrSlE6xeRKQfCfn+KS@&8YU#!tE z`IjU~Le+YgO50G5FDrbk01Im_yNm&4mE1tcqG7S|y_~}|N(V?V2YFQ-jMkNjix z%w6g@sN4O1U=<%Qzu|)S&n)Obfij!x8s|Ta*zSL3ApdEBckUjE3m^~mts`M?>(ED+ zoR@XLf6E||w=@;@5um)GETGhV>!OVnnnm2`K=!@9^NuE{Ocj|itdKPQoohBnuB>3s z=WK6^sH|Da2r}zU=hA_C38ZB_EW_GbrVBM!BW(x#MwDFb-nl%a}fhHnT- z1eQ5;Hd0M}qc}=+jlT}ge!|9p6d;8Zh)gY-@)o0>;V$mId6*p<6}SHmh3reJhF)C z#AVg-kJTQoA%HB2EE)}~X###jbu&J7;p7eB=`q#!b=i)Y>l{gYJROm>{$*PCZ~z*` zb|>$WQ~yA%G~hiWD}}Q0Ke_!G?BsWeiip;oK&ZxYmvyC z(a~UKO;w6CAhsEpE^Q789wW&WlpkK0{d`Gd&R)fLgI*n!;lPpsP)@IkIj@}M1)Rn- zZ*DbpTs?OW*sdcUQ~=flBEN!i0I|!o04@2)#m=#jB);VdF{L3(q43wu@TDP8`}~DHfRrSW!18f|8`IwvoIV;(P5#YQJ>vO_i zUS66F4f8@nNUF&c7k;ToSC>yqa=mEQFds!w-`y;b{E-=Qs3SJG>$E{XcwLD(2MfHg zEsS@?i?m!xEV)myu8b9$`_#i;@Bb&htBe9LdiFZ$) zGhUvylm0W&_VA3c^2!ZWObF80Lr3X_n~&~FZr)_Amy85+W7VIjbC)Q{Um>xoU+ek5 z0ds>x8Vz0b>W zcec2h)>ku~H8D5_)$F`l400w4nA3yiOP5T`ohmM0aosfzvF!W?=z@9bOrOS~;DDcx6ba&^wH*6!{*7DpU?7g%=W|%NS zHcN<5&H{tQ?%1o#d3+Ih2-r6m_W5c2j2?h)(UC#qc^EJldOkQs?yfwJ`$?}f5xb{5= zbR77Ag~_>O(E5z0IIK7+E#L2>;&Uv(M~9R8gq{PJXkN-lLyx{AquY^>|GP0oK=ZL& zv_@Hg)+z#}s65F#iX`<^Xx(+}J^awu6!FwPuqpg=8)3z>8Ldjtde+eL@nP?FR1YjV zv*K{zx6@6t4Vh0|1-`__-H;7@ucwquLg%hx+}p#Z zeC}Oh>80J>pWVfy3;C#hRvq^%6}H#8x8|Aqh8jk-_-XY|a|#x~%fQKS{L-L#k6o}} z#SZuT`9Q5q3MAVJuf2(|;WZGbk4CGE4Ek^oD`W{CyUc z=Pzvl(O6RQ4&sXZ#&<@9kajE0XfMX-Iy+N$fVni2VKP>2MyK&^wa1?p6ab$8#m|4( z8Xz&r-=K+q$jU1h{MpCW76_6=WyUzEI21kfeJl~H^L3Y;10ncbomeJ{E?5F)Q*4W{?Ofq(Y*?N`!46yi{}Kk7a{#rPqrZ@)gI5Vgo9Z|TRgN7zxg!!$2-mIJ+dC$? zhue}yNPPyTO0B!SZpAMLHVFIy?^*%aB$NJoX%%2mRH$Z0wEn`79Q5=BH$SiGPuF>uulUng zq6AOvT^~YitA50SW+2LXB1(PG;rlhP_&FE6RzRDZQ+9zP@yie`9T77>_Z6OtK@Z-CYC`|LQmX&v@rM-}zJoT!!KgbMf-@pHF=1MrRt+>0pf7Bz`c0?62o*{0vDPXO`1=`m+6rMcVNN0sRl+M_qQpmFE>U}~Od(VqA zq&|myIE{c=hPRJsXOkg~?8aPdw4ciXriVZkRE~i_mHcOz#Dps8P+N~rme%keXaN8y1Q3!o7V~3!%!x>_~+k7S<)I_d7-@r1~D?}N;fIx#U6zqeaDhmmg& z`QCS3FreP+ndY;jN?Db1dTuqhI4g7r)PsGJx~r}eLD6{>9K50SIm`RJc+1j#5~?)u zDd$gUFO{6cjB_xF!7yub0U{#Cs5UGIv&{*V7*m@#_Mpih4C6Y=83Lwx?N z&)-)4df}C$R%LRpaIX&DN5R(J)wE82H`!A2ZI@JVLUOy0C0d{zb>b&i#@$-kPf=K& zUX_i49Jvl%CA6Jrkyv+w7e~A8J^`_F1npxX$Mt!N1)EjYb+bcj*2D(6VR(sMoEQbI zMXHdmE{#@2D$&Mkw6H%Rw!n&>&m|LRq6DkHm&;<{LFzdcY_{$q2#2x4G!I)6U8%PE zsu7LM;{=7efPKJEx1IJJy3>EF5X-zj&**IXuodJjK(5mY!X$(!u;$=UR#qy>nO)p= z->D&FCaue=oy}HYT`iBjytIdOyAHS>DP(DDH&2~B?{%l91AsE+@N7rPo-U}-!JKv; z4+kgUH-6(c;#c4GuK4S}{*R&c#h@|B602vyTUtfbXDT;Arz*xPP8rh zIZXqq5dh9Zy2WMc5ec7^p=df=$54grDh^tihRmuZ<7x%!3Y+vY7{#BUbR_Chkt0;p zFTn{tZ`FO67p~xS&1N60d1Ey=$=(cI@CcG*qCFURvdd6KBBIZa^r1d@2`tRso?H<- zVqb`Yc0?(WVGC{D6`}_MK8UOM({$;%LUGIwj>#zSh+?v<=dp`b& zkH(9K7xDSeeAUWIKg8LFDmpkmQ$KD9gA{m`QDsP#XEVFb z{S2G`%-^4w_QS|5ZJtmK6Ri@f=3yvux44(oIbv<(^ti3Yc$YWS9f2`FsvH|`&P-nU z>*T#&^w4fO^v`uygA%~Lvr603r}l+T!MQgvWe9SyHcfRxysl?9ww?$ zgy>l1=GtT{jLocS9xKQdMnrV=KeWKL>!kCD#J&6uXOpWw{dKDqoKnKsBRl_ z1dyK>+vuQqd*6yPm>ggCb{!X@lKalS?1))f_R1%rFBX$%j2?kp3#;CB(~dHFkx+`n z)xQFIEO38+7eU6q{FnbS-t|x48UN`&{dH(gz~gNH;~)Q6JUqONFMR$Baesdwz{M0m zJt?+b>rxD6bcu!!lfS3d2`E*=;=8W4iIjS$e&#&kCfT=f_K^H@3Ix^JpM#a>k%NZ1 z-ERFD`-XpR|JfLPDH_2TpGEg=sXOury$Ke}HkpUsos@kQ6QkWkqgZ)X{3Mo~rnko0 zTD6sFK8x@iaq^O3+T6*k4>MQuN(vXI?HPbHH>?Ial^jOp)+1Iak{Vl+r40l5 z*7XusRq|xOI5VGPUm;|%;rAu za=^{$djaa~mUn_PnG}>sVe0&>U2h+yMRad&4IAcQB|6XBzfvYDz2msQe_KTSB>u(! z@qfg--u15dPygxvl4trc`9H)Lzxc()*r!{@wh>F?fb3Y(Zo7tp+$UfvtjcB)d#?sj zP_lbPD6~gE+qEd<(AdP#v7d$EWAk^_@8bA74>XhFJl7)Cnf;UzY#Ymk=vJ$%t6NvA zN``E_k3KSmB=Ut2pIh^m)=fbf3uM%`ng{98*uJ6bo(s`pr$f>idKETvslt!Wmj8e0 z)zATbjW&hi3oBjvy2>Vh4kDa!&{}cT?Snif$mXqVhyuKV-vC1?uW=7uEk%n(NAmZ? zxJO(%geqdv5>$i}5y@POuoY%bXnDq+Jq=8NDFOD3?Wmu#uIqrwCnlL! zZ0?OiY~>bxcqKen;O6JJ!tPbVSB(QQA_EES_mM<@M*FzAHkJr&qIL#$@BcSztJKYv z!DnR|Gw7H~BWf2h>jYGkf;Qe>ZdKJ-Js+Lqn%sK_lIN}xUS%B*2*Le z{mQ*#pAU4{RNhfYP&28q29GttR{lY)(47>eCZQm4Ato(!-AV1qNa-9fhR&ozTdAmE z4>)~}hvMt5%$UyU;OByMXC+%^h{ZvT%vE^pEW4h37%!0}SWc;e8UiNui0uCUE=a~d z`{(~W-t|xaY5b@E`w; zrfoGZ)X`GO3C&EX6mg7AyxMQX=&=wEA=@(Q0-m!98>frS`s1p@s*+UCvc;=*%klH> z)x$pY<#&);m0YC|d~vHl=tD&F;8yX34!eXre4SjyC+Nf(IZT8(hO>O^-5FB%w+7HI zvQvpf7%wwy_f9d6F+wDiFQh3l*3AKJ>QbLg85^t}%VK#u!Jo=}B|nN4`i6l%OHyDC z5|1B6&9TuC1eZ|D>FZ~Q?%z*FG#DJqdf@L)da8>(ipu-@x5bZs^#6^2_Rs%$TrQXR zNB`&_#sBiZ{IBulFMsKY@P|~K@8^sTLCViA2dhE0R*jBYfh-_Zazww5Gf=rF2TYBC zAr*_l>{<*3<<^Qs?`(pfxHmfips7$;ZPas&P@~)_7FOjxsS1cGR#ZZ@pPio>V;lvD zCStk~^OVD~VOR_-V5IpD;xPb`xO{lqgY@?qs-%ZIu5nF6|mv za-PGc%SQ{~t~gQX+~nVT+84q^O_O zixQoaj^q7Q=ptRYIMgfi_aWnv1n89T`XS5^+x3Du;hEVeC$Dxu9BA)VqaoW$)}T-& zoM)LBU>Qwb(d_y)5Y>xV$%s|6Ky|e|W|{4hifOF zzmK2%sEWewMvr`gzOmpKYRwxMjOtR&I0XuV? zGYQ$|3F8Pf-C>Eyg^nR^^o7YaQ;kZFwe7X|pnNB0Ln-Ag z6$=rwMhk|*qmKWO0pQyo-n?JNcn()}(E1&Z(XSq1Un+ZY6~@qT&^bk_E~B{j3GWVI z^W||wkSq?AOs%25E83)hhEA3R)ZLF(EXljaU2&>^UKUu= z@Tw~;Gmm4Z?l(Ey7$g{jw$Ps1UWuknUnJq-3u{ zfVq*^J%q>NWKPS1V`|H#+EiB;NguPqS&h2_1)ENT=D_HAYu-M>LSC7+y>iF3x2n+_~B5o^QO2W2wiJK)_dNNXej7&RYwt6wEVNyz?G!iH{>YSKW{n!2kB2UcIz*zi7Q{A zun=a4ibBj4BeJ*mdf~srC@_0cf9B-~w$0gMvFJxD^=9KjeW+Y}sxY&xqzIWd*=K5^B zhJ1ZSwC7o`R_ZR^ks%d|=g;Nt?8fjjCRltb76fyCEIvCLs@ARbXB8tPqZH~!xcd=F zAM5Jbd)UUU6^BxA&NV`6HMcjuwV3o;6A{+^a~L@QZoHw%@1A&^%z$umRyEJ4`Q0TjW>{M>bXgNe8* zK1(%iK@F%5O)5cs*ua1oDb@R_#A4XULwa7#v0H^GS_TC?>b-a;t^~-Q-;6xVfR<=+ zrtklsz0-{SO6{~?9x=O9A|~rvU3a@X?i~LpV0~xMbP&;2&61VC>KcwNa#O{JI;ukM z(5JISSq%4HjTd*TeH@efJW^NdbRh~{h$hDT%<}s#{s5x9ES`YRG0gEN7*4AmT{V*% z(a!m;D@jzSkUMNQtGb=O!Q%>; zx(Tubqoq?%T|B~!+XllP_r9eHIK`$;M@TYqAUaV9-U3y(H9_!apm$||E*wYgoPP2N zIMe;_kpPGd8L#<~Uto_jwGeWj6&Xwt@VXxhxtVv~ZP(iY+>QgZ=-Kjpsso>O>FkI% z8s~|(9M;ipj_<8Eno)k2%RO-p6@AJB7gt%Lsq=a1$(p<+Y#%#llMSBevn+-)gdjP5 zSvU8I(!DPS-3B{tBthwmJ8d8!&NG9(mYPGFg{P>Dxg-D@4! zbbWa3l9uQCn_xJoY|RMP#@$jrV^dgAcYm2wgz#+n1%jn6P@EIwT99bDVchgFrUJw< zqgAKaoEfPS$kh^d{eBwhQX{f1j>YJ5W-J0h9f@L{xfUZZpf(B_Z9!lYcc$(zM%ezR zD@t5Jk&6PoO;zo=V;r^Sv(XC`7V{l7GOU1869)^?5Lg6Hjmyp=GLssqt&uiG*p5hv zyeS5!-(nrZZfCm75wqN#>jTce|Dp*E9r8{e)Ewr#MnyBLgM^io(adTFBaJsoCkr+E zQ8ODk6Xs?H6RnD#MHy&jL=Gyg#a5O2t>QyfUemwB{cp_sph%9e%6S-z%w57^2f$*2WvfeOg+pBj z5bUI|cOD6oY&5rb`zigJQ3)i; zHKEPaqEdRhN878{!oS+?*5ugNgR2VQp7(S75elTMTZm_GwYuJT;3)Zy_C`t*ZYN1# zR^tM*aTB3T`es3(oxVgG0qAZ||1h=7tPp{m#FPTxst}f%NMqDc8KoMA-079~ham}z z)q0q*foLEKlh6>Q>7es!l@2J~@MrlQ@cP;+p_1IrsQhL^Pe3cfSFN^GsEU>WyI!)R zg?9yLtDu*zT9aXRMUG>>bL`ymD8LiKZudcTMG!^o(ouKWVx%C};eAn1FK}wNFc!Rn zp_6UM4t!VI<$H1Kz`eG+=2lGPuU^Ph0y9j39K(1{C-HOMe~44|-zSSB|M%6HGnV%P ziHx`ywc6qK6*k6f>XXNg`r}dv3x(;zvEey|h4|;fT^D(Kq(yK3WYVNo->dv3w&!*J zKP2UdLEVK+%zpfZmu^?6A-0eK-RMjy}~#0rh5gV`U(u5*ee z*DAlaVJNTaPF`H47b=f`&F$=mNv0;SSYwLn*Im#6xY0umEd2u23z1d95N^M}j&%BJ zn+uXKiK>q{WJf29uR6Qb@3?Ca^aQMEFn}Mm)cdKr(*zuR|i@L@8pUZmGmerc(sz6UDG@>qg-Kl$v&kZXS(O!)g-S19bJGY&&c~skqHCb zckK?%s0my1N3tM~)`3t&si|OtNRruT=*&DAgP={sD#}vjzdZrf5!cFQ#?sZ%6gWLl zA4zwocG&OMboUv~*{<*YZv=HjGCcSJJORO;{SUU|MBjxwWUDH;s)Dy5K4rJuna$|2 zU*8_V@`t*YM&XT&O_VOoSJK}69=*`Jgj-B0H@wrgh}zG%%G1gdxu+z~5dYBqr2 zWP`<;=T=8T`>R*cmn=0tL&gfFlx%oRcX8U~pW@z`fdXtt=YH0q^@3Pe_jD{W+Te&ewZ%C&VV~-FF?*x4$ zP>I=>1A3pjRZ5uB&$yyN-xc0G=1ZzdJ(q0yoVO>lYBRheJ$90t{xgT)vVQ>-JN!_D zPI$&D;3S2!%A48((1g38dumXehb=WL+yo`1=ytQ!?Y<49^G7J8Pa%K2uE%6KO(DF5 zRYzQ%0W=a-b?(zaarrI{-s?Z7?o!*Nf$5w^+3((?SAiPT_641l>4raJ(g4LG7a?Iw z9e=!{9_*QA5hTJUv3YdtnC0$v%6H`27(4eVzWVsv3uL9yQh72IBPQ2z(ma<{wp^(> zN?y*oXK&qFF`%XuLEGh~Y;=@kEH`3bWn8tWVbzgJ^)cBYS!;gk;zf{XPPUPcEdsIT z;EPH)o+Z70FhQCr3)nu1bRh>#fb-SZezglTba&&-)qUr_dX-%XrM`Q)g$9k(Kg zuygKO{X-?*QUJp~J2aFa@gB;|aJ8Ja@Omw{GU{F&!$P}%0$~ZO8xM_)avb~kz?pX# zn`iE3;@SrH(3ChMU0qPkxq{jxml)sm97C{qzB|7Z7KRy16Xv#o#Pg=mDW!Yg6QNFg zCob1avf&lVOjA%qC{p3-$f>*ONd@wp^X=Re)?o zsj9hHg1FM=-ic}G2ch7%KCcKd? zKfCM#$fB&b6i7{!r;MrO-&=ksx#=Du%gnCW7i~_7h{!VCOnjd_%k&78>t6gmx9$Wf z(J2irYx5`;Gb0CS@1CiPgBaeyPO&bAA{?y{qKPf({=(F*4MO)`5Z=s*!}xbzVb+ql zECkqc4&VwzufbBs#j62Zuoou1U{bc=bsTclzkta{%DV!$pONEE*9@Vw_4WC=2m!fn zPHQ4V5yaO3Wer2>UTWtDB;yDR9nzo$Fpz6`$kjk>FgEc4-w9Jl9nB z9Tm!#o2wKzg|GdoVrb=}tXAH!K`?e}w)?x|JLnUCj?svUeca?Z3+FWYwM4mYD9x@s zSFMxD&C*$QPl8>s;ZJeX5GheGngkAAybFlmi(R>~E=|)@xJ`;*U+lTBpR3pbci8`^ zJ`^L=RmIOy#&U)!A(IYOa6Ii%pDWJJtn3H0Cj5SRCYHVbc!+%)+N<2j%}+zq`f)4O zMGkwm*v#TgLg!{rSeozb5R2nP%XKU$sBrzU8sh91uzwb1|G8>cv?K(Wcj{Ca*De}j zgoN_y)wn3TRnDR*JHHQ&tWoTD>+XZC%jO30uS71*jc|xTW%&0b?iC%+#VE*kwM*19 z3bxaim=nO6Kd-m1vNeSh*s0zR&dqX%T4Yl#YlfrNpvCMw+ot!VkgEzl- z(OqyCY#|E~r*;L&3Zvq-r=kRlZ+&Mfua`)#R^`uzF_=K2KC!I6aU3hr7Ize58rtq@ zCbOQY8l$6n&ABr}{7Uhy?wO+%Ynwv0DqvbPLw#_V(GW_EQ^G*Ij&hR6o>ponXxgC? zJI{bR0@yWGwC79b0fbYn>+JX`j_Q?cxa}VD)U(cxlwo)4kJ#vP6|Ai?uu6{P@Th7oD04f+O5+)4FqjsxZ$1g~DbSMtD zS_JCc-w-%V7P`uIJjWa<`&`s7)z~3>6NLGF>!|ZA!(aKaKWBWfbMG`GizSvQ_IvATY%i+&K{F7T2}n6A3vSid+ciR=-B2 znq2tiRpRpJ=totT%q$M$uobO3QS(M!^}83lS0vL?tQafkZcH@E1;fl!7~TwqrWLB< zGtZNhJOme}EbVt{ zf~q=jtMT0)`C@Hq$*`_`a!!Pp*{)~S<<87fbcNVi*19TnY~n`rlZlOD_E)VhIlyhp zXTVg+!*uLCJzHu?$6iJ>sJ^Yfv;u>ft;&eLLPd$JbYiD=A#5s#YY@V2#>Vl&XyPJe zBFU_BG<0Va`*5BBbc}fKa;CdTijh}O9+2IQLgg@{deCcfs$kddk|<*-H0^?J+7(;m zPzwSb`Xwuyd+olI(alQ6BqdwE-_@#{3B@Y0oEA~9>yk9&+E7Y> zM?gk%%j2yx?j82D=U;afD;%nVq$9d?$OXkIOkFUqpvPs*5lPCi2HH&ALhBfMAjh^~ z$!~(WTZQO0=`VT~g)p6@E{8;QiS2i&7fh2#V>6enXBSNrYDZFI4Tz;!x^}jtf$wc1 zq?xNJXwoa|Q5Ky${{m#>gqyq&6ORVQg|8z?by3($qC$4#-ioycxUK=9ZMt=*jG_Ci z8XK_VgZ9p#K4;hwqHGr_ zQ8UUBUKXXxIxUKz-AUXKKf9xNeWZp`1V@iGQX|KsPksEMG!z)kHc0NEubeFw@ga(_ z9M%HBGh|)z+^>I4y8o(6tT#JIuA5w?49 zP?t_sL>yv#w$2F2ut_b?7|XNW?s9vSiku;8K-}9~Fry(v z#TH^E>(~U_E`2IoyJ5|lgzSo_sp&b>RmL7+U^JDxsQ_8`;nzY`6_Qn0tg5`;;^E@b zd2H-vqX50mz1H;Szx%oFoC(2m#A5)%X3Ea5!8C=y=AF-<+wqZ9p3`IfLIU(kOK$Ic zXIp6w7V7#`Ulr5v=j?sn2`&?}HA-dLtJG?aaY%;>0-U|0TEetR6W79(LqVKCM8MAWP* zhrN&^>EUI@@Q!++R0XwG9e90ZF^q_60LqG%eVnLAbzR+Tm-GgGgjSny)-sSmUjMvq zW`q(GcB4XWlDNNrdw74B{F@6;f2OD?TG%z`brmg}NFlTUR?OoL&V|k4;)oXWmAt$v zNYwZ0+p1btTOm*+pSFnm77mkh`ED$7e3sq3|KLKbm3nuyr-8 z$q$GcIFtidX6RF{9w`QAhoLKD*DJ)K&3!r=P)7jDv?NTWI785Vbz~wtI#H#Pyvb9j zNBx{swwUDb+0F&5teY>yF^pB`wYUJZ^f4OxlDP*;c*HyEK_ddJom^GtQoiC28B;5q z1s;bAW)(^3DuVhoXuW*d6~wW1vX|Yi@AsVFdhI}R0k8JWW9;fu0dPX?N#xZZ@gm=PbIRcSth? zaU@&Byr-xLLLto#uB4m}v3Ym1U1e7F4mw0=)d7VdN?I)vL=DxI^!L(*Sw{D)!nsgg zMAyWi4MzFdsrAk$dK(lk=IBDmiS(=Ns?kuNt{TXgw{&n~{NUK*$|$J7 zq}<&*r901O6~X?0pE3LiGg{mr1I+I{!N<*X%Y8rCyGKr=4THR%`mQJe7|%eUr)Q!R zMyEy=s(dd^M;*6Rl}|UW?c5dJ46gTm%F8v@^nYKA`-@8s>hfgR$5)P6R!Z{PVE@pM z^F0c9QNgbj>g&aW?i3(`yMdWeKWmv^LBUI&4XamKI^#K8zhcvsQmlG$u=M0mEw1vk z`{HO;3-mI%9X%+aw+&6d&8XMx~4{ADbs~%DoioST9iT}VSbboCj_o` z-SQa+Lf;I`Maa=&fSurc5R^+jADAIeO8-t}S09`FP7oiop>vNON*sa8b+F|w= z#-azpw5RL!2=rWVywvc7vpkQ9*zZ=a?rZFGAu7`dzxj|E)@TQ8{lE0d+pH=!o$)-A zCEYjyM(|}IRMtPwo%Xf*+%U;yXM60re+(T#Wfb>6ckMh^qE$}1v>nnqPCG^b>+v)O zE^0kBYM~0#0U;qRZIc9$Zf{;29^3o321VLG$5UPS8r;Y*=#w{$@`&Mpem3OIJ4K!+ z^hNARfsRakV!Nb`H77Z5Cr9hZW_}!53xl<2?6C}{iR$sfyOPef%(onb>cmQeTDe&1 zNOyY7*rmT~lN@GMQ^&c^vr@?5gt{R8j7t|8sSrk=H&QBJZk z0`bMtu^V_Px$@--HGekcCyg>M3InC9c|XefOGGzGId+e$j)1m!v;)rE?I#nOsp`}- zJGF~nlTR+{kXI_pe7}2QL!O279pFr&Dl)``IMsJ8iHjA`gIo22nDeuIHxaOau`tZV zK@~sZh)O8&oIDbuVHwjFN~xGhqisq7tZeq;#7?TvliPo;;yY)yaHix}NwRgrMbBlK ziXj>#EEnw@yY$_d;0*MS4H6Ks7n{jJpH0GflIn#)?W*VwPZWVsWYJv$;i%>z}sC8kn1D}(SP8igIg!p*a+VnTZK zlHv#;Mg{qdRPuQ34}1I;B2%1ll`4!;nv!0W$WeM!!Z(y1uu{Q_p&Qk9pq>Oah%88G zG+)s6xhQn}ork(QuxG~v2L9?7r*yIjD%2tpy|aoWxIrfZ1V49AtC5^wM+%5`R}j^m z{>f)sNxCZU_42a@kA$qnU;=|JR(c^wqouAd6xuVsLW}Eam|~IpWXWa`ti^>Wll0N~ zAOAoLW1*k~^$s3FB3ahEi|6Dmhc&rO@~bf0DLVt7c?aB0dM4FECC^+}ebp-IH5T1i z?ev_f8R|bWneQ5SJn8G zam$$?Ze_C1(5~=Z*8NwP+dnT&Dx^{SQb`1%50wPYVX-3-+ zX^AjGjF2{Kt|FnnbG558es%mwc^C9NW z!(P5g?dpsb=tLe;b8karlk;}nEg#()3v)E=c*c`}kqV5OK+f#^&cz|yyH;w0&e#Sx z(?R*_yt{e{rm#Rdsw-SCl(-OzSfql_c%?f(3~HgCfVe~I-(&24R~Nq>2cnOo;#v2i zCr>p_JMMM<-e;s{r%fBp*>F0WhkY)})`^3Pr-GLw%H~E9KC8Hmi8K6y;hkadk2k27 zZUiz~(hG~;z2;E_Lb35>2M_&Da}J1YaX@Mh3x97^Y^6o0l;+Gl7CosA0j;>3k#g6Z zclqv%6qk`ECom=pRcY)H6X~SFsgf--$%v?GeEZ83Edb6ErFoW<=b@9!U&L%0fzm~) zNV(wbC%n*gz`>BDX;iJegC7Q82E9(G-YrCuR0WA=sH>Q&wCS6yEo+zPo|zHdD9x-F z@u)L*7o3fX-Llz{1Cc7|>PLV$NAviqDHL)d&_!7h*Sw2*PawLtJnuz&UpDX~L(gz> z%TP1x9XeOPAUC6;YQL(CvZmQTPL2XFj6@y3X+i@apmpuT;0=--%N?R{*MefJgWf&| za4@cN&(f1(^}L?~=66k_O0FUQ_u=s6M`2nvo_Zt^4w=mbbtOROtuepKd;NEpn&i4) zay=L|$@KXJN_8$PAH-tS>f4FVZp?7pVVL9?)SWY}~l91#t5nRQjXLqU4tSkG>R>~ey6}V#GHrl#YIjJ<((P$Gr8X`m5hDXhR)1$8plqZOX7;>;>pQa34&x}) zai8#5{=e1<{esBY+(6cUG;36wX0h^xa`D))+hfL>@V0nExgN+KOr| zp5?20_21pSo7NPU{|`L^Q0kbLAZB)#^O_QJCpEzBS>U9+BgyShofkInYi@qj?z$J) zdXBiyHe_$!eauY{CK4Goh?P3ysv+cHl7wL-mT=xstEH+tZ>;=fj9FDlok5gGSIW6= z2&h9Ok48_em-ifl&AZ%dKeU`eDMTxpvE%$+6s+okvlpQ^peiuOLt>khHn-K>`uqWf!We$1j7s%!Q$?0m75{(zrn55_0# zpW7R4IGAtR62ZbcuBJEKc0r)7*RrMqhHi81BC+@xz;sWw3#mK9y=b-pQ&{0<;~z-K zS4$8>5IG%@=y`%SUX^nvV+(`C^zmao>+5~h2nGxKrMlKquuZdFD@?;p;dW;Bj}yhj z9+|1hstP}?MQ78?mxWZ;*2smn_7utLu$@4fl~^mx?tCCZo(TzySGPfAqn%3ZtXnR5 zJhfW5*W7q@3iX6^r9IH|fEy$9_uf=%&8Q>4m+J`N`VbhpvNd+El@G8UvV8Ahez|~v zsV0ikLx8RFr9exyMIcSJSS=~JY4ACAR#jROH+$K9U=>tWyQni4Ut0PuE0L>8mnWv| zg3DC3>St1mtR(Y_vm+G@GPN*c1EKu@x7orGrRZWIS z-Dbd4pwHukTLLdU6fI%PQ$=YNU7HGjgc_$*MM27yYb;jXjIiwYehzrz`NfS_1jMEo znTXfio`cTQP*rL*BSX&``5<| zJ?}+B~*b8vtzyZ#PZ11Fg|yI57ZC4+Vp&iGmPYTZJWV9|g;fhJ>^3##rGX6;Nv{9SaT zuc@t9Vn;mkg-RZKtN}~C+ZC>5*_1hAn>dFy*+dF~3{2>MYNNL3Pw!^)lCS9Ra8x;vO0{Rp(>@ zYK&9b94$hNsf6rybtgYv!kq(OFHrnSm#WN^Oe=;9!}Xa?Fs~|t1ldRm zvY87UlXKcH@mNQ~lxpcSR5xf;c}H1FUVGpZlG9yzN9u@{?E>&L9`+#wokZ1Q{ZdGkeC zYIk0hAJ4dP%1&Wdt8(7%EIQ&S#~|XYTy%g$l9u&i7wpw{tAe6EP%Y|nte2=D--&Xt z4S!r8=I9thBZ8?NnS(f zC=BRGXD6sv9SB%hVm!y)tj+oa2u^A;g zo|qHsswBs%p#U3aCXqWFVzEJsIz6ocYUZS_Xtme4?{KpOMY-d)bQ2Dn3-Eng@n#i@%* zvUYkX8uv~RXm{DpTC4U6n@{Lbo*_DDu{`{)9iR#cj7J88z*Y|+A+$AIaxyN1z@{@V z$plVvHWqg^m{)+qi=(MDUT3~)N8BlahLk6lv5GZ0qM0rmFcu zNi^h)d^5~w#5sgwAts{noN`QnL?D_Su!cN4sYK}wV|mmB&`67dNhkKi)lE&! z(=-csm3Qv)x?Of!$>i3-33jJld=+O4ZyvFm1EwKS3@zToGg%c zBSV<8u*BdtKUVIYf;fW->4Sy0orlFCI;O_N+E?HRVJ!Cn0^Jei{I%d7&s(=Hu7#{a zFVcG=n@HH60H_hejxgx_>_;0VPttP_E}C&qBZTl2Y?CNW6o|Y+8xTJeh7nEy<3;z5 zrh>;Kv=C2hW}z7>@8l$gT}6X>5$;k&csD0+DAZZevk^<34X*)=$e!TpQjigf)jCP` z9)dh`=UtJVy5F0V|9;cML!Amr(?wQG6ls;5vkyDz3g#J*hs43*jpoeJ%xO`7`%kB_LhU*xh zlWtWU*QCZrj=>Ir)!O{M5u5oP*&Q>=IX<`^>q=&Bgu6WUrGC-%%XBjkwZf%{3fy)p zRT*kOJ45cS+cwS_<~2jH`}IXrGtp=}rAi{w>6K$k*6kJTttdh7;@GOw$%1!=yeWu! z>OEcyh^&dw1!9h>S~Kc9L>p1bEmf&5Od@3?{-{oCN&06-tBUI(#x0)hi!JoqOi8RO z8;pIiC?d>xTs!=}^$^PrwKjd}g-$J&ITTlG(x=H?9L}FVvsi|mYh!TyJFlQw5v#Qk znTo#aID_2XtI0`j(w}$9o|~=``|jQ(*GH%v8Q_$JNrorm4h>FA3$6eY|Gy?mo-3|2 zVz@7|jw{V^JW-Qb-Uw0#NDehoYqVI%-@VAkXiMJTv*Ho}iy2Ub(rFyy4(roAFRL?Q zfWv;R8%i0-o{Eq)Yj}5F16ndio6YXLpX++dt|N(Zh*z>9rBC;520G4Xl`%w=#ET9e z7wvyvuqjzn_a4#K(Ht4`kYVojp)2g46RayFVTyodHk~dR$_Rk%f?r9jU9ocKf~XB^ z4pADmgm@}BSa?}|j;f8$jT7e1{3*l#ZY_6h7MR9U3RU1SuN3mz>pRq@WV*2K=#ndX zoe|62Eg#+=(Ymdf1%HMF7@I${Ll`3b#>cGCsmHM01+_u+JlkOOqOfn;6vDX_lhV!8 zEx|&|V7KQbnL(a=`bu6W8?>jI`k*k^KknWQYr{6<9& zp89>cK!i==iOpP66%b0Zp9U^fFs%w)CqB{;SbcHdp~O|tDUDHDM~xG+KuwS(!@@-^ zD1b)fMW8m%g3FIHNY)jnio~o?zk-=v0fiHH$_H~j#?s@(xHT*NcO(=cLfEMq?Evn` zZ#a1nccid0T!8S2o?VGfCGT|$V1I_I`d{DlVbXHKn4lru=+xRpO~i4ch}B#)hdOIT z&amSEAgkY2^5rZUuU$?LJLAerTH;o_Haj6eqxn->#MxTQz!U~13CyM)A zfhRcGo4S`%_o5>-X)0gdN-~@D2BuX#tBi)Jo33I%80U@A_!f+=05?F$zt`QXJzGps zJ9+tFqQq#p3GN-vcZiZA4{2#%=fHN>c}?$PE2-xFN|5tH56Q&M33Fbvf-pnTJMx3g zEZ6QWHvZ=!k|GDF)&L0TKiaZGVW z{cmURgAEGc8>=jx?#6yFjYBRDc4sEAyKfqafzg0DVznCU6||F4_*z(h*6)CIQg(FQRDvyz z^wklgydDZU;;8-;u5eQweN`gsTN0DHqY{nM$x8*&WBX+;7P|lqOBXz>Oim&*HhJ%@ zte=k>obepsW_`NUN?41?9+xuDN5k7lVp+Q+1%Xm#BCh70^v-`?ZTCdwUR2HkdD>o? zgGrPgt7iU+lD0Oh&Tx0Xb1Q1Ri-^?>$XBC%E#bH%wJ695S3p=aol$$}tKwXD7F*%^ zYKN*Sz`QW3L)xuTJUs92Mj)3@L-=fuEzcLkzCyaWu1 zY>}!9V1$!}9SbmWJ5uuECUp&RSMU~Y$FQP&`{#6|s}Qbfo}6|-+!)UD^WN2*=uf)W zwNBBk?kVJeCkhO6msvd+G%;~CRm-R_huBnoJ(L!O>d@=sbEZ;y%;?S4Vu(dY8{o&F zwaMOzW9c)nH;0Bm(ewAdxH+rl;yJlaO3P5&nTc*2TX<~hNb{JXb~{Sh%&S#F%vL%q zF9j+@^?z&RiU`UqD;h&lL34mtNK6%BES*3ltZ{+eATEY8W>FBCQ@j&;?l{vCJ#`}q z!p(?-(v?>$hgmKY;U%Y)6|>_asLqd@(UQ9xMaP_?bD@T?a}ms9#G?1k^Ek>u@+Kjn z&s+7GsPkAiDw;+OreJSlGK@u-)>N2AS!Xy(XSfSHHNdHW;E6b~n=qW=EIc7L%-wJ% z7VBrM$?lU5OHE`D1%&>YuE}f2-0g#%RZ0xez;P_f<_!bKqjKa-bp0A&ewWu=w>y)S zr*xPBi3&>)%#@Olnin>64Ov0ec@2ERnq1=CE~tP!nI16hL5|4sv3(7rKm2oQfBOMV zd&baJtR#;>j7*jpRMt)~ou7li+sapjcCy;fwwg;-IV&W)bKP(ja#2=9J(4-jTx`{| zCa^a5Y-8Vci zcBC%p^f3l)LWY`wri4<27>YiJBKrGLS59x^zb$_v z{5mpg;n|Bt)!_p%&fHh63x&QlEA(<^R^cL2Yziw#0c!`aUO58+mM&&Acz>mZo(#gJo|)yLb9KeX)gEIW!#S6|mgVP=Dl zpr={7)A|vG6JwG(MQjm?LvnRmL5cy6XJN^AfuB*lXZz2bZof0A3310E;=z6d1+k(P(=WivK5ja7YA%=vL*tz5nH^;y%oC@LA_%D2yP;QHS#zOu|pe%h0J?hx22 zu-ujUx#QGj_KWCI7}x_FMMhT(y5za1p9#4Ohf^I{-by$lsuW$BjoNazey=s~b+tX7 znDn z_sc4MA=MRCQc37u^evN9ihGEBx2NZ5WT^YbN0^aDESw)*81D&gG{|Fl{!zJoXSPdr zf5sJsP6X)8>g^78E~~`N{Zb$`v7dd*;)*KvA^mf#;}qebIX5iR*l5X5@MYJd>R*+L zKlcpNb74gk96+OdRk$I}c30Uda7A)1w7D^uT4Lg*cSA1dL0r6C!HsJe>%50ylfog* zIE&9{+uiG|cyb?Otek^GpeAHT%uujU(ctE|dcYe$(;0+sMdg}CH^1$dDV_0Q|-q~=kaarxU7EwF2-zH4(|0CLn8 z+$E-U1cpY8w886?oo&Qyam(;)m+JgOt}99e$ZB)sjRKxJ@4Z+}ix{YA2vhL)s)kB8 z|GxzhP)QNz{?3A|Ue7>PvLsb83B8q4$0V|oUbH+A0wr{w4UrI1D*nr2y_=2AD&p%D zDrW(y?kP|ars;el>;@UvhE-%a-E}lEL^PgDr+I-II&l7He5~ad10!Tz0@lvxzCx%1hC0wuT z>63=^Rrq1n*mfPUIGh7%is>_RC~n-0?FhiWAgIMfwfQ|EU->kDb9>l5*hVwln8;3g z7VE|_JIFj_(y5o{fC0H#nOu@B`bdgoQHU%ZZuvP1kpO0i*}6hHcg2eEH@#!V$N*=Z zbwg@!h zCiZcY^woFgiD17mGh!a6kj}0grI=J3T_F+_1jlD7zUg8iM5i61L+%|gIU#WqXGs>;CGRptW=T%LUM+Jh(zr z&GNSC|%OzooQ4sYn<1PyYn%+)0s>7=!G20 z;zA?(DXH6YBaoS7>THEo7v_w>Dk+dJJH9#uCUCBU(M_N z%3)rYc2?}GF_2OI%unrEBOx?f`dWNUT&JfIK%IN0ZnaA0mc!pKqDySWtc5XL2tAvr zFn&*DB56xFs2Zn~gVCgrX)4i9kgPlY^E%CWps?E5Yu0XrCZ_bmu8Cq0t2q?x(j7tY z>A4dUhO5O`pT}RH@6oLshHtdUOy|YqioU5(ClZ>TFY6W3ypq?tL$f~SrI2SRcMtp3 zqOqJ;h7C>{N$^3xTTQbhR}6)YV&_v@HftfD7?P9Xh#+Ql&0Uds+-o*s7RsvXPh;fc zU|DR=$KLZpH(;9Eb@)V3bmDqU3e+NBZN;#RW(^6J9m(h@MBnD2h|^j@Gb~|e?Xqez`!T$ z6?!iu9JvZsYd|xa^GvfQR9Z=1nC_GVTp8j(hajh*?cXcMLJi?WI4^Fmwe7|kuJ9`U z1nHw6p5bmKulvYncuEC3r;c^1Gr6&Q%g@Fdu*CPnP_XdCthLPn%cU(6)s5g3EBX{h zoQkqw3F@w%tO*u3$Pq>+xf}ba0;Y2=w61@ImY*$~HRZRgBs^RwX-578Bov5ZsHWoOSTZkrTr@Fa*&1{xN>O$TZ%#VNm zeoeFuUgQev)fFNSUmx?=+_iBvu3$WVFTRzM5>C@4dPwVgmr zl;@H^=kYmEpxlVFVnThd8!3TdIZzd1?|SFCqJNy5qQS8&`~6p|mSfvu5OIngbSfNr z-TJ7A&id@6SVmn~Fi`(GZ|iGMAp#W!uL;UdBwHS@C>bntHx*2Jmah=04rwZ6tZuC^ zCJ5H;=6BA-io_lE;GX?YDZP9xDi2xM_3l>zs>ugLLEviNpH{zrvTI)7_wi@{^MC%& z@n?Vbji&(qCWkczxm()P4=#(cG0sgd4=SGZYimE7g^4JK4?y0C>JZ8s8;{p`txc> zgA{PecT%HKqhP3ak=5TrPc+qN3{0%}%3RLf&v7czo{bLVHQ?m~PEi1GS@lE;g1U&& z&~19=3mUTi{4|arMG#!{!wXa>-yzpdRBJ}8&rInPtc8RQEH&VX#9KHUYn{+Pvzqyv z^R)c1_3!F2SwFu$Xi)@j^rUcmMJ)5y{{7e0s&r}BS4eYuNA`fKB|XX)#o@t1$~SMg`x{4)`+nHww^bW$ek zkneaEVajpCBS4d3oGLWeLQ2K|PL@-oacqhVi0^Y;*1WFn^VRk5r0le)1%`A~rEL&f z46!*@$9630s09in_@mhLeZG&MoiM4jzf zF%(+9kh~TkJs2_yA#$zagP0XOqF&^356zMc~{OQj5(Q$565EFvsk+`+lQX`exl8_2`BW{q5Y6S zRJYg^131?=NR>d3bku?ZLjkBdD(mH5#uZ&x-ys?iJ2G49c+$9rJ^4p8*bpNDmO^8K zc4XuWEG1#wH!Ko&=7s=misN7>BMGN4H8Lv19SOGs)Sne0l=Zw=OMeD4Y0@_yYA+h5 z=}^y&8(5Zs%X+3Rak)15m%D{u!sJGjy@uDXsc@uwO&Leo%e0E+jHkp;8hyjjHam7 zuHKB3F^;Q_5rJ+jufP9ZS0);cpqIWc(1O|PX0Ntps7=pS8)5tC2!a!n#v} z==|%YSPPW?XT_nSpEs&5q*uJxeNhd0xtVNt%iCAMd2X-KmpyMmk<{`mPLEC096EHN zR_3BjxT?V8Dex05s7SIHJF#v~-ch(Lly{)=LDX2v&o52Tuw4c0$iuk<_Vcik17XK{ zwE)p``aZ9$f>??#B+pl}5-(lnXzyB+9EWo~jkXYXclQku%`<$rQIy-win?W#Xg(XN zNkiE&mwV{8NZO4X^wv(7vvr&?)ljMxQB?PmP`>v^W5$L?r8v;MPQnzLxqwKB10!}W zjuZuNLrbv`nb67LYs>=-hX~36QRNZH(aI&i49IzHOZ3t%wpNBtB!ymUp!VoJa(I(7sG8MrC=b^1HpY=^Rx0Y=V=dgj5 z#d};F)bUz*BCPX_EPU2=d&*3|k{|&wLOnjug`8dtO67I!kEiO8N$b5oQjU@n>NH~;x5ui2L{fc6!SPFFV!{X?y%2^X)f$x%Ho;MZVZD(g(@eX+deew z1)PHb5JPtbn*?Y(jwRU^3*B6>a#_{NGQI8dvVIm_-1@}W1BUcU0Bk2&+3}Px=5B7N z{vE@u0!iZ>AuQ6*c}{Zm*?1GH2raR!ijVbudtdWDx_~Wk6-X#QAKYrHM-_C7N#?yFLMGV*wbEv2fKzZh zWO!+KieP*0v}Zd^ftjC^y?atbCFB^Ua#EDA)D0ePS`4Z{s$2-CApj8r z5#4u$;nxbaYa7+T`bj2T>3SS9VP~&h#9(T&F4_wmX1#JR-B)NSc6CW*7l&dvOBCWk zQQiq`(GFC^gma;d>q=mM#(=w<(GssMpg7rebG&y-tD)(HkVdrbIs%Z+d(~MfQe~|D z)YqZ`t%Fr=f^KHq9m81M=yWHP6`t15p*yI_KD4{)`B6oGQKwNQ^WtkkQ=##r>uB2A ztV)E`XBuqEc{D{*`)pJ{4<#{HGbyifwzFrIgdZbBrJ+lN7QFFnW9fE|7*GHz{J#`u zxht)sC+%FRii_p_juN<9xv%m@fNtqp?|3Tg*RBWs{Ou?`a_?H~%1b1MT2>WsV+syu zswM{rFBC+#hn|Uvx*LuWWgV3Yq0cb{Qs@e$ohA90aAnM=KvZav*mDJEEC{A@HO>65 z9-BQ%=9Ea!*$wC7uWjO#`{la$9LLI8AU9(vRY-+DPX-ms?}KsikVGMywF5$_%9kMb z*xRQ1McAhg93daL+KrblQ9z<>fljlcyH7iYLzEe?vtUV>&MAbV(`<+$UAF|vp=Xa; z2t%1|=x&Xhu|f3F~C|0$UmMgP0&QNbr%u03Cv_X^Q<~JcZ4OmTWpT zb!X~gS=H11_kv^tVl*!>=+`q!QURINgyJwW6ia4ct;657L$aanA)rC@_QWDu}2|hPDs?j=r$24xu-_e=y zPs}{6MFXl0W-p2OD+~4vNIb*jb8p*v{L{UOWHV-C(GA zySkV&_X*?Vb;h5WC%XFjouA|Iq>|SeBA++1aq#i}qHF&IWz{?D4roIs1xNcXf@Lli z3zOMFz`c^eb`xVjI25~{v}2)w>-HfFRT5)|zaKDRgq?Na*@<`SJMGXdOCb@we`#egUC7qYgGniPVrYwq8tUUj* zX>Oc<3k_@>ejH=@K`HZtI%QnF^okmrWCy{N4hg~Z*|-xtfqdYpN;Ht{bM^H7_@P&OmEf1> zKptXJ!Ab?wJv_h8#b_>y8d+dzP}w#68S2N-_c7==@C1zP5V?7yMgMOO zyqU=!mv$Us8|A{eNP$%~0;@uw7`yGHYxB-FO~DYwP>V+JNhLX$qRev>y17_J+vb_F z`W%qQA)_a~1HTq)(u}K(X!B=ZKR3A{9AiqzrSLXLv9l%5BUU9KwKic8s9tRp{7g_4 zkh;+F8w0Bjjv57A@)u)+Lfr)frm;Y`+*R>!KL=eZ`6{7lFGfUWibkj%%QoACVw7Xs zt*-<}J&xc828ssrcDM{;bt*P9-3oTlpbasQbXJ(Gk7DYmK_^5+-`x%Kj1bzl-ArouvH0$}pru&)-kaGX(_mf%)8iDZVgyB}R)^*UHa5qTQnpj$0 z0ns%_I0k#Se~nG&#}<%hC|_%UaQ$~Uii3PUU^+rIwg_Ly@!VZ@YLZ9dV@aBf^DchT zd_a_&rYjPa{)Yb!(>kddBTVO4z1O@mNWrwvU9)Ps`sc0aYA&EE`YU*6oSWDK=~LGB z;=V2G=v+2ERAc4t%S8+G#EEXl99qm3jP97L46A_G%S>HEdcAv_Aap+~X6s;^CGNl; z?du_`5_F;wG>Pj9d)IjwLhh)t&a_?7)B+WW7)YAH89CT5a2?7dW~#7tC!%IvosCPs zj&F!>G)bh-WyuM)?;85&buIkp31YO~ZL8h7BILNC*;2!kyF8gltGLy(2W0h-LrJ*rTZ{gmE^o=Jx(Y}a`%=e>7@P@+C(N<_0Ns-k^PQFvIHaM+@KMQbbJIK7jk z2w7+IeH_yt0jigCnNf#DfPpFJ)UgUhg8&_`Ih`A9#;-8wY%WG9q>~k~IekWDQJ;RG zdhSF15@(@rkof`|xNQMA&0vb1P{?Wn?aS3{QW7((L5mL7>r2flRGQ%9yUn=F$mPDGdhAOt|`P{MV&0crw64zBvpLkaffWt>d++D#($q9Og+Mg+4 z^t;YUenl&|4fv{q)$gOuOCfnK`F_>{w4+E6zVax~l%#M{ArPeUm_`%)n1Sss&f7Mts9Zb{x=Q6dX-A{tiZ#(6M88RLWqiVd<&{slhp zJBIFlmC3!=dXBu=P6}X+m;^aD)a#&Ypk=T0#XkLx+*7?07`t^qWs<^S^b+B?JQ?}R zT!`vNUptPq;5mwvwJ7cH*B7=L(V%5UvfSr-k1Kqt6OVt6il?K4ew9Y=;zUYsAv#Y$ z7NXOpQ$=)g%uDDC{hg}+tFJ|Sw5cZ9Sp+Kkm8gvwKd0X*uqq!Jr;Hc#8GzpOSW%X` zl3S4}-@vHmv>&f5>eKURM{{7uD_2MA@gdJ+9hK~GqD$n7RV^`%TO8Y5SK(nwjPkfj z4X^1D)uUyE9hz_uAVhW;l5h#-+ypx-p0$-|VO1}{*5~|vPJhAzxLH@yezY~=&TM9G zT(BSt%1H2T2=XRlx|B!N-ZyI|rvI?ruqw@k_kM82K_7oj>WFzA%iEFG6(+|O=%b{g z!+|Jx^x5i;X#K2EB6!Q6MnzF+-(7zGwEv!@82$8ftIjh|S&%#NDpkDH=gu*{l1enE z{%_rR+AW%sbNG61wNjm0na2FC!pDu?MAnARc`Z~TBR9xHkL_y245(%_Z?)C4(|-<2 zlTdXvrUtK~tDew*{hXI6kY(7+v$~ZDLj3?M8!;!gX`Rc#rL^4_m63depU+zU14Z&u z(vvaFeK9~{kmG>fY1gU^WAdHcpX&2)t5-ge=_26q$EX!NiZKjKFge53Knap{z7}Df zD9fr?gYL2GnQNz_i?2z2?Pj$dN?QO!v2!~WV$XSbe&A4ic!8uGa4LanLI(D$vF)jv z=aY8WZ}QzLxp4D)ytqnAdRE@J+dXF{`b0on$9*v4DSy}2Vkx6gsvw~xuzKy2iI560 z0<0fV`8V`Crj#aQ(*U^UL~%IMpU0Vo&W}&#v8ssCq`a3qD|l6eDFj5vUP@$seII@N zOfxR)=z!Hwu@_^)p|3IOVNj%44l+#u-|;-SnVE)xX;J>F zhL&^f>*n<949?9dRkaC=UI8=-prS(xS zz$OtZq@jALI1?akDn~N{=$t25#7?g+E1eY}TE58*0&KCNNZl17V4QJN+?~@9o&d`T zz)LMIi9rg%pSdt7e;y+-VeW40nt{pOva=HGPRW1ZEify{3Jt<_7rUb;8kXt-!L28G z`_(0o07E5N0(aX2(a@JJLRb>O>c;07-rV%rWew1h1WalkK@Ur$Se0z z#G!dy?6fnSY95Anx*|$wVqX1y(Kf)q{xi?xOBnQI8W-kj<0uj#V&L>lXk+k2ci$5m z6`RgRE9}jRTHe?}?%7g7Tg=3>3a6@WX|1U1y3Sg`o3)Z&e`u8|zmljF*L20mVV>VS zpe;n%|M&HoXmTPNf5FWYWv9=c{QV5y0lPA0Ac{I*H91#>KQSjCHy!#r z?Rxof8>!4LuFGer@gqVq@7KNiacm_=;On#KU2yK?nZ%MD(whH0!rLmVf^ynE5jp!Q z@mx~X2FQ6gsjW<}FId4LTC4x*&xe;(>`c&p0KIMGeg=~n+P;EJ9tr5hOx23UX=4s$ z?K^b}xfAvFq~@U1nX%A~N9!;q6r&d(y(t_LUm2@s4y7nWo1v|U zlwHvhW0LCn)=?7*!sb-GsDv^!4dH~k)LQW*r+cCqAd~B;Lquwfc3c8wY%`4&ZtJPr zabZMXHFT@G)L@*A0T6}$S~yQDj?4Fi8Yv;Pr1(JUlvclPbfSy2iXta{mZv{)@$-Aw zpymicb28gOh?6a2M3eH|s;Wf}23#xZte%7_g>9?hbMxgc+#&)tj>~j>Kf!dS)@s)? zS@rp6MZ>LHSehNW@jzHaNOcDN^VNVP&L9Mg#hNVhc}$xZlK-%(LQaoKjZZixWk44P zfSRFlENIed;V48EVnz!A>KOIA;SI`f+(+6h(192C^GyHnOi z3btY7u{XNtKt!mOx|&E;F?l<}GzB-qqKK%F160Al@^f%&q*F0Y74tN&N}bI)57BQ| z*m3aVXTIczF+r*QQmBhYF={-L$7-D!n~KI)$DTyTn_!TecdaB7P2>_#3VRiJ{)bczV8AQyxBope7mR;kl^TH>XT} zii}XQp3ZzBC&DgY>q$OU&8yE2$I-y3$c1gf>B0~FyX8d2A$YKKuR3Wdnbq7$qQjJ% z%c!&tG_0=_!ggB^b(V|pt3r&vZZ*$*u|<8N%uF-EUR~PkG>PWC)n|3NBj|Hoe~ym1 zel#%_z@0^uu1|F2(TSm6OCT1qSd7x!3Vn*;699npU2?Zq)*b~{rK3)rWnKxJT`szl zEA<*~oIuQWg{ltLl^avvgHrQTS_}v0xY~lxMRbxihQ61|>is}+Fd%ZZGxrHF-|>08 zrxX-b@s^tsidUs`l-54r=3J~BOUL+$#k>isi%w&=EJe(nx@;oMhKZG;h=Gpha!gi` z2NXrZ%hatM5R7xflGu3;Xmsm@7~milo%MdPrplb0T=p`w?3vpFnrg`udfpj%y{wB@ zR5OvedOIJecAbicos^Q7BcNR&Y4U7$uMi`5Ara06FKbd%!I&usX<|_&3@Ju;FL1Hx zDt0DPZmkJJ(WXR5Vi-$wB&n|teGW`r3US8V_6{Od&X<0=0r<>yCU)c8t9wuUe1ucheze6>&WL;oT}AHZeoRP*^Cg z7izN`>pbi3cTtg`m8zikkqL`9oQk<^w1$Rq%ls)25x*)LV}a$R&~-6)krI^lq2|Es zSCY)W_cZsBickY-i#375YPjo}Y!)+7@TptH(YyCiI)O03VMa+-IP94HI!LYr8)2HG z8Q43CWbN~<1)cICUG=d6JQK!qU0x<0RbilRJ_AEs^*2avj?g5*(n)I>(Vh?htyj=j z-`TpQN$S)aN~r)mF^ehBakgEiO$Pdz_CVY>Nb=8Cogs|~i|0~c6UeojsI%>M;}7o* zk7T~2;$FV@D^JO-yv6ve6-r`PPNfhMW7gdF=LKMOr;*?F#^wjdE;)~7AVxbJMry9X zpi%O>ded;Z+fQ+2A*IkhvuW&1lhfkH<>|gCijWM6Xgj@_s!R!Juat}Le(PUmI1AfY zR~yg+2zhRXrnRQgb|(F-ORQNLn5#q7uBv9T{mqx#v-p`>u4$bl6O+6?^jTk1>IT)`B!ks$WI1M}g|CjJcA^VBO?AF1)+Z1o+UhTznSJ10LT)Df|`-8T3Pf={Fih`3Lh?fyZv^{cC zDm((N$jC%Zq;U?%$L-`~byJ~7b*oWT9k1p>6vK85%>P%#?dq<`;eMtTZy29+1T5zu z47v|4)`~{x1PVt?#a{V&q!`b5W29*e*8aUPlUun25`ngSy5l@uI`dG?W?@J>p=T7X zGEa$afL1Uwc{}94lOxrxPmlYX>%*lXKw*4Qit*jyWZww~RAGTq#dV~>zX!^~p$mvO zYvJYpTxW}1Svqo0?w(;_(g`7PojJ-y$Z&Rsw%Ixo)j@bK0*PoYmuY1>!;T;hRHqbJ zS4GOk{N@(&%NM=}srejIqAj(6=sNeYAUH6ilitDGW|a1SlttA_Xbq`H(C>?aSC4{F zabDc0Z(4tx5tTZI85%0f!SZf>^Pj;p)D1Z_ZBxTl3KoOlOj;G$CS8fAIiw{_K}Msz zm(e>doK!Vqb|O=LgqY*jx_*t&`Xe6o?dM^q_u_2lu_6GPgg#T z?Px!9x}Z`n(>{o4U%p@TF7en2fNC6&IS>?Z*rdy?ES+4NfAcF~ln zgVlS;x~LW~>zX{F_e2cuRKGFH&u@pGPi z3)eraC=11kA-4oZGKx5s9#>`y`bpzKp#X{lflX(N2D?|tyKWwJO^_&~M$IK?J_K?c z+7qu`n-ya|ugn^z0pJkl^?GD`h7zgnTSOF%WcvTe+d>x>eam%Lu%ZLx89@>~v(?Z{ zKXh0s`*U+VC-4#*lp=Q#!7y`D-;L&K)y@6gjIn?*t-xqe4y+wWR7DV#d?YtUT0U2%svFfZY&&a^eHnx?x zSG!+d2%>#QWgTndpxwY3?6d(<_#MT&A|W~wpc+r*4wt%DD}=_@`G&DAPMZU0aV!_! zs)+4qfr}lv$n1BX;npc9-< zOck|Kg-6%t5ImGY3xMOsv~!&?seG zNCbF+VK!rvf*@1HK#i2j*dz-&BL-IN-7l%qBjsMWK5VW-b@PkKo;M^c)H}&D5H6o_ zXs3!egxS#1k+Ap?G<(?um$Ji5l5-G6uq0$32Qki zRFuP^I&LR9WQS1+m`z1)_%4AQDZGi#IwILPaIy0;02WU?MQp2D>JA}u?ubmu%y(Io z`_sMHtSA+Rd&E#o_g=^<4UZV0;*IbM6?}T;KQL>7$NaXB5qA=icslcHw86zNhy!Zc z*MbANu<`|6w6Q|8;+~tvql~fS99=8G2BQf5gs}Ur1aFP}Noi=Qw?aWM)y1`PlD)nQ zM8r9F)EV9J9GfF%>QzLX$dP-ay}aw+KQ}p_=}X_CMXFM>9Ai)H`ci3&%r=h$#LSN7 zA!`Vwuj(PqOm2yp(QFo7Fse4J#~7a)o~EuErvp^?s1FE?b0QQo{dMEuMu>}$Zg#;i zD>ShgpX_9qcU{He!;X2a&2{gS*p5poU92Z$Fzira{~jx1#c*9@?Z$K$dwu_Ur@ya( zWnPJz={jdgzwXyMLUOpXm1x$xdOhpcXQp|6(5>MfTLt<$Rm(`0JL}K(5#PG_lOvBM z2%b~-sZkSuUTKQ*j>z7MR!qfI$dRH(54ah9sg4;V8b@|{TGDxKz!ba3xyqUkC7Ht| zZ^wD5o)H)})ppLR5q+CtDjF2=dfIO5^5UzoSVvJ~LFjgTA+97qo|<2&+3EVfkH9u{ z9FxtXfTO1b5QM& z2IEb>D<&Y%QnZVZ_s>-Yt<~_Gu@d4RlReqA#uAGb{0Hdf+abTJ5s9$Swklrqxn0nY(Je72Y^5YB)fTsBJj}Q!chn@0 zVUzO-fY1zONp6^6^FkDi9n8JiS`y?se?KV6j%RdG^tgx}VQ}wufZBo5xS^v5lQsDI zXLbfWDb_TGzO(=CjSgiKDZXQKMC?sQC7o))uE+m>2{FsdmwASgcQ(IW^o~JVh6_RweMj&Nnj46lv?pZpfqI{ z+!BjaH%igz=YUernubVA0n-@aEW6=M9i-}byQML2Ye8ugR5UOgVzO>H%=agT*Qdv~R)ZxG2g>~3Wiz+g)@+NALpb4wh3}`Jx z-L8HWy^6N-1u4DWJLIN;z?=kE0&W+CS<3gZjig7 zw=MenPCYZIykgkA7bbz9-q^6bM^`L5hrgN}Y0wpjvs=%v_M^EzkBfS+z)+P*wW#V~ zqyoC?==$%dJFn^zeKwmJy3Peo%c(vJe8EDpjo-0-OcT?5nrHhtWz@N; zTDRPId#{CnLX=Po-om)%Fyq`oqZ$bmt6G?#QC~dhQOSNu9c`7+k;j}IxwyaBeO`e; zF~&w<+5^7@dY&0$#dyYCW1{Bd2civg*L!RvDuP!(FjBF@?FU6GNa0n6E$TKke|}uB z8#zvmSA=&v>{}Utk4L$XS(Th3jUlyZ-*OLSL-2?)U7|Sasnss^rL}Y+il7cnLWz|J z_cYYl?KH3RtWLnFhBRcDSxXLvN~O)ip0%o1s&WyYtOe2iY`P|>edt_4=Cz-0zd2t5 zZq}iERoy>RIk=qWeR*V54UY6BnBc=r=ee8%QjHQ=yl7c;>7A_d5=7XIt5o-y2~Udi z;<^lO5;R0nuHSPi%H7ke$#B$i58X))d7h&c>nbWjT6bf-p)8aTA2N^g* zS+aI}Z^yCdaf3n>s+$iXx>1^n&(3=w^jPKUfEv;6iq~|=O~C2VQ8CN9-ZeH9x(n)L zt&q7{qKOA?o2};$*A!Ad&I#FrG&Cy05Ut?R1vf3Znq>`CjVka+0@R1k&q(wP&zWt6 zfz>psP`41SD;IMI?q)3e06HHW#AJ#w{|v~3qu~3z8!o!bL_pkE_h5%NX98oTXAg+1=p zv%J$x&;@rVb~Ci;Q-8LZ=xBZyxilyFT|#IBWU@W94glK)r-iS(Cix^ssVdPcM0xD5 zN>c@dtYnly%Kgf!F0%U zhBe)6wstODl+UW1W=4|MO_kgG!Sqfvs^cX<#e0zMgJ?*WBKl-K`khz|hVIBDw+Km4 zqnxLDBCZK9>9czguw8O+C=JS;>7yLR3BjvU)UD0KY^BQ)Y4jrk7&9o-bv6Z22*m6d z%V^^-_j$FQuA8&~?y{(JqU3#*C=yJe?-=cncd!=oY=yZ(GM9JENm4qWU>i)xLL2Bva4<-LpRqo0Y5 z3_+GrbIqX$V?hw$5sJ#tuisBIgzc*>fy|IW5kmnNZN9112>m?s+A-elFjp}n#SL%z+oOWm-4Qk=!taIV5Q6DCWZ5=C=zRK#s(QT4fev)$6 z>$1}r3o}HRv+oLi)@n_l=GY*}(a_jb&_VyMOP_6ZL5cp0wFbO|oDkcUKs`r05+NwM zc4)8oTOu$DcYs=&<#)4mJ+oECp+ohmGhPg5Up>nm zA0q5XE^%I1#}Bo*bj=q0IJOz^s5L>Ch}Bk(y0?hknryZ9?VbSFO#*G^(>WSLtd{Gi z?k+oYb2#6seuG2gAPbz%56b5nBjOtc8CUlesX(mpcm3HHy<>jX@v4*J-0Gf(5zQ)H zQm2Y>cH1?bXQ#sB@c9{bD1sh4DY6QV9O_?cZo6OiY6y!Y_LT#JO<@pIAXRW18e-8$ z1Qf71laiS>0;v$*{5%vQrR0ZipN-+6Sb8l9mxKLWHz&92IcQx3*HJ)NSl(IdcEqHT zJ82x_!i?^wqRn*~^?A~(2deIMJMOB`q|>0MNIJ9vLT%}-K*_3TV!@)*dtsCWhM^nF z&y+N_$k1q@L)L2Sy#7AV2zO0JkNH|^IOGUp>|k3VK|6i`u!%{uIw;*2q3Uqt*na$9 z-86D~Cum4SCLXS4UW!1-O+2RAicN3P?+dM5x56jZr#mxSJ0ym!}aEIaFREfYWdy)(cnWofG5y@nea9NaJ}w&QCkC zkd+T3ywqj66xIogI>}ip+FVSzia&2Z)L_6KaK)OV6nddJPsVIy-qocz8@|id&YL=c z){&UnX4w;1AtZ>;n0{efFwwH2Q4lKi9FaW=l2DJ^7+58!v_tQT%vz1a z+^Xq`wQ|5=^f=C#&z((%M)pJGhDBu|I zun8hc$G;~x-(60mHa+8AOHdl;JzX&A@7y;Mx^pJl8C(mioRARC?>i?&7P1hRpF7E^ z7RNpKV7#uzru8gffK8_n!I{k)Pb7qxU3QK22(223=%!-ImGArxcoqVi#LD_6l46O6 zTtO^xhLcMv#Fj-pw;P4dQfPOP8Ko|FHc2kciPQ(6L~d2rnL<(UF>UkEy<4Vp zq)38Ge30nstR~CCT{`$w>zE7@%}_b9uf+R1z7{H%D&C@rJ<}nt7tK|~MGszd7;7cD z`f~dRup2QTRlXf1Kxmb=omV{im?GvPqV4F{q|2Hh=z~#9;%Jcb*-lkmT8%y!Dc1E_ zio~rp3;box9mTpKpk#tG(xc{+{`*RAbW>1--BO8GEch`Mw(o)Top(h$cF7M$na>x? zZmz2L<3mEu+Sa%hJtV~VVS=c&T45h0!JOA9LR6kz5Ai*FlJ~2cGl35c)tXm(ov+0a z^eGGHJf;8?3V&wfpqm!01?XyEDBoE%VV4}xS!_CWr{5jkJjAH0|7#~geW?b4kS@S7UmVDb z$N`!zFLOwmP;*X92Lu8tc1T2V1{8aqm2nKo^i(TXzRS$0f~tD;_tOG2E1IzD{2@qS3w;Mce;=;&me?_Fzngve@>g^Fcln54;-P~*0e)eT?2Afw)uUp+DJ?d z9R;ssFZ&F1w=|6==>llIliH}r1;r4^-8+>q;l2j(;5sO~o}^V+TYyACb;KQI4&uK&)m*3OVVh zOhyjN3g3vF*Uh1te%zhN8U+_!-IhyhJ6xrRN8`Yzvi5GaR_5<;5Uff}7~%K4f24-RdbVCw}*#BK{HLalD9aZ2~|;0Cpc6HN{5nO(n+)1#P2B|SNGqawAM ziyr$B2|~`Ui@u0IMqqWLfCCiYk&Xj-pb+kIs7>#R`-TH$@jr1v&b-ItS<;TlI+=M! zhtqQ#bwT>pLLbL=e%CKC6_>~jJw4Sp5WKZhY+}^g8*UyBVw_jjG=l=DAa%2U+K#?u_pWnKkLp z=tuv16JNtiK&ws*2!nKFsp#x4F(HGL_g@t^dK|!ETvbVf3?i)wXS>1vqW#Qbnq|?<g%9T;CiFGMw46yz*Y^0c(QFJ1V zdDX?k*Rv3`d73 zUUx;2Uw_r3g=!#FQ5m)ZKTGe=W~n;h}J*Gt={P8$6S{X-7<)JO}AIY~6SP(+E|Z9k_Rk zje4Ss1CXnyYf;v95NM}0$H;CHzdHVN=^pD&ei9N!)rXljFzX-#QTZzwLj@aGYCls> ztet{adFtNJS}4Sz3*%*t=)T<=Rk#Uz7=!{=o0P-viO{4LK^_s$^{UpU_n|X*yAo95sfZQ_du`CjgrIqVi18!OHv3NAwxBdbgfDTQ@HzMYA*HC^t?y z3`U|AU3o`;@|xI<2y=1LzQ5eiz%WmS=)?|0X}7Q5$x{6s^<=qvQ&gf=eFSb*u?p6> zCMidJsMy3xh{dLG@3Ek6AOR3=cW1W5$_GmXMGk2aW z_`3+v+^~8PCjHF&y{gjWOvH4`2IP_|_EVc;Lq*-}Fx?M>?WjF5EQX5aj9lrGq^Y(5 zq9h*A6z^S12*;(I+;_gzFs#khv}I?A=qq`cLZ^=!YVvfSn>JDPH6CrLsxGuBT4XZq zt4?_aH(l-!g^*hlx+Z*@(LyHG0T5(D4EDYu$0vQ~TCvFmEX>{Z1PUC>HgoOC%5P=# ztrN9Gq|jLzM9_2gTaXOPj>bTCu_vEyiYCsBDrUgnuZd z?U4{)L#`GMfQ_#;G_RN0`n8K8PFKYtByW~;A~b4=`216QykV#b8l7bRNb6ccqeYHwww;?MtC*6DUi)#BDcSr#w}Vc za2)rvOI1uiNaBNz~l*#V+(Ztuw9TFA*~^(khG8$31@q4b+>bOa?IChO?K9% z!SO&OqIN4_u}ozcnoRCjdfONTY8$2e?p6@1y?o`L!A0#+DJZ(m-*xmmQg$!gG*@M^ z@pj0c9`W=z-!~rEP@LEz(TM}l&&t%fhd6Y@Rh7EOSy8ZdUD+`#h6kjoFBG=pM8eWR zug@u$%2@6w>z};_b?+Ql3yO$oPMy2c5QUj%Ft79Fp0HekL$CDdyTf##F`b=SL{1t2 zXu-n;BR$qQXCTuZ=UmZ6trAJMTd$yI1;w(xw`R%(?XS>B4+6!KVnrorq@83xF3Xw$ zG-EBc!dH<_bK+nqQ62?R&t%>5e8hRzV;sM|vY)FWx`eh!!gLnD-rEE6cPlgt#gwd* z5&H;mkRCUxc8PHgZ0;|&;|E&gDnGoVseC#Y4*8_&{N2b!Z!a}xP4uybp2>S8o5p8G zj~{i+L=9G?;nws#vYxMtQ~i_v>na#clD;Ci)Ln7XFWt2Rh-g~{x8Fr=m79yt$0U}? zano9bn`yZ&d)ncq>F9J7-#fY;bDgI9*K(h=7)vXH%tR8B;?RemPo9E{XJe`Sxxxfe zTAh7TAx%i8AU=U8q7a1p;BEw{IUb#-;no$=0((vNQzzBub4pE;Lhd+3w~>EblVEK` zz;%|39FxsD*xYzTDeft@qb5RdhgsLPt@@6&Lu5!VifjB)=K|dArE?fl^=IHMW~ZV# z-+8!X&1->}JL~j&m!GlcQ>dS_cJMvc0eYN5BblrXi}d)GR0^T1!Pc;~v$!eN&r*FW zQ~}d@ER!-K1t&%q^v4-?BWq1gyng1(Ik?TKB|!%G+oeyzc6mSpbJ}X{+eA7g>B-hM zOp@(?Zx!&MbOfY_XmJRd+@1xUjVA^R)EKHs2)N8upp!{Vuaq+hPN~wNjbK)0I~u%- zG7FhGKR1(>wmjd?!Q#cP!{QQQURSQpb|+MAOdD&u*0%pyxH? zmBMrx&FEe3IFaaRyUhMv^jTH%$m{mYfx^>1lTPq+1)@7EV&sDge?ufS-)~f%_r4~L zF)q$zH#HVSgU_|Nmv}aI{dpiE!a`6o#N@&sqA{7yTWruVUEJlI<@jgobI@nnNiZu? zxZX||`Zu>t8)cL1RT$U!e9=r(3XzYgv*W2lmcJas?EuR)D`famkpi>MHs!1@xVzxP z96lyr^;vPLR;a031w?RIE5RvwdGni8kdkCw@i$~u}cU2^$*REYr9wUh$=QR;_1=G_Ko*cA>cMxHHDDUg+t+)GhL z_M)lZ_3GJCpP`cjW5)~=2nCSg)%5}ZdM@6X&1^wv z?wU2jTf>*Im3h~M@S+@nDmJC(igPFIwG7;z_4=I@j{xo=`yQ{Vb$-#O!_GeFKi-CYxXB;&Dx)Fpa>vE~{M? zz3u=eNM9y@h?u*4UKB1EwC9V4|5aRPd&icbX~!$M<=1>M1+Yv8RXl;Pg!#Vfd!!sW zcQiq3=yX%Re(y-GQov#0VrLr)(ZL+7dTvc!>KsOo7V7V=olmy0oYw8InfdzQv!6>& zhpdXpFgl@5tzU)c)~oxXS1YTe9@_4UV!rkixYzHIy1M8NV9lx%ZD$@rViwL9r9QvP zUtkowOg-Aj9h*W2Xr7I_pdQ+GB0DL#1y5M&c9^akh`141CVQ#P8x$>rL#ldmGE{c~ zhQUp_wuC`-v$3avAvr}l`}OZ0XN+mnL(7tjgtqD{2xn9PV*t;hO!W_8DERbtOJ7-> zgwh)m83qQ~0V@zhch@)ipE34n8vjQ|UrLRcRqq<5v#>DueSkxnns_0tnpZD89 z*v&awv6hMhY9lGFit7pwJrYw*&!rx+BN(v!b7l6UpjRw&37Gj5#qRy4b7r|Ha6v)M zbF_k0Cdkbl$n_wsv9!F^~s=!&(GvPSK%p)RQG{)KzQLj@^ zhF-m~feh~X{X0^yLX-3eP>%{HR53hayGS!X&abDA+3^_^%EjXHhw`pDr~)#@Gj_5) zh=v(2XeRlt3a|4Pb^dw)2+3sDwy?dUorBQyInWNafrIAGO+d~y(fS=^UG>+BHw#@* zD|CjlWc3KwXxlnyKxkj{0-7jyFV15i^>b&#k`-;~n-J?6?^_VA@a*%@yq>2DNOU|5 zyMj}kRr*!5ToCj>w~DGHWwb{0+i@>+G9%Ucs`z`{oxcqAqF4hcb+_~Ju|Mczx1L%$ zL7ufK!8jsuCysZE?o!aRtBLLjpuIrccHVS_aLBwSoib06b$7g`iRZCd(XC@yN&2L0 zm{g9v^scM=bi-Df2U2jbRUe`GpaVX6BxRF=cA&9sKo2D(xecU&tKQN4gySenCrXr$b}s0XrgwaY_Rw$ zDs(+(&3C>)pGU`ZpfGwxMimttipSa+bzOwVU)@E38dO=H5vD+mZ2F>=BavpN(|F<# z7FxwXC?NUX-D}%!Jf(3IOH)MODHj3F5PDTGQqQwOn6(&MyVeS8R{kCqD}t3LuxeqT zCNnc8au&wgET|%tohjePa)`#ckU0thkwrpo)A?8Yh;iG2Irc={h-v8@79LG?SzZ74 zx}8$b`{M=)LYa{%WVoX*LfNzyrBWU_+Pzb5stE~UFXR<3NSgB?nniVQij=p7fV{*v?q3vpwtKs#)lfxb&AP8ibpO>s~73ps&aM(qhV41JApi*m} z3~MA}8T8zoGl&hOBgpkts*YStoyFcXDx^(sS0J1eJ`vsjed?5Vf>GVCq9svuGLs_m zDx{>YEpibO(XgwMh=xEAx!66|GpQ5C48LX-!j2}?=7@50WG-N9!qj6|+PLKHvGe$~ z{(H)wksOx)9xv@b{+-))3a}Cm(dsM>aK<;I1?sr7U_Z zuH=9=<~)kPi|+JuJW)G^U33AuS{*&-!@%(aJlI&wF}Qq8h6~=f$Xo70SaY6Ba9U4X z&AO(70^>h&s~)YWqW3n}7h41!t}BcYGZS2E>EG7L6jTl$V5Cc)GzjtgxT)B%Fh2&^ zlY*dE5E|vly^yXv`VdJgA|G!KXBlQ3rCzr`%N)5MYD}g!TsX`+>s@xA-NDN=opwf! znqZ4?$C=SS@w`?}Tf><{CM@~+Vm<~&T>S5uP!Q`kgDw3;mYO$u1S zstX(;tS2Q*QwTjMn8PY&VfFk=V9l^`#Lj2^km;S|X}wTJS6!n}YeMf>j*1je zdWD^*F27zXwCY-GSIexB;U@|<`N)1%)%)xb-w*VF@lXY%mEk+F)t+aM6 z^)gRpJs|_VE=2Vxq_gk!_Z)-4?T=Fz+`@NWtH$Z|++17@TPB>wgC5=M$Rr$g5}lBm zNr;-0f&~F{g-74(r)eboT$;smfSXx&wT`8L(m9}6ssU2gmHv^ak8)yVpTdj-oP2!UxBSXT3`C@w=2@PpZlCMq>=Xf4Y zF4r;6r{FuAk~qm#wM|2dOw=!W*m{1@Ea|$vZ$eQ*Ig3Uc5#3N35sTN+O|ix~ zgo)zpe=u-U)(wtH0zO+G=d%-S%SIQkS|m)Z>T-N;kv>ZuXkfb1*D2OAW^6@dK$_l{jBy9C!7GTtgS zl_A|aj`8L$l7EtNkv0!myTjZi&yeLoh%<$(>9*IupS9{;9_CPNV9`0?!fEN~SJeur zq*84$|k>AUFuV@0@q#wEn#~kc)s3 zKkv_l{UT_^GPNTE17T}uw*_3;Kq)^3cWK;nfG8|_1%B=5R?B0+y|c0jF`6HpkC!iY7{W&&t>eh}o$@0>$5#15*OnivV8H?E4 z`)V$UUeB7eA0o7jcV&VbI9r&X_49aT9*1rEW@S02mdUiiBY$V~BwH0Nb3=+U&S6Y6 zE9W@c#lepERtv{Wz;otMbPFXht#!q7|n4}>kf_8@8g#_zq|lHYk2u~7IGsBI3RHBbGvUP4xFP@$yUT9B5b6;v z72e+LqE;_i<;hjc1Mx##9=E2X=1_VLqz|~B?<$8bhyz0LGdVzq%2-BDH^Unhd8y)C zvXp{C2ZVR*>ed9tK{KNK*_ElQBxku6Hibt)hM&1(ehze~RsOS8qoF2$$~mc8E#wd^ zR8X4*Y5dH!cDC-WRiYe*aY8+x=>y zU5ElvcWK%L%XRM=!q@Lp+p_nV$#z~VmqaD)6hGh)!X3g>SH~UkcvoyuATWK#m}HTg zPlsO5BgOjyY%H=P%YsspLxfyyjT8FP??NU=8y=ARd+n^^iU8=2SoALk^)9`tXih#H4qbD_ zLH2HU#Jub=u|q64x^X1=1w3c@%5MhESwjU#L@@%h}~oHw^v!D$NqNlBo;1UExMkxap+7ZcAk7 zJmg(=GU%&!Lyi0CT(%zo+sL_2crF(En57Y`vHqEohoBIx;u~UgKU}_uRXNg_hIMAY z=lUppnN`?G7RGcOB+6zfk5Y5d=TW&>?SM1uS}JL=2aA12=3pvuX`uplM+1avFT^;yY%$C zOP#jPViO1E1j1*HdV-tzY={vY%{h%woQ0YsJISgRk&H<^ z^c7~_(piqw@+?gA`z4acGt4tmF?qIZcV@9DNZd}+hlpE>!& z>ZgKEW7ARhqUG2Zce|!@XUD%2Tofbe>EcH9|Iu;@ng4>JY!{~}n+yi!f4DAta&`I^0V4!$}6#f~CJ-xwp_=QOR z1-YKGO#u>StQdBTnD2T2c^3)I+HR}MknT)Faw1#1a{mQ$pv~2aGgtZ7!CwPHH=-B3C&Cm-)%^uUX=i4gN*&^&i?y$2;3wEcJZf1I1;}q zb38aCrIH8)kD-!!RzjAxhNhQb#wtD)Cm?(XUc;sgh>!n9mM(j^9>*8UGT8ZyWUM4wR{dcN`r2qLlKWbOOT?53X|YuBFu~Ygc3v**K09cEdr@S-Y(qoPe4OB)lzr z;pee%GRiFP#E&2QUcd5v@YhV)Bpm0{34HC4v5*OF-6~qg8i^ZcJOi%CRVU9b&ybFQ z8Ob?M#o~@=^?R@P^xeAYZscKL>-3!~->37ie6rnZG5C!R3IVi`x(FTJX3?d<;HWu_ z9>=1x|2_T8kH2^Eg^61k%fX$e;7N>7m_ie@U;7cXvJecdEbS`r(;8$0^`D1W6`vt< zC%CoJbe*ju2WiHxM;fA`Ec2#7?JCtm^n`Ro#k*3%?gd7L=6WF29To-!G}>7rL}I*d zUb?M=?zp9lh~{pr6&H2Assx)#B%RJ>vL=o*NQ5gAL{LRxSQiv2b0CnM>{bQ1867I! zjR>q>$SXucu}I?z^SXFBmY{Bu&_O7;e?Ks^y)T9WR-`trr&s#dpRpcy&STf1& zqSe(psZx#|x}cIH7pmCc)_4)xxT?oct@R&br5s{|sefOs8p`OKZ0hgr{6>0HeOxC* z-Y)28;gUN^4hl*p(Wnl>?DIB~1&6L|EEv`xgx2kKo$p--OBs+LFf0v2`Z?=*$hG5Q z?~ENxx30s~wZ z4s&zEm-_{v|Ez9ltnvrU2t&)S_a@S*CJyFP7IkLv$;ev^8JSyGr**@p8V1^23Ngrs z8I|ltfcZ>ZG>q*;4p7+7JDF6ainmm6@Kp`BVmJ&fuCeKEP^#QSywaD0oGbE~fVB4= zr~(xBJ3u1?PORuC0y>1G-nA!6Ex~?pNU5ewJ>W&F-fx#`xxtOGD$gc|Zn!)@RLHx$ zpDtd}x*e@iQGYjw?%$&(O3+914h{%BqaPFR#)&f}p$c2GqnSImP(_#nLNLa6=s}eGxf@YLctZEw zM7fXQJuoI>bM4@@mP77*-PT!z)+eCNDHXNoe+HqwXb{Tu%8AZZ{)xZK{>~*`7S`|D z)*)!igl&)00w6$s#4`9q@G{<}K z^`C|vXR@3^TxidWmKzS!VV7VCwYH?*9R)N>0coOjjI|T)Mky>}QM5(89haDSe4bnH zVuna0bloC_Y;TyN)Qro-&(eA%CsCwizrAZFC>kOz8VmYfW%Dx*W5yj9teGeIvKw4j0cd&dZNSy;``8~=WSs|Q$loAI0T8)yHcPDr)$Evv#)Qafbnlu8? ziKkYW$!ui!5_-n2R&mfo8zxAjtI$E_a?;I!kHdxHE|-ZgdR40?_gP+7cW({Wv9OJv zuaP^V*Rh{_o!Po|n6BWbx>B}6P-_O%N>}N(cQ_b8VVj3g1ItOIE4M*>R>G7$>>q0!x#< zu$J2s9Mmy00q*htnIy*9o1hkiU6C-qfI6yCiDB~TaFXcy+$=mJQuw_0onW+3>FlL5 zTA}yiS5Y|ZQ4)!m<`HDqIf-G!#deo-9AD2<%f?lg9AtGxsXMB!U^fZHxNcK^IfnW0YM!P%ltWg51U0b^O<^J2qpdy1NcjM8*i)cJka5=oP2OjUYQ|x{q#9 znw=isyY{_H&UGD*ZG`3Z8~Roe#8v~t3r2OKEkemdt8%N^sa<(LVnoz+}ft*pul8&@)j?-D7=ioSbrRWELk zo9_Nl;H=p24|W}1{yP2A&T~KoVQL0F#d-(IzH?pE%i|DM>)vV{1J{k~E`CjVj9q1W z{6sYe%i938asVGATo%XgN9#b{_uMyk#v(=|C6A&|zIamc~sv3^~V#4RZ4 zpQCjkylBaB<`3it0-@R{>_JKL4twCZevdMWq8_~Om5@Q=jGPEEXV)D(o==trLf?!yuxwSn(f@|kCEJx{j;Y)MCF(~x|s5|aZrh@DzT}K*Uq5HP^+za|6CWr z-TbQZFa&=>K7UG7Wc|66a}&31fN?`8F!_)umBe%FiT!+pY(P>>kk-;MHVPq7)P_J^ z&(H}(c}3paogTOG9FmS>3qa4T`z(}l-dwvt7x;ZZt0=?aX-_jE;O&Cts;bO{MUYk6 z`RaxF;I=yq+K0JT+kgw)gJjm!9YVYNX>am%H6d(J$ZL8KT~l$lvLhbVO+gl0IuKV@ zHp1^#t2r^GU``DJPUItZg}#7M(B#eP+Ki{VeeteXDQFnNUU1E~adX4|91rA+CuhUr z4xW&`rW%#dp$xU^WPy7*6fFC#gZVRejR80M0lbk-Z&1o-95+vt@5Ij4w4wpDqlAuP zWrR-M^`qOrlEf8x5%Robb0O!fC&tdyi9e62*YU7M{~!%`(DGB&$;r~p`kB>4T!G}< z=agbP_Y429GPz;Ar)3l+~9YyvXonmXq-t_~*noZsG_#_94iu>;%t)due4R6;*(d&d zDJ!I##}|68sTA_gAO>RP#Wp#N)gAHNh3T^>(ICb| zsEn*lt+@cJBygFxQq8P6Nd9Ihc-2nu?|tuueHFNvrF&fvp@G6+x(kI=l!|%%UN@vg zNqY7Kp~s(YuBQSh3__rgsRH3fnDLzJAUMGJ`tvALts5d?16IBF+#o_LD;?pDk`yxL zMoz96VVUuJ#=UlsEL|rlS8sRl>^z1jXEY3oP&czAqqsW0hCl1TXw=}ML3m^z5 zZq$oN;gBdD8zGShw*fPDRNUE+7L~!!`~kN21T!zDghgASVGHFr(cO2%QLii3qN+O44X%*w6 zY6o8xe=pqyEXG;G#N6!rlo8Js>5xPg?Rs>kV{{{qD&?316cRiuR{*WttX>~lFJ@nB zbnsmcw8v;Hpx+}I7oS;0(LxQCj~0 zwHRT{7R60}B0{d!uA?+PlkY#j6C{<|V1GvtYsk9zns+1B_;1bUeeCLDlZv@okv081 zLDcQ@c1^&2L>QLp1o;<@w$t)#9A`_#h%Qp*3a8j0BxlB?>qZPpkx&q`r?_=FH+P8w zamP^QPJg$|^pZ;6RW*+STBls~nC2~WrxmTMs>xd`yMxL>( zgg-hQy?kDD82kpGmwA$Qq>CcD;@09;F^(9jY2Cr&dZ{;;0`=0Sx$)v=Vr2xWND^U$X#_K7Xu&2yaXUVsf+O%behxvg2vyGFcL%kK~& zJqFc6FBz4hnR5hqY}iLxcT`LkHK|lHHR8?@_Gqlcjc%Qg%lH`qO~v%BQd5Jp6Avv8 zk8zx1;NtKzsVaO~_27Oso5DPVq1f*i%CUIlMP}ZYyLX#69Rl#Za9d@_bUSG(`HG_C zrrp5MoW345NHiu7nOWdR^e9j-cw*@QZXHsG=Ddw69}p8drQcK5NS_YLw1tK*Oamcf zw)CxOZ|tLUPDV_wbKV~=;`mfF(|UHo(FoLxjERM~6zX*7o#;X$T~<+uv%8NA4K$y# zdzS+t)zX>ie(AD#R+e`-3#Pbm*i5Nn;_34KDr#1dnO-=}kctlZiF4+{s$>X*(n z>@d6V1bnxjy9q|&lK5$Xz2oAkE=E79n6MwbZXC!{02IvPUC^9Iy3-8M=Xe7znazH{ zp*?G0PFv7nlNjPMFK)gNe}B7ho^YA?yX$}xZ#;S0q9K$3apt8f@7;2|h@}oYXU+mL zcF608+D$VtQ%0Rvz|AEt;;jxMELGAv$WwSGmp<43wWt?}*y#>n$6XRQa+0e@RV$ z&}C5493niVKRBp^B7TH#l(mCDMMFcOo^`fAPxB#@rGoSL8L-|OSgTVYMymHjSUnfG zoJR1T^(wTSo%)8_T};?n{s11&i2`P3s7Y0vQ^C#a=sE9%PKREgHYb++0UO~bg{oEf zj^NzKUU^>K2|uG;mTxig+$66w)M^s%wmBvI5D759hJ3Zg0!U$VOdu|4SQ3I(U8x&)p zbnb%N#uUNcbrPDtq_3<8e+;m%%aXRvP-DFAIH(QYd3g#J_!SAbI zruRyHUbcc!Oj392V#_?=13Q6jV_GUS$22l&V^D3RitV1Gak>XplthncDS*zAJO%l# z6V2ghy7}%2k!tkWYH}18+CpYZ!U=qLYNU@YarafZ+*%kXjN^taJWowd*vo)Ga#Av zSksEVsMCEsw%-r3^rtB@%>Crg$(uPIWs&r?H1$|z?Af8S2Ri=Y50x#OJ$*;ix^pjF z3l#Fq_|h93&YY-&y$rzvf-M)ma(u^h!4wR8NgJ;jKcgA;0VgQ4r>MCi!qYVU|2G}1 zOclBD$L-)2z*^pMYj!ddR#u~AdR0K2T02-oo%6qEtN;q2|Lm@6S9pJZDpnFlDB+Em zBAEU7AHB;KJz7PlBr2O1aLgi5?hwpid(%D({a+5nJ}NemqP_cejY*6mfAY5uDKJ`~ zblLS0w_Fe|4rf6po5vtH4_;D#xiw+#{OuQ}2AWZA)5A2FGF>Val>&q*U)>Wi+!(c- z-#OlyG)>qls>4BLTNBz58KQem2i7UFHs4!X3*AbU{IUSFa1ky^Ya2`8ikqB__L$8r ze1w8)DsMl1(FKr?=gYT0^N>x(JOjw`w43eh7b?M$6V6lkku0i=IVteGuzRP=5M#HP zY;Jl7e>yjBho_i^VizmLbakZnHw}Eo0g&xrQ5YLfcVV@StZgkXUA;UPJA-{3x0$B% zJ^tJF^8~8ltq}Ki!JD5x&vHL|Lye|!ox2KE*4GHx<4$YeTslv>Ea)J z?_a^LyimY=UehQdBLo#;I+FoiVS@Swoefu`<6;|u|4jivk)8d8X(T2+O33+3bmf@d zIM}6eR#WLLc0-_S+!8rv?N+u$^rwF5@jn^y-_O8ze9y( zaIxwI;Y{a2(%;c$fJC%I%mB0OV}D)nCqzxY@9pDN$lGX{?u^ zI9~>pb0yDtm2ShuWgdNLW^^G9zn}TJ8E)1J!BZhLJIVRq{m_mJI&zwq(4S=j%u=Y6 zrBEIR#lHg}ZyJFUBaI{8xjtu(j@5rCiUj|f-0f*{wv`3w<9$NJrPGkpF^y-pGpBJ2 zqoZM<`blw7@R%%AOCBiG3b_Vjg*i{|P1owBuPuvW3Zd(`B%!aaz!P-Cn=@yI^QNHl zI7$<{|9+m9$OVOVXWvE(*E6BBTvQBfcZ;C$xcfdl-|usfpamXcBb%5Hs7#ZP@-wmG z_dIGKWHcdTuh`F=U33?BP-qbII0@YXzYv0G_`(W+{#exJ`N%#VbGaz6L*fYqj+K2T zD||F%o7o>@gp)TlFR%UIIXLca_EI|!52g3+$l1`&3*D=9>D|bpI|ShioW!&gn{MO} z-f_0zty>H&1|3aUyHX!)fzf%L}$0y+o$$3fcra%mp&j|`$QD7e3)KT;0h0372=;Xcy4U#;C){?gN z=U??wHZjqT>&gWAoNM5CH()|l){$ne%2~X9oUq{O)HB%SXp8@p@!5A5x38rAVv})_ z5_G+3>KhHHrbEh7Kc|kQzhu|7-nkbc<(V)Tb3^;Z)gqV0RbCZOMRc$Fx%syP5t>rm zBpMy9r#s?`nAEi*bC_jN+GDTIDUbMs`eZKgi&rOt_B=g^Jv41)wy8QVZmuDKJZ?gvv z2os_+6eyjH*hVA2bj*ozeJQ(&Mokoz$4+yge{AIDpYOTXXM^Di_Ns~S!Z&Itb!pPn zP`gE79$~39Zj>sWT%J+U%)J#XGBQ|?FCi86IV;Q9`1FjyffYErBqQ+$TeEx_Lh{oV;FaDeN8cMALGxfY0~4nULonN$h~x%){X80$IEe? z({?qJwFli$sk`G{y*gm-`p<7g21(!?5>5{7XayJYv|g>gCU5+3E9*?INnl)hvwn$z2=3ka|T8^-*+~885=-)rtGy*bNahRx;W_x=5h5C4Vy#WGG&)(o+z9Ga=7LU574`JlBJ zV3;%F-kRi+Q@xGJdBt!HM=^gcmRhI=R4G7%X z9T$ZzZ9?&7zq&}-0*8{i=6n4eYQvS#SM}3}|Hcm{|NW#{U{~;P5w!8}Dc>p2B(&un zH}q#ZR=Nvl3%Sa*;-5)rJif}Ek00ZUOEfJBN&O+7IAS{EqBk*Sh6^4V>p?M4DxuCO zkWxCI?f3jqsr)E>EB}8wW1Lr0TvrchEmXsNmR^-!r-g82QMz1il{yfhh5ek+h~!l( z;AkW~TPOWE^5tTlEQP&G9sxg(`4Nc^^xwpSkhY zNs!{sS$VUFu#l6iP>L=WHY=IW^9>w%F+Iu(^W~Tuelx-q!!w{d;`P{HlZTMup?dA_ zAd}F8x0eG=SnOka+~Mqn*ewP$vtIt=K(aY1X=ntQt}e~baA?YAJ4@3oUHH0@m?-huauB9)mH1O&im-68bE)+v%4p)|%=taj4yw(f!5mGEf_k-h8PJsMhC;J7#`sADr1(WF15aI^Glqi8s@b;G)dj`zT+7)kXnVq%}%1k5770^$I-Ez*oiQ|0ZVn}-dO+vPtjcw=FG$5*+ z>ilk}Km9~v-K2oxRhr@dHJ0lN4NdT~cdBq9@;T8AZARR7f~#vHV%wXLt2-(>0B!~7 z2D4L&?2T$k_L3D1NFLe}-&=_Bh%Vr__VK~*y5KA!2t??n}(D>|3 z9E{45i~{ZiUR-X`#&ev_8EMdBI(g`aM{N+`b%vL{6(mI!^hHzP_M|K7LcCR|6b!+o zb2Zx_(#Jb~WSJjU(9>Wgq1X~YVbcfQx#2y|iw=3|+4KrZ4O_*jz`xCke9rGXUVR@c zgpLW7$c)0^?=gB8g7quEp9MWbWE_i|{0*qIYpRO6E+e%?SSVr9PF@=RLedL5F2j$? zy5~5H-tP6$odBO7lk0jop&w~%F z96>cQ$Vfsr51og|-K)Cp@nX-|B8dmAzfu6(G>C33`pfQsQ?+U`WyJLRr$+8VU$wtC zq51Z{w0HgA1K}*Hh-Y5?@w3{EmS^GOa9d%|D4r|kwo8JMo@tmh4|{^#wXD-pH0KoC z)hUkoy*UT#iH&u8JBti|7KFR^zAltcg`0OD~#i0|ha5OK(9fqb%>4@8`_&G8)Jg_6$XrV0iv3W`dAT5;em)X~Y zw?eIBLmKXc8*e!)^Ez6m<=|vDzh}d8glq(x{ZJ>7_ORPr*jU}(Z^fOu`TO;XG|=ju z8_%60(NX}}1ioxu5WIhDL88k=lmWCBOX;J#sODg`l9-f|o@wJBg2c~b4_ILl=M2^I zCM-{b!%alu>~wG-Pxh`~P&ew*y~@JrtY^r$=S%d|C%HAcA z;cuQmI`6LDb2Yr@+rP`dBq2Ab`z)JFa~uv`tR%(ztnqT%13T@A=^_ zO8cQSIFCHcR%G}bGg>7P3bIsDbzGwVJcRTGyppt6S%#OK@b;sD=;L|MKW@(xp2tXx z%3{}ARi)dQn2>0p4l+yrI(5fR?wsvMBV@3qgR7Q$tHkHgCO#5-s-7dSl^*dFM|qX_IY z*$E5BIOsQoPQ2ciy6n4OltL#!5=o@ooC>bntuAWe~7|Lk8BW%}AoTj-~#lX<>pI8{e;-`qQ=4SIwZ&u*F- zdHQ<@3ZFgjaqy&%U3@c+L`6au+$8WJ9iC>Ft?wpd_`_WUvX!?F#34?SI=pQb`5T5p z-r>1?<~RIW)-E0eHiw1p^|A~*oiRsdw$UvL@p+?i&*HGxFSD8_?k?|*YMGq`254OW zrxk2!bWl!x#tn(0Lt*$iApJDEf4<1n=DZV7Bdx{oQ-EsWd*{#lt!Gs)5E)HIMb;+8 z!@dx2-dhF>kl&&pP;e=%uLrNm2eo6accNu8BZPk@6)x1Q(1^4!qrv&)Cx|(n0gVt1 zxbF)eecOMJw}fw=CdsJ7qzVIzqZ7F-Sr1nVryKmtfF5TQmVf;U#d?eCo78{ZAUxz!VWsF$*^B6SPrw7TWr z%XXr(3kpCN0!AUvP?nDWB`#WB`L&yHs_}VP99+V9UKww+XPnvIF)Ju2{qr_E+=wQE>-=!UTMv!1i5XLG zIKHO!!u9)1rs!$Zi#F)hb@ykJn6Ex7L*;x4F-n-r`Tm>=PWL*CzUTh!al=fas+J;pm~u777n#nxT-5x3>w!^^X-b>!n$v}_h; ziBYLC7icep*>k|3FF6_pGDD*E@N}C#E?lbl3R8Ryh~ecqaYyZ4J*%5#Hi{`)f?y!} zN8NWfx0)tUVNpvSWmYR-U8jF5M$e1hp+^Z6#x&@eh370NryVk#1v-qYxNtgu&u7AJ zF4$(TzC)e{@NmlU9;q`%@mMT8oXdt@y1~Anjqs>IaY@f*HwWDy#r1 zo12@OKS4u1T!mVmu{`Icx7~LHYZV&5r@E=f1c*UiTwya0x*osmF2}?`l@lp&g4rP? zlq>S0bw9!_Rv_1$m-kGuq)U{9L?%Af*sPY0Vx<75P;?qlbzMXCrq~5$Gh7ERH3e&O z5Jn|YVVdVLyRVus*(Y!&Z8#CSbA-9_@A!9}k9>CYg}XyGc=A-NthMlF86C^?)K-L7 zy~~!oN7f|%ojcSunpVe;Y5NHml|Ul)%sBKkq04=$)+_kDiQAM^MZ|J6uAk0D)%@YD zTTXyFO=Pg;HcoS$K1y`62km|X0#)*(((dz>>}bev_*5e&bODpr$n=IRq`l~(8XmvQ z-_Rioi`b>nbB%fUg8M~v8hLD^UW3}PrYKtANmFU(9D|&NoZ`(W;q(0WL+t+9w2nL8 zJ>Ct%fa9;5rllSbRsdaSkNFI>pb|BbRm)oDj+P4#(jsuj<@w?sk3CZz$EEi@3v`3B z=LM<(b3azKoPE#=7X_dTM1`CMhAbjS3&fu*y}0I!o<`jCS|pQ5!B)h0PFi)km72wA zNY)DlCxi?`X=!}l9UYyB&`!}PoCWxp>PV(bgu+^9E)|GKxKr%oKlmp8OH<`_M>ZB0 zor=$%_*A>69Lh{zP|Qe5@>cJn#4%ef@j}UNODZE&qD{r#ZUfg=$pR2u8^(Z8W<=$J2T9 zm|if|Lisrzk@x-{OnJLtsF+QEkewjRn8T+F{nS}_VHZz$B-pX?W#88zqGd?^9Pb9Z zKc602-3L!}FosgxCHg5zKR^z8fHbAw`_I$}pq7SSIYphBWH{!Y$3Hp<#(2jwALe7X z?v<(4JN>m#kysS_-@!uUZwK!ixoJ)nKnM6HpxWDKJ&Vwduuno{yVEwGkbeaLEj(8U z^q9##lCf7y7iim7P_8J+1sym&b!Kk-z3M;U%Kll@wG9tiF`d8y7oyh7I98*OIS=nH z^m)jfK_e%hFY1spjNiK7xP%7Pmk}0i*^OqRIGO26Ifdm0PZ7|~FI*RrbRWY5c)DGT z(>QD6K<8Rw;}f1psQY#g$*Q3~p3}#R_abnm!!PlfYPs|cd~f^(h9Fawt4<7&B+ZV8 zxu@w?PYLyN_~XGzX520pD)Tnc;EJ=!>yvxtdu!2)%0LHnLL4Ed z{Z&^w@1*t=7=JH~IYYN#CBeKn7am!7Z#BJy8yO;QE85Gh)oD-TnzQ6ucx0b{aCW!e z+3&{dR&V&}p17kSZuDky*ggd3^d^|;epNUpCvOWflo?$Umrxy-Q zf#fd$=w>}Krqw;Mx?IL%ir<4viZgIM&RH7{!Dl|5Vr3xt9m)- zvhWjm9p);wjzNZMIA8D-8g`B1-x}{e*b^c-M^sMkwDAVzrO%7;Josj={aJ0!%XVKN zb$a6Fb6!VfFq*Wz3mv!8>|PmKPHXYmH$GS2u9KYbDxGM6VkPl)TW0!<>?}f@g96Io z!=FnLaugTcue|NGF4mef)4xI}-vy&|b-q?3CSCU1EY5N5oohF{D<}VsK5FYyD}P0M zQgIW3!sW~hQWqe^=+gpZgYX) z_42|bc%Hlf((-@jdiFsd&L~MccbN$hqcR7)2Cq3|wR=uM1{*|WlQler^b}+@yJ_9L zMnI$p-Bb2UI0=G%eul28YW+;x;*Tljb!s65$f7d}+eXva7s3~dlL{igl}eM4DOv?* zXW}7;u4Nf<^y}UuJAU6T1+pBKH|?%Vv0{Bnhz3<@26JS*K&aU`@AeQm)@vAatqJHxCRUef+xP2g`xvCJHpV9{r(F(7$Ng(kA3sPBGuaf;oU6Q~qXfYd%#hS0f%OkItn zWt@yUmc-`_X|xLsBsgmrS(IynOi0kT(|>|NeYft<)@ppjd*!%5k2B!R;qW0gZxaxm zSH+70TQeNz5wvDDlnYg2&EDs7(m zJv4${0cXg}O|(Xr==R^_@Uz~O)F*B8-89Zhn8SD6W;uB_QnKH_D<3#urqNvq73O&h zMmk^q4(RGQl6hYIam>0?=YS4-c;Mv9Cv%_OGdp9OX_ydC5t{Xm>Z9m zXrGuxwP7E$!#}35xM^q71=Pve9&inj8tIBhf{?NZE#vI7);@IJ>9I93j?{`WfcG+17ohjGV_n z!upQUFgUCDUcjE%FUL7+eSd$K`EhowD8w-_a-}ZQ7LVuJk{pu30_b;z|0ZUiMa_rQ zvHTEw_VlfK4u}M;9LeS+RRy}7<2*$jo!{JC@3zq#(?uD-^x2)>j7Vm8Jjb=v4yP=C zHdV+1ltLh$BZHPkha`3QUS;mMbKg~OpGnt4w{~%xn6tgB%$9-R(iA=NL>u#jVrz|% zwM@@6ra2i-QSZk1&Q9l!w2@zf@nNtClngqQWu#PS{6x`B**f>d3fTPqbDxO39r|zm z&w)V%sS~;uhpq5dps_RK*&lYpq)boOaN*nkxyQK+ed6DSY|Zz0QiOK2RuiU9^LL+7 zJXhcYgdaV>z#%&s-qO5MPV~%c;&!JQ+8To5YiiX3Op*xwN^`a^4Um~w`1F@vxg~Q5 z=gnd;UPivgg)iey;Kn7g!HE-X)E7`TPI@o-`J!(y*i`Y3=*s9FS2cFY^LJXFk0H3H zXlNH%fl8AvPDqG!2#s2xiL>J6g9HwNG?XL2@YD047eZA%%_vTVwBO~Q)JSYjG$FKy z`PgYW&AIh{-4TzzWf17P|D4F`dYxvcA+*QT8dIV!h%4&%(&Z-~k~kaw7D?H{&~j-~ z;<|XME+@=;Nkb!$yP}R_tcK*A`$3w83M*xK8Z#vX2c=oF;gO4UG|aNGe`#Sx^i;tDgVxBPPfqwctaTM#;r(-O(4|bg>xRnpi)m|ybfuzPvD!_;wr+Wc z{Ws0Z=2OD1pNVdBu_oBjTHwMd?4?x0=Q!zfFE*-qPEGl97osi=Y8J8GJOlD2CD&-P zk;#$KGZ1bRB~t;_T6_8t%)9I}yQMTXn6kyOh9WsZGmxgz&jD$kRaO^!ROmbXMKK=m zO+-f*p(|GM-tAm?)|zPbJ!yJ^VReQ*fx@_$5K#fPsf@i}KaE0e=0D^gp5r+)y%PpG zap`Znwu1$p5yJz4-f2$gmn!k{dqq^qnbMV5;BisdGcpp2h1&rZv8nubW2CwUg@>>h zMaXew#XG0EfbNY#e_8>d4P9&?tjOZp#UOVI)6cK7DG{&P%}vl#2RqH?8W5%e@5Kiu2!h=&Fxk_^_KV+96|t zbB28E_L}Xa$SovhLiXLmzbdQujrz>~=E4b1$o;WU2Cr~4(%5N-r#9-*qF^p_AR$F5 zOaUVq(D4Lp$OU=O8`zlF67&C>SwJsLVpvGo*9`18^&;8PWP-1AFNXWV%-57vU;%=~ z?)eTza25!4oBUj+vzw!JHv^$)Q1t=nH~6}Stx=fS-2jcf9Tj0m|O4f>Nnm@p0F1@G-AB*2!Q4?(IAE*-?(&4Yi^=)jfM6;ao zoInr3@E2WZy2MFlgG4LpvWeNI(;j!RQ`Ou@YG&G@bs^I{6nL~{QBUX1I4AZFEAKhy zSWK09`F6mp5U=Tq%k!9{wP`PkSkQ(DZ^+~i7A&-ESLf)y1$rK{``ZO7!?kJ&O(A2Q z-P+n+nlmAkqhDuy@pp0Q-361}jOB>gV?_aKvA!Q}829=6EAo{x9!5#WUkBh{busLSNS7fw^*vn# zci$?v8zl!)MJ(z6cyAQ$(`kYBvo$-GGx4rwDUiOQc4BOrG1Jo2jAuk*F1#xyS6BXQ zP$)uFZ1ZKmo2*bV;%sDl@|Rm*+^KbY)R`skiUERS7dW~FzL1;e)I`jm#kSK_KOcbY zGVd(fDKa=sJ@hZWH(K{j4L@CWj#sb2I8*Uh3jvqC>;*B2)gKoh+gxl{r8-!d`I;W0 z^fpK$aifRvamc&V;lk6Z{W+oq%{H@lXuYuGX#h2-8eqTdS@LJMcYIf6yb6J|Ya`78 z`zFPap~Mr-%G}4foK-HPbnTD@?laNOlp)jNNV&q(ZoDdNf#MFus`!^J_{$j+JPu6M zWp8q3RP)wd!S@z?UrZjI`h}HVP^{0-(g5ksyFj$=bQPTYUQiItqvDLP&1>!giEusZ zc3zeOd*0sN-|drSo0{5?WEtC?nHGets all public and private fields for a type + // deepestBaseType: Stops at this base type (exclusive) + public static IEnumerable GetAllFields(Type type, Type deepestBaseType) + { + const BindingFlags publicFields = BindingFlags.Public | BindingFlags.Instance; + const BindingFlags privateFields = BindingFlags.NonPublic | BindingFlags.Instance; + + // get public fields (includes fields from base type) + FieldInfo[] allPublicFields = type.GetFields(publicFields); + foreach (FieldInfo field in allPublicFields) + { + yield return field; + } + + // get private fields in current type, then move to base type + while (type != null) + { + FieldInfo[] allPrivateFields = type.GetFields(privateFields); + foreach (FieldInfo field in allPrivateFields) + { + yield return field; + } + + type = type.BaseType; + + // stop early + if (type == deepestBaseType) + { + break; + } + } + } + + public static bool IsSyncVar(this FieldInfo field) + { + object[] fieldMarkers = field.GetCustomAttributes(typeof(SyncVarAttribute), true); + return fieldMarkers.Length > 0; + } + + public static bool IsSerializeField(this FieldInfo field) + { + object[] fieldMarkers = field.GetCustomAttributes(typeof(SerializeField), true); + return fieldMarkers.Length > 0; + } + + public static bool IsVisibleField(this FieldInfo field) + { + return field.IsPublic || IsSerializeField(field); + } + + public static bool ImplementsInterface(this FieldInfo field) + { + return typeof(T).IsAssignableFrom(field.FieldType); + } + + public static bool HasShowInInspector(this FieldInfo field) + { + object[] fieldMarkers = field.GetCustomAttributes(typeof(ShowInInspectorAttribute), true); + return fieldMarkers.Length > 0; + } + + // checks if SyncObject is public or has our custom [ShowInInspector] field + public static bool IsVisibleSyncObject(this FieldInfo field) + { + return field.IsPublic || HasShowInInspector(field); + } + } +} diff --git a/Assets/Mirror/Editor/InspectorHelper.cs.meta b/Assets/Mirror/Editor/InspectorHelper.cs.meta new file mode 100644 index 0000000..852ff71 --- /dev/null +++ b/Assets/Mirror/Editor/InspectorHelper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 047c894c2a5ccc1438b7e59302f62744 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Mirror.Editor.asmdef b/Assets/Mirror/Editor/Mirror.Editor.asmdef new file mode 100644 index 0000000..651b8fe --- /dev/null +++ b/Assets/Mirror/Editor/Mirror.Editor.asmdef @@ -0,0 +1,19 @@ +{ + "name": "Mirror.Editor", + "rootNamespace": "", + "references": [ + "GUID:30817c1a0e6d646d99c048fc403f5979", + "GUID:1d0b9d21c3ff546a4aa32399dfd33474" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/Assets/Mirror/Editor/Mirror.Editor.asmdef.meta b/Assets/Mirror/Editor/Mirror.Editor.asmdef.meta new file mode 100644 index 0000000..e2e6f2a --- /dev/null +++ b/Assets/Mirror/Editor/Mirror.Editor.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 1c7c33eb5480dd24c9e29a8250c1a775 +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/NetworkBehaviourInspector.cs b/Assets/Mirror/Editor/NetworkBehaviourInspector.cs new file mode 100644 index 0000000..52c56d6 --- /dev/null +++ b/Assets/Mirror/Editor/NetworkBehaviourInspector.cs @@ -0,0 +1,104 @@ +using System; +using System.Reflection; +using UnityEditor; +using UnityEngine; + +namespace Mirror +{ + [CustomEditor(typeof(NetworkBehaviour), true)] + [CanEditMultipleObjects] + public class NetworkBehaviourInspector : Editor + { + bool syncsAnything; + SyncObjectCollectionsDrawer syncObjectCollectionsDrawer; + + // does this type sync anything? otherwise we don't need to show syncInterval + bool SyncsAnything(Type scriptClass) + { + // check for all SyncVar fields, they don't have to be visible + foreach (FieldInfo field in InspectorHelper.GetAllFields(scriptClass, typeof(NetworkBehaviour))) + { + if (field.IsSyncVar()) + { + return true; + } + } + + // has OnSerialize that is not in NetworkBehaviour? + // then it either has a syncvar or custom OnSerialize. either way + // this means we have something to sync. + MethodInfo method = scriptClass.GetMethod("OnSerialize"); + if (method != null && method.DeclaringType != typeof(NetworkBehaviour)) + { + return true; + } + + // SyncObjects are serialized in NetworkBehaviour.OnSerialize, which + // is always there even if we don't use SyncObjects. so we need to + // search for SyncObjects manually. + // Any SyncObject should be added to syncObjects when unity creates an + // object so we can check length of list so see if sync objects exists + return ((NetworkBehaviour)serializedObject.targetObject).HasSyncObjects(); + } + + void OnEnable() + { + // sometimes target is null. just return early. + if (target == null) return; + + // If target's base class is changed from NetworkBehaviour to MonoBehaviour + // then Unity temporarily keep using this Inspector causing things to break + if (!(target is NetworkBehaviour)) { return; } + + Type scriptClass = target.GetType(); + + syncObjectCollectionsDrawer = new SyncObjectCollectionsDrawer(serializedObject.targetObject); + + syncsAnything = SyncsAnything(scriptClass); + } + + public override void OnInspectorGUI() + { + DrawDefaultInspector(); + DrawSyncObjectCollections(); + DrawDefaultSyncSettings(); + } + + // Draws Sync Objects that are IEnumerable + protected void DrawSyncObjectCollections() + { + // Need this check in case OnEnable returns early + if (syncObjectCollectionsDrawer == null) return; + + syncObjectCollectionsDrawer.Draw(); + } + + // Draws SyncSettings if the NetworkBehaviour has anything to sync + protected void DrawDefaultSyncSettings() + { + // does it sync anything? then show extra properties + // (no need to show it if the class only has Cmds/Rpcs and no sync) + if (!syncsAnything) + { + return; + } + + EditorGUILayout.Space(); + EditorGUILayout.LabelField("Sync Settings", EditorStyles.boldLabel); + + // sync direction + SerializedProperty syncDirection = serializedObject.FindProperty("syncDirection"); + EditorGUILayout.PropertyField(syncDirection); + + // sync mdoe: only show for ServerToClient components + if (syncDirection.enumValueIndex == (int)SyncDirection.ServerToClient) + EditorGUILayout.PropertyField(serializedObject.FindProperty("syncMode")); + + // sync interval + EditorGUILayout.PropertyField(serializedObject.FindProperty("syncInterval")); + + // apply + serializedObject.ApplyModifiedProperties(); + } + } +} diff --git a/Assets/Mirror/Editor/NetworkBehaviourInspector.cs.meta b/Assets/Mirror/Editor/NetworkBehaviourInspector.cs.meta new file mode 100644 index 0000000..78d9fa8 --- /dev/null +++ b/Assets/Mirror/Editor/NetworkBehaviourInspector.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f02853db46b6346e4866594a96c3b0e7 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/NetworkInformationPreview.cs b/Assets/Mirror/Editor/NetworkInformationPreview.cs new file mode 100644 index 0000000..ec0a01e --- /dev/null +++ b/Assets/Mirror/Editor/NetworkInformationPreview.cs @@ -0,0 +1,305 @@ +using System.Collections.Generic; +using UnityEditor; +using UnityEngine; + +namespace Mirror +{ + [CustomPreview(typeof(GameObject))] + class NetworkInformationPreview : ObjectPreview + { + struct NetworkIdentityInfo + { + public GUIContent name; + public GUIContent value; + } + + struct NetworkBehaviourInfo + { + // This is here just so we can check if it's enabled/disabled + public NetworkBehaviour behaviour; + public GUIContent name; + } + + class Styles + { + public GUIStyle labelStyle = new GUIStyle(EditorStyles.label); + public GUIStyle componentName = new GUIStyle(EditorStyles.boldLabel); + public GUIStyle disabledName = new GUIStyle(EditorStyles.miniLabel); + + public Styles() + { + Color fontColor = new Color(0.7f, 0.7f, 0.7f); + labelStyle.padding.right += 20; + labelStyle.normal.textColor = fontColor; + labelStyle.active.textColor = fontColor; + labelStyle.focused.textColor = fontColor; + labelStyle.hover.textColor = fontColor; + labelStyle.onNormal.textColor = fontColor; + labelStyle.onActive.textColor = fontColor; + labelStyle.onFocused.textColor = fontColor; + labelStyle.onHover.textColor = fontColor; + + componentName.normal.textColor = fontColor; + componentName.active.textColor = fontColor; + componentName.focused.textColor = fontColor; + componentName.hover.textColor = fontColor; + componentName.onNormal.textColor = fontColor; + componentName.onActive.textColor = fontColor; + componentName.onFocused.textColor = fontColor; + componentName.onHover.textColor = fontColor; + + disabledName.normal.textColor = fontColor; + disabledName.active.textColor = fontColor; + disabledName.focused.textColor = fontColor; + disabledName.hover.textColor = fontColor; + disabledName.onNormal.textColor = fontColor; + disabledName.onActive.textColor = fontColor; + disabledName.onFocused.textColor = fontColor; + disabledName.onHover.textColor = fontColor; + } + } + + GUIContent title; + Styles styles = new Styles(); + + public override GUIContent GetPreviewTitle() + { + if (title == null) + { + title = new GUIContent("Network Information"); + } + return title; + } + + public override bool HasPreviewGUI() + { + // need to check if target is null to stop MissingReferenceException + return target != null && target is GameObject gameObject && gameObject.GetComponent() != null; + } + + public override void OnPreviewGUI(Rect r, GUIStyle background) + { + if (Event.current.type != EventType.Repaint) + return; + + if (target == null) + return; + + GameObject targetGameObject = target as GameObject; + + if (targetGameObject == null) + return; + + NetworkIdentity identity = targetGameObject.GetComponent(); + + if (identity == null) + return; + + if (styles == null) + styles = new Styles(); + + + // padding + RectOffset previewPadding = new RectOffset(-5, -5, -5, -5); + Rect paddedr = previewPadding.Add(r); + + //Centering + float initialX = paddedr.x + 10; + float Y = paddedr.y + 10; + + Y = DrawNetworkIdentityInfo(identity, initialX, Y); + + Y = DrawNetworkBehaviors(identity, initialX, Y); + + Y = DrawObservers(identity, initialX, Y); + + _ = DrawOwner(identity, initialX, Y); + + } + + float DrawNetworkIdentityInfo(NetworkIdentity identity, float initialX, float Y) + { + IEnumerable infos = GetNetworkIdentityInfo(identity); + // Get required label size for the names of the information values we're going to show + // There are two columns, one with label for the name of the info and the next for the value + Vector2 maxNameLabelSize = new Vector2(140, 16); + Vector2 maxValueLabelSize = GetMaxNameLabelSize(infos); + + Rect labelRect = new Rect(initialX, Y, maxNameLabelSize.x, maxNameLabelSize.y); + Rect idLabelRect = new Rect(maxNameLabelSize.x, Y, maxValueLabelSize.x, maxValueLabelSize.y); + + foreach (NetworkIdentityInfo info in infos) + { + GUI.Label(labelRect, info.name, styles.labelStyle); + GUI.Label(idLabelRect, info.value, styles.componentName); + labelRect.y += labelRect.height; + labelRect.x = initialX; + idLabelRect.y += idLabelRect.height; + } + + return labelRect.y; + } + + float DrawNetworkBehaviors(NetworkIdentity identity, float initialX, float Y) + { + IEnumerable behavioursInfo = GetNetworkBehaviorInfo(identity); + + // Show behaviours list in a different way than the name/value pairs above + Vector2 maxBehaviourLabelSize = GetMaxBehaviourLabelSize(behavioursInfo); + Rect behaviourRect = new Rect(initialX, Y + 10, maxBehaviourLabelSize.x, maxBehaviourLabelSize.y); + + GUI.Label(behaviourRect, new GUIContent("Network Behaviours"), styles.labelStyle); + // indent names + behaviourRect.x += 20; + behaviourRect.y += behaviourRect.height; + + foreach (NetworkBehaviourInfo info in behavioursInfo) + { + if (info.behaviour == null) + { + // could be the case in the editor after existing play mode. + continue; + } + + GUI.Label(behaviourRect, info.name, info.behaviour.enabled ? styles.componentName : styles.disabledName); + behaviourRect.y += behaviourRect.height; + Y = behaviourRect.y; + } + + return Y; + } + + float DrawObservers(NetworkIdentity identity, float initialX, float Y) + { + if (identity.observers.Count > 0) + { + Rect observerRect = new Rect(initialX, Y + 10, 200, 20); + + GUI.Label(observerRect, new GUIContent("Network observers"), styles.labelStyle); + // indent names + observerRect.x += 20; + observerRect.y += observerRect.height; + + foreach (KeyValuePair kvp in identity.observers) + { + GUI.Label(observerRect, $"{kvp.Value.address}:{kvp.Value}", styles.componentName); + observerRect.y += observerRect.height; + Y = observerRect.y; + } + } + + return Y; + } + + float DrawOwner(NetworkIdentity identity, float initialX, float Y) + { + if (identity.connectionToClient != null) + { + Rect ownerRect = new Rect(initialX, Y + 10, 400, 20); + GUI.Label(ownerRect, new GUIContent($"Client Authority: {identity.connectionToClient}"), styles.labelStyle); + Y += ownerRect.height; + } + return Y; + } + + // Get the maximum size used by the value of information items + Vector2 GetMaxNameLabelSize(IEnumerable infos) + { + Vector2 maxLabelSize = Vector2.zero; + foreach (NetworkIdentityInfo info in infos) + { + Vector2 labelSize = styles.labelStyle.CalcSize(info.value); + if (maxLabelSize.x < labelSize.x) + { + maxLabelSize.x = labelSize.x; + } + if (maxLabelSize.y < labelSize.y) + { + maxLabelSize.y = labelSize.y; + } + } + return maxLabelSize; + } + + Vector2 GetMaxBehaviourLabelSize(IEnumerable behavioursInfo) + { + Vector2 maxLabelSize = Vector2.zero; + foreach (NetworkBehaviourInfo behaviour in behavioursInfo) + { + Vector2 labelSize = styles.labelStyle.CalcSize(behaviour.name); + if (maxLabelSize.x < labelSize.x) + { + maxLabelSize.x = labelSize.x; + } + if (maxLabelSize.y < labelSize.y) + { + maxLabelSize.y = labelSize.y; + } + } + return maxLabelSize; + } + + IEnumerable GetNetworkIdentityInfo(NetworkIdentity identity) + { + List infos = new List + { + GetAssetId(identity), + GetString("Scene ID", identity.sceneId.ToString("X")) + }; + + if (Application.isPlaying) + { + infos.Add(GetString("Network ID", identity.netId.ToString())); + infos.Add(GetBoolean("Is Client", identity.isClient)); + infos.Add(GetBoolean("Is Server", identity.isServer)); + infos.Add(GetBoolean("Is Owned", identity.isOwned)); + infos.Add(GetBoolean("Is Local Player", identity.isLocalPlayer)); + } + return infos; + } + + IEnumerable GetNetworkBehaviorInfo(NetworkIdentity identity) + { + List behaviourInfos = new List(); + + NetworkBehaviour[] behaviours = identity.GetComponents(); + foreach (NetworkBehaviour behaviour in behaviours) + { + behaviourInfos.Add(new NetworkBehaviourInfo + { + name = new GUIContent(behaviour.GetType().FullName), + behaviour = behaviour + }); + } + return behaviourInfos; + } + + NetworkIdentityInfo GetAssetId(NetworkIdentity identity) + { + string assetId = identity.assetId.ToString(); + if (string.IsNullOrWhiteSpace(assetId)) + { + assetId = ""; + } + return GetString("Asset ID", assetId); + } + + static NetworkIdentityInfo GetString(string name, string value) + { + return new NetworkIdentityInfo + { + name = new GUIContent(name), + value = new GUIContent(value) + }; + } + + static NetworkIdentityInfo GetBoolean(string name, bool value) + { + return new NetworkIdentityInfo + { + name = new GUIContent(name), + value = new GUIContent((value ? "Yes" : "No")) + }; + } + } +} diff --git a/Assets/Mirror/Editor/NetworkInformationPreview.cs.meta b/Assets/Mirror/Editor/NetworkInformationPreview.cs.meta new file mode 100644 index 0000000..9bf2de4 --- /dev/null +++ b/Assets/Mirror/Editor/NetworkInformationPreview.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 51a99294efe134232932c34606737356 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/NetworkManagerEditor.cs b/Assets/Mirror/Editor/NetworkManagerEditor.cs new file mode 100644 index 0000000..94b0844 --- /dev/null +++ b/Assets/Mirror/Editor/NetworkManagerEditor.cs @@ -0,0 +1,108 @@ +using UnityEditor; +using UnityEditorInternal; +using UnityEngine; + +namespace Mirror +{ + [CustomEditor(typeof(NetworkManager), true)] + [CanEditMultipleObjects] + public class NetworkManagerEditor : Editor + { + SerializedProperty spawnListProperty; + ReorderableList spawnList; + protected NetworkManager networkManager; + + protected void Init() + { + if (spawnList == null) + { + networkManager = target as NetworkManager; + spawnListProperty = serializedObject.FindProperty("spawnPrefabs"); + spawnList = new ReorderableList(serializedObject, spawnListProperty) + { + drawHeaderCallback = DrawHeader, + drawElementCallback = DrawChild, + onReorderCallback = Changed, + onRemoveCallback = RemoveButton, + onChangedCallback = Changed, + onAddCallback = AddButton, + // this uses a 16x16 icon. other sizes make it stretch. + elementHeight = 16 + }; + } + } + + public override void OnInspectorGUI() + { + Init(); + DrawDefaultInspector(); + EditorGUI.BeginChangeCheck(); + spawnList.DoLayoutList(); + if (EditorGUI.EndChangeCheck()) + { + serializedObject.ApplyModifiedProperties(); + } + } + + static void DrawHeader(Rect headerRect) + { + GUI.Label(headerRect, "Registered Spawnable Prefabs:"); + } + + internal void DrawChild(Rect r, int index, bool isActive, bool isFocused) + { + SerializedProperty prefab = spawnListProperty.GetArrayElementAtIndex(index); + GameObject go = (GameObject)prefab.objectReferenceValue; + + GUIContent label; + if (go == null) + { + label = new GUIContent("Empty", "Drag a prefab with a NetworkIdentity here"); + } + else + { + NetworkIdentity identity = go.GetComponent(); + label = new GUIContent(go.name, identity != null ? $"AssetId: [{identity.assetId}]" : "No Network Identity"); + } + + GameObject newGameObject = (GameObject)EditorGUI.ObjectField(r, label, go, typeof(GameObject), false); + + if (newGameObject != go) + { + if (newGameObject != null && !newGameObject.GetComponent()) + { + Debug.LogError($"Prefab {newGameObject} cannot be added as spawnable as it doesn't have a NetworkIdentity."); + return; + } + prefab.objectReferenceValue = newGameObject; + } + } + + internal void Changed(ReorderableList list) + { + EditorUtility.SetDirty(target); + } + + internal void AddButton(ReorderableList list) + { + spawnListProperty.arraySize += 1; + list.index = spawnListProperty.arraySize - 1; + + SerializedProperty obj = spawnListProperty.GetArrayElementAtIndex(spawnListProperty.arraySize - 1); + obj.objectReferenceValue = null; + + spawnList.index = spawnList.count - 1; + + Changed(list); + } + + internal void RemoveButton(ReorderableList list) + { + spawnListProperty.DeleteArrayElementAtIndex(spawnList.index); + if (list.index >= spawnListProperty.arraySize) + { + list.index = spawnListProperty.arraySize - 1; + } + } + } +} diff --git a/Assets/Mirror/Editor/NetworkManagerEditor.cs.meta b/Assets/Mirror/Editor/NetworkManagerEditor.cs.meta new file mode 100644 index 0000000..7fe8dbc --- /dev/null +++ b/Assets/Mirror/Editor/NetworkManagerEditor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 519712eb07f7a44039df57664811c2c5 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/NetworkScenePostProcess.cs b/Assets/Mirror/Editor/NetworkScenePostProcess.cs new file mode 100644 index 0000000..2fa07d6 --- /dev/null +++ b/Assets/Mirror/Editor/NetworkScenePostProcess.cs @@ -0,0 +1,98 @@ +using System.Collections.Generic; +using System.Linq; +using UnityEditor; +using UnityEditor.Callbacks; +using UnityEngine; + +namespace Mirror +{ + public class NetworkScenePostProcess : MonoBehaviour + { + [PostProcessScene] + public static void OnPostProcessScene() + { + // find all NetworkIdentities in all scenes + // => can't limit it to GetActiveScene() because that wouldn't work + // for additive scene loads (the additively loaded scene is never + // the active scene) + // => ignore DontDestroyOnLoad scene! this avoids weird situations + // like in NetworkZones when we destroy the local player and + // load another scene afterwards, yet the local player is still + // in the FindObjectsOfType result with scene=DontDestroyOnLoad + // for some reason + // => OfTypeAll so disabled objects are included too + // => Unity 2019 returns prefabs here too, so filter them out. + IEnumerable identities = Resources.FindObjectsOfTypeAll() + .Where(identity => identity.gameObject.hideFlags != HideFlags.NotEditable && + identity.gameObject.hideFlags != HideFlags.HideAndDontSave && + identity.gameObject.scene.name != "DontDestroyOnLoad" && + !Utils.IsPrefab(identity.gameObject)); + + foreach (NetworkIdentity identity in identities) + { + // if we had a [ConflictComponent] attribute that would be better than this check. + // also there is no context about which scene this is in. + if (identity.GetComponent() != null) + Debug.LogError("NetworkManager has a NetworkIdentity component. This will cause the NetworkManager object to be disabled, so it is not recommended."); + + // not spawned before? + // OnPostProcessScene is called after additive scene loads too, + // and we don't want to set main scene's objects inactive again + if (!identity.isClient && !identity.isServer) + { + // valid scene object? + // otherwise it might be an unopened scene that still has null + // sceneIds. builds are interrupted if they contain 0 sceneIds, + // but it's still possible that we call LoadScene in Editor + // for a previously unopened scene. + // (and only do SetActive if this was actually a scene object) + if (identity.sceneId != 0) + { + PrepareSceneObject(identity); + } + // throwing an exception would only show it for one object + // because this function would return afterwards. + else + { + // there are two cases where sceneId == 0: + // * if we have a prefab open in the prefab scene + // * if an unopened scene needs resaving + // show a proper error message in both cases so the user + // knows what to do. + string path = identity.gameObject.scene.path; + if (string.IsNullOrWhiteSpace(path)) + Debug.LogError($"{identity.name} is currently open in Prefab Edit Mode. Please open the actual scene before launching Mirror."); + else + Debug.LogError($"Scene {path} needs to be opened and resaved, because the scene object {identity.name} has no valid sceneId yet."); + + // either way we shouldn't continue. nothing good will + // happen when trying to launch with invalid sceneIds. + EditorApplication.isPlaying = false; + } + } + } + } + + static void PrepareSceneObject(NetworkIdentity identity) + { + // set scene hash + identity.SetSceneIdSceneHashPartInternal(); + + // spawnable scene objects are force disabled on scene load to + // ensure Start/Update/etc. aren't called until actually spawned. + // + // note: NetworkIdentity.OnDisable adds itself to the + // spawnableObjects dictionary (only if sceneId != 0) + identity.gameObject.SetActive(false); + + // safety check for prefabs with more than one NetworkIdentity + GameObject prefabGO = PrefabUtility.GetCorrespondingObjectFromSource(identity.gameObject); + if (prefabGO) + { + GameObject prefabRootGO = prefabGO.transform.root.gameObject; + if (prefabRootGO != null && prefabRootGO.GetComponentsInChildren().Length > 1) + Debug.LogWarning($"Prefab {prefabRootGO.name} has several NetworkIdentity components attached to itself or its children, this is not supported."); + } + } + } +} diff --git a/Assets/Mirror/Editor/NetworkScenePostProcess.cs.meta b/Assets/Mirror/Editor/NetworkScenePostProcess.cs.meta new file mode 100644 index 0000000..b567cc9 --- /dev/null +++ b/Assets/Mirror/Editor/NetworkScenePostProcess.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a3ec1c414d821444a9e77f18a2c130ea +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/SceneDrawer.cs b/Assets/Mirror/Editor/SceneDrawer.cs new file mode 100644 index 0000000..f391684 --- /dev/null +++ b/Assets/Mirror/Editor/SceneDrawer.cs @@ -0,0 +1,47 @@ +using UnityEditor; +using UnityEngine; + +namespace Mirror +{ + [CustomPropertyDrawer(typeof(SceneAttribute))] + public class SceneDrawer : PropertyDrawer + { + public override void OnGUI(Rect position, SerializedProperty property, GUIContent label) + { + if (property.propertyType == SerializedPropertyType.String) + { + SceneAsset sceneObject = AssetDatabase.LoadAssetAtPath(property.stringValue); + + if (sceneObject == null && !string.IsNullOrWhiteSpace(property.stringValue)) + { + // try to load it from the build settings for legacy compatibility + sceneObject = GetBuildSettingsSceneObject(property.stringValue); + } + if (sceneObject == null && !string.IsNullOrWhiteSpace(property.stringValue)) + { + Debug.LogError($"Could not find scene {property.stringValue} in {property.propertyPath}, assign the proper scenes in your NetworkManager"); + } + SceneAsset scene = (SceneAsset)EditorGUI.ObjectField(position, label, sceneObject, typeof(SceneAsset), true); + + property.stringValue = AssetDatabase.GetAssetPath(scene); + } + else + { + EditorGUI.LabelField(position, label.text, "Use [Scene] with strings."); + } + } + + protected SceneAsset GetBuildSettingsSceneObject(string sceneName) + { + foreach (EditorBuildSettingsScene buildScene in EditorBuildSettings.scenes) + { + SceneAsset sceneAsset = AssetDatabase.LoadAssetAtPath(buildScene.path); + if (sceneAsset!= null && sceneAsset.name == sceneName) + { + return sceneAsset; + } + } + return null; + } + } +} diff --git a/Assets/Mirror/Editor/SceneDrawer.cs.meta b/Assets/Mirror/Editor/SceneDrawer.cs.meta new file mode 100644 index 0000000..6a996dc --- /dev/null +++ b/Assets/Mirror/Editor/SceneDrawer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b24704a46211b4ea294aba8f58715cea +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/SyncObjectCollectionsDrawer.cs b/Assets/Mirror/Editor/SyncObjectCollectionsDrawer.cs new file mode 100644 index 0000000..2c95bcf --- /dev/null +++ b/Assets/Mirror/Editor/SyncObjectCollectionsDrawer.cs @@ -0,0 +1,83 @@ +// helper class for NetworkBehaviourInspector to draw all enumerable SyncObjects +// (SyncList/Set/Dictionary) +// 'SyncObjectCollectionsDrawer' is a nicer name than 'IEnumerableSyncObjectsDrawer' +using System.Collections; +using System.Collections.Generic; +using System.Reflection; +using UnityEditor; + +namespace Mirror +{ + class SyncObjectCollectionField + { + public bool visible; + public readonly FieldInfo field; + public readonly string label; + + public SyncObjectCollectionField(FieldInfo field) + { + this.field = field; + visible = false; + label = $"{field.Name} [{field.FieldType.Name}]"; + } + } + + public class SyncObjectCollectionsDrawer + { + readonly UnityEngine.Object targetObject; + readonly List syncObjectCollectionFields; + + public SyncObjectCollectionsDrawer(UnityEngine.Object targetObject) + { + this.targetObject = targetObject; + syncObjectCollectionFields = new List(); + foreach (FieldInfo field in InspectorHelper.GetAllFields(targetObject.GetType(), typeof(NetworkBehaviour))) + { + // only draw SyncObjects that are IEnumerable (SyncList/Set/Dictionary) + if (field.IsVisibleSyncObject() && + field.ImplementsInterface() && + field.ImplementsInterface()) + { + syncObjectCollectionFields.Add(new SyncObjectCollectionField(field)); + } + } + } + + public void Draw() + { + if (syncObjectCollectionFields.Count == 0) { return; } + + EditorGUILayout.Space(); + EditorGUILayout.LabelField("Sync Collections", EditorStyles.boldLabel); + + for (int i = 0; i < syncObjectCollectionFields.Count; i++) + { + DrawSyncObjectCollection(syncObjectCollectionFields[i]); + } + } + + void DrawSyncObjectCollection(SyncObjectCollectionField syncObjectCollectionField) + { + syncObjectCollectionField.visible = EditorGUILayout.Foldout(syncObjectCollectionField.visible, syncObjectCollectionField.label); + if (syncObjectCollectionField.visible) + { + using (new EditorGUI.IndentLevelScope()) + { + object fieldValue = syncObjectCollectionField.field.GetValue(targetObject); + if (fieldValue is IEnumerable syncObject) + { + int index = 0; + foreach (object item in syncObject) + { + string itemValue = item != null ? item.ToString() : "NULL"; + string itemLabel = $"Element {index}"; + EditorGUILayout.LabelField(itemLabel, itemValue); + + index++; + } + } + } + } + } + } +} diff --git a/Assets/Mirror/Editor/SyncObjectCollectionsDrawer.cs.meta b/Assets/Mirror/Editor/SyncObjectCollectionsDrawer.cs.meta new file mode 100644 index 0000000..44ba75d --- /dev/null +++ b/Assets/Mirror/Editor/SyncObjectCollectionsDrawer.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 6f90afab12e04f0e945d83e9d38308a3 +timeCreated: 1632556645 \ No newline at end of file diff --git a/Assets/Mirror/Editor/SyncVarAttributeDrawer.cs b/Assets/Mirror/Editor/SyncVarAttributeDrawer.cs new file mode 100644 index 0000000..2356a5e --- /dev/null +++ b/Assets/Mirror/Editor/SyncVarAttributeDrawer.cs @@ -0,0 +1,28 @@ +using UnityEditor; +using UnityEngine; + +namespace Mirror +{ + [CustomPropertyDrawer(typeof(SyncVarAttribute))] + public class SyncVarAttributeDrawer : PropertyDrawer + { + static readonly GUIContent syncVarIndicatorContent = new GUIContent("SyncVar", "This variable has been marked with the [SyncVar] attribute."); + + public override void OnGUI(Rect position, SerializedProperty property, GUIContent label) + { + Vector2 syncVarIndicatorRect = EditorStyles.miniLabel.CalcSize(syncVarIndicatorContent); + float valueWidth = position.width - syncVarIndicatorRect.x; + + Rect valueRect = new Rect(position.x, position.y, valueWidth, position.height); + Rect labelRect = new Rect(position.x + valueWidth, position.y, syncVarIndicatorRect.x, position.height); + + EditorGUI.PropertyField(valueRect, property, label, true); + GUI.Label(labelRect, syncVarIndicatorContent, EditorStyles.miniLabel); + } + + public override float GetPropertyHeight(SerializedProperty property, GUIContent label) + { + return EditorGUI.GetPropertyHeight(property); + } + } +} diff --git a/Assets/Mirror/Editor/SyncVarAttributeDrawer.cs.meta b/Assets/Mirror/Editor/SyncVarAttributeDrawer.cs.meta new file mode 100644 index 0000000..6311f1d --- /dev/null +++ b/Assets/Mirror/Editor/SyncVarAttributeDrawer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 27821afc81c4d064d8348fbeb00c0ce8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver.meta b/Assets/Mirror/Editor/Weaver.meta new file mode 100644 index 0000000..121fbf4 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: d9f8e6274119b4ce29e498cfb8aca8a4 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/AssemblyInfo.cs b/Assets/Mirror/Editor/Weaver/AssemblyInfo.cs new file mode 100644 index 0000000..08b43f5 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/AssemblyInfo.cs @@ -0,0 +1,3 @@ +using System.Runtime.CompilerServices; + +[assembly: InternalsVisibleTo("Mirror.Tests")] diff --git a/Assets/Mirror/Editor/Weaver/AssemblyInfo.cs.meta b/Assets/Mirror/Editor/Weaver/AssemblyInfo.cs.meta new file mode 100644 index 0000000..d356af8 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/AssemblyInfo.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 929924d95663264478d4238d4910d22e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Empty.meta b/Assets/Mirror/Editor/Weaver/Empty.meta new file mode 100644 index 0000000..6e29ee7 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 30fc290f2ff9c29498f54f63de12ca6f +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Empty/GenericArgumentResolver.cs b/Assets/Mirror/Editor/Weaver/Empty/GenericArgumentResolver.cs new file mode 100644 index 0000000..a88144a --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/GenericArgumentResolver.cs @@ -0,0 +1 @@ +// Removed Oct 1 2020 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/Empty/GenericArgumentResolver.cs.meta b/Assets/Mirror/Editor/Weaver/Empty/GenericArgumentResolver.cs.meta new file mode 100644 index 0000000..685f914 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/GenericArgumentResolver.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: fd67b3f7c2d66074a9bc7a23787e2ffb +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Empty/MessageClassProcessor.cs b/Assets/Mirror/Editor/Weaver/Empty/MessageClassProcessor.cs new file mode 100644 index 0000000..b38f171 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/MessageClassProcessor.cs @@ -0,0 +1 @@ +// removed Oct 5 2020 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/Empty/MessageClassProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Empty/MessageClassProcessor.cs.meta new file mode 100644 index 0000000..cbea4d6 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/MessageClassProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: e25c00c88fc134f6ea7ab00ae4db8083 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Empty/Program.cs b/Assets/Mirror/Editor/Weaver/Empty/Program.cs new file mode 100644 index 0000000..a214b81 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/Program.cs @@ -0,0 +1 @@ +// Removed 05/09/20 diff --git a/Assets/Mirror/Editor/Weaver/Empty/Program.cs.meta b/Assets/Mirror/Editor/Weaver/Empty/Program.cs.meta new file mode 100644 index 0000000..0a14018 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/Program.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 0152994c9591626408fcfec96fcc7933 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Empty/SyncDictionaryProcessor.cs b/Assets/Mirror/Editor/Weaver/Empty/SyncDictionaryProcessor.cs new file mode 100644 index 0000000..a88144a --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/SyncDictionaryProcessor.cs @@ -0,0 +1 @@ +// Removed Oct 1 2020 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/Empty/SyncDictionaryProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Empty/SyncDictionaryProcessor.cs.meta new file mode 100644 index 0000000..0a7c2aa --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/SyncDictionaryProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 29e4a45f69822462ab0b15adda962a29 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Empty/SyncEventProcessor.cs b/Assets/Mirror/Editor/Weaver/Empty/SyncEventProcessor.cs new file mode 100644 index 0000000..2fdbc52 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/SyncEventProcessor.cs @@ -0,0 +1 @@ +// removed 2020-09 diff --git a/Assets/Mirror/Editor/Weaver/Empty/SyncEventProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Empty/SyncEventProcessor.cs.meta new file mode 100644 index 0000000..81b9576 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/SyncEventProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a5d8b25543a624384944b599e5a832a8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Empty/SyncListProcessor.cs b/Assets/Mirror/Editor/Weaver/Empty/SyncListProcessor.cs new file mode 100644 index 0000000..a88144a --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/SyncListProcessor.cs @@ -0,0 +1 @@ +// Removed Oct 1 2020 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/Empty/SyncListProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Empty/SyncListProcessor.cs.meta new file mode 100644 index 0000000..b73b047 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Empty/SyncListProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 4f3445268e45d437fac325837aff3246 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/EntryPoint.meta b/Assets/Mirror/Editor/Weaver/EntryPoint.meta new file mode 100644 index 0000000..81827c5 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPoint.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 251338e67afb4cefa38da924f8c50a6e +timeCreated: 1628851818 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedHook.cs b/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedHook.cs new file mode 100644 index 0000000..b5db851 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedHook.cs @@ -0,0 +1,188 @@ +// for Unity 2020+ we use ILPostProcessor. +// only automatically invoke it for older versions. +#if !UNITY_2020_3_OR_NEWER +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using Mono.CecilX; +using UnityEditor; +using UnityEditor.Compilation; +using UnityEngine; +using UnityAssembly = UnityEditor.Compilation.Assembly; + +namespace Mirror.Weaver +{ + public static class CompilationFinishedHook + { + // needs to be the same as Weaver.MirrorAssemblyName! + const string MirrorRuntimeAssemblyName = "Mirror"; + const string MirrorWeaverAssemblyName = "Mirror.Weaver"; + + // global weaver define so that tests can use it + internal static Weaver weaver; + + // delegate for subscription to Weaver warning messages + public static Action OnWeaverWarning; + // delete for subscription to Weaver error messages + public static Action OnWeaverError; + + // controls whether Weaver errors are reported direct to the Unity console (tests enable this) + public static bool UnityLogEnabled = true; + + [InitializeOnLoadMethod] + public static void OnInitializeOnLoad() + { + CompilationPipeline.assemblyCompilationFinished += OnCompilationFinished; + + // We only need to run this once per session + // after that, all assemblies will be weaved by the event + if (!SessionState.GetBool("MIRROR_WEAVED", false)) + { + // reset session flag + SessionState.SetBool("MIRROR_WEAVED", true); + SessionState.SetBool("MIRROR_WEAVE_SUCCESS", true); + + WeaveExistingAssemblies(); + } + } + + public static void WeaveExistingAssemblies() + { + foreach (UnityAssembly assembly in CompilationPipeline.GetAssemblies()) + { + if (File.Exists(assembly.outputPath)) + { + OnCompilationFinished(assembly.outputPath, new CompilerMessage[0]); + } + } + + EditorUtility.RequestScriptReload(); + } + + static Assembly FindCompilationPipelineAssembly(string assemblyName) => + CompilationPipeline.GetAssemblies().First(assembly => assembly.name == assemblyName); + + static bool CompilerMessagesContainError(CompilerMessage[] messages) => + messages.Any(msg => msg.type == CompilerMessageType.Error); + + public static void OnCompilationFinished(string assemblyPath, CompilerMessage[] messages) + { + // Do nothing if there were compile errors on the target + if (CompilerMessagesContainError(messages)) + { + Debug.Log("Weaver: stop because compile errors on target"); + return; + } + + // Should not run on the editor only assemblies (test ones still need to be weaved) + if (assemblyPath.Contains("-Editor") || + (assemblyPath.Contains(".Editor") && !assemblyPath.Contains(".Tests"))) + { + return; + } + + // skip Mirror.dll because CompilationFinishedHook can't weave itself. + // this would cause a sharing violation. + // skip Mirror.Weaver.dll too. + string assemblyName = Path.GetFileNameWithoutExtension(assemblyPath); + if (assemblyName == MirrorRuntimeAssemblyName || assemblyName == MirrorWeaverAssemblyName) + { + return; + } + + // find Mirror.dll + Assembly mirrorAssembly = FindCompilationPipelineAssembly(MirrorRuntimeAssemblyName); + if (mirrorAssembly == null) + { + Debug.LogError("Failed to find Mirror runtime assembly"); + return; + } + + string mirrorRuntimeDll = mirrorAssembly.outputPath; + if (!File.Exists(mirrorRuntimeDll)) + { + // this is normal, it happens with any assembly that is built before mirror + // such as unity packages or your own assemblies + // those don't need to be weaved + // if any assembly depends on mirror, then it will be built after + return; + } + + // find UnityEngine.CoreModule.dll + string unityEngineCoreModuleDLL = UnityEditorInternal.InternalEditorUtility.GetEngineCoreModuleAssemblyPath(); + if (string.IsNullOrEmpty(unityEngineCoreModuleDLL)) + { + Debug.LogError("Failed to find UnityEngine assembly"); + return; + } + + HashSet dependencyPaths = GetDependencyPaths(assemblyPath); + dependencyPaths.Add(Path.GetDirectoryName(mirrorRuntimeDll)); + dependencyPaths.Add(Path.GetDirectoryName(unityEngineCoreModuleDLL)); + + if (!WeaveFromFile(assemblyPath, dependencyPaths.ToArray())) + { + // Set false...will be checked in \Editor\EnterPlayModeSettingsCheck.CheckSuccessfulWeave() + SessionState.SetBool("MIRROR_WEAVE_SUCCESS", false); + if (UnityLogEnabled) Debug.LogError($"Weaving failed for {assemblyPath}"); + } + } + + static HashSet GetDependencyPaths(string assemblyPath) + { + // build directory list for later asm/symbol resolving using CompilationPipeline refs + HashSet dependencyPaths = new HashSet + { + Path.GetDirectoryName(assemblyPath) + }; + foreach (Assembly assembly in CompilationPipeline.GetAssemblies()) + { + if (assembly.outputPath == assemblyPath) + { + foreach (string reference in assembly.compiledAssemblyReferences) + { + dependencyPaths.Add(Path.GetDirectoryName(reference)); + } + } + } + + return dependencyPaths; + } + // helper function to invoke Weaver with an AssemblyDefinition from a + // file path, with dependencies added. + static bool WeaveFromFile(string assemblyPath, string[] dependencies) + { + // resolve assembly from stream + using (DefaultAssemblyResolver asmResolver = new DefaultAssemblyResolver()) + using (AssemblyDefinition assembly = AssemblyDefinition.ReadAssembly(assemblyPath, new ReaderParameters{ ReadWrite = true, ReadSymbols = true, AssemblyResolver = asmResolver })) + { + // add this assembly's path and unity's assembly path + asmResolver.AddSearchDirectory(Path.GetDirectoryName(assemblyPath)); + asmResolver.AddSearchDirectory(Helpers.UnityEngineDllDirectoryName()); + + // add dependencies + if (dependencies != null) + { + foreach (string path in dependencies) + { + asmResolver.AddSearchDirectory(path); + } + } + + // create weaver with logger + weaver = new Weaver(new CompilationFinishedLogger()); + if (weaver.Weave(assembly, asmResolver, out bool modified)) + { + // write changes to file if modified + if (modified) + assembly.Write(new WriterParameters{WriteSymbols = true}); + + return true; + } + return false; + } + } + } +} +#endif diff --git a/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedHook.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedHook.cs.meta new file mode 100644 index 0000000..ed537ab --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedHook.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: de2aeb2e8068f421a9a1febe408f7051 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedLogger.cs b/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedLogger.cs new file mode 100644 index 0000000..e053404 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedLogger.cs @@ -0,0 +1,31 @@ +// logger for compilation finished hook. +// where we need a callback and Debug.Log. +// for Unity 2020+ we use ILPostProcessor. +#if !UNITY_2020_3_OR_NEWER +using Mono.CecilX; +using UnityEngine; + +namespace Mirror.Weaver +{ + public class CompilationFinishedLogger : Logger + { + public void Warning(string message) => Warning(message, null); + public void Warning(string message, MemberReference mr) + { + if (mr != null) message = $"{message} (at {mr})"; + + if (CompilationFinishedHook.UnityLogEnabled) Debug.LogWarning(message); + CompilationFinishedHook.OnWeaverWarning?.Invoke(message); + } + + public void Error(string message) => Error(message, null); + public void Error(string message, MemberReference mr) + { + if (mr != null) message = $"{message} (at {mr})"; + + if (CompilationFinishedHook.UnityLogEnabled) Debug.LogError(message); + CompilationFinishedHook.OnWeaverError?.Invoke(message); + } + } +} +#endif diff --git a/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedLogger.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedLogger.cs.meta new file mode 100644 index 0000000..f8c7139 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPoint/CompilationFinishedLogger.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 47026732f0fa475c94bd1dd41f1de559 +timeCreated: 1629379868 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPoint/EnterPlayModeHook.cs b/Assets/Mirror/Editor/Weaver/EntryPoint/EnterPlayModeHook.cs new file mode 100644 index 0000000..5dffa97 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPoint/EnterPlayModeHook.cs @@ -0,0 +1,44 @@ +#if !UNITY_2020_3_OR_NEWER +// make sure we weaved successfully when entering play mode. +using UnityEditor; +using UnityEngine; + +namespace Mirror +{ + public class EnterPlayModeSettingsCheck : MonoBehaviour + { + [InitializeOnLoadMethod] + static void OnInitializeOnLoad() + { + // Hook this event to see if we have a good weave every time + // user attempts to enter play mode or tries to do a build + EditorApplication.playModeStateChanged += OnPlayModeStateChanged; + } + + static void OnPlayModeStateChanged(PlayModeStateChange state) + { + // Per Unity docs, this fires "when exiting edit mode before the Editor is in play mode". + // This doesn't fire when closing the editor. + if (state == PlayModeStateChange.ExitingEditMode) + { + // Check if last weave result was successful + if (!SessionState.GetBool("MIRROR_WEAVE_SUCCESS", false)) + { + // Last weave result was a failure...try to weave again + // Faults will show in the console that may have been cleared by "Clear on Play" + SessionState.SetBool("MIRROR_WEAVE_SUCCESS", true); + Weaver.CompilationFinishedHook.WeaveExistingAssemblies(); + + // Did that clear things up for us? + if (!SessionState.GetBool("MIRROR_WEAVE_SUCCESS", false)) + { + // Nope, still failed, and console has the issues logged + Debug.LogError("Can't enter play mode until weaver issues are resolved."); + EditorApplication.isPlaying = false; + } + } + } + } + } +} +#endif diff --git a/Assets/Mirror/Editor/Weaver/EntryPoint/EnterPlayModeHook.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPoint/EnterPlayModeHook.cs.meta new file mode 100644 index 0000000..eca31e3 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPoint/EnterPlayModeHook.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: b73d0f106ba84aa983baa5142b08a0a9 +timeCreated: 1628851346 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor.meta b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor.meta new file mode 100644 index 0000000..6ef7bf3 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 09082db63d1d48d9ab91320165c1b684 +timeCreated: 1628859005 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/CompiledAssemblyFromFile.cs b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/CompiledAssemblyFromFile.cs new file mode 100644 index 0000000..e4d9de2 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/CompiledAssemblyFromFile.cs @@ -0,0 +1,31 @@ +// tests use WeaveAssembler, which uses AssemblyBuilder to Build(). +// afterwards ILPostProcessor weaves the build. +// this works on windows, but build() does not run ILPP on mac atm. +// we need to manually invoke ILPP with an assembly from file. +// +// this is in Weaver folder becuase CompilationPipeline can only be accessed +// from assemblies with the name "Unity.*.CodeGen" +using System.IO; +using Unity.CompilationPipeline.Common.ILPostProcessing; + +namespace Mirror.Weaver +{ + public class CompiledAssemblyFromFile : ICompiledAssembly + { + readonly string assemblyPath; + + public string Name => Path.GetFileNameWithoutExtension(assemblyPath); + public string[] References { get; set; } + public string[] Defines { get; set; } + public InMemoryAssembly InMemoryAssembly { get; } + + public CompiledAssemblyFromFile(string assemblyPath) + { + this.assemblyPath = assemblyPath; + byte[] peData = File.ReadAllBytes(assemblyPath); + string pdbFileName = Path.GetFileNameWithoutExtension(assemblyPath) + ".pdb"; + byte[] pdbData = File.ReadAllBytes(Path.Combine(Path.GetDirectoryName(assemblyPath), pdbFileName)); + InMemoryAssembly = new InMemoryAssembly(peData, pdbData); + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/CompiledAssemblyFromFile.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/CompiledAssemblyFromFile.cs.meta new file mode 100644 index 0000000..1e5091e --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/CompiledAssemblyFromFile.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 9009d1db4ed44f6694a92bf8ad7738e9 +timeCreated: 1630129423 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorAssemblyResolver.cs b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorAssemblyResolver.cs new file mode 100644 index 0000000..2b6b325 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorAssemblyResolver.cs @@ -0,0 +1,199 @@ +// based on paul's resolver from +// https://github.com/MirageNet/Mirage/commit/def64cd1db525398738f057b3d1eb1fe8afc540c?branch=def64cd1db525398738f057b3d1eb1fe8afc540c&diff=split +// +// an assembly resolver's job is to open an assembly in case we want to resolve +// a type from it. +// +// for example, while weaving MyGame.dll: if we want to resolve ArraySegment, +// then we need to open and resolve from another assembly (CoreLib). +// +// using DefaultAssemblyResolver with ILPostProcessor throws Exceptions in +// WeaverTypes.cs when resolving anything, for example: +// ArraySegment in Mirror.Tests.Dll. +// +// we need a custom resolver for ILPostProcessor. +#if UNITY_2020_3_OR_NEWER +using System; +using System.Collections.Concurrent; +using System.IO; +using System.Linq; +using System.Threading; +using Mono.CecilX; +using Unity.CompilationPipeline.Common.ILPostProcessing; + +namespace Mirror.Weaver +{ + class ILPostProcessorAssemblyResolver : IAssemblyResolver + { + readonly string[] assemblyReferences; + + // originally we used Dictionary + lock. + // Resolve() is called thousands of times for large projects. + // ILPostProcessor is multithreaded, so best to use ConcurrentDictionary without the lock here. + readonly ConcurrentDictionary assemblyCache = + new ConcurrentDictionary(); + + // Resolve() calls FindFile() every time. + // thousands of times for String => mscorlib alone in large projects. + // cache the results! ILPostProcessor is multithreaded, so use a ConcurrentDictionary here. + readonly ConcurrentDictionary fileNameCache = + new ConcurrentDictionary(); + + readonly ICompiledAssembly compiledAssembly; + AssemblyDefinition selfAssembly; + + readonly Logger Log; + + public ILPostProcessorAssemblyResolver(ICompiledAssembly compiledAssembly, Logger Log) + { + this.compiledAssembly = compiledAssembly; + assemblyReferences = compiledAssembly.References; + this.Log = Log; + } + + public void Dispose() + { + Dispose(true); + GC.SuppressFinalize(this); + } + + protected virtual void Dispose(bool disposing) + { + // Cleanup + } + + public AssemblyDefinition Resolve(AssemblyNameReference name) => + Resolve(name, new ReaderParameters(ReadingMode.Deferred)); + + // here is an example on when this is called: + // Player : NetworkBehaviour has a [SyncVar] of type String. + // Weaver's SyncObjectInitializer checks if ImplementsSyncObject() + // which needs to resolve the type 'String' from mscorlib. + // Resolve() lives in CecilX.MetadataResolver.Resolve() + // which calls assembly_resolver.Resolve(). + // which uses our ILPostProcessorAssemblyResolver here. + // + // for large projects, this is called thousands of times for mscorlib alone. + // initially ILPostProcessorAssemblyResolver took 30x longer than with CompilationFinishedHook. + // we need to cache and speed up everything we can here! + public AssemblyDefinition Resolve(AssemblyNameReference name, ReaderParameters parameters) + { + if (name.Name == compiledAssembly.Name) + return selfAssembly; + + // cache FindFile. + // in large projects, this is called thousands(!) of times for String=>mscorlib alone. + // reduces a single String=>mscorlib resolve from 0.771ms to 0.015ms. + // => 50x improvement in TypeReference.Resolve() speed! + // => 22x improvement in Weaver speed! + if (!fileNameCache.TryGetValue(name.Name, out string fileName)) + { + fileName = FindFile(name.Name); + fileNameCache.TryAdd(name.Name, fileName); + } + + if (fileName == null) + { + // returning null will throw exceptions in our weaver where. + // let's make it obvious why we returned null for easier debugging. + // NOTE: if this fails for "System.Private.CoreLib": + // ILPostProcessorReflectionImporter fixes it! + Log.Warning($"ILPostProcessorAssemblyResolver.Resolve: Failed to find file for {name}"); + return null; + } + + // try to get cached assembly by filename + writetime + DateTime lastWriteTime = File.GetLastWriteTime(fileName); + string cacheKey = fileName + lastWriteTime; + if (assemblyCache.TryGetValue(cacheKey, out AssemblyDefinition result)) + return result; + + // otherwise resolve and cache a new assembly + parameters.AssemblyResolver = this; + MemoryStream ms = MemoryStreamFor(fileName); + + string pdb = fileName + ".pdb"; + if (File.Exists(pdb)) + parameters.SymbolStream = MemoryStreamFor(pdb); + + AssemblyDefinition assemblyDefinition = AssemblyDefinition.ReadAssembly(ms, parameters); + assemblyCache.TryAdd(cacheKey, assemblyDefinition); + return assemblyDefinition; + } + + // find assemblyname in assembly's references + string FindFile(string name) + { + // perhaps the type comes from a .dll or .exe + // check both in one call without Linq instead of iterating twice like originally + foreach (string r in assemblyReferences) + { + if (Path.GetFileNameWithoutExtension(r) == name) + return r; + } + + // this is called thousands(!) of times. + // constructing strings only once saves ~0.1ms per call for mscorlib. + string dllName = name + ".dll"; + + // Unfortunately the current ICompiledAssembly API only provides direct references. + // It is very much possible that a postprocessor ends up investigating a type in a directly + // referenced assembly, that contains a field that is not in a directly referenced assembly. + // if we don't do anything special for that situation, it will fail to resolve. We should fix this + // in the ILPostProcessing API. As a workaround, we rely on the fact here that the indirect references + // are always located next to direct references, so we search in all directories of direct references we + // got passed, and if we find the file in there, we resolve to it. + foreach (string parentDir in assemblyReferences.Select(Path.GetDirectoryName).Distinct()) + { + string candidate = Path.Combine(parentDir, dllName); + if (File.Exists(candidate)) + return candidate; + } + + return null; + } + + // open file as MemoryStream. + // ILPostProcessor is multithreaded. + // retry a few times in case another thread is still accessing the file. + static MemoryStream MemoryStreamFor(string fileName) + { + return Retry(10, TimeSpan.FromSeconds(1), () => + { + byte[] byteArray; + using (FileStream fs = new FileStream(fileName, FileMode.Open, FileAccess.Read, FileShare.ReadWrite)) + { + byteArray = new byte[fs.Length]; + int readLength = fs.Read(byteArray, 0, (int)fs.Length); + if (readLength != fs.Length) + throw new InvalidOperationException("File read length is not full length of file."); + } + + return new MemoryStream(byteArray); + }); + } + + static MemoryStream Retry(int retryCount, TimeSpan waitTime, Func func) + { + try + { + return func(); + } + catch (IOException) + { + if (retryCount == 0) + throw; + Console.WriteLine($"Caught IO Exception, trying {retryCount} more times"); + Thread.Sleep(waitTime); + return Retry(retryCount - 1, waitTime, func); + } + } + + // if the CompiledAssembly's AssemblyDefinition is known, we can add it + public void SetAssemblyDefinitionForCompiledAssembly(AssemblyDefinition assemblyDefinition) + { + selfAssembly = assemblyDefinition; + } + } +} +#endif diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorAssemblyResolver.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorAssemblyResolver.cs.meta new file mode 100644 index 0000000..07289dd --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorAssemblyResolver.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 0b3e94696e22440ead0b3a42411bbe14 +timeCreated: 1629693784 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorFromFile.cs b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorFromFile.cs new file mode 100644 index 0000000..6a70641 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorFromFile.cs @@ -0,0 +1,53 @@ +// helper function to use ILPostProcessor for an assembly from file. +// we keep this in Weaver folder because we can access CompilationPipleine here. +// in tests folder we can't, unless we rename to "Unity.*.CodeGen", +// but then tests wouldn't be weaved anymore. +#if UNITY_2020_3_OR_NEWER +using System; +using System.IO; +using Unity.CompilationPipeline.Common.Diagnostics; +using Unity.CompilationPipeline.Common.ILPostProcessing; + +namespace Mirror.Weaver +{ + public static class ILPostProcessorFromFile + { + // read, weave, write file via ILPostProcessor + public static void ILPostProcessFile(string assemblyPath, string[] references, Action OnWarning, Action OnError) + { + // we COULD Weave() with a test logger manually. + // but for test result consistency on all platforms, + // let's invoke the ILPostProcessor here too. + CompiledAssemblyFromFile assembly = new CompiledAssemblyFromFile(assemblyPath); + assembly.References = references; + + // create ILPP and check WillProcess like Unity would. + ILPostProcessorHook ilpp = new ILPostProcessorHook(); + if (ilpp.WillProcess(assembly)) + { + //Debug.Log($"Will Process: {assembly.Name}"); + + // process it like Unity would + ILPostProcessResult result = ilpp.Process(assembly); + + // handle the error messages like Unity would + foreach (DiagnosticMessage message in result.Diagnostics) + { + if (message.DiagnosticType == DiagnosticType.Warning) + { + OnWarning(message.MessageData); + } + else if (message.DiagnosticType == DiagnosticType.Error) + { + OnError(message.MessageData); + } + } + + // save the weaved assembly to file. + // some tests open it and check for certain IL code. + File.WriteAllBytes(assemblyPath, result.InMemoryAssembly.PeData); + } + } + } +} +#endif diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorFromFile.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorFromFile.cs.meta new file mode 100644 index 0000000..e06dfa7 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorFromFile.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 2a4b115486b74d27a9540f3c39ae2d46 +timeCreated: 1630152191 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorHook.cs b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorHook.cs new file mode 100644 index 0000000..0cfb433 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorHook.cs @@ -0,0 +1,143 @@ +// hook via ILPostProcessor from Unity 2020.3+ +// (2020.1 has errors https://github.com/vis2k/Mirror/issues/2912) +#if UNITY_2020_3_OR_NEWER +// Unity.CompilationPipeline reference is only resolved if assembly name is +// Unity.*.CodeGen: +// https://forum.unity.com/threads/how-does-unity-do-codegen-and-why-cant-i-do-it-myself.853867/#post-5646937 +using System.IO; +using System.Linq; +// to use Mono.CecilX here, we need to 'override references' in the +// Unity.Mirror.CodeGen assembly definition file in the Editor, and add CecilX. +// otherwise we get a reflection exception with 'file not found: CecilX'. +using Mono.CecilX; +using Mono.CecilX.Cil; +using Unity.CompilationPipeline.Common.ILPostProcessing; +// IMPORTANT: 'using UnityEngine' does not work in here. +// Unity gives "(0,0): error System.Security.SecurityException: ECall methods must be packaged into a system module." +//using UnityEngine; + +namespace Mirror.Weaver +{ + public class ILPostProcessorHook : ILPostProcessor + { + // from CompilationFinishedHook + const string MirrorRuntimeAssemblyName = "Mirror"; + + // ILPostProcessor is invoked by Unity. + // we can not tell it to ignore certain assemblies before processing. + // add a 'ignore' define for convenience. + // => WeaverTests/WeaverAssembler need it to avoid Unity running it + public const string IgnoreDefine = "ILPP_IGNORE"; + + // we can't use Debug.Log in ILPP, so we need a custom logger + ILPostProcessorLogger Log = new ILPostProcessorLogger(); + + // ??? + public override ILPostProcessor GetInstance() => this; + + // check if assembly has the 'ignore' define + static bool HasDefine(ICompiledAssembly assembly, string define) => + assembly.Defines != null && + assembly.Defines.Contains(define); + + // process Mirror, or anything that references Mirror + public override bool WillProcess(ICompiledAssembly compiledAssembly) + { + // compiledAssembly.References are file paths: + // Library/Bee/artifacts/200b0aE.dag/Mirror.CompilerSymbols.dll + // Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.dll + // /Applications/Unity/Hub/Editor/2021.2.0b6_apple_silicon/Unity.app/Contents/NetStandard/ref/2.1.0/netstandard.dll + // + // log them to see: + // foreach (string reference in compiledAssembly.References) + // LogDiagnostics($"{compiledAssembly.Name} references {reference}"); + bool relevant = compiledAssembly.Name == MirrorRuntimeAssemblyName || + compiledAssembly.References.Any(filePath => Path.GetFileNameWithoutExtension(filePath) == MirrorRuntimeAssemblyName); + bool ignore = HasDefine(compiledAssembly, IgnoreDefine); + return relevant && !ignore; + } + + public override ILPostProcessResult Process(ICompiledAssembly compiledAssembly) + { + //Log.Warning($"Processing {compiledAssembly.Name}"); + + // load the InMemoryAssembly peData into a MemoryStream + byte[] peData = compiledAssembly.InMemoryAssembly.PeData; + //LogDiagnostics($" peData.Length={peData.Length} bytes"); + using (MemoryStream stream = new MemoryStream(peData)) + using (ILPostProcessorAssemblyResolver asmResolver = new ILPostProcessorAssemblyResolver(compiledAssembly, Log)) + { + // we need to load symbols. otherwise we get: + // "(0,0): error Mono.CecilX.Cil.SymbolsNotFoundException: No symbol found for file: " + using (MemoryStream symbols = new MemoryStream(compiledAssembly.InMemoryAssembly.PdbData)) + { + ReaderParameters readerParameters = new ReaderParameters{ + SymbolStream = symbols, + ReadWrite = true, + ReadSymbols = true, + AssemblyResolver = asmResolver, + // custom reflection importer to fix System.Private.CoreLib + // not being found in custom assembly resolver above. + ReflectionImporterProvider = new ILPostProcessorReflectionImporterProvider() + }; + using (AssemblyDefinition asmDef = AssemblyDefinition.ReadAssembly(stream, readerParameters)) + { + // resolving a Mirror.dll type like NetworkServer while + // weaving Mirror.dll does not work. it throws a + // NullReferenceException in WeaverTypes.ctor + // when Resolve() is called on the first Mirror type. + // need to add the AssemblyDefinition itself to use. + asmResolver.SetAssemblyDefinitionForCompiledAssembly(asmDef); + + // weave this assembly. + Weaver weaver = new Weaver(Log); + if (weaver.Weave(asmDef, asmResolver, out bool modified)) + { + //Log.Warning($"Weaving succeeded for: {compiledAssembly.Name}"); + + // write if modified + if (modified) + { + // when weaving Mirror.dll with ILPostProcessor, + // Weave() -> WeaverTypes -> resolving the first + // type in Mirror.dll adds a reference to + // Mirror.dll even though we are in Mirror.dll. + // -> this would throw an exception: + // "Mirror references itself" and not compile + // -> need to detect and fix manually here + if (asmDef.MainModule.AssemblyReferences.Any(r => r.Name == asmDef.Name.Name)) + { + asmDef.MainModule.AssemblyReferences.Remove(asmDef.MainModule.AssemblyReferences.First(r => r.Name == asmDef.Name.Name)); + //Log.Warning($"fixed self referencing Assembly: {asmDef.Name.Name}"); + } + + MemoryStream peOut = new MemoryStream(); + MemoryStream pdbOut = new MemoryStream(); + WriterParameters writerParameters = new WriterParameters + { + SymbolWriterProvider = new PortablePdbWriterProvider(), + SymbolStream = pdbOut, + WriteSymbols = true + }; + + asmDef.Write(peOut, writerParameters); + + InMemoryAssembly inMemory = new InMemoryAssembly(peOut.ToArray(), pdbOut.ToArray()); + return new ILPostProcessResult(inMemory, Log.Logs); + } + } + // if anything during Weave() fails, we log an error. + // don't need to indicate 'weaving failed' again. + // in fact, this would break tests only expecting certain errors. + //else Log.Error($"Weaving failed for: {compiledAssembly.Name}"); + } + } + } + + // always return an ILPostProcessResult with Logs. + // otherwise we won't see Logs if weaving failed. + return new ILPostProcessResult(compiledAssembly.InMemoryAssembly, Log.Logs); + } + } +} +#endif diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorHook.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorHook.cs.meta new file mode 100644 index 0000000..9d7e0a2 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorHook.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 5f113eb695b348b5b28cd85358c8959a +timeCreated: 1628859074 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorLogger.cs b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorLogger.cs new file mode 100644 index 0000000..2c070cc --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorLogger.cs @@ -0,0 +1,67 @@ +using System.Collections.Generic; +using Mono.CecilX; +using Unity.CompilationPipeline.Common.Diagnostics; + +namespace Mirror.Weaver +{ + public class ILPostProcessorLogger : Logger + { + // can't Debug.Log in ILPostProcessor. need to add to this list. + internal List Logs = new List(); + + void Add(string message, DiagnosticType logType) + { + Logs.Add(new DiagnosticMessage + { + // TODO add file etc. for double click opening later? + DiagnosticType = logType, // doesn't have .Log + File = null, + Line = 0, + Column = 0, + MessageData = message + }); + } + + public void LogDiagnostics(string message, DiagnosticType logType = DiagnosticType.Warning) + { + // DiagnosticMessage can't display \n for some reason. + // it just cuts it off and we don't see any stack trace. + // so let's replace all line breaks so we get the stack trace. + // (Unity 2021.2.0b6 apple silicon) + //message = message.Replace("\n", "/"); + + // lets break it into several messages instead so it's easier readable + string[] lines = message.Split('\n'); + + // if it's just one line, simply log it + if (lines.Length == 1) + { + // tests assume exact message log. + // don't include 'Weaver: ...' or similar. + Add($"{message}", logType); + } + // for multiple lines, log each line separately with start/end indicators + else + { + // first line with Weaver: ... first + Add("----------------------------------------------", logType); + foreach (string line in lines) Add(line, logType); + Add("----------------------------------------------", logType); + } + } + + public void Warning(string message) => Warning(message, null); + public void Warning(string message, MemberReference mr) + { + if (mr != null) message = $"{message} (at {mr})"; + LogDiagnostics(message, DiagnosticType.Warning); + } + + public void Error(string message) => Error(message, null); + public void Error(string message, MemberReference mr) + { + if (mr != null) message = $"{message} (at {mr})"; + LogDiagnostics(message, DiagnosticType.Error); + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorLogger.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorLogger.cs.meta new file mode 100644 index 0000000..8bb72e0 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorLogger.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: e7b56e7826664e34a415e4b70d958f2a +timeCreated: 1629533154 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporter.cs b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporter.cs new file mode 100644 index 0000000..e15c103 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporter.cs @@ -0,0 +1,36 @@ +// based on paul's resolver from +// https://github.com/MirageNet/Mirage/commit/def64cd1db525398738f057b3d1eb1fe8afc540c?branch=def64cd1db525398738f057b3d1eb1fe8afc540c&diff=split +// +// ILPostProcessorAssemblyRESOLVER does not find the .dll file for: +// "System.Private.CoreLib" +// we need this custom reflection importer to fix that. +using System.Linq; +using System.Reflection; +using Mono.CecilX; + +namespace Mirror.Weaver +{ + internal class ILPostProcessorReflectionImporter : DefaultReflectionImporter + { + const string SystemPrivateCoreLib = "System.Private.CoreLib"; + readonly AssemblyNameReference fixedCoreLib; + + public ILPostProcessorReflectionImporter(ModuleDefinition module) : base(module) + { + // find the correct library for "System.Private.CoreLib". + // either mscorlib or netstandard. + // defaults to System.Private.CoreLib if not found. + fixedCoreLib = module.AssemblyReferences.FirstOrDefault(a => a.Name == "mscorlib" || a.Name == "netstandard" || a.Name == SystemPrivateCoreLib); + } + + public override AssemblyNameReference ImportReference(AssemblyName name) + { + // System.Private.CoreLib? + if (name.Name == SystemPrivateCoreLib && fixedCoreLib != null) + return fixedCoreLib; + + // otherwise import as usual + return base.ImportReference(name); + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporter.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporter.cs.meta new file mode 100644 index 0000000..d361e21 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporter.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 6403a7e3b3ae4e009ae282f111d266e0 +timeCreated: 1629709256 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporterProvider.cs b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporterProvider.cs new file mode 100644 index 0000000..7358e1b --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporterProvider.cs @@ -0,0 +1,16 @@ +// based on paul's resolver from +// https://github.com/MirageNet/Mirage/commit/def64cd1db525398738f057b3d1eb1fe8afc540c?branch=def64cd1db525398738f057b3d1eb1fe8afc540c&diff=split +// +// ILPostProcessorAssemblyRESOLVER does not find the .dll file for: +// "System.Private.CoreLib" +// we need this custom reflection importer to fix that. +using Mono.CecilX; + +namespace Mirror.Weaver +{ + internal class ILPostProcessorReflectionImporterProvider : IReflectionImporterProvider + { + public IReflectionImporter GetReflectionImporter(ModuleDefinition module) => + new ILPostProcessorReflectionImporter(module); + } +} diff --git a/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporterProvider.cs.meta b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporterProvider.cs.meta new file mode 100644 index 0000000..d9b6f6b --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/EntryPointILPostProcessor/ILPostProcessorReflectionImporterProvider.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: a1003b568bad4e69b961c4c81d5afd96 +timeCreated: 1629709223 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/Extensions.cs b/Assets/Mirror/Editor/Weaver/Extensions.cs new file mode 100644 index 0000000..566a51a --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Extensions.cs @@ -0,0 +1,359 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Mono.CecilX; + +namespace Mirror.Weaver +{ + public static class Extensions + { + public static bool Is(this TypeReference td, Type type) => + type.IsGenericType + ? td.GetElementType().FullName == type.FullName + : td.FullName == type.FullName; + + // check if 'td' is exactly of type T. + // it does not check if any base type is of , only the specific type. + // for example: + // NetworkConnection Is NetworkConnection: true + // NetworkConnectionToClient Is NetworkConnection: false + public static bool Is(this TypeReference td) => Is(td, typeof(T)); + + // check if 'tr' is derived from T. + // it does not check if 'tr' is exactly T. + // for example: + // NetworkConnection IsDerivedFrom: false + // NetworkConnectionToClient IsDerivedFrom: true + public static bool IsDerivedFrom(this TypeReference tr) => IsDerivedFrom(tr, typeof(T)); + + public static bool IsDerivedFrom(this TypeReference tr, Type baseClass) + { + TypeDefinition td = tr.Resolve(); + if (!td.IsClass) + return false; + + // are ANY parent classes of baseClass? + TypeReference parent = td.BaseType; + + if (parent == null) + return false; + + if (parent.Is(baseClass)) + return true; + + if (parent.CanBeResolved()) + return IsDerivedFrom(parent.Resolve(), baseClass); + + return false; + } + + public static TypeReference GetEnumUnderlyingType(this TypeDefinition td) + { + foreach (FieldDefinition field in td.Fields) + { + if (!field.IsStatic) + return field.FieldType; + } + throw new ArgumentException($"Invalid enum {td.FullName}"); + } + + public static bool ImplementsInterface(this TypeDefinition td) + { + TypeDefinition typedef = td; + + while (typedef != null) + { + if (typedef.Interfaces.Any(iface => iface.InterfaceType.Is())) + return true; + + try + { + TypeReference parent = typedef.BaseType; + typedef = parent?.Resolve(); + } + catch (AssemblyResolutionException) + { + // this can happen for plugins. + //Console.WriteLine("AssemblyResolutionException: "+ ex.ToString()); + break; + } + } + + return false; + } + + public static bool IsMultidimensionalArray(this TypeReference tr) => + tr is ArrayType arrayType && arrayType.Rank > 1; + + // Does type use netId as backing field + public static bool IsNetworkIdentityField(this TypeReference tr) => + tr.Is() || + tr.Is() || + // handle both NetworkBehaviour and inheritors. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/2939 + tr.IsDerivedFrom() || + tr.Is(); + + public static bool CanBeResolved(this TypeReference parent) + { + while (parent != null) + { + if (parent.Scope.Name == "Windows") + { + return false; + } + + if (parent.Scope.Name == "mscorlib") + { + TypeDefinition resolved = parent.Resolve(); + return resolved != null; + } + + try + { + parent = parent.Resolve().BaseType; + } + catch + { + return false; + } + } + return true; + } + + // Makes T => Variable and imports function + public static MethodReference MakeGeneric(this MethodReference generic, ModuleDefinition module, TypeReference variableReference) + { + GenericInstanceMethod instance = new GenericInstanceMethod(generic); + instance.GenericArguments.Add(variableReference); + + MethodReference readFunc = module.ImportReference(instance); + return readFunc; + } + + // Given a method of a generic class such as ArraySegment`T.get_Count, + // and a generic instance such as ArraySegment`int + // Creates a reference to the specialized method ArraySegment`int`.get_Count + // Note that calling ArraySegment`T.get_Count directly gives an invalid IL error + public static MethodReference MakeHostInstanceGeneric(this MethodReference self, ModuleDefinition module, GenericInstanceType instanceType) + { + MethodReference reference = new MethodReference(self.Name, self.ReturnType, instanceType) + { + CallingConvention = self.CallingConvention, + HasThis = self.HasThis, + ExplicitThis = self.ExplicitThis + }; + + foreach (ParameterDefinition parameter in self.Parameters) + reference.Parameters.Add(new ParameterDefinition(parameter.ParameterType)); + + foreach (GenericParameter generic_parameter in self.GenericParameters) + reference.GenericParameters.Add(new GenericParameter(generic_parameter.Name, reference)); + + return module.ImportReference(reference); + } + + // needed for NetworkBehaviour support + // https://github.com/vis2k/Mirror/pull/3073/ + public static FieldReference MakeHostInstanceGeneric(this FieldReference self) + { + var declaringType = new GenericInstanceType(self.DeclaringType); + foreach (var parameter in self.DeclaringType.GenericParameters) + { + declaringType.GenericArguments.Add(parameter); + } + return new FieldReference(self.Name, self.FieldType, declaringType); + } + + // Given a field of a generic class such as Writer.write, + // and a generic instance such as ArraySegment`int + // Creates a reference to the specialized method ArraySegment`int`.get_Count + // Note that calling ArraySegment`T.get_Count directly gives an invalid IL error + public static FieldReference SpecializeField(this FieldReference self, ModuleDefinition module, GenericInstanceType instanceType) + { + FieldReference reference = new FieldReference(self.Name, self.FieldType, instanceType); + return module.ImportReference(reference); + } + + public static CustomAttribute GetCustomAttribute(this ICustomAttributeProvider method) + { + return method.CustomAttributes.FirstOrDefault(ca => ca.AttributeType.Is()); + } + + public static bool HasCustomAttribute(this ICustomAttributeProvider attributeProvider) + { + return attributeProvider.CustomAttributes.Any(attr => attr.AttributeType.Is()); + } + + public static T GetField(this CustomAttribute ca, string field, T defaultValue) + { + foreach (CustomAttributeNamedArgument customField in ca.Fields) + if (customField.Name == field) + return (T)customField.Argument.Value; + return defaultValue; + } + + public static MethodDefinition GetMethod(this TypeDefinition td, string methodName) + { + return td.Methods.FirstOrDefault(method => method.Name == methodName); + } + + public static List GetMethods(this TypeDefinition td, string methodName) + { + return td.Methods.Where(method => method.Name == methodName).ToList(); + } + + public static MethodDefinition GetMethodInBaseType(this TypeDefinition td, string methodName) + { + TypeDefinition typedef = td; + while (typedef != null) + { + foreach (MethodDefinition md in typedef.Methods) + { + if (md.Name == methodName) + return md; + } + + try + { + TypeReference parent = typedef.BaseType; + typedef = parent?.Resolve(); + } + catch (AssemblyResolutionException) + { + // this can happen for plugins. + break; + } + } + + return null; + } + + // Finds public fields in type and base type + public static IEnumerable FindAllPublicFields(this TypeReference variable) + { + return FindAllPublicFields(variable.Resolve()); + } + + // Finds public fields in type and base type + public static IEnumerable FindAllPublicFields(this TypeDefinition typeDefinition) + { + while (typeDefinition != null) + { + foreach (FieldDefinition field in typeDefinition.Fields) + { + // ignore static, private, protected fields + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3485 + // credit: James Frowen + if (field.IsStatic || field.IsPrivate || field.IsFamily) + continue; + + // also ignore internal fields + // we dont want to create different writers for this type if they are in current dll or another dll + // so we have to ignore internal in all cases + if (field.IsAssembly) + continue; + + if (field.IsNotSerialized) + continue; + + yield return field; + } + + try + { + typeDefinition = typeDefinition.BaseType?.Resolve(); + } + catch (AssemblyResolutionException) + { + break; + } + } + } + + public static bool ContainsClass(this ModuleDefinition module, string nameSpace, string className) => + module.GetTypes().Any(td => td.Namespace == nameSpace && + td.Name == className); + + + public static AssemblyNameReference FindReference(this ModuleDefinition module, string referenceName) + { + foreach (AssemblyNameReference reference in module.AssemblyReferences) + { + if (reference.Name == referenceName) + return reference; + } + return null; + } + + // Takes generic arguments from child class and applies them to parent reference, if possible + // eg makes `Base` in Child : Base have `int` instead of `T` + // Originally by James-Frowen under MIT + // https://github.com/MirageNet/Mirage/commit/cf91e1d54796866d2cf87f8e919bb5c681977e45 + public static TypeReference ApplyGenericParameters(this TypeReference parentReference, + TypeReference childReference) + { + // If the parent is not generic, we got nothing to apply + if (!parentReference.IsGenericInstance) + return parentReference; + + GenericInstanceType parentGeneric = (GenericInstanceType)parentReference; + // make new type so we can replace the args on it + // resolve it so we have non-generic instance (eg just instance with instead of ) + // if we don't cecil will make it double generic (eg INVALID IL) + GenericInstanceType generic = new GenericInstanceType(parentReference.Resolve()); + foreach (TypeReference arg in parentGeneric.GenericArguments) + generic.GenericArguments.Add(arg); + + for (int i = 0; i < generic.GenericArguments.Count; i++) + { + // if arg is not generic + // eg List would be int so not generic. + // But List would be T so is generic + if (!generic.GenericArguments[i].IsGenericParameter) + continue; + + // get the generic name, eg T + string name = generic.GenericArguments[i].Name; + // find what type T is, eg turn it into `int` if `List` + TypeReference arg = FindMatchingGenericArgument(childReference, name); + + // import just to be safe + TypeReference imported = parentReference.Module.ImportReference(arg); + // set arg on generic, parent ref will be Base instead of just Base + generic.GenericArguments[i] = imported; + } + + return generic; + } + + // Finds the type reference for a generic parameter with the provided name in the child reference + // Originally by James-Frowen under MIT + // https://github.com/MirageNet/Mirage/commit/cf91e1d54796866d2cf87f8e919bb5c681977e45 + static TypeReference FindMatchingGenericArgument(TypeReference childReference, string paramName) + { + TypeDefinition def = childReference.Resolve(); + // child class must be generic if we are in this part of the code + // eg Child : Base <--- child must have generic if Base has T + // vs Child : Base <--- wont be here if Base has int (we check if T exists before calling this) + if (!def.HasGenericParameters) + throw new InvalidOperationException( + "Base class had generic parameters, but could not find them in child class"); + + // go through parameters in child class, and find the generic that matches the name + for (int i = 0; i < def.GenericParameters.Count; i++) + { + GenericParameter param = def.GenericParameters[i]; + if (param.Name == paramName) + { + GenericInstanceType generic = (GenericInstanceType)childReference; + // return generic arg with same index + return generic.GenericArguments[i]; + } + } + + // this should never happen, if it does it means that this code is bugged + throw new InvalidOperationException("Did not find matching generic"); + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Extensions.cs.meta b/Assets/Mirror/Editor/Weaver/Extensions.cs.meta new file mode 100644 index 0000000..78660f9 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Extensions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 562a5cf0254cc45738e9aa549a7100b2 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Helpers.cs b/Assets/Mirror/Editor/Weaver/Helpers.cs new file mode 100644 index 0000000..56b7385 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Helpers.cs @@ -0,0 +1,26 @@ +using System.IO; +using System.Linq; +using System.Reflection; +using Mono.CecilX; + +namespace Mirror.Weaver +{ + static class Helpers + { + // This code is taken from SerializationWeaver + public static string UnityEngineDllDirectoryName() + { + string directoryName = Path.GetDirectoryName(Assembly.GetExecutingAssembly().CodeBase); + return directoryName?.Replace(@"file:\", ""); + } + + public static bool IsEditorAssembly(AssemblyDefinition currentAssembly) + { + // we want to add the [InitializeOnLoad] attribute if it's available + // -> usually either 'UnityEditor' or 'UnityEditor.CoreModule' + return currentAssembly.MainModule.AssemblyReferences.Any(assemblyReference => + assemblyReference.Name.StartsWith(nameof(UnityEditor)) + ); + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Helpers.cs.meta b/Assets/Mirror/Editor/Weaver/Helpers.cs.meta new file mode 100644 index 0000000..231f539 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Helpers.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6c4ed76daf48547c5abb7c58f8d20886 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Logger.cs b/Assets/Mirror/Editor/Weaver/Logger.cs new file mode 100644 index 0000000..8be978f --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Logger.cs @@ -0,0 +1,13 @@ +using Mono.CecilX; + +namespace Mirror.Weaver +{ + // not static, because ILPostProcessor is multithreaded + public interface Logger + { + void Warning(string message); + void Warning(string message, MemberReference mr); + void Error(string message); + void Error(string message, MemberReference mr); + } +} diff --git a/Assets/Mirror/Editor/Weaver/Logger.cs.meta b/Assets/Mirror/Editor/Weaver/Logger.cs.meta new file mode 100644 index 0000000..3f62978 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Logger.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2a21c60c40a4c4d679c2b71a7c40882e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors.meta b/Assets/Mirror/Editor/Weaver/Processors.meta new file mode 100644 index 0000000..eb719b4 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: e538d627280d2471b8c72fdea822ca49 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/CommandProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/CommandProcessor.cs new file mode 100644 index 0000000..0c05318 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/CommandProcessor.cs @@ -0,0 +1,130 @@ +using Mono.CecilX; +using Mono.CecilX.Cil; + +namespace Mirror.Weaver +{ + // Processes [Command] methods in NetworkBehaviour + public static class CommandProcessor + { + /* + // generates code like: + public void CmdThrust(float thrusting, int spin) + { + NetworkWriterPooled writer = NetworkWriterPool.Get(); + writer.Write(thrusting); + writer.WritePackedUInt32((uint)spin); + base.SendCommandInternal(cmdName, cmdHash, writer, channel); + NetworkWriterPool.Return(writer); + } + + public void CallCmdThrust(float thrusting, int spin) + { + // whatever the user was doing before + } + + Originally HLAPI put the send message code inside the Call function + and then proceeded to replace every call to CmdTrust with CallCmdTrust + + This method moves all the user's code into the "CallCmd" method + and replaces the body of the original method with the send message code. + This way we do not need to modify the code anywhere else, and this works + correctly in dependent assemblies + */ + public static MethodDefinition ProcessCommandCall(WeaverTypes weaverTypes, Writers writers, Logger Log, TypeDefinition td, MethodDefinition md, CustomAttribute commandAttr, ref bool WeavingFailed) + { + MethodDefinition cmd = MethodProcessor.SubstituteMethod(Log, td, md, ref WeavingFailed); + + ILProcessor worker = md.Body.GetILProcessor(); + + NetworkBehaviourProcessor.WriteSetupLocals(worker, weaverTypes); + + // NetworkWriter writer = new NetworkWriter(); + NetworkBehaviourProcessor.WriteGetWriter(worker, weaverTypes); + + // write all the arguments that the user passed to the Cmd call + if (!NetworkBehaviourProcessor.WriteArguments(worker, writers, Log, md, RemoteCallType.Command, ref WeavingFailed)) + return null; + + int channel = commandAttr.GetField("channel", 0); + bool requiresAuthority = commandAttr.GetField("requiresAuthority", true); + + // invoke internal send and return + // load 'base.' to call the SendCommand function with + worker.Emit(OpCodes.Ldarg_0); + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + worker.Emit(OpCodes.Ldstr, md.FullName); + // pass the function hash so we don't have to compute it at runtime + // otherwise each GetStableHash call requires O(N) complexity. + // noticeable for long function names: + // https://github.com/MirrorNetworking/Mirror/issues/3375 + worker.Emit(OpCodes.Ldc_I4, md.FullName.GetStableHashCode()); + // writer + worker.Emit(OpCodes.Ldloc_0); + worker.Emit(OpCodes.Ldc_I4, channel); + // requiresAuthority ? 1 : 0 + worker.Emit(requiresAuthority ? OpCodes.Ldc_I4_1 : OpCodes.Ldc_I4_0); + worker.Emit(OpCodes.Call, weaverTypes.sendCommandInternal); + + NetworkBehaviourProcessor.WriteReturnWriter(worker, weaverTypes); + + worker.Emit(OpCodes.Ret); + return cmd; + } + + /* + // generates code like: + protected static void InvokeCmdCmdThrust(NetworkBehaviour obj, NetworkReader reader, NetworkConnection senderConnection) + { + if (!NetworkServer.active) + { + return; + } + ((ShipControl)obj).CmdThrust(reader.ReadSingle(), (int)reader.ReadPackedUInt32()); + } + */ + public static MethodDefinition ProcessCommandInvoke(WeaverTypes weaverTypes, Readers readers, Logger Log, TypeDefinition td, MethodDefinition method, MethodDefinition cmdCallFunc, ref bool WeavingFailed) + { + string cmdName = Weaver.GenerateMethodName(Weaver.InvokeRpcPrefix, method); + + MethodDefinition cmd = new MethodDefinition(cmdName, + MethodAttributes.Family | MethodAttributes.Static | MethodAttributes.HideBySig, + weaverTypes.Import(typeof(void))); + + ILProcessor worker = cmd.Body.GetILProcessor(); + Instruction label = worker.Create(OpCodes.Nop); + + NetworkBehaviourProcessor.WriteServerActiveCheck(worker, weaverTypes, method.Name, label, "Command"); + + // setup for reader + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Castclass, td); + + if (!NetworkBehaviourProcessor.ReadArguments(method, readers, Log, worker, RemoteCallType.Command, ref WeavingFailed)) + return null; + + AddSenderConnection(method, worker); + + // invoke actual command function + worker.Emit(OpCodes.Callvirt, cmdCallFunc); + worker.Emit(OpCodes.Ret); + + NetworkBehaviourProcessor.AddInvokeParameters(weaverTypes, cmd.Parameters); + + td.Methods.Add(cmd); + return cmd; + } + + static void AddSenderConnection(MethodDefinition method, ILProcessor worker) + { + foreach (ParameterDefinition param in method.Parameters) + { + if (NetworkBehaviourProcessor.IsSenderConnection(param, RemoteCallType.Command)) + { + // NetworkConnection is 3nd arg (arg0 is "obj" not "this" because method is static) + // example: static void InvokeCmdCmdSendCommand(NetworkBehaviour obj, NetworkReader reader, NetworkConnection connection) + worker.Emit(OpCodes.Ldarg_2); + } + } + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/CommandProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/CommandProcessor.cs.meta new file mode 100644 index 0000000..20c3e15 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/CommandProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 73f6c9cdbb9e54f65b3a0a35cc8e55c2 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/MethodProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/MethodProcessor.cs new file mode 100644 index 0000000..8a4c581 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/MethodProcessor.cs @@ -0,0 +1,139 @@ +using Mono.CecilX; +using Mono.CecilX.Cil; + +namespace Mirror.Weaver +{ + public static class MethodProcessor + { + const string RpcPrefix = "UserCode_"; + + // For a function like + // [ClientRpc] void RpcTest(int value), + // Weaver substitutes the method and moves the code to a new method: + // UserCode_RpcTest(int value) <- contains original code + // RpcTest(int value) <- serializes parameters, sends the message + // + // Note that all the calls to the method remain untouched. + // FixRemoteCallToBaseMethod replaces them afterwards. + public static MethodDefinition SubstituteMethod(Logger Log, TypeDefinition td, MethodDefinition md, ref bool WeavingFailed) + { + string newName = Weaver.GenerateMethodName(RpcPrefix, md); + + MethodDefinition cmd = new MethodDefinition(newName, md.Attributes, md.ReturnType); + + // force the substitute method to be protected. + // -> public would show in the Inspector for UnityEvents as + // User_CmdUsePotion() etc. but the user shouldn't use those. + // -> private would not allow inheriting classes to call it, see + // OverrideVirtualWithBaseCallsBothVirtualAndBase test. + // -> IL has no concept of 'protected', it's called IsFamily there. + cmd.IsPublic = false; + cmd.IsFamily = true; + + // add parameters + foreach (ParameterDefinition pd in md.Parameters) + { + cmd.Parameters.Add(new ParameterDefinition(pd.Name, ParameterAttributes.None, pd.ParameterType)); + } + + // swap bodies + (cmd.Body, md.Body) = (md.Body, cmd.Body); + + // Move over all the debugging information + foreach (SequencePoint sequencePoint in md.DebugInformation.SequencePoints) + cmd.DebugInformation.SequencePoints.Add(sequencePoint); + md.DebugInformation.SequencePoints.Clear(); + + foreach (CustomDebugInformation customInfo in md.CustomDebugInformations) + cmd.CustomDebugInformations.Add(customInfo); + md.CustomDebugInformations.Clear(); + + (md.DebugInformation.Scope, cmd.DebugInformation.Scope) = (cmd.DebugInformation.Scope, md.DebugInformation.Scope); + + td.Methods.Add(cmd); + + FixRemoteCallToBaseMethod(Log, td, cmd, ref WeavingFailed); + return cmd; + } + + // For a function like + // [ClientRpc] void RpcTest(int value), + // Weaver substitutes the method and moves the code to a new method: + // UserCode_RpcTest(int value) <- contains original code + // RpcTest(int value) <- serializes parameters, sends the message + // + // FixRemoteCallToBaseMethod replaces all calls to + // RpcTest(value) + // with + // UserCode_RpcTest(value) + public static void FixRemoteCallToBaseMethod(Logger Log, TypeDefinition type, MethodDefinition method, ref bool WeavingFailed) + { + string callName = method.Name; + + // Cmd/rpc start with Weaver.RpcPrefix + // e.g. CallCmdDoSomething + if (!callName.StartsWith(RpcPrefix)) + return; + + // e.g. CmdDoSomething + string baseRemoteCallName = method.Name.Substring(RpcPrefix.Length); + + foreach (Instruction instruction in method.Body.Instructions) + { + // is this instruction a Call to a method? + // if yes, output the method so we can check it. + if (IsCallToMethod(instruction, out MethodDefinition calledMethod)) + { + // when considering if 'calledMethod' is a call to 'method', + // we originally compared .Name. + // + // to fix IL2CPP build bugs with overloaded Rpcs, we need to + // generated rpc names like + // RpcTest(string value) => RpcTestString(strig value) + // RpcTest(int value) => RpcTestInt(int value) + // to make them unique. + // + // calledMethod.Name is still "RpcTest", so we need to + // convert this to the generated name as well before comparing. + string calledMethodName_Generated = Weaver.GenerateMethodName("", calledMethod); + if (calledMethodName_Generated == baseRemoteCallName) + { + TypeDefinition baseType = type.BaseType.Resolve(); + MethodDefinition baseMethod = baseType.GetMethodInBaseType(callName); + + if (baseMethod == null) + { + Log.Error($"Could not find base method for {callName}", method); + WeavingFailed = true; + return; + } + + if (!baseMethod.IsVirtual) + { + Log.Error($"Could not find base method that was virtual {callName}", method); + WeavingFailed = true; + return; + } + + instruction.Operand = baseMethod; + } + } + } + } + + static bool IsCallToMethod(Instruction instruction, out MethodDefinition calledMethod) + { + if (instruction.OpCode == OpCodes.Call && + instruction.Operand is MethodDefinition method) + { + calledMethod = method; + return true; + } + else + { + calledMethod = null; + return false; + } + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/MethodProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/MethodProcessor.cs.meta new file mode 100644 index 0000000..3c81894 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/MethodProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 661e1af528e3441f79e1552fb5ec4e0e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/MonoBehaviourProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/MonoBehaviourProcessor.cs new file mode 100644 index 0000000..e88c5d6 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/MonoBehaviourProcessor.cs @@ -0,0 +1,56 @@ +using Mono.CecilX; + +namespace Mirror.Weaver +{ + // only shows warnings in case we use SyncVars etc. for MonoBehaviour. + static class MonoBehaviourProcessor + { + public static void Process(Logger Log, TypeDefinition td, ref bool WeavingFailed) + { + ProcessSyncVars(Log, td, ref WeavingFailed); + ProcessMethods(Log, td, ref WeavingFailed); + } + + static void ProcessSyncVars(Logger Log, TypeDefinition td, ref bool WeavingFailed) + { + // find syncvars + foreach (FieldDefinition fd in td.Fields) + { + if (fd.HasCustomAttribute()) + { + Log.Error($"SyncVar {fd.Name} must be inside a NetworkBehaviour. {td.Name} is not a NetworkBehaviour", fd); + WeavingFailed = true; + } + + if (SyncObjectInitializer.ImplementsSyncObject(fd.FieldType)) + { + Log.Error($"{fd.Name} is a SyncObject and must be inside a NetworkBehaviour. {td.Name} is not a NetworkBehaviour", fd); + WeavingFailed = true; + } + } + } + + static void ProcessMethods(Logger Log, TypeDefinition td, ref bool WeavingFailed) + { + // find command and RPC functions + foreach (MethodDefinition md in td.Methods) + { + if (md.HasCustomAttribute()) + { + Log.Error($"Command {md.Name} must be declared inside a NetworkBehaviour", md); + WeavingFailed = true; + } + if (md.HasCustomAttribute()) + { + Log.Error($"ClientRpc {md.Name} must be declared inside a NetworkBehaviour", md); + WeavingFailed = true; + } + if (md.HasCustomAttribute()) + { + Log.Error($"TargetRpc {md.Name} must be declared inside a NetworkBehaviour", md); + WeavingFailed = true; + } + } + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/MonoBehaviourProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/MonoBehaviourProcessor.cs.meta new file mode 100644 index 0000000..ef3f5f4 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/MonoBehaviourProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 35c16722912b64af894e4f6668f2e54c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs new file mode 100644 index 0000000..901fc96 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs @@ -0,0 +1,1041 @@ +using System.Collections.Generic; +using Mono.CecilX; +using Mono.CecilX.Cil; + +namespace Mirror.Weaver +{ + public enum RemoteCallType + { + Command, + ClientRpc, + TargetRpc + } + + // processes SyncVars, Cmds, Rpcs, etc. of NetworkBehaviours + class NetworkBehaviourProcessor + { + AssemblyDefinition assembly; + WeaverTypes weaverTypes; + SyncVarAccessLists syncVarAccessLists; + SyncVarAttributeProcessor syncVarAttributeProcessor; + Writers writers; + Readers readers; + Logger Log; + + List syncVars = new List(); + List syncObjects = new List(); + // + Dictionary syncVarNetIds = new Dictionary(); + readonly List commands = new List(); + readonly List clientRpcs = new List(); + readonly List targetRpcs = new List(); + readonly List commandInvocationFuncs = new List(); + readonly List clientRpcInvocationFuncs = new List(); + readonly List targetRpcInvocationFuncs = new List(); + + readonly TypeDefinition netBehaviourSubclass; + + public struct CmdResult + { + public MethodDefinition method; + public bool requiresAuthority; + } + + public struct ClientRpcResult + { + public MethodDefinition method; + public bool includeOwner; + } + + public NetworkBehaviourProcessor(AssemblyDefinition assembly, WeaverTypes weaverTypes, SyncVarAccessLists syncVarAccessLists, Writers writers, Readers readers, Logger Log, TypeDefinition td) + { + this.assembly = assembly; + this.weaverTypes = weaverTypes; + this.syncVarAccessLists = syncVarAccessLists; + this.writers = writers; + this.readers = readers; + this.Log = Log; + syncVarAttributeProcessor = new SyncVarAttributeProcessor(assembly, weaverTypes, syncVarAccessLists, Log); + netBehaviourSubclass = td; + } + + // return true if modified + public bool Process(ref bool WeavingFailed) + { + // only process once + if (WasProcessed(netBehaviourSubclass)) + { + return false; + } + + MarkAsProcessed(netBehaviourSubclass); + + // deconstruct tuple and set fields + (syncVars, syncVarNetIds) = syncVarAttributeProcessor.ProcessSyncVars(netBehaviourSubclass, ref WeavingFailed); + + syncObjects = SyncObjectProcessor.FindSyncObjectsFields(writers, readers, Log, netBehaviourSubclass, ref WeavingFailed); + + ProcessMethods(ref WeavingFailed); + if (WeavingFailed) + { + // originally Process returned true in every case, except if already processed. + // maybe return false here in the future. + return true; + } + + // inject initializations into static & instance constructor + InjectIntoStaticConstructor(ref WeavingFailed); + InjectIntoInstanceConstructor(ref WeavingFailed); + + GenerateSerialization(ref WeavingFailed); + if (WeavingFailed) + { + // originally Process returned true in every case, except if already processed. + // maybe return false here in the future. + return true; + } + + GenerateDeSerialization(ref WeavingFailed); + return true; + } + + /* + generates code like: + if (!NetworkClient.active) + Debug.LogError((object) "Command function CmdRespawn called on server."); + + which is used in InvokeCmd, InvokeRpc, etc. + */ + public static void WriteClientActiveCheck(ILProcessor worker, WeaverTypes weaverTypes, string mdName, Instruction label, string errString) + { + // client active check + worker.Emit(OpCodes.Call, weaverTypes.NetworkClientGetActive); + worker.Emit(OpCodes.Brtrue, label); + + worker.Emit(OpCodes.Ldstr, $"{errString} {mdName} called on server."); + worker.Emit(OpCodes.Call, weaverTypes.logErrorReference); + worker.Emit(OpCodes.Ret); + worker.Append(label); + } + /* + generates code like: + if (!NetworkServer.active) + Debug.LogError((object) "Command CmdMsgWhisper called on client."); + */ + public static void WriteServerActiveCheck(ILProcessor worker, WeaverTypes weaverTypes, string mdName, Instruction label, string errString) + { + // server active check + worker.Emit(OpCodes.Call, weaverTypes.NetworkServerGetActive); + worker.Emit(OpCodes.Brtrue, label); + + worker.Emit(OpCodes.Ldstr, $"{errString} {mdName} called on client."); + worker.Emit(OpCodes.Call, weaverTypes.logErrorReference); + worker.Emit(OpCodes.Ret); + worker.Append(label); + } + + public static void WriteSetupLocals(ILProcessor worker, WeaverTypes weaverTypes) + { + worker.Body.InitLocals = true; + worker.Body.Variables.Add(new VariableDefinition(weaverTypes.Import())); + } + + public static void WriteGetWriter(ILProcessor worker, WeaverTypes weaverTypes) + { + // create writer + worker.Emit(OpCodes.Call, weaverTypes.GetWriterReference); + worker.Emit(OpCodes.Stloc_0); + } + + public static void WriteReturnWriter(ILProcessor worker, WeaverTypes weaverTypes) + { + // NetworkWriterPool.Recycle(writer); + worker.Emit(OpCodes.Ldloc_0); + worker.Emit(OpCodes.Call, weaverTypes.ReturnWriterReference); + } + + public static bool WriteArguments(ILProcessor worker, Writers writers, Logger Log, MethodDefinition method, RemoteCallType callType, ref bool WeavingFailed) + { + // write each argument + // example result + /* + writer.WritePackedInt32(someNumber); + writer.WriteNetworkIdentity(someTarget); + */ + + bool skipFirst = callType == RemoteCallType.TargetRpc + && TargetRpcProcessor.HasNetworkConnectionParameter(method); + + // arg of calling function, arg 0 is "this" so start counting at 1 + int argNum = 1; + foreach (ParameterDefinition param in method.Parameters) + { + // NetworkConnection is not sent via the NetworkWriter so skip it here + // skip first for NetworkConnection in TargetRpc + if (argNum == 1 && skipFirst) + { + argNum += 1; + continue; + } + // skip SenderConnection in Command + if (IsSenderConnection(param, callType)) + { + argNum += 1; + continue; + } + + MethodReference writeFunc = writers.GetWriteFunc(param.ParameterType, ref WeavingFailed); + if (writeFunc == null) + { + Log.Error($"{method.Name} has invalid parameter {param}", method); + WeavingFailed = true; + return false; + } + + // use built-in writer func on writer object + // NetworkWriter object + worker.Emit(OpCodes.Ldloc_0); + // add argument to call + worker.Emit(OpCodes.Ldarg, argNum); + // call writer extension method + worker.Emit(OpCodes.Call, writeFunc); + argNum += 1; + } + return true; + } + + #region mark / check type as processed + public const string ProcessedFunctionName = "Weaved"; + + // check if the type has a "Weaved" function already + public static bool WasProcessed(TypeDefinition td) + { + return td.GetMethod(ProcessedFunctionName) != null; + } + + // add the Weaved() function which returns true. + // can be called at runtime and from tests to check if weaving succeeded. + public void MarkAsProcessed(TypeDefinition td) + { + if (!WasProcessed(td)) + { + // add a function: + // public override bool MirrorProcessed() { return true; } + // ReuseSlot means 'override'. + MethodDefinition versionMethod = new MethodDefinition( + ProcessedFunctionName, + MethodAttributes.Public | MethodAttributes.Virtual | MethodAttributes.ReuseSlot, + weaverTypes.Import(typeof(bool))); + ILProcessor worker = versionMethod.Body.GetILProcessor(); + worker.Emit(OpCodes.Ldc_I4_1); + worker.Emit(OpCodes.Ret); + td.Methods.Add(versionMethod); + } + } + #endregion + + // helper function to remove 'Ret' from the end of the method if 'Ret' + // is the last instruction. + // returns false if there was an issue + static bool RemoveFinalRetInstruction(MethodDefinition method) + { + // remove the return opcode from end of function. will add our own later. + if (method.Body.Instructions.Count != 0) + { + Instruction retInstr = method.Body.Instructions[method.Body.Instructions.Count - 1]; + if (retInstr.OpCode == OpCodes.Ret) + { + method.Body.Instructions.RemoveAt(method.Body.Instructions.Count - 1); + return true; + } + return false; + } + + // we did nothing, but there was no error. + return true; + } + + // we need to inject several initializations into NetworkBehaviour cctor + void InjectIntoStaticConstructor(ref bool WeavingFailed) + { + if (commands.Count == 0 && clientRpcs.Count == 0 && targetRpcs.Count == 0) + return; + + // find static constructor + MethodDefinition cctor = netBehaviourSubclass.GetMethod(".cctor"); + bool cctorFound = cctor != null; + if (cctor != null) + { + // remove the return opcode from end of function. will add our own later. + if (!RemoveFinalRetInstruction(cctor)) + { + Log.Error($"{netBehaviourSubclass.Name} has invalid class constructor", cctor); + WeavingFailed = true; + return; + } + } + else + { + // make one! + cctor = new MethodDefinition(".cctor", MethodAttributes.Private | + MethodAttributes.HideBySig | + MethodAttributes.SpecialName | + MethodAttributes.RTSpecialName | + MethodAttributes.Static, + weaverTypes.Import(typeof(void))); + } + + ILProcessor cctorWorker = cctor.Body.GetILProcessor(); + + // register all commands in cctor + for (int i = 0; i < commands.Count; ++i) + { + CmdResult cmdResult = commands[i]; + GenerateRegisterCommandDelegate(cctorWorker, weaverTypes.registerCommandReference, commandInvocationFuncs[i], cmdResult); + } + + // register all client rpcs in cctor + for (int i = 0; i < clientRpcs.Count; ++i) + { + ClientRpcResult clientRpcResult = clientRpcs[i]; + GenerateRegisterRemoteDelegate(cctorWorker, weaverTypes.registerRpcReference, clientRpcInvocationFuncs[i], clientRpcResult.method.FullName); + } + + // register all target rpcs in cctor + for (int i = 0; i < targetRpcs.Count; ++i) + { + GenerateRegisterRemoteDelegate(cctorWorker, weaverTypes.registerRpcReference, targetRpcInvocationFuncs[i], targetRpcs[i].FullName); + } + + // add final 'Ret' instruction to cctor + cctorWorker.Append(cctorWorker.Create(OpCodes.Ret)); + if (!cctorFound) + { + netBehaviourSubclass.Methods.Add(cctor); + } + + // in case class had no cctor, it might have BeforeFieldInit, so injected cctor would be called too late + netBehaviourSubclass.Attributes &= ~TypeAttributes.BeforeFieldInit; + } + + // we need to inject several initializations into NetworkBehaviour ctor + void InjectIntoInstanceConstructor(ref bool WeavingFailed) + { + if (syncObjects.Count == 0) + return; + + // find instance constructor + MethodDefinition ctor = netBehaviourSubclass.GetMethod(".ctor"); + if (ctor == null) + { + Log.Error($"{netBehaviourSubclass.Name} has invalid constructor", netBehaviourSubclass); + WeavingFailed = true; + return; + } + + // remove the return opcode from end of function. will add our own later. + if (!RemoveFinalRetInstruction(ctor)) + { + Log.Error($"{netBehaviourSubclass.Name} has invalid constructor", ctor); + WeavingFailed = true; + return; + } + + ILProcessor ctorWorker = ctor.Body.GetILProcessor(); + + // initialize all sync objects in ctor + foreach (FieldDefinition fd in syncObjects) + { + SyncObjectInitializer.GenerateSyncObjectInitializer(ctorWorker, weaverTypes, fd); + } + + // add final 'Ret' instruction to ctor + ctorWorker.Append(ctorWorker.Create(OpCodes.Ret)); + } + + /* + // This generates code like: + NetworkBehaviour.RegisterCommandDelegate(base.GetType(), "CmdThrust", new NetworkBehaviour.CmdDelegate(ShipControl.InvokeCmdCmdThrust)); + */ + + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + void GenerateRegisterRemoteDelegate(ILProcessor worker, MethodReference registerMethod, MethodDefinition func, string functionFullName) + { + worker.Emit(OpCodes.Ldtoken, netBehaviourSubclass); + worker.Emit(OpCodes.Call, weaverTypes.getTypeFromHandleReference); + worker.Emit(OpCodes.Ldstr, functionFullName); + worker.Emit(OpCodes.Ldnull); + worker.Emit(OpCodes.Ldftn, func); + + worker.Emit(OpCodes.Newobj, weaverTypes.RemoteCallDelegateConstructor); + // + worker.Emit(OpCodes.Call, registerMethod); + } + + void GenerateRegisterCommandDelegate(ILProcessor worker, MethodReference registerMethod, MethodDefinition func, CmdResult cmdResult) + { + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + string cmdName = cmdResult.method.FullName; + bool requiresAuthority = cmdResult.requiresAuthority; + + worker.Emit(OpCodes.Ldtoken, netBehaviourSubclass); + worker.Emit(OpCodes.Call, weaverTypes.getTypeFromHandleReference); + worker.Emit(OpCodes.Ldstr, cmdName); + worker.Emit(OpCodes.Ldnull); + worker.Emit(OpCodes.Ldftn, func); + + worker.Emit(OpCodes.Newobj, weaverTypes.RemoteCallDelegateConstructor); + + // requiresAuthority ? 1 : 0 + worker.Emit(requiresAuthority ? OpCodes.Ldc_I4_1 : OpCodes.Ldc_I4_0); + + worker.Emit(OpCodes.Call, registerMethod); + } + + void GenerateSerialization(ref bool WeavingFailed) + { + const string SerializeMethodName = "SerializeSyncVars"; + if (netBehaviourSubclass.GetMethod(SerializeMethodName) != null) + return; + + if (syncVars.Count == 0) + { + // no synvars, no need for custom OnSerialize + return; + } + + MethodDefinition serialize = new MethodDefinition(SerializeMethodName, + MethodAttributes.Public | MethodAttributes.Virtual | MethodAttributes.HideBySig, + weaverTypes.Import(typeof(void))); + + serialize.Parameters.Add(new ParameterDefinition("writer", ParameterAttributes.None, weaverTypes.Import())); + serialize.Parameters.Add(new ParameterDefinition("forceAll", ParameterAttributes.None, weaverTypes.Import())); + ILProcessor worker = serialize.Body.GetILProcessor(); + + serialize.Body.InitLocals = true; + + // base.SerializeSyncVars(writer, forceAll); + MethodReference baseSerialize = Resolvers.TryResolveMethodInParents(netBehaviourSubclass.BaseType, assembly, SerializeMethodName); + if (baseSerialize != null) + { + // base + worker.Emit(OpCodes.Ldarg_0); + // writer + worker.Emit(OpCodes.Ldarg_1); + // forceAll + worker.Emit(OpCodes.Ldarg_2); + worker.Emit(OpCodes.Call, baseSerialize); + } + + // Generates: + // if (forceAll) + // { + // writer.WriteInt(health); + // ... + // } + Instruction initialStateLabel = worker.Create(OpCodes.Nop); + // forceAll + worker.Emit(OpCodes.Ldarg_2); // load 'forceAll' flag + worker.Emit(OpCodes.Brfalse, initialStateLabel); // start the 'if forceAll' branch + + // generates write.Write(syncVar) for each SyncVar in forceAll case + foreach (FieldDefinition syncVarDef in syncVars) + { + FieldReference syncVar = syncVarDef; + if (netBehaviourSubclass.HasGenericParameters) + { + syncVar = syncVarDef.MakeHostInstanceGeneric(); + } + // Generates a writer call for each sync variable + // writer + worker.Emit(OpCodes.Ldarg_1); + // this + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldfld, syncVar); + MethodReference writeFunc; + // For NBs we always need to use the default NetworkBehaviour write func + // since the reader counter part uses that exact layout which is not easy to change + // without introducing more edge cases + // effectively this disallows custom NB-type writers/readers on SyncVars + // see: https://github.com/MirrorNetworking/Mirror/issues/2680 + if (syncVar.FieldType.IsDerivedFrom()) + { + writeFunc = writers.GetWriteFunc(weaverTypes.Import(), ref WeavingFailed); + } + else + { + writeFunc = writers.GetWriteFunc(syncVar.FieldType, ref WeavingFailed); + } + + if (writeFunc != null) + { + worker.Emit(OpCodes.Call, writeFunc); + } + else + { + Log.Error($"{syncVar.Name} has unsupported type. Use a supported Mirror type instead", syncVar); + WeavingFailed = true; + return; + } + } + + // if (forceAll) then always return at the end of the 'if' case + worker.Emit(OpCodes.Ret); + + // end the 'if' case for "if (forceAll)" + worker.Append(initialStateLabel); + + //////////////////////////////////////////////////////////////////// + + // write dirty bits before the data fields + // Generates: writer.WritePackedUInt64 (base.get_syncVarDirtyBits ()); + // writer + worker.Emit(OpCodes.Ldarg_1); + // base + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Call, weaverTypes.NetworkBehaviourDirtyBitsReference); + MethodReference writeUint64Func = writers.GetWriteFunc(weaverTypes.Import(), ref WeavingFailed); + worker.Emit(OpCodes.Call, writeUint64Func); + + // generate a writer call for any dirty variable in this class + + // start at number of syncvars in parent + int dirtyBit = syncVarAccessLists.GetSyncVarStart(netBehaviourSubclass.BaseType.FullName); + foreach (FieldDefinition syncVarDef in syncVars) + { + FieldReference syncVar = syncVarDef; + if (netBehaviourSubclass.HasGenericParameters) + { + syncVar = syncVarDef.MakeHostInstanceGeneric(); + } + Instruction varLabel = worker.Create(OpCodes.Nop); + + // Generates: if ((base.get_syncVarDirtyBits() & 1uL) != 0uL) + // base + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Call, weaverTypes.NetworkBehaviourDirtyBitsReference); + // 8 bytes = long + worker.Emit(OpCodes.Ldc_I8, 1L << dirtyBit); + worker.Emit(OpCodes.And); + worker.Emit(OpCodes.Brfalse, varLabel); + + // Generates a call to the writer for that field + // writer + worker.Emit(OpCodes.Ldarg_1); + // base + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldfld, syncVar); + + MethodReference writeFunc; + // For NBs we always need to use the default NetworkBehaviour write func + // since the reader counter part uses that exact layout which is not easy to change + // without introducing more edge cases + // effectively this disallows custom NB-type writers/readers on SyncVars + // see: https://github.com/MirrorNetworking/Mirror/issues/2680 + if (syncVar.FieldType.IsDerivedFrom()) + { + writeFunc = writers.GetWriteFunc(weaverTypes.Import(), ref WeavingFailed); + } + else + { + writeFunc = writers.GetWriteFunc(syncVar.FieldType, ref WeavingFailed); + } + + if (writeFunc != null) + { + worker.Emit(OpCodes.Call, writeFunc); + } + else + { + Log.Error($"{syncVar.Name} has unsupported type. Use a supported Mirror type instead", syncVar); + WeavingFailed = true; + return; + } + + worker.Append(varLabel); + dirtyBit += 1; + } + + // add a log message if needed for debugging + //worker.Emit(OpCodes.Ldstr, $"Injected Serialize {netBehaviourSubclass.Name}"); + //worker.Emit(OpCodes.Call, WeaverTypes.logErrorReference); + + // generate: return + worker.Emit(OpCodes.Ret); + netBehaviourSubclass.Methods.Add(serialize); + } + + void DeserializeField(FieldDefinition syncVar, ILProcessor worker, ref bool WeavingFailed) + { + // put 'this.' onto stack for 'this.syncvar' below + worker.Append(worker.Create(OpCodes.Ldarg_0)); + + // push 'ref T this.field' + worker.Emit(OpCodes.Ldarg_0); + // if the netbehaviour class is generic, we need to make the field reference generic as well for correct IL + if (netBehaviourSubclass.HasGenericParameters) + { + worker.Emit(OpCodes.Ldflda, syncVar.MakeHostInstanceGeneric()); + } + else + { + worker.Emit(OpCodes.Ldflda, syncVar); + } + + // hook? then push 'new Action(Hook)' onto stack + MethodDefinition hookMethod = syncVarAttributeProcessor.GetHookMethod(netBehaviourSubclass, syncVar, ref WeavingFailed); + if (hookMethod != null) + { + syncVarAttributeProcessor.GenerateNewActionFromHookMethod(syncVar, worker, hookMethod); + } + // otherwise push 'null' as hook + else + { + worker.Emit(OpCodes.Ldnull); + } + + // call GeneratedSyncVarDeserialize. + // special cases for GameObject/NetworkIdentity/NetworkBehaviour + // passing netId too for persistence. + if (syncVar.FieldType.Is()) + { + // reader + worker.Emit(OpCodes.Ldarg_1); + + // GameObject setter needs one more parameter: netId field ref + FieldDefinition netIdField = syncVarNetIds[syncVar]; + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, netIdField); + worker.Emit(OpCodes.Call, weaverTypes.generatedSyncVarDeserialize_GameObject); + } + else if (syncVar.FieldType.Is()) + { + // reader + worker.Emit(OpCodes.Ldarg_1); + + // NetworkIdentity deserialize needs one more parameter: netId field ref + FieldDefinition netIdField = syncVarNetIds[syncVar]; + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, netIdField); + worker.Emit(OpCodes.Call, weaverTypes.generatedSyncVarDeserialize_NetworkIdentity); + } + // handle both NetworkBehaviour and inheritors. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/2939 + else if (syncVar.FieldType.IsDerivedFrom() || syncVar.FieldType.Is()) + { + // reader + worker.Emit(OpCodes.Ldarg_1); + + // NetworkIdentity deserialize needs one more parameter: netId field ref + // (actually its a NetworkBehaviourSyncVar type) + FieldDefinition netIdField = syncVarNetIds[syncVar]; + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, netIdField); + // make generic version of GeneratedSyncVarSetter_NetworkBehaviour + MethodReference getFunc = weaverTypes.generatedSyncVarDeserialize_NetworkBehaviour_T.MakeGeneric(assembly.MainModule, syncVar.FieldType); + worker.Emit(OpCodes.Call, getFunc); + } + else + { + // T value = reader.ReadT(); + // this is still in IL because otherwise weaver generated + // readers/writers don't seem to work in tests. + // besides, this also avoids reader.Read overhead. + MethodReference readFunc = readers.GetReadFunc(syncVar.FieldType, ref WeavingFailed); + if (readFunc == null) + { + Log.Error($"{syncVar.Name} has unsupported type. Use a supported Mirror type instead", syncVar); + WeavingFailed = true; + return; + } + // reader. for 'reader.Read()' below + worker.Emit(OpCodes.Ldarg_1); + // reader.Read() + worker.Emit(OpCodes.Call, readFunc); + + // make generic version of GeneratedSyncVarDeserialize + MethodReference generic = weaverTypes.generatedSyncVarDeserialize.MakeGeneric(assembly.MainModule, syncVar.FieldType); + worker.Emit(OpCodes.Call, generic); + } + } + + void GenerateDeSerialization(ref bool WeavingFailed) + { + const string DeserializeMethodName = "DeserializeSyncVars"; + if (netBehaviourSubclass.GetMethod(DeserializeMethodName) != null) + return; + + if (syncVars.Count == 0) + { + // no synvars, no need for custom OnDeserialize + return; + } + + MethodDefinition serialize = new MethodDefinition(DeserializeMethodName, + MethodAttributes.Public | MethodAttributes.Virtual | MethodAttributes.HideBySig, + weaverTypes.Import(typeof(void))); + + serialize.Parameters.Add(new ParameterDefinition("reader", ParameterAttributes.None, weaverTypes.Import())); + serialize.Parameters.Add(new ParameterDefinition("initialState", ParameterAttributes.None, weaverTypes.Import())); + ILProcessor serWorker = serialize.Body.GetILProcessor(); + // setup local for dirty bits + serialize.Body.InitLocals = true; + VariableDefinition dirtyBitsLocal = new VariableDefinition(weaverTypes.Import()); + serialize.Body.Variables.Add(dirtyBitsLocal); + + MethodReference baseDeserialize = Resolvers.TryResolveMethodInParents(netBehaviourSubclass.BaseType, assembly, DeserializeMethodName); + if (baseDeserialize != null) + { + // base + serWorker.Append(serWorker.Create(OpCodes.Ldarg_0)); + // reader + serWorker.Append(serWorker.Create(OpCodes.Ldarg_1)); + // initialState + serWorker.Append(serWorker.Create(OpCodes.Ldarg_2)); + serWorker.Append(serWorker.Create(OpCodes.Call, baseDeserialize)); + } + + // Generates: if (initialState); + Instruction initialStateLabel = serWorker.Create(OpCodes.Nop); + + serWorker.Append(serWorker.Create(OpCodes.Ldarg_2)); + serWorker.Append(serWorker.Create(OpCodes.Brfalse, initialStateLabel)); + + foreach (FieldDefinition syncVar in syncVars) + { + DeserializeField(syncVar, serWorker, ref WeavingFailed); + } + + serWorker.Append(serWorker.Create(OpCodes.Ret)); + + // Generates: end if (initialState); + serWorker.Append(initialStateLabel); + + // get dirty bits + serWorker.Append(serWorker.Create(OpCodes.Ldarg_1)); + serWorker.Append(serWorker.Create(OpCodes.Call, readers.GetReadFunc(weaverTypes.Import(), ref WeavingFailed))); + serWorker.Append(serWorker.Create(OpCodes.Stloc_0)); + + // conditionally read each syncvar + // start at number of syncvars in parent + int dirtyBit = syncVarAccessLists.GetSyncVarStart(netBehaviourSubclass.BaseType.FullName); + foreach (FieldDefinition syncVar in syncVars) + { + Instruction varLabel = serWorker.Create(OpCodes.Nop); + + // check if dirty bit is set + serWorker.Append(serWorker.Create(OpCodes.Ldloc_0)); + serWorker.Append(serWorker.Create(OpCodes.Ldc_I8, 1L << dirtyBit)); + serWorker.Append(serWorker.Create(OpCodes.And)); + serWorker.Append(serWorker.Create(OpCodes.Brfalse, varLabel)); + + DeserializeField(syncVar, serWorker, ref WeavingFailed); + + serWorker.Append(varLabel); + dirtyBit += 1; + } + + // add a log message if needed for debugging + //serWorker.Append(serWorker.Create(OpCodes.Ldstr, $"Injected Deserialize {netBehaviourSubclass.Name}")); + //serWorker.Append(serWorker.Create(OpCodes.Call, WeaverTypes.logErrorReference)); + + serWorker.Append(serWorker.Create(OpCodes.Ret)); + netBehaviourSubclass.Methods.Add(serialize); + } + + public static bool ReadArguments(MethodDefinition method, Readers readers, Logger Log, ILProcessor worker, RemoteCallType callType, ref bool WeavingFailed) + { + // read each argument + // example result + /* + CallCmdDoSomething(reader.ReadPackedInt32(), reader.ReadNetworkIdentity()); + */ + + bool skipFirst = callType == RemoteCallType.TargetRpc + && TargetRpcProcessor.HasNetworkConnectionParameter(method); + + // arg of calling function, arg 0 is "this" so start counting at 1 + int argNum = 1; + foreach (ParameterDefinition param in method.Parameters) + { + // NetworkConnection is not sent via the NetworkWriter so skip it here + // skip first for NetworkConnection in TargetRpc + if (argNum == 1 && skipFirst) + { + argNum += 1; + continue; + } + // skip SenderConnection in Command + if (IsSenderConnection(param, callType)) + { + argNum += 1; + continue; + } + + + MethodReference readFunc = readers.GetReadFunc(param.ParameterType, ref WeavingFailed); + + if (readFunc == null) + { + Log.Error($"{method.Name} has invalid parameter {param}. Unsupported type {param.ParameterType}, use a supported Mirror type instead", method); + WeavingFailed = true; + return false; + } + + worker.Emit(OpCodes.Ldarg_1); + worker.Emit(OpCodes.Call, readFunc); + + // conversion.. is this needed? + if (param.ParameterType.Is()) + { + worker.Emit(OpCodes.Conv_R4); + } + else if (param.ParameterType.Is()) + { + worker.Emit(OpCodes.Conv_R8); + } + } + return true; + } + + public static void AddInvokeParameters(WeaverTypes weaverTypes, ICollection collection) + { + collection.Add(new ParameterDefinition("obj", ParameterAttributes.None, weaverTypes.Import())); + collection.Add(new ParameterDefinition("reader", ParameterAttributes.None, weaverTypes.Import())); + // senderConnection is only used for commands but NetworkBehaviour.CmdDelegate is used for all remote calls + collection.Add(new ParameterDefinition("senderConnection", ParameterAttributes.None, weaverTypes.Import())); + } + + // check if a Command/TargetRpc/Rpc function & parameters are valid for weaving + public bool ValidateRemoteCallAndParameters(MethodDefinition method, RemoteCallType callType, ref bool WeavingFailed) + { + if (method.IsStatic) + { + Log.Error($"{method.Name} must not be static", method); + WeavingFailed = true; + return false; + } + + return ValidateFunction(method, ref WeavingFailed) && + ValidateParameters(method, callType, ref WeavingFailed); + } + + // check if a Command/TargetRpc/Rpc function is valid for weaving + bool ValidateFunction(MethodReference md, ref bool WeavingFailed) + { + if (md.ReturnType.Is()) + { + Log.Error($"{md.Name} cannot be a coroutine", md); + WeavingFailed = true; + return false; + } + if (!md.ReturnType.Is(typeof(void))) + { + Log.Error($"{md.Name} cannot return a value. Make it void instead", md); + WeavingFailed = true; + return false; + } + if (md.HasGenericParameters) + { + Log.Error($"{md.Name} cannot have generic parameters", md); + WeavingFailed = true; + return false; + } + return true; + } + + // check if all Command/TargetRpc/Rpc function's parameters are valid for weaving + bool ValidateParameters(MethodReference method, RemoteCallType callType, ref bool WeavingFailed) + { + for (int i = 0; i < method.Parameters.Count; ++i) + { + ParameterDefinition param = method.Parameters[i]; + if (!ValidateParameter(method, param, callType, i == 0, ref WeavingFailed)) + { + return false; + } + } + return true; + } + + // validate parameters for a remote function call like Rpc/Cmd + bool ValidateParameter(MethodReference method, ParameterDefinition param, RemoteCallType callType, bool firstParam, ref bool WeavingFailed) + { + // need to check this before any type lookups since those will fail since generic types don't resolve + if (param.ParameterType.IsGenericParameter) + { + Log.Error($"{method.Name} cannot have generic parameters", method); + WeavingFailed = true; + return false; + } + + bool isNetworkConnection = param.ParameterType.Is(); + bool isSenderConnection = IsSenderConnection(param, callType); + + if (param.IsOut) + { + Log.Error($"{method.Name} cannot have out parameters", method); + WeavingFailed = true; + return false; + } + + // if not SenderConnection And not TargetRpc NetworkConnection first param + if (!isSenderConnection && isNetworkConnection && !(callType == RemoteCallType.TargetRpc && firstParam)) + { + if (callType == RemoteCallType.Command) + { + Log.Error($"{method.Name} has invalid parameter {param}, Cannot pass NetworkConnections. Instead use 'NetworkConnectionToClient conn = null' to get the sender's connection on the server", method); + } + else + { + Log.Error($"{method.Name} has invalid parameter {param}. Cannot pass NetworkConnections", method); + } + WeavingFailed = true; + return false; + } + + // sender connection can be optional + if (param.IsOptional && !isSenderConnection) + { + Log.Error($"{method.Name} cannot have optional parameters", method); + WeavingFailed = true; + return false; + } + + return true; + } + + public static bool IsSenderConnection(ParameterDefinition param, RemoteCallType callType) + { + if (callType != RemoteCallType.Command) + { + return false; + } + + TypeReference type = param.ParameterType; + + return type.Is() + || type.Resolve().IsDerivedFrom(); + } + + void ProcessMethods(ref bool WeavingFailed) + { + HashSet names = new HashSet(); + + // copy the list of methods because we will be adding methods in the loop + List methods = new List(netBehaviourSubclass.Methods); + // find command and RPC functions + foreach (MethodDefinition md in methods) + { + foreach (CustomAttribute ca in md.CustomAttributes) + { + if (ca.AttributeType.Is()) + { + ProcessCommand(names, md, ca, ref WeavingFailed); + break; + } + + if (ca.AttributeType.Is()) + { + ProcessTargetRpc(names, md, ca, ref WeavingFailed); + break; + } + + if (ca.AttributeType.Is()) + { + ProcessClientRpc(names, md, ca, ref WeavingFailed); + break; + } + } + } + } + + void ProcessClientRpc(HashSet names, MethodDefinition md, CustomAttribute clientRpcAttr, ref bool WeavingFailed) + { + if (md.IsAbstract) + { + Log.Error("Abstract ClientRpc are currently not supported, use virtual method instead", md); + WeavingFailed = true; + return; + } + + if (!ValidateRemoteCallAndParameters(md, RemoteCallType.ClientRpc, ref WeavingFailed)) + { + return; + } + + bool includeOwner = clientRpcAttr.GetField("includeOwner", true); + + names.Add(md.Name); + clientRpcs.Add(new ClientRpcResult + { + method = md, + includeOwner = includeOwner + }); + + MethodDefinition rpcCallFunc = RpcProcessor.ProcessRpcCall(weaverTypes, writers, Log, netBehaviourSubclass, md, clientRpcAttr, ref WeavingFailed); + // need null check here because ProcessRpcCall returns null if it can't write all the args + if (rpcCallFunc == null) { return; } + + MethodDefinition rpcFunc = RpcProcessor.ProcessRpcInvoke(weaverTypes, writers, readers, Log, netBehaviourSubclass, md, rpcCallFunc, ref WeavingFailed); + if (rpcFunc != null) + { + clientRpcInvocationFuncs.Add(rpcFunc); + } + } + + void ProcessTargetRpc(HashSet names, MethodDefinition md, CustomAttribute targetRpcAttr, ref bool WeavingFailed) + { + if (md.IsAbstract) + { + Log.Error("Abstract TargetRpc are currently not supported, use virtual method instead", md); + WeavingFailed = true; + return; + } + + if (!ValidateRemoteCallAndParameters(md, RemoteCallType.TargetRpc, ref WeavingFailed)) + return; + + names.Add(md.Name); + targetRpcs.Add(md); + + MethodDefinition rpcCallFunc = TargetRpcProcessor.ProcessTargetRpcCall(weaverTypes, writers, Log, netBehaviourSubclass, md, targetRpcAttr, ref WeavingFailed); + + MethodDefinition rpcFunc = TargetRpcProcessor.ProcessTargetRpcInvoke(weaverTypes, readers, Log, netBehaviourSubclass, md, rpcCallFunc, ref WeavingFailed); + if (rpcFunc != null) + { + targetRpcInvocationFuncs.Add(rpcFunc); + } + } + + void ProcessCommand(HashSet names, MethodDefinition md, CustomAttribute commandAttr, ref bool WeavingFailed) + { + if (md.IsAbstract) + { + Log.Error("Abstract Commands are currently not supported, use virtual method instead", md); + WeavingFailed = true; + return; + } + + if (!ValidateRemoteCallAndParameters(md, RemoteCallType.Command, ref WeavingFailed)) + return; + + bool requiresAuthority = commandAttr.GetField("requiresAuthority", true); + + names.Add(md.Name); + commands.Add(new CmdResult + { + method = md, + requiresAuthority = requiresAuthority + }); + + MethodDefinition cmdCallFunc = CommandProcessor.ProcessCommandCall(weaverTypes, writers, Log, netBehaviourSubclass, md, commandAttr, ref WeavingFailed); + + MethodDefinition cmdFunc = CommandProcessor.ProcessCommandInvoke(weaverTypes, readers, Log, netBehaviourSubclass, md, cmdCallFunc, ref WeavingFailed); + if (cmdFunc != null) + { + commandInvocationFuncs.Add(cmdFunc); + } + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs.meta new file mode 100644 index 0000000..67c27dc --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8118d606be3214e5d99943ec39530dd8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/ReaderWriterProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/ReaderWriterProcessor.cs new file mode 100644 index 0000000..280240c --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/ReaderWriterProcessor.cs @@ -0,0 +1,216 @@ +// finds all readers and writers and register them +using System.Linq; +using Mono.CecilX; +using Mono.CecilX.Cil; +using Mono.CecilX.Rocks; +using UnityEngine; + +namespace Mirror.Weaver +{ + public static class ReaderWriterProcessor + { + public static bool Process(AssemblyDefinition CurrentAssembly, IAssemblyResolver resolver, Logger Log, Writers writers, Readers readers, ref bool WeavingFailed) + { + // find NetworkReader/Writer extensions from Mirror.dll first. + // and NetworkMessage custom writer/reader extensions. + // NOTE: do not include this result in our 'modified' return value, + // otherwise Unity crashes when running tests + ProcessMirrorAssemblyClasses(CurrentAssembly, resolver, Log, writers, readers, ref WeavingFailed); + + // find readers/writers in the assembly we are in right now. + return ProcessAssemblyClasses(CurrentAssembly, CurrentAssembly, writers, readers, ref WeavingFailed); + } + + static void ProcessMirrorAssemblyClasses(AssemblyDefinition CurrentAssembly, IAssemblyResolver resolver, Logger Log, Writers writers, Readers readers, ref bool WeavingFailed) + { + // find Mirror.dll in assembly's references. + // those are guaranteed to be resolvable and correct. + // after all, it references them :) + AssemblyNameReference mirrorAssemblyReference = CurrentAssembly.MainModule.FindReference(Weaver.MirrorAssemblyName); + if (mirrorAssemblyReference != null) + { + // resolve the assembly to load the AssemblyDefinition. + // we need to search all types in it. + // if we only were to resolve one known type like in WeaverTypes, + // then we wouldn't need it. + AssemblyDefinition mirrorAssembly = resolver.Resolve(mirrorAssemblyReference); + if (mirrorAssembly != null) + { + ProcessAssemblyClasses(CurrentAssembly, mirrorAssembly, writers, readers, ref WeavingFailed); + } + else Log.Error($"Failed to resolve {mirrorAssemblyReference}"); + } + else Log.Error("Failed to find Mirror AssemblyNameReference. Can't register Mirror.dll readers/writers."); + } + + static bool ProcessAssemblyClasses(AssemblyDefinition CurrentAssembly, AssemblyDefinition assembly, Writers writers, Readers readers, ref bool WeavingFailed) + { + bool modified = false; + foreach (TypeDefinition klass in assembly.MainModule.Types) + { + // extension methods only live in static classes + // static classes are represented as sealed and abstract + if (klass.IsAbstract && klass.IsSealed) + { + // if assembly has any declared writers then it is "modified" + modified |= LoadDeclaredWriters(CurrentAssembly, klass, writers); + modified |= LoadDeclaredReaders(CurrentAssembly, klass, readers); + } + } + + foreach (TypeDefinition klass in assembly.MainModule.Types) + { + // if assembly has any network message then it is modified + modified |= LoadMessageReadWriter(CurrentAssembly.MainModule, writers, readers, klass, ref WeavingFailed); + } + return modified; + } + + static bool LoadMessageReadWriter(ModuleDefinition module, Writers writers, Readers readers, TypeDefinition klass, ref bool WeavingFailed) + { + bool modified = false; + if (!klass.IsAbstract && !klass.IsInterface && klass.ImplementsInterface()) + { + readers.GetReadFunc(module.ImportReference(klass), ref WeavingFailed); + writers.GetWriteFunc(module.ImportReference(klass), ref WeavingFailed); + modified = true; + } + + foreach (TypeDefinition td in klass.NestedTypes) + { + modified |= LoadMessageReadWriter(module, writers, readers, td, ref WeavingFailed); + } + return modified; + } + + static bool LoadDeclaredWriters(AssemblyDefinition currentAssembly, TypeDefinition klass, Writers writers) + { + // register all the writers in this class. Skip the ones with wrong signature + bool modified = false; + foreach (MethodDefinition method in klass.Methods) + { + if (method.Parameters.Count != 2) + continue; + + if (!method.Parameters[0].ParameterType.Is()) + continue; + + if (!method.ReturnType.Is(typeof(void))) + continue; + + if (!method.HasCustomAttribute()) + continue; + + if (method.HasGenericParameters) + continue; + + TypeReference dataType = method.Parameters[1].ParameterType; + writers.Register(dataType, currentAssembly.MainModule.ImportReference(method)); + modified = true; + } + return modified; + } + + static bool LoadDeclaredReaders(AssemblyDefinition currentAssembly, TypeDefinition klass, Readers readers) + { + // register all the reader in this class. Skip the ones with wrong signature + bool modified = false; + foreach (MethodDefinition method in klass.Methods) + { + if (method.Parameters.Count != 1) + continue; + + if (!method.Parameters[0].ParameterType.Is()) + continue; + + if (method.ReturnType.Is(typeof(void))) + continue; + + if (!method.HasCustomAttribute()) + continue; + + if (method.HasGenericParameters) + continue; + + readers.Register(method.ReturnType, currentAssembly.MainModule.ImportReference(method)); + modified = true; + } + return modified; + } + + // helper function to add [RuntimeInitializeOnLoad] attribute to method + static void AddRuntimeInitializeOnLoadAttribute(AssemblyDefinition assembly, WeaverTypes weaverTypes, MethodDefinition method) + { + // NOTE: previously we used reflection because according paul, + // 'weaving Mirror.dll caused unity to rebuild all dlls but in wrong + // order, which breaks rewired' + // it's not obvious why importing an attribute via reflection instead + // of cecil would break anything. let's use cecil. + + // to add a CustomAttribute, we need the attribute's constructor. + // in this case, there are two: empty, and RuntimeInitializeOnLoadType. + // we want the last one, with the type parameter. + MethodDefinition ctor = weaverTypes.runtimeInitializeOnLoadMethodAttribute.GetConstructors().Last(); + //MethodDefinition ctor = weaverTypes.runtimeInitializeOnLoadMethodAttribute.GetConstructors().First(); + // using ctor directly throws: ArgumentException: Member 'System.Void UnityEditor.InitializeOnLoadMethodAttribute::.ctor()' is declared in another module and needs to be imported + // we need to import it first. + CustomAttribute attribute = new CustomAttribute(assembly.MainModule.ImportReference(ctor)); + // add the RuntimeInitializeLoadType.BeforeSceneLoad argument to ctor + attribute.ConstructorArguments.Add(new CustomAttributeArgument(weaverTypes.Import(), RuntimeInitializeLoadType.BeforeSceneLoad)); + method.CustomAttributes.Add(attribute); + } + + // helper function to add [InitializeOnLoad] attribute to method + // (only works in Editor assemblies. check IsEditorAssembly first.) + static void AddInitializeOnLoadAttribute(AssemblyDefinition assembly, WeaverTypes weaverTypes, MethodDefinition method) + { + // NOTE: previously we used reflection because according paul, + // 'weaving Mirror.dll caused unity to rebuild all dlls but in wrong + // order, which breaks rewired' + // it's not obvious why importing an attribute via reflection instead + // of cecil would break anything. let's use cecil. + + // to add a CustomAttribute, we need the attribute's constructor. + // in this case, there's only one - and it's an empty constructor. + MethodDefinition ctor = weaverTypes.initializeOnLoadMethodAttribute.GetConstructors().First(); + // using ctor directly throws: ArgumentException: Member 'System.Void UnityEditor.InitializeOnLoadMethodAttribute::.ctor()' is declared in another module and needs to be imported + // we need to import it first. + CustomAttribute attribute = new CustomAttribute(assembly.MainModule.ImportReference(ctor)); + method.CustomAttributes.Add(attribute); + } + + // adds Mirror.GeneratedNetworkCode.InitReadWriters() method that + // registers all generated writers into Mirror.Writer static class. + // -> uses [RuntimeInitializeOnLoad] attribute so it's invoke at runtime + // -> uses [InitializeOnLoad] if UnityEditor is referenced so it works + // in Editor and in tests too + // + // use ILSpy to see the result (it's in the DLL's 'Mirror' namespace) + public static void InitializeReaderAndWriters(AssemblyDefinition currentAssembly, WeaverTypes weaverTypes, Writers writers, Readers readers, TypeDefinition GeneratedCodeClass) + { + MethodDefinition initReadWriters = new MethodDefinition("InitReadWriters", MethodAttributes.Public | + MethodAttributes.Static, + weaverTypes.Import(typeof(void))); + + // add [RuntimeInitializeOnLoad] in any case + AddRuntimeInitializeOnLoadAttribute(currentAssembly, weaverTypes, initReadWriters); + + // add [InitializeOnLoad] if UnityEditor is referenced + if (Helpers.IsEditorAssembly(currentAssembly)) + { + AddInitializeOnLoadAttribute(currentAssembly, weaverTypes, initReadWriters); + } + + // fill function body with reader/writer initializers + ILProcessor worker = initReadWriters.Body.GetILProcessor(); + // for debugging: add a log to see if initialized on load + //worker.Emit(OpCodes.Ldstr, $"[InitReadWriters] called!"); + //worker.Emit(OpCodes.Call, Weaver.weaverTypes.logWarningReference); + writers.InitializeWriters(worker); + readers.InitializeReaders(worker); + worker.Emit(OpCodes.Ret); + + GeneratedCodeClass.Methods.Add(initReadWriters); + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/ReaderWriterProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/ReaderWriterProcessor.cs.meta new file mode 100644 index 0000000..c14d6fa --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/ReaderWriterProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f3263602f0a374ecd8d08588b1fc2f76 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs new file mode 100644 index 0000000..6c341e7 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs @@ -0,0 +1,104 @@ +using Mono.CecilX; +using Mono.CecilX.Cil; + +namespace Mirror.Weaver +{ + // Processes [Rpc] methods in NetworkBehaviour + public static class RpcProcessor + { + public static MethodDefinition ProcessRpcInvoke(WeaverTypes weaverTypes, Writers writers, Readers readers, Logger Log, TypeDefinition td, MethodDefinition md, MethodDefinition rpcCallFunc, ref bool WeavingFailed) + { + string rpcName = Weaver.GenerateMethodName(Weaver.InvokeRpcPrefix, md); + + MethodDefinition rpc = new MethodDefinition(rpcName, MethodAttributes.Family | MethodAttributes.Static | MethodAttributes.HideBySig, + weaverTypes.Import(typeof(void))); + + ILProcessor worker = rpc.Body.GetILProcessor(); + Instruction label = worker.Create(OpCodes.Nop); + + NetworkBehaviourProcessor.WriteClientActiveCheck(worker, weaverTypes, md.Name, label, "RPC"); + + // setup for reader + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Castclass, td); + + if (!NetworkBehaviourProcessor.ReadArguments(md, readers, Log, worker, RemoteCallType.ClientRpc, ref WeavingFailed)) + return null; + + // invoke actual command function + worker.Emit(OpCodes.Callvirt, rpcCallFunc); + worker.Emit(OpCodes.Ret); + + NetworkBehaviourProcessor.AddInvokeParameters(weaverTypes, rpc.Parameters); + td.Methods.Add(rpc); + return rpc; + } + + /* + * generates code like: + + public void RpcTest (int param) + { + NetworkWriter writer = new NetworkWriter (); + writer.WritePackedUInt32((uint)param); + base.SendRPCInternal(typeof(class),"RpcTest", writer, 0); + } + public void CallRpcTest (int param) + { + // whatever the user did before + } + + Originally HLAPI put the send message code inside the Call function + and then proceeded to replace every call to RpcTest with CallRpcTest + + This method moves all the user's code into the "CallRpc" method + and replaces the body of the original method with the send message code. + This way we do not need to modify the code anywhere else, and this works + correctly in dependent assemblies + */ + public static MethodDefinition ProcessRpcCall(WeaverTypes weaverTypes, Writers writers, Logger Log, TypeDefinition td, MethodDefinition md, CustomAttribute clientRpcAttr, ref bool WeavingFailed) + { + MethodDefinition rpc = MethodProcessor.SubstituteMethod(Log, td, md, ref WeavingFailed); + + ILProcessor worker = md.Body.GetILProcessor(); + + NetworkBehaviourProcessor.WriteSetupLocals(worker, weaverTypes); + + // add a log message if needed for debugging + //worker.Emit(OpCodes.Ldstr, $"Call ClientRpc function {md.Name}"); + //worker.Emit(OpCodes.Call, WeaverTypes.logErrorReference); + + NetworkBehaviourProcessor.WriteGetWriter(worker, weaverTypes); + + // write all the arguments that the user passed to the Rpc call + if (!NetworkBehaviourProcessor.WriteArguments(worker, writers, Log, md, RemoteCallType.ClientRpc, ref WeavingFailed)) + return null; + + int channel = clientRpcAttr.GetField("channel", 0); + bool includeOwner = clientRpcAttr.GetField("includeOwner", true); + + // invoke SendInternal and return + // this + worker.Emit(OpCodes.Ldarg_0); + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + worker.Emit(OpCodes.Ldstr, md.FullName); + // pass the function hash so we don't have to compute it at runtime + // otherwise each GetStableHash call requires O(N) complexity. + // noticeable for long function names: + // https://github.com/MirrorNetworking/Mirror/issues/3375 + worker.Emit(OpCodes.Ldc_I4, md.FullName.GetStableHashCode()); + // writer + worker.Emit(OpCodes.Ldloc_0); + worker.Emit(OpCodes.Ldc_I4, channel); + // includeOwner ? 1 : 0 + worker.Emit(includeOwner ? OpCodes.Ldc_I4_1 : OpCodes.Ldc_I4_0); + worker.Emit(OpCodes.Callvirt, weaverTypes.sendRpcInternal); + + NetworkBehaviourProcessor.WriteReturnWriter(worker, weaverTypes); + + worker.Emit(OpCodes.Ret); + + return rpc; + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs.meta new file mode 100644 index 0000000..22375ba --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a3cb7051ff41947e59bba58bdd2b73fc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/ServerClientAttributeProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/ServerClientAttributeProcessor.cs new file mode 100644 index 0000000..6bb95ee --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/ServerClientAttributeProcessor.cs @@ -0,0 +1,163 @@ +// Injects server/client active checks for [Server/Client] attributes +using Mono.CecilX; +using Mono.CecilX.Cil; + +namespace Mirror.Weaver +{ + static class ServerClientAttributeProcessor + { + public static bool Process(WeaverTypes weaverTypes, Logger Log, TypeDefinition td, ref bool WeavingFailed) + { + bool modified = false; + foreach (MethodDefinition md in td.Methods) + { + modified |= ProcessSiteMethod(weaverTypes, Log, md, ref WeavingFailed); + } + + foreach (TypeDefinition nested in td.NestedTypes) + { + modified |= Process(weaverTypes, Log, nested, ref WeavingFailed); + } + return modified; + } + + static bool ProcessSiteMethod(WeaverTypes weaverTypes, Logger Log, MethodDefinition md, ref bool WeavingFailed) + { + if (md.Name == ".cctor" || + md.Name == NetworkBehaviourProcessor.ProcessedFunctionName || + md.Name.StartsWith(Weaver.InvokeRpcPrefix)) + return false; + + if (md.IsAbstract) + { + if (HasServerClientAttribute(md)) + { + Log.Error("Server or Client Attributes can't be added to abstract method. Server and Client Attributes are not inherited so they need to be applied to the override methods instead.", md); + WeavingFailed = true; + } + return false; + } + + if (md.Body != null && md.Body.Instructions != null) + { + return ProcessMethodAttributes(weaverTypes, md); + } + return false; + } + + public static bool HasServerClientAttribute(MethodDefinition md) + { + foreach (CustomAttribute attr in md.CustomAttributes) + { + switch (attr.Constructor.DeclaringType.ToString()) + { + case "Mirror.ServerAttribute": + case "Mirror.ServerCallbackAttribute": + case "Mirror.ClientAttribute": + case "Mirror.ClientCallbackAttribute": + return true; + default: + break; + } + } + return false; + } + + public static bool ProcessMethodAttributes(WeaverTypes weaverTypes, MethodDefinition md) + { + if (md.HasCustomAttribute()) + InjectServerGuard(weaverTypes, md, true); + else if (md.HasCustomAttribute()) + InjectServerGuard(weaverTypes, md, false); + else if (md.HasCustomAttribute()) + InjectClientGuard(weaverTypes, md, true); + else if (md.HasCustomAttribute()) + InjectClientGuard(weaverTypes, md, false); + else + return false; + + return true; + } + + static void InjectServerGuard(WeaverTypes weaverTypes, MethodDefinition md, bool logWarning) + { + ILProcessor worker = md.Body.GetILProcessor(); + Instruction top = md.Body.Instructions[0]; + + worker.InsertBefore(top, worker.Create(OpCodes.Call, weaverTypes.NetworkServerGetActive)); + worker.InsertBefore(top, worker.Create(OpCodes.Brtrue, top)); + if (logWarning) + { + worker.InsertBefore(top, worker.Create(OpCodes.Ldstr, $"[Server] function '{md.FullName}' called when server was not active")); + worker.InsertBefore(top, worker.Create(OpCodes.Call, weaverTypes.logWarningReference)); + } + InjectGuardParameters(md, worker, top); + InjectGuardReturnValue(md, worker, top); + worker.InsertBefore(top, worker.Create(OpCodes.Ret)); + } + + static void InjectClientGuard(WeaverTypes weaverTypes, MethodDefinition md, bool logWarning) + { + ILProcessor worker = md.Body.GetILProcessor(); + Instruction top = md.Body.Instructions[0]; + + worker.InsertBefore(top, worker.Create(OpCodes.Call, weaverTypes.NetworkClientGetActive)); + worker.InsertBefore(top, worker.Create(OpCodes.Brtrue, top)); + if (logWarning) + { + worker.InsertBefore(top, worker.Create(OpCodes.Ldstr, $"[Client] function '{md.FullName}' called when client was not active")); + worker.InsertBefore(top, worker.Create(OpCodes.Call, weaverTypes.logWarningReference)); + } + + InjectGuardParameters(md, worker, top); + InjectGuardReturnValue(md, worker, top); + worker.InsertBefore(top, worker.Create(OpCodes.Ret)); + } + + // this is required to early-out from a function with "ref" or "out" parameters + static void InjectGuardParameters(MethodDefinition md, ILProcessor worker, Instruction top) + { + int offset = md.Resolve().IsStatic ? 0 : 1; + for (int index = 0; index < md.Parameters.Count; index++) + { + ParameterDefinition param = md.Parameters[index]; + if (param.IsOut) + { + // this causes IL2CPP build issues with generic out parameters: + // https://github.com/MirrorNetworking/Mirror/issues/3482 + // TypeReference elementType = param.ParameterType.GetElementType(); + // + // instead we need to use ElementType not GetElementType() + // GetElementType() will get the element type of the inner elementType + // which will return wrong type for arrays and generic + // credit: JamesFrowen + ByReferenceType byRefType = (ByReferenceType)param.ParameterType; + TypeReference elementType = byRefType.ElementType; + + md.Body.Variables.Add(new VariableDefinition(elementType)); + md.Body.InitLocals = true; + + worker.InsertBefore(top, worker.Create(OpCodes.Ldarg, index + offset)); + worker.InsertBefore(top, worker.Create(OpCodes.Ldloca_S, (byte)(md.Body.Variables.Count - 1))); + worker.InsertBefore(top, worker.Create(OpCodes.Initobj, elementType)); + worker.InsertBefore(top, worker.Create(OpCodes.Ldloc, md.Body.Variables.Count - 1)); + worker.InsertBefore(top, worker.Create(OpCodes.Stobj, elementType)); + } + } + } + + // this is required to early-out from a function with a return value. + static void InjectGuardReturnValue(MethodDefinition md, ILProcessor worker, Instruction top) + { + if (!md.ReturnType.Is(typeof(void))) + { + md.Body.Variables.Add(new VariableDefinition(md.ReturnType)); + md.Body.InitLocals = true; + + worker.InsertBefore(top, worker.Create(OpCodes.Ldloca_S, (byte)(md.Body.Variables.Count - 1))); + worker.InsertBefore(top, worker.Create(OpCodes.Initobj, md.ReturnType)); + worker.InsertBefore(top, worker.Create(OpCodes.Ldloc, md.Body.Variables.Count - 1)); + } + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/ServerClientAttributeProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/ServerClientAttributeProcessor.cs.meta new file mode 100644 index 0000000..5a5451d --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/ServerClientAttributeProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 024f251bf693bb345b90b9177892d534 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncObjectInitializer.cs b/Assets/Mirror/Editor/Weaver/Processors/SyncObjectInitializer.cs new file mode 100644 index 0000000..a174403 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/SyncObjectInitializer.cs @@ -0,0 +1,39 @@ +using Mono.CecilX; +using Mono.CecilX.Cil; + +namespace Mirror.Weaver +{ + public static class SyncObjectInitializer + { + // generates code like: + // this.InitSyncObject(m_sizes); + public static void GenerateSyncObjectInitializer(ILProcessor worker, WeaverTypes weaverTypes, FieldDefinition fd) + { + // register syncobject in network behaviour + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldfld, fd); + worker.Emit(OpCodes.Call, weaverTypes.InitSyncObjectReference); + } + + public static bool ImplementsSyncObject(TypeReference typeRef) + { + try + { + // value types cant inherit from SyncObject + if (typeRef.IsValueType) + { + return false; + } + + return typeRef.Resolve().IsDerivedFrom(); + } + catch + { + // sometimes this will fail if we reference a weird library that can't be resolved, so we just swallow that exception and return false + } + + return false; + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncObjectInitializer.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/SyncObjectInitializer.cs.meta new file mode 100644 index 0000000..22f976e --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/SyncObjectInitializer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d02219b00b3674e59a2151f41e791688 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs new file mode 100644 index 0000000..8143e86 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs @@ -0,0 +1,90 @@ +using System.Collections.Generic; +using Mono.CecilX; + +namespace Mirror.Weaver +{ + public static class SyncObjectProcessor + { + // ulong = 64 bytes + const int SyncObjectsLimit = 64; + + // Finds SyncObjects fields in a type + // Type should be a NetworkBehaviour + public static List FindSyncObjectsFields(Writers writers, Readers readers, Logger Log, TypeDefinition td, ref bool WeavingFailed) + { + List syncObjects = new List(); + + foreach (FieldDefinition fd in td.Fields) + { + if (fd.FieldType.IsGenericParameter || fd.ContainsGenericParameter) + { + // can't call .Resolve on generic ones + continue; + } + + if (fd.FieldType.Resolve().IsDerivedFrom()) + { + if (fd.IsStatic) + { + Log.Error($"{fd.Name} cannot be static", fd); + WeavingFailed = true; + continue; + } + + // SyncObjects always needs to be readonly to guarantee. + // Weaver calls InitSyncObject on them for dirty bits etc. + // Reassigning at runtime would cause undefined behaviour. + // (C# 'readonly' is called 'initonly' in IL code.) + // + // NOTE: instead of forcing readonly, we could also scan all + // instructions for SyncObject assignments. this would + // make unit tests very difficult though. + if (!fd.IsInitOnly) + { + // just a warning for now. + // many people might still use non-readonly SyncObjects. + Log.Warning($"{fd.Name} should have a 'readonly' keyword in front of the variable because {typeof(SyncObject)}s always need to be initialized by the Weaver.", fd); + + // only log, but keep weaving. no need to break projects. + //WeavingFailed = true; + } + + GenerateReadersAndWriters(writers, readers, fd.FieldType, ref WeavingFailed); + + syncObjects.Add(fd); + } + } + + // SyncObjects dirty mask is 64 bit. can't sync more than 64. + if (syncObjects.Count > 64) + { + Log.Error($"{td.Name} has > {SyncObjectsLimit} SyncObjects (SyncLists etc). Consider refactoring your class into multiple components", td); + WeavingFailed = true; + } + + + return syncObjects; + } + + // Generates serialization methods for synclists + static void GenerateReadersAndWriters(Writers writers, Readers readers, TypeReference tr, ref bool WeavingFailed) + { + if (tr is GenericInstanceType genericInstance) + { + foreach (TypeReference argument in genericInstance.GenericArguments) + { + if (!argument.IsGenericParameter) + { + readers.GetReadFunc(argument, ref WeavingFailed); + writers.GetWriteFunc(argument, ref WeavingFailed); + } + } + } + + if (tr != null) + { + GenerateReadersAndWriters(writers, readers, tr.Resolve().BaseType, ref WeavingFailed); + } + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs.meta new file mode 100644 index 0000000..0efe434 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 78f71efc83cde4917b7d21efa90bcc9a +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeAccessReplacer.cs b/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeAccessReplacer.cs new file mode 100644 index 0000000..da7b825 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeAccessReplacer.cs @@ -0,0 +1,206 @@ +// [SyncVar] int health; +// is replaced with: +// public int Networkhealth { get; set; } properties. +// this class processes all access to 'health' and replaces it with 'Networkhealth' +using System; +using Mono.CecilX; +using Mono.CecilX.Cil; + +namespace Mirror.Weaver +{ + public static class SyncVarAttributeAccessReplacer + { + // process the module + public static void Process(Logger Log, ModuleDefinition moduleDef, SyncVarAccessLists syncVarAccessLists) + { + DateTime startTime = DateTime.Now; + + // process all classes in this module + foreach (TypeDefinition td in moduleDef.Types) + { + if (td.IsClass) + { + ProcessClass(Log, syncVarAccessLists, td); + } + } + + Console.WriteLine($" ProcessSitesModule {moduleDef.Name} elapsed time:{(DateTime.Now - startTime)}"); + } + + static void ProcessClass(Logger Log, SyncVarAccessLists syncVarAccessLists, TypeDefinition td) + { + //Console.WriteLine($" ProcessClass {td}"); + + // process all methods in this class + foreach (MethodDefinition md in td.Methods) + { + ProcessMethod(Log, syncVarAccessLists, md); + } + + // processes all nested classes in this class recursively + foreach (TypeDefinition nested in td.NestedTypes) + { + ProcessClass(Log, syncVarAccessLists, nested); + } + } + + static void ProcessMethod(Logger Log, SyncVarAccessLists syncVarAccessLists, MethodDefinition md) + { + // process all references to replaced members with properties + //Log.Warning($" ProcessSiteMethod {md}"); + + // skip static constructor, "MirrorProcessed", "InvokeUserCode_" + if (md.Name == ".cctor" || + md.Name == NetworkBehaviourProcessor.ProcessedFunctionName || + md.Name.StartsWith(Weaver.InvokeRpcPrefix)) + return; + + // skip abstract + if (md.IsAbstract) + { + return; + } + + // go through all instructions of this method + if (md.Body != null && md.Body.Instructions != null) + { + for (int i = 0; i < md.Body.Instructions.Count;) + { + Instruction instr = md.Body.Instructions[i]; + i += ProcessInstruction(Log, syncVarAccessLists, md, instr, i); + } + } + } + + static int ProcessInstruction(Logger Log, SyncVarAccessLists syncVarAccessLists, MethodDefinition md, Instruction instr, int iCount) + { + // stfld (sets value of a field)? + if (instr.OpCode == OpCodes.Stfld) + { + // operand is a FieldDefinition in the same assembly? + if (instr.Operand is FieldDefinition opFieldst) + { + ProcessSetInstruction(syncVarAccessLists, md, instr, opFieldst); + } + // operand is a FieldReference in another assembly? + // this is not supported just yet. + // compilation error is better than silently failing SyncVar serialization at runtime. + // https://github.com/MirrorNetworking/Mirror/issues/3525 + else if (instr.Operand is FieldReference opFieldstRef) + { + // resolve it from the other assembly + FieldDefinition field = opFieldstRef.Resolve(); + + // [SyncVar]? + if (field.HasCustomAttribute()) + { + // ILPostProcessor would need to Process() the assembly's + // references before processing this one. + // we can not control the order. + // instead, Log an error to suggest adding a SetSyncVar(value) function. + // this is a very easy solution for a very rare edge case. + Log.Error($"'[SyncVar] {opFieldstRef.Name}' in '{md.Module.Name}' is modified by '{md.FullName}' in '{field.Module.Name}'. Modifying a [SyncVar] from another assembly is not supported. Please add a: 'public void Set{opFieldstRef.Name}(value) {{ this.{opFieldstRef.Name} = value; }}' function in '{opFieldstRef.DeclaringType.Name}' and call this function from '{md.FullName}' instead."); + } + } + } + + // ldfld (load value of a field)? + if (instr.OpCode == OpCodes.Ldfld) + { + // operand is a FieldDefinition in the same assembly? + if (instr.Operand is FieldDefinition opFieldld) + { + // this instruction gets the value of a field. cache the field reference. + ProcessGetInstruction(syncVarAccessLists, md, instr, opFieldld); + } + } + + // ldflda (load field address aka reference) + if (instr.OpCode == OpCodes.Ldflda) + { + // operand is a FieldDefinition in the same assembly? + if (instr.Operand is FieldDefinition opFieldlda) + { + // watch out for initobj instruction + // see https://github.com/vis2k/Mirror/issues/696 + return ProcessLoadAddressInstruction(syncVarAccessLists, md, instr, opFieldlda, iCount); + } + } + + // we processed one instruction (instr) + return 1; + } + + // replaces syncvar write access with the NetworkXYZ.set property calls + static void ProcessSetInstruction(SyncVarAccessLists syncVarAccessLists, MethodDefinition md, Instruction i, FieldDefinition opField) + { + // don't replace property call sites in constructors + if (md.Name == ".ctor") + return; + + // does it set a field that we replaced? + if (syncVarAccessLists.replacementSetterProperties.TryGetValue(opField, out MethodDefinition replacement)) + { + //replace with property + //Log.Warning($" replacing {md.Name}:{i}", opField); + i.OpCode = OpCodes.Call; + i.Operand = replacement; + //Log.Warning($" replaced {md.Name}:{i}", opField); + } + } + + // replaces syncvar read access with the NetworkXYZ.get property calls + static void ProcessGetInstruction(SyncVarAccessLists syncVarAccessLists, MethodDefinition md, Instruction i, FieldDefinition opField) + { + // don't replace property call sites in constructors + if (md.Name == ".ctor") + return; + + // does it set a field that we replaced? + if (syncVarAccessLists.replacementGetterProperties.TryGetValue(opField, out MethodDefinition replacement)) + { + //replace with property + //Log.Warning($" replacing {md.Name}:{i}"); + i.OpCode = OpCodes.Call; + i.Operand = replacement; + //Log.Warning($" replaced {md.Name}:{i}"); + } + } + + static int ProcessLoadAddressInstruction(SyncVarAccessLists syncVarAccessLists, MethodDefinition md, Instruction instr, FieldDefinition opField, int iCount) + { + // don't replace property call sites in constructors + if (md.Name == ".ctor") + return 1; + + // does it set a field that we replaced? + if (syncVarAccessLists.replacementSetterProperties.TryGetValue(opField, out MethodDefinition replacement)) + { + // we have a replacement for this property + // is the next instruction a initobj? + Instruction nextInstr = md.Body.Instructions[iCount + 1]; + + if (nextInstr.OpCode == OpCodes.Initobj) + { + // we need to replace this code with: + // var tmp = new MyStruct(); + // this.set_Networkxxxx(tmp); + ILProcessor worker = md.Body.GetILProcessor(); + VariableDefinition tmpVariable = new VariableDefinition(opField.FieldType); + md.Body.Variables.Add(tmpVariable); + + worker.InsertBefore(instr, worker.Create(OpCodes.Ldloca, tmpVariable)); + worker.InsertBefore(instr, worker.Create(OpCodes.Initobj, opField.FieldType)); + worker.InsertBefore(instr, worker.Create(OpCodes.Ldloc, tmpVariable)); + worker.InsertBefore(instr, worker.Create(OpCodes.Call, replacement)); + + worker.Remove(instr); + worker.Remove(nextInstr); + return 4; + } + } + + return 1; + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeAccessReplacer.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeAccessReplacer.cs.meta new file mode 100644 index 0000000..e8c2500 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeAccessReplacer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d48f1ab125e9940a995603796bccc59e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeProcessor.cs new file mode 100644 index 0000000..4d0e7b8 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeProcessor.cs @@ -0,0 +1,490 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Mono.CecilX; +using Mono.CecilX.Cil; +using Mono.CecilX.Rocks; + +namespace Mirror.Weaver +{ + // Processes [SyncVar] attribute fields in NetworkBehaviour + // not static, because ILPostProcessor is multithreaded + public class SyncVarAttributeProcessor + { + // ulong = 64 bytes + const int SyncVarLimit = 64; + + AssemblyDefinition assembly; + WeaverTypes weaverTypes; + SyncVarAccessLists syncVarAccessLists; + Logger Log; + + string HookParameterMessage(string hookName, TypeReference ValueType) => + $"void {hookName}({ValueType} oldValue, {ValueType} newValue)"; + + public SyncVarAttributeProcessor(AssemblyDefinition assembly, WeaverTypes weaverTypes, SyncVarAccessLists syncVarAccessLists, Logger Log) + { + this.assembly = assembly; + this.weaverTypes = weaverTypes; + this.syncVarAccessLists = syncVarAccessLists; + this.Log = Log; + } + + // Get hook method if any + public MethodDefinition GetHookMethod(TypeDefinition td, FieldDefinition syncVar, ref bool WeavingFailed) + { + CustomAttribute syncVarAttr = syncVar.GetCustomAttribute(); + + if (syncVarAttr == null) + return null; + + string hookFunctionName = syncVarAttr.GetField("hook", null); + + if (hookFunctionName == null) + return null; + + return FindHookMethod(td, syncVar, hookFunctionName, ref WeavingFailed); + } + + // push hook from GetHookMethod() onto the stack as a new Action. + // allows for reuse without handling static/virtual cases every time. + public void GenerateNewActionFromHookMethod(FieldDefinition syncVar, ILProcessor worker, MethodDefinition hookMethod) + { + // IL_000a: ldarg.0 + // IL_000b: ldftn instance void Mirror.Examples.Tanks.Tank::ExampleHook(int32, int32) + // IL_0011: newobj instance void class [netstandard]System.Action`2::.ctor(object, native int) + + // we support static hook sand instance hooks. + if (hookMethod.IsStatic) + { + // for static hooks, we need to push 'null' first. + // we can't just push nothing. + // stack would get out of balance because we already pushed + // other stuff above. + worker.Emit(OpCodes.Ldnull); + } + else + { + // for instance hooks, we need to push 'this.' first. + worker.Emit(OpCodes.Ldarg_0); + } + + MethodReference hookMethodReference; + // if the network behaviour class is generic, we need to make the method reference generic for correct IL + if (hookMethod.DeclaringType.HasGenericParameters) + { + hookMethodReference = hookMethod.MakeHostInstanceGeneric(hookMethod.Module, hookMethod.DeclaringType.MakeGenericInstanceType(hookMethod.DeclaringType.GenericParameters.ToArray())); + } + else + { + hookMethodReference = hookMethod; + } + + // we support regular and virtual hook functions. + if (hookMethod.IsVirtual) + { + // for virtual / overwritten hooks, we need different IL. + // this is from simply testing Action = VirtualHook; in C#. + worker.Emit(OpCodes.Dup); + worker.Emit(OpCodes.Ldvirtftn, hookMethodReference); + } + else + { + worker.Emit(OpCodes.Ldftn, hookMethodReference); + } + + // call 'new Action()' constructor to convert the function to an action + // we need to make an instance of the generic Action. + // + // TODO this allocates a new 'Action' for every SyncVar hook call. + // we should allocate it once and store it somewhere in the future. + // hooks are only called on the client though, so it's not too bad for now. + TypeReference actionRef = assembly.MainModule.ImportReference(typeof(Action<,>)); + GenericInstanceType genericInstance = actionRef.MakeGenericInstanceType(syncVar.FieldType, syncVar.FieldType); + worker.Emit(OpCodes.Newobj, weaverTypes.ActionT_T.MakeHostInstanceGeneric(assembly.MainModule, genericInstance)); + } + + MethodDefinition FindHookMethod(TypeDefinition td, FieldDefinition syncVar, string hookFunctionName, ref bool WeavingFailed) + { + List methods = td.GetMethods(hookFunctionName); + + List methodsWith2Param = new List(methods.Where(m => m.Parameters.Count == 2)); + + if (methodsWith2Param.Count == 0) + { + Log.Error($"Could not find hook for '{syncVar.Name}', hook name '{hookFunctionName}'. " + + $"Method signature should be {HookParameterMessage(hookFunctionName, syncVar.FieldType)}", + syncVar); + WeavingFailed = true; + + return null; + } + + foreach (MethodDefinition method in methodsWith2Param) + { + if (MatchesParameters(syncVar, method)) + { + return method; + } + } + + Log.Error($"Wrong type for Parameter in hook for '{syncVar.Name}', hook name '{hookFunctionName}'. " + + $"Method signature should be {HookParameterMessage(hookFunctionName, syncVar.FieldType)}", + syncVar); + WeavingFailed = true; + + return null; + } + + bool MatchesParameters(FieldDefinition syncVar, MethodDefinition method) + { + // matches void onValueChange(T oldValue, T newValue) + return method.Parameters[0].ParameterType.FullName == syncVar.FieldType.FullName && + method.Parameters[1].ParameterType.FullName == syncVar.FieldType.FullName; + } + + public MethodDefinition GenerateSyncVarGetter(FieldDefinition fd, string originalName, FieldDefinition netFieldId) + { + //Create the get method + MethodDefinition get = new MethodDefinition( + $"get_Network{originalName}", MethodAttributes.Public | + MethodAttributes.SpecialName | + MethodAttributes.HideBySig, + fd.FieldType); + + ILProcessor worker = get.Body.GetILProcessor(); + + FieldReference fr; + if (fd.DeclaringType.HasGenericParameters) + { + fr = fd.MakeHostInstanceGeneric(); + } + else + { + fr = fd; + } + + FieldReference netIdFieldReference = null; + if (netFieldId != null) + { + if (netFieldId.DeclaringType.HasGenericParameters) + { + netIdFieldReference = netFieldId.MakeHostInstanceGeneric(); + } + else + { + netIdFieldReference = netFieldId; + } + } + + // [SyncVar] GameObject? + if (fd.FieldType.Is()) + { + // return this.GetSyncVarGameObject(ref field, uint netId); + // this. + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldfld, netIdFieldReference); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, fr); + worker.Emit(OpCodes.Call, weaverTypes.getSyncVarGameObjectReference); + worker.Emit(OpCodes.Ret); + } + // [SyncVar] NetworkIdentity? + else if (fd.FieldType.Is()) + { + // return this.GetSyncVarNetworkIdentity(ref field, uint netId); + // this. + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldfld, netIdFieldReference); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, fr); + worker.Emit(OpCodes.Call, weaverTypes.getSyncVarNetworkIdentityReference); + worker.Emit(OpCodes.Ret); + } + // handle both NetworkBehaviour and inheritors. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/2939 + else if (fd.FieldType.IsDerivedFrom() || fd.FieldType.Is()) + { + // return this.GetSyncVarNetworkBehaviour(ref field, uint netId); + // this. + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldfld, netIdFieldReference); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, fr); + MethodReference getFunc = weaverTypes.getSyncVarNetworkBehaviourReference.MakeGeneric(assembly.MainModule, fd.FieldType); + worker.Emit(OpCodes.Call, getFunc); + worker.Emit(OpCodes.Ret); + } + // [SyncVar] int, string, etc. + else + { + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldfld, fr); + worker.Emit(OpCodes.Ret); + } + + get.Body.Variables.Add(new VariableDefinition(fd.FieldType)); + get.Body.InitLocals = true; + get.SemanticsAttributes = MethodSemanticsAttributes.Getter; + + return get; + } + + // for [SyncVar] health, weaver generates + // + // NetworkHealth + // { + // get => health; + // set => GeneratedSyncVarSetter(...) + // } + // + // the setter used to be manually IL generated, but we moved it to C# :) + public MethodDefinition GenerateSyncVarSetter(TypeDefinition td, FieldDefinition fd, string originalName, long dirtyBit, FieldDefinition netFieldId, ref bool WeavingFailed) + { + //Create the set method + MethodDefinition set = new MethodDefinition($"set_Network{originalName}", MethodAttributes.Public | + MethodAttributes.SpecialName | + MethodAttributes.HideBySig, + weaverTypes.Import(typeof(void))); + + ILProcessor worker = set.Body.GetILProcessor(); + FieldReference fr; + if (fd.DeclaringType.HasGenericParameters) + { + fr = fd.MakeHostInstanceGeneric(); + } + else + { + fr = fd; + } + + FieldReference netIdFieldReference = null; + if (netFieldId != null) + { + if (netFieldId.DeclaringType.HasGenericParameters) + { + netIdFieldReference = netFieldId.MakeHostInstanceGeneric(); + } + else + { + netIdFieldReference = netFieldId; + } + } + + // if (!SyncVarEqual(value, ref playerData)) + Instruction endOfMethod = worker.Create(OpCodes.Nop); + + // NOTE: SyncVar...Equal functions are static. + // don't Emit Ldarg_0 aka 'this'. + + // call WeaverSyncVarSetter(T value, ref T field, ulong dirtyBit, Action OnChanged = null) + // IL_0000: ldarg.0 + // IL_0001: ldarg.1 + // IL_0002: ldarg.0 + // IL_0003: ldflda int32 Mirror.Examples.Tanks.Tank::health + // IL_0008: ldc.i4.1 + // IL_0009: conv.i8 + // IL_000a: ldnull + // IL_000b: call instance void [Mirror]Mirror.NetworkBehaviour::GeneratedSyncVarSetter(!!0, !!0&, uint64, class [netstandard]System.Action`2) + // IL_0010: ret + + // 'this.' for the call + worker.Emit(OpCodes.Ldarg_0); + + // first push 'value' + worker.Emit(OpCodes.Ldarg_1); + + // push 'ref T this.field' + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, fr); + + // push the dirty bit for this SyncVar + worker.Emit(OpCodes.Ldc_I8, dirtyBit); + + // hook? then push 'new Action(Hook)' onto stack + MethodDefinition hookMethod = GetHookMethod(td, fd, ref WeavingFailed); + if (hookMethod != null) + { + GenerateNewActionFromHookMethod(fd, worker, hookMethod); + } + // otherwise push 'null' as hook + else + { + worker.Emit(OpCodes.Ldnull); + } + + // call GeneratedSyncVarSetter. + // special cases for GameObject/NetworkIdentity/NetworkBehaviour + // passing netId too for persistence. + if (fd.FieldType.Is()) + { + // GameObject setter needs one more parameter: netId field ref + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, netIdFieldReference); + worker.Emit(OpCodes.Call, weaverTypes.generatedSyncVarSetter_GameObject); + } + else if (fd.FieldType.Is()) + { + // NetworkIdentity setter needs one more parameter: netId field ref + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, netIdFieldReference); + worker.Emit(OpCodes.Call, weaverTypes.generatedSyncVarSetter_NetworkIdentity); + } + // handle both NetworkBehaviour and inheritors. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/2939 + else if (fd.FieldType.IsDerivedFrom() || fd.FieldType.Is()) + { + // NetworkIdentity setter needs one more parameter: netId field ref + // (actually its a NetworkBehaviourSyncVar type) + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldflda, netIdFieldReference); + // make generic version of GeneratedSyncVarSetter_NetworkBehaviour + MethodReference getFunc = weaverTypes.generatedSyncVarSetter_NetworkBehaviour_T.MakeGeneric(assembly.MainModule, fd.FieldType); + worker.Emit(OpCodes.Call, getFunc); + } + else + { + // make generic version of GeneratedSyncVarSetter + MethodReference generic = weaverTypes.generatedSyncVarSetter.MakeGeneric(assembly.MainModule, fd.FieldType); + worker.Emit(OpCodes.Call, generic); + } + + worker.Append(endOfMethod); + + worker.Emit(OpCodes.Ret); + + set.Parameters.Add(new ParameterDefinition("value", ParameterAttributes.In, fd.FieldType)); + set.SemanticsAttributes = MethodSemanticsAttributes.Setter; + + return set; + } + + public void ProcessSyncVar(TypeDefinition td, FieldDefinition fd, Dictionary syncVarNetIds, long dirtyBit, ref bool WeavingFailed) + { + string originalName = fd.Name; + + // GameObject/NetworkIdentity SyncVars have a new field for netId + FieldDefinition netIdField = null; + // NetworkBehaviour has different field type than other NetworkIdentityFields + // handle both NetworkBehaviour and inheritors. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/2939 + if (fd.FieldType.IsDerivedFrom() || fd.FieldType.Is()) + { + netIdField = new FieldDefinition($"___{fd.Name}NetId", + FieldAttributes.Family, // needs to be protected for generic classes, otherwise access isn't allowed + weaverTypes.Import()); + netIdField.DeclaringType = td; + + syncVarNetIds[fd] = netIdField; + } + else if (fd.FieldType.IsNetworkIdentityField()) + { + netIdField = new FieldDefinition($"___{fd.Name}NetId", + FieldAttributes.Family, // needs to be protected for generic classes, otherwise access isn't allowed + weaverTypes.Import()); + netIdField.DeclaringType = td; + + syncVarNetIds[fd] = netIdField; + } + + MethodDefinition get = GenerateSyncVarGetter(fd, originalName, netIdField); + MethodDefinition set = GenerateSyncVarSetter(td, fd, originalName, dirtyBit, netIdField, ref WeavingFailed); + + //NOTE: is property even needed? Could just use a setter function? + //create the property + PropertyDefinition propertyDefinition = new PropertyDefinition($"Network{originalName}", PropertyAttributes.None, fd.FieldType) + { + GetMethod = get, + SetMethod = set + }; + + //add the methods and property to the type. + td.Methods.Add(get); + td.Methods.Add(set); + td.Properties.Add(propertyDefinition); + syncVarAccessLists.replacementSetterProperties[fd] = set; + + // replace getter field if GameObject/NetworkIdentity so it uses + // netId instead + // -> only for GameObjects, otherwise an int syncvar's getter would + // end up in recursion. + if (fd.FieldType.IsNetworkIdentityField()) + { + syncVarAccessLists.replacementGetterProperties[fd] = get; + } + } + + public (List syncVars, Dictionary syncVarNetIds) ProcessSyncVars(TypeDefinition td, ref bool WeavingFailed) + { + List syncVars = new List(); + Dictionary syncVarNetIds = new Dictionary(); + + // the mapping of dirtybits to sync-vars is implicit in the order of the fields here. this order is recorded in m_replacementProperties. + // start assigning syncvars at the place the base class stopped, if any + int dirtyBitCounter = syncVarAccessLists.GetSyncVarStart(td.BaseType.FullName); + + // find syncvars + foreach (FieldDefinition fd in td.Fields) + { + if (fd.HasCustomAttribute()) + { + if ((fd.Attributes & FieldAttributes.Static) != 0) + { + Log.Error($"{fd.Name} cannot be static", fd); + WeavingFailed = true; + continue; + } + + if (fd.FieldType.IsGenericParameter) + { + Log.Error($"{fd.Name} has generic type. Generic SyncVars are not supported", fd); + WeavingFailed = true; + continue; + } + + if (fd.FieldType.IsArray) + { + Log.Error($"{fd.Name} has invalid type. Use SyncLists instead of arrays", fd); + WeavingFailed = true; + continue; + } + + if (SyncObjectInitializer.ImplementsSyncObject(fd.FieldType)) + { + Log.Warning($"{fd.Name} has [SyncVar] attribute. SyncLists should not be marked with SyncVar", fd); + } + else + { + syncVars.Add(fd); + + ProcessSyncVar(td, fd, syncVarNetIds, 1L << dirtyBitCounter, ref WeavingFailed); + dirtyBitCounter += 1; + + if (dirtyBitCounter > SyncVarLimit) + { + Log.Error($"{td.Name} has > {SyncVarLimit} SyncVars. Consider refactoring your class into multiple components", td); + WeavingFailed = true; + continue; + } + } + } + } + + // add all the new SyncVar __netId fields + foreach (FieldDefinition fd in syncVarNetIds.Values) + { + td.Fields.Add(fd); + } + + // include parent class syncvars + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3457 + int parentSyncVarCount = syncVarAccessLists.GetSyncVarStart(td.BaseType.FullName); + syncVarAccessLists.SetNumSyncVars(td.FullName, parentSyncVarCount + syncVars.Count); + + return (syncVars, syncVarNetIds); + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeProcessor.cs.meta new file mode 100644 index 0000000..982f768 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/SyncVarAttributeProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f52c39bddd95d42b88f9cd554dfd9198 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Processors/TargetRpcProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/TargetRpcProcessor.cs new file mode 100644 index 0000000..cbc1e5d --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/TargetRpcProcessor.cs @@ -0,0 +1,159 @@ +using Mono.CecilX; +using Mono.CecilX.Cil; + +namespace Mirror.Weaver +{ + // Processes [TargetRpc] methods in NetworkBehaviour + public static class TargetRpcProcessor + { + // helper functions to check if the method has a NetworkConnection parameter + public static bool HasNetworkConnectionParameter(MethodDefinition md) + { + if (md.Parameters.Count > 0) + { + // we need to allow both NetworkConnection, and inheriting types. + // NetworkBehaviour.SendTargetRpc takes a NetworkConnection parameter. + // fixes https://github.com/vis2k/Mirror/issues/3290 + TypeReference type = md.Parameters[0].ParameterType; + return type.Is() || + type.IsDerivedFrom(); + } + return false; + } + + public static MethodDefinition ProcessTargetRpcInvoke(WeaverTypes weaverTypes, Readers readers, Logger Log, TypeDefinition td, MethodDefinition md, MethodDefinition rpcCallFunc, ref bool WeavingFailed) + { + string trgName = Weaver.GenerateMethodName(Weaver.InvokeRpcPrefix, md); + + MethodDefinition rpc = new MethodDefinition(trgName, MethodAttributes.Family | + MethodAttributes.Static | + MethodAttributes.HideBySig, + weaverTypes.Import(typeof(void))); + + ILProcessor worker = rpc.Body.GetILProcessor(); + Instruction label = worker.Create(OpCodes.Nop); + + NetworkBehaviourProcessor.WriteClientActiveCheck(worker, weaverTypes, md.Name, label, "TargetRPC"); + + // setup for reader + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Castclass, td); + + // NetworkConnection parameter is optional + if (HasNetworkConnectionParameter(md)) + { + // TargetRpcs are sent from server to client. + // on server, we currently support two types: + // TargetRpc(NetworkConnection) + // TargetRpc(NetworkConnectionToClient) + // however, it's always a connection to client. + // in the future, only NetworkConnectionToClient will be supported. + // explicit typing helps catch issues at compile time. + // + // on client, InvokeTargetRpc calls the original code. + // we need to fill in the NetworkConnection parameter. + // NetworkClient.connection is always a connection to server. + // + // we used to pass NetworkClient.connection as the TargetRpc parameter. + // which caused: https://github.com/MirrorNetworking/Mirror/issues/3455 + // when the parameter is defined as a NetworkConnectionToClient. + // + // a client's connection never fits into a NetworkConnectionToClient. + // we need to always pass null here. + worker.Emit(OpCodes.Ldnull); + } + + // process reader parameters and skip first one if first one is NetworkConnection + if (!NetworkBehaviourProcessor.ReadArguments(md, readers, Log, worker, RemoteCallType.TargetRpc, ref WeavingFailed)) + return null; + + // invoke actual command function + worker.Emit(OpCodes.Callvirt, rpcCallFunc); + worker.Emit(OpCodes.Ret); + + NetworkBehaviourProcessor.AddInvokeParameters(weaverTypes, rpc.Parameters); + td.Methods.Add(rpc); + return rpc; + } + + /* generates code like: + public void TargetTest (NetworkConnection conn, int param) + { + NetworkWriter writer = new NetworkWriter (); + writer.WritePackedUInt32 ((uint)param); + base.SendTargetRPCInternal (conn, typeof(class), "TargetTest", val); + } + public void CallTargetTest (NetworkConnection conn, int param) + { + // whatever the user did before + } + + or if optional: + public void TargetTest (int param) + { + NetworkWriter writer = new NetworkWriter (); + writer.WritePackedUInt32 ((uint)param); + base.SendTargetRPCInternal (null, typeof(class), "TargetTest", val); + } + public void CallTargetTest (int param) + { + // whatever the user did before + } + + Originally HLAPI put the send message code inside the Call function + and then proceeded to replace every call to TargetTest with CallTargetTest + + This method moves all the user's code into the "CallTargetRpc" method + and replaces the body of the original method with the send message code. + This way we do not need to modify the code anywhere else, and this works + correctly in dependent assemblies + + */ + public static MethodDefinition ProcessTargetRpcCall(WeaverTypes weaverTypes, Writers writers, Logger Log, TypeDefinition td, MethodDefinition md, CustomAttribute targetRpcAttr, ref bool WeavingFailed) + { + MethodDefinition rpc = MethodProcessor.SubstituteMethod(Log, td, md, ref WeavingFailed); + + ILProcessor worker = md.Body.GetILProcessor(); + + NetworkBehaviourProcessor.WriteSetupLocals(worker, weaverTypes); + + NetworkBehaviourProcessor.WriteGetWriter(worker, weaverTypes); + + // write all the arguments that the user passed to the TargetRpc call + // (skip first one if first one is NetworkConnection) + if (!NetworkBehaviourProcessor.WriteArguments(worker, writers, Log, md, RemoteCallType.TargetRpc, ref WeavingFailed)) + return null; + + // invoke SendInternal and return + // this + worker.Emit(OpCodes.Ldarg_0); + if (HasNetworkConnectionParameter(md)) + { + // connection + worker.Emit(OpCodes.Ldarg_1); + } + else + { + // null + worker.Emit(OpCodes.Ldnull); + } + // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions + worker.Emit(OpCodes.Ldstr, md.FullName); + // pass the function hash so we don't have to compute it at runtime + // otherwise each GetStableHash call requires O(N) complexity. + // noticeable for long function names: + // https://github.com/MirrorNetworking/Mirror/issues/3375 + worker.Emit(OpCodes.Ldc_I4, md.FullName.GetStableHashCode()); + // writer + worker.Emit(OpCodes.Ldloc_0); + worker.Emit(OpCodes.Ldc_I4, targetRpcAttr.GetField("channel", 0)); + worker.Emit(OpCodes.Callvirt, weaverTypes.sendTargetRpcInternal); + + NetworkBehaviourProcessor.WriteReturnWriter(worker, weaverTypes); + + worker.Emit(OpCodes.Ret); + + return rpc; + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Processors/TargetRpcProcessor.cs.meta b/Assets/Mirror/Editor/Weaver/Processors/TargetRpcProcessor.cs.meta new file mode 100644 index 0000000..0ff7cc5 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Processors/TargetRpcProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: fb3ce6c6f3f2942ae88178b86f5a8282 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Readers.cs b/Assets/Mirror/Editor/Weaver/Readers.cs new file mode 100644 index 0000000..33941d9 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Readers.cs @@ -0,0 +1,385 @@ +using System; +using System.Collections.Generic; +using Mono.CecilX; +using Mono.CecilX.Cil; +// to use Mono.CecilX.Rocks here, we need to 'override references' in the +// Unity.Mirror.CodeGen assembly definition file in the Editor, and add CecilX.Rocks. +// otherwise we get an unknown import exception. +using Mono.CecilX.Rocks; + +namespace Mirror.Weaver +{ + // not static, because ILPostProcessor is multithreaded + public class Readers + { + // Readers are only for this assembly. + // can't be used from another assembly, otherwise we will get: + // "System.ArgumentException: Member ... is declared in another module and needs to be imported" + AssemblyDefinition assembly; + WeaverTypes weaverTypes; + TypeDefinition GeneratedCodeClass; + Logger Log; + + Dictionary readFuncs = + new Dictionary(new TypeReferenceComparer()); + + public Readers(AssemblyDefinition assembly, WeaverTypes weaverTypes, TypeDefinition GeneratedCodeClass, Logger Log) + { + this.assembly = assembly; + this.weaverTypes = weaverTypes; + this.GeneratedCodeClass = GeneratedCodeClass; + this.Log = Log; + } + + internal void Register(TypeReference dataType, MethodReference methodReference) + { + if (readFuncs.ContainsKey(dataType)) + { + // TODO enable this again later. + // Reader has some obsolete functions that were renamed. + // Don't want weaver warnings for all of them. + //Log.Warning($"Registering a Read method for {dataType.FullName} when one already exists", methodReference); + } + + // we need to import type when we Initialize Readers so import here in case it is used anywhere else + TypeReference imported = assembly.MainModule.ImportReference(dataType); + readFuncs[imported] = methodReference; + } + + void RegisterReadFunc(TypeReference typeReference, MethodDefinition newReaderFunc) + { + Register(typeReference, newReaderFunc); + GeneratedCodeClass.Methods.Add(newReaderFunc); + } + + // Finds existing reader for type, if non exists trys to create one + public MethodReference GetReadFunc(TypeReference variable, ref bool WeavingFailed) + { + if (readFuncs.TryGetValue(variable, out MethodReference foundFunc)) + return foundFunc; + + TypeReference importedVariable = assembly.MainModule.ImportReference(variable); + return GenerateReader(importedVariable, ref WeavingFailed); + } + + MethodReference GenerateReader(TypeReference variableReference, ref bool WeavingFailed) + { + // Arrays are special, if we resolve them, we get the element type, + // so the following ifs might choke on it for scriptable objects + // or other objects that require a custom serializer + // thus check if it is an array and skip all the checks. + if (variableReference.IsArray) + { + if (variableReference.IsMultidimensionalArray()) + { + Log.Error($"{variableReference.Name} is an unsupported type. Multidimensional arrays are not supported", variableReference); + WeavingFailed = true; + return null; + } + + return GenerateReadCollection(variableReference, variableReference.GetElementType(), nameof(NetworkReaderExtensions.ReadArray), ref WeavingFailed); + } + + TypeDefinition variableDefinition = variableReference.Resolve(); + + // check if the type is completely invalid + if (variableDefinition == null) + { + Log.Error($"{variableReference.Name} is not a supported type", variableReference); + WeavingFailed = true; + return null; + } + else if (variableReference.IsByReference) + { + // error?? + Log.Error($"Cannot pass type {variableReference.Name} by reference", variableReference); + WeavingFailed = true; + return null; + } + + // use existing func for known types + if (variableDefinition.IsEnum) + { + return GenerateEnumReadFunc(variableReference, ref WeavingFailed); + } + else if (variableDefinition.Is(typeof(ArraySegment<>))) + { + return GenerateArraySegmentReadFunc(variableReference, ref WeavingFailed); + } + else if (variableDefinition.Is(typeof(List<>))) + { + GenericInstanceType genericInstance = (GenericInstanceType)variableReference; + TypeReference elementType = genericInstance.GenericArguments[0]; + + return GenerateReadCollection(variableReference, elementType, nameof(NetworkReaderExtensions.ReadList), ref WeavingFailed); + } + // handle both NetworkBehaviour and inheritors. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/2939 + else if (variableReference.IsDerivedFrom() || variableReference.Is()) + { + return GetNetworkBehaviourReader(variableReference); + } + + // check if reader generation is applicable on this type + if (variableDefinition.IsDerivedFrom()) + { + Log.Error($"Cannot generate reader for component type {variableReference.Name}. Use a supported type or provide a custom reader", variableReference); + WeavingFailed = true; + return null; + } + if (variableReference.Is()) + { + Log.Error($"Cannot generate reader for {variableReference.Name}. Use a supported type or provide a custom reader", variableReference); + WeavingFailed = true; + return null; + } + if (variableReference.Is()) + { + Log.Error($"Cannot generate reader for {variableReference.Name}. Use a supported type or provide a custom reader", variableReference); + WeavingFailed = true; + return null; + } + if (variableDefinition.HasGenericParameters) + { + Log.Error($"Cannot generate reader for generic variable {variableReference.Name}. Use a supported type or provide a custom reader", variableReference); + WeavingFailed = true; + return null; + } + if (variableDefinition.IsInterface) + { + Log.Error($"Cannot generate reader for interface {variableReference.Name}. Use a supported type or provide a custom reader", variableReference); + WeavingFailed = true; + return null; + } + if (variableDefinition.IsAbstract) + { + Log.Error($"Cannot generate reader for abstract class {variableReference.Name}. Use a supported type or provide a custom reader", variableReference); + WeavingFailed = true; + return null; + } + + return GenerateClassOrStructReadFunction(variableReference, ref WeavingFailed); + } + + MethodReference GetNetworkBehaviourReader(TypeReference variableReference) + { + // uses generic ReadNetworkBehaviour rather than having weaver create one for each NB + MethodReference generic = weaverTypes.readNetworkBehaviourGeneric; + + MethodReference readFunc = generic.MakeGeneric(assembly.MainModule, variableReference); + + // register function so it is added to Reader + // use Register instead of RegisterWriteFunc because this is not a generated function + Register(variableReference, readFunc); + + return readFunc; + } + + MethodDefinition GenerateEnumReadFunc(TypeReference variable, ref bool WeavingFailed) + { + MethodDefinition readerFunc = GenerateReaderFunction(variable); + + ILProcessor worker = readerFunc.Body.GetILProcessor(); + + worker.Emit(OpCodes.Ldarg_0); + + TypeReference underlyingType = variable.Resolve().GetEnumUnderlyingType(); + MethodReference underlyingFunc = GetReadFunc(underlyingType, ref WeavingFailed); + + worker.Emit(OpCodes.Call, underlyingFunc); + worker.Emit(OpCodes.Ret); + return readerFunc; + } + + MethodDefinition GenerateArraySegmentReadFunc(TypeReference variable, ref bool WeavingFailed) + { + GenericInstanceType genericInstance = (GenericInstanceType)variable; + TypeReference elementType = genericInstance.GenericArguments[0]; + + MethodDefinition readerFunc = GenerateReaderFunction(variable); + + ILProcessor worker = readerFunc.Body.GetILProcessor(); + + // $array = reader.Read<[T]>() + ArrayType arrayType = elementType.MakeArrayType(); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Call, GetReadFunc(arrayType, ref WeavingFailed)); + + // return new ArraySegment($array); + worker.Emit(OpCodes.Newobj, weaverTypes.ArraySegmentConstructorReference.MakeHostInstanceGeneric(assembly.MainModule, genericInstance)); + worker.Emit(OpCodes.Ret); + return readerFunc; + } + + MethodDefinition GenerateReaderFunction(TypeReference variable) + { + string functionName = $"_Read_{variable.FullName}"; + + // create new reader for this type + MethodDefinition readerFunc = new MethodDefinition(functionName, + MethodAttributes.Public | + MethodAttributes.Static | + MethodAttributes.HideBySig, + variable); + + readerFunc.Parameters.Add(new ParameterDefinition("reader", ParameterAttributes.None, weaverTypes.Import())); + readerFunc.Body.InitLocals = true; + RegisterReadFunc(variable, readerFunc); + + return readerFunc; + } + + MethodDefinition GenerateReadCollection(TypeReference variable, TypeReference elementType, string readerFunction, ref bool WeavingFailed) + { + MethodDefinition readerFunc = GenerateReaderFunction(variable); + // generate readers for the element + GetReadFunc(elementType, ref WeavingFailed); + + ModuleDefinition module = assembly.MainModule; + TypeReference readerExtensions = module.ImportReference(typeof(NetworkReaderExtensions)); + MethodReference listReader = Resolvers.ResolveMethod(readerExtensions, assembly, Log, readerFunction, ref WeavingFailed); + + GenericInstanceMethod methodRef = new GenericInstanceMethod(listReader); + methodRef.GenericArguments.Add(elementType); + + // generates + // return reader.ReadList(); + + ILProcessor worker = readerFunc.Body.GetILProcessor(); + worker.Emit(OpCodes.Ldarg_0); // reader + worker.Emit(OpCodes.Call, methodRef); // Read + + worker.Emit(OpCodes.Ret); + + return readerFunc; + } + + MethodDefinition GenerateClassOrStructReadFunction(TypeReference variable, ref bool WeavingFailed) + { + MethodDefinition readerFunc = GenerateReaderFunction(variable); + + // create local for return value + readerFunc.Body.Variables.Add(new VariableDefinition(variable)); + + ILProcessor worker = readerFunc.Body.GetILProcessor(); + + TypeDefinition td = variable.Resolve(); + + if (!td.IsValueType) + GenerateNullCheck(worker, ref WeavingFailed); + + CreateNew(variable, worker, td, ref WeavingFailed); + ReadAllFields(variable, worker, ref WeavingFailed); + + worker.Emit(OpCodes.Ldloc_0); + worker.Emit(OpCodes.Ret); + return readerFunc; + } + + void GenerateNullCheck(ILProcessor worker, ref bool WeavingFailed) + { + // if (!reader.ReadBoolean()) { + // return null; + // } + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Call, GetReadFunc(weaverTypes.Import(), ref WeavingFailed)); + + Instruction labelEmptyArray = worker.Create(OpCodes.Nop); + worker.Emit(OpCodes.Brtrue, labelEmptyArray); + // return null + worker.Emit(OpCodes.Ldnull); + worker.Emit(OpCodes.Ret); + worker.Append(labelEmptyArray); + } + + // Initialize the local variable with a new instance + void CreateNew(TypeReference variable, ILProcessor worker, TypeDefinition td, ref bool WeavingFailed) + { + if (variable.IsValueType) + { + // structs are created with Initobj + worker.Emit(OpCodes.Ldloca, 0); + worker.Emit(OpCodes.Initobj, variable); + } + else if (td.IsDerivedFrom()) + { + GenericInstanceMethod genericInstanceMethod = new GenericInstanceMethod(weaverTypes.ScriptableObjectCreateInstanceMethod); + genericInstanceMethod.GenericArguments.Add(variable); + worker.Emit(OpCodes.Call, genericInstanceMethod); + worker.Emit(OpCodes.Stloc_0); + } + else + { + // classes are created with their constructor + MethodDefinition ctor = Resolvers.ResolveDefaultPublicCtor(variable); + if (ctor == null) + { + Log.Error($"{variable.Name} can't be deserialized because it has no default constructor. Don't use {variable.Name} in [SyncVar]s, Rpcs, Cmds, etc.", variable); + WeavingFailed = true; + return; + } + + MethodReference ctorRef = assembly.MainModule.ImportReference(ctor); + + worker.Emit(OpCodes.Newobj, ctorRef); + worker.Emit(OpCodes.Stloc_0); + } + } + + void ReadAllFields(TypeReference variable, ILProcessor worker, ref bool WeavingFailed) + { + foreach (FieldDefinition field in variable.FindAllPublicFields()) + { + // mismatched ldloca/ldloc for struct/class combinations is invalid IL, which causes crash at runtime + OpCode opcode = variable.IsValueType ? OpCodes.Ldloca : OpCodes.Ldloc; + worker.Emit(opcode, 0); + MethodReference readFunc = GetReadFunc(field.FieldType, ref WeavingFailed); + if (readFunc != null) + { + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Call, readFunc); + } + else + { + Log.Error($"{field.Name} has an unsupported type", field); + WeavingFailed = true; + } + FieldReference fieldRef = assembly.MainModule.ImportReference(field); + + worker.Emit(OpCodes.Stfld, fieldRef); + } + } + + // Save a delegate for each one of the readers into Reader.read + internal void InitializeReaders(ILProcessor worker) + { + ModuleDefinition module = assembly.MainModule; + + TypeReference genericReaderClassRef = module.ImportReference(typeof(Reader<>)); + + System.Reflection.FieldInfo fieldInfo = typeof(Reader<>).GetField(nameof(Reader.read)); + FieldReference fieldRef = module.ImportReference(fieldInfo); + TypeReference networkReaderRef = module.ImportReference(typeof(NetworkReader)); + TypeReference funcRef = module.ImportReference(typeof(Func<,>)); + MethodReference funcConstructorRef = module.ImportReference(typeof(Func<,>).GetConstructors()[0]); + + foreach (KeyValuePair kvp in readFuncs) + { + TypeReference targetType = kvp.Key; + MethodReference readFunc = kvp.Value; + + // create a Func delegate + worker.Emit(OpCodes.Ldnull); + worker.Emit(OpCodes.Ldftn, readFunc); + GenericInstanceType funcGenericInstance = funcRef.MakeGenericInstanceType(networkReaderRef, targetType); + MethodReference funcConstructorInstance = funcConstructorRef.MakeHostInstanceGeneric(assembly.MainModule, funcGenericInstance); + worker.Emit(OpCodes.Newobj, funcConstructorInstance); + + // save it in Reader.read + GenericInstanceType genericInstance = genericReaderClassRef.MakeGenericInstanceType(targetType); + FieldReference specializedField = fieldRef.SpecializeField(assembly.MainModule, genericInstance); + worker.Emit(OpCodes.Stsfld, specializedField); + } + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Readers.cs.meta b/Assets/Mirror/Editor/Weaver/Readers.cs.meta new file mode 100644 index 0000000..838ff59 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Readers.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: be40277098a024539bf63d0205cae824 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Resolvers.cs b/Assets/Mirror/Editor/Weaver/Resolvers.cs new file mode 100644 index 0000000..a9d551b --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Resolvers.cs @@ -0,0 +1,94 @@ +// all the resolve functions for the weaver +// NOTE: these functions should be made extensions, but right now they still +// make heavy use of Weaver.fail and we'd have to check each one's return +// value for null otherwise. +// (original FieldType.Resolve returns null if not found too, so +// exceptions would be a bit inconsistent here) +using Mono.CecilX; + +namespace Mirror.Weaver +{ + public static class Resolvers + { + public static MethodReference ResolveMethod(TypeReference tr, AssemblyDefinition assembly, Logger Log, string name, ref bool WeavingFailed) + { + if (tr == null) + { + Log.Error($"Cannot resolve method {name} without a class"); + WeavingFailed = true; + return null; + } + MethodReference method = ResolveMethod(tr, assembly, Log, m => m.Name == name, ref WeavingFailed); + if (method == null) + { + Log.Error($"Method not found with name {name} in type {tr.Name}", tr); + WeavingFailed = true; + } + return method; + } + + public static MethodReference ResolveMethod(TypeReference t, AssemblyDefinition assembly, Logger Log, System.Func predicate, ref bool WeavingFailed) + { + foreach (MethodDefinition methodRef in t.Resolve().Methods) + { + if (predicate(methodRef)) + { + return assembly.MainModule.ImportReference(methodRef); + } + } + + Log.Error($"Method not found in type {t.Name}", t); + WeavingFailed = true; + return null; + } + + public static MethodReference TryResolveMethodInParents(TypeReference tr, AssemblyDefinition assembly, string name) + { + if (tr == null) + { + return null; + } + foreach (MethodDefinition methodDef in tr.Resolve().Methods) + { + if (methodDef.Name == name) + { + MethodReference methodRef = methodDef; + if (tr.IsGenericInstance) + { + methodRef = methodRef.MakeHostInstanceGeneric(tr.Module, (GenericInstanceType)tr); + } + return assembly.MainModule.ImportReference(methodRef); + } + } + + // Could not find the method in this class, try the parent + return TryResolveMethodInParents(tr.Resolve().BaseType.ApplyGenericParameters(tr), assembly, name); + } + + public static MethodDefinition ResolveDefaultPublicCtor(TypeReference variable) + { + foreach (MethodDefinition methodRef in variable.Resolve().Methods) + { + if (methodRef.Name == ".ctor" && + methodRef.Resolve().IsPublic && + methodRef.Parameters.Count == 0) + { + return methodRef; + } + } + return null; + } + + public static MethodReference ResolveProperty(TypeReference tr, AssemblyDefinition assembly, string name) + { + foreach (PropertyDefinition pd in tr.Resolve().Properties) + { + if (pd.Name == name) + { + return assembly.MainModule.ImportReference(pd.GetMethod); + } + } + return null; + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Resolvers.cs.meta b/Assets/Mirror/Editor/Weaver/Resolvers.cs.meta new file mode 100644 index 0000000..f4f6602 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Resolvers.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 3039a59c76aec43c797ad66930430367 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/SyncVarAccessLists.cs b/Assets/Mirror/Editor/Weaver/SyncVarAccessLists.cs new file mode 100644 index 0000000..fa7a682 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/SyncVarAccessLists.cs @@ -0,0 +1,32 @@ +// tracks SyncVar read/write access when processing NetworkBehaviour, +// to later be replaced by SyncVarAccessReplacer. +using System.Collections.Generic; +using Mono.CecilX; + +namespace Mirror.Weaver +{ + // This data is flushed each time - if we are run multiple times in the same process/domain + public class SyncVarAccessLists + { + // setter functions that replace [SyncVar] member variable references. dict + public Dictionary replacementSetterProperties = + new Dictionary(); + + // getter functions that replace [SyncVar] member variable references. dict + public Dictionary replacementGetterProperties = + new Dictionary(); + + // amount of SyncVars per class. dict + // necessary for SyncVar dirty bits, where inheriting classes start + // their dirty bits at base class SyncVar amount. + public Dictionary numSyncVars = new Dictionary(); + + public int GetSyncVarStart(string className) => + numSyncVars.TryGetValue(className, out int value) ? value : 0; + + public void SetNumSyncVars(string className, int num) + { + numSyncVars[className] = num; + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/SyncVarAccessLists.cs.meta b/Assets/Mirror/Editor/Weaver/SyncVarAccessLists.cs.meta new file mode 100644 index 0000000..9a4da44 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/SyncVarAccessLists.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 6905230c3c4c4e158760065a93380e83 +timeCreated: 1629348618 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/TypeReferenceComparer.cs b/Assets/Mirror/Editor/Weaver/TypeReferenceComparer.cs new file mode 100644 index 0000000..e3c31d5 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/TypeReferenceComparer.cs @@ -0,0 +1,15 @@ +using System.Collections.Generic; +using Mono.CecilX; + +namespace Mirror.Weaver +{ + // Compares TypeReference using FullName + public class TypeReferenceComparer : IEqualityComparer + { + public bool Equals(TypeReference x, TypeReference y) => + x.FullName == y.FullName; + + public int GetHashCode(TypeReference obj) => + obj.FullName.GetHashCode(); + } +} diff --git a/Assets/Mirror/Editor/Weaver/TypeReferenceComparer.cs.meta b/Assets/Mirror/Editor/Weaver/TypeReferenceComparer.cs.meta new file mode 100644 index 0000000..890b4dc --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/TypeReferenceComparer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 55eb9eb8794946f4da7ad39788c9920b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Unity.Mirror.CodeGen.asmdef b/Assets/Mirror/Editor/Weaver/Unity.Mirror.CodeGen.asmdef new file mode 100644 index 0000000..987382c --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Unity.Mirror.CodeGen.asmdef @@ -0,0 +1,21 @@ +{ + "name": "Unity.Mirror.CodeGen", + "rootNamespace": "", + "references": [ + "GUID:30817c1a0e6d646d99c048fc403f5979" + ], + "includePlatforms": [ + "Editor" + ], + "excludePlatforms": [], + "allowUnsafeCode": true, + "overrideReferences": true, + "precompiledReferences": [ + "Mono.CecilX.dll", + "Mono.CecilX.Rocks.dll" + ], + "autoReferenced": false, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/Unity.Mirror.CodeGen.asmdef.meta b/Assets/Mirror/Editor/Weaver/Unity.Mirror.CodeGen.asmdef.meta new file mode 100644 index 0000000..b65a0cd --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Unity.Mirror.CodeGen.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 1d0b9d21c3ff546a4aa32399dfd33474 +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/Weaver.cs b/Assets/Mirror/Editor/Weaver/Weaver.cs new file mode 100644 index 0000000..4bff720 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Weaver.cs @@ -0,0 +1,269 @@ +using System; +using System.Collections.Generic; +using System.Diagnostics; +using Mono.CecilX; +using Mono.CecilX.Cil; +using Mono.CecilX.Rocks; + +namespace Mirror.Weaver +{ + // not static, because ILPostProcessor is multithreaded + internal class Weaver + { + public const string InvokeRpcPrefix = "InvokeUserCode_"; + + // generated code class + public const string GeneratedCodeNamespace = "Mirror"; + public const string GeneratedCodeClassName = "GeneratedNetworkCode"; + TypeDefinition GeneratedCodeClass; + + // for resolving Mirror.dll in ReaderWriterProcessor, we need to know + // Mirror.dll name + public const string MirrorAssemblyName = "Mirror"; + + WeaverTypes weaverTypes; + SyncVarAccessLists syncVarAccessLists; + AssemblyDefinition CurrentAssembly; + Writers writers; + Readers readers; + + // in case of weaver errors, we don't stop immediately. + // we log all errors and then eventually return false if + // weaving has failed. + // this way the user can fix multiple errors at once, instead of having + // to fix -> recompile -> fix -> recompile for one error at a time. + bool WeavingFailed; + + // logger functions can be set from the outside. + // for example, Debug.Log or ILPostProcessor Diagnostics log for + // multi threaded logging. + public Logger Log; + + // remote actions now support overloads, + // -> but IL2CPP doesnt like it when two generated methods + // -> have the same signature, + // -> so, append the signature to the generated method name, + // -> to create a unique name + // Example: + // RpcTeleport(Vector3 position) -> InvokeUserCode_RpcTeleport__Vector3() + // RpcTeleport(Vector3 position, Quaternion rotation) -> InvokeUserCode_RpcTeleport__Vector3Quaternion() + // fixes https://github.com/vis2k/Mirror/issues/3060 + public static string GenerateMethodName(string initialPrefix, MethodDefinition md) + { + initialPrefix += md.Name; + + for (int i = 0; i < md.Parameters.Count; ++i) + { + // with __ so it's more obvious that this is the parameter suffix. + // otherwise RpcTest(int) => RpcTestInt(int) which is not obvious. + initialPrefix += $"__{md.Parameters[i].ParameterType.Name}"; + } + + return initialPrefix; + } + + public Weaver(Logger Log) + { + this.Log = Log; + } + + // returns 'true' if modified (=if we did anything) + bool WeaveNetworkBehavior(TypeDefinition td) + { + if (!td.IsClass) + return false; + + if (!td.IsDerivedFrom()) + { + if (td.IsDerivedFrom()) + MonoBehaviourProcessor.Process(Log, td, ref WeavingFailed); + return false; + } + + // process this and base classes from parent to child order + + List behaviourClasses = new List(); + + TypeDefinition parent = td; + while (parent != null) + { + if (parent.Is()) + { + break; + } + + try + { + behaviourClasses.Insert(0, parent); + parent = parent.BaseType.Resolve(); + } + catch (AssemblyResolutionException) + { + // this can happen for plugins. + //Console.WriteLine("AssemblyResolutionException: "+ ex.ToString()); + break; + } + } + + bool modified = false; + foreach (TypeDefinition behaviour in behaviourClasses) + { + modified |= new NetworkBehaviourProcessor(CurrentAssembly, weaverTypes, syncVarAccessLists, writers, readers, Log, behaviour).Process(ref WeavingFailed); + } + return modified; + } + + bool WeaveModule(ModuleDefinition moduleDefinition) + { + bool modified = false; + + Stopwatch watch = Stopwatch.StartNew(); + watch.Start(); + + // ModuleDefinition.Types only finds top level types. + // GetAllTypes recursively finds all nested types as well. + // fixes nested types not being weaved, for example: + // class Parent { // ModuleDefinition.Types finds this + // class Child { // .Types.NestedTypes finds this + // class GrandChild {} // only GetAllTypes finds this too + // } + // } + // note this is not about inheritance, only about type definitions. + // see test: NetworkBehaviourTests.DeeplyNested() + foreach (TypeDefinition td in moduleDefinition.GetAllTypes()) + { + if (td.IsClass && td.BaseType.CanBeResolved()) + { + modified |= WeaveNetworkBehavior(td); + modified |= ServerClientAttributeProcessor.Process(weaverTypes, Log, td, ref WeavingFailed); + } + } + + watch.Stop(); + Console.WriteLine($"Weave behaviours and messages took {watch.ElapsedMilliseconds} milliseconds"); + + return modified; + } + + void CreateGeneratedCodeClass() + { + // create "Mirror.GeneratedNetworkCode" class which holds all + // Readers and Writers + GeneratedCodeClass = new TypeDefinition(GeneratedCodeNamespace, GeneratedCodeClassName, + TypeAttributes.BeforeFieldInit | TypeAttributes.Class | TypeAttributes.AnsiClass | TypeAttributes.Public | TypeAttributes.AutoClass | TypeAttributes.Abstract | TypeAttributes.Sealed, + weaverTypes.Import()); + } + + void ToggleWeaverFuse() + { + // // find Weaved() function + MethodDefinition func = weaverTypes.weaverFuseMethod.Resolve(); + // // change return 0 to return 1 + + ILProcessor worker = func.Body.GetILProcessor(); + func.Body.Instructions[0] = worker.Create(OpCodes.Ldc_I4_1); + } + + // Weave takes an AssemblyDefinition to be compatible with both old and + // new weavers: + // * old takes a filepath, new takes a in-memory byte[] + // * old uses DefaultAssemblyResolver with added dependencies paths, + // new uses ...? + // + // => assembly: the one we are currently weaving (MyGame.dll) + // => resolver: useful in case we need to resolve any of the assembly's + // assembly.MainModule.AssemblyReferences. + // -> we can resolve ANY of them given that the resolver + // works properly (need custom one for ILPostProcessor) + // -> IMPORTANT: .Resolve() takes an AssemblyNameReference. + // those from assembly.MainModule.AssemblyReferences are + // guaranteed to be resolve-able. + // Parsing from a string for Library/.../Mirror.dll + // would not be guaranteed to be resolve-able because + // for ILPostProcessor we can't assume where Mirror.dll + // is etc. + public bool Weave(AssemblyDefinition assembly, IAssemblyResolver resolver, out bool modified) + { + WeavingFailed = false; + modified = false; + try + { + CurrentAssembly = assembly; + + // fix "No writer found for ..." error + // https://github.com/vis2k/Mirror/issues/2579 + // -> when restarting Unity, weaver would try to weave a DLL + // again + // -> resulting in two GeneratedNetworkCode classes (see ILSpy) + // -> the second one wouldn't have all the writer types setup + if (CurrentAssembly.MainModule.ContainsClass(GeneratedCodeNamespace, GeneratedCodeClassName)) + { + //Log.Warning($"Weaver: skipping {CurrentAssembly.Name} because already weaved"); + return true; + } + + weaverTypes = new WeaverTypes(CurrentAssembly, Log, ref WeavingFailed); + + // weaverTypes are needed for CreateGeneratedCodeClass + CreateGeneratedCodeClass(); + + // WeaverList depends on WeaverTypes setup because it uses Import + syncVarAccessLists = new SyncVarAccessLists(); + + // initialize readers & writers with this assembly. + // we need to do this in every Process() call. + // otherwise we would get + // "System.ArgumentException: Member ... is declared in another module and needs to be imported" + // errors when still using the previous module's reader/writer funcs. + writers = new Writers(CurrentAssembly, weaverTypes, GeneratedCodeClass, Log); + readers = new Readers(CurrentAssembly, weaverTypes, GeneratedCodeClass, Log); + + Stopwatch rwstopwatch = Stopwatch.StartNew(); + // Need to track modified from ReaderWriterProcessor too because it could find custom read/write functions or create functions for NetworkMessages + modified = ReaderWriterProcessor.Process(CurrentAssembly, resolver, Log, writers, readers, ref WeavingFailed); + rwstopwatch.Stop(); + Console.WriteLine($"Find all reader and writers took {rwstopwatch.ElapsedMilliseconds} milliseconds"); + + ModuleDefinition moduleDefinition = CurrentAssembly.MainModule; + Console.WriteLine($"Script Module: {moduleDefinition.Name}"); + + modified |= WeaveModule(moduleDefinition); + + if (WeavingFailed) + { + return false; + } + + if (modified) + { + SyncVarAttributeAccessReplacer.Process(Log, moduleDefinition, syncVarAccessLists); + + // add class that holds read/write functions + moduleDefinition.Types.Add(GeneratedCodeClass); + + ReaderWriterProcessor.InitializeReaderAndWriters(CurrentAssembly, weaverTypes, writers, readers, GeneratedCodeClass); + + // DO NOT WRITE here. + // CompilationFinishedHook writes to the file. + // ILPostProcessor writes to in-memory assembly. + // it depends on the caller. + //CurrentAssembly.Write(new WriterParameters{ WriteSymbols = true }); + } + + // if weaving succeeded, switch on the Weaver Fuse in Mirror.dll + if (CurrentAssembly.Name.Name == MirrorAssemblyName) + { + ToggleWeaverFuse(); + } + + return true; + } + catch (Exception e) + { + Log.Error($"Exception :{e}"); + WeavingFailed = true; + return false; + } + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Weaver.cs.meta b/Assets/Mirror/Editor/Weaver/Weaver.cs.meta new file mode 100644 index 0000000..0ea2dfe --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Weaver.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: de160f52931054064852f2afd7e7a86f +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/WeaverExceptions.cs b/Assets/Mirror/Editor/Weaver/WeaverExceptions.cs new file mode 100644 index 0000000..efedd27 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/WeaverExceptions.cs @@ -0,0 +1,26 @@ +using System; +using System.Runtime.Serialization; +using Mono.CecilX; + +namespace Mirror.Weaver +{ + [Serializable] + public abstract class WeaverException : Exception + { + public MemberReference MemberReference { get; } + + protected WeaverException(string message, MemberReference member) : base(message) + { + MemberReference = member; + } + + protected WeaverException(SerializationInfo serializationInfo, StreamingContext streamingContext) : base(serializationInfo, streamingContext) {} + } + + [Serializable] + public class GenerateWriterException : WeaverException + { + public GenerateWriterException(string message, MemberReference member) : base(message, member) {} + protected GenerateWriterException(SerializationInfo serializationInfo, StreamingContext streamingContext) : base(serializationInfo, streamingContext) {} + } +} diff --git a/Assets/Mirror/Editor/Weaver/WeaverExceptions.cs.meta b/Assets/Mirror/Editor/Weaver/WeaverExceptions.cs.meta new file mode 100644 index 0000000..68643b2 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/WeaverExceptions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8aaaf6193bad7424492677f8e81f1b30 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Weaver/WeaverTypes.cs b/Assets/Mirror/Editor/Weaver/WeaverTypes.cs new file mode 100644 index 0000000..5a988a1 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/WeaverTypes.cs @@ -0,0 +1,171 @@ +using System; +using Mono.CecilX; +using UnityEditor; +using UnityEngine; + +namespace Mirror.Weaver +{ + // not static, because ILPostProcessor is multithreaded + public class WeaverTypes + { + public MethodReference ScriptableObjectCreateInstanceMethod; + + public MethodReference NetworkBehaviourDirtyBitsReference; + public MethodReference GetWriterReference; + public MethodReference ReturnWriterReference; + + public MethodReference NetworkClientConnectionReference; + + public MethodReference RemoteCallDelegateConstructor; + + public MethodReference NetworkServerGetActive; + public MethodReference NetworkClientGetActive; + + // custom attribute types + public MethodReference InitSyncObjectReference; + + // array segment + public MethodReference ArraySegmentConstructorReference; + + // Action for SyncVar Hooks + public MethodReference ActionT_T; + + // syncvar + public MethodReference generatedSyncVarSetter; + public MethodReference generatedSyncVarSetter_GameObject; + public MethodReference generatedSyncVarSetter_NetworkIdentity; + public MethodReference generatedSyncVarSetter_NetworkBehaviour_T; + public MethodReference generatedSyncVarDeserialize; + public MethodReference generatedSyncVarDeserialize_GameObject; + public MethodReference generatedSyncVarDeserialize_NetworkIdentity; + public MethodReference generatedSyncVarDeserialize_NetworkBehaviour_T; + public MethodReference getSyncVarGameObjectReference; + public MethodReference getSyncVarNetworkIdentityReference; + public MethodReference getSyncVarNetworkBehaviourReference; + public MethodReference registerCommandReference; + public MethodReference registerRpcReference; + public MethodReference getTypeFromHandleReference; + public MethodReference logErrorReference; + public MethodReference logWarningReference; + public MethodReference sendCommandInternal; + public MethodReference sendRpcInternal; + public MethodReference sendTargetRpcInternal; + + public MethodReference readNetworkBehaviourGeneric; + + public TypeReference weaverFuseType; + public MethodReference weaverFuseMethod; + + // attributes + public TypeDefinition initializeOnLoadMethodAttribute; + public TypeDefinition runtimeInitializeOnLoadMethodAttribute; + + AssemblyDefinition assembly; + + public TypeReference Import() => Import(typeof(T)); + + public TypeReference Import(Type t) => assembly.MainModule.ImportReference(t); + + // constructor resolves the types and stores them in fields + public WeaverTypes(AssemblyDefinition assembly, Logger Log, ref bool WeavingFailed) + { + // system types + this.assembly = assembly; + + TypeReference ArraySegmentType = Import(typeof(ArraySegment<>)); + ArraySegmentConstructorReference = Resolvers.ResolveMethod(ArraySegmentType, assembly, Log, ".ctor", ref WeavingFailed); + + TypeReference ActionType = Import(typeof(Action<,>)); + ActionT_T = Resolvers.ResolveMethod(ActionType, assembly, Log, ".ctor", ref WeavingFailed); + + weaverFuseType = Import(typeof(WeaverFuse)); + weaverFuseMethod = Resolvers.ResolveMethod(weaverFuseType, assembly, Log, "Weaved", ref WeavingFailed); + + TypeReference NetworkServerType = Import(typeof(NetworkServer)); + NetworkServerGetActive = Resolvers.ResolveMethod(NetworkServerType, assembly, Log, "get_active", ref WeavingFailed); + + TypeReference NetworkClientType = Import(typeof(NetworkClient)); + NetworkClientGetActive = Resolvers.ResolveMethod(NetworkClientType, assembly, Log, "get_active", ref WeavingFailed); + NetworkClientConnectionReference = Resolvers.ResolveMethod(NetworkClientType, assembly, Log, "get_connection", ref WeavingFailed); + + TypeReference NetworkBehaviourType = Import(); + + NetworkBehaviourDirtyBitsReference = Resolvers.ResolveProperty(NetworkBehaviourType, assembly, "syncVarDirtyBits"); + + generatedSyncVarSetter = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GeneratedSyncVarSetter", ref WeavingFailed); + generatedSyncVarSetter_GameObject = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GeneratedSyncVarSetter_GameObject", ref WeavingFailed); + generatedSyncVarSetter_NetworkIdentity = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GeneratedSyncVarSetter_NetworkIdentity", ref WeavingFailed); + generatedSyncVarSetter_NetworkBehaviour_T = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GeneratedSyncVarSetter_NetworkBehaviour", ref WeavingFailed); + + generatedSyncVarDeserialize_GameObject = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GeneratedSyncVarDeserialize_GameObject", ref WeavingFailed); + generatedSyncVarDeserialize = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GeneratedSyncVarDeserialize", ref WeavingFailed); + generatedSyncVarDeserialize_NetworkIdentity = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GeneratedSyncVarDeserialize_NetworkIdentity", ref WeavingFailed); + generatedSyncVarDeserialize_NetworkBehaviour_T = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GeneratedSyncVarDeserialize_NetworkBehaviour", ref WeavingFailed); + + getSyncVarGameObjectReference = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GetSyncVarGameObject", ref WeavingFailed); + getSyncVarNetworkIdentityReference = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GetSyncVarNetworkIdentity", ref WeavingFailed); + getSyncVarNetworkBehaviourReference = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "GetSyncVarNetworkBehaviour", ref WeavingFailed); + + sendCommandInternal = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "SendCommandInternal", ref WeavingFailed); + sendRpcInternal = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "SendRPCInternal", ref WeavingFailed); + sendTargetRpcInternal = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "SendTargetRPCInternal", ref WeavingFailed); + + InitSyncObjectReference = Resolvers.ResolveMethod(NetworkBehaviourType, assembly, Log, "InitSyncObject", ref WeavingFailed); + + TypeReference RemoteProcedureCallsType = Import(typeof(RemoteCalls.RemoteProcedureCalls)); + registerCommandReference = Resolvers.ResolveMethod(RemoteProcedureCallsType, assembly, Log, "RegisterCommand", ref WeavingFailed); + registerRpcReference = Resolvers.ResolveMethod(RemoteProcedureCallsType, assembly, Log, "RegisterRpc", ref WeavingFailed); + + TypeReference RemoteCallDelegateType = Import(); + RemoteCallDelegateConstructor = Resolvers.ResolveMethod(RemoteCallDelegateType, assembly, Log, ".ctor", ref WeavingFailed); + + TypeReference ScriptableObjectType = Import(); + ScriptableObjectCreateInstanceMethod = Resolvers.ResolveMethod( + ScriptableObjectType, assembly, Log, + md => md.Name == "CreateInstance" && md.HasGenericParameters, + ref WeavingFailed); + + TypeReference unityDebug = Import(typeof(UnityEngine.Debug)); + // these have multiple methods with same name, so need to check parameters too + logErrorReference = Resolvers.ResolveMethod(unityDebug, assembly, Log, md => + md.Name == "LogError" && + md.Parameters.Count == 1 && + md.Parameters[0].ParameterType.FullName == typeof(object).FullName, + ref WeavingFailed); + + logWarningReference = Resolvers.ResolveMethod(unityDebug, assembly, Log, md => + md.Name == "LogWarning" && + md.Parameters.Count == 1 && + md.Parameters[0].ParameterType.FullName == typeof(object).FullName, + ref WeavingFailed); + + TypeReference typeType = Import(typeof(Type)); + getTypeFromHandleReference = Resolvers.ResolveMethod(typeType, assembly, Log, "GetTypeFromHandle", ref WeavingFailed); + + TypeReference NetworkWriterPoolType = Import(typeof(NetworkWriterPool)); + GetWriterReference = Resolvers.ResolveMethod(NetworkWriterPoolType, assembly, Log, "Get", ref WeavingFailed); + ReturnWriterReference = Resolvers.ResolveMethod(NetworkWriterPoolType, assembly, Log, "Return", ref WeavingFailed); + + TypeReference readerExtensions = Import(typeof(NetworkReaderExtensions)); + readNetworkBehaviourGeneric = Resolvers.ResolveMethod(readerExtensions, assembly, Log, (md => + { + return md.Name == nameof(NetworkReaderExtensions.ReadNetworkBehaviour) && + md.HasGenericParameters; + }), + ref WeavingFailed); + + // [InitializeOnLoadMethod] + // 'UnityEditor' is not available in builds. + // we can only import this attribute if we are in an Editor assembly. + if (Helpers.IsEditorAssembly(assembly)) + { + TypeReference initializeOnLoadMethodAttributeRef = Import(typeof(InitializeOnLoadMethodAttribute)); + initializeOnLoadMethodAttribute = initializeOnLoadMethodAttributeRef.Resolve(); + } + + // [RuntimeInitializeOnLoadMethod] + TypeReference runtimeInitializeOnLoadMethodAttributeRef = Import(typeof(RuntimeInitializeOnLoadMethodAttribute)); + runtimeInitializeOnLoadMethodAttribute = runtimeInitializeOnLoadMethodAttributeRef.Resolve(); + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/WeaverTypes.cs.meta b/Assets/Mirror/Editor/Weaver/WeaverTypes.cs.meta new file mode 100644 index 0000000..d71c33f --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/WeaverTypes.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 2585961bf7fe4c10a9143f4087efdf6f +timeCreated: 1596486854 \ No newline at end of file diff --git a/Assets/Mirror/Editor/Weaver/Writers.cs b/Assets/Mirror/Editor/Weaver/Writers.cs new file mode 100644 index 0000000..8311a26 --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Writers.cs @@ -0,0 +1,341 @@ +using System; +using System.Collections.Generic; +using Mono.CecilX; +using Mono.CecilX.Cil; +// to use Mono.CecilX.Rocks here, we need to 'override references' in the +// Unity.Mirror.CodeGen assembly definition file in the Editor, and add CecilX.Rocks. +// otherwise we get an unknown import exception. +using Mono.CecilX.Rocks; + +namespace Mirror.Weaver +{ + // not static, because ILPostProcessor is multithreaded + public class Writers + { + // Writers are only for this assembly. + // can't be used from another assembly, otherwise we will get: + // "System.ArgumentException: Member ... is declared in another module and needs to be imported" + AssemblyDefinition assembly; + WeaverTypes weaverTypes; + TypeDefinition GeneratedCodeClass; + Logger Log; + + Dictionary writeFuncs = + new Dictionary(new TypeReferenceComparer()); + + public Writers(AssemblyDefinition assembly, WeaverTypes weaverTypes, TypeDefinition GeneratedCodeClass, Logger Log) + { + this.assembly = assembly; + this.weaverTypes = weaverTypes; + this.GeneratedCodeClass = GeneratedCodeClass; + this.Log = Log; + } + + public void Register(TypeReference dataType, MethodReference methodReference) + { + if (writeFuncs.ContainsKey(dataType)) + { + // TODO enable this again later. + // Writer has some obsolete functions that were renamed. + // Don't want weaver warnings for all of them. + //Log.Warning($"Registering a Write method for {dataType.FullName} when one already exists", methodReference); + } + + // we need to import type when we Initialize Writers so import here in case it is used anywhere else + TypeReference imported = assembly.MainModule.ImportReference(dataType); + writeFuncs[imported] = methodReference; + } + + void RegisterWriteFunc(TypeReference typeReference, MethodDefinition newWriterFunc) + { + Register(typeReference, newWriterFunc); + GeneratedCodeClass.Methods.Add(newWriterFunc); + } + + // Finds existing writer for type, if non exists trys to create one + public MethodReference GetWriteFunc(TypeReference variable, ref bool WeavingFailed) + { + if (writeFuncs.TryGetValue(variable, out MethodReference foundFunc)) + return foundFunc; + + // this try/catch will be removed in future PR and make `GetWriteFunc` throw instead + try + { + TypeReference importedVariable = assembly.MainModule.ImportReference(variable); + return GenerateWriter(importedVariable, ref WeavingFailed); + } + catch (GenerateWriterException e) + { + Log.Error(e.Message, e.MemberReference); + WeavingFailed = true; + return null; + } + } + + //Throws GenerateWriterException when writer could not be generated for type + MethodReference GenerateWriter(TypeReference variableReference, ref bool WeavingFailed) + { + if (variableReference.IsByReference) + { + throw new GenerateWriterException($"Cannot pass {variableReference.Name} by reference", variableReference); + } + + // Arrays are special, if we resolve them, we get the element type, + // e.g. int[] resolves to int + // therefore process this before checks below + if (variableReference.IsArray) + { + if (variableReference.IsMultidimensionalArray()) + { + throw new GenerateWriterException($"{variableReference.Name} is an unsupported type. Multidimensional arrays are not supported", variableReference); + } + TypeReference elementType = variableReference.GetElementType(); + return GenerateCollectionWriter(variableReference, elementType, nameof(NetworkWriterExtensions.WriteArray), ref WeavingFailed); + } + + if (variableReference.Resolve()?.IsEnum ?? false) + { + // serialize enum as their base type + return GenerateEnumWriteFunc(variableReference, ref WeavingFailed); + } + + // check for collections + if (variableReference.Is(typeof(ArraySegment<>))) + { + GenericInstanceType genericInstance = (GenericInstanceType)variableReference; + TypeReference elementType = genericInstance.GenericArguments[0]; + + return GenerateCollectionWriter(variableReference, elementType, nameof(NetworkWriterExtensions.WriteArraySegment), ref WeavingFailed); + } + if (variableReference.Is(typeof(List<>))) + { + GenericInstanceType genericInstance = (GenericInstanceType)variableReference; + TypeReference elementType = genericInstance.GenericArguments[0]; + + return GenerateCollectionWriter(variableReference, elementType, nameof(NetworkWriterExtensions.WriteList), ref WeavingFailed); + } + + // handle both NetworkBehaviour and inheritors. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/2939 + if (variableReference.IsDerivedFrom() || variableReference.Is()) + { + return GetNetworkBehaviourWriter(variableReference); + } + + // check for invalid types + TypeDefinition variableDefinition = variableReference.Resolve(); + if (variableDefinition == null) + { + throw new GenerateWriterException($"{variableReference.Name} is not a supported type. Use a supported type or provide a custom writer", variableReference); + } + if (variableDefinition.IsDerivedFrom()) + { + throw new GenerateWriterException($"Cannot generate writer for component type {variableReference.Name}. Use a supported type or provide a custom writer", variableReference); + } + if (variableReference.Is()) + { + throw new GenerateWriterException($"Cannot generate writer for {variableReference.Name}. Use a supported type or provide a custom writer", variableReference); + } + if (variableReference.Is()) + { + throw new GenerateWriterException($"Cannot generate writer for {variableReference.Name}. Use a supported type or provide a custom writer", variableReference); + } + if (variableDefinition.HasGenericParameters) + { + throw new GenerateWriterException($"Cannot generate writer for generic type {variableReference.Name}. Use a supported type or provide a custom writer", variableReference); + } + if (variableDefinition.IsInterface) + { + throw new GenerateWriterException($"Cannot generate writer for interface {variableReference.Name}. Use a supported type or provide a custom writer", variableReference); + } + if (variableDefinition.IsAbstract) + { + throw new GenerateWriterException($"Cannot generate writer for abstract class {variableReference.Name}. Use a supported type or provide a custom writer", variableReference); + } + + // generate writer for class/struct + return GenerateClassOrStructWriterFunction(variableReference, ref WeavingFailed); + } + + MethodReference GetNetworkBehaviourWriter(TypeReference variableReference) + { + // all NetworkBehaviours can use the same write function + if (writeFuncs.TryGetValue(weaverTypes.Import(), out MethodReference func)) + { + // register function so it is added to writer + // use Register instead of RegisterWriteFunc because this is not a generated function + Register(variableReference, func); + + return func; + } + else + { + // this exception only happens if mirror is missing the WriteNetworkBehaviour method + throw new MissingMethodException($"Could not find writer for NetworkBehaviour"); + } + } + + MethodDefinition GenerateEnumWriteFunc(TypeReference variable, ref bool WeavingFailed) + { + MethodDefinition writerFunc = GenerateWriterFunc(variable); + + ILProcessor worker = writerFunc.Body.GetILProcessor(); + + MethodReference underlyingWriter = GetWriteFunc(variable.Resolve().GetEnumUnderlyingType(), ref WeavingFailed); + + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldarg_1); + worker.Emit(OpCodes.Call, underlyingWriter); + + worker.Emit(OpCodes.Ret); + return writerFunc; + } + + MethodDefinition GenerateWriterFunc(TypeReference variable) + { + string functionName = $"_Write_{variable.FullName}"; + // create new writer for this type + MethodDefinition writerFunc = new MethodDefinition(functionName, + MethodAttributes.Public | + MethodAttributes.Static | + MethodAttributes.HideBySig, + weaverTypes.Import(typeof(void))); + + writerFunc.Parameters.Add(new ParameterDefinition("writer", ParameterAttributes.None, weaverTypes.Import())); + writerFunc.Parameters.Add(new ParameterDefinition("value", ParameterAttributes.None, variable)); + writerFunc.Body.InitLocals = true; + + RegisterWriteFunc(variable, writerFunc); + return writerFunc; + } + + MethodDefinition GenerateClassOrStructWriterFunction(TypeReference variable, ref bool WeavingFailed) + { + MethodDefinition writerFunc = GenerateWriterFunc(variable); + + ILProcessor worker = writerFunc.Body.GetILProcessor(); + + if (!variable.Resolve().IsValueType) + WriteNullCheck(worker, ref WeavingFailed); + + if (!WriteAllFields(variable, worker, ref WeavingFailed)) + return null; + + worker.Emit(OpCodes.Ret); + return writerFunc; + } + + void WriteNullCheck(ILProcessor worker, ref bool WeavingFailed) + { + // if (value == null) + // { + // writer.WriteBoolean(false); + // return; + // } + // + + Instruction labelNotNull = worker.Create(OpCodes.Nop); + worker.Emit(OpCodes.Ldarg_1); + worker.Emit(OpCodes.Brtrue, labelNotNull); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldc_I4_0); + worker.Emit(OpCodes.Call, GetWriteFunc(weaverTypes.Import(), ref WeavingFailed)); + worker.Emit(OpCodes.Ret); + worker.Append(labelNotNull); + + // write.WriteBoolean(true); + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldc_I4_1); + worker.Emit(OpCodes.Call, GetWriteFunc(weaverTypes.Import(), ref WeavingFailed)); + } + + // Find all fields in type and write them + bool WriteAllFields(TypeReference variable, ILProcessor worker, ref bool WeavingFailed) + { + foreach (FieldDefinition field in variable.FindAllPublicFields()) + { + MethodReference writeFunc = GetWriteFunc(field.FieldType, ref WeavingFailed); + // need this null check till later PR when GetWriteFunc throws exception instead + if (writeFunc == null) { return false; } + + FieldReference fieldRef = assembly.MainModule.ImportReference(field); + + worker.Emit(OpCodes.Ldarg_0); + worker.Emit(OpCodes.Ldarg_1); + worker.Emit(OpCodes.Ldfld, fieldRef); + worker.Emit(OpCodes.Call, writeFunc); + } + + return true; + } + + MethodDefinition GenerateCollectionWriter(TypeReference variable, TypeReference elementType, string writerFunction, ref bool WeavingFailed) + { + + MethodDefinition writerFunc = GenerateWriterFunc(variable); + + MethodReference elementWriteFunc = GetWriteFunc(elementType, ref WeavingFailed); + MethodReference intWriterFunc = GetWriteFunc(weaverTypes.Import(), ref WeavingFailed); + + // need this null check till later PR when GetWriteFunc throws exception instead + if (elementWriteFunc == null) + { + Log.Error($"Cannot generate writer for {variable}. Use a supported type or provide a custom writer", variable); + WeavingFailed = true; + return writerFunc; + } + + ModuleDefinition module = assembly.MainModule; + TypeReference readerExtensions = module.ImportReference(typeof(NetworkWriterExtensions)); + MethodReference collectionWriter = Resolvers.ResolveMethod(readerExtensions, assembly, Log, writerFunction, ref WeavingFailed); + + GenericInstanceMethod methodRef = new GenericInstanceMethod(collectionWriter); + methodRef.GenericArguments.Add(elementType); + + // generates + // reader.WriteArray(array); + + ILProcessor worker = writerFunc.Body.GetILProcessor(); + worker.Emit(OpCodes.Ldarg_0); // writer + worker.Emit(OpCodes.Ldarg_1); // collection + + worker.Emit(OpCodes.Call, methodRef); // WriteArray + + worker.Emit(OpCodes.Ret); + + return writerFunc; + } + + // Save a delegate for each one of the writers into Writer{T}.write + internal void InitializeWriters(ILProcessor worker) + { + ModuleDefinition module = assembly.MainModule; + + TypeReference genericWriterClassRef = module.ImportReference(typeof(Writer<>)); + + System.Reflection.FieldInfo fieldInfo = typeof(Writer<>).GetField(nameof(Writer.write)); + FieldReference fieldRef = module.ImportReference(fieldInfo); + TypeReference networkWriterRef = module.ImportReference(typeof(NetworkWriter)); + TypeReference actionRef = module.ImportReference(typeof(Action<,>)); + MethodReference actionConstructorRef = module.ImportReference(typeof(Action<,>).GetConstructors()[0]); + + foreach (KeyValuePair kvp in writeFuncs) + { + TypeReference targetType = kvp.Key; + MethodReference writeFunc = kvp.Value; + + // create a Action delegate + worker.Emit(OpCodes.Ldnull); + worker.Emit(OpCodes.Ldftn, writeFunc); + GenericInstanceType actionGenericInstance = actionRef.MakeGenericInstanceType(networkWriterRef, targetType); + MethodReference actionRefInstance = actionConstructorRef.MakeHostInstanceGeneric(assembly.MainModule, actionGenericInstance); + worker.Emit(OpCodes.Newobj, actionRefInstance); + + // save it in Writer.write + GenericInstanceType genericInstance = genericWriterClassRef.MakeGenericInstanceType(targetType); + FieldReference specializedField = fieldRef.SpecializeField(assembly.MainModule, genericInstance); + worker.Emit(OpCodes.Stsfld, specializedField); + } + } + } +} diff --git a/Assets/Mirror/Editor/Weaver/Writers.cs.meta b/Assets/Mirror/Editor/Weaver/Writers.cs.meta new file mode 100644 index 0000000..3769f7f --- /dev/null +++ b/Assets/Mirror/Editor/Weaver/Writers.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a90060ad76ea044aba613080dd922709 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Editor/Welcome.cs b/Assets/Mirror/Editor/Welcome.cs new file mode 100644 index 0000000..14e57bc --- /dev/null +++ b/Assets/Mirror/Editor/Welcome.cs @@ -0,0 +1,23 @@ +// Shows either a welcome message, only once per session. +#if UNITY_EDITOR +using UnityEditor; +using UnityEngine; + +namespace Mirror +{ + static class Welcome + { + [InitializeOnLoadMethod] + static void OnInitializeOnLoad() + { + // InitializeOnLoad is called on start and after each rebuild, + // but we only want to show this once per editor session. + if (!SessionState.GetBool("MIRROR_WELCOME", false)) + { + SessionState.SetBool("MIRROR_WELCOME", true); + Debug.Log("Mirror | mirror-networking.com | discord.gg/N9QVxbM"); + } + } + } +} +#endif diff --git a/Assets/Mirror/Editor/Welcome.cs.meta b/Assets/Mirror/Editor/Welcome.cs.meta new file mode 100644 index 0000000..9062df0 --- /dev/null +++ b/Assets/Mirror/Editor/Welcome.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 180619c3887314f56bf396769c0a23ee +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Notice.txt b/Assets/Mirror/Notice.txt new file mode 100644 index 0000000..5eeaf88 --- /dev/null +++ b/Assets/Mirror/Notice.txt @@ -0,0 +1,123 @@ +This asset is governed by the Asset Store EULA; however, the following +components are governed by the licenses indicated below: + +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- + +Mirror +MIT License + +Copyright (c) 2015, Unity Technologies +Copyright (c) 2019, vis2k, Paul and Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- + +kcp2k +MIT License + +Copyright (c) 2016 limpo1989 +Copyright (c) 2020 Paul Pacheco +Copyright (c) 2020 Lymdun +Copyright (c) 2020 vis2k + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- + +Mono.Cecil +MIT License + +Copyright (c) 2008 - 2015 Jb Evain +Copyright (c) 2008 - 2011 Novell, Inc. + +https://github.com/jbevain/cecil + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- + +Telepathy +MIT License + +Copyright (c) 2018, vis2k + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- \ No newline at end of file diff --git a/Assets/Mirror/Notice.txt.meta b/Assets/Mirror/Notice.txt.meta new file mode 100644 index 0000000..3281bd8 --- /dev/null +++ b/Assets/Mirror/Notice.txt.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 1a7b49ad188074707b004e7bb8824857 +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Plugins.meta b/Assets/Mirror/Plugins.meta new file mode 100644 index 0000000..9504239 --- /dev/null +++ b/Assets/Mirror/Plugins.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 05eb4061e2eb94061b9a08c918fff99b +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Plugins/Mono.Cecil.meta b/Assets/Mirror/Plugins/Mono.Cecil.meta new file mode 100644 index 0000000..a104e2e --- /dev/null +++ b/Assets/Mirror/Plugins/Mono.Cecil.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: ce126b4e1a7d13b4c865cd92929f13c3 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Plugins/Mono.Cecil/License.txt b/Assets/Mirror/Plugins/Mono.Cecil/License.txt new file mode 100644 index 0000000..2a9b88f --- /dev/null +++ b/Assets/Mirror/Plugins/Mono.Cecil/License.txt @@ -0,0 +1,25 @@ +Copyright (c) 2008 - 2015 Jb Evain +Copyright (c) 2008 - 2011 Novell, Inc. +Copyright vis2k + +https://github.com/jbevain/cecil +https://github.com/vis2k/cecil <- X + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/Assets/Mirror/Plugins/Mono.Cecil/License.txt.meta b/Assets/Mirror/Plugins/Mono.Cecil/License.txt.meta new file mode 100644 index 0000000..9477cb6 --- /dev/null +++ b/Assets/Mirror/Plugins/Mono.Cecil/License.txt.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: ab858db5ebbb0d542a9acd197669cb5a +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Mdb.dll b/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Mdb.dll new file mode 100644 index 0000000000000000000000000000000000000000..f6815d3b41f5d04b8389ae99b07df13246c3b6da GIT binary patch literal 43520 zcmeIb3wTu3)i=J+WzL+LNkV3lOt=IH3OFPoKtKgA2m(r!n}P@`4S@_0O>$r+pctnH zZ><-+)!ORoU2C=4da1V6+Ny7DU+t@XtF;%a@@ng)+S+Pc+ghvsf4{Z&nVA6kw%_xA zp6`3U=Np)P)>?b*wbxpE?dv&bviO8cm7|n$@%`u{rM`tLKXWAgpT1Ug8s&J*~Z+~zQ*pp#`#N^H}(cy+1AR+_;@3F z*#e~&S&n+=miK=f*7lOxr!iqoRq7^CJWY*1f@>qbFX5|HwZOL4n*{1FpGHe5(D`xH zoO8*_|D~%zNy6v;hm~4N;3cKj(h+-nEL8#8ecx4T#U6Q|KxkCTFU$6UFD%1b`?II@ z1FyaTNh7|r)#wdKK8;YRHJ8t=2PV3`1b~L#f^XSp4w|bqm+c9_NL`gOKDbSgVlqdm z!;6Rk-hlo5P&Zpe)Z?8>^_-+sOsJ(~2J9a!p&tv4u`}>?yy+m@aWhFknH159L~97` zV>_AJ5U2}*Gy#;Y=e1_4qgqe{tVr6yaFBu#Na7lHP7X!_vx8BRGTReM)9>wk1F!lPB5NW&D6M>44ok)X%C1M9>PxbfS5}WIB+^Z|DE@+ukYInnl_=w6pcKkY1n01n zn>mQ3-at+6hiUk-SV}xlrnEL=fU2)9Amm}d?koj_p_{IWG>^~@NJhjpPH;A=N=E8e z)kKn!a^L)7PZ_2fN?Kh&WbUmRbP!bIu^Rd?=>-SF2q)-cH6E%#TGq4LKE4`CT3tXd z+gmm0xu_<}Y8Y3^XmE&BvyRoEook{=v^2A%pMF9$l(f2l4sWW_9c{9cZcb=0I24i# z=v8~u10f7DJ7~*6hJ7~JgTs*2_=p2PGe;C#%@*}DbAd?g_#dVb>;F@WQvB)y`bJSX zcF6*|e~};&#Aq&zFQd};GISNjl~IfSC}1$$n>iRwUB~NA2Zux8L=yqJhn96UCp}y< zKrv+@`fYW$8u>$21r+crYUGC@Ji;0^!!q>W*&{ti;M{J5lADJIJtu=d)N#DHw&;XdzlZ){uZ_#Arf z=HWt}koGQuEbFET^<&#Kq#2_v2jngT+sNJ7qK1EX$Uk93y1bz6>4_*>KrFZzd8zf- z>R%GCS}1Gr4Cjv z)LWIHSRCikd%2v#oZ1e?T(hM%XO0472S+1KUmYyMCGKS~jCh#9N7UyRgOEYMc$nWJ zGACmMOWGL>H(uQF2B>3Z37A^ya{EJEy>Wwmlkp?w^gL#3uc^(9AdJ2u!T>EIjNu}} zFfStPfDkl*aZs+Tl{jJqmg<=KHm=A|I`wT;m?4-oK=ISOJeGHug~h>>!#Nofg_p82 z%aCOc(0NYE4vwKA5x>UWwZ#NYaqUrAMljO%L8;6p*yhx)K4FzvlxVhm0CI&9><7n6 zEo@*}%*151!fN8t7SGFIT93bwG;L<9CUwr&6oP_tb3|cQ;9AVADT?}M8d1YeIKt+X zSM5b@jC>h*&AUlYb;8j0da+N@KM*>^KWvMC#y^ZG`e((zoPclvXibX zEx}qDvoi>0ukFz?@xFvnc?_{Hu;1HQZGG)t9Ydqg?=d4O#Q5$pRBkC3T$r4x3R`*= zl$hvOmJ5&RF~!DeaoqHhY_uH*{2_70p8QY5m8p}aq6^8Iq@uh=zhqC78rxo~vmJG! z)ck!ct{b#8M78}`Gtu!UA%AkDt|qc;n2)4Pm}z1@gN(MPOpUTFK`i+#UQ`cuWwCVG&DxfgT7GeWlWv5~Vts%$ zx7T#K(=t+Xw4_WQ_!MocmDwJF!ubs=7rl?EE3`lXdrV<6FJohcR$gV#m+3&UU@elk zH?lSDH4dUsYZbaBdVo88ZGjh&XRAsq3;3}=K^|7@Tv-%Gu?7QUb}Yh}ON%ha+mHvt zPZ4e`gE?n~Je*-dc;7OZ{VSw%bP3^!WiThukj~Z!VYX@r!^|Qq4m0|T*9JwVgLO&m=RVVWMoG(CiAdI;0>5T@xNOw&V{riU<14`G@f!ZbaEX?h6L z^bn@$AxzUln5Ks?O%Gw39>O$TU=);j`Fdl2?tCnJ#>T^Sk2oV-D%!Fw3m1a+03Bj5 zY+h)t!4TRs*kGgV0h(;E277=;8*H>aK(h^oH4qIq*w~moK-)Dchc7s!kkf}W_mfq_m#{XCY0GA(@yXAG;)B?3 zyEqcjXF5&+%XVsyENYJhlxPnJ=zi^}F6fD+6V|Z^MeMnygd0R53+FOp59`o{G)2oX zFooC#hRaixmsOC=#Glytz81 zGFZ^X6DiBdw4-9+@M3)O>o~DfAEuMV^Bu@6Dq!RYo&$FUpWzLB>?^u{!Z8b@aJ|aA0*`h{Ytl<-Kt0f?4fR2K#kkb?&(-gOH#vHafoW!_8 zQ()$|gJGz$0R3INzOa;+{5F&-ECJZ`pgllRX+;M8d~(gCb@b@OS}%uyb-loK%=S(r8;spVkJC5OF<=31NwV9JSCIDSbEXwW)7 z`PXPytNhFtHB!IeG~^nYf^P?2*<6ov-_rrrxG8vv_BokLU=+v$6!#Lu;W!up9yYIT z+vC)@ZDHHqsK$R^!y8Z;8!23j&| zrnyDKrr>$*KDsq@AZ>t?JdAmKBG&vY(iU>qz>^gt9a+8+<257LFt&U?e#MBs!OS5G;n& zsIoG&ZgMm&M>S0*-o{Y`x;8~HA0i4O0=@OtVv8P2W8A`WUeHym=tIUgx++d0Tv^)j zW>4l6RoXU=Ue(7$*$^&MIqE<7k3U6 zuJ7__)`5gG0Y7 zwP1mY(C_Ev&XzfcE;Ne}da!H}0&`Y_V)_P}TRvfkiy;FoU?`k`1j9Nl8<Kd;^nE}zU)iu!)1+xK;Ia-_DkrJ6$PlctKqi2F4B#eVa ze1EV+TPL__UAA6d#?F!JP__hbV$rg;wqz8GdV(iRsddK)ZFiC#=$*U-e9l??8DP1huvyG-H4)io8#3fWE8wT=YThO%|7)qtp^$(mN_HhzRh zUPNf~J|WpKtrjwgEUYU|pyEU_QLOk8o zsh&CpG1-WiZgzPXRSa8 zBYIrtGJ#?_ZJC!IV9y!P|T*+>AiBG)ue;L30c$L#{bnd=Jj z;Gh6|(0BohkRse$1_yx4Lby1ilE=)b#;%ifDRE_A8QfC_Z!Uwkl)r#P&iFu=$O7do<>Az|%@YplR3a40PHM~vyR zLN90|q!zm>UZCz(UIsnVvz;n04*_0bJBS!L5|Vdu_o{+G5iWRe7I$%X+#B0CbpdYc z9a0sEUQ)sN4*komz>U4i=EkZ>tVHuO=fL?b(W+Se+Ui)7Y^=Su7vvV8*Y-$L{#<0& zKx$2dPiD+aMv~sml!!S3Pfq9)oAb&=6v>!PK7)+#!HpyogFyJrRvX~Iec-pccwNGt zY&Bt7vE25ru8c`Q1)rrnFAwK>r^n>n&YLn6omL%_*iPtd?58yzofb72vM8}p<(F|R zDN&i8=Gy~|ns7~oW@XTYn<8d~FoVu406FGXW2oAf?W_e&4Q~RMkJ|+axdFB~8v=C^ zL}TCvhs>(j)M=V_KUUidV4(5%t7y+!@O!HYyr5G|h72JnGb!xcsIlq4RmxtjYZJ+DrW1L9CrCpS;n zBSx;3j#1pIac+KMXft}HaXBmE&-QpytykcmZHx&PR*;Fdm2hXH0|iNS!` z$3mE{4q>_~glS#~vnqjkWQ^GNCfXT9IxmP^Ue4E-3wYsJF$yvCC0xf#3~}%qvP-5p zE!fKOiktdp+5+rmoAZxqV- zrtcNT)FodG?-jc0-(kaqz1zTGZ^1(jyw*fsyb7G!%ai?D;P43WPqu_@qAe*N03_X= z9BgD9<@hsJSHSs~viv-z4(}GS6o(nN?fIbwYK_YG>d6QiCA9C(`%Csc2raRLKtJE3 zjo7rzqV3!9PuNH9J?+ETZ5Jq&_F;sOZj42ipFa$?-Bf1RuZP;DHThV( zZux3xm!lqncKhw!F7|ZV#VhRkoY=w0*LGnA^FOv5x%ae-V@H8f%@chxq`<0WY%yk* zS@!Z!%d{@LSr)d}t#_5|>VS5cz1t;Y6qakeR_ww-9eeO(x3*%}6dWrR15wihEJr;( zX`2FN-2qP#gmoXaT-VJx42uD-V3STi25dX-$y}mmlqq(7Q#n4(u4_tj9N_afh*P3b>04O0Vx3h0iaje1Ph^F0Ca;mnetPE| z#CWq6DGY*w%DE0Z7B#2nFMR}I%Id|Z2rw%t3eg~LXNe$@f)z!|9-usIDn?;`(vJ#x zZEuQvTP=rt_=SsYswEQvV2Tb0Pl^s|(J1!L(QL-y$88!EV*cgWSA9@{FvU4;q}j z7f$MF%g(Q*Oy(NR$wu(xQF*w*ZE+%4tzC>7PInzXm%bKUxZkDSV5g1y>z&{(WTbHe za5o19_pre3%{5%}e;oTkTFMB+h3E9?3P;N_nIrd_307&{0KE(?!ZS6DJKW*IcXW4f z32ccsr*OOHQb3wLcmUj>U{Z-sepTN98i7@VKKR7=%jnBoj@(_ am-K3pEI#Dm6C zW0Y$}PsYrsE{7nnFgV(HDs61Dz7L?(L8|gd1ju6tc-@|xUN7}A}Z^CXZoa1-v)Ls8vGrF)6+2ivG|YzUhsL8KqxRr zpI$Vb2LEQ-O#s#MdakND?L4 znXjYZWTy^KcMCXhAgJ+(=eYUV$U#%EWHh)6C3N{{a5Z4`E6EA|4TuxWVfE5iQMZ~Z z^;14i`4ea`SVB}37J?CmQ~qlpz~jpstcVXZ@futUYI+);P!sGr)>zxrXAgYV2(8dU zi3Zm*7Xuj^T6_S_^)pYJ9R}Y3mI9eWgZVgnnZa7H<9hjduq3#V5>eX)rnX_aHlo2z z%)8p;LG;ZO%^XdF;@9=s1mj%G?WT+`D+zU7%ol zkjJVzj?-8ifHkLM*!5g3ZIZba;<_Wq41BvVWe8POiq?p}OH|i31T6ZkS?i7x=-Kp$_jW z(CI-On!~l<#Kq3s$5i(SjC^sg7SlaDn!MwaaH0XaDjPhHUJx&!XP|f9P7u)?&S_2o zQR_0uE+uh*Snw5=yTBem*Kk`#*y#cRTrkFfg^Ua)k8dYYD*5@)zGR?pdVD*Hh{HDI zMN$FBmNZ;fhwv%#23_7tgu)a2vOuSBh5zh!F3b5PtoC3TG2h*osfT2-d^P&ug9mUvu2+HnHKRTHov$Q<` zm!lMgd-iOH;xlpLTO!#UetV;Gl1yPsAg^-PDrew2RSh zw%UUF4v=<}w!Q}}7};{)X6eTv)WiTfSG*r{Jy)}|rml4w6v=#-9MJ(9_A%Vi0Sr2B zfr%%e6MP-ACL(N5zo))|E5=I9f&W_l(+gVMkLPeMyAL9R`>7*hW)#}GOkDl6R)d*9 zmWql7i8+Q}Hw$cLt9W8onVX}2a0BesttrLO_~FA3mp=n}>Je;yYa)kE(KTh`X6@A;mG#1GvZw6Zu`xtZ74-{h-c< zGd!JxyYyp0!>!yeTM1fknBGXHx@!g7*10k-sT2YG{sSl4$bg#GD@o~RCqjo=j2)gPdfXwj zdr>)ptnlUGF<%ZL^WR6=N?#ru<8#F6wlPW9!8l*JKRSRw=1wQ~+Ecg$k#l6Kn zdM@rlJqL-c=dm92-fg&Iia`g77oI?Zst?js>`ytjh?*;6mRXjQa3}Z#T0(dw?y27YBm>M1dAN+T`V*1T?|nb4p(D6krSr!W0dD zM4{9>s=%Z$p1?n!1>Xc5->=$v0J;kvRY~XnixSd#3^MWHX~NC`TSpU~At7;7wD1!E zm_(ZkK5k6Fck%#WeQVr6!>6wmL3AQWaFSb+C?wcnNR)|bSZ3k+RmsRr&H$wc&mu`i zGOt6$$*CbUj^6r#E+4n|PRFeruZho8p#!T!#jc-$A>Q1FxcfPvL^SvXE-k632z5ke z3vL7L+UNw&A&2iz{u0;d5Uj1$37#L4TaHbwHqt~J$Qp&(UI6>#^YwCkd~rFRZt~5u z9#J)LmR?u0J&%LF&D2*qi8C;rQM@0U){(ft`?{|J%fASzXoe}w-lgGbg#TN^QwhJM z;WolA1LliNHxL1Z58?7@4^Iw0Lu4e6K1)M`j2zOL-TWU|W@H{+Gk$tFLR?uKAuzjR zgwRvn&4lylr||+-WE>`-te*QLa%MkU;uZawV*yzhudqtu)gEAZuht3B^W!ZQ`g(Eq z*y>hH)0oIf4z7bl48&yhWp&`^ZA<1mkrxdRA`ER=Z>)t+4?~@`?0bu_8bXhXSGX9X z-vDr(hv!QC;7x#;cOW(%LB?;HQAL*D2}Igk0(pQi?8UE>p6>+kOT6uls;GAi`lGMV zPt_dSH}Ezx@)0P7wL0W7;>cU!W4rI~oQJ+usV_CIxkk*@GgrJ!6~lcH+$%{&@#5wm zp`11uH$^Q7PJ1$!*Tm8_@#eNEj)g_!#nz0Myh@)4L>?e(=(?OkS?1F7PPWLC|x|w&O64rciC<`;Fu`8XqwN7L3geGJ@ zqzvZ__Gnk0KG2k~54Pr^qBnROvYT4-VD<*TK{(9c2MvN*QFd!s0?5(<{n~9>S?s(- zF}+JJhKL7&2Ds50r%g3eEk6IsH9N*6$@(s&v7sKO)Y7Vkc}?o@qN8TC0->yX7;XORplaCFzA3ye{L@W;U@78oaK+D>X$2Ws7v{LAVim%ot0W-4! zml}Lw6W`yGCkLkB3Ryh2m-0|Sem8@%lzNkoD&iAYC&d1%##0YVdT5;RAN|EOHOhgL zJoVqPGlzNVZ<2bkyOG-~@CA~Nl(Z&(eWjLbzC*!NkX}!p749A_aJ9mCDWBj zrpH7`pQDboJhe{Jo%Z#W$E(RO;Y4*A4A>~Jr;d_R-3`>??ifq`tdi*rDfLd2@Fi+d zgQpfiW)+@EqRe|!&Az8bRP4kr39N}QeOV}Tt4Ke+j?zA~311*^eAG@n4}5m=nTnK} zAnCos94n=MI)aq%2<5qI!n1}ky-{+fSCOY%D9a?>PxV^A7R^)YuHobyG4h!TPyO7d zS5H&dSEf`&lBMoVk$z5s`i~cnonA%HoCF?EwR_aC*(K$#X{L*XXF<&@c=#(L$aAIm z;rGJdA>O{Vl74u17;}evEETOFd{ko6C{I=Tgg1)khc{4@b4CAW9S0tJ5v3Rnk1|2D z@L#p6sJ8cQI* z8iUy-skwkE1$)FLHXQBAydR7vHU%qdV&4?(Ks8&%Q2QXT9azuJ6YMpV+kqMINWnf6 zC3ZMg<>ah_E<12HVW~*DS)?3+6L`w}nPBaRGGd<-Y?<05*qx%wYPC(UtmK`n3LS@6o!LCw26YO$$cdoid z{Zd)bdP{POHCJ7)o)>JC!FH)Z1pnh7X)OOra z{X4K~wIAAKuDVSyyr=3j?{@WpaQ+5E!*=yGgXwbj0&~VytA&s>7kg7+@X|dIVi-~J zTSC>U0mJ)Tj6n{j>x*l~L@o7x%|xW5>RXX6sXGAak4GMc^zWm-;#%q_lD>*`qWVh} zQ)k#$Tu=Qn&D@id^T7E~;z*=#Czc_t9YvYD604Cul~{-La{J_{qwW~_71vQWNcwu5 za6G}(M!Is4l2;B=^2)(QR$tUp&wj7?wu8#sBRMN}8ZsTtnYppSR2L;CGnw&0g)ZbJI`#J0V1K93sN z7GFX7L4qkcEj)F%Ejms;6geyEsyEVKL)n|f4`;w96V<8y*Fm`w)~y`;H_%rO_Jh81 zFaUk!;6MY@uUSl&N10CYm|iWER~*8A)z_oT2VWn_^hul2{#~r=6R-YAY}6KwfZr_D zDd{3fm82I-`h49tpsm|Lt*S?S8}N+u!$?!<$B^EYegf&Nkv~HEs`xez|EwIWMRbM! z*Is2yO;jCq&w%sdnx7#p#s7HY)%V3$Tb*6V9b54$q|?*CMVe0k3F+6;?<1Xomm$Wf z-`7?kJ$^(j(rxxv+;OVl4EHT{>2D>ADq8bKchpId5T{RF`59hO=p z7JVc<{lfoCc*c{+@f5w}LFXpavdo);bTq6R2MIF(-v9~Y@GwdP;IGxr_C0Ty#Wt#U zx4;9>)^0(pZXB_&NdIa@0rbOcrqdgk)}|1*D8=@Avf^B%D^pDWTz9U}DectyZ-DZ? z#q_sG55VsNEcVkFGmk~RM?n8^>h;mrAuTx1MwT^Vh*akdpIO71XjKtg3yU`vu?)ti zEk$e!)?%k?3}apdGt=2+c~Nzd$-5S-R9{_Tu-?Q*9|NO&eo%Sh=pH{-hHWXsj`uLX z6!Ruj?GNn9MiR81F$F`2slPefP;Q*TJ{*3AA6Ew%EajZ#C)7fNO>#c#SEwC=ovrSV zM(}3UHw^ZYdn5ewyuo%v@9;;;!(mFDt-dg7f80}S+=um@t=0=R$6(t8TPxTO^|XJl zKU!_(A`qIr8hOwkt1cC62fRB4r?tPqUR_96)nF$Jc9y}86zmd%T`t%)20LA_+YNTSVD}j8410mKpL)Px z54pSi{nTR`Q(uex8rU_HsONe9A8Ow4GwKzMsmc+50QL}<`N)gczw1xJBcH@}sPhp^ zlhjLsou}4Uy^p*@T7*+|IPc?WhPyT97iz3nvl>2G=hUVYDLFqCVToytDmz z$y98zx=ygyta}lilhv06dkk0|u*Ws0L~^Sd&PBO88(4j;Rn5Q-i0${ZKQ=Z^&6q~) z2kNxM(O3`tw_uE{{bDoJTSaV2Y^M5q5j!Auuu8PC961k*%~1;l(^8I94+wVI@Yyv- z#g0@@6gigwds{H-vMP48T032&s5||LTCBPSqh=kkCF&Z%w9KXIBh86&+1OH*p22dI z(i1yY9ilOm>yNEa>jcx~R;r5xqn>BPR;rte<<5<*R!rxzu#fi3g|QBGc3HVjb!}O>b?TdC<<_g`isd4_ zuW|sT==!=;L1XGk_l#IpT_Mda__eW9)UO14Io3RSi+_rGRWSPOM&ym0$#UnZ3nRD3dR4o|{Ocn< zexKT8^3HMYiuI}61Up+bS{<=1>K56lvNgXM%c<{b3^IFSdG)Gb=c!*|Ke$!BE!YlK zkJa5)HT+*CG^Sc@3)tfZ`%NYD4w+3U+VkhCPYHIO|6uy%*tu$xVCSH|*MU7Q7~B1=*m>#~ z8iNP_68o%LJ(p5Gr+$SKg^N^=V9?h}#4lA(a0`w$>aD4ZU!h!X@-Y%US~oU+rK&L4 zQjE}7s#=4s9u)!BC>ZOT5dVVuTM=uGU#+GdK`EE1E8KAv|T^^(CFt^U}p z>K_ZGK55O{)cAId-R>@p-==f_zpRLf%KX%F76&Jc|8xgmbLx=k?J&=dQr@|Td4diKZeQX2)+R!_5WiRbNn`2?$5QvIcMUcz@{W72s$5E$=c(^j^vCa0V+=Mk)gS++nqsim z>fUi5RPznSdGjH)!eD;n!q~&A$6(gTf%v29B7?1P&W-;-J!!B5Q2P_=C4+r$#3k`3 zl)p^Z{=E^OkN;53Fxb=)*Td4QN3$8>4}$=f2@{bjr@N6RduDoF0Xhx{yX)pBKBPT z_iFrd&3PKMen-vJnEzhg3GqKF{+K3Xen-WxfPK+mV-R(JRQDO|`pE0R9@3b)zv3PD zkIGx2%N>9i{Il9eW9qN&g|R=Yc7siFUXT4ntu11|i~m)19Vg{r-`(-|)cJzFX5ERo z`0wf(gRwRLt{yfRBkS+#7Y1Xi{9XOVVBZ_@r}+Eoz?GEwn)M}HB|cKK4Au~-Nkpwf z3^pyYZ=%ZDV6bJW{S)=pCWFnZpPv|G{oG(962~RRTdx{yg>zD3KkLs1yBE(KWvp?> z>-rckldP!*Ti~uwG+Cz^>^yf$Y^rs-!H$Y;Nldq{HrUCjfy4pUH3r*n zGisP=HLhX}JJci2U}Bc_E5X?RK9e}edPlI=tVb(%CJwg#WUxy2Zgr^ju3#_6{@Bpt z&$jH`NV8%KaHR5pO1zSZ4@!neyuXm{@A9 zI7v&{82vDDjODJ;oHZjWE0$YX!So7ng_RTRN_9hZUBwFPOoN>P>^SQp!})Y-RK-f` z)*?2cVwLq(!RSv*onYNx#HLo9U_Ea*uSyJFXvLUdzA*7}ygZUDB?YFVrE#@B7B=(biFti5)y;uPyy!CtdIsQyev zkM+F4xWetR-ZoghzY}@WIu$-z>pp9iV0y*bXDt|l9W#V;wP0uC1p4z8ebzd`UPEN{ z_?xYhHK*S&VhgZbvE20)o2}0pPR3cz`l7)YSvl)lMb4XDo{wXn?eY}-<+>6)yP7b6 z*Ac%jgfsRKesehC@!+?x6D_5yMo>b374Od6mBuXroE-4n|J_=ikEZ}fac01?_2*Gb zOs%z9_9jVtk=p7b9m@H2?qQG_Q7(ZPW)|~XbEuMFb=QWSc{cSYN)t=Gbu#~22AC~iLPio4ZlFOxO`C1blQG_jt z1Y7l>WgW3Mtg)QG+zQ=-TFyf_hjk=ET=f@;UQNFXlJO=3a`8Ssq9S5)wah&w>zLR2 zXbFtu(1+xA)OXQGT=g00DVpbJfF1QUp>N)U-XZ;BZH-MEN80fDD-xfjx@?I($3&)< z$)4p%&vK<_MWkop9tQM@O3(78XT_vv#ZAw86Lp1t({i+p6%q-$UD$Sx_}Mjn)|}vSHsO9QMuKdvVCa9v#BveYre-*i&qYPe-joyt&e+hW3$d@RfseFG@Q? zT9&CE4II;&I*PP)Ys7DiqR=|sUvwY&XJ8%4dbD9H@C1=HmTU6KntxpGQLqvBlhDV* z-pwA3c#!^Ef*o~{^kuDcx&O<($5sm?Q;%#~=V$6eU)kyqjM$DERYPw?P?sew9*z&! ziIO!Q50r=cgho^1CjE+XFi5cxht8!TDQ{ur{ zzW6y1Z+syAT8~1y$LWRd z$HR^Qr5ER#wIZiM((#h+FqGG=E?96VPJzcO!s7+56*y*7hZf;%0p(P{=Tx4FdY|@> zkTe3%#2fAq_->@Ey;em=@kx(!D!+l0k{eW0%|kd_eRsr@NE=5zjr-GF(T*4TAwoYy z=(R$bFO>O0X%IQ%C2bLDE$Zuazs4`aG}ZhCf4}725ix6paGtMjtEjTB!fDgtuzDHx zKUb;S>qc7-K>xdOho81|N&2#C8Fn;YIJvfdruDLVqIR}5&VJHbU_FQ2qrm^(=o742 zV*6aXvZmKMNp;2hk|O7V81nbv~!=(?^AOcngP>$JJiAHSM<$%kb0*2Nwq~h|Cs3Tr0DRZ=&;@Xq5p_;r)YSm#KWCxXXTU5vqE`6q&+L? z3nKGbk@86i^blw!@4eU2ViPd3vYh|{FMBh^^FmCLE88zVOP?7 z;Q!~W3z61}&#$t0SMw@sYW;K2=Wyp~)gTfYB=;WctXgXOx!S))D#VHzV#Na%_qdiF z9h2}Luy|@bL-fB)bQ@uJR9AcNSZBuTynAeN`f9EEndf74dESfTsg{=jpJu&*^bG6w zUIfpQ{0Zqf*1JeQYyB1JMb>*rFSXuBdWH1?(l1KxHP%OfZ;wfb|}LK2hlF)we3=t5YE7dk&@T>*kT(Ea~^$ z0l;%clfG8cS?Xk*#$KS()^zJQYn^qLb-s0l^>5Z!t#4WnTR*X0wf+imttd$!$U z=j@&Kzu7n1U$!5zAGM#cU$JA(G-tN6*jeRlaQdCIob#RQom-sSov%6HcYf*o#`%Xc z(rs~PxU=15?n&;&?#pf>GBGkavNm!}j5NR>d|rwx2?uQz!P7KJ{Hwv6 z$HS2}V3rzfz%F?>O{6#0vaHU1tMYBYw~8jy>~{gbn0^oG_v=1F`qU_D755@o@g&l5 zq~}&tBW+37A-yLu3hCO~Mx>u<*xjxl;Y2vJPFsDzh@n>7SnJ@~ADkUUkS5?!zRej! zIu@7>|5YL#hi4&etdNpO_l1XT%=C3gC&0tDng}1;@a-t1P4K*pH#Em0orZF@T8R>T z6LbR76VVDbX6{KyI}oG%otDW+H{w|}8~tn=(jG)D*0vZ6xmwyEa1L+wU`K^@myIXK z4o3QEJhyLQCvhm?%klJ@jr$vOk$xRfZmav$0;Kn2y=bd%Vufbo?!eJVe~SCDHqQT- zBK-wcd^XPemm^iyaY!xec%+WC8mViY2wT5}I2xgD!&8PMQD!Bc6%N$*A>{@2dvNcI zSKq&6?XpJO{%Th2X;(Vha8*j?3#x^eYd>(^z7_)nz+2bbNwl6 zr>S{CPfvDze|OLaqiE2o$tq`XPWBl>dH-16w=<;KfO(@2=sM+x0LJ5 zZC~4_dfJ4qO&zhdZ$0jmv(WUg&;c{l;`#fB*t7!#T9jQkt!<_{KG)r!HSor4f5&kv zj+lv?kh9bwi-WGMJ=xic)Fqw0+5G0t^;tX<+*bzY*9V(PTh`Orzahx=0$jd5-=FPm zZC|Pu2Yo^7yzKh!o>gjFXV2DbM~Borzq7wn*DFvL(K6oF#a-)EFC^!By4OLK^=fhF z#_si@;F8Dktw(12vN>ew(nVL6GO~SL^YNGQ^8KB;ega+i&Og3m(URpI>w~_0e+T^3 zvAIa=?Aq4Zw?0csXV1m}uG!Sv-X$K;-dLH<<8B+S`{OLhH@;Zwk7WZid2I-rTMIfvDfv56bdv|4;%Wp}QxWE3tH zb2;E0y}BMPx){4kq?gd+@^}Eggi?A5Lk07+v=VJGoSDrXo86E_E$g#7k`~Yn9r^5* ztwMv9+B|gxj5Z*e*Ff$0x%thf86+=$0Ao)U;gwbBWBJaFS=H0ow{a^0l+%{!0>^@$ z#mLZ?U9y#$tms_VlkFg`b6{`h)}H<{3M*z8)%o)_W!ImwTX6+LcPG*FOE+vl^GgkE zxv-g6cILWSs|lSw$TXi7?#8z_+L3snptEN;#zn#UGMX6>rNZ|4-TBQyUf_kD`Az)- z9lN!!zq>cPV*BRo!p^=fCA;YDmiSOi=!vPX(QsGOS2v_v)btV zrR$fG=;GbSi6OjX5Q4Zx>HY;3C8*W1VDnbY>J;6R#YK!3{n7lTd1-Dx-XmJKRruCz z-MEpxvP6TqE4%aELuhl&q_m>DznpbNXAbdj1pat%_S7JEN=XLCFia=KdKQEeP>B?Z zWH_5Cde2PG$GP54uC*}4=!v|atFlJU5r?++Gr5Ml}hR{_b_%J>C7~xfp~F-wuzj z$Zbb(O5o`QmJAPEX39D%TyrWthsaninR=)z;X}i_MAuHp9@p2cCju$FBIxgw!BC5m zx5xzKVs5!!%L*>-g!ND<4u#wfY2BSYRFcu#ktfuyRm21q_J$Rk5Qbftps~CH9|6-( zjB{E|6EX)QR+oOC4Xa}Vz%vHwl8J+S>lxYv5NREpL}btrfVLuvHBrWY8IC(P36~~t zP}2lG;CA!}r)2vyWxZaob!>%snzC#wu7~j4d)^eM}a{Tg^ig%?d^nWNg*oI@Y6>WwWPXiGgHM_Ox!yyBtJi0^V)# z)U@&?`n>KQar)ezp52%3tzDok!OSsanb(fEM+0)&lYt~xM!>>cM#-`aDt}zAM{UKI zof<8f?d+9iNBvA1J0BCRX{hI%ZY5dk`u6q|c)xY8H#;ZBBYFD-v- zuUgNA({ca{`jCicNy!5d9!ZD^BZ2n(!tSoFY+txWl(lnTb|VJVj_!QNCY?!1D;Pr} z6MdkQn;}in&eHIaSknlb37aBScbmhvYeK*9utk?*=;`iLi@Q%l%32T>dRrpCC}Egf z4V_#PB4vC-a8Af352dhw;x0#oFI{f>BEtRTAXh}X`$|YJb2_%^VORAstBA2`#u$fY zGg!^fVlpWku`#{sh36g_GD+`A)pIJ=>SlYb=V$02;>8iCn*$OnmKB!l88m@vEerA* z;ZmxIED8D25e)m{_Mk)_x(Y1O+xxIB?&hwLK^gRwa=QDl&nuyG za~q|Hlql@|ow@9a05kGtG{53#iDsqC7}X(&;VT4}VD!>^c*CO`Q%bP3MrGToP^=v7 zW(h0^)ViE%@5RnU{Jju`vN?q*a6L9I<)kCC{pDyF*vIMuScMv>T?e_rP-+NH{~zAn zhXanV;PxTtCM_2)ZyHQbcH;SG}O(*2m8MV^g z{cO-6#}!p)KgNWdlAg2|dKmVmJ#)K_ys|jJ>MNv|@S@TjsE+GH%{|*Ou4x6;*4+u_ zghU@IEYIe)b)(J9GSie9Vzi9vx;0F8v2}*B4;{SKV$(#1=~SLB(I-r^z1{u1hTGef z*}kqI#|;~YRqZm>x*m>0Di>(oO?1x{vg+2SEsX9wMVLkiV0k_qO>yFqmyTf$1awBR zALL7uaz3mgTwLIYEt?BAho0I!JDhxr`5O_dIvVmyZy)n$N-l`eC>U9?y6$ik)7b92 zXHAs>t;8sv+>OSzDBor0Wipm&x>S%VVI(LKwwWPRS7VN=IJ<@_%Zeu-y4GOyt&EI$ zbv#Zqf>ZM>B2H9jK(6lcIJw~QmTc3?jL>R{rb7)jq>^bm8`_$j;)XL%GxMr5+>&(| zf}GvV>*?H@NA6Z0g#n*V1`a>@#Jw&Tu!ORpe?~t00T%yxO2K9aOS4kY$L5 zHgKz;uw7vj^8hVu#}%8pbvapONmz0XZZKKx%F0VKNplI4fjWA4_>or&wru4E&czsv zwlNcLNa5LH*hb+fjit1lIhxrM{Vlh>xKAnuH^iCQFRzLoMpWdLc58>gjGNM$-Go+g zFPX>MuD3i}8odJ@7za{$@zUJ&oDWnWCrH{>(_grgK-HMLWSyMnd8|xqnrpc^L|Ybg z_kmA4cQ;~q&}Mi-v}3a_Bd(O-oZGvud*fE@;_1j^5w_Zq0?iBhu-Z^Z$bL{QU3W6J zEqWy*IxB8v^Z^)$a|1z)fpl2NKFLtZc2psyynmLniiTmQEYH}>F3iX(22nYCsSV1h zWsWW;yz^Mk80p<`3Jlo*ytkNt2cyX{Ty9DI^ga)Am?H-+JNJS5sBJ7Jp80ZI0kil7l zeGn#Y(P)_qG@+*xH;j7qOxGVdDv(06#=Ig@d8dK^c7Zyi^0Q#uI)pY zheE*+)!*6Omp?j-T)mmW;mTI5r?$7w%WdD>A8gEZZr-$Ag$GW>n?2zPxkiT!vzk<@T;oGK ziKZ2YS|g>{HNtFJL36~?ge*I*3O0Ahq>aWQ+}?*ij-4H__B{85OLGf)Hv{8m|K<2q zlV1F)P=Gt~jkr(WjcXQAx5^{!1HB*DPJFi^?E$?@sns7>Y7=-^ZX0Ce0Cl5$AMgP+ z75DTTQO{P9m&LF9YzEJIU|C2c$24%L?*BE(t)~1Z*U*L<$T^)gO_>K>`-&D~Ljatb z1A=DL4b-T{Vopt;U0%bNvwjj|3s5l>}y zLr=E5ZYfG*d$gFECgaLlh?m!b(ubXhr!fN9i(3uQIe>+y>>(%AnAdV`*WgWW*3MFl zu9Zl0(4}PmP<=u8?LY!m!+!@=Q`Z)@SJ>{_lS@!jFG}X2W2e}?yT`+F;Ez#0M^M3n8Du!p3)2J-B(X#vql4KphDkip9mnvAP3?3(|sv6zkHQH8HY8IJN z?I`0rQ7i5?DnS6?Pp^Vng+j+!sb%`IP+#V=Pz`<<5E;?B)N0#L&51%>jjFM{Mymz@ zg!zrpSlq8mc3P>0lFpZOneT(x%`&KMbcC`btx>+;sK`@;*C(YI7$B-qL3QHu^<`Nc zY^kix>QH@_qDX>JO)5%9exn`tlRIKw)bV|>c67uyIxjTW`7k8822X`mRaJRVDYYYs zij!;NjgD27+)Z*Qp7j!6+HykoK(1sD9~Me&!;su~&^07uxA5l=ZJNc$yc=*vtm>Y_3HNYomg zoFVDVRMe%blQWVtIZ))&dsy}!xqGog?)lU7Ze0ZQ2tz^@D@qe_^hg~AUPi64GK3XMV znXyTaMBq}A=^X@X2F`%nYNE)i^2K4vsiTuq{UrWmjEz>7cCP}~XrbAn;)PTOezF^? zqA{t+A1xA18&=0tiz=g0F(vL(R2i0PDaVqB_=q)dR^c+b%4cPRJFV17TDOxJNs=ri zG(R4-#dRm8dUbH0#1KMRJC#9Kg$I202Ab7EZ>L&}JYaBRi*CuO`f^B3GzMB~ndYY< zHsXUmLLe|MQ(dWru(P2d0?7>x3_4JJs?x(aX^=WLNlYz(d#Xl9SgJ>Iec|tcQNFTL zJKB>w7W<6=jsa|suJWLGYVbSIzsh($HTY;%)J+cl6ahZ?)acaUa}3kLpQ5$F`Lyj} zh(hasrvff|*8wFp_#Q~mY&d=y)E;AvK|e>%7%;sz#=;LfgU25h^>kyV24D0=CY)3y zW5VFekozKs)Bkc$bty`hu`2_08}nH_y&HCcksEA(C0!K z&n4MI246)*EM|i>#<2$!^wcm%?0ka(3=JREF_;>>#*aFv^_tYe7&HT#8hlGU@aULm zA~kqJsGL8#_>bHt`BdiVk}_|h?NM(fV@EW35mpy%gZ+kzrobPdZnS(KMxnB&rQA>b zZ=QbA$`LbOI^SRRqlX)Q^uUilHFyIaomB21evK3hV$Vhb{MhAlr}5ED{+?FzN!Oq0 z&gf}7YTCBH{p9y&9sKa*wSRd2dmZO}a9#Gz**#B>dg?!KzIpkp$4r0x&XX2><-t{> zT6#bFzNQNCM=qZgwPF^gH_NeH%eUrOXS#S47*Dn`p(!rjMZ?d=BC%9ddJ2YC zeO+j-^Yy@riNx_zH+2Noezi_kU9_$-qzR#IHC zf6BUHbOXYw%6HLyF`lRtR|J@zB$d@cYT59{7`pv@jFyMMB3KENs$iraYeX|u0ld`1 z1dAb>-6U0!T*GT}4F*DtE{&-z5nie==^{<8(ZqIEHXhYr(28)XW|gQ!U{;)3rr~7_ z`zjLVh?dn+)RkK7`*K~tE408z>wuLI`e1s6w#k_g85W}EFa!GdRTxqQ!;lNE6|4$I$DtxFqa&ju z38)89V6inL{Eb+6fDY$UPiRtM+j0C=fkjlxwhd7r+pbP!@E@hw2=oSc{1J_D0()sD z4(AX|hc6PfFkQmoEdn3nqrNI1dNaRKyQ3;bC!%G1)a;~AN)7i@m}p=mavY?z1S3&u zJ_bPiS&^#Ld}BCPUv$QBQH!M#Yz0b!EC~xV05jPTQe_M49j+baS2Vh*!D|sD{FlPd z9VQ2FL@Ru0bR;==J46hFv~oPz7#o5k1~tc5(b6nX-RNO_zqT|C)4<_Xww@bqtkl_9 zkPTkzBc7?(jj#?eXF(@uK6tGdG+&1_twvyw6*Jfa=x}IT1Et!f4F|uIYJ_J~gWpGa zWIe%|b?_;S*=Pq2-7$rh#-ecWIpODo8YRo4sfBoZK_)TMs<6N@(+H<0VR;L!j+r2} zOsfB&SUsUsJAIg3gRX+g@0VJyfz%Ojh>`PF$qm(*j_3na1X;MCj;E>sm8yJ7=X0iq z6|f)kFT)d8ncthO^rWJAFJ3@0OI^@yFv%xJ7~a z1TRVOQ*Eh4*#kHDjcmLsJ1=~utnuG(Z)}@7b!OvaT&B%zJZfFzf^9f0#OuJEhEyf0 zo7y^U8h!?RDqe=c?{SvNlIQEyftDKCx@5tM;sbXr=CO@K`Rn1(v8uM1#rxPjo!fcB zM(O|CKhJ#U=5v*`co|)F9=<+)72UtFq!xXESJ3fJhEf+J@8YsNa^aQeA)jNH&tLwR zv)`UNVsX>LTkc%=N^aygKB9~%$Khx`KV{3Q* zk=GlJ=sxY(ES^o~z3S~#*7J>rDS3I;DL(}d#!kWWUsLcDVHQs=P3g<_&zL%8x8`Ww zj8`6(FPz)9{{hM<^2IKr2#k$%zW?_NFZk3qKVQG}smd2&Q26;P;l>afdVQmePpOW1 zcpRapXEB3B-mS=Hc9}Ukg%sau%N5wd0Ix15U*F886HB70BfYTOMb7JOkFJ;=-WrcGp3u1)X@_ z$Mdy~dyzC-c&6eUQ2(2O^I?pouorKh7y0MQnc8}h!*kJ6J&U0aPb2w$C{Nva%D4*H zVw~HpgPbPx@%E}*7D>rhbvET!?QgF*`HKrD{Ah+ zKLuZngPcW>u~8)OGlKIx5(IQ#1d&z`hK{4#qZ^rk;%0^;d7G5mG|prc?_Biec! zB+{q+EE9c~8o8uW->}t+=ZgQd-ZSwAC4Qp=@_72W6<+Nxv;O1k=MSXP*F($g?(x0( t`yeSd7g1Dx=b#bMH?+0(R#qJFe|qwW{(B)6I=uc**Y^ME_y4m8{y*D^#|Z!c literal 0 HcmV?d00001 diff --git a/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Mdb.dll.meta b/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Mdb.dll.meta new file mode 100644 index 0000000..d5555bf --- /dev/null +++ b/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Mdb.dll.meta @@ -0,0 +1,92 @@ +fileFormatVersion: 2 +guid: a078fc7c0dc14d047a28dea9c93fd259 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 0 + isExplicitlyReferenced: 0 + platformData: + - first: + '': Any + second: + enabled: 0 + settings: + Exclude Editor: 0 + Exclude Linux: 1 + Exclude Linux64: 1 + Exclude LinuxUniversal: 1 + Exclude OSXUniversal: 1 + Exclude Win: 1 + Exclude Win64: 1 + - first: + Any: + second: + enabled: 0 + settings: {} + - first: + Editor: Editor + second: + enabled: 1 + settings: + DefaultValueInitialized: true + - first: + Facebook: Win + second: + enabled: 0 + settings: + CPU: None + - first: + Facebook: Win64 + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: Linux + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: Linux64 + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: LinuxUniversal + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: OSXUniversal + second: + enabled: 0 + settings: + CPU: x86 + - first: + Standalone: Win + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: Win64 + second: + enabled: 0 + settings: + CPU: None + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Pdb.dll b/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Pdb.dll new file mode 100644 index 0000000000000000000000000000000000000000..3b58436e37e6705aa683b65555cbb77a256c82db GIT binary patch literal 87552 zcmeFa2Y4Jswl-YT-P1D~1#2|Yj3ft1wq=hsN|u~+&N(5QU@#akV2_bZ9Ld<^U>i)v zYZha2SYSy@&KTH*B`pg}T7uW)oE8?F|9wx@v_>{?_xta?|M!2-clF@Y^`3L;)Twx? ztGkEki_THDQp&-ui zu7PA1P%98W8@{;7t^hU9y%}<=0lERa&hmU1GnVSE`Yli)R+i;Y!4-vu?PM9$lI0+w zME3#}uRsb#(Tm-S>JAY!df-y?(wlh&YF88^y0cf1E+gL6 z1WHBf9km4ggFX&hHhOd&22V|{6OC7*zw(^eyl9o1?8R;ly2;+SCNP}hxH|qkC;l|F z^ZahI4;b-3$+*KP3)NW6#gvTD>;j*R(5gk&>I5~bL8^UKmL0D_3VPzlWL&Y{g{@>Q zxUr_goE3FJ4HC8!TNv`Yv8H*^>}XCRY6q-fvW~XuK?221*}+&-PVg{yMZBdf{A&C7C= z{nEfq_W$2l$N&DO<(RM)hRbeaQ-+odNJ$OYy$N^g^#`n$flz4+$f`PsNyINKu!EUI zIB>j`9SfL)+_gUCRz>Rl>Ufk59@fPn(B+u6<3o`Oxq5sLLpn7aq_|dG8G&SWV8gPq z;yPdqLI;-0=gb{9m-4dw^$W57<^)QE(X#ybNGMyumQlF0VW2oxpsY|bv|$RsCqKP7 z-m*7ZcC2Y*wKEacv-LZA#b&hRfXLuz1|1Zl4W|m?~FN6kDvl$Xg`K2_(jWDVi>Fne93XR)L4a8 zcFTCAa;!iwo&z_7fz*pAI*y2#sP5S^5wgl?%OqTqSRg``fz%5SYsM5X5}hoaBf2RV z55hp(RB!{SXQ8D_&MmN|%v$6nx4LUEMIGeRO49)1A!eN}Sy}#uWwE|9V-Y7Y!k7;` z#(u=FvnOXjIqZ*TA!AKJ2VN3euTa=QtD&{EcWAjg1F6?o{EC)Y5Jy}Mld}l|iH3qe zd=8Vru$!FA{K4cTm~OvJ25O2mwP3#%O3nvCjs>{XJdQ32?26`kT@p<0MFVcK370_X zb(A{zN{$jqCa-~^77WHvBujHre}_gS6pdsjri4S`>`jpzbp0aQ$VpyDZE63#$;e9X zqxskG&fgb&JGmdF*{FJUI6E9dwQn-sWQjLHJIUrY<-UP(lZ$~@VSnRG?vGT^jHOE7 z$b)>cci?)8Ri1mdu)Sef3)a?9$YvNQ2?RIgW>x38R+b}uFAXn|fJ60d&SOVCiJ^qy z8kVsXa_!U?D7Ae=8HSzu66~h-fn}#Y0V9qRTwp z7S}XnrM^NcEAAP- zTryDZA<%0(6hw0({%Fpilb{jyW7@h-av4O@v|)F(->;m?npm&Z4idZEyVz5QL0-9r zk|b7`L?jS)QxC&5##^AeTR4zB0tz)n;owo|L0@%FICvEkHFjYn=%!dOGCYV3Tqs(W zv$Pc;;(FM>VcE!*pMLtuPJKrAvCJfD##$*ZuXaIJG6}`%kQ>gD36|)C4Y22KJR9C| z-4SIBua!_vtGbq*`VooJCIz3OLaj& zrl&2lv)YN}ym^S7JPHyn21nx>=ztn(?c^~Xq?xEb-&m931zVj_+ObftIYTdoh2G4I zR;9;pK&4L9Ya!zpCOPk6uto=^O_aC%xw710xv9lks6liScHL}_K!K&(&I(oq9BHW> zBMC}71*>3}WBdw?am;_%_d1{&_F9gEmsokp#7G@<6x3v}#u3~?LzVy*VsyrmDZq$7 zD=K@ch#PjxM)i+@Rt^1*V+?R8?@3)&LORye?)ALda=O%bd{qi z2JBv^M9;9l8FgKm#Ka3#_x9w);*2RF>{REv$&;ah*?kHw>DfK<#9crA8-vYT8FYW%_qslrmX@1TXz7r;<<5%D)br`ifsxh-cS zRcWWbhdh1`(#egQ@dFv>l5w79{F4k!_E7Qy5KIfP6-ZtP6p-?KYy(vw^^pA!=H^9^ zR=w$M>_R9XjdU@%ZCErM%W1=0#2)YxaxiU>+{7e$gge0AXfCmBsT$ahh;8O5P|1Oi zWfv$bMWd#_Xf@~_X+c*)3L2TK< zcoDB+D>)QN`o??y(HO=>UcFknLKNy`#jir{>MTSP%yTy}$k?sd*W}fd_Q(LqYsd-1 zK^80WWH;or_40l#n1eAql)=|g>3Wdt#NN0iyaB14VDd&>asSuaD5z$#96D~Y2Pp1cqqwj=_1^aw zb?D#IdtX~&n5ZcGUiYi7N|%|u9ri{0R)T+zCcbu;mZ9)Ku^6h0z`&;PUR-w1k-AUI z?q?pf7*_Dz%Av`h%^b#EIh!aT8$&6z;aolBn&I5aVDbSPoq*PQGZd_LgZhvN^?wlj zAzx!r)KRpn*HKk!bU!(hQjKVqH}EeXEf&I+e-{2>?5YTOyiLHYmA}sQt~vq2n6&#* z$dC^9*p?n+;6u39smB`PuIXrj)UL5Y#G~wc|fU?GV%wH z0=80IHJtVt;7>jZ8$)`w>oOK39|J*Hd=9RnWgjQ@czW5U$$?NFXhw?!xU z6r|1n$guWD&sy!zXnwSZWltaV`4jRE>4_a6y3*Md?dEmm9?j#luZGE|k;`d)1~k3} zB*&IbaXiR{u3r>4Mdg}<-RYkpj|8o7Fz5#2C8#pvJ~s?nBl#@k4bR)MQH^8ol&I+& zjbtUdY7VxQXn1TxtZ*n^%G_DVofXc~;^gzp{TDlRB(8CcvqVijZ-%;HK_x4koqPco zryxhx)%5L+7A9Y0=9hGn1(L&Iy~?Z!7pr$u>3f)v+^6F84V==3f6Di;maN2D;*(*MW*trgvpVxhuMjHp5$v_G@OC^p)A!C zgNc8-Y&-cnM0OG*Cxjd3H*twZaR8MZ#ENilIT^Yo@Y_md(^sK(^6yYgzD0uZ6v7RC zIn=^#{2idQ<#&;`liNYDCU3zdIapeU@zF2O9Wc|vHctVpR4$C$NeoCFEGKv1Qf;{= z3~IKWd=FeZ`M%H(K$9b24yCncb(0^0ProgNB}AXWNvuv{0AqVoU80?HWtHQ}r1*t+ zm=2RebiFM#1Nr&q?IQ|VeOaX2u>LqW`{zZL>$WHvDbmv9$0$jsqZ#SaAgW5 zcCm_wTkc~GT&pdJkmK5IS-4nHcb9uV_${9zL%h58$5G7Fg?Sz@c|tl*HuJ=g=fOSm z)FDq-=6Oi+*ljt?W3}b-;Yz78^+$FVYE*2Gxk!t@fhNqBr4mNwy@hz;*1 zzwo5N=o(KQ!F@Zx3!& z4TkeA^s3IZCBb^xX4X-s2W$?D26Jnma}-S5lbR^ zy6Mx}w8eWmSd7<01@*!a0UgHiV5myYX8{t-eK6)enArKs^{C}oItzE%RnecTm%W=g z+!eK(tD(8H7wu2`u$R(T!=E0WKXxaplii88Tt0D(&bY}!6zjG$va^m(8|Vjw6EZ%KVsr4>s#`V2 zNS#7|vY(kLK|t^l!dBRH)EEpY{C6oXblHV^H^URawt_T@Zt>?U*4-?J(V#?$gwDR zMp{b-O&hvEWO6;;a^efoD7KX%jyg$fn9!loHVivQV){b(tj8c(P7|D_>V{=*U3YIB zk`qV^xNX9bxs+rKTPewGtQ*v%3xS_fSa&=!m&EF{A-fLuuu2nA~|%fu~2NBSluz-A#*yGVES(#SmR$uXkNaTv1lu zk=L2Lct>6r^6ESCx{^0&$^P?=^WBW||7P<)zkBmv_;W4#!XBN#w)vkvFysA~`T%2x z>rxk7xh~-z0_T42*<9q~`(m!^Z9Yy1KallncfBO_4%l7KRg5jYw7oJL%YQj1o*v2B zxWST%7}&Vkv;JDuiJ7B~cPydZhI&VZF6|2G;l#DR9_3=)442B?PRMfO2hzFX^WBp3 z-PrkV^!(^92NeGNq!yRuANT^#s6wclU-Dva8n&>aF6J^9$C;B^z_jZw&#ywWjbpAE z#+&xg!y7N{?%75S?d(_FbD4H_Sb1X?x6o{%4a@2f8JJ4*H`e^^KXfD3lrDjN>8O$a z>t&>Cls07-&gQ;0M;#4Y*jGrKu$wL1*syIZ90lsD9p7KDW3GO4b(gfLi7`qjWC+6tevw1x>0mbXXs8VIrk-gj2%2=LXr&`WJ=Hrd| zMqgE)AGhkM50P{4Y?IhGCs^IAdBKIbS#Dp;%|*M=yTJK4IfVfm8>Fn{%}C+el<&A% z3qyRUkQk!#@f6kVYr7FPsLmMmGU9Ai=L|c{8g_JEH(LJ)_av+Z*Am`$pMop@&}S!t zo#gmK`lO8X$r(aUz(Br zEz`!g%QDhi(mLt-Se^k_!SFHdXOEh*Hq7g$>}3|zsqX@Dy|Rjc)?jP%tR>1#6d zugyqb$21ot*uOqQ|Auth!9A?idL!ZCTJ3k~bfP#dIU++M>C)sPuuwUUH{A5eAGB{` zUgP%78R=V?HvRDXjP$Kc8~1L@(7!z+eMg4Qo#}MCU5B7##!o9+m)&ez*vR9!CUiW) zbHVCAK-oP%J76{NnHP`YgoPNrJwvt1ik2M|U#+Wy`Z(%b*pzz@xxcidb@|PGVYzuM z&G(>rr!3Uqcghax+oSmuO0EDY3&~nhc92}+IDQUkWy>j>w5aT$z1!}CKbYCP>>Y1K zfe5?nao%FJ-31m_RZ3h@y_bv>soRicxv_<9OiO$Fd2Yq`vcgt5&U;T-9CF-w{+Khh z^FgsDJGOAYrg<(FQoOJiKPBBqjyef>s*wk^$!`9R6_IwbQY<>h4)RtBA?pO>$c;uE z7mWQPE?$MXf)4VeJXM5aC!Q1{S%{=A{IIMQjRknjoQi7O$6KkpS%7qCL(qz!2wxIdwOJ+2?VGQ4Fs589eiGyu zDY`Mdj>(DU7NKj>{QdYs8CAmmv)M_ygANQkMYRYdy9u2(c3%g5yN!L;fz`^6t(+3v zpSMqR8BHUecW5X?>C9p?219T~;{nF+v{N!JrunOTH}8w)=$Ml-JzH?Z70MiuCb#jr zW9g`1FR8bQ{hA1D3Dj2By5l^-BO=f{8noFu3{>OowIcEB{eM_*i*-G?LfZwd)Y%HV>yqg_ ziDN7~c`(Xem-1K#fprL3tsZN(jd#WNql@9dx;BqJ#4ZRXmk2w!Znekm!PnWA2|G*5 z=WTfMP?{W{R>D4n@5#x2rfLWxVZ09pa=Z#;cbGnKUSv7R<+SS87h5hS-r~%YXU^f4 z1T2JbXQx{MEh~3Jw!Rnx1qLSfg1Lxe$u+A9%Q40x2eE~=l6g{Oe5eHI=O}!%wz1Z+i-8Xi{w7hRu!mM zKi2EF(5tlDp2MK3blRTB1v|IZf5J76m(|VtMgcY2R;oYOg4It`R0okGK8Bn;x%tC4 z1sB3pHqOyG5(YWQ;FxA|%)rq(FkqY@cU|RQ!iiBYVyEF0xUKVGS0)<4d;;Ek5G=?9 zd!^MdA5&Drg<0e0KwDn&8@U!1G2u4xwQ~Im+|h}lV8j;k-Qyh1ItmF^+E{5^3e4IY zbB*)EIedFHwoq)=Ka?0p3r(9Mx#8Rn8LNRaGj<8*N=A8sz+%*^%S!ukpGgdP6Vpz& zMkEVEKe3lnkk{IT;!O+WwJyvAi_##Rm!bf#MyA**cq16E@c2rb7DYNamC_&KPI^@6 zv9HSrI}MlNTqU&rZN`b0kr6K-@CAJ7sqyrsAV0JC{LJF>TfO1~;rx_%xfYGR>K|<8 zd~vAdMz(&~R4<%eiHVmT4sQ*I<(0t*f|slr5q<4uvMp+g6hEO)<@#x>_75PD2p?*c-qQgu*R*W10Khljo z@+NG!uuYZb)y%{4+!Z4~`SGWpuexiN!D?Gzg1K}gyNQ@r`b!S)63#fccUub9Rg~(0u6rw2yA4>RJj)zWe zAS>AbxfTZ--ZzQbcr$jy-YJyk>YDAgI0lk<0vC$*4cUPtp1y@f+Ytx=Ao_3fuREDRU;#o*jj=o0w=HLPAv8dEqRvX`hak@y{3<6>kg0`_+ z@K821yPRL6w9JJZt7pqaxMt(i4sH=!eg}{f47e?)BazEDqGeka+k|i4xUq9_au(l! z1mDzZUW!IS@Eic6h>|TpCQ6f&(#5{Ltz5;H=2g5>j0fKWF=e%yvo)y0Uh7&mM1qTZinelVM3g=>8 zVSx=}i`{TxIFua1va@lw%|p7uCt}i=H0C{SP*<6Ux^lt(ZO@?Ka2Rfd@s|&`{v6J3kAdNA zjEByc&lMOCgW;Vwo0WuYclX)cVT)nu**s`ICK|q_k`+nM3~Z@nL?TvV@0i|P=`{=Y zzj!sR%g|ip3J1y^2SGGjECgFWx3RFvX0IUF`UL^ED_E8(Sp7%TB|a2QI(RE8Yb94e z*8Hb*4-MuyiiI(xcQ_$)%{JE@bImo^Jh|rKZMT9>$zd>BQ%S(ndwiUegHFtAxdR38 zrL_>+xl_u*eOIKDNz{Cbw%%R0jVcK2GSd>Hn_q%&>4R%iiFJG^z|C4P#ro;}mEN&= z8SyHgHlZ6)uYV&qVO9Q_W%B1%M@(M*#9#I_Ie6|r0+rw^Z=py&K3~p{k75!dB8Uk0 zBbqhoMZ`8A>Hv+=(2&oU^LIsY+tdE}vUz{+U0+>+m4_ymbGd2gK%Dob_nFf9y#`@h zj~>}=PcE`tU9}+gQUTdZ@rGz9Z+-@S0%ArFHZRzcw;oIfb+5XuhY;|ljgmvtfcqX% zlX}cU8%Kh%_!!nQw0bNr+4_=`=QMY6@gitYcG~iqs9ATa6XgmH%Q6_r^Xt3MtW9}- z?8>>)h4TtR1=)DdaXkShKF3MR?EsNnKKaR&O{-bf;SW7E%dT4#mFbo)!e^3>hEZb_VZ4sY>+%av7?7Y`SNY3mt&XpOJe@Hcuu3=8+a6@ z;^c^z8|@XxHY-$}-MkQKeNbY_ z8G|KJqA9jeC-yGIDGkeO=kO$z_a$vSR&Z<==LmEdK9Zpy5ACNNj_RUta2JYif=(4a z4#gH!r)8Y+2Au7IL*#rs&KY*hN=wiO02W_ex`22vRb}r zjTapeotZB@QVsQ7R7$O zOYNX=u)GTA1q);S2Vym9JvP0H5gg|Md_^jNF)*g6!J*?ITc%hj!^>XA$xu@y$12Fy&Sld%c@&Ysr=h zW?^TJ0Bf~e2DCMSxuXT`P4yY(P7rg)R(SDF4QuaDd{~}`e|}u>Z_ty{2v$bJrEh4l zDB(oF%t;g0vbeh`FGs)D7b0OJQCns>wc`>;BiWNYeEL;h!^FJA60Cf!*Rw);>GHMS zkOqGL6nw3Z9hPudvBWUEpydeHgv$h;WaeqTG^g0&?>`{D@PSq7ClD1$Fw{j zd;_<$!`T+*r#e#XE!i9(q_BVF4jO58oZLnu&5m#57sXm7R$JD59HxJIXRo<(5M|CB z>=Z|PP0&tp09DsCUjy}Y0Mx?tfr3`a41XwvGlECz{4zU!DVhb3P_u*4`ao8+o;Qm4 z<~WLvJ0mX66|4ZJ;re$mlH2%AvK3svo$0?Y?XG`?>6e(!TF+?E_E)6CPILr+Ld25K z3i0rn_r1EBR!TCaBuk3QEx+do8#EpIPJy0Z<|Z)5+$dp!<>Dwu2By;Ba9%FCNM_R%$H57Y1YHM+)Tg~BJGjx+pxnsc!U@^*+8Q8&+O7$p|}+{ z=o#}4k3HD)VLvnYotE3QimqN_jwK@^>{9AFEoXF)_CoQw-mRVr)`~MKSWnn1V|1VVoaIX9;vWcc{2V1^z z7-j5B^l{hAq4_INL~xJcX&94%v&ofqMIe42ugy371MwqUzU_dEs{E;uA8sqZZ6Q*B zoeXjxcx9DkS;gh|QhEc)?d0t*ul=myZA#1I@No@~AzPkcil>fgzotWXH2m`3H+Ta= zU0191O)u@W%6e=9t+u~I0Iv%y`9Xq!-EuALZspb?;12wd@0l=b)lHt&w>(Q$>)RRW zchYI*p%SlTR&B!jsP7_y_iDHE;&0o*OP2#@jF+;UP}Qna>C+Y3#m6jvU} zDZ2$n)`|{6DIH$Kn?QyeCIpFlChX8HJhS(r)}Z~dVERow@yi5_4n#i@Zs%C2)u=tz*~3; zyoHy*TX+e)h1YLFfh9jiVAfGP+zH1*dc93xiDi?RMbxjC*mSnU96Tv!D}{GoL_Ljq zFV)MEUwkmDyI(KIo-~+F>GnKKcioDS>#-y3$g0hjCAMWU#@z9Kv$*sojafOH#w83SqB zYWrHJsnhn2PBU}cw@6o=>rKG#D015V$&0`3dtNY2exT9|p3=Xx5^wXNw9_cV% zC%L+9_#Diss%`lL99qMl#_+a}Q?NyP2ukw#XL1Uf3~KjKjo$`)YE^b}DrB*Y_XGco zUvz+qe1H^7;)npRih2zERs&?olX0(?oDR|RqTrcp##iL&yjCke<7)r1*Hhxzl`Zd% zk7M7Y_yL#vJ`4)tS6t@Prx`FW-#od=nMh_Qj=<|Q2qOH#dNwZJ2fw+&B!%~_b+c)%LASMjDWM+Cr|KUZD* zy8b=L9uwzJ#<)>;0T*_GY|IhKB~->A!i8_I2e%H-3IY7!Yvc#(EPXBh@v$G?*ii`V z>i3S4jze##k;sJixa7AdxNAb6h_4Y`xocv6^uAn~=0Dt)$!Gk9P~H{g8%KI44--yfT2C zX6vnPNmY&IFr-$DVBW0Ccl(9ZQfuc>S6$MtHWE^|&RW|TQu_`joi>v6li{RCpsbL3 zZ4hZpq}iaZS`Yiz7@Mnv|E1_W+JhxtI+OZu&LBN=HudKw*fJNoEO+<_>YP8C(p4jw z{t{k=RADvKkIf>jky6gnzK!0M8&WylsWVRacly~H{ri(XH<&i(#VNgS0?X=C$=2Ho z9=hs*2I?HthjfFq^D(+FhSWw}6{vZ)-`?t<7?X8AwvVgEjCQ7k)bpr?tGbSLrnu_5 zAe&h8A2XJm>3v!54d8^-7eea?G5wo9^kEzhWFgq94VKaH>uQtwx+#cK;n9l-gAnc`DhaB%+Y=)!L8sI!}iewe9I7ty?P zjz-*T=c~iJ7IqsC8)xBPzS?gDk%Jd@h>n5H@fgWrSzf-17k1l;Urp(XiI}gJh^!FE z=gU{GO1=_RDd;VO;)42(q?Hnt5H!Rfyk-C^{xMp{$(^qr7n`N3zwdJRc2RtLUw%nE zNzfpJrU=@vhn7thRM$%*#7g+`A~eS%AEFp+UO25MN-tM)eL=|Xn$fdciLX084kQXG zqMoWn>i241Pt>p0p!%Lf{S4|?MKsu;n;VG68noR{G~J+|L^jKy!v!rc=%m@y+#86c z?~U?Ge1{s@gaXQv1|8jrXoo>7r1V8T?dK5jY^gy9iR^HLJ|D(>M;UZT8Bv=-%cXv& z8sv_q>4cRGU#iu za*aXXkD}%cKp1xFbSdw5Mpie5vO5g=&Ad!>FnY7Zcejyk9YpkyL3hJSiSKcPok{9Nv`o;42KAQK{RoKd@=^}_;WHzfh;dfp``VxrrIo%jXpl?U4+gCk zn>!8aH4vZ@;TIu8FZnbVuKD9KTFd21eF?emGoa{gMK5Zi$SAi&}LVI z1_~-O=zE*83WHVzh`JlJT2_W02A!ToSxeRT*@?8a=z=<;$p)Pw zy*bUGX@X`N)F(mBxdv5WeJSxRFz6ZS_k{+1FLl_*pyQOO2A!Bs^rAs877@J+#I@%!Aj~Qw`$=T)7})UlHUQlqGX4WYAwkmS>P(WJLxgrH{H8G)GXG zLGz^_Dh&EWtaJxrn~jRH?mdm{A(17FtWIQgMz&F8Lk!w1Xq-Xs3YuV0t(2Zd;{{DJ zvb|&^Pc}%2Y??vGifoQS3q>~Hpdvwg8?;>A0p#h@jkd9^{K1zm5@KtZ<{R4wREgB(Hk7<6bO zOMk$ia*;i5&=;~!JY~>g@$+eemdNaX-JrY0v-b_!DeLve2IWYbeQwZ0QXUcO*CopO zePv{m#0m}-WCk1~C}7ZXK|zDQ6O?bzDS}E2`dmuyVo(n$z1*Ndf_ek7^qEq6wUI3q zS))Olhq7G;7|n553wEj@Ms`O}%0?R5AG0YNYh?S2FB6SyBWB!AHPxWSQr;Y+`SM^| znP*UIB~g>n{AnWd?QLYI_NHvHK?5Yp9AGq4Qo?~o_G3S49&BVeQrmSvQ~P0S7OP0Zp1k^q_-BCqQou>DjH)_lR?*pv?xIC1@4eWxRUC zStsc4@P+6iLHW=eum0%#M$q|a&+)kH!Sg8Cym&UzTh6uO*#>FBcbywVcH4N$-gj;k zbP#GZUVZ5NPEarGg2tzjJq62dMcl&It>~CU+KVAj>_X+w+P{{v)pdc)dS2_NN1mP7Gpicfr ze7VT?GM*%r_`?3jeAz%B%^->Z`Qgho)2JCW=&J!5ZSzH7;qokMM*UCvDpW_E&;V?Tmi~l73$rtxlV{r!xNaEHTI9t=_&eK`u!Q{_?Q<_;(N1eo!M({ z9P|V@AB}z`999SCyc!Iv*Fh^(uQ9KKKX&?C(ENC20=~V_m-Nd~?+b_C{;ihuFXKKA z+v;xL6QHv!(wqIHXS<}k0;Huu(&vS~E3{vToJFAYyw+K;W?S%cc>9XbmwZe&xuoT} zpL;r`v9H0o*(U88Af1%;wI`h${wFwA4(Yeqq|F7SQ-yzE7p5Eiq=m(#W1*QYy*%$n zaIP*Q{VYa$Zw~1tT}ampzfI`1QF0!DPCD-yF;%c&&6Gk_kmmHk@4qZq(_iRlp^Jo0 z2TkjYwu8`l-6gG8q?K7gPkL)%4mcw$(hDVBCFx83dX~`1 z7OmlJX;6Hy06IWuq0lm+8;Z#vCv>LJR-uc89xU`)KXn!hT_*Gbp)EpJ3;j5sI0p(hEg2~lTz7U`!#ONH}K zN!ya1C+*o=XuZ(sLI(>SEA-qTEsPO5U1*!oCZPxEv`w8pLi-E-3hx*!So4_B=Y&qg zE7}Xz6btPsbcA@4EwotZ+miPwp)U!YDfJyFbga;$B=5dLmkC`hc@GkLq)E_>9Q`QKNXT@7m+?8np1@i5S@F4ZV~#7l=XpFxJgm}c(HJo=;OtIS`baVy@7Ov z@JITYK3Y6^Q+#L*D2LMTgx)KhEU~#m@)k<^OGyV})ci3@`nk{>#LhI)*)Hjq zgocFn7Mhn${bNP{hZ3ek`J~r~%@>7!Ed0S@XNI&xmrm3t_A_dTimol>t^LQfXy zxl*r7CD&JC`C^fNBdz*@&}c5LjSvf2lAbSlZxi~mcsNU1si&l`mt3bvYcvbpE|y;u zIs-pRhTe2Zhf6OsW-&cbELRD=Pjv7Bodl$zwVyI+xo_Hw8%dDeCN5SYA{P&JUePtpd`zY|_~|<(|&!x=L`ySCZZ@ zv`Zt?FE@}j3Fif&^}_!M{IrK3bg6>QxJJ_NyOBO!L7Fp+^rShYF{IP_6NlG2HRz zl(e5rUpRq#(WB=u{oZWS4>M|{({%;3P%c#K95U}?Z!dR&nuXRb50hS(NBUIpEa?BK z->bp2P3osDpVqV8hXO^NOipGkbXlkLWnP^gJeg^&vwSRTov!bElz8=6`uUKL^pJTh z<>or-kDA-wJ}>lTo1Zp>v|>1Qx;0S$!+zB1)IADD`JI zvi)Z_Qh#>iV&NgfIaKK3yJ@yGP`bU2w55SM+v`YM8mPIwj&!dE z+B`t$b9GF=Dpb$4him9(X5Dpb=yv#cCZ(C2)nn=TU3I(X%Cw-zNoFo>XHUN7=)Agj zGSeT=Y#*zmWSsA5LHAT9U)LzpvaU;}&aZR6s%^hlvU8IdnWY7!R%g-`LYE5NOX$I+ zK6h93P=?qDa6k0EInAoWiIwqSs%Y=Wr(5r-AD6~~{&Jy~d zc=ep{-xT_xk9ogyNKbM}w+2Wb5$Wwh*NC@Y2;C%h7D#%d&|^gB(@xA46VBK!Our=U zP$vEt3C$6DfY5$L)Y%>*T`F{u(1rQr94$JJSWMp~^l71Q3jK@F!$s$7N#konT8omt zBD52Jp>x5SxX`<#UN;KuEbTm8Xm6p9g{XPA&5)ZDzmrY+TA1|jxum6#Vzr!`8*L|IhZu5U=^Or2_S^6*8e7I(J&oez)Gk~@8)erVsrmE)_w8PciNROx|{kSV> zuJAv!x4`G`db3_9_9WGHUq9wxn{CUM+^6SN&@as2M!zp%W{ZR+26hy035wW^nKH(xmGl&D-g_j zctdPvmaZ*)n=vo`9Xs#T(6~a^zz{PMd{?oqwzNlO{&TA??|+`McIITy&PrDyA&_g*68(Fq=Ae%t5??@qN6pJ%Rc!bA9I~=k?K-(u1EWkv!&<#o*m86(P2x^N5H>D z%KB~~XUf@f$EUh6S6FDlxOSVFoZZKHI+7kZ>q)dsLs!y)3DOUHk#1`seSXxFDDhdD zS-LLTTfO!kDsxTm%-LVG$>#`@{MCiJow6Ca7bE~T?& zbWiEJG{_!6M+AL8SiV5lg5zz(oVQ`^qzclbXT1#zd3Wy^u=p@S=scmW(8WS4=h4nGNlzB4`%CXDE-9zxy2K{?SibBR$d| zw6D4tZRk_M>EDC$S)Nbb1J6N`*Qc7`p-Y+|jY};TnHr_L^?l2irZ= zgWcW__fTKdP_y4K(rT&WMX=LD1%&g%>~9JhmD}~zV57Q!S}@Y6!UKa5TWM=gNqo0^ zu#RhGwRvJ1(|WxcJ|P#HJEuoL6VppTKN-jU%tzzPXkq$hq<8`$`@y6{tlh%TMFm#76oo<}H zk00-m_ddmwzB%+vFTJ^{1#PI$$F3eb747hijORPe36GyIyyI`1f6J`1`B+;1w)r2N zjgLk=^g(wY|If@uc1U-Z|374d?u>7Vw4;OL_|(CZMMt^v#ylC@{Ifft(>tIyMrLZ( zcaY^JGG#rhuZi&cM*eN{pVcE@{=bPDE$`vtsk{E$=5K|p9eslm@R_dsZS!AMdvl~6 zJwNoWNRcO7H~q0liHDAaFXbM399G)Vl^tXcc0kYiUy8JAUV(i0U32-{=AY!g6KO{` zPRW;V5h&c||G4IZNR3tmIJQ1`oM?c4DlgW!0nI zLi|30{B83u>YiOV%tL={j27aBcO#qKyKCVD59L?&D4gV>6?L_Rc%ec5w)r0&KA>=p zhxVO4rVyW58rizJGYSvz(BX4K{-qwetYJan!5(UD2>F+J=(jWWEj-Laf$XJ)D?HS@ z{_sM6%fi2H{;Iko3!60nip*YG*y5oRx*cA4l!prEe-=5$L*4rxU3i>_4jLHpr#y7& zl-9yl4}CG^tLVWNff0!Lp_boijL!*XWRCus z#U7elv!HOZhYBk$E4<7@|CoP6;WZw*rr$k!Bm#9~D05p?Q;*7QX7CcSB1HU-!_}J^xk6_hIDT@i0qUwi27Ddk1&sQ=WeqVGLfWNP1{e|cy^-O!?+JmgHvDYASTZu8&OYkZOG zq3g!YD$4fIm5_Dv&``(vr_U;yY=k69x7VyA(dTK zl=RS~Xkx1y){R+=vTIB4?CGmSP3JlDV4L&{HB@fMLSRQ@ZH>;dRPc7bmY;*J#-(o>))iZsL zjsDGdqCpKk)CDf(E8pW#+71=|FbWpcK8@qO00lEj4NHN zJcAflx>`jBF|JftT?}Ge>0$LSh;gOTsxpXirI*#$AjXxrHOL^wl`3nbL5wTa)&zqX zS8A>41~IPGS@R5HTxqoSHi&U$ptZyx#+4D)GJ_ab##k#2VqBSE9b*vV$`ot0L5wR? zty2tQT$yRDGl+3zj&+_vj4O+*O$ITpEVV8-h;iiz>so^tSB|u9Hi&WMIO|S>7*|fP z?l*{Wn(#ASI)QIGl+5JeCtz#7*{T^ zzA=b#GjY!Kthl~$QSj4Rhzaf29F zuCXo@v{5yW-4MOey2YSf_2)-#viv=@O~#yCtsH|Gb8fdH1~KN`WtAGlm~*dHVGv`^ zgI3%i#+=8jI)fN+0HSDF{jLq7{r)UVV4@jnA6LyFo-cHZpRH`%&D^L3}Vcwu?HB$ zm{VsDH;6H(!5(K2V@`j2szHo71MN8mG3E@i7aGKvGt}PSAjX^#_8|r_=8Uyh7{r(} z!9L0$#+=D^t3ix8)9jNBV$7LopJ@HGG3PA%F@qR$*4h6uh%slqZS~Tg$duLUe0vQ)md2XAuI#?(`S#OtbF)@O zCO;Ovzz$YXM)XqjBK!3O(MDAle>-}Ky{=lzKAH1b^f&g$f;Os8=KM2ysl6G$EysMv zO}As0*>4$i-}v0v<#xH;6m3)&_KwA_u#XkAR^2?SXY6YGeL*{Xg}86L#BmC}lHeS2M-wxlz#8Ak($c@%obx+qZvFq(txzSpy)^{Bm zyV3r-k(z7Or1;d>@9cBrwrj0gH@zu#i(QPLv8C+oo(IN$Z%;C4-mK-ZJM1k6-8^em z>`t3M>dNxy=O64*f*AW-V}GzWYos0-dSdJ@`#FQ=4Lu`vx9tpOzEf4sgtKG!*rN=Z zI`)#-efBCrYt_WWme~DvA%5nOn$LE1)r0mbLAtyL?X?EAj>vW&w6F9~h5N95zs?6= zT=l5^q$kUEAGQ0)ZRHMM>xc^XaeF^O^x9QV*asWg*3k*~3Hww*8`Wu}uZulpU+2jN zxqq^6$;kJNeU~RoxX;+{nS7%s|33Dt?UNhV9louj2f5GL0|e>vUa&`a=nt_M?CBb* zzm(k{d(mdi*QkxagA3Y7kFAw%fNDv}M+g*gx!d4O%z-%h(6DZ-lmaRjpP0 znO$HIPh7sV%MId*%U5=-K|JO7+8$=mo$;*VZ|o+6c*^mueW*eAbj>UN&i;*{jl~C# zEh_$AS^_)V+%IP|t9JB6-%RxCxRMObo5%LZKqGo(qW9*#onhtcs!TMw=03>omC`xm zmKJ_*KQCxU7EAw^{WpVH`oHYAJxw3bHyQs>@sDxJR)fC4O_k;R*`VJC>x*s29i?rK4-LSt z^~DX^<_s(LJLed5a$roc>r5Z5H8%w(6$hMC3>q4mQ5Jk|*+Ul{d+6HY&d&0QQhM--zHh5?=U9!T^l~Rhj-NPsPAjf(awdx=(Cx+Do%cO-T5(V3 zpefq3w%+#^S31`VVm?>(a_;g_Z>yKnG*xSE>HAP|+&MweN$RGuKNeRz>of{J-|xBN zTBq|gYOYm}V{cmL^fTzXzC`0ZAr71ulEGj+Zb=f7Uu=-eqt&%c4rbAssE zd&L8t?X#$<>o>$XV@?`WP^H5KCSp9=S73Y4Lz;+WM{iUw*#Hx z^jyY#x{pqES_SD|In{Yd(5b&haf=Q*1Viq~cpU+CQIn*)wR9B=`Bb{(HopPK_{t4)U?tYoG}@izjJ0} zX#UPwU^ILAno57?9FQTq$ysJ(NuR53axU#4yUNI#MD|Dr+0#aLnaDOLrFCV@-{f2= z=p=Qr$etFo!*_Yr;?kR(_{w(8Tbz19T6T+bV}|Tj$5-xCAL5A3QaASW;a7bAI>v`z z6#2G~Rqj_48u*#u3`B=CeRie=P0jBylfPgxWHx_eXeD;Id?Obj25$$^=E~lrf9plM z&lq31rH<%L`=6pLN6o3QkoQs?EaJeTs|9{VSG(MS1?t~Bi~QGS`^xz=&GbP0m-3#2{g=)gP~VFM?L!JZi}x19TmIyu zU!94)ysORw4XEqE3938L4(Zx;t)+fG+Qd;OAg%d6HMW61xAviQ1*qnv`G3Zq+*W_a z9^O&6gZk7V71aL$ZQ@h2>zVe0ru*nR>=P`p*-=`Gv1h3Ws83DB-HD|_pg#4TP;HYf zZ%b=C9a?+OKHY|xVM*Qb{Q_$0NZtKXcl`PfH~~|4UAsMNq50#b#1iy{qdpDOpI_r^ zZ!L9$v{j^Nc#zXt8B9I%*Z{_$4oX_X?#1Oj%pY*?RQK7O5jr zzmX=#Qc558l;ZcWP+~yJO^>d5GIw-MS)wC0{bJKKHrdOT8i-v7p8HQz%~D~sNl3ko)=rN@Ju7vM^qAy~v((K4RXLuyV}Fa4p?^ne zsRdKWDeJGwEp_cgdiA>41P6K1cgTDEWY)#wL-W-PO}*NzM2+;wx76BRTqn=yMUL)$ z>ewn&XTeSp(tgzs?c-CgHFA|+D|xTQ|4`IY55=j;HgsTzI@gZn8hd-WRgSkMAr)`I zS=vb7@{u>gH_g`;${msV+dcQB_sOd0)yU(cT;!tk=W)m)Tz%r(0kJ-oDI>!B>H zUEqI(HtguRZtchB(TDksyIbRYwABxjDSa60Pr58`e!(VZR(civuj0?{mhK~4jl>9d z)YILu(y708=Nfx4=14#-L%BgU4>U`CChMVI{YHq-f5l96)Xl@0>uyk2^wa%FKe688 zZe@?w0RKo?rFBnjo7?UQ*L+7Un@yX|p!jXLNftb@t1NhO#sCYRoC_LK*Hx+VZ1pv~ z&FL@_bnm=@bAoia;GlP&2Z!U9Wp$}#Peo^H9hMbDnrkDaDH9`@*0uf=KYDAaX9jcp zKO-@s0>9*l-;2a-^{E@sRysc7jT#x-dfq)OvuUTyyGy0DwLW`1JvTWf({pnS_?E;D z%qfW)+MjWlQ}}-`$lTe9Ip|l}NT)5FIe}7LiZ1sp_|uW|v{=wO=~a|r`q%g2Okaie?6@n)97}tSii@!Va4fM0=Yeu8u?G)9&t|I! zv3lgFbrK^o?KB_?JE|P}G{5Qt$}zdS9p(+0ygv0US(KG^DQjA}>LF~6*bF4jYO zMc;yAGt2m+Bf`?&%r&U1LPX+UdhgLBYh&i_f>FkYUyUGrV<79Y8Bso+o|GZge6FSc z^*ct|{GT18-Xs0bj`4qXjC$|-|G|zC^N#zv|K=Sd)}sG#$B32ZXLpRqyW5Ttn*UWh z#x;mpmU>vCz{!&SauiqcRke&byKoBl@9rvT2fIq--ECJ1&adn$Q3|E$sHgYI*oz|9 zuk0$3>;J{B61jeMSBbKIc2^1h&+aP0$F36Aeq~n)>Cf&ek@shJmH$b8W(5B~bXSS} zz|Za~(K7$xt`a)`t-DIj5$w&9ppP z!~G}udS9w_bh;7Gozwas;Vv(o{t5e13n!=?rP{LUNjuDi^Guws_za&?OEuz-FU?8& zz|~vxpTT{iPkjRmmUC zSI$2_2H(OLCDgh0|7q{-YfBSrXkCXd*U)Ocs&$-TZUL}naZ$sT;UeQ2*U)o)d_*#Bs zlr``$)?)u%WXw0BmK;3XuftOEJ*=UY$K#PwoFf`Fjd2q@Y=YNfuh>?U^SeGM|3mZ_ zEph0NLfc)^gWULR7wd{=4VHvzL|YxhTHBFqkzHt(&c73h4 zV;9Ad>)N0nOZ|(4)&3unmi;q{;SJ1EY>5ZEmyl!UP5PJ4^9}IhTAr(6`hP~}s*xVz z8gmEsRrrY*=Hw^RgU%88Mk#u~dY%6RUB&hyiG%%PTi3_7DzbgLT>gGVKhf3MV` zPqjB&yjJBU(ctuR8A^y&d;a2m~)*U=IuB6blP2O3oWN(KiT^Hv=k+0h~_uOR&RY9 zWoJImLs{JF;y&i{4bWbEqKaYHqoo`j)2aM-Q1>h^_MkAE1-kJmD%Rw!qT96g_A(uQ z1sY*_ep>o#yJFi4+$IrppzI`F^n7XC!A>f7Q z{w=-<$lh@rc;EOxsw4Je?r*5uZQkj)-G23w7a;j7{|^OUQ4gyl=l&XaOP||%SbZz_ z9O!TN1+8Nu-yx-l3JwaMVU5PFRLAUV$G2MNT4#*!v~E@xydwtsjgI$NkK4iV5o-xP z_gP8U^XoxBIDUf_l~P2de!5YU4_n9VzaRgqwOwlUGN7flTPKZu1CsI?->|x^=hr`N zU1tBs+0Q}p^Re#%Uy1$5+J|`Fu)-25gIa2`^HNJ;xURJWsGqmnRq>OT8hg(EQv5>u z3X$xURQ6iK(SG}CBe^x!Z|}7}EOpM9?^X|P-D`JSe|qM_NQ=3;PH?+*dF)m@g&6Jv z-oIrHNT1B80rzES)SN(~Hxo=15v z?hCl~Nn76`rPyv=(03)|E5^=qU1t4s_&LxYIO9Cm9a5H%l=^nm+qmm?JK6nS*8(IH zz`M?xa{a>YJvRrMpDVoG{?W!m;^#w<9LIMN+-^VBeb^PUzB_o0>mJF;{m7?Rbz5H_ z`V-d@;`u7@n>Zz3vgWrDKP&Vw==;V04#{}{K3kRLnp*cSu7EYN?%OWQ^+N9ppzrDZ zG3W=*eHHW%*T3%CA!SU8R^P2Y_U;w#2PDNu1n*Y&>^RSTv-%`HwR$e%>~^04-0tqS z2F@CAKd!#zehzuNedtQ{oc*o%m7tHJZmBbaaQ%9788!3Su|w{V^^?IXp|QRFL~s9< z?&DIQPe^?pvj))@j@jSdc$52>H8ga)`)T!f&!4*=w&EL(xu1|)eO}t@4A=V6uez_0 zurEp2$B`eedJ5?BJZ0VI4tn-lZQ=7=SF6W&J*R+(XRq~@=t|G|LO*W(S@J#BOA_a0 zR^?3Q`Cfc7_i@A@^gJT9caOyXs>Huwedmmwp4;vA;XcnV>~E|a^ekAPi#&iH+CH50 zyejcLB6Zkp{qxp+p6etPAX2|kXdvi)LIXkHFZ7c2d!q}UCDETH>-gKBLu*cLBi<_X zPSEfP|0#=hBW2yv_uHP7WhbA5u0DwxyW46`UhBErdhi_|^DzG(_xwP7{y^$2V10M< z1L^^z4`1uN!xON6BKS?<1L~VS^XhJO@2;=dPg(EYa5rj?cl<2$&8HyY%|Oe3cpdAO z_X3}?9&=l&+qJFdxW|IzpFG{JdvUAFlH0e(>^0~7tLKf#L2)y!8J~(5J2YYwr!nNvpaU_=@*-`}E_N zam3cDnninWx3`Wy0Gih3Df>wG@A;mxZy0;Rw;GZ+tPb(hVQA_@2Xwf}zfR=M7RR#N z?eC0FxmKIl?i=6jUoC!?)P1n(>%`AGiGQ7Sr2nx0eCyoE&Hf(L$>)Hq6U+7e&VTYR zsqc(`(~maY^lks`_JfG$cKiFVQ5lrfQW>c?%Pl3fo_NPZ;A`j|(}Aa~JN>hPdqh{O z23hAjq|O62?PS2Fh1?-&9dTXW|9c2k#LZ2Q+NpNq$M2$Q4{!kAV2xWbY9DYv&=39n zE#N~c4SYn+03TJez~ib6d_r8G6v@--ASBPKD}XPG{3QwXvV?k7EkXX8_aZB9(_)J2ET*_#LY*(6x~yv<*(RZONT{gL140i<45Jc5 zQexOAuKUF`Bd#;zS`v9x@Q}D(A-E`ht`q(=guNf}2h=nQs{IWah***!l!|nj?w9f!W?Q?(w z_IbcT8$X_n?@PZBn6%#s++)8RxX+FP_uFw`#vTUF*a=|X-UBSz?*~@xN#G%S8hC}B z2QJ!|0k5{_f!Ej{1YTz^0*~4s2Ht4@FW^n~?*ebJZv@_E-weFN{v_}&`%}Ps?7M*X z+J6GP-~Kb;7wo?TK43ope8_$n_=x?tz(?)B2OhT{13qSd1NemfP2iLEcYsgZ&jX*e ze*k>m{t56!`#*p$*{=a#w%-80YTM1wZQBQY-EIadR|x2Ky$$GhoeFGrbpl&mX9HKe z-T`cPT>$KG^#D6v+kxv`?*guOMS$nK27q0zAz+Vd47km8DR75tA8@BD1&q3;fCH`r zz(H3DIO>`MCS8{U_qcu=xX*PpaKGyaFys0i;Ee0{fO*$Vz>@0|z^dzi0}r`A4ZOm2 z4{*_SAMk3|UjXsR9N=}Xhk!?2Ujg3e`a9q)u73pH=6V8nhwCZeT`u?*p!X1O1ST+WUx$z2H&Ti;x_5{TTR|>!-jcTt5ds>3SXbw98t7ns<4D z&%2s{FS=TRFS*tLUv`}WeARV2@HN*u;Onk)fy%uR=yq=g`rX@r&F+hVt?pjnYIi@d z-8~5GaPIVi zqWd3!SG)fic#Zo>;C1e2fJfcm1>WfXKJX^@OTb&)uK;gz|0nPc_b-8Wxm645-|Ye3 z>kb0%cdrC~!Mz&zfcs?NL+;ankGRhQKI&c%Jnr5Ae9XNG_=Mn-?yaDocJBZ_>kb2- zclQBbbYB8|$vp~u**y+?)%{-JYwii)>+TFtd2&FvrvUVOD!^vXAz-WLL%`LZtAOpE zj{-Y9*8w{{Hvrdp{s6e%^M}xi^F4nAy32DLu*Y*JaGU2dz#X2?0e5=t2Sz=|fCHYt z1`c|@3>@`53QT&w4&3AUC*VHMzXJDro(5(-&jIrujwU4!N0X|Dqsbu;$Dk`b9D^1; z98IqF90gwEp>AL2p>7}bd=Fu7@^Ear#lx}bHV?<9J0!NdB({6S^?q^vg19~)t`CXp zBa+smlGbra>oG~|NeT6|gnCv&JujhNlu$28sFx+wYvS{D@u|E_-R)&r{9cx&*~_xD zdRdm$UY4c9%iMOt)u+~bf7Ier=X-ww?DD<>+$NG8BH1aDsP|RK2fRNA4toC!IO=@^ znDnZZKDEc|T8WyJ6f<5g=ov3Zlf0Lft>kTjr0Q*5iP6ow2Ka#Y6yQT5dBl4<=tsTl zfXBV(0w43r2=X%D<1W227TPeJYOAPDXs}@gXFpZ?ZeRk?Zb@$+J~D0v=6rg zXdiA1&_3J|pnbS2K>Kh{fcD|u0PVy50osQz1ZW=~2+%$}6rg>0BtZM{Xn^+Nc!2id zvB1Sh>xn=w@X0_w@ae!H@Y%pF;PZjqz!wAW1HKg44}3Y01-=^i0PwXy5%_wb3RJ-b zpgVXa&>uVuYz|%nYz;FG}7;4{Ev@Vmf0!S4h21z!U0555A-1pgB_ z6Z|DGA5^Vqub>B54F-XSf-8Yn1XlwWgC_&84xR?QCU_R`y5M@?(clK)jloU8n}S<` zw+P-A+yVNIU>JB;un%}o@Dkv?!BOD-!ExXhg6{=B5S#!$6wCl03Fd&01`ELB!3yxP z;341>!4CnS3|<9%I`~oGv%%|t&j)V+z8L%i;7h?j0=^u)4ftyCPT*_7&j4Q!eh#Rb z?gzS?jsg8me+_JI`ZBP!=~3Y7rmq9roBj#d(e$st&Zeh<>zbYet{1wii5l3`#6G^Q ziM?#6NTMPc5Xq=Wk|Nmy3FgU7oH=KjzSrteGfkX1=bK&xU26Ivu-fzz@KDoFfLAoV z-0D-;HL*V)ZDN1Cv5EchrY82jTbkJWZfj!iyQAq1*qkp&S`SEC4@v5eG_lt|+9WgZ zCieQrnhv6mKPhoOjW`49dH4^g7vUfAH#4o9ntzIPZ)yG+@V4gHfOjJaT`dBl2>l4klBDN=+txy2Jq=VlpSI;(YVk*r|ppUNLoc6{Q zO!1}_Gr(I`%mQy)L0fvLh4pzw3tb;uNqk}@{XDsnex6==E%4cuj{~1y`7H3om8Uib z)JrRyknYPXnV(lzGC!}aWPV;>c`j_x{jDs~7g||+545uO9%^OnJ<`hBd$jexP;W1_ zGToP3*^aNavK?P*T|)e=A?9{EcPcyGsZ5uS_jyc2O>b;?Z@PDh73_XnJ z>(;)|H>~}kZ{h8-$3ocY46U*=p|kO9#q)0P{dh(|@51vwJZbO;@Ko@85YNN*Oz3NP ze*@3Y?0q52wJ&rMp0#++!n4_x2_13eLwCBq*Lt@v8Ty=WEW~|yrEtI?Z(Jak_wSqc zpMmRyho53M{VMf2^)0M}H&~O_&DMUqY`3|(T^GCl(DfIthh6{Za=F*Jce>y2{;vBZ zPucTf&#j(6_1y3IqURyc-+Ch6VQv2U;8Uq5MzW_U_4nPxZ%1>$zl~IYz2^{r zlsp7{?H$A~Zny&2=>JDM7a_UwopgO>{KLS%?F*H%zS$TR*d0_8NPG z{cd}g{c-z#`|s?tTpx4Y>1uPI;=aax)cslagYI9tw|V-#liqpX_kFg1$p5?kJN?%N zly$)Vv$Jqod;sU!9`_=u67|eK>dgHC{&uumcn$wMFaQbvv@cSh4HP=~UheNcoF*yk zwfNKzaMJTbob>z%&r5iIjOQonLiO)x$CuSJI5l|&+V_2&{QRSJy}H4^Uj3>4uj)VW z_PFBKrS56#X?NV(?}=Mec=Dc~TmR+xB_2dS*f%j6j&^sczQK`j67NcGdTW;=$Dt#;C&nTZ#sOh#Uh1OA$k6CuY>xy)B$3fUO(T*TZHU2aYHBQ-%EK?o z$ZRQp2=qv7XksWa(Kj-d919O`hofXt-jR{sk-;vt<6YY)Cb~CIfI`=Cv z%A~3(rXr3f#wWr{%eiW{uUI~qDre$_sUm$NA`y>Qa)s#=g^u59ww$UK%Z>iyMkb|{ z(sijQa)1a+sZ5uePvuPo7AK1!Bi-FjyVeMmKwBkZW4mKfkx4yv>voP0CrP1!425PJ zuM0KFmXA+3;zpVADKE)Zw~EIKbF(POWInsUTd@U-6~jb|`Fu8A%@qr9ar~jc;0AM* zDqbj4H_HS8m4apJR;f&;Tr12bl%_u#PKGy=8mv*HtQI|K-1FWei`)L5*4 z%#gk4P!vkEy(1%NRRV9b1%y_&&QgMq`n9 zcu?YlvC_4viN1;C-cjAr#!T~~W02C_%gES&j8Kz^)pRe48)e3)yrg?=QhjrU^!`og zSJIDCorO(%*>48V-*YWTc(u3^TLf5(`C$B1ZB5{v*}Cm6yq@C9Z0Gy zwbziEs;Mgd%9zKJI;zUjA;(YzQ%*w}Yi)#79bI;9ttoDlnLzRqb#jvGzR;w3p&E)_ zsGH(Koh0j{dyB5z8eJoFo*Z{XETqYmBW4yrvrWt>!uXa+osjzNR1gBy`aEdU)g3A7 zjj?VqS>K|w4ars`*{UU5>jmlBRxgOqEQk=uGF78{lkwp&bw#3+(IoAw!HZE9LiLg|?PG*&h;0q6Lvf?b1d^9%&9<5bYYGjq zjk7XS?b~&=Z&y2pikZ25_FZbnXgN2Zs%GPuC#+2 zf^m@KT%OpUtr|akp=o#bjSojKBT!SZh#Cs_$0L*uj}OJhKr&nC)=sbiW*yg>F$kfiAMXj z_4W0IW8L9Ro5Q`~O+C>_Z||1wO}%|+LfSW&0Z=jv(j<$nspQBdv0+VyhtYOnR-@)& z70_CwSqt@!iaZ(HH_}&gleR>cUzS&@lbRY#M*5LFqQieqk->zMjIYKzR6{xG&!lVO z7M>=%Z}gIW=7A%YR&L2rc+4Nyp7_Q<2@tNPJLD4JClAXzBZr z@kDY0IUH28WsJVXay1GXsSS_gO>d4Kj1I+y=zz|KsEOrlnlDaI_)gCg5u`7UhJiW2 z2p1nxGyt%o;}Y0;L&;!8=((omk?=5iPPk&4tT|x;CRrMR5^1t;EDpom7m*;Nx`Phy z-c13rI6e%WX8CIhUb6;u(*bv5L>NTIYjy?Zp+2r*eLp;MDdS=tCF03ge7J9fesuMX zj3%SK{US>&RI1t8jqwK8;gP=45mhN@9L^pjfv_hmczQ=g2t^-`jxsZeOX8zSOffkW z6rGZDMsg1M=4cY5%qF^M|JcZQEy@UY2b}n$4x>%2!?BM=p!GFxhSp^?j1EFZx?5yG zC{9>4h3+<17doVVBeRK3*h@?p4|R&2v>wVKoi|)Bt-ERxabcC9Mr3wJ8U*6C=8k+|)3(8R_XP7e zQSXu_A{0&c@5o@iI0%Q$-8#?dL1f^P#E?@17|UoKSPeB2l_u3NF%ZT)BQi2LJ_HYD zuV5%XN?Jxqp^krKjS~Hh zj0`7|815w}hSUKt{tU(7kc4&A6y#cuq5n*pFEg$s21iJbhB0k4G{zr8$xCcSVgL=V ztH&W(K@N>f8ydAv2%cQ~_aI;IZ&eGR7A}EVdccbsRo5P{@;FF6&x`C@Lcnq)CJUU=~ z@nRgEiN0ZL(`m!kX39D^5;6s<@th?Z&wBnkGI3-d z(rm4dX%-dexS_F}`j73QD+E!@E62vddkx!2>*8XUBHrgX!#51V;J671qYoNAokk`$ zl*FWW0L|^kz>(UnGYNU;?P+hJYwO9F2)vJ-3pGJ`z+7>rF<`D|v1#3u!IX zmMStn#;uOMFf26^UK-1%p4N))OW@DX)@wrG@J&r)IN4O=;JXy!Q0v4$Wz@Qk*NN&3?GJRSKgS zMqVlGk+x*6G^->id6(p7wC>N0n}i+ zSkC7_fKN{*a?>~%0$Ha@^EF{f+;9%d?YCs{K(@dQOWD}OIfa^v7xD=bRU9zzYb}YY~;J0JzUHl$y?^)vTbIme)@fD;xW>g=`rfw8qtr9P19E4>+vA)~Zy%5Gz1U zv6+PuwGkI?;HwgWwHGO;u_%H{k*E|#W>Y0*K2hV6MbgM{rZ1Jox#nmVtf}%$wt|a1 zlcTAOjv4Rb)D+o~QntXYZ8bwE6S(FY-!*3_A;Osq4@FdtPbH0`r1XL+ulEs?L@w7Wz z$P~+3%n15&g^cVIn?p2Br_(c~lI)=pU!u}esEEjz`wrZ+1mnnOM+RhMJ{aXLi`Z3|XGdj8tc`Wy4l!fSkNsI)jYX z?q{GD^SNv#SxnC4D#m-VywIPm8m4l&A!c=5i6A(C%M^jwg7G@J3E;z*Lj?HB(j&yi5rY{ zLPjZ7$QeS9S_t@wVsxl)4TVuSC6S^b_9V?Z2m4Mn-s%o;YoXv`L5ao6{ zn99|tWU)p@i)q{pDO78Myy>*Ci*ho}i1YKQ@&xsA0%|_ZLO~}LeWvC>$Y2~P77ygI z7)IyOet1=}cQ=C(ERPx~j;6|$tk7Bwmz{`XdZ3TSRsEKViq|ixh*60a=X6wt=#LDb zk0J80xk5FEL4y6>h>+t^*)E^J%o@jU@KqOKo}@(>7&L)q=z~S0AKePV>6XwWObpyH zu1-vmpt+te;wl80T%|_V6Nyd?&E=~(oUAQNxh9kyK|KM{qo*9osX>lX822h1!lIKo z<0CSYO&>5c+8W1qDqX2A;1#DvN({>gQE!o;Ynb8*D>1P!!m%(y=tzY`rARj)uF7tbtyf%TW36bHUo#yu!XZ5$Cec2}5;F~Y(i z;@CVavi2qyh|ElYwMDgH#fa-cL1=50PKZU`;L~D^g+m+Wg~;NV-*GS1scKn-Rg9?G zKaXUEniDL~%PW^TB=1OZwv;Nv7|vpLhIehQ51QJD>qePy9tsS7Dx|7&5VQ9(}g0dJc9Pr1GKrWC`uW2CbLoxX1J)r$y{c@EGM4@FGtMkAn$xC z<`_M_EK3k5dZwlminGl+Cv7{;QK~LO;N7`OZka4xsbEmgFC=r-Mz6~hv>t<=zlni4 zSS%l?JESL1uwiD3cA~U&q5u~taEe}!$jJ}w`feCt^t?Aa@_MV8Wv23P@`VnU!hoeG zEA_yA`P6i!&gz^tDI7Eu2g>r6srojpO&5RbSmqLRS zoj5fsS8VE$n1P?LpQ|p^T@$=tquX65DwT9}-Zwd+2DKccjUgsERnc^*kuGVO zo?#kygff+71f^wcVV=f?)BXHHER(B-3sn7Tt^nawA~m1ILTXyxQzdzE5tqQG0|y@p zgvQ8}D@+MFUBcj;6S9;!IErPX(4z<@vjpL0a|L;0F`kCmWpubifEIV8SQQIdtvFO> za(X6H7UAUF6lSYJ;yMnyztD)O3Ns{h23?(t=LO;FTP0k5WG5<2kSlBKdg9sVQ9YgiciTYnrP%%tv4*^|n+F>s34OX-vD(jIg@9RDWW)hyegAL~Ml6h>Pj()py|ZFktA! zfm|ulAUC9#Z9}8|4JFl|DjQC>I~H<|0A*j!8IP6A4Uw3etjIMyX~^-xA~MD}g~0Al zxtK3%3E~cyrxjM*syA1_J>CRvL8oW1Z&|F4rmCQ*`m`2kGHSQ#Lu1bv1xdoo4AxzM zX;`1ZY+)KC=9qlR)KBKd%lGe8I+Ifv@<%2=fOePL+iDWqSqGHN)j4)1ve^TwG+sEM zFjqSOU&$FO<iWd&|{}e z_J^=un}KiC?J^#=bQzC0%vEM-UQC#v>v=T=1wj4fx$c%X{MA-udK}I-bhf^U1{r!* zcDjtPGLMQE(q(-+u`xh&Vt1}wor9-(#5g>x%doX<7?fO@odr(kRP}(oIB=lLVHne@ zz)SI}Je^;**&4~A1bN)j-Q$;$|LftzozzWWO^kNB9O8u3`+!SUCl5aK-x3aH2_u zM)b&?6RHB%(4_{N0}*<+&Kt}n4Zmh8Cck2QWt3JW{lb#L@Z}=fZx)-Ps0`@|nEubo zd|wDXV^o>kEGCh1B!CUhaAlTl$pY%!&VlD973X-;L_(Bi_TnFmq6F8Uw+4`W1p7Zd2zCst38V3oR zjEg%=k`6Q`7+l0Vtv(5(U=GP42>M1A>qi(FQrfzZ(#tClGEdZ>)lk^doi0cOg+ftZ z&()#iQwAi_&F9MEB?4>EUoOs-D2^4X2G^YbcoE&`Y>oVK{73H29JMsli_(pO(#SMGKNmLr0{+ zqq$j!#A*#fY^QUrfdL6;DznfZGCW^#XiPpDINdNOZh0%`b1`pnK!$4D&a#v6CLelQ z|7NjSXTQloFQeZimIFSWyWV1E;Z5#P&;;%y&XkLV+~uNU4T~wotBSwD3A4el=rx;c zkj6q!!fNxZ?3DTF9clr~2DFC5b4+J-HgpbsB4T<9k2Q3kQBw}#R50enILbs|Jvo*M zlNM0J8(0n+qs5ALqps8#d^}J~<0G*{>1@f#OP#@C6o)ezo3oj^9Hve7lSk$-K^7}o zcSB*Ma_bVu_b_$`>r(6?(>!2TsVvo9cc~QWv=g>2DOIv_nWD@@oKJ6J4Wt)^jRKCU z(l?zMEZb9p)%SlzRNI0Tj&o~N3wHY9o85PEx)!i@M4?lwv#={Qg~HJic8?}<44;#W zpPI%{C^8<7s`qBgMRhp=N;8zibjTq~*i6xEr6AcKlL|a}-7kvkVM>irelLp%@N!X0!|yh67oL zHk(-(e@m(?`&vSxY$b~D)<#;mS&bQdJ{3zT;=CZPbMjmtlWy*C;iDol)4(~3)05D- zE^~|&42okS`5{J!#zz>%M`Q*>4%14SH#8wuM9Y>(;tAJPF) zD6CNpB^`_(tHBs+L_C(_8dJJ6rZ@wb)q|_=C>jAfBvu!qFh+#hN@F~16getoe4rSH zf&q{{R4y8rSp80bk?1udx}o9ukwVM{4TpG_@iRIa%m(0xO9aWYlZa>_ayOr&IELb3 z+|Rrz&6HhwFjABI+;@zA$7l#^}e zG}(xqGiAdji-wrTl(bmZw>5@RAJAlt=!*^Ia2P;mO*DKv0h@u#KKf2$)fyQMn?<#Sv)?j2oC(R>_td=y`Jqp(59tDhdV&2kjLlI|I0H#>tM< zovs;t>5`lcS2(6~ZeI~4)D$O}Sn(qVax6^0BY8uj4Ya4c1Y#43Z8s_LVv6CVyJO2l z)Y-_`>#5y_WoQ)7a1|cLzNw;4sKZXC_F1Ic`JAoXy zSCrO-27xoaG>8~~1Iz4k)zBc)v78{JzZ1@Eblbg2SbmelRLPs7BWi~w6G}RQ=nA%g-~jD|-U#i4&<+ey6YKe)2_bVs zpXBOKsIF<6mwv$u z1*{1)oPNRhV?&n7OQmS9hAf*ms$c$hR@L@u<(p#YokdwzU%DIUI}x=m;jlO+?w!NE z=xPP40{zxAnUSff3ZgCT+I)Q2Octc3#>79GD~fx@6|*yhx;um!pR{zM%8mMTs;aPv%1+GIV|imh#PZKy^UFiy)F6npt}frjvf zk1y!Pl+#Jrd&sbQs2U+!3F||{=q8p%((NldnT9N-W#}_pqZZKY8Zq0VzB7w^1=Nm) z4OvGr%?}^&=1=1~GM;aU1=U+SKrmud$cZ9e@nscZZ?z$;KD#_2b|)`Y9H$r>`JO16 zEK=++{n;vNPsL$ca@mFx0b&7qgp1OkaQCWG9Vuf5!h1WoVLOfs z=4Ec2;wo*S%1J58gxxvNdM#gLaktnwporSX6gKp5Mu$#=)|!?#7BABUp;*h#y3WK^ zW0Ch7?esgd!mcTf)9t7TFu_bDmoWtD!%)=&hQLW054CW~+X$dnhRW6VOmUVnQ8JNf zso|L0$Xr>HaXx{8y~qla)fFKfp4Uq>fsH#&R4&(V%)!uGF%s%q+R~RO=&G> zaxosaX%>0qU4#aSeh{^b)YuvUB@=p95QZnu@VuxkO3qK`P}vnHo~g_S@WqkP2JVc@05_Ogz#a&vLX9jM zvymOb8R#&s?K%t5Bx&B`#XKDoR`jYWnNoUQW#@VEMzYUgmlK@WA(b9V0VbE-=h31> z^?(qw@F3O7t5K32(?b~pKcpphrqt|IS`)}Hx(251MRUbLi#c25xuxc~fHiW=4K$UL z1fU45PbZA}une6Ud_MjGE6DpFz`W!13m3D|?X(DzRZlX{KI$nU; z&>TK#g;TAOa%{E)H)+<2rnMb%W`#6GH5%5aMprJcktH)>U@DWu6RRW&}j~#BodGKja6{RkUOV~2Lg|`a7 z^idTWA9lbyt!Ci20KZ|#VV%HDA`PaeE({}v1-PdFZ$h1p4`P~7Lx`n{6pHx8r8wf5 z0;OE|iBcDScF`3^89Nm?Ab8)9iYol*W4sGF*siwX-zK#MF>C;r1(gBSgE+eIeY}*V z#GSHDc)Ea_fZOqX-)Xp|lojs=zYWsu2%T2l2(<}(x5U|vcLshpAhnEy-2mVE-xPc? zWDi2p)tZYUKGqv+5Bsg4W>u%8Q&4Y*tkXy{pm2nUf1U7EKv>OpN*g*MH$u7|tyYBe zV)a3!^&$KQBPNLIa^btdpR245VZ=JECh%)g_^tq?S;B))W+J@>HKJgR;ErpSi07bE zA(pz)hYIWPbD}HMnh|N)5ri3oU)_mT{-x)(6DLM8VfMck_U#5gC^CGZO~0>nfb;b#y-LA_UU z0exD5`wEcY-W4S3>=VPYBzgRsP`m5CpxMiFJ^}s52Lz=rOhXUnP?NaWB`wUpFoAz6 z!jkB;a_~C>KdcFAMo#LEEu~9IpV&u$D`s?%>He8fYVWwXFn+c_-C6gYsMV2p@{#y+k!PHS2xzF+-f zg#I9U0QF4G{-!()BRuU)=LveRHIMpAjnQ$Fn>O0~PIU;qhdSM9w3J$IQro_~7TGfx zvLJb#Lygd`v41qiDEZtKgDZ|I@YMTT4k4$(v-aY6(^fkDjOj1$Wy{O1R$Ks055p4T zd)V-`^Xvhg_`Npfh2?(x3GrDg66iVj_CX+iGWP9B_&)%D1xQ%;>=o2&<_RC+0*b{8 zB;h^?UTq&iN<$JWKAeP{>Kc3}BZA)K)rh(P`V>cO%rSl%xqAqq z@Ih&$k5x3%qh8Qg1iyZ89%y{O6hd^unr;;9rcS5bpO#RLJ{^?stVih4296=Pjx6P3 zY+C0WD^=INZu;JSDPk+5q)t1~03+GxzLCbX%^qtaDu^rDi66>mvg{ z8tq*?d)wV-KY!jG%H3&MepjcmJRm|LvMmH#`0c(mZF}uN+xz{Uw!KQVuCk0E)$DVv zY0Fw|?{9m5C>Q8dYuc7V;NUE8KP6dwxxQEXa(62HY(S?9<&aju*J;CPl?B>nM4`*9 zwp3dxl#^hyU=WNi@^EA{;>YW=nI68~-)i?FbPER5&{7=Ow)lD5+YSf2ooKcDJw8{! z&!YKJ9+%&%ToAhS%gcz69&*(7eu-mTaIc@`ZE0Klun>W^!_^=qZHKRGTRal*x!M+g zf30V&$FD3C_emp+o!R1|rFXp%HP&gERyKhA(2e-Dxn^7%oi=Sv)ynRh*@ouXvihqlLg0NR0 z>=jI;E#+%Pi>*CPd4d+Q>V+({c+BlZFqUwf)DdYURO;d<&`9!TSfse7ZShV-OLrzf ziB8A~vE=cf!Tf$5Zpq`w7hfmBy`fX_1e$DDlwiLnRl2#DS<9tq_TX=rGz$Myznub(NA zW7OyZKA#KfiC*n(O9iQfY;CQFiw~dT^R=zlmHABDBL1^-LW|Eqm8HklRq`2AM7*W4 zpYbb~4bLr3#UPY;!5dn;3crxpsXCCw#b3bN3-;<(%VsMtg>+;80-Q~4S$v`0XX1PT zy{2vP2W^W#4&~60&}K>M1znOQG=mlJ8N1WzTjBTn;Y<5@5bYaUd<8XpAD*9~ye9C2 zq7<*d;Iy>hcYj#IGB?}w>Fb|p$F2YzG-tuqcigfUlEON$rw zYU%ctCbSUS`ZQ&lXo+4rB;XBb*|s?-DEuPNOL(DbmjYS}3PV8K;^Xjuww?d@5&WwiY;j#Mc0AU`7a!%5S~x*uMtu%V?D_)QjIM`-C78nWHj>0&s45H=d7lh)IX zs9>}0X2|hcffp)ct>542fhF?W9>nGIDAl&~6@+eK=oP-EfY0YKe=VI&XwMo83c*-O zw$z8KrKO_-aRgd?zCZw7>4AVB;Agkvn~%>M2w({Dvw1r@IGzOj$T+hYT6(70M>oG8 zdGh<4eL;`M?e+Ns!6wuo)M0JM$-Y+UOLXU7XkTa_-(qXf$NVdOO>Kww=vXM0#;l?e zIDT}rEnRq_?-ca^Jq&wzXXtP{m?{`CK-JLU4v0HoAH)#Q&$`gz^~kc$BEtK{hA;?v z3T*u0D(rFS@Sx#F5!0ySGzu+PyGmW;Th+Fw?Qp5>@HK6R_rU^bUk`s7%CkMhL+wq z*#|o-xvb^oYEYr8u3jOpTa38Fw;FXNe?I&<*>3T8LRa15^|}2X4>~K<03Flz`2c~y z+kCBW5#|=E`BixzMnRao9Q*lI9`<2hyRk7#9_biMp0*`uW^J6|Sc_Rhiyspdjx$yN zUtYd%_sKoa9`TR+|NFPTJn@k?KAHXDyYi2p`t`s6)Ta_J?ArY3J^Kbf^Tj=< zoDD(ckO?!>8p`{ zYW~zak6qgQ#>^87ufP1j!sYW9z4ZQ8_41le{^!Zx4?MNz?0WBQCcKak*Ux=XTKnQ#$3| zPtPd=0s!dHN{3Feon$-7mdKXKmdIX4_A;`Uk)0tsLw1I2j%jx2t%3qUqR_6)LT zkUfKJnQWPCnJhM>0Awp<`Do}SCKu7 z>{(>bB0EoZp6onXY>xoQ9wfV(>}s;B$*v>2j_f+JhsYixdx-1;*#)u-WOtI?Np>gM zFxfEKFxg(Ry<~gIM#x6UM#zqm9VI(Tb{E-QWOtDrBRfWRj4T$U0I~_PU1Yn+c9HES z+fBBcEcVR+WH*uBOm;Kb&18dQn+Yw1w+Tyqv7i@jo8Tf)P23)Wm*6A#2?0Wo&_rk^ ztRS=yRuWnXAp(Eo%xw{Df{VbWc6$h3f{)-Q1PDQbLaVqff=zG{*ivo}!AtNF{Dc4@ zNN6H76IKvf2rCKrB{sxIun8`Lo8TdM2|j|K5Fi8zO@wB`3PKBEC83oNBD4`!5mpn{ z5Y!^TBG?2M!Acr-c6?yh`{P z;XesKC%i`Z1>wI4za+d)c!TgO!mkM{0JeouN!e~?`xO+y#@chILJ@3bx%o?J?nMHB zVacn>r|kP z$A!m@rwI?|&f{Fh=}i?wq#)5-1Obt738yJ;Ks1R=uQ(BWrw)!4T2MQ1iDr8}nD4CP z0`3QdAHyT|I@+4eWCQeC_*ff&uMD0UJb64NJXJi0@LU1KSzIJsL%5D`lyD>ACc-U* z+X#2qm=5867vUbly@baAOPxr_WqaMW*K2!&wztXlHrw76NMb*oUnIOlc$x4j;WfZj z)ZDB5gl0l3qG1|W?Ia9y1q;6ZuAPxHx6yCv>Gb>j#(t3uwop5t&r^jk(4Ta7BHf$h3bzA+uPB&I6fp$OM z9W8Bfy9q>VXb4VgJ*}NwTVWmI{A=zEVDG{FdAZBcq1QbDu729Fx^xHH1B}fh?*J#J z9l=g4gxV#+v5Ue{7YVlqxF%!-^sWgqonBTM z2;_#Zm7PJIX_T?8mAS)Wb9H+Mwt)hzfwhPLrEA4nkdzCniCyGSMF`s(Xh%x~M1U%2 z4ZsneK%uQra~`_1AS4=yB(owiERF&J<4%(9@aRElkPM>bgTEE1WRQ|(YkPZVbDe`& z|3h$T5s8oC@aSBjC7G8%D=H2IVqx+SNPJvflL<0yiK<=VX*qd$GVM-6t?g@2S59z7 zt3#dEx$-TfIutUuN*Bo~1(VYGX=!aov)gQYKZ?Mu39QWQKr8l(^*bff_ha1%^~5i7 zTTn7)SZ`OLS9!3-w|G6aNU#TS11z{~GjMTrb6cvlQ+A#7t|InnZ*Jn|#3#gJ-i#l7 zbzC8nJ&YrPw(+2Xmm~BtjvWrJj1f*#SA%NCMg%%E>@XNV)A=xZIWmi^x9yb7Jf-)I z;0hr(X`87}+%>$pHI$RA%P#A~P%FsqLwD36e#S-N4#X&B-l>I0$Z#W_k=>3sv>1Do z*lt_bwq#**sck1VUp(BF8JD2gIaF=_70Tm>7ItV=MBFe4p`jJ%2`$)K(nbK*qHRZu zUL>zXzi8Xxn2NQ?lnW-sX4{ChfpWSq5(Z>d4x=~7R7R!f*aKq1tzJR5pq2!M_6c$U zYqd%{w>FW6u_XpvovInn3RGWcX^r@5VKI?=GHrXPBz`y2hP`uPKNA}ttPku&?14U$ zkX<6$#I`+{$RWo8 zJ}Jo<3}qNnPJ4c9Gj@E5!l9kK)!D8& z`SG-XfxfNBw0u1p&Tny+jla{li;=Y7c4;|P!Z!)lJ|2yq4lN$6U^0i<8~<7@)ztU} z;OZPpol*OSuFk)?yK_@l*S5|Lcy({<4*rn8J zORa2(OTLs^ZMD=X8;4`b+IOFwzgvG}z{T@D8@rIlmen;Ud@l!o6qvV`)VY>g*W1e`~9I$Uz#k3qV6w{P9LX-jOwcKlq^ zhMuXe3pZ>JZ`!hxS-a zoBP5&-I3_F3%6^ZTchE~woP4IH$*pwV;g$XTM=jPmaQAMZ`#(?9q!q_HQLjoQ~+~d zd>jEcA^u1FU7P*kuaq@3%4Yrup5zBm*MqvEm_bsj@Vp(*H{tfp1~-WCE9A@n#uCxQ zD=jm_w}$?p_jjLtVePwGP7gAU3wYJBa=~Q>dAI$7Ll~W*6WyjQCJ-<$_XX@`B>z2QDy|lP@S_t36#8oS;e@;Y;Cn z&^BGTMVXA)D@{gN*nZDlfBe$l{6We7t2@7OE`Ijg`HPV5bhzd33mg0?#b2h2=JP{T zaQW)=Y*xPC$AtOy*@&hUrk$H>@;l*J7~!|uarFhy*?4fqt}epUk7qBQ19%SO`4pb7 z;Q4nvXCpT$JlNt>0W{7*Jioy6aYQ_V#nS~Ir7p%s%(X~lE%x$W!G_FvSbaZ^9lkfP z_wkQ!Q!0C^QvcS8uxPv@68-fyyrW8;KBm<5lS+-xqkVq|>3>G4Bgc^kEc!oc%_i*jo8B)?9ARV;PWKg(?>0Qt+zdZPfEUykA$aeqjCk}NsM@Uxs-N#S;2pdp^!@Pp41H-ztkU*0F=4I4iE8^C_1 zg&O2N82aa(qCDzT-z@q+rMVF)^VXVDQ@E{V$?Z3MeH|pcAzPG7n`rj0fQd^|1mxnvC#^0*G-znjEW0iO1W>LaCYN-?2x4gC9Dy&q%|8&@I Sp+?bvIT-!FzyIIW!2buACErW{ literal 0 HcmV?d00001 diff --git a/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Pdb.dll.meta b/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Pdb.dll.meta new file mode 100644 index 0000000..3ab420f --- /dev/null +++ b/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Pdb.dll.meta @@ -0,0 +1,92 @@ +fileFormatVersion: 2 +guid: 534d998d93b238041bddcd864f7f1088 +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 0 + isExplicitlyReferenced: 0 + platformData: + - first: + '': Any + second: + enabled: 0 + settings: + Exclude Editor: 0 + Exclude Linux: 1 + Exclude Linux64: 1 + Exclude LinuxUniversal: 1 + Exclude OSXUniversal: 1 + Exclude Win: 1 + Exclude Win64: 1 + - first: + Any: + second: + enabled: 0 + settings: {} + - first: + Editor: Editor + second: + enabled: 1 + settings: + DefaultValueInitialized: true + - first: + Facebook: Win + second: + enabled: 0 + settings: + CPU: None + - first: + Facebook: Win64 + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: Linux + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: Linux64 + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: LinuxUniversal + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: OSXUniversal + second: + enabled: 0 + settings: + CPU: x86 + - first: + Standalone: Win + second: + enabled: 0 + settings: + CPU: None + - first: + Standalone: Win64 + second: + enabled: 0 + settings: + CPU: None + - first: + Windows Store Apps: WindowsStoreApps + second: + enabled: 0 + settings: + CPU: AnyCPU + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Rocks.dll b/Assets/Mirror/Plugins/Mono.Cecil/Mono.CecilX.Rocks.dll new file mode 100644 index 0000000000000000000000000000000000000000..7d820f0cc4eb2ead833303c0e6e2dea9f7b0eef1 GIT binary patch literal 27648 zcmeHw3w%`7wf8z_X3m_MBtvHM=9K_~Lqft+3<}6ANHpOUR8TMs$p9mhIbmjk1SBM4 zt*Euqs?~}uR%=^dS8r{7T-$=JTCMuk);_pe3%yort+lk;TUvzgzt%qI%n)er*Wd5^ ze&79mzi)7_z1L%}z4qFBuf6vspE&~mG3W<7RQ*(l9t*rY z>ItpoYFHOQo!A&ANC^x+hhWNYyM@(pJ-Db;cWtih^g@s+Tqq zwP+qP3l~1>w04L_*A!@zh&n+r6m|M8tj<0RW!# z)wUa$d}@f+Hl#CY77^R_p}-wokCgYBgW+mO$CDNW*;d+*#Ja9P%KOYAnwN)4v22&3 zux&c|=#05gHisyn$S&+e|NC9+?-wr6qZLF!JyQv|Lxa7wwR-hJPZVQdaIwiQZqv6j zw|a$D1`hqm9>CV(ZWSee{;wocxYc%q70T|IS zDAk8;3J^u9t*9-pP1)x3IbE>MfN(U(nz!lIOC8(CvQoBV9JASu+Gp&lQKzbY+$aMh zb0&+xqB>h(yb`D-_RCZ-@L$+tMIjb6s)wveYtfJ`jB(VWa29H+ zp*?wEvWr<+EtIK&Ia#XuzY_Ljn^C`dRJ6!$?gB=ya?$fy`(RURT~qC81^;>JBJ`9$ z9wlD~lO`CM3COl#bXZ4)OhUUG+nvF&>cPSYu`e=cZVFJb|-{W4_0F16Zv0hXP)8}F; zTGK$r(y`8R*dA*-iZa>GW?F!KCVh`d&v~SC&hl7|EFG~`!q2u!dx+8qkhw-?Ko(9Y zXD6J)$~~?V(rvC_?H`pkkJ#=mZ?6S|gK98rmo(VD^I9`mTSQD1ANKJW$vmG0&V*sG znG2_@?XhNaed1v1raUUguKuMi@aw=B-b0}D7;~K-C8Lb4KB{mgrZo4JTT(kJo1Ggt5vR8&iF&5CBJ69Thk$P%{)b|Kr2?RvLgoC zXFIS``B)InAfh1rmF~d&3>vy|+*pc2W*LCB96-^xGq?6q9)P$z0Eql>OI_`y)yFfK zw863Z4(#s1v7Q|W4m^0=&gEzaaW$OTg!ZsRcfi$N){}Ad7~7c!(tu0St&5>zf~i{= z?_j-=S&0mL$|_`RV-m_TmjdBosv9S5=>((syby+A=pI_L)*>tLTdN^iXjZis1u7ei zKvhFg-B7c#!-yjO7@ddq`IG@{JFuVyj~Zh=Rsxxd zFIdAAly=zupfOb0#|EKKsEW1L*NH5Os=*0Gy5YChqhxJ>xGufI-tQ%Bb5sC59`Qra zW1)^w;ITF$D>PU-sIM$)VhImySM*bmE5oqv?@R+|D={zJ%LCPY%g0vF& zIHblaP|*zg__Sg)t^pzg5-jnD{hxwWT8UX+608e{%`nVl&wL?_SzZzh2gCj;@1kbd zw8n7VQA&|vVFm^{Y8j0ohs5<1>2GK=?CVQ{5bXk(Py!Wponc((-yt9*b_t)2jK=33 zlBmI^Z!|vUkWwr)l1XpP!7zn;cR%lWLg6tDn`Y@wGNHV;nQqoy*j@Av%DVTcZkE!y;AC8_u&?4J#Y>LPTM~vr1LLXqaSE8k*~Ns^YMQ z0#&GMD5={7lfr>4j>4LCCd{n6R1sjeoKlRsW<_XVLX;&M!+{>gN{Yfo6AGDIq!`s; zaJ`aHIHVXM-n)6ZZ$ZBhv3WHF&inA#i4(QcbzV+5PFx8ZV#_eBr3Vn|3VBT;PQi`t zDR(PGEClsnu#q=Q`eNBTL^Z;(Dh(oug1(r~2lNYjz#BP~S=)I1G~&s~mU<4OR3 zUmv=xmq&LZi%y1f8|UW86?x>^9Jw-&T#_SK<&lrU4u4-i>$U~}%Vo$^1BV9jD)M;W z8^o*3<8goUbynr^ZWP|tr){r$5HG*I6@z&B?KKYK<+nFncO8yPOuXXX41i#wFpBDU+z{_r2jpd;{cb`iw&!gV#QY-SP+gxg89<|e@ zR^?F_yVRk1)JB&&ERQmR8C$cK$KNmf z-L5Yl5&U`=-zWGDE`GD%H@bMg;Gc5vx{SZ?CKp-n@B6fitn&AvvKo@Q7JuI!7dg-0 z_Zb(N;_v&ci;VU6-QpsZ{=QpX1bhE&4uWv=Ih4=&#NSSwcrz5CTvnfw0-D};Btk%U#6`mRt=%UlGX!R%pmU^zx4=qKAhq#+{ z=@v&p!@2{|j(kNCPn4rv^{A;A*zR8o_v3ti;>3xaS4=$1tbv05D<)4+17{|3BV((p zSUEP>_j%}u-U(ps1&~{wVq13spYn;?VL0SGhv0yIof4bB01*TRH$)dS?tmn&3LK&f zO$pH@-iTK$E%AkY)ivj)u)@N=n&)Aiy6f{H=2=WT4sVa5Tm^x1fj3SD!IYVmEl1a^ zFG6WiploVH5p`=H2vfb~MRho9-Hq}DZ=hmjQJ@K_i~bst#D47H*^!Bl1I1h(}n;Qs?lzUpdj z5p`d4@tK0(@8S~#f562#VA+<0h4mm<`IhiG>z}aXAy+eRYi8fWF8;5A|BH)%NpLJ; z+lQY4Zd>w6VPWu2vV>2cwk7}6_$fd0^CPqGUkB+Nk<;n=S;>1u{_BI}-^b7^8@|lp zmrv7WtD1tK^0X^M8jHjelx7~tPeo9X5W)8al#4W*eK^xA$JWg>`<`}@iDuuoTx4|EsP3OKJZ#kT zqtS^arW~ik#)ca?^vX=c;*)@NCC*t0SXzF-(xcNkx{w>UMnTKXyzG#ixHSw%pcSAG z;q@ME3uJ_$P~TrMHd;X z_x->{D)qjXT%q;?MW};N!pP>6| z4MjET-__BKJeR8B{8YWs8C>1ar$V7oOm)96!JMsxY^liVrD*WSXeMaXqik5Oq0D!V zpCI={f6CZj2b=mcQ2P)M)bj=?!t;hKn#ueejIsU9;m7cGQ4^qcoG!aj#Y%pjpcAhn zNDS^j7Qq~-n4sffb963Bs$U+tbs!{$J*CTZ>)+8peX(x6j@)_!prS!$HRI*hF95Og zzlki3+1j1PeCUq;5@@|h9YQH{7@)wgeub>u`VT<97rljCHs4>PkX?q6D+2XxreY^f z|0nAi1FXIn*a;UasEham);nO-m80+*E;to4?*iNA@ms$|zN`Xg16|%1RiH2BnfE}% z1e1RJ4&?%wV2HrMLfwqcL;s76fc1Oe<1oQKK<-R1)VI%6My;A(B{a6tnO}HA2LJNM zBYv>{fU40W0Aov|e?&H+ARW+fWBe1!+w|x{v@{lvw6-uh))So%-1-nmZJ)>bh~@d6 z$^uY5)}I};383o`2{KtWwC?EWiCg@)}(>uvig_R5`sqe)ab0C5<2?=)knVnUOKp49!MRc4(8x?OD&9|+we=LY1r{? zvO~8DAX0Di;ldL{xcCX0>BBTs%O7hK z%l}GDi3}d8VfizM-%r%3cUy3Xd`_#A!%uV(>h@vK^Yv}b>0=JRt+Ms~6EzSs!1j|7f4txQF{z~BaT&yE_PdUO<^g}ZTZ#~5bAFR&ZF;R{7r-_AlfeSF;D zH7chD=}o^LJp&}%1=ZRLlU~A)<5j(fkdJWd75JMxATW0<5<81C>QefwB$ z8INa!dWDcGf^T-^xMzZ4VM7e=z-!l_Uj4Di)Zwi%;}%vShgwy?(y3qX$k|dj*dZ(_ zyY*7hR37AxjE9alWRK#$cwyJQ_o}|6922CS2?e$$#0z%ocDA>6sCqYv*Gr7vSOX8> z8M)dYM!G(zK0bAXzMWm0^YqjLyrvo# z3t(mKXbhbcKqzzwQUIaIAxHrPn5?Qu0R(tM5v1VE5hp*#qszOKXdTvBMQuYSg}gt^ zbsUkA-t7&_9yPtzd8~=R_3aoZubdV<{Jyykl`~wKj}~s_b(wC^@Ir@$j~knTWN?-V zLKwT3(a(X%6&{J#uhJ6Uy>ecw@bcptudjJ+7tGW6hKdimPg|xnOlp`qY3gLGT)yoj z0Utq(7}JL}h`{_CF1KaViPQ$zg?6T?C!b?3YNMrRspIpQ^Dk<~K1pkVA40eqGcRea zV_|%-9<)oUzf=%_C+V-+RD!MCIy}VZFy2$-UEGbxeMm4__$?@7K5%`RTx=^ZiBU*g zpO*;ESd!p3d^$o*$6TX33$#*$jtIQDkjr%i-6bV79t|3J{C(39gDw%^`!XD0raAp!dtUd@LNQ3eiu7eBKkH_F{%Z1^!wn7Rm;m`2G^~3x&Sg zV42}2!xlh;?$T}!h3K3BQ=Ss|TY)n~{)G_J4Nwd!hUFpp6DS5$W(oFnk-VW!_3X8KH%%fFWLSG2#f zX0#HbwyL(!kLg7m)I;-xM}rGxuVz=s$!rjzP=9JZCNw_}2*QxlwG`C7yXv+lX3+MZU-T zd4v_Bmv|~;?()B4TIn5MHbct&2&3nO7}KeO?uJZL$@ns!`9o;{ykJD}Y6bgFnZhOs zw$sLD2zIND%@S;}jm;Kpy^WnG*aJ4UNU(Eltc5&i?+n<&7jW$YV?G056WK$)aXar&%yns_kF;ZL~^e;g5%){?|z*5 z-uAu-of}JDG^XQi$t(DJ$Cv0wpxj<`SSUw8(dZ*7SNgd;9PmPc*8(oBf$=m@>Bad* zqYj199`87uB2zZ@TqUjt)N5l8nN$28y4}Y1`x^aT@{J;V_Rvovv;97rFW3N82O9kb zwcFVDsuuYD)MsPc$}jMn^oWf$2g`f``on0}GC*erSNMapVvNH6TzRR#fcDtf>fk1S z5j|mJTY_o-5c-{s-5%WPFQ!#zsCwgz`}|?L-NxSbf5KlvqxqD97XAXcGHMa*Ir?Q$ z4?^{7!EU3Ayf?x_mE)A;d-NH91x0P_MY`QzNskD28{OymqQ8oMV`I&}@A`+*3BmTz zZzJFJ<6I}7=X?cbk%uEZf1dMwT=+A8wL*ZE7X8vMZV=u_+B<&fj$m2+1HYIh*e(A5 z^q=Y0+vY#vAMav6Eb^P!k>&H8&kVieuXnL=p&{l(7n|&_G$*^*ixs2IsV-I)tTVB( z$>%xWF7qst&%yiw=ACWMPzbOA-y-u|suXi>qaO#Co3rQ|!S>K&zUAh5^p=gCS#_y7 zms+A+bq~Gi>oDijEjIS5kuVp~55@33G|%5{E~G<(-A480z2+i%Y?7+i74A2i>3cTT z8@|D8q1Obvjk=0@&BgQwn>VDa*IYtZNf&RUk>{dZRJPn@-eX=&3vBEq-~Hw#v|O;;=trerH&@Xf z8~dWM-@KIe+L&4Kym=YDWY?=L{Gqv;ZWovCp%2TSH!r7SHa2d^>t;JGI!CqlT;V%r zj5gZXO(pM`9dyXXR+heF#%blbO7h{tBjyHrM6lcF!XY1<32L0lyxZt2<%NMH-DqPY zODY3h^oEW7tfVlIqKUJVSZa^c5RhYfcYj z>0fLt9he>Hp(ku?RbWxzO8TCSEi#t}dg-j$s=e{%>cDoIWn)Lo&cIdFB-phQmv&IA zV7m})Q`!!?%;ov0kFFBzu=WIQxI5`F8}n5S1=fEaw=h7zKpfpkdj&fjSdPWLlkQcR zR*8GrPI|!R-Beiz>zWTVePAtxxh*VyVm@Ukqqpl;WqYtBMoeHKfK9itCp^7@0h(=N&w6$OJKx4`D%Cw#(-IroTY7EaYFcSyOG`cz*hOn? zY<0=!fF%?rUb==hpM>=awu=h1y8_qHb%O1w43^v%xR!3olf0Jp+L8~@{ovi3$GeUm zw0ZNiZv?KRX9ZJQcGIhQlDp}kEg7T(f!*}SJjv_nc%J0-WXvUecHzu>C~!T6Y-|Ov z8>rmIJ`Ie|$r_FEF?_X>;c+~0(C9yfaw|?6PWjC$F7K7|wvthhkK8(a5*Ha&SH~Xg zlpSqM(dn+Rq8AtIbc<*+aOBo(`gOw9MbGWh?h^*ry1jyB^2;GVQyA(rS0w-UmfNI7 zrSm!IuPQIjYj-}*vyKheI^DAJiIP`dRb}N*hB{6XEdTe)XNhOFpkF$vGDDrt7rGje z7vLpbJm8_ZGEzB;MoK0hULkc^Mk7_u=jKLJKWW_aWnx2gw0N<2CMJ3q>hvxyQW_ls z{IAL%VqWQ_>au1vXFT+a_&Y=6xLZgMA;Qkk&PHUNp*@6% zT1w9&k~VA4BZ4jy`BggC+6)aE?!*c%^PNwBW) z^bYOWP@Q&^^uQ$4J&3w&VKE)lZbyq@ZG-PTZ3Wd84aM8YQAOiGSt*ot72{~N_;9t{ zE>_Dv*(sJJ(U+8#McIe%JMxVpD|d`L=yHtIfL;Y3J}G_}(C_hoL%T|9y{g5%&ua(t zf};1d7xXcP4|k`9VIN))a_L-kq`a%5&;3}=ryd1UuRM-j1U-gZkY^&-5;e5w{d4+m?QrN${avy7Mj5Y1wW9L<`Yo7aujzYb?j6uxH{OBftoc6RcZ@%w ztz$(S^}F@yk)tTrcsJ^gYP{PX)W@NGKzrLLLith8MsW2I!~3OtH7q=!jrY~jLH+Y# zrauy7cs{fp)UOvxnV-v-RxqrW^5s%~MD%<~;Nt?nCh*$=7em8d;`MSsJIhzt4?UoEgy=xqW=2)9t6N8m(}IY8XX3@Lj=a-P850zV`0 z%K{%3_#MCl+N_Egt#ReO7HjFE3>)^KY93- z=UwfiQmkd|&C(k0gW~xIWn7MEk3+-VdVkS0@4H&pkeS}2h-34-N3`bBX76Jnqv`u9 z)_4Q@sG>U3BrYA*-qwrhsP=8#H^+N;Eg#iBEbs6hM%^9I&olOEnX!kp$|0ZfJ}vWM zKp~d(b(6}LAL5mL~+8oiYf}NY`mB0Z|c9pOVtnGWEZInLL z_e1XtPh-)~yx$X@qx2tD{lYsJl()Rio>JqF=mny#?^W%(km+0InHUK9j(}2z^0P&V zZ(46?m@j~KNBK0ssP8el%KI8UC~yybA2z&1tyPV_*KF^3f(w0Bo@_p$(%X|sx`x{bs2DFv=<_c^E{H$-8z$b}g{tF`imPp1#CL!>564^eKXm(7Vo^1A9 z;r)ScvuA=gM#tnC$}u_TACo63$K=_{F?o`5OrD{jj2-G2^!org5+0LCc#QazzgsKz zzYoiw!F(u$A8x?RnTkH%K_%Xy*kPB^Q$_=x1`P=|;Qf0k;4m5iIEH2d)=?ASRJs`O zT-pIRpLPLWD6oz8pnRFoJLs#y4$<>nf&U@Uqp{{O0_O{iX`4Xlkn(_(cS-qfDc>XT zfWYqxJS@=(FCU=5CqLxOVz?i09Q;2{M~ zsT*KeBXEwuwF3JE?i09Q;30u{Tg>tT=LlRYuwUSz-~-@N0mHQd`vvY3xL@EQfmFDO z^$46JaIL_8f%^pR7kEe@6^XpS1w+1$y0_8OWN4$b>Dm(Q5$&+{fmVSpPCTerd8TABGp@DA}NybpPQ=lz>^z;~zbRo`2_5KdS_j343TIhYo}>6JgKCYOfb$u;Li@IeS^2)s~? z6h?~RjYbJlsV!ecw~Oph`U#$I^1JfC;Q1`SAAJC~EquGnrcbo#lWqD`7K zqUsd8YHK{Z(dv}8gv4s6GH-r59?Qm|lYe{6`k30%+0ouSjoFu^6WRFObUN0{eP~N; zNX4=}>9{m}mMgF{hTnF_vvJj#8BAX#-KCjeWkj5{;@8OFwPjV_(iux{0B*O|I@u{r zKE-d$;!2b4%8YYmNG?ssyW^?OX0#rIJ7;&I(`zTw;+|wOwk{b*vAHSL(*>@==5}Ng zR*K2dy8epE>*N_Vz2&v2HGQwYM)!q+-cr?_^pYk99Vu zvQwwfl2mglnMlPIX7_1|ZTA%0ZpPW}DNu9jXs?|@3wu%>$n5GWp*ssY-6D z)BN;l`OO1U^&K@1-hP%-Ve)i`=N8T;OoA=#&5aJHk*6`uY_&RjlJVKNuC-bzt6_e; zBavL$fS>4R;@S3Rl>61LQ6chMRMt|62B;A*HDF2yj>MGWbH!IDa1FkWSRk(+zi7N`CY&_Pup!X zZ6j#|dW3}%>x^Y%(mfaH%5+%iWMUl;o73Uk^vN`wA5X>8i4I%8JFjvKR^6OY3s|+P z9HH8brD7Z6ohvqCEp|3{qLE~Kdm@#{CSpmKh)A-)!s74hil?#=;+ZG4=l7)3ASpqb z+u2EpPIo#iOvIC&B&%2zXF7eFy{Wx@UaVsiUP#-V`S>#or&5<%85m-vPUT#j00%4X z6h#-u(g|K|nNwKkglcTP*u`F1(v78=>J)!FWy_}7Yn$eF^AeZdUW8(Lp4DTcE!LI! zC_0BQ=l0%4(dv?PVgs+)d9h49N6o_|PT3rBS5B%mmhIRGH`x@CTo}vd38+@PRJJ^h z2;LDFYZoIdX1WGX#$Vz7pcRZP+a2U>Et?{mP@pKM{ zZ7LAwk<#qVY;TSNceKSf_eg^)+N_>58lE|OYI}P|m3dTnF36BbLAop@HDWGzNw*Z2 zq~h~>vvC_+aizsr#zw8~4pxTsE-qOV%QSakx>Iv%i?s>#WZWGur@I6b-SQTDHs!~0 zYUYj7%J3|cm9W6-;i40SZIstY8%8dVW24*;71;=XeFOo{9WLoLkDE}iX1fvbVo8^> z5F3jiGD~Jom6bvOnswo*zVMp)ttSESb1rufoCDuuPrsB*3>2bXO}7H8tP z^m(}f&8y3!A*j=?%j2mo$nto`N^Xg}xZ4eBer^_DQCZiMRkCc*f_O&~Baqr4wJ|Wf zQC^hljHi>m4wd`Sh8TqHPtH1`Y6V6&<+i^(j&p-TrNunF#j-Z_bc*FXJ2y;=Hw-M4Ow*Ak-y$S0u9eqAPH?z?Q;6?@BAZDW^l}ji(nS zIy>X39KC64HlAY3b0kOgLYR0lj75mBE=zh8rBwlR-2zom`aO(tTgJgUrZ8RMLi1kOwISx}t>5#%LoNn~kDY>V?2AvrJmE++6U)1Ki{bB5Q< zlJ(RQ%Ve7osi6_@PGhCgO5WO6N?V$#HWSPS@s_*ONx+GuUqZO7-XA=~ut!EwX zb6ic%yExlnV!HL_;egYzksM1M)V?sZU75i7f*`X=j`eDeN&C&2ixcT=Pb`^#aBY~M zI2m7Vb!^HsbS9IqY-Lwc)x<6&1&JPVLbo+?_?E->MJe8UadM`4a*~##vJm+cEz<60 z#i3mGSqbW7M{J?CCblM0Br|RSCYdZQ>U2xZxrxnZ(>zSgyF7v#Hra32Cpu&ev9ImP zruHF4?UX%9m3f@hosJw)8;waQcZWE>-oEXTbF^3xUoWR@E0sIT<5+@`#3IE?r$k;^ zPHMRtq>gHNgj2O*)c9zTC&QzWhssWvhc~P9Tpq>UuJUM2Td)P?;fNsJe8S5ku~VFb zyBug-WU-ZP=5@{6SiG}oYe!tRO#;2Gr@PxqpG0ltFz=jvbHa1e8*rmeWta41m#kkN zOKpgs%Hs=oj*7!xEScz(13tSp$8mJ!D6Q6(_zDZo<5NnQ|s~~(KrKYXj zxIVPTI?||u^MNW|8VA}<^WvMG@o!0_HseZ2U2e%7={}7*%qK=JRK3s@UR6m*uckzlOAN*u_^D-7Bx4w*cVJ;I%R(9 z;FPzh3#ikN1&P>(l$C+zj8u_Xlflsboqf#avvJsh@-Vful@f3q6oxxR`&D=4_VXNaoJniz;%_w7^et3al`eg=f5FoH=_KZ&e{kuKMld*dEcho#q>I zJDAJMTaVJ;ygem1$`YthCBbL7^}ROAjk!Hm-WnV`TpymwkPT%}b#o4Mwyy>`U*If<&HH5BUNw2%aibIh zLj#U@sKm`F6J)O1MP&>hQE+I<@_dw&;*vB5FV+Lf!bCcQr#ueojE;R_Q_nZzYTJ`0 zoUYLPo=n#2a*xA&b?>sLUC;o%F zPLyY_=ZnsqJ*B-J_W*vLsII4S)}T0_IK*x9@#IaFnlp>zSGFbb7nU%)ar{v7{M?+9 z40!uq%zw|+cFhVdV%ATar(l^U7alL(-yBuF#~g2%IlcW zhH>r4w#HJuWOcVUZN_;S7a1-$r|_^qVSGIAcBe7(ZM&SAf?ES0S(c>bnZN3d9YuS2 zzPaUY`?!VoJotWU9KZBgPgKFDjdp6Ht;myjr`Ca#b?MFcHvdWVqFJ;MzYJK6ce(ho zt?x4asl4YhB;-Y1(AtGJcyWBspNg;&@eThpG{$XS7H{q>{^PJiwxE@av}CdD*=_h9 zQ3maD{RV17-XV3_mR?Yniq0;n#q}&oL7wVQN9WpEJoeAxUmCLOpouk;eZ;hszK7eo;7efqmFm!)er2lTMguFF)$p^x4Cfo`_poVOguZAN1ccF4* zmM19GSGCB%3=?cApcbo+%raFS5LbZ~!i!WrgqA3>#wd#^&i{P=%CS)GeTYBMJ2yk#V=g=^g_k;nyN_#OLo8 zfcz6rq&3q2td5@~>LVd5q>&hrXGdy2{FJ&?5BR;2nUVejJ`-N|8GapQvnW>;sGkK{ z1bvURdJWX}i(Ghz#|ZDhYi=D5*x|=04kW@m&hQU`FoYt-rZ3$8P`LjEbA%b`e_6RH z(*Im=TV=7$W8j^h){HCh3t?k^X~bPQ#-Z9!!ac zc=`_y`n~AW;UI96xJeWY%uut0D*XOPtD~74R;HLdm0B6BD)xKw_+Voe*-{~t@_0NT z&8UT86_A_itsz+0ih;t4!RUO;T?5UdK-{AXh%_U+Rg-KFG}%}IM${=+7was0t2Po- zlQW(qdoV?9BK{UCENJ$@g8n1LevJOnNdL#-0Sv}~&s{g5I{rQCClA(SD8!B&s1m0Q z>~Y+Pib@a#5%2**GX@XP?m1dG8W{+vs&_d4IBN0?3orv79|(tdz97ectYaX+ItId` z1KQ<3(LNAXDnNnC$iQ7N4Y6dnAa{rSH69=%hI1DOiZJlQp+%wnN0kj#(!kd+z^Y>! z!i$h(%p+@t`=O8>!cpZ>9xG!6PcQZ)7FkuXX8YLos^epw166A&*p9zl4)<|Qq}fD# z>A~FCZF>#z2~B~s1~V`c9}!t&M%HlH#WYw0nQ0P8R0NTb!a<^hbi?!!eDtK@_vo0T z5;Qn;L!6_P2=UTBz!o)!l;zGGF(2Qy`r@i-hjyDwU-{1PSDyUg<^B8c#ar_B6WxMc z!_WbMFK?TRuNL$7Ni?ck{l%T$X~`)UOy2UBAOHU9bH7u+_Jh~I+kWlGUx@#9cJkF> zFaO}4d)j`zZ0h$PT-|d2Q!9r}=sNMom+C`r%)j-n*ROptGbwof=dYgog%5XscXWI8 zTjRfCF5UiQ%rv-`@)~A-U%Em z``qQ9{PuhQqLIgl%nERDglqaA1y+o-AjA|qE~2|b7|mN65NR2$XeTpH#vry-bj$c6 zG-;8!0-FRj3v89$sa49$0+8X&h&M7w$BQRvx)6Be6CBQYT)VKjfV){>50gBRUg50K zp)C|acmjWwOw0b=V~SaaELT~+_Oj=#!zGuTGWkXl&mn{zubuns+_dwcofq0UVz9`E zOqGwoW-SEx)h0z&xukD6Bm^s4>PffsEkB`~t=Jn7zGiX(-O?g64Uo;qOs4ifiX77) zqjoTe?>VdBIvlIrE`kTC!@NRTBdwevKyl4hj+KSPednMT>3VRK^nZjeGYR_$!WeYn+gnO8no(^_)`Rs2Rme;~ zOc}tElzbG&Q2Gz>$jWBRyR<@{EdUKo%RJ@{q*x|F zu~~!8@cxdkRB6E)-ns>axZ{E5ky6f^;Naw8Py`j;D4*Y=G~5?Os|QdrrSxnt%JE3G z3s$k0zq5tEJ7OZk588R1uh7dc!8da7X4QRki0As&l^G3k92fATdW{P5zO^EMiFcIy zDy8O`uhmSMG^w$s9@*r^nhVy|G;N9DVK(8{u=wC_k(iSjCQrr>`|RG6JeDeEkoQ^MwxI2qxu1Idt#97d^5roD6Z^he@eJ#jco8m$ znTeb6RgG-##H|xM<69=;7RApE+FKLpw3VJHUn^Re*orSt@b^uubnnCt{-)8yG{4-K zXsx?qBHpaU@e+GtDxRG-Y2qnE(a_zwj@lN@opRQ6vW<9YtZf8$^k}kV!lDgde0laI zj|B1SHup1z%QY@~Qo;EjVJITL6p>z#Ot$hAkuLA zyhP-_<^A9|@8t!8<-YMLKb!;&8@;{2Z2@EpkThuJ+vP&sR{7T1j2q{A+(P+-U+Vy_ z0GIEf8Swees&2p{K#zF&Z)Iw*N!@qx3hXqRE)bbXA~t7O+in8=fNH-F0+b47oJuIa?<|elq?wpk+?{ zX(9goJ@=UJ=xO9JXm)StxUutH{~xv6fZKW!|M>4Qj)JZh=-D7z=A&LWo*!^;HsIL< zo@>DR!L%Cs8WzA5@k}F1^)@z{7`p&|s==6VfyM+Z;m-=Od5Nu;scf^;Z^q>5!arqu zBYq*K;W0{tCb_;aY@^ONfh_WbGmevZ_ei}B%SLHyJv2~X8vCZ0TM cr>iSY`0oh%)!(#fociCmGIx{ZuQLcNVZ3kXLQ&e8Aoz6BMB_oAW*^;?!#cN$Plo@Z3AwiF%TG! zF}XvqIdW}S5(pvrHg`71CL!U>0l6Xf>4aS5J~r285A*%rtLmASER)^u|NTGNJze#x z>eZ`PuU@@+Ro#8cIk!5V<2XLo(@#6jN4d-25&HYgKRZZXP`+=0^P$`qmw&YF+wI(WgwgELoe8QipG@aR*|7`!sR=;E=?&hS|l^=ZdA z&dF__b5`4jew5VqLubFieA|JJGt%xjfq`}%MR<_#M(&QYNW-q7TL418{@qPFaQX9` zBVHz1<$vpLqXOdZ{v+F+QzZc2hB1;Yi#D?D`GMVtqwFRuJOI{ z9hEAk!9UP``4ie)r``GWde_k_?rt>X-g^tyEcjx0(6<6+4*Ufd};c8p8pAa|zCajx>B35o4?qt)EO zyGC!jHfh$zK@zJgtS(`1*QV%Tf%%O|Zk2Jj=WT(L z_j7~WM*84buzu$Sa3JpnnPLW>9u9q(N&smAspH@3sX!Zi>ZOs4!$Oy{XYpbRQ0>x* zVI`t>VwqAkT2dlM7rEZD>1YANd+_u#jvOD$&mc5c)s6r&%_w(FN1degYrP!+7ENc1 z{aSH0I+9FXPBvOdjs^l9dgY$!&b|w~{Vu2AYmvrt0lT@NF85-=*ODft#d8IJy0hSy zF6?fnOuH#_v@Ij|VxirZk(e#hKHb^MeT>a5_f~F+&6oRFn_KR!+!C8F_i;A2+*`RN zHeYUruC`U~t=tlumD_UW1mMzqZ<@Y4a6p(Opca!PrUiE|><(t0N4FG$+KB+K@5x6e zanEOh_+;+8M~92unc67?he|Q>8P?FGt>j?1)ScPw6fz_3p8nlVrg9{uBv#Qoireh^BtS-7u-jQmw=1B{gE)*tALy>`ESYDs(r{=BCuUf zpAiL-s-P~vMTD4$<}aoUy$Xa3n)_>i+i_#v?;pL7-qFHyZwH!NgWGNwI8 z^bhB~g=SBFW=>@!5b~lh;>u zR~a_ZU7IRfyyAGymN_6P<3&hkSP6^v|3ToM2BK4o>LkxuA&lYAR*QOmn`qK#J^6Nb z4Da@acRRInh+LoWG$Ty(kVAM%xXn0*q8^Ri{zf};yE=Nd1Zcq^G+ev=kv)@=muVVv0`3qFwbs= z@?7RK2u4R}lfq!}gj+<415+}XuVkrmpBrD&BsFRGr2;7`-{z2gwrNw*^DT=mBdgdB z?aqGGkG?CI1npkSfnty#mfS(*^i*?KSrIq(2jfNm{Ne%ap1*!kTQU%qT3#kBoi??2 z>mxyFJKHy1P2p~n&t&p1j-)}Ap!pAaU1v2lDZjKcJ(=RI=pEQrNrJuS^hcY7X#J%h z%s~8rrE8+Cl2DioRZC%nX0Mv@LOlc2H*owm)n`WUF$a{AF-o|< zIYuv+CXF$e`Ux!F<5r}OzBzS>Y=^tEX7Dej{gSTwlsRW%3-7`%gLeQ~-SYV^ZwnOo-8Vo4o0_nT4d1G6J%Z@-ER zL!%wTwHHcYheRu3$^J*r%?Mz#xqG8QjVVJW2eGENO43bxC7BVey=JoPa{ZJhL(Wx| z`9>^#qs01aR}13*#%;_U!O#>{RKjc@K|Zdbq={GPugF8H+{z>FXjf?`H4O|Ey?f=p z$Z;z!(_Cpf^2tI}BI`|}iw-k7R64`$iCzTKkzji#Mr_56uOqg2qQ{M|C*a0)sj*nw z#*IWKO%nUkiKax7L-ix}gN`N7jo0LzpcrqbSo}!n1nWv+b-+M_7Sua!4BcexYAq4p zK!NdZmXL`7bO~}I>#~ABn)S9b`}*rDe*FHx3BqDN=xU30klQZMv^2ckC$J~D5^`!cl6`20q{LWJ)pfhOE!N#(W+Vur7nA-y9UIi;Iz7(X z3!D%VoX>a$^GeU%9?V9(MG(J45lc#p*-@<&K_a?vin1WU92dey^Iq+xk~3TvRD4in zW}}J))you>q{Pe!Rndp8BQ)hjr^eI1Hon>uWa5{THU2Ar5w}#yutvg6eFd=bADj9; zUB62?Z|2*~yYVYY9B$!QnJKR7@MgZ>O!5+>zXqwvoksh(H}hmOZzau>?CgeIB@KC% zHbhclrh^two=saiT0H6S+}ep$*JMg=Hm(;6uA3B>q{N6rbynTs?EEv5|J9mbQexOI zb$`xwf!m{;&(AJYlR`IZAxWVlD8%}0LvfE+8TUtg*W1VxddUU_`eGuqGb#Zv!hA{c zH`qieai~AiPKhV9$P*ZK-iFQo7D}DpKEm4Wk_}I2F-ezlPhfDwGt!R?yRF=1pi38O z-!lLmMksyw(8=$PB5+4$cWFY*3a^3&PBXyWi}%3giF z3pC^J_h$as%*xnq(>Y~<$l&PWWvoW`6erspH@=0;#=1`Eoq%4}G05tS8K~8MXuDNt z^Rm$uGCW3vO#E z4vhL=mnv^|Zx#jU>93a5kQO&7@$J-P#?$kuL;hS-NBmu=^7J=)4Vgxy&iDrkl-~$> zttzIN!9q^?P38QJ0_8W_%#Y+O!86wpSx1#%3*pT3!ytaRo#rp}Ml)`_9<5mMN*Fgm z{21W8T0@!oYlR<(X~xqIRXoeUgOZc+PpMFI2KCq3oDlSSY1+6OpA8}-wY&V0h3=36 zY>b}=yplvOd18YB(8z0$p8>?p$l4*))1~!@e2uz`$&pA{pOvtbJh_=f?WoM`UTkDw zmaG)_Eh}w~v`b|wdV{ci@!ZTP(|~0Pala3XA$#PMuu5IO5z=}6QA4GOjNp4`1|L@f4)1~y|8T`<7pNzm&{up`sa+# zf&XT{rTfn3tNquFEJXiE`^Y%>0p_DpsdgvP=uQ0OnSkHS{YnIH1cAPk;f~r8T9!al zkI2#0RR(hyj0W59B4;It@0QYUk+6)9BgnT{@|pg3`zoyD?jbb{%B$8Ng9)QvT}0o3 z6uqhiw@rtPZ+=i*d+OfksOB=+Vi3O#u$wJrcWsK_PH-q3{dp$-Uxcuz)6-$c z?Ac|j%r5^V1$IbEj5asZA^m1-1pFB(8{r*_+u8`7vvFN5xZbI_BqgS))<#%E8+x@3 zw`R<@`Yzx7@qFv_`w=y>7gi`A0h$f2c-geoQ~O z@h{Oc(fcV%O%ledpm*P(?=+cBWvw~!66j^UgI;~Y6}?(sxc(UQmKtjzcl5Ph5>BoJ zmcA!>lRU{iC?7f29+Z!fd8Al5){PH={2{b5|k9Q)w8@_vUydZ2*+oL}zfe+(8<-5M5sdon3ua5gH6jWBOl?Cu zBqe6ft;)nzsvPCUe-ZU9ZjoLHH*=oMMT|@OR%W{}n0bm0P%e)S2QzNWK5^Vz?Bcy2cW2I%W_=LiByy=lJ|q!Yclb^j{9LG-QeW-E zz*+dC_k#Rx{DncF`!(Oo;6Gz>cagAMw~Cpr@5d=SsI-YL>EC>S8WVJC7`nBOaEm|6 z&)`vKoOslpw*2m_8^j+2Am}Wdc7BgUf+g}>@h$U6+BcY_~d$$2Z^}($zyG>Ek8MBg9G_VwB<9E@3T4m{A6H* z+5F^xP_tkyNusa#;vK{N&%@^dL0B!Qa~8V1Dw)Hn<```7Ik9 z&QE^P23O`MAF;tGKlu?GtmG%(ZG$8E$+y^GH9z@!f?f&EmSF5iE?XK~G`&Ps zB8z%fC}R?vM}u(itps5Y(}F@6lg#lNL^@t>gFX4`_CdmheDxZ+_vfoy}ugF)=miutNx>oKh^VMVJ9_6ct$-R=V9whgXe05Cj)qHhW?g!?p%j7@11OSA*lq;mwa6LU@81x|~N`GwHU;LT?S!P7R@r+0U(Q||*~os(CQ zJt%I(`N!3}v9gb%{@7wIk{v7Py+qM9^A{bMQ)|yrcT=~P3f3I0_qH{~%pr%gS!ml- zKf%eLp+q#*om!A2`BVSVEIajUf|Cy=xxzKWnmar7lO#)SO4PnW!>Mmb?%R{x3#Pu5 zBo(HfNP<064@<5ql3Xj+oS>!q*9_>rG$mqXKvQ>1Rynky@qsCp{U$g#bxRUlF@?L$ znH)%RMQfI7?%}cP^uBWJ8oftjwMlG4Q@%2GxdN+WSL%IaY~$p&NlbT3&`0<5a}97U z;abYIjH{fJpHP1C^3x$do$|9leiq8lBKaxEPnZ03%TJH|EN=F9X-=p4Rz$L6Ih_j= zTJ|9xt`(2KipL=0QJm8RTeNRZP3{^aS#4uu+In|vze%xFG!l$0*L%OkKQOj<@&OVP zaztVi)>!;=The1&Qlcd~qI_|52YzhD3JFsamnSW_jk2yOV+4Hg#hXbf>N-ILR`|Q0PxxkOYINGm>C- zYFcv1=?z7dl&ZBxe1zjxnvO|S&OV5+phOD zWA*Cxw7ezb=l{BD3Cc3Blx1Qmi?EhOhm}!cDPM>0d=6=P)~q$nAS6$5eVj{Fwdnmt za8>sI59gA8kyClE;u8BuEThSFpy>_!cG4a0P_g&Up;GD2q2BVqo%zXU&r0eiX_+LI zNLo(PKv*u?VoOLPy_ceWpy(&xKsk5k(2{a^=g_k9f;)%GIm!){!*UP5`Er5Zjxt5c zom4ecUQiz7cVT%2zl+Ml{1(b9`Ryu4{C1Zs{PvVb_+4DCQvX{Zy%hG^>J4f6$yWoN z-4+Pz1+_8V`oe*^&7@=>dHS`zC(lAEl$Nxyt7pNbtu!k?xpWp-XjlR?Gm8dkN=aJP zOLOv*zobX{nq)UIeHCzT*l&m{30r!lOrLQ2Bc!!jD*Yq1yag!yPue4xq}2Z-{tuOl zoFcnGq3_MjtIn(oZu92x&v zwp3metY0^r@?%OanO&hk6^I;HKx; z#82ewp5ZX%A0NYTi|&_1G(=c?kRJ{{bhYhSyo!`e{15;yn0X<-lgBTGotig(80c1s zuJePLoutK&09ogs)`PEgSCK#6Qr>|R)UT~3X$R|n8!8ZDhppZ#clP}o8UTP#(f~BD z#oZv9MW*~Bmjx`f5oX?P8bDd*Lb(nkns9-nyLE;-~;T@Iz zEyb*PN~^?Er14_>7=>`UEAg@&7#1t`+yE!Brm(Et=mWINIIRF3H3wv5;d<(eq#Y5S zTRc}YAEV`!+GhoMF!P}F&MOHIvw^rqHV%W-W-!NKq@fulr324iQCg}SeyOeD6#e7( z2Q!~+q6{>roUu5E102Udo)qRh98U>K-iBZiO;E5F@_$ z&A=E&^gG^6?RUA;DNDHN2FJ*_iMZP&#ofLramp?vuqU`qoU)&X@Sz=&5+mDH_B3i= z5RgUlMG1!uDIbWm3vQf{rj7>QUJie2#EZ8}>~^=lj4W*D={;sa!BG%7=b^cxv!yxL zn8cyc?qS#6Ci!jZ^CT4%Ws5@YG1kB=6tA!-B+;Ufphba*2%&le-T0CZfluu0SUxcZ z4e>7#a@`2MqI=SdaECumO|ii3K?3I0aQrDYyuI47K!^PJU~Un^$M_mkXYAN$dlYf9 zXE%vG*^K$ob_)3ML6q&AU_(w))`9wZj8wZTBNqsGFl^X&A5`R)K8JSEW7_GX|??4bP)4judz(&Wi^_k+b z=rY7e?)ZsAH)BvMk`_hMDYL88J%vN5lRlwNW)L5zinjw_Pd38v3Bzg-eNFB`2P#{d z6Jz&>ox8*ANRTyK6*-ie*{di!3&+e}1v84;3+%wiGZ5ewF_5`V#lcPzMp%r(4`$lD zWX1?)GOe&%7n$gfaeajIW$jC671=U7fmydMk!t%)wUuF39aBxX8~p~J<}=Fg(UHuq zk*L^FWlu7D%LTM;=3H_{-)z>e&xnYTw7bfr_JS0er$95(JG&{Dx6;kDHPoqNLfEE# zel9#hcJ(~@PBI&v$Yk$` zzeBt;JK7QC;_s1p@=w%}YZiEpDbVc~{9T)RIlce+Chme?yhHZx!tVA$`^+zZo87zR z#BlN3*h*qKKZ!ki@^zpOc<|$n8nuP-52eZ*6PPmIV9`8u#Y)P?yUA5OUrKcc1;am+ z>qMg3>fUozy5rxHlV>8TLqRMZRLB&#de7;VBQoKj_?{z>g?ARv|J|7aC)6Yx9rNX+ ziw=Kk&(lw<0uO!G<=P}g0zv#@Nnw@iW0iSQUHo4VOvEJ;#CwPsVoDSFpuUrg@gRHSf$oi83%&4F z+77w2eSsH`5E=<;CtxA5iTZ3eXmB=zlkySp(S?EQ#upKapG$hRlfKe~_-LZ}%t)up zai}p#|2RKx{bs4}DY|*23*{{_xAqeDeB=8_HvB&U8sH%`i~}3Zy2bc;lIX_ga>M-H zUnKnp2v936m^m&1a@?oa7ATqf^Mr8Y0F+icsCY{+J(rif8Pk6>a43gOlvt&p`NMxRW%@+=&(7U+48C`YQA z+FtxV8ZrJe!{43cl|K;Uz@o}mVW}{Ecu}ZPIYFXS$pI2e)k_7o$ctaW{bq(_n{CuB z0+*sV;K8&riQ*0;`kEwK(CBSRl#>R?iBiu^T4#9cIjmphTt9t(6Pe|FWPwNd;wK?r z^I2o`N47cIA4gM$nU6B-Asl}~ z*EY`v9|IYD7eRyKyI6>E>(brCLA)5mKcz@KLyGdkQubxR^P?snN`U9=gs!uMuDN)A zCU}nEd`}wBms)tPhaQ&A;7QI0T}>j&F0Fxg^Jth9FhCCLC2)hvCH($zg_$|*prA+-l%PxyiEPBY zN%S&_Qt2k{+Q4kQ%YrURKx7t4wsmLY$4ThS#lO&ex%gK}zFhn}3;KNma&zfk{5g~y zzL}#E$yi+rg`G;XoYWMNI0S+j0m8el=}^nY-$;g9HvWzUeK!GFnr!dx5`H{j`Ee|` zSx?a~uQmLrt^)Tj4DQv5Tx8?t5EKp^o`7cK{H5UhjKzswaj+S|dAr5A44l6*IM12C zlYT7-zRk02^;=P=q92SxG4ZHJhL`Aw!@)fTZgj*dt0FjXqoW-yt;fZD%?*Qu(nTPKN}y#%+Qdi zWvX=A_`@uf{OD=qNwhJ(L^(O+_0F%C+5JoF*@SbXH&+nBj|qg zQE0JHdCZ!_;SD;Fn@)ob7|)8LwkrpHFv_odiIlmeO+nuj^iu`f8yF70EFlH87yppT zDkpmVJmeNVC}B6cUvA1j>)G32&tXz4(=2;yGDP-(Xp}LH$_-l*tBW%9=BsM?6DWEE?a> z93=iegCnR9gUK(gKgaYL55NfD5hdqH!BZZL*oDxOZZ#GZ&|st?{*#D$5FJb+AohTQ zn1L)Hj^|^IeSjxpO-Zl9;k}R1bkB`eNWRaaoCps|_!0?AoxbxX>O}Tww+M0_bI%_^ z8I)Hj9;O`u2Rkuk+@X$!Bxm#ZsV~u`kE~k;L9hZZwVpdrGu-8Ht59eNWclLDbc!}B z_=R?*x5@+B1Z6cLnT7U(Z`<=1fEm*7QP205VDtEElRjczbe=1;Mk9j0MRDynXai`K zaT&c->Y_aoiKl645buBwDzC1d{blaA>1M2-KxfOT!Y;>@YC)r&l*F~J3Ms^-bMF?@r!^*sTsiS(C={VB|on}xDkFKq)hAupWLStQ)7V**)KrH3B z+5*H|2*=C$>GlKWt^<`{>eq^;LS0*J$!uPAdr*0&B}A-id|9xVXWI;I0uos?}?P zsK%O0j$o?nv)-0dc*wqC9*Rv)w_-H8nP?3K>;Fpbk{r?1834gp^;7j}_ztUNdA|o` zBSUpi`y-j*|K!I>GF<@kMWJ>hXF_>*yIamhD0Qs9LD!c z#3lA;V$mSz8rXDxcZOwi%pfqm8XR^Qh6#s7W&RZT7kl04dyz9Q+Mj}n&oV7*M$~G5 z1rcj6nHU5|yPo6(4U(>Nnf`8DD+(0vi|=jkN<7>J^>A-v+O7Q?NQQPuO5DSerscnS z1cf5g)84l6PF){sT`9%Fq6l}i$B^gWXzJ)!Ogouh7qF4l33?Tt@!ue5ecp(5ruIwh4%s^^2e~^$BgGA|nVv0-$!3ZEJGoVvh$G^=rr`te_aSO@ zfr<5LjE68I_Va^mB9mfQooM(i<5VfZ7{m>A$B>%UYMQDsld{6a4P|)!GRkA~Bx6g; zi*AkBU8X7y8t}_ zi&Tr5%+gCT@8ATWYB?&c^j*OH)D}NQ6m+iIe-`^{*n?q15)G1|#-IrsEK_}1m!VRY z!0=%z@38kyH24iEccgg+jIA_Imz29(Y#o;;r*?<-&(4a3@~ zkU`08iJ#VwQFftB95Vh`969(73vRC+yYke9j*!qOro6dvknfu!*V#b|uoWSv`Wj*z z<3^QPqw!^S)spbzgbhvEc!kiHZ9H4EVh)Iki;m+b-T}TW=5c>?G||Qz6oJ>f#6&sG z>YGtB(wSwk@mwkLH7TO&fMLj3-sHVB@&GE*XGUySt&)lZ?N!^>J1BEHWn|x!S=n{l zmF@YAotgO_Huc{D0c_qlEt{HA@5<#;@YS_(E(r3-7u_;VCw_)hUh3)d?2#N zF-zxq@qY9rZaX<9>P06|VwQ2mv(utqWWy&d#h&V>%6o0|;gJqcWufVzQoNgTJEiu9 zBrE@2J#~M!(!c^Q;hv=L+7vQe55WRBnFJQ!^7N{&k7ACNJ^K_{wvvsPgEr>0Jr2wF zGWwg(DT$Tvu)MxW+d9bod2{OV;%BAXdJ6R*@0=GR@3iDCwZ>@=Q*K@dREHU)*c38@ z<;;-msjY^L#3pV_jakDHrlKM0>T;V_Mcc##F6HLoDY-nQUo2O_iR%$5^;@<}YP3NcWYRL_x`UM{V&!c~ljH=_%@6NeO*O`D!r-`QHHFMVPZ+Biop6Bl)&nR== zj~V|m=P^>l+E0k&@fV0PX6idQBXb{~%dozHAMNfz@Z}OH4$x3FeeFp~#`wal6{zUO zAF?FHt072jLSOeM&l7r#reeUGIWad|f8a|E83KM3yeL-Dx zu`ypK-2QZwN4Q{CH*00dlAX>(&x0&u9w@4Ve^M>FeLQFG?g=ERhQBF{N|2S&v3nu( zY|uUuhW$YXM@l|NV?!zBwp2o~)deOsrG>Ue~=kG=AWyLA_&#Ti-p3Y*vul7~Ct*1~M8`x87S zEBg~-pov~#E_Sdplkp^M)cJVn?D2$T%6u%zIvCv z9fM!ZK|axa8|Lq0)I+L|c_iQTr-Ds?Htpd#v`QAGbomLC0 zIrx>1@2w^-fXdlwq8A*L5=9}2HT;%g)Q7-W9{Rc-zC>wG>x#79oDVWJjtp33(UVdZ zX$65V&iXQZu^XIA1*hpc6rbsruG#%ENRfslqLYW3Iyu8B-X1l{*+G_}oXy3Pu&1e( zzpirB>YGbv_02)g&^MQ9JLkzy-z*pUlkPYeB#GMIj|8@SRi&rpOkXaZr!OUOPG2rAm*({4 zn!WpSSDPbe5g9jEK&zD+W*k2?1u*P}pvq|d`@lh;3w?~Uf{a~ ze18hOS&{6|%s=_|y}%U#-vYSH*`~O~$n4Aw0_hnG^we(Z{ZmJpWz~hEz zBy32`0=;;DAl1W?5>mZb%JnK$QKH?HkeCJ95*@}Fnz%$|Xw~O1S8j=Ruw{f%V_%LnLYDEb8H7d-(NWG7A|pnp2;r*hXSt4wwNVN(FG;fM`U9Hl#3goK za+g@Ir%q73`gDvU@d5nkJS7Xo&&xtFK8}GBT?KbFb{QJ56%zq8F_|-ugf>jv)V|(G zb6;;ycl{`c87<1PScD*IbRClrSr7IYh2MewPiy@J`AkJzNM~cAk%XG57iLQ|>Id!?1 zwWV2!;xxD#AvbOC#Lw$2rw#5>KeZBAVsNM54GHGbp^+30HU`JlHN1Uv(xB~pnfm_-A^?=5z8^6pgsu{!g(?_tgU2} z8{V}$FNTH}3Jpfb2x`?aOJ>h?_{c@aNOCq`>a3p9)G^D9YH4>PW>7X(WHU!bNOz{I zz3KD_CVC|*UJo2qoFA;=?GI!8_102e^*#tn{LwSYlN&%{s1o~=cSIQbGkQDl#2;^D_2KZ2F0WLK zc!W48v1_o-kB=Z-Hfu{0g+e>2+r;D>I!RtSGFoWQMsJWQs+7s*q8mZj<&jg1les!8 zdurcd)juWqg@N*}d8S=Q`qX-f^xz3ydL)&P7CFVSQ`kRL^zW5>%oKrD>f!TShEk51 zI*eUr_A0Os8J{nOnwD(vWP|zFxprUqgW55IInXjS6sb5W;+1sA*2_fs zTK`Q+{Wr&vY#i#x6EY&A1;>AA$%vl|5j0rz$cfbZBB|H(AggOLrbcFusS`lekVNdq zJ{RHAag!`VUPcq`-o%gRI%T8~I*=uJH9m@ZQ)9>Q=asYgbM!v=Blg90%Aa}i^L}*b zOZamV;lz<68#*nnV8{krkvuoXYd4EE%?%x1^`aX(GQQET@|Kl^H~6RwZ~ErpjU>XG z!|Xa~*j;KIu_#o!jIf2}g5G z>~@K%UgB)7yf6VBkchGIW9e4Ta;gezRm>&%o`6o69A@QR3fgQfFaD`*`zW9CVDbV% zS=%g4nic4hMs`nlU105e&cDj8=i;n!b=J8BxMR;Y0e@^=^;#1Q z*Yub`Fm{}Uj2&M+#{>t)$|g`9JFI%F-7S({4b;z@=eB4d8753Lunqwp25sJxpqGuQ_3 z@(zFrk$l*t#mm=|0AqUseM7D6V95H4wGNr2Db(%j+go0uZQ%$CmZp)z0UgNJON)gi z1Bg!zsJ)Pgo|_0&+nAL>cdVycNd#@Nm9B|ih8!~$7&@z68h)dOt*bRR2qj^PE3*vL zT(phh##0~(pLBo0v%4~Jg+#VXtS!u!QT_qcJkcgLwJCEJ*qOEx-m-9+R4Yuz6rUMb z$sv9T@)~-%)&7i5puB9|@I1xW!5053pi1rQFfE@kDJ-PEMT)gQJbgE?%AB1*b!5m9 z4;is;J1T?1vq-ah+4Zbdui7)lN-T$Fg#kjhA?eZ%U*-XM^HsCICqZqqVqP9XEarVK zL0+GsEicN%r^1@rgH+s+Rha&ibOSs7xJbZGsi9L0jRCti%?U5IcW}GNc)llXGVHd` z;rNcsNiP>V%-p%iHh?|2h(eH}GFDrQ&chy+WVJ`_n)fSgj+UARsYsPi z8~~#~+r6O6+f#hKcw&ap4XO9?UF0l#vF=o;K9I3}lh9l4*vsx;jZuPgizkBIa;Tw} zVonqq_I>R*Mt96cjIr)FdurZq;S@8tMdz>{7PlR~22L5Vddl1)MzH3Z4%PnS)yU&d zS$*p1-u=zWLsn3lWz6(1LC3Ld+SIV^^XGRO8i1CPhXK^=dG+;hrwWTkl4+jc8hy=}Mg z8-I^%Nt@53UbbkGG0qOCu>m`0kMZZjHO9Ckt6wW}`^?bh0E7t8v!(2y z+2!Q;*W}wJ?^F)yXcHuMw4F~bqq~oV4)~AGn>Qztyn(!GI0ZUX?9fdi+en7t_~+8N zWB_&B=GXzWfC2P*(o+LSawNPEpS~GG?`cviW9aaC#*oO%>Ey?^3eEH64{GnAtCBJF z0%)5vhTcyddyktLV>UEIPvvi)}bE}EuA_uI$z#a9vjQ?EtKekq*OAqCee)A#2wk%h1Aq3 z=ij<=JX=D>_#z<5ys|mFW&9~G*EpFvq`%u8`~;$dIKL|;)6?3_3-Hd(yiuMEJ3;2P zD`-eQQ>tA|zQ(a2$kgR`=23E_X2bY=GBc(gq3#+D3u+TG+%KUNbGQ)W2hI9@=f~9l z8s+UuBk6LA^HOqEg4$)=c<;0`2nNl;4Unvd3Gs9#3tC*C}6z6AP(nY3fla z>y1fzTs&fOpnVCa5D$TJHk2L{Ct33xk*=mP@#UnAf7cv%?qJ$vrzVtxqT$4lz$Prezuuj@ah^hGN z;27yLxID!?;+HyhU+TqQCPn&pH}}k}*!Y+iKQSvc9Xk-qUMS;PRjL5j0JU9BaP(DJ zO?(mpxwlqRu_9x^ymO%7)NfAgCf|8ho8#OG?X~ZMX-FSL4r@;mZoC;5Sb$f*7PQj_ z&YLBDmE&=*{vyCFVGh0ebpVP7l@fMqJU$VQH}0mGSHGTgHJFMAoyud+&1kJoLgOCt zU|Oxj$k7ysZqH0d56}&q2WYw9l3tJiY9kSil9BJwY$~br~MV7$5I*nVL)9I6Qn0;Rd#2hSd?kO*rIDOVa zcJOKH8atSMgd-S1TLM++n}hn{5?jB1Q~U|^NVl&G3|?X&Z#K|HMu)ybwWnhead0v- zUzS<+`}{EA;8;0}t&wtk_#e8YyX)ONtYoAKthbyQEcn10j5 z)Xh03Fw}08O#5r5QQMRyV_haR5?V;tgx}M_1L!8Is~@y`?QaQBSEqQ|$pQQpPpzNe zdr-zWNOb=aI$ifn)}*youoK1ZHY5?XbzY*bhHE)|c4iJ-lQFZXbY8kM@MC1-fNa$L zDS9P-u?UZ`%YSCIm*8b5DtnLh5#J>hL}cdsl|E;tt#*_NMkbu$Li@;IswmG3m>83a z45c_rb&2H^j6Wp%ztKymHu@x`H71Kk6BAo%5FYG%&FME+nKJ*d+;r}SUp-+@zNe$7 z(^CVEwYvBNj>&~S*W~Z`!9_1;Jfer8DnI#sffyyM zU^N=T*?B%j9xwg|`8y}yGY5k_QJ+G`nq*c59n~As8LWfL6fsp*&!3$kjjnps?6ha5 zv)VH&x22e~5I!91W4Eoks6BUwm@4mktbQ+p0e6PY|{mQ0$* zA|w%&xSy2=iP~A!-t-8Y5v=j=nE7uI{L4k=qff(1%XDVGlkCjLB!8PoiqNuyyl-iZ zk7Wrh2d8PNy%c$BNE*Xqty}KYH3geW#u74On~7dVE=#B6&35_m%K;6iVI1*^SVvXk zSCG=2xZllp^4gu>yN+{@(*03`h9n8s=bmhQ~2ZuDHUXIxtGbV{wiSG zdGgzjZXz^t5wp8Vcr{VA)jDf86J*$}$f+WeH>#MByb#6gcP^(J>4tCsB;*Sp}3v=uKN>cYB?}V{?SC9G5Gy9B+()w=9Kp}+*RBm}a7t`HQJ+u(o zJUZXTw~|`O?+xO?33G@_J5x^v08od({j3c7gyhabXCZ8S8KMZ}8;_enM}v)S8qsMQ z!Cug827bHQh)3sd#Dc;C!@Pxs1v<<0ukT*e(_JVm9PKVFC@j(`rdS&h5(?FNVPSFA z$xV0-*$WE`^@TOvU4<@var_jzN(sUW2oD%a zx>ovpHlqiTo?4eyo+%Wxk=4!V?Av)0fEAJbGpaiGMiAqs4{NKyVi4?~Nn_YMzgDPO zS$({YvV-vM;H1p!1(`l0Boj!otUvtd|B?lmvCH`UM9%G?kaIqVROQiNd|5is%y#`S z?-w(Eti+4OQc33v-sz_X$S~zr%E+u#)MhE)3$08n6q*AU>Zc-^0m7Pf!5%$(ugnpRjlwZ=o?z^X8ArTE5rU zYFq6%@+&>&d!DEQPV(sMLJXRGby48fID!}G=Do2USN)nI+6I;wayAxyDXj~=_#B}p z=P^i?A|6u)Aj^eCJoYcPSA0DEslB*4*rE^b2`~Ntp0_I=$y56fTw-M=IPo&dZRe1f zJ2L4n;=xA)dvh|A^Btq{U)X${U}(cz(q3JZW3eB7in4DmwDY(iIw&Xk0(n(P5WfL3 zirqo=>aNV5#h0N0yRznvQrorZfP5EE`3A3*?S`-rP{9G?g-mx27sBhh!>*itWoK93 zmf;~5fNzw{;dE(zO^S81eJNG(Dygh^tjxPL3pkBLbILB}OLY%cdY_e~bofCCkZg=b z-%Mg(A`pE|Vmki;m#+jA_}tntgYc|GoRa_JYn-yDaCLFPSqFy8`55PME{tZycL4V( z8-_+FPxxZ)k8t5TlX=+j%12J!t@mTbPM%yt4qDKpc__jUg&RKwsu(G#jmqJi+Cqdw z9An?2f#g#GsjZhJ8+KD+5end66=tMS+N=e98}q>j6mC#&Q*_B#{IX&y8NrE6Oxa&9 z>}gBaz=~u)D8(g^jlM#mkwR8mmWdCR&XPuEq3jDJ#cP2iVc9%N!W&ZI=cmHwY1oT? zEX3%T693sh=~xg^2m_A&j&ypZxCRM9`3D=m0_X?>x>`XG0^+%xYl(PQ-$WPiR)#*j zCdAFw9wwa#Sw?r#c$@u(k)@{5oaL8=wSHs??{d2xwI;E{i?@Nous8lb7LYi+O%1y2 zV*%u4YrluTL)}5+`B)nTHYYg}a2>@MgPCe6XFKQDWQy;Q;eiH`*Qbfw@<-}0{gE_W z?5QJZx7c=mjD^b6rBYc?`$q~ja0QDgx7@2sh(n2bG)+I?7kyW_ekZxCCHLLRHN340 z&T#<1+u8{`q8~^VSo%L~@^~3_A*^!taj_fe%-_bgQ+xD%vX~P}yxh~+oH9-rzUVmZ z4>$S=c~DEg;?@zA<-Dn`4yBmftkdpECa5DY#D?@!ZpR z57(P$h<-uT)O{xD=n(1_-;R6&JL~n-P?)^xb+p6V{${e<=+0B6=e_t)GRo-*6c`I- zY4W|2VvbIra)0h+ObOAuM}S}c=H-~@nPu`4eAHg_B$#+q&op20-Yj@qxR~hlTV|#d zTjnrl!9-*jRq@QS`03_imigePpp<_3ncjm)MS(HkI?Q1D=kW-ROziDkqg*{)%efBW zI)-Z9EqCwwte`w;71if0y2TeJgVF1tu(8KsV2r@B|_%;(3(^Fp`1zbAgX7r}ykrnyP4HJG?!rM*w(-OYHgg+zU9TJxBBmM}|%=bp` zqWi9w_WmAnr>%#QsHw`Vc9{LzwMs$0%-4Vjjy15+8QKh z=~$W2*l6|0puA3o*jZ!!)itw~tPDi86=U(yQ#Y{JwZ|d%wSY!=#dv=A>2ih>^AN#FOlRKC;Wp`~_W#MM^lR_A%Gti<7%uyJX z6;H?Od!@fq*>4MH*Q_t96;t`ZEU%^GePg^+^B#D>T17a``y{&Y?aM@-iywvu@hcq? z#gsNI9(^ohURADbZdd>G`>3<_R*)o;>5X<990qADTOEtqid0*aLo681lVX3ERP5CD z;;JQuV3gOEOU1JaO@4@sJd;0dO>~*oc}bd@+*Nv3h-T5A89lg=9i0d`rTi)NJ^uE0 zdz|>bR`3A{7UNHt+e6&qdqoDO@hmSgXlS9b0FR-;Kiz?>iETfPgVQ4Bc_~4WGnlA& zI#$%VLUuZCqGbtTmIH=qhjy`%$J<*>CvSGGuh-SJ`IbH6cak$512pyh@Y2KW=10GW zX=b0`oy~oMEU*2R( z;qBBC-AH-P@E=e8-R+!C|6c%kQD_~}@~d)O{ht7I`0>eP=**4sl*d{^yx?>_3;0ey zK22i#1tVpS^-DN@2l>srxrVe=%QnUvfnyx!Y8SdX=STlaD-a}X!}wxS zW#{h?(lCt2$Yo=%J7WkfZjL#hfPokf1GV*bo3sK)#-#4(4!V4IPk|RIf=*Ah@B(kC zim%E2ZMbr~zC8=)u`po)r_eMMpH1cpi~jg52^{Lif22i&Pe1KAyg>#Pw3?AA zUkp$^^jFdV*53_s#7Xs$teX)H^a1A^LU{#{q)squXbhe}fubD*D5ne>5(vC|*CK9B zL}I^wH_XRAsR_&e}ssU7f;^pq4EN+PJr-Fk`&ysNC^KFLE9N=@TUcA2~XwzjDSyo z5L@A+#K+$&wLM12^b0;ITbDlGNOhkjEx3i9i-G#*1cBvK3jBEi8<9xo{=)p=FACTa zmqPL-0Sj@nt7KswE=zL>-&lC~#gy)4~xc*H^-qWgqsTn0_*QefOF^MUa|8R{&L z*i^AR`X(X6qobNUs;-7w{1?=P;Xa^ap*QL46kLXckqwLX+k*C!!uszhS{)P9Exad! zcg~m?NMtJof2JXk>S!Gj?`aMR8Gm!?VjWEza?%DY)h1(7VAjTADIp;RXVp7Ps90`? z#r;rL#h5rxoca`X|?s_z1!NGR5YipoYvi2FQ@{T+uC;t1)@rP{gu_F zQt)G?K=iPAzSHWUiM{)=FR5xyKc+{JcH^g{D$#(Ao!xmfpPh<*Sm*&@>fsFrD1o1C~v~Qly{Iq~=8&Y8TxOlo7+K8KZ$0cNBRQwt#dw@?aP*<x;Ry&8)Zkcz{I}!|4~1EK1!;Ii5Ln_;U|x*Tq#^|#5pZgV zj1o7xXN-`k>!v23tJlHg14syNStxbk7;M&+04}*r_7B));>W33dggym6Vt(+EfO%xZT8ydu zM@fERgk}75iJSHwO-S2&WQ*tX=%l9JpJTM7B~6?ADPf{D@wIKwY;Tk+|Lw)Y9D8F+ zi{6dM2%cwnh9_h|4)r%jZ3@g|33in}EBEp9=RP6HZ8>%#@$olE<4z)E<@A|lq^a==20^d2$Bv!#CLBdnOUsqJ2I`mz_mYaLZyL{%k>Em3RvLy!pY?0#1qTdg4Zx zokPgzvLl+js*b~`lzgWAG->T%I3v7w_l$bZ?jY9pq=G2 zu{xzS$b{ZGwq(jSlLcY9GtmgC1YJn0&uZ4XTWq;Bb3RJk*ph;2zNMwq{~}jUbn=eX z24*EsYc|d`x96K1dzJz`-`qBs+eUMHf!xdo!Mp~WoN}t@5}cNe<0b4jPLNxB<3zbF z@EgZ!j@n1iWsTD$Tw5=}bsBu01W(uCg%afaBpEhH@JtQH5@gp4=w=C?EkWKK`do=1 zwNze;o`o;8ae+p9Bep%OjSDrx3jrl^kw$p=l0?{rCvRXi8$&o7lk-$Hc0Qy2PRlR9)LB^|KA!B#Z58^W5tG7}p;V`}+Ti4Au@4iLfH5 zGFSUQm8jYa1r_e6|K~ijeO!CNyiBvYTIPNE<4oUiLStQiM^`aNayQ@3eU^#nc1`o^ zZ3b4mlT9csSos&_*$^&uEqNY$2!kinDPvx-+O{m7fD3#R{P<<@YC@d-s>^uu;^)xA zmGhH#K+9`SWz_QZEt^XQt`~2V*!f=l5cV_8%TZHcXx> zi!KulB@@i7q>CkKlO)M>VDn!NkmDh2c5G2%6p4N`4$uo*ApJrdpqUm(zas~z)&l7V z;s9MEpa{hq1S89W_(8V4`0Q2?y-gtT!%6h*t&-P52OqyNRB1j-U_%m0Zqh!9MtoyB zXfUnF*y@mHz#Qa+eHSHOS~O&K-Q){5hr=SCUZcuDzRMTHjNb4G8)ob_!;JA}m@zEj zC&|y7^nS%Hx?E@t^ufXCDlm7qbF7jhTAw6^ zJ^Q;5E#5s)OtOd+$TviUa@h zD|kVJe5YGKCS)IoqnpCRPse85cawHdM8;veo_G3iizo7kCp_tou%om)$7u2)j5PBe z%Kl8cU*bz4#8l5ti#8YyYW0=9Z`mtR&6 z4U@(k$=5?fg5=nDbQe`NWQAHCmRz~5^rIVp6=?id;dCqA3KS0`#HhQb*wJ0#;m3+q zu5E-@&PSw;b{Kf^$2mC?21aFa>hTjqRkFhpTf7=mxt=T5l@r~%*j9YdkOO(~v}#M? zW5(G*9UpD+Q9fP?A6G{BxU`?ngNd7@pLjO+MHJ4(JNSi>*Kkut65iShN7up*?5LLs zSFWHvF?yV5F_dR3d45Kv>Kzbcr3%d&j^Cl{*w;eK$DoDdoFE*LW1ZaN?fmeX?d!R5 z*6AwR%$qxBy(xcTc95bgCeAd;m4spXF#4KYU3@GB-?(I|gi%lOp#mj;Vxg2BmJ`}a z8!xmmpKQt1)&KIadBXYSR)NZwKRNH|M%U3mH+qHs-o!70DfV;~WcRiBDc=W`H%aKn zFyF%fimoTGIRKjawr9JZky|cp7ivVIp970@M_mF&!1UWA-nKVzM$4_A3s}FU;cfc| z1&G0J0CDrI~Cd-kGE>H`LW&CYP9*W-8(hf{MhbY8hryKX$5c7=w>meEY6wZ^@C?d-T6rcPrN*?_Kf;Js z(_#$_lPQr;e?>ZqbFB}>q>0+ASKcQ)c|>?(zB?`SwZ5^eQ|-IR65U2i(&^=Y7I z&_5$(qPo!y7tvolDoiV8=>~??he4rgzJ@{%VW)iH%s(2 z8vQKDQo~li_KY&MUkkZM^XNC6rN}=@G>ER3!TX3?UK*VUZnw_-3RzNFd=4ht{5+|= z-YqYR(42^Yd^ma^xe{JIs=P|R{j0osN_h1;NU*%pNz(8ttIu0Kro4KQ;T1v%Q5)qk zW4r@AuydLMJ}LypX9D)()A^mt$bSL9GSaP|M}ZnMSQs-macJ0!Ua#!<0>x6QR6jN? z+`--f>3K=2(SzqEQKJVhOQP69!pdufmEsS$4Eg)4w)t_g)GuT`!HT{ZL~kVH$O5;B z3*iz7itf-_5}kof=@<_Z@%&^d1S;? z?vba|ac)+B)P@t@Jxft;Ckz6egYE^b>smI&s#vj5R0O)M0`m1t7&zy zXId7q7q1o~gOMB`cnhMpfWwOqNYwQzQcU=}0Kp|CP?S(9teHz3B) zU=wzJ6Sk-c+X&2X_XUJ3cP|iN!rjV!?OyymhMrsQjj)rdUVCd0`b$(WYs|S}jEN>A zS?1M@e5=9vvhwi^u}}Ey<6GekHvJ}{-nD`o)27eD z7Q9j3OIb1Bg9?LVq+3I-JGt;I{g1BwZMp6CE;uIbHI;%TcqLt~5t~QyN?Eyr@{wcL zP2Nt()rXaMNs>IQG}4*Tr<6Qxbp^`H3sAbuq+x_D6bQuKN=Lf93+zyIp?Om3Ql3aK zud37%y&wt z&^%*70nsOzj?Pz9F3u9UKm(nQmGv`f@5n~4qG_0yo1w?+H7YNwuYpwU&U-JJELa6+ zqmMVmC8g`JvM6tdA7j|sm4SSV*1=1K4RtYnBXu53oj;X2-TLKJmW^W)ynd@?v(YD- z_^}(pnE5*#wulkxkoVPyY_0; z3DR8Izl$X6E_gt-IF{Os)+8&3){5SgwhQ|hyClR^^Ws0EDpHfN_!8dRY>UiUY-iWL z2E^F6RcN|V`{t_@Og^yWZDpo%dHCTyWE|q8@uTpK_fUOL%CSFl1@w5aco=vxf*L-U z)L^1bW6VT9)Jzo_^qj+~^BckkMIQ!B6+P1r7El;}nW_+xqP%hR^>lW89?QY_JK#_W zFuBH`3@T?^@|GCtJk3+tJQw;0w5drt^nVlgCSY%f7<(YVovu6((yFWt2>7$~69pdNNmr9acsx+&UM#Eihex>bm&%b<@UGjnA}r z3Zw(deY3+8)`X8Jh0`l!Rd{7>it&5P_>l!H3vU@eqQcPjMbfXWi1OR%f_=&N$YHI3 z4D@{*l5O4EEK3iYZ)~wGf#*#s(|g2!HLBR54S+vT#4!0;JN`c{;HS9>LCoSmQ+ZbW z8rOkNgle({A#D7R0pkD0F@nuPBlLuJPA{OxCcgt%J*nPeq{dV^?WMsg#`&%1IW=CoV z7SQh5)4et}$#Wg)#%~qpw9Gf@n{9_1VN3rI=jbLTHT)Mih;s6pOeRRq=aa8PhZ4)jpEU0`Q}3tnVmE+2kGwbAh-_Z6A~fRx z4w@heV=lC+zSnQ|)W1W%Ik$Upn0y0LQG$YvM>LuY71(L`C7?obKfm_`h2-aa-5Lgw zwUi(ZGr>(#cI#b1bnN^fd8%X(;H`iP#=D8mE|~;ryEJz#Y#1NR6uIv@KDIJA7#~P} z;^SE=;6n1dH0gkG?LW!t!sU$dak#6BEV8ox5 zcfGvp~Hl9xT!-1n82?bpC$ zav=ghT47xKgbi8GxP*OTq$jr6w41me(9vjlWIfZ$7vMw+v<|vF3sDE=eQWEY>3gYN zG`1KK>sG~tQLZ%iQo3Cs{sR2FHl4S#>OX)_Hxrbi{LU}ajg5uMW{aP1%05|q3gtO- zDZ;~(BL_i$2+4G;FjPWNB+wxj3o)B!wnFW)m}^tDm7*h?AikC6UIU|1%Bb!*H!08i zI(+7vUnildnP}boyP1s!^G#F``RNm)0@gA$`4-G<*-!%^3;j>U8!yXa)+x1Jmgjn} zyW0F6c1GU>6*p@x@zXcWO|xi*5oZVN*j(u`wwADZJ_x=t^LS+U_4Cbd!A*i}=xBCm z(Be2&XQP5OLB{pG?O69IZ%uN^RH{i5?T9T1^2w0e?4?v$zwPyyOzZ~UqcQ_;TA%NL zANB|sE5oEfOifefu$h3a6ej%wZ*&!Im+^U2A~YMBsOH}R&m2DZGU=rTtz200PSwlT zbhG+00tfXxNGzE*XzqmT;_}c*+Bj@Jt1b^G;pK>+`D_K7YChHmvd14Vu{uSjEW=!# zLiiE9BX@s9f0izjYz#bH%X}<8Z@^Ps@2Lp6q+>`h& z444l`zoMCbdyG6P%thhEA*WZW;lw%oYHkT_FAI5`e7B{@)c$xW zL;-yUjePo`ps7Ql?g(~ei`^SWD7l-GNs;X&of`*+itMJVVit*1wEDEOb=70AYWe{i z6&ri}#Dn>`81vnWn|*jq5LsRiM;~Mpxp6wr}|p%gi#1f_kO!$z6F*iW2V%TGFWVujsDs3U9F#vES!gs?AOSg<8k8bvjp%kCju^r zqs8S#GuJq6W+x?c)yjn3-W8S?JhjbOnEO!iI)=?YHk94Bzs!RYXG9~MgcR)(XCMcb zqf||4yc+5ERsh`z@}QTYwW050fK=3*w^TOYIzp1810w?ib8qs^y*#QTO+*^J*)laU z2nMfP6zA?|GuN_-m0K|SM}}^W?a?DGQV_t}iN?4fw}LcQDGggNun(tG#;#RWsxJ(u z8RVZtarha_hLY@(XCk5-iU+9dWOes7rITrC_x#e$J`h? zOFJ00_Y3?UqIG++h3>Kx-` z52<~<^#}QM?+~SB0lrzdSk^~T{S>loUW3ph#{X@s+nht+&HXY{AJYfO?%qjG!Nr@3 zT_Zl-!#@OKKYx$s zZykRt`CHH5M*dXUm+*Hre=p^anzS8`4Rj+;+uwmS+NW8guX3-Oo`78dtnEQR(-(i% z>La`ZfxIvNy!RmI_Qjv`9?1@uw1d=-t?J0s9aHkS8V&D2A=VfFA0G)hrZ3i7SZK@_ zeesvPXO}!*mB(c^ySt!1cL3Z!NoDd7cH{EC!i1lI|104;E0t@Uk;=jL_*rnnrz*ah z_Oa-~^t&cDY>O+Amc z_H!j^^?azuE0==g2$~}42MMOrqU3|r^k$$(rcf>*q|m7P{?MZb6Q`p#BPjj_MA6F` zdN6SY8>%VP`ba)E*-ne@q^;5qsU!cAXnw0yNn*1>Ww!y`U&BA$U=A`Rn3ft^OmYSX&&3#yo zhbbdB{HUBb|D5}s)kBk^Hy{6=+=b>edx*67$|LS3FS3WYy((LXFE(Fwc0jfe@5O`U z!k`fh4>TD7^Ai`(4h7C>#0Hvlv;2y~1eD84e4t7D@j$sekOtv_av2cfj4_BsBl+eZ z0J2{9uJ{kIN-(2NphND>KUr+ToztS@{v%+RGPvBv74aBr5R{vLwpdsdHdmS^gIq8a z6q_`myct8(wqR+dU`wCcNO7kE_Lk`heP-^@HS=PVD$l2GiWS3aFbSRCr|{~!AoK%k z$3-D(y>=FL0piGt(hA-`-uVM9t6!qpQX>ti$up=2ngvqUhDmVg=BO$L5;_MeGL$u+ zV7X|A6K4;0T?U!_ZWtIX7ST1k&J-YswTbe!_CWct11QqugT(a&d8$h!4Yb7)uc_3{ z?@BeFd>nMH?UZeV-@xvYOa^}hAfFHM*&=Im$;TYv-wnWfQ!Xo*GA!wdFlDR8F-KNi zxT5kQYm|y&TaY}8>G0O3VbK;tPeTjN>m#C@u{eXK)pPktm|{xDer2y2^lIYCYYXcm z)F+qA%*#g5E`h0$vG_qXtIL8qBG?t7ZS&-{J0s*2DX&e=k~SlmMOo9_CEwAhkNu7G zEQEUxmv+lIAk-#XA*JiI=Y?9x0I2^<$TOFkaX3GAp&QQ8Qi;O~o-u2%5XPSZZ#x1K zt#YTJ7@I#8jU#Wrt^XcFxQ$VZ#bdW&-|_DBH(bXXD0E9xb&N7yVVRk#V{6YjTVk_X z&nJ^epfiPhkUR_rk_jrPD0vz`ltb7!T)qKD8kKwej(`d#X~XpGH1nMw8NQT)Frj)Z#(Xo?eQwx|@w}6IRC#)D=##fuNd? zhuUn)w=Co9itOrX8k?S~8D_LU(}aBX8hddwnn*|c7V3%N2AP9Z73MrsPU{!IS+{Nvoz-6iK}`N=AvuURGjHBgDzJy_EIN)=NAx_H*>l9wZEkp1E<6!$ zkUJ)K&Tcy|lDjdmyIM1=0=ugTm4$W(sw#!lz*qg*rz3Qr}2V zvV}UQ8eK34Y^)_u014)wx9H%Bqeq=3Lf; ztW-uw4`qxRCaMjkob5qx=0(;;8zZt!rX6+&SNC!Vh-NoE;J(*O*bAD^(_n@n-(fP@ zlE;-QhTrq?hzeGY<#O0~FB$jmlnwj7hq%a5g3h2c7@C+;h(|%~t$7pZ9lmt<*gy1j z`D*C>1A43c2wK0Kg3!3M%f93F>+QR;ev7`PbeOWlgm$~YT9BX0-reyog`#m34eWM9 zQa&sccca)6X9#Wi*h+Vl8nNbySkUj=r%m8YjB_6_1$VMC0%&w1&m(xv$1Luf1NNxaOb)l0xA6;CO1t3#%ko` zI`u*awb8jVx-#Eak`-hlkmgMWUC*k&pOmHND~(A{SK6h?sX7-lU%)r{IFq7826@8d z6Y`}&pX>_yR5s{8yMjKQ4bpk;HVM6tTs_GrbvK^mJA!P=Ktg*yq8&p>)m2t`)m2WR z)9st%y-@OJ2UXgnzbw)ZLtIPgxXWc}zU&&GtEa$J4-cmGRHC4a+%M3Hxza~p^;C-6 zl{6=wow*Hrp1!40a=cGc+au-9*|X{kgSZA?;mlzDZVJ3{3RT2$8&|GhQLZpUQU!x= z^M$GczAw`E%rIsuMh=q5=v_^tbg%X+Z~p`U>Ovw>lBLStYr==PhUICrxdQW zxESJ5o3JM`;?o%0H4FN7JHeNQKYPg?oT-_m>w*TlS00?O7dGr{nG1gz6ywu-X}pyJ zNofej(ReNDK4=J#p>f0i3mU@dq9Fk7*<}zZ-(~doR2&m}n(sfzTW{M)c?oeSD-}sl zZl#5BxVn!kFf3pgv=b$ROH9@f82Z*a=!q&P{$Y|E7%Lb1R)d&(%$)^%e3A-!r%;0V zN@_>CY<8qyz`CgMJr(LMg(PQCh}E~cIzpf52=zhHXz*(GNHr=<@1hdR z{?T3EB4gPu1AC5N=c-rczh6q~I(&vWuYxy=-~yrN0HkshNM8qXC9@}IZ)S=3vSqpB zk+6gFf;dusoIMegqovl3#4>%0WQ6t9xs#=XrUJNZLmOqM5sjx!dMIIv5Fph~aFn2- zwCjd8UmOJ;(_zqaG!eU=6Pn2cBj+PW398|eo|!aSEDJ@ZYGraFH2TzrEhs@fSxQin z@mB0$q~mv`yGM-XXd{QgcvXs?`jA2#S9EWM#`ILYl^YmVRY%`qh-Qwg0D! zZokYC9XIxZBA(M?70kWCk^U{oouEvW%7^}hR~;sElf1wp z&F;p8U7Rpg_2RK2YtTP~O^r9W@&;a%tGGN1-IqE_4wE$Fd`qEdPuJ-9X8Uzgr z)~y~(-!_(cgk=t}Ugxp&ZDW~7SmtqV^Px{x zD3h%UYEt5SOj$>~ZAex;h=c{ev_C+dcl3hFN;W)j`-F z|FfzfZ$yL19LG5t*E1ETldjg74WM~zJIV)o%D!rpypzQ_av9gD<6UY3R*5sqT;1sz z0;`>1&m+0p4bwBhp1CNPUzv`n$mrPSzeZy!3Sq`ng(MV0ZBMDliZQ+#qO$$J45m4L za>gaTFUt&n^9?X$&B`1!1$`4q0rej<2nF$9amMe2M3om#ryx zbu6gemQphZ0J?@FZw>&rrvP(Y9yH$!Ks{bxv$Q}5r6*_@aba9LP*|8Wt@nm43x$-R z#=1EGyd?#g1HhY7fH_bBDbfAP@iw)GGieXbAI9gaF&IZFQe^>BWih1j1xVwIA+211 zv~n?|RSS?-Erzsu0n+Nlkk%|fTC*6^ehZNH%OV})%4K5Q7t~q4pa3k2w$>5rpsmfK z9hXw$uBes!d2MnN%d&`RvXcvwo$N|Br8kKYp>BFWvh?WIs?kaMOfEi8HLek$4GQC} z?MhEkwePb4RiH&t^S!8m7Dc7wEu;!)QPjy^R6tqOO+F7mbH1c5PV;53Y#AUVT80$> zoxYqava7NY4E_+2f_+2^V5`$_+C|6(rG=RVl+8gKwb+|kK#QVs4XTG~ejlily{MC2 zsBWG5_?(ls+^FSr4!q%`k;_!AZt$|9uNFBEW3$E@>|WV7c`qYU{eFf?KSFBeO05!# z4kM(-J;^>Aw2+vX*tL|26_Yncn(_zn2l0go8my>#zvIBA=fiD0Y#h#9g3&24;NP*4 zGf~{crXlhp`CR$Zzo7Xs!YB65A}PjN9cZh*B^XaYy88|DtJ6tjl}#cq(Imna8AY4Q4`jDP(aD;cXNTmpEYvb3qejMt=LJ{Y=`D z4|%#jcamct{_k4AKN(3GU(?O_wH?M4;uu$Sai*`%OPK@iKW5w;^iZA4aPW@?&5wg9 zkwo7%o;+xMOyS*<$A=$7PRv_wSwc)VA5pydApR|dJ-rllx&Y~M4A3q7dW4lvh>R0u zp2Q#&GzFMvOvvx;Q*j={>NzlfOCbm|v99quHIzYAj^;pA`Y0$8%kKXdiXgSE}4J@_p#*kq30@890;bJ6=jTR^&-JFtvY`gKLvoxb&6D3fW)-g zi!{CfiD|VLY2^YWrqy1gRSS@qR(p|FFF;~i?L}I%0Eua}2ZQqlUhBsU6Ob@M|4Fa`zwAq4Tbxl}xJr6v5U)&4E;_@8VJ| zQ=|p{Nh2h$1nOI@Ane9}#ubor_6a(2{H<*vcrX=$6}<=V0xg2YSU+ZGOj_=Dqcqa; zUjUPU4FFsMaF@1t%AQl5@N(t=Wjqzg(Fk`|OIBwbLdkhGvwA!(je zA!#1z8rurVHl(AFY=hd&$$rj0)sg{$mNzZJEN(|F=~bCl)h^7+TWfYk!rX%yeWVLk zN=_f?79`%CCEQV2M)hAY884>3e0wk!pU4CnIQ^x#awO`%SB#&lswY;r*qO>#OJh}9 z5#s3Qz>2r{B`tGnXh*gBZB45%r+3X-jNnYB*1$s5ve~c* za*Phzi*>s4l8Z3NW`-45J72aEvt0QXi#s7f(dU;7WbKkda|_oxr2JGqUV+Pa9p{xa z8T))TW8L{uP*=VLu*~Q@pUcdu^qQgRS{}Bb-s0ngcn#fVooB>zK&5Aj;drnp21-kW zQB{Vng4|))cpM;ycwLP!x1s`YJ=z=qz90bKFZ%D7^wpkMNB;Q=AWe+=+9^+`uaGP> zJ?*+*FuyjHB=*CxS1%4ljbEDxq>$t+sz2Q)?YH-!T>TquWCeYZ6^!Pbr@2$WV1A;T z^2E6A0cOMWY} z=mh1n1B`Bqzyn^41ZMT>puUGP3<>>8goPmO=_yPxq<_Af-ZC{aw9cU>XOm9V$=1iy zCf1l9e3W{0vNdC?JjfVUXO-DPy-4e=_1A~^xC*t$gKcYesuYiby>JhN(bL8r+7kb% ze(SMF7itzOGa`ud`$^i`Op25dK@2GsLAsDKB8VZSB8VZeoucn5H=mtGhRo~dvMkEl zZWI>A^!TV{D4w6J&>(nQXz+Aw3n+|FvcgqgJ(aT6zrcsAr zZHz0l#E5pYX=-fw&C_QAoco~;40#H#Kp0mdRw`lMa6PC~LcZ-vpRaVnF^BC+G%Q;w zaxkMS*)5AC%ZlPY(i%gMze?L+%W2+z8*Hql5Qe&cQNHeUh%;kBrNK$G(iAot_!y2S z;vjl^)gsz&!YRNKr@%O2huYuj?1}Kqxnugc&^$tkx1h}*>2gddefEA$$N}eTN#9N* z&J1H0g=s2pw)wcTzoo=cug^G*_Y0jdjN~Y)-$_q8gXHaDyi+~bMfF^ZJptDOI4xO1jxH2z#DX85ys~?x z28EGtd>U!2WQf~&>(jl{4Ld3Z{5l;bX?>>MB|sy7&t7*5tUNWwng1g(w{G$T1m}7 z-T=oNvB*HjQRvkCaPA`ust6=Lqa4CuZi$ui zn@GyWoR^C`>pgGA#Tey=jzx2DI~dFQY>Cswd5F^CEri**7R{`t*{*RH7B->aB^ElA#+f~#u3Su3f#i!&heE<+H2~%VEljnC8rAm4=)u59v^!bTMs56prjqPd z7h$H?`7hmH{W_C^YNo*H$xcsk=OdRf>hr?KHAlNQuGRL{rf*lhwQs0l%=bx!|s`|3rm!h$FKbUO~Sy8f9yqDuUpgLG+tmH%6 zRpAX6lTm!5`LqCeR=zfFS?=!|3;M|@=jWBt9~4KUOb+RtuB{!PJNW6Yt+4{(6i+GK zTHYI0FHg_Yh5L3THptNnt@#G3dkZB*ZP9z1$J+XWi-m zgox=;NgUd^&d2ZI*Lq88KpFw%J;2<+ucKq}yYLzhL5_{~+%mQA2SMpZrd4%_j_bKau;V&iymF@8^ec{+E2*+XV$v!-=1AY8lW07iT)GYFH-uYfp?x@RekBOBm*xs{FCxpu>e&R4GCzN1OBwp0x| zLy8@h^hU40Z8GK~DbG>S@b^S@cX~N=59aT9{t)u)@2PyRq3;#FKZU1XO4{&LC9ekO zJa7-^PdBKy>jw4d8$Jp+y+-G*&$-6XcrR#NxM4`tof^AX=R=%;xBbn8U@18p;-tdu zZy-M=!2CV$g(i|6n1{KI?p z%JZN+9Fb3?SoAG8#5r03hQ66=^qht-kB-$28!04x0EDdX$XMsnyXUSmgN!k-j*X0Y zRA)u^V-O0rzf|mT^QD*+X}m6?e3?v+5CA4aK`_ew?tx@^2D7WERy)jLVRC@Bl%=Ag z=kjvN?uk!_BZF1k^oNN1%7e}^JTjcTk_oRox}sJa85&vPZdaE_hL@LP>MY{JCSufh z3qJ|FX{C`BWNgLAijg6^{XO@2$huqcqf3I3CE4^PnT{?6CZTk6*~n7o7%7idYWt0F ziF(;cC3ztxhZpo}n)eQDqUw&ue8oMwI(4jmzh*SCsSfYdJT2f}3A8=l_wk#;o7VE}|QkKLAmQW|_oODXfzy2DORc zWw1m_{KOpYMG$LYQdSL=4z1!=Tt_(@~f$aJ;P3Ll3pK!8>9I>+nn*}p#rzQ znKMd_-_Z7^M*CamV0(I`-!A`8X|)kOM7QvQm7_3skLY%UD$Pw!=4j-e^>bGyk_#@N zOjfkZB;C?TZAD_64<7UJ`^k#QKpaMt@WX0IAG;{C+Ezh5jm=+#DY~}y?Lrm7#T^p% zf{W%e0lTD`_jzDenz7WSG5oQnSiZ~^PNQs&QrW4Cbh5GQNTY><{)-gd9O$kNr-ad6 znU`=T4@b@%0GK-*z#IU6odV1O;5RA29J}?V!6)H7n7FtlBIxoIm5(CuF*M@+HjQTv z01u=9a{ypYbZMId0P~{*m}8w@O;A!Qhd-o2<~UAwtc{Cu%K%`|;$38O0Qgf1Fvm&3 z#M(CFDaxNy6mvke;!sw!3_$rI7^?jCM{G3R-vKyMzcwolR6wr-9qN=qSTFUNEr&Ag zE{N9wE7gXO8xF!{D7a(XGe6(61O-s}RF+uotZOPa7ji2n&8DvDuuh;2>)+D8z2zqe z_i3t&rubXmSM7pM57rNqQV)`)9jGD<$;W!SiuIVKxv{LDGW)9vgySK84*mnc7(zZec{#U#fk55FN-fxb4oBX(ra(Q7QRm-_}w&mf!9PvLRww@Uf-pt80tO z=k}eH7qpVUtBm+6TupFq%JUrMUr~J;D5LbVI}HwMgRCwY72Jk}lO^9B)XyNH&}h1Q zAO}-((!cKL=wHK@CH4Lu;v1>$Tfn+>Vsmn?$w77za~rE0wo)MmVAtBJhZ_o zG@a$LzV;(FTqlZ5q8==mMBNYi2L2dba~odFk4q4p_ zUZVSqD_!Y$p9)_qRX1TgMDp$iC3g#%W2_-1dcjNb@6k*@TwK?Cc~>#JdUf$lBs85+|&pC{Zzos=ve7Rf&{!aXk)#S)b-`Bh!2O|o>426apBIE2HBEXQAi|;_*Xhs zk%HcHa{C$fu2uUU*b&fkd2!QQPhPP8N%UoX%<@cT#+>prvLH_^el1U28)I%>{=dr8 zJ@ByF^0a{#iDKO>Blc$N=-q@COqg*Z&BlLe1E$B_&VyOL3T+d@oa--j``=E~iLEHk zEX4n;mT$l7AMJe8x_Le3OA6b`xI+6~e~|Odu<|qMh>~=gB_|-oqdt-^UKWg{V>e*_ zvVDi`B)EK*jh)vMh7#Z8sacJndWZ&{(G>PluOrMX>tK(%?KXxxPtweNJ+*treCPJB zOvhye9XoF60qsz8BHC=}z}gAg^+5w=q&62Z18Aq}v(zRr_eqz2kb4H{>z}t%Z|i_| zv>=(L17VlQ%xAgfLOc#1)gYNs*DD6etjC~8SlsJ3t~iXU4;i)){l;a5RHW(rS5=(- zs{9Nj`$=pA@M{dX`;w=_8%tL7a$1d;z=u{abt*1JG37!d6BJ#rbGLKi3!oiw?n@QK z3tL8n_RHRg^-Bf``xk`kb@FXG49!ZDGx2J_N;61mK6BeFbNY=}TDIMbZ4}wZEJVNY z3RfT!`m?=z6zwl$GUMK~(bjswtr}cG=ujbrp#58}@woGl+b9(Mn^^8{A5Ak8P1WDZ zyi+MRX7D7Kbpi5TAmf!R>FJoY!cMv+A;^ADoERhsebRc)j4mBdyP%+H?U6GcFTUxGVz|niz5^ zxsCNglWC)r=m?9S17@JRA9TYqx@5J43~4n4L{$-*E`^cNIgK%2r{=j z{17IGK^_?|$lc`IM$lxJRM#lV4P=l~OTM7V?x%y%q)ILMf+jmu4u;CD)RHe~va{o0 zL@TxA3!1E^GjZh$n(RzuVDbe`wBHWK8ne`rFKD7Mbg(A~CSTAbIR|@;VDbe`v}X=> ztYGp5O|)Sdn0!H#)wY983QxYE$!aqLlP_qp5^%5?;mH>?ktQANXu;$Qnn-32X6eco zG?8o^%=nWpn4eRPGIirzFDESnOy)g@dAMNm1x@PK!K|d^tL_LZM-7KuaN(|4{`yNV zJIwBo%M(_%?Cu0}9jFs5j|C%#o4fO%OJz%VTPGHWkUFvCNn@FNU$Ho9)`=xg8q3`K zip9Z#PAqxSSmxeWERF+oV#$-nGWUX57q|wTc@ZfuBUxs)MQs^#>qpAli!X5zlC@m zn8%~+)nB@bZlkhFkyrq{_?$1mOO7*!AfN$ZQ34jwA+P|?6KMA}b=G!YlgApJljB!2 z2D8RzZK*!XBN7ba>GK8o!!c3``l{3qSi-~Rqh!3YR0{?$?Qz(9##p_&MLb{0Cs}2L0Tw7DVrfdXICwO;Zae`pcozQ0VDD)2I0AIh;&{dIhbM=F_$&%11(sV13@Up^Tf+8W z)IkPst3Cb`p{t|zpd9mdf5h}2X+q4-wl?!`kjc(EbP1fV3 zsa*<5&d~wQ8+imo+;SpQ-{dPyui2}pFVZTLn-U82Co<*qCo->5C?rnsB=p_qp-u&Q z5^`n_byB(~0kS#&akLZta}_hG1NU2J9+~1RWihinmcGwuE#?Txq&uWSWg;sT+cw!VTu9x=ZqAmE=iQ zk_t)AwWF><<817OO%1jbr@)z+AonQpkvDnE>!^7D*n$_i7V82+&bN%UHbJ5Lc5AAa zUY%Qgq`Tj$K821pH!1q@`Q#&JD}x56$ZCE1BG&0MHM5LM#Eqljn@h-oxC<_Za#GMd zSyAlj)Aj1Ww6lJ*kqCL}!9pRZZ`zzua0<0kPzns@*L4@v%T-V(TR|x#IZp*O#(Jd^ zzm(V%hS9Wk{dgtDzo5xBj5SDolNZ^E1l_~#KG%FucS^5NN{_ab6q0OJO5XmHJJHLD9+Jg`!v&I3I_4k-oOh&-S9Td@oX< z?*elAE^xL&FYBtq#}XQ!PfBXPZu~ruve|!OT?@}0XWt|aODzFx1lFjPy|d)}{=l$2 z8m0}HIWX+}iy>tW3>#8{)Pk5m5Gt4gFJ9E{k z8@1Sr3TRQPlf9^bvZx$37xm0Za`R?U+B`DcFXR!>qNp2tQ2}L9Y5tEQ;q0M$=l3Nk zkNSuKGkwJQ7emT4e?v-}f0oj!O!F6fRoeW!kTM7T4T&4#PodgdS)^>s7QEfE4T&<- zcR_n>gM2}Bp=vhm6tAHQltuN$k-g(5JY7t`u+1MeDqyBY&6`C@>1=fAsoxo$jaj5L z3purVc3|BFci~w_$fEAggpvqjUBGpRE9BZg7*9crRUWh|1ySlAv^E8?@n#@450^O@ z_UyUgm;xu;Kyqt9Za_)FwZK}&o*=$aGviDUU#l-FJ&B|BJ5kG+b;lXhF9vyU3PEdF z)_o7QpT4STkuJiV)47!QQQZRknnLm|^^PEjcj9Aiu-*0^e0NEZLo#k#(;SFcTT_5J z0BlPE<~Sy3qU6Y{sBPN0-1(8Eg2t~ADs7wH!I+Ymv-@<$Hg|x@H!6rybS2ZS-hW{4 zN{2}}ZVM}94ASR|G>ybaOLmzc?vSll6eNK~U#`zIHbIN2OkR^k++N>-md@Se+wX(8 zD}C@0u~CVfX0EkhQHfyV%vakml@z7*Myp z*dt2so0TM7DD6|AMf%8KMnpS`GV-LaiBw)iFIB6w);f^6lA~AGrONdr#q@TcrIDZ8 zQ?6d`Z)gUM2Z(0OTSaGYYu?9Zl`~l~>@HzukuBqSD~6tk7wC|`TGYbpo7QxaZxKRk zG#NO1gYzbuftE}cs7U!=foV-+*MoWuylWL56L8d z70n}^hr{&pr9nJbl?mdBs!oue!tTWSqkLyM!rI$a^6oKhSqyXOd~-3Jp9om)5c=t2 zNZ7ILLi(!wDcP^d(`KJ{uX-8z*@F1@FNVaMRL;Jc~H`xqk*JV35-VA0JZx_Jq#_a-_dfGyI>g5YzTG_OjNH5`9N^0)y5Zh_L(G76v zIoy`etZmjZqg|RI?eeLSU9McJ|C(b{5I=&UC5VS86Wa)96UOdjWWs^*`N=_BS@wr;nshFHxV)$GTM;&Xgwxbjzl^ffweImqN;2 zc*>_1{X~ctuiMu-layz3w0SP~^4tNPRlnDGR+NX}S;7CG@GL^X#6+9tM#{4}DEL+i zFb9C`DZm^6u1o>u0B}_bFb9BVrT}vQcvcE92Y_d%0CND?kpj#CpqT>90bo7_m;=Dh z6yP1>@e%4Vyp!usF)2$}&`SwCC&f1h1a_qWa{zd53NQzNt5bkE06Z@Rm;=D`Q-C=D zydVXb1HcPYfH~+4#$CB3E`s=EHI9e#6HGo1k*8$|U6!%zsw+{+V_E0PKT0CNENmlR+Q0547f<^b@L6kv{2iG~pON&;3ogB_sBXT8uI0A8H}%<V$ zVc4l}(71$tGbX831HM4&%DeTwn64}bLZ3eI^T(gbHusfaJSGWhzA` za=N4Al|L63*-mk*L2PkmFcBkvFkekoEeGS+8|{{=g*=z0b}1z0Zi23mKf$Rs6eSWr zZ^0pc^i7_I9%d1KR`u{RW%?hB3qSg1`H?@EuXXeD8u9Z)<3}O!(;YvjIDQnx*ig#zE)&UwR|Wfeum4(X)Yg%!evj)$>9+1`ewAa&K%(d z4n8%rMCJ&E62x5J!1i>|{8t}Q-{c+L4FvOcY9QlX^>GIIImq&1QOSqC*?h#@`LE~o}@nONBIMzVkhC>L$zFKJ3@Jdwepb)5j^iZh4&WjuZjbR+rGzaW0Dki*usLJXU1$mLs_FmSVF zmXFV|;3oTJ*pYN_CbWD@LpM0=m*ra;wQ;j!m3KUaO}4A@jR#9UWCvF~B|l}9awEH0%N1xHSWkM&x(s(9Xf4?qn_G<;Es8gj= zE&BTbG_c@Wnm??&6}&;MV6(LXh3Je}t@<_3Lo~ldY%-M0b;r6*vCgts3enN4Y^<|= zto7Zo-l$mTSS*F;`HXC=bA2rA-e=qC?TU4t#ZpMTU9nDMOONI0bt;P>ti++_hqs4T z61r!_W`=W7vW_^uCdr$ z{@&!mm@jO{yrUg6b&bX5+MON{w#_tMn`;w!hGYCWZ6a@J6G>fTvAG~3#@zwnU@;=Q z+C=`XO(b=V#pZ&Dj*~tFk>`qt9+SC_h8n*^gfNCRe?)gvze7!Zn>BTX#8;}RuXUoE z&g_Tw#9h_K+J)j=QzKH7V-|T-6y|;;+k?Y-4$I4zoDW&&EVhK@+ygCPWo5tgeE&f1 z0a;<>2f_r@3MHQ6YI`i)*Q$^=Cn@QFCgvd#nKM{`94n4UaKDt zf0>8-{;a$gFN%Jj=R_=V^UlzE3xksYQ=`#yMRkOS9J)Bffj=;uC*BjX~o%^_rVeJ~hN~T$gjxQA1N6 zO5V@82uJdQ%hqVbZCYdej8ndeWqd7<%R zydl+ty-%g_AfH2M)BC_9!OAef1Om4?E499rm6$isRh4V`Odl1Qv30$C$z}gHQW}>w zZs&K9!Y?GO!%B7#x$M*-N-c^a|fPl|-fJ)c`k-q|KV{!vc}$J1=1N*CYx_}7X#7c?y5e=6ec zRIqV3CaGQZ*qxj$%WM5y;4 zBL%xpWiz&0gPlBSMFTAGYs&VRn-9pRf-Y_^RUtAnC!MsNTQOYAmj&I)flN>|(&?L7 z#$^&YlSH)k7sk}gxE6GBX8CxsQ0hT56fv`$nu&jokFP)Ne2i2|rCE2@gy z#*;-c6&PD}7lPKZ!t*HO-6(9`^`KcF8QEqg~?J?NhA(x)lPuxxZ9<%D1e!_;rJaR^RTee_G36-|z1Z zRcTwxEV`D-Re6+Cfp!HhrpMDb^Mc6A*i$q9(-1BcU`b&a%vvCQGqm^0na)NQL2#zW zE`f|QJ*G(R-a+$bItZr67AI?T=jc5~cg&@^!qQ9)i={-j7_^%x{ik1fP=_=J0OOah zdWZ#>1AygUnCAF0*GGlwdN2l!>z8ZXW^WG5N@081U}P!xl!&FWU{k=^Y4q1{Cr)gu z$M;J)Fb5p0O#$WrFp&bxL4y`%rp=qzw+ACaQ`C1&X1m|{{dRvBQsxAXA*Cm9x{xxb z3k-?Q@f3BjE~L!48AD3X&18|Vp>u({u(sv}pGddn4G95G-^pAdmzz{=cTS~r!?VeE zM+){43HZJvh5LvEeBY5+vMtIU@O?+>-$x|i*+|Fv(m9mj7)WaJSaW6r*jn`itpC zZkG*+ET3i|57}{+wmZ&2khQLB4#tSS-0_SN`WNh6M__y@BMsZO&T|lFp*Wd^P>)o0;H#C{o zqLP5V?F71k>ANz5nyxXhcO9*4GkmuT()MRP>j${6olls?)TB7>+|8@-_6=9ks^7}y zA6t7?DCPK(lnIiI;s~g3#Q__dj!gawb2?{n7le!`!FTVTW)FPYTy~ z<8Z(oieOWyWbf}4=YAe>3?kS$4Rv2dPCgP~arsCgl8^og{+xVd5Y>neYN{DdGV^9; z>o&-b&el?y*d1I0hz*940otHNQPp1;paROGqOw}#&=BIN>i$~FYfk0$Im)FJ1@RNe zhV3`IBPh|tWP*ybw2mM>T$4g$2gTMf_|yLsB&YDzUFCy|<-_z;wvWZl<<7Yi-A;D| z{MBSTdGh6G;$V+$3Ag1D6`#%_oeF6N3zdV(BbCh7z1BNy+H{|J<}7;e8$jwr=m%W` zTKM+Qv8m4G7#w?}cd`0vJe^iGwM!u^>i6~b&*QeawT?RgHA5OU@R;K~Rs`;>%#zfy zxxu-oe>z!Gqp=b1`koQ519`|1Z&`c9n@bZm2a>`16krafeSP=KyusuA{=tzhq|6&U zhQzdgzGieo>TGZ;C2GZ>BzQuapgE4={62urYkq2LE2*cq+Ma~M+@1iccO4=Yzzk`h z)D_E(Pn~!Q?TRNr_MD0(Ze{i>+Vc+hdMp@LCFX$rXQ?&WYxG)dE_|WX=UxV5PN5(9V2l(6T{^`Dg_y z@4S&tnSH>@Oh66(78t}0vN26_Rw}7^7zPWa7R)~?ZO$95IlouU`EqN{3ehXZHL@d0 z>ALv@($POo?~5SE$&`SU#h&DG-6Y>9l8KR2h#o|)aooYO^^k4$QSCPSauVX1FK54F zS$Gdx6(E`GErvi9zCwr^PtC!30ke92W5@D`0Ty1ik+Ey-4d-)gU&wYB$`dSk@qWwt z66XNS)p^NfDdN0B`6!6_!W78!C#2av9>?D3gUa?5mTiS3JIOX0q2@mWa`B^PU2Y@t zd6#1OkO7yVf9&OX)&iAU`4DC@p_bjNFBQG6VgYm1v>eRBS#(?A8(igK4q_Mu#c-_q z7zTAO#TZ;M%%L)Qyw$eq`!%E@aY5hYK6;H47rO60oY-9qA5t;!L>c3wLiGG~=I+B5 zXdhwaZM5M_UvgqJ+jk!X4CYVjru<=1-fol?lAu^&12Sm*kTRpmDvp}0)oUjYw*Xci z^v!Gscjw{c?v(z$lLv(?l7}NL4@R3j=-ZPA0fYHRcT@fkQNGghppXPDtmWbF6fSvC zoT&Nk0tWM&y7~I3_vcozllUc~HnAd3dZ|MDdC-RJcu1$q*4dJ<=g3uGcqFxkfoo!^T)Hv6PV8Ntbr zP$Zg6)PDXh?{1`gT2D=mA--+Gv@_3mqD|&<^v*rPNSgSRSRmaClN*bP!W| z*~beFul;zTd>EEZUXgxvqB(UA_d%7C%C6JAfp! z?;Li+A0krrox^OT_B)3H>OPnc%)WEj24!>5M&mqF(JJ%;~cG znjw+;jarkja@7GttzAyZxqlAF*|m{4x&T{eDm&m?QX(ij79hG?!W9mO+d>6-CTQD` zm+_LdXe+o=62HW;uz0xLC!Uj>%W9rwJ|^@scY~%BFz2n=eG*a6WaxjeRz~>X-7iUx z`bs9$(I7oZq9>^3rOIZc(0n6aD|gPuDn#vn0>aRB}2r!h+e8K zr9D0u*C3YZg@^ZQyfZ&_W*~pVp$NB4Oq+1$f(yAd2c&i&L!C#nf9@#EG`rHawrVOP zvxD__(o3A-M@mI7d-W!D%SI4~XZg)qs&v5X z^9b^XO>B-v6x42c)Y*=A(a%D=V}{m`^`a%~&dBkk!waCGJN#q1I&J&5Ve7485BqSm ziPqb2Qv^nX__;@tM&pwRRnn{dm4a)XhFFFBA9AAt%17}ZadK3GCFB|SV~pxYtuq}K z#$cn?lW>QeuLxqSK1Qu4E6Al0se8zUj72PpefRWg_s^tn;AzZx1>r3KKIdjZKZIvy7toCVrjotczm&GA{vBFb5bFrw3U|X` zPi;Y(F0FkN{1@WRe9`h0hDOq@OY$PFlr za@~ZN=T^iR)~Ic`b&;Tny)KM3%YtZ&B~_hWTbMX^{b36enD~cLsU5p8pyJ>MaoRDj z<|k9RRzeRf&lN2!m^jxU>uQ?OGWB}wGHeL?_8#U?*X542a>(M$uIS;CLJ*;evmI4t zp(9fd_H2V<{0G$*Ymr(JYtw1sDPQY?`0s?|5|f_d zIo?XF_!l-w>gnv+hf#R5Yr4xQo1MAOx_F*WCL`tj?CbDZ)O#t}f? zm~LwLDem@`xCErN?^|%;W{ZW zbNIL(>0H<_eH${3H^H8-VZc;=y=Vd_ zyISM@>BK*Y_&f(hQ{k;a!k8mM%YJelWOQE|>ziE@(F7CGiinx0ecHKP9VoTuqyNrF zJU4V-mM0wovJ-&Q6YlF?z4$H6c(k|ERCHEIGI~C@8onM>o7Xm+n{247FkT9WejcFh z1a=PPWYw4C(<$Ur%|R5k%@_mW#5rz)35)LQO3$YFxqB%>X!Pe8OmmMG4YNc%WhP^> z@WY|Ua=#@QPSpH7W#$Q)j$cVCGt02Bx&(eg+L`UEIlHw6%bVbQJ=tS#!P&r!N5BpG zV_v+A5S;3LVfq?t7{to}y6rUei6D0@JUzyEl5yu!Y7lukDvZxAsqOELAFKGhrQ^&~ zA_jHm!7YEYbcRhvOV{e1VNNnDPnNUHD;pfl$VL3Imd*Vz^S283h5SVm`^~PXh7(nn zZ(QrVE7(3v&u4FzbwV^f9M(S+q`3s^Y=>1D=82JXThV%N!Azje-5*Yz+a|OXLT2K0 zs2x%L>$DNxE2n1tt|YI6nYmLv17s$z`DlnR!C-0{M4#vgFTa(oItBE}q`lFb(7(MM zP_4c{Fmi6dF~Q0F$>k8Q|Ad$R%p60wRklj)rB-!bE||GJkd@S_0B$E^uztS;;};`! zaG=O+hXuBX(xQornYt*~j%R>09>-MM@mj*{#N!<@x5P0AwW6~T`}4KA!rmX%9+Sjr zwm_VT1(u;!I>^20YVuPQv#peDHOV@T$0ti=8C{T;O{e1)?yE7jGd?O*^!3fyU69x2 zpuXIA%1b73Z>n6vy^VdREyOvny%iK$d9$cs%gdJm$B_4@)iOJ`4aJL67Y^$*qwe#p zyESYx+1>NEcH$X;c)?Ign|jeZS-yNV20a$u^e<@MOCrjvzU0+RXt(4EVwv8aei%=~ zD+MzGQNLf$;2EyHmFEy$TnhFf{!=A-#KS2HTzyWEKE00eRtRJ9k|3#&oUS8mDPExLuFmK>(pdHYCJTAL()+6TJS&KA&>&R^8lPfe$JM*f=>q}g#Z3@; ztj5fyaP0&_=5B3x3hzjsGQ8(trwYm^k0D<}#eUll4U1Ew`BO*o!`Yh!1JHHr=_R>C zk8$S=l#X;!|8qKrES63&z7h8Kky@J8ktevc=mI7VXpB(5e4O%jB`F8ADO$FbNR)g* zC9orCevM2|&5Y@6ubg#f6*%6c>f->^*DZKd!E!o#%k9u_bVB8HwwL3_`ncchgvwbr zJIw9SZ*@ZDteZ{dcIdY|p>o#EK65+tJDpHD>t?ID9s1o)sGN1P+uRP_(+QQcZZ@1< zD8=zT3$@~qv+nFUw}Zdm36`_&Y&*Auf6xh*v+nFXw}bEN1j|`>HlN$UKkNj{S$FoI z+rdBT1j|`>R-W6z|J@0ev+gWDw}XG&36`_&EJ?eXB;P;j1j|`>R;69+w%)`#dg~vA zqgdO^N2l;zM@w3)AzBYA$Qk@@p_>*OvQNJH`8Jwn%2uEtrxfo2OSoad2}H60*OHUn;!u*9oeVa zcnK5uRQ&?xjQaES^A#>=IPYH&2r#$(W%^HYtzrE~H%d3&)o3agW%d3#eluZ?xB zT;`RlyS#p?u%V^tk9m7jJVOW-oa!aDTJBz1+W9;4kXu@A}z) z*`ioS3*5mvYjLcL1@5G{qm5O`wuu`BzTHsuW8S~w>MpOz5yCd;=PLdDtA2X9|7=#4YmnV*N)q*4>L^eP7_;w13Ro+j0&a1M8Ufk9m8sE)&Ae_K$gcu|6n-FX|`1 zf*)^Kj&dgntJ5aT+neIEy0OgLi}lWKzRcUp*QdMrGH)+mcMGf2Cd}JgkH6~1GH)-| zSf#5Z%-fsdT47z(9_7s2OKYx8%f@^2_O|;Igk}BFupZPT(TjCvH!bt_Vx4ES+HKXm zy`_42HX@Ui-O3|uWu05?kBuL%^{>(vvtI+Go zcKjmYtcWI-ZEHt+xx*OLMZ2 z#~$~jY$Uj(MWwy+4vW1wKP-%u$fWnAX423m;GX zQx~+iK5K8&l|oak$h9cf!160gHEiHrLDNVZ@CCTz20zsYvX8o0wa2~`+pWTxy0nsQ zH=F5ToYtwf`AB#y4s*8)`>`_JFmzn!T%K0)RJ=d3wYlB*s zl%mR(%8?P5-Y06DFLEQwW=0enX_Mzu45qlMotWvr$xCV0=;WJcQ<_%zxYcQsGWc04 zh2}W|x5-e^t5ve_q4GI~?`hU|J9WK^aMiW&sB5jQToO@JYb%#T)YRI_I7{^&oRiI+ z4y`iUjv)Ck3#*}`4T=v}u8Xk^Q+eK+y0U1m&P~gGY0<{G>HdjBOSN-~odI=xJ$n&5 zATlGg<0^wi8$5>xrjH!30cAA5Jm0C!^^*hEhNR1_%oaxa$7cs>LlfiD?TdC9Gj$7*Rzj504OKq%hMzakz0Xzy|(R(AkzY^$YRD&*X;+ zae9|`=1%y%J2Rm(80_uj&ag5KlJms!X7+IgYma9z-GWOmpQx0r&1%v&-S5n7(G4|o z3?HtSMbTR3i?WA5y$#Pt3p(qP^c+V%N4WiSZCDHC zsmfN27uDaY0r%&W-_*Dpd9={BQF&W(I?kz8TR8z0BnJL7)2@a_3s}1_V2uyZ7`BA5 zO3U<>+ma{o(eR~VO&~v53QWV^!pFuS*RDUiU<}(#u-diIXxCBzSn9Z?05IaXr2yy} z&$zmmdy=n%UsB%eP)NsU(|%?BY>@mE;Pg5_mVCHfwqu2Kx-S*ux>`?AN$dS0)%yBrBtY_SLsOAFlnVjA$$rCIr}Id8_(9k%cmFQ>mvjzUqXU^X(=q8D+}g5;+&~I z&gf^2IJBc#L8Y-xT+E9LjoX^$o(!J7rR8+~t~c~A@3)SoH!deZ>YE*Oj@7eK?UB)7 z?dZr}xifLXwuNkih;q`Qw29^G%Y|-2j!0g&{0i}QaM+-=(ak;IxIFJ>i;03YY@S`| zh#rG_jO9Frw9_iXg`&+81J$ct8A^dvS)Xl)6y5KrDz`7DvZMQS&1(-3sB;=ckawkyu%6n7wy6wb5QmL`Q=s zI8FSSUYSB9Q!)A&^a*XK78Wy=f>S?UC9u{KW))_fap@pz_b`H#lMi6SZ+LkaAA;`= z4zTsn;-bb=z>Tlr$HpPeOXpcRUO~?pTF$-}L6blON#LR0?$Xw?X47nF$w~eiUC7A7 zP+J#xzNPeZ`5W;${tC-agD`BUE;p0fR^#DSNT)V4mTEIpS$k$A36+6gwJdjZe97l4 zLwi<(Y%|~IUHx`uzH+tb=f0ub(I=&Kn$LZPG`Eqa8*rra9Ufr$z{11Mz7+W`@qe}D z5`^?y8LSOe^y@9H1(||2QKM7R+~q4yz8(tOkbbN>dXQ%++2XaTmj;72_IqeFf!@`M z>bFy=L2{Cyc8cQ^>ZEWj=cOEKW4%HyW~ygB`(o|r(bn>M^EP+B%CRY!ySpqG0KHw*Isu4+)Um5i-@)4ZaCki?rk~tAs8s} zAsRnqz-5InH~^O0+V;WmgIjIqS%EUURE}S!w#o66{I-?>GfwvW47BijOlWWy%6m6E z!YjG|9PoE**aVi=XS%cKS zq0aXjav$HqPj#+rrr&mzl^4n7dAlPULW5lm+URSE7vI9qpiZd1Mj1UT2rnxquO<4r zAYbMYwd4-1RSb!ekoX@IaHt`E&vGN(k-97cU!V zG6G<^>k59iT)z3zGaSZfzVQYUAMKyaP3Ce|<)hL3ZGaHl8*fxlAt<+VHd5eretat# z4vJmC{HEd-2Or5_R`KN^>>zm~9OO5R}(5R4+0NzQoOPBN6U8?!IT zo%UfnyGFV9+j+S@%Dpz}O0_?}1LWjRXqLh}XTMa+{n3_XVSoA1?`TfR=V;Nni>$oA zNR#IjAc9n>YWXY$D=QT9?O?u8*sUA zT-F{#J5!}{;eEbkeL?(sY6M{@+#FuKHQEy2t`@l|NInQj_uKfkKqUI6E{^0&Inn|2 zH{%yG$y-v#TT{o|Qpdlhj(h?3Pl&cAww6v}WyK zuSj8L2}ljY;GFwZl`~KX3 zK9d3|YGs>?Z1Txjgs44)*I&v2uVxfw+eBn-BIF8VXNZcjBY)(&|3ma0H`X0TI{N1j z!)zL%YjKOf7+jSkTvCTewK$Gw}gvsv(=*%{1H_#YG3+%El> z&5QAS83#*lz{RleqckB#@jY&w$l|^4A@KTh)6kP_?l_#HCXf`O@w0S1zGQRnV7XBC z#a?i7faa!05Rb(da@s_}lxriHcmJU5iWSRmaT+Y~g<02U@35{sHsd4f0j z;7PUExnNawoX(-~IEMc~Z5Sq$Ky)*@d1g-Umzy42?ElcA~gxYNNj6LGtU4ra`i@sU08 z4sfbBBYxEKuxO5=ti0qmAI|-awi@T_kgztddg|tx`v^hDplsuf@ICeau=d_@QdRf+ z_}zPF?##|Eu#MSeDYJl!muzqT@XbS3k12kgN9E0J2TSgD(%cDqr-`*(b8cZw$(W7 zJqT~$RI#HAb3KO7&VC3r-;QXqb5xx?)+_>jEI$EyY#P-dBrrFf`QO0SQUyWj|1#p_ zXN(hZYP_V1eDN?h`w$$3h==j1n}G@vR|gp=Ggc!L%&Bu=;xU4awrL{ZKQ@>lgTRJunCB2% zLDhR7mYc!^86fKjmg<4A_%1=3rc=(E4pb7DE3^Ga5FBohNT5sIo=RTpI;~&Wz1`aO z%=h!#gP|rW*X%DDaYoKC$T>DD2jfYsiKI#!dnMhAuwWPnE2gl&bXsP;vKV$*KR9dN zM5V;~VP+PaXtAbd5Ad+f*Uht{K)%!nj3Uyirwx)4JJY z12@kqC`i+VaF;*yoE1%9Ks;QeD|Qfxb15yF2lwg@?AZyJc%RuF*av{h&pmK!Da((Y zqg+q!DKvGH_n$twP-Frx7-wxRDWyy_U@kI-?z%kKrF^WQJX2;_Gox|}Q`=Hxsnn0WfVs(fOVsmkl)}g#HDHd4+Qw!Axhe7P>kt zrYj$VPqWYAUh+JqKY7r?$P%Lh+i6iPU#8!|YkG4Fd%9%IGjOCLw!L=+=n51DhB|*C z<{=Bjx`23`CU`YOCL%75vf-7=PCGc*&`IFUj85Wm5aqGbWR7Svn{CY^WM6^zH{y({ zrdN8{$s8F?wUx|KoU(Og92UyshI?DmF7|FfM12^xKNDLqo;9I&BN2iins(q%){YfL zoTo+^bl8uuj$^!bCZl88Pm|Z%gZUgyJbnXraBR2C`wAKyT|5FimMamGy5^go+hL~+ zG=m2Ht@keHLN@fD-!`j%%K?FD%Y+8#zOH(5_D+@1#QyT!zAgO&q-AfKo${|u3tC1( zv%2Eads+@?DDL>2v!t6*;F?K&S)itZ`bUA<50qOQavlh(qCm|BHK0Hp3TjA!Ivo8C z=A2~qJe2o5doMT&f3Px7U~nc4W<`;SMD~p$9YpqzA{P+ZFN&N%gc;rREyf^zj%S>k zwv5wtXxf7e%hF={F(%h`m`t~zlSQ|@g1_sq+ zL>5zE9Zd`)s0vU6679w9Xo@8R7=0L!p#BP~HbI-eCtf4A&}E>n5$$XI2RT3<1yY0Z zCcg>6#TK+lfL+Q?gG*@8M}Qd5kk#4<$MHb=1+G%~0?@T#fI;sIx)@(v|5@-{rm7H@ zR>A=duE8J?w-N7`N9|P??0tt+w=;%@J!S&flOI2(K8V3~d=(n-{F+vR=;?1zJNUx% zR+uL6y#ZhPmsza_u`Jv0Q6@-37_Ed+G>GWMSOb7#ByH8=i&bbVQ&!v_WCv_S6+D%2 zDa>(W1~kRUAOS}+Iqb~fLg=_JG=p}n6G@RJ2;g>j-Y0?ZJ-xOul#t8}88XdBW8XC$d6qClZo#`Qu(pgw{&81Z3@p4ynb$K#B1od=* zcJn)c#D2H}qLKgH_Eb4mDY#oGGj`%6Y=JfHUKSx**4bvUbxFCo7xBqHh>(@IiASd5#R~6L}66Kpkf&RA#Y_8Wgzcgci*5>`S{o z2arZi>9$HV4F!)C8;=EJdiv|Aql~}Um)k@DKOD<7R&IkFOzq5rP)zL{#!oyq4J-S3 zRGK=yJ6~A-5PW*Zo7isphhXbz-9qHPmVN=j$(oj4p~-C=eKr&G~Jvr<|nxK=*T)_CS8Xl?SfBKRTBA1r(N}=l%QO zr=}eOg0Cfcm!TPAJ8$R6=3Nd_7MRA|3w1QUCrh>j91S~UmpJq876-J*e&g^dNu)=O zgDA4f(A9V*vGOqNGt=ds^P$=9z7B6?u{|$UzltXQYHaVy9}Y`cjmLd&cqau*#M%ES zZ^aOBc!qPIBjJ~UXtC{%;plzh={~VIN(p~F_)_&IpSUK2xOwJ`JQv&1H*u}Cu&;Tf z9Nog9^m=UH#uMTos@qL`+IGie$hLD#SjnvN;*cyMwpq7t8V;_R;-VZ)Ke~o%31~

HFvly*KXxyP)w+jBy^lSZV zUvl8I9x3JD1%(f;Gq*M+>i!Cz#(3Q)_`GiNifth;S*I|sXj;hI%u*BNH5P`~y*muT z2oLqjvD1-b4STxF$M%v4j#z5~mt&baIE#r;>#)}muga9OnXB=Pae?U5R*XofGd#wA z!{v64(ajqK6zwKyNHU3#qm@lGpV9}tm*oscA+($-g0m%Xwh#(s^6QXS!=O-r;yDaC z-Qj~^s1m7_nQ<;a>9R?gF2Ppj%ar+}5O_?io4bK`f*@382zd}yCL1V{l_*&H3}O!f zpJYj5W2r4-v3ED4K4Qh>0okrK0Z9MUCn(F;M}nzvqrVY^J8;v(aco|0qkNj^o=?LV zQ53Nb?-E|y>k%e%m|qrj<`)yV76t?tTFS@TtsH890&N`LE!dMV5gbMV_zQZ-4D>-T zFeaA^UMYM8&#)TE^z=v5e_I%Z$}OlujYgq0HUfYJR6rxDZV8F1CL=`i1e>r>K==Go zkQMl&hd&nnNRMa?J=Vh?LyyVFrULhWjj4~di!%M@{&!DAJroURIugt%UfmtXHj6Ih z)Rg}s-Jz80Y%5qSQ|^?Qg_bnY9eR5db@xjc+onCGdZ)j}9T*20B)UQdH zn}|Ngv>3H9uCg!&(4;zEq5k_!rxVJ~czDeMKpEW7s3sB(_A2Qx(l zNrRZR65-~W7J?x!mcf>zI!1+NrvWfv zI8?u@Qjc>R(rFH^`AMS?EO}3}p#fD>P+gn}4m^3{P)g^yH zXuK*Vr<%fAU@BX^OyDYMl=k$=Of!*O6IQIM*XJNNRgd85x^$rmri6acGT@~l$Jh>< zgZZ!)0&Htm%wbz|F`_O+DWp#%iyM#ijUYcRFb1jdD(G!Hr$!9t*<#+k%t3v+;QJMD z!?!PJ^%>G5YB1uAilC7Z(a+#sH68E!x$rF;kWyS!(7bNg_a8 zpW`||f9O9bl@34@`?x~GY}Za>>0I#apN0?oX&943u_itOnr>(3hxHftiVkGoRLK-m zO^wA>js*4!<3{y#TydtV#&P!IrJmSeh}oo6b$cJK&0tQ=_G%e#{TT{SGBp(4idh)7 zSs2ZS`_r)2(#uWQ=GwKb*J%FQSZe*8(IEdFk1v0A{~*M;pep8N;Dn9Myov)X0|!V3 z?`srd%P?io*($_T0HI$ah_Mtvn4lBH7!uU5G}e?fF|J{e$&MzMhkpAK{yLR;F0#q7 zdvn&#C8bj%s15+Uh}N!$U7X_@gLfCpUU7~~456MY4Bnjv=K@2h=lVj(!}Wkr&vgW& z$NSN+<|h4@)u6VUJO3i?uU#~8DHaHL8`|Iqj4KB#Oc&!SpG;~~9&?>J^K=@WMZB6f-;{a?X zs3RyLJO9s8`&keI+Vn3)qch;02$6A}!tSl4O}{{*;k8r?8GfuNmHRFx@K za9?nz^L6Zvv|x7G&eWj=tF!)!ZHv5$*~Cw&`F8S`CXIK?(5D=Z;c zv@5>+*nAWP#Nat{gDvhB2`rQ*y4z1fWd16ywLI({_bdcM0EhMZg6WAb^d{r+}HLR@eS;G z9`rbxswsn=nS+D8{VekQ&KGskh0bWD>t;&)onfuqZP&rkG>(hzA1M;$IMKyZqb$*t zB^4#ms^m3cvL5wpo+Yz9RbJx11O`l$1;&doy@uWDnA%H}W7(s!xExg%XEK70aO*YY z;BGH*Gd&VvsMS*L0z@9FEOj$I%S+SQzBtY3@5In%dUd1Ay3p7GYpmkh*5U0viZi|1 zGk=}mqc}My)3?1chRYD!Q3Z5nAd}%rYRcoP;M*H9&1dXj1v1kU{9W8G?&6iQ^0@5{ zg|9k!kmuvppApOanIcoq3vksP2JriBQ0k+#y|RRfg!*WmAH}=W{HC3(2r>m* zPO&060x4Y@g)U;EO+!~PY%IEp!IW`lqk$8tokUkYgxl;b`!Ds0-7hGT}D}Lal)tb;~h_z>6x;Tf)u7bt8EB!<+`qws0Yh<=pf-8xF0z5~9uQ2i)g;NyeMo zuG0p?kgS3GtSe4NpTo(N`VXNp#BPm(s`j!3qXgWe6+9Dw&Gx1*K!0CAd$oZz&JSaV zgw>r`iR1E!(5dsaBM`MCs_*%@)ETGPAP5%>INk_ooJ6p}o_!x|Csg0Z(L{5~sh6bM zIbv~wy4O4czBioEoFG;MS)pqH-R^6rZn(8>v7I{`Mh=|X1x}gLvFS`iNW;uHj!nQI z7H^LqHQ!?v=esjvj~N!kq{tg(0d=WuF`gExZ`Nso8OtKfVKgPplnN5s0Oq{K^gzgk z6rwp7%3xTB;ETpfd+sRB?PM`_0)WEXxtmW;8YW^!j(MBH$l9W#m@rWptkP3Oa$- z8OYO4Q!fX@g%`oLc2V`5#Up~#INWPUkcX*|txGU}W_a8=AxlD|M-*xrxXE-v`(`oM z&c5rYF#fvB?}6KoarI@oJ~i8&-GI>2_P%jvcF$OBR$PwF=DnS;&vZaLsGp5h3@)7K z&jUM&S`z1r2=-pC6;b0If-qth{~VIB{JH#KFXrw*&0fq4fiT4=$ zox1>EZz_{yEcY|4?n?y9J`$HKCo%=&Y!7hXBU5|9s{!naR z#TBM|Q^+24JX()paLzzrY;pk2c`N~tKDIZz0AU$6!1g7^9p&~w>${>hEB&-(NN*pQ z*xoFtNKCph5^;ML;uhCaU~Pgi=&r|3Rvf(jx(GA7m~xOt9>97Sdvjz$FZy-)k^9yH z`?%P;V82&jKas#?AQ05m>f0tij)UE^>Gom{Fg#3<{JixZiN^AA5P z90>$oc-d`u+s-jJ<*+Un!>czDDyLD_{tR${7Jwk^;10jA zj|1Xb??M3nKM<+h!%se%MmTrs{~CO(CF~p#|2dGz$8c)_vxY#& z^`8gKBHydXdjVSGL9}P|2p)5$n=A3;2F^xiQ8}ja7t`TtQ?Hq_Xx4{W9*q0sp!+X@ z-MCN0e;Fj*&&k~NUjdDT?Th;VaoEM474&In<{d@l-5M7cQjmS?&os#+e71% z3QYaCz+2ruX9G6!(`*Bh-aiJsfq4m>d>bsyXX4bky*>RM>f+#-XK?0xxV7qTbLM=y zoqY$a_1QOgJLtR6qN=a6KE$mQb^mdY#tx(RD7+2|_Z@#TB3bbtRC4T~bxDTod&orD z_aG;K2?EzW8PsNUrUO}+4)25CqyuAw8DNPrfXrS00~otHZArIuS_Ld`F#oblb;?t^ zbxGGio}#CFy3+2?kggXnUCrA%HFK-mC0|GDcX!O>Q7NAC;At7aI2Mn^2=b<-$tJjUW?KV({V zUMo!=b(GbmnQ7;cxntFf9oF6R(~EHvIZtVP1WV`yY@=PA0MCDH=uh~G=YK;OCnEBn z8u&8<|CS$I)%`mfuZQvPjqx9h@#lf@AN7srzreTQVX*y)KrH`fe&YGR$T*h&Qr~#~ zD}CMkU-4!6wXHo6FZ{vk-)I=i|DB(B{%f(u^8e5`p8u!5ZvGp66ZwDXo6LW!Z*l(L z_%>{Ca^K+_lWGoXR5-c+5kxh-3Bt6+>@#2w8`>jU!k~aGC8(&m`sjZTA|ZW3`UMRu zo!mVrF)^uay`0<@QB+Z$(hXycxxp7S-0$RmAqJ{#{hi$XqNvjH1EQ$P@_~lia4j&# z3kpYYX4=^w;2%aPt8JyX%H2K)1I{YpZi(!X5T{mA}nGt)(FtW%N*`nbu9ns}sBM}->ytQy4RRb2FcAi}~S3ioB2 z#>8P=!X2N^jbA|)_F0BqSb||dka4-0v`fZi;o(+V)84z*5%9|zrd3chf`>@H3$ZEt-unYCgH zf%a0{xkMb-5U_0IP&i|q2W!k36({e)yy1Q1+$1!1j--=ECkulOo^?l4PDqv=e?F&N zctAxvuX(15hE;~&F(AUoGQoVw@e-ooLZ%V+9vzICpnNf%@h$~~YG)lkIYO#0)7|ZO zmvr(4{V%5HTGop?Fp+Zm;2Oi47B|rcH!@YYHAggHHOK7Le~?+kT+1LoIo6fU3~qb~;%8^XSZ*E0Z|Dc3 zPt3^7O$XVGDLN7ucJbp+<^~@cM0mL6{}zZ;9B?*Hdosea28u8d`P~a13(jM7`qTir zO(Q?Gz{Z;p@py86j{>rShPsZUsh9(W4saQ}HqTtpXoLz`?sqc}W2J_-lJh>Ik?Y4I%Jj~t1+0kIDjN`hz4ruze z^upv^dEC2-p_~Y-nAr1+P+W}lMC*fSPdAvrG7s|{8~f*BUaQ*iCeVMyA5V%{@xY9{ zJO%X`{v7!njz4qpFY$jH|1rG!%ADIMvAs3$dTnBEduc+47*%;x;EpLA(|Hs%V*7@0 zX(Q44$KnRtw-t2SYG1t!$qI;kMo<7bIfh{+E;WpKryvqBGLgO2%Z-IcU|}`96Q@>46XefJZ=%qoawk$JW#G4W)~ z1ad}%Ve)4qwH)ty1{2<6zB~-yOIQx&aTG5GqXZ|ldpHSP#<@N>9`;7ytY*3tWRJ!X zNz9Sg9E_F+BLOUvmB+v{h~ z66G5{;U=3K@vU10uXL+h;?@X&$j?D}%ak6R!oFfv<}N0FegS*g1bhtr{h{951f2>HxD=>Qv*S+UB5lS+-*ceiHMAtbrt+@DdH%d8go9hF+T|x`_IqD5u2Di zGqjSz{}xVj8TViK`pqzpi@DvHekao?|Mr0Yho9ufRW>dbwQho8kbnmQN%+NZUo#=j zM4!nEPjP%O4d2U{7kvk8y342<7pV@%BoT9Mq#!JNlvRWcE@0Wi)tCU6GqR={Rz#mC#Jsn%!M?~Cic zvMVTa#VcGR-iF}!9?=g|(VetnA^QnT^5k)HuaXlJm5t52Vrpxc0l2}42Ck2XHdDO+ zi?TZH`l&(!iOQ{il?_IdmVg= zHF_sU$}fR8QjN3Fr!0jISv9fZ4RUq$ZJrp6-t1yjnn>dMHAO{ZafP$JH<}f@I8P?X z>j8Pqx0s9K5~!rikR54f&ehdghn!@_>})glMq1)f1L~MUMqq+AyUIBUes%#Op<}`Wua@D?GWd)YW>Zg`UW#Ww1D3xFHZ|#G?D!k$<;R@d4U{;L5_uhj zs5@ZY+W;TXh$);IKo`9miE@YAcYrtZV45>4$Q*3$lZQ)6(NI zOxCBfo%nR0Gju(JN=FXkO)R#u=~0asfFDn@J}TQXrlWdqjfj)KH!ve_P4H)rj(^$>^Z(;1ceC!67yFOd-L0FXO-yXtj%JW` z!fbeV1M{eQ|EZwYfky;6guuhGTk$a^1?#uG1Pjw5HM%2dG*#uo8=#U5q z@|n5sBr?`S8IWz$CqZV_)El}fShkHN(%yX#q<-R#@Yl)g$3*)fDOhJQan&J_m1<)} z?fLnzgU#uz-&XeI(E~NdrOE#DOK|NimvVSX0Q<;2iis5m<*_GrtoOs#n6l0ykZ5lD zQ6~Vm@1jF$B9*rqcb2+RlxbvK?Bt;5xLOmRm}5sHyrcnNRyMej-b~G-jzZ@nR;}F_ z`4l@FPM!tS&dx)PmM@jIbGo$$Xj3omgfI?7yg1&&h$>t*ncIUyWGt~`mf#UUsm5x@ zUw}yl?;$c6gJ04>dm%a6O68^BjhM9Ru>Hee3wsg#f8g5FCUkB0gybqs zO0hnR>#W1|%qyxha#J{7M?VjX+t4|XJApvEJO zr_qZJO!t9l&Eeq%Paf^TB9m|qVw7X~>Tq?VJVM$%K(aU*jqxB}xQ&aW7MgWv>9ko-wAf54^$p1O%s zDc&mqf&Oxl_hvw>BJq}pIwZ$&@CFu@ioB=bq?&c(F2-Z5ypzi?1%ju1(CQkz@D{S8 z`@3#po@yQu#5!x@h*sIUdXC?dV-Q!91g^g`Qy6)UlL`%oI%cO8ol^h8QTKw4%zRXV zc-GJ)=VX}sPp~e>W55R54G^CacKm-~(YhKUr3uO!+Y}rV4a>aivyRJ58aBw3{pQ-B z{8pIK-;BkA8Q>UzHDX>fq`vOi_#!uJ9bTD=!80YcL_xzH_LzvT;>u`eEt|B_jy{LT z#AOAIjktk#J?CZIJj07g8x#Iid7>g-;a~>x1#pI^gOjbV8A)z1*-WYBF-`CW;hG0O z{k#w^pK}2mM@_~ExEEp>m#K5ykHM2$T-{REI3(%+00$iJd8m!p3h_S$Dryo8l*=HY z^%qz@#qz#0t2yCh%Yp3c%(AQf3h3kqM|)&ZhRgACYcH5#Ii?bZO%CedIJ)T5y+x=! zW@8J=D{w4|I52w=7>r)V$HcRv`?haInDowf=TsSnWO$D#)l!3voNc3#?5w3!(oqG| zdVsJd(JgTf9#J<&rn*Gk@aNDC_OI3VLa=NTEUeqka?rfX^GRH*Om7o&gTQj!S_^x( zF}{tzj$?ege4eKNoa&t%Cp|lelRLq8dw0H?w&j5zF>{EAyuG6^AK278kmW;GrlZAm zoaxnbW+(iU*+nS>mGDo2*2i{>)STH-X0NTlyc`^Qx3{{jSCplrZ7Aj8I6{DC;fmwE z%2+o+SSH}LNc=B`-}$p~aeD>6NLwoz`BKk+ui)F=jCl7y*K8V0$oQ$5Gn=12{2rn6-%RgeWv;gs!NcUD>%FOr z;(Bit!fR{2&CKOB&PKbkx5_A4N~!|?_+v2cS5D|K%=*H+8Bj& zr88w+0XoMvCUmZ#H_pNDj?QNX@ta3sQv70M&uH^|!5|Qe?4@;)*;f>^$^{WWaJrN$veE380a6mY} zf(1kKK39(8CH8N944$~uU18P13=Nub=q|R%9EID46E7Tq(QVknblkB8gZ=i!?Z=vp zNF3Oi?TgFJwp3%Tv*JcONBN0Q2L#(2p$mF6*k$g)H{6bqm!=gf-vGS35m{IsalCt= z$rD1$EhF&?0B-|%w}ia+l9v#9^`%^Cz}raP`$FDdke3j7^(C(~;B6xB{UPrI9%=G9A*mC+1&{*2Br ztukPVX&uemi>C0wZu~;lPs#1^f6MLp-{kI2xeVfzP_svjr>eo^4?e* zxj6|luYnA>h#n@z-RP2TbgCO&+KukfjqcTr?%9nl>qeJ%qbs`6mEGv7ZglT%bh;Z| zU7(dF+_%K`!f7t)xEsg7vRM1T8y27*El{{F7isVKY1FSNw|85>Sq&0>9-6r^zXp`r zGqW!B|AWlx_CV@VdhW;G;i`SZmjBh`NY9}NFOs0dLxO)u6T_rHfsd^e|AT@*%|m_T4lXvVsQ=C0_S!}5m_crE2jE|e ze+~W^fU!`sOn(lWo8iYS=J$~~Y;PC%64w;@n1o3U!FzRqCh+%SnEK~}b%=4I8QZNc z1c~!m0cV#0W{QWW5>4faOmWM;jmIT8K){?u+fir;FPB3|ZmW3|QU5yft% zDR3T-kBLufFUhr-NN8+vGlN3UNt*vY8dZ2XKpT4mt^~O8=f!r%+b9@87@QSMO7o;m zEpm~88&2$Hrd;~snB_JWBdi9Xs8nUgFc)rPF8p($bOpSb(w20nE$M2{G4_dLFlB_`mV7TS6Q7PJken}x$slNk%=2QJifb6*=%y0Y*jY$S;s?MpE% zYeRpQcjw_8OII=dyR)n+u)N*1h6;o>6%xBwH>*alVsy}tVl?%W%*s)%KVq)vOtv2X z-QMm$vRBz@ujfzNL)FGf8dj5>F;yif4FJxX(t!KTWFQRyZY~ob4eO2!>W;fuzvVR9 z(%gFpdgc_IJp%cmKBcW)Y?pI;0`xA$L_arttKR7YyBZtHtiHL|5Ifr!B@njAEL+oQ zi^~JDW$G*1D_7T=rpDeO#x(+kz6wgLe#S%GSE^|#?1AF#>tCuo8;CPi=G`#PQZ?7u zEBH11-du>T@)p7msPKq~eIY>B-3+_lip7jn2A%e%QEqk+2K$`h=$r5n9!x#g!64~l z_gBiFhB{T#9R~G(3$XQ_1Z-D>sX6KTBPb=|X7Oeu<}U2)pDPk|x!${b)TNBFM9yb=IwZrxj=@}> zxWIjJVC$0Ldui~!Ecjj?e6QeFdGZm2kH5mxC3ydrXB0FPq%Fx8ZNNY6978x(>IY2wpD8%feDp;Jhy{xGJ8VTi%}kmz$kZ1 zS^f%n=RT(Y3ADlqa_1)MQpN#SaffL?MVTvAE1D~fxzokm`F}S*zl;3}BR{my`m&n! z1G{VVr)wRLILH3~^1AJA;i9=OP*>=pxm4W;FkZu@g;mTcY38q8+$46amtLf8?AnJ~ zj(w;Bcx|{1m5Vx`D|;o1wQb#894`b$kC?j1w#J~+=CAHIP}VSpR&mE|CS&xBX=ccH zT|918W>0{>S6wZvsHiA{T_eo4<8?)GtIF_QE6j1C*al&-SQNWXSUeuZt{3LIQS1g` zi9{6JC@h(bVmAsaE{>gp&)lqDVu$r1EcCWBLeWKWX!fI=y*e`_j?Hk4J7uK&|6nj8e z|Nc?zL16<1M6rj2Wir6Z!f>Epfc#fihw$1V_K2{71A#eKwTXjY3L7*CSh-bWuwMxq zJQ!HQ>SM4+h1Kr>EMC;xV2=qKQZFpX8;=Xyafn@qRxQAu5a#VjtZzSK_eo(xJz&WY zdrDZt&;;D*8`ynXSYv}#SJW$%_l&TnMhBP^@I5Q6xhabMT3AanF+1RUPS~)PDE7Rt z;lrZX3&KVWk76$hYaJ2AUJ};U8pU1~HnJ^>y&`OvHnXu`5MzP-t+iQ9h`<<}8_YxMAqu&dgv3Hd3 z55i{75EhiJ&xP$XQ&>>8{wQqLKEi^!=?h`|&LS2M((O;e_S-j#{aM)l`$e(82%Eis z6#G)x0kes@fxNGT9e4n-WPtru*g*#pD-N)~32Q%y80HMrmi=AWoc1X8wXnH!qS!x# z9XvOR{ZrVygQM6t!VZ}i#r`Gi&_klwx5DNh8pZxC?6CP!>^or#4vS*{Bkb@6QS5tR zM;so-eh{|sh$yyQ*pUl~6$NqdA7Muw8O3lm2lejJM+pn^WRb9Aj*eosutmp2F-O?q zMZ$u76%+Qe#lnI-6c@JSXTpL!NmO1!*wSO8@{+>*rFNZDsEdn*9p}gEoYF9_ zrGy=S95E*dZ;7yubc0={x#%TG$yIq_7GCo6>IPKLaqRN%i#VJl7%7TB#4mS0Y+B(U3C*vcHSupf~Y zcIpaYf!%6htMbIcengG1(^dj2jRo@h2s{1MXx!HdJ7ZN8>nrTc)1p{EVP~B#EJ*YI z!p=S;$~QpRIcG+(jIeXhieh!b&O19QZ=kUA&x!I45_ZA4QEafV)#m{#Eeg_Y2VrZ@ zXLy|es~5KR0$}kljfM!ja5edG50>hP9fhr1L%tC6gk7{YiVYQZ@r6;WLD(hhqFAG_ zOD~FIO~Nj_IEpn3yZjPiL7cV-yW-L)-!NfUUM4IkTNqiO{9bjru%K*>5VrmbVL=?U z3cLDBVm*R<&?fAftD@LQVb`vYVmk@jaCH$^ zU^@%jcpb6w02?dp#_NHVmImcx7h#)jAQtkC6L!-^VqrNNFYMkMqj_V3u=_Sev5CTd zaZ?nVB<%j1qu8#(9=IinO&0dx&!gCG!XCO+SdebJ3w!vsC^kjdleYsaEei759>Siw zLwrHHO%?X+o#YGauxY|x+YGEE>=*AT?De~3H;^}7*w(wF*j~ckxF?G3E$q!LQEY~= zx9*K%Glji$U=-V5*ar_qvDv~te3*Ue zu=yiTys+AL*#3s{I)wFm7j{d-xX%jf z{~qOqd1INd0q;Xz!R`sbu&y7|S>`IP^>Qz_8}m+(iqnp+Hwcq{n00l%6ERio`qyLL z&s)XGpVLF;lfcIHaeNzN-f6TXhOx1@w;i+2PWBA)W723OEc4Rqli{u|4X|^kgj!52 zVfO_&FvWW!P%Lpyu=V=G77|YpyICYz+-G z^Q0H<;fbXS<`quTOR2j>>Nb0D+20rx9hgeQyjbiD0^kG(s=6YmW;gsgxn zE{xuPj^V=!ujV#wtDf^)oD0m3#bhma7M%yl_?&M(7nsj#eB6e^vEPDGOV+P zJeb+t;1L>Z`w4?*Y49-(PBb#Q$dlK26ccw{c&Ecf-UO`p_CH5zYoEwy`1b+&SNX~D ze}TmY?+O$9!PN-a(_j_Z>Oy?HQ=u#?#=tmxF?8lU<0Qy{-?0wzGO#R;%;UZvy$!3A zWkaN9HzC8M($!gFyz!QDZPR`EzH1(E14YmFw%j)$5| zhucN6Sy(_?<(D()wb`H3D>wsA((%vgLY+$rdyi=5uOXp1Xs)jRmvS^XT8_M{Xl3zF zl^|mTIb0{<>ia{CM?1Ta+r=D|O?3J3D3FuLUP~EaFpva!_=SgBWY?@8K#OJYpit#t zjzYCUpB$FvWBHZT=cqa@C^X^_nMYjUP>}yDT*Za=DBah zZ05%~tE&OxQPbyX#&e<-NYDzW&caHMc^%TJn}NmS{Kb$_;nd_W(bvw=M>*^Yh~?Ko zSDZ4Z7!xXtI(UTpG05YizQ@fC+%AoBrUQM6YQqp*(?Z|r+G$loy7$SjrFA$fpM|k_<@VOOAWDXA`qp?yOGX9Ht!H_nLI~t2?y=I<>rm*f8YyrV$T(Jjl~ptn;6P++TM3y&b;8 zx?pES^XjicJcnVJ4lZ*R%mk|Q0)C-ENDl&+Zon%^FD~UJHG_CXKvSBkxrVPKS-lt+ zAMge~T!X;tYszD&j9cH~9o?u!c;aISt}$5OR7=%Z!oBFBUap15KWOm{gvr*PbOZ~x zd@?I5JpwJxpdkMsX7cM05fO8LKSfu8-=7KE#J!_-5%2tUX&1A1qIyrM)j{=jB~oKq z4`g(_)0MrI$=0oY>D4`^CjLg?JYB59g9|=QDZ!@0 zLMaOLEJewbd{dIh@=>e$%nbi_eP;#V-GlFBeeE2*;NOU9ZjrD1)di#%>p|&6wW&q1 zpiQ>opep4V0#lV%SP5fSC8S30#MY86-Cr$TLa) zxj>#pa#X*N`D~J_3gkH;t2Xq)v>TEP|~rvD^S|;Z5N>7sFjQ#oX;GB7+T2~!e-AM zp~o`pO2&|f^H|t3T#X};j9auzJgrr3SGTz`$6jJ{DVy8ysJ)VrSg>KQWF!V;O@qCX zkr%79w%G+Kcv2W;y~yJEfoBx9O>lq*qWRVF z1#}c|f}UN0r;v(xGp|7Z0u5XA9Rzbfd#4<{NLS#cT_!@h;e19!WDl;Br(5<4y0X1D z#*=+<67>xSe0t0n#8--T}Z{P{<^#uec{{km8YsCXY-<2MT$TKxg+G70g|<{wYfrgx?85 z!lePQIRvCZ+sALUhnyl>tM4jlELBKyF>3v1K^$zkOsh(5Rm4JPM4#;&C@zON=q0#kX5dY z?CRR1p)6@2{IL*_2EgMXAPs;gLO>b-zX}0qIuA#PoM7jkg1L8Pkh)>oVx)_{JB>`* zHkv^a1>q)6SDQE>fH+LD=5W-)0Bmb5&?ZV%DpW`69xYZ9xG}8Ody3=_y_Q z(X8vb3-+?Zz*mC90FyAaK(x5iVIT5R&4Yhz(1mjZm~>>opvE^_0v8uxe zz%>~<{jMNY#Qj!SZYpy_823!J0SU*!Nq;1$*5}=ZwYF|f!^O8d0cogSlSXdlkc-K* z(VKwyYnYJPo_!OVdOLq4Uf(ryXFMPN65<1WjdZF5gM#C50pxga`7LO-OB;7g`pwWd z6^{QA60@lqTbHX-#U+hB6UE#Yoob3>*uJe#(#LHzspi+WrIJk;nQKNZme|*AD31m6 zYSmWTbSnktEMy;V6umiw(?vKtY4#7F&-n&HqiHw@M_H%S-<>t|rw9xN+`Pl=R>*l7 z{&qBJ>;D1yrwJLvF;5-WMkW%QdT0a5HkEg5M41CKoXAdr?d4TE>S7i3W9a8t zWs58ar)rS3PqE6*GkS)p50F>>YnTQ^!&Gj%QdO;{h3rMrb$p7Rp$L# zxOna%fO_7qtq@jDr#2)yw!y>RyD--6KcxY0wRT+gN9Mao9OW@@BY3v9#84i36f)u3 zMXeteH&qoPY$gz$~_?56H2Y$q8CA`| zXnJf*ZF7fga}YmO4aJB66aH~lzjn((9g7?T{lS*A0DAUSI0uMqX2Q=5t+BS5L$W*e zK-7A(7#&yas>eTEh!{l^XTwj?G}gq>YKv zjrBE(vyJtA?A5rn#okz7i$UV?MiI!rD z4<||bqUD@MPA7L55-GnY^m0G0H?NQp&`w4~ajnWo#nBk>=JtcFVM8&15H%YV^mG;X zQ?%!)ac`u9c{+`|k$MZmP40o%wCIL!jDY68_VM)9YAW8vEGU;k$xer5OnK0EflKr) zZV19cVQM*Ize=HKXvr=?!mNt1AsS$!zF`oi_;3#!(hVAPJd6gn5E;#iP=i~9403y@ zxg*qIt-=`LOb{k7%-UgQu)hu2A&t9QTCyk8*U3JCmz3u_%T4;I@8_kLgRd zG^S6FWN}L}Sv=hC-M~3HH?fm+VLY{D&!n^IsI#N6h=)8F^M7uFat=9aq8yCWrN;1l z8rF6f0pnscaW$zDYPL!$za zAk8$xw>9{-1z+5qBz))Ki(?O>Tlk%cIQS0fVjeH>_X^DR3BFec-&^=)IM-5xp_myF z^w{22PFFUmLP8dbh>WWgOXKeXVHIE`KjsNSIMh$?jB^uL)PT%bV<1vMOf;bXNU_R9!p{cHbz(d1iYX zUP5F-cBX4viJdm_ooY;^vp2&toEaMnraa>u`N{U~1d6 zmxhy~hAf1*I4$Pmw3x|aTMX+1WZf;wN;y+PuKhyI{-I`ksF@IIjt@1sSIx*iEYvIr zH48({k<=8tj8w>JUFzbi>_%G4EOUs=m2cUG85)k3(J<{Fp^=j+M|x=x68N zLZEVMutaG*Lw~&4ei9T2ch__T#SI$H&+i?xdrJH<<@-5EGlw8Wu3%pPE$J{U5iPK6~v^w%YQ}3j|3>02N zCxs(tSgk})wz{25`%BRhwPL`BcnZU=K)wv01a0PNaJy7)x5H1kgfPc1T1>iauOPvT zk$F8~V3Pee$dudh2Xqtt5242j>q`*me?q-^Z@&JuKcP#Z^GyDig!2>>#8w9aWQ6$@ zh^9a;{K2^9Sohq{xR}GhyJ(3~6$JlMd@*XU8V6LT)9LIAmV}yuuC|~v>9-#@z$h%< zi;Vw~%m5Fg4}nvioM)TMPdtAxKX}?^p1$$?A^N)cL-9oxe+^bw&8I%hOvvJD1a*a@ z;?l7&@UY&3-*J)0Rs<~7%hnecC2~knJ*O16^h(pCkz+%SAri&<3`4ut6&Zn5s3fcu z<1+YUdV35r$HnF|zxgR6hwJ)Av^NvEs^GQGntTC6(OKg2M=%7elcRMxnYz{G?;yDU zOI`l9(uel`*ScJ;r}IaFFRaTKLT~4Y`1`PFIhwSc<0pSO_0@UW>a5EpL+1Wl=)|io zC%6ALC=KT|KF=RR%c#rA&$^tn2JEcMCAlV$Z0d3&S6pFT&OoCsm!vA=Gx^li<@B@h zxt(Ju{8{jSq%MDpQTG2(mv=hMx?COz>vDQCQkRP?)aCCK;@s5bOv=ubRb4L8s>?aM z!MdE&8+rOxmEZ?Jk(amOvx+rRA;WOI$T|pnE6QUz%vzc1jg`)>c#N;P)J^ajaUPj= zH|ljh{|j`|O!uNt4fRIJGW`w%*~y?9!npXMDr7rr^8V8&V+;Tt>Kyz}9N99wrEPfI zh@FYVttC+JzN*L?jH9&u))!gp9#`!DNQwDf3fuCc5;_P4Fi2LU@^f9ui{ZL18} z;Hd}f$-d<#(7*ISPhR35PGv!lr@|Uva zOj~lEYYp6!>RPFnOug%zN~`B;RE^fId)kX#Yp&E=rp^G*l4(TFllsV1>K6*XOLBfY z^`Em`>$)2*KE$;q45NDBE>th}sg6rMQ|(%7%HF}s!Hri@eM$J2$5Q{IWPV>vo*8%k z=L*-_B-0H`X}4-Ik(KvQ-#U!?=gy$|qWI@Y@`+Mo3&}IJgzBp0^EbQJ?~AF=&6{1} zT9=KY{_FWvzdM-73Bva+C9==y4AI~bM`4fY`^Qs#Vl&mV52fjzQyELY7w6-WS+OVa zA&1icYx`4wQYro4E}k{wshc%_Gxo>M8@mv(H;FtmJgR%|LDjpFYR`kHj=z+uzm&dO zuCSl5=UrI)K2b6UkD}iWK91_EQ>fm0AJrp;6n98}CDkph^yk*8l=iqsY1P+Iy?9ru zyH2Cb^RA)kh(7fBG4rUFpG4F7r&67!n8a;U(4Pc-w&;U1nI9I&CtoXEHS%FxzU?!e z(ss>JeSJNpeRB!b15cv*7p34Yq#kqtd8VD!3;AS++0-9#0A1NOg8HqeGPYlrI=?6F zKA5ChegaL0t=$)~NPH__J2a;k41N52g? z^q$o~`Vo0<2da7b@Y1W8A}`9t4Tsb2v#S`cyAGlH8|kMh7yZ*C^1D-M_xEQ?vf{Z~ z{v0ax)tX+|aezlvSjnK27g?)tLiNn+Eo*#%nmFvdj`64|ig0Idne|@rc^y+gIpSQI zqFG#ZM49!Fe_qF)NLv@O%B;mQbJ54A%scP+$CmL{vDE`|%B*3jPpU~(Sw%405mXxW z$*$tO_3#;$uXR5ttZQF9qw;yH z&U!=CfI~^`D5}i5f5#b>KernL%3U&}a&OGzyeq#9sHc=B>jP^Qe75C8QlqTz5gldL zt)OOEqpdiirp!7`)EEmRJy5%X8sm(y`igo?)CA0~GqfMBq?BE)uZk%1vqnRGEow{g zjLKtR_N}N(MNPK;N7N=zCvr8#rVB?l&8S=nDkkcWpiT$nih3E;*`Si5dVxA0R7%tk zP-{VziaN4+M&-qzdWzZ$)a9VcM12#;tPnM{Wk%(Cm{o~-5M~=dRU0$d+X$-Gn1SSj={fSMwz71UNx82Z64|AM`Zp!O7XD5$qV?JeqWaPM+ZGeymUd!%NG z8V%}wQ2U8G0rqG%Thv)_VH>CeMNI?sDX4Z)I|NeZinLSS80JFnH z9k-l$aEf(=sIQPe$2cpkH*J=jOIOUOEGjzH`WL7&tL4%el|4ZHk6kpd%xd*#RF)%e z{$QVmoP679lyaI?g!6V~)(3l#I?JkdSW*wXnI-jXt3}i|H<3Em8sXf4+Mxfm8Q9`= zzBN+zMt~X*Y8Quf!DEm)vgl%KhRjx}q+Vj}3kvr~s7zmBwae_=B{M4L6Vl#htfewLd}qqsXf2byYu2&!-)21|vjcuMqjE{nuSmh(J3G+c(-t1xgbP22^BLM^fH^U!I5Ap)pj)*14N$wha_z z{z+1{Sqntnjd-EiLfN|<{(K(Pu`;`5G|fH@s4HaeQ><4}%Gr~RS%;|U^5>^kUew=D zHD)VCZ3xUx7d2&-F*_s17U2%~YzkaBC&t)48)oD2^4vO6&7yv1ZC0E;s+l}1wOv$eK%t@^SZ0kyo}U9V2i1O=b%^r( zf2?Gjp-rPqPeI$zH_mh)e+XsTMg8JMMd-OJM0G{8L~TBn=`coAne{UApl44C%=Wv8 zW_uSsAs2qH9665^WR{Po%)^U5kd#xEmyRs@I?gcMw2)Gc1*P-@C+5zIT$lD<1ogeW zv?wX+eo=l=1t`n<$fJA574?(Z$Lr}rHlXenb!yQlnf+DNIYrY%{f#BZUR|`mq@0qW zl)HWDKvX1ph^|K#{=rDb7=M~DTE=Z_V(q#?3!I@_G-~j;{_L+bI#E=a zbs^&VTl=zrYLU-wv_HVuvCOJN%ztOyVt)p|lvyW$+HU>a{-ez1j#sN798i?XjZP9zuI>*;AAB%gz&N?{oXGBwhIC7@GYMP_HZ^ z^&fkI%(ltQb`BSHugqNM2vJvwN;wNfEfQ7g94YF(D=4L>b5xRT)n$jV6!&&6kn0a3 z=ATC^wm!KEW>Zlb$6I4SG3?t=y&dwT zc5&WGvYy!Wf&0p*fO=nMtA^5Syz`-`6CiUq?pFSzsMl8BS3c62=ln<1+sBa8cUp^? z?q_Yful#wmX>Fj&tconn&JL)F*|}BgoO7IsG8>$mTeSq#WKpj#pIbG?xyU(4)UyFK zr! zK(k@-e?dx_b;gPx=8U&S2GoKxNbM4LQ#3348L9E{W>I@>AvHO^cZ#{Eeen--1{CcT zKLqnYW!7X+gFqbtPVC=0m@e!cUo2|ISW*WD)RQ}tIwYX}dKRe;P%K9`Att6+>p-o7 zlo@O3-j(qcsncNQt|oO=JTJc_PbPJuyHZp;;*8YkqAZy$ch`!VC9~!3#iAaTSUNo(>fS29H112z)7;H6vu-1GuKS>T?LR`b&dO?q&#~hQ)Pqus-#TWNGY4#ZIbfEI!d|O{ZwWn?xxwT zpjh+WaulW9?*2|vHb}~y?iZqtgxN8%yWOuP<+co^-0OZPvu|#oy zFsHoeQ+JA}*Fl{IYHA7Fhs8?2Pu)FBScjacFns3DC|LzxpNsH~w>}5O&<;42GCz0s z6ZNKC_}o1}Qu>`@I1iG~wxI;P8T;IwtC;v^2V-`KTsQ`^9OJDo+#^a-aDnqsQ>?Gt zg(Wsz-*PkGO#a&aS&0K*ug22Lc)ThZrFtb!ikOurmPe?n#L5x}GE4Hbmrk4(F-s@T zh)^|&vm;b(;=BmeKd}Z>XU8tdnE9KsLOfX}%B5`wsb3)>-2sJ6O zB|`0%xWB|f%rBWld;27wl9Xc(K@>afiKj)K8&J=elpsW39nV;rlXxW}Wq#sSNqPDX zN?DNDDtmuGy+Z2El1hYOICgYRu@)sh5(OYaA$S4R8Q0`IaMj>ZU%3aax_`@8?qKVv zy}oh=qNDw_GYYe{R&1bEeJ#~#IjZ~T`^FsW!OL*c$=Y}3ix@++E_^XoZq0pYVmxg< zeS|gYz*Vg)UW^^Msvc^kRkBxnRHZeqZyfk_z3Ix((Nwe2Hx8!$`rF9=9n>PLtu8sL z$l6ir_m`DHziw2`D975Ttsn8V1EEg5qyg%ZE86hj%e=~QkbM7^iBL}-K{YM)yHV7a zo=$b$tceBAwWD_fazbCK4<>hmoW46wg}M$gP-Hzag=*_U3&`9{#zB2)%jNLZti!2} zJe2%>4!9g)KjQGcpkD%8J6N;jw||-W z=!an+Lp^iYZ=r4&_D87u4*wGBq~TvftsVX?)Tf940QGmn?9l_Q6Ne?BHV!X^diC&f zsGkl`L%n@?U#MRWuY-E@uzIKm3~LyTcTAQKgZ_=-BcUELd}pYS51Rn>_F=n0eRTLV zs9T54fVytjeo$8oKM3kJ#YxGsdC1{& zo05gPX4jLU9)+9?nTYv;))P19;gf$YI(_tD@GzE^pu7}W;>N7$fttL`YL$&gLs!Qiky{#|R*iKZ}9!&L)kyPK7 z{;*&tA3^^ zu#f(L?fN(CzNMBA6odU{r1X#5`>f|*#=l{I*tAU58nIwF48{RmED~2R?cYI>?af>$hvh(RN z{X~7#Q(<=SuN#*|*9J`uMEz|q_6%NK6;U0oqKeqw=qGrqb#%ZJD@BZjo>9csHfW~? z*0yaX||x?a{n8 zpzoJ>fI7|h1{HI=f_^0#&$3RIOY~!T0$&g-okHd2WuP|S?=?&@c7W9Ld0sDr4rj8i_ zx^LBJOF#VAb25}1TN`y@G^!8TMsKulkav_5+6kn8#-aU(33XT>)W!`_*9<{@7>{}y zR1wi@r$O!Y180GrSdQ1aZ%Kb083|sz*C@iZ**vi4O4AF?6SfoY6#J(C1@&&2{uEO5Bg%8ZKVY|9{2p}60;?{PsF70>v`da7 z{AVgWmOkELJM`4(9)VXsW1k}E|KlA|)s3i~Jd5b4LvPO-KSN4MUDQ>eANSge8l{k8 zXNPJajjxS%>zb%_Amw9Z?SnTVC3h3*)Kb*b&Zq^D@-gOb`#X?wDirluEz~|6QBP!{ z?hM49!Fylj-3{Be*t<4dV{d$d`pSUX)&})$b=2mzsAYDj^=qK6uZjAQ^f9GhBKyE> zOz*lG)t@xN5$&lZsPjqpP|R1PM@aulLhpa0P=88BJ+=|`Q7zOU%H>UZhT^x97L&G4 z#Td_0)FYHDBn$0cGf}7QsqKS3qn}@my1+Tx4|VEpRR4ykOM9aRkT%+k_SIgfjtv^Y z9>*(>e$IZp^Xf+k-hc5-oM-9Jw{SmFMK?GfEBhAft>3XJl-9EsYR&qnzxF`w+6wi{ zF{m*!QS&Hf5_ymJ#+1N5sM|;{lMd9&amMr+q}3_qniHl(K+4CfW!O#}=OlZ!>{8hS zZ6QYWLM`fq+GsPXV}rJk>%?*oOJ3YYML0CWv%`f{A3^D3kFiy*Ig6Zpu}sq0pdat2 zII{X!Z|LrB5c5rA)NMtmLrYO#9HbOVKSA2NAEx;BMr{^`dTcZ50E#c6m<^;UuHB%n z>vY$y96jpeOnq!=q!Hc6G3WUq-QdhkSQbpZfyaEgR03y22OHE18MRm~v7ASXy z`#n*o_@llLNA1uFHHx%aceL+Bpk{AGP3RqCDSxqd0;F^eL$!-QeKb0uinj-(R0~7R z-iUgN>=X6THhQBD>(ir3d@7`zsGnLTB^^?#g{4a{gQM6 z1sgHtONt-+1={mTD|(~-%((>mL7xHL4|oByX`K5ge5PavmVy_zSEaFv5k}59r_*Of z+csh^B{f9toQhg+JgQq1YGcyxYM_0YbVqfx50HLhhxRbio*mIH^FaM^HtJ1MpJcRq zm@3CJi@oc^HT-RL)G|BN$E25PqTRa=sz(^=p4q6El2Lojr1VtO)Xk_LMxj>pLVaaG zJx+R(O8%V6>`IaTpe;ls^gs(Sd~14_7NXX&VW1yVVk~wOm_@b_>Ck%^nLv?&zAZ$r z+{vIH<9ks0If_XIdt?4l(BWGLb@8C}6A#fI)=WIaiJp0|I`m@YNjTp0-nOOHl{PTf zFv2|4zjJ4?X^cJ_#j`lV^BnBWH*u)>q;8GTKGzg=a~kTAprCEupVX*)2bWGm{RL8$F~P+zr2t+@rY z52e&Mq8&FF)iwDXoWBuY;M~7*4X1^O&iC)!Li`wu^Q(@Lx! zi1rv5d0L4DFuJo6cL(nBwh|9vTxTWfz_0sC$zK1{teoF>sN4Z?ePH4mn(Hqhit;N9o%;xS5EXbs1>j+uzmt#S2#x|T!+Z@3mW((Om~d) z@0>8bCF$xdXcv;+4R!HLn%)}bGDhKKhwCl<9PvE8Q+yZtE!z=w0H`EtufnayBh89> z&r0}E?=`54+uH?|XXS?W&HUhcG9LA)8|v}}s9|+c+XSPIBX7o7w6jPjl17krC-o+s zdkAB`AsyWo?dkQJ`58r{ac-cMJSTh-pLnRvUXlbM-hqZK!SMpjM+uqZ8WR zLr`CLLG|%LT^NU2cW@e&jMwnR-lceCHblMg32LqJsILsDZEaBBR!41ai&|!fTE7PB z`kJT@Ngq@CC9++UF@57~)DRPD4?k4veAEl$P^XrlrtU`dq?pdN(T=WzI+pSlY(zVY zBEO_ud9^TQ%P!P}-l$8zK&>GAnKRlW0#K(mKsEO(g=6?+EUuB_8k&_Tazu6CiATuB zMg8H}e!9WePZ67{;mYbP+vU~%ul>Sy)&FZss~UgR`hSbm)2G&W^8e|rR`bRG&ls1Q zOY6cnCGGP-Q|#B&HNp{+VcCNbo+DwOzKKK4C+#^KZMVj#>13a4iuN$FH>aUJG!?a# z3ANJ}RF4SM>%CBI4x`p6MqRNR^*BZTJ_hX^D(68V+RkH9S5rzB<*GghQ~FZ*PpLhB z)x(tQl=q-L+P#ud&r!;b18C2fi8{A7Y82Hql2Rs9N?}J#AK;66vnA@xwW#^DEw`!s zX*)2bWGm{RL8$F~P+zr2tx4P1hf?YrF(q#BNZ9-7aMjY+wX8%oT|Gh?;!)A6L4Us% zV%MVfmUD3MxG|8+&=Ym50d=+wYNRddZ=@?IeLSW6Qp$PKb(B7Z(gP{wD(RoKsWj5Z zq{XE9q@|>9`e4jkDq*XNb|RJIMkN%JI@iGT!K80V>(|7T$E3@soXK{W(vwn-lD(1a z-LzdWa>}j8%J(~0&=|s{~q<50h`xW(%fqLe2bxe_{XR>Ka zUy$~r?fqXZ^nOh#g_N=-4pWLr&r&%*Pzm!XW(dWcBfEs`H;x!Tp&sQ*MZH&y`XjYx zM;hAO$?nw{?PIiclV+g(x;JV|vWqEZj|o%kccH$Z+W)26_fw5IRO5ZJ&y!u7_V1r$ zA1%UMk7-ZcBYij(Txype;4f zHfHJDOGnOSNPK6;#)R>?)Ek?~&L?{* z*=Dk>4`R&NXw;jO_X8cJVN^oWZcIN&N7159Xdk0of0KPyw?|?6OVSB+Mogx>Q^<~` zBQ}FlMw301GocJ^?AP1j6u3wk{BO+X#{y4(v|HT9-C$o5h<$Al= zI}1`isexK%K)nriWqdZIm};S}9fw*#`no>a4INNjQ&A7~Lbd6GTC@u_#1VB3#cu(>9r*Z97wOyt*jxCwN%isUPZvR;Z_Dpz2R*`nQC!1dlKeCNF@zlc%A6IDqWYG1te|<|iM7 z78-h@&gz4@l2U%Fi*}!4)Tkb)_ePOJPHfKuX>i)X3hb*GTJ@p#4Mi5liHy zjbB2_gGQ+CwNY2qL~U(Eo$HMn(gSr2dH0*pK9GcZBbn@;sB^lYem4#^gVN7a$!#dt zNYc~f{RF%pw{gGWG{hgMhI*KEZV$9CkiDAh_cbYo>@GFXZex!+!i0K?A{UW&GpT{R zp%mGf?6DN-+y~=#Q;j*4D~~jea{WuScv3D`%9TO6mW{()rj*mLcdk?mgT0?;iyGGo zH9i&fU;yfB(&^*S_Dc!#^%Uugzw`4HOWb|{T?g7(3?8>0)X)=ks{wVk4Qiw<>Tjeg zD1AJo`%=nz(sh(Rh0+5lS}}fknCxnpgo%O zAn8QXQ>1s2(fbwkkAZsTbahOTsAsZiOJ9)oqwW1)E%bg(DTS1>B@R=HNzYO_KTrwt zDP{=8oFlu0>^F`WKcODwN=3a_jQS(BXGa>^+sW?L80}-Ub(3bG{kk`5OR|e8W{(L| z?02EQpxXbX+V@k9IaK3)vd@!UoA&RYWFIZUT#so_-6MTC8&f1YO6~H|97!)cF1kllrJ45b8;{esH8)DPpIk=CSg+L7L&6hU@lQh(BD(t)JysK$6| z)u#inoNOxp7Hw%G+Fy5Qd+X8uDxfVj&^Bi2+e=5zWlBFnDP^>$8c_NJD(4ZEu!CaE z6!RO|r^!A=@xG;4dkCqC^b+N*MQylBB~+s}ETg>dNHeK~>!hn`-`x$va(Yt<{b`F_ zC|64=$CX-TP3lKmy2ga@xzrn*$j&EwDcNSStq)?%*l5(7l=lN2rD0S;(r!#YNJr74 zO=usZTz`{&R<}oC`b*LYbVf|3yi>@Ir6V?jQbv2H&oMYbn2HbqTy*(fCAPy%{_0XSiRV zrxbka#wf;4yXog4&bGP(x~$O?(5b~g)$tJHYoMB|q243Acm=+LF=o>{DB;Lf$zKvv zym3VI?*PWy|W`~xPz6yQP?f24s~5QR10ie>wqso6upDHf5RrIAByVvE8^|q2B6Otxq{lQ zYX^}Hhv&eykJ)6fJgZvl-5JWPpWYd~tvdLDzTInp5s3a~2tN6(e8PoK2H)-tfO_?} ziDGFygKt1#J8^x<$u$&8d$1q1T>xsT8Fd2bOw!JzD@mh4@fkNNuF~ThJNP^i-@<}t z)@Dpmw&S+!$dB^>*c%f{lc3C(-l%umqZ(XM50{`OwnSajGYQ&x<_jFZ>HV`e3wy?C zZZ9Zp%wp8D@Z6-HI1DlWxA)#I?(hFG{ahjT?YR6G@YO&)@?7B)tBq{C=>IsUyiqBHNg6A@x(y3Zg{5_>^qQ9S~ z^v)i2h?oH>&1=npEqXRAtBoXf6+VG=#Yx5I;N44n)AD2aIh_|m`3*Xu?)E}mk%qb` z5Y@FAYWv2h(Q8qYJyCCWMQs*{R%osx(AwS_!l%(*1FXberoM**tX_i-w~}rr>Op*anR;^;;yv`>=-e*ba(2XlErD^oAM_de;hVAHyf06O=Ka z)vRZOrW!DPg|rGZkK$`;ySn2#EnbU4OsH8Uc%7L;E9$*rgbBYCKa45Y&9-1SC^*p_ zo<|(OnbE=0@Xjs7adAUWgJunuI zTfGO~F1`k3{tF88AnJibw&;Ct`#WvpUyygD{Iq+#3%ryp^2A$bB|s9rnO*_OVgQlZ z@#(DJVg56Qs6wh1Cc*FCR};Onl|5H3t(+JwUY_)2FQ)Fwr(E6x$+ik-Dw0-VG{rh-~60~!ch_-cp{ zxgxk<`+!Cwf+@6~S3qM?=BoQT0J(_E&5`m%TD`6TO~q{sc?C2R(eR}f0bjbv+vyJf zUn+^ouJ0AKxyWSd(Dzrhg;+;qHtZ^M7j9xZQyKgRY&UU==y#iG2jMC&%9+AqkiKIo zBj5K-FVmWX?*>!7zO6-T;not{^1IChXiHn+&Q#IB2;|8$aaSjx&P2G6B%nwOX+T3Q z)T~-NQASiDy>WEb+Kakww6)UR6)su_(Tr(U+(Xq}_%Ia|{R&SIbC_Ch)P$$F!DNVW z(K?BGt@Kh}j+2C!2xUsnyrX)FG$OMYS`rfAE#?zti_v>E_^!YPrb(N+t3E=)&&P<< z(ksXFY8Qdu6hvBAbYArr8q=AL=hbe)n#n5Wyc!_zOQ9I~9BK~|wnV3t5qmVC7@}DM z{-Lo57Fk5UOTRk$!0+I{XSxLWLd9jKb1U$7;?enM@VY zK_XJ@WvT`J5+x2Zd1Z#fhwm;BnZ?hujP|kO8v72$X%M9X+w|#V?)k=!q3}OnCIf3VR|v$0Q&}B0LI`pcGFFwb$ZA4?R*`jlH9q#AKpV zGWJq}$R;{1u;&xSTqf+#WU+(^_d~MCW5S;AA=WYBUg;&a5ao%0!+iq!h`kmX5RfWP zGMVB=2Be8|Om7?~2J{o}m<|n`6_74^wZpB=6RWo_3g|Binci+*6);eAYOnijmTn0c zEQT_M$m@rI5h4OV<^yGRUUMzrGm*sPnpE`d`-7}MOGmVwhnswH2Cz*%CT zC7)NIS&Xsd^ADT{Z^i31%*_c7Tqu?^EnFTQm?Mgq(!3G_b44c)J<`cDEpVAgV{&Xh zFmSoZC(0G|SBwf=DXv*)Lf~rnA03zvebWQiilIb#V$jsNf$PLxCaVrh0}I42OulpS z12>9$Oks1j1#TAAJ@wi@OO6iQCLEa}MwSF_7wJr!Iu&SzVy=bC0(Xc5Oiw+_0(Xkr zOyj)D0(S{p_!K4Xm3C$uQPu+`whlM>;?LLnJkBAheFC7cCqoOC1@5+~f$Kb6OJzw(5{{l~l z%S;{p>jix!9KCg4mT!}wuSGi3`sh|cr^Q$%lb3tYH==;4N1S(1xj4yGkr5E|o#^PJ zmvSvSJm{coo#0A)E9k!Xo2XpeNy@T%C|qK&cC+E}iYGx2MSrF-J>A7aF_G#0EF(}U zQMn<&59u&dyq^QmNv2fKEUUl7B_?|>r29nKhNdM*pT%N*<%Y}>qxegVCc=BbtDwKc zTnl{&dL(|;$&l)49sIZWgDJz)7U&TZ*6>7F$6=WjHlFFVgP(}HOrhzHK#oLagS@y& z@Kdpvskvt>pgg7;J39d3Czi1%8twD~Dj}+{d6sJw&%{-xA-Vp+&%{fnMk~?hWYTLt zkQW9%Z=#uWk9#HpbRUgBpNZK-dE%G-@erABq151);yF{R{ey%5Cq7tcMDQzN7mqdM ziB|i^2fq={7Mc?LR=5%6f^Tl{d*MrD7S7@DYj_cEp`73kqKAbf`0CO?3#|&4q|p|7 zZY@jGEL0GzNQ;T|<3*G5bf2N-{vE-Zw4SNq{$il*dZfXp%Yk4kX{YXko;U(@z(QXK z8>DYI@*~_?M0%f9m;SUweh)uOg&RKnRoLK>WhWV!GCb{to#aSlHY^OyvZ^7u zFs%x;hws(8GX)OxcdjY1AgJpf^n8_BFD0kg6x* z)|w47_9=B7B!8y6{To@=lh!f)ufI~Kp0t-JTjW5#`jR0D^Of5y?Q$!)zGO>eHsIM& zUvf`IU!HIX`xAUCQ;^JtQ+@vmc9aU3uJnBhR7g~AgL}nE+ROAjS*hbB9VXJxF=y#3 zCOpTSrL#o({%asTCc<<2```vr^B!2Ae)Kew+7ZnH-@m~ywWYt)+JlagXu?#kbzC7r znnbfFAj*cL+&aW4?Ip^Ce|TgU(o{T1dXV zbYI@*%|hIyUPRck_93mM0Ys+-*4{>%rTc)qLfS}Os7Z!g_u z`fsjt^$t?qK6>QU)e#}?QU=oxd8QB#sfZ~nw?{}v=_S*pInLERrL0svUsoulljNSJ z)3P;Q!CulrCf7yI)jLbKnIa0Dt9wgL@E5<(pV&)2l0Q+ln6aX7h_6Jy28LFTS}{Dt zPrAjvQh9txSLrE{zU|$mH$?ij2S`r+D$5Lz8W3fR{nGf5K*^N|^NEmPX^e%YhJ;Al zIC5U>{E%?z0Mn7!+>i+A3{#;)BkM>>{Y2lsLWjJNNXeaP(Vo}VQBoSyU&Z+$QBn?5 z54bzUNo7pk_rA7{lP)s-+ORMrPI|@EWN$H$ZMt4V&-8;KCdrklZsv)Qcq!dN--IMc zg+yi{kFX9-lKy5I8umj-lGL!jfWK_<8+;r+Svo^x7A5nqh9pb2^bt?9XbX3XWGR`c z2HaPYrKd!Y&vS?&S!y^?FXik!Nu)^gh|FT+yjvkD(iWy4TEcHrrQ1wn7CZponG8Lj zce58jwu6w&BDZB;NDrwm5!A4(IJl>@m}yIBad0oGkRxrENTIzYpTT-5x0b-#h%}KY zdKHrG5cK7Wt_`dq(v8S0zFATuw2#z_Y0?sh&{XLRQMT9xrKCxnhw5cICo~OBlQM{M zMa=}a(0|-m^nLlX8g6qTc+)p`)bB?0b_j6{yK)dgS1s)uEY^8E=j)PC7&=x;Co+pmb4o+UOHbK%s?n*?&!tZ?^~n2k zBr#E1z_iVGYUo6%kjN}n+g}KsB-I(MM=puF8ai2uA<7l=Vs3_JNo~jIz8YqDt{^QW zGK(3zFN98!erDeS=-sK3&sdCv`CLJb(5cc;rig;Oq0^*>lN*mcXYpx_#Nf((8 zy37q*B`yC#&$n#N@~}11Bc_3Cmxtv`ow9VF)ztN2>!qbkD}%O$ZIHGQnMF=!ao8rw zZHgW_7W!qgR7PYLzH1JJZIN~#RgWxceJ*UP^bM1=MiPb6OD5liKZg}c z3#VaZuK2mt^RS)LWg@fqw!jd+TT-W^&n%V|)C@0{vWT+9PS~4!q@S3w6B~x_kzNv+ z#ghfD;U$u5He`c*#}>2+-zTji$`;oaNN^v34>-afj5QJ(hVPd=iOk}=5})vcQXo@S zOkjAa6wh=nEF%1nl*4p#Q9^i`BxdS0^z7d!{IK+rDRKC~@FS87eBT3WuxmUp{HWB6 z$Slqd9~OR0n#I1ZO^1aamyR*b%@`eiLb9E$=W7}?G5kv@fT>-J8R1_^bD1tTpAr7G z)XA(zI<%M3^?5*&t($7R@;j;8z_%+FC zf!?yCaKF7KxiTps&%=L~@`>!OO!lKi#4pn4MA_oMJW2d2 z6|&ENrA@@I($7pkwp4eq9{J}oz5%;8%M7iQe?_m-5rL1LonGJjPJx zcJNE7EmN|D6w1_4MoQDk(7W$f5ih0Bh;Z!oEl?3hCWh1w{#QE2^y`%K5&ue^*XuQm zpYn6WD=CHu)>w+~M7)uv6T#L7J&brKo#DvS!7n5JlfEg?^Wk0lKj{(?oGZbvBR)vK zGu=u@ddiXJ;158TH|pEBGRP1qowHb<{GKWK161* zXI;BUP0nE7#jQb+2KgjWuK0FXkH~8BZT5Y(ZD?e5Ibe%kO4t_HNLzU!Q@7~MNIUsw zrlC&J3?X*LY@I_$yE4Le&;w~D? z^T=m5B(*UDu}^aj|2DFc&ceTNY9gt!FJaw^3|?n0#3=OV`uRj_X$(Q>gVFrhAd$C&=gwM~IT z)u!^8D*0UH$wcMQFW*MG%KM4%e2_$Q`B)WSbJ@5Di_v{8@R!S;;tz=sw-PcMURmIm@o>;}#S}w2RYa?H*;%g&!+E-a-TiKsT zFSD(@foW6V`N($i{wk3j&Ql$%R!Sy=2=1AIr3j>MS=Q(#!Ob-Png^`p63{k*-m`azT|yKe@0Ix$WI#dm???yUG4leBI@cD!%UWvMRm+Ilqbz9vGKamKi7;i1ac8<(^f1L2`N( zUyyvNiZ59HzKSnc_BiyhCw!tp&)seC*k>2V^c_Y)N!1$;r`9PJ(82MP0$Qaq-@W*z(iHw!qi1c=vWOw#qJ5BP{ zD!zF6b`@W|eCbGKTN30OM0#5iBf2-n4lJ8gXCCM4bD)S}FBZ%~T z$?_4VO@VJBQ{*42MD~<_t`gZ(PCi~)N-sH$NH3+AyrYV*w|tO5-){M;|T6pVetP%xp%>ozCgBrRAQe(eezYDJ@H*#>lIfV0tOW%C6t* zkybv(qsGdonJ$BGoP3|@#0n&rAN0s~>CV;1$s3r8`a4%2FJESw1N6Dv>AW7f8fb!? z%VgWXJZhqRnyECsJZh5sj_Gj5g{aB0{{=mt7er>slbAgBT#uR}7c%__`KHRZiE>5n zTKA%+$$wkuSyZ;#_^9-0QL)`5VmN z7s(5merVJvda>N@itgKH-za*C+>dGL?nco$@+_uESVhg1%b0$0@d{olPrRz<+XQQ> z%j8E)8#29um&+m7bl=$pUcoEmLZV#JbB}9up8PZW>P~GFy;AP=vmWU(x^wgzc@~o= ztjw;Je`XqaI4mq*UUglMZ0^`KdYycRDG63>3*?5s=)RkUv0)qJ-~>R+%!T#j9dbTX1*|p0H=UV6`;U*_C42m) zM~3W~8eJr3Fx_vyFnYJVg=us8y68Rfb*9veZP9yWn_GH5$2|w4_sJcY9!&izdcW+$ z)FtR!pix9-(JT03^Z|Ja)7m{(q7TXona=OI9bGD~WjeU$Ui2Zkh$vfJ5BWQ~O#UC! zuHd)Phh@9ldhO$a)R-f(8`H@kyO^W050igLy_jQiCX;h$lbGZ33#Npix6vnL^>+b( z*+L6-i}_McW^xJX81t39oN0cDU(DC?O{Se8Au*@qXGFOoZd7c{X<5C4rImltK{03K>34PC`9-5*&dP>Ab$XaTD(0L#mq`o# zJm!0OXa)M92lJ-I{2+I_r$-(dWR5v6-(XrXI49!R2*|vPPfp}nCo&8Q-n`>%nf$y>5n~mQMcrGL}qcS|FxLg z@~TI=uY2(AnBQf$$4I$i`OF6~cjO$RY~it?U(8*(=HKYUyUf#=KjkJmi8bB-7gHg- zG5ICgi+gf9(=M3t-IrTF!F<_bT&;W24`e?gvv{2TD(Imc!?Y?Go(ao8Kh-0D4gN3Y zk!=4Q$t<1*sj-jcXrgTKbx8HtzvXdEE4w?yK9yH+Wc_6LI=p;{=_I@b^;|y5G;96y z@E3B+7kUkywl$1>DMv6Z-_|1bUwH#l|1Aw;U&-oAJu)t;L+l$llj)17An{I~^^flR z4t($B157=;z6$yvyZ?(mv-ok{^KkffD-m1=cY4Q4%5tJ?v0z=dSXnvE^y9kFSVeit z^lWQFtfqAOpI*b)k-cNBmE}ZcQ8u_ugh9E>^a#jCsrw2ebA@3@dTcdiH&M12-uzWi zb>$e5S#%gZB-U2(c%zrO((kiaJH?NwQ}^+)HIxVr{uJ8NOEr6@a_MNB ztXTMuiR3GnO54neg`cG}6}8EYbySMqBAX2>TI>jRQc87#w9_o)h7lV~K`F$~)aBRvxk!O_XZys0OhU$VF+$^y9*fu|_3cC&TN&Z9sFGY=gGN zHdT%j=`+k`$~~fNvF*U_*k+3Q9?LA3ev2-RZLZX{(DB$7irataJ1y-!^lhx0@{TB1 zY#4JbwvFQY0e#tGg~RdKw#qvp0p*H*%YTb)ucS#jg%cTMol5IffX|x<)~xCs2b##V z5y)LR!*m9yqml`4c4L|AIzEi;q`-ed0n*=Z^;T?Dq|@-WfrIc?suSsNyZR_ii7ITy zEjPkf@H;R~U+w_Zl_?*5z6$(b6fDzbH~4&&UQ9DaK9B993}RX}@)ginrrK-a*AvQg zrjpekV*QjwOuzWQj_^|om>&4Q3i4C-F}?D)iSt*!Br?N$9$8lYN;wlg;rCbIzlcCv z%!coqWm$DqE;Ieo48Dx7{K|BxW2@k9%6+C~-ZkU8DQ}4Mr`6pQYfaxGd|KU2aU{~8 zj(1n0i1cUI-IcMr500}}LEV)VMEbMq0A(HLJLK~^B0$;7)FrBu2vBxg@^y#}P)@NA zw6|LtKz@$r9NB2sRG>%I&Unc^wgAq1SVaqLO+ns!AW$SEVy^n#EN{IxMP6 z!RyKOju^90{>wI zT3um-?F>~$FkxFlm6c4`>QH4b6Sgc=`ITsu`bfR*IERBtU z{|bS=Sz`EsesQtNBcjs+&zv|V-UfZ;^d5^zNg~2~Tt=Kp$*|C8af$H15HJ#3Jt;0l zS+4uUpQ-y?dn+%QzOB>9y0;Qv4I^{KFR70Ldn;#%%!VF0v*P+F7nug-%m=#8bke0m zaH{ez(|H)vrYawpo`WwZ0G#eD77f^GiP-BPSzDf{N5AgL>qM5eOg)itR6Pfbn z=En6?4iV{ZI`va-FyWg{{ggLMk2+yKTU)HJ!sfqD4nWPBj)3nI#hd98_&!nMnacdu z#-%HLna=t-S5H?46O|jTjxdV;%BMuwyBp*BD+`IT1wN0hT{1Tw7x-zcRg(;)C=DubCOf-h6aVww|X6r+^|Ol#rn7_Dq%`tkt$R!rH; z^wR+cpmL_p`;B6(a)l{+zXQ-;OrL>oobrZgA^65A_BHuPhBC)1O_*Gu%<+mB)1%$+ z-ESq7>HTg8pfsiv;G3X~V7dan3Cc_+=VGIns4QpdQ0xFy#Pko`xh5&cn529Mpi4}{ zn;FGqz_BvZY^ zMloCYiK)e52cW;0woQg#T`KRHN+&x2Io8(OiEpaSQAX3zb;l}SdYRhZLYmLP#dQ0QH`t@E2&InQA(Y~%5bJ0Ig)9K zGL~sjjy2FSq6(WvTZ|${ImFa%iv!TNOlLNC61mECrYoC+fbKBiyQoVQcukP5!gz&V zsx)UBF&cecnVx1&iCn6rG6@*#FI6&#%!Z}TMzKs8%e2ec0cal69ys5ZE324}!}-2k zDQ4Qa-zZin$ChiN68w|UAdra!^AQh^s3sRy5fZ>7?RsVn$a zDQ%gO!M92YV!~_IY9)aQuUV^=Axs~@w?_G#$=1;UXd%;o2jPDLC~KMQN*#bonELcK zihSiH)6m`yKv$V^8W_boHrOmkBm zfO>Kyo+}%aPnqys*`Une$ZDI7VxzL0$!W6#&~76A-ndEG%lYswx=A_Cgm=+RO1Yj7 z&XpRb&B}8p zv0qusguT08DP+QH-G0T!na&63U3kMr@gl;J&f2*BiVxHE?yn>ED}F>3HlM7+Qev1o zt!r)CuZ-3s4HI3_H;(9cn*lDJz?a3e)(2@GN9t|KXVTkJy}`$}bcNdM66y6FP+Xa? zz5_}mQMsYa?{&lhr3celzgIyAlyoL6^PsYb30rnh$zj6U4=S68ez(Dv9aMG_;c@mV z=%DhgPB1d=Vk%WGFb&EH0Q#A!{YZClNV&~)$S2%%NV(7SD613D(~neOgvgkNw0(w| z1+Brimq;J)9#XC_;nnnz@`9+`fcy54;z_S4mm6^39#Xn6;kK74;Y_&gWl9{8*-)#g zcidqmm3?@;99G6L;W+ZJa*7F$v%|_+COpm#D?c(}4<1pjGi{$@6i1XBOxS}*lv_;S z`NW!zDEElWhCsNY98vydN`x!Q5yiH#zU}$oJE}BbDgxh8#e-=e_>L(7OcTI&OzFY& zPoYs9S2CFD?r;E_#N@fdC{8GIn0kZngp$vc2fi*S>nxEGA>S%R78+$bqZ}i`-v&-FomI{- ztt*;f`d;~u>CDCnrt^xy1?z(qmnjoW7ZrD+)50odg6XG^a|AoQPhYkW-lr=G@6%T- zKD(3S+-YF{y@068i{Y)d6!TPg{E0d&I>iF2n)!j-R^79ZY^DhcmLzgc{EKdL0WAKkL} z@P1TDct5&r@!|cblJI_1Nq9f1B)lK}{xP5CG<}|_k_NO`YPw_b4QR32^hXuiYWlMZ zm6+~XC=%N9)=PmOm_XA$KJzv1)a>#Hl7_6=Va@2D1WGMM1{#_$KO8_LYzPF5alVC&IRzH#Jk8T45SysC)O;e`E0^Lu)Vm$fhduE&-cyZt*Xf(4)(Ku}hKEiC8Fdo8)t`v4 z%+)4e^`3>cn*7vv7Ai4yRcm#`d}agwrm4H?#5AyDmQ{Dv$TXs(z38sCCel~^0@QZ8 z54QG5aDeJSm@Vuoe`h7U=}7mPE9A ziGAO}?`5LZUzvVt=#~(z-evOi&9aJ7A2Egc+KU+VAEr7me~4AzGc|+xL#%4$srToS zHt_o#wFc9gHt?S;)%rS7?IzX8z6tQ2qe*SWGzXq7nbeL|BIDIyOXSSRcs1G*`B`kd zn#_bfk)WnAVNWEegLI<$64eP+A`{hVRU#ABxm6;Q)YU{d)^M(#q!wDpSUp)SBhtSv z&_n%-=&qn|2B>G5@aqD7)JshGb%8YX1`~dVpr7j2Nk3Y1lAX1F>O>;=)kd;cqfgYi zMCJ60#&k7@3GZX+DjcftS8j**)c)#0_Th-Lzj~YrN1XlDaw2`TaDaNA3Ga9V)N4d$ zL)546wS4ss5w3D{NEoO-VQTlO7tkvvT#?UE>w96V%WZJ1k)gI{!tq3g>cNEL&kQw! zNS`TYsPPuE2j5VgL=J4jAayyB8D=&|;s){doz`$Ic95D+K7EDfqpuuRW=mtM((%~A zANvJ-{s}{?P*}pSDiohELfxX*XJ|XVPr_$v5fhH*KT{v-1p7T5eDyoikqk5>VU!w5 zq(5OCt(tV7VS09E!dSJZCGvBiaYQ)V^-mb5MtEZ>xuRkBDG8se$Cwt5n4d67Reh*G zAu=rC3pIc!TR1h&OPHcgC&~rdoG@LzXo-wZn4#A7#eCT!tLgrPSt|Z#FZ}&xR@0LS zbJR{<^!nmDUrd;%&Sh$mc_(3kYViB$dz7$9&9>0L2}{)F7WywCS1q)VA#s^%?f)@f z?Zg$TqlFqKu2lCD;Z?tB=xX&O`<5@O8L(Du+f8rT)aHGH)~d6Zc6D!&n6Dlu$`#k@ zcqFb@ZxERUesg7m`b7ZdGm8ezgAzBWYnbr2UK`cJOoK+iDu;TJ34hPES$)D322ZlL zs8)e`DfkPLt!i^7x8aSVx2gV2_zRNlYAVzE;aKG>cmBE2a^NDT%w)i%kBB&eiv*516FHPZIa4a**B@m&B%_`_x)YcM_bdA5dE}4N4fA zcu);y%1W4$ct}lTii60*>Tsr!t(PPoQ71FywO*NcOkKt_y|r`o6KWCDw-EWIdX(ut zM1G}SX1WTIr_{$x!xnBzJgrK>dOH(ZM}(BC4or;}7AJnIwqknIsz=CoYFDPHg+~(4 zstHUTTbn|@R|hd2ODs?PL7mF4Lne1GvN&Lfx43kXP*z$Ger7|^#k=HQ;&TZ=@w4g zZrEHhIq89#&s0=09q1jC&!9O;4^{sNJu(*FdwQsbGVRHPZ#SsDm@+dLCHXDwXS z3a(#2Qd=_N`t>8VD-*6?KUQOyaQ*tRI)Dk+um4s@GvWI6-|8GDT)%#z<}u;=^%J#- z3D>Wmsz;e{{rai;BNMJ)KT~fr;rjJ6^oW@qf;W^%WwSuU^23HUMQ(rOR z>cM|%tysOC_}uA(+KdUGJAF|7nYz_B3ZX?ah1Yff>d!PO+9)I~lgS+I0Ayx5)!8Uy zZ3WYhogIL7G4*yb3Pn4@^r@2r&_$-M;8V3*Owr&|wSSn-#~FpDsd0L%Z^bzPIWwJu z{b!}MWx5Ib&q@nrO6X%0)>==dj6M!PnM_(kqcCXGm>e5A0IguU7H| zrkO*GqMG(CQ{E5Z0G15g8||E9yYM>SWb z>fp1}+B2EHFp3(QH&f~t4nToS>-rht+lEn0JNh{QB{LlapS{+P=`{H4wNIH&1j1K3 zw6RRz1;ST4w5dcDHn^fxTU)?{D@wJsuC4%NVq=~ zC)LsF$K$r+3S@`idYZFN^e$CBttk_(DAm*2FyV?)ea({zSCr~&{!F-{)|A4t&>jl#HfMx1^aMazkxQLeK;#< zpxq$Sd$55f66tt>9^4n#K=ZXw6H_BCk*Hic0PE#0S_+Z=G|5Hl%RcOD7j3+r&oI^H zWRi3xRxTUX7M3GcVAng@~DfKT;YwFoABs^_Zp;7D9gZmx}F z!u90l+80c?p4>v4%Y^I6Ewnr$v*85X5n5`ynSO#hLQCx^N8%c;oAwhEuHm|Ax0rAZ z*G+q@=Y#!Vh-{_3)5)+2dcL)$CetxUPsCblwU}^gTWgL?c(k_Bnls_i+D2>3glnp8 zHD4w?1KMf~iAev}RY%R8efY(!j+!SEele?~)`e*n zTopaFu1wf!Pc4}U=Ums5JheQc3Tlg&wqEy9TfDUGoDYxI&e{l;S_T0L=_7#)Q#QMnr+ILI|6B_~j#MF2N z{Ks?c7pC?r9Dx2{iihVf^x_KxW-j6Z`ltta)MVfRXSb5pZp zy13E-sGd%+rzH`pHL=ixq)^R^BVC%fCWmQVnOZez4HU+-zOzSixE9B>v$Ho)PbSZC z-I61;PnZJ7g#!&`@(oQ$j?^-lqC$HDO=7}*6s2V|;XaDe<}=|wiq@7g;XaDi)-vHf ziqSSR;XaDdikNU8#cBtba395L$91A@kJIiD!IvMs`z6O|?>Q2;Ax_hJ={<M`NIHEB(l9!|_ij@Mc;DU*f)xifWxeVd^9FqvTACTM|7UNc4~Cu)&Q(K99h zCF(@&Ow#(WZ`lB&NYaKf;XX>zGMR86C25nGIyRY_oUCOt1vi-mG@oduVcp6F$tl`y z_Tk=4(GD`<-b~RhFbx}+Wz|Ew#x!N1z38DmW5T`JQ+v&Xd$Xq|_tyKYM^0{XFRdEW zpq!OJb(s3jS)bfnYrr&m&K4k7rjc+(>7%t}+E3Jpsi;w5NFU9g>0l$bggzR4P6)21 z`n$cUT0HyGp|4Z5RHmDs?@CV91`?GU@Tp#^Hkf@i_m_b0GoqP>-qTBga+%cW$AAuS zBp#osnqwb*`|yZN)dHCCy9ZDM)7$x2`*Nl=@D-<2?FG}H^U&v-s+Y15zRi@X&0<=# z0DX^`GT_@xsakXzM(S@3q-w*N@ZJykh~OKFOEBL7CV9!%(CWH<^%|1N7sAv8zITzT zZDGRi52k7#nDG09shXjmULVec(==BmoC&9Ckwp49D@~haq4ptZTGLM`AANDKuQq_l zEDD-O*!0yhE%beIKW!1y-sV3gr)&8Z`Zalg_B~Oyz^^I|(%!HSzm+sZb5Ex&qA#Kh z(FQZ&cSnY3`AiMF|Cu~QE3wey~5sKR8{W>_M-rOee9T4=Rto|b2c?3S`X+hC#9riI$K zmdNmw#oCV++G<*&{c4E}Ps!E(w9r=5Qq6YY$L)(xS+3QyP>E@U=E5|fMSRLit+j

xOFu~47zwb~q_nTD0{eeZlNMsSa;r^vR%7DWQK3z z!MBpM`a|^X>$u`@N}=Xzp_3^)v|OS*_{!gzlwH~e3tdPl(tL*MW&SVqdP=btNraIP zQvM(I-UO_wYJK2d`<%1a+8Yp#iW8!Vl0%ZB;*^*}m=jKk%peM;7L_HL7NsbW8kGZ@ zCFKy78jg`+QK^wynOR!by4r$yvnNfc4u+HHWw|l$y|G&@o|DNZohu8PF*1O&{ z?zPumdpJAI1TS5j@Pc`dw*0dDuM=K03yBKoo15ikv6q(Iu-n}4B}2So9`(|y8(uLl zd+DO8FsX4ypZg|z~M8sdceBJD(3D@PXo7WNXw;uPH{dF8Z`LM@?&!f>Sh1WTI z%+W+VPwX{sCc;&vTkJLOCgOW9`^@_}4)!WlKHQ|*_rD@;7CBrM5O0$tBypnp;jMjv+>6_+6O?YMVrkSe= zuWa5l*J#2kn>WpkL0x5Oxl2=5iX-_dkC>?j>DKh`uGc9ag7-)QO_8YT{! zwVHat&dEWu;jPpU*4Yv8>&E6)ntmG51Sm>V%cL;zwt0i5YhV}dZ8J#|UjMyg-l_?& z|K2h4HQ{yKA#YbxM zH~SOu7(D5@9)o*)`^TR&;e&lxTl(7YNpqMcyk0qJj?wh@kT7w|yom_M^`*h5%;`)p zlB42Jn|ErOvgA6Tdo=}a&Xs4(`I=g7c8fFS!Ib`w=gnq!a5)!2+y%3XrnL}v!Hm`P62x6JGc_HC zxQk|fyy-De#kGT^G+@&?uYzhHYDPeM8awmpIF)l>j+SIoyX6+zq;bFC(PpG(Lin(%!tA>DUz?zlT5WG2ym3wK9^ zEGAkijMX>C3we@=XK#m8Gcny68)t8aY^DikZ>Q{}31@Go?5+uS`CT$b6Ylc6WSS=2 ztvBTznsB$?lnaS?k4(xZHQ^j7Ef9jpUn}@Gev%`BzPNx2&=J zN)z5KYb?bqY%{F;%Qpmjed686re4Ckk4Q->gW6nfWlL+*)MfF_ zL# zj2#{lE*ELq9J?<(TrSg;HVS@8NWP-!)=?%E6_};k%Un&}V3ukxKi7mKq`eHzWy^yP9RQ!Xnr>f%amO|FU-Lf1 z4ZNQ%arCs8#hRKt@>hs69>6%hSKeN>*My_By^PU>E6(OdYS*i)| znzWa16T#kZGfelfCVacHz5G@a9%CKkubS`}>mY;Yayjws%8s&~rr8kJQTEk@Z&!Ab z!!+UBm7Qd|CVac{8hM*0e7o`*xj+-XUD;VK(}ZtVc9t78;oFrF@+D39c4dToSCbQb zUMs6K;oFth%8Q!t?aD6FF^@})Z&!AaEi~cVm0e{gP55?YS2<7$Ni4yqn4^Pd=7A+e3FRot`3yXX~OgLK)Ia=pK3WB zKS;i+>DuXk2ii}BGvCGd!SY8h{Tx3;2Egt&JUuMt_cX+C8B2s`?bV})%P~X+*2nNH z>TsE$>F@9?>TsDs#4D>2vPcsi(<9`^n((@Kg#26+UKfv$UlHLsP9=<#;z8;aAb7r2 zb|AvI5dYD#mzTo)$H*Ir@VcsD!Z;bH>8a9&3FGBtO$XOCOqd{NXp*rF6B6VcBJ?R@ zlH@8cwMa;oyS3$|=3)M+a-XJy>%#og0`kjFI1*f9Ue@`NUQ-ZV=_7GNFV zZI-wY|17y&(;}cLat~1fJfZk?+|BZYmuljsO8F3_gOa($bQ#Vh-nlL;;TE}&XsM_v z@0f6_Jnp63w%JlH#B@u=!~VH#ZIRo6XoHqlC`!}x@IWC_ty*vCvyxK|$6^lrhe3HQtVLau}Vb+;zWmB)xyiZwm& zNywA#M>wwX>UjzIGGEhuPbLq3Nbb?JtM_9G3#E9JEzf4JPFO4_YP!D1ri4f2Dx#I* zc$XIv9+P`?T-o!lBrKJ#$2i^LzHcNfm#Z}Ogx^hiT%Pj8WxbcMO156gmiawCPIywr z67jjeSjK6>bAPeSXR`6#vZrLBCVaQ-DOsTjSEEnMN=?9t%&y9_$0zw8L0`+scU7bCVVP) zt(>O`-?CdPKP4)#`nH6(W963|NADZ1lNU7MJ>hjSbUBuc-(+1cXENEiqFyg&X~OHc z^>U6TT!XEbxteC|K$`2ZydP=4CVaYKy?js;-WOdj7iz*gw(I4?ns5(dy?j&?zW2Fa zF4csy>3X?V6V9gV~HW!tt_I&enwEWviU4 z3HxZ9EYyU3v`sG8gyUtqT&oGMdbZ0gn(*%NcKNaSK>S7N!WCMvKN zHwha3imcJJa2HbZmDIY{;&nd_dqwuvG$Isff~MmWk?B)bG&x2f zy{l<+AkyD8EhMrZXD_4uF|LEAOMXZ#7nzlShb_ic#%OCZ3RwZuX?BPW(b{*R*i@4~eJbDWU>#{o*T$r{&n^ z(Xv2{2Rb8{5G@r=9=4Ot%Cb_7TPmL2)iCLtY_kO^PwZ_Un)IbiCBlAaoAi~eC0Z)( z8XA#QE$40Jbms70N#DpCBCPFzqzm%kHjKlTAD;A`?6jRM=@;s1U~pf;PLT8mfa#q9WWBjnv1Qf@d5EZ>*{{ zINptp{a`1>4Ha;hc{CbG(8>oYIt*% zuIaVFec>(CR84*T4}^!P8Jbr5o1&$fqbaJvq3}>OU(+4So$&3ehcyMibRem<+Mwyg zy@!*oQZEzbQ~lbgLply?6sC+9sYXyvL$p=FUNV6?ddbAI>MP1t{ts>(~I=%ykn*z%6$hm*RijhcFO|1_zGI-=>BZYPtX)FmSPy1yxU zs>oL{9UiIYl6tAxn&LZNOzNYy6XDsy5PelSlT~~dTwSYoy>V@a^i_ZJk|Fvj*K1ss zkFWhHsh@IdS~KCbm}u2b)9O*L#q?KwG~q9mU9Yk=bt*nGa)4TQA4^b7GmOT25>Zq)Ij25sZ{w$#Kt6T;-cgJ5xp{-=z8+ zVEUo)gyiumSJSwe@SA4p$%7cTRBRcQnmj>mC(0Ap)`{vhP1x2+>X0V2(h$ii@-X{s z4_=bhcA}LctJ9R^WOYeX?Y7Dsm>5BxkFoIxYipxLs}4 z^wZs4uD)Fz)U<%&rXOW5`=)J9zFjTRbb1x0d+{TV>i|bHq|+3ehF)BM;ke6W8K)_5 z+IH}AS`*IfGt>{7K5%bOzEd?h&gnjImnY9uT{XStJ`kRxVl`cuIy(7obzIY}aQ2?1 zZu^AO&7Sa+nxzVf3d9{yhgmB1uN+stxy#kFRHdfCS+6J0QqC%jTPpTVcq@61YNV-f z{3}WKsy3QRfbLU~nl6t&oSdt&hzi7F7+DXf&x!KH?K3}2en5%8aefP4GQ>Ppt7#9> zrcXI8e{w4|PgQBUuPIu#|BU1AX^u2d(|Dpvq5^R{969q;@CmlOau-t67f1!-E24;# z9Jd%+VxEfAbYj9M?dPd-O$&1xE zO=joI$%QII)AcVoQyx((HC4F-QXW;Mnoa^erasklX+qd_eL3O@ z6-9(|T}a9kY6%g1hXCf})vAQ!1pY=qvHDcg+oQr$o>Dblx+Z0fvd?ip>>Ym~e4V;V z(~c$w!q=-Vn%cBF5dMtnuj!G7ktroAktk2#-1Dp|)NwaA?341GD%La+=AKPTe90|Q z4J+$SYM`b9*xT8pay1PK{V-{hsw659ID>6cwK`6%JTQEdf}f3oy61^a%llrvS(Rxz zl8JPTs6aS_4}@=46aP*%qSk$0O=A*wcGxuHc{R@`u2e13aj!StG@?|kVxnK@*`gpb z_-}s${7T0b^&G{~UINf|BJPK+>J?5$`E6B4m<0X;!&cR(noHdVp4{A~!idgL|7}-Y ziTGT+U5zDz?<~OYIBZvi948tS4NTdgrhScG;5Ubgh5+5C$$585%1-qtQKhkWyj#4W zHWG2k%G53*&Y?^lXQE$&C{vBU;gaoWayaQl)sbkwz}$DKETT$*K3`IQC1Nk->LgoI z9m>_2-^6|EC1>Mub%_a|O-tFWhJK6rVGBANzpUbk(5JKUD{3N>z|}>Cn(2*O?fOsWqa#Hp4lC$wiHI@nLUOx1c zDkZ8kdaNrSdRm?4I2vbXRE?$vX?s)7D91%lshy3_s^(18F6UH)Pu!QP4^gE+pI@ox zi1IA__Tt~wF0ZAE`Mdg%306UahE}V9?S%}y>YS$89p6s5pxXSvai>}z z0owi}m*w*KzocALhc!)k;M0`vRFx*#^>j*&`byJr__f3D)g>bMQcPiW$`5M&CHC3i z)*n-TROLiVMT1*^O}V7Pf8w~)Qw?!hC2DFp4QZ98yNIeZb$%is^|H#p%;~Oa)++TE zb({!(_Yv-J{Ho6BxG!cH;#W2HXSR%92~U!!5=}4e2v5DDX4i7u`QDvVg%$b>Q|q;c zFsvL+4?fyG)v(rTI?(%$ScjGUD_X*HjywCOI;~Sgc_Ojxm{euWyTV>x=r}Re-&$zk zk8+`YA ztv*ilQXu?x&P#1!%^_MUVs<{18e*-`G_B>MsV%KCqC9ba$Gp@~E78Td9|vk>WtmLZ z?p%@D+FGTl%`8K-vD!$Ei&%v;P1AyoPp7uAiZz{Yy&*NsI&ZOM!urzGwpMSOX$;I+ z?W{3GOGTIMFQkTB2|8}`_LozywhA?ModtK6ts|ON!1}DcmF34?zK`9T+TJ=uv{ZZ+ z`(A1X>zt;SV^5@ZvikU=zvllY8J?rm#^uS7H!26!LM9S8<=*z zwMtVS&;ZK{LQC{AGHsw$qG>3M-5abLB3O;yFgY#8YVJl$q&w1vSTRKKos3Dd({8jD zY3kPYCpFYst!X;k#~W&G)`a^7!>qS7wQ<2$a;&48dfV__9P4jH1=f=(xpJg+TGRRz zw-{-Cqv@qSbJJq2pEd32^B|DjkVY(Yvv}Hg& zHC+Sg##sF|4TN-KtQ$2Ib$TLgtTkTKx=w3=CTThaU+fuYP1p22e6eSob(g05=Rccv zlQmbPt-8$+eJN;Ix%1e#YZ?mEr^AXVN##ZTfSc|;W zA^lEknU}hy&$L#1sbBitR*9E}q~Bw0@zS{TIo2*OrKjI#z3!!3((ktpYARd*bn0B| zFJ79JKF>PqrFrS|tslL#I6dD|!CcO=^+o9gRx>X>oxafO;H78N7hAo(v^BlZ8tSE8 z>5p0oUV1Hki8a+r`_q?M_ju`WdXe>zmp)2gX+7?x6X~n0=e+dy^e3&Cy!3r~v2{>W z^`I;1Pg|i)xYWxZxRSosnxU!1RU1;*TZNidw7Zi2jI~>n6}usIgY^XytzVwCzS4x> zj(*nqPSa#qK|E*utm!s5KRjo-n)2~*sCAUsXa#6G-g+=l6HV`~eIad=)k@PRYd55B zvf68k+4@4-W~+;)QCl~pZnk<8;rO&CK5vckQp1T`tSq(^bKu#nZI;yxbLYM7ZB{K2 zoF9@}Ox$LLHOIJ>Fs|E8++hvyQpCia);(V8GqKDn@lwphUDjW{G!n90R$Bh_)1+9kRTKAHUA(k@;z29R zOIs(tZ7ucED-#b{Z+Yp!#KV@+l3V@(_kdtcPlSo1);vv3p7wDXa(5O+e;fCu2oersST)&cI1J#YcywiDsHr{@jFtk;=D`hv?7KeP@I z;g~SQht_*uGJ%d0;j=0t<0I>orl(3p#&N4fE6kx1zG@~iKC!|z$ykw5Wu*|I&z?7Y zYTe=`E8{aOS6g0c?#}q!+NkNNQg_BlD}a757Ja%iPFuq?$yj&BS!)$hp7?UphSV>u z3q%EUNBS%4iYENN+gDaY_)%C`30S3meXst?YN6@T0HiQY*Nqq+@|87IQ=g8_GrqFM zXd0N(8Yn^2@aw{XCTe=E?=?VEHQkaE33P|1))SCs6Jgy4xW2Lm&`-BqX2X$O) z_$8<-*3+5}^iGcz_Dh;xgx^9l>?4|@SEk20>~Dzp*NNcAiF(%6&uI@MS}NX5S(stk zCEmDk8Pa~9i0fzBFA!mkmS$M?JK7R!WZNHT!W!B32~AjPKl>X^xCifV*J_HGyDG!q z?$V3P5;1puMgu#R2v)Ikw`K&{cM);!4efh5j#{^&y^sjY@>)hi`y($M%xG+%B|2ji zzx;JTc>1Lo~Ca`*0kVvza}XC{NrC{m{(bs0p9A zZ)WHAMaw*aJ6O%^Lqul`tWh)DbzNPJTG;+XT!)r+V-PU$?G+HhdLE}ElXl)k|trXYx|1zVEy-HJjtBV<7cDbgr zX+LMQwa{t8zNo$Lde`arsC?DsUqK)P$}NNtErh3J?fW!cEF3$jo4vqmnE`rC&zO$`eZ{p}hiNVg%izujyQ zr2{g>^>zf4g>SYEu>Zl$nbJY_%bM_g?ZNgTP58d{ zVEY0Q*I}^z6Hx)>H`tbgxvlXF9)s;bP56A)V7r;7_$8H-Zm_S?G-b)#Kpi#JPK2*Y z*u6A0%z&>-*dvKBzxO8%v2!>M=r5Co+WWO7<~Q6vtO@fQZvREo5O^YMg#DSO_yLy& zkFd{a!rwa^X`j~=1HXMZ(*B7Fa`Wv6M`_yA z=hEP@cDyG1rND7^x~AvbZv~pFsck{7yve>pQ$&GV++@$z)aI&llg8WgGd}B|J70?5i~`YwT>CV0R(fZ?%DR ziFP-RgLLNPM0=37jLXfPlxz>zG$nUFP@E>UFmQ5;ovZ2QN0CZA>EP{)6#FeA&LPD< zM1&M4ZDEyD`T>S=vsXVs|0p9H!a>bh;Nd z!f%DyLp8m=5q>Mo9!tbtrrF~;4!po`h1pYy*voW#woZpvDAVnEniAHAiRtzdP5x^; zO`dMQsA+lc9zd^ZdJ6Vpr`!8A&4J%~yTv}N>2dh2w_EJvMA*7LZ@ATNGn8s8e%aJ_ za<-kL>BpM}Prl6_GmPUtd~__(OroXY!$(tq@^u`}t+#u|yosx>8D7FwR~_N1>rQVR zu43=

Y{Gb}jp)c9~_H!!dXM;_f|m5D~6e++vR1+$Zi{yRA3Q5V>||FTpQs+0jJ2 zYQEogk3gSD<1*&jaU+r74ppz)C+FD*HLZxgXYzbIE*9ffih|jBlk@FTBKTH()Z)nx z+Mj7U*KXP5hrD&b_0mEw;d-f#a9vkNxFTERwZt{%!?rbwONMce*u%ZFKI1WaED^8P zmfDF-7Cu?L)SlvvyEJ&IeLE4p8}Y>CW%ixgG7;VpTV~JEG#%a%TV~JKglDzo_F^I& z6PE@r_m&L36xnMjj`s_S?1Mzhg_^Ji;>2hwwf*GAe$ExPMfACS-^M7h!oG$GeReTd z*u&V;h~Emo1Z8j5)M>o|w3{eT+zIQ*mG+N14p)^cZ83)Wh^~QF+5tq|5-aUsq6MO< zQ8Ia@-AYrfv1RfqyS=7Mj$MFex7u&|q}y)4?~`u3{js)O>*$`j-9ANh##le7f96g* zYAm)Om!-^(CgO6I*~5MlHZ<*qQmZ9j@si*PhHnc7&!x7!!x>C{5p}_cD*z(V7y>PcuKTV>GQ6 zUuGV&V>NwjT*~~&j?=W)<;*&6Pt)|H*(mE1dxoYBvTatCJzLW{)jjJ|d!DALuEAL+ z>_tRaYEyh+ZzTHM_;H9KPTD6l;n8@~ZZjTh3%|MUhjGzFpW6`|SC2kv$1oXwaHO8J zN9s5{!cW?9I&ND2sH~HAv8LVmqam(@h{xGUdpi-g;7PljXaRhIG7-}4^|3r{zw2Xp z+Wt^mj#HDePTMCn1zERdowcid(tT-P@=5olE#k073*gtEbF#j)ZB41p1zCT$8)^E{ zRhad)-BQyxazWO&cDSa&*5g?h>}xgUIiJn?&hDitSiP9_y*)tF1J;79AMIh9))Nnm? zrfBMyL&RgSnO~_U9D~jLsuQ_nI0l>fSxHEr+aEmFV{$V;HxrG)W`50d9FDf%^>1BH1o?P;*vG<%O_eO-f}dCbV3;7=8?aZ4q>#!kX=1dHhW44 zhZui9>gPNBUcaXlfBn2uybvyJgCPzIF$BCY3i{%vXoKM{5qcH+sUKe14L&}sV;3yP zRCldMOJ6;I2Zr1Q-aN6t*MA%P^LDgH>G(|@>xaKtj+W&sQ1(gty<`s@&S_c4@;F3= zHy4BI=nzez*6hbYx&Jv`QJdd58q@y1NB+1LTm~)`x6g%J&;!=RA;yt6_Kaozcgj;R z2L04YPoH9lL$^}*EVQ}zE(e6XyuoAd5dBNA$K!g`h4|{7y8bqnb8(2r@BPR2SffAh z%^{Lu{CIq#?$qtcCEuBdA-*Gemo`N+HpIebO>h$_!EubnDRX${#fVo zb6?lj$3Ik8Yt(&f?diuQz0ihb%P7>h^hCKL_4o3TK^TJ4A@)9tdY9HH!`q=8xf&&w z;kPofH-^;pwISZR%VXp435T)t2VD5p~#p|rjs+!tJOln&iHb$#jy;r6L-$sX$4 zbMDyY4xx&$Y<0R*w>gLKJm6c?e^=*mSU;7o|AJ0fk`$1hF*b(!mnFw?UHJH_ulssH zo&7jOD9sqxEy0kw9x=pJnvr~^Z!8}Rz9HPg=*J<3QQ0uoqjRb1O6#e`j;p~CS ziMmsCCO>@C^L*ZQ2$r)e?A^e5uqlqTpSL^U-0Jr{hPQ$d z;>}Q$e4gbHmOStI)~oG!^l&4cp%!&U{pilR8HW9^{daV>eSRaxI_V6~;hA*2uqDf! zKIkXgrzCaZp0aUGeM^G6Lp)5g5QnEhEgYiJLaYnh^GthD16!@7+%-Q4v|TQIGB5895&hN8Q)bSLamOkJs6^ zo$ApYf^{wrOYRY_9qT_oisi?VZ-^VI*L>^lTXNLlEIHQW-`oB)Bk{VIXAG`m8yY{X z^IU-?_pJADR5-*7a1P}*)X^1sh`R>gVlMFh0EMv5Ex_er|6B_$6-v)lInTO0 zfBKe+&t*gC3ZhPW=1-nQS#s^_&VAsS=2-6K587hcSf4~=iS<TB17tc9`V>#pi ztY-{y1@vKa>oA08HkQ+1zsVt9TY%yBQki)kOQDwG5zehq*8-j%;VXBZ zpV8iPZNiqmt72{|Zauy(`{%lE+6F#t&Yszuuf*#Mhq#tjM6AC;SAV{J#6885{oG9T zT|N@)UiM5~3p@|4q&lm(}S`5emKF5@>0No|Kkt>ZC*5dWXlSLwrW7mk(dU z5SG4m+|nI$lQiYl6~M$-)DTatgSx9yMR z=e}c0EUo8Sn?raF5Dn`_L)1xJ^J571i07(-Yr3lp!?`5vjdv~hy45#?ul0OG@G8Ki z*P+7c-&Ck9y@(uA#_5Up$_a8hfPdvN1U=`0pbXTHLA^XUJsJ)Vy|dlBr1cctpiCZ2sN&X*BGwol$%)FN1az?^l2b44E&-(N&kFRInI{Mo1c;k^@ ze{T)XVxC!r&#M2E@#&lP3pj!df$~2+j_#+GBuihFpU{qz1`^6Gko?Qxv*4zN?t#vH=q&^H&(9nbF`OTM1vm4RaNTjAx&@?(UUm z?6C*m@c)U9S0bLfEnJI7;K@h_?Qh@+M}1^4wuA5P0b6p2ug*snhhrT*skoilTgZ3} ze=rpDW!*Pl-2H?73OXWK_l^CdwCoM{Ogv@w=yiE{La;_29b8qZQt+E*4wEW9i!_Y=gTrp1ruUv=`@TJ@mjj?mDuKA+B43-Z0#$?~?c) z3;)0F+X6fr@Vb=Oz`n8db+%{AI{n{YxA=PI9`_CTBfY-m30Sv#uFiZ@{ZY8D&A+RE zNxQ87ZmR!=J>M(gdo*~Kbm;qrTYBOV!LxxU9PdZ?hVUIdObdJFQFzp_pSl$_A3=s- zOWzqA+uxyQb@b`c@%-+&pXiy3&@cWi z{-L`ga5Q9wOdl zbBeabc%@TJE4upk2QdWBiO{E>tLggQIQRN#eMc#l)3e&~4gYubbJt^exYtnktUY+P z;Sk?G{m-r=>X(Y!nf-GtkBa)1|Gf~bqeJwAt5MH&)1N5`kM_QBSNhMjKi8DoGppW} zzHi7sZ-F{Lo_rhht1H9dsaO}>{qWQULkz*;y!-KIYWLr3?f-`7y7|!abjt5TTw>pK zb*;o@_yw-JRf6O@>5S(enW69ulWmmx!q22;zbPSka4gx344sYFa%2l&qUE) zrLSH{*QEW!@yvxe8f3%g7pJ~k$2F?+S?9m*eCHec$RM}dA-<*S$9L&I8hhq^QFjV# z0hhL6|8=pR(z1s?Gv0h#xK8II2zRTnUjI1U6d688pKo4uwe~zYQ0IYnJUn}1yvywv zgDuRp;}E>caEQA%)U|(ooo68q=W{gco8au@NsDdk87*~ftCEwrll^@U@C4Mf2Eo;c%CY{NOC-S>18_$5X#>JFIyK^V*OG&+L+Ph}95c=w9HG^K(I*3-0rK%J#}k z)DJ_yIK^f-ay`!r@tMLmFJGN!xt3X&3h!{aU{tu>rfBgZdf-?Lcj~7K>xW=XxeQKm zb}gpDR&@yOM=Ym9V7&~nm&O=}aLX*E-6z(4YlL<294~yY?f25Nqr$c3p4ym+xs=dx zT3=#bo>XKP=Uv0Q6R;JH@4c7~&FL0{@XEhnr%-zl@b4DCl2#U>hZ_21`p^-#&=hrL-={B&|9%QnKWmzPnH~V{VI&* zr}$9!JR8qX?<_9I<02p)ZFc3NWY2t0obQtJeiyG0FxDYv&c!i#5#D%n2`&R3FMk|< zaTMl)=Mng-Gg8VARSO?{V`?)Z0cuF{VXPwSvW{KgR=lWvdD%B9&J}h}O z;&rh>Pg6jxVSY12BHY1uXdNwCcZvq1aR$4Z&XT_m=d{ogFlVwQ=jEVOztxY;kbKITU@e&b`Juubo)u9RGK9e&UpU;_A^;1|AO_&d=MR?uq4f z6vz6O*0&b_cS??RgeR71PVm+LDCD2_EUyPjX{V7};1{@SY0$eEo?QN@t$f?Zx845l zv{n7Ob2(Z5XZt^O9{$riXxvlv&nDc?zUy;eU9Y>MuyWWv0yte0l=QB0WNPHfz?}0-w){_?PJ$ik6UQv&N{SD7sKlN>V zLwJ9fLk`0E+S4+q|F&MUXwAUV*Mn~zeRW@(cQ&H89GZtY978;LaR`qhZW&&O__mmS zbBFF){?SM)q+Z6c;n|a~A7aos?vFfhYoLT@iQ(GB&~Mpr2=^V^{PVH;NB-~i*|pnC zyQci~AU{FP&o=Op_21SPrDGjAFWSEAL+bH!>#fE zmX2f9cR%otb-wob=k~o}w+gP5K{~|)a0I!;&NAE+_;|S6E%pAG@3`tptK}4$leyhI zE$ot! zuYijZ$0!IJEy|725O$M@G2+EW_*(*hWkw?WB?Bh|CzD=#6jb3vB#JT`aCGh0^xEj zggh65-9iXk2<2WV=D8L_o{NDO!;jT1hCCh?h45Dfe@o!6#CS~faV&wq6~HSXdF4w*`K8sv$_&eIh*!q@U;p(k=Ru90an77*6^) zl1U^dk(^HQPLg{`28j1xgfE?niLoeIZ;*C1=v~vU5nqaxnc?!OP`M$^>jUj7FuK{Vr4hDJ6Iuq>UW(*ZSiR18welW;XVHi)soBU50Sc@Gb zyE(Arc_1U4c>=!!W6*bFs=%_J(=hO>F{cbnyAEvNEgrIub6{+$1H-c*f_%HQ9Z2{!CejCh zysPsNkW)HOaMg(QgQmG!IB(lE%e9-@>Vjx_;}X{<@%FPTLB6>b<-|rPZzY*dauUfb zl20{UNok*St%L8`t^?V9^|P)pCzdMAd2Bh13(#M1^#$pM?-QYnfVbG+aSbAy2z;;I z6(R22ZbJCMb%#M8GaB^j!|8v8dxO2w#Anl_s{*EZ1=7+-<>T1oU_aNbK($q4m0$MULd%13+TEBB;%=MusSId^G9{mqB{51M77G%0Jo+GY*$$fE?XAQiK^N z=A*P1pgf;{3xqo}BSonL>sac*dW~~FJa?{H2L6|sV%6B^7^Wu!NYA6Y&8k&P4Eyhw1FA~-&kz|A=7rWQZ8t*Wo7`iTQKRNPAqe%6U$sn zlUkUvW#%z_@CtLmid9gaFCG8XW+lfZMNDAEpQPe{+it&qu*`6 zs3_+vojX}!&OJT9m0`|dcS9c;=erHC?xfuFAnh<~j?p0aCM(ZqH*zA#%j2h7G0w&# z!vy-DX~mLdtP{scER`^pO4|+6!kz=fnj((MmP&dmSyobO2atU#*{70@N0~J9oV{*5 zYb^r#wYA&$Iqo|v%=iL+)2yNM3&=gmiNBGU(ke)+&F6p_X*Fqb%^V`#wSOGwAtd3q)5&v|>y^%{{jvOw|>ri@|I6F`IK*=3y;TRFdht&Fdw?`I6daTJ}siO z#UKrV(gca&(G*)kA*CQ!`mQrayH=1_(Dd=-J?ydykjAx2UIQNCQ z%UpOKEOX&^bt=hc1^KKXZxyaRJKLBQx3n84at+vW6_HsZDBJSi)K=VJ(&Ll&e$V-y5ECJrMXUNWY-( zKw^)dqB^=vte4Bg_Blnp6F?yW6tWvi-lh@GuD_^Y3i;d^9rROBDA>Rb56EJ_P!mT{ zsEOktg3^YY=zlMqYrbq0ZsNF#BKs)v5J57ULZV5>+1T0mOOSTsK}Ot+iwfI3xN(Gu zeHw1!n2B}bc`ydb6Jo|VFRkzAtftWtLpjEfA8b#U_e`9JZP49fuMxNVgT{Novs>V~ z=|p2}Lj%rnSYMn;+#=4zHB73B^J=Pzp6@hrcD909+7bVY$^!q(%xbvL`Hrhv1gsMv zv$q+rRz*Lx@P06?e+1SyTVPFVDcohCWgLaaQFxrdTDT1KSDzd2}n<}!Y z64+l=0{g2shV$R?X?@~I4!WK&5tm1L7oWyqm2C%T!RR3QAQ;sY)qTDWxi&?S@ZXi`ccDB;aYm>Cu~DFj*US7bzN`^pu?A*830ETS`G z8H5KnEzu!(rptwp{!NQ1{!@RfJzliiW^6cVN6kY`(88CZbUdIf)qB%zE z>I>rS(ifW+Q7)wvn+-b5-lWHnpIj4D<&z#v;T51~Gz=xZ81&$#g=AAq=b&OL)giJE zC!1rWXOo^odKT%Gq~}xGShgX3jtCvFwb=z@M8}swx_jozREo`^*b=H^3Dql_RwGHy z@$1?*F9Dm3h85(wMxPC_#awjmC?yY-6zeiEJb=OjNZ;+;Q#`r(aO1-wTjBWvuAwMA zifp1tk0w2ubUaTP;&bEPDrb!Ix)J@HF=P`%_J_EY zsGOCg!!8D#VP?>9~%r1%csc3Jen%I&75`6}f3?&&(5|22z;szZhwpfJ3zK)Q1r5qu# zg*&~W`v-)HD2Z#NK@Kd# zAcr6P&h8+`z8OKG)2UR09B-sG39Y3y$sh;z#c;>szFV7ha`niF6y03kw+avK=IR~R z89t1P<(ve$j12`Dy|vjmNBHXG(CLmY*Kch$$#Iy%7u=c)mh*3$9~wn%5(RCt+CN%; zksH}60!FDRqUDk}SP#oZaXldfSB!o~R}U$sCfoB=bq)TGS9pjwPA7vQXk0uZY6&DiW>>*b-KN z@LU$@MWmOKUPiKlWTC|UF&Cs-?O#bDhp3LnNUtLO6zSEZ*N~p%%pcvnO)cpzh1Wy@ zAa7~2*Lb+q@-|7%$oOIQAOk&D)2xEh1Ram=P=#yJP=#YYRN?p!2f56|YX_L4NRJ{J zO|puvC9CMVGKNB8Nyd>(C7DGsn`92j8p;=?2|F9;ITyl1nxJlyzOq#<>;Z6 z7{6{(_#k6q!nE*B&`S4&?{@u|<`%nM-`((?wS#(mknw%;vhdxYKOVl@z~ABdcE}X)nX|JO!aCpdG$A|{D!cpCX^9$mc1Y7hb_tE1VOm70wAYq}OO2uYGDMq?STz6^G!Jj?2PS zE(=q+EV@dvI2^Bl0w^|sVgo2PfMNqIj>YSvV6q7&n_#jDCYxZg3AWe<*UZ5du9<@^ zTr;~Il&=Hxog?BqMv71i`z6$(>sbp&EcVNN9b#x^-s|{!_|6V{9i6-H0=cT&X&K|d zqcw(hDI*~5GBd)${fa0^3$rVY(kM8ig}I|GJc6PvY{?kfQHiqftQ2Kof5lS1u@)X# zv6Oopd5Z&YaJB2e-DBLBc0*d+2acg*WF76uMN!&l8c`@=Zr7#4y2MaOsRPf0eO<3K z-`A6`kz?VxJBQNdP^xUw zV`znzYvCBim5f{9Y;Y4Dr`L2IM5P_%z~4L>jw=Qn=qEOg*k?F$`qw!Y&kbX>S47s7GZ z{Q}wl%EJ0!>ohYfO%BLHNj zBM9U{MUG{qc z;JL)v2joTwu|+9_D3R~NdM$LJ|3Vk~U*balMJ~*Dl?(kByRcqsU0AOY7uIW|3+q+t z!g_6YVZF*+*MKZ1KNY0!abfFKy0G;Qy81)xAs5#Ahzm=5%!Rc+?ivWP%GDv#6sKG_ zfIR0K0fFtPkuCYFDiiRH;QvHYvZzL8&{kr|+0l2bs|%3DCX6#B6g z`Uy~XfOM-IkilvW$WZkF$Tn&L$Z)j~WJmQe*hi>GK#x@CKp&`5Z<+l{%3BTnaPx-9?dCu=~kkx)qfIRQF8f1;%81Qh(?e1Xi9e2K_XP9@Ss5@GU>ZvLXU!7UKJ7IbKn z2H3X88{kn{)c{-gL<4N$Qw^|%&o#gnu5N%We7*s;a7_bj;Y$s$g=-sN3yVN(VOJow zuoZ|c91w^t><+{uIyey9`Px9tC5~ibAm)`Ch)E)4#cs&HW0^lNg$5xje$6}O9OFi zZx6(=T^5LAyF3ubc10kL?LC1wwkrd1Y#$87v3)2I$M%sx9NWhNacmzC#Iao!h-3Ri zAdc-*fjG9$1>)GQ4#cs2J`l%tO(2f#OMy7HYXfI?ha(~gN4P5pN4OP)BRnAJZU}b= z-2*Z>2uFMKpxq!tgXTa;o1ptZh6mjbvLXoUxF-nfSQ&(MJQ##^JQRd=JQ9R;JQjp? zJRXE~tO~+9o(RG^o(jS`o(sY{RtI4n&j(>0Yl5(jmx8d4wLw@%;l?_;+*n7;jdcug zV;$XYtYfen>)6~q7s?ar#+tTqV@<=|c@WakjrEOiV|^ptSl=i&*0+xv>l^LH`VMqs zePi4UKn`<12r}0F5XiCaMIhtc4}(l}KLRq<{TRp$_fn8q?&Tn-xmSS9c0UeshWiPS zIquaUXS<&Qnd@Eya-Mq~$b9!R{||590UcGfw!P;}&4fT^CIu2oNC+XIND=}>5l90f zfdC0b5yK>zBqNiVFp~hWVnI>F0(#XeDu^9>?_$?$K?Sj2@nXFe^kTgh{^x!7K4;DZ z@caI?{`F_AdG@p4UC*xXF6RWeCiMp31*ta`W5h_Mws%)5wYvLKsntD{O0Dj(RBCnG zQmNHFn@X+j#Z+o_ucT6|dp(s}-Of~Mb?>B73;!UMTKMi%YT=)xQVahgm0I}Msno*1 zOQn(Ihg2F#eo3W~tx#_(}DUW|HP1&7{AFG?Rgz?}0fU z(oBYVNHZDXA)V(i56yIAJh$Lk#(GFsncyK^Wuk|4l_?(5RjNFs5l#2p0Y9}K(pzSG z?gek~kdCy_Lpsdy9@1f!cu0q7@jL|AcF*I$kmqS&r{@J=m**AWO3xd>Q#`wXt32-m z&-UyFuJL>dyukBs;KiQ3z)L-}#<{}t1NcVIufR>7KY`bKtR)z+JucvF9?}x;@}z*@ z=kWp`@?-)Z^9%%T^9%((>lqGw(K8D8if0V)bx$d9r{_rEJD$nF4?I=C-JTlYC!Sfr zFFf_YuRSC1MBjN9g8$%I4E)8@1pM981{B^9(B@qRba|Hp`*=?Vrg~Qa)4Z#J{k`V{ z2YN38=6Ej!4)b0K9O1nNc$jw!aE$k6;8^eNzzN=afD^qB0;hN%16FxS*PZTt3cS|) zJaD%6WnhE%b>KqpTfpPJ?*W&1KLWORKLNITzXXQ7-vT?m`+!~EUw|vUe*jPMYGYCU zUMKKuZy(?quLpR6Hv@RFHye1VHwSoyHy^msI}*6bdj#-$?^xi?-ZJ2AUO&p`F7G7p z`@EIFhrH8)k9lVTw|VCRpY<*PzUVz3_=?vLeBIj$-058ke8<}f{J`4{-0eLH_=)#) z;1}MrfnR&i1Agbd5cq?41MnB`6~N!UR|AFbI-t#W6VT?-eD4Cs`u+)=;M)V7==%aV#rF-c%J(1Obl=aw zTHo)$**;4t%HQVzF7zb>kN2elm-y0wExs&ZyKe|EwCd=r4H zd`AP%_EiAa_@)6b@YMn@_RRra>YER|!nX*x(YFM+$rk`#?>iBAvo8X?&DRCI%hvUcR$9!vm+kESQ&-&H_U-VrLe8smB__}X1aHsD^;5)vpzz=+P0eAcE2Y%vv z1o(yTN#NJMXMx}OUIPB$dky%DZwK&q-#b8&_94)g_Aj6-?Q>wCw6B4wY2O3W(tZL? zNuv?6Dvd_STIREvH>A;MxiF1J%OxytVR<{tLoDx1qfxXgjYiRxX*7zSl18KGsx%r! z&rYLJbWIwKq8FsmD0*=kjiOg@Y#TYYZOor#{vyZx3dcD%opLoHopLoXopLfIopMr@ zPAN`Lrxa_`DaG08lww0VrFcAtTEd}PI8-}_3UR1T4z-f~oWg!qv7fWq&l>h~0sFa_ zW4@GQzJg=km`=~KDV?6>`gD4ho73r8ZcC>b;jVO=5$;Q;8R4OHnh_pLrx{^eI?V{r zrqhh@3a9%zr@NEWeTUQifYaU0>3+iLe!=N}&FOx}>Hfg!{=(`0&gqH_O4pV_>AEr~ z-98zVZfXXlo0dW8_RpYn2WHSrl#@X-(Xb4fiAH45OmtWV%|v4|XeJt)K{L^W44R21 zW_&+J6Q2&KBuN(W@~mp`C0SGpEm@RGd)79r>^5f68g^5bmGlt!fgX}Y`pG+4q@R3{ zMf%C^EYeRt$s+yai!9PlzRn{3%l)&dmIr22{5jcF%fqs%mPce$EgzOm zwR|!Ayp(-j!9F*#&(~SLljZNQ`~#Nn<`_QV7{1^bzRsq0@?AEylOM9FHh;;c+WbA6 zYEulP+O!R%QgscaQtdO4O7-l4l*2Uxxg8Fg1wLgE?fz8_`VC(kJ8w`WmCp#mYT#&r z#SeD-$n=S?+R4loKd_l6d_l605(C*R5r?yRlxSeHQXI$T3}x0Ue~Uyr%bUe|W&V63 z#nUW~3rX|w4lbDJ`ED-$ng$aIuBMVWhGQaS?f*>gUWIYpUEl(|ZoXTbEq z|0ZRB1}25yt?YOOK*poYJeXWA%DzOItCV?`a^Ixv+myLmnZm2$Q|1(9u2SYEWo}dE zZe^nJaX#{3Qu>w3+@$1Nlzp4B?^Y&W2ax$!W+hAtzeP9kr3Pvzc^OjPtjs;iwBoHR zYJb*T8P7JDR9;rRUB%@9lkCq7mu6mpG%J|otcZ)LjD6@H_loyUif3j?dpS*&u(Q->6Z2-%3P()P0HM+%TJR2HYrn_EbTeUoTAJn z%3P&Pi&%vbYqrILa}Ocr!2Hu8#9Yf9Ta&HRc82W{+Y2^}y|4Ww`-Ao`?CFkn$8yIi z$F+{z91l32cYNvi*&&>z&Q|9s&P$w^JMVKo__LO^5K2FK%o8R~Fz6<)E z-FI!@zxBPP@29QrQgzi%lfV8x4PfDejEFJ*6%<4 zoT+0|C#IIC)~3!&Jt_6P)JsxtPJKM}v()cW_orrfhI$G-XL%m;eCTm{J>Ej^(cWXc z8@yS*VZI}LNBR7|4&Md7t9&>39`-%yd)xQ9?^j=P+BIpL(jQNMCw*^vPDXyljEqGY ztr^jb(=t|P{4HZ+#&sEQXY9%NHN%#foq2fXgv?2qb(tq*uFO0u^Zd-KGOx?LFY}qq zotgj2+?Of(JNu{h&*^_y{|Wso`ybPPPX818pVt3x{cq{Nt^bbxAN2pc{}27`1F{B8 z7*I7}{(#m29Rs=toIK#n0qX`_IpB@~FAjKhz%K(FSp`}3S;uFEv%0cQ&$=e-)~x?z z!3kO~{@TP%34NM($)S&7?vj(*d zS~=+SLAMQhbkN&_z8%ze@T9>VgHIiN&fx8Xe;GV<$fO~Ia;D_e=frYW=Uka{ZO(l; zPvz{)*_V?yv~lPuL!TY`&Crb8y4=>>rMb&;*W_->&V4y|SMGy_B~-Z%^LWd6r?B!-fwl9#%fA zZdm8A(}rC??2TdH5BqhP$amy>@(c2d^Q-e4@{iB&&Oa^x%>1?a*W_=_zc2r({1@{7 zmH%1(-uxf)f6v#3yM|{DA2d9F_))_vhR+;cKm54i&BKGkR}cSlxUC>sa7Mv71s4|F zRPac_j)E@>eku5~px=nh5l4=gHe$($;E33WbtBe~xP8QWFto{50bC5n5qZ zVQJx%!l{LIg-Z(C3cCwe7hY6&RpIr8_Y^)<_)_7n!Vd~RE&R4{f1!P3+Q>m8t41C( za`wo^k-?EYBhMPSe&oiHH;%k*2tbqES;vojvN3QGXxx`- z0uAUB(IP$*0r7=s75^6PVlUps{Es+M{2)SjzpX?3Cc?OZ9TQf|a$&Qq6i!Qza9K{m z&FYgys^t{n!Fzl@yb+mZIa3U_oF#Jb7UWR8_1K6v9mAG&;uOn;;#|D(c%J2AyqUOO zTyEJQwpcC|Tk+N-z3uom-f(;mZ#e$jvRQm<*&@EPTrV{3M&ZzI68*KCMV5A}7_8kU z^0eDUzIKN=OuJKz(H;`Tc+>Gj?FkXqo)l}eZQ^3>MRC3MlDJWOMck~tDsI(Y7hAP= zaN_&ExLx}|+^KztbKif8yS3fo9&N9PcYc(Jui#M{ftp+zuH=xt-3>yJW&!;4(#-lh73MzivuZLdUgV0mrQV5h(r7;X0B&rK^lVhLZ8f zu%{MMY%*7}ggqO6gXGN|suAZP_yB$) z`E>Hx<#Ty9c;H8tK*q#Oa9IwIpG;-`a3+P_$ao6lwNpv5>psG|dkHUQ9L5sM9VB`8 zcES?o_Kn0(&tu$7c*6ifna`hYBR-wm#!FmZH!^<7xZ^r zABPkWP3LEJDJ<9Tn;j=S0~IsJoCBS?qWQdvHvaf6pI<3 zU^LgM9Gzt9=4UVaJB5`ijKl73`Q z`QO*$TyDd1e7m`r#vj?oHy*VJdH8lR;pKNxIlnQJa3A-<3kUfjuPGz{1>B0R8Abft z$!$g`>0hEb|FULfK4%4~OlAi=5XwBx$kLFtaAbE3uCfN7Kck1z^p3C9$rq-*0_jXbq9_ZWxzIQG0|E#?QT-KMYqbvVL z@{NDH7xMqxzWL`u3cH5;rgb*)5nBnTGG>k-emajr=02OlB`kIS%f<~8SE&bhK3%ARPRmu0Kl!L#$XlWD||+}wtx-XisxHC%?~P>1rl%;fXK z5!>-}J9yldt$OhpZ$YxU=Y8OZJs$&S9sfCS*~)K##g|dN#JC3c^SrQ=^`8fZ?1Ssj z@xKD+cI^j7t6gnE94b!fN5-7j(-%JLIp(@E)4(rpqEuv@3x;Gt^7-XCKpFp)&D6(b z{GJWNAzyp$VZaMYNbVg=_%M$QvM;xA%-=6Bh95ab-E!Xq@O7(>298}-2{h+ZYF7Kt zr#$puTLafG&m;czd2_)p;l6q4+T+2^?cw{2$j=`awL-p-`J#(D!KKD%?zva72K!<+ z`ImJhb7gLCvNaYK&{$_~W9AgiE$s^KHK%ZIJ(7FeAIDJqqq)D!wkq4FOz|lmOW&JB z?MkLAThU&g@jV+(;+#`SPA^#no?c9`rLdm!?tJ1$6%szqnnvwe#8TSKkFcQPxkouYCku*Rh`kH$R2B%*~_d|4+SFu8ICP+V9!i{$;sc!*i3=n&hk@ zYkYQ){sY5a))UN6C)>X)TdDucc;uKoJGc{}{(5GSTEWrTRF7tjQMMe}o@H&yHKx?= zx=u-gg;AiQ=n_3>E)2|s8g^mG&c zUPCzG7{X`z5^j;0One&Su_?sM7-ts~zq^R=yw!xKG7f7X{^Bsg&o6%uWp(WNp8?l< zz6L%t@jIZ@kmbr$@=ZK$NUcwU323i8l6H@_Cu1%qy6v`?Ck<) zY@`!DRhSI^>pHm&lw@{Id2JZK9_>Vbd;1mQ2_Ue3y45WWVm< zF0;q{6kw;Bz zL++X)z7B1K&c!Tfjg~yoLQ>O}vBe<3%K2S81Hh&^G8_$Lrw)D-pL zyMdbc7`w#y-;qE~?7==U-Wmqt)`B<|{4<~?KF6N11v|rwz`w-au?0KCi^0Fb{xN-> zqY?ZY>@wra^FU2}hy7#?U)c%(_lY*he*kLYN9-x%{{RBpxoKztz|Us*%_TF(Lw zv95+Z2dLp&Wak2Nt>;0K2gHAsvaSWs2Wn!tbsez4dJ%Ah^%BSnftna;-2fbIy$pDS z^>Sd5^-5r|^(x?4>(#(g>$Sjf*3H22)-AvZ)*FCj)|-GwT5ka!W!;K6CjvEbwDor2 zB^y_%dPhVE36L!E3FR$tE`U#tF4a%r&^x`&aplPTxfj;u^kK4#BtW= zz!w2Eyhro`_+p?YPO!cN-U!t2X3@()zx7pMlXW|=+4=^s#kvE20zmwCb?aN;Z9olg zAH5A81Zv_$>$||P^?gVpKn-steF*HbegsK3P!r3oAA_#|;(xYU_ki~R@!ub;pMswZ z)bRe&=isLTHF28tOYqZynpkE13j7S9CeE~e1AZ1z6K7lZg0BW@;vDPu;O7E0vBtU& z{5+s0&bR&uz7~kDyjp(-UkB90h1OreF9PEGy4K&oF9B*|z4Z_94M0s?YTXZh8Bh~{ z!*}@beQcm6uCT%oR{}NhcdH%zDxfAdTAkom12u7tH3|G$pe8n1lfgFwHF2Fa1$+w- zvO!7%OnzU=dFPHSvsf6!^11 zeCgVHIQa8G{0~0s5#TQZHSv1_c3Gii{QJ{z7l)@rj1>%2;Sj)h-12yrw^(gQ+ zfSP#IdNlYBpeA-&CxgEQ)Wj}pIr!T^j7!!^@OOclcn_x@7V$n%6CYTofqw|p#6PVy z;2!}svD-QW{9~Xd{$-sBz6Yp@PjFgd5uXC_pWm%?>is!T6JJ>C!M_A*;@{SJ;9mhX z@wIgU@Ehx~kbDco=ww|4{vRMl9_wP@57tKDf31GVe*-IBmEil`*4mi+u5#k&K#JFd>1USUD z0hnXE3^>$wIWW(5CHxEnY9ilu6>zxiYG8rwTHpxVW?-Rh3vi_E2H+^$O~Au!w;8xh@$#hYc3_e1PGGU^ZeWS+Ubv10Vm!3n4;*KE5IElUFmQtHQDB+varikB zi1E<&B=|%i#zTCQ!y+aDF&^5U0iOcIcxZbLyaI^v(Dnj&6%b>f?IrNJKuy%!UIuRf zYGR)4Rp5NvcHjcr8^DFO9l&F4Zvl_9y$xJsdlz`T?S0^4+lRmtY##v|Z65=d*!BSZ zwoidgw$BlBGZ5pX?Mv_g5aXonD`1=L8%WxLnh4tVf}aS~#8P}&5MOlzYNEro4;Z%n z2uTEpk<<1w_%a~=qlfKR@E8zdsqHuLZXm`|+aKU7fEY_{`++?+i-xfjst?9eAjVRg z9eA$I34GL+1bobv4A;kjns~yN0({EW50a;W8s6LVfIkP+#Pc>E_zOS{Z*r!CzXU{o zw`GFA4AjJ{wgKR;0X4DRmJR+oP!n(127$i`gw|mj0=^T7K5iQd{x%R_8n@+vzXyZ{ zV#^2r0Em8VD**oph`wnn1pf+%zG)i;{Kj@TB;Nw@AJ%L~fPV)>KeZJB|6?nGWFHXy z)K&`o(Ka6VldTN+v+XFL)qXV4W}ggn*~@{m?Ue{M2dIg;_G<8YAii2}p9Ve;h}L4S z0bc+_Yq8G&KNg5~VxI{--d+b>Y@Y)>!Cnt+w9f-Bu`dAn?Z?7@6A<&MeGzyIP!j?B zVqmMi5t23_=2N>L7_>J7PqYVsOYLpIkUa?OurCFM?H%wR0ivDQBjC$`Xeah%;4vWD zi9H714MaP!cZ070qMg`RfcF5=PV7D4Cj-$=>?ebt3dEdiKNb9RAm&{A>ELGoG3VOP z06zEP9bAgz1?dO7@2gICfKM#B@5Oc15E%-Vh=3M(a@QZ+$bL|&_ zUjoFOYrh110}ykreFOMqK+L)J%fK%OV$QW+4t^yNbFTeL@T-8BbM04wUk${ZYrh)& zS|H|J`?cVkftYjco58mLG3VO1fZqVboNK=U{3amgT>DMnw*WEc+HV2h3dEdi-wJ*^ z5Oc2mcJMoam~-uSg5M3qoNK=u{9YjDT>HJ?_XDBB+wTW|5C|RK{vi0nK+MSYhru5O zqF34<1wL+n9Qc&|NywiDVivYP1^z4$v#|Xc@aKV;h3(G)U$nmfe98V2@E`VihQ5&V1zL{GGT z4E)Hx2a?@DtOD$xg8vJMRe=3-@K1nP1=zm?erEp)___TX$iDz$6=2^B{%;^w0ru~~ zzXqZg+xLNg3q&ur{|Nlf{xc-s12NCqe+B+v{|%BKf#|>XKfr$mLg%;d2mcj_S=er| zVipEs7Pdnb6Mq0P3)}7B`+=B+9ZsOdkp$En$v~?k1?X_}13DcZpv&Qd|0E!0UPn4G z*^vqC;}`%;ab&}_FHjTx9D{(Vjv+uVz7dOCfk4c{jyzzxBOjRIC;(e-<9}2|k!%+&J2gK^bF&;c0h`HEN23`QfTen zfLM<>W`G|B)bMShncznQu^w^Mflmf%Vv1u9csUU35l20EB@pWo$2{!RG)mYdieF21hd_^MDwK9RctKK#aqV zHsG<2ASA~DF&aCTf*%jWXzb_!KLLo**bxC=0>o(SSO(q%#Axh@0b3m1z<^@~*l{i};y4f3=~xR~=2!=eIxYgn9G3vQ z92~|{9hU=FIIaY)bX*1Oaa;{N$#E_4WXERUDUL0`Qyn)TKc@jTak}Fs;3~&0 zz`Gncz+=Jwex52EFg4j=da)c zf!JGc{sul62p!w`2Y3z;I<|8^crFl{w$oyRrVWIq?X-dq2clm)?Z85(6F3szz(crw=&RnGSg=5WU-(2|gZ(-t8O!EOTZ9k8}JM+OSfY7U*1>jXc>@zqE!KVT>G0iy&d^%7QHO|9< z$2gAw&Tvc9sAeoTb2d&hfzc&N8?z0HPN=j{+X&JQ|WkKxk9W$>58D(59T_ zz(!{!Bujwkzs_p#CLnsQa~d$eAzz*j;VA#0; z7;zp8|D8beS?3~P)VUZKb2b8doPM~T1VpcNHUm#}1|T^Ni2mqo178Ky#2L;Y_?bZH zMb4$b)y@t`&H+OAc1FP00P*gMa~be_XAHR3*$uqFxdOP(*#o@Lc{1=K=c&Mpou>mY zah?HO?>q~*!MPfEsqA*q4Sqck|54O=E%=Q}@(92HysRrsRAS{AnOGCFkSd&jO(-IiCc7 z9tcgz`4sqzKxj(NXTbjf#5n1E4*V4$G$rQ?z}K8FL9!i)k<&dfkR#2!)GoKBZ+GtaG2{y zNb-Tu6I?$73tYbfN4S0i7P|fbj&$t@j&fP-7*AYQ;NdPiaJ0(_Ji?U(9OFs`7P(S@ z#jbw9BV8WgQ7)eyD{&x33|Bh%Bp^l%S0?xrAVv(=0APhH8(8TY1gvrm0oJ;P0%yAN zfU{irz&cj}aJH)uIL9>#IM;PJu-wXT`K3tV-;O|Ch}^JXB{1+IGF&8~Tn z+ycbh=UM=)NIDj{C}|P!_@u?a6OtN%O-X)WFsT{XnG^t?o74telN1E5OIixtoz#KY zJ_cexDk%cK2Z;Tsq-Efr0--G@#lSxYVm~UW8~jTk*1Sn8z`p`w&70H%{tZwQ-zJ?5 zz845>Iq6jJ?}1qJCY=tx4+xz(=?w56ftXK|&I11hsEJ>bR)hZ+h<);;bHRTHVz)f$ zJn%n(m|>IFf(!RraEp5#xCX>L>%Iuw287P+z65xL_tn6e?rR~L1w>15ZwAhGZ-HbE5G}!d19&|UEx~;gaGv`X z;C%O1-~#vUz=iHRfycV<2A=4?7r4}YKQQEe5ZK{<7#Max3XHfP2X?xj1TJ$w1&q3% z0mj_V0lVBU0MB&41iZ@qGVmeytH6id+mVMyfEbJ1Z-74r#8~9s0saIKW0CtU@NGbh zMeetOPrKiRrU1VoE+r-1(g zgl^{U2mTunD=)VP{0|^jUTz=wejrv}$?4!0AXZ+S(d^j*8`3PWUauKk9atUxy zaw+@_24dt)9uJ-a#AumZ1{{`r6tE!qXvjwZF+wI!1|JE;2$@_C9GzSV$q_(|ipkZ$ zlH_T?vB@>S(&QPyamh2`XFL%4RdOA884#mW@*Lpe0AfT+o(F76UH}Xv9}B!S zc@glo`pW*ZE?7GU27k+kk&de#CXVc&~5RaXY@u z(&cyp-yC_u^@KPwbsKPE>Laf4mVabaifYTO%$dO1nRUR1%sIgMnf1VhndEw0<~-o> znUnF~oNk5BI?HYFS!cN`a}n?!_^h+s2cLD82Qn7}AA-*;yr( ztwC$ldb0Ig{6CY;);p~aTA#GOXnn)_p7jgsPu5?p$+qG43HE9B#rCNE9Q*b5r|d7; z(L)_W9FrV#@U`1q=Va$JXP0xc^Eu}b*YU29>vY$(uE$(6leQ#1oU}cu-o3?$`L8kQ|6>xl(ISHyOdv3 zQu-d%x3=%5zR&dC-FJWA;r;&6?}L7$Qae*OrQV^dr){)BOXU9xxy)C+m@{?OD6C zzRa>`r(~yRmuJ^zugqSXeQWlg*&_y>Gw8ZOFAUl~XwRUZ2c-=jHF)~qYX;vl_}#(U zkb)u8hqMhjZOGL_ZW!|Xkk^Ln9rE*#!kn6%6LQYXc_imwIe+AMhaNt(c4%PeIYVz4 z`r6Q+hvwu?&Rv{akau2QzhPPV9r>^2$A+IeeDm;!hCes_hv9t+G754F#uQ8`m|JjS z!RrP8D)_FTXvFs;Mim}gc-Y7ZBflK^g!ScE9_WX_OG#vuN*nRuN@_)WFkD5hEN z5YzFW*lH|~iDN9=#0>muEia0hmL2%tXCI>F7g}ap#-TNjv&_Y>-f|2wZo`d+GR`@^ zAqDb>dHgVHQ`P;0_Ey}!sO`CXI*?(8&D;9ea zmEbFuKe;$xQ})+j$H*^Uvuwqi;zGQxyYF1CCIDVxFMub`QjZYt?eFq-m|olW61utHmsY>PuWbx>Bk47$ljdtE&emF z5CNFvKaldwX0o@j-3C+I_xF?WzUm==Hu0*5&r)B=4z(XQz8isuoSX(^v*jVZfe?t=M==InbtzPxp&meTJ`t<$qfyym%Hoa1dt zDNB3Jc0GQ#;CCl}_v7~{eox`|0)DUJw*$X-@%sqBPx1Q-zwhz;8NWa9v!=ghn~YyI zelzf!gWm%D7US29UoicA??U@)w$s7S#_vJ=-o)=q{Q73RW*eWe&-NV5m+^Z8zkT?n zXTD||ieCYK3-Jr#7sc;D&%*yf%xX<}A*(6nJ#c5=rj)dlmXw9r zn?z%FOUl{VttnS$H>EiHwx-wzx2EI{Zb=yr^SHsAL>qo9@Ov&}t$oGdwe}0}TaVur zgRy@CJ^4oP+u-*Z{Jz33ZAfcMDSpS{*FB^qPkHvF1W8dElj zZy<9IZAuw5v?XOSehY`Tro`~O0>20G+l^mRZfi<$?lod%?w|cu=3b9>@Mph^z&Ap6 z5q=wU*V;eKd&Tp9{#xfk`}y9Xndf`&Oxq+zjo2iP!*4TwH{o}B;rZU`^lQYiBR7c{ zeiz{Pz{r-Adq!dB7IzxTF_x6$JG<4;392!ERO8-L6fN;)OA&s>_?6&2&x!c)Ut?o^ zm%l66Tpo@3duqbLu7;k@Kz;C}z|lqH#)!Xg9bYy^l#Ur&Q8i{l*_h&r@zvEu)#c;I zOeig`t{z`eGNxk8xXP-rMI~dZ;jy}+xMX})S;^G$VmMciEh`yUJ)x>(TuJ$u@~YCJ zqVZEpr-2w6|J&@NjBf|1nEYQ&u>X{p84MYRsW*Mt=muXYda|5wRXnCMA5{`BG z!(B3Aav(3oMZ}Qqf?&9$n7npJRXoxuo|Ve(SXZQ@ysIl3Z0hb(PcW9lQ%sW4b5=xJ zdMK5+TPgeEGFTo6ck#nZ+1!A?WoD$MJH!u3-ew^NBhsRxV#*(f40lC)W=Deh6R-n6 zB{Mw2bbsuid1UwabJPc#yQ9Ibo~l4|$R9;}LBVjLlp0Y=MyVpsy5)grG}s~^IPPbh zDcM6sDgAIc(_>V02SY7016}?Wf0v(<D$kOgkYA02J)*v;8NLcqzQ4{V8L|gr;iAX1| zeU5-U;rZGlEnK2wjrdCqXB6n{Xrwa`?Fy#41D6z& zhcfm+1&n;?or2?+E}V<;s_G8@BmD7^<2=>inQOn)@i?hn<3 zTO(YX>_pk=T~qA9(G}~#4?0juSMpfG{^G66)Lx|%c`7p!OstZ4a%GfzQ%5Oc0UBKI zth1aGW=0RuyFd*uV+}8}Yr@OX{q+KfJD_l?jTw%`wJo7YGjdbkCC%Cvf3ywu+1;^r zV5AdH)60v*yqY464Z(0rBS?LhA}G-1jdjagNm$zw2n9N%v(DI^-FQ@)StJ_tXyz3O zBQ&@QtxI9biMB{gJk+pAfjCJEjJLrrzKyCV=)wyI#PGZHhLmUUzLl+l&*FphX@DkGtg9Mm~g z>R|D?Gr^G_r7j%mNf07@N2fm;h*DhDNFf9bAwecH)DtnTRS z>VetrkF__VdlYdMD{SmUbyJ0eibOL3HMF`;xJDE-b}AMPv>H4p*~Cd5jg3=-VN6^- zs0%dX`esa_u}LjZA&NP!d6)o7iUmEJiP8f^1JDw6Ay@Umr7BoML=nniJkmIehnBKl zQA#0ZgBZF8Wr^J-ZHP#-3v*m!kX@N}OFplr7|n@WezD#KisOx#U1h^3XPwC|P%Iks z!1GLD!1ac&q%7f9T`VRBCzYZERU4*AsST5z`e?Ci!^J{1vSKkK(8K!pY=1Di1ce=0 z0j#MCawEjt0UK(#m}*$oN?m8Mh~P(6CTCF8SW!udXedDjc;sR5%qVLh???oV@3JQD#E!lft>*W)hAUgsNPCI zxptIT)wuE?z3R0GpU3kQjV)scK42!Qi`;cA}uvax@eqH(x663gR7EO9#GP{yQF$aL&}s& z8XWUPap^c?fFWK}GGUx(7^i0n3E~0AQC`MTUf?!fcN1$={p+tEveZzBv=@WhB7Y7G74HoLCeHMwN4ci zXGep}{at~Yj!sO-SkLkrvI;X@Fch04Dx(27&aE%!B80}vt$=kfvXr;97#!+?!MS}% z->j4oof%mkXowKQ0HTapft5_B2iw}Ku_lgm_P~Ao*l}Yji^q={UshT)eoS#$b>-Ny z3FF3&8CO+OUR7LNT2eZpX#BXb6=G^p(YSG?l@rDn7mXb^ZtD06qw(D9OUD`eX9{RRATk8#808I5&B#Q_Cb~hSVo(Ab*)TkGMgUocd}(_ zaAmh-2vXN{A~Zsi|GEAZY(q+<71g!s0^U{%MA6lhk4`{D;Bp?I8;tYC-&ZG@lX{A#RX^$%}Wy` z7!Rc#bpn6K_?Ph~dxXlpt zvd#+!n=w4~k{)Cii6cOc*qj=TbX58~gR{GvLcwO}c8OB?NWI0n9Xp5Ucun*a_1)@8 zs7rQrch+}7FmX~dJ-R+H)P$$`dkLsbDPd)I6x+95CP_RTR%zs`4L`I1?5x#y2ATy8 zxlG!4u&QkLN9zM!vm#wAlp|O#AsQA!H^wM96?gT@=0GQHf=%~_TS9>-g$%X^n`NyW z(p4rX*T}Nu)PR{FlD-n$l|_Y*bR{?<=gO`ITui%aITstP_El6bJcvVuKZbnEm{AGX zFj09@7WDUewUa{AZ(UbA9#o07ht1yBg8D!D=y* zhluddt^CBI%_2%b*-$;cp*@O%u4zGQ2sL8C!<+hskUUoU!&Dcdt}`GB3uSYV9+4W{ z4^k?;?i`KB5p`ig`S^P0MKFB}d1@rO!XHJ4MgyW{aokQD4=SrFxNegzNVmzT=Y>1u z=CCTcSLPXD5w7)M~54#B~3E z=|#p;fjzLP!LGz`y@Y>}9`+ah#{>;O2`L&<`DiLhLn{5!pdCaHqe(DI%~yZ2gE(Le zi-g-|`8#lK)fR@&d06#JhTt*Y28C2cJUbXBFX%jVD~LoGaZ(YC!iMb+99)3R3wL7& zK-9!AA)v9NHSs2l2zJQxC>5LRz#`21iAtun&^Qf)*Tm+9F@MsbQVWKXSRhKIBC--F zGe*<1&S_A>1~H#z=?|VLJ6Pk6_y5r~vHG5HGula*WBng|s|=V!sAgvtNnf?iK|M!I zrvggYgJo9^L2lSh@^`SPt&cjemjnU%py|PIH7u-> z8?j*R(Ow>Ei{MP8y~FT)ptK=k1kux(AAlwkHNqT3JS(t*okJ?CjcxQea?)fn5q6?e&1tCW_?_CWJeN#*z_`80K`DzIWh)0e_l zs!*xODm@nCIjOTS2q}lG)rs=3v{l2T8X=Qh)x@cbO;&P++N!%KIx7;c^v7smtfI+> zIu!|&r6!D7DcGfK6ayxOD0!nabxsAObFNR_5>cMpM9%Kos8JUBS4^~y#R^QXn6bUhv`dn3@sk@Cf%A*~;OlBt; zO9SapT`WMK;!HFyrToc(Npi~KJmf!G5$RT0H(9&mF66N`vcl}qWDUh#I80*`N5^8t z%}RcadO{kqp(~F@89;eTSO@g>Lg_1S^6^kJVHJ&%lb0I(z)Q)fLQT$?$(4<2J#JGG z>HWYILLNn!0wo9#11Uj)nf~T>Y{DpSvI8lL>OrO`=LR~k@nDKFK_H(3ZM&}36vmv& zj9~N9x>ntl9^}xj^!$f*m21C4yB{oc#7LQPDo^>bcu;xeAwuzrKwB`ZxEwE(g`%D6 zruTkx4m5tHGJ3Afb1By)UZ5=+#5jT+>@BHwTTNK{c;ox?9eX({s~=jV&{Er$_K~ z6}QT!5x37*+DBX>hvT?ib|PIdr(%e^QA?-v;u4G)i2|ABL>W&#i6W}tXapBSaKA%s z)g*erM4l*+`AU?j%~RvyDSy3=%SkopEt1}-n;guAlISf*BkCI2KV>ADz3E=5SHFCFXo3K)-Sy+pKpq@AHgc}t8cf+i2TF-BbXZOEvM6Ymp| zH@Px2Jn2u|ON`bs6^kar8zKs}VrgOsqI$}dcU<8h)vvsn+FxB*zrVu|aVR%TaeS|f zD~oRnhblvG_OQ>sBlsqrbQR5JE~!|jTmu7GlBSP>yxOj#o`7JX{r z0Q9`*yK;1;NNLt0JEdi|M@?>OwCaMagFWl#v)I`&B2yb=s(Gr7AzetZQyKYb3rQD7 zI-4nFl~Q8|S+Ld2MO4#)#fRMXkd%rAWh5;@cEvazBVXjCuMhY+3`;}ApjDA(oc4#i z3;`_>8bfOBz|9O?)lcFr#JS3W6qa5ah`JN>ivw@`>5dfce{fbqczkr=B+-!L*QU&| z^_I&1+gnQ2**oHxjD~s=-yt!_YL>_t&61iJbQ9?vO;-=+M^{6K;p|eY@J9pK*24k; zMF|V7PMPyc2%B4MkqUxtqw1@P)smtvS8q7F>8!#&1K)tqE%lwaEg>a505wC|lvQ7e zU8taJz=}3Y3DifarwUfW6z`OZji?9()U-FhoNtGS25DgOi(e-Zaw?>aOXUfDHg4m2 zQ#zOxNEt{)*K1Ib(pp;8>(iC>7aAkBd`So8{4TenIm_pK^JnCzr4 zSuN;Bm?D%2y+XQi-SSQv_F$w)AAO{avm&YaiH*%S6^M&a-kX!2IeoK0uL$WZ2YUTj zi}mS9v`4zp5=9?_ly9{gBy9~5j6Jacmq1kydRVYoZ=F0IC$v{Obue7PtHaBK*gB)( z)etXNDkE+>8P}}n9*cgkO91r-|ps|ay(1n&srwGd0g51Xp8;>Q*1uG1k33bSo zr&@U^C%G4<=OaOgQzG0Bl1T-5zoyYFYUVc8=-02IE1#69#ui+iiszA(9%bzy%_V9Q z$i)wJipE&5O;3%MHjPL#qy%!1lrgGuXrb*4Y~>sK8Op25)}fpOywQg}ZarpwyDu)1 zMPh6Z%2Zp_%&3CNXrxo89)+~Zk$Nu1N7_{3ijot1f~ZE{ie(QnOoB*;Nf0StxB*|$ zQxD{+q$^1MQTaZY6NRdZ;Al-w+lsP&q2QcI(AJSCA?#UV4MG9!D2m0atgQ>iQ|%2`spA)-h*&UaQQ&e@B}a1;g21^nbp zI5>_?*@7GyLv?`P$e_&WPWp(z_Ew6eCN@73!nPPF4KNXyobpU8UxQeGv-%`smjQ0d8n)UB#qb*s!N6(39Z zu?!nR8yr&sdVHwI5VY!H2uJQ5ne3cn_BywL&s+T=wozf$#8eK<4yp^wRLu@Dgju5cBAw!zVx@Xex#es6 z`p$z%E-#ZB0;8Jfu?(rKGdh#9a1v<1P{v(I)iC!Wo$~|e7Fn&j zEur=~0^`m|qL;*$D&)qx?gdY#I<_u}$y*yy*{nEX=;K&`%l@r%$_%u}XqVvt$@+hg?UB~7L0e)aURsg8L;;O%(g`Y@;fGoybXqy8N-29Z zZEhQW%_?@>E2~M;iik}%+ENI0(^Uw=RjQCigl21^Rudy__HDn{oxQ+4{w_)N4#j}bh#41!h0v}p&1QeaIA~B*&lwc7iUrb|nn#`g!7%LrK zANJVMv^{4;Pi=tqu?&ISr!lO$?#u!z#RP$_$g-BDpacQe0V)X;EB;rAe3a zpkR15-nnE6g-De2UO-ZdGZbVFBTqNv(K%mXXX%VER`PKx7jrCbr-Y!P(9J*gzT9Bs zQ(giya%8en4V$d2iJ0uuOqcmMIK^fh(-;vZN)U(}%>hyrFLr$o5XT#1qEidM^a*8- z(?P7X0-6_Y!TpsUUCR4dylOSFS4l@eM%Lmsp8i-ar%k5ySZiTO46y}C#I*!z4^p zyk>jv3v8U5c6m5%i5$O2afE27nGjDyv<1r@Id7)|rrNdeMsJF8vNGb$=Z(sVHyF(hv|(PSW*F_!Dz=q@%VX$)u5+DyZgqyda;lF3dlx!#4OO?3xpFvg2 z*wDdQS5(xv?FF&AEIAWLVFD96x<^F-`!Ja6a5BzH-15Lwyn})D2@Wo3XTP_UMmsqu z(#pwL&Cs6NA;b-M%0#~uM?y#*FXIwYZ!sgq1*Syx<&*4oy*j}qLBjr6!we-@sh6UF+5tyC}gYE#?;70rQX zP6_U&7m?#~eoTGNi;EE*57F36i^Zkk^a02wPAY0_#H0yIkFKwcFvHP{5o$z}N~tcB z{&X7^Io`5R{<&^($-Ev_LLIGA=aozOdmw5%0j-^z498Dlq>T&TAC?wcHA)tR2fQLm zQPKr=?0kb&1@MM2=8Zs$v8Ld+OfYgsd2C5^qFbGDkH&U{A(}_0zJ?94W4pYKHk;!z zOak+RG1@d?;^G9oE-tQ##W@};ZkZbLx0$Ro{RU~jIf9oBLjIM^Oz!$aVXSEBZtjZ5qdQdM zWy2`mJ2W}zWky{tRyRp36zIu_ zfSC-$lp4O_8h2zy3Q1!V1!Wdv+Q6$@j#e`2hLUl#y;_KLp`_7KmwyYY& zKV~8QQYMv53b^abmqSdk^-7x7siyF_l}F1#Qv?Z;S&_J3v4{ zDivG0tJha>+a1~`-XWy-66ITo`iO_-wA>i#qy?%1$@r1u_rkdH^wf<~lSFUl53mmaoFdOR9JqMiEMsUPR!*k%^&9#@{WHK}p%f+Y5i~Nj^l}BiZTR z4u_KEsVvh}%}bpJIUujI@rE9D7>pd5?bJ!|S|6s8=B4a`I$8zR49)Fv8PqUiQ5%=4 zpoWWD1IIm3+B5wt;{s}K34-}SytW2qoXQGW$IFyh)yk)$D*UW_@TV}y zjrD>UFlVgRfUsEv# z4Eb^qxyz@=!5r3oxUvO_EFjF)d@il~h}%_fm#@*GZHVeH+6xifeUzk&-ae~ol^b-i z@@N1rCdr%fGJ1aX>;QMHu_+eH(O-IyucIAP(;(;FKtohEQqFmKTN|DwhS8DBK#%Ys zVtP(`0|q6f`!ZS8Q>xi^w9+!jBMKciXmF*9snk7n0S;D4lhdv6YV4-#GC7JKAeNKJ z0b=gXY6o7A0kPIW?WS+%=^`0vZ>fy4w-izK7RlgBnU8Pr>aojs4(W^t59uajK2($k z$`RLrLOifqj`J)Q#YrZbldJ-nz#*Mw)(`27MH&nm1B@Li6UKHC z&%p5)tL4;dvQwMG9s#u-8k%&gZakyPaLg|ZAU-$aW^3m1{%7_k(Scc7>QFmBXF zFha$@8Brd^&;_k3N~D&)$Ux&4khNhTCZBczy_O8Lg_cG+nTra1#3|Y{m!?&`28#tV zHnlLE2p)(UWBl?|tg#~)!^=_-^O{yNIZ&<$l9*}-T3tI2K}?huVCM4aS<+5^WtCzC zstC0Emj`j$MPCsRQ$vJuwrr9vQT|$$z~j+ZtMK)Yu6CM2=;$8T*xE7I0w}uLK)6l1 zVZz}f-MECxL%j?i7qSizw<3$`W!JduV67(Zs;47$l(<|mbQ8s*Xtj+YnZFgZ49-R1C9z^juUr$IzY`zy@Z$>5u7JT zo*CocrZG!&adTj)kSD8jHvmyXu|>7xvU+8EH|(;!vA+gg4sS>Mo4Xo2;fvHU{SEz@ z{@7A9LjEo(b9!Tt32%zwJqEUr#z|TZTXr755&|qA@UsL@PKx=^`z1NkM1R zvRTkwS+>dS>tDnq_ZYVbvxNN2i%J(VyYa(Xfa^ye(&eZ?BZ=u#GfK!K6OS6?PDed7 zxWq&7Ig@m!q-f7rIbzL2+s(>Gv!SAD@0La)esEc2%8{NRQNRVN2bC`f%JeXP;3Bsk zj=f>+$j4y`DcKYzm^EVkLUxGR2+HL}@z`YxL`% zLBLJJU$`y>|S~y1cyis3#YA_QEu#RrB9&pG+yK|iRnwW{!gjHVv;rfWtl1LXy zF6DA{U^p38bVdF9uehg0s-(2eD@w4|6en2cC0g;h>4dO})|v^4u8Gzf!*Q;`=zFyD z$R@u%CMs}2l5G6lF@4QX5fHlu&gi zN?0{Y6p;c>>-j|KwD{dd8M_qF@i3GJL&SZ@5KwxCle{%X7lgRkkx%Kyd5Bx(S|e^p zLJ1bAxbf{3d4OxAK^`$h8+K!RNJ`Y*9?k=m7vG%33?f~re3>{g-yifc#PvZVShA&`X49dPy)y^pfzzCiTt6E`B&@!t!e_ z%HGKz25Vdz=uv{&7U>Zm^Fw{m!5XgX;}likT00Qq15ZzKT@0IWAM0A zxuF?jBfGmpjtOxaJtnV8Os-~o087ed6_6HMx`o1Fj|0bR5t;Z*|A`S?08kRv(W}sB z_%sVzKP^O!(=E=eT5xke&^d||V?Ms-rVBWkgatbLSDR2~UwoIYmpqynl4oK)3@!h3 zj%0bkNMHBUWwf9OM0FcKonZ-vBZdn;Wq|xPE|-UHLM3U~X)S^mf^=s&PvI+%qxF7F zZ>LEq@_jI|ym53e7sO6|Ffnea0v{-^ z;r-}Dzf@8OL?F{UP_8!OX=ao8rP|~{(sW+Q^?88MD29W%=&ygvmEQqASm(qMzyS{b zhrM@?lKZ&sJAd8t=x#g)(+xl*r5UPef)Z#E-~bo^1DkRP0we(&AR%HXK`|9z9zDc} z1I%b>-N+l-k+X8boCBYwPv|VO zk@qmWP?lcp=X-C}uYWx=q+~fcXa5MnsbAHt*R5N(Zr!@|XbOe3()U0kVwmmUCkC3mPmCLB-Y1eNcu8mDR@LO>UInIgwi5S#*H5FYN)lGutA3TlB>t&$ z>D|E0Q4=@Vy-yr1d!HD${{`NS2d1UP*V1QfdF|-@Jl!Go4#VPJUOCjooi1P)(>v3v zVwOX!blYanU?qnBER-`bJ}TCXQhV2oKrqhfsgX#4g^o8cEMy9g zM`nK)pnKig;rPx@GAUTPaq@QcB7ezu%({P^L84MiOsGDm8dIftuC zt?w5_t*erUYFEK2W)*C8FJSZ0255)ACLH2APejW^b>ZFJX&J0nM3^ex#fKu^ibS2W z@0sdo!HQ&|t(i2O6xGnpK-S=yph9L6`BqT|aJP;(XTp&J84$yTGsybQtH{Du?umKM zfJul*8l(Ymk4Cl>Ci1Q1*)(z?7Nb-$ld)@}r7CE}!dFARgIB{fW3MV=$|15w#ZrBd z{xH9IaCUYoJ^sM65py*?nc9Jegc zB-equ*@!0#S4PNCm&)%>`Z%obzp$+Ls7)Ua5A!nr>M=c)#U6}pIPAZ(us+jV!UZL;5usAv9@te?L_L~(Zx>iE?&9S!A!TBci^#c z9Z0~1XAhSPuzAibpT~U^%d>n(A3Xnv?lbXX z7j_bR?PPo&5uq3K?Q<9VAb8`xotTVZm@+z2mE%O60PBGTmYMz-iPU51BPjgl6}Lw# zr=n~S`Aa4iFX@quM|5O^$_}%y1cf89R)R{*hE-y!KH3NlI|XU#Y*?wYVM*Z5FE_ag zlm&Ees%B$+!p}ki@>$TmW`|n=$p)=_TY_exCnsiVtAJ+EH8Y{LtV_u>$b(C@jtXE9 zXHoN}V$?!3+qYvZ6cEoq(rdpKf6n^XUU+cR_^i5iI(_zm!$tPvSDs?ZU!$-zsVUL+ zB9eJso<9%6OiV4#2Pv-AZSaO&rGpoiopI6^m<+;}Gu!yK?BpY%q@W3UdAeSkALoI} z6c__OdSfVxe^&!gE$bAR122$G=5a>10|M!nu!Qky$U-=$8AG$#w?NY9Mc(*O;9Td04+W>= zyBU@c0$HLTKDUs_VtCkg1SSZH8w6oVM@Yl16M~;Rf#o#Oee<4;HEVV+9VmrxD*oNbd2^;R|$Q?F-2v{_a{#?q5uflNhTgvy5+wTF}M-QfTFg zMZ0OwSx5h>8Dc1zM>&JX`{DCC#crTwroYouihPv6aUUiwJB()1ege>msGm8y?}9WF zF<05vc$Ru{LX%L<<151fiG(!Mu9a zEeitWY*44o?w^Uz zaSTb141p!z#R?&Q$foN>OuECaJ+idwJ}sO^I9h2iz3*@4+78&WTR%$j25VF&o`vtq z-)ZecW@eBS_`dy>rZ}3VSPET9+B8D)V9gwKv|bopGmd_7@~6eb2Sd|oDUDeJW3wUX z@@*ip*RcZH!FWYP2jdkHT^O&31LGBtw9A-zr1f_2QO$9ftcq0a?;ClvvnpSeQKf!B zw95T}X!JF=$)!|V%5pHjP7;V2z>n!X5Qm&1I2{Z=#bl$HUV2@%8YL-2y z4n5il>OfB>$a&G2P&i1sr$fi?W%1l#Al&=Lk>@lE25bQ8>T?WM-cwSp`{qSp#0U0& z0(O`{KV%RfU7BuarXA4>=jx3TT>y;!Q)gprx@?Jnt`*j!HPhf?oaH=ymW?^?S|ymZ z;A4ONCcJo)eGn(nHWbU>kU)gFpPzeJv>$zlycgCzi_Gcv+D}ThG@`>dcdz)7Oa0#2 zD%g}Sq|h7CA}9@&&H6GeSlYvb=j}1|m31Z$E=;3@tO7eIC3+)lnMGZ<%2UYA-WlN z33Y1-|N9Dlmafw^m&U05EUAOvHH8pxyi$Fk3)&U1$u&U2+!sPLBRjJsCs%~C+C<3W zpb+R1r82r$tIki)M4!Um(<>e*2+;6cLH1E4jzDr?ntW53RP;US_5{2z277ga-8HM5 z!y&M0p0dKDT#nO>Yq+lPq_8j{u1dScG-ZXZo_|#A8qiSi8ZqgN5T_Dusjr$|67;PT zKXT~guC#koBIrnGI5D$Eq!SyQL?sij3?mD83_aY534xS;!8qw%7HN_KRoW`x(G{Z2 z^R5Ca?<$}UXsrSU!mWZ&gvZ=cbW%Dly489yiAhjr&5pg8VBFJ6vvc_(>`6fz4xS|Z zoJ?|2KjUhB%fubdAtP}ODy&ySC4v`}DF_|O4|*p##h-{A-!J|&Gd&;`vH}zjH>?1U z&xb7W&0}_^tq2y6>4MUETl@JsW8-!!+W=3}GgYi|6)jvijL?EM}nrj@!Ee+OwPBca-%y-r19BXesr@S4ov- z4f9+e{?3?;ZoXsuhj@j>-tysu>K`Lt_B17@Mt82c`TU=uY;g+w9X7zeivlx^ThTJ@ zmU5>Y+U%Ti*FNe>Oq!Xmwshg zo@JRXm=YGE|3V1xyOV&rEij2LE5yNafyu*f)S?L578bvrx@3rQVrOE>DB?cr7JHAt zet9AbRIhp1rww-1#leqvyM$Ck!9i%9cb|POf6{S_;n+xL+2r zB{RmvGw~ks4(Y%;O6jmg*<@uQ+ z{Z^h6Q8uP5%oUZDP);hF4Jw;54DG|S6Az!C_X1@n^j@+)^Hv5gnq2U8ni&AXjRs{x zpVhN+Oa7x>OUWeHM~=sn@%(3P~R$;YK)^klhj6Ks@3p|KQJ z)GJJuw%@vxnJNOnwU#vukX`XBm!2VV(JsxK@dm?!U;G0fo&>xUA3>kQE&?c3ZqCol zK70Yih0WQWp|=zd`Tdq)+@ccDe~gKnJ@`e2yE!2n{jfj`VnRv5sAJmwS1MZ_cY+W) z6WO731{g@4fh=_LXL9()=Tc^y$YvSq1~WU+2aHT_a{#DpwmIzA6CJls2-M=a;t(G& z=_Fx8BShJ@lGDQ_Lsr-o@-jGgBSC+TiUF#~Ko#&RbasGj28*ni-Pc3lB`ueOWGbZ6tv2_@O<# zJmg7~RYZ0)+y@=qqsZ(7uAZnHLgH>fKxQ>Cb9CF7DjTMhY;e`3>ug)H2}5OBkXch5 zf6Xy^45-r@*xdv7x{P1q877FaY!s+vU*lT}KWiG|7UJtI{+daEvVX@fqQxHt@VyxC z@ARl!P#ojQHyfh5$(MOOiDAtQuo7mvNv0T|>9c?pKSh#>3MT|IkT?V~AZ@v2f<6i| z01+w^6scjOxeQ2)gcTsias^OXSIALkrBy)qU=^%0C{{($i(X-8r8K_C-6EZOvmfj3 z-f!}*fd|$q=zYLzB<(hoX6T`IrfP8pE;_9Rcih*Cp<$W)utz3ji=<3APSzQaBjTH3 zE5I}}&Qh6}AgepiEt#a!LDtUiW-RGfHs`Y8DL>0F(P8eTumhJ(r3pkvZv@{ebBdxUt3c~KVJ=-*{RuOi&Hv;Xa^uJ>H?hQ_r+yB)-$4(%tOjJ z&QCgeRT@1uS9ooi;4Cqx=X8T*$ye-Qhjb}1qrPWX=egO}^Jl}V$c($$1YLm8))=qM z&hz|0vmI2kiNGXs1T2y!K5LLXX7})yLRzY5@gJvJy^WcHBi zXPkyZ+uj*=lKcG*p*x3uha{+?X^E*eo$`#Z?9`q)4jsfp7bJ5+IxDus&Yk%P?pk>^ zbxAK5z|3Az?P55*nJpu8Sb=qboq*DbF><=d^?)cOy9pX$s!lot_`CYFgwK-NG1linxTh3`$)^S@A zT)Czq3nFASlu@u6*ck$=<3b}=N8D@27T1KY1|rj$N>;-UPJf=RTn!iUnHGX|CgeI= z24FYgvSFsS4z*MkCowtz>#i)|_^j;rnG~VX83?V-guFQ!z{4vyG?#qE=o@n(5HSc_ zcp9kZOhsT#Wh*6nzQd-*qf6ljB^_icW;aME@_r>360=D<;SkR;$*%Y`?D5$+_v?i5 zl%5gM=48zu{NPTJb}wks8n=3UwQcg^;Bv6|&|fU^!py<6VgWTmbBqP1qDOf6&gM1X%?6*}t_$!_4RtdC=p=@v)_wGYgpHm;dVgKq^UYo=QZA3sx;1$2pNUawPO zrcl?%aXpbj&Z{#{cf!hTI8!5Xj=Sg|I7d9Hd@7Gl_gQ!4;Q4DIv$^?%d)YD)PL7ADw^wIWhz=I#|GW!w$W#lRI4!|*mIp}t? zzNU$~Vf?uB{A0C6-S)AUhC>&i|yReuyLe-5~cx@!eL_5E?p+V zX7o&$A3xS&IE4g~q~So5G&~iHT|?4`caYt*y*A?)|^BYqm+>26VK2}@S&E_EVSU}ikgi8aRRtYkV7?`v}tDxay% z&DqaH37NHWFE0iQopo_kEUeqofSbJ01QD4jkit{{bT}VkWyD#_M*E63btwpI_D6S$ zH99lgLh_k$%_6!}tia%dui<+53G@_dp2e=S>V_6!caId!7qvWKnUKH140;5 z2H%3GUA+{JKT?#HgLhl3E1PGssAf9N&F86zj%! zO5|Ovgl3UEq_eHURtEDlfcm2+F)fbs9T)5eCDPa~ndVTFD`K{k9Z22QI% z37M!msnS3&X6Z?JFkv#Mun-WdICw209Aina6NQq!ca+-T(Y^y=zf;8+&{1ZyD(XxI z3iiy*>_zQYc-NV|$$QPcLi4Eh7L>$$GX!R{3DTeN)KrqDTnW`Ea4Qt=tIp0~yfK|s zU;AN%gn4X^M!>JOO(x}-bL_MFI3iqI4_L^j@-hn^39W2U(UPLR)*-biZ6W04`Ji4# z`w3ug;wrGG)?L}IbQwTqRTXfJ+bvx=RsdD*eW-BODD&tBxp_hlOTi0=9OP4m^YSdy zu+z)(#rs}#u7%C4*ICkf8tbeTK$imSPIcvsfvHd&ui}~f;KbmkXKRnyjREuA%Q`>+ zq4ePL)P3`hv7W*SHxSd8ssy8FI#KEqCXfywRWJmK_asfQ%Wx~;y^A>Z$}aKt?kE?X zFFK*MeP^to8^uR01Zt*^+rolbrYnX9GKT#3`nn^qwd)swc#xsG0+bC}$9iJXyz4TOgT=jTfWa%JrYGc}?S%gThF_bW zHL_*)LlfTrkaJ&eYKiiv^EPsFuZHgIeU@c>9dbvX%Z&6YyM)Qi#r#w zkMh$eb^||2@8T!p^O~O=+A;ljm>((-SSIB60UAAjbI zXKZKZE*<2B$#9y{>U;lK&-;G4R>NI_rG@*1C#AuTVs}ndcQwX~xqmUumTlCk$Sg{$ z@~lezK<#0sMSi+6wwK>oP5oX}8uV(@;Juv#nY=E)czPlh;n|$#Uf~*43@z-64}p91 z(l;G?w{Bs%_vo?v&jUFZZhKo`4MinPL)nKTnG&^Uc&FdL1VGrUMGovDwK*e%-;kNN*&^Fi(4ALigHZ znrS2tRr1>enVd)U*bYxhd*{c%EU$?;SnZ7GK|N6?q;~0gYX@R7at)APBIyQ$*D3&$ zUAP#PUO4L%-FdsA1M}+i(m)4>s?mLlRrJ@dv#x|%W*^&~+|&FZtoAY>zU?+6>~(%v zsM>N)bNm{&DLsy=`7I9nu~~*I&qQf$ryOfQJI(PO^fYbikzyeQ%K_c!L@YgSk$yN` zv&tT`Loe>1nOF``b>g9kg$a%ac^{^MsR-rfmz~^E3j9aUv%1BGNQi|A4LeA|=BGLC z$J7dhDMcqZ;+$aI2rLb2U}VEW#pXN|`^*DOLC|?4+8Z7qqkeC$6)DH%!e<3DF zl4Qrhgv&w6h2&gPOU@_DNfq}(GRMDaGEZC;__>6aUXn{m^6{g@KAKDrJDW@sH;Hc^ zx0;+K-2^ax*EdN%@_y-dCP^vgNp6Y0Dy1z^#xiBi^W}Jj)iIZl{?-Sn^AY~$lgDtg zbE%n@Fk_?}uKhFtb+Gr()Xju=V;rH^2hgv32Im0oUwb(vKUAe5G-EZ9ye`?lS==aoWRB zP8eMzW;)q{Up(Y;Aj@a7z$CX^dc~eu0;>i7Nj5nZa$D~MCYc%~${EIHQvd1W6d;xr z398A*lOJa={{-Jyq$-`VY+^!nsL*o}A~ulFRn9DvcLa#uuJPL?EtR@YR+x^OmdWAb{JP| zyRvP`M~;(f3L5b88-M(4Be>m{+zsm_A3dJjkN^JUbaF4uc!=)_O1V3^htf`gcM!29 z^@^AxDLia6Ny;((@#G|F#jp_~!QKh&L)0e)k4x4+N=U-~G(zRH+#8OEl2-}tt?D%& z)co>7WbPiQ(sMhxtI79Miv**1M@*gc{Qy0g^xTB+rUbXVV6A?X_NxaMljQbpE|u_8 zE$ZP*&|5=FVr|N}krHqDZn(*@h`gWNw6X^tpoR|jfko-l;47SxO?TlFUkZow#2lh# ziPdEN$>c6@GLcY9ed~{sY8lSjN82BS?rA8*IPGJMg+h$=Lz>4!C&5A@LiHyb4}*zM z0}8oX;ql3Er2jPBQGO-&9{mecV#0cK#nDb^ms8}COde4cbu#B01vnNK1mS+9`B zDE@LB`}6Sia)P3hLR8lm3~~p;u`>yx5N%Xks;tdQXsRbfQ^|_Qh*gRzIIDH8`na%F ze|uaMcM`74V01RnMe;*(X|=>iKC)oBeM(X2j#urCoOqbtca^`F@<1MH#C0iu*K` zPcu4mv)_C9OZ1(_k7(x8{0G)_{DW(9MNgC3cU9VVpi6cJa=upo`lR_?m4DOf>3W>j zMkRVtuR*7o-&N9_;*t^dZqv$~qCiNwqV?JN)@MsCV}#{OIvZzya%IVDjWg#MX}l|F zy0;t4wJE<7?K1MLxLih+wR*zvp*MU9+L<%s0{e_K%i#}<-Fg)1D$V%Q^hk~Q-|~Dy zy0PmC_d~Ziq?CHB!yS_1mptvpSc2sQ)AvoeOM17~F0)9SOV-ybDdhTGoLiGmes|P5 z3I3w}+{$qsTo*muw`P`|LTAZo=>^z>_y0TxpW%W+lCHcYZ^NH11`Kn4%Mp7cf zMK?GlyY&m}Hz<`IH68l14x&$2(m#$U%gdcB&l4#3vy_q_{10A7r%><*(oh4XLIg>j>!-Had7FBWO+Atmu9Ax?^2J@Qe3o< z zjc%p6i?2qvv;@=oZuy|tbUrR=g(vBeY#t}SxJ2e>&F#>#9LJL6jc6f=>%-AlmlPf} z?n*Xg$0t&_E4*h#7%sVgoP3V^LFzilTp9Hxwa(|o?)g&ls;`|7lEO!3Y8KnP2JGhJ zLC;XTlyjM}=q5W^DQxY${toJrL65cKraOXW^#B?R;RD?`W{sd4qtULgM$Mn>&bhL6 z-yt`~JZTf&din-~W?UVbO=LnA8#f_p=Fqyh+vL6W8c!Tth0@)&E%C_=a7lXCS1_XA zq~7e9P}gYT$3@8n>qF62w4A2wRsF)Ii{?C;Qain|0Hn57>W{pC>g2i~4K~9cz&>;l z|1Ru@7{oC?!%uMX5lUn(>AN}kv*zwda^;)Ro}E)fDR_GQ&5RY_$dUhETcIGK3pe9C zNjW#8>6#(Gd;)H{3(CZe3Rxr6&WpJ6i$1*FXf_M+vPva%U8gr>liW#ZW(mCRv~e}B ztx`hGv=H@3lEM#LI!SwjZ&Z)OwPSLfU_L@FP)pQWlY(YJ>|`6YQkVh*tzwgs=6lJ8 zq~v{F@=y2!EsGRBZ0(DB*ozHen@2Aq&;;%Q{^gEpjkn9-DsPIk6a3qYU%94ouztI-xPnNgeHKESPOSilCYd0tXg+jNi(F>Hd>^3EJ;-RppsP1F3R}R zN-Ak*O8y2gW3Y&SXdPjR{Ov`P5R0fJ<`B(h{AGXmS6VFU8`k5k4dw!OpT*RIK4 zO1+z!cbiXAZWnNkhC`NO2Wcf6?g6e5?c3buOfQQg2#!+)r@LUOKmU6kF?2>8-MD`G&M_Ukh7Vce?AUn)Wnr8oTGt zTAQ=`UWX`KYyCOwsOV;FK+B&Lf}T=1PT3qh==-$vfF$`>|L7AxzxU0*bMznn(;xY@ z_V0Z0iwRp|x!!6nSM0+nZQ_&nhu;`6!U5WymULx75M@^W%R{X|wS zktV6s8-=Zv`V(X=RTF$)#3#s~4_}2TdmEokTg$DNN(KHa-%;YfK?|4fOd&-8U+yWC zO6$y1ZarBlIgHc+)_e&+(a-g&hyuRL`82XIUMg(>^g>^``KIDSrp9!~yHF~vxBP{2 zgYw;9ZsIlni~Y)%CU2i9ge0YMgCf-il9Zd<%FXLL$(kc+j^=V9R@;20RN8160y^MZ zssBRmMp0zJ33Hs!`mL3@9O=}O4T{14(u^xI&lH0@prHY{L<&^s~gox8CUPYYw}*u|OB)y?$H@m!@*=etc`jevoC z(RjMjyxLn$HYW-_kt5`Znis?Ot?&h|ZX6g;!e7XhTift7W^Ay?c` z?Nbs97yAl5#bU8g%@;RAuf9UQINY}`>65tN|KdQQSbnhbso_2nRX&^VOLD~Y^bhw5 z@qx-`dy}N{DU(eP_9JP^ji1%0()iMbLVx)|@_dSapQYBme1Fj!D^Ui%3Q#9C8~OkV ztsl(w7Kd+4ZlpcE>qypHz$sXpi{PrHeMufP!Uguz`8=-e9dbC zf#x;nSgAid5KF%tOJ}^t((AEQBE6uxm3lb@V%`^G-WT%ltKk8t(zsd_4lm%@Sm^Qk zFBU7!i_p2;zREl@us*<#6)VS#h?QfIpYhVS4(#aUe5F|pIU`!_H`3NzEJC6DK(UZ7 z*MGTO|7(4$OY6VfU+pncS95>}Q_)7MtknNTzJGuW0|W3&4-*%h33pcNe`~mpH0uiF z6C?74Nnwy`GTay1*nBy(vH5aJpXL>(e)CG8lM*?yS45}g%OMb3-#A;WG|q-DI~$?R ztI*_Xf6_C+eTSS-<-zm}Jm zY@0P63i;ta(YsRr^>Y0;iV0NxR=M$OCAbz}rSbROr$|yV_=X06QEVW_9p4i60XFct@3 zha}$z5r0!OJyIDHCpE{#pUp&sXunixzepMRfpuW}2Xs4qWzplbu`-sT_ZF4-C}`B- zgL)cqr5L@9BgMf&ueYxXS5zy_+d?y|F>~`W5tjq>a)dTcQRJz>TBnQ`nw?Q+WeM@t zLuy6qA&I(j>#GECOTzQWK%u`l3=JyBO1OQ+AOw!N(337`dA4mTz;8^5&GBMspwc`- zn0(DS{gwC&n9ad$#i;l+76wYy0=k=Je6gt6d4S2V(tOcWo3avwj4v`t<@n2&7>>*t zxy?a7mMX0gx^i8<1Pd1Ws80ju9St6hlHbq6t=q)Rd5hZUcwJQhErs?r-z<2eq_dE6 zvy+-^jcc02RT3zAz{Uylx)>X9KVzaO{n9Eb^@2qykm$yogx>EX?N#cHxnfll?BM2{ z&kA7FL)DP#>iPnD=pbrb>#Nq~QVr0cJiC-w1zlt4*OY0^_i&+fQ=y>AUCs1_U4fD` zF>&Tq26K^qxMrbil|n!MO5_kJ_~jtu6LMnh{ypNjV^DFs?=A##yn1`$U94@GbZ<#c)qRSY2~E~0 zb}F=vuJdAPK(?snlg6DOJuO8!iu_GpPT{%@N22;^x`T;3ZP? zNbF!wpyfzREa`Y-vZI?1JlU#zsQ)ACk1jl`DW26XJgbIh6~!}l!Hvv@y~rPm87#t4 zWmXOY8<~}~5OJklve|JBkhmaY<#by?>SA~F%5aflK(NHDlN+X*b%h>%DvfrLUPVGY zS!vW&%D6@rNJkzrK+kVZgabh&W2Q< zO5;5eQ^o)p-Xk#*t8#`U2sL;+Aq(U3y;9oIBy}!8F^G*#0bp!obk@lx^)V-HVmht4X&m}!;GE8;O2;w8Y4@r)PQd?ix;6%;}5xK}F8SG-djcUB7< z;1AV(hP-c<25d@coI$7o5@AEEqy#`9$Uati;($5+FMfzQX}HpQOMi&3`tJ?*;SA8v zB|7yjFjjxH-eQ%4B++0Hca?7Funlyz<-bRC%mFc6?GJO<=AO;HoBJv*3bR>;d=^?! zP=%!&e~43)x7iHds`jZe8Pzo;h#E?Ra5pCY4w9WU+F_ea}?dmqFx=bv#WLG<+C0 zmG;v@u+n~VxDU0yQvZ(u*C(|Q11tUykZ0^GqM-$|Bt_Y%)SoXmelHJzK>G*iacQ4VQ+ss&myg>jn@xDvf1GRB1f^p+d1w1IJp@yeMy_`MC3V zxp4=)N%S@2&vN6=D8w3fu7@3mNkF6$Z($XDhl!R~nBB|Gg-YYCO5>eML@DW5(`}InrYAwP4TBXIhOnSR% zDO#jfwX&<)%C3qhV>Cg!l(cy6HvhQ2C>V#(QZgBWEhw05d|H7$`}r&ICndGgdYQF! z<#EkW^}4xjbDuQ#DRZAT_Zf3-&aHph{4bdMvbnFAd&S(Zn)|A`ZWD#NnhhdV$lM$8wal2MGX@-`B4d(ADHyTRN+bGMj#y}3h@y3HU2C9Kr6i;Akh zxwTsAk`$Yv!Da-Mvny+g`ddg{6p|A#r)7C-ONcyHsiV81v$JA01nO7QRm5DS{x$N= zS&pyWD1(Kh-;0&H6z3OdO0<=gn@+BGWX^HDdvgyf14Lrb_>rvjw;2&ArK+-_IePhD3iRN9z_Tq$cmL(DTp%GBB& ztnfK0@eGQ)wgss!!H$$>8HfNh>wg%J%0*k4j>x#KKzw6c5370#)O=0|_+X)*vY16; z$1#o|G1Pm!(tOXP^;l(exPWrV+%kf&9OfT(2^a5piYZ4Uk&97ZY}^qGG*#B+b*}_B zw4s6l^gMOts5;PqR0)<*vr(aFH;8^>S<0AXf490`nLw$X8J9>8iMs_84eI6oeuA?@SRfoH60zPJcOM|cE%&j z;sCM02&h3MRaOF<_TXs@%VXupRz6nL{uFkN93oaW^D%uDLD4m4M_J|xp!gWu;o7We z^0O)eHphqZvBp!ChoUv~Y=uD~gwEPXW@YWm5u3g-oIP7>2Ps7yBCct1z z*?^8IV{EFmm4poHcBlr;1ioDu3DMQp3I=ueT}o;i&a-E223o| z&ir~zKVn!{KElc^KOiCfawkz|QI`k3En27exBWPVCd3w~vRsK)N%S@$+PcR7TK6(| zP?#SgBwY?~%S=Y?7qXGfr$S`&slc+zW7`nTYR3@1JsQA?bjocv19&wAG#J}Y#&OVo zQsFRLN-@?rZ{8+gt7_xcX355@u9`M&f^V9F)k>tO33ZIDR`@ZQgq!2;k2N&sB0@1) zbIuU*bQmh*kbH4f!WXj%Uo_O-i6o&kSsblKJh2oOn=7ztoXM2ZIMbEibZ2RDRnKKT zip-^G4fz;sUi03BQL}~HcH^~;q0t`lgpK!BCB)K@N!WNVBs{V@;gPO{N3drXdsuf2 z%WNq|@)j`PNc(>U3doD6&^yHR-*`?s@*iLVtvtlE>!2HR&N2d;Rdh3E(akxgg&2P$ z*3vxYQPUIk8+~Srpmdu@ zD#zeoupo?!>OrlFV1+F?XmWZpT9!02ZyUNCu~vPWwEue4-@v>hBaaaa&SKzT$@1-BH~*y;S!CfIPF z77Nx(7K6Z5?;T^@m7Cw7&T`{HbT3m(!P1%-GZ=DtYQ(TYs^&LHD8jae6wlmk$&rE%=)&|ryJ{$S;u>|ScVD3irHZ>a-u{~ZR z+X?CGLPURso^|Xm+?aFWfb3F$-5(uFLdh*y#vbh#v%ATDaSt5HVrZCR`)o}jQ)WRW zvChy2Ez6iA`a?^#SsDm7PVHfp=+1Rgty`~xa|PRoxV!Z#d#_)GCRem?hFl)&GXFG!p2JLlnkIkFeH;9nUzr=dLxU9!JL*BS_z`l^sMJ&Y)( zOWww%Ixd*a!pa%bop|Rn>KV_ z>$%=&=FoAk7y4pob8ngOiyW%aE~Q&|uLJT@DGPB+jyJZ1gkTvVt}(kK29`Wqt>D2X za`Afgg2|%RyWvxAZ>hB2MYfgO8?+GB>APP3Hf&|hMhxB2dY3qss0!tW>B<8f-RXc^={7!uAWk z5`9;@jIDP)9iX{N+stb1ISmact(B7o1-l*W)JE)#8w z$yond0>7 z?P{S$YWiR*GYf#xQDv)9qN((m_6yc=*l(@IEet0{Em8*=hc@&#I1oa2j7zjdsb$H8@x_JVfN?O=#yxtK;opIA>+ekhH3 z#!?qX`g3>ibP8Vq}rOAQ)Km_?+=Oj})wE8<;A!0Ct6_XQw1&pCL1zu| zWh$a5x5aW4PrFUNBiH;11`O4qJBd4=*y4&BB1LBir9MhCjKR(U4_{Okqyf=?5`CJK zg!d^46b|3wqp>x8t>imw&U4+q_;-Kop-@f zdJ`VM$|aw8=&$@_@95m_AKvxowSVz{G=K0P?l|)w{`EgT{ZoJRi?x6ELvz3Nk>C7h zzw}EdfB#c^UVrJKW54qEPJQIIbKm|yzqVuG%|k!?3;+73zOpp3?%tno9{k03zxa>8 z@AOCCy7jLXPyG1rY;Aq&%ZKoh^atPh++gy} zt-ttx-SBTqzq|D>{h6Qs2mkxu{7~n`pX|x!W?iSYb?-!9|EII>(XTV-**L-X@wYpZ zqC5XyJBzNHKDxuB6YTnzEhEDGyPH$iy1CMVkrI=!TW#hmjM}Nz3J={^5KMI1M{eEx5;nT~q~7q{e&V&3?Re`pg?uVkt=6ptzqO?v(7g(kP{Y-&o!|F8l2e5{^?@f2V z$Z=bDq%IBU0S&)2x$=d<59#*p>IVjUdAKU+9gvfg!ygXb-h?6Co7^ds(lj+M1_Hqs<={=^(r+*6PRry}C;IH5lZoNf0%8tT@?@kK>=uHN3W)#E- zfUQkVNzOVs>*Z{avqjEF<$O#IFD50uo8)YkvsKQAOapXg?!SJPx|sB;6IZ8Hb<6{{JJEMy?q0#4JL^s zzbWaZAxZD`a_VxDs+^=pPEO7s4rIXBD~C%M{W(rf=SsPCx%IgXxsADj+@@SPSHV2J zCAT&Aq1^Sk8*(4X4Pi0)Xs((&n7g}oqe?EzsaPEpO;PGbKyv!!u)gN{k(_mMHpt-+ zEJhYNTjX3P=fiS7BBv_nW;q{|^Km)b<$S-KPsq7V&WM~{a(2tvBWG03UOD^Z?3c69 zdl{G3-pL0fhjTaO?#!LYeJb~0?z-HEbKjS{Ikzo$OYUR2kLR}MZq0pv?i0D&awEB2 zx!t)vxzXI-+`ioY-kZqU`*AtETblH8*CpxYDYvAT+d4@vS9_CQZk8v#d*qDD;my#b zcb^>I1WkI!MOwMsR_sO|m&Zp!&AcuRyN$H8| z()(xR=*~{>895VjCgn`YnU+(N^RS$=a%SaxUd|(OxCNB-aw#e4Juhco&VrmT$l*Rx z(#tj8q<2})1v!t(c}&hlIlM%g^!}KfAD8pEoS%@x4eF%#C*?HcH08A9wB@E zWjVhf=NIMt6**WlECh43vjk4H2bE>b1leXiI5gN+8L`G=+{3rmVx^(O8r1nb`^3 zz-lt?gmbDwwe{AAV^T*dd%#W!+K&gUsV;LIE%0V%t4`#)KHuM`?@(X=M;o8a%R3^v zJr(;v-QA)iWH6yx##3AU(A=g}kIT6Yr*TETi;6fbpLM`j74aHQ`z1x3lJlw@`nyv9 ziXvX5Oda7;KUG@hRF&c(In#2^G8V>&Y`iY#RUhQogdG>QD1%2O2|FMXE za#j}D4ueW~7l#dNxb?wwj6DIxF@uxQPqR@&`-JuM3A`;F45adbW~BvbDlJj9^^}}f zg1XBr#Q=Y|iD1^dtBZl%J_J!E_MdSynw)h5{X3|m1zZ+W8_7J z+8(0(2!1Ad4lCa&C4!LUC#b9Z1hDcG^bVK86#JH;sly$*5SIpY|IG%tVlwyKM0$bP z;p@Z`aHguK`E^Up1c?&+{j?Zox4UB5*;`zpZ0$C~@|E`6CQc||EN+NFu}b@$P>@XT zY&Cc;?1lss{mr!6shFF+3>|_05!@n!od@7b{Tl*;$$mV5kSH**|;Ua~>kEJOigfrC{dU@s- z)4F``d{v6ZneG(TkiulY+q|xA?kd*zyjQ~-@2vql5=uvm+s?J-RUPu-{w}S$J|zfxXWf{$N zx)<1}dTV{caqPxZgF|SZZbjwb&-isoxIcFU0T6F100$8U%`+q<(=%AwJPJZ^%GZ7)_yAT> zCf11>=2IbI$9?=H)RYOZ#`6@$)7gZEdToR|6YaHOS`Uo3qbJR`k;k*;Kd9C%=Fm=;F z#ka?qkEXcK&hkFo2MGi~ACcl|3y-1^@i zB;P=h^L)0EP^yZf>nvwBRrA5;VI_eTxp+zv8c-l!&FN)R`G_{;kI{1_bpzuPwjHOGYzNlthb zC;T$)^8kb)$Me8YhxE$L7c3?Ex^78wJM~SN%ktL0MAGsdN-CGbbuX#-7ekewMFX8{L7kRHl#Na={MJOMDKZXI^2jpu!L)ufu0!{J1g(|p-O zPj3XFDD~PeTBXQ8^i|+0`=RyVZq?x@k9wHBi&7DE*qPQj^pbkEI0!_Cf=B~DTq#!7 zHzf8vSHK63xl#gdD36D3W?04kn@fE!Zmen%!dgIgPD|FW?}!6YPbm-Xy}E%E)}7*f z?f~aXr4JA0P4wJI40>L?>d6q!kx3)PDpv;1E}$w3PySa?K1~o~Npyw+gnjfVD@WA% z=yno!4q#88-XHLfcSSTWQ!P>li6f5C#l)*rYTTie_y>?*fd+B3RGQxVjZU#u5`T0AtFY4os`xxW z8^cXc-lvd!XuQ~I1V`bGJ&=2YVl=MERQ=mf$Fr&eU>(KkHFQ)%!d+)Z$b+xaXx~s} z&Y`2gRf;1w?Y*(A?bcx->p=}B^M@zI(A1nbD{a%UtM}D{-o+OUzfAn0+4~_RoHpGMoPP!DJ zvn~TFiIj*QhfLMHIhhrBNsmYV!5+O zqIA^8{WU9-5&5JwuAw%HylOZ!av^Y$L|A6%jxBIl!AOgNCVn@QHu~eYoR|Q~q$+qB zqpEZw)~n&a5`MNEhu z@q)9-E6ygcrR2{D)xe`(7NSa3!%=vK(0%0Nd_chay)2TA_X0wV_aZ{ES)*1_a}>Dx zNlfBCM2PW_3me)!D#{^Cm@70PwBK+_joHU$0&bjyC`u;)V!_jxi=Hdd^IlAInf8zv z^oL^HkrKLocVGwDJBCiz^KUFx(Cru0Rqd5!#LP$7ASd zo0vWDF|ToFhp@3MZw@73uwF#3)~4b?B%ny!lOi#U+Cq*PQlZW!@& zSk&06R>xKKGU-r6O=$AO35C-{551_ornk`=sc+OP^pOc3I3uwm!{Im)fY3;!OIBLf zTYT$!70{SgfKRAwIu?J{0EGBIMa*lyY#D9dz^HD4FUxJd>j-jf7|gl&_GRk!k&oYc zmC4AzbtWb2Ae0Sb)K^I>Bv}x`Q(kYSaan$D=jng*H_<@0`GBgTf^Lh(YR0kXH4N4J)&a@u*TSH3P0 zS6$X6BCD!#t6>@vL_8V?0{$AfUkeBa8TT?gKsuEY+G$iJT_~x!J^Du>jpg^nm5o51 zY7^^-bZCFlC}1b(V?K0oB&flvqN|dc+D3IqMAiCU<+Fk|6Dy#ZY+$jd0>s=!qgx0d z=TI3HN0BUj37F8fIut2Ah_u@+GCq(6YD5%!=qEWEBL2~BU7jW3u96li$C#5mh0wH#G;9F{aA`{>-X||j z!cfK1r4Wq^y|S<_B*#nF(EiJVQe)l!bjOd?Lhu1gQ+M@?l}ap^I*infx}|7VV~P)3 z`5vV5tP+Z5lOmOcQ;?>ZV#rxqZ=I*jFw8<4_$E>KSitIKgU13RLITx5o!{DG7`3)o z;FUCS_{4QvyXVd>7t zQucc0UIiLowLs&m7I@7AuPM-e$pY<{2t5LF3e>-1f%;c0@k5?i(?EsmU&=r2plJ)7^}t!h>!GcLC%AALR#fBFNF7_L zb4XGhG%yH-n05%t7et<(KBKz^EO?cBsG_T_wy&DP?p_;cX8AHXf$&x?2{aQX$lzNH zBDoWyf_NdyR45bAs;luzanlG#qqI^Em!m2p*!>*vTinUj#i*?#`JNkdgDarcT50@< z2U(MXFBp@sYD)&SU(|r%BeS3qrm2o-g;0N`sXuRWMjq4zRu}-o0z-O3 ztmzB0*vo{~hXslOe@e#FwSG?$#&@<=|ElXd*LKI`)iayra0oFJbeZ0a1j;#%b zV{1cE3I!B>(=`J;;1Sx5yfA|DN`QaICF?6sY;)u86WjU|ln<^fp&<5P*!IUBZ`3)q zVRCTW=80`Z+5O-bdV>>T!K)&|#7Gp05|9|=-+-s!B9mz-O2gwd_@CIeG1!ft*k;_E zNWcn?@P@$G?BpIs-e=b*T3ErL&tkU*Kiy%kKWieMRMz%EZ~LGg=8Vb^C;6Df=)Ccb zRbi=0II8fZk%DK5nqPOKTxC-?lBfB)`>Jg3db+dh@yh2nfYvACbgp!ix%UK3q80cm zby19Dr6G8g?y%}N0J1o=m}?%VYfTm>gkWphQ?(>t!{bS+NKs3&1&}47-&HX4W9xd0 zxgNjAyjK+ESY0`Bn1owJOHu?_lHAft=~w~dxb&`dPz60&Ae-4Vq$v353RYe#NItqx z^Wi{<T2DGd>$pcPv(46=UaDrb@pMc+*3`~!=kxfIUD3`q>nfqKgRzg zWn)qwP`CnOdgSWGb2XGHIo&P?}t$#DK{VP3(RE8!T|&iK?tH zu;)m-n$vo^)W`70${RCPU_!VK#gJEKIJQuKK3`!JKmiSb2xGhpA>qcR3yX7O5I8K87^&=xuV!NTc~fS(t4MV9Xp~s5!i$<1t50=vs*l= ziq0#$hthS8JLReCp zFbro>LQ##XS%S=0)Rc@!*C2*PG~5|i)uJ=&p!krBA8Hh(s8JO3E{V9;@P>t&7crs8 z{D#m`gV0WuvIE$n5t9XIGohRat4u0`bTX-=VkpTxoUa%}uKPYF6fsF)cXLu|wBGp; zZ8gEsddKhnxQn$0!dL`-U;!>Xfjv;umRes|`#29`lH(g5_=W|1PHfqn*t+U5S8X7? zYw>S8=xvGxXDG$sbPuw#<8O?0{5(C8rfJN<67}4}BF(%oKxJhW5h@1K$Zt91) zsUPA-zo})`KfNhTBA&w4iqy9*^=(Lf8#^UJ+?dCR8v_i6P9n9*Z3=2}@Vyg#a9|>l zz#ua=`lgyI*a8B@~aLgA39nMLwb?}WH@dz-T@QP_| zrz^tQhsM@!Wy5e|28Jw^)(B;xbK$YFs!U@Qh?GZ(q^>$XT~5d3Njlni$~;8s+?KkF zRGk_zw-L0I%$>OeT!xtmJ7tt&Jr$bbD9T!3uu3${R-?IAtJmXfGZ$NSaT7v4RoH z=_8LQ%aJL0(>7o24uWwe7V35dPjv-tS6c}5>n*AQ7Dtq?tHZ4kG%l1cyE7g>De7GR z6dL}fhmN21Y)^`Pdh5T4FWGTsS|lvH*j`-I~Q!W>p;nNmIB*K z4u@ETqg#zomK8DniZUHjrsfNH5fFqq&H>;KK^rg0d#9kS#F7oAc`pjedRp#naxsG| z%N-$wtoH#w-i}nN?G`_tmQXe5RY99?%HKF67Yn({nKsDPG_}>#xNLDxn)_wB&39vp zM%}^-a4|+WPhGNIQnEFxz8gVg|C^N>u*Kl;(H^Zt71%Z$%#q z-cUM*j#$rSmDbu|?%?{O24h%@!%dZAlw|E>9lD*#&=w6;hTWEw@AssSI+9<_aD3XIxE>LWJif1Uh1_Q5d^wD3puh(U;P% zZA`?}rd-Qu{6!15Ls)ZG%=t{}J4_npA9{=Nn@fsZdr3I5ljM@|{D(fXII(cw{Q0{t zPSqBcXXnq4pIw}PY>7*F-0ahTylJui`26|#orh{uvvb_m`dBWx>CpVbrN!BY&n{R0 z(O;|X9vK;{?%=a)top-~)w>^^nB}fjUrxC>NpwTXV^_nd#lT_fAfZ z?wFa_yJyGf=;ZDl6Z@tocZ}_w*;^YOo1U87JDMbosa(?dT&CWg7uDxS>_U;0YT_clI`$zXo?;e?&*t2J1^1$BxBU3Ze`^KgzW@c(e(FgWV?BBO% zvNpAMT8*3;*|nFl_ff(Akpt5Q2<_in8{0owt4&VKK;#LC{G(YSpO~KfuO$92OXB1I zmBjy$bG66j7azIp)3wDVri)KLI=XX& ziDY0)8g+PfX<=^S(tV^%ZpbB@A6%+ckDgnYUtE5mHd9-you8^PGn8`NAYQI3`!_C{Jj{e3ZZH!M>z=b6<*^rozqqeVo6aBkt!iaY{5OC-dI}Cl8LjZ?{?c zp4p2J)E4HKW|!v|FWo++iTn2X$ZKy9uzu~fVLd~JDjZTYJ))cyU#Ou8gFO}8DMn>#Mu;M~#_ zeOTK$JvSG#eESxP8SFVfztA_iSetmHFgHE1`0&n=@ZA-@yTf-6-?{lIi`Q52`YK-E zJ%y!ZkN5Ac5Z)cW%CGX5iuRq@xkQ8kLIH}P0FO{fOZ{`x=P%67mFA|WcFvCOJhzJ! z<{OEg6tX))_C(KU^z4nEebKW&dd8whRjFkEjM-<=LyKcQ(-#(c7UmavK7VeZcWPp8 zu20Tv&th%4cXDy(QfYE=W@2usM$;x2mlrSK>6@&5LGHume|TB`IrGoqFHWAX?YwYa z9ufr4a`2GMA*7TiKe<>474&=YJrv$UPX3mAD3-tFelN1$3*@8B{i@SG7Fv32c6sV7 zO`bhJy>nKiljlP8%!-BviJn=}&>+z>J4R<&_7JleV;0BgCdDk)W=c!T!B=!2l?Bi4 z=oyWkvEZSkkZr7IVtTq~>B3~sxeIeW)3cBE^G7=%__==mgw z2=&kyHF{!kk=D%B&VxB(?c4-it}m!Y--XmSyE}!YzS+?fmilHj2)&dTxtK;Sj;#xk zuoe6f(nZfMIL$%3Q{QOn8;d^53+X5?`f4+==!x@}A{1}Q`few_^&OJz>i92Y{Ik0= z@Qi!& zI;eHL7YdASMZkv{o?JM6``|ua*iH zAD)|CTJD)b0!=-<+|Qr*V+sMpA6{|$@_9N^LkAyW^7OmNhrzcghtJohca|QVpPN`lDcRY#JTW`BvmjD2R5m~ah9lD(i5RAnbB|aQ zUnIcJ0`ge{uzzXx$7=I4>zuI5=sFO7VtW4k+@+mK5?>&D`A?nx$@1^4`vJW>)?0u7 zcgPCA^`AcT+OPiZH-Bko`&Tyo>K|?VgSY?a^Y8qHpZ?e`uV{0sl2@YwygzP)?kFaEo}ciwvYrdNOY zKfL{i(+?fn@H4;u*Pq?~xyjpprFPr!fBKi7T>jkrj^F>oKl^9?=BC$v?vo!I`g4^- zwdt(;xcpPIEulsS`c$(Z4s4yi)qjo37-J z{pL;MXJ?nHs51|vV^*go&LcRhleOyNh4a;wIvEM7Sjjtb=>&^zK|Q=K>W_6wM~g2xT^F*()%})nR8QU zF6lXgVWVE(0G3txHwXm&`*+jqxtx+VsNh$s=-0ds#})6^y%*b5>Y~opk;Qg_%y(=j zc22EpeLJJw<=m#O@>cu!t>mpGT9n?&mqT-rM3F;8jxgZI>4x;xmKv?9s=! z{abL!=rz4L^5bGJyJwWmFfXsQ9!>*d8auyPW=Vyo9iLMW?GM@i_Yvzv@+-(^XRIckwnI<3h52fJpr<5zeyxDPLH=9NV(pBEnVp9=hEz m>yU%d1DU0u6LOc8SEtI>6JOR-v Player > Other Settings) + +Documentation: + https://mirror-networking.gitbook.io/docs/ + +Support: + Discord: https://discordapp.com/invite/N9QVxbM + Bug Reports: https://github.com/vis2k/Mirror/issues diff --git a/Assets/Mirror/Readme.txt.meta b/Assets/Mirror/Readme.txt.meta new file mode 100644 index 0000000..d52ccce --- /dev/null +++ b/Assets/Mirror/Readme.txt.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: f6d84e019c68446f28415a923b460a03 +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports.meta b/Assets/Mirror/Transports.meta new file mode 100644 index 0000000..72fd20d --- /dev/null +++ b/Assets/Mirror/Transports.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: d7d3068968d80427e8cc256e22b0b0b5 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP.meta b/Assets/Mirror/Transports/KCP.meta new file mode 100644 index 0000000..1727b05 --- /dev/null +++ b/Assets/Mirror/Transports/KCP.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: ea4ea5d03df6a49449fa679ac2390773 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/KcpTransport.cs b/Assets/Mirror/Transports/KCP/KcpTransport.cs new file mode 100644 index 0000000..1bb431f --- /dev/null +++ b/Assets/Mirror/Transports/KCP/KcpTransport.cs @@ -0,0 +1,366 @@ +//#if MIRROR <- commented out because MIRROR isn't defined on first import yet +using System; +using System.Linq; +using System.Net; +using UnityEngine; +using Mirror; +using Unity.Collections; +using UnityEngine.Serialization; + +namespace kcp2k +{ + [HelpURL("https://mirror-networking.gitbook.io/docs/transports/kcp-transport")] + [DisallowMultipleComponent] + public class KcpTransport : Transport, PortTransport + { + // scheme used by this transport + public const string Scheme = "kcp"; + + // common + [Header("Transport Configuration")] + [FormerlySerializedAs("Port")] + public ushort port = 7777; + public ushort Port { get => port; set => port=value; } + [Tooltip("DualMode listens to IPv6 and IPv4 simultaneously. Disable if the platform only supports IPv4.")] + public bool DualMode = true; + [Tooltip("NoDelay is recommended to reduce latency. This also scales better without buffers getting full.")] + public bool NoDelay = true; + [Tooltip("KCP internal update interval. 100ms is KCP default, but a lower interval is recommended to minimize latency and to scale to more networked entities.")] + public uint Interval = 10; + [Tooltip("KCP timeout in milliseconds. Note that KCP sends a ping automatically.")] + public int Timeout = 10000; + [Tooltip("Socket receive buffer size. Large buffer helps support more connections. Increase operating system socket buffer size limits if needed.")] + public int RecvBufferSize = 1024 * 1027 * 7; + [Tooltip("Socket send buffer size. Large buffer helps support more connections. Increase operating system socket buffer size limits if needed.")] + public int SendBufferSize = 1024 * 1027 * 7; + + [Header("Advanced")] + [Tooltip("KCP fastresend parameter. Faster resend for the cost of higher bandwidth. 0 in normal mode, 2 in turbo mode.")] + public int FastResend = 2; + [Tooltip("KCP congestion window. Restricts window size to reduce congestion. Results in only 2-3 MTU messages per Flush even on loopback. Best to keept his disabled.")] + /*public*/ bool CongestionWindow = false; // KCP 'NoCongestionWindow' is false by default. here we negate it for ease of use. + [Tooltip("KCP window size can be modified to support higher loads. This also increases max message size.")] + public uint ReceiveWindowSize = 4096; //Kcp.WND_RCV; 128 by default. Mirror sends a lot, so we need a lot more. + [Tooltip("KCP window size can be modified to support higher loads.")] + public uint SendWindowSize = 4096; //Kcp.WND_SND; 32 by default. Mirror sends a lot, so we need a lot more. + [Tooltip("KCP will try to retransmit lost messages up to MaxRetransmit (aka dead_link) before disconnecting.")] + public uint MaxRetransmit = Kcp.DEADLINK * 2; // default prematurely disconnects a lot of people (#3022). use 2x. + [Tooltip("Enable to automatically set client & server send/recv buffers to OS limit. Avoids issues with too small buffers under heavy load, potentially dropping connections. Increase the OS limit if this is still too small.")] + [FormerlySerializedAs("MaximizeSendReceiveBuffersToOSLimit")] + public bool MaximizeSocketBuffers = true; + + [Header("Allowed Max Message Sizes\nBased on Receive Window Size")] + [Tooltip("KCP reliable max message size shown for convenience. Can be changed via ReceiveWindowSize.")] + [ReadOnly] public int ReliableMaxMessageSize = 0; // readonly, displayed from OnValidate + [Tooltip("KCP unreliable channel max message size for convenience. Not changeable.")] + [ReadOnly] public int UnreliableMaxMessageSize = 0; // readonly, displayed from OnValidate + + // config is created from the serialized properties above. + // we can expose the config directly in the future. + // for now, let's not break people's old settings. + protected KcpConfig config; + + // use default MTU for this transport. + const int MTU = Kcp.MTU_DEF; + + // server & client + protected KcpServer server; + protected KcpClient client; + + // debugging + [Header("Debug")] + public bool debugLog; + // show statistics in OnGUI + public bool statisticsGUI; + // log statistics for headless servers that can't show them in GUI + public bool statisticsLog; + + // translate Kcp <-> Mirror channels + public static int FromKcpChannel(KcpChannel channel) => + channel == KcpChannel.Reliable ? Channels.Reliable : Channels.Unreliable; + + public static KcpChannel ToKcpChannel(int channel) => + channel == Channels.Reliable ? KcpChannel.Reliable : KcpChannel.Unreliable; + + public static TransportError ToTransportError(ErrorCode error) + { + switch(error) + { + case ErrorCode.DnsResolve: return TransportError.DnsResolve; + case ErrorCode.Timeout: return TransportError.Timeout; + case ErrorCode.Congestion: return TransportError.Congestion; + case ErrorCode.InvalidReceive: return TransportError.InvalidReceive; + case ErrorCode.InvalidSend: return TransportError.InvalidSend; + case ErrorCode.ConnectionClosed: return TransportError.ConnectionClosed; + case ErrorCode.Unexpected: return TransportError.Unexpected; + default: throw new InvalidCastException($"KCP: missing error translation for {error}"); + } + } + + protected virtual void Awake() + { + // logging + // Log.Info should use Debug.Log if enabled, or nothing otherwise + // (don't want to spam the console on headless servers) + if (debugLog) + Log.Info = Debug.Log; + else + Log.Info = _ => {}; + Log.Warning = Debug.LogWarning; + Log.Error = Debug.LogError; + + // create config from serialized settings + config = new KcpConfig(DualMode, RecvBufferSize, SendBufferSize, MTU, NoDelay, Interval, FastResend, CongestionWindow, SendWindowSize, ReceiveWindowSize, Timeout, MaxRetransmit); + + // client (NonAlloc version is not necessary anymore) + client = new KcpClient( + () => OnClientConnected.Invoke(), + (message, channel) => OnClientDataReceived.Invoke(message, FromKcpChannel(channel)), + () => OnClientDisconnected.Invoke(), + (error, reason) => OnClientError.Invoke(ToTransportError(error), reason), + config + ); + + // server + server = new KcpServer( + (connectionId) => OnServerConnected.Invoke(connectionId), + (connectionId, message, channel) => OnServerDataReceived.Invoke(connectionId, message, FromKcpChannel(channel)), + (connectionId) => OnServerDisconnected.Invoke(connectionId), + (connectionId, error, reason) => OnServerError.Invoke(connectionId, ToTransportError(error), reason), + config + ); + + if (statisticsLog) + InvokeRepeating(nameof(OnLogStatistics), 1, 1); + + Debug.Log("KcpTransport initialized!"); + } + + protected virtual void OnValidate() + { + // show max message sizes in inspector for convenience. + // 'config' isn't available in edit mode yet, so use MTU define. + ReliableMaxMessageSize = KcpPeer.ReliableMaxMessageSize(MTU, ReceiveWindowSize); + UnreliableMaxMessageSize = KcpPeer.UnreliableMaxMessageSize(MTU); + } + + // all except WebGL + public override bool Available() => + Application.platform != RuntimePlatform.WebGLPlayer; + + // client + public override bool ClientConnected() => client.connected; + public override void ClientConnect(string address) + { + client.Connect(address, Port); + } + public override void ClientConnect(Uri uri) + { + if (uri.Scheme != Scheme) + throw new ArgumentException($"Invalid url {uri}, use {Scheme}://host:port instead", nameof(uri)); + + int serverPort = uri.IsDefaultPort ? Port : uri.Port; + client.Connect(uri.Host, (ushort)serverPort); + } + public override void ClientSend(ArraySegment segment, int channelId) + { + client.Send(segment, ToKcpChannel(channelId)); + + // call event. might be null if no statistics are listening etc. + OnClientDataSent?.Invoke(segment, channelId); + } + public override void ClientDisconnect() => client.Disconnect(); + // process incoming in early update + public override void ClientEarlyUpdate() + { + // only process messages while transport is enabled. + // scene change messsages disable it to stop processing. + // (see also: https://github.com/vis2k/Mirror/pull/379) + if (enabled) client.TickIncoming(); + } + // process outgoing in late update + public override void ClientLateUpdate() => client.TickOutgoing(); + + // server + public override Uri ServerUri() + { + UriBuilder builder = new UriBuilder(); + builder.Scheme = Scheme; + builder.Host = Dns.GetHostName(); + builder.Port = Port; + return builder.Uri; + } + public override bool ServerActive() => server.IsActive(); + public override void ServerStart() => server.Start(Port); + public override void ServerSend(int connectionId, ArraySegment segment, int channelId) + { + server.Send(connectionId, segment, ToKcpChannel(channelId)); + + // call event. might be null if no statistics are listening etc. + OnServerDataSent?.Invoke(connectionId, segment, channelId); + } + public override void ServerDisconnect(int connectionId) => server.Disconnect(connectionId); + public override string ServerGetClientAddress(int connectionId) + { + IPEndPoint endPoint = server.GetClientEndPoint(connectionId); + return endPoint != null + // Map to IPv4 if "IsIPv4MappedToIPv6" + // "::ffff:127.0.0.1" -> "127.0.0.1" + ? (endPoint.Address.IsIPv4MappedToIPv6 + ? endPoint.Address.MapToIPv4().ToString() + : endPoint.Address.ToString()) + : ""; + } + public override void ServerStop() => server.Stop(); + public override void ServerEarlyUpdate() + { + // only process messages while transport is enabled. + // scene change messsages disable it to stop processing. + // (see also: https://github.com/vis2k/Mirror/pull/379) + if (enabled) server.TickIncoming(); + } + // process outgoing in late update + public override void ServerLateUpdate() => server.TickOutgoing(); + + // common + public override void Shutdown() {} + + // max message size + public override int GetMaxPacketSize(int channelId = Channels.Reliable) + { + // switch to kcp channel. + // unreliable or reliable. + // default to reliable just to be sure. + switch (channelId) + { + case Channels.Unreliable: + return KcpPeer.UnreliableMaxMessageSize(config.Mtu); + default: + return KcpPeer.ReliableMaxMessageSize(config.Mtu, ReceiveWindowSize); + } + } + + // kcp reliable channel max packet size is MTU * WND_RCV + // this allows 144kb messages. but due to head of line blocking, all + // other messages would have to wait until the maxed size one is + // delivered. batching 144kb messages each time would be EXTREMELY slow + // and fill the send queue nearly immediately when using it over the + // network. + // => instead we always use MTU sized batches. + // => people can still send maxed size if needed. + public override int GetBatchThreshold(int channelId) => + KcpPeer.UnreliableMaxMessageSize(config.Mtu); + + // server statistics + // LONG to avoid int overflows with connections.Sum. + // see also: https://github.com/vis2k/Mirror/pull/2777 + public long GetAverageMaxSendRate() => + server.connections.Count > 0 + ? server.connections.Values.Sum(conn => conn.peer.MaxSendRate) / server.connections.Count + : 0; + public long GetAverageMaxReceiveRate() => + server.connections.Count > 0 + ? server.connections.Values.Sum(conn => conn.peer.MaxReceiveRate) / server.connections.Count + : 0; + long GetTotalSendQueue() => + server.connections.Values.Sum(conn => conn.peer.SendQueueCount); + long GetTotalReceiveQueue() => + server.connections.Values.Sum(conn => conn.peer.ReceiveQueueCount); + long GetTotalSendBuffer() => + server.connections.Values.Sum(conn => conn.peer.SendBufferCount); + long GetTotalReceiveBuffer() => + server.connections.Values.Sum(conn => conn.peer.ReceiveBufferCount); + + // PrettyBytes function from DOTSNET + // pretty prints bytes as KB/MB/GB/etc. + // long to support > 2GB + // divides by floats to return "2.5MB" etc. + public static string PrettyBytes(long bytes) + { + // bytes + if (bytes < 1024) + return $"{bytes} B"; + // kilobytes + else if (bytes < 1024L * 1024L) + return $"{(bytes / 1024f):F2} KB"; + // megabytes + else if (bytes < 1024 * 1024L * 1024L) + return $"{(bytes / (1024f * 1024f)):F2} MB"; + // gigabytes + return $"{(bytes / (1024f * 1024f * 1024f)):F2} GB"; + } + + protected virtual void OnGUIStatistics() + { + GUILayout.BeginArea(new Rect(5, 110, 300, 300)); + + if (ServerActive()) + { + GUILayout.BeginVertical("Box"); + GUILayout.Label("SERVER"); + GUILayout.Label($" connections: {server.connections.Count}"); + GUILayout.Label($" MaxSendRate (avg): {PrettyBytes(GetAverageMaxSendRate())}/s"); + GUILayout.Label($" MaxRecvRate (avg): {PrettyBytes(GetAverageMaxReceiveRate())}/s"); + GUILayout.Label($" SendQueue: {GetTotalSendQueue()}"); + GUILayout.Label($" ReceiveQueue: {GetTotalReceiveQueue()}"); + GUILayout.Label($" SendBuffer: {GetTotalSendBuffer()}"); + GUILayout.Label($" ReceiveBuffer: {GetTotalReceiveBuffer()}"); + GUILayout.EndVertical(); + } + + if (ClientConnected()) + { + GUILayout.BeginVertical("Box"); + GUILayout.Label("CLIENT"); + GUILayout.Label($" MaxSendRate: {PrettyBytes(client.peer.MaxSendRate)}/s"); + GUILayout.Label($" MaxRecvRate: {PrettyBytes(client.peer.MaxReceiveRate)}/s"); + GUILayout.Label($" SendQueue: {client.peer.SendQueueCount}"); + GUILayout.Label($" ReceiveQueue: {client.peer.ReceiveQueueCount}"); + GUILayout.Label($" SendBuffer: {client.peer.SendBufferCount}"); + GUILayout.Label($" ReceiveBuffer: {client.peer.ReceiveBufferCount}"); + GUILayout.EndVertical(); + } + + GUILayout.EndArea(); + } + +// OnGUI allocates even if it does nothing. avoid in release. +#if UNITY_EDITOR || DEVELOPMENT_BUILD + protected virtual void OnGUI() + { + if (statisticsGUI) OnGUIStatistics(); + } +#endif + + protected virtual void OnLogStatistics() + { + if (ServerActive()) + { + string log = "kcp SERVER @ time: " + NetworkTime.localTime + "\n"; + log += $" connections: {server.connections.Count}\n"; + log += $" MaxSendRate (avg): {PrettyBytes(GetAverageMaxSendRate())}/s\n"; + log += $" MaxRecvRate (avg): {PrettyBytes(GetAverageMaxReceiveRate())}/s\n"; + log += $" SendQueue: {GetTotalSendQueue()}\n"; + log += $" ReceiveQueue: {GetTotalReceiveQueue()}\n"; + log += $" SendBuffer: {GetTotalSendBuffer()}\n"; + log += $" ReceiveBuffer: {GetTotalReceiveBuffer()}\n\n"; + Debug.Log(log); + } + + if (ClientConnected()) + { + string log = "kcp CLIENT @ time: " + NetworkTime.localTime + "\n"; + log += $" MaxSendRate: {PrettyBytes(client.peer.MaxSendRate)}/s\n"; + log += $" MaxRecvRate: {PrettyBytes(client.peer.MaxReceiveRate)}/s\n"; + log += $" SendQueue: {client.peer.SendQueueCount}\n"; + log += $" ReceiveQueue: {client.peer.ReceiveQueueCount}\n"; + log += $" SendBuffer: {client.peer.SendBufferCount}\n"; + log += $" ReceiveBuffer: {client.peer.ReceiveBufferCount}\n\n"; + Debug.Log(log); + } + } + + public override string ToString() => "KCP"; + } +} +//#endif MIRROR <- commented out because MIRROR isn't defined on first import yet diff --git a/Assets/Mirror/Transports/KCP/KcpTransport.cs.meta b/Assets/Mirror/Transports/KCP/KcpTransport.cs.meta new file mode 100644 index 0000000..f7280c8 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/KcpTransport.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6b0fecffa3f624585964b0d0eb21b18e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k.meta b/Assets/Mirror/Transports/KCP/kcp2k.meta new file mode 100644 index 0000000..1dceadf --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 71a1c8e8c022d4731a481c1808f37e5d +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/KCP.asmdef b/Assets/Mirror/Transports/KCP/kcp2k/KCP.asmdef new file mode 100644 index 0000000..66d2148 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/KCP.asmdef @@ -0,0 +1,16 @@ +{ + "name": "kcp2k", + "rootNamespace": "", + "references": [ + "GUID:30817c1a0e6d646d99c048fc403f5979" + ], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": true, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/KCP.asmdef.meta b/Assets/Mirror/Transports/KCP/kcp2k/KCP.asmdef.meta new file mode 100644 index 0000000..1d70e80 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/KCP.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 6806a62c384838046a3c66c44f06d75f +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/LICENSE.txt b/Assets/Mirror/Transports/KCP/kcp2k/LICENSE.txt new file mode 100644 index 0000000..c77582e --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/LICENSE.txt @@ -0,0 +1,24 @@ +MIT License + +Copyright (c) 2016 limpo1989 +Copyright (c) 2020 Paul Pacheco +Copyright (c) 2020 Lymdun +Copyright (c) 2020 vis2k + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/LICENSE.txt.meta b/Assets/Mirror/Transports/KCP/kcp2k/LICENSE.txt.meta new file mode 100644 index 0000000..49dc767 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/LICENSE.txt.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 9a3e8369060cf4e94ac117603de47aa6 +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/VERSION.txt b/Assets/Mirror/Transports/KCP/kcp2k/VERSION.txt new file mode 100644 index 0000000..40a9bd0 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/VERSION.txt @@ -0,0 +1,238 @@ +V1.37 [2023-07-31] +- fix: #47 KcpServer.Stop now clears connections so they aren't carried over to the next session +- fix: KcpPeer doesn't log 'received unreliable message while not authenticated' anymore. + +V1.36 [2023-06-08] +- fix: #49 KcpPeer.RawInput message size check now considers cookie as well +- kcp.cs cleanups + +V1.35 [2023-04-05] +- fix: KcpClients now need to validate with a secure cookie in order to protect against + UDP spoofing. fixes: + https://github.com/MirrorNetworking/Mirror/issues/3286 + [disclosed by IncludeSec] +- KcpClient/Server: change callbacks to protected so inheriting classes can use them too +- KcpClient/Server: change config visibility to protected + +V1.34 [2023-03-15] +- Send/SendTo/Receive/ReceiveFrom NonBlocking extensions. + to encapsulate WouldBlock allocations, exceptions, etc. + allows for reuse when overwriting KcpServer/Client (i.e. for relays). + +V1.33 [2023-03-14] +- perf: KcpServer/Client RawReceive now call socket.Poll to avoid non-blocking + socket's allocating a new SocketException in case they WouldBlock. + fixes https://github.com/MirrorNetworking/Mirror/issues/3413 +- perf: KcpServer/Client RawSend now call socket.Poll to avoid non-blocking + socket's allocating a new SocketException in case they WouldBlock. + fixes https://github.com/MirrorNetworking/Mirror/issues/3413 + +V1.32 [2023-03-12] +- fix: KcpPeer RawInput now doesn't disconnect in case of random internet noise + +V1.31 [2023-03-05] +- KcpClient: Tick/Incoming/Outgoing can now be overwritten (virtual) +- breaking: KcpClient now takes KcpConfig in constructor instead of in Connect. + cleaner, and prepares for KcpConfig.MTU setting. +- KcpConfig now includes MTU; KcpPeer now works with KcpConfig's MTU, KcpServer/Client + buffers are now created with config's MTU. + +V1.30 [2023-02-20] +- fix: set send/recv buffer sizes directly instead of iterating to find the limit. + fixes: https://github.com/MirrorNetworking/Mirror/issues/3390 +- fix: server & client sockets are now always non-blocking to ensure main thread never + blocks on socket.recv/send. Send() now also handles WouldBlock. +- fix: socket.Receive/From directly with non-blocking sockets and handle WouldBlock, + instead of socket.Poll. faster, more obvious, and fixes Poll() looping forever while + socket is in error state. fixes: https://github.com/MirrorNetworking/Mirror/issues/2733 + +V1.29 [2023-01-28] +- fix: KcpServer.CreateServerSocket now handles NotSupportedException when setting DualMode + https://github.com/MirrorNetworking/Mirror/issues/3358 + +V1.28 [2023-01-28] +- fix: KcpClient.Connect now resolves hostname before creating peer + https://github.com/MirrorNetworking/Mirror/issues/3361 + +V1.27 [2023-01-08] +- KcpClient.Connect: invoke own events directly instead of going through peer, + which calls our own events anyway +- fix: KcpPeer/Client/Server callbacks are readonly and assigned in constructor + to ensure they are safe to use at all times. + fixes https://github.com/MirrorNetworking/Mirror/issues/3337 + +V1.26 [2022-12-22] +- KcpPeer.RawInput: fix compile error in old Unity Mono versions +- fix: KcpServer sets up a new connection's OnError immediately. + fixes KcpPeer throwing NullReferenceException when attempting to call OnError + after authentication errors. +- improved log messages + +V1.25 [2022-12-14] +- breaking: removed where-allocation. use IL2CPP on servers instead. +- breaking: KcpConfig to simplify configuration +- high level cleanups + +V1.24 [2022-12-14] +- KcpClient: fixed NullReferenceException when connection without a server. + added test coverage to ensure this never happens again. + +V1.23 [2022-12-07] +- KcpClient: rawReceiveBuffer exposed +- fix: KcpServer RawSend uses connection.remoteEndPoint instead of the helper + 'newClientEP'. fixes clients receiving the wrong messages meant for others. + https://github.com/MirrorNetworking/Mirror/issues/3296 + +V1.22 [2022-11-30] +- high level refactor, part two. + +V1.21 [2022-11-24] +- high level refactor, part one. + - KcpPeer instead of KcpConnection, KcpClientConnection, KcpServerConnection + - RawSend/Receive can now easily be overwritten in KcpClient/Server. + for non-alloc, relays, etc. + +V1.20 [2022-11-22] +- perf: KcpClient receive allocation was removed entirely. + reduces Mirror benchmark client sided allocations from 4.9 KB / 1.7 KB (non-alloc) to 0B. +- fix: KcpConnection.Disconnect does not check socket.Connected anymore. + UDP sockets don't have a connection. + fixes Disconnects not being sent to clients in netcore. +- KcpConnection.SendReliable: added OnError instead of logs + +V1.19 [2022-05-12] +- feature: OnError ErrorCodes + +V1.18 [2022-05-08] +- feature: OnError to allow higher level to show popups etc. +- feature: KcpServer.GetClientAddress is now GetClientEndPoint in order to + expose more details +- ResolveHostname: include exception in log for easier debugging +- fix: KcpClientConnection.RawReceive now logs the SocketException even if + it was expected. makes debugging easier. +- fix: KcpServer.TickIncoming now logs the SocketException even if it was + expected. makes debugging easier. +- fix: KcpClientConnection.RawReceive now calls Disconnect() if the other end + has closed the connection. better than just remaining in a state with unusable + sockets. + +V1.17 [2022-01-09] +- perf: server/client MaximizeSendReceiveBuffersToOSLimit option to set send/recv + buffer sizes to OS limit. avoids drops due to small buffers under heavy load. + +V1.16 [2022-01-06] +- fix: SendUnreliable respects ArraySegment.Offset +- fix: potential bug with negative length (see PR #2) +- breaking: removed pause handling because it's not necessary for Mirror anymore + +V1.15 [2021-12-11] +- feature: feature: MaxRetransmits aka dead_link now configurable +- dead_link disconnect message improved to show exact retransmit count + +V1.14 [2021-11-30] +- fix: Send() now throws an exception for messages which require > 255 fragments +- fix: ReliableMaxMessageSize is now limited to messages which require <= 255 fragments + +V1.13 [2021-11-28] +- fix: perf: uncork max message size from 144 KB to as much as we want based on + receive window size. + fixes https://github.com/vis2k/kcp2k/issues/22 + fixes https://github.com/skywind3000/kcp/pull/291 +- feature: OnData now includes channel it was received on + +V1.12 [2021-07-16] +- Tests: don't depend on Unity anymore +- fix: #26 - Kcp now catches exception if host couldn't be resolved, and calls + OnDisconnected to let the user now. +- fix: KcpServer.DualMode is now configurable in the constructor instead of + using #if UNITY_SWITCH. makes it run on all other non dual mode platforms too. +- fix: where-allocation made optional via virtuals and inheriting + KcpServer/Client/Connection NonAlloc classes. fixes a bug where some platforms + might not support where-allocation. + +V1.11 rollback [2021-06-01] +- perf: Segment MemoryStream initial capacity set to MTU to avoid early runtime + resizing/allocations + +V1.10 [2021-05-28] +- feature: configurable Timeout +- allocations explained with comments (C# ReceiveFrom / IPEndPoint.GetHashCode) +- fix: #17 KcpConnection.ReceiveNextReliable now assigns message default so it + works in .net too +- fix: Segment pool is not static anymore. Each kcp instance now has it's own + Pool. fixes #18 concurrency issues + +V1.9 [2021-03-02] +- Tick() split into TickIncoming()/TickOutgoing() to use in Mirror's new update + functions. allows to minimize latency. + => original Tick() is still supported for convenience. simply processes both! + +V1.8 [2021-02-14] +- fix: Unity IPv6 errors on Nintendo Switch +- fix: KcpConnection now disconnects if data message was received without content. + previously it would call OnData with an empty ArraySegment, causing all kinds of + weird behaviour in Mirror/DOTSNET. Added tests too. +- fix: KcpConnection.SendData: don't allow sending empty messages anymore. disconnect + and log a warning to make it completely obvious. + +V1.7 [2021-01-13] +- fix: unreliable messages reset timeout now too +- perf: KcpConnection OnCheckEnabled callback changed to a simple 'paused' boolean. + This is faster than invoking a Func every time and allows us to fix #8 more + easily later by calling .Pause/.Unpause from OnEnable/OnDisable in MirrorTransport. +- fix #8: Unpause now resets timeout to fix a bug where Mirror would pause kcp, + change the scene which took >10s, then unpause and kcp would detect the lack of + any messages for >10s as timeout. Added test to make sure it never happens again. +- MirrorTransport: statistics logging for headless servers +- Mirror Transport: Send/Receive window size increased once more from 2048 to 4096. + +V1.6 [2021-01-10] +- Unreliable channel added! +- perf: KcpHeader byte added to every kcp message to indicate + Handshake/Data/Ping/Disconnect instead of scanning each message for Hello/Byte/Ping + content via SegmentEquals. It's a lot cleaner, should be faster and should avoid + edge cases where a message content would equal Hello/Ping/Bye sequence accidentally. +- Kcp.Input: offset moved to parameters for cases where it's needed +- Kcp.SetMtu from original Kcp.c + +V1.5 [2021-01-07] +- KcpConnection.MaxSend/ReceiveRate calculation based on the article +- MirrorTransport: large send/recv window size defaults to avoid high latencies caused + by packets not being processed fast enough +- MirrorTransport: show MaxSend/ReceiveRate in debug gui +- MirrorTransport: don't Log.Info to console in headless mode if debug log is disabled + +V1.4 [2020-11-27] +- fix: OnCheckEnabled added. KcpConnection message processing while loop can now + be interrupted immediately. fixes Mirror Transport scene changes which need to stop + processing any messages immediately after a scene message) +- perf: Mirror KcpTransport: FastResend enabled by default. turbo mode according to: + https://github.com/skywind3000/kcp/blob/master/README.en.md#protocol-configuration +- perf: Mirror KcpTransport: CongestionControl disabled by default (turbo mode) + +V1.3 [2020-11-17] +- Log.Info/Warning/Error so logging doesn't depend on UnityEngine anymore +- fix: Server.Tick catches SocketException which happens if Android client is killed +- MirrorTransport: debugLog option added that can be checked in Unity Inspector +- Utils.Clamp so Kcp.cs doesn't depend on UnityEngine +- Utils.SegmentsEqual: use Linq SequenceEqual so it doesn't depend on UnityEngine +=> kcp2k can now be used in any C# project even without Unity + +V1.2 [2020-11-10] +- more tests added +- fix: raw receive buffers are now all of MTU size +- fix: raw receive detects error where buffer was too small for msgLength and + result in excess data being dropped silently +- KcpConnection.MaxMessageSize added for use in high level +- KcpConnection.MaxMessageSize increased from 1200 bytes to to maximum allowed + message size of 145KB for kcp (based on mtu, overhead, wnd_rcv) + +V1.1 [2020-10-30] +- high level cleanup, fixes, improvements + +V1.0 [2020-10-22] +- Kcp.cs now mirrors original Kcp.c behaviour + (this fixes dozens of bugs) + +V0.1 +- initial kcp-csharp based version \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/VERSION.txt.meta b/Assets/Mirror/Transports/KCP/kcp2k/VERSION.txt.meta new file mode 100644 index 0000000..2a07daa --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/VERSION.txt.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: ed3f2cf1bbf1b4d53a6f2c103d311f71 +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty.meta b/Assets/Mirror/Transports/KCP/kcp2k/empty.meta new file mode 100644 index 0000000..ae61673 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: d9ce2267cb8a4a1c9632025287e8da88 +timeCreated: 1669162433 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnection.cs b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnection.cs new file mode 100644 index 0000000..7926893 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnection.cs @@ -0,0 +1 @@ +// removed 2022-11-23 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnection.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnection.cs.meta new file mode 100644 index 0000000..3369918 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnection.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 96512e74aa8214a6faa8a412a7a07877 +timeCreated: 1602601237 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnectionNonAlloc.cs b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnectionNonAlloc.cs new file mode 100644 index 0000000..8c3864d --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnectionNonAlloc.cs @@ -0,0 +1 @@ +// removed 2022-11-22 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnectionNonAlloc.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnectionNonAlloc.cs.meta new file mode 100644 index 0000000..9d4a42e --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientConnectionNonAlloc.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 4c1b235bbe054706bef6d092f361006e +timeCreated: 1626430539 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientNonAlloc.cs b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientNonAlloc.cs new file mode 100644 index 0000000..8c3864d --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientNonAlloc.cs @@ -0,0 +1 @@ +// removed 2022-11-22 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientNonAlloc.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientNonAlloc.cs.meta new file mode 100644 index 0000000..266dafb --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpClientNonAlloc.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 2cf0ccf7d551480bb5af08fcbe169f84 +timeCreated: 1626435264 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerConnectionNonAlloc.cs b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerConnectionNonAlloc.cs new file mode 100644 index 0000000..7926893 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerConnectionNonAlloc.cs @@ -0,0 +1 @@ +// removed 2022-11-23 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerConnectionNonAlloc.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerConnectionNonAlloc.cs.meta new file mode 100644 index 0000000..383fe02 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerConnectionNonAlloc.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 4e1b74cc224b4c83a0f6c8d8da9090ab +timeCreated: 1626430608 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerNonAlloc.cs b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerNonAlloc.cs new file mode 100644 index 0000000..4623b53 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerNonAlloc.cs @@ -0,0 +1 @@ +// removed 2022-12-13 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerNonAlloc.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerNonAlloc.cs.meta new file mode 100644 index 0000000..a878cc1 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/empty/KcpServerNonAlloc.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 54b8398dcd544c8a93bcad846214cc40 +timeCreated: 1626432191 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel.meta new file mode 100644 index 0000000..1c11c3d --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 5a54d18b954cb4407a28b633fc32ea6d +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Common.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Common.cs new file mode 100644 index 0000000..ea5140f --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Common.cs @@ -0,0 +1,75 @@ +using System; +using System.Net; +using System.Net.Sockets; +using System.Security.Cryptography; + +namespace kcp2k +{ + public static class Common + { + // helper function to resolve host to IPAddress + public static bool ResolveHostname(string hostname, out IPAddress[] addresses) + { + try + { + // NOTE: dns lookup is blocking. this can take a second. + addresses = Dns.GetHostAddresses(hostname); + return addresses.Length >= 1; + } + catch (SocketException exception) + { + Log.Info($"Failed to resolve host: {hostname} reason: {exception}"); + addresses = null; + return false; + } + } + + // if connections drop under heavy load, increase to OS limit. + // if still not enough, increase the OS limit. + public static void ConfigureSocketBuffers(Socket socket, int recvBufferSize, int sendBufferSize) + { + // log initial size for comparison. + // remember initial size for log comparison + int initialReceive = socket.ReceiveBufferSize; + int initialSend = socket.SendBufferSize; + + // set to configured size + try + { + socket.ReceiveBufferSize = recvBufferSize; + socket.SendBufferSize = sendBufferSize; + } + catch (SocketException) + { + Log.Warning($"Kcp: failed to set Socket RecvBufSize = {recvBufferSize} SendBufSize = {sendBufferSize}"); + } + + + Log.Info($"Kcp: RecvBuf = {initialReceive}=>{socket.ReceiveBufferSize} ({socket.ReceiveBufferSize/initialReceive}x) SendBuf = {initialSend}=>{socket.SendBufferSize} ({socket.SendBufferSize/initialSend}x)"); + } + + // generate a connection hash from IP+Port. + // + // NOTE: IPEndPoint.GetHashCode() allocates. + // it calls m_Address.GetHashCode(). + // m_Address is an IPAddress. + // GetHashCode() allocates for IPv6: + // https://github.com/mono/mono/blob/bdd772531d379b4e78593587d15113c37edd4a64/mcs/class/referencesource/System/net/System/Net/IPAddress.cs#L699 + // + // => using only newClientEP.Port wouldn't work, because + // different connections can have the same port. + public static int ConnectionHash(EndPoint endPoint) => + endPoint.GetHashCode(); + + // cookies need to be generated with a secure random generator. + // we don't want them to be deterministic / predictable. + // RNG is cached to avoid runtime allocations. + static readonly RNGCryptoServiceProvider cryptoRandom = new RNGCryptoServiceProvider(); + static readonly byte[] cryptoRandomBuffer = new byte[4]; + public static uint GenerateCookie() + { + cryptoRandom.GetBytes(cryptoRandomBuffer); + return BitConverter.ToUInt32(cryptoRandomBuffer, 0); + } + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Common.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Common.cs.meta new file mode 100644 index 0000000..e349d86 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Common.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 9ced451c2954435f88cf718bcba020cb +timeCreated: 1669135138 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/ErrorCode.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/ErrorCode.cs new file mode 100644 index 0000000..15b872f --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/ErrorCode.cs @@ -0,0 +1,15 @@ +// kcp specific error codes to allow for error switching, localization, +// translation to Mirror errors, etc. +namespace kcp2k +{ + public enum ErrorCode : byte + { + DnsResolve, // failed to resolve a host name + Timeout, // ping timeout or dead link + Congestion, // more messages than transport / network can process + InvalidReceive, // recv invalid packet (possibly intentional attack) + InvalidSend, // user tried to send invalid data + ConnectionClosed, // connection closed voluntarily or lost involuntarily + Unexpected // unexpected error / exception, requires fix. + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/ErrorCode.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/ErrorCode.cs.meta new file mode 100644 index 0000000..42f163f --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/ErrorCode.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 3abbeffc1d794f11a45b7fcf110353f5 +timeCreated: 1652320712 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Extensions.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Extensions.cs new file mode 100644 index 0000000..20725a9 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Extensions.cs @@ -0,0 +1,166 @@ +using System; +using System.Net; +using System.Net.Sockets; + +namespace kcp2k +{ + public static class Extensions + { + // ArraySegment as HexString for convenience + public static string ToHexString(this ArraySegment segment) => + BitConverter.ToString(segment.Array, segment.Offset, segment.Count); + + // non-blocking UDP send. + // allows for reuse when overwriting KcpServer/Client (i.e. for relays). + // => wrapped with Poll to avoid WouldBlock allocating new SocketException. + // => wrapped with try-catch to ignore WouldBlock exception. + // make sure to set socket.Blocking = false before using this! + public static bool SendToNonBlocking(this Socket socket, ArraySegment data, EndPoint remoteEP) + { + try + { + // when using non-blocking sockets, SendTo may return WouldBlock. + // in C#, WouldBlock throws a SocketException, which is expected. + // unfortunately, creating the SocketException allocates in C#. + // let's poll first to avoid the WouldBlock allocation. + // note that this entirely to avoid allocations. + // non-blocking UDP doesn't need Poll in other languages. + // and the code still works without the Poll call. + if (!socket.Poll(0, SelectMode.SelectWrite)) return false; + + // send to the the endpoint. + // do not send to 'newClientEP', as that's always reused. + // fixes https://github.com/MirrorNetworking/Mirror/issues/3296 + socket.SendTo(data.Array, data.Offset, data.Count, SocketFlags.None, remoteEP); + return true; + } + catch (SocketException e) + { + // for non-blocking sockets, SendTo may throw WouldBlock. + // in that case, simply drop the message. it's UDP, it's fine. + if (e.SocketErrorCode == SocketError.WouldBlock) return false; + + // otherwise it's a real socket error. throw it. + throw; + } + } + + // non-blocking UDP send. + // allows for reuse when overwriting KcpServer/Client (i.e. for relays). + // => wrapped with Poll to avoid WouldBlock allocating new SocketException. + // => wrapped with try-catch to ignore WouldBlock exception. + // make sure to set socket.Blocking = false before using this! + public static bool SendNonBlocking(this Socket socket, ArraySegment data) + { + try + { + // when using non-blocking sockets, SendTo may return WouldBlock. + // in C#, WouldBlock throws a SocketException, which is expected. + // unfortunately, creating the SocketException allocates in C#. + // let's poll first to avoid the WouldBlock allocation. + // note that this entirely to avoid allocations. + // non-blocking UDP doesn't need Poll in other languages. + // and the code still works without the Poll call. + if (!socket.Poll(0, SelectMode.SelectWrite)) return false; + + // SendTo allocates. we used bound Send. + socket.Send(data.Array, data.Offset, data.Count, SocketFlags.None); + return true; + } + catch (SocketException e) + { + // for non-blocking sockets, SendTo may throw WouldBlock. + // in that case, simply drop the message. it's UDP, it's fine. + if (e.SocketErrorCode == SocketError.WouldBlock) return false; + + // otherwise it's a real socket error. throw it. + throw; + } + } + + // non-blocking UDP receive. + // allows for reuse when overwriting KcpServer/Client (i.e. for relays). + // => wrapped with Poll to avoid WouldBlock allocating new SocketException. + // => wrapped with try-catch to ignore WouldBlock exception. + // make sure to set socket.Blocking = false before using this! + public static bool ReceiveFromNonBlocking(this Socket socket, byte[] recvBuffer, out ArraySegment data, ref EndPoint remoteEP) + { + data = default; + + try + { + // when using non-blocking sockets, ReceiveFrom may return WouldBlock. + // in C#, WouldBlock throws a SocketException, which is expected. + // unfortunately, creating the SocketException allocates in C#. + // let's poll first to avoid the WouldBlock allocation. + // note that this entirely to avoid allocations. + // non-blocking UDP doesn't need Poll in other languages. + // and the code still works without the Poll call. + if (!socket.Poll(0, SelectMode.SelectRead)) return false; + + // NOTE: ReceiveFrom allocates. + // we pass our IPEndPoint to ReceiveFrom. + // receive from calls newClientEP.Create(socketAddr). + // IPEndPoint.Create always returns a new IPEndPoint. + // https://github.com/mono/mono/blob/f74eed4b09790a0929889ad7fc2cf96c9b6e3757/mcs/class/System/System.Net.Sockets/Socket.cs#L1761 + // + // throws SocketException if datagram was larger than buffer. + // https://learn.microsoft.com/en-us/dotnet/api/system.net.sockets.socket.receive?view=net-6.0 + int size = socket.ReceiveFrom(recvBuffer, 0, recvBuffer.Length, SocketFlags.None, ref remoteEP); + data = new ArraySegment(recvBuffer, 0, size); + return true; + } + catch (SocketException e) + { + // for non-blocking sockets, Receive throws WouldBlock if there is + // no message to read. that's okay. only log for other errors. + if (e.SocketErrorCode == SocketError.WouldBlock) return false; + + // otherwise it's a real socket error. throw it. + throw; + } + } + + // non-blocking UDP receive. + // allows for reuse when overwriting KcpServer/Client (i.e. for relays). + // => wrapped with Poll to avoid WouldBlock allocating new SocketException. + // => wrapped with try-catch to ignore WouldBlock exception. + // make sure to set socket.Blocking = false before using this! + public static bool ReceiveNonBlocking(this Socket socket, byte[] recvBuffer, out ArraySegment data) + { + data = default; + + try + { + // when using non-blocking sockets, ReceiveFrom may return WouldBlock. + // in C#, WouldBlock throws a SocketException, which is expected. + // unfortunately, creating the SocketException allocates in C#. + // let's poll first to avoid the WouldBlock allocation. + // note that this entirely to avoid allocations. + // non-blocking UDP doesn't need Poll in other languages. + // and the code still works without the Poll call. + if (!socket.Poll(0, SelectMode.SelectRead)) return false; + + // ReceiveFrom allocates. we used bound Receive. + // returns amount of bytes written into buffer. + // throws SocketException if datagram was larger than buffer. + // https://learn.microsoft.com/en-us/dotnet/api/system.net.sockets.socket.receive?view=net-6.0 + // + // throws SocketException if datagram was larger than buffer. + // https://learn.microsoft.com/en-us/dotnet/api/system.net.sockets.socket.receive?view=net-6.0 + int size = socket.Receive(recvBuffer, 0, recvBuffer.Length, SocketFlags.None); + data = new ArraySegment(recvBuffer, 0, size); + return true; + } + catch (SocketException e) + { + // for non-blocking sockets, Receive throws WouldBlock if there is + // no message to read. that's okay. only log for other errors. + if (e.SocketErrorCode == SocketError.WouldBlock) return false; + + // otherwise it's a real socket error. throw it. + throw; + } + } + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Extensions.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Extensions.cs.meta new file mode 100644 index 0000000..36d3193 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Extensions.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: c0649195e5ba4fcf8e0e1231fee7d5f6 +timeCreated: 1641701011 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpChannel.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpChannel.cs new file mode 100644 index 0000000..c085e17 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpChannel.cs @@ -0,0 +1,10 @@ +namespace kcp2k +{ + // channel type and header for raw messages + public enum KcpChannel : byte + { + // don't react on 0x00. might help to filter out random noise. + Reliable = 1, + Unreliable = 2 + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpChannel.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpChannel.cs.meta new file mode 100644 index 0000000..2721025 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpChannel.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 9e852b2532fb248d19715cfebe371db3 +timeCreated: 1610081248 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpClient.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpClient.cs new file mode 100644 index 0000000..788d065 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpClient.cs @@ -0,0 +1,226 @@ +// kcp client logic abstracted into a class. +// for use in Mirror, DOTSNET, testing, etc. +using System; +using System.Net; +using System.Net.Sockets; + +namespace kcp2k +{ + public class KcpClient + { + // kcp + // public so that bandwidth statistics can be accessed from the outside + public KcpPeer peer; + + // IO + protected Socket socket; + public EndPoint remoteEndPoint; + + // config + protected readonly KcpConfig config; + + // raw receive buffer always needs to be of 'MTU' size, even if + // MaxMessageSize is larger. kcp always sends in MTU segments and having + // a buffer smaller than MTU would silently drop excess data. + // => we need the MTU to fit channel + message! + // => protected because someone may overwrite RawReceive but still wants + // to reuse the buffer. + protected readonly byte[] rawReceiveBuffer; + + // callbacks + // even for errors, to allow liraries to show popups etc. + // instead of logging directly. + // (string instead of Exception for ease of use and to avoid user panic) + // + // events are readonly, set in constructor. + // this ensures they are always initialized when used. + // fixes https://github.com/MirrorNetworking/Mirror/issues/3337 and more + protected readonly Action OnConnected; + protected readonly Action, KcpChannel> OnData; + protected readonly Action OnDisconnected; + protected readonly Action OnError; + + // state + public bool connected; + + public KcpClient(Action OnConnected, + Action, KcpChannel> OnData, + Action OnDisconnected, + Action OnError, + KcpConfig config) + { + // initialize callbacks first to ensure they can be used safely. + this.OnConnected = OnConnected; + this.OnData = OnData; + this.OnDisconnected = OnDisconnected; + this.OnError = OnError; + this.config = config; + + // create mtu sized receive buffer + rawReceiveBuffer = new byte[config.Mtu]; + } + + public void Connect(string address, ushort port) + { + if (connected) + { + Log.Warning("KcpClient: already connected!"); + return; + } + + // resolve host name before creating peer. + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3361 + if (!Common.ResolveHostname(address, out IPAddress[] addresses)) + { + // pass error to user callback. no need to log it manually. + OnError(ErrorCode.DnsResolve, $"Failed to resolve host: {address}"); + OnDisconnected(); + return; + } + + // create fresh peer for each new session + // client doesn't need secure cookie. + peer = new KcpPeer(RawSend, OnAuthenticatedWrap, OnData, OnDisconnectedWrap, OnError, config, 0); + + // some callbacks need to wrapped with some extra logic + void OnAuthenticatedWrap() + { + Log.Info($"KcpClient: OnConnected"); + connected = true; + OnConnected(); + } + void OnDisconnectedWrap() + { + Log.Info($"KcpClient: OnDisconnected"); + connected = false; + peer = null; + socket?.Close(); + socket = null; + remoteEndPoint = null; + OnDisconnected(); + } + + Log.Info($"KcpClient: connect to {address}:{port}"); + + // create socket + remoteEndPoint = new IPEndPoint(addresses[0], port); + socket = new Socket(remoteEndPoint.AddressFamily, SocketType.Dgram, ProtocolType.Udp); + + // recv & send are called from main thread. + // need to ensure this never blocks. + // even a 1ms block per connection would stop us from scaling. + socket.Blocking = false; + + // configure buffer sizes + Common.ConfigureSocketBuffers(socket, config.RecvBufferSize, config.SendBufferSize); + + // bind to endpoint so we can use send/recv instead of sendto/recvfrom. + socket.Connect(remoteEndPoint); + + // client should send handshake to server as very first message + peer.SendHandshake(); + } + + // io - input. + // virtual so it may be modified for relays, etc. + // call this while it returns true, to process all messages this tick. + // returned ArraySegment is valid until next call to RawReceive. + protected virtual bool RawReceive(out ArraySegment segment) + { + segment = default; + if (socket == null) return false; + + try + { + return socket.ReceiveNonBlocking(rawReceiveBuffer, out segment); + } + // for non-blocking sockets, Receive throws WouldBlock if there is + // no message to read. that's okay. only log for other errors. + catch (SocketException e) + { + // the other end closing the connection is not an 'error'. + // but connections should never just end silently. + // at least log a message for easier debugging. + // for example, his can happen when connecting without a server. + // see test: ConnectWithoutServer(). + Log.Info($"KcpClient: looks like the other end has closed the connection. This is fine: {e}"); + peer.Disconnect(); + return false; + } + } + + // io - output. + // virtual so it may be modified for relays, etc. + protected virtual void RawSend(ArraySegment data) + { + try + { + socket.SendNonBlocking(data); + } + catch (SocketException e) + { + Log.Error($"KcpClient: Send failed: {e}"); + } + } + + public void Send(ArraySegment segment, KcpChannel channel) + { + if (!connected) + { + Log.Warning("KcpClient: can't send because not connected!"); + return; + } + + peer.SendData(segment, channel); + } + + public void Disconnect() + { + // only if connected + // otherwise we end up in a deadlock because of an open Mirror bug: + // https://github.com/vis2k/Mirror/issues/2353 + if (!connected) return; + + // call Disconnect and let the connection handle it. + // DO NOT set it to null yet. it needs to be updated a few more + // times first. let the connection handle it! + peer?.Disconnect(); + } + + // process incoming messages. should be called before updating the world. + // virtual because relay may need to inject their own ping or similar. + public virtual void TickIncoming() + { + // recv on socket first, then process incoming + // (even if we didn't receive anything. need to tick ping etc.) + // (connection is null if not active) + if (peer != null) + { + + while (RawReceive(out ArraySegment segment)) + peer.RawInput(segment); + } + + // RawReceive may have disconnected peer. null check again. + peer?.TickIncoming(); + } + + // process outgoing messages. should be called after updating the world. + // virtual because relay may need to inject their own ping or similar. + public virtual void TickOutgoing() + { + // process outgoing + // (connection is null if not active) + peer?.TickOutgoing(); + } + + // process incoming and outgoing for convenience + // => ideally call ProcessIncoming() before updating the world and + // ProcessOutgoing() after updating the world for minimum latency + public virtual void Tick() + { + TickIncoming(); + TickOutgoing(); + } + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpClient.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpClient.cs.meta new file mode 100644 index 0000000..e55306b --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpClient.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 6aa069a28ed24fedb533c102d9742b36 +timeCreated: 1603786960 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpConfig.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpConfig.cs new file mode 100644 index 0000000..382d06b --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpConfig.cs @@ -0,0 +1,97 @@ +// common config struct, instead of passing 10 parameters manually every time. +using System; + +namespace kcp2k +{ + // [Serializable] to show it in Unity inspector. + // 'class' so we can set defaults easily. + [Serializable] + public class KcpConfig + { + // socket configuration //////////////////////////////////////////////// + // DualMode uses both IPv6 and IPv4. not all platforms support it. + // (Nintendo Switch, etc.) + public bool DualMode; + + // UDP servers use only one socket. + // maximize buffer to handle as many connections as possible. + // + // M1 mac pro: + // recv buffer default: 786896 (771 KB) + // send buffer default: 9216 (9 KB) + // max configurable: ~7 MB + public int RecvBufferSize; + public int SendBufferSize; + + // kcp configuration /////////////////////////////////////////////////// + // configurable MTU in case kcp sits on top of other abstractions like + // encrypted transports, relays, etc. + public int Mtu; + + // NoDelay is recommended to reduce latency. This also scales better + // without buffers getting full. + public bool NoDelay; + + // KCP internal update interval. 100ms is KCP default, but a lower + // interval is recommended to minimize latency and to scale to more + // networked entities. + public uint Interval; + + // KCP fastresend parameter. Faster resend for the cost of higher + // bandwidth. + public int FastResend; + + // KCP congestion window heavily limits messages flushed per update. + // congestion window may actually be broken in kcp: + // - sending max sized message @ M1 mac flushes 2-3 messages per update + // - even with super large send/recv window, it requires thousands of + // update calls + // best to leave this disabled, as it may significantly increase latency. + public bool CongestionWindow; + + // KCP window size can be modified to support higher loads. + // for example, Mirror Benchmark requires: + // 128, 128 for 4k monsters + // 512, 512 for 10k monsters + // 8192, 8192 for 20k monsters + public uint SendWindowSize; + public uint ReceiveWindowSize; + + // timeout in milliseconds + public int Timeout; + + // maximum retransmission attempts until dead_link + public uint MaxRetransmits; + + // constructor ///////////////////////////////////////////////////////// + // constructor with defaults for convenience. + // makes it easy to define "new KcpConfig(DualMode=false)" etc. + public KcpConfig( + bool DualMode = true, + int RecvBufferSize = 1024 * 1024 * 7, + int SendBufferSize = 1024 * 1024 * 7, + int Mtu = Kcp.MTU_DEF, + bool NoDelay = true, + uint Interval = 10, + int FastResend = 0, + bool CongestionWindow = false, + uint SendWindowSize = Kcp.WND_SND, + uint ReceiveWindowSize = Kcp.WND_RCV, + int Timeout = KcpPeer.DEFAULT_TIMEOUT, + uint MaxRetransmits = Kcp.DEADLINK) + { + this.DualMode = DualMode; + this.RecvBufferSize = RecvBufferSize; + this.SendBufferSize = SendBufferSize; + this.Mtu = Mtu; + this.NoDelay = NoDelay; + this.Interval = Interval; + this.FastResend = FastResend; + this.CongestionWindow = CongestionWindow; + this.SendWindowSize = SendWindowSize; + this.ReceiveWindowSize = ReceiveWindowSize; + this.Timeout = Timeout; + this.MaxRetransmits = MaxRetransmits; + } + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpConfig.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpConfig.cs.meta new file mode 100644 index 0000000..a687e23 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpConfig.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 99692f99c45c4b47b0500e7abbfd12da +timeCreated: 1670946969 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpHeader.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpHeader.cs new file mode 100644 index 0000000..7817796 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpHeader.cs @@ -0,0 +1,19 @@ +namespace kcp2k +{ + // header for messages processed by kcp. + // this is NOT for the raw receive messages(!) because handshake/disconnect + // need to be sent reliably. it's not enough to have those in rawreceive + // because those messages might get lost without being resent! + public enum KcpHeader : byte + { + // don't react on 0x00. might help to filter out random noise. + Handshake = 1, + // ping goes over reliable & KcpHeader for now. could go over unreliable + // too. there is no real difference except that this is easier because + // we already have a KcpHeader for reliable messages. + // ping is only used to keep it alive, so latency doesn't matter. + Ping = 2, + Data = 3, + Disconnect = 4 + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpHeader.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpHeader.cs.meta new file mode 100644 index 0000000..9e81c94 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpHeader.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 91b5edac31224a49bd76f960ae018942 +timeCreated: 1610081248 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpPeer.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpPeer.cs new file mode 100644 index 0000000..e78261e --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpPeer.cs @@ -0,0 +1,819 @@ +// Kcp Peer, similar to UDP Peer but wrapped with reliability, channels, +// timeouts, authentication, state, etc. +// +// still IO agnostic to work with udp, nonalloc, relays, native, etc. +using System; +using System.Diagnostics; +using System.Net.Sockets; + +namespace kcp2k +{ + enum KcpState { Connected, Authenticated, Disconnected } + + public class KcpPeer + { + // kcp reliability algorithm + internal Kcp kcp; + + // security cookie to prevent UDP spoofing. + // credits to IncludeSec for disclosing the issue. + // + // server passes the expected cookie to the client's KcpPeer. + // KcpPeer sends cookie to the connected client. + // KcpPeer only accepts packets which contain the cookie. + // => cookie can be a random number, but it needs to be cryptographically + // secure random that can't be easily predicted. + // => cookie can be hash(ip, port) BUT only if salted to be not predictable + readonly uint cookie; + + // this is the cookie that the other end received during handshake. + // store byte[] representation to avoid runtime int->byte[] conversions. + internal readonly byte[] receivedCookie = new byte[4]; + + // IO agnostic + readonly Action> RawSend; + + // state: connected as soon as we create the peer. + // leftover from KcpConnection. remove it after refactoring later. + KcpState state = KcpState.Connected; + + // events are readonly, set in constructor. + // this ensures they are always initialized when used. + // fixes https://github.com/MirrorNetworking/Mirror/issues/3337 and more + readonly Action OnAuthenticated; + readonly Action, KcpChannel> OnData; + readonly Action OnDisconnected; + // error callback instead of logging. + // allows libraries to show popups etc. + // (string instead of Exception for ease of use and to avoid user panic) + readonly Action OnError; + + // If we don't receive anything these many milliseconds + // then consider us disconnected + public const int DEFAULT_TIMEOUT = 10000; + public int timeout; + uint lastReceiveTime; + + // internal time. + // StopWatch offers ElapsedMilliSeconds and should be more precise than + // Unity's time.deltaTime over long periods. + readonly Stopwatch watch = new Stopwatch(); + + // we need to subtract the channel and cookie bytes from every + // MaxMessageSize calculation. + // we also need to tell kcp to use MTU-1 to leave space for the byte. + const int CHANNEL_HEADER_SIZE = 1; + const int COOKIE_HEADER_SIZE = 4; + const int METADATA_SIZE = CHANNEL_HEADER_SIZE + COOKIE_HEADER_SIZE; + + // reliable channel (= kcp) MaxMessageSize so the outside knows largest + // allowed message to send. the calculation in Send() is not obvious at + // all, so let's provide the helper here. + // + // kcp does fragmentation, so max message is way larger than MTU. + // + // -> runtime MTU changes are disabled: mss is always MTU_DEF-OVERHEAD + // -> Send() checks if fragment count < rcv_wnd, so we use rcv_wnd - 1. + // NOTE that original kcp has a bug where WND_RCV default is used + // instead of configured rcv_wnd, limiting max message size to 144 KB + // https://github.com/skywind3000/kcp/pull/291 + // we fixed this in kcp2k. + // -> we add 1 byte KcpHeader enum to each message, so -1 + // + // IMPORTANT: max message is MTU * rcv_wnd, in other words it completely + // fills the receive window! due to head of line blocking, + // all other messages have to wait while a maxed size message + // is being delivered. + // => in other words, DO NOT use max size all the time like + // for batching. + // => sending UNRELIABLE max message size most of the time is + // best for performance (use that one for batching!) + static int ReliableMaxMessageSize_Unconstrained(int mtu, uint rcv_wnd) => + (mtu - Kcp.OVERHEAD - METADATA_SIZE) * ((int)rcv_wnd - 1) - 1; + + // kcp encodes 'frg' as 1 byte. + // max message size can only ever allow up to 255 fragments. + // WND_RCV gives 127 fragments. + // WND_RCV * 2 gives 255 fragments. + // so we can limit max message size by limiting rcv_wnd parameter. + public static int ReliableMaxMessageSize(int mtu, uint rcv_wnd) => + ReliableMaxMessageSize_Unconstrained(mtu, Math.Min(rcv_wnd, Kcp.FRG_MAX)); + + // unreliable max message size is simply MTU - channel header size + public static int UnreliableMaxMessageSize(int mtu) => + mtu - METADATA_SIZE; + + // buffer to receive kcp's processed messages (avoids allocations). + // IMPORTANT: this is for KCP messages. so it needs to be of size: + // 1 byte header + MaxMessageSize content + readonly byte[] kcpMessageBuffer;// = new byte[1 + ReliableMaxMessageSize]; + + // send buffer for handing user messages to kcp for processing. + // (avoids allocations). + // IMPORTANT: needs to be of size: + // 1 byte header + MaxMessageSize content + readonly byte[] kcpSendBuffer;// = new byte[1 + ReliableMaxMessageSize]; + + // raw send buffer is exactly MTU. + readonly byte[] rawSendBuffer; + + // send a ping occasionally so we don't time out on the other end. + // for example, creating a character in an MMO could easily take a + // minute of no data being sent. which doesn't mean we want to time out. + // same goes for slow paced card games etc. + public const int PING_INTERVAL = 1000; + uint lastPingTime; + + // if we send more than kcp can handle, we will get ever growing + // send/recv buffers and queues and minutes of latency. + // => if a connection can't keep up, it should be disconnected instead + // to protect the server under heavy load, and because there is no + // point in growing to gigabytes of memory or minutes of latency! + // => 2k isn't enough. we reach 2k when spawning 4k monsters at once + // easily, but it does recover over time. + // => 10k seems safe. + // + // note: we have a ChokeConnectionAutoDisconnects test for this too! + internal const int QueueDisconnectThreshold = 10000; + + // getters for queue and buffer counts, used for debug info + public int SendQueueCount => kcp.snd_queue.Count; + public int ReceiveQueueCount => kcp.rcv_queue.Count; + public int SendBufferCount => kcp.snd_buf.Count; + public int ReceiveBufferCount => kcp.rcv_buf.Count; + + // maximum send rate per second can be calculated from kcp parameters + // source: https://translate.google.com/translate?sl=auto&tl=en&u=https://wetest.qq.com/lab/view/391.html + // + // KCP can send/receive a maximum of WND*MTU per interval. + // multiple by 1000ms / interval to get the per-second rate. + // + // example: + // WND(32) * MTU(1400) = 43.75KB + // => 43.75KB * 1000 / INTERVAL(10) = 4375KB/s + // + // returns bytes/second! + public uint MaxSendRate => kcp.snd_wnd * kcp.mtu * 1000 / kcp.interval; + public uint MaxReceiveRate => kcp.rcv_wnd * kcp.mtu * 1000 / kcp.interval; + + // calculate max message sizes based on mtu and wnd only once + public readonly int unreliableMax; + public readonly int reliableMax; + + // SetupKcp creates and configures a new KCP instance. + // => useful to start from a fresh state every time the client connects + // => NoDelay, interval, wnd size are the most important configurations. + // let's force require the parameters so we don't forget it anywhere. + public KcpPeer( + Action> output, + Action OnAuthenticated, + Action, KcpChannel> OnData, + Action OnDisconnected, + Action OnError, + KcpConfig config, + uint cookie) + { + // initialize callbacks first to ensure they can be used safely. + this.OnAuthenticated = OnAuthenticated; + this.OnData = OnData; + this.OnDisconnected = OnDisconnected; + this.OnError = OnError; + this.RawSend = output; + + // set up kcp over reliable channel (that's what kcp is for) + kcp = new Kcp(0, RawSendReliable); + + // security cookie + this.cookie = cookie; + + // set nodelay. + // note that kcp uses 'nocwnd' internally so we negate the parameter + kcp.SetNoDelay(config.NoDelay ? 1u : 0u, config.Interval, config.FastResend, !config.CongestionWindow); + kcp.SetWindowSize(config.SendWindowSize, config.ReceiveWindowSize); + + // IMPORTANT: high level needs to add 1 channel byte to each raw + // message. so while Kcp.MTU_DEF is perfect, we actually need to + // tell kcp to use MTU-1 so we can still put the header into the + // message afterwards. + kcp.SetMtu((uint)config.Mtu - METADATA_SIZE); + + // create mtu sized send buffer + rawSendBuffer = new byte[config.Mtu]; + + // calculate max message sizes once + unreliableMax = UnreliableMaxMessageSize(config.Mtu); + reliableMax = ReliableMaxMessageSize(config.Mtu, config.ReceiveWindowSize); + + // set maximum retransmits (aka dead_link) + kcp.dead_link = config.MaxRetransmits; + + // create message buffers AFTER window size is set + // see comments on buffer definition for the "+1" part + kcpMessageBuffer = new byte[1 + reliableMax]; + kcpSendBuffer = new byte[1 + reliableMax]; + + timeout = config.Timeout; + + watch.Start(); + } + + void HandleTimeout(uint time) + { + // note: we are also sending a ping regularly, so timeout should + // only ever happen if the connection is truly gone. + if (time >= lastReceiveTime + timeout) + { + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.Timeout, $"KcpPeer: Connection timed out after not receiving any message for {timeout}ms. Disconnecting."); + Disconnect(); + } + } + + void HandleDeadLink() + { + // kcp has 'dead_link' detection. might as well use it. + if (kcp.state == -1) + { + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.Timeout, $"KcpPeer: dead_link detected: a message was retransmitted {kcp.dead_link} times without ack. Disconnecting."); + Disconnect(); + } + } + + // send a ping occasionally in order to not time out on the other end. + void HandlePing(uint time) + { + // enough time elapsed since last ping? + if (time >= lastPingTime + PING_INTERVAL) + { + // ping again and reset time + //Log.Debug("KCP: sending ping..."); + SendPing(); + lastPingTime = time; + } + } + + void HandleChoked() + { + // disconnect connections that can't process the load. + // see QueueSizeDisconnect comments. + // => include all of kcp's buffers and the unreliable queue! + int total = kcp.rcv_queue.Count + kcp.snd_queue.Count + + kcp.rcv_buf.Count + kcp.snd_buf.Count; + if (total >= QueueDisconnectThreshold) + { + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.Congestion, + $"KcpPeer: disconnecting connection because it can't process data fast enough.\n" + + $"Queue total {total}>{QueueDisconnectThreshold}. rcv_queue={kcp.rcv_queue.Count} snd_queue={kcp.snd_queue.Count} rcv_buf={kcp.rcv_buf.Count} snd_buf={kcp.snd_buf.Count}\n" + + $"* Try to Enable NoDelay, decrease INTERVAL, disable Congestion Window (= enable NOCWND!), increase SEND/RECV WINDOW or compress data.\n" + + $"* Or perhaps the network is simply too slow on our end, or on the other end."); + + // let's clear all pending sends before disconnting with 'Bye'. + // otherwise a single Flush in Disconnect() won't be enough to + // flush thousands of messages to finally deliver 'Bye'. + // this is just faster and more robust. + kcp.snd_queue.Clear(); + + Disconnect(); + } + } + + // reads the next reliable message type & content from kcp. + // -> to avoid buffering, unreliable messages call OnData directly. + bool ReceiveNextReliable(out KcpHeader header, out ArraySegment message) + { + message = default; + header = KcpHeader.Disconnect; + + int msgSize = kcp.PeekSize(); + if (msgSize <= 0) return false; + + // only allow receiving up to buffer sized messages. + // otherwise we would get BlockCopy ArgumentException anyway. + if (msgSize > kcpMessageBuffer.Length) + { + // we don't allow sending messages > Max, so this must be an + // attacker. let's disconnect to avoid allocation attacks etc. + // pass error to user callback. no need to log it manually. + OnError(ErrorCode.InvalidReceive, $"KcpPeer: possible allocation attack for msgSize {msgSize} > buffer {kcpMessageBuffer.Length}. Disconnecting the connection."); + Disconnect(); + return false; + } + + // receive from kcp + int received = kcp.Receive(kcpMessageBuffer, msgSize); + if (received < 0) + { + // if receive failed, close everything + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.InvalidReceive, $"KcpPeer: Receive failed with error={received}. closing connection."); + Disconnect(); + return false; + } + + // extract header & content without header + header = (KcpHeader)kcpMessageBuffer[0]; + message = new ArraySegment(kcpMessageBuffer, 1, msgSize - 1); + lastReceiveTime = (uint)watch.ElapsedMilliseconds; + return true; + } + + void TickIncoming_Connected(uint time) + { + // detect common events & ping + HandleTimeout(time); + HandleDeadLink(); + HandlePing(time); + HandleChoked(); + + // any reliable kcp message received? + if (ReceiveNextReliable(out KcpHeader header, out ArraySegment message)) + { + // message type FSM. no default so we never miss a case. + switch (header) + { + case KcpHeader.Handshake: + { + // we were waiting for a handshake. + // it proves that the other end speaks our protocol. + + // parse the cookie + if (message.Count != 4) + { + // pass error to user callback. no need to log it manually. + OnError(ErrorCode.InvalidReceive, $"KcpPeer: received invalid handshake message with size {message.Count} != 4. Disconnecting the connection."); + Disconnect(); + return; + } + + // store the cookie bytes to avoid int->byte[] conversions when sending. + // still convert to uint once, just for prettier logging. + Buffer.BlockCopy(message.Array, message.Offset, receivedCookie, 0, 4); + uint prettyCookie = BitConverter.ToUInt32(message.Array, message.Offset); + + Log.Info($"KcpPeer: received handshake with cookie={prettyCookie}"); + state = KcpState.Authenticated; + OnAuthenticated?.Invoke(); + break; + } + case KcpHeader.Ping: + { + // ping keeps kcp from timing out. do nothing. + break; + } + case KcpHeader.Data: + case KcpHeader.Disconnect: + { + // everything else is not allowed during handshake! + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.InvalidReceive, $"KcpPeer: received invalid header {header} while Connected. Disconnecting the connection."); + Disconnect(); + break; + } + } + } + } + + void TickIncoming_Authenticated(uint time) + { + // detect common events & ping + HandleTimeout(time); + HandleDeadLink(); + HandlePing(time); + HandleChoked(); + + // process all received messages + while (ReceiveNextReliable(out KcpHeader header, out ArraySegment message)) + { + // message type FSM. no default so we never miss a case. + switch (header) + { + case KcpHeader.Handshake: + { + // should never receive another handshake after auth + // GetType() shows Server/ClientConn instead of just Connection. + Log.Warning($"KcpPeer: received invalid header {header} while Authenticated. Disconnecting the connection."); + Disconnect(); + break; + } + case KcpHeader.Data: + { + // call OnData IF the message contained actual data + if (message.Count > 0) + { + //Log.Warning($"Kcp recv msg: {BitConverter.ToString(message.Array, message.Offset, message.Count)}"); + OnData?.Invoke(message, KcpChannel.Reliable); + } + // empty data = attacker, or something went wrong + else + { + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.InvalidReceive, $"KcpPeer: received empty Data message while Authenticated. Disconnecting the connection."); + Disconnect(); + } + break; + } + case KcpHeader.Ping: + { + // ping keeps kcp from timing out. do nothing. + break; + } + case KcpHeader.Disconnect: + { + // disconnect might happen + // GetType() shows Server/ClientConn instead of just Connection. + Log.Info($"KcpPeer: received disconnect message"); + Disconnect(); + break; + } + } + } + } + + public void TickIncoming() + { + uint time = (uint)watch.ElapsedMilliseconds; + + try + { + switch (state) + { + case KcpState.Connected: + { + TickIncoming_Connected(time); + break; + } + case KcpState.Authenticated: + { + TickIncoming_Authenticated(time); + break; + } + case KcpState.Disconnected: + { + // do nothing while disconnected + break; + } + } + } + // TODO KcpConnection is IO agnostic. move this to outside later. + catch (SocketException exception) + { + // this is ok, the connection was closed + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.ConnectionClosed, $"KcpPeer: Disconnecting because {exception}. This is fine."); + Disconnect(); + } + catch (ObjectDisposedException exception) + { + // fine, socket was closed + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.ConnectionClosed, $"KcpPeer: Disconnecting because {exception}. This is fine."); + Disconnect(); + } + catch (Exception exception) + { + // unexpected + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.Unexpected, $"KcpPeer: unexpected Exception: {exception}"); + Disconnect(); + } + } + + public void TickOutgoing() + { + uint time = (uint)watch.ElapsedMilliseconds; + + try + { + switch (state) + { + case KcpState.Connected: + case KcpState.Authenticated: + { + // update flushes out messages + kcp.Update(time); + break; + } + case KcpState.Disconnected: + { + // do nothing while disconnected + break; + } + } + } + // TODO KcpConnection is IO agnostic. move this to outside later. + catch (SocketException exception) + { + // this is ok, the connection was closed + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.ConnectionClosed, $"KcpPeer: Disconnecting because {exception}. This is fine."); + Disconnect(); + } + catch (ObjectDisposedException exception) + { + // fine, socket was closed + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.ConnectionClosed, $"KcpPeer: Disconnecting because {exception}. This is fine."); + Disconnect(); + } + catch (Exception exception) + { + // unexpected + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.Unexpected, $"KcpPeer: unexpected exception: {exception}"); + Disconnect(); + } + } + + void OnRawInputReliable(ArraySegment message) + { + // input into kcp, but skip channel byte + int input = kcp.Input(message.Array, message.Offset, message.Count); + if (input != 0) + { + // GetType() shows Server/ClientConn instead of just Connection. + Log.Warning($"KcpPeer: Input failed with error={input} for buffer with length={message.Count - 1}"); + } + } + + void OnRawInputUnreliable(ArraySegment message) + { + // ideally we would queue all unreliable messages and + // then process them in ReceiveNext() together with the + // reliable messages, but: + // -> queues/allocations/pools are slow and complex. + // -> DOTSNET 10k is actually slower if we use pooled + // unreliable messages for transform messages. + // + // DOTSNET 10k benchmark: + // reliable-only: 170 FPS + // unreliable queued: 130-150 FPS + // unreliable direct: 183 FPS(!) + // + // DOTSNET 50k benchmark: + // reliable-only: FAILS (queues keep growing) + // unreliable direct: 18-22 FPS(!) + // + // -> all unreliable messages are DATA messages anyway. + // -> let's skip the magic and call OnData directly if + // the current state allows it. + if (state == KcpState.Authenticated) + { + OnData?.Invoke(message, KcpChannel.Unreliable); + + // set last receive time to avoid timeout. + // -> we do this in ANY case even if not enabled. + // a message is a message. + // -> we set last receive time for both reliable and + // unreliable messages. both count. + // otherwise a connection might time out even + // though unreliable were received, but no + // reliable was received. + lastReceiveTime = (uint)watch.ElapsedMilliseconds; + } + else + { + // it's common to receive unreliable messages before being + // authenticated, for example: + // - random internet noise + // - game server may send an unreliable message after authenticating, + // and the unreliable message arrives on the client before the + // 'auth_ok' message. this can be avoided by sending a final + // 'ready' message after being authenticated, but this would + // add another 'round trip time' of latency to the handshake. + // + // it's best to simply ignore invalid unreliable messages here. + // Log.Info($"KcpPeer: received unreliable message while not authenticated."); + } + } + + // insert raw IO. usually from socket.Receive. + // offset is useful for relays, where we may parse a header and then + // feed the rest to kcp. + public void RawInput(ArraySegment segment) + { + // ensure valid size: at least 1 byte for channel + 4 bytes for cookie + if (segment.Count <= 5) return; + + // parse channel + // byte channel = segment[0]; ArraySegment[i] isn't supported in some older Unity Mono versions + byte channel = segment.Array[segment.Offset + 0]; + + // parse cookie + uint messageCookie = BitConverter.ToUInt32(segment.Array, segment.Offset + 1); + + // compare cookie to protect against UDP spoofing. + // messages won't have a cookie until after handshake. + // so only compare if we are authenticated. + // simply drop the message if the cookie doesn't match. + if (state == KcpState.Authenticated && messageCookie != cookie) + { + Log.Warning($"KcpPeer: dropped message with invalid cookie: {messageCookie} expected: {cookie}."); + return; + } + + // parse message + ArraySegment message = new ArraySegment(segment.Array, segment.Offset + 1+4, segment.Count - 1-4); + + switch (channel) + { + case (byte)KcpChannel.Reliable: + { + OnRawInputReliable(message); + break; + } + case (byte)KcpChannel.Unreliable: + { + OnRawInputUnreliable(message); + break; + } + default: + { + // invalid channel indicates random internet noise. + // servers may receive random UDP data. + // just ignore it, but log for easier debugging. + Log.Warning($"KcpPeer: invalid channel header: {channel}, likely internet noise"); + break; + } + } + } + + // raw send called by kcp + void RawSendReliable(byte[] data, int length) + { + // write channel header + // from 0, with 1 byte + rawSendBuffer[0] = (byte)KcpChannel.Reliable; + + // write handshake cookie to protect against UDP spoofing. + // from 1, with 4 bytes + Buffer.BlockCopy(receivedCookie, 0, rawSendBuffer, 1, 4); + + // write data + // from 5, with N bytes + Buffer.BlockCopy(data, 0, rawSendBuffer, 1+4, length); + + // IO send + ArraySegment segment = new ArraySegment(rawSendBuffer, 0, length + 1+4); + RawSend(segment); + } + + void SendReliable(KcpHeader header, ArraySegment content) + { + // 1 byte header + content needs to fit into send buffer + if (1 + content.Count > kcpSendBuffer.Length) // TODO + { + // otherwise content is larger than MaxMessageSize. let user know! + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.InvalidSend, $"KcpPeer: Failed to send reliable message of size {content.Count} because it's larger than ReliableMaxMessageSize={reliableMax}"); + return; + } + + // write channel header + kcpSendBuffer[0] = (byte)header; + + // write data (if any) + if (content.Count > 0) + Buffer.BlockCopy(content.Array, content.Offset, kcpSendBuffer, 1, content.Count); + + // send to kcp for processing + int sent = kcp.Send(kcpSendBuffer, 0, 1 + content.Count); + if (sent < 0) + { + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.InvalidSend, $"KcpPeer: Send failed with error={sent} for content with length={content.Count}"); + } + } + + void SendUnreliable(ArraySegment message) + { + // message size needs to be <= unreliable max size + if (message.Count > unreliableMax) + { + // otherwise content is larger than MaxMessageSize. let user know! + // GetType() shows Server/ClientConn instead of just Connection. + Log.Error($"KcpPeer: Failed to send unreliable message of size {message.Count} because it's larger than UnreliableMaxMessageSize={unreliableMax}"); + return; + } + + // write channel header + // from 0, with 1 byte + rawSendBuffer[0] = (byte)KcpChannel.Unreliable; + + // write handshake cookie to protect against UDP spoofing. + // from 1, with 4 bytes + Buffer.BlockCopy(receivedCookie, 0, rawSendBuffer, 1, 4); + + // write data + // from 5, with N bytes + Buffer.BlockCopy(message.Array, message.Offset, rawSendBuffer, 1 + 4, message.Count); + + // IO send + ArraySegment segment = new ArraySegment(rawSendBuffer, 0, message.Count + 1 + 4); + RawSend(segment); + } + + // server & client need to send handshake at different times, so we need + // to expose the function. + // * client should send it immediately. + // * server should send it as reply to client's handshake, not before + // (server should not reply to random internet messages with handshake) + // => handshake info needs to be delivered, so it goes over reliable. + public void SendHandshake() + { + // server includes a random cookie in handshake. + // client is expected to include in every message. + // this avoid UDP spoofing. + // KcpPeer simply always sends a cookie. + // in case client -> server cookies are ever implemented, etc. + + // TODO nonalloc + byte[] cookieBytes = BitConverter.GetBytes(cookie); + + // GetType() shows Server/ClientConn instead of just Connection. + Log.Info($"KcpPeer: sending Handshake to other end with cookie={cookie}!"); + SendReliable(KcpHeader.Handshake, new ArraySegment(cookieBytes)); + } + + public void SendData(ArraySegment data, KcpChannel channel) + { + // sending empty segments is not allowed. + // nobody should ever try to send empty data. + // it means that something went wrong, e.g. in Mirror/DOTSNET. + // let's make it obvious so it's easy to debug. + if (data.Count == 0) + { + // pass error to user callback. no need to log it manually. + // GetType() shows Server/ClientConn instead of just Connection. + OnError(ErrorCode.InvalidSend, $"KcpPeer: tried sending empty message. This should never happen. Disconnecting."); + Disconnect(); + return; + } + + switch (channel) + { + case KcpChannel.Reliable: + SendReliable(KcpHeader.Data, data); + break; + case KcpChannel.Unreliable: + SendUnreliable(data); + break; + } + } + + // ping goes through kcp to keep it from timing out, so it goes over the + // reliable channel. + void SendPing() => SendReliable(KcpHeader.Ping, default); + + // disconnect info needs to be delivered, so it goes over reliable + void SendDisconnect() => SendReliable(KcpHeader.Disconnect, default); + + // disconnect this connection + public void Disconnect() + { + // only if not disconnected yet + if (state == KcpState.Disconnected) + return; + + // send a disconnect message + try + { + SendDisconnect(); + kcp.Flush(); + } + // TODO KcpConnection is IO agnostic. move this to outside later. + catch (SocketException) + { + // this is ok, the connection was already closed + } + catch (ObjectDisposedException) + { + // this is normal when we stop the server + // the socket is stopped so we can't send anything anymore + // to the clients + + // the clients will eventually timeout and realize they + // were disconnected + } + + // set as Disconnected, call event + // GetType() shows Server/ClientConn instead of just Connection. + Log.Info($"KcpPeer: Disconnected."); + state = KcpState.Disconnected; + OnDisconnected?.Invoke(); + } + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpPeer.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpPeer.cs.meta new file mode 100644 index 0000000..fa5dcff --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpPeer.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 3915c7c62b72d4dc2a9e4e76c94fc484 +timeCreated: 1602600432 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServer.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServer.cs new file mode 100644 index 0000000..64b990c --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServer.cs @@ -0,0 +1,377 @@ +// kcp server logic abstracted into a class. +// for use in Mirror, DOTSNET, testing, etc. +using System; +using System.Collections.Generic; +using System.Net; +using System.Net.Sockets; + +namespace kcp2k +{ + public class KcpServer + { + // callbacks + // even for errors, to allow liraries to show popups etc. + // instead of logging directly. + // (string instead of Exception for ease of use and to avoid user panic) + // + // events are readonly, set in constructor. + // this ensures they are always initialized when used. + // fixes https://github.com/MirrorNetworking/Mirror/issues/3337 and more + protected readonly Action OnConnected; + protected readonly Action, KcpChannel> OnData; + protected readonly Action OnDisconnected; + protected readonly Action OnError; + + // configuration + protected readonly KcpConfig config; + + // state + protected Socket socket; + EndPoint newClientEP; + + // raw receive buffer always needs to be of 'MTU' size, even if + // MaxMessageSize is larger. kcp always sends in MTU segments and having + // a buffer smaller than MTU would silently drop excess data. + // => we need the mtu to fit channel + message! + protected readonly byte[] rawReceiveBuffer; + + // connections where connectionId is EndPoint.GetHashCode + public Dictionary connections = + new Dictionary(); + + public KcpServer(Action OnConnected, + Action, KcpChannel> OnData, + Action OnDisconnected, + Action OnError, + KcpConfig config) + { + // initialize callbacks first to ensure they can be used safely. + this.OnConnected = OnConnected; + this.OnData = OnData; + this.OnDisconnected = OnDisconnected; + this.OnError = OnError; + this.config = config; + + // create mtu sized receive buffer + rawReceiveBuffer = new byte[config.Mtu]; + + // create newClientEP either IPv4 or IPv6 + newClientEP = config.DualMode + ? new IPEndPoint(IPAddress.IPv6Any, 0) + : new IPEndPoint(IPAddress.Any, 0); + } + + public virtual bool IsActive() => socket != null; + + static Socket CreateServerSocket(bool DualMode, ushort port) + { + if (DualMode) + { + // IPv6 socket with DualMode @ "::" : port + Socket socket = new Socket(AddressFamily.InterNetworkV6, SocketType.Dgram, ProtocolType.Udp); + // settings DualMode may throw: + // https://learn.microsoft.com/en-us/dotnet/api/System.Net.Sockets.Socket.DualMode?view=net-7.0 + // attempt it, otherwise log but continue + // fixes: https://github.com/MirrorNetworking/Mirror/issues/3358 + try + { + socket.DualMode = true; + } + catch (NotSupportedException e) + { + Log.Warning($"Failed to set Dual Mode, continuing with IPv6 without Dual Mode. Error: {e}"); + } + socket.Bind(new IPEndPoint(IPAddress.IPv6Any, port)); + return socket; + } + else + { + // IPv4 socket @ "0.0.0.0" : port + Socket socket = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp); + socket.Bind(new IPEndPoint(IPAddress.Any, port)); + return socket; + } + } + + public virtual void Start(ushort port) + { + // only start once + if (socket != null) + { + Log.Warning("KcpServer: already started!"); + return; + } + + // listen + socket = CreateServerSocket(config.DualMode, port); + + // recv & send are called from main thread. + // need to ensure this never blocks. + // even a 1ms block per connection would stop us from scaling. + socket.Blocking = false; + + // configure buffer sizes + Common.ConfigureSocketBuffers(socket, config.RecvBufferSize, config.SendBufferSize); + } + + public void Send(int connectionId, ArraySegment segment, KcpChannel channel) + { + if (connections.TryGetValue(connectionId, out KcpServerConnection connection)) + { + connection.peer.SendData(segment, channel); + } + } + + public void Disconnect(int connectionId) + { + if (connections.TryGetValue(connectionId, out KcpServerConnection connection)) + { + connection.peer.Disconnect(); + } + } + + // expose the whole IPEndPoint, not just the IP address. some need it. + public IPEndPoint GetClientEndPoint(int connectionId) + { + if (connections.TryGetValue(connectionId, out KcpServerConnection connection)) + { + return connection.remoteEndPoint as IPEndPoint; + } + return null; + } + + // io - input. + // virtual so it may be modified for relays, nonalloc workaround, etc. + // https://github.com/vis2k/where-allocation + // bool return because not all receives may be valid. + // for example, relay may expect a certain header. + protected virtual bool RawReceiveFrom(out ArraySegment segment, out int connectionId) + { + segment = default; + connectionId = 0; + if (socket == null) return false; + + try + { + if (socket.ReceiveFromNonBlocking(rawReceiveBuffer, out segment, ref newClientEP)) + { + // set connectionId to hash from endpoint + connectionId = Common.ConnectionHash(newClientEP); + return true; + } + } + catch (SocketException e) + { + // NOTE: SocketException is not a subclass of IOException. + // the other end closing the connection is not an 'error'. + // but connections should never just end silently. + // at least log a message for easier debugging. + Log.Info($"KcpServer: ReceiveFrom failed: {e}"); + } + + return false; + } + + // io - out. + // virtual so it may be modified for relays, nonalloc workaround, etc. + // relays may need to prefix connId (and remoteEndPoint would be same for all) + protected virtual void RawSend(int connectionId, ArraySegment data) + { + // get the connection's endpoint + if (!connections.TryGetValue(connectionId, out KcpServerConnection connection)) + { + Log.Warning($"KcpServer: RawSend invalid connectionId={connectionId}"); + return; + } + + try + { + socket.SendToNonBlocking(data, connection.remoteEndPoint); + } + catch (SocketException e) + { + Log.Error($"KcpServer: SendTo failed: {e}"); + } + } + + protected virtual KcpServerConnection CreateConnection(int connectionId) + { + // events need to be wrapped with connectionIds + Action> RawSendWrap = + data => RawSend(connectionId, data); + + // create empty connection without peer first. + // we need it to set up peer callbacks. + // afterwards we assign the peer. + KcpServerConnection connection = new KcpServerConnection(newClientEP); + + // generate a random cookie for this connection to avoid UDP spoofing. + // needs to be random, but without allocations to avoid GC. + uint cookie = Common.GenerateCookie(); + + // set up peer with callbacks + KcpPeer peer = new KcpPeer(RawSendWrap, OnAuthenticatedWrap, OnDataWrap, OnDisconnectedWrap, OnErrorWrap, config, cookie); + + // assign peer to connection + connection.peer = peer; + return connection; + + // setup authenticated event that also adds to connections + void OnAuthenticatedWrap() + { + // only send handshake to client AFTER we received his + // handshake in OnAuthenticated. + // we don't want to reply to random internet messages + // with handshakes each time. + connection.peer.SendHandshake(); + + // add to connections dict after being authenticated. + connections.Add(connectionId, connection); + Log.Info($"KcpServer: added connection({connectionId})"); + + // setup Data + Disconnected events only AFTER the + // handshake. we don't want to fire OnServerDisconnected + // every time we receive invalid random data from the + // internet. + + // setup data event + + + // finally, call mirror OnConnected event + Log.Info($"KcpServer: OnConnected({connectionId})"); + OnConnected(connectionId); + } + + void OnDataWrap(ArraySegment message, KcpChannel channel) + { + // call mirror event + //Log.Info($"KCP: OnServerDataReceived({connectionId}, {BitConverter.ToString(message.Array, message.Offset, message.Count)})"); + OnData(connectionId, message, channel); + } + + void OnDisconnectedWrap() + { + // flag for removal + // (can't remove directly because connection is updated + // and event is called while iterating all connections) + connectionsToRemove.Add(connectionId); + + // call mirror event + Log.Info($"KcpServer: OnDisconnected({connectionId})"); + OnDisconnected(connectionId); + } + + void OnErrorWrap(ErrorCode error, string reason) + { + OnError(connectionId, error, reason); + } + } + + // receive + add + process once. + // best to call this as long as there is more data to receive. + void ProcessMessage(ArraySegment segment, int connectionId) + { + //Log.Info($"KCP: server raw recv {msgLength} bytes = {BitConverter.ToString(buffer, 0, msgLength)}"); + + // is this a new connection? + if (!connections.TryGetValue(connectionId, out KcpServerConnection connection)) + { + // create a new KcpConnection based on last received + // EndPoint. can be overwritten for where-allocation. + connection = CreateConnection(connectionId); + + // DO NOT add to connections yet. only if the first message + // is actually the kcp handshake. otherwise it's either: + // * random data from the internet + // * or from a client connection that we just disconnected + // but that hasn't realized it yet, still sending data + // from last session that we should absolutely ignore. + // + // + // TODO this allocates a new KcpConnection for each new + // internet connection. not ideal, but C# UDP Receive + // already allocated anyway. + // + // expecting a MAGIC byte[] would work, but sending the raw + // UDP message without kcp's reliability will have low + // probability of being received. + // + // for now, this is fine. + + + // now input the message & process received ones + // connected event was set up. + // tick will process the first message and adds the + // connection if it was the handshake. + connection.peer.RawInput(segment); + connection.peer.TickIncoming(); + + // again, do not add to connections. + // if the first message wasn't the kcp handshake then + // connection will simply be garbage collected. + } + // existing connection: simply input the message into kcp + else + { + connection.peer.RawInput(segment); + } + } + + // process incoming messages. should be called before updating the world. + // virtual because relay may need to inject their own ping or similar. + readonly HashSet connectionsToRemove = new HashSet(); + public virtual void TickIncoming() + { + // input all received messages into kcp + while (RawReceiveFrom(out ArraySegment segment, out int connectionId)) + { + ProcessMessage(segment, connectionId); + } + + // process inputs for all server connections + // (even if we didn't receive anything. need to tick ping etc.) + foreach (KcpServerConnection connection in connections.Values) + { + connection.peer.TickIncoming(); + } + + // remove disconnected connections + // (can't do it in connection.OnDisconnected because Tick is called + // while iterating connections) + foreach (int connectionId in connectionsToRemove) + { + connections.Remove(connectionId); + } + connectionsToRemove.Clear(); + } + + // process outgoing messages. should be called after updating the world. + // virtual because relay may need to inject their own ping or similar. + public virtual void TickOutgoing() + { + // flush all server connections + foreach (KcpServerConnection connection in connections.Values) + { + connection.peer.TickOutgoing(); + } + } + + // process incoming and outgoing for convenience. + // => ideally call ProcessIncoming() before updating the world and + // ProcessOutgoing() after updating the world for minimum latency + public virtual void Tick() + { + TickIncoming(); + TickOutgoing(); + } + + public virtual void Stop() + { + // need to clear connections, otherwise they are in next session. + // fixes https://github.com/vis2k/kcp2k/pull/47 + connections.Clear(); + socket?.Close(); + socket = null; + } + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServer.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServer.cs.meta new file mode 100644 index 0000000..ef720d4 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServer.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 9759159c6589494a9037f5e130a867ed +timeCreated: 1603787747 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServerConnection.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServerConnection.cs new file mode 100644 index 0000000..5b9c888 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServerConnection.cs @@ -0,0 +1,22 @@ +// server needs to store a separate KcpPeer for each connection. +// as well as remoteEndPoint so we know where to send data to. +using System.Net; + +namespace kcp2k +{ + // struct to avoid memory indirection + public struct KcpServerConnection + { + // peer can't be set from constructor at the moment. + // because peer callbacks need to know 'connection'. + // see KcpServer.CreateConnection. + public KcpPeer peer; + public readonly EndPoint remoteEndPoint; + + public KcpServerConnection(EndPoint remoteEndPoint) + { + peer = null; + this.remoteEndPoint = remoteEndPoint; + } + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServerConnection.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServerConnection.cs.meta new file mode 100644 index 0000000..10d9803 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/KcpServerConnection.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: 80a9b1ce9a6f14abeb32bfa9921d097b +timeCreated: 1602601483 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Log.cs b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Log.cs new file mode 100644 index 0000000..c28d8b8 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Log.cs @@ -0,0 +1,14 @@ +// A simple logger class that uses Console.WriteLine by default. +// Can also do Logger.LogMethod = Debug.Log for Unity etc. +// (this way we don't have to depend on UnityEngine) +using System; + +namespace kcp2k +{ + public static class Log + { + public static Action Info = Console.WriteLine; + public static Action Warning = Console.WriteLine; + public static Action Error = Console.Error.WriteLine; + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Log.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Log.cs.meta new file mode 100644 index 0000000..333bee5 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/highlevel/Log.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 7b5e1de98d6d84c3793a61cf7d8da9a4 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp.meta b/Assets/Mirror/Transports/KCP/kcp2k/kcp.meta new file mode 100644 index 0000000..a7d6e11 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 5cafb8851a0084f3e94a580c207b3923 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/AckItem.cs b/Assets/Mirror/Transports/KCP/kcp2k/kcp/AckItem.cs new file mode 100644 index 0000000..820f451 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/AckItem.cs @@ -0,0 +1,8 @@ +namespace kcp2k +{ + internal struct AckItem + { + internal uint serialNumber; + internal uint timestamp; + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/AckItem.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/kcp/AckItem.cs.meta new file mode 100644 index 0000000..301e2eb --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/AckItem.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 71f47cb11125d429e84e188a150f3ae5 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/AssemblyInfo.cs b/Assets/Mirror/Transports/KCP/kcp2k/kcp/AssemblyInfo.cs new file mode 100644 index 0000000..5fe5547 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/AssemblyInfo.cs @@ -0,0 +1,3 @@ +using System.Runtime.CompilerServices; + +[assembly: InternalsVisibleTo("kcp2k.Tests")] \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/AssemblyInfo.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/kcp/AssemblyInfo.cs.meta new file mode 100644 index 0000000..6b442a9 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/AssemblyInfo.cs.meta @@ -0,0 +1,3 @@ +fileFormatVersion: 2 +guid: aec6a15ac7bd43129317ea1f01f19782 +timeCreated: 1602665988 \ No newline at end of file diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/Kcp.cs b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Kcp.cs new file mode 100644 index 0000000..851faaa --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Kcp.cs @@ -0,0 +1,1118 @@ +// Kcp based on https://github.com/skywind3000/kcp +// Kept as close to original as possible. +using System; +using System.Collections.Generic; + +namespace kcp2k +{ + public class Kcp + { + // original Kcp has a define option, which is not defined by default: + // #define FASTACK_CONSERVE + + public const int RTO_NDL = 30; // no delay min rto + public const int RTO_MIN = 100; // normal min rto + public const int RTO_DEF = 200; // default RTO + public const int RTO_MAX = 60000; // maximum RTO + public const int CMD_PUSH = 81; // cmd: push data + public const int CMD_ACK = 82; // cmd: ack + public const int CMD_WASK = 83; // cmd: window probe (ask) + public const int CMD_WINS = 84; // cmd: window size (tell/insert) + public const int ASK_SEND = 1; // need to send CMD_WASK + public const int ASK_TELL = 2; // need to send CMD_WINS + public const int WND_SND = 32; // default send window + public const int WND_RCV = 128; // default receive window. must be >= max fragment size + public const int MTU_DEF = 1200; // default MTU (reduced to 1200 to fit all cases: https://en.wikipedia.org/wiki/Maximum_transmission_unit ; steam uses 1200 too!) + public const int ACK_FAST = 3; + public const int INTERVAL = 100; + public const int OVERHEAD = 24; + public const int FRG_MAX = byte.MaxValue; // kcp encodes 'frg' as byte. so we can only ever send up to 255 fragments. + public const int DEADLINK = 20; // default maximum amount of 'xmit' retransmissions until a segment is considered lost + public const int THRESH_INIT = 2; + public const int THRESH_MIN = 2; + public const int PROBE_INIT = 7000; // 7 secs to probe window size + public const int PROBE_LIMIT = 120000; // up to 120 secs to probe window + public const int FASTACK_LIMIT = 5; // max times to trigger fastack + + // kcp members. + internal int state; + readonly uint conv; // conversation + internal uint mtu; + internal uint mss; // maximum segment size := MTU - OVERHEAD + internal uint snd_una; // unacknowledged. e.g. snd_una is 9 it means 8 has been confirmed, 9 and 10 have been sent + internal uint snd_nxt; // forever growing send counter for sequence numbers + internal uint rcv_nxt; // forever growing receive counter for sequence numbers + internal uint ssthresh; // slow start threshold + internal int rx_rttval; // average deviation of rtt, used to measure the jitter of rtt + internal int rx_srtt; // smoothed round trip time (a weighted average of rtt) + internal int rx_rto; + internal int rx_minrto; + internal uint snd_wnd; // send window + internal uint rcv_wnd; // receive window + internal uint rmt_wnd; // remote window + internal uint cwnd; // congestion window + internal uint probe; + internal uint interval; + internal uint ts_flush; // last flush timestamp in milliseconds + internal uint xmit; + internal uint nodelay; // not a bool. original Kcp has '<2 else' check. + internal bool updated; + internal uint ts_probe; // probe timestamp + internal uint probe_wait; + internal uint dead_link; // maximum amount of 'xmit' retransmissions until a segment is considered lost + internal uint incr; + internal uint current; // current time (milliseconds). set by Update. + + internal int fastresend; + internal int fastlimit; + internal bool nocwnd; // congestion control, negated. heavily restricts send/recv window sizes. + internal readonly Queue snd_queue = new Queue(16); // send queue + internal readonly Queue rcv_queue = new Queue(16); // receive queue + // snd_buffer needs index removals. + // C# LinkedList allocates for each entry, so let's keep List for now. + internal readonly List snd_buf = new List(16); // send buffer + // rcv_buffer needs index insertions and backwards iteration. + // C# LinkedList allocates for each entry, so let's keep List for now. + internal readonly List rcv_buf = new List(16); // receive buffer + internal readonly List acklist = new List(16); + + // memory buffer + // size depends on MTU. + // MTU can be changed at runtime, which resizes the buffer. + internal byte[] buffer; + + // output function of type + readonly Action output; + + // segment pool to avoid allocations in C#. + // this is not part of the original C code. + readonly Pool SegmentPool = new Pool( + // create new segment + () => new Segment(), + // reset segment before reuse + (segment) => segment.Reset(), + // initial capacity + 32 + ); + + // ikcp_create + // create a new kcp control object, 'conv' must equal in two endpoint + // from the same connection. + public Kcp(uint conv, Action output) + { + this.conv = conv; + this.output = output; + snd_wnd = WND_SND; + rcv_wnd = WND_RCV; + rmt_wnd = WND_RCV; + mtu = MTU_DEF; + mss = mtu - OVERHEAD; + rx_rto = RTO_DEF; + rx_minrto = RTO_MIN; + interval = INTERVAL; + ts_flush = INTERVAL; + ssthresh = THRESH_INIT; + fastlimit = FASTACK_LIMIT; + dead_link = DEADLINK; + buffer = new byte[(mtu + OVERHEAD) * 3]; + } + + // ikcp_segment_new + // we keep the original function and add our pooling to it. + // this way we'll never miss it anywhere. + Segment SegmentNew() => SegmentPool.Take(); + + // ikcp_segment_delete + // we keep the original function and add our pooling to it. + // this way we'll never miss it anywhere. + void SegmentDelete(Segment seg) => SegmentPool.Return(seg); + + // calculate how many packets are waiting to be sent + public int WaitSnd => snd_buf.Count + snd_queue.Count; + + // ikcp_wnd_unused + // returns the remaining space in receive window (rcv_wnd - rcv_queue) + internal uint WndUnused() + { + if (rcv_queue.Count < rcv_wnd) + return rcv_wnd - (uint)rcv_queue.Count; + return 0; + } + + // ikcp_recv + // receive data from kcp state machine + // returns number of bytes read. + // returns negative on error. + // note: pass negative length to peek. + public int Receive(byte[] buffer, int len) + { + // kcp's ispeek feature is not supported. + // this makes 'merge fragment' code significantly easier because + // we can iterate while queue.Count > 0 and dequeue each time. + // if we had to consider ispeek then count would always be > 0 and + // we would have to remove only after the loop. + // + //bool ispeek = len < 0; + if (len < 0) + throw new NotSupportedException("Receive ispeek for negative len is not supported!"); + + if (rcv_queue.Count == 0) + return -1; + + if (len < 0) len = -len; + + int peeksize = PeekSize(); + + if (peeksize < 0) + return -2; + + if (peeksize > len) + return -3; + + bool recover = rcv_queue.Count >= rcv_wnd; + + // merge fragment. + int offset = 0; + len = 0; + // original KCP iterates rcv_queue and deletes if !ispeek. + // removing from a c# queue while iterating is not possible, but + // we can change to 'while Count > 0' and remove every time. + // (we can remove every time because we removed ispeek support!) + while (rcv_queue.Count > 0) + { + // unlike original kcp, we dequeue instead of just getting the + // entry. this is fine because we remove it in ANY case. + Segment seg = rcv_queue.Dequeue(); + + // copy segment data into our buffer + Buffer.BlockCopy(seg.data.GetBuffer(), 0, buffer, offset, (int)seg.data.Position); + offset += (int)seg.data.Position; + + len += (int)seg.data.Position; + uint fragment = seg.frg; + + // note: ispeek is not supported in order to simplify this loop + + // unlike original kcp, we don't need to remove seg from queue + // because we already dequeued it. + // simply delete it + SegmentDelete(seg); + + if (fragment == 0) + break; + } + + // move available data from rcv_buf -> rcv_queue + int removed = 0; + foreach (Segment seg in rcv_buf) + { + if (seg.sn == rcv_nxt && rcv_queue.Count < rcv_wnd) + { + // can't remove while iterating. remember how many to remove + // and do it after the loop. + // note: don't return segment. we only add it to rcv_queue + ++removed; + // add + rcv_queue.Enqueue(seg); + // increase sequence number for next segment + rcv_nxt++; + } + else + { + break; + } + } + rcv_buf.RemoveRange(0, removed); + + // fast recover + if (rcv_queue.Count < rcv_wnd && recover) + { + // ready to send back CMD_WINS in flush + // tell remote my window size + probe |= ASK_TELL; + } + + return len; + } + + // ikcp_peeksize + // check the size of next message in the recv queue. + // returns -1 if there is no message, or if the message is still incomplete. + public int PeekSize() + { + int length = 0; + + // empty queue? + if (rcv_queue.Count == 0) return -1; + + // peek the first segment + Segment seq = rcv_queue.Peek(); + + // seg.frg is 0 if the message requires no fragmentation. + // in that case, the segment's size is the final message size. + if (seq.frg == 0) return (int)seq.data.Position; + + // check if all fragment parts were received yet. + // seg.frg is the n-th fragment, but in reverse. + // this way the first received segment tells us how many fragments there are for the message. + // for example, if a message contains 3 segments: + // first segment: .frg is 2 (index in reverse) + // second segment: .frg is 1 (index in reverse) + // third segment: .frg is 0 (index in reverse) + if (rcv_queue.Count < seq.frg + 1) return -1; + + // recv_queue contains all the fragments necessary to reconstruct the message. + // sum all fragment's sizes to get the full message size. + foreach (Segment seg in rcv_queue) + { + length += (int)seg.data.Position; + if (seg.frg == 0) break; + } + + return length; + } + + // ikcp_send + // splits message into MTU sized fragments, adds them to snd_queue. + public int Send(byte[] buffer, int offset, int len) + { + // fragment count + int count; + + if (len < 0) return -1; + + // streaming mode: removed. we never want to send 'hello' and + // receive 'he' 'll' 'o'. we want to always receive 'hello'. + + // calculate amount of fragments necessary for 'len' + if (len <= mss) count = 1; + else count = (int)((len + mss - 1) / mss); + + // IMPORTANT kcp encodes 'frg' as 1 byte. + // so we can only support up to 255 fragments. + // (which limits max message size to around 288 KB) + // this is difficult to debug. let's make this 100% obvious. + if (count > FRG_MAX) + throw new Exception($"Send len={len} requires {count} fragments, but kcp can only handle up to {FRG_MAX} fragments."); + + // original kcp uses WND_RCV const instead of rcv_wnd runtime: + // https://github.com/skywind3000/kcp/pull/291/files + // which always limits max message size to 144 KB: + //if (count >= WND_RCV) return -2; + // using configured rcv_wnd uncorks max message size to 'any': + if (count >= rcv_wnd) return -2; + + if (count == 0) count = 1; + + // fragment + for (int i = 0; i < count; i++) + { + int size = len > (int)mss ? (int)mss : len; + Segment seg = SegmentNew(); + + if (len > 0) + { + seg.data.Write(buffer, offset, size); + } + // seg.len = size: WriteBytes sets segment.Position! + + // set fragment number. + // if the message requires no fragmentation, then + // seg.frg becomes 1-0-1 = 0 + seg.frg = (uint)(count - i - 1); + snd_queue.Enqueue(seg); + offset += size; + len -= size; + } + + return 0; + } + + // ikcp_update_ack + void UpdateAck(int rtt) // round trip time + { + // https://tools.ietf.org/html/rfc6298 + if (rx_srtt == 0) + { + rx_srtt = rtt; + rx_rttval = rtt / 2; + } + else + { + int delta = rtt - rx_srtt; + if (delta < 0) delta = -delta; + rx_rttval = (3 * rx_rttval + delta) / 4; + rx_srtt = (7 * rx_srtt + rtt) / 8; + if (rx_srtt < 1) rx_srtt = 1; + } + int rto = rx_srtt + Math.Max((int)interval, 4 * rx_rttval); + rx_rto = Utils.Clamp(rto, rx_minrto, RTO_MAX); + } + + // ikcp_shrink_buf + internal void ShrinkBuf() + { + if (snd_buf.Count > 0) + { + Segment seg = snd_buf[0]; + snd_una = seg.sn; + } + else + { + snd_una = snd_nxt; + } + } + + // ikcp_parse_ack + // removes the segment with 'sn' from send buffer + internal void ParseAck(uint sn) + { + if (Utils.TimeDiff(sn, snd_una) < 0 || Utils.TimeDiff(sn, snd_nxt) >= 0) + return; + + // for-int so we can erase while iterating + for (int i = 0; i < snd_buf.Count; ++i) + { + // is this the segment? + Segment seg = snd_buf[i]; + if (sn == seg.sn) + { + // remove and return + snd_buf.RemoveAt(i); + SegmentDelete(seg); + break; + } + if (Utils.TimeDiff(sn, seg.sn) < 0) + { + break; + } + } + } + + // ikcp_parse_una + // removes all unacknowledged segments with sequence numbers < una from send buffer + internal void ParseUna(uint una) + { + int removed = 0; + foreach (Segment seg in snd_buf) + { + // if (Utils.TimeDiff(una, seg.sn) > 0) + if (seg.sn < una) + { + // can't remove while iterating. remember how many to remove + // and do it after the loop. + ++removed; + SegmentDelete(seg); + } + else + { + break; + } + } + snd_buf.RemoveRange(0, removed); + } + + // ikcp_parse_fastack + internal void ParseFastack(uint sn, uint ts) // serial number, timestamp + { + // sn needs to be between snd_una and snd_nxt + // if !(snd_una <= sn && sn < snd_nxt) return; + + // if (Utils.TimeDiff(sn, snd_una) < 0) + if (sn < snd_una) + return; + + // if (Utils.TimeDiff(sn, snd_nxt) >= 0) + if (sn >= snd_nxt) + return; + + foreach (Segment seg in snd_buf) + { + // if (Utils.TimeDiff(sn, seg.sn) < 0) + if (sn < seg.sn) + { + break; + } + else if (sn != seg.sn) + { +#if !FASTACK_CONSERVE + seg.fastack++; +#else + if (Utils.TimeDiff(ts, seg.ts) >= 0) + seg.fastack++; +#endif + } + } + } + + // ikcp_ack_push + // appends an ack. + void AckPush(uint sn, uint ts) // serial number, timestamp + { + acklist.Add(new AckItem{ serialNumber = sn, timestamp = ts }); + } + + // ikcp_parse_data + void ParseData(Segment newseg) + { + uint sn = newseg.sn; + + if (Utils.TimeDiff(sn, rcv_nxt + rcv_wnd) >= 0 || + Utils.TimeDiff(sn, rcv_nxt) < 0) + { + SegmentDelete(newseg); + return; + } + + InsertSegmentInReceiveBuffer(newseg); + MoveReceiveBufferReadySegmentsToQueue(); + } + + // inserts the segment into rcv_buf, ordered by seg.sn. + // drops the segment if one with the same seg.sn already exists. + // goes through receive buffer in reverse order for performance. + // + // note: see KcpTests.InsertSegmentInReceiveBuffer test! + // note: 'insert or delete' can be done in different ways, but let's + // keep consistency with original C kcp. + internal void InsertSegmentInReceiveBuffer(Segment newseg) + { + bool repeat = false; // 'duplicate' + + // original C iterates backwards, so we need to do that as well. + // note if rcv_buf.Count == 0, i becomes -1 and no looping happens. + int i; + for (i = rcv_buf.Count - 1; i >= 0; i--) + { + Segment seg = rcv_buf[i]; + if (seg.sn == newseg.sn) + { + // duplicate segment found. nothing will be added. + repeat = true; + break; + } + if (Utils.TimeDiff(newseg.sn, seg.sn) > 0) + { + // this entry's sn is < newseg.sn, so let's stop + break; + } + } + + // no duplicate? then insert. + if (!repeat) + { + rcv_buf.Insert(i + 1, newseg); + } + // duplicate. just delete it. + else + { + SegmentDelete(newseg); + } + } + + // move ready segments from rcv_buf -> rcv_queue. + // moves only the ready segments which are in rcv_nxt sequence order. + // some may still be missing an inserted later. + void MoveReceiveBufferReadySegmentsToQueue() + { + int removed = 0; + foreach (Segment seg in rcv_buf) + { + // move segments while they are in 'rcv_nxt' sequence order. + // some may still be missing and inserted later, in this case it stops immediately + // because segments always need to be received in the exact sequence order. + if (seg.sn == rcv_nxt && rcv_queue.Count < rcv_wnd) + { + // can't remove while iterating. remember how many to remove + // and do it after the loop. + ++removed; + rcv_queue.Enqueue(seg); + // increase sequence number for next segment + rcv_nxt++; + } + else + { + break; + } + } + rcv_buf.RemoveRange(0, removed); + } + + // ikcp_input + // used when you receive a low level packet (e.g. UDP packet) + // => original kcp uses offset=0, we made it a parameter so that high + // level can skip the channel byte more easily + public int Input(byte[] data, int offset, int size) + { + uint prev_una = snd_una; + uint maxack = 0; + uint latest_ts = 0; + int flag = 0; + + if (data == null || size < OVERHEAD) return -1; + + while (true) + { + // enough data left to decode segment (aka OVERHEAD bytes)? + if (size < OVERHEAD) break; + + // decode segment + offset += Utils.Decode32U(data, offset, out uint conv_); + if (conv_ != conv) return -1; + + offset += Utils.Decode8u(data, offset, out byte cmd); + // IMPORTANT kcp encodes 'frg' as 1 byte. + // so we can only support up to 255 fragments. + // (which limits max message size to around 288 KB) + offset += Utils.Decode8u(data, offset, out byte frg); + offset += Utils.Decode16U(data, offset, out ushort wnd); + offset += Utils.Decode32U(data, offset, out uint ts); + offset += Utils.Decode32U(data, offset, out uint sn); + offset += Utils.Decode32U(data, offset, out uint una); + offset += Utils.Decode32U(data, offset, out uint len); + + // reduce remaining size by what was read + size -= OVERHEAD; + + // enough remaining to read 'len' bytes of the actual payload? + // note: original kcp casts uint len to int for <0 check. + if (size < len || (int)len < 0) return -2; + + // validate command type + if (cmd != CMD_PUSH && cmd != CMD_ACK && + cmd != CMD_WASK && cmd != CMD_WINS) + return -3; + + rmt_wnd = wnd; + ParseUna(una); + ShrinkBuf(); + + if (cmd == CMD_ACK) + { + if (Utils.TimeDiff(current, ts) >= 0) + { + UpdateAck(Utils.TimeDiff(current, ts)); + } + ParseAck(sn); + ShrinkBuf(); + if (flag == 0) + { + flag = 1; + maxack = sn; + latest_ts = ts; + } + else + { + if (Utils.TimeDiff(sn, maxack) > 0) + { +#if !FASTACK_CONSERVE + maxack = sn; + latest_ts = ts; +#else + if (Utils.TimeDiff(ts, latest_ts) > 0) + { + maxack = sn; + latest_ts = ts; + } +#endif + } + } + } + else if (cmd == CMD_PUSH) + { + if (Utils.TimeDiff(sn, rcv_nxt + rcv_wnd) < 0) + { + AckPush(sn, ts); + if (Utils.TimeDiff(sn, rcv_nxt) >= 0) + { + Segment seg = SegmentNew(); + seg.conv = conv_; + seg.cmd = cmd; + seg.frg = frg; + seg.wnd = wnd; + seg.ts = ts; + seg.sn = sn; + seg.una = una; + if (len > 0) + { + seg.data.Write(data, offset, (int)len); + } + ParseData(seg); + } + } + } + else if (cmd == CMD_WASK) + { + // ready to send back CMD_WINS in flush + // tell remote my window size + probe |= ASK_TELL; + } + else if (cmd == CMD_WINS) + { + // do nothing + } + else + { + return -3; + } + + offset += (int)len; + size -= (int)len; + } + + if (flag != 0) + { + ParseFastack(maxack, latest_ts); + } + + // cwnd update when packet arrived + if (Utils.TimeDiff(snd_una, prev_una) > 0) + { + if (cwnd < rmt_wnd) + { + if (cwnd < ssthresh) + { + cwnd++; + incr += mss; + } + else + { + if (incr < mss) incr = mss; + incr += (mss * mss) / incr + (mss / 16); + if ((cwnd + 1) * mss <= incr) + { + cwnd = (incr + mss - 1) / ((mss > 0) ? mss : 1); + } + } + if (cwnd > rmt_wnd) + { + cwnd = rmt_wnd; + incr = rmt_wnd * mss; + } + } + } + + return 0; + } + + // flush helper function + void MakeSpace(ref int size, int space) + { + if (size + space > mtu) + { + output(buffer, size); + size = 0; + } + } + + // flush helper function + void FlushBuffer(int size) + { + // flush buffer up to 'offset' (<= MTU) + if (size > 0) + { + output(buffer, size); + } + } + + // ikcp_flush + // flush remain ack segments. + // flush may output multiple <= MTU messages from MakeSpace / FlushBuffer. + // the amount of messages depends on the sliding window. + // configured by send/receive window sizes + congestion control. + // with congestion control, the window will be extremely small(!). + public void Flush() + { + int size = 0; // amount of bytes to flush. 'buffer ptr' in C. + bool lost = false; // lost segments + + // update needs to be called before flushing + if (!updated) return; + + // kcp only stack allocates a segment here for performance, leaving + // its data buffer null because this segment's data buffer is never + // used. that's fine in C, but in C# our segment is a class so we + // need to allocate and most importantly, not forget to deallocate + // it before returning. + Segment seg = SegmentNew(); + seg.conv = conv; + seg.cmd = CMD_ACK; + seg.wnd = WndUnused(); + seg.una = rcv_nxt; + + // flush acknowledges + foreach (AckItem ack in acklist) + { + MakeSpace(ref size, OVERHEAD); + // ikcp_ack_get assigns ack[i] to seg.sn, seg.ts + seg.sn = ack.serialNumber; + seg.ts = ack.timestamp; + size += seg.Encode(buffer, size); + } + acklist.Clear(); + + // probe window size (if remote window size equals zero) + if (rmt_wnd == 0) + { + if (probe_wait == 0) + { + probe_wait = PROBE_INIT; + ts_probe = current + probe_wait; + } + else + { + if (Utils.TimeDiff(current, ts_probe) >= 0) + { + if (probe_wait < PROBE_INIT) + probe_wait = PROBE_INIT; + probe_wait += probe_wait / 2; + if (probe_wait > PROBE_LIMIT) + probe_wait = PROBE_LIMIT; + ts_probe = current + probe_wait; + probe |= ASK_SEND; + } + } + } + else + { + ts_probe = 0; + probe_wait = 0; + } + + // flush window probing commands + if ((probe & ASK_SEND) != 0) + { + seg.cmd = CMD_WASK; + MakeSpace(ref size, OVERHEAD); + size += seg.Encode(buffer, size); + } + + // flush window probing commands + if ((probe & ASK_TELL) != 0) + { + seg.cmd = CMD_WINS; + MakeSpace(ref size, OVERHEAD); + size += seg.Encode(buffer, size); + } + + probe = 0; + + // calculate the window size which is currently safe to send. + // it's send window, or remote window, whatever is smaller. + // for our max + uint cwnd_ = Math.Min(snd_wnd, rmt_wnd); + + // double negative: if congestion window is enabled: + // limit window size to cwnd. + // + // note this may heavily limit window sizes. + // for our max message size test with super large windows of 32k, + // 'congestion window' limits it down from 32.000 to 2. + if (!nocwnd) cwnd_ = Math.Min(cwnd, cwnd_); + + // move cwnd_ 'window size' messages from snd_queue to snd_buf + // 'snd_nxt' is what we want to send. + // 'snd_una' is what hasn't been acked yet. + // copy up to 'cwnd_' difference between them (sliding window) + while (Utils.TimeDiff(snd_nxt, snd_una + cwnd_) < 0) + { + if (snd_queue.Count == 0) break; + + Segment newseg = snd_queue.Dequeue(); + + newseg.conv = conv; + newseg.cmd = CMD_PUSH; + newseg.wnd = seg.wnd; + newseg.ts = current; + newseg.sn = snd_nxt; + snd_nxt += 1; // increase sequence number for next segment + newseg.una = rcv_nxt; + newseg.resendts = current; + newseg.rto = rx_rto; + newseg.fastack = 0; + newseg.xmit = 0; + snd_buf.Add(newseg); + } + + // calculate resent + uint resent = fastresend > 0 ? (uint)fastresend : 0xffffffff; + uint rtomin = nodelay == 0 ? (uint)rx_rto >> 3 : 0; + + // flush data segments + int change = 0; + foreach (Segment segment in snd_buf) + { + bool needsend = false; + + // initial transmit + if (segment.xmit == 0) + { + needsend = true; + segment.xmit++; + segment.rto = rx_rto; + segment.resendts = current + (uint)segment.rto + rtomin; + } + // RTO + else if (Utils.TimeDiff(current, segment.resendts) >= 0) + { + needsend = true; + segment.xmit++; + xmit++; + if (nodelay == 0) + { + segment.rto += Math.Max(segment.rto, rx_rto); + } + else + { + int step = (nodelay < 2) ? segment.rto : rx_rto; + segment.rto += step / 2; + } + segment.resendts = current + (uint)segment.rto; + lost = true; + } + // fast retransmit + else if (segment.fastack >= resent) + { + if (segment.xmit <= fastlimit || fastlimit <= 0) + { + needsend = true; + segment.xmit++; + segment.fastack = 0; + segment.resendts = current + (uint)segment.rto; + change++; + } + } + + if (needsend) + { + segment.ts = current; + segment.wnd = seg.wnd; + segment.una = rcv_nxt; + + int need = OVERHEAD + (int)segment.data.Position; + MakeSpace(ref size, need); + + size += segment.Encode(buffer, size); + + if (segment.data.Position > 0) + { + Buffer.BlockCopy(segment.data.GetBuffer(), 0, buffer, size, (int)segment.data.Position); + size += (int)segment.data.Position; + } + + // dead link happens if a message was resent N times, but an + // ack was still not received. + if (segment.xmit >= dead_link) + { + state = -1; + } + } + } + + // kcp stackallocs 'seg'. our C# segment is a class though, so we + // need to properly delete and return it to the pool now that we are + // done with it. + SegmentDelete(seg); + + // flush remaining segments + FlushBuffer(size); + + // update ssthresh + // rate halving, https://tools.ietf.org/html/rfc6937 + if (change > 0) + { + uint inflight = snd_nxt - snd_una; + ssthresh = inflight / 2; + if (ssthresh < THRESH_MIN) + ssthresh = THRESH_MIN; + cwnd = ssthresh + resent; + incr = cwnd * mss; + } + + // congestion control, https://tools.ietf.org/html/rfc5681 + if (lost) + { + // original C uses 'cwnd', not kcp->cwnd! + ssthresh = cwnd_ / 2; + if (ssthresh < THRESH_MIN) + ssthresh = THRESH_MIN; + cwnd = 1; + incr = mss; + } + + if (cwnd < 1) + { + cwnd = 1; + incr = mss; + } + } + + // ikcp_update + // update state (call it repeatedly, every 10ms-100ms), or you can ask + // Check() when to call it again (without Input/Send calling). + // + // 'current' - current timestamp in millisec. pass it to Kcp so that + // Kcp doesn't have to do any stopwatch/deltaTime/etc. code + // + // time as uint, likely to minimize bandwidth. + // uint.max = 4294967295 ms = 1193 hours = 49 days + public void Update(uint currentTimeMilliSeconds) + { + current = currentTimeMilliSeconds; + + // not updated yet? then set updated and last flush time. + if (!updated) + { + updated = true; + ts_flush = current; + } + + // slap is time since last flush in milliseconds + int slap = Utils.TimeDiff(current, ts_flush); + + // hard limit: if 10s elapsed, always flush no matter what + if (slap >= 10000 || slap < -10000) + { + ts_flush = current; + slap = 0; + } + + // last flush is increased by 'interval' each time. + // so slap >= is a strange way to check if interval has elapsed yet. + if (slap >= 0) + { + // increase last flush time by one interval + ts_flush += interval; + + // if last flush is still behind, increase it to current + interval + // if (Utils.TimeDiff(current, ts_flush) >= 0) // original kcp.c + if (current >= ts_flush) // less confusing + { + ts_flush = current + interval; + } + Flush(); + } + } + + // ikcp_check + // Determine when should you invoke update + // Returns when you should invoke update in millisec, if there is no + // input/send calling. you can call update in that time, instead of + // call update repeatly. + // + // Important to reduce unnecessary update invoking. use it to schedule + // update (e.g. implementing an epoll-like mechanism, or optimize update + // when handling massive kcp connections). + public uint Check(uint current_) + { + uint ts_flush_ = ts_flush; + // int tm_flush = 0x7fffffff; original kcp: useless assignment + int tm_packet = 0x7fffffff; + + if (!updated) + { + return current_; + } + + if (Utils.TimeDiff(current_, ts_flush_) >= 10000 || + Utils.TimeDiff(current_, ts_flush_) < -10000) + { + ts_flush_ = current_; + } + + if (Utils.TimeDiff(current_, ts_flush_) >= 0) + { + return current_; + } + + int tm_flush = Utils.TimeDiff(ts_flush_, current_); + + foreach (Segment seg in snd_buf) + { + int diff = Utils.TimeDiff(seg.resendts, current_); + if (diff <= 0) + { + return current_; + } + if (diff < tm_packet) tm_packet = diff; + } + + uint minimal = (uint)(tm_packet < tm_flush ? tm_packet : tm_flush); + if (minimal >= interval) minimal = interval; + + return current_ + minimal; + } + + // ikcp_setmtu + // Change MTU (Maximum Transmission Unit) size. + public void SetMtu(uint mtu) + { + if (mtu < 50 || mtu < OVERHEAD) + throw new ArgumentException("MTU must be higher than 50 and higher than OVERHEAD"); + + buffer = new byte[(mtu + OVERHEAD) * 3]; + this.mtu = mtu; + mss = mtu - OVERHEAD; + } + + // ikcp_interval + public void SetInterval(uint interval) + { + // clamp interval between 10 and 5000 + if (interval > 5000) interval = 5000; + else if (interval < 10) interval = 10; + this.interval = interval; + } + + // ikcp_nodelay + // configuration: https://github.com/skywind3000/kcp/blob/master/README.en.md#protocol-configuration + // nodelay : Whether nodelay mode is enabled, 0 is not enabled; 1 enabled. + // interval ：Protocol internal work interval, in milliseconds, such as 10 ms or 20 ms. + // resend ：Fast retransmission mode, 0 represents off by default, 2 can be set (2 ACK spans will result in direct retransmission) + // nc ：Whether to turn off flow control, 0 represents “Do not turn off” by default, 1 represents “Turn off”. + // Normal Mode: ikcp_nodelay(kcp, 0, 40, 0, 0); + // Turbo Mode： ikcp_nodelay(kcp, 1, 10, 2, 1); + public void SetNoDelay(uint nodelay, uint interval = INTERVAL, int resend = 0, bool nocwnd = false) + { + this.nodelay = nodelay; + if (nodelay != 0) + { + rx_minrto = RTO_NDL; + } + else + { + rx_minrto = RTO_MIN; + } + + if (interval >= 0) + { + // clamp interval between 10 and 5000 + if (interval > 5000) interval = 5000; + else if (interval < 10) interval = 10; + this.interval = interval; + } + + if (resend >= 0) + { + fastresend = resend; + } + + this.nocwnd = nocwnd; + } + + // ikcp_wndsize + public void SetWindowSize(uint sendWindow, uint receiveWindow) + { + if (sendWindow > 0) + { + snd_wnd = sendWindow; + } + + if (receiveWindow > 0) + { + // must >= max fragment size + rcv_wnd = Math.Max(receiveWindow, WND_RCV); + } + } + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/Kcp.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Kcp.cs.meta new file mode 100644 index 0000000..935b423 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Kcp.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a59b1cae10a334faf807432ab472f212 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/Pool.cs b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Pool.cs new file mode 100644 index 0000000..81b5289 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Pool.cs @@ -0,0 +1,46 @@ +// Pool to avoid allocations (from libuv2k & Mirror) +using System; +using System.Collections.Generic; + +namespace kcp2k +{ + public class Pool + { + // Mirror is single threaded, no need for concurrent collections + readonly Stack objects = new Stack(); + + // some types might need additional parameters in their constructor, so + // we use a Func generator + readonly Func objectGenerator; + + // some types might need additional cleanup for returned objects + readonly Action objectResetter; + + public Pool(Func objectGenerator, Action objectResetter, int initialCapacity) + { + this.objectGenerator = objectGenerator; + this.objectResetter = objectResetter; + + // allocate an initial pool so we have fewer (if any) + // allocations in the first few frames (or seconds). + for (int i = 0; i < initialCapacity; ++i) + objects.Push(objectGenerator()); + } + + // take an element from the pool, or create a new one if empty + public T Take() => objects.Count > 0 ? objects.Pop() : objectGenerator(); + + // return an element to the pool + public void Return(T item) + { + objectResetter(item); + objects.Push(item); + } + + // clear the pool + public void Clear() => objects.Clear(); + + // count to see how many objects are in the pool. useful for tests. + public int Count => objects.Count; + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/Pool.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Pool.cs.meta new file mode 100644 index 0000000..5eba0e0 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Pool.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 35c07818fc4784bb4ba472c8e5029002 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/Segment.cs b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Segment.cs new file mode 100644 index 0000000..d7e4131 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Segment.cs @@ -0,0 +1,78 @@ +using System.IO; + +namespace kcp2k +{ + // KCP Segment Definition + internal class Segment + { + internal uint conv; // conversation + internal uint cmd; // command, e.g. Kcp.CMD_ACK etc. + // fragment (sent as 1 byte). + // 0 if unfragmented, otherwise fragment numbers in reverse: N,..,32,1,0 + // this way the first received segment tells us how many fragments there are. + internal uint frg; + internal uint wnd; // window size that the receive can currently receive + internal uint ts; // timestamp + internal uint sn; // sequence number + internal uint una; + internal uint resendts; // resend timestamp + internal int rto; + internal uint fastack; + internal uint xmit; // retransmit count + + // we need an auto scaling byte[] with a WriteBytes function. + // MemoryStream does that perfectly, no need to reinvent the wheel. + // note: no need to pool it, because Segment is already pooled. + // -> default MTU as initial capacity to avoid most runtime resizing/allocations + // + // .data is only used for Encode(), which always fits it into a buffer. + // the buffer is always Kcp.buffer. Kcp ctor creates the buffer of size: + // (mtu + OVERHEAD) * 3 bytes. + // in other words, Encode only ever writes up to the above amount of bytes. + internal MemoryStream data = new MemoryStream(Kcp.MTU_DEF); + + // ikcp_encode_seg + // encode a segment into buffer. + // buffer is always Kcp.buffer. Kcp ctor creates the buffer of size: + // (mtu + OVERHEAD) * 3 bytes. + // in other words, Encode only ever writes up to the above amount of bytes. + internal int Encode(byte[] ptr, int offset) + { + int previousPosition = offset; + + offset += Utils.Encode32U(ptr, offset, conv); + offset += Utils.Encode8u(ptr, offset, (byte)cmd); + // IMPORTANT kcp encodes 'frg' as 1 byte. + // so we can only support up to 255 fragments. + // (which limits max message size to around 288 KB) + offset += Utils.Encode8u(ptr, offset, (byte)frg); + offset += Utils.Encode16U(ptr, offset, (ushort)wnd); + offset += Utils.Encode32U(ptr, offset, ts); + offset += Utils.Encode32U(ptr, offset, sn); + offset += Utils.Encode32U(ptr, offset, una); + offset += Utils.Encode32U(ptr, offset, (uint)data.Position); + + int written = offset - previousPosition; + return written; + } + + // reset to return a fresh segment to the pool + internal void Reset() + { + conv = 0; + cmd = 0; + frg = 0; + wnd = 0; + ts = 0; + sn = 0; + una = 0; + rto = 0; + xmit = 0; + resendts = 0; + fastack = 0; + + // keep buffer for next pool usage, but reset length (= bytes written) + data.SetLength(0); + } + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/Segment.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Segment.cs.meta new file mode 100644 index 0000000..d14dc1a --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Segment.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: fc58706a05dd3442c8fde858d5266855 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/Utils.cs b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Utils.cs new file mode 100644 index 0000000..2cb7462 --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Utils.cs @@ -0,0 +1,76 @@ +using System.Runtime.CompilerServices; + +namespace kcp2k +{ + public static partial class Utils + { + // Clamp so we don't have to depend on UnityEngine + public static int Clamp(int value, int min, int max) + { + if (value < min) return min; + if (value > max) return max; + return value; + } + + // encode 8 bits unsigned int + public static int Encode8u(byte[] p, int offset, byte value) + { + p[0 + offset] = value; + return 1; + } + + // decode 8 bits unsigned int + public static int Decode8u(byte[] p, int offset, out byte value) + { + value = p[0 + offset]; + return 1; + } + + // encode 16 bits unsigned int (lsb) + public static int Encode16U(byte[] p, int offset, ushort value) + { + p[0 + offset] = (byte)(value >> 0); + p[1 + offset] = (byte)(value >> 8); + return 2; + } + + // decode 16 bits unsigned int (lsb) + public static int Decode16U(byte[] p, int offset, out ushort value) + { + ushort result = 0; + result |= p[0 + offset]; + result |= (ushort)(p[1 + offset] << 8); + value = result; + return 2; + } + + // encode 32 bits unsigned int (lsb) + public static int Encode32U(byte[] p, int offset, uint value) + { + p[0 + offset] = (byte)(value >> 0); + p[1 + offset] = (byte)(value >> 8); + p[2 + offset] = (byte)(value >> 16); + p[3 + offset] = (byte)(value >> 24); + return 4; + } + + // decode 32 bits unsigned int (lsb) + public static int Decode32U(byte[] p, int offset, out uint value) + { + uint result = 0; + result |= p[0 + offset]; + result |= (uint)(p[1 + offset] << 8); + result |= (uint)(p[2 + offset] << 16); + result |= (uint)(p[3 + offset] << 24); + value = result; + return 4; + } + + // timediff was a macro in original Kcp. let's inline it if possible. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static int TimeDiff(uint later, uint earlier) + { + return (int)(later - earlier); + } + } +} diff --git a/Assets/Mirror/Transports/KCP/kcp2k/kcp/Utils.cs.meta b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Utils.cs.meta new file mode 100644 index 0000000..86118bc --- /dev/null +++ b/Assets/Mirror/Transports/KCP/kcp2k/kcp/Utils.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ef959eb716205bd48b050f010a9a35ae +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Latency.meta b/Assets/Mirror/Transports/Latency.meta new file mode 100644 index 0000000..07d138e --- /dev/null +++ b/Assets/Mirror/Transports/Latency.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 397bb578e2bb049ebac1e29effa9d298 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Latency/LatencySimulation.cs b/Assets/Mirror/Transports/Latency/LatencySimulation.cs new file mode 100644 index 0000000..af819f1 --- /dev/null +++ b/Assets/Mirror/Transports/Latency/LatencySimulation.cs @@ -0,0 +1,319 @@ +// wraps around a transport and adds latency/loss/scramble simulation. +// +// reliable: latency +// unreliable: latency, loss, scramble (unreliable isn't ordered so we scramble) +// +// IMPORTANT: use Time.unscaledTime instead of Time.time. +// some games might have Time.timeScale modified. +// see also: https://github.com/vis2k/Mirror/issues/2907 +using System; +using System.Collections.Generic; +using UnityEngine; +using UnityEngine.Serialization; + +namespace Mirror +{ + struct QueuedMessage + { + public int connectionId; + public byte[] bytes; + public double time; + } + + [HelpURL("https://mirror-networking.gitbook.io/docs/transports/latency-simulaton-transport")] + [DisallowMultipleComponent] + public class LatencySimulation : Transport + { + public Transport wrap; + + [Header("Common")] + [Tooltip("Jitter latency via perlin(Time * jitterSpeed) * jitter")] + [FormerlySerializedAs("latencySpikeMultiplier")] + [Range(0, 1)] public float jitter = 0.02f; + [Tooltip("Jitter latency via perlin(Time * jitterSpeed) * jitter")] + [FormerlySerializedAs("latencySpikeSpeedMultiplier")] + public float jitterSpeed = 1; + + [Header("Reliable Messages")] + [Tooltip("Reliable latency in milliseconds (1000 = 1 second)")] + [Range(0, 10000)] public float reliableLatency = 100; + // note: packet loss over reliable manifests itself in latency. + // don't need (and can't add) a loss option here. + // note: reliable is ordered by definition. no need to scramble. + + [Header("Unreliable Messages")] + [Tooltip("Packet loss in %\n2% recommended for long term play testing, upto 5% for short bursts.\nAnything higher, or for a prolonged amount of time, suggests user has a connection fault.")] + [Range(0, 100)] public float unreliableLoss = 2; + [Tooltip("Unreliable latency in milliseconds (1000 = 1 second) \n100ms recommended for long term play testing, upto 500ms for short bursts.\nAnything higher, or for a prolonged amount of time, suggests user has a connection fault.")] + [Range(0, 10000)] public float unreliableLatency = 100; + [Tooltip("Scramble % of unreliable messages, just like over the real network. Mirror unreliable is unordered.")] + [Range(0, 100)] public float unreliableScramble = 2; + + // message queues + // list so we can insert randomly (scramble) + List reliableClientToServer = new List(); + List reliableServerToClient = new List(); + List unreliableClientToServer = new List(); + List unreliableServerToClient = new List(); + + // random + // UnityEngine.Random.value is [0, 1] with both upper and lower bounds inclusive + // but we need the upper bound to be exclusive, so using System.Random instead. + // => NextDouble() is NEVER < 0 so loss=0 never drops! + // => NextDouble() is ALWAYS < 1 so loss=1 always drops! + System.Random random = new System.Random(); + + public void Awake() + { + if (wrap == null) + throw new Exception("LatencySimulationTransport requires an underlying transport to wrap around."); + } + + // forward enable/disable to the wrapped transport + void OnEnable() { wrap.enabled = true; } + void OnDisable() { wrap.enabled = false; } + + // noise function can be replaced if needed + protected virtual float Noise(float time) => Mathf.PerlinNoise(time, time); + + // helper function to simulate latency + float SimulateLatency(int channeldId) + { + // spike over perlin noise. + // no spikes isn't realistic. + // sin is too predictable / no realistic. + // perlin is still deterministic and random enough. +#if !UNITY_2020_3_OR_NEWER + float spike = Noise((float)NetworkTime.localTime * jitterSpeed) * jitter; +#else + float spike = Noise((float)Time.unscaledTimeAsDouble * jitterSpeed) * jitter; +#endif + + // base latency + switch (channeldId) + { + case Channels.Reliable: + return reliableLatency/1000 + spike; + case Channels.Unreliable: + return unreliableLatency/1000 + spike; + default: + return 0; + } + } + + // helper function to simulate a send with latency/loss/scramble + void SimulateSend( + int connectionId, + ArraySegment segment, + int channelId, + float latency, + List reliableQueue, + List unreliableQueue) + { + // segment is only valid after returning. copy it. + // (allocates for now. it's only for testing anyway.) + byte[] bytes = new byte[segment.Count]; + Buffer.BlockCopy(segment.Array, segment.Offset, bytes, 0, segment.Count); + + // enqueue message. send after latency interval. + QueuedMessage message = new QueuedMessage + { + connectionId = connectionId, + bytes = bytes, +#if !UNITY_2020_3_OR_NEWER + time = NetworkTime.localTime + latency +#else + time = Time.unscaledTimeAsDouble + latency +#endif + }; + + switch (channelId) + { + case Channels.Reliable: + // simulate latency + reliableQueue.Add(message); + break; + case Channels.Unreliable: + // simulate packet loss + bool drop = random.NextDouble() < unreliableLoss/100; + if (!drop) + { + // simulate scramble (Random.Next is < max, so +1) + bool scramble = random.NextDouble() < unreliableScramble/100; + int last = unreliableQueue.Count; + int index = scramble ? random.Next(0, last + 1) : last; + + // simulate latency + unreliableQueue.Insert(index, message); + } + break; + default: + Debug.LogError($"{nameof(LatencySimulation)} unexpected channelId: {channelId}"); + break; + } + } + + public override bool Available() => wrap.Available(); + + public override void ClientConnect(string address) + { + wrap.OnClientConnected = OnClientConnected; + wrap.OnClientDataReceived = OnClientDataReceived; + wrap.OnClientError = OnClientError; + wrap.OnClientDisconnected = OnClientDisconnected; + wrap.ClientConnect(address); + } + + public override void ClientConnect(Uri uri) + { + wrap.OnClientConnected = OnClientConnected; + wrap.OnClientDataReceived = OnClientDataReceived; + wrap.OnClientError = OnClientError; + wrap.OnClientDisconnected = OnClientDisconnected; + wrap.ClientConnect(uri); + } + + public override bool ClientConnected() => wrap.ClientConnected(); + + public override void ClientDisconnect() + { + wrap.ClientDisconnect(); + reliableClientToServer.Clear(); + unreliableClientToServer.Clear(); + } + + public override void ClientSend(ArraySegment segment, int channelId) + { + float latency = SimulateLatency(channelId); + SimulateSend(0, segment, channelId, latency, reliableClientToServer, unreliableClientToServer); + } + + public override Uri ServerUri() => wrap.ServerUri(); + + public override bool ServerActive() => wrap.ServerActive(); + + public override string ServerGetClientAddress(int connectionId) => wrap.ServerGetClientAddress(connectionId); + + public override void ServerDisconnect(int connectionId) => wrap.ServerDisconnect(connectionId); + + public override void ServerSend(int connectionId, ArraySegment segment, int channelId) + { + float latency = SimulateLatency(channelId); + SimulateSend(connectionId, segment, channelId, latency, reliableServerToClient, unreliableServerToClient); + } + + public override void ServerStart() + { + wrap.OnServerConnected = OnServerConnected; + wrap.OnServerDataReceived = OnServerDataReceived; + wrap.OnServerError = OnServerError; + wrap.OnServerDisconnected = OnServerDisconnected; + wrap.ServerStart(); + } + + public override void ServerStop() + { + wrap.ServerStop(); + reliableServerToClient.Clear(); + unreliableServerToClient.Clear(); + } + + public override void ClientEarlyUpdate() => wrap.ClientEarlyUpdate(); + public override void ServerEarlyUpdate() => wrap.ServerEarlyUpdate(); + public override void ClientLateUpdate() + { + // flush reliable messages after latency. + // need to iterate all, since queue isn't a sortedlist. + for (int i = 0; i < reliableClientToServer.Count; ++i) + { + // message ready to be sent? + QueuedMessage message = reliableClientToServer[i]; +#if !UNITY_2020_3_OR_NEWER + if (message.time <= NetworkTime.localTime) +#else + if (message.time <= Time.unscaledTimeAsDouble) +#endif + { + // send and eat + wrap.ClientSend(new ArraySegment(message.bytes), Channels.Reliable); + reliableClientToServer.RemoveAt(i); + --i; + } + } + + // flush unreliable messages after latency. + // need to iterate all, since queue isn't a sortedlist. + for (int i = 0; i < unreliableClientToServer.Count; ++i) + { + // message ready to be sent? + QueuedMessage message = unreliableClientToServer[i]; +#if !UNITY_2020_3_OR_NEWER + if (message.time <= NetworkTime.localTime) +#else + if (message.time <= Time.unscaledTimeAsDouble) +#endif + { + // send and eat + wrap.ClientSend(new ArraySegment(message.bytes), Channels.Reliable); + unreliableClientToServer.RemoveAt(i); + --i; + } + } + + // update wrapped transport too + wrap.ClientLateUpdate(); + } + public override void ServerLateUpdate() + { + + // flush reliable messages after latency. + // need to iterate all, since queue isn't a sortedlist. + for (int i = 0; i < reliableServerToClient.Count; ++i) + { + // message ready to be sent? + QueuedMessage message = reliableServerToClient[i]; +#if !UNITY_2020_3_OR_NEWER + if (message.time <= NetworkTime.localTime) +#else + if (message.time <= Time.unscaledTimeAsDouble) +#endif + { + // send and eat + wrap.ServerSend(message.connectionId, new ArraySegment(message.bytes), Channels.Reliable); + reliableServerToClient.RemoveAt(i); + --i; + } + } + + + // flush unreliable messages after latency. + // need to iterate all, since queue isn't a sortedlist. + for (int i = 0; i < unreliableServerToClient.Count; ++i) + { + // message ready to be sent? + QueuedMessage message = unreliableServerToClient[i]; +#if !UNITY_2020_3_OR_NEWER + if (message.time <= NetworkTime.localTime) +#else + if (message.time <= Time.unscaledTimeAsDouble) +#endif + { + // send and eat + wrap.ServerSend(message.connectionId, new ArraySegment(message.bytes), Channels.Reliable); + unreliableServerToClient.RemoveAt(i); + --i; + } + } + + // update wrapped transport too + wrap.ServerLateUpdate(); + } + + public override int GetBatchThreshold(int channelId) => wrap.GetBatchThreshold(channelId); + public override int GetMaxPacketSize(int channelId = 0) => wrap.GetMaxPacketSize(channelId); + + public override void Shutdown() => wrap.Shutdown(); + + public override string ToString() => $"{nameof(LatencySimulation)} {wrap}"; + } +} diff --git a/Assets/Mirror/Transports/Latency/LatencySimulation.cs.meta b/Assets/Mirror/Transports/Latency/LatencySimulation.cs.meta new file mode 100644 index 0000000..eabbe4a --- /dev/null +++ b/Assets/Mirror/Transports/Latency/LatencySimulation.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 96b149f511061407fb54895c057b7736 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Middleware.meta b/Assets/Mirror/Transports/Middleware.meta new file mode 100644 index 0000000..3038832 --- /dev/null +++ b/Assets/Mirror/Transports/Middleware.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 69344c174fdaf432e9ff0cdaf2e2ba21 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Middleware/MiddlewareTransport.cs b/Assets/Mirror/Transports/Middleware/MiddlewareTransport.cs new file mode 100644 index 0000000..7dd934a --- /dev/null +++ b/Assets/Mirror/Transports/Middleware/MiddlewareTransport.cs @@ -0,0 +1,61 @@ +using System; +using UnityEngine; + +namespace Mirror +{ + ///

+ /// Allows Middleware to override some of the transport methods or let the inner transport handle them. + /// + [DisallowMultipleComponent] + public abstract class MiddlewareTransport : Transport + { + /// + /// Transport to call to after middleware + /// + public Transport inner; + + public override bool Available() => inner.Available(); + public override int GetMaxPacketSize(int channelId = 0) => inner.GetMaxPacketSize(channelId); + public override int GetBatchThreshold(int channelId = Channels.Reliable) => inner.GetBatchThreshold(channelId); + public override void Shutdown() => inner.Shutdown(); + + #region Client + public override void ClientConnect(string address) + { + inner.OnClientConnected = OnClientConnected; + inner.OnClientDataReceived = OnClientDataReceived; + inner.OnClientDisconnected = OnClientDisconnected; + inner.OnClientError = OnClientError; + inner.ClientConnect(address); + } + + public override bool ClientConnected() => inner.ClientConnected(); + public override void ClientDisconnect() => inner.ClientDisconnect(); + public override void ClientSend(ArraySegment segment, int channelId) => inner.ClientSend(segment, channelId); + + public override void ClientEarlyUpdate() => inner.ClientEarlyUpdate(); + public override void ClientLateUpdate() => inner.ClientLateUpdate(); + #endregion + + #region Server + public override bool ServerActive() => inner.ServerActive(); + public override void ServerStart() + { + inner.OnServerConnected = OnServerConnected; + inner.OnServerDataReceived = OnServerDataReceived; + inner.OnServerDisconnected = OnServerDisconnected; + inner.OnServerError = OnServerError; + inner.ServerStart(); + } + + public override void ServerStop() => inner.ServerStop(); + public override void ServerSend(int connectionId, ArraySegment segment, int channelId) => inner.ServerSend(connectionId, segment, channelId); + public override void ServerDisconnect(int connectionId) => inner.ServerDisconnect(connectionId); + public override string ServerGetClientAddress(int connectionId) => inner.ServerGetClientAddress(connectionId); + public override Uri ServerUri() => inner.ServerUri(); + + public override void ServerEarlyUpdate() => inner.ServerEarlyUpdate(); + public override void ServerLateUpdate() => inner.ServerLateUpdate(); + #endregion + } +} diff --git a/Assets/Mirror/Transports/Middleware/MiddlewareTransport.cs.meta b/Assets/Mirror/Transports/Middleware/MiddlewareTransport.cs.meta new file mode 100644 index 0000000..dce8378 --- /dev/null +++ b/Assets/Mirror/Transports/Middleware/MiddlewareTransport.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 46f20ede74658e147a1af57172710de2 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Mirror.Transports.asmdef b/Assets/Mirror/Transports/Mirror.Transports.asmdef new file mode 100644 index 0000000..3a67a0a --- /dev/null +++ b/Assets/Mirror/Transports/Mirror.Transports.asmdef @@ -0,0 +1,19 @@ +{ + "name": "Mirror.Transports", + "rootNamespace": "", + "references": [ + "GUID:30817c1a0e6d646d99c048fc403f5979", + "GUID:6806a62c384838046a3c66c44f06d75f", + "GUID:725ee7191c021de4dbf9269590ded755", + "GUID:3b5390adca4e2bb4791cb930316d6f3e" + ], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": true, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/Mirror.Transports.asmdef.meta b/Assets/Mirror/Transports/Mirror.Transports.asmdef.meta new file mode 100644 index 0000000..d180ef1 --- /dev/null +++ b/Assets/Mirror/Transports/Mirror.Transports.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 627104647b9c04b4ebb8978a92ecac63 +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Multiplex.meta b/Assets/Mirror/Transports/Multiplex.meta new file mode 100644 index 0000000..59c257e --- /dev/null +++ b/Assets/Mirror/Transports/Multiplex.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 28d5150129fea43048bbdd23ea6e2446 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Multiplex/MultiplexTransport.cs b/Assets/Mirror/Transports/Multiplex/MultiplexTransport.cs new file mode 100644 index 0000000..0797e7a --- /dev/null +++ b/Assets/Mirror/Transports/Multiplex/MultiplexTransport.cs @@ -0,0 +1,331 @@ +using System; +using System.Collections.Generic; +using System.Text; +using UnityEngine; + +namespace Mirror +{ + // a transport that can listen to multiple underlying transport at the same time + [DisallowMultipleComponent] + public class MultiplexTransport : Transport + { + public Transport[] transports; + + Transport available; + + // underlying transport connectionId to multiplexed connectionId lookup. + // + // originally we used a formula to map the connectionId: + // connectionId * transportAmount + transportId + // + // if we have 3 transports, then + // transport 0 will produce connection ids [0, 3, 6, 9, ...] + // transport 1 will produce connection ids [1, 4, 7, 10, ...] + // transport 2 will produce connection ids [2, 5, 8, 11, ...] + // + // however, some transports like kcp may give very large connectionIds. + // if they are near int.max, then "* transprotAmount + transportIndex" + // will overflow, resulting in connIds which can't be projected back. + // https://github.com/vis2k/Mirror/issues/3280 + // + // instead, use a simple lookup with 0-indexed ids. + // with initial capacity to avoid runtime allocations. + + // (original connectionId, transport#) to multiplexed connectionId + readonly Dictionary, int> originalToMultiplexedId = + new Dictionary, int>(100); + + // multiplexed connectionId to (original connectionId, transport#) + readonly Dictionary> multiplexedToOriginalId = + new Dictionary>(100); + + // next multiplexed id counter. start at 1 because 0 is reserved for host. + int nextMultiplexedId = 1; + + // add to bidirection lookup. returns the multiplexed connectionId. + public int AddToLookup(int originalConnectionId, int transportIndex) + { + // add to both + KeyValuePair pair = new KeyValuePair(originalConnectionId, transportIndex); + int multiplexedId = nextMultiplexedId++; + + originalToMultiplexedId[pair] = multiplexedId; + multiplexedToOriginalId[multiplexedId] = pair; + + return multiplexedId; + } + + public void RemoveFromLookup(int originalConnectionId, int transportIndex) + { + // remove from both + KeyValuePair pair = new KeyValuePair(originalConnectionId, transportIndex); + int multiplexedId = originalToMultiplexedId[pair]; + + originalToMultiplexedId.Remove(pair); + multiplexedToOriginalId.Remove(multiplexedId); + } + + public void OriginalId(int multiplexId, out int originalConnectionId, out int transportIndex) + { + KeyValuePair pair = multiplexedToOriginalId[multiplexId]; + originalConnectionId = pair.Key; + transportIndex = pair.Value; + } + + public int MultiplexId(int originalConnectionId, int transportIndex) + { + KeyValuePair pair = new KeyValuePair(originalConnectionId, transportIndex); + return originalToMultiplexedId[pair]; + } + + //////////////////////////////////////////////////////////////////////// + + public void Awake() + { + if (transports == null || transports.Length == 0) + { + Debug.LogError("[Multiplexer] Multiplex transport requires at least 1 underlying transport"); + } + } + + public override void ClientEarlyUpdate() + { + foreach (Transport transport in transports) + transport.ClientEarlyUpdate(); + } + + public override void ServerEarlyUpdate() + { + foreach (Transport transport in transports) + transport.ServerEarlyUpdate(); + } + + public override void ClientLateUpdate() + { + foreach (Transport transport in transports) + transport.ClientLateUpdate(); + } + + public override void ServerLateUpdate() + { + foreach (Transport transport in transports) + transport.ServerLateUpdate(); + } + + void OnEnable() + { + foreach (Transport transport in transports) + transport.enabled = true; + } + + void OnDisable() + { + foreach (Transport transport in transports) + transport.enabled = false; + } + + public override bool Available() + { + // available if any of the transports is available + foreach (Transport transport in transports) + if (transport.Available()) + return true; + + return false; + } + + #region Client + + public override void ClientConnect(string address) + { + foreach (Transport transport in transports) + { + if (transport.Available()) + { + available = transport; + transport.OnClientConnected = OnClientConnected; + transport.OnClientDataReceived = OnClientDataReceived; + transport.OnClientError = OnClientError; + transport.OnClientDisconnected = OnClientDisconnected; + transport.ClientConnect(address); + return; + } + } + throw new ArgumentException("[Multiplexer] No transport suitable for this platform"); + } + + public override void ClientConnect(Uri uri) + { + foreach (Transport transport in transports) + { + if (transport.Available()) + { + try + { + available = transport; + transport.OnClientConnected = OnClientConnected; + transport.OnClientDataReceived = OnClientDataReceived; + transport.OnClientError = OnClientError; + transport.OnClientDisconnected = OnClientDisconnected; + transport.ClientConnect(uri); + return; + } + catch (ArgumentException) + { + // transport does not support the schema, just move on to the next one + } + } + } + throw new ArgumentException("[Multiplexer] No transport suitable for this platform"); + } + + public override bool ClientConnected() + { + return (object)available != null && available.ClientConnected(); + } + + public override void ClientDisconnect() + { + if ((object)available != null) + available.ClientDisconnect(); + } + + public override void ClientSend(ArraySegment segment, int channelId) + { + available.ClientSend(segment, channelId); + } + + #endregion + + #region Server + void AddServerCallbacks() + { + // all underlying transports should call the multiplex transport's events + for (int i = 0; i < transports.Length; i++) + { + // this is required for the handlers, if I use i directly + // then all the handlers will use the last i + int transportIndex = i; + Transport transport = transports[i]; + + transport.OnServerConnected = (originalConnectionId => + { + // invoke Multiplex event with multiplexed connectionId + int multiplexedId = AddToLookup(originalConnectionId, transportIndex); + OnServerConnected.Invoke(multiplexedId); + }); + + transport.OnServerDataReceived = (originalConnectionId, data, channel) => + { + // invoke Multiplex event with multiplexed connectionId + int multiplexedId = MultiplexId(originalConnectionId, transportIndex); + OnServerDataReceived.Invoke(multiplexedId, data, channel); + }; + + transport.OnServerError = (originalConnectionId, error, reason) => + { + // invoke Multiplex event with multiplexed connectionId + int multiplexedId = MultiplexId(originalConnectionId, transportIndex); + OnServerError.Invoke(multiplexedId, error, reason); + }; + + transport.OnServerDisconnected = originalConnectionId => + { + // invoke Multiplex event with multiplexed connectionId + int multiplexedId = MultiplexId(originalConnectionId, transportIndex); + OnServerDisconnected.Invoke(multiplexedId); + RemoveFromLookup(originalConnectionId, transportIndex); + }; + } + } + + // for now returns the first uri, + // should we return all available uris? + public override Uri ServerUri() => + transports[0].ServerUri(); + + public override bool ServerActive() + { + // avoid Linq.All allocations + foreach (Transport transport in transports) + if (!transport.ServerActive()) + return false; + + return true; + } + + public override string ServerGetClientAddress(int connectionId) + { + // convert multiplexed connectionId to original id & transport index + OriginalId(connectionId, out int originalConnectionId, out int transportIndex); + return transports[transportIndex].ServerGetClientAddress(originalConnectionId); + } + + public override void ServerDisconnect(int connectionId) + { + // convert multiplexed connectionId to original id & transport index + OriginalId(connectionId, out int originalConnectionId, out int transportIndex); + transports[transportIndex].ServerDisconnect(originalConnectionId); + } + + public override void ServerSend(int connectionId, ArraySegment segment, int channelId) + { + // convert multiplexed connectionId to original transport + connId + OriginalId(connectionId, out int originalConnectionId, out int transportIndex); + transports[transportIndex].ServerSend(originalConnectionId, segment, channelId); + } + + public override void ServerStart() + { + AddServerCallbacks(); + + foreach (Transport transport in transports) + transport.ServerStart(); + } + + public override void ServerStop() + { + foreach (Transport transport in transports) + transport.ServerStop(); + } + #endregion + + public override int GetMaxPacketSize(int channelId = 0) + { + // finding the max packet size in a multiplex environment has to be + // done very carefully: + // * servers run multiple transports at the same time + // * different clients run different transports + // * there should only ever be ONE true max packet size for everyone, + // otherwise a spawn message might be sent to all tcp sockets, but + // be too big for some udp sockets. that would be a debugging + // nightmare and allow for possible exploits and players on + // different platforms seeing a different game state. + // => the safest solution is to use the smallest max size for all + // transports. that will never fail. + int mininumAllowedSize = int.MaxValue; + foreach (Transport transport in transports) + { + int size = transport.GetMaxPacketSize(channelId); + mininumAllowedSize = Mathf.Min(size, mininumAllowedSize); + } + return mininumAllowedSize; + } + + public override void Shutdown() + { + foreach (Transport transport in transports) + transport.Shutdown(); + } + + public override string ToString() + { + StringBuilder builder = new StringBuilder(); + + foreach (Transport transport in transports) + builder.AppendLine(transport.ToString()); + + return builder.ToString().Trim(); + } + } +} diff --git a/Assets/Mirror/Transports/Multiplex/MultiplexTransport.cs.meta b/Assets/Mirror/Transports/Multiplex/MultiplexTransport.cs.meta new file mode 100644 index 0000000..6e97b28 --- /dev/null +++ b/Assets/Mirror/Transports/Multiplex/MultiplexTransport.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 929e3234c7db540b899f00183fc2b1fe +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb.meta b/Assets/Mirror/Transports/SimpleWeb.meta new file mode 100644 index 0000000..5baa80f --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: a3ba68af305d809418d6c6a804939290 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb.meta new file mode 100644 index 0000000..c2852a8 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 8ae237a052b29fc4b8d000f48e545bb7 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/AssemblyInfo.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/AssemblyInfo.cs new file mode 100644 index 0000000..c0df7fe --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/AssemblyInfo.cs @@ -0,0 +1,7 @@ +using System.Reflection; +using System.Runtime.CompilerServices; + +[assembly: AssemblyVersion("1.6.0")] + +[assembly: InternalsVisibleTo("SimpleWebTransport.Tests.Runtime")] +[assembly: InternalsVisibleTo("SimpleWebTransport.Tests.Editor")] diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/AssemblyInfo.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/AssemblyInfo.cs.meta new file mode 100644 index 0000000..028a307 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/AssemblyInfo.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: ee9e76201f7665244bd6ab8ea343a83f +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/CHANGELOG.md b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/CHANGELOG.md new file mode 100644 index 0000000..d98f014 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/CHANGELOG.md @@ -0,0 +1,48 @@ +# [1.3.0](https://github.com/James-Frowen/SimpleWebTransport/compare/v1.2.7...v1.3.0) (2022-02-12) + + +### Features + +* Allowing max message size to be increase to int32.max ([#2](https://github.com/James-Frowen/SimpleWebTransport/issues/2)) ([4cc60fd](https://github.com/James-Frowen/SimpleWebTransport/commit/4cc60fd67f3c65d90ced0e6f9f97d15d0368076d)) + +## [1.2.7](https://github.com/James-Frowen/SimpleWebTransport/compare/v1.2.6...v1.2.7) (2022-02-12) + + +### Bug Fixes + +* fixing ObjectDisposedException in toString ([426de52](https://github.com/James-Frowen/SimpleWebTransport/commit/426de52ee4e98ac6212713b2b2272e3affb8fc99)) + +## [1.2.6](https://github.com/James-Frowen/SimpleWebTransport/compare/v1.2.5...v1.2.6) (2022-02-02) + + +### Bug Fixes + +* fixing Runtime is not defined for unity 2021 ([945b50d](https://github.com/James-Frowen/SimpleWebTransport/commit/945b50dbad5b71c43e2bdaa4033f87d3f62c5572)) + +## [1.2.5](https://github.com/James-Frowen/SimpleWebTransport/compare/v1.2.4...v1.2.5) (2022-02-02) + + +### Bug Fixes + +* updating Pointer_stringify to UTF8ToString ([2f5a74b](https://github.com/James-Frowen/SimpleWebTransport/commit/2f5a74ba10865e934be8d3b54ebfdeb14ca491f6)) + +## [1.2.4](https://github.com/James-Frowen/SimpleWebTransport/compare/v1.2.3...v1.2.4) (2021-12-16) + + +### Bug Fixes + +* adding meta file for changelog ([ba5b164](https://github.com/James-Frowen/SimpleWebTransport/commit/ba5b1647aa5cc69ca80f5b52c542a9b5ee749c7f)) + +## [1.2.3](https://github.com/James-Frowen/SimpleWebTransport/compare/v1.2.2...v1.2.3) (2021-12-16) + + +### Bug Fixes + +* fixing compile error in assemblyInfo ([7ee8380](https://github.com/James-Frowen/SimpleWebTransport/commit/7ee8380b4daf34d4e12017de55d8be481690046f)) + +## [1.2.2](https://github.com/James-Frowen/SimpleWebTransport/compare/v1.2.1...v1.2.2) (2021-12-16) + + +### Bug Fixes + +* fixing release with empty commit ([068af74](https://github.com/James-Frowen/SimpleWebTransport/commit/068af74f7399354081f25181f90fb060b0fa1524)) diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/CHANGELOG.md.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/CHANGELOG.md.meta new file mode 100644 index 0000000..bc43099 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/CHANGELOG.md.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: b0ef23ac1c6a62546bbad5529b3bfdad +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client.meta new file mode 100644 index 0000000..e6e2943 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 5faa957b8d9fc314ab7596ccf14750d9 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/SimpleWebClient.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/SimpleWebClient.cs new file mode 100644 index 0000000..7732cd5 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/SimpleWebClient.cs @@ -0,0 +1,102 @@ +using System; +using System.Collections.Concurrent; +using UnityEngine; + +namespace Mirror.SimpleWeb +{ + public enum ClientState + { + NotConnected = 0, + Connecting = 1, + Connected = 2, + Disconnecting = 3, + } + + /// + /// Client used to control websockets + /// Base class used by WebSocketClientWebGl and WebSocketClientStandAlone + /// + public abstract class SimpleWebClient + { + public static SimpleWebClient Create(int maxMessageSize, int maxMessagesPerTick, TcpConfig tcpConfig) + { +#if UNITY_WEBGL && !UNITY_EDITOR + return new WebSocketClientWebGl(maxMessageSize, maxMessagesPerTick); +#else + return new WebSocketClientStandAlone(maxMessageSize, maxMessagesPerTick, tcpConfig); +#endif + } + + readonly int maxMessagesPerTick; + protected readonly int maxMessageSize; + public readonly ConcurrentQueue receiveQueue = new ConcurrentQueue(); + protected readonly BufferPool bufferPool; + + protected ClientState state; + + protected SimpleWebClient(int maxMessageSize, int maxMessagesPerTick) + { + this.maxMessageSize = maxMessageSize; + this.maxMessagesPerTick = maxMessagesPerTick; + bufferPool = new BufferPool(5, 20, maxMessageSize); + } + + public ClientState ConnectionState => state; + + public event Action onConnect; + public event Action onDisconnect; + public event Action> onData; + public event Action onError; + + /// + /// Processes all new messages + /// + public void ProcessMessageQueue() + { + ProcessMessageQueue(null); + } + + /// + /// Processes all messages while is enabled + /// + /// + public void ProcessMessageQueue(MonoBehaviour behaviour) + { + int processedCount = 0; + bool skipEnabled = behaviour == null; + // check enabled every time in case behaviour was disabled after data + while ( + (skipEnabled || behaviour.enabled) && + processedCount < maxMessagesPerTick && + // Dequeue last + receiveQueue.TryDequeue(out Message next) + ) + { + processedCount++; + + switch (next.type) + { + case EventType.Connected: + onConnect?.Invoke(); + break; + case EventType.Data: + onData?.Invoke(next.data.ToSegment()); + next.data.Release(); + break; + case EventType.Disconnected: + onDisconnect?.Invoke(); + break; + case EventType.Error: + onError?.Invoke(next.exception); + break; + } + } + if (receiveQueue.Count > 0) + Debug.LogWarning($"SimpleWebClient ProcessMessageQueue has {receiveQueue.Count} remaining."); + } + + public abstract void Connect(Uri serverAddress); + public abstract void Disconnect(); + public abstract void Send(ArraySegment segment); + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/SimpleWebClient.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/SimpleWebClient.cs.meta new file mode 100644 index 0000000..90c361b --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/SimpleWebClient.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 13131761a0bf5a64dadeccd700fe26e5 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone.meta new file mode 100644 index 0000000..bf320c6 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: a9c19d05220a87c4cbbe4d1e422da0aa +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientHandshake.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientHandshake.cs new file mode 100644 index 0000000..666f25b --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientHandshake.cs @@ -0,0 +1,88 @@ +using System; +using System.IO; +using System.Security.Cryptography; +using System.Text; + +namespace Mirror.SimpleWeb +{ + /// + /// Handles Handshake to the server when it first connects + /// The client handshake does not need buffers to reduce allocations since it only happens once + /// + internal class ClientHandshake + { + public bool TryHandshake(Connection conn, Uri uri) + { + try + { + Stream stream = conn.stream; + + byte[] keyBuffer = new byte[16]; + using (RNGCryptoServiceProvider rng = new RNGCryptoServiceProvider()) + rng.GetBytes(keyBuffer); + + string key = Convert.ToBase64String(keyBuffer); + string keySum = key + Constants.HandshakeGUID; + byte[] keySumBytes = Encoding.ASCII.GetBytes(keySum); + Log.Verbose($"[SimpleWebTransport] Handshake Hashing {Encoding.ASCII.GetString(keySumBytes)}"); + + // SHA-1 is the websocket standard: + // https://www.rfc-editor.org/rfc/rfc6455 + // we should follow the standard, even though SHA1 is considered weak: + // https://stackoverflow.com/questions/38038841/why-is-sha-1-considered-insecure + byte[] keySumHash = SHA1.Create().ComputeHash(keySumBytes); + + string expectedResponse = Convert.ToBase64String(keySumHash); + string handshake = + $"GET {uri.PathAndQuery} HTTP/1.1\r\n" + + $"Host: {uri.Host}:{uri.Port}\r\n" + + $"Upgrade: websocket\r\n" + + $"Connection: Upgrade\r\n" + + $"Sec-WebSocket-Key: {key}\r\n" + + $"Sec-WebSocket-Version: 13\r\n" + + "\r\n"; + byte[] encoded = Encoding.ASCII.GetBytes(handshake); + stream.Write(encoded, 0, encoded.Length); + + byte[] responseBuffer = new byte[1000]; + + int? lengthOrNull = ReadHelper.SafeReadTillMatch(stream, responseBuffer, 0, responseBuffer.Length, Constants.endOfHandshake); + + if (!lengthOrNull.HasValue) + { + Log.Error("[SimpleWebTransport] Connection closed before handshake"); + return false; + } + + string responseString = Encoding.ASCII.GetString(responseBuffer, 0, lengthOrNull.Value); + Log.Verbose($"[SimpleWebTransport] Handshake Response {responseString}"); + + string acceptHeader = "Sec-WebSocket-Accept: "; + int startIndex = responseString.IndexOf(acceptHeader, StringComparison.InvariantCultureIgnoreCase); + + if (startIndex < 0) + { + Log.Error($"[SimpleWebTransport] Unexpected Handshake Response {responseString}"); + return false; + } + + startIndex += acceptHeader.Length; + int endIndex = responseString.IndexOf("\r\n", startIndex); + string responseKey = responseString.Substring(startIndex, endIndex - startIndex); + + if (responseKey != expectedResponse) + { + Log.Error($"[SimpleWebTransport] Response key incorrect\nResponse:{responseKey}\nExpected:{expectedResponse}"); + return false; + } + + return true; + } + catch (Exception e) + { + Log.Exception(e); + return false; + } + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientHandshake.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientHandshake.cs.meta new file mode 100644 index 0000000..ad3d40d --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientHandshake.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 3ffdcabc9e28f764a94fc4efc82d3e8b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientSslHelper.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientSslHelper.cs new file mode 100644 index 0000000..78ce2bb --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientSslHelper.cs @@ -0,0 +1,47 @@ +using System; +using System.IO; +using System.Net.Security; +using System.Net.Sockets; +using System.Security.Cryptography.X509Certificates; + +namespace Mirror.SimpleWeb +{ + internal class ClientSslHelper + { + internal bool TryCreateStream(Connection conn, Uri uri) + { + NetworkStream stream = conn.client.GetStream(); + if (uri.Scheme != "wss") + { + conn.stream = stream; + return true; + } + + try + { + conn.stream = CreateStream(stream, uri); + return true; + } + catch (Exception e) + { + Log.Error($"[SimpleWebTransport] Create SSLStream Failed: {e}", false); + return false; + } + } + + Stream CreateStream(NetworkStream stream, Uri uri) + { + SslStream sslStream = new SslStream(stream, true, ValidateServerCertificate); + sslStream.AuthenticateAsClient(uri.Host); + return sslStream; + } + + static bool ValidateServerCertificate(object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors) + { + // Do not allow this client to communicate with unauthenticated servers. + + // only accept if no errors + return sslPolicyErrors == SslPolicyErrors.None; + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientSslHelper.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientSslHelper.cs.meta new file mode 100644 index 0000000..d6be2bb --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/ClientSslHelper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 46055a75559a79849a750f39a766db61 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/WebSocketClientStandAlone.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/WebSocketClientStandAlone.cs new file mode 100644 index 0000000..b787bf9 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/WebSocketClientStandAlone.cs @@ -0,0 +1,140 @@ +using System; +using System.Net.Sockets; +using System.Threading; + +namespace Mirror.SimpleWeb +{ + public class WebSocketClientStandAlone : SimpleWebClient + { + readonly ClientSslHelper sslHelper; + readonly ClientHandshake handshake; + readonly TcpConfig tcpConfig; + Connection conn; + + internal WebSocketClientStandAlone(int maxMessageSize, int maxMessagesPerTick, TcpConfig tcpConfig) : base(maxMessageSize, maxMessagesPerTick) + { +#if UNITY_WEBGL && !UNITY_EDITOR + throw new NotSupportedException(); +#else + sslHelper = new ClientSslHelper(); + handshake = new ClientHandshake(); + this.tcpConfig = tcpConfig; +#endif + } + + public override void Connect(Uri serverAddress) + { + state = ClientState.Connecting; + + // create connection here before thread so that send queue exist before connected + TcpClient client = new TcpClient(); + tcpConfig.ApplyTo(client); + + // create connection object here so dispose correctly disconnects on failed connect + conn = new Connection(client, AfterConnectionDisposed); + + Thread receiveThread = new Thread(() => ConnectAndReceiveLoop(serverAddress)); + receiveThread.IsBackground = true; + receiveThread.Start(); + } + + void ConnectAndReceiveLoop(Uri serverAddress) + { + try + { + // connection created above + TcpClient client = conn.client; + conn.receiveThread = Thread.CurrentThread; + + try + { + client.Connect(serverAddress.Host, serverAddress.Port); + } + catch (SocketException) + { + client.Dispose(); + throw; + } + + + bool success = sslHelper.TryCreateStream(conn, serverAddress); + if (!success) + { + Log.Warn($"[SimpleWebTransport] Failed to create Stream with {serverAddress}"); + conn.Dispose(); + return; + } + + success = handshake.TryHandshake(conn, serverAddress); + if (!success) + { + Log.Warn($"[SimpleWebTransport] Failed Handshake with {serverAddress}"); + conn.Dispose(); + return; + } + + Log.Info($"[SimpleWebTransport] HandShake Successful with {serverAddress}"); + + state = ClientState.Connected; + + receiveQueue.Enqueue(new Message(EventType.Connected)); + + Thread sendThread = new Thread(() => + { + SendLoop.Config sendConfig = new SendLoop.Config( + conn, + bufferSize: Constants.HeaderSize + Constants.MaskSize + maxMessageSize, + setMask: true); + + SendLoop.Loop(sendConfig); + }); + + conn.sendThread = sendThread; + sendThread.IsBackground = true; + sendThread.Start(); + + ReceiveLoop.Config config = new ReceiveLoop.Config(conn, + maxMessageSize, + false, + receiveQueue, + bufferPool); + ReceiveLoop.Loop(config); + } + catch (ThreadInterruptedException e) { Log.InfoException(e); } + catch (ThreadAbortException e) { Log.InfoException(e); } + catch (Exception e) { Log.Exception(e); } + finally + { + // close here in case connect fails + conn?.Dispose(); + } + } + + void AfterConnectionDisposed(Connection conn) + { + state = ClientState.NotConnected; + // make sure Disconnected event is only called once + receiveQueue.Enqueue(new Message(EventType.Disconnected)); + } + + public override void Disconnect() + { + state = ClientState.Disconnecting; + Log.Info("[SimpleWebTransport] Disconnect Called"); + + if (conn == null) + state = ClientState.NotConnected; + else + conn?.Dispose(); + } + + public override void Send(ArraySegment segment) + { + ArrayBuffer buffer = bufferPool.Take(segment.Count); + buffer.CopyFrom(segment); + + conn.sendQueue.Enqueue(buffer); + conn.sendPending.Set(); + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/WebSocketClientStandAlone.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/WebSocketClientStandAlone.cs.meta new file mode 100644 index 0000000..37229d3 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/StandAlone/WebSocketClientStandAlone.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 05a9c87dea309e241a9185e5aa0d72ab +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl.meta new file mode 100644 index 0000000..2d81f7f --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 7142349d566213c4abc763afaf4d91a1 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/SimpleWebJSLib.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/SimpleWebJSLib.cs new file mode 100644 index 0000000..6af4671 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/SimpleWebJSLib.cs @@ -0,0 +1,34 @@ +using System; +#if UNITY_WEBGL +using System.Runtime.InteropServices; +#endif + +namespace Mirror.SimpleWeb +{ + internal static class SimpleWebJSLib + { +#if UNITY_WEBGL + [DllImport("__Internal")] + internal static extern bool IsConnected(int index); + +#pragma warning disable CA2101 // Specify marshaling for P/Invoke string arguments + [DllImport("__Internal")] +#pragma warning restore CA2101 // Specify marshaling for P/Invoke string arguments + internal static extern int Connect(string address, Action openCallback, Action closeCallBack, Action messageCallback, Action errorCallback); + + [DllImport("__Internal")] + internal static extern void Disconnect(int index); + + [DllImport("__Internal")] + internal static extern bool Send(int index, byte[] array, int offset, int length); +#else + internal static bool IsConnected(int index) => throw new NotSupportedException(); + + internal static int Connect(string address, Action openCallback, Action closeCallBack, Action messageCallback, Action errorCallback) => throw new NotSupportedException(); + + internal static void Disconnect(int index) => throw new NotSupportedException(); + + internal static bool Send(int index, byte[] array, int offset, int length) => throw new NotSupportedException(); +#endif + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/SimpleWebJSLib.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/SimpleWebJSLib.cs.meta new file mode 100644 index 0000000..9dfa12e --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/SimpleWebJSLib.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 97b96a0b65c104443977473323c2ff35 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/WebSocketClientWebGl.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/WebSocketClientWebGl.cs new file mode 100644 index 0000000..cabb7ff --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/WebSocketClientWebGl.cs @@ -0,0 +1,144 @@ +using System; +using System.Collections.Generic; +using AOT; + +namespace Mirror.SimpleWeb +{ +#if !UNITY_2021_3_OR_NEWER + + // Unity 2019 doesn't have ArraySegment.ToArray() yet. + public static class Extensions + { + public static byte[] ToArray(this ArraySegment segment) + { + byte[] array = new byte[segment.Count]; + Array.Copy(segment.Array, segment.Offset, array, 0, segment.Count); + return array; + } + } + +#endif + + public class WebSocketClientWebGl : SimpleWebClient + { + static readonly Dictionary instances = new Dictionary(); + + /// + /// key for instances sent between c# and js + /// + int index; + + /// + /// Queue for messages sent by high level while still connecting, they will be sent after onOpen is called. + /// + /// This is a workaround for anything that calls Send immediately after Connect. + /// Without this the JS websocket will give errors. + /// + /// + Queue ConnectingSendQueue; + + internal WebSocketClientWebGl(int maxMessageSize, int maxMessagesPerTick) : base(maxMessageSize, maxMessagesPerTick) + { +#if !UNITY_WEBGL || UNITY_EDITOR + throw new NotSupportedException(); +#endif + } + + public bool CheckJsConnected() => SimpleWebJSLib.IsConnected(index); + + public override void Connect(Uri serverAddress) + { + index = SimpleWebJSLib.Connect(serverAddress.ToString(), OpenCallback, CloseCallBack, MessageCallback, ErrorCallback); + instances.Add(index, this); + state = ClientState.Connecting; + } + + public override void Disconnect() + { + state = ClientState.Disconnecting; + // disconnect should cause closeCallback and OnDisconnect to be called + SimpleWebJSLib.Disconnect(index); + } + + public override void Send(ArraySegment segment) + { + if (segment.Count > maxMessageSize) + { + Log.Error($"[SimpleWebTransport] Cant send message with length {segment.Count} because it is over the max size of {maxMessageSize}"); + return; + } + + if (state == ClientState.Connected) + { + SimpleWebJSLib.Send(index, segment.Array, segment.Offset, segment.Count); + } + else + { + if (ConnectingSendQueue == null) + ConnectingSendQueue = new Queue(); + + ConnectingSendQueue.Enqueue(segment.ToArray()); + } + } + + void onOpen() + { + receiveQueue.Enqueue(new Message(EventType.Connected)); + state = ClientState.Connected; + + if (ConnectingSendQueue != null) + { + while (ConnectingSendQueue.Count > 0) + { + byte[] next = ConnectingSendQueue.Dequeue(); + SimpleWebJSLib.Send(index, next, 0, next.Length); + } + + ConnectingSendQueue = null; + } + } + + void onClose() + { + // this code should be last in this class + + receiveQueue.Enqueue(new Message(EventType.Disconnected)); + state = ClientState.NotConnected; + instances.Remove(index); + } + + void onMessage(IntPtr bufferPtr, int count) + { + try + { + ArrayBuffer buffer = bufferPool.Take(count); + buffer.CopyFrom(bufferPtr, count); + + receiveQueue.Enqueue(new Message(buffer)); + } + catch (Exception e) + { + Log.Error($"[SimpleWebTransport] onMessage {e.GetType()}: {e.Message}\n{e.StackTrace}"); + receiveQueue.Enqueue(new Message(e)); + } + } + + void onErr() + { + receiveQueue.Enqueue(new Message(new Exception("Javascript Websocket error"))); + Disconnect(); + } + + [MonoPInvokeCallback(typeof(Action))] + static void OpenCallback(int index) => instances[index].onOpen(); + + [MonoPInvokeCallback(typeof(Action))] + static void CloseCallBack(int index) => instances[index].onClose(); + + [MonoPInvokeCallback(typeof(Action))] + static void MessageCallback(int index, IntPtr bufferPtr, int count) => instances[index].onMessage(bufferPtr, count); + + [MonoPInvokeCallback(typeof(Action))] + static void ErrorCallback(int index) => instances[index].onErr(); + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/WebSocketClientWebGl.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/WebSocketClientWebGl.cs.meta new file mode 100644 index 0000000..3827d3a --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/WebSocketClientWebGl.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 015c5b1915fd1a64cbe36444d16b2f7d +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin.meta new file mode 100644 index 0000000..b516a8f --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 1999985791b91b9458059e88404885a7 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin/SimpleWeb.jslib b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin/SimpleWeb.jslib new file mode 100644 index 0000000..02e6b93 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin/SimpleWeb.jslib @@ -0,0 +1,114 @@ +// this will create a global object +const SimpleWeb = { + webSockets: [], + next: 1, + GetWebSocket: function (index) { + return SimpleWeb.webSockets[index] + }, + AddNextSocket: function (webSocket) { + var index = SimpleWeb.next; + SimpleWeb.next++; + SimpleWeb.webSockets[index] = webSocket; + return index; + }, + RemoveSocket: function (index) { + SimpleWeb.webSockets[index] = undefined; + }, +}; + +function IsConnected(index) { + var webSocket = SimpleWeb.GetWebSocket(index); + if (webSocket) { + return webSocket.readyState === webSocket.OPEN; + } + else { + return false; + } +} + +function Connect(addressPtr, openCallbackPtr, closeCallBackPtr, messageCallbackPtr, errorCallbackPtr) { + // fix for unity 2021 because unity bug in .jslib + if (typeof Runtime === "undefined") { + // if unity doesn't create Runtime, then make it here + // dont ask why this works, just be happy that it does + Runtime = { + dynCall: dynCall + } + } + + const address = UTF8ToString(addressPtr); + console.log("Connecting to " + address); + // Create webSocket connection. + webSocket = new WebSocket(address); + webSocket.binaryType = 'arraybuffer'; + const index = SimpleWeb.AddNextSocket(webSocket); + + // Connection opened + webSocket.addEventListener('open', function (event) { + console.log("Connected to " + address); + Runtime.dynCall('vi', openCallbackPtr, [index]); + }); + webSocket.addEventListener('close', function (event) { + console.log("Disconnected from " + address); + Runtime.dynCall('vi', closeCallBackPtr, [index]); + }); + + // Listen for messages + webSocket.addEventListener('message', function (event) { + if (event.data instanceof ArrayBuffer) { + // TODO dont alloc each time + var array = new Uint8Array(event.data); + var arrayLength = array.length; + + var bufferPtr = _malloc(arrayLength); + var dataBuffer = new Uint8Array(HEAPU8.buffer, bufferPtr, arrayLength); + dataBuffer.set(array); + + Runtime.dynCall('viii', messageCallbackPtr, [index, bufferPtr, arrayLength]); + _free(bufferPtr); + } + else { + console.error("message type not supported") + } + }); + + webSocket.addEventListener('error', function (event) { + console.error('Socket Error', event); + + Runtime.dynCall('vi', errorCallbackPtr, [index]); + }); + + return index; +} + +function Disconnect(index) { + var webSocket = SimpleWeb.GetWebSocket(index); + if (webSocket) { + webSocket.close(1000, "Disconnect Called by Mirror"); + } + + SimpleWeb.RemoveSocket(index); +} + +function Send(index, arrayPtr, offset, length) { + var webSocket = SimpleWeb.GetWebSocket(index); + if (webSocket) { + const start = arrayPtr + offset; + const end = start + length; + const data = HEAPU8.buffer.slice(start, end); + webSocket.send(data); + return true; + } + return false; +} + + +const SimpleWebLib = { + $SimpleWeb: SimpleWeb, + IsConnected, + Connect, + Disconnect, + Send +}; +autoAddDeps(SimpleWebLib, '$SimpleWeb'); +mergeInto(LibraryManager.library, SimpleWebLib); diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin/SimpleWeb.jslib.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin/SimpleWeb.jslib.meta new file mode 100644 index 0000000..cc1319e --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Client/Webgl/plugin/SimpleWeb.jslib.meta @@ -0,0 +1,37 @@ +fileFormatVersion: 2 +guid: 54452a8c6d2ca9b49a8c79f81b50305c +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 0 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 0 + settings: {} + - first: + Editor: Editor + second: + enabled: 0 + settings: + DefaultValueInitialized: true + - first: + Facebook: WebGL + second: + enabled: 1 + settings: {} + - first: + WebGL: WebGL + second: + enabled: 1 + settings: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common.meta new file mode 100644 index 0000000..078faaa --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 564d2cd3eee5b21419553c0528739d1b +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/BufferPool.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/BufferPool.cs new file mode 100644 index 0000000..6231c22 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/BufferPool.cs @@ -0,0 +1,249 @@ +using System; +using System.Collections.Concurrent; +using System.Diagnostics; +using System.Runtime.InteropServices; +using System.Threading; + +namespace Mirror.SimpleWeb +{ + public interface IBufferOwner + { + void Return(ArrayBuffer buffer); + } + + public sealed class ArrayBuffer : IDisposable + { + readonly IBufferOwner owner; + + public readonly byte[] array; + + /// + /// number of bytes written to buffer + /// + public int count { get; internal set; } + + /// + /// How many times release needs to be called before buffer is returned to pool + /// This allows the buffer to be used in multiple places at the same time + /// + public void SetReleasesRequired(int required) + { + releasesRequired = required; + } + + /// + /// How many times release needs to be called before buffer is returned to pool + /// This allows the buffer to be used in multiple places at the same time + /// + /// + /// This value is normally 0, but can be changed to require release to be called multiple times + /// + int releasesRequired; + + public ArrayBuffer(IBufferOwner owner, int size) + { + this.owner = owner; + array = new byte[size]; + } + + public void Release() + { + int newValue = Interlocked.Decrement(ref releasesRequired); + if (newValue <= 0) + { + count = 0; + owner?.Return(this); + } + } + public void Dispose() + { + Release(); + } + + + public void CopyTo(byte[] target, int offset) + { + if (count > (target.Length + offset)) + throw new ArgumentException($"{nameof(count)} was greater than {nameof(target)}.length", nameof(target)); + + Buffer.BlockCopy(array, 0, target, offset, count); + } + + public void CopyFrom(ArraySegment segment) + { + CopyFrom(segment.Array, segment.Offset, segment.Count); + } + + public void CopyFrom(byte[] source, int offset, int length) + { + if (length > array.Length) + throw new ArgumentException($"{nameof(length)} was greater than {nameof(array)}.length", nameof(length)); + + count = length; + Buffer.BlockCopy(source, offset, array, 0, length); + } + + public void CopyFrom(IntPtr bufferPtr, int length) + { + if (length > array.Length) + throw new ArgumentException($"{nameof(length)} was greater than {nameof(array)}.length", nameof(length)); + + count = length; + Marshal.Copy(bufferPtr, array, 0, length); + } + + public ArraySegment ToSegment() => new ArraySegment(array, 0, count); + + [Conditional("UNITY_ASSERTIONS")] + internal void Validate(int arraySize) + { + if (array.Length != arraySize) + Log.Error("[SimpleWebTransport] Buffer that was returned had an array of the wrong size"); + } + } + + internal class BufferBucket : IBufferOwner + { + public readonly int arraySize; + readonly ConcurrentQueue buffers; + + /// + /// keeps track of how many arrays are taken vs returned + /// + internal int _current = 0; + + public BufferBucket(int arraySize) + { + this.arraySize = arraySize; + buffers = new ConcurrentQueue(); + } + + public ArrayBuffer Take() + { + IncrementCreated(); + if (buffers.TryDequeue(out ArrayBuffer buffer)) + return buffer; + else + { + Log.Verbose($"[SimpleWebTransport] BufferBucket({arraySize}) create new"); + return new ArrayBuffer(this, arraySize); + } + } + + public void Return(ArrayBuffer buffer) + { + DecrementCreated(); + buffer.Validate(arraySize); + buffers.Enqueue(buffer); + } + + [Conditional("DEBUG")] + void IncrementCreated() + { + int next = Interlocked.Increment(ref _current); + // Log.Verbose($"[SimpleWebTransport] BufferBucket({arraySize}) count:{next}"); + } + [Conditional("DEBUG")] + void DecrementCreated() + { + int next = Interlocked.Decrement(ref _current); + // Log.Verbose($"[SimpleWebTransport] BufferBucket({arraySize}) count:{next}"); + } + } + + /// + /// Collection of different sized buffers + /// + /// + /// + /// Problem:
+ /// * Need to cached byte[] so that new ones aren't created each time
+ /// * Arrays sent are multiple different sizes
+ /// * Some message might be big so need buffers to cover that size
+ /// * Most messages will be small compared to max message size
+ /// + ///
+ /// + /// Solution:
+ /// * Create multiple groups of buffers covering the range of allowed sizes
+ /// * Split range exponentially (using math.log) so that there are more groups for small buffers
+ /// + /// + public class BufferPool + { + internal readonly BufferBucket[] buckets; + readonly int bucketCount; + readonly int smallest; + readonly int largest; + + public BufferPool(int bucketCount, int smallest, int largest) + { + if (bucketCount < 2) throw new ArgumentException("Count must be at least 2"); + if (smallest < 1) throw new ArgumentException("Smallest must be at least 1"); + if (largest < smallest) throw new ArgumentException("Largest must be greater than smallest"); + + this.bucketCount = bucketCount; + this.smallest = smallest; + this.largest = largest; + + // split range over log scale (more buckets for smaller sizes) + double minLog = Math.Log(this.smallest); + double maxLog = Math.Log(this.largest); + double range = maxLog - minLog; + double each = range / (bucketCount - 1); + + buckets = new BufferBucket[bucketCount]; + + for (int i = 0; i < bucketCount; i++) + { + double size = smallest * Math.Pow(Math.E, each * i); + buckets[i] = new BufferBucket((int)Math.Ceiling(size)); + } + + + Validate(); + + // Example + // 5 count + // 20 smallest + // 16400 largest + + // 3.0 log 20 + // 9.7 log 16400 + + // 6.7 range 9.7 - 3 + // 1.675 each 6.7 / (5-1) + + // 20 e^ (3 + 1.675 * 0) + // 107 e^ (3 + 1.675 * 1) + // 572 e^ (3 + 1.675 * 2) + // 3056 e^ (3 + 1.675 * 3) + // 16,317 e^ (3 + 1.675 * 4) + + // precision wont be lose when using doubles + } + + [Conditional("UNITY_ASSERTIONS")] + void Validate() + { + if (buckets[0].arraySize != smallest) + Log.Error($"[SimpleWebTransport] BufferPool Failed to create bucket for smallest. bucket:{buckets[0].arraySize} smallest{smallest}"); + + int largestBucket = buckets[bucketCount - 1].arraySize; + // rounded using Ceiling, so allowed to be 1 more that largest + if (largestBucket != largest && largestBucket != largest + 1) + Log.Error($"[SimpleWebTransport] BufferPool Failed to create bucket for largest. bucket:{largestBucket} smallest{largest}"); + } + + public ArrayBuffer Take(int size) + { + if (size > largest) { throw new ArgumentException($"Size ({size}) is greatest that largest ({largest})"); } + + for (int i = 0; i < bucketCount; i++) + if (size <= buckets[i].arraySize) + return buckets[i].Take(); + + throw new ArgumentException($"Size ({size}) is greatest that largest ({largest})"); + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/BufferPool.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/BufferPool.cs.meta new file mode 100644 index 0000000..0b1070f --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/BufferPool.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 94ae50f3ec35667469b861b12cd72f92 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Connection.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Connection.cs new file mode 100644 index 0000000..c8081c4 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Connection.cs @@ -0,0 +1,133 @@ +using System; +using System.Collections.Concurrent; +using System.IO; +using System.Linq; +using System.Net; +using System.Net.Sockets; +using System.Threading; + +namespace Mirror.SimpleWeb +{ + internal sealed class Connection : IDisposable + { + public const int IdNotSet = -1; + private readonly object disposedLock = new object(); + + public TcpClient client; + + public int connId = IdNotSet; + + /// + /// Connect request, sent from client to start handshake + /// Only valid on server + /// + public Request request; + /// + /// RemoteEndpoint address or address from request header + /// Only valid on server + /// + public string remoteAddress; + + + public Stream stream; + public Thread receiveThread; + public Thread sendThread; + + public ManualResetEventSlim sendPending = new ManualResetEventSlim(false); + public ConcurrentQueue sendQueue = new ConcurrentQueue(); + + public Action onDispose; + private volatile bool hasDisposed; + + public Connection(TcpClient client, Action onDispose) + { + this.client = client ?? throw new ArgumentNullException(nameof(client)); + this.onDispose = onDispose; + } + + /// + /// disposes client and stops threads + /// + public void Dispose() + { + Log.Verbose($"[SimpleWebTransport] Dispose {ToString()}"); + + // check hasDisposed first to stop ThreadInterruptedException on lock + if (hasDisposed) return; + + Log.Info($"[SimpleWebTransport] Connection Close: {ToString()}"); + + lock (disposedLock) + { + // check hasDisposed again inside lock to make sure no other object has called this + if (hasDisposed) return; + + hasDisposed = true; + + // stop threads first so they don't try to use disposed objects + receiveThread.Interrupt(); + sendThread?.Interrupt(); + + try + { + // stream + stream?.Dispose(); + stream = null; + client.Dispose(); + client = null; + } + catch (Exception e) + { + Log.Exception(e); + } + + sendPending.Dispose(); + + // release all buffers in send queue + while (sendQueue.TryDequeue(out ArrayBuffer buffer)) + buffer.Release(); + + onDispose.Invoke(this); + } + } + + public override string ToString() + { + if (hasDisposed) + return $"[Conn:{connId}, Disposed]"; + else + try + { + System.Net.EndPoint endpoint = client?.Client?.RemoteEndPoint; + return $"[Conn:{connId}, endPoint:{endpoint}]"; + } + catch (SocketException) + { + return $"[Conn:{connId}, endPoint:n/a]"; + } + } + + /// + /// Gets the address based on the and RemoteEndPoint + /// Called after ServerHandShake is accepted + /// + internal string CalculateAddress() + { + if (request.Headers.TryGetValue("X-Forwarded-For", out string forwardFor)) + { + string actualClientIP = forwardFor.ToString().Split(',').First(); + // Remove the port number from the address + return actualClientIP.Split(':').First(); + } + else + { + IPEndPoint ipEndPoint = (IPEndPoint)client.Client.RemoteEndPoint; + IPAddress ipAddress = ipEndPoint.Address; + if (ipAddress.IsIPv4MappedToIPv6) + ipAddress = ipAddress.MapToIPv4(); + + return ipAddress.ToString(); + } + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Connection.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Connection.cs.meta new file mode 100644 index 0000000..d48a835 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Connection.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a13073c2b49d39943888df45174851bd +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Constants.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Constants.cs new file mode 100644 index 0000000..3aa16c3 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Constants.cs @@ -0,0 +1,77 @@ +using System.Text; + +namespace Mirror.SimpleWeb +{ + /// + /// Constant values that should never change + /// + /// Some values are from https://tools.ietf.org/html/rfc6455 + /// + /// + internal static class Constants + { + /// + /// Header is at most 4 bytes + /// + /// If message is less than 125 then header is 2 bytes, else header is 4 bytes + /// + /// + public const int HeaderSize = 4; + + /// + /// Smallest size of header + /// + /// If message is less than 125 then header is 2 bytes, else header is 4 bytes + /// + /// + public const int HeaderMinSize = 2; + + /// + /// bytes for short length + /// + public const int ShortLength = 2; + + /// + /// bytes for long length + /// + public const int LongLength = 8; + + /// + /// Message mask is always 4 bytes + /// + public const int MaskSize = 4; + + /// + /// Max size of a message for length to be 1 byte long + /// + /// payload length between 0-125 + /// + /// + public const int BytePayloadLength = 125; + + /// + /// if payload length is 126 when next 2 bytes will be the length + /// + public const int UshortPayloadLength = 126; + + /// + /// if payload length is 127 when next 8 bytes will be the length + /// + public const int UlongPayloadLength = 127; + + + /// + /// Guid used for WebSocket Protocol + /// + public const string HandshakeGUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; + + public static readonly int HandshakeGUIDLength = HandshakeGUID.Length; + + public static readonly byte[] HandshakeGUIDBytes = Encoding.ASCII.GetBytes(HandshakeGUID); + + /// + /// Handshake messages will end with \r\n\r\n + /// + public static readonly byte[] endOfHandshake = new byte[4] { (byte)'\r', (byte)'\n', (byte)'\r', (byte)'\n' }; + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Constants.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Constants.cs.meta new file mode 100644 index 0000000..ece602e --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Constants.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 85d110a089d6ad348abf2d073ebce7cd +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/EventType.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/EventType.cs new file mode 100644 index 0000000..3a9d185 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/EventType.cs @@ -0,0 +1,10 @@ +namespace Mirror.SimpleWeb +{ + public enum EventType + { + Connected, + Data, + Disconnected, + Error + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/EventType.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/EventType.cs.meta new file mode 100644 index 0000000..a91403a --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/EventType.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 2d9cd7d2b5229ab42a12e82ae17d0347 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Log.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Log.cs new file mode 100644 index 0000000..e0c5309 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Log.cs @@ -0,0 +1,108 @@ +using System; +using UnityEngine; +using Conditional = System.Diagnostics.ConditionalAttribute; + +namespace Mirror.SimpleWeb +{ + public static class Log + { + public enum Levels + { + none = 0, + error = 1, + warn = 2, + info = 3, + verbose = 4, + } + + public static ILogger logger = Debug.unityLogger; + public static Levels level = Levels.none; + + public static string BufferToString(byte[] buffer, int offset = 0, int? length = null) + { + return BitConverter.ToString(buffer, offset, length ?? buffer.Length); + } + + public static void DumpBuffer(string label, byte[] buffer, int offset, int length) + { + if (level < Levels.verbose) + return; + + logger.Log(LogType.Log, $"[SimpleWebTransport] VERBOSE: {label}: {BufferToString(buffer, offset, length)}"); + } + + public static void DumpBuffer(string label, ArrayBuffer arrayBuffer) + { + if (level < Levels.verbose) + return; + + logger.Log(LogType.Log, $"[SimpleWebTransport] VERBOSE: {label}: {BufferToString(arrayBuffer.array, 0, arrayBuffer.count)}"); + } + + public static void Verbose(string msg, bool showColor = true) + { + if (level < Levels.verbose) + return; + + if (showColor) + logger.Log(LogType.Log, $"[SimpleWebTransport] VERBOSE: {msg}"); + else + logger.Log(LogType.Log, $"[SimpleWebTransport] VERBOSE: {msg}"); + } + + public static void Info(string msg, bool showColor = true) + { + if (level < Levels.info) + return; + + if (showColor) + logger.Log(LogType.Log, $"[SimpleWebTransport] INFO: {msg}"); + else + logger.Log(LogType.Log, $"[SimpleWebTransport] INFO: {msg}"); + } + + public static void InfoException(Exception e) + { + if (level < Levels.info) + return; + +#if UNITY_SERVER + logger.Log(LogType.Log, $"[SimpleWebTransport] INFO_EXCEPTION: {e.GetType().Name} Message: {e.Message}\n{e.StackTrace}\n\n"); +#else + logger.Log(LogType.Log, $"[SimpleWebTransport] INFO_EXCEPTION: {e.GetType().Name} Message: {e.Message}\n{e.StackTrace}\n\n"); +#endif + } + + public static void Warn(string msg, bool showColor = true) + { + if (level < Levels.warn) + return; + + if (showColor) + logger.Log(LogType.Warning, $"[SimpleWebTransport] WARN: {msg}"); + else + logger.Log(LogType.Warning, $"[SimpleWebTransport] WARN: {msg}"); + } + + public static void Error(string msg, bool showColor = true) + { + if (level < Levels.error) + return; + + if (showColor) + logger.Log(LogType.Error, $"[SimpleWebTransport] ERROR: {msg}"); + else + logger.Log(LogType.Error, $"[SimpleWebTransport] ERROR: {msg}"); + } + + public static void Exception(Exception e) + { + // always log Exceptions +#if UNITY_SERVER + logger.Log(LogType.Error, $"[SimpleWebTransport] EXCEPTION: {e.GetType().Name} Message: {e.Message}\n{e.StackTrace}\n\n"); +#else + logger.Log(LogType.Error, $"[SimpleWebTransport] EXCEPTION: {e.GetType().Name} Message: {e.Message}\n{e.StackTrace}\n\n"); +#endif + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Log.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Log.cs.meta new file mode 100644 index 0000000..beb2883 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Log.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 3cf1521098e04f74fbea0fe2aa0439f8 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Message.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Message.cs new file mode 100644 index 0000000..29b4849 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Message.cs @@ -0,0 +1,49 @@ +using System; + +namespace Mirror.SimpleWeb +{ + public struct Message + { + public readonly int connId; + public readonly EventType type; + public readonly ArrayBuffer data; + public readonly Exception exception; + + public Message(EventType type) : this() + { + this.type = type; + } + + public Message(ArrayBuffer data) : this() + { + type = EventType.Data; + this.data = data; + } + + public Message(Exception exception) : this() + { + type = EventType.Error; + this.exception = exception; + } + + public Message(int connId, EventType type) : this() + { + this.connId = connId; + this.type = type; + } + + public Message(int connId, ArrayBuffer data) : this() + { + this.connId = connId; + type = EventType.Data; + this.data = data; + } + + public Message(int connId, Exception exception) : this() + { + this.connId = connId; + type = EventType.Error; + this.exception = exception; + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Message.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Message.cs.meta new file mode 100644 index 0000000..3286a2c --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Message.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f5d05d71b09d2714b96ffe80bc3d2a77 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/MessageProcessor.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/MessageProcessor.cs new file mode 100644 index 0000000..e3269f3 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/MessageProcessor.cs @@ -0,0 +1,175 @@ +using System; +using System.IO; +using System.Runtime.CompilerServices; + +namespace Mirror.SimpleWeb +{ + public static class MessageProcessor + { + [MethodImpl(MethodImplOptions.AggressiveInlining)] + static byte FirstLengthByte(byte[] buffer) => (byte)(buffer[1] & 0b0111_1111); + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool NeedToReadShortLength(byte[] buffer) + { + byte lenByte = FirstLengthByte(buffer); + return lenByte == Constants.UshortPayloadLength; + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool NeedToReadLongLength(byte[] buffer) + { + byte lenByte = FirstLengthByte(buffer); + return lenByte == Constants.UlongPayloadLength; + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static int GetOpcode(byte[] buffer) => buffer[0] & 0b0000_1111; + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static int GetPayloadLength(byte[] buffer) => GetMessageLength(buffer, 0, FirstLengthByte(buffer)); + + /// + /// Has full message been sent + /// + /// + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool Finished(byte[] buffer) => (buffer[0] & 0b1000_0000) != 0; + + public static void ValidateHeader(byte[] buffer, int maxLength, bool expectMask, bool opCodeContinuation = false) + { + bool finished = Finished(buffer); + bool hasMask = (buffer[1] & 0b1000_0000) != 0; // true from clients, false from server, "All messages from the client to the server have this bit set" + + int opcode = buffer[0] & 0b0000_1111; // expecting 1 - text message + byte lenByte = FirstLengthByte(buffer); + + ThrowIfMaskNotExpected(hasMask, expectMask); + ThrowIfBadOpCode(opcode, finished, opCodeContinuation); + + int msglen = GetMessageLength(buffer, 0, lenByte); + + ThrowIfLengthZero(msglen); + ThrowIfMsgLengthTooLong(msglen, maxLength); + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void ToggleMask(byte[] src, int sourceOffset, int messageLength, byte[] maskBuffer, int maskOffset) + { + ToggleMask(src, sourceOffset, src, sourceOffset, messageLength, maskBuffer, maskOffset); + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void ToggleMask(byte[] src, int sourceOffset, ArrayBuffer dst, int messageLength, byte[] maskBuffer, int maskOffset) + { + ToggleMask(src, sourceOffset, dst.array, 0, messageLength, maskBuffer, maskOffset); + dst.count = messageLength; + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static void ToggleMask(byte[] src, int srcOffset, byte[] dst, int dstOffset, int messageLength, byte[] maskBuffer, int maskOffset) + { + for (int i = 0; i < messageLength; i++) + { + byte maskByte = maskBuffer[maskOffset + i % Constants.MaskSize]; + dst[dstOffset + i] = (byte)(src[srcOffset + i] ^ maskByte); + } + } + + /// + static int GetMessageLength(byte[] buffer, int offset, byte lenByte) + { + if (lenByte == Constants.UshortPayloadLength) + { + // header is 2 bytes + ushort value = 0; + value |= (ushort)(buffer[offset + 2] << 8); + value |= buffer[offset + 3]; + + return value; + } + else if (lenByte == Constants.UlongPayloadLength) + { + // header is 8 bytes + ulong value = 0; + value |= ((ulong)buffer[offset + 2] << 56); + value |= ((ulong)buffer[offset + 3] << 48); + value |= ((ulong)buffer[offset + 4] << 40); + value |= ((ulong)buffer[offset + 5] << 32); + value |= ((ulong)buffer[offset + 6] << 24); + value |= ((ulong)buffer[offset + 7] << 16); + value |= ((ulong)buffer[offset + 8] << 8); + value |= ((ulong)buffer[offset + 9] << 0); + + if (value > int.MaxValue) + throw new NotSupportedException($"Can't receive payloads larger that int.max: {int.MaxValue}"); + + return (int)value; + } + else // is less than 126 + { + // header is 2 bytes long + return lenByte; + } + } + + /// + static void ThrowIfMaskNotExpected(bool hasMask, bool expectMask) + { + if (hasMask != expectMask) + throw new InvalidDataException($"Message expected mask to be {expectMask} but was {hasMask}"); + } + + /// + static void ThrowIfBadOpCode(int opcode, bool finished, bool opCodeContinuation) + { + // 0 = continuation + // 2 = binary + // 8 = close + + // do we expect Continuation? + if (opCodeContinuation) + { + // good it was Continuation + if (opcode == 0) + return; + + // bad, wasn't Continuation + throw new InvalidDataException("Expected opcode to be Continuation"); + } + else if (!finished) + { + // fragmented message, should be binary + if (opcode == 2) + return; + + throw new InvalidDataException("Expected opcode to be binary"); + } + else + { + // normal message, should be binary or close + if (opcode == 2 || opcode == 8) + return; + + throw new InvalidDataException("Expected opcode to be binary or close"); + } + } + + /// + static void ThrowIfLengthZero(int msglen) + { + if (msglen == 0) + throw new InvalidDataException("Message length was zero"); + } + + /// + /// need to check this so that data from previous buffer isn't used + /// + public static void ThrowIfMsgLengthTooLong(int msglen, int maxLength) + { + if (msglen > maxLength) + throw new InvalidDataException("Message length is greater than max length"); + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/MessageProcessor.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/MessageProcessor.cs.meta new file mode 100644 index 0000000..7e3a7c4 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/MessageProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 4c1f218a2b16ca846aaf23260078e549 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReadHelper.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReadHelper.cs new file mode 100644 index 0000000..f8b5c3b --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReadHelper.cs @@ -0,0 +1,123 @@ +using System; +using System.IO; +using System.Runtime.Serialization; + +namespace Mirror.SimpleWeb +{ + public static class ReadHelper + { + /// + /// Reads exactly length from stream + /// + /// outOffset + length + /// + public static int Read(Stream stream, byte[] outBuffer, int outOffset, int length) + { + int received = 0; + try + { + while (received < length) + { + int read = stream.Read(outBuffer, outOffset + received, length - received); + if (read == 0) + throw new ReadHelperException("returned 0"); + + received += read; + } + } + catch (AggregateException ae) + { + // if interrupt is called we don't care about Exceptions + Utils.CheckForInterupt(); + + // rethrow + ae.Handle(e => false); + } + + if (received != length) + throw new ReadHelperException("returned not equal to length"); + + return outOffset + received; + } + + /// + /// Reads and returns results. This should never throw an exception + /// + public static bool TryRead(Stream stream, byte[] outBuffer, int outOffset, int length) + { + try + { + Read(stream, outBuffer, outOffset, length); + return true; + } + catch (ReadHelperException) + { + return false; + } + catch (IOException) + { + return false; + } + catch (Exception e) + { + Log.Exception(e); + return false; + } + } + + public static int? SafeReadTillMatch(Stream stream, byte[] outBuffer, int outOffset, int maxLength, byte[] endOfHeader) + { + try + { + int read = 0; + int endIndex = 0; + int endLength = endOfHeader.Length; + while (true) + { + int next = stream.ReadByte(); + if (next == -1) // closed + return null; + + if (read >= maxLength) + { + Log.Error("[SimpleWebTransport] SafeReadTillMatch exceeded maxLength"); + return null; + } + + outBuffer[outOffset + read] = (byte)next; + read++; + + // if n is match, check n+1 next + if (endOfHeader[endIndex] == next) + { + endIndex++; + // when all is match return with read length + if (endIndex >= endLength) + return read; + } + // if n not match reset to 0 + else + endIndex = 0; + } + } + catch (IOException e) + { + Log.InfoException(e); + return null; + } + catch (Exception e) + { + Log.Exception(e); + return null; + } + } + } + + [Serializable] + public class ReadHelperException : Exception + { + public ReadHelperException(string message) : base(message) { } + + protected ReadHelperException(SerializationInfo info, StreamingContext context) : base(info, context) { } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReadHelper.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReadHelper.cs.meta new file mode 100644 index 0000000..77d09c1 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReadHelper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 9f4fa5d324e708c46a55810a97de75bc +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReceiveLoop.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReceiveLoop.cs new file mode 100644 index 0000000..21ef782 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReceiveLoop.cs @@ -0,0 +1,254 @@ +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.IO; +using System.Net.Sockets; +using System.Text; +using System.Threading; +using UnityEngine.Profiling; + +namespace Mirror.SimpleWeb +{ + internal static class ReceiveLoop + { + public struct Config + { + public readonly Connection conn; + public readonly int maxMessageSize; + public readonly bool expectMask; + public readonly ConcurrentQueue queue; + public readonly BufferPool bufferPool; + + public Config(Connection conn, int maxMessageSize, bool expectMask, ConcurrentQueue queue, BufferPool bufferPool) + { + this.conn = conn ?? throw new ArgumentNullException(nameof(conn)); + this.maxMessageSize = maxMessageSize; + this.expectMask = expectMask; + this.queue = queue ?? throw new ArgumentNullException(nameof(queue)); + this.bufferPool = bufferPool ?? throw new ArgumentNullException(nameof(bufferPool)); + } + + public void Deconstruct(out Connection conn, out int maxMessageSize, out bool expectMask, out ConcurrentQueue queue, out BufferPool bufferPool) + { + conn = this.conn; + maxMessageSize = this.maxMessageSize; + expectMask = this.expectMask; + queue = this.queue; + bufferPool = this.bufferPool; + } + } + + struct Header + { + public int payloadLength; + public int offset; + public int opcode; + public bool finished; + } + + public static void Loop(Config config) + { + (Connection conn, int maxMessageSize, bool expectMask, ConcurrentQueue queue, BufferPool _) = config; + + Profiler.BeginThreadProfiling("SimpleWeb", $"ReceiveLoop {conn.connId}"); + + byte[] readBuffer = new byte[Constants.HeaderSize + (expectMask ? Constants.MaskSize : 0) + maxMessageSize]; + try + { + try + { + TcpClient client = conn.client; + + while (client.Connected) + ReadOneMessage(config, readBuffer); + + Log.Info($"[SimpleWebTransport] {conn} Not Connected"); + } + catch (Exception) + { + // if interrupted we don't care about other exceptions + Utils.CheckForInterupt(); + throw; + } + } + catch (ThreadInterruptedException e) { Log.InfoException(e); } + catch (ThreadAbortException e) { Log.InfoException(e); } + catch (ObjectDisposedException e) { Log.InfoException(e); } + catch (ReadHelperException e) + { + Log.InfoException(e); + } + catch (SocketException e) + { + // this could happen if wss client closes stream + Log.Warn($"[SimpleWebTransport] ReceiveLoop SocketException\n{e.Message}", false); + queue.Enqueue(new Message(conn.connId, e)); + } + catch (IOException e) + { + // this could happen if client disconnects + Log.Warn($"[SimpleWebTransport] ReceiveLoop IOException\n{e.Message}", false); + queue.Enqueue(new Message(conn.connId, e)); + } + catch (InvalidDataException e) + { + Log.Error($"[SimpleWebTransport] Invalid data from {conn}: {e.Message}"); + queue.Enqueue(new Message(conn.connId, e)); + } + catch (Exception e) + { + Log.Exception(e); + queue.Enqueue(new Message(conn.connId, e)); + } + finally + { + Profiler.EndThreadProfiling(); + conn.Dispose(); + } + } + + static void ReadOneMessage(Config config, byte[] buffer) + { + (Connection conn, int maxMessageSize, bool expectMask, ConcurrentQueue queue, BufferPool bufferPool) = config; + Stream stream = conn.stream; + + Header header = ReadHeader(config, buffer); + + int msgOffset = header.offset; + header.offset = ReadHelper.Read(stream, buffer, header.offset, header.payloadLength); + + if (header.finished) + { + switch (header.opcode) + { + case 2: + HandleArrayMessage(config, buffer, msgOffset, header.payloadLength); + break; + case 8: + HandleCloseMessage(config, buffer, msgOffset, header.payloadLength); + break; + } + } + else + { + // todo cache this to avoid allocations + Queue fragments = new Queue(); + fragments.Enqueue(CopyMessageToBuffer(bufferPool, expectMask, buffer, msgOffset, header.payloadLength)); + int totalSize = header.payloadLength; + + while (!header.finished) + { + header = ReadHeader(config, buffer, opCodeContinuation: true); + + msgOffset = header.offset; + header.offset = ReadHelper.Read(stream, buffer, header.offset, header.payloadLength); + fragments.Enqueue(CopyMessageToBuffer(bufferPool, expectMask, buffer, msgOffset, header.payloadLength)); + + totalSize += header.payloadLength; + MessageProcessor.ThrowIfMsgLengthTooLong(totalSize, maxMessageSize); + } + + + ArrayBuffer msg = bufferPool.Take(totalSize); + msg.count = 0; + while (fragments.Count > 0) + { + ArrayBuffer part = fragments.Dequeue(); + + part.CopyTo(msg.array, msg.count); + msg.count += part.count; + + part.Release(); + } + + // dump after mask off + Log.DumpBuffer($"[SimpleWebTransport] Message", msg); + + queue.Enqueue(new Message(conn.connId, msg)); + } + } + + static Header ReadHeader(Config config, byte[] buffer, bool opCodeContinuation = false) + { + (Connection conn, int maxMessageSize, bool expectMask, ConcurrentQueue queue, BufferPool bufferPool) = config; + Stream stream = conn.stream; + Header header = new Header(); + + // read 2 + header.offset = ReadHelper.Read(stream, buffer, header.offset, Constants.HeaderMinSize); + // log after first blocking call + // Log.Verbose($"[SimpleWebTransport] Message From {conn}"); + + if (MessageProcessor.NeedToReadShortLength(buffer)) + header.offset = ReadHelper.Read(stream, buffer, header.offset, Constants.ShortLength); + if (MessageProcessor.NeedToReadLongLength(buffer)) + header.offset = ReadHelper.Read(stream, buffer, header.offset, Constants.LongLength); + + // Log.DumpBuffer($"[SimpleWebTransport] Raw Header", buffer, 0, header.offset); + + MessageProcessor.ValidateHeader(buffer, maxMessageSize, expectMask, opCodeContinuation); + + if (expectMask) + header.offset = ReadHelper.Read(stream, buffer, header.offset, Constants.MaskSize); + + header.opcode = MessageProcessor.GetOpcode(buffer); + header.payloadLength = MessageProcessor.GetPayloadLength(buffer); + header.finished = MessageProcessor.Finished(buffer); + + // Log.Verbose($"[SimpleWebTransport] Header ln:{header.payloadLength} op:{header.opcode} mask:{expectMask}"); + + return header; + } + + static void HandleArrayMessage(Config config, byte[] buffer, int msgOffset, int payloadLength) + { + (Connection conn, int _, bool expectMask, ConcurrentQueue queue, BufferPool bufferPool) = config; + + ArrayBuffer arrayBuffer = CopyMessageToBuffer(bufferPool, expectMask, buffer, msgOffset, payloadLength); + + // dump after mask off + Log.DumpBuffer($"[SimpleWebTransport] Message", arrayBuffer); + + queue.Enqueue(new Message(conn.connId, arrayBuffer)); + } + + static ArrayBuffer CopyMessageToBuffer(BufferPool bufferPool, bool expectMask, byte[] buffer, int msgOffset, int payloadLength) + { + ArrayBuffer arrayBuffer = bufferPool.Take(payloadLength); + + if (expectMask) + { + int maskOffset = msgOffset - Constants.MaskSize; + // write the result of toggle directly into arrayBuffer to avoid 2nd copy call + MessageProcessor.ToggleMask(buffer, msgOffset, arrayBuffer, payloadLength, buffer, maskOffset); + } + else + arrayBuffer.CopyFrom(buffer, msgOffset, payloadLength); + + return arrayBuffer; + } + + static void HandleCloseMessage(Config config, byte[] buffer, int msgOffset, int payloadLength) + { + (Connection conn, int _, bool expectMask, ConcurrentQueue _, BufferPool _) = config; + + if (expectMask) + { + int maskOffset = msgOffset - Constants.MaskSize; + MessageProcessor.ToggleMask(buffer, msgOffset, payloadLength, buffer, maskOffset); + } + + // dump after mask off + // Log.DumpBuffer($"[SimpleWebTransport] Message", buffer, msgOffset, payloadLength); + Log.Info($"[SimpleWebTransport] Close: {GetCloseCode(buffer, msgOffset)} message:{GetCloseMessage(buffer, msgOffset, payloadLength)}"); + + conn.Dispose(); + } + + static string GetCloseMessage(byte[] buffer, int msgOffset, int payloadLength) + => Encoding.UTF8.GetString(buffer, msgOffset + 2, payloadLength - 2); + + static int GetCloseCode(byte[] buffer, int msgOffset) + => buffer[msgOffset + 0] << 8 | buffer[msgOffset + 1]; + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReceiveLoop.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReceiveLoop.cs.meta new file mode 100644 index 0000000..47c6ff5 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/ReceiveLoop.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a26c2815f58431c4a98c158c8b655ffd +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Request.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Request.cs new file mode 100644 index 0000000..705b957 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Request.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Mirror.SimpleWeb +{ + /// + /// Represents a client's request to the Websockets server, which is the first message from the client. + /// + public class Request + { + private static readonly char[] lineSplitChars = new char[] { '\r', '\n' }; + private static readonly char[] headerSplitChars = new char[] { ':' }; + public string RequestLine; + public Dictionary Headers = new Dictionary(); + + public Request(string message) + { + string[] all = message.Split(lineSplitChars, StringSplitOptions.RemoveEmptyEntries); + RequestLine = all.First(); + Headers = all.Skip(1) + .Select(header => header.Split(headerSplitChars, 2, StringSplitOptions.RemoveEmptyEntries)) + .ToDictionary(split => split[0].Trim(), split => split[1].Trim()); + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Request.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Request.cs.meta new file mode 100644 index 0000000..8baf222 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Request.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 50b41ad63d4956a42a073bad5158fe09 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/SendLoop.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/SendLoop.cs new file mode 100644 index 0000000..31c6726 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/SendLoop.cs @@ -0,0 +1,225 @@ +using System; +using System.IO; +using System.Net.Sockets; +using System.Security.Cryptography; +using System.Threading; +using UnityEngine.Profiling; + +namespace Mirror.SimpleWeb +{ + public static class SendLoopConfig + { + public static volatile bool batchSend = false; + public static volatile bool sleepBeforeSend = false; + } + internal static class SendLoop + { + public struct Config + { + public readonly Connection conn; + public readonly int bufferSize; + public readonly bool setMask; + + public Config(Connection conn, int bufferSize, bool setMask) + { + this.conn = conn ?? throw new ArgumentNullException(nameof(conn)); + this.bufferSize = bufferSize; + this.setMask = setMask; + } + + public void Deconstruct(out Connection conn, out int bufferSize, out bool setMask) + { + conn = this.conn; + bufferSize = this.bufferSize; + setMask = this.setMask; + } + } + + public static void Loop(Config config) + { + (Connection conn, int bufferSize, bool setMask) = config; + + Profiler.BeginThreadProfiling("SimpleWeb", $"SendLoop {conn.connId}"); + + // create write buffer for this thread + byte[] writeBuffer = new byte[bufferSize]; + MaskHelper maskHelper = setMask ? new MaskHelper() : null; + try + { + TcpClient client = conn.client; + Stream stream = conn.stream; + + // null check in case disconnect while send thread is starting + if (client == null) + return; + + while (client.Connected) + { + // wait for message + conn.sendPending.Wait(); + // wait for 1ms for mirror to send other messages + if (SendLoopConfig.sleepBeforeSend) + Thread.Sleep(1); + + conn.sendPending.Reset(); + + if (SendLoopConfig.batchSend) + { + int offset = 0; + while (conn.sendQueue.TryDequeue(out ArrayBuffer msg)) + { + // check if connected before sending message + if (!client.Connected) + { + Log.Info($"[SimpleWebTransport] SendLoop {conn} not connected"); + msg.Release(); + return; + } + + int maxLength = msg.count + Constants.HeaderSize + Constants.MaskSize; + + // if next writer could overflow, write to stream and clear buffer + if (offset + maxLength > bufferSize) + { + stream.Write(writeBuffer, 0, offset); + offset = 0; + } + + offset = SendMessage(writeBuffer, offset, msg, setMask, maskHelper); + msg.Release(); + } + + // after no message in queue, send remaining messages + // don't need to check offset > 0 because last message in queue will always be sent here + + stream.Write(writeBuffer, 0, offset); + } + else + { + while (conn.sendQueue.TryDequeue(out ArrayBuffer msg)) + { + // check if connected before sending message + if (!client.Connected) + { + Log.Info($"[SimpleWebTransport] SendLoop {conn} not connected"); + msg.Release(); + return; + } + + int length = SendMessage(writeBuffer, 0, msg, setMask, maskHelper); + stream.Write(writeBuffer, 0, length); + msg.Release(); + } + } + } + + Log.Info($"[SimpleWebTransport] {conn} Not Connected"); + } + catch (ThreadInterruptedException e) { Log.InfoException(e); } + catch (ThreadAbortException e) { Log.InfoException(e); } + catch (Exception e) + { + Log.Exception(e); + } + finally + { + Profiler.EndThreadProfiling(); + conn.Dispose(); + maskHelper?.Dispose(); + } + } + + /// new offset in buffer + static int SendMessage(byte[] buffer, int startOffset, ArrayBuffer msg, bool setMask, MaskHelper maskHelper) + { + int msgLength = msg.count; + int offset = WriteHeader(buffer, startOffset, msgLength, setMask); + + if (setMask) + { + offset = maskHelper.WriteMask(buffer, offset); + } + + msg.CopyTo(buffer, offset); + offset += msgLength; + + // dump before mask on + // Log.DumpBuffer("[SimpleWebTransport] Send", buffer, startOffset, offset); + + if (setMask) + { + int messageOffset = offset - msgLength; + MessageProcessor.ToggleMask(buffer, messageOffset, msgLength, buffer, messageOffset - Constants.MaskSize); + } + + return offset; + } + + public static int WriteHeader(byte[] buffer, int startOffset, int msgLength, bool setMask) + { + int sendLength = 0; + const byte finished = 128; + const byte byteOpCode = 2; + + buffer[startOffset + 0] = finished | byteOpCode; + sendLength++; + + if (msgLength <= Constants.BytePayloadLength) + { + buffer[startOffset + 1] = (byte)msgLength; + sendLength++; + } + else if (msgLength <= ushort.MaxValue) + { + buffer[startOffset + 1] = 126; + buffer[startOffset + 2] = (byte)(msgLength >> 8); + buffer[startOffset + 3] = (byte)msgLength; + sendLength += 3; + } + else + { + buffer[startOffset + 1] = 127; + // must be 64 bytes, but we only have 32 bit length, so first 4 bits are 0 + buffer[startOffset + 2] = 0; + buffer[startOffset + 3] = 0; + buffer[startOffset + 4] = 0; + buffer[startOffset + 5] = 0; + buffer[startOffset + 6] = (byte)(msgLength >> 24); + buffer[startOffset + 7] = (byte)(msgLength >> 16); + buffer[startOffset + 8] = (byte)(msgLength >> 8); + buffer[startOffset + 9] = (byte)msgLength; + + sendLength += 9; + } + + if (setMask) + buffer[startOffset + 1] |= 0b1000_0000; + + return sendLength + startOffset; + } + + } + sealed class MaskHelper : IDisposable + { + readonly byte[] maskBuffer; + readonly RNGCryptoServiceProvider random; + + public MaskHelper() + { + maskBuffer = new byte[4]; + random = new RNGCryptoServiceProvider(); + } + public void Dispose() + { + random.Dispose(); + } + + public int WriteMask(byte[] buffer, int offset) + { + random.GetBytes(maskBuffer); + Buffer.BlockCopy(maskBuffer, 0, buffer, offset, 4); + + return offset + 4; + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/SendLoop.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/SendLoop.cs.meta new file mode 100644 index 0000000..09dfd1e --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/SendLoop.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: f87dd81736d9c824db67f808ac71841d +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/TcpConfig.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/TcpConfig.cs new file mode 100644 index 0000000..230cd7a --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/TcpConfig.cs @@ -0,0 +1,26 @@ +using System.Net.Sockets; + +namespace Mirror.SimpleWeb +{ + [System.Serializable] + public struct TcpConfig + { + public readonly bool noDelay; + public readonly int sendTimeout; + public readonly int receiveTimeout; + + public TcpConfig(bool noDelay, int sendTimeout, int receiveTimeout) + { + this.noDelay = noDelay; + this.sendTimeout = sendTimeout; + this.receiveTimeout = receiveTimeout; + } + + public void ApplyTo(TcpClient client) + { + client.SendTimeout = sendTimeout; + client.ReceiveTimeout = receiveTimeout; + client.NoDelay = noDelay; + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/TcpConfig.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/TcpConfig.cs.meta new file mode 100644 index 0000000..62ba232 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/TcpConfig.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 81ac8d35f28fab14b9edda5cd9d4fc86 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Utils.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Utils.cs new file mode 100644 index 0000000..b8a860c --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Utils.cs @@ -0,0 +1,13 @@ +using System.Threading; + +namespace Mirror.SimpleWeb +{ + internal static class Utils + { + public static void CheckForInterupt() + { + // sleep in order to check for ThreadInterruptedException + Thread.Sleep(1); + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Utils.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Utils.cs.meta new file mode 100644 index 0000000..79a1583 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Common/Utils.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 4643ffb4cb0562847b1ae925d07e15b6 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/LICENSE b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/LICENSE new file mode 100644 index 0000000..d2b4728 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 James Frowen + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/LICENSE.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/LICENSE.meta new file mode 100644 index 0000000..8ece59e --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/LICENSE.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 0a0cf751b4a201242ac60b4adbc54657 +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/README.txt b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/README.txt new file mode 100644 index 0000000..fd59b3d --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/README.txt @@ -0,0 +1,19 @@ +SimpleWebTransport is a Transport that implements websocket for Webgl +Can be used in High level networking solution like Mirror or Mirage +This transport can also work on standalone builds and has support for +encryption with websocket secure. + +Requirements: + Unity 2019.4 LTS + +Documentation: + https://mirror-networking.gitbook.io/docs/ + https://github.com/James-Frowen/SimpleWebTransport/blob/master/README.md + +Support: + Discord: https://discord.gg/BZTQcftBkE + Bug Reports: https://github.com/James-Frowen/SimpleWebTransport/issues + + +**To get most recent updates and fixes download from github** +https://github.com/James-Frowen/SimpleWebTransport/releases diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/README.txt.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/README.txt.meta new file mode 100644 index 0000000..b63fe39 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/README.txt.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 0e3971d5783109f4d9ce93c7a689d701 +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server.meta new file mode 100644 index 0000000..31f317f --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 0e599e92544d43344a9a9060052add28 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerHandshake.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerHandshake.cs new file mode 100644 index 0000000..e603b83 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerHandshake.cs @@ -0,0 +1,156 @@ +using System; +using System.IO; +using System.Security.Cryptography; +using System.Text; + +namespace Mirror.SimpleWeb +{ + /// + /// Handles Handshakes from new clients on the server + /// The server handshake has buffers to reduce allocations when clients connect + /// + internal class ServerHandshake + { + const int GetSize = 3; + const int ResponseLength = 129; + const int KeyLength = 24; + const int MergedKeyLength = 60; + const string KeyHeaderString = "\r\nSec-WebSocket-Key: "; + // this isn't an official max, just a reasonable size for a websocket handshake + readonly int maxHttpHeaderSize = 3000; + + // SHA-1 is the websocket standard: + // https://www.rfc-editor.org/rfc/rfc6455 + // we should follow the standard, even though SHA1 is considered weak: + // https://stackoverflow.com/questions/38038841/why-is-sha-1-considered-insecure + readonly SHA1 sha1 = SHA1.Create(); + readonly BufferPool bufferPool; + + public ServerHandshake(BufferPool bufferPool, int handshakeMaxSize) + { + this.bufferPool = bufferPool; + maxHttpHeaderSize = handshakeMaxSize; + } + + ~ServerHandshake() + { + sha1.Dispose(); + } + + public bool TryHandshake(Connection conn) + { + Stream stream = conn.stream; + + using (ArrayBuffer getHeader = bufferPool.Take(GetSize)) + { + if (!ReadHelper.TryRead(stream, getHeader.array, 0, GetSize)) + return false; + + getHeader.count = GetSize; + + if (!IsGet(getHeader.array)) + { + Log.Warn($"[SimpleWebTransport] First bytes from client was not 'GET' for handshake, instead was {Log.BufferToString(getHeader.array, 0, GetSize)}", false); + return false; + } + } + + string msg = ReadToEndForHandshake(stream); + + if (string.IsNullOrEmpty(msg)) + return false; + + try + { + AcceptHandshake(stream, msg); + + conn.request = new Request(msg); + conn.remoteAddress = conn.CalculateAddress(); + + return true; + } + catch (ArgumentException e) + { + Log.InfoException(e); + return false; + } + } + + string ReadToEndForHandshake(Stream stream) + { + using (ArrayBuffer readBuffer = bufferPool.Take(maxHttpHeaderSize)) + { + int? readCountOrFail = ReadHelper.SafeReadTillMatch(stream, readBuffer.array, 0, maxHttpHeaderSize, Constants.endOfHandshake); + if (!readCountOrFail.HasValue) + return null; + + int readCount = readCountOrFail.Value; + + string msg = Encoding.ASCII.GetString(readBuffer.array, 0, readCount); + // GET isn't in the bytes we read here, so we need to add it back + msg = $"GET{msg}"; + Log.Info($"Client Handshake Message:\r\n{msg}", false); + + return msg; + } + } + + static bool IsGet(byte[] getHeader) + { + // just check bytes here instead of using Encoding.ASCII + return getHeader[0] == 71 && // G + getHeader[1] == 69 && // E + getHeader[2] == 84; // T + } + + void AcceptHandshake(Stream stream, string msg) + { + using ( + ArrayBuffer keyBuffer = bufferPool.Take(KeyLength + Constants.HandshakeGUIDLength), + responseBuffer = bufferPool.Take(ResponseLength)) + { + GetKey(msg, keyBuffer.array); + AppendGuid(keyBuffer.array); + byte[] keyHash = CreateHash(keyBuffer.array); + CreateResponse(keyHash, responseBuffer.array); + + stream.Write(responseBuffer.array, 0, ResponseLength); + } + } + + static void GetKey(string msg, byte[] keyBuffer) + { + int start = msg.IndexOf(KeyHeaderString, StringComparison.InvariantCultureIgnoreCase) + KeyHeaderString.Length; + + Log.Verbose($"[SimpleWebTransport] Handshake Key: {msg.Substring(start, KeyLength)}", false); + Encoding.ASCII.GetBytes(msg, start, KeyLength, keyBuffer, 0); + } + + static void AppendGuid(byte[] keyBuffer) + { + Buffer.BlockCopy(Constants.HandshakeGUIDBytes, 0, keyBuffer, KeyLength, Constants.HandshakeGUIDLength); + } + + byte[] CreateHash(byte[] keyBuffer) + { + Log.Verbose($"[SimpleWebTransport] Handshake Hashing {Encoding.ASCII.GetString(keyBuffer, 0, MergedKeyLength)}", false); + return sha1.ComputeHash(keyBuffer, 0, MergedKeyLength); + } + + static void CreateResponse(byte[] keyHash, byte[] responseBuffer) + { + string keyHashString = Convert.ToBase64String(keyHash); + + // compiler should merge these strings into 1 string before format + string message = string.Format( + "HTTP/1.1 101 Switching Protocols\r\n" + + "Connection: Upgrade\r\n" + + "Upgrade: websocket\r\n" + + "Sec-WebSocket-Accept: {0}\r\n\r\n", + keyHashString); + + Log.Verbose($"[SimpleWebTransport] Handshake Response length {message.Length}, IsExpected {message.Length == ResponseLength}", false); + Encoding.ASCII.GetBytes(message, 0, ResponseLength, responseBuffer, 0); + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerHandshake.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerHandshake.cs.meta new file mode 100644 index 0000000..6fa74da --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerHandshake.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6268509ac4fb48141b9944c03295da11 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerSslHelper.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerSslHelper.cs new file mode 100644 index 0000000..97daca2 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerSslHelper.cs @@ -0,0 +1,82 @@ +using System; +using System.IO; +using System.Net.Security; +using System.Net.Sockets; +using System.Security.Authentication; +using System.Security.Cryptography.X509Certificates; + +namespace Mirror.SimpleWeb +{ + public struct SslConfig + { + public readonly bool enabled; + public readonly string certPath; + public readonly string certPassword; + public readonly SslProtocols sslProtocols; + + public SslConfig(bool enabled, string certPath, string certPassword, SslProtocols sslProtocols) + { + this.enabled = enabled; + this.certPath = certPath; + this.certPassword = certPassword; + this.sslProtocols = sslProtocols; + } + } + internal class ServerSslHelper + { + readonly SslConfig config; + readonly X509Certificate2 certificate; + + public ServerSslHelper(SslConfig sslConfig) + { + Console.Clear(); + + config = sslConfig; + if (config.enabled) + { + certificate = new X509Certificate2(config.certPath, config.certPassword); + + Console.ForegroundColor = ConsoleColor.Cyan; + Console.WriteLine($"[SimpleWebTransport] SSL Certificate {certificate.Subject} loaded with expiration of {certificate.GetExpirationDateString()}"); + Console.ResetColor(); + } + } + + internal bool TryCreateStream(Connection conn) + { + NetworkStream stream = conn.client.GetStream(); + if (config.enabled) + { + try + { + conn.stream = CreateStream(stream); + return true; + } + catch (Exception e) + { + Console.ForegroundColor = ConsoleColor.Red; + Console.WriteLine($"[SimpleWebTransport] Create SSLStream Failed: {e.Message}"); + Console.ResetColor(); + + return false; + } + } + else + { + conn.stream = stream; + return true; + } + } + + Stream CreateStream(NetworkStream stream) + { + SslStream sslStream = new SslStream(stream, true, acceptClient); + sslStream.AuthenticateAsServer(certificate, false, config.sslProtocols, false); + + return sslStream; + } + + // always accept client + bool acceptClient(object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors) => true; + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerSslHelper.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerSslHelper.cs.meta new file mode 100644 index 0000000..e0d133c --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/ServerSslHelper.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 11061fee528ebdd43817a275b1e4a317 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/SimpleWebServer.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/SimpleWebServer.cs new file mode 100644 index 0000000..3013994 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/SimpleWebServer.cs @@ -0,0 +1,117 @@ +using System; +using System.Collections.Generic; +using UnityEngine; + +namespace Mirror.SimpleWeb +{ + public class SimpleWebServer + { + public event Action onConnect; + public event Action onDisconnect; + public event Action> onData; + public event Action onError; + + readonly int maxMessagesPerTick; + readonly WebSocketServer server; + readonly BufferPool bufferPool; + + public bool Active { get; private set; } + + public SimpleWebServer(int maxMessagesPerTick, TcpConfig tcpConfig, int maxMessageSize, int handshakeMaxSize, SslConfig sslConfig) + { + this.maxMessagesPerTick = maxMessagesPerTick; + // use max because bufferpool is used for both messages and handshake + int max = Math.Max(maxMessageSize, handshakeMaxSize); + bufferPool = new BufferPool(5, 20, max); + server = new WebSocketServer(tcpConfig, maxMessageSize, handshakeMaxSize, sslConfig, bufferPool); + } + + public void Start(ushort port) + { + server.Listen(port); + Active = true; + } + + public void Stop() + { + server.Stop(); + Active = false; + } + + public void SendAll(List connectionIds, ArraySegment source) + { + ArrayBuffer buffer = bufferPool.Take(source.Count); + buffer.CopyFrom(source); + buffer.SetReleasesRequired(connectionIds.Count); + + // make copy of array before for each, data sent to each client is the same + foreach (int id in connectionIds) + server.Send(id, buffer); + } + + public void SendOne(int connectionId, ArraySegment source) + { + ArrayBuffer buffer = bufferPool.Take(source.Count); + buffer.CopyFrom(source); + server.Send(connectionId, buffer); + } + + public bool KickClient(int connectionId) => server.CloseConnection(connectionId); + + public string GetClientAddress(int connectionId) => server.GetClientAddress(connectionId); + + public Request GetClientRequest(int connectionId) => server.GetClientRequest(connectionId); + + /// + /// Processes all new messages + /// + public void ProcessMessageQueue() + { + ProcessMessageQueue(null); + } + + /// + /// Processes all messages while is enabled + /// + /// + public void ProcessMessageQueue(MonoBehaviour behaviour) + { + int processedCount = 0; + bool skipEnabled = behaviour == null; + // check enabled every time in case behaviour was disabled after data + while ( + (skipEnabled || behaviour.enabled) && + processedCount < maxMessagesPerTick && + // Dequeue last + server.receiveQueue.TryDequeue(out Message next) + ) + { + processedCount++; + + switch (next.type) + { + case EventType.Connected: + onConnect?.Invoke(next.connId); + break; + case EventType.Data: + onData?.Invoke(next.connId, next.data.ToSegment()); + next.data.Release(); + break; + case EventType.Disconnected: + onDisconnect?.Invoke(next.connId); + break; + case EventType.Error: + onError?.Invoke(next.connId, next.exception); + break; + } + } + + if (server.receiveQueue.Count > 0) + { + Console.ForegroundColor = ConsoleColor.Yellow; + Console.WriteLine($"SimpleWebServer ProcessMessageQueue has {server.receiveQueue.Count} remaining."); + Console.ResetColor(); + } + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/SimpleWebServer.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/SimpleWebServer.cs.meta new file mode 100644 index 0000000..c8c6f5a --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/SimpleWebServer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: bd51d7896f55a5e48b41a4b526562b0e +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/WebSocketServer.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/WebSocketServer.cs new file mode 100644 index 0000000..f3d515e --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/WebSocketServer.cs @@ -0,0 +1,264 @@ +using System; +using System.Collections.Concurrent; +using System.Linq; +using System.Net.Sockets; +using System.Threading; + +namespace Mirror.SimpleWeb +{ + public class WebSocketServer + { + public readonly ConcurrentQueue receiveQueue = new ConcurrentQueue(); + + readonly TcpConfig tcpConfig; + readonly int maxMessageSize; + + TcpListener listener; + Thread acceptThread; + bool serverStopped; + readonly ServerHandshake handShake; + readonly ServerSslHelper sslHelper; + readonly BufferPool bufferPool; + readonly ConcurrentDictionary connections = new ConcurrentDictionary(); + + int _idCounter = 0; + + public WebSocketServer(TcpConfig tcpConfig, int maxMessageSize, int handshakeMaxSize, SslConfig sslConfig, BufferPool bufferPool) + { + this.tcpConfig = tcpConfig; + this.maxMessageSize = maxMessageSize; + sslHelper = new ServerSslHelper(sslConfig); + this.bufferPool = bufferPool; + handShake = new ServerHandshake(this.bufferPool, handshakeMaxSize); + } + + public void Listen(int port) + { + listener = TcpListener.Create(port); + listener.Start(); + + Console.ForegroundColor = ConsoleColor.Green; + Console.WriteLine($"[SimpleWebTransport] Server Started on {port}!"); + Console.ResetColor(); + + acceptThread = new Thread(acceptLoop); + acceptThread.IsBackground = true; + acceptThread.Start(); + } + + public void Stop() + { + serverStopped = true; + + // Interrupt then stop so that Exception is handled correctly + acceptThread?.Interrupt(); + listener?.Stop(); + acceptThread = null; + + Console.WriteLine($"[SimpleWebTransport] Server stopped...closing all connections."); + + // make copy so that foreach doesn't break if values are removed + Connection[] connectionsCopy = connections.Values.ToArray(); + foreach (Connection conn in connectionsCopy) + conn.Dispose(); + + connections.Clear(); + } + + void acceptLoop() + { + try + { + try + { + while (true) + { + TcpClient client = listener.AcceptTcpClient(); + tcpConfig.ApplyTo(client); + + // TODO keep track of connections before they are in connections dictionary + // this might not be a problem as HandshakeAndReceiveLoop checks for stop + // and returns/disposes before sending message to queue + Connection conn = new Connection(client, AfterConnectionDisposed); + Console.WriteLine($"[SimpleWebTransport] A client connected {conn}", false); + + // handshake needs its own thread as it needs to wait for message from client + Thread receiveThread = new Thread(() => HandshakeAndReceiveLoop(conn)); + + conn.receiveThread = receiveThread; + + receiveThread.IsBackground = true; + receiveThread.Start(); + } + } + catch (SocketException) + { + // check for Interrupted/Abort + Utils.CheckForInterupt(); + throw; + } + } + catch (ThreadInterruptedException e) { Log.InfoException(e); } + catch (ThreadAbortException e) { Log.InfoException(e); } + catch (Exception e) { Log.Exception(e); } + } + + void HandshakeAndReceiveLoop(Connection conn) + { + try + { + bool success = sslHelper.TryCreateStream(conn); + if (!success) + { + Console.ForegroundColor = ConsoleColor.Red; + Console.WriteLine($"[SimpleWebTransport] Failed to create SSL Stream {conn}"); + Console.ResetColor(); + conn.Dispose(); + return; + } + + success = handShake.TryHandshake(conn); + + if (success) + Console.WriteLine($"[SimpleWebTransport] Sent Handshake {conn}, false"); + else + { + Console.ForegroundColor = ConsoleColor.Red; + Console.WriteLine($"[SimpleWebTransport] Handshake Failed {conn}"); + Console.ResetColor(); + conn.Dispose(); + return; + } + + // check if Stop has been called since accepting this client + if (serverStopped) + { + Console.WriteLine("[SimpleWebTransport] Server stops after successful handshake", false); + return; + } + + conn.connId = Interlocked.Increment(ref _idCounter); + connections.TryAdd(conn.connId, conn); + + receiveQueue.Enqueue(new Message(conn.connId, EventType.Connected)); + + Thread sendThread = new Thread(() => + { + SendLoop.Config sendConfig = new SendLoop.Config( + conn, + bufferSize: Constants.HeaderSize + maxMessageSize, + setMask: false); + + SendLoop.Loop(sendConfig); + }); + + conn.sendThread = sendThread; + sendThread.IsBackground = true; + sendThread.Name = $"SendThread {conn.connId}"; + sendThread.Start(); + + ReceiveLoop.Config receiveConfig = new ReceiveLoop.Config( + conn, + maxMessageSize, + expectMask: true, + receiveQueue, + bufferPool); + + ReceiveLoop.Loop(receiveConfig); + } + catch (ThreadInterruptedException e) + { + Console.ForegroundColor = ConsoleColor.Red; + Console.WriteLine($"[SimpleWebTransport] Handshake ThreadInterruptedException {e.Message}"); + Console.ResetColor(); + } + catch (ThreadAbortException e) + { + Console.ForegroundColor = ConsoleColor.Red; + Console.WriteLine($"[SimpleWebTransport] Handshake ThreadAbortException {e.Message}"); + Console.ResetColor(); + } + catch (Exception e) + { + Console.ForegroundColor = ConsoleColor.Red; + Console.WriteLine($"[SimpleWebTransport] Handshake Exception {e.Message}"); + Console.ResetColor(); + } + finally + { + // close here in case connect fails + conn.Dispose(); + } + } + + void AfterConnectionDisposed(Connection conn) + { + if (conn.connId != Connection.IdNotSet) + { + receiveQueue.Enqueue(new Message(conn.connId, EventType.Disconnected)); + connections.TryRemove(conn.connId, out Connection _); + } + } + + public void Send(int id, ArrayBuffer buffer) + { + if (connections.TryGetValue(id, out Connection conn)) + { + conn.sendQueue.Enqueue(buffer); + conn.sendPending.Set(); + } + else + { + Console.ForegroundColor = ConsoleColor.Yellow; + Console.WriteLine($"[SimpleWebTransport] Cannot send message to {id} because connection was not found in dictionary. Maybe it disconnected."); + Console.ResetColor(); + } + } + + public bool CloseConnection(int id) + { + if (connections.TryGetValue(id, out Connection conn)) + { + Console.ForegroundColor = ConsoleColor.Magenta; + Console.WriteLine($"[SimpleWebTransport] Kicking connection {id}"); + Console.ResetColor(); + conn.Dispose(); + return true; + } + else + { + Console.ForegroundColor = ConsoleColor.Yellow; + Console.WriteLine($"[SimpleWebTransport] Failed to kick {id} because id not found."); + Console.ResetColor(); + + return false; + } + } + + public string GetClientAddress(int id) + { + if (!connections.TryGetValue(id, out Connection conn)) + { + Console.ForegroundColor = ConsoleColor.Yellow; + Console.WriteLine($"[SimpleWebTransport] Cannot get address of connection {id} because connection was not found in dictionary."); + Console.ResetColor(); + return null; + } + + return conn.remoteAddress; + } + + public Request GetClientRequest(int id) + { + if (!connections.TryGetValue(id, out Connection conn)) + { + Console.ForegroundColor = ConsoleColor.Yellow; + Console.WriteLine($"[SimpleWebTransport] Cant get request of connection {id} because connection was not found in dictionary."); + Console.ResetColor(); + return null; + } + + return conn.request; + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/WebSocketServer.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/WebSocketServer.cs.meta new file mode 100644 index 0000000..0a76a9f --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/Server/WebSocketServer.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 5c434db044777d2439bae5a57d4e8ee7 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SimpleWebTransport.asmdef b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SimpleWebTransport.asmdef new file mode 100644 index 0000000..dfb91ea --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SimpleWebTransport.asmdef @@ -0,0 +1,14 @@ +{ + "name": "SimpleWebTransport", + "rootNamespace": "", + "references": [], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [], + "versionDefines": [], + "noEngineReferences": false +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SimpleWebTransport.asmdef.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SimpleWebTransport.asmdef.meta new file mode 100644 index 0000000..99755b6 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SimpleWebTransport.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 3b5390adca4e2bb4791cb930316d6f3e +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SslConfigLoader.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SslConfigLoader.cs new file mode 100644 index 0000000..9996793 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SslConfigLoader.cs @@ -0,0 +1,49 @@ +using System.IO; +using System.Security.Authentication; +using UnityEngine; + +namespace Mirror.SimpleWeb +{ + + public class SslConfigLoader + { + internal struct Cert + { + public string path; + public string password; + } + public static SslConfig Load(bool sslEnabled, string sslCertJson, SslProtocols sslProtocols) + { + // don't need to load anything if ssl is not enabled + if (!sslEnabled) + return default; + + string certJsonPath = sslCertJson; + + Cert cert = LoadCertJson(certJsonPath); + + return new SslConfig( + enabled: sslEnabled, + sslProtocols: sslProtocols, + certPath: cert.path, + certPassword: cert.password + ); + } + + internal static Cert LoadCertJson(string certJsonPath) + { + string json = File.ReadAllText(certJsonPath); + Cert cert = JsonUtility.FromJson(json); + + if (string.IsNullOrWhiteSpace(cert.path)) + throw new InvalidDataException("Cert Json didn't not contain \"path\""); + + // don't use IsNullOrWhiteSpace here because whitespace could be a valid password for a cert + // password can also be empty + if (string.IsNullOrEmpty(cert.password)) + cert.password = string.Empty; + + return cert; + } + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SslConfigLoader.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SslConfigLoader.cs.meta new file mode 100644 index 0000000..e653532 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWeb/SslConfigLoader.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: dfdb6b97a48a48b498e563e857342da1 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWebTransport.cs b/Assets/Mirror/Transports/SimpleWeb/SimpleWebTransport.cs new file mode 100644 index 0000000..45ac066 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWebTransport.cs @@ -0,0 +1,304 @@ +using System; +using System.Net; +using System.Security.Authentication; +using UnityEngine; +using UnityEngine.Serialization; + +namespace Mirror.SimpleWeb +{ + [DisallowMultipleComponent] + public class SimpleWebTransport : Transport, PortTransport + { + public const string NormalScheme = "ws"; + public const string SecureScheme = "wss"; + + [Tooltip("Port to use for server and client")] + public ushort port = 7778; + public ushort Port { get => port; set => port=value; } + + [Tooltip("Tells the client to use the default port. This is useful when connecting to reverse proxy rather than directly to websocket server")] + public bool ClientUseDefaultPort; + + [Tooltip("Protect against allocation attacks by keeping the max message size small. Otherwise an attacker might send multiple fake packets with 2GB headers, causing the server to run out of memory after allocating multiple large packets.")] + public int maxMessageSize = 16 * 1024; + + [Tooltip("Max size for http header send as handshake for websockets")] + public int handshakeMaxSize = 3000; + + [Tooltip("disables nagle algorithm. lowers CPU% and latency but increases bandwidth")] + public bool noDelay = true; + + [Tooltip("Send would stall forever if the network is cut off during a send, so we need a timeout (in milliseconds)")] + public int sendTimeout = 5000; + + [Tooltip("How long without a message before disconnecting (in milliseconds)")] + public int receiveTimeout = 20000; + + [Tooltip("Caps the number of messages the server will process per tick. Allows LateUpdate to finish to let the reset of unity continue in case more messages arrive before they are processed")] + public int serverMaxMessagesPerTick = 10000; + + [Tooltip("Caps the number of messages the client will process per tick. Allows LateUpdate to finish to let the reset of unity continue in case more messages arrive before they are processed")] + public int clientMaxMessagesPerTick = 1000; + + [Header("Server settings")] + + [Tooltip("Groups messages in queue before calling Stream.Send")] + public bool batchSend = true; + + [Tooltip("Waits for 1ms before grouping and sending messages.\n" + + "This gives time for mirror to finish adding message to queue so that less groups need to be made.\n" + + "If WaitBeforeSend is true then BatchSend Will also be set to true")] + public bool waitBeforeSend = true; + + [Header("Ssl Settings")] + [Tooltip("Sets connect scheme to wss. Useful when client needs to connect using wss when TLS is outside of transport.\nNOTE: if sslEnabled is true clientUseWss is also true")] + public bool clientUseWss; + + [Tooltip("Requires wss connections on server, only to be used with SSL cert.json, never with reverse proxy.\nNOTE: if sslEnabled is true clientUseWss is also true")] + public bool sslEnabled; + + [Tooltip("Path to json file that contains path to cert and its password\nUse Json file so that cert password is not included in client builds\nSee Assets/Mirror/Transports/.cert.example.Json")] + public string sslCertJson = "./cert.json"; + + [Tooltip("Protocols that SSL certificate is created to support.")] + public SslProtocols sslProtocols = SslProtocols.Tls12; + + [Header("Debug")] + [Tooltip("Log functions uses ConditionalAttribute which will effect which log methods are allowed.")] + [FormerlySerializedAs("logLevels")] + [SerializeField] Log.Levels _logLevels = Log.Levels.warn; + + /// + /// Gets _logLevels field + /// Sets _logLevels and Log.level fields + /// + public Log.Levels LogLevels + { + get => _logLevels; + set + { + _logLevels = value; + Log.level = _logLevels; + } + } + + SimpleWebClient client; + SimpleWebServer server; + + TcpConfig TcpConfig => new TcpConfig(noDelay, sendTimeout, receiveTimeout); + + void Awake() + { + Log.level = _logLevels; + } + + void OnValidate() + { + Log.level = _logLevels; + } + + public override bool Available() => true; + + public override int GetMaxPacketSize(int channelId = 0) => maxMessageSize; + + public override void Shutdown() + { + client?.Disconnect(); + client = null; + server?.Stop(); + server = null; + } + + #region Client + + string GetClientScheme() => (sslEnabled || clientUseWss) ? SecureScheme : NormalScheme; + + public override bool ClientConnected() + { + // not null and not NotConnected (we want to return true if connecting or disconnecting) + return client != null && client.ConnectionState != ClientState.NotConnected; + } + + public override void ClientConnect(string hostname) + { + UriBuilder builder = new UriBuilder + { + Scheme = GetClientScheme(), + Host = hostname, + }; + // https://github.com/MirrorNetworking/Mirror/pull/3477 + if (!ClientUseDefaultPort) + builder.Port = Port; + + ClientConnect(builder.Uri); + } + + public override void ClientConnect(Uri uri) + { + // connecting or connected + if (ClientConnected()) + { + Debug.LogError("[SimpleWebTransport] Already Connected"); + return; + } + + client = SimpleWebClient.Create(maxMessageSize, clientMaxMessagesPerTick, TcpConfig); + if (client == null) + return; + + client.onConnect += OnClientConnected.Invoke; + + client.onDisconnect += () => + { + OnClientDisconnected.Invoke(); + // clear client here after disconnect event has been sent + // there should be no more messages after disconnect + client = null; + }; + + client.onData += (ArraySegment data) => OnClientDataReceived.Invoke(data, Channels.Reliable); + + client.onError += (Exception e) => + { + OnClientError.Invoke(TransportError.Unexpected, e.ToString()); + ClientDisconnect(); + }; + + client.Connect(uri); + } + + public override void ClientDisconnect() + { + // don't set client null here of messages wont be processed + client?.Disconnect(); + } + + public override void ClientSend(ArraySegment segment, int channelId) + { + if (!ClientConnected()) + { + Debug.LogError("[SimpleWebTransport] Not Connected"); + return; + } + + if (segment.Count > maxMessageSize) + { + Log.Error("[SimpleWebTransport] Message greater than max size"); + return; + } + + if (segment.Count == 0) + { + Log.Error("[SimpleWebTransport] Message count was zero"); + return; + } + + client.Send(segment); + + // call event. might be null if no statistics are listening etc. + OnClientDataSent?.Invoke(segment, Channels.Reliable); + } + + // messages should always be processed in early update + public override void ClientEarlyUpdate() + { + client?.ProcessMessageQueue(this); + } + + #endregion + + #region Server + + string GetServerScheme() => sslEnabled ? SecureScheme : NormalScheme; + + public override Uri ServerUri() + { + UriBuilder builder = new UriBuilder + { + Scheme = GetServerScheme(), + Host = Dns.GetHostName(), + Port = port + }; + return builder.Uri; + } + + public override bool ServerActive() + { + return server != null && server.Active; + } + + public override void ServerStart() + { + if (ServerActive()) + Debug.LogError("[SimpleWebTransport] Server Already Started"); + + SslConfig config = SslConfigLoader.Load(sslEnabled, sslCertJson, sslProtocols); + server = new SimpleWebServer(serverMaxMessagesPerTick, TcpConfig, maxMessageSize, handshakeMaxSize, config); + + server.onConnect += OnServerConnected.Invoke; + server.onDisconnect += OnServerDisconnected.Invoke; + server.onData += (int connId, ArraySegment data) => OnServerDataReceived.Invoke(connId, data, Channels.Reliable); + server.onError += (connId, exception) => OnServerError(connId, TransportError.Unexpected, exception.ToString()); + + SendLoopConfig.batchSend = batchSend || waitBeforeSend; + SendLoopConfig.sleepBeforeSend = waitBeforeSend; + + server.Start(port); + } + + public override void ServerStop() + { + if (!ServerActive()) + Debug.LogError("[SimpleWebTransport] Server Not Active"); + + server.Stop(); + server = null; + } + + public override void ServerDisconnect(int connectionId) + { + if (!ServerActive()) + Debug.LogError("[SimpleWebTransport] Server Not Active"); + + server.KickClient(connectionId); + } + + public override void ServerSend(int connectionId, ArraySegment segment, int channelId) + { + if (!ServerActive()) + { + Log.Error("[SimpleWebTransport] Server Not Active", false); + return; + } + + if (segment.Count > maxMessageSize) + { + Log.Error("[SimpleWebTransport] Message greater than max size", false); + return; + } + + if (segment.Count == 0) + { + Log.Error("[SimpleWebTransport] Message count was zero", false); + return; + } + + server.SendOne(connectionId, segment); + + // call event. might be null if no statistics are listening etc. + OnServerDataSent?.Invoke(connectionId, segment, Channels.Reliable); + } + + public override string ServerGetClientAddress(int connectionId) => server.GetClientAddress(connectionId); + + public Request ServerGetClientRequest(int connectionId) => server.GetClientRequest(connectionId); + + // messages should always be processed in early update + public override void ServerEarlyUpdate() + { + server?.ProcessMessageQueue(this); + } + + #endregion + } +} diff --git a/Assets/Mirror/Transports/SimpleWeb/SimpleWebTransport.cs.meta b/Assets/Mirror/Transports/SimpleWeb/SimpleWebTransport.cs.meta new file mode 100644 index 0000000..381a5c7 --- /dev/null +++ b/Assets/Mirror/Transports/SimpleWeb/SimpleWebTransport.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 0110f245bfcfc7d459681f7bd9ebc590 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy.meta b/Assets/Mirror/Transports/Telepathy.meta new file mode 100644 index 0000000..ede2d0e --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 552b3d8382916438d81fe7f39e18db72 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy.meta b/Assets/Mirror/Transports/Telepathy/Telepathy.meta new file mode 100644 index 0000000..345a638 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: a1233408bc4b145fb8f6f5a8e95790e0 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Client.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Client.cs new file mode 100644 index 0000000..44fa0b5 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Client.cs @@ -0,0 +1,361 @@ +using System; +using System.Net.Sockets; +using System.Threading; + +namespace Telepathy +{ + // ClientState OBJECT that can be handed to the ReceiveThread safely. + // => allows us to create a NEW OBJECT every time we connect and start a + // receive thread. + // => perfectly protects us against data races. fixes all the flaky tests + // where .Connecting or .client would still be used by a dieing thread + // while attempting to use it for a new connection attempt etc. + // => creating a fresh client state each time is the best solution against + // data races here! + class ClientConnectionState : ConnectionState + { + public Thread receiveThread; + + // TcpClient.Connected doesn't check if socket != null, which + // results in NullReferenceExceptions if connection was closed. + // -> let's check it manually instead + public bool Connected => client != null && + client.Client != null && + client.Client.Connected; + + // TcpClient has no 'connecting' state to check. We need to keep track + // of it manually. + // -> checking 'thread.IsAlive && !Connected' is not enough because the + // thread is alive and connected is false for a short moment after + // disconnecting, so this would cause race conditions. + // -> we use a threadsafe bool wrapper so that ThreadFunction can remain + // static (it needs a common lock) + // => Connecting is true from first Connect() call in here, through the + // thread start, until TcpClient.Connect() returns. Simple and clear. + // => bools are atomic according to + // https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/variables + // made volatile so the compiler does not reorder access to it + public volatile bool Connecting; + + // thread safe pipe for received messages + // => inside client connection state so that we can create a new state + // each time we connect + // (unlike server which has one receive pipe for all connections) + public readonly MagnificentReceivePipe receivePipe; + + // constructor always creates new TcpClient for client connection! + public ClientConnectionState(int MaxMessageSize) : base(new TcpClient(), MaxMessageSize) + { + // create receive pipe with max message size for pooling + receivePipe = new MagnificentReceivePipe(MaxMessageSize); + } + + // dispose all the state safely + public void Dispose() + { + // close client + client.Close(); + + // wait until thread finished. this is the only way to guarantee + // that we can call Connect() again immediately after Disconnect + // -> calling .Join would sometimes wait forever, e.g. when + // calling Disconnect while trying to connect to a dead end + receiveThread?.Interrupt(); + + // we interrupted the receive Thread, so we can't guarantee that + // connecting was reset. let's do it manually. + Connecting = false; + + // clear send pipe. no need to hold on to elements. + // (unlike receiveQueue, which is still needed to process the + // latest Disconnected message, etc.) + sendPipe.Clear(); + + // IMPORTANT: DO NOT CLEAR RECEIVE PIPE. + // we still want to process disconnect messages in Tick()! + + // let go of this client completely. the thread ended, no one uses + // it anymore and this way Connected is false again immediately. + client = null; + } + } + + public class Client : Common + { + // events to hook into + // => OnData uses ArraySegment for allocation free receives later + public Action OnConnected; + public Action> OnData; + public Action OnDisconnected; + + // disconnect if send queue gets too big. + // -> avoids ever growing queue memory if network is slower than input + // -> disconnecting is great for load balancing. better to disconnect + // one connection than risking every connection / the whole server + // -> huge queue would introduce multiple seconds of latency anyway + // + // Mirror/DOTSNET use MaxMessageSize batching, so for a 16kb max size: + // limit = 1,000 means 16 MB of memory/connection + // limit = 10,000 means 160 MB of memory/connection + public int SendQueueLimit = 10000; + public int ReceiveQueueLimit = 10000; + + // all client state wrapped into an object that is passed to ReceiveThread + // => we create a new one each time we connect to avoid data races with + // old dieing threads still using the previous object! + ClientConnectionState state; + + // Connected & Connecting + public bool Connected => state != null && state.Connected; + public bool Connecting => state != null && state.Connecting; + + // pipe count, useful for debugging / benchmarks + public int ReceivePipeCount => state != null ? state.receivePipe.TotalCount : 0; + + // constructor + public Client(int MaxMessageSize) : base(MaxMessageSize) {} + + // the thread function + // STATIC to avoid sharing state! + // => pass ClientState object. a new one is created for each new thread! + // => avoids data races where an old dieing thread might still modify + // the current thread's state :/ + static void ReceiveThreadFunction(ClientConnectionState state, string ip, int port, int MaxMessageSize, bool NoDelay, int SendTimeout, int ReceiveTimeout, int ReceiveQueueLimit) + + { + Thread sendThread = null; + + // absolutely must wrap with try/catch, otherwise thread + // exceptions are silent + try + { + // connect (blocking) + state.client.Connect(ip, port); + state.Connecting = false; // volatile! + + // set socket options after the socket was created in Connect() + // (not after the constructor because we clear the socket there) + state.client.NoDelay = NoDelay; + state.client.SendTimeout = SendTimeout; + state.client.ReceiveTimeout = ReceiveTimeout; + + // start send thread only after connected + // IMPORTANT: DO NOT SHARE STATE ACROSS MULTIPLE THREADS! + sendThread = new Thread(() => { ThreadFunctions.SendLoop(0, state.client, state.sendPipe, state.sendPending); }); + sendThread.IsBackground = true; + sendThread.Start(); + + // run the receive loop + // (receive pipe is shared across all loops) + ThreadFunctions.ReceiveLoop(0, state.client, MaxMessageSize, state.receivePipe, ReceiveQueueLimit); + } + catch (SocketException exception) + { + // this happens if (for example) the ip address is correct + // but there is no server running on that ip/port + Log.Info("[Telepathy] Client Recv: failed to connect to ip=" + ip + " port=" + port + " reason=" + exception); + } + catch (ThreadInterruptedException) + { + // expected if Disconnect() aborts it + } + catch (ThreadAbortException) + { + // expected if Disconnect() aborts it + } + catch (ObjectDisposedException) + { + // expected if Disconnect() aborts it and disposed the client + // while ReceiveThread is in a blocking Connect() call + } + catch (Exception exception) + { + // something went wrong. probably important. + Log.Error("[Telepathy] Client Recv Exception: " + exception); + } + // add 'Disconnected' event to receive pipe so that the caller + // knows that the Connect failed. otherwise they will never know + state.receivePipe.Enqueue(0, EventType.Disconnected, default); + + // sendthread might be waiting on ManualResetEvent, + // so let's make sure to end it if the connection + // closed. + // otherwise the send thread would only end if it's + // actually sending data while the connection is + // closed. + sendThread?.Interrupt(); + + // Connect might have failed. thread might have been closed. + // let's reset connecting state no matter what. + state.Connecting = false; + + // if we got here then we are done. ReceiveLoop cleans up already, + // but we may never get there if connect fails. so let's clean up + // here too. + state.client?.Close(); + } + + public void Connect(string ip, int port) + { + // not if already started + if (Connecting || Connected) + { + Log.Warning("[Telepathy] Client can not create connection because an existing connection is connecting or connected"); + return; + } + + // overwrite old thread's state object. create a new one to avoid + // data races where an old dieing thread might still modify the + // current state! fixes all the flaky tests! + state = new ClientConnectionState(MaxMessageSize); + + // We are connecting from now until Connect succeeds or fails + state.Connecting = true; + + // create a TcpClient with perfect IPv4, IPv6 and hostname resolving + // support. + // + // * TcpClient(hostname, port): works but would connect (and block) + // already + // * TcpClient(AddressFamily.InterNetworkV6): takes Ipv4 and IPv6 + // addresses but only connects to IPv6 servers (e.g. Telepathy). + // does NOT connect to IPv4 servers (e.g. Mirror Booster), even + // with DualMode enabled. + // * TcpClient(): creates IPv4 socket internally, which would force + // Connect() to only use IPv4 sockets. + // + // => the trick is to clear the internal IPv4 socket so that Connect + // resolves the hostname and creates either an IPv4 or an IPv6 + // socket as needed (see TcpClient source) + state.client.Client = null; // clear internal IPv4 socket until Connect() + + // client.Connect(ip, port) is blocking. let's call it in the thread + // and return immediately. + // -> this way the application doesn't hang for 30s if connect takes + // too long, which is especially good in games + // -> this way we don't async client.BeginConnect, which seems to + // fail sometimes if we connect too many clients too fast + state.receiveThread = new Thread(() => { + ReceiveThreadFunction(state, ip, port, MaxMessageSize, NoDelay, SendTimeout, ReceiveTimeout, ReceiveQueueLimit); + }); + state.receiveThread.IsBackground = true; + state.receiveThread.Start(); + } + + public void Disconnect() + { + // only if started + if (Connecting || Connected) + { + // dispose all the state safely + state.Dispose(); + + // IMPORTANT: DO NOT set state = null! + // we still want to process the pipe's disconnect message etc.! + } + } + + // send message to server using socket connection. + // arraysegment for allocation free sends later. + // -> the segment's array is only used until Send() returns! + public bool Send(ArraySegment message) + { + if (Connected) + { + // respect max message size to avoid allocation attacks. + if (message.Count <= MaxMessageSize) + { + // check send pipe limit + if (state.sendPipe.Count < SendQueueLimit) + { + // add to thread safe send pipe and return immediately. + // calling Send here would be blocking (sometimes for long + // times if other side lags or wire was disconnected) + state.sendPipe.Enqueue(message); + state.sendPending.Set(); // interrupt SendThread WaitOne() + return true; + } + // disconnect if send queue gets too big. + // -> avoids ever growing queue memory if network is slower + // than input + // -> avoids ever growing latency as well + // + // note: while SendThread always grabs the WHOLE send queue + // immediately, it's still possible that the sending + // blocks for so long that the send queue just gets + // way too big. have a limit - better safe than sorry. + else + { + // log the reason + Log.Warning($"[Telepathy] Client.Send: sendPipe reached limit of {SendQueueLimit}. This can happen if we call send faster than the network can process messages. Disconnecting to avoid ever growing memory & latency."); + + // just close it. send thread will take care of the rest. + state.client.Close(); + return false; + } + } + Log.Error("[Telepathy] Client.Send: message too big: " + message.Count + ". Limit: " + MaxMessageSize); + return false; + } + Log.Warning("[Telepathy] Client.Send: not connected!"); + return false; + } + + // tick: processes up to 'limit' messages + // => limit parameter to avoid deadlocks / too long freezes if server or + // client is too slow to process network load + // => Mirror & DOTSNET need to have a process limit anyway. + // might as well do it here and make life easier. + // => returns amount of remaining messages to process, so the caller + // can call tick again as many times as needed (or up to a limit) + // + // Tick() may process multiple messages, but Mirror needs a way to stop + // processing immediately if a scene change messages arrives. Mirror + // can't process any other messages during a scene change. + // (could be useful for others too) + // => make sure to allocate the lambda only once in transports + public int Tick(int processLimit, Func checkEnabled = null) + { + // only if state was created yet (after connect()) + // note: we don't check 'only if connected' because we want to still + // process Disconnect messages afterwards too! + if (state == null) + return 0; + + // process up to 'processLimit' messages + for (int i = 0; i < processLimit; ++i) + { + // check enabled in case a Mirror scene message arrived + if (checkEnabled != null && !checkEnabled()) + break; + + // peek first. allows us to process the first queued entry while + // still keeping the pooled byte[] alive by not removing anything. + if (state.receivePipe.TryPeek(out int _, out EventType eventType, out ArraySegment message)) + { + switch (eventType) + { + case EventType.Connected: + OnConnected?.Invoke(); + break; + case EventType.Data: + OnData?.Invoke(message); + break; + case EventType.Disconnected: + OnDisconnected?.Invoke(); + break; + } + + // IMPORTANT: now dequeue and return it to pool AFTER we are + // done processing the event. + state.receivePipe.TryDequeue(); + } + // no more messages. stop the loop. + else break; + } + + // return what's left to process for next time + return state.receivePipe.TotalCount; + } + } +} diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Client.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Client.cs.meta new file mode 100644 index 0000000..1b6d222 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Client.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: a5b95294cc4ec4b15aacba57531c7985 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Common.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Common.cs new file mode 100644 index 0000000..15265f9 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Common.cs @@ -0,0 +1,39 @@ +// common code used by server and client +namespace Telepathy +{ + public abstract class Common + { + // IMPORTANT: DO NOT SHARE STATE ACROSS SEND/RECV LOOPS (DATA RACES) + // (except receive pipe which is used for all threads) + + // NoDelay disables nagle algorithm. lowers CPU% and latency but + // increases bandwidth + public bool NoDelay = true; + + // Prevent allocation attacks. Each packet is prefixed with a length + // header, so an attacker could send a fake packet with length=2GB, + // causing the server to allocate 2GB and run out of memory quickly. + // -> simply increase max packet size if you want to send around bigger + // files! + // -> 16KB per message should be more than enough. + public readonly int MaxMessageSize; + + // Send would stall forever if the network is cut off during a send, so + // we need a timeout (in milliseconds) + public int SendTimeout = 5000; + + // Default TCP receive time out can be huge (minutes). + // That's way too much for games, let's make it configurable. + // we need a timeout (in milliseconds) + // => '0' means disabled + // => disabled by default because some people might use Telepathy + // without Mirror and without sending pings, so timeouts are likely + public int ReceiveTimeout = 0; + + // constructor + protected Common(int MaxMessageSize) + { + this.MaxMessageSize = MaxMessageSize; + } + } +} diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Common.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Common.cs.meta new file mode 100644 index 0000000..5d8ab5b --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Common.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c4d56322cf0e248a89103c002a505dab +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/ConnectionState.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/ConnectionState.cs new file mode 100644 index 0000000..cdfe3c0 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/ConnectionState.cs @@ -0,0 +1,35 @@ +// both server and client need a connection state object. +// -> server needs it to keep track of multiple connections +// -> client needs it to safely create a new connection state on every new +// connect in order to avoid data races where a dieing thread might still +// modify the current state. can't happen if we create a new state each time! +// (fixes all the flaky tests) +// +// ... besides, it also allows us to share code! +using System.Net.Sockets; +using System.Threading; + +namespace Telepathy +{ + public class ConnectionState + { + public TcpClient client; + + // thread safe pipe to send messages from main thread to send thread + public readonly MagnificentSendPipe sendPipe; + + // ManualResetEvent to wake up the send thread. better than Thread.Sleep + // -> call Set() if everything was sent + // -> call Reset() if there is something to send again + // -> call WaitOne() to block until Reset was called + public ManualResetEvent sendPending = new ManualResetEvent(false); + + public ConnectionState(TcpClient client, int MaxMessageSize) + { + this.client = client; + + // create send pipe with max message size for pooling + sendPipe = new MagnificentSendPipe(MaxMessageSize); + } + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/ConnectionState.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/ConnectionState.cs.meta new file mode 100644 index 0000000..3dcceaf --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/ConnectionState.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: af95e2b6f6343411aa8bdf871abd7b1b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Empty.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty.meta new file mode 100644 index 0000000..1bc9652 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 885e89897e3a03241827ab7a14fe5fa0 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Logger.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Logger.cs new file mode 100644 index 0000000..4f7722a --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Logger.cs @@ -0,0 +1 @@ +// removed 2021-02-04 \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Logger.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Logger.cs.meta new file mode 100644 index 0000000..304866f --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Logger.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: aa8d703f0b73f4d6398b76812719b68b +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Message.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Message.cs new file mode 100644 index 0000000..4f7722a --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Message.cs @@ -0,0 +1 @@ +// removed 2021-02-04 \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Message.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Message.cs.meta new file mode 100644 index 0000000..5937bb9 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/Message.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: aedf812e9637b4f92a35db1aedca8c92 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/SafeQueue.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/SafeQueue.cs new file mode 100644 index 0000000..7899911 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/SafeQueue.cs @@ -0,0 +1 @@ +// removed 2021-02-04 diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/SafeQueue.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/SafeQueue.cs.meta new file mode 100644 index 0000000..f3a9310 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/SafeQueue.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 8fc06e2fb29854a0c9e90c0188d36a08 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/ThreadExtensions.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/ThreadExtensions.cs new file mode 100644 index 0000000..85dece4 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/ThreadExtensions.cs @@ -0,0 +1 @@ +// removed 2021-02-04 diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/ThreadExtensions.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/ThreadExtensions.cs.meta new file mode 100644 index 0000000..77c885d --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Empty/ThreadExtensions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 64df4eaebe4ff9a43a9fb318c3e8e321 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/EventType.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/EventType.cs new file mode 100644 index 0000000..66bc3b4 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/EventType.cs @@ -0,0 +1,9 @@ +namespace Telepathy +{ + public enum EventType + { + Connected, + Data, + Disconnected + } +} diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/EventType.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/EventType.cs.meta new file mode 100644 index 0000000..ac88c1b --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/EventType.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 49f1a330755814803be5f27f493e1910 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/LICENSE b/Assets/Mirror/Transports/Telepathy/Telepathy/LICENSE new file mode 100644 index 0000000..680deef --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018, vis2k + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/LICENSE.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/LICENSE.meta new file mode 100644 index 0000000..4d7664e --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/LICENSE.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 0ba11103b95fd4721bffbb08440d5b8e +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Log.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Log.cs new file mode 100644 index 0000000..2d50aa3 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Log.cs @@ -0,0 +1,15 @@ +// A simple logger class that uses Console.WriteLine by default. +// Can also do Logger.LogMethod = Debug.Log for Unity etc. +// (this way we don't have to depend on UnityEngine.DLL and don't need a +// different version for every UnityEngine version here) +using System; + +namespace Telepathy +{ + public static class Log + { + public static Action Info = Console.WriteLine; + public static Action Warning = Console.WriteLine; + public static Action Error = Console.Error.WriteLine; + } +} diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Log.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Log.cs.meta new file mode 100644 index 0000000..8f78650 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Log.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 0a123d054bef34d059057ac2ce936605 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentReceivePipe.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentReceivePipe.cs new file mode 100644 index 0000000..2e10318 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentReceivePipe.cs @@ -0,0 +1,222 @@ +// a magnificent receive pipe to shield us from all of life's complexities. +// safely sends messages from receive thread to main thread. +// -> thread safety built in +// -> byte[] pooling coming in the future +// +// => hides all the complexity from telepathy +// => easy to switch between stack/queue/concurrentqueue/etc. +// => easy to test +using System; +using System.Collections.Generic; + +namespace Telepathy +{ + public class MagnificentReceivePipe + { + // queue entry message. only used in here. + // -> byte arrays are always of 4 + MaxMessageSize + // -> ArraySegment indicates the actual message content + struct Entry + { + public int connectionId; + public EventType eventType; + public ArraySegment data; + public Entry(int connectionId, EventType eventType, ArraySegment data) + { + this.connectionId = connectionId; + this.eventType = eventType; + this.data = data; + } + } + + // message queue + // ConcurrentQueue allocates. lock{} instead. + // + // IMPORTANT: lock{} all usages! + readonly Queue queue = new Queue(); + + // byte[] pool to avoid allocations + // Take & Return is beautifully encapsulated in the pipe. + // the outside does not need to worry about anything. + // and it can be tested easily. + // + // IMPORTANT: lock{} all usages! + Pool pool; + + // unfortunately having one receive pipe per connetionId is way slower + // in CCU tests. right now we have one pipe for all connections. + // => we still need to limit queued messages per connection to avoid one + // spamming connection being able to slow down everyone else since + // the queue would be full of just this connection's messages forever + // => let's use a simpler per-connectionId counter for now + Dictionary queueCounter = new Dictionary(); + + // constructor + public MagnificentReceivePipe(int MaxMessageSize) + { + // initialize pool to create max message sized byte[]s each time + pool = new Pool(() => new byte[MaxMessageSize]); + } + + // return amount of queued messages for this connectionId. + // for statistics. don't call Count and assume that it's the same after + // the call. + public int Count(int connectionId) + { + lock (this) + { + return queueCounter.TryGetValue(connectionId, out int count) + ? count + : 0; + } + } + + // total count + public int TotalCount + { + get { lock (this) { return queue.Count; } } + } + + // pool count for testing + public int PoolCount + { + get { lock (this) { return pool.Count(); } } + } + + // enqueue a message + // -> ArraySegment to avoid allocations later + // -> parameters passed directly so it's more obvious that we don't just + // queue a passed 'Message', instead we copy the ArraySegment into + // a byte[] and store it internally, etc.) + public void Enqueue(int connectionId, EventType eventType, ArraySegment message) + { + // pool & queue usage always needs to be locked + lock (this) + { + // does this message have a data array content? + ArraySegment segment = default; + if (message != default) + { + // ArraySegment is only valid until returning. + // copy it into a byte[] that we can store. + // ArraySegment array is only valid until returning, so copy + // it into a byte[] that we can queue safely. + + // get one from the pool first to avoid allocations + byte[] bytes = pool.Take(); + + // copy into it + Buffer.BlockCopy(message.Array, message.Offset, bytes, 0, message.Count); + + // indicate which part is the message + segment = new ArraySegment(bytes, 0, message.Count); + } + + // enqueue it + // IMPORTANT: pass the segment around pool byte[], + // NOT the 'message' that is only valid until returning! + Entry entry = new Entry(connectionId, eventType, segment); + queue.Enqueue(entry); + + // increase counter for this connectionId + int oldCount = Count(connectionId); + queueCounter[connectionId] = oldCount + 1; + } + } + + // peek the next message + // -> allows the caller to process it while pipe still holds on to the + // byte[] + // -> TryDequeue should be called after processing, so that the message + // is actually dequeued and the byte[] is returned to pool! + // => see TryDequeue comments! + // + // IMPORTANT: TryPeek & Dequeue need to be called from the SAME THREAD! + public bool TryPeek(out int connectionId, out EventType eventType, out ArraySegment data) + { + connectionId = 0; + eventType = EventType.Disconnected; + data = default; + + // pool & queue usage always needs to be locked + lock (this) + { + if (queue.Count > 0) + { + Entry entry = queue.Peek(); + connectionId = entry.connectionId; + eventType = entry.eventType; + data = entry.data; + return true; + } + return false; + } + } + + // dequeue the next message + // -> simply dequeues and returns the byte[] to pool (if any) + // -> use Peek to actually process the first element while the pipe + // still holds on to the byte[] + // -> doesn't return the element because the byte[] needs to be returned + // to the pool in dequeue. caller can't be allowed to work with a + // byte[] that is already returned to pool. + // => Peek & Dequeue is the most simple, clean solution for receive + // pipe pooling to avoid allocations! + // + // IMPORTANT: TryPeek & Dequeue need to be called from the SAME THREAD! + public bool TryDequeue() + { + // pool & queue usage always needs to be locked + lock (this) + { + if (queue.Count > 0) + { + // dequeue from queue + Entry entry = queue.Dequeue(); + + // return byte[] to pool (if any). + // not all message types have byte[] contents. + if (entry.data != default) + { + pool.Return(entry.data.Array); + } + + // decrease counter for this connectionId + queueCounter[entry.connectionId]--; + + // remove if zero. don't want to keep old connectionIds in + // there forever, it would cause slowly growing memory. + if (queueCounter[entry.connectionId] == 0) + queueCounter.Remove(entry.connectionId); + + return true; + } + return false; + } + } + + public void Clear() + { + // pool & queue usage always needs to be locked + lock (this) + { + // clear queue, but via dequeue to return each byte[] to pool + while (queue.Count > 0) + { + // dequeue + Entry entry = queue.Dequeue(); + + // return byte[] to pool (if any). + // not all message types have byte[] contents. + if (entry.data != default) + { + pool.Return(entry.data.Array); + } + } + + // clear counter too + queueCounter.Clear(); + } + } + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentReceivePipe.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentReceivePipe.cs.meta new file mode 100644 index 0000000..614bab6 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentReceivePipe.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 010a208972a9a4e0cb0e7c18a60b4494 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentSendPipe.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentSendPipe.cs new file mode 100644 index 0000000..be456a0 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentSendPipe.cs @@ -0,0 +1,165 @@ +// a magnificent send pipe to shield us from all of life's complexities. +// safely sends messages from main thread to send thread. +// -> thread safety built in +// -> byte[] pooling coming in the future +// +// => hides all the complexity from telepathy +// => easy to switch between stack/queue/concurrentqueue/etc. +// => easy to test + +using System; +using System.Collections.Generic; + +namespace Telepathy +{ + public class MagnificentSendPipe + { + // message queue + // ConcurrentQueue allocates. lock{} instead. + // -> byte arrays are always of MaxMessageSize + // -> ArraySegment indicates the actual message content + // + // IMPORTANT: lock{} all usages! + readonly Queue> queue = new Queue>(); + + // byte[] pool to avoid allocations + // Take & Return is beautifully encapsulated in the pipe. + // the outside does not need to worry about anything. + // and it can be tested easily. + // + // IMPORTANT: lock{} all usages! + Pool pool; + + // constructor + public MagnificentSendPipe(int MaxMessageSize) + { + // initialize pool to create max message sized byte[]s each time + pool = new Pool(() => new byte[MaxMessageSize]); + } + + // for statistics. don't call Count and assume that it's the same after + // the call. + public int Count + { + get { lock (this) { return queue.Count; } } + } + + // pool count for testing + public int PoolCount + { + get { lock (this) { return pool.Count(); } } + } + + // enqueue a message + // arraysegment for allocation free sends later. + // -> the segment's array is only used until Enqueue() returns! + public void Enqueue(ArraySegment message) + { + // pool & queue usage always needs to be locked + lock (this) + { + // ArraySegment array is only valid until returning, so copy + // it into a byte[] that we can queue safely. + + // get one from the pool first to avoid allocations + byte[] bytes = pool.Take(); + + // copy into it + Buffer.BlockCopy(message.Array, message.Offset, bytes, 0, message.Count); + + // indicate which part is the message + ArraySegment segment = new ArraySegment(bytes, 0, message.Count); + + // now enqueue it + queue.Enqueue(segment); + } + } + + // send threads need to dequeue each byte[] and write it into the socket + // -> dequeueing one byte[] after another works, but it's WAY slower + // than dequeueing all immediately (locks only once) + // lock{} & DequeueAll is WAY faster than ConcurrentQueue & dequeue + // one after another: + // + // uMMORPG 450 CCU + // SafeQueue: 900-1440ms latency + // ConcurrentQueue: 2000ms latency + // + // -> the most obvious solution is to just return a list with all byte[] + // (which allocates) and then write each one into the socket + // -> a faster solution is to serialize each one into one payload buffer + // and pass that to the socket only once. fewer socket calls always + // give WAY better CPU performance(!) + // -> to avoid allocating a new list of entries each time, we simply + // serialize all entries into the payload here already + // => having all this complexity built into the pipe makes testing and + // modifying the algorithm super easy! + // + // IMPORTANT: serializing in here will allow us to return the byte[] + // entries back to a pool later to completely avoid + // allocations! + public bool DequeueAndSerializeAll(ref byte[] payload, out int packetSize) + { + // pool & queue usage always needs to be locked + lock (this) + { + // do nothing if empty + packetSize = 0; + if (queue.Count == 0) + return false; + + // we might have multiple pending messages. merge into one + // packet to avoid TCP overheads and improve performance. + // + // IMPORTANT: Mirror & DOTSNET already batch into MaxMessageSize + // chunks, but we STILL pack all pending messages + // into one large payload so we only give it to TCP + // ONCE. This is HUGE for performance so we keep it! + packetSize = 0; + foreach (ArraySegment message in queue) + packetSize += 4 + message.Count; // header + content + + // create payload buffer if not created yet or previous one is + // too small + // IMPORTANT: payload.Length might be > packetSize! don't use it! + if (payload == null || payload.Length < packetSize) + payload = new byte[packetSize]; + + // dequeue all byte[] messages and serialize into the packet + int position = 0; + while (queue.Count > 0) + { + // dequeue + ArraySegment message = queue.Dequeue(); + + // write header (size) into buffer at position + Utils.IntToBytesBigEndianNonAlloc(message.Count, payload, position); + position += 4; + + // copy message into payload at position + Buffer.BlockCopy(message.Array, message.Offset, payload, position, message.Count); + position += message.Count; + + // return to pool so it can be reused (avoids allocations!) + pool.Return(message.Array); + } + + // we did serialize something + return true; + } + } + + public void Clear() + { + // pool & queue usage always needs to be locked + lock (this) + { + // clear queue, but via dequeue to return each byte[] to pool + while (queue.Count > 0) + { + pool.Return(queue.Dequeue().Array); + } + } + } + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentSendPipe.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentSendPipe.cs.meta new file mode 100644 index 0000000..cf1415f --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/MagnificentSendPipe.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d490021c2e6a64374bc88168cec75c70 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/NetworkStreamExtensions.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/NetworkStreamExtensions.cs new file mode 100644 index 0000000..7cfd73c --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/NetworkStreamExtensions.cs @@ -0,0 +1,67 @@ +using System; +using System.IO; +using System.Net.Sockets; + +namespace Telepathy +{ + public static class NetworkStreamExtensions + { + // .Read returns '0' if remote closed the connection but throws an + // IOException if we voluntarily closed our own connection. + // + // let's add a ReadSafely method that returns '0' in both cases so we don't + // have to worry about exceptions, since a disconnect is a disconnect... + public static int ReadSafely(this NetworkStream stream, byte[] buffer, int offset, int size) + { + try + { + return stream.Read(buffer, offset, size); + } + // IOException happens if we voluntarily closed our own connection. + catch (IOException) + { + return 0; + } + // ObjectDisposedException can be thrown if Client.Disconnect() + // disposes the stream, while we are still trying to read here. + // catching it fixes https://github.com/vis2k/Telepathy/pull/104 + catch (ObjectDisposedException) + { + return 0; + } + } + + // helper function to read EXACTLY 'n' bytes + // -> default .Read reads up to 'n' bytes. this function reads exactly + // 'n' bytes + // -> this is blocking until 'n' bytes were received + // -> immediately returns false in case of disconnects + public static bool ReadExactly(this NetworkStream stream, byte[] buffer, int amount) + { + // there might not be enough bytes in the TCP buffer for .Read to read + // the whole amount at once, so we need to keep trying until we have all + // the bytes (blocking) + // + // note: this just is a faster version of reading one after another: + // for (int i = 0; i < amount; ++i) + // if (stream.Read(buffer, i, 1) == 0) + // return false; + // return true; + int bytesRead = 0; + while (bytesRead < amount) + { + // read up to 'remaining' bytes with the 'safe' read extension + int remaining = amount - bytesRead; + int result = stream.ReadSafely(buffer, bytesRead, remaining); + + // .Read returns 0 if disconnected + if (result == 0) + return false; + + // otherwise add to bytes read + bytesRead += result; + } + return true; + } + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/NetworkStreamExtensions.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/NetworkStreamExtensions.cs.meta new file mode 100644 index 0000000..e7e5744 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/NetworkStreamExtensions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 7a8076c43fa8d4d45831adae232d4d3c +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Pool.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Pool.cs new file mode 100644 index 0000000..4ec4fd2 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Pool.cs @@ -0,0 +1,34 @@ +// pool to avoid allocations. originally from libuv2k. +using System; +using System.Collections.Generic; + +namespace Telepathy +{ + public class Pool + { + // objects + readonly Stack objects = new Stack(); + + // some types might need additional parameters in their constructor, so + // we use a Func generator + readonly Func objectGenerator; + + // constructor + public Pool(Func objectGenerator) + { + this.objectGenerator = objectGenerator; + } + + // take an element from the pool, or create a new one if empty + public T Take() => objects.Count > 0 ? objects.Pop() : objectGenerator(); + + // return an element to the pool + public void Return(T item) => objects.Push(item); + + // clear the pool with the disposer function applied to each object + public void Clear() => objects.Clear(); + + // count to see how many objects are in the pool. useful for tests. + public int Count() => objects.Count; + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Pool.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Pool.cs.meta new file mode 100644 index 0000000..9a7dafc --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Pool.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 6d3e530f6872642ec81e9b8b76277c93 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Server.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Server.cs new file mode 100644 index 0000000..687b90e --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Server.cs @@ -0,0 +1,402 @@ +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Net; +using System.Net.Sockets; +using System.Threading; + +namespace Telepathy +{ + public class Server : Common + { + // events to hook into + // => OnData uses ArraySegment for allocation free receives later + public Action OnConnected; + public Action> OnData; + public Action OnDisconnected; + + // listener + public TcpListener listener; + Thread listenerThread; + + // disconnect if send queue gets too big. + // -> avoids ever growing queue memory if network is slower than input + // -> disconnecting is great for load balancing. better to disconnect + // one connection than risking every connection / the whole server + // -> huge queue would introduce multiple seconds of latency anyway + // + // Mirror/DOTSNET use MaxMessageSize batching, so for a 16kb max size: + // limit = 1,000 means 16 MB of memory/connection + // limit = 10,000 means 160 MB of memory/connection + public int SendQueueLimit = 10000; + public int ReceiveQueueLimit = 10000; + + // thread safe pipe for received messages + // IMPORTANT: unfortunately using one pipe per connection is way slower + // when testing 150 CCU. we need to use one pipe for all + // connections. this scales beautifully. + protected MagnificentReceivePipe receivePipe; + + // pipe count, useful for debugging / benchmarks + public int ReceivePipeTotalCount => receivePipe.TotalCount; + + // clients with + readonly ConcurrentDictionary clients = new ConcurrentDictionary(); + + // connectionId counter + int counter; + + // public next id function in case someone needs to reserve an id + // (e.g. if hostMode should always have 0 connection and external + // connections should start at 1, etc.) + public int NextConnectionId() + { + int id = Interlocked.Increment(ref counter); + + // it's very unlikely that we reach the uint limit of 2 billion. + // even with 1 new connection per second, this would take 68 years. + // -> but if it happens, then we should throw an exception because + // the caller probably should stop accepting clients. + // -> it's hardly worth using 'bool Next(out id)' for that case + // because it's just so unlikely. + if (id == int.MaxValue) + { + throw new Exception("connection id limit reached: " + id); + } + + return id; + } + + // check if the server is running + public bool Active => listenerThread != null && listenerThread.IsAlive; + + // constructor + public Server(int MaxMessageSize) : base(MaxMessageSize) {} + + // the listener thread's listen function + // note: no maxConnections parameter. high level API should handle that. + // (Transport can't send a 'too full' message anyway) + void Listen(int port) + { + // absolutely must wrap with try/catch, otherwise thread + // exceptions are silent + try + { + // start listener on all IPv4 and IPv6 address via .Create + listener = TcpListener.Create(port); + listener.Server.NoDelay = NoDelay; + // IMPORTANT: do not set send/receive timeouts on listener. + // On linux setting the recv timeout will cause the blocking + // Accept call to timeout with EACCEPT (which mono interprets + // as EWOULDBLOCK). + // https://stackoverflow.com/questions/1917814/eagain-error-for-accept-on-blocking-socket/1918118#1918118 + // => fixes https://github.com/vis2k/Mirror/issues/2695 + // + //listener.Server.SendTimeout = SendTimeout; + //listener.Server.ReceiveTimeout = ReceiveTimeout; + listener.Start(); + Log.Info($"[Telepathy] Starting server on port {port}"); + + // keep accepting new clients + while (true) + { + // wait and accept new client + // note: 'using' sucks here because it will try to + // dispose after thread was started but we still need it + // in the thread + TcpClient client = listener.AcceptTcpClient(); + + // set socket options + client.NoDelay = NoDelay; + client.SendTimeout = SendTimeout; + client.ReceiveTimeout = ReceiveTimeout; + + // generate the next connection id (thread safely) + int connectionId = NextConnectionId(); + + // add to dict immediately + ConnectionState connection = new ConnectionState(client, MaxMessageSize); + clients[connectionId] = connection; + + // spawn a send thread for each client + Thread sendThread = new Thread(() => + { + // wrap in try-catch, otherwise Thread exceptions + // are silent + try + { + // run the send loop + // IMPORTANT: DO NOT SHARE STATE ACROSS MULTIPLE THREADS! + ThreadFunctions.SendLoop(connectionId, client, connection.sendPipe, connection.sendPending); + } + catch (ThreadAbortException) + { + // happens on stop. don't log anything. + // (we catch it in SendLoop too, but it still gets + // through to here when aborting. don't show an + // error.) + } + catch (Exception exception) + { + Log.Error("[Telepathy] Server send thread exception: " + exception); + } + }); + sendThread.IsBackground = true; + sendThread.Start(); + + // spawn a receive thread for each client + Thread receiveThread = new Thread(() => + { + // wrap in try-catch, otherwise Thread exceptions + // are silent + try + { + // run the receive loop + // (receive pipe is shared across all loops) + ThreadFunctions.ReceiveLoop(connectionId, client, MaxMessageSize, receivePipe, ReceiveQueueLimit); + + // IMPORTANT: do NOT remove from clients after the + // thread ends. need to do it in Tick() so that the + // disconnect event in the pipe is still processed. + // (removing client immediately would mean that the + // pipe is lost and the disconnect event is never + // processed) + + // sendthread might be waiting on ManualResetEvent, + // so let's make sure to end it if the connection + // closed. + // otherwise the send thread would only end if it's + // actually sending data while the connection is + // closed. + sendThread.Interrupt(); + } + catch (Exception exception) + { + Log.Error("[Telepathy] Server client thread exception: " + exception); + } + }); + receiveThread.IsBackground = true; + receiveThread.Start(); + } + } + catch (ThreadAbortException exception) + { + // UnityEditor causes AbortException if thread is still + // running when we press Play again next time. that's okay. + Log.Info("[Telepathy] Server thread aborted. That's okay. " + exception); + } + catch (SocketException exception) + { + // calling StopServer will interrupt this thread with a + // 'SocketException: interrupted'. that's okay. + Log.Info("[Telepathy] Server Thread stopped. That's okay. " + exception); + } + catch (Exception exception) + { + // something went wrong. probably important. + Log.Error("[Telepathy] Server Exception: " + exception); + } + } + + // start listening for new connections in a background thread and spawn + // a new thread for each one. + public bool Start(int port) + { + // not if already started + if (Active) return false; + + // create receive pipe with max message size for pooling + // => create new pipes every time! + // if an old receive thread is still finishing up, it might still + // be using the old pipes. we don't want to risk any old data for + // our new start here. + receivePipe = new MagnificentReceivePipe(MaxMessageSize); + + // start the listener thread + // (on low priority. if main thread is too busy then there is not + // much value in accepting even more clients) + Log.Info($"[Telepathy] Starting server on port {port}"); + + listenerThread = new Thread(() => { Listen(port); }); + listenerThread.IsBackground = true; + listenerThread.Priority = ThreadPriority.BelowNormal; + listenerThread.Start(); + return true; + } + + public void Stop() + { + // only if started + if (!Active) return; + + Log.Info("[Telepathy] Server: stopping..."); + + // stop listening to connections so that no one can connect while we + // close the client connections + // (might be null if we call Stop so quickly after Start that the + // thread was interrupted before even creating the listener) + listener?.Stop(); + + // kill listener thread at all costs. only way to guarantee that + // .Active is immediately false after Stop. + // -> calling .Join would sometimes wait forever + listenerThread?.Interrupt(); + listenerThread = null; + + // close all client connections + foreach (KeyValuePair kvp in clients) + { + TcpClient client = kvp.Value.client; + // close the stream if not closed yet. it may have been closed + // by a disconnect already, so use try/catch + try { client.GetStream().Close(); } catch {} + client.Close(); + } + + // clear clients list + clients.Clear(); + + // reset the counter in case we start up again so + // clients get connection ID's starting from 1 + counter = 0; + } + + // send message to client using socket connection. + // arraysegment for allocation free sends later. + // -> the segment's array is only used until Send() returns! + public bool Send(int connectionId, ArraySegment message) + { + // respect max message size to avoid allocation attacks. + if (message.Count <= MaxMessageSize) + { + // find the connection + if (clients.TryGetValue(connectionId, out ConnectionState connection)) + { + // check send pipe limit + if (connection.sendPipe.Count < SendQueueLimit) + { + // add to thread safe send pipe and return immediately. + // calling Send here would be blocking (sometimes for long + // times if other side lags or wire was disconnected) + connection.sendPipe.Enqueue(message); + connection.sendPending.Set(); // interrupt SendThread WaitOne() + return true; + } + // disconnect if send queue gets too big. + // -> avoids ever growing queue memory if network is slower + // than input + // -> disconnecting is great for load balancing. better to + // disconnect one connection than risking every + // connection / the whole server + // + // note: while SendThread always grabs the WHOLE send queue + // immediately, it's still possible that the sending + // blocks for so long that the send queue just gets + // way too big. have a limit - better safe than sorry. + else + { + // log the reason + Log.Warning($"[Telepathy] Server.Send: sendPipe for connection {connectionId} reached limit of {SendQueueLimit}. This can happen if we call send faster than the network can process messages. Disconnecting this connection for load balancing."); + + // just close it. send thread will take care of the rest. + connection.client.Close(); + return false; + } + } + + // sending to an invalid connectionId is expected sometimes. + // for example, if a client disconnects, the server might still + // try to send for one frame before it calls GetNextMessages + // again and realizes that a disconnect happened. + // so let's not spam the console with log messages. + //Logger.Log("Server.Send: invalid connectionId: " + connectionId); + return false; + } + Log.Error("[Telepathy] Server.Send: message too big: " + message.Count + ". Limit: " + MaxMessageSize); + return false; + } + + // client's ip is sometimes needed by the server, e.g. for bans + public string GetClientAddress(int connectionId) + { + // find the connection + if (clients.TryGetValue(connectionId, out ConnectionState connection)) + { + return ((IPEndPoint)connection.client.Client.RemoteEndPoint).Address.ToString(); + } + return ""; + } + + // disconnect (kick) a client + public bool Disconnect(int connectionId) + { + // find the connection + if (clients.TryGetValue(connectionId, out ConnectionState connection)) + { + // just close it. send thread will take care of the rest. + connection.client.Close(); + Log.Info("[Telepathy] Server.Disconnect connectionId:" + connectionId); + return true; + } + return false; + } + + // tick: processes up to 'limit' messages for each connection + // => limit parameter to avoid deadlocks / too long freezes if server or + // client is too slow to process network load + // => Mirror & DOTSNET need to have a process limit anyway. + // might as well do it here and make life easier. + // => returns amount of remaining messages to process, so the caller + // can call tick again as many times as needed (or up to a limit) + // + // Tick() may process multiple messages, but Mirror needs a way to stop + // processing immediately if a scene change messages arrives. Mirror + // can't process any other messages during a scene change. + // (could be useful for others too) + // => make sure to allocate the lambda only once in transports + public int Tick(int processLimit, Func checkEnabled = null) + { + // only if pipe was created yet (after start()) + if (receivePipe == null) + return 0; + + // process up to 'processLimit' messages for this connection + for (int i = 0; i < processLimit; ++i) + { + // check enabled in case a Mirror scene message arrived + if (checkEnabled != null && !checkEnabled()) + break; + + // peek first. allows us to process the first queued entry while + // still keeping the pooled byte[] alive by not removing anything. + if (receivePipe.TryPeek(out int connectionId, out EventType eventType, out ArraySegment message)) + { + switch (eventType) + { + case EventType.Connected: + OnConnected?.Invoke(connectionId); + break; + case EventType.Data: + OnData?.Invoke(connectionId, message); + break; + case EventType.Disconnected: + OnDisconnected?.Invoke(connectionId); + // remove disconnected connection now that the final + // disconnected message was processed. + clients.TryRemove(connectionId, out ConnectionState _); + break; + } + + // IMPORTANT: now dequeue and return it to pool AFTER we are + // done processing the event. + receivePipe.TryDequeue(); + } + // no more messages. stop the loop. + else break; + } + + // return what's left to process for next time + return receivePipe.TotalCount; + } + } +} diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Server.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Server.cs.meta new file mode 100644 index 0000000..9cee8b7 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Server.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: fb98a16841ccc4338a7e0b4e59136563 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Telepathy.asmdef b/Assets/Mirror/Transports/Telepathy/Telepathy/Telepathy.asmdef new file mode 100644 index 0000000..cd8d16a --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Telepathy.asmdef @@ -0,0 +1,12 @@ +{ + "name": "Telepathy", + "references": [], + "optionalUnityReferences": [], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [] +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Telepathy.asmdef.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Telepathy.asmdef.meta new file mode 100644 index 0000000..572c127 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Telepathy.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 725ee7191c021de4dbf9269590ded755 +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/ThreadFunctions.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/ThreadFunctions.cs new file mode 100644 index 0000000..a5f0324 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/ThreadFunctions.cs @@ -0,0 +1,244 @@ +// IMPORTANT +// force all thread functions to be STATIC. +// => Common.Send/ReceiveLoop is EXTREMELY DANGEROUS because it's too easy to +// accidentally share Common state between threads. +// => header buffer, payload etc. were accidentally shared once after changing +// the thread functions from static to non static +// => C# does not automatically detect data races. best we can do is move all of +// our thread code into static functions and pass all state into them +// +// let's even keep them in a STATIC CLASS so it's 100% obvious that this should +// NOT EVER be changed to non static! +using System; +using System.Net.Sockets; +using System.Threading; + +namespace Telepathy +{ + public static class ThreadFunctions + { + // send message (via stream) with the message structure + // this function is blocking sometimes! + // (e.g. if someone has high latency or wire was cut off) + // -> payload is of multiple < parts + public static bool SendMessagesBlocking(NetworkStream stream, byte[] payload, int packetSize) + { + // stream.Write throws exceptions if client sends with high + // frequency and the server stops + try + { + // write the whole thing + stream.Write(payload, 0, packetSize); + return true; + } + catch (Exception exception) + { + // log as regular message because servers do shut down sometimes + Log.Info("[Telepathy] Send: stream.Write exception: " + exception); + return false; + } + } + // read message (via stream) blocking. + // writes into byte[] and returns bytes written to avoid allocations. + public static bool ReadMessageBlocking(NetworkStream stream, int MaxMessageSize, byte[] headerBuffer, byte[] payloadBuffer, out int size) + { + size = 0; + + // buffer needs to be of Header + MaxMessageSize + if (payloadBuffer.Length != 4 + MaxMessageSize) + { + Log.Error($"[Telepathy] ReadMessageBlocking: payloadBuffer needs to be of size 4 + MaxMessageSize = {4 + MaxMessageSize} instead of {payloadBuffer.Length}"); + return false; + } + + // read exactly 4 bytes for header (blocking) + if (!stream.ReadExactly(headerBuffer, 4)) + return false; + + // convert to int + size = Utils.BytesToIntBigEndian(headerBuffer); + + // protect against allocation attacks. an attacker might send + // multiple fake '2GB header' packets in a row, causing the server + // to allocate multiple 2GB byte arrays and run out of memory. + // + // also protect against size <= 0 which would cause issues + if (size > 0 && size <= MaxMessageSize) + { + // read exactly 'size' bytes for content (blocking) + return stream.ReadExactly(payloadBuffer, size); + } + Log.Warning("[Telepathy] ReadMessageBlocking: possible header attack with a header of: " + size + " bytes."); + return false; + } + + // thread receive function is the same for client and server's clients + public static void ReceiveLoop(int connectionId, TcpClient client, int MaxMessageSize, MagnificentReceivePipe receivePipe, int QueueLimit) + { + // get NetworkStream from client + NetworkStream stream = client.GetStream(); + + // every receive loop needs it's own receive buffer of + // HeaderSize + MaxMessageSize + // to avoid runtime allocations. + // + // IMPORTANT: DO NOT make this a member, otherwise every connection + // on the server would use the same buffer simulatenously + byte[] receiveBuffer = new byte[4 + MaxMessageSize]; + + // avoid header[4] allocations + // + // IMPORTANT: DO NOT make this a member, otherwise every connection + // on the server would use the same buffer simulatenously + byte[] headerBuffer = new byte[4]; + + // absolutely must wrap with try/catch, otherwise thread exceptions + // are silent + try + { + // add connected event to pipe + receivePipe.Enqueue(connectionId, EventType.Connected, default); + + // let's talk about reading data. + // -> normally we would read as much as possible and then + // extract as many , messages + // as we received this time. this is really complicated + // and expensive to do though + // -> instead we use a trick: + // Read(2) -> size + // Read(size) -> content + // repeat + // Read is blocking, but it doesn't matter since the + // best thing to do until the full message arrives, + // is to wait. + // => this is the most elegant AND fast solution. + // + no resizing + // + no extra allocations, just one for the content + // + no crazy extraction logic + while (true) + { + // read the next message (blocking) or stop if stream closed + if (!ReadMessageBlocking(stream, MaxMessageSize, headerBuffer, receiveBuffer, out int size)) + // break instead of return so stream close still happens! + break; + + // create arraysegment for the read message + ArraySegment message = new ArraySegment(receiveBuffer, 0, size); + + // send to main thread via pipe + // -> it'll copy the message internally so we can reuse the + // receive buffer for next read! + receivePipe.Enqueue(connectionId, EventType.Data, message); + + // disconnect if receive pipe gets too big for this connectionId. + // -> avoids ever growing queue memory if network is slower + // than input + // -> disconnecting is great for load balancing. better to + // disconnect one connection than risking every + // connection / the whole server + if (receivePipe.Count(connectionId) >= QueueLimit) + { + // log the reason + Log.Warning($"[Telepathy] ReceivePipe reached limit of {QueueLimit} for connectionId {connectionId}. This can happen if network messages come in way faster than we manage to process them. Disconnecting this connection for load balancing."); + + // IMPORTANT: do NOT clear the whole queue. we use one + // queue for all connections. + //receivePipe.Clear(); + + // just break. the finally{} will close everything. + break; + } + } + } + catch (Exception exception) + { + // something went wrong. the thread was interrupted or the + // connection closed or we closed our own connection or ... + // -> either way we should stop gracefully + Log.Info("[Telepathy] ReceiveLoop finished receive function for connectionId=" + connectionId + " reason: " + exception); + } + finally + { + // clean up no matter what + stream.Close(); + client.Close(); + + // add 'Disconnected' message after disconnecting properly. + // -> always AFTER closing the streams to avoid a race condition + // where Disconnected -> Reconnect wouldn't work because + // Connected is still true for a short moment before the stream + // would be closed. + receivePipe.Enqueue(connectionId, EventType.Disconnected, default); + } + } + // thread send function + // note: we really do need one per connection, so that if one connection + // blocks, the rest will still continue to get sends + public static void SendLoop(int connectionId, TcpClient client, MagnificentSendPipe sendPipe, ManualResetEvent sendPending) + { + // get NetworkStream from client + NetworkStream stream = client.GetStream(); + + // avoid payload[packetSize] allocations. size increases dynamically as + // needed for batching. + // + // IMPORTANT: DO NOT make this a member, otherwise every connection + // on the server would use the same buffer simulatenously + byte[] payload = null; + + try + { + while (client.Connected) // try this. client will get closed eventually. + { + // reset ManualResetEvent before we do anything else. this + // way there is no race condition. if Send() is called again + // while in here then it will be properly detected next time + // -> otherwise Send might be called right after dequeue but + // before .Reset, which would completely ignore it until + // the next Send call. + sendPending.Reset(); // WaitOne() blocks until .Set() again + + // dequeue & serialize all + // a locked{} TryDequeueAll is twice as fast as + // ConcurrentQueue, see SafeQueue.cs! + if (sendPipe.DequeueAndSerializeAll(ref payload, out int packetSize)) + { + // send messages (blocking) or stop if stream is closed + if (!SendMessagesBlocking(stream, payload, packetSize)) + // break instead of return so stream close still happens! + break; + } + + // don't choke up the CPU: wait until queue not empty anymore + sendPending.WaitOne(); + } + } + catch (ThreadAbortException) + { + // happens on stop. don't log anything. + } + catch (ThreadInterruptedException) + { + // happens if receive thread interrupts send thread. + } + catch (Exception exception) + { + // something went wrong. the thread was interrupted or the + // connection closed or we closed our own connection or ... + // -> either way we should stop gracefully + Log.Info("[Telepathy] SendLoop Exception: connectionId=" + connectionId + " reason: " + exception); + } + finally + { + // clean up no matter what + // we might get SocketExceptions when sending if the 'host has + // failed to respond' - in which case we should close the connection + // which causes the ReceiveLoop to end and fire the Disconnected + // message. otherwise the connection would stay alive forever even + // though we can't send anymore. + stream.Close(); + client.Close(); + } + } + } +} \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/ThreadFunctions.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/ThreadFunctions.cs.meta new file mode 100644 index 0000000..ea536ac --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/ThreadFunctions.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: d01598bf851164dc48a24c26913460b9 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Utils.cs b/Assets/Mirror/Transports/Telepathy/Telepathy/Utils.cs new file mode 100644 index 0000000..8f04fe9 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Utils.cs @@ -0,0 +1,23 @@ +namespace Telepathy +{ + public static class Utils + { + // IntToBytes version that doesn't allocate a new byte[4] each time. + // -> important for MMO scale networking performance. + public static void IntToBytesBigEndianNonAlloc(int value, byte[] bytes, int offset = 0) + { + bytes[offset + 0] = (byte)(value >> 24); + bytes[offset + 1] = (byte)(value >> 16); + bytes[offset + 2] = (byte)(value >> 8); + bytes[offset + 3] = (byte)value; + } + + public static int BytesToIntBigEndian(byte[] bytes) + { + return (bytes[0] << 24) | + (bytes[1] << 16) | + (bytes[2] << 8) | + bytes[3]; + } + } +} diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/Utils.cs.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/Utils.cs.meta new file mode 100644 index 0000000..0a9253b --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/Utils.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 951d08c05297f4b3e8feb5bfcab86531 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/VERSION b/Assets/Mirror/Transports/Telepathy/Telepathy/VERSION new file mode 100644 index 0000000..9ec0736 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/VERSION @@ -0,0 +1,62 @@ +V1.8 [2021-06-02] +- fix: Do not set timeouts on listener (fixes https://github.com/vis2k/Mirror/issues/2695) +- fix: #104 - ReadSafely now catches ObjectDisposedException too + +V1.7 [2021-02-20] +- ReceiveTimeout: disabled by default for cases where people use Telepathy by + itself without pings etc. + +V1.6 [2021-02-10] +- configurable ReceiveTimeout to avoid TCPs high default timeout +- Server/Client receive queue limit now disconnects instead of showing a + warning. this is necessary for load balancing to avoid situations where one + spamming connection might fill the queue and slow down everyone else. + +V1.5 [2021-02-05] +- fix: client data races & flaky tests fixed by creating a new client state + object every time we connect. fixes data race where an old dieing thread + might still try to modify the current state +- fix: Client.ReceiveThreadFunction catches and ignores ObjectDisposedException + which can happen if Disconnect() closes and disposes the client, while the + ReceiveThread just starts up and still uses the client. +- Server/Client Tick() optional enabled check for Mirror scene changing + +V1.4 [2021-02-03] +- Server/Client.Tick: limit parameter added to process up to 'limit' messages. + makes Mirror & DOTSNET transports easier to implement +- stability: Server/Client send queue limit disconnects instead of showing a + warning. allows for load balancing. better to kick one connection and keep + the server running than slowing everything down for everyone. + +V1.3 [2021-02-02] +- perf: ReceivePipe: byte[] pool for allocation free receives (╯°□°)╯︵ ┻━┻ +- fix: header buffer, payload buffer data races because they were made non + static earlier. server threads would all access the same ones. + => all threaded code was moved into a static ThreadFunctions class to make it + 100% obvious that there should be no shared state in the future + +V1.2 [2021-02-02] +- Client/Server Tick & OnConnected/OnData/OnDisconnected events instead of + having the outside process messages via GetNextMessage. That's easier for + Mirror/DOTSNET and allows for allocation free data message processing later. +- MagnificientSend/RecvPipe to shield Telepathy from all the complexity +- perf: SendPipe: byte[] pool for allocation free sends (╯°□°)╯︵ ┻━┻ + +V1.1 [2021-02-01] +- stability: added more tests +- breaking: Server/Client.Send: ArraySegment parameter and copy internally so + that Transports don't need to worry about it +- perf: Buffer.BlockCopy instead of Array.Copy +- perf: SendMessageBlocking puts message header directly into payload now +- perf: receiveQueues use SafeQueue instead of ConcurrentQueue to avoid + allocations +- Common: removed static state +- perf: SafeQueue.TryDequeueAll: avoid queue.ToArray() allocations. copy into a + list instead. +- Logger.Log/LogWarning/LogError renamed to Log.Info/Warning/Error +- MaxMessageSize is now specified in constructor to prepare for pooling +- flaky tests are ignored for now +- smaller improvements + +V1.0 +- first stable release \ No newline at end of file diff --git a/Assets/Mirror/Transports/Telepathy/Telepathy/VERSION.meta b/Assets/Mirror/Transports/Telepathy/Telepathy/VERSION.meta new file mode 100644 index 0000000..04c1c8a --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/Telepathy/VERSION.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: d942af06608be434dbeeaa58207d20bd +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Transports/Telepathy/TelepathyTransport.cs b/Assets/Mirror/Transports/Telepathy/TelepathyTransport.cs new file mode 100644 index 0000000..fabc189 --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/TelepathyTransport.cs @@ -0,0 +1,274 @@ +// wraps Telepathy for use as HLAPI TransportLayer +using System; +using System.Net; +using System.Net.Sockets; +using UnityEngine; + +// Replaced by Kcp November 2020 +namespace Mirror +{ + [HelpURL("https://github.com/vis2k/Telepathy/blob/master/README.md")] + [DisallowMultipleComponent] + public class TelepathyTransport : Transport, PortTransport + { + // scheme used by this transport + // "tcp4" means tcp with 4 bytes header, network byte order + public const string Scheme = "tcp4"; + + public ushort port = 7777; + public ushort Port { get => port; set => port=value; } + + [Header("Common")] + [Tooltip("Nagle Algorithm can be disabled by enabling NoDelay")] + public bool NoDelay = true; + + [Tooltip("Send timeout in milliseconds.")] + public int SendTimeout = 5000; + + [Tooltip("Receive timeout in milliseconds. High by default so users don't time out during scene changes.")] + public int ReceiveTimeout = 30000; + + [Header("Server")] + [Tooltip("Protect against allocation attacks by keeping the max message size small. Otherwise an attacker might send multiple fake packets with 2GB headers, causing the server to run out of memory after allocating multiple large packets.")] + public int serverMaxMessageSize = 16 * 1024; + + [Tooltip("Server processes a limit amount of messages per tick to avoid a deadlock where it might end up processing forever if messages come in faster than we can process them.")] + public int serverMaxReceivesPerTick = 10000; + + [Tooltip("Server send queue limit per connection for pending messages. Telepathy will disconnect a connection's queues reach that limit for load balancing. Better to kick one slow client than slowing down the whole server.")] + public int serverSendQueueLimitPerConnection = 10000; + + [Tooltip("Server receive queue limit per connection for pending messages. Telepathy will disconnect a connection's queues reach that limit for load balancing. Better to kick one slow client than slowing down the whole server.")] + public int serverReceiveQueueLimitPerConnection = 10000; + + [Header("Client")] + [Tooltip("Protect against allocation attacks by keeping the max message size small. Otherwise an attacker host might send multiple fake packets with 2GB headers, causing the connected clients to run out of memory after allocating multiple large packets.")] + public int clientMaxMessageSize = 16 * 1024; + + [Tooltip("Client processes a limit amount of messages per tick to avoid a deadlock where it might end up processing forever if messages come in faster than we can process them.")] + public int clientMaxReceivesPerTick = 1000; + + [Tooltip("Client send queue limit for pending messages. Telepathy will disconnect if the connection's queues reach that limit in order to avoid ever growing latencies.")] + public int clientSendQueueLimit = 10000; + + [Tooltip("Client receive queue limit for pending messages. Telepathy will disconnect if the connection's queues reach that limit in order to avoid ever growing latencies.")] + public int clientReceiveQueueLimit = 10000; + + Telepathy.Client client; + Telepathy.Server server; + + // scene change message needs to halt message processing immediately + // Telepathy.Tick() has a enabledCheck parameter that we can use, but + // let's only allocate it once. + Func enabledCheck; + + void Awake() + { + // tell Telepathy to use Unity's Debug.Log + Telepathy.Log.Info = Debug.Log; + Telepathy.Log.Warning = Debug.LogWarning; + Telepathy.Log.Error = Debug.LogError; + + // allocate enabled check only once + enabledCheck = () => enabled; + + Debug.Log("TelepathyTransport initialized!"); + } + + public override bool Available() + { + // C#'s built in TCP sockets run everywhere except on WebGL + return Application.platform != RuntimePlatform.WebGLPlayer; + } + + // client + private void CreateClient() + { + // create client + client = new Telepathy.Client(clientMaxMessageSize); + // client hooks + // other systems hook into transport events in OnCreate or + // OnStartRunning in no particular order. the only way to avoid + // race conditions where telepathy uses OnConnected before another + // system's hook (e.g. statistics OnData) was added is to wrap + // them all in a lambda and always call the latest hook. + // (= lazy call) + client.OnConnected = () => OnClientConnected.Invoke(); + client.OnData = (segment) => OnClientDataReceived.Invoke(segment, Channels.Reliable); + // fix: https://github.com/vis2k/Mirror/issues/3287 + // Telepathy may call OnDisconnected twice. + // Mirror may have cleared the callback already, so use "?." here. + client.OnDisconnected = () => OnClientDisconnected?.Invoke(); + + // client configuration + client.NoDelay = NoDelay; + client.SendTimeout = SendTimeout; + client.ReceiveTimeout = ReceiveTimeout; + client.SendQueueLimit = clientSendQueueLimit; + client.ReceiveQueueLimit = clientReceiveQueueLimit; + } + public override bool ClientConnected() => client != null && client.Connected; + public override void ClientConnect(string address) + { + CreateClient(); + client.Connect(address, port); + } + + public override void ClientConnect(Uri uri) + { + CreateClient(); + if (uri.Scheme != Scheme) + throw new ArgumentException($"Invalid url {uri}, use {Scheme}://host:port instead", nameof(uri)); + + int serverPort = uri.IsDefaultPort ? port : uri.Port; + client.Connect(uri.Host, serverPort); + } + public override void ClientSend(ArraySegment segment, int channelId) + { + client?.Send(segment); + + // call event. might be null if no statistics are listening etc. + OnClientDataSent?.Invoke(segment, Channels.Reliable); + } + public override void ClientDisconnect() + { + client?.Disconnect(); + client = null; + // client triggers the disconnected event in client.Tick() which won't be run anymore + OnClientDisconnected?.Invoke(); + } + + // messages should always be processed in early update + public override void ClientEarlyUpdate() + { + // note: we need to check enabled in case we set it to false + // when LateUpdate already started. + // (https://github.com/vis2k/Mirror/pull/379) + if (!enabled) return; + + // process a maximum amount of client messages per tick + // IMPORTANT: check .enabled to stop processing immediately after a + // scene change message arrives! + client?.Tick(clientMaxReceivesPerTick, enabledCheck); + } + + // server + public override Uri ServerUri() + { + UriBuilder builder = new UriBuilder(); + builder.Scheme = Scheme; + builder.Host = Dns.GetHostName(); + builder.Port = port; + return builder.Uri; + } + public override bool ServerActive() => server != null && server.Active; + public override void ServerStart() + { + // create server + server = new Telepathy.Server(serverMaxMessageSize); + + // server hooks + // other systems hook into transport events in OnCreate or + // OnStartRunning in no particular order. the only way to avoid + // race conditions where telepathy uses OnConnected before another + // system's hook (e.g. statistics OnData) was added is to wrap + // them all in a lambda and always call the latest hook. + // (= lazy call) + server.OnConnected = (connectionId) => OnServerConnected.Invoke(connectionId); + server.OnData = (connectionId, segment) => OnServerDataReceived.Invoke(connectionId, segment, Channels.Reliable); + server.OnDisconnected = (connectionId) => OnServerDisconnected.Invoke(connectionId); + + // server configuration + server.NoDelay = NoDelay; + server.SendTimeout = SendTimeout; + server.ReceiveTimeout = ReceiveTimeout; + server.SendQueueLimit = serverSendQueueLimitPerConnection; + server.ReceiveQueueLimit = serverReceiveQueueLimitPerConnection; + + server.Start(port); + } + + public override void ServerSend(int connectionId, ArraySegment segment, int channelId) + { + server?.Send(connectionId, segment); + + // call event. might be null if no statistics are listening etc. + OnServerDataSent?.Invoke(connectionId, segment, Channels.Reliable); + } + public override void ServerDisconnect(int connectionId) => server?.Disconnect(connectionId); + public override string ServerGetClientAddress(int connectionId) + { + try + { + return server?.GetClientAddress(connectionId); + } + catch (SocketException) + { + // using server.listener.LocalEndpoint causes an Exception + // in UWP + Unity 2019: + // Exception thrown at 0x00007FF9755DA388 in UWF.exe: + // Microsoft C++ exception: Il2CppExceptionWrapper at memory + // location 0x000000E15A0FCDD0. SocketException: An address + // incompatible with the requested protocol was used at + // System.Net.Sockets.Socket.get_LocalEndPoint () + // so let's at least catch it and recover + return "unknown"; + } + } + public override void ServerStop() + { + server?.Stop(); + server = null; + } + + // messages should always be processed in early update + public override void ServerEarlyUpdate() + { + // note: we need to check enabled in case we set it to false + // when LateUpdate already started. + // (https://github.com/vis2k/Mirror/pull/379) + if (!enabled) return; + + // process a maximum amount of server messages per tick + // IMPORTANT: check .enabled to stop processing immediately after a + // scene change message arrives! + server?.Tick(serverMaxReceivesPerTick, enabledCheck); + } + + // common + public override void Shutdown() + { + Debug.Log("TelepathyTransport Shutdown()"); + client?.Disconnect(); + client = null; + server?.Stop(); + server = null; + } + + public override int GetMaxPacketSize(int channelId) + { + return serverMaxMessageSize; + } + + public override string ToString() + { + if (server != null && server.Active && server.listener != null) + { + // printing server.listener.LocalEndpoint causes an Exception + // in UWP + Unity 2019: + // Exception thrown at 0x00007FF9755DA388 in UWF.exe: + // Microsoft C++ exception: Il2CppExceptionWrapper at memory + // location 0x000000E15A0FCDD0. SocketException: An address + // incompatible with the requested protocol was used at + // System.Net.Sockets.Socket.get_LocalEndPoint () + // so let's use the regular port instead. + return $"Telepathy Server port: {port}"; + } + else if (client != null && (client.Connecting || client.Connected)) + { + return $"Telepathy Client port: {port}"; + } + return "Telepathy (inactive/disconnected)"; + } + } +} diff --git a/Assets/Mirror/Transports/Telepathy/TelepathyTransport.cs.meta b/Assets/Mirror/Transports/Telepathy/TelepathyTransport.cs.meta new file mode 100644 index 0000000..99cde3e --- /dev/null +++ b/Assets/Mirror/Transports/Telepathy/TelepathyTransport.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c7424c1070fad4ba2a7a96b02fbeb4bb +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 1000 + icon: {fileID: 2800000, guid: 7453abfe9e8b2c04a8a47eb536fe21eb, type: 3} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Mirror/Version.txt b/Assets/Mirror/Version.txt new file mode 100644 index 0000000..18b6a57 --- /dev/null +++ b/Assets/Mirror/Version.txt @@ -0,0 +1 @@ +81.4.0 \ No newline at end of file diff --git a/Assets/Mirror/Version.txt.meta b/Assets/Mirror/Version.txt.meta new file mode 100644 index 0000000..097f259 --- /dev/null +++ b/Assets/Mirror/Version.txt.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: c6b1f72568a9340178b4c34608fbdbc3 +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: