Compare commits
9 Commits
1.7.0
...
2.0.0-pre.
| Author | SHA1 | Date | |
|---|---|---|---|
|
a813ba0dd6 | ||
|
|
c813386c5c | ||
|
|
ed38a4dcc2 | ||
|
|
36d539e265 | ||
|
|
63c7e4c78a | ||
|
|
143a6cbd34 | ||
|
|
f8ebf679ec | ||
|
|
07f206ff9e | ||
|
|
514166e159 |
252
CHANGELOG.md
252
CHANGELOG.md
@@ -6,6 +6,256 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
|
||||
|
||||
Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com).
|
||||
|
||||
## [2.0.0-pre.3] - 2024-07-23
|
||||
|
||||
### Added
|
||||
- Added: `UnityTransport.GetNetworkDriver` and `UnityTransport.GetLocalEndpoint` methods to expose the driver and local endpoint being used. (#2978)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where deferred despawn was causing GC allocations when converting an `IEnumerable` to a list. (#2983)
|
||||
- Fixed issue where the realtime network stats monitor was not able to display RPC traffic in release builds due to those stats being only available in development builds or the editor. (#2979)
|
||||
- Fixed issue where `NetworkManager.ScenesLoaded` was not being updated if `PostSynchronizationSceneUnloading` was set and any loaded scenes not used during synchronization were unloaded. (#2971)
|
||||
- Fixed issue where `Rigidbody2d` under Unity 6000.0.11f1 has breaking changes where `velocity` is now `linearVelocity` and `isKinematic` is replaced by `bodyType`. (#2971)
|
||||
- Fixed issue where `NetworkSpawnManager.InstantiateAndSpawn` and `NetworkObject.InstantiateAndSpawn` were not honoring the ownerClientId parameter when using a client-server network topology. (#2968)
|
||||
- Fixed issue where internal delta serialization could not have a byte serializer defined when serializing deltas for other types. Added `[GenerateSerializationForType(typeof(byte))]` to both the `NetworkVariable` and `AnticipatedNetworkVariable` classes to assure a byte serializer is defined.(#2962)
|
||||
- Fixed issue when scene management was disabled and the session owner would still try to synchronize a late joining client. (#2962)
|
||||
- Fixed issue when using a distributed authority network topology where it would allow a session owner to spawn a `NetworkObject` prior to being approved. Now, an error message is logged and the `NetworkObject` will not be spawned prior to the client being approved. (#2962)
|
||||
- Fixed issue where attempting to spawn during `NetworkBehaviour.OnInSceneObjectsSpawned` and `NetworkBehaviour.OnNetworkSessionSynchronized` notifications would throw a collection modified exception. (#2962)
|
||||
|
||||
### Changed
|
||||
|
||||
- Changed logic where clients can now set the `NetworkSceneManager` client synchronization mode when using a distributed authority network topology. (#2985)
|
||||
|
||||
|
||||
## [2.0.0-pre.2] - 2024-06-17
|
||||
|
||||
### Added
|
||||
|
||||
- Added `AnticipatedNetworkVariable<T>`, which adds support for client anticipation of `NetworkVariable` values, allowing for more responsive gameplay. (#2957)
|
||||
- Added `AnticipatedNetworkTransform`, which adds support for client anticipation of NetworkTransforms. (#2957)
|
||||
- Added `NetworkVariableBase.ExceedsDirtinessThreshold` to allow network variables to throttle updates by only sending updates when the difference between the current and previous values exceeds a threshold. (This is exposed in `NetworkVariable<T>` with the callback `NetworkVariable<T>.CheckExceedsDirtinessThreshold`). (#2957)
|
||||
- Added `NetworkVariableUpdateTraits`, which add additional throttling support: `MinSecondsBetweenUpdates` will prevent the `NetworkVariable` from sending updates more often than the specified time period (even if it exceeds the dirtiness threshold), while `MaxSecondsBetweenUpdates` will force a dirty `NetworkVariable` to send an update after the specified time period even if it has not yet exceeded the dirtiness threshold. (#2957)
|
||||
- Added virtual method `NetworkVariableBase.OnInitialize` which can be used by `NetworkVariable` subclasses to add initialization code. (#2957)
|
||||
- Added `NetworkTime.TickWithPartial`, which represents the current tick as a double that includes the fractional/partial tick value. (#2957)
|
||||
- Added `NetworkTickSystem.AnticipationTick`, which can be helpful with implementation of client anticipation. This value represents the tick the current local client was at at the beginning of the most recent network round trip, which enables it to correlate server update ticks with the client tick that may have triggered them. (#2957)
|
||||
- Added event `NetworkManager.OnSessionOwnerPromoted` that is invoked when a new session owner promotion occurs. (#2948)
|
||||
- Added `NetworkRigidBodyBase.GetLinearVelocity` and `NetworkRigidBodyBase.SetLinearVelocity` convenience/helper methods. (#2948)
|
||||
- Added `NetworkRigidBodyBase.GetAngularVelocity` and `NetworkRigidBodyBase.SetAngularVelocity` convenience/helper methods. (#2948)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue when `NetworkTransform` half float precision is enabled and ownership changes the current base position was not being synchronized. (#2948)
|
||||
- Fixed issue where `OnClientConnected` not being invoked on the session owner when connecting to a new distributed authority session. (#2948)
|
||||
- Fixed issue where Rigidbody micro-motion (i.e. relatively small velocities) would result in non-authority instances slightly stuttering as the body would come to a rest (i.e. no motion). Now, the threshold value can increase at higher velocities and can decrease slightly below the provided threshold to account for this. (#2948)
|
||||
|
||||
### Changed
|
||||
|
||||
- Changed `NetworkAnimator` no longer requires the `Animator` component to exist on the same `GameObject`. (#2957)
|
||||
- Changed `NetworkObjectReference` and `NetworkBehaviourReference` to allow null references when constructing and serializing. (#2957)
|
||||
- Changed the client's owned objects is now returned (`NetworkClient` and `NetworkSpawnManager`) as an array as opposed to a list for performance purposes. (#2948)
|
||||
- Changed `NetworkTransfrom.TryCommitTransformToServer` to be internal as it will be removed by the final 2.0.0 release. (#2948)
|
||||
- Changed `NetworkTransformEditor.OnEnable` to a virtual method to be able to customize a `NetworkTransform` derived class by creating a derived editor control from `NetworkTransformEditor`. (#2948)
|
||||
|
||||
|
||||
## [2.0.0-exp.5] - 2024-06-03
|
||||
|
||||
### Added
|
||||
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where SessionOwner message was being treated as a new entry for the new message indexing when it should have been ordinally sorted with the legacy message indices. (#2942)
|
||||
|
||||
### Changed
|
||||
- Changed `FastBufferReader` and `FastBufferWriter` so that they always ensure the length of items serialized is always serialized as an `uint` and added a check before casting for safe reading and writing.(#2946)
|
||||
|
||||
|
||||
## [2.0.0-exp.4] - 2024-05-31
|
||||
|
||||
### Added
|
||||
|
||||
- Added `NetworkRigidbodyBase.AttachToFixedJoint` and `NetworkRigidbodyBase.DetachFromFixedJoint` to replace parenting for rigid bodies that have `NetworkRigidbodyBase.UseRigidBodyForMotion` enabled. (#2933)
|
||||
- Added `NetworkBehaviour.OnNetworkPreSpawn` and `NetworkBehaviour.OnNetworkPostSpawn` methods that provide the ability to handle pre and post spawning actions during the `NetworkObject` spawn sequence. (#2912)
|
||||
- Added a client-side only `NetworkBehaviour.OnNetworkSessionSynchronized` convenience method that is invoked on all `NetworkBehaviour`s after a newly joined client has finished synchronizing with the network session in progress. (#2912)
|
||||
- Added `NetworkBehaviour.OnInSceneObjectsSpawned` convenience method that is invoked when all in-scene `NetworkObject`s have been spawned after a scene has been loaded or upon a host or server starting. (#2912)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where non-authoritative rigid bodies with `NetworkRigidbodyBase.UseRigidBodyForMotion` enabled would constantly log errors about the renderTime being before `StartTimeConsumed`. (#2933)
|
||||
- Fixed issue where in-scene placed NetworkObjects could be destroyed if a client disconnects early and/or before approval. (#2924)
|
||||
- Fixed issue where a `NetworkObject` component's associated `NetworkBehaviour` components would not be detected if scene loading is disabled in the editor and the currently loaded scene has in-scene placed `NetworkObject`s. (#2912)
|
||||
- Fixed issue where an in-scene placed `NetworkObject` with `NetworkTransform` that is also parented under a `GameObject` would not properly synchronize when the parent `GameObject` had a world space position other than 0,0,0. (#2898)
|
||||
|
||||
### Changed
|
||||
|
||||
- Change all the access modifiers of test class from Public to Internal (#2930)
|
||||
- Changed messages are now sorted by enum values as opposed to ordinally sorting the messages by their type name. (#2929)
|
||||
- Changed `NetworkClient.SessionModeTypes` to `NetworkClient.NetworkTopologyTypes`. (#2875)
|
||||
- Changed `NetworkClient.SessionModeType` to `NetworkClient.NetworkTopologyType`. (#2875)
|
||||
- Changed `NetworkConfig.SessionMode` to `NeworkConfig.NetworkTopology`. (#2875)
|
||||
|
||||
## [2.0.0-exp.2] - 2024-04-02
|
||||
|
||||
### Added
|
||||
- Added updates to all internal messages to account for a distributed authority network session connection. (#2863)
|
||||
- Added `NetworkRigidbodyBase` that provides users with a more customizable network rigidbody, handles both `Rigidbody` and `Rigidbody2D`, and provides an option to make `NetworkTransform` use the rigid body for motion. (#2863)
|
||||
- For a customized `NetworkRigidbodyBase` class:
|
||||
- `NetworkRigidbodyBase.AutoUpdateKinematicState` provides control on whether the kinematic setting will be automatically set or not when ownership changes.
|
||||
- `NetworkRigidbodyBase.AutoSetKinematicOnDespawn` provides control on whether isKinematic will automatically be set to true when the associated `NetworkObject` is despawned.
|
||||
- `NetworkRigidbodyBase.Initialize` is a protected method that, when invoked, will initialize the instance. This includes options to:
|
||||
- Set whether using a `RigidbodyTypes.Rigidbody` or `RigidbodyTypes.Rigidbody2D`.
|
||||
- Includes additional optional parameters to set the `NetworkTransform`, `Rigidbody`, and `Rigidbody2d` to use.
|
||||
- Provides additional public methods:
|
||||
- `NetworkRigidbodyBase.GetPosition` to return the position of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
|
||||
- `NetworkRigidbodyBase.GetRotation` to return the rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
|
||||
- `NetworkRigidbodyBase.MovePosition` to move to the position of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
|
||||
- `NetworkRigidbodyBase.MoveRotation` to move to the rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
|
||||
- `NetworkRigidbodyBase.Move` to move to the position and rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
|
||||
- `NetworkRigidbodyBase.Move` to move to the position and rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
|
||||
- `NetworkRigidbodyBase.SetPosition` to set the position of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
|
||||
- `NetworkRigidbodyBase.SetRotation` to set the rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
|
||||
- `NetworkRigidbodyBase.ApplyCurrentTransform` to set the position and rotation of the `Rigidbody` or `Rigidbody2d` based on the associated `GameObject` transform (depending upon its initialized setting).
|
||||
- `NetworkRigidbodyBase.WakeIfSleeping` to wake up the rigid body if sleeping.
|
||||
- `NetworkRigidbodyBase.SleepRigidbody` to put the rigid body to sleep.
|
||||
- `NetworkRigidbodyBase.IsKinematic` to determine if the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting) is currently kinematic.
|
||||
- `NetworkRigidbodyBase.SetIsKinematic` to set the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting) current kinematic state.
|
||||
- `NetworkRigidbodyBase.ResetInterpolation` to reset the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting) back to its original interpolation value when initialized.
|
||||
- Now includes a `MonoBehaviour.FixedUpdate` implementation that will update the assigned `NetworkTransform` when `NetworkRigidbodyBase.UseRigidBodyForMotion` is true. (#2863)
|
||||
- Added `RigidbodyContactEventManager` that provides a more optimized way to process collision enter and collision stay events as opposed to the `Monobehaviour` approach. (#2863)
|
||||
- Can be used in client-server and distributed authority modes, but is particularly useful in distributed authority.
|
||||
- Added rigid body motion updates to `NetworkTransform` which allows users to set interolation on rigid bodies. (#2863)
|
||||
- Extrapolation is only allowed on authoritative instances, but custom class derived from `NetworkRigidbodyBase` or `NetworkRigidbody` or `NetworkRigidbody2D` automatically switches non-authoritative instances to interpolation if set to extrapolation.
|
||||
- Added distributed authority mode support to `NetworkAnimator`. (#2863)
|
||||
- Added session mode selection to `NetworkManager` inspector view. (#2863)
|
||||
- Added distributed authority permissions feature. (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject` permissions flags (Distributable, Transferable, and RequestRequired). (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject.SetOwnershipStatus` method that applies one or more `NetworkObject` instance's ownership flags. If updated when spawned, the ownership permission changes are synchronized with the other connected clients. (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject.RemoveOwnershipStatus` method that removes one or more `NetworkObject` instance's ownership flags. If updated when spawned, the ownership permission changes are synchronized with the other connected clients. (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject.HasOwnershipStatus` method that will return (true or false) whether one or more ownership flags is set. (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject.SetOwnershipLock` method that locks ownership of a `NetworkObject` to prevent ownership from changing until the current owner releases the lock. (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject.RequestOwnership` method that sends an ownership request to the current owner of a spawned `NetworkObject` instance. (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject.OnOwnershipRequested` callback handler that is invoked on the owner/authoritative side when a non-owner requests ownership. Depending upon the boolean returned value depends upon whether the request is approved or denied. (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject.OnOwnershipRequestResponse` callback handler that is invoked when a non-owner's request has been processed. This callback includes a `NetworkObjet.OwnershipRequestResponseStatus` response parameter that describes whether the request was approved or the reason why it was not approved. (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject.DeferDespawn` method that defers the despawning of `NetworkObject` instances on non-authoritative clients based on the tick offset parameter. (#2863)
|
||||
- Added distributed authority mode specific `NetworkObject.OnDeferredDespawnComplete` callback handler that can be used to further control when deferring the despawning of a `NetworkObject` on non-authoritative instances. (#2863)
|
||||
- Added `NetworkClient.SessionModeType` as one way to determine the current session mode of the network session a client is connected to. (#2863)
|
||||
- Added distributed authority mode specific `NetworkClient.IsSessionOwner` property to determine if the current local client is the current session owner of a distributed authority session. (#2863)
|
||||
- Added distributed authority mode specific client side spawning capabilities. When running in distributed authority mode, clients can instantiate and spawn `NetworkObject` instances (the local client is automatically the owner of the spawned object). (#2863)
|
||||
- This is useful to better visually synchronize owner authoritative motion models and newly spawned `NetworkObject` instances (i.e. projectiles for example).
|
||||
- Added distributed authority mode specific client side player spawning capabilities. Clients will automatically spawn their associated player object locally. (#2863)
|
||||
- Added distributed authority mode specific `NetworkConfig.AutoSpawnPlayerPrefabClientSide` property (default is true) to provide control over the automatic spawning of player prefabs on the local client side. (#2863)
|
||||
- Added distributed authority mode specific `NetworkManager.OnFetchLocalPlayerPrefabToSpawn` callback that, when assigned, will allow the local client to provide the player prefab to be spawned for the local client. (#2863)
|
||||
- This is only invoked if the `NetworkConfig.AutoSpawnPlayerPrefabClientSide` property is set to true.
|
||||
- Added distributed authority mode specific `NetworkBehaviour.HasAuthority` property that determines if the local client has authority over the associated `NetworkObject` instance (typical use case is within a `NetworkBehaviour` script much like that of `IsServer` or `IsClient`). (#2863)
|
||||
- Added distributed authority mode specific `NetworkBehaviour.IsSessionOwner` property that determines if the local client is the session owner (typical use case would be to determine if the local client can has scene management authority within a `NetworkBehaviour` script). (#2863)
|
||||
- Added support for distributed authority mode scene management where the currently assigned session owner can start scene events (i.e. scene loading and scene unloading). (#2863)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where the host was not invoking `OnClientDisconnectCallback` for its own local client when internally shutting down. (#2822)
|
||||
- Fixed issue where NetworkTransform could potentially attempt to "unregister" a named message prior to it being registered. (#2807)
|
||||
- Fixed issue where in-scene placed `NetworkObject`s with complex nested children `NetworkObject`s (more than one child in depth) would not synchronize properly if WorldPositionStays was set to true. (#2796)
|
||||
|
||||
### Changed
|
||||
- Changed client side awareness of other clients is now the same as a server or host. (#2863)
|
||||
- Changed `NetworkManager.ConnectedClients` can now be accessed by both server and clients. (#2863)
|
||||
- Changed `NetworkManager.ConnectedClientsList` can now be accessed by both server and clients. (#2863)
|
||||
- Changed `NetworkTransform` defaults to owner authoritative when connected to a distributed authority session. (#2863)
|
||||
- Changed `NetworkVariable` defaults to owner write and everyone read permissions when connected to a distributed authority session (even if declared with server read or write permissions). (#2863)
|
||||
- Changed `NetworkObject` no longer implements the `MonoBehaviour.Update` method in order to determine whether a `NetworkObject` instance has been migrated to a different scene. Instead, only `NetworkObjects` with the `SceneMigrationSynchronization` property set will be updated internally during the `NetworkUpdateStage.PostLateUpdate` by `NetworkManager`. (#2863)
|
||||
- Changed `NetworkManager` inspector view layout where properties are now organized by category. (#2863)
|
||||
- Changed `NetworkTransform` to now use `NetworkTransformMessage` as opposed to named messages for NetworkTransformState updates. (#2810)
|
||||
- Changed `CustomMessageManager` so it no longer attempts to register or "unregister" a null or empty string and will log an error if this condition occurs. (#2807)
|
||||
|
||||
## [1.9.1] - 2024-04-18
|
||||
|
||||
### Added
|
||||
- Added `AnticipatedNetworkVariable<T>`, which adds support for client anticipation of NetworkVariable values, allowing for more responsive game play (#2820)
|
||||
- Added `AnticipatedNetworkTransform`, which adds support for client anticipation of `NetworkTransform`s (#2820)
|
||||
- Added `NetworkVariableBase.ExceedsDirtinessThreshold` to allow network variables to throttle updates by only sending updates when the difference between the current and previous values exceeds a threshold. (This is exposed in NetworkVariable<T> with the callback NetworkVariable<T>.CheckExceedsDirtinessThreshold) (#2820)
|
||||
- Added `NetworkVariableUpdateTraits`, which add additional throttling support: `MinSecondsBetweenUpdates` will prevent the `NetworkVariable` from sending updates more often than the specified time period (even if it exceeds the dirtiness threshold), while `MaxSecondsBetweenUpdates` will force a dirty `NetworkVariable` to send an update after the specified time period even if it has not yet exceeded the dirtiness threshold. (#2820)
|
||||
- Added virtual method `NetworkVariableBase.OnInitialize()` which can be used by `NetworkVariable` subclasses to add initialization code (#2820)
|
||||
- Added virtual method `NetworkVariableBase.Update()`, which is called once per frame to support behaviors such as interpolation between an anticipated value and an authoritative one. (#2820)
|
||||
- Added `NetworkTime.TickWithPartial`, which represents the current tick as a double that includes the fractional/partial tick value. (#2820)
|
||||
- `NetworkVariable` now includes built-in support for `NativeHashSet`, `NativeHashMap`, `List`, `HashSet`, and `Dictionary` (#2813)
|
||||
- `NetworkVariable` now includes delta compression for collection values (`NativeList`, `NativeArray`, `NativeHashSet`, `NativeHashMap`, `List`, `HashSet`, `Dictionary`, and `FixedString` types) to save bandwidth by only sending the values that changed. (Note: For `NativeList`, `NativeArray`, and `List`, this algorithm works differently than that used in `NetworkList`. This algorithm will use less bandwidth for "set" and "add" operations, but `NetworkList` is more bandwidth-efficient if you are performing frequent "insert" operations.) (#2813)
|
||||
- `UserNetworkVariableSerialization` now has optional callbacks for `WriteDelta` and `ReadDelta`. If both are provided, they will be used for all serialization operations on NetworkVariables of that type except for the first one for each client. If either is missing, the existing `Write` and `Read` will always be used. (#2813)
|
||||
- Network variables wrapping `INetworkSerializable` types can perform delta serialization by setting `UserNetworkVariableSerialization<T>.WriteDelta` and `UserNetworkVariableSerialization<T>.ReadDelta` for those types. The built-in `INetworkSerializable` serializer will continue to be used for all other serialization operations, but if those callbacks are set, it will call into them on all but the initial serialization to perform delta serialization. (This could be useful if you have a large struct where most values do not change regularly and you want to send only the fields that did change.) (#2813)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where `NetworkTransformEditor` would throw and exception if you excluded the physics package. (#2871)
|
||||
- Fixed issue where `NetworkTransform` could not properly synchronize its base position when using half float precision. (#2845)
|
||||
- Fixed issue where the host was not invoking `OnClientDisconnectCallback` for its own local client when internally shutting down. (#2822)
|
||||
- Fixed issue where NetworkTransform could potentially attempt to "unregister" a named message prior to it being registered. (#2807)
|
||||
- Fixed issue where in-scene placed `NetworkObject`s with complex nested children `NetworkObject`s (more than one child in depth) would not synchronize properly if WorldPositionStays was set to true. (#2796)
|
||||
|
||||
### Changed
|
||||
|
||||
- Changed `NetworkObjectReference` and `NetworkBehaviourReference` to allow null references when constructing and serializing. (#2874)
|
||||
- Changed `NetworkAnimator` no longer requires the `Animator` component to exist on the same `GameObject`. (#2872)
|
||||
- Changed `NetworkTransform` to now use `NetworkTransformMessage` as opposed to named messages for NetworkTransformState updates. (#2810)
|
||||
- Changed `CustomMessageManager` so it no longer attempts to register or "unregister" a null or empty string and will log an error if this condition occurs. (#2807)
|
||||
|
||||
## [1.8.1] - 2024-02-05
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed a compile error when compiling for IL2CPP targets when using the new `[Rpc]` attribute. (#2824)
|
||||
|
||||
## [1.8.0] - 2023-12-12
|
||||
|
||||
### Added
|
||||
|
||||
- Added a new RPC attribute, which is simply `Rpc`. (#2762)
|
||||
- This is a generic attribute that can perform the functions of both Server and Client RPCs, as well as enabling client-to-client RPCs. Includes several default targets: `Server`, `NotServer`, `Owner`, `NotOwner`, `Me`, `NotMe`, `ClientsAndHost`, and `Everyone`. Runtime overrides are available for any of these targets, as well as for sending to a specific ID or groups of IDs.
|
||||
- This attribute also includes the ability to defer RPCs that are sent to the local process to the start of the next frame instead of executing them immediately, treating them as if they had gone across the network. The default behavior is to execute immediately.
|
||||
- This attribute effectively replaces `ServerRpc` and `ClientRpc`. `ServerRpc` and `ClientRpc` remain in their existing forms for backward compatibility, but `Rpc` will be the recommended and most supported option.
|
||||
- Added `NetworkManager.OnConnectionEvent` as a unified connection event callback to notify clients and servers of all client connections and disconnections within the session (#2762)
|
||||
- Added `NetworkManager.ServerIsHost` and `NetworkBehaviour.ServerIsHost` to allow a client to tell if it is connected to a host or to a dedicated server (#2762)
|
||||
- Added `SceneEventProgress.SceneManagementNotEnabled` return status to be returned when a `NetworkSceneManager` method is invoked and scene management is not enabled. (#2735)
|
||||
- Added `SceneEventProgress.ServerOnlyAction` return status to be returned when a `NetworkSceneManager` method is invoked by a client. (#2735)
|
||||
- Added `NetworkObject.InstantiateAndSpawn` and `NetworkSpawnManager.InstantiateAndSpawn` methods to simplify prefab spawning by assuring that the prefab is valid and applies any override prior to instantiating the `GameObject` and spawning the `NetworkObject` instance. (#2710)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where a client disconnected by a server-host would not receive a local notification. (#2789)
|
||||
- Fixed issue where a server-host could shutdown during a relay connection but periodically the transport disconnect message sent to any connected clients could be dropped. (#2789)
|
||||
- Fixed issue where a host could disconnect its local client but remain running as a server. (#2789)
|
||||
- Fixed issue where `OnClientDisconnectedCallback` was not being invoked under certain conditions. (#2789)
|
||||
- Fixed issue where `OnClientDisconnectedCallback` was always returning 0 as the client identifier. (#2789)
|
||||
- Fixed issue where if a host or server shutdown while a client owned NetworkObjects (other than the player) it would throw an exception. (#2789)
|
||||
- Fixed issue where setting values on a `NetworkVariable` or `NetworkList` within `OnNetworkDespawn` during a shutdown sequence would throw an exception. (#2789)
|
||||
- Fixed issue where a teleport state could potentially be overridden by a previous unreliable delta state. (#2777)
|
||||
- Fixed issue where `NetworkTransform` was using the `NetworkManager.ServerTime.Tick` as opposed to `NetworkManager.NetworkTickSystem.ServerTime.Tick` during the authoritative side's tick update where it performed a delta state check. (#2777)
|
||||
- Fixed issue where a parented in-scene placed NetworkObject would be destroyed upon a client or server exiting a network session but not unloading the original scene in which the NetworkObject was placed. (#2737)
|
||||
- Fixed issue where during client synchronization and scene loading, when client synchronization or the scene loading mode are set to `LoadSceneMode.Single`, a `CreateObjectMessage` could be received, processed, and the resultant spawned `NetworkObject` could be instantiated in the client's currently active scene that could, towards the end of the client synchronization or loading process, be unloaded and cause the newly created `NetworkObject` to be destroyed (and throw and exception). (#2735)
|
||||
- Fixed issue where a `NetworkTransform` instance with interpolation enabled would result in wide visual motion gaps (stuttering) under above normal latency conditions and a 1-5% or higher packet are drop rate. (#2713)
|
||||
- Fixed issue where you could not have multiple source network prefab overrides targeting the same network prefab as their override. (#2710)
|
||||
|
||||
### Changed
|
||||
- Changed the server or host shutdown so it will now perform a "soft shutdown" when `NetworkManager.Shutdown` is invoked. This will send a disconnect notification to all connected clients and the server-host will wait for all connected clients to disconnect or timeout after a 5 second period before completing the shutdown process. (#2789)
|
||||
- Changed `OnClientDisconnectedCallback` will now return the assigned client identifier on the local client side if the client was approved and assigned one prior to being disconnected. (#2789)
|
||||
- Changed `NetworkTransform.SetState` (and related methods) now are cumulative during a fractional tick period and sent on the next pending tick. (#2777)
|
||||
- `NetworkManager.ConnectedClientsIds` is now accessible on the client side and will contain the list of all clients in the session, including the host client if the server is operating in host mode (#2762)
|
||||
- Changed `NetworkSceneManager` to return a `SceneEventProgress` status and not throw exceptions for methods invoked when scene management is disabled and when a client attempts to access a `NetworkSceneManager` method by a client. (#2735)
|
||||
- Changed `NetworkTransform` authoritative instance tick registration so a single `NetworkTransform` specific tick event update will update all authoritative instances to improve perofmance. (#2713)
|
||||
- Changed `NetworkPrefabs.OverrideToNetworkPrefab` dictionary is no longer used/populated due to it ending up being related to a regression bug and not allowing more than one override to be assigned to a network prefab asset. (#2710)
|
||||
- Changed in-scene placed `NetworkObject`s now store their source network prefab asset's `GlobalObjectIdHash` internally that is used, when scene management is disabled, by clients to spawn the correct prefab even if the `NetworkPrefab` entry has an override. This does not impact dynamically spawning the same prefab which will yield the override on both host and client. (#2710)
|
||||
- Changed in-scene placed `NetworkObject`s no longer require a `NetworkPrefab` entry with `GlobalObjectIdHash` override in order for clients to properly synchronize. (#2710)
|
||||
- Changed in-scene placed `NetworkObject`s now set their `IsSceneObject` value when generating their `GlobalObjectIdHash` value. (#2710)
|
||||
- Changed the default `NetworkConfig.SpawnTimeout` value from 1.0s to 10.0s. (#2710)
|
||||
|
||||
## [1.7.1] - 2023-11-15
|
||||
|
||||
### Added
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed a bug where having a class with Rpcs that inherits from a class without Rpcs that inherits from NetworkVariable would cause a compile error. (#2751)
|
||||
- Fixed issue where `NetworkBehaviour.Synchronize` was not truncating the write buffer if nothing was serialized during `NetworkBehaviour.OnSynchronize` causing an additional 6 bytes to be written per `NetworkBehaviour` component instance. (#2749)
|
||||
|
||||
## [1.7.0] - 2023-10-11
|
||||
|
||||
### Added
|
||||
@@ -63,7 +313,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
|
||||
### Added
|
||||
|
||||
### Fixed
|
||||
|
||||
- Bumped minimum Unity version supported to 2021.3 LTS
|
||||
- Fixed issue where `NetworkClient.OwnedObjects` was not returning any owned objects due to the `NetworkClient.IsConnected` not being properly set. (#2631)
|
||||
- Fixed a crash when calling TrySetParent with a null Transform (#2625)
|
||||
- Fixed issue where a `NetworkTransform` using full precision state updates was losing transform state updates when interpolation was enabled. (#2624)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
|
||||
#if UNITY_EDITOR
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Editor")]
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Editor.CodeGen")]
|
||||
#endif // UNITY_EDITOR
|
||||
|
||||
#if UNITY_INCLUDE_TESTS
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.RuntimeTests")]
|
||||
[assembly: InternalsVisibleTo("TestProject.RuntimeTests")]
|
||||
#if UNITY_EDITOR
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.EditorTests")]
|
||||
[assembly: InternalsVisibleTo("TestProject.EditorTests")]
|
||||
#endif // UNITY_EDITOR
|
||||
#endif // UNITY_INCLUDE_TESTS
|
||||
@@ -1,103 +0,0 @@
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
/// <summary>
|
||||
/// NetworkRigidbody allows for the use of <see cref="Rigidbody"/> on network objects. By controlling the kinematic
|
||||
/// mode of the <see cref="Rigidbody"/> and disabling it on all peers but the authoritative one.
|
||||
/// </summary>
|
||||
[RequireComponent(typeof(Rigidbody))]
|
||||
[RequireComponent(typeof(NetworkTransform))]
|
||||
[AddComponentMenu("Netcode/Network Rigidbody")]
|
||||
public class NetworkRigidbody : NetworkBehaviour
|
||||
{
|
||||
/// <summary>
|
||||
/// Determines if we are server (true) or owner (false) authoritative
|
||||
/// </summary>
|
||||
private bool m_IsServerAuthoritative;
|
||||
|
||||
private Rigidbody m_Rigidbody;
|
||||
private NetworkTransform m_NetworkTransform;
|
||||
private RigidbodyInterpolation m_OriginalInterpolation;
|
||||
|
||||
// Used to cache the authority state of this Rigidbody during the last frame
|
||||
private bool m_IsAuthority;
|
||||
|
||||
private void Awake()
|
||||
{
|
||||
m_NetworkTransform = GetComponent<NetworkTransform>();
|
||||
m_IsServerAuthoritative = m_NetworkTransform.IsServerAuthoritative();
|
||||
|
||||
m_Rigidbody = GetComponent<Rigidbody>();
|
||||
m_OriginalInterpolation = m_Rigidbody.interpolation;
|
||||
|
||||
// Set interpolation to none if NetworkTransform is handling interpolation, otherwise it sets it to the original value
|
||||
m_Rigidbody.interpolation = m_NetworkTransform.Interpolate ? RigidbodyInterpolation.None : m_OriginalInterpolation;
|
||||
|
||||
// Turn off physics for the rigid body until spawned, otherwise
|
||||
// clients can run fixed update before the first full
|
||||
// NetworkTransform update
|
||||
m_Rigidbody.isKinematic = true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// For owner authoritative (i.e. ClientNetworkTransform)
|
||||
/// we adjust our authority when we gain ownership
|
||||
/// </summary>
|
||||
public override void OnGainedOwnership()
|
||||
{
|
||||
UpdateOwnershipAuthority();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// For owner authoritative(i.e. ClientNetworkTransform)
|
||||
/// we adjust our authority when we have lost ownership
|
||||
/// </summary>
|
||||
public override void OnLostOwnership()
|
||||
{
|
||||
UpdateOwnershipAuthority();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the authority differently depending upon
|
||||
/// whether it is server or owner authoritative
|
||||
/// </summary>
|
||||
private void UpdateOwnershipAuthority()
|
||||
{
|
||||
if (m_IsServerAuthoritative)
|
||||
{
|
||||
m_IsAuthority = NetworkManager.IsServer;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_IsAuthority = IsOwner;
|
||||
}
|
||||
|
||||
// If you have authority then you are not kinematic
|
||||
m_Rigidbody.isKinematic = !m_IsAuthority;
|
||||
|
||||
// Set interpolation of the Rigidbody based on authority
|
||||
// With authority: let local transform handle interpolation
|
||||
// Without authority: let the NetworkTransform handle interpolation
|
||||
m_Rigidbody.interpolation = m_IsAuthority ? m_OriginalInterpolation : RigidbodyInterpolation.None;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public override void OnNetworkSpawn()
|
||||
{
|
||||
UpdateOwnershipAuthority();
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public override void OnNetworkDespawn()
|
||||
{
|
||||
m_Rigidbody.interpolation = m_OriginalInterpolation;
|
||||
// Turn off physics for the rigid body until spawned, otherwise
|
||||
// non-owners can run fixed updates before the first full
|
||||
// NetworkTransform update and physics will be applied (i.e. gravity, etc)
|
||||
m_Rigidbody.isKinematic = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif // COM_UNITY_MODULES_PHYSICS
|
||||
@@ -1,83 +0,0 @@
|
||||
#if COM_UNITY_MODULES_PHYSICS2D
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
/// <summary>
|
||||
/// NetworkRigidbody allows for the use of <see cref="Rigidbody2D"/> on network objects. By controlling the kinematic
|
||||
/// mode of the rigidbody and disabling it on all peers but the authoritative one.
|
||||
/// </summary>
|
||||
[RequireComponent(typeof(Rigidbody2D))]
|
||||
[RequireComponent(typeof(NetworkTransform))]
|
||||
[AddComponentMenu("Netcode/Network Rigidbody 2D")]
|
||||
public class NetworkRigidbody2D : NetworkBehaviour
|
||||
{
|
||||
private Rigidbody2D m_Rigidbody;
|
||||
private NetworkTransform m_NetworkTransform;
|
||||
|
||||
private bool m_OriginalKinematic;
|
||||
private RigidbodyInterpolation2D m_OriginalInterpolation;
|
||||
|
||||
// Used to cache the authority state of this rigidbody during the last frame
|
||||
private bool m_IsAuthority;
|
||||
|
||||
/// <summary>
|
||||
/// Gets a bool value indicating whether this <see cref="NetworkRigidbody2D"/> on this peer currently holds authority.
|
||||
/// </summary>
|
||||
private bool HasAuthority => m_NetworkTransform.CanCommitToTransform;
|
||||
|
||||
private void Awake()
|
||||
{
|
||||
m_Rigidbody = GetComponent<Rigidbody2D>();
|
||||
m_NetworkTransform = GetComponent<NetworkTransform>();
|
||||
}
|
||||
|
||||
private void FixedUpdate()
|
||||
{
|
||||
if (IsSpawned)
|
||||
{
|
||||
if (HasAuthority != m_IsAuthority)
|
||||
{
|
||||
m_IsAuthority = HasAuthority;
|
||||
UpdateRigidbodyKinematicMode();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Puts the rigidbody in a kinematic non-interpolated mode on everyone but the server.
|
||||
private void UpdateRigidbodyKinematicMode()
|
||||
{
|
||||
if (m_IsAuthority == false)
|
||||
{
|
||||
m_OriginalKinematic = m_Rigidbody.isKinematic;
|
||||
m_Rigidbody.isKinematic = true;
|
||||
|
||||
m_OriginalInterpolation = m_Rigidbody.interpolation;
|
||||
// Set interpolation to none, the NetworkTransform component interpolates the position of the object.
|
||||
m_Rigidbody.interpolation = RigidbodyInterpolation2D.None;
|
||||
}
|
||||
else
|
||||
{
|
||||
// Resets the rigidbody back to it's non replication only state. Happens on shutdown and when authority is lost
|
||||
m_Rigidbody.isKinematic = m_OriginalKinematic;
|
||||
m_Rigidbody.interpolation = m_OriginalInterpolation;
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public override void OnNetworkSpawn()
|
||||
{
|
||||
m_IsAuthority = HasAuthority;
|
||||
m_OriginalKinematic = m_Rigidbody.isKinematic;
|
||||
m_OriginalInterpolation = m_Rigidbody.interpolation;
|
||||
UpdateRigidbodyKinematicMode();
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public override void OnNetworkDespawn()
|
||||
{
|
||||
UpdateRigidbodyKinematicMode();
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif // COM_UNITY_MODULES_PHYSICS2D
|
||||
@@ -1,27 +0,0 @@
|
||||
{
|
||||
"name": "Unity.Netcode.Components",
|
||||
"rootNamespace": "Unity.Netcode.Components",
|
||||
"references": [
|
||||
"Unity.Netcode.Runtime",
|
||||
"Unity.Collections",
|
||||
"Unity.Mathematics"
|
||||
],
|
||||
"allowUnsafeCode": true,
|
||||
"versionDefines": [
|
||||
{
|
||||
"name": "com.unity.modules.animation",
|
||||
"expression": "",
|
||||
"define": "COM_UNITY_MODULES_ANIMATION"
|
||||
},
|
||||
{
|
||||
"name": "com.unity.modules.physics",
|
||||
"expression": "",
|
||||
"define": "COM_UNITY_MODULES_PHYSICS"
|
||||
},
|
||||
{
|
||||
"name": "com.unity.modules.physics2d",
|
||||
"expression": "",
|
||||
"define": "COM_UNITY_MODULES_PHYSICS2D"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -9,14 +9,14 @@ See guides below to install Unity Netcode for GameObjects, set up your project,
|
||||
- [Documentation](https://docs-multiplayer.unity3d.com/netcode/current/about)
|
||||
- [Installation](https://docs-multiplayer.unity3d.com/netcode/current/installation)
|
||||
- [First Steps](https://docs-multiplayer.unity3d.com/netcode/current/tutorials/get-started-ngo)
|
||||
- [API Reference](https://docs-multiplayer.unity3d.com/netcode/current/api/introduction)
|
||||
- [API Reference](https://docs.unity3d.com/Packages/com.unity.netcode.gameobjects@1.6/api/index.html)
|
||||
|
||||
# Technical details
|
||||
|
||||
## Requirements
|
||||
|
||||
Netcode for GameObjects targets the following Unity versions:
|
||||
- Unity 2020.3, 2021.1, 2021.2 and 2021.3
|
||||
- Unity 2021.3 (LTS), 2022.3 (LTS) and 2023.2
|
||||
|
||||
On the following runtime platforms:
|
||||
- Windows, MacOS, and Linux
|
||||
|
||||
@@ -21,13 +21,16 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
public const string NetcodeModuleName = "Unity.Netcode.Runtime.dll";
|
||||
|
||||
public const string RuntimeAssemblyName = "Unity.Netcode.Runtime";
|
||||
public const string ComponentsAssemblyName = "Unity.Netcode.Components";
|
||||
|
||||
public static readonly string NetworkBehaviour_FullName = typeof(NetworkBehaviour).FullName;
|
||||
public static readonly string INetworkMessage_FullName = typeof(INetworkMessage).FullName;
|
||||
public static readonly string ServerRpcAttribute_FullName = typeof(ServerRpcAttribute).FullName;
|
||||
public static readonly string ClientRpcAttribute_FullName = typeof(ClientRpcAttribute).FullName;
|
||||
public static readonly string RpcAttribute_FullName = typeof(RpcAttribute).FullName;
|
||||
public static readonly string ServerRpcParams_FullName = typeof(ServerRpcParams).FullName;
|
||||
public static readonly string ClientRpcParams_FullName = typeof(ClientRpcParams).FullName;
|
||||
public static readonly string RpcParams_FullName = typeof(RpcParams).FullName;
|
||||
public static readonly string ClientRpcSendParams_FullName = typeof(ClientRpcSendParams).FullName;
|
||||
public static readonly string ClientRpcReceiveParams_FullName = typeof(ClientRpcReceiveParams).FullName;
|
||||
public static readonly string ServerRpcSendParams_FullName = typeof(ServerRpcSendParams).FullName;
|
||||
|
||||
@@ -17,7 +17,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
{
|
||||
public override ILPPInterface GetInstance() => this;
|
||||
|
||||
public override bool WillProcess(ICompiledAssembly compiledAssembly) => compiledAssembly.Name == CodeGenHelpers.RuntimeAssemblyName;
|
||||
public override bool WillProcess(ICompiledAssembly compiledAssembly) => compiledAssembly.Name == CodeGenHelpers.RuntimeAssemblyName || compiledAssembly.Name == CodeGenHelpers.ComponentsAssemblyName;
|
||||
|
||||
private readonly List<DiagnosticMessage> m_Diagnostics = new List<DiagnosticMessage>();
|
||||
|
||||
|
||||
@@ -27,10 +27,48 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
|
||||
public override ILPPInterface GetInstance() => this;
|
||||
|
||||
public override bool WillProcess(ICompiledAssembly compiledAssembly) => compiledAssembly.References.Any(filePath => Path.GetFileNameWithoutExtension(filePath) == CodeGenHelpers.RuntimeAssemblyName);
|
||||
public override bool WillProcess(ICompiledAssembly compiledAssembly) => compiledAssembly.Name == CodeGenHelpers.RuntimeAssemblyName ||
|
||||
compiledAssembly.References.Any(filePath => Path.GetFileNameWithoutExtension(filePath) == CodeGenHelpers.RuntimeAssemblyName);
|
||||
|
||||
private readonly List<DiagnosticMessage> m_Diagnostics = new List<DiagnosticMessage>();
|
||||
|
||||
public void AddWrappedType(TypeReference wrappedType)
|
||||
{
|
||||
if (!m_WrappedNetworkVariableTypes.Contains(wrappedType))
|
||||
{
|
||||
m_WrappedNetworkVariableTypes.Add(wrappedType);
|
||||
|
||||
var resolved = wrappedType.Resolve();
|
||||
if (resolved != null)
|
||||
{
|
||||
if (resolved.FullName == "System.Collections.Generic.List`1")
|
||||
{
|
||||
AddWrappedType(((GenericInstanceType)wrappedType).GenericArguments[0]);
|
||||
}
|
||||
if (resolved.FullName == "System.Collections.Generic.HashSet`1")
|
||||
{
|
||||
AddWrappedType(((GenericInstanceType)wrappedType).GenericArguments[0]);
|
||||
}
|
||||
else if (resolved.FullName == "System.Collections.Generic.Dictionary`2")
|
||||
{
|
||||
AddWrappedType(((GenericInstanceType)wrappedType).GenericArguments[0]);
|
||||
AddWrappedType(((GenericInstanceType)wrappedType).GenericArguments[1]);
|
||||
}
|
||||
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
||||
else if (resolved.FullName == "Unity.Collections.NativeHashSet`1")
|
||||
{
|
||||
AddWrappedType(((GenericInstanceType)wrappedType).GenericArguments[0]);
|
||||
}
|
||||
else if (resolved.FullName == "Unity.Collections.NativeHashMap`2")
|
||||
{
|
||||
AddWrappedType(((GenericInstanceType)wrappedType).GenericArguments[0]);
|
||||
AddWrappedType(((GenericInstanceType)wrappedType).GenericArguments[1]);
|
||||
}
|
||||
#endif
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public override ILPostProcessResult Process(ICompiledAssembly compiledAssembly)
|
||||
{
|
||||
if (!WillProcess(compiledAssembly))
|
||||
@@ -87,10 +125,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
if (attribute.AttributeType.Name == nameof(GenerateSerializationForTypeAttribute))
|
||||
{
|
||||
var wrappedType = mainModule.ImportReference((TypeReference)attribute.ConstructorArguments[0].Value);
|
||||
if (!m_WrappedNetworkVariableTypes.Contains(wrappedType))
|
||||
{
|
||||
m_WrappedNetworkVariableTypes.Add(wrappedType);
|
||||
}
|
||||
AddWrappedType(wrappedType);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -101,10 +136,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
if (attribute.AttributeType.Name == nameof(GenerateSerializationForTypeAttribute))
|
||||
{
|
||||
var wrappedType = mainModule.ImportReference((TypeReference)attribute.ConstructorArguments[0].Value);
|
||||
if (!m_WrappedNetworkVariableTypes.Contains(wrappedType))
|
||||
{
|
||||
m_WrappedNetworkVariableTypes.Add(wrappedType);
|
||||
}
|
||||
AddWrappedType(wrappedType);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -241,6 +273,36 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
serializeMethod?.GenericArguments.Add(wrappedType);
|
||||
equalityMethod.GenericArguments.Add(wrappedType);
|
||||
}
|
||||
else if (type.Resolve().FullName == "System.Collections.Generic.List`1")
|
||||
{
|
||||
var wrappedType = ((GenericInstanceType)type).GenericArguments[0];
|
||||
serializeMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeSerializer_List_MethodRef);
|
||||
|
||||
equalityMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeEqualityChecker_List_MethodRef);
|
||||
serializeMethod.GenericArguments.Add(wrappedType);
|
||||
equalityMethod.GenericArguments.Add(wrappedType);
|
||||
}
|
||||
else if (type.Resolve().FullName == "System.Collections.Generic.HashSet`1")
|
||||
{
|
||||
var wrappedType = ((GenericInstanceType)type).GenericArguments[0];
|
||||
serializeMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeSerializer_HashSet_MethodRef);
|
||||
|
||||
equalityMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeEqualityChecker_HashSet_MethodRef);
|
||||
serializeMethod.GenericArguments.Add(wrappedType);
|
||||
equalityMethod.GenericArguments.Add(wrappedType);
|
||||
}
|
||||
else if (type.Resolve().FullName == "System.Collections.Generic.Dictionary`2")
|
||||
{
|
||||
var wrappedKeyType = ((GenericInstanceType)type).GenericArguments[0];
|
||||
var wrappedValType = ((GenericInstanceType)type).GenericArguments[1];
|
||||
serializeMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeSerializer_Dictionary_MethodRef);
|
||||
|
||||
equalityMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeEqualityChecker_Dictionary_MethodRef);
|
||||
serializeMethod.GenericArguments.Add(wrappedKeyType);
|
||||
serializeMethod.GenericArguments.Add(wrappedValType);
|
||||
equalityMethod.GenericArguments.Add(wrappedKeyType);
|
||||
equalityMethod.GenericArguments.Add(wrappedValType);
|
||||
}
|
||||
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
||||
else if (type.Resolve().FullName == "Unity.Collections.NativeList`1")
|
||||
{
|
||||
@@ -267,12 +329,30 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
equalityMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeEqualityChecker_UnmanagedValueEqualsList_MethodRef);
|
||||
}
|
||||
|
||||
if (serializeMethod != null)
|
||||
{
|
||||
serializeMethod.GenericArguments.Add(wrappedType);
|
||||
}
|
||||
serializeMethod?.GenericArguments.Add(wrappedType);
|
||||
equalityMethod.GenericArguments.Add(wrappedType);
|
||||
}
|
||||
else if (type.Resolve().FullName == "Unity.Collections.NativeHashSet`1")
|
||||
{
|
||||
var wrappedType = ((GenericInstanceType)type).GenericArguments[0];
|
||||
serializeMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeSerializer_NativeHashSet_MethodRef);
|
||||
|
||||
equalityMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeEqualityChecker_NativeHashSet_MethodRef);
|
||||
serializeMethod.GenericArguments.Add(wrappedType);
|
||||
equalityMethod.GenericArguments.Add(wrappedType);
|
||||
}
|
||||
else if (type.Resolve().FullName == "Unity.Collections.NativeHashMap`2")
|
||||
{
|
||||
var wrappedKeyType = ((GenericInstanceType)type).GenericArguments[0];
|
||||
var wrappedValType = ((GenericInstanceType)type).GenericArguments[1];
|
||||
serializeMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeSerializer_NativeHashMap_MethodRef);
|
||||
|
||||
equalityMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeEqualityChecker_NativeHashMap_MethodRef);
|
||||
serializeMethod.GenericArguments.Add(wrappedKeyType);
|
||||
serializeMethod.GenericArguments.Add(wrappedValType);
|
||||
equalityMethod.GenericArguments.Add(wrappedKeyType);
|
||||
equalityMethod.GenericArguments.Add(wrappedValType);
|
||||
}
|
||||
#endif
|
||||
else if (type.IsValueType)
|
||||
{
|
||||
@@ -329,6 +409,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Diagnostics.AddError($"{type}: Managed type in NetworkVariable must implement IEquatable<{type}>");
|
||||
equalityMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeEqualityChecker_ManagedClassEquals_MethodRef);
|
||||
}
|
||||
|
||||
@@ -363,11 +444,14 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
private FieldReference m_NetworkManager_LogLevel_FieldRef;
|
||||
private MethodReference m_NetworkBehaviour___registerRpc_MethodRef;
|
||||
private TypeReference m_NetworkBehaviour_TypeRef;
|
||||
private TypeReference m_AttributeParamsType_TypeRef;
|
||||
private TypeReference m_NetworkVariableBase_TypeRef;
|
||||
private MethodReference m_NetworkVariableBase_Initialize_MethodRef;
|
||||
private MethodReference m_NetworkBehaviour___nameNetworkVariable_MethodRef;
|
||||
private MethodReference m_NetworkBehaviour_beginSendServerRpc_MethodRef;
|
||||
private MethodReference m_NetworkBehaviour_endSendServerRpc_MethodRef;
|
||||
private MethodReference m_NetworkBehaviour_beginSendRpc_MethodRef;
|
||||
private MethodReference m_NetworkBehaviour_endSendRpc_MethodRef;
|
||||
private MethodReference m_NetworkBehaviour_beginSendClientRpc_MethodRef;
|
||||
private MethodReference m_NetworkBehaviour_endSendClientRpc_MethodRef;
|
||||
private FieldReference m_NetworkBehaviour_rpc_exec_stage_FieldRef;
|
||||
@@ -378,9 +462,13 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
private TypeReference m_RpcParams_TypeRef;
|
||||
private FieldReference m_RpcParams_Server_FieldRef;
|
||||
private FieldReference m_RpcParams_Client_FieldRef;
|
||||
private FieldReference m_RpcParams_Ext_FieldRef;
|
||||
private TypeReference m_ServerRpcParams_TypeRef;
|
||||
private FieldReference m_ServerRpcParams_Receive_FieldRef;
|
||||
private FieldReference m_ServerRpcParams_Receive_SenderClientId_FieldRef;
|
||||
private FieldReference m_UniversalRpcParams_Receive_FieldRef;
|
||||
private FieldReference m_UniversalRpcParams_Receive_SenderClientId_FieldRef;
|
||||
private TypeReference m_UniversalRpcParams_TypeRef;
|
||||
private TypeReference m_ClientRpcParams_TypeRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedByMemcpy_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedByMemcpyArray_MethodRef;
|
||||
@@ -391,7 +479,12 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedINetworkSerializableArray_MethodRef;
|
||||
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedINetworkSerializableList_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_NativeHashSet_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_NativeHashMap_MethodRef;
|
||||
#endif
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_List_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_HashSet_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_Dictionary_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_ManagedINetworkSerializable_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_FixedString_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_FixedStringArray_MethodRef;
|
||||
@@ -408,7 +501,12 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeEqualityChecker_UnmanagedValueEqualsArray_MethodRef;
|
||||
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeEqualityChecker_UnmanagedValueEqualsList_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeEqualityChecker_NativeHashSet_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeEqualityChecker_NativeHashMap_MethodRef;
|
||||
#endif
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeEqualityChecker_List_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeEqualityChecker_HashSet_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeEqualityChecker_Dictionary_MethodRef;
|
||||
private MethodReference m_NetworkVariableSerializationTypes_InitializeEqualityChecker_ManagedClassEquals_MethodRef;
|
||||
|
||||
private MethodReference m_RuntimeInitializeOnLoadAttribute_Ctor;
|
||||
@@ -495,6 +593,8 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
private const string k_NetworkBehaviour_NetworkVariableFields = nameof(NetworkBehaviour.NetworkVariableFields);
|
||||
private const string k_NetworkBehaviour_beginSendServerRpc = nameof(NetworkBehaviour.__beginSendServerRpc);
|
||||
private const string k_NetworkBehaviour_endSendServerRpc = nameof(NetworkBehaviour.__endSendServerRpc);
|
||||
private const string k_NetworkBehaviour_beginSendRpc = nameof(NetworkBehaviour.__beginSendRpc);
|
||||
private const string k_NetworkBehaviour_endSendRpc = nameof(NetworkBehaviour.__endSendRpc);
|
||||
private const string k_NetworkBehaviour_beginSendClientRpc = nameof(NetworkBehaviour.__beginSendClientRpc);
|
||||
private const string k_NetworkBehaviour_endSendClientRpc = nameof(NetworkBehaviour.__endSendClientRpc);
|
||||
private const string k_NetworkBehaviour___initializeVariables = nameof(NetworkBehaviour.__initializeVariables);
|
||||
@@ -511,8 +611,11 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
private const string k_ServerRpcAttribute_RequireOwnership = nameof(ServerRpcAttribute.RequireOwnership);
|
||||
private const string k_RpcParams_Server = nameof(__RpcParams.Server);
|
||||
private const string k_RpcParams_Client = nameof(__RpcParams.Client);
|
||||
private const string k_RpcParams_Ext = nameof(__RpcParams.Ext);
|
||||
private const string k_ServerRpcParams_Receive = nameof(ServerRpcParams.Receive);
|
||||
private const string k_RpcParams_Receive = nameof(RpcParams.Receive);
|
||||
private const string k_ServerRpcReceiveParams_SenderClientId = nameof(ServerRpcReceiveParams.SenderClientId);
|
||||
private const string k_RpcReceiveParams_SenderClientId = nameof(RpcReceiveParams.SenderClientId);
|
||||
|
||||
// CodeGen cannot reference the collections assembly to do a typeof() on it due to a bug that causes that to crash.
|
||||
private const string k_INativeListBool_FullName = "Unity.Collections.INativeList`1<System.Byte>";
|
||||
@@ -545,13 +648,20 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
TypeDefinition rpcParamsTypeDef = null;
|
||||
TypeDefinition serverRpcParamsTypeDef = null;
|
||||
TypeDefinition clientRpcParamsTypeDef = null;
|
||||
TypeDefinition universalRpcParamsTypeDef = null;
|
||||
TypeDefinition fastBufferWriterTypeDef = null;
|
||||
TypeDefinition fastBufferReaderTypeDef = null;
|
||||
TypeDefinition networkVariableSerializationTypesTypeDef = null;
|
||||
TypeDefinition bytePackerTypeDef = null;
|
||||
TypeDefinition byteUnpackerTypeDef = null;
|
||||
TypeDefinition attributeParamsType = null;
|
||||
foreach (var netcodeTypeDef in m_NetcodeModule.GetAllTypes())
|
||||
{
|
||||
if (attributeParamsType == null && netcodeTypeDef.Name == nameof(RpcAttribute.RpcAttributeParams))
|
||||
{
|
||||
attributeParamsType = netcodeTypeDef;
|
||||
continue;
|
||||
}
|
||||
if (networkManagerTypeDef == null && netcodeTypeDef.Name == nameof(NetworkManager))
|
||||
{
|
||||
networkManagerTypeDef = netcodeTypeDef;
|
||||
@@ -588,6 +698,12 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
continue;
|
||||
}
|
||||
|
||||
if (universalRpcParamsTypeDef == null && netcodeTypeDef.Name == nameof(RpcParams))
|
||||
{
|
||||
universalRpcParamsTypeDef = netcodeTypeDef;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (clientRpcParamsTypeDef == null && netcodeTypeDef.Name == nameof(ClientRpcParams))
|
||||
{
|
||||
clientRpcParamsTypeDef = netcodeTypeDef;
|
||||
@@ -606,7 +722,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
continue;
|
||||
}
|
||||
|
||||
if (networkVariableSerializationTypesTypeDef == null && netcodeTypeDef.Name == nameof(NetworkVariableSerializationTypes))
|
||||
if (networkVariableSerializationTypesTypeDef == null && netcodeTypeDef.Name == nameof(NetworkVariableSerializationTypedInitializers))
|
||||
{
|
||||
networkVariableSerializationTypesTypeDef = netcodeTypeDef;
|
||||
continue;
|
||||
@@ -662,6 +778,8 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
}
|
||||
}
|
||||
|
||||
m_AttributeParamsType_TypeRef = moduleDefinition.ImportReference(attributeParamsType);
|
||||
|
||||
foreach (var fieldDef in networkManagerTypeDef.Fields)
|
||||
{
|
||||
switch (fieldDef.Name)
|
||||
@@ -696,6 +814,12 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
case k_NetworkBehaviour_endSendServerRpc:
|
||||
m_NetworkBehaviour_endSendServerRpc_MethodRef = moduleDefinition.ImportReference(methodDef);
|
||||
break;
|
||||
case k_NetworkBehaviour_beginSendRpc:
|
||||
m_NetworkBehaviour_beginSendRpc_MethodRef = moduleDefinition.ImportReference(methodDef);
|
||||
break;
|
||||
case k_NetworkBehaviour_endSendRpc:
|
||||
m_NetworkBehaviour_endSendRpc_MethodRef = moduleDefinition.ImportReference(methodDef);
|
||||
break;
|
||||
case k_NetworkBehaviour_beginSendClientRpc:
|
||||
m_NetworkBehaviour_beginSendClientRpc_MethodRef = moduleDefinition.ImportReference(methodDef);
|
||||
break;
|
||||
@@ -763,6 +887,9 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
case k_RpcParams_Client:
|
||||
m_RpcParams_Client_FieldRef = moduleDefinition.ImportReference(fieldDef);
|
||||
break;
|
||||
case k_RpcParams_Ext:
|
||||
m_RpcParams_Ext_FieldRef = moduleDefinition.ImportReference(fieldDef);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -786,6 +913,26 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
break;
|
||||
}
|
||||
}
|
||||
m_UniversalRpcParams_TypeRef = moduleDefinition.ImportReference(universalRpcParamsTypeDef);
|
||||
foreach (var fieldDef in rpcParamsTypeDef.Fields)
|
||||
{
|
||||
switch (fieldDef.Name)
|
||||
{
|
||||
case k_RpcParams_Receive:
|
||||
foreach (var recvFieldDef in fieldDef.FieldType.Resolve().Fields)
|
||||
{
|
||||
switch (recvFieldDef.Name)
|
||||
{
|
||||
case k_RpcReceiveParams_SenderClientId:
|
||||
m_UniversalRpcParams_Receive_SenderClientId_FieldRef = moduleDefinition.ImportReference(recvFieldDef);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
m_UniversalRpcParams_Receive_FieldRef = moduleDefinition.ImportReference(fieldDef);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
m_ClientRpcParams_TypeRef = moduleDefinition.ImportReference(clientRpcParamsTypeDef);
|
||||
m_FastBufferWriter_TypeRef = moduleDefinition.ImportReference(fastBufferWriterTypeDef);
|
||||
@@ -861,73 +1008,103 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
|
||||
switch (method.Name)
|
||||
{
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_UnmanagedByMemcpy):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_UnmanagedByMemcpy):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedByMemcpy_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_UnmanagedByMemcpyArray):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_UnmanagedByMemcpyArray):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedByMemcpyArray_MethodRef = method;
|
||||
break;
|
||||
|
||||
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_UnmanagedByMemcpyList):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_UnmanagedByMemcpyList):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedByMemcpyList_MethodRef = method;
|
||||
break;
|
||||
#endif
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_UnmanagedINetworkSerializable):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_UnmanagedINetworkSerializable):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedINetworkSerializable_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_UnmanagedINetworkSerializableArray):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_UnmanagedINetworkSerializableArray):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedINetworkSerializableArray_MethodRef = method;
|
||||
break;
|
||||
|
||||
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_UnmanagedINetworkSerializableList):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_UnmanagedINetworkSerializableList):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedINetworkSerializableList_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_NativeHashSet):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_NativeHashSet_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_NativeHashMap):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_NativeHashMap_MethodRef = method;
|
||||
break;
|
||||
#endif
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_ManagedINetworkSerializable):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_List):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_List_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_HashSet):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_HashSet_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_Dictionary):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_Dictionary_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_ManagedINetworkSerializable):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_ManagedINetworkSerializable_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_FixedString):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_FixedString):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_FixedString_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_FixedStringArray):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_FixedStringArray):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_FixedStringArray_MethodRef = method;
|
||||
break;
|
||||
|
||||
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeSerializer_FixedStringList):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeSerializer_FixedStringList):
|
||||
m_NetworkVariableSerializationTypes_InitializeSerializer_FixedStringList_MethodRef = method;
|
||||
break;
|
||||
#endif
|
||||
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeEqualityChecker_ManagedIEquatable):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_ManagedIEquatable):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_ManagedIEquatable_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeEqualityChecker_UnmanagedIEquatable):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_UnmanagedIEquatable):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_UnmanagedIEquatable_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeEqualityChecker_UnmanagedIEquatableArray):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_UnmanagedIEquatableArray):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_UnmanagedIEquatableArray_MethodRef = method;
|
||||
break;
|
||||
|
||||
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeEqualityChecker_UnmanagedIEquatableList):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_UnmanagedIEquatableList):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_UnmanagedIEquatableList_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_NativeHashSet):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_NativeHashSet_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_NativeHashMap):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_NativeHashMap_MethodRef = method;
|
||||
break;
|
||||
#endif
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeEqualityChecker_UnmanagedValueEquals):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_List):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_List_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_HashSet):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_HashSet_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_Dictionary):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_Dictionary_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_UnmanagedValueEquals):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_UnmanagedValueEquals_MethodRef = method;
|
||||
break;
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeEqualityChecker_UnmanagedValueEqualsArray):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_UnmanagedValueEqualsArray):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_UnmanagedValueEqualsArray_MethodRef = method;
|
||||
break;
|
||||
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeEqualityChecker_UnmanagedValueEqualsList):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_UnmanagedValueEqualsList):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_UnmanagedValueEqualsList_MethodRef = method;
|
||||
break;
|
||||
#endif
|
||||
case nameof(NetworkVariableSerializationTypes.InitializeEqualityChecker_ManagedClassEquals):
|
||||
case nameof(NetworkVariableSerializationTypedInitializers.InitializeEqualityChecker_ManagedClassEquals):
|
||||
m_NetworkVariableSerializationTypes_InitializeEqualityChecker_ManagedClassEquals_MethodRef = method;
|
||||
break;
|
||||
}
|
||||
@@ -1190,10 +1367,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
continue;
|
||||
}
|
||||
var wrappedType = genericInstanceType.GenericArguments[idx];
|
||||
if (!m_WrappedNetworkVariableTypes.Contains(wrappedType))
|
||||
{
|
||||
m_WrappedNetworkVariableTypes.Add(wrappedType);
|
||||
}
|
||||
AddWrappedType(wrappedType);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1226,10 +1400,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
continue;
|
||||
}
|
||||
var wrappedType = genericInstanceType.GenericArguments[idx];
|
||||
if (!m_WrappedNetworkVariableTypes.Contains(wrappedType))
|
||||
{
|
||||
m_WrappedNetworkVariableTypes.Add(wrappedType);
|
||||
}
|
||||
AddWrappedType(wrappedType);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1237,8 +1408,10 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
}
|
||||
}
|
||||
|
||||
if (rpcHandlers.Count > 0)
|
||||
//if (rpcHandlers.Count > 0)
|
||||
{
|
||||
|
||||
// This always needs to generate even if it's empty.
|
||||
var initializeRpcsMethodDef = new MethodDefinition(
|
||||
k_NetworkBehaviour___initializeRpcs,
|
||||
MethodAttributes.Family | MethodAttributes.Virtual | MethodAttributes.HideBySig,
|
||||
@@ -1352,7 +1525,8 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
var customAttributeType_FullName = customAttribute.AttributeType.FullName;
|
||||
|
||||
if (customAttributeType_FullName == CodeGenHelpers.ServerRpcAttribute_FullName ||
|
||||
customAttributeType_FullName == CodeGenHelpers.ClientRpcAttribute_FullName)
|
||||
customAttributeType_FullName == CodeGenHelpers.ClientRpcAttribute_FullName ||
|
||||
customAttributeType_FullName == CodeGenHelpers.RpcAttribute_FullName)
|
||||
{
|
||||
bool isValid = true;
|
||||
|
||||
@@ -1387,6 +1561,13 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
isValid = false;
|
||||
}
|
||||
|
||||
if (customAttributeType_FullName == CodeGenHelpers.RpcAttribute_FullName &&
|
||||
!methodDefinition.Name.EndsWith("Rpc", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
m_Diagnostics.AddError(methodDefinition, "Rpc method must end with 'Rpc' suffix!");
|
||||
isValid = false;
|
||||
}
|
||||
|
||||
if (customAttributeType_FullName == CodeGenHelpers.ClientRpcAttribute_FullName &&
|
||||
!methodDefinition.Name.EndsWith("ClientRpc", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
@@ -1409,11 +1590,15 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
{
|
||||
if (methodDefinition.Name.EndsWith("ServerRpc", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
m_Diagnostics.AddError(methodDefinition, "ServerRpc method must be marked with 'ServerRpc' attribute!");
|
||||
m_Diagnostics.AddError(methodDefinition, $"ServerRpc method {methodDefinition} must be marked with 'ServerRpc' attribute!");
|
||||
}
|
||||
else if (methodDefinition.Name.EndsWith("ClientRpc", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
m_Diagnostics.AddError(methodDefinition, "ClientRpc method must be marked with 'ClientRpc' attribute!");
|
||||
m_Diagnostics.AddError(methodDefinition, $"ClientRpc method {methodDefinition} must be marked with 'ClientRpc' attribute!");
|
||||
}
|
||||
else if (methodDefinition.Name.EndsWith("ExtRpc", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
m_Diagnostics.AddError(methodDefinition, $"Ext Rpc method {methodDefinition} must be marked with 'ExtRpc' attribute!");
|
||||
}
|
||||
|
||||
return null;
|
||||
@@ -1885,8 +2070,17 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
var instructions = new List<Instruction>();
|
||||
var processor = methodDefinition.Body.GetILProcessor();
|
||||
var isServerRpc = rpcAttribute.AttributeType.FullName == CodeGenHelpers.ServerRpcAttribute_FullName;
|
||||
var isClientRpc = rpcAttribute.AttributeType.FullName == CodeGenHelpers.ClientRpcAttribute_FullName;
|
||||
var isGenericRpc = rpcAttribute.AttributeType.FullName == CodeGenHelpers.RpcAttribute_FullName;
|
||||
var requireOwnership = true; // default value MUST be == `ServerRpcAttribute.RequireOwnership`
|
||||
var rpcDelivery = RpcDelivery.Reliable; // default value MUST be == `RpcAttribute.Delivery`
|
||||
var defaultTarget = SendTo.Everyone;
|
||||
var allowTargetOverride = false;
|
||||
|
||||
if (isGenericRpc)
|
||||
{
|
||||
defaultTarget = (SendTo)rpcAttribute.ConstructorArguments[0].Value;
|
||||
}
|
||||
foreach (var attrField in rpcAttribute.Fields)
|
||||
{
|
||||
switch (attrField.Name)
|
||||
@@ -1897,6 +2091,9 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
case k_ServerRpcAttribute_RequireOwnership:
|
||||
requireOwnership = attrField.Argument.Type == typeSystem.Boolean && (bool)attrField.Argument.Value;
|
||||
break;
|
||||
case nameof(RpcAttribute.AllowTargetOverride):
|
||||
allowTargetOverride = attrField.Argument.Type == typeSystem.Boolean && (bool)attrField.Argument.Value;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1904,7 +2101,33 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
var hasRpcParams =
|
||||
paramCount > 0 &&
|
||||
((isServerRpc && methodDefinition.Parameters[paramCount - 1].ParameterType.FullName == CodeGenHelpers.ServerRpcParams_FullName) ||
|
||||
(!isServerRpc && methodDefinition.Parameters[paramCount - 1].ParameterType.FullName == CodeGenHelpers.ClientRpcParams_FullName));
|
||||
(isClientRpc && methodDefinition.Parameters[paramCount - 1].ParameterType.FullName == CodeGenHelpers.ClientRpcParams_FullName) ||
|
||||
(isGenericRpc && methodDefinition.Parameters[paramCount - 1].ParameterType.FullName == CodeGenHelpers.RpcParams_FullName));
|
||||
|
||||
if (isGenericRpc && defaultTarget == SendTo.SpecifiedInParams)
|
||||
{
|
||||
if (!hasRpcParams)
|
||||
{
|
||||
m_Diagnostics.AddError($"{methodDefinition}: {nameof(SendTo)}.{nameof(SendTo.SpecifiedInParams)} cannot be used without a final parameter of type {CodeGenHelpers.RpcParams_FullName}.");
|
||||
}
|
||||
|
||||
foreach (var attrField in rpcAttribute.Fields)
|
||||
{
|
||||
switch (attrField.Name)
|
||||
{
|
||||
case nameof(RpcAttribute.AllowTargetOverride):
|
||||
m_Diagnostics.AddWarning($"{methodDefinition}: {nameof(RpcAttribute.AllowTargetOverride)} is ignored with {nameof(SendTo)}.{nameof(SendTo.SpecifiedInParams)}");
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (isGenericRpc && allowTargetOverride)
|
||||
{
|
||||
if (!hasRpcParams)
|
||||
{
|
||||
m_Diagnostics.AddError($"{methodDefinition}: {nameof(RpcAttribute.AllowTargetOverride)} cannot be used without a final parameter of type {CodeGenHelpers.RpcParams_FullName}.");
|
||||
}
|
||||
}
|
||||
|
||||
methodDefinition.Body.InitLocals = true;
|
||||
// NetworkManager networkManager;
|
||||
@@ -1917,10 +2140,17 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
// XXXRpcParams
|
||||
if (!hasRpcParams)
|
||||
{
|
||||
methodDefinition.Body.Variables.Add(new VariableDefinition(isServerRpc ? m_ServerRpcParams_TypeRef : m_ClientRpcParams_TypeRef));
|
||||
methodDefinition.Body.Variables.Add(new VariableDefinition(isServerRpc ? m_ServerRpcParams_TypeRef : (isClientRpc ? m_ClientRpcParams_TypeRef : m_UniversalRpcParams_TypeRef)));
|
||||
}
|
||||
int rpcParamsIdx = !hasRpcParams ? methodDefinition.Body.Variables.Count - 1 : -1;
|
||||
|
||||
if (isGenericRpc)
|
||||
{
|
||||
methodDefinition.Body.Variables.Add(new VariableDefinition(m_AttributeParamsType_TypeRef));
|
||||
}
|
||||
|
||||
int rpcAttributeParamsIdx = isGenericRpc ? methodDefinition.Body.Variables.Count - 1 : -1;
|
||||
|
||||
{
|
||||
var returnInstr = processor.Create(OpCodes.Ret);
|
||||
var lastInstr = processor.Create(OpCodes.Nop);
|
||||
@@ -1950,20 +2180,23 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
// if (__rpc_exec_stage != __RpcExecStage.Client) -> ClientRpc
|
||||
instructions.Add(processor.Create(OpCodes.Ldarg_0));
|
||||
instructions.Add(processor.Create(OpCodes.Ldfld, m_NetworkBehaviour_rpc_exec_stage_FieldRef));
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)(isServerRpc ? NetworkBehaviour.__RpcExecStage.Server : NetworkBehaviour.__RpcExecStage.Client)));
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)NetworkBehaviour.__RpcExecStage.Execute));
|
||||
instructions.Add(processor.Create(OpCodes.Ceq));
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, 0));
|
||||
instructions.Add(processor.Create(OpCodes.Ceq));
|
||||
instructions.Add(processor.Create(OpCodes.Brfalse, lastInstr));
|
||||
|
||||
// if (networkManager.IsClient || networkManager.IsHost) { ... } -> ServerRpc
|
||||
// if (networkManager.IsServer || networkManager.IsHost) { ... } -> ClientRpc
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, netManLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Callvirt, isServerRpc ? m_NetworkManager_getIsClient_MethodRef : m_NetworkManager_getIsServer_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Brtrue, beginInstr));
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, netManLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Callvirt, m_NetworkManager_getIsHost_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Brfalse, lastInstr));
|
||||
if (!isGenericRpc)
|
||||
{
|
||||
// if (networkManager.IsClient || networkManager.IsHost) { ... } -> ServerRpc
|
||||
// if (networkManager.IsServer || networkManager.IsHost) { ... } -> ClientRpc
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, netManLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Callvirt, isServerRpc ? m_NetworkManager_getIsClient_MethodRef : m_NetworkManager_getIsServer_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Brtrue, beginInstr));
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, netManLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Callvirt, m_NetworkManager_getIsHost_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Brfalse, lastInstr));
|
||||
}
|
||||
|
||||
instructions.Add(beginInstr);
|
||||
|
||||
@@ -2025,7 +2258,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
instructions.Add(processor.Create(OpCodes.Call, m_NetworkBehaviour_beginSendServerRpc_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Stloc, bufWriterLocIdx));
|
||||
}
|
||||
else
|
||||
else if (isClientRpc)
|
||||
{
|
||||
// ClientRpc
|
||||
|
||||
@@ -2045,6 +2278,89 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
instructions.Add(processor.Create(OpCodes.Call, m_NetworkBehaviour_beginSendClientRpc_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Stloc, bufWriterLocIdx));
|
||||
}
|
||||
else
|
||||
{
|
||||
// Generic RPC
|
||||
|
||||
// var bufferWriter = __beginSendRpc(rpcMethodId, rpcParams, rpcAttributeParams, defaultTarget, rpcDelivery);
|
||||
instructions.Add(processor.Create(OpCodes.Ldarg_0));
|
||||
|
||||
// rpcMethodId
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, unchecked((int)rpcMethodId)));
|
||||
|
||||
// rpcParams
|
||||
instructions.Add(hasRpcParams ? processor.Create(OpCodes.Ldarg, paramCount) : processor.Create(OpCodes.Ldloc, rpcParamsIdx));
|
||||
|
||||
// rpcAttributeParams
|
||||
instructions.Add(processor.Create(OpCodes.Ldloca, rpcAttributeParamsIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Initobj, m_AttributeParamsType_TypeRef));
|
||||
|
||||
RpcAttribute.RpcAttributeParams dflt = default;
|
||||
foreach (var field in rpcAttribute.Fields)
|
||||
{
|
||||
var found = false;
|
||||
foreach (var attrField in m_AttributeParamsType_TypeRef.Resolve().Fields)
|
||||
{
|
||||
if (attrField.Name == field.Name)
|
||||
{
|
||||
found = true;
|
||||
var value = field.Argument.Value;
|
||||
var paramField = dflt.GetType().GetField(attrField.Name);
|
||||
if (value != paramField.GetValue(dflt))
|
||||
{
|
||||
instructions.Add(processor.Create(OpCodes.Ldloca, rpcAttributeParamsIdx));
|
||||
var type = value.GetType();
|
||||
if (type == typeof(bool))
|
||||
{
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (bool)value ? 1 : 0));
|
||||
}
|
||||
else if (type == typeof(short) || type == typeof(int) || type == typeof(ushort)
|
||||
|| type == typeof(byte) || type == typeof(sbyte) || type == typeof(char))
|
||||
{
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)value));
|
||||
}
|
||||
else if (type == typeof(long) || type == typeof(ulong))
|
||||
{
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I8, (long)value));
|
||||
}
|
||||
else if (type == typeof(float))
|
||||
{
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_R8, (float)value));
|
||||
|
||||
}
|
||||
else if (type == typeof(double))
|
||||
{
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_R8, (double)value));
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Diagnostics.AddError("Unsupported attribute parameter type.");
|
||||
}
|
||||
}
|
||||
|
||||
instructions.Add(processor.Create(OpCodes.Stfld, m_MainModule.ImportReference(attrField)));
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!found)
|
||||
{
|
||||
m_Diagnostics.AddError($"{nameof(RpcAttribute)} contains field {field} which is not present in {nameof(RpcAttribute.RpcAttributeParams)}.");
|
||||
}
|
||||
}
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, rpcAttributeParamsIdx));
|
||||
|
||||
// defaultTarget
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)defaultTarget));
|
||||
|
||||
// rpcDelivery
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)rpcDelivery));
|
||||
|
||||
// __beginSendRpc
|
||||
instructions.Add(processor.Create(OpCodes.Call, m_NetworkBehaviour_beginSendRpc_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Stloc, bufWriterLocIdx));
|
||||
}
|
||||
|
||||
// write method parameters into stream
|
||||
for (int paramIndex = 0; paramIndex < paramCount; ++paramIndex)
|
||||
@@ -2073,7 +2389,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
}
|
||||
if (!isServerRpc)
|
||||
{
|
||||
m_Diagnostics.AddError($"ClientRpcs may not accept {nameof(ServerRpcParams)} as a parameter.");
|
||||
m_Diagnostics.AddError($"Only ServerRpcs may accept {nameof(ServerRpcParams)} as a parameter.");
|
||||
}
|
||||
continue;
|
||||
}
|
||||
@@ -2084,9 +2400,22 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
{
|
||||
m_Diagnostics.AddError(methodDefinition, $"{nameof(ClientRpcParams)} must be the last parameter in a ClientRpc.");
|
||||
}
|
||||
if (isServerRpc)
|
||||
if (!isClientRpc)
|
||||
{
|
||||
m_Diagnostics.AddError($"ServerRpcs may not accept {nameof(ClientRpcParams)} as a parameter.");
|
||||
m_Diagnostics.AddError($"Only clientRpcs may accept {nameof(ClientRpcParams)} as a parameter.");
|
||||
}
|
||||
continue;
|
||||
}
|
||||
// RpcParams
|
||||
if (paramType.FullName == CodeGenHelpers.RpcParams_FullName)
|
||||
{
|
||||
if (paramIndex != paramCount - 1)
|
||||
{
|
||||
m_Diagnostics.AddError(methodDefinition, $"{nameof(RpcParams)} must be the last parameter in a ClientRpc.");
|
||||
}
|
||||
if (!isGenericRpc)
|
||||
{
|
||||
m_Diagnostics.AddError($"Only Rpcs may accept {nameof(RpcParams)} as a parameter.");
|
||||
}
|
||||
continue;
|
||||
}
|
||||
@@ -2249,7 +2578,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
// __endSendServerRpc
|
||||
instructions.Add(processor.Create(OpCodes.Call, m_NetworkBehaviour_endSendServerRpc_MethodRef));
|
||||
}
|
||||
else
|
||||
else if (isClientRpc)
|
||||
{
|
||||
// ClientRpc
|
||||
|
||||
@@ -2277,6 +2606,41 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
// __endSendClientRpc
|
||||
instructions.Add(processor.Create(OpCodes.Call, m_NetworkBehaviour_endSendClientRpc_MethodRef));
|
||||
}
|
||||
else
|
||||
{
|
||||
// Generic Rpc
|
||||
|
||||
// __endSendRpc(ref bufferWriter, rpcMethodId, rpcParams, rpcAttributeParams, defaultTarget, rpcDelivery);
|
||||
instructions.Add(processor.Create(OpCodes.Ldarg_0));
|
||||
|
||||
// bufferWriter
|
||||
instructions.Add(processor.Create(OpCodes.Ldloca, bufWriterLocIdx));
|
||||
|
||||
// rpcMethodId
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, unchecked((int)rpcMethodId)));
|
||||
if (hasRpcParams)
|
||||
{
|
||||
// rpcParams
|
||||
instructions.Add(processor.Create(OpCodes.Ldarg, paramCount));
|
||||
}
|
||||
else
|
||||
{
|
||||
// default
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, rpcParamsIdx));
|
||||
}
|
||||
|
||||
// rpcAttributeParams
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, rpcAttributeParamsIdx));
|
||||
|
||||
// defaultTarget
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)defaultTarget));
|
||||
|
||||
// rpcDelivery
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)rpcDelivery));
|
||||
|
||||
// __endSendClientRpc
|
||||
instructions.Add(processor.Create(OpCodes.Call, m_NetworkBehaviour_endSendRpc_MethodRef));
|
||||
}
|
||||
|
||||
instructions.Add(lastInstr);
|
||||
}
|
||||
@@ -2285,25 +2649,53 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
var returnInstr = processor.Create(OpCodes.Ret);
|
||||
var lastInstr = processor.Create(OpCodes.Nop);
|
||||
|
||||
// if (__rpc_exec_stage == __RpcExecStage.Server) -> ServerRpc
|
||||
// if (__rpc_exec_stage == __RpcExecStage.Client) -> ClientRpc
|
||||
instructions.Add(processor.Create(OpCodes.Ldarg_0));
|
||||
instructions.Add(processor.Create(OpCodes.Ldfld, m_NetworkBehaviour_rpc_exec_stage_FieldRef));
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)(isServerRpc ? NetworkBehaviour.__RpcExecStage.Server : NetworkBehaviour.__RpcExecStage.Client)));
|
||||
instructions.Add(processor.Create(OpCodes.Ceq));
|
||||
instructions.Add(processor.Create(OpCodes.Brfalse, returnInstr));
|
||||
if (!isGenericRpc)
|
||||
{
|
||||
// if (__rpc_exec_stage == __RpcExecStage.Execute)
|
||||
instructions.Add(processor.Create(OpCodes.Ldarg_0));
|
||||
instructions.Add(processor.Create(OpCodes.Ldfld, m_NetworkBehaviour_rpc_exec_stage_FieldRef));
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)NetworkBehaviour.__RpcExecStage.Execute));
|
||||
instructions.Add(processor.Create(OpCodes.Ceq));
|
||||
instructions.Add(processor.Create(OpCodes.Brfalse, returnInstr));
|
||||
|
||||
// if (networkManager.IsServer || networkManager.IsHost) -> ServerRpc
|
||||
// if (networkManager.IsClient || networkManager.IsHost) -> ClientRpc
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, netManLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Callvirt, isServerRpc ? m_NetworkManager_getIsServer_MethodRef : m_NetworkManager_getIsClient_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Brtrue, lastInstr));
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, netManLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Callvirt, m_NetworkManager_getIsHost_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Brtrue, lastInstr));
|
||||
// if (networkManager.IsServer || networkManager.IsHost) -> ServerRpc
|
||||
// if (networkManager.IsClient || networkManager.IsHost) -> ClientRpc
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, netManLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Callvirt, isServerRpc ? m_NetworkManager_getIsServer_MethodRef : m_NetworkManager_getIsClient_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Brtrue, lastInstr));
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, netManLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Callvirt, m_NetworkManager_getIsHost_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Brtrue, lastInstr));
|
||||
instructions.Add(returnInstr);
|
||||
instructions.Add(lastInstr);
|
||||
|
||||
// This needs to be set back before executing the callback or else sending another RPC
|
||||
// from within an RPC will not work.
|
||||
// __rpc_exec_stage = __RpcExecStage.Send
|
||||
instructions.Add(processor.Create(OpCodes.Ldarg_0));
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)NetworkBehaviour.__RpcExecStage.Send));
|
||||
instructions.Add(processor.Create(OpCodes.Stfld, m_NetworkBehaviour_rpc_exec_stage_FieldRef));
|
||||
}
|
||||
else
|
||||
{
|
||||
// if (__rpc_exec_stage == __RpcExecStage.Execute)
|
||||
instructions.Add(processor.Create(OpCodes.Ldarg_0));
|
||||
instructions.Add(processor.Create(OpCodes.Ldfld, m_NetworkBehaviour_rpc_exec_stage_FieldRef));
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)NetworkBehaviour.__RpcExecStage.Execute));
|
||||
instructions.Add(processor.Create(OpCodes.Ceq));
|
||||
instructions.Add(processor.Create(OpCodes.Brtrue, lastInstr));
|
||||
|
||||
instructions.Add(returnInstr);
|
||||
instructions.Add(lastInstr);
|
||||
|
||||
// This needs to be set back before executing the callback or else sending another RPC
|
||||
// from within an RPC will not work.
|
||||
// __rpc_exec_stage = __RpcExecStage.Send
|
||||
instructions.Add(processor.Create(OpCodes.Ldarg_0));
|
||||
instructions.Add(processor.Create(OpCodes.Ldc_I4, (int)NetworkBehaviour.__RpcExecStage.Send));
|
||||
instructions.Add(processor.Create(OpCodes.Stfld, m_NetworkBehaviour_rpc_exec_stage_FieldRef));
|
||||
}
|
||||
|
||||
instructions.Add(returnInstr);
|
||||
instructions.Add(lastInstr);
|
||||
}
|
||||
|
||||
instructions.Reverse();
|
||||
@@ -2456,6 +2848,8 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
var processor = rpcHandler.Body.GetILProcessor();
|
||||
|
||||
var isServerRpc = rpcAttribute.AttributeType.FullName == CodeGenHelpers.ServerRpcAttribute_FullName;
|
||||
var isCientRpc = rpcAttribute.AttributeType.FullName == CodeGenHelpers.ClientRpcAttribute_FullName;
|
||||
var isGenericRpc = rpcAttribute.AttributeType.FullName == CodeGenHelpers.RpcAttribute_FullName;
|
||||
var requireOwnership = true; // default value MUST be == `ServerRpcAttribute.RequireOwnership`
|
||||
foreach (var attrField in rpcAttribute.Fields)
|
||||
{
|
||||
@@ -2562,6 +2956,15 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
processor.Emit(OpCodes.Stloc, localIndex);
|
||||
continue;
|
||||
}
|
||||
|
||||
// RpcParams
|
||||
if (paramType.FullName == CodeGenHelpers.RpcParams_FullName)
|
||||
{
|
||||
processor.Emit(OpCodes.Ldarg_2);
|
||||
processor.Emit(OpCodes.Ldfld, m_RpcParams_Ext_FieldRef);
|
||||
processor.Emit(OpCodes.Stloc, localIndex);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
Instruction jumpInstruction = null;
|
||||
@@ -2688,7 +3091,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
// NetworkBehaviour.__rpc_exec_stage = __RpcExecStage.Server; -> ServerRpc
|
||||
// NetworkBehaviour.__rpc_exec_stage = __RpcExecStage.Client; -> ClientRpc
|
||||
processor.Emit(OpCodes.Ldarg_0);
|
||||
processor.Emit(OpCodes.Ldc_I4, (int)(isServerRpc ? NetworkBehaviour.__RpcExecStage.Server : NetworkBehaviour.__RpcExecStage.Client));
|
||||
processor.Emit(OpCodes.Ldc_I4, (int)(NetworkBehaviour.__RpcExecStage.Execute));
|
||||
processor.Emit(OpCodes.Stfld, m_NetworkBehaviour_rpc_exec_stage_FieldRef);
|
||||
|
||||
// NetworkBehaviour.XXXRpc(...);
|
||||
@@ -2711,7 +3114,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
|
||||
// NetworkBehaviour.__rpc_exec_stage = __RpcExecStage.None;
|
||||
processor.Emit(OpCodes.Ldarg_0);
|
||||
processor.Emit(OpCodes.Ldc_I4, (int)NetworkBehaviour.__RpcExecStage.None);
|
||||
processor.Emit(OpCodes.Ldc_I4, (int)NetworkBehaviour.__RpcExecStage.Send);
|
||||
processor.Emit(OpCodes.Stfld, m_NetworkBehaviour_rpc_exec_stage_FieldRef);
|
||||
|
||||
processor.Emit(OpCodes.Ret);
|
||||
|
||||
@@ -2,6 +2,7 @@ using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using Mono.Cecil;
|
||||
using Mono.Cecil.Cil;
|
||||
using Mono.Cecil.Rocks;
|
||||
using Unity.CompilationPipeline.Common.Diagnostics;
|
||||
using Unity.CompilationPipeline.Common.ILPostProcessing;
|
||||
using ILPPInterface = Unity.CompilationPipeline.Common.ILPostProcessing.ILPostProcessor;
|
||||
@@ -52,6 +53,15 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
case nameof(NetworkBehaviour):
|
||||
ProcessNetworkBehaviour(typeDefinition);
|
||||
break;
|
||||
case nameof(RpcAttribute):
|
||||
foreach (var methodDefinition in typeDefinition.GetConstructors())
|
||||
{
|
||||
if (methodDefinition.Parameters.Count == 0)
|
||||
{
|
||||
methodDefinition.IsPublic = true;
|
||||
}
|
||||
}
|
||||
break;
|
||||
case nameof(__RpcParams):
|
||||
case nameof(RpcFallbackSerialization):
|
||||
typeDefinition.IsPublic = true;
|
||||
@@ -154,6 +164,8 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__endSendServerRpc) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__beginSendClientRpc) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__endSendClientRpc) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__beginSendRpc) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__endSendRpc) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__initializeVariables) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__initializeRpcs) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__registerRpc) ||
|
||||
|
||||
@@ -19,7 +19,7 @@ namespace Unity.Netcode.Editor.Configuration
|
||||
{
|
||||
// First parameter is the path in the Settings window.
|
||||
// Second parameter is the scope of this setting: it only appears in the Settings window for the Project scope.
|
||||
var provider = new SettingsProvider("Project/NetcodeForGameObjects", SettingsScope.Project)
|
||||
var provider = new SettingsProvider("Project/Multiplayer/NetcodeForGameObjects", SettingsScope.Project)
|
||||
{
|
||||
label = "Netcode for GameObjects",
|
||||
keywords = new[] { "netcode", "editor" },
|
||||
|
||||
@@ -30,7 +30,9 @@ namespace Unity.Netcode.Editor
|
||||
private SerializedProperty m_ProtocolVersionProperty;
|
||||
private SerializedProperty m_NetworkTransportProperty;
|
||||
private SerializedProperty m_TickRateProperty;
|
||||
private SerializedProperty m_MaxObjectUpdatesPerTickProperty;
|
||||
#if MULTIPLAYER_SERVICES_SDK_INSTALLED
|
||||
private SerializedProperty m_NetworkTopologyProperty;
|
||||
#endif
|
||||
private SerializedProperty m_ClientConnectionBufferTimeoutProperty;
|
||||
private SerializedProperty m_ConnectionApprovalProperty;
|
||||
private SerializedProperty m_EnsureNetworkVariableLengthSafetyProperty;
|
||||
@@ -38,10 +40,14 @@ namespace Unity.Netcode.Editor
|
||||
private SerializedProperty m_EnableSceneManagementProperty;
|
||||
private SerializedProperty m_RecycleNetworkIdsProperty;
|
||||
private SerializedProperty m_NetworkIdRecycleDelayProperty;
|
||||
private SerializedProperty m_SpawnTimeOutProperty;
|
||||
private SerializedProperty m_RpcHashSizeProperty;
|
||||
private SerializedProperty m_LoadSceneTimeOutProperty;
|
||||
private SerializedProperty m_PrefabsList;
|
||||
|
||||
private SerializedProperty m_NetworkProfileMetrics;
|
||||
private SerializedProperty m_NetworkMessageMetrics;
|
||||
|
||||
private NetworkManager m_NetworkManager;
|
||||
private bool m_Initialized;
|
||||
|
||||
@@ -96,15 +102,27 @@ namespace Unity.Netcode.Editor
|
||||
m_ProtocolVersionProperty = m_NetworkConfigProperty.FindPropertyRelative("ProtocolVersion");
|
||||
m_NetworkTransportProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTransport");
|
||||
m_TickRateProperty = m_NetworkConfigProperty.FindPropertyRelative("TickRate");
|
||||
#if MULTIPLAYER_SERVICES_SDK_INSTALLED
|
||||
m_NetworkTopologyProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTopology");
|
||||
#endif
|
||||
m_ClientConnectionBufferTimeoutProperty = m_NetworkConfigProperty.FindPropertyRelative("ClientConnectionBufferTimeout");
|
||||
m_ConnectionApprovalProperty = m_NetworkConfigProperty.FindPropertyRelative("ConnectionApproval");
|
||||
m_EnsureNetworkVariableLengthSafetyProperty = m_NetworkConfigProperty.FindPropertyRelative("EnsureNetworkVariableLengthSafety");
|
||||
m_ForceSamePrefabsProperty = m_NetworkConfigProperty.FindPropertyRelative("ForceSamePrefabs");
|
||||
m_EnableSceneManagementProperty = m_NetworkConfigProperty.FindPropertyRelative("EnableSceneManagement");
|
||||
m_RecycleNetworkIdsProperty = m_NetworkConfigProperty.FindPropertyRelative("RecycleNetworkIds");
|
||||
m_NetworkIdRecycleDelayProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkIdRecycleDelay");
|
||||
m_RpcHashSizeProperty = m_NetworkConfigProperty.FindPropertyRelative("RpcHashSize");
|
||||
|
||||
m_EnableSceneManagementProperty = m_NetworkConfigProperty.FindPropertyRelative("EnableSceneManagement");
|
||||
m_SpawnTimeOutProperty = m_NetworkConfigProperty.FindPropertyRelative("SpawnTimeout");
|
||||
m_LoadSceneTimeOutProperty = m_NetworkConfigProperty.FindPropertyRelative("LoadSceneTimeOut");
|
||||
|
||||
m_NetworkProfileMetrics = m_NetworkConfigProperty.FindPropertyRelative("NetworkProfileMetrics");
|
||||
#if MULTIPLAYER_TOOLS
|
||||
m_NetworkMessageMetrics = m_NetworkConfigProperty.FindPropertyRelative("NetworkMessageMetrics");
|
||||
#endif
|
||||
|
||||
|
||||
m_RpcHashSizeProperty = m_NetworkConfigProperty.FindPropertyRelative("RpcHashSize");
|
||||
m_PrefabsList = m_NetworkConfigProperty
|
||||
.FindPropertyRelative(nameof(NetworkConfig.Prefabs))
|
||||
.FindPropertyRelative(nameof(NetworkPrefabs.NetworkPrefabsLists));
|
||||
@@ -124,15 +142,27 @@ namespace Unity.Netcode.Editor
|
||||
m_ProtocolVersionProperty = m_NetworkConfigProperty.FindPropertyRelative("ProtocolVersion");
|
||||
m_NetworkTransportProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTransport");
|
||||
m_TickRateProperty = m_NetworkConfigProperty.FindPropertyRelative("TickRate");
|
||||
#if MULTIPLAYER_SERVICES_SDK_INSTALLED
|
||||
m_NetworkTopologyProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTopology");
|
||||
#endif
|
||||
m_ClientConnectionBufferTimeoutProperty = m_NetworkConfigProperty.FindPropertyRelative("ClientConnectionBufferTimeout");
|
||||
m_ConnectionApprovalProperty = m_NetworkConfigProperty.FindPropertyRelative("ConnectionApproval");
|
||||
m_EnsureNetworkVariableLengthSafetyProperty = m_NetworkConfigProperty.FindPropertyRelative("EnsureNetworkVariableLengthSafety");
|
||||
m_ForceSamePrefabsProperty = m_NetworkConfigProperty.FindPropertyRelative("ForceSamePrefabs");
|
||||
m_EnableSceneManagementProperty = m_NetworkConfigProperty.FindPropertyRelative("EnableSceneManagement");
|
||||
m_RecycleNetworkIdsProperty = m_NetworkConfigProperty.FindPropertyRelative("RecycleNetworkIds");
|
||||
m_NetworkIdRecycleDelayProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkIdRecycleDelay");
|
||||
m_RpcHashSizeProperty = m_NetworkConfigProperty.FindPropertyRelative("RpcHashSize");
|
||||
|
||||
|
||||
m_EnableSceneManagementProperty = m_NetworkConfigProperty.FindPropertyRelative("EnableSceneManagement");
|
||||
m_SpawnTimeOutProperty = m_NetworkConfigProperty.FindPropertyRelative("SpawnTimeout");
|
||||
m_LoadSceneTimeOutProperty = m_NetworkConfigProperty.FindPropertyRelative("LoadSceneTimeOut");
|
||||
|
||||
m_NetworkProfileMetrics = m_NetworkConfigProperty.FindPropertyRelative("NetworkProfilingMetrics");
|
||||
#if MULTIPLAYER_TOOLS
|
||||
m_NetworkMessageMetrics = m_NetworkConfigProperty.FindPropertyRelative("NetworkMessageMetrics");
|
||||
#endif
|
||||
|
||||
m_RpcHashSizeProperty = m_NetworkConfigProperty.FindPropertyRelative("RpcHashSize");
|
||||
m_PrefabsList = m_NetworkConfigProperty
|
||||
.FindPropertyRelative(nameof(NetworkConfig.Prefabs))
|
||||
.FindPropertyRelative(nameof(NetworkPrefabs.NetworkPrefabsLists));
|
||||
@@ -153,10 +183,54 @@ namespace Unity.Netcode.Editor
|
||||
serializedObject.Update();
|
||||
EditorGUILayout.PropertyField(m_RunInBackgroundProperty);
|
||||
EditorGUILayout.PropertyField(m_LogLevelProperty);
|
||||
EditorGUILayout.Space();
|
||||
|
||||
EditorGUILayout.PropertyField(m_PlayerPrefabProperty);
|
||||
EditorGUILayout.Space();
|
||||
EditorGUILayout.LabelField("Network Settings", EditorStyles.boldLabel);
|
||||
#if MULTIPLAYER_SERVICES_SDK_INSTALLED
|
||||
EditorGUILayout.PropertyField(m_NetworkTopologyProperty);
|
||||
#endif
|
||||
EditorGUILayout.PropertyField(m_ProtocolVersionProperty);
|
||||
EditorGUILayout.PropertyField(m_NetworkTransportProperty);
|
||||
if (m_NetworkTransportProperty.objectReferenceValue == null)
|
||||
{
|
||||
EditorGUILayout.HelpBox("You have no transport selected. A transport is required for netcode to work. Which one do you want?", MessageType.Warning);
|
||||
|
||||
int selection = EditorGUILayout.Popup(0, m_TransportNames);
|
||||
|
||||
if (selection > 0)
|
||||
{
|
||||
ReloadTransports();
|
||||
|
||||
var transportComponent = m_NetworkManager.gameObject.GetComponent(m_TransportTypes[selection - 1]) ?? m_NetworkManager.gameObject.AddComponent(m_TransportTypes[selection - 1]);
|
||||
m_NetworkTransportProperty.objectReferenceValue = transportComponent;
|
||||
|
||||
Repaint();
|
||||
}
|
||||
}
|
||||
EditorGUILayout.PropertyField(m_TickRateProperty);
|
||||
EditorGUILayout.PropertyField(m_SpawnTimeOutProperty);
|
||||
EditorGUILayout.PropertyField(m_ConnectionApprovalProperty);
|
||||
if (m_NetworkManager.NetworkConfig.ConnectionApproval)
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_ClientConnectionBufferTimeoutProperty);
|
||||
}
|
||||
EditorGUILayout.PropertyField(m_EnsureNetworkVariableLengthSafetyProperty, new GUIContent("NetworkVariable Length Safety"));
|
||||
EditorGUILayout.PropertyField(m_RecycleNetworkIdsProperty);
|
||||
if (m_NetworkManager.NetworkConfig.RecycleNetworkIds)
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_NetworkIdRecycleDelayProperty);
|
||||
}
|
||||
EditorGUILayout.PropertyField(m_RpcHashSizeProperty);
|
||||
|
||||
EditorGUILayout.PropertyField(m_NetworkProfileMetrics);
|
||||
#if MULTIPLAYER_TOOLS
|
||||
EditorGUILayout.PropertyField(m_NetworkMessageMetrics);
|
||||
#endif
|
||||
|
||||
EditorGUILayout.Space();
|
||||
EditorGUILayout.LabelField("Prefab Settings", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_ForceSamePrefabsProperty);
|
||||
EditorGUILayout.PropertyField(m_PlayerPrefabProperty, new GUIContent("Default Player Prefab"));
|
||||
|
||||
if (m_NetworkManager.NetworkConfig.HasOldPrefabList())
|
||||
{
|
||||
@@ -214,62 +288,11 @@ namespace Unity.Netcode.Editor
|
||||
}
|
||||
EditorGUILayout.PropertyField(m_PrefabsList);
|
||||
}
|
||||
|
||||
EditorGUILayout.Space();
|
||||
|
||||
EditorGUILayout.LabelField("General", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_ProtocolVersionProperty);
|
||||
|
||||
EditorGUILayout.PropertyField(m_NetworkTransportProperty);
|
||||
|
||||
if (m_NetworkTransportProperty.objectReferenceValue == null)
|
||||
{
|
||||
EditorGUILayout.HelpBox("You have no transport selected. A transport is required for netcode to work. Which one do you want?", MessageType.Warning);
|
||||
|
||||
int selection = EditorGUILayout.Popup(0, m_TransportNames);
|
||||
|
||||
if (selection > 0)
|
||||
{
|
||||
ReloadTransports();
|
||||
|
||||
var transportComponent = m_NetworkManager.gameObject.GetComponent(m_TransportTypes[selection - 1]) ?? m_NetworkManager.gameObject.AddComponent(m_TransportTypes[selection - 1]);
|
||||
m_NetworkTransportProperty.objectReferenceValue = transportComponent;
|
||||
|
||||
Repaint();
|
||||
}
|
||||
}
|
||||
|
||||
EditorGUILayout.PropertyField(m_TickRateProperty);
|
||||
|
||||
EditorGUILayout.LabelField("Performance", EditorStyles.boldLabel);
|
||||
|
||||
EditorGUILayout.PropertyField(m_EnsureNetworkVariableLengthSafetyProperty);
|
||||
|
||||
EditorGUILayout.LabelField("Connection", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_ConnectionApprovalProperty);
|
||||
|
||||
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.ConnectionApproval))
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_ClientConnectionBufferTimeoutProperty);
|
||||
}
|
||||
|
||||
EditorGUILayout.LabelField("Spawning", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_ForceSamePrefabsProperty);
|
||||
|
||||
|
||||
EditorGUILayout.PropertyField(m_RecycleNetworkIdsProperty);
|
||||
|
||||
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.RecycleNetworkIds))
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_NetworkIdRecycleDelayProperty);
|
||||
}
|
||||
|
||||
EditorGUILayout.LabelField("Bandwidth", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_RpcHashSizeProperty);
|
||||
|
||||
EditorGUILayout.LabelField("Scene Management", EditorStyles.boldLabel);
|
||||
EditorGUILayout.LabelField("Scene Management Settings", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_EnableSceneManagementProperty);
|
||||
|
||||
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.EnableSceneManagement))
|
||||
if (m_NetworkManager.NetworkConfig.EnableSceneManagement)
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_LoadSceneTimeOutProperty);
|
||||
}
|
||||
@@ -287,20 +310,31 @@ namespace Unity.Netcode.Editor
|
||||
GUI.enabled = false;
|
||||
}
|
||||
|
||||
if (GUILayout.Button(new GUIContent("Start Host", "Starts a host instance" + buttonDisabledReasonSuffix)))
|
||||
if (m_NetworkManager.NetworkConfig.NetworkTopology == NetworkTopologyTypes.ClientServer)
|
||||
{
|
||||
m_NetworkManager.StartHost();
|
||||
if (GUILayout.Button(new GUIContent("Start Host", "Starts a host instance" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_NetworkManager.StartHost();
|
||||
}
|
||||
|
||||
if (GUILayout.Button(new GUIContent("Start Server", "Starts a server instance" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_NetworkManager.StartServer();
|
||||
}
|
||||
|
||||
if (GUILayout.Button(new GUIContent("Start Client", "Starts a client instance" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_NetworkManager.StartClient();
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if (GUILayout.Button(new GUIContent("Start Client", "Starts a distributed authority client instance" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_NetworkManager.StartClient();
|
||||
}
|
||||
}
|
||||
|
||||
if (GUILayout.Button(new GUIContent("Start Server", "Starts a server instance" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_NetworkManager.StartServer();
|
||||
}
|
||||
|
||||
if (GUILayout.Button(new GUIContent("Start Client", "Starts a client instance" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_NetworkManager.StartClient();
|
||||
}
|
||||
|
||||
if (!EditorApplication.isPlaying)
|
||||
{
|
||||
|
||||
120
Editor/NetworkManagerRelayIntegration.cs
Normal file
120
Editor/NetworkManagerRelayIntegration.cs
Normal file
@@ -0,0 +1,120 @@
|
||||
#if UNITY_2022_3_OR_NEWER && (RELAY_SDK_INSTALLED && !UNITY_WEBGL ) || (RELAY_SDK_INSTALLED && UNITY_WEBGL && UTP_TRANSPORT_2_0_ABOVE)
|
||||
using System;
|
||||
using System.Threading.Tasks;
|
||||
using Unity.Netcode.Transports.UTP;
|
||||
using Unity.Networking.Transport.Relay;
|
||||
using Unity.Services.Authentication;
|
||||
using Unity.Services.Core;
|
||||
using Unity.Services.Relay;
|
||||
using Unity.Services.Relay.Models;
|
||||
|
||||
namespace Unity.Netcode.Editor
|
||||
{
|
||||
/// <summary>
|
||||
/// Integration with Unity Relay SDK and Unity Transport that support the additional buttons in the NetworkManager inspector.
|
||||
/// This code could theoretically be used at runtime, but we would like to avoid the additional dependencies in the runtime assembly of netcode for gameobjects.
|
||||
/// </summary>
|
||||
public static class NetworkManagerRelayIntegration
|
||||
{
|
||||
|
||||
#if UNITY_WEBGL
|
||||
private const string k_DefaultConnectionType = "wss";
|
||||
#else
|
||||
private const string k_DefaultConnectionType = "dtls";
|
||||
#endif
|
||||
|
||||
/// <summary>
|
||||
/// Easy relay integration (host): it will initialize the unity services, sign in anonymously and start the host with a new relay allocation.
|
||||
/// Note that this will force the use of Unity Transport.
|
||||
/// </summary>
|
||||
/// <param name="networkManager">The network manager that will start the connection</param>
|
||||
/// <param name="maxConnections">Maximum number of connections to the created relay.</param>
|
||||
/// <param name="connectionType">The connection type of the <see cref="RelayServerData"/> (wss, ws, dtls or udp) </param>
|
||||
/// <returns>The join code that a potential client can use and the allocation</returns>
|
||||
/// <exception cref="ServicesInitializationException"> Exception when there's an error during services initialization </exception>
|
||||
/// <exception cref="UnityProjectNotLinkedException"> Exception when the project is not linked to a cloud project id </exception>
|
||||
/// <exception cref="CircularDependencyException"> Exception when two registered <see cref="IInitializablePackage"/> depend on the other </exception>
|
||||
/// <exception cref="AuthenticationException"> The task fails with the exception when the task cannot complete successfully due to Authentication specific errors. </exception>
|
||||
/// <exception cref="RequestFailedException"> See <see cref="IAuthenticationService.SignInAnonymouslyAsync"/></exception>
|
||||
/// <exception cref="ArgumentException">Thrown when the maxConnections argument fails validation in Relay Service SDK.</exception>
|
||||
/// <exception cref="RelayServiceException">Thrown when the request successfully reach the Relay Allocation Service but results in an error.</exception>
|
||||
internal static async Task<(string, Allocation)> StartHostWithRelay(this NetworkManager networkManager, int maxConnections = 5)
|
||||
{
|
||||
var codeAndAllocation = await InitializeAndCreateAllocAsync(networkManager, maxConnections, k_DefaultConnectionType);
|
||||
return networkManager.StartHost() ? codeAndAllocation : (null, null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Easy relay integration (server): it will initialize the unity services, sign in anonymously and start the server with a new relay allocation.
|
||||
/// Note that this will force the use of Unity Transport.
|
||||
/// </summary>
|
||||
/// <param name="networkManager">The network manager that will start the connection</param>
|
||||
/// <param name="maxConnections">Maximum number of connections to the created relay.</param>
|
||||
/// <returns>The join code that a potential client can use and the allocation.</returns>
|
||||
/// <exception cref="ServicesInitializationException"> Exception when there's an error during services initialization </exception>
|
||||
/// <exception cref="UnityProjectNotLinkedException"> Exception when the project is not linked to a cloud project id </exception>
|
||||
/// <exception cref="CircularDependencyException"> Exception when two registered <see cref="IInitializablePackage"/> depend on the other </exception>
|
||||
/// <exception cref="AuthenticationException"> The task fails with the exception when the task cannot complete successfully due to Authentication specific errors. </exception>
|
||||
/// <exception cref="RequestFailedException"> See <see cref="IAuthenticationService.SignInAnonymouslyAsync"/></exception>
|
||||
/// <exception cref="ArgumentException">Thrown when the maxConnections argument fails validation in Relay Service SDK.</exception>
|
||||
/// <exception cref="RelayServiceException">Thrown when the request successfully reach the Relay Allocation Service but results in an error.</exception>
|
||||
internal static async Task<(string, Allocation)> StartServerWithRelay(this NetworkManager networkManager, int maxConnections = 5)
|
||||
{
|
||||
var codeAndAllocation = await InitializeAndCreateAllocAsync(networkManager, maxConnections, k_DefaultConnectionType);
|
||||
return networkManager.StartServer() ? codeAndAllocation : (null, null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Easy relay integration (client): it will initialize the unity services, sign in anonymously, join the relay with the given join code and start the client.
|
||||
/// Note that this will force the use of Unity Transport.
|
||||
/// </summary>
|
||||
/// <param name="networkManager">The network manager that will start the connection</param>
|
||||
/// <param name="joinCode">The join code of the allocation</param>
|
||||
/// <exception cref="ServicesInitializationException"> Exception when there's an error during services initialization </exception>
|
||||
/// <exception cref="UnityProjectNotLinkedException"> Exception when the project is not linked to a cloud project id </exception>
|
||||
/// <exception cref="CircularDependencyException"> Exception when two registered <see cref="IInitializablePackage"/> depend on the other </exception>
|
||||
/// <exception cref="AuthenticationException"> The task fails with the exception when the task cannot complete successfully due to Authentication specific errors. </exception>
|
||||
/// <exception cref="RequestFailedException">Thrown when the request does not reach the Relay Allocation Service.</exception>
|
||||
/// <exception cref="ArgumentException">Thrown if the joinCode has the wrong format.</exception>
|
||||
/// <exception cref="RelayServiceException">Thrown when the request successfully reach the Relay Allocation Service but results in an error.</exception>
|
||||
/// <returns>True if starting the client was successful</returns>
|
||||
internal static async Task<JoinAllocation> StartClientWithRelay(this NetworkManager networkManager, string joinCode)
|
||||
{
|
||||
await UnityServices.InitializeAsync();
|
||||
if (!AuthenticationService.Instance.IsSignedIn)
|
||||
{
|
||||
await AuthenticationService.Instance.SignInAnonymouslyAsync();
|
||||
}
|
||||
var joinAllocation = await RelayService.Instance.JoinAllocationAsync(joinCode: joinCode);
|
||||
GetUnityTransport(networkManager, k_DefaultConnectionType).SetRelayServerData(new RelayServerData(joinAllocation, k_DefaultConnectionType));
|
||||
return networkManager.StartClient() ? joinAllocation : null;
|
||||
}
|
||||
|
||||
private static async Task<(string, Allocation)> InitializeAndCreateAllocAsync(NetworkManager networkManager, int maxConnections, string connectionType)
|
||||
{
|
||||
await UnityServices.InitializeAsync();
|
||||
if (!AuthenticationService.Instance.IsSignedIn)
|
||||
{
|
||||
await AuthenticationService.Instance.SignInAnonymouslyAsync();
|
||||
}
|
||||
Allocation allocation = await RelayService.Instance.CreateAllocationAsync(maxConnections);
|
||||
GetUnityTransport(networkManager, connectionType).SetRelayServerData(new RelayServerData(allocation, connectionType));
|
||||
var joinCode = await RelayService.Instance.GetJoinCodeAsync(allocation.AllocationId);
|
||||
return (joinCode, allocation);
|
||||
}
|
||||
|
||||
private static UnityTransport GetUnityTransport(NetworkManager networkManager, string connectionType)
|
||||
{
|
||||
if (!networkManager.TryGetComponent<UnityTransport>(out var transport))
|
||||
{
|
||||
transport = networkManager.gameObject.AddComponent<UnityTransport>();
|
||||
}
|
||||
#if UTP_TRANSPORT_2_0_ABOVE
|
||||
transport.UseWebSockets = connectionType.StartsWith("ws"); // Probably should be part of SetRelayServerData, but not possible at this point
|
||||
#endif
|
||||
networkManager.NetworkConfig.NetworkTransport = transport; // Force using UnityTransport
|
||||
return transport;
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif
|
||||
3
Editor/NetworkManagerRelayIntegration.cs.meta
Normal file
3
Editor/NetworkManagerRelayIntegration.cs.meta
Normal file
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 23b658b1c2e443109a8a131ef3632c9b
|
||||
timeCreated: 1698673251
|
||||
@@ -1,4 +1,7 @@
|
||||
using System.Collections.Generic;
|
||||
#if BYPASS_DEFAULT_ENUM_DRAWER && MULTIPLAYER_SERVICES_SDK_INSTALLED
|
||||
using System.Linq;
|
||||
#endif
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
|
||||
@@ -49,6 +52,10 @@ namespace Unity.Netcode.Editor
|
||||
{
|
||||
var guiEnabled = GUI.enabled;
|
||||
GUI.enabled = false;
|
||||
if (m_NetworkObject.NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(NetworkObject.Ownership)));
|
||||
}
|
||||
EditorGUILayout.TextField(nameof(NetworkObject.GlobalObjectIdHash), m_NetworkObject.GlobalObjectIdHash.ToString());
|
||||
EditorGUILayout.TextField(nameof(NetworkObject.NetworkObjectId), m_NetworkObject.NetworkObjectId.ToString());
|
||||
EditorGUILayout.TextField(nameof(NetworkObject.OwnerClientId), m_NetworkObject.OwnerClientId.ToString());
|
||||
@@ -138,4 +145,52 @@ namespace Unity.Netcode.Editor
|
||||
NetworkBehaviourEditor.CheckForNetworkObject(m_GameObject, true);
|
||||
}
|
||||
}
|
||||
|
||||
// Keeping this here just in case, but it appears that in Unity 6 the visual bugs with
|
||||
// enum flags is resolved
|
||||
#if BYPASS_DEFAULT_ENUM_DRAWER && MULTIPLAYER_SERVICES_SDK_INSTALLED
|
||||
[CustomPropertyDrawer(typeof(NetworkObject.OwnershipStatus))]
|
||||
public class NetworkObjectOwnership : PropertyDrawer
|
||||
{
|
||||
public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
|
||||
{
|
||||
label = EditorGUI.BeginProperty(position, label, property);
|
||||
// Don't allow modification while in play mode
|
||||
EditorGUI.BeginDisabledGroup(EditorApplication.isPlaying);
|
||||
|
||||
// This is a temporary work around due to EditorGUI.EnumFlagsField having a bug in how it displays mask values.
|
||||
// For now, we will just display the flags as a toggle and handle the masking of the value ourselves.
|
||||
EditorGUILayout.BeginHorizontal();
|
||||
var names = System.Enum.GetNames(typeof(NetworkObject.OwnershipStatus)).ToList();
|
||||
names.RemoveAt(0);
|
||||
var value = property.enumValueFlag;
|
||||
var compareValue = 0x01;
|
||||
GUILayout.Label(label);
|
||||
foreach (var name in names)
|
||||
{
|
||||
var isSet = (value & compareValue) > 0;
|
||||
isSet = GUILayout.Toggle(isSet, name);
|
||||
if (isSet)
|
||||
{
|
||||
value |= compareValue;
|
||||
}
|
||||
else
|
||||
{
|
||||
value &= ~compareValue;
|
||||
}
|
||||
compareValue = compareValue << 1;
|
||||
}
|
||||
property.enumValueFlag = value;
|
||||
EditorGUILayout.EndHorizontal();
|
||||
|
||||
// The below can cause visual anomalies and/or throws an exception within the EditorGUI itself (index out of bounds of the array). and has
|
||||
// The visual anomaly is when you select one field it is set in the drop down but then the flags selection in the popup menu selects more items
|
||||
// even though if you exit the popup menu the flag setting is correct.
|
||||
//var ownership = (NetworkObject.OwnershipStatus)EditorGUI.EnumFlagsField(position, label, (NetworkObject.OwnershipStatus)property.enumValueFlag);
|
||||
//property.enumValueFlag = (int)ownership;
|
||||
EditorGUI.EndDisabledGroup();
|
||||
EditorGUI.EndProperty();
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
@@ -10,6 +10,7 @@ namespace Unity.Netcode.Editor
|
||||
[CustomEditor(typeof(NetworkTransform), true)]
|
||||
public class NetworkTransformEditor : UnityEditor.Editor
|
||||
{
|
||||
private SerializedProperty m_UseUnreliableDeltas;
|
||||
private SerializedProperty m_SyncPositionXProperty;
|
||||
private SerializedProperty m_SyncPositionYProperty;
|
||||
private SerializedProperty m_SyncPositionZProperty;
|
||||
@@ -29,6 +30,7 @@ namespace Unity.Netcode.Editor
|
||||
private SerializedProperty m_UseQuaternionCompression;
|
||||
private SerializedProperty m_UseHalfFloatPrecision;
|
||||
private SerializedProperty m_SlerpPosition;
|
||||
private SerializedProperty m_AuthorityMode;
|
||||
|
||||
private static int s_ToggleOffset = 45;
|
||||
private static float s_MaxRowWidth = EditorGUIUtility.labelWidth + EditorGUIUtility.fieldWidth + 5;
|
||||
@@ -37,8 +39,9 @@ namespace Unity.Netcode.Editor
|
||||
private static GUIContent s_ScaleLabel = EditorGUIUtility.TrTextContent("Scale");
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void OnEnable()
|
||||
public virtual void OnEnable()
|
||||
{
|
||||
m_UseUnreliableDeltas = serializedObject.FindProperty(nameof(NetworkTransform.UseUnreliableDeltas));
|
||||
m_SyncPositionXProperty = serializedObject.FindProperty(nameof(NetworkTransform.SyncPositionX));
|
||||
m_SyncPositionYProperty = serializedObject.FindProperty(nameof(NetworkTransform.SyncPositionY));
|
||||
m_SyncPositionZProperty = serializedObject.FindProperty(nameof(NetworkTransform.SyncPositionZ));
|
||||
@@ -57,12 +60,14 @@ namespace Unity.Netcode.Editor
|
||||
m_UseQuaternionCompression = serializedObject.FindProperty(nameof(NetworkTransform.UseQuaternionCompression));
|
||||
m_UseHalfFloatPrecision = serializedObject.FindProperty(nameof(NetworkTransform.UseHalfFloatPrecision));
|
||||
m_SlerpPosition = serializedObject.FindProperty(nameof(NetworkTransform.SlerpPosition));
|
||||
m_AuthorityMode = serializedObject.FindProperty(nameof(NetworkTransform.AuthorityMode));
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override void OnInspectorGUI()
|
||||
{
|
||||
EditorGUILayout.LabelField("Syncing", EditorStyles.boldLabel);
|
||||
var networkTransform = target as NetworkTransform;
|
||||
EditorGUILayout.LabelField("Axis to Synchronize", EditorStyles.boldLabel);
|
||||
{
|
||||
GUILayout.BeginHorizontal();
|
||||
|
||||
@@ -124,16 +129,26 @@ namespace Unity.Netcode.Editor
|
||||
GUILayout.EndHorizontal();
|
||||
}
|
||||
|
||||
EditorGUILayout.Space();
|
||||
EditorGUILayout.LabelField("Authority", EditorStyles.boldLabel);
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_AuthorityMode);
|
||||
}
|
||||
EditorGUILayout.Space();
|
||||
EditorGUILayout.LabelField("Thresholds", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_PositionThresholdProperty);
|
||||
EditorGUILayout.PropertyField(m_RotAngleThresholdProperty);
|
||||
EditorGUILayout.PropertyField(m_ScaleThresholdProperty);
|
||||
|
||||
EditorGUILayout.Space();
|
||||
EditorGUILayout.LabelField("Delivery", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_UseUnreliableDeltas);
|
||||
EditorGUILayout.Space();
|
||||
EditorGUILayout.LabelField("Configurations", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_InLocalSpaceProperty);
|
||||
EditorGUILayout.PropertyField(m_InterpolateProperty);
|
||||
if (!networkTransform.HideInterpolateValue)
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_InterpolateProperty);
|
||||
}
|
||||
EditorGUILayout.PropertyField(m_SlerpPosition);
|
||||
EditorGUILayout.PropertyField(m_UseQuaternionSynchronization);
|
||||
if (m_UseQuaternionSynchronization.boolValue)
|
||||
|
||||
@@ -3,11 +3,21 @@
|
||||
"rootNamespace": "Unity.Netcode.Editor",
|
||||
"references": [
|
||||
"Unity.Netcode.Runtime",
|
||||
"Unity.Netcode.Components"
|
||||
"Unity.Netcode.Components",
|
||||
"Unity.Services.Relay",
|
||||
"Unity.Networking.Transport",
|
||||
"Unity.Services.Core",
|
||||
"Unity.Services.Authentication"
|
||||
],
|
||||
"includePlatforms": [
|
||||
"Editor"
|
||||
],
|
||||
"excludePlatforms": [],
|
||||
"allowUnsafeCode": false,
|
||||
"overrideReferences": false,
|
||||
"precompiledReferences": [],
|
||||
"autoReferenced": true,
|
||||
"defineConstraints": [],
|
||||
"versionDefines": [
|
||||
{
|
||||
"name": "com.unity.multiplayer.tools",
|
||||
@@ -33,6 +43,22 @@
|
||||
"name": "com.unity.modules.physics2d",
|
||||
"expression": "",
|
||||
"define": "COM_UNITY_MODULES_PHYSICS2D"
|
||||
},
|
||||
{
|
||||
"name": "com.unity.services.relay",
|
||||
"expression": "1.0",
|
||||
"define": "RELAY_SDK_INSTALLED"
|
||||
},
|
||||
{
|
||||
"name": "com.unity.transport",
|
||||
"expression": "2.0",
|
||||
"define": "UTP_TRANSPORT_2_0_ABOVE"
|
||||
},
|
||||
{
|
||||
"name": "com.unity.services.multiplayer",
|
||||
"expression": "0.2.0",
|
||||
"define": "MULTIPLAYER_SERVICES_SDK_INSTALLED"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"noEngineReferences": false
|
||||
}
|
||||
10
LICENSE.md
10
LICENSE.md
@@ -1,9 +1,7 @@
|
||||
MIT License
|
||||
Unity Companion License (UCL License)
|
||||
|
||||
Copyright (c) 2021 Unity Technologies
|
||||
com.unity.netcode.gameobjects copyright © 2021-2024 Unity Technologies
|
||||
Licensed under the Unity Companion License for Unity-dependent projects (see https://unity3d.com/legal/licenses/unity_companion_license).
|
||||
Unless expressly provided otherwise, the Software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the license for details on these and other terms and conditions.
|
||||
|
||||
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.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 8b267eb841a574dc083ac248a95d4443
|
||||
guid: 2e42215d00468b549bbc69ebf8a74a1e
|
||||
folderAsset: yes
|
||||
DefaultImporter:
|
||||
externalObjects: {}
|
||||
501
Runtime/Components/AnticipatedNetworkTransform.cs
Normal file
501
Runtime/Components/AnticipatedNetworkTransform.cs
Normal file
@@ -0,0 +1,501 @@
|
||||
using Unity.Mathematics;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
|
||||
#pragma warning disable IDE0001
|
||||
/// <summary>
|
||||
/// A subclass of <see cref="NetworkTransform"/> that supports basic client anticipation - the client
|
||||
/// can set a value on the belief that the server will update it to reflect the same value in a future update
|
||||
/// (i.e., as the result of an RPC call). This value can then be adjusted as new updates from the server come in,
|
||||
/// in three basic modes:
|
||||
///
|
||||
/// <list type="bullet">
|
||||
///
|
||||
/// <item><b>Snap:</b> In this mode (with <see cref="StaleDataHandling"/> set to
|
||||
/// <see cref="StaleDataHandling.Ignore"/> and no <see cref="NetworkBehaviour.OnReanticipate"/> callback),
|
||||
/// the moment a more up-to-date value is received from the authority, it will simply replace the anticipated value,
|
||||
/// resulting in a "snap" to the new value if it is different from the anticipated value.</item>
|
||||
///
|
||||
/// <item><b>Smooth:</b> In this mode (with <see cref="StaleDataHandling"/> set to
|
||||
/// <see cref="Netcode.StaleDataHandling.Ignore"/> and an <see cref="NetworkBehaviour.OnReanticipate"/> callback that calls
|
||||
/// <see cref="Smooth"/> from the anticipated value to the authority value with an appropriate
|
||||
/// <see cref="Mathf.Lerp"/>-style smooth function), when a more up-to-date value is received from the authority,
|
||||
/// it will interpolate over time from an incorrect anticipated value to the correct authoritative value.</item>
|
||||
///
|
||||
/// <item><b>Constant Reanticipation:</b> In this mode (with <see cref="StaleDataHandling"/> set to
|
||||
/// <see cref="Netcode.StaleDataHandling.Reanticipate"/> and an <see cref="NetworkBehaviour.OnReanticipate"/> that calculates a
|
||||
/// new anticipated value based on the current authoritative value), when a more up-to-date value is received from
|
||||
/// the authority, user code calculates a new anticipated value, possibly calling <see cref="Smooth"/> to interpolate
|
||||
/// between the previous anticipation and the new anticipation. This is useful for values that change frequently and
|
||||
/// need to constantly be re-evaluated, as opposed to values that change only in response to user action and simply
|
||||
/// need a one-time anticipation when the user performs that action.</item>
|
||||
///
|
||||
/// </list>
|
||||
///
|
||||
/// Note that these three modes may be combined. For example, if an <see cref="NetworkBehaviour.OnReanticipate"/> callback
|
||||
/// does not call either <see cref="Smooth"/> or one of the Anticipate methods, the result will be a snap to the
|
||||
/// authoritative value, enabling for a callback that may conditionally call <see cref="Smooth"/> when the
|
||||
/// difference between the anticipated and authoritative values is within some threshold, but fall back to
|
||||
/// snap behavior if the difference is too large.
|
||||
/// </summary>
|
||||
#pragma warning restore IDE0001
|
||||
[DisallowMultipleComponent]
|
||||
[AddComponentMenu("Netcode/Anticipated Network Transform")]
|
||||
public class AnticipatedNetworkTransform : NetworkTransform
|
||||
{
|
||||
|
||||
#if UNITY_EDITOR
|
||||
internal override bool HideInterpolateValue => true;
|
||||
#endif
|
||||
|
||||
public struct TransformState
|
||||
{
|
||||
public Vector3 Position;
|
||||
public Quaternion Rotation;
|
||||
public Vector3 Scale;
|
||||
}
|
||||
|
||||
private TransformState m_AuthoritativeTransform = new TransformState();
|
||||
private TransformState m_AnticipatedTransform = new TransformState();
|
||||
private TransformState m_PreviousAnticipatedTransform = new TransformState();
|
||||
private ulong m_LastAnticipaionCounter;
|
||||
private ulong m_LastAuthorityUpdateCounter;
|
||||
|
||||
private TransformState m_SmoothFrom;
|
||||
private TransformState m_SmoothTo;
|
||||
private float m_SmoothDuration;
|
||||
private float m_CurrentSmoothTime;
|
||||
|
||||
private bool m_OutstandingAuthorityChange = false;
|
||||
|
||||
#if UNITY_EDITOR
|
||||
private void Reset()
|
||||
{
|
||||
// Anticipation + smoothing is a form of interpolation, and adding NetworkTransform's buffered interpolation
|
||||
// makes the anticipation get weird, so we default it to false.
|
||||
Interpolate = false;
|
||||
}
|
||||
#endif
|
||||
|
||||
#pragma warning disable IDE0001
|
||||
/// <summary>
|
||||
/// Defines what the behavior should be if we receive a value from the server with an earlier associated
|
||||
/// time value than the anticipation time value.
|
||||
/// <br/><br/>
|
||||
/// If this is <see cref="Netcode.StaleDataHandling.Ignore"/>, the stale data will be ignored and the authoritative
|
||||
/// value will not replace the anticipated value until the anticipation time is reached. <see cref="OnAuthoritativeValueChanged"/>
|
||||
/// and <see cref="OnReanticipate"/> will also not be invoked for this stale data.
|
||||
/// <br/><br/>
|
||||
/// If this is <see cref="Netcode.StaleDataHandling.Reanticipate"/>, the stale data will replace the anticipated data and
|
||||
/// <see cref="OnAuthoritativeValueChanged"/> and <see cref="OnReanticipate"/> will be invoked.
|
||||
/// In this case, the authoritativeTime value passed to <see cref="OnReanticipate"/> will be lower than
|
||||
/// the anticipationTime value, and that callback can be used to calculate a new anticipated value.
|
||||
/// </summary>
|
||||
#pragma warning restore IDE0001
|
||||
public StaleDataHandling StaleDataHandling = StaleDataHandling.Reanticipate;
|
||||
|
||||
/// <summary>
|
||||
/// Contains the current state of this transform on the server side.
|
||||
/// Note that, on the server side, this gets updated at the end of the frame, and will not immediately reflect
|
||||
/// changes to the transform.
|
||||
/// </summary>
|
||||
public TransformState AuthoritativeState => m_AuthoritativeTransform;
|
||||
|
||||
/// <summary>
|
||||
/// Contains the current anticipated state, which will match the values of this object's
|
||||
/// actual <see cref="MonoBehaviour.transform"/>. When a server
|
||||
/// update arrives, this value will be overwritten by the new
|
||||
/// server value (unless stale data handling is set to "Ignore"
|
||||
/// and the update is determined to be stale). This value will
|
||||
/// be duplicated in <see cref="PreviousAnticipatedState"/>, which
|
||||
/// will NOT be overwritten in server updates.
|
||||
/// </summary>
|
||||
public TransformState AnticipatedState => m_AnticipatedTransform;
|
||||
|
||||
/// <summary>
|
||||
/// Indicates whether this transform currently needs
|
||||
/// reanticipation. If this is true, the anticipated value
|
||||
/// has been overwritten by the authoritative value from the
|
||||
/// server; the previous anticipated value is stored in <see cref="PreviousAnticipatedState"/>
|
||||
/// </summary>
|
||||
public bool ShouldReanticipate
|
||||
{
|
||||
get;
|
||||
private set;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Holds the most recent anticipated state, whatever was
|
||||
/// most recently set using the Anticipate methods. Unlike
|
||||
/// <see cref="AnticipatedState"/>, this does not get overwritten
|
||||
/// when a server update arrives.
|
||||
/// </summary>
|
||||
public TransformState PreviousAnticipatedState => m_PreviousAnticipatedTransform;
|
||||
|
||||
/// <summary>
|
||||
/// Anticipate that, at the end of one round trip to the server, this transform will be in the given
|
||||
/// <see cref="newPosition"/>
|
||||
/// </summary>
|
||||
/// <param name="newPosition"></param>
|
||||
public void AnticipateMove(Vector3 newPosition)
|
||||
{
|
||||
if (NetworkManager.ShutdownInProgress || !NetworkManager.IsListening)
|
||||
{
|
||||
return;
|
||||
}
|
||||
transform.position = newPosition;
|
||||
m_AnticipatedTransform.Position = newPosition;
|
||||
if (CanCommitToTransform)
|
||||
{
|
||||
m_AuthoritativeTransform.Position = newPosition;
|
||||
}
|
||||
|
||||
m_PreviousAnticipatedTransform = m_AnticipatedTransform;
|
||||
|
||||
m_LastAnticipaionCounter = NetworkManager.AnticipationSystem.AnticipationCounter;
|
||||
|
||||
m_SmoothDuration = 0;
|
||||
m_CurrentSmoothTime = 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Anticipate that, at the end of one round trip to the server, this transform will have the given
|
||||
/// <see cref="newRotation"/>
|
||||
/// </summary>
|
||||
/// <param name="newRotation"></param>
|
||||
public void AnticipateRotate(Quaternion newRotation)
|
||||
{
|
||||
if (NetworkManager.ShutdownInProgress || !NetworkManager.IsListening)
|
||||
{
|
||||
return;
|
||||
}
|
||||
transform.rotation = newRotation;
|
||||
m_AnticipatedTransform.Rotation = newRotation;
|
||||
if (CanCommitToTransform)
|
||||
{
|
||||
m_AuthoritativeTransform.Rotation = newRotation;
|
||||
}
|
||||
|
||||
m_PreviousAnticipatedTransform = m_AnticipatedTransform;
|
||||
|
||||
m_LastAnticipaionCounter = NetworkManager.AnticipationSystem.AnticipationCounter;
|
||||
|
||||
m_SmoothDuration = 0;
|
||||
m_CurrentSmoothTime = 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Anticipate that, at the end of one round trip to the server, this transform will have the given
|
||||
/// <see cref="newScale"/>
|
||||
/// </summary>
|
||||
/// <param name="newScale"></param>
|
||||
public void AnticipateScale(Vector3 newScale)
|
||||
{
|
||||
if (NetworkManager.ShutdownInProgress || !NetworkManager.IsListening)
|
||||
{
|
||||
return;
|
||||
}
|
||||
transform.localScale = newScale;
|
||||
m_AnticipatedTransform.Scale = newScale;
|
||||
if (CanCommitToTransform)
|
||||
{
|
||||
m_AuthoritativeTransform.Scale = newScale;
|
||||
}
|
||||
|
||||
m_PreviousAnticipatedTransform = m_AnticipatedTransform;
|
||||
|
||||
m_LastAnticipaionCounter = NetworkManager.AnticipationSystem.AnticipationCounter;
|
||||
|
||||
m_SmoothDuration = 0;
|
||||
m_CurrentSmoothTime = 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Anticipate that, at the end of one round trip to the server, the transform will have the given
|
||||
/// <see cref="newState"/>
|
||||
/// </summary>
|
||||
/// <param name="newState"></param>
|
||||
public void AnticipateState(TransformState newState)
|
||||
{
|
||||
if (NetworkManager.ShutdownInProgress || !NetworkManager.IsListening)
|
||||
{
|
||||
return;
|
||||
}
|
||||
var transform_ = transform;
|
||||
transform_.position = newState.Position;
|
||||
transform_.rotation = newState.Rotation;
|
||||
transform_.localScale = newState.Scale;
|
||||
m_AnticipatedTransform = newState;
|
||||
if (CanCommitToTransform)
|
||||
{
|
||||
m_AuthoritativeTransform = newState;
|
||||
}
|
||||
|
||||
m_PreviousAnticipatedTransform = m_AnticipatedTransform;
|
||||
|
||||
m_SmoothDuration = 0;
|
||||
m_CurrentSmoothTime = 0;
|
||||
}
|
||||
|
||||
public override void OnUpdate()
|
||||
{
|
||||
// If not spawned or this instance has authority, exit early
|
||||
if (!IsSpawned)
|
||||
{
|
||||
return;
|
||||
}
|
||||
// Do not call the base class implementation...
|
||||
// AnticipatedNetworkTransform applies its authoritative state immediately rather than waiting for update
|
||||
// This is because AnticipatedNetworkTransforms may need to reference each other in reanticipating
|
||||
// and we will want all reanticipation done before anything else wants to reference the transform in
|
||||
// OnUpdate()
|
||||
//base.Update();
|
||||
|
||||
if (m_CurrentSmoothTime < m_SmoothDuration)
|
||||
{
|
||||
m_CurrentSmoothTime += NetworkManager.RealTimeProvider.DeltaTime;
|
||||
var transform_ = transform;
|
||||
var pct = math.min(m_CurrentSmoothTime / m_SmoothDuration, 1f);
|
||||
|
||||
m_AnticipatedTransform = new TransformState
|
||||
{
|
||||
Position = Vector3.Lerp(m_SmoothFrom.Position, m_SmoothTo.Position, pct),
|
||||
Rotation = Quaternion.Slerp(m_SmoothFrom.Rotation, m_SmoothTo.Rotation, pct),
|
||||
Scale = Vector3.Lerp(m_SmoothFrom.Scale, m_SmoothTo.Scale, pct)
|
||||
};
|
||||
m_PreviousAnticipatedTransform = m_AnticipatedTransform;
|
||||
if (!CanCommitToTransform)
|
||||
{
|
||||
transform_.position = m_AnticipatedTransform.Position;
|
||||
transform_.localScale = m_AnticipatedTransform.Scale;
|
||||
transform_.rotation = m_AnticipatedTransform.Rotation;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
internal class AnticipatedObject : IAnticipationEventReceiver, IAnticipatedObject
|
||||
{
|
||||
public AnticipatedNetworkTransform Transform;
|
||||
|
||||
|
||||
public void SetupForRender()
|
||||
{
|
||||
if (Transform.CanCommitToTransform)
|
||||
{
|
||||
var transform_ = Transform.transform;
|
||||
Transform.m_AuthoritativeTransform = new TransformState
|
||||
{
|
||||
Position = transform_.position,
|
||||
Rotation = transform_.rotation,
|
||||
Scale = transform_.localScale
|
||||
};
|
||||
if (Transform.m_CurrentSmoothTime >= Transform.m_SmoothDuration)
|
||||
{
|
||||
// If we've had a call to Smooth() we'll continue interpolating.
|
||||
// Otherwise we'll go ahead and make the visual and actual locations
|
||||
// match.
|
||||
Transform.m_AnticipatedTransform = Transform.m_AuthoritativeTransform;
|
||||
}
|
||||
|
||||
transform_.position = Transform.m_AnticipatedTransform.Position;
|
||||
transform_.rotation = Transform.m_AnticipatedTransform.Rotation;
|
||||
transform_.localScale = Transform.m_AnticipatedTransform.Scale;
|
||||
}
|
||||
}
|
||||
|
||||
public void SetupForUpdate()
|
||||
{
|
||||
if (Transform.CanCommitToTransform)
|
||||
{
|
||||
var transform_ = Transform.transform;
|
||||
transform_.position = Transform.m_AuthoritativeTransform.Position;
|
||||
transform_.rotation = Transform.m_AuthoritativeTransform.Rotation;
|
||||
transform_.localScale = Transform.m_AuthoritativeTransform.Scale;
|
||||
}
|
||||
}
|
||||
|
||||
public void Update()
|
||||
{
|
||||
// No need to do this, it's handled by NetworkTransform.OnUpdate
|
||||
}
|
||||
|
||||
public void ResetAnticipation()
|
||||
{
|
||||
Transform.ShouldReanticipate = false;
|
||||
}
|
||||
|
||||
public NetworkObject OwnerObject => Transform.NetworkObject;
|
||||
}
|
||||
|
||||
private AnticipatedObject m_AnticipatedObject = null;
|
||||
|
||||
private void ResetAnticipatedState()
|
||||
{
|
||||
var transform_ = transform;
|
||||
m_AuthoritativeTransform = new TransformState
|
||||
{
|
||||
Position = transform_.position,
|
||||
Rotation = transform_.rotation,
|
||||
Scale = transform_.localScale
|
||||
};
|
||||
m_AnticipatedTransform = m_AuthoritativeTransform;
|
||||
m_PreviousAnticipatedTransform = m_AnticipatedTransform;
|
||||
|
||||
m_SmoothDuration = 0;
|
||||
m_CurrentSmoothTime = 0;
|
||||
}
|
||||
|
||||
protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer)
|
||||
{
|
||||
base.OnSynchronize(ref serializer);
|
||||
if (!CanCommitToTransform)
|
||||
{
|
||||
m_OutstandingAuthorityChange = true;
|
||||
ApplyAuthoritativeState();
|
||||
ResetAnticipatedState();
|
||||
}
|
||||
}
|
||||
|
||||
public override void OnNetworkSpawn()
|
||||
{
|
||||
if (NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
Debug.LogWarning($"This component is not currently supported in distributed authority.");
|
||||
}
|
||||
base.OnNetworkSpawn();
|
||||
m_OutstandingAuthorityChange = true;
|
||||
ApplyAuthoritativeState();
|
||||
ResetAnticipatedState();
|
||||
|
||||
m_AnticipatedObject = new AnticipatedObject { Transform = this };
|
||||
NetworkManager.AnticipationSystem.RegisterForAnticipationEvents(m_AnticipatedObject);
|
||||
NetworkManager.AnticipationSystem.AllAnticipatedObjects.Add(m_AnticipatedObject);
|
||||
}
|
||||
|
||||
public override void OnNetworkDespawn()
|
||||
{
|
||||
if (m_AnticipatedObject != null)
|
||||
{
|
||||
NetworkManager.AnticipationSystem.DeregisterForAnticipationEvents(m_AnticipatedObject);
|
||||
NetworkManager.AnticipationSystem.AllAnticipatedObjects.Remove(m_AnticipatedObject);
|
||||
NetworkManager.AnticipationSystem.ObjectsToReanticipate.Remove(m_AnticipatedObject);
|
||||
m_AnticipatedObject = null;
|
||||
}
|
||||
ResetAnticipatedState();
|
||||
|
||||
base.OnNetworkDespawn();
|
||||
}
|
||||
|
||||
public override void OnDestroy()
|
||||
{
|
||||
if (m_AnticipatedObject != null)
|
||||
{
|
||||
NetworkManager.AnticipationSystem.DeregisterForAnticipationEvents(m_AnticipatedObject);
|
||||
NetworkManager.AnticipationSystem.AllAnticipatedObjects.Remove(m_AnticipatedObject);
|
||||
NetworkManager.AnticipationSystem.ObjectsToReanticipate.Remove(m_AnticipatedObject);
|
||||
m_AnticipatedObject = null;
|
||||
}
|
||||
|
||||
base.OnDestroy();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Interpolate between the transform represented by <see cref="from"/> to the transform represented by
|
||||
/// <see cref="to"/> over <see cref="durationSeconds"/> of real time. The duration uses
|
||||
/// <see cref="Time.deltaTime"/>, so it is affected by <see cref="Time.timeScale"/>.
|
||||
/// </summary>
|
||||
/// <param name="from"></param>
|
||||
/// <param name="to"></param>
|
||||
/// <param name="durationSeconds"></param>
|
||||
public void Smooth(TransformState from, TransformState to, float durationSeconds)
|
||||
{
|
||||
var transform_ = transform;
|
||||
if (durationSeconds <= 0)
|
||||
{
|
||||
m_AnticipatedTransform = to;
|
||||
m_PreviousAnticipatedTransform = m_AnticipatedTransform;
|
||||
transform_.position = to.Position;
|
||||
transform_.rotation = to.Rotation;
|
||||
transform_.localScale = to.Scale;
|
||||
m_SmoothDuration = 0;
|
||||
m_CurrentSmoothTime = 0;
|
||||
return;
|
||||
}
|
||||
m_AnticipatedTransform = from;
|
||||
m_PreviousAnticipatedTransform = m_AnticipatedTransform;
|
||||
|
||||
if (!CanCommitToTransform)
|
||||
{
|
||||
transform_.position = from.Position;
|
||||
transform_.rotation = from.Rotation;
|
||||
transform_.localScale = from.Scale;
|
||||
}
|
||||
|
||||
m_SmoothFrom = from;
|
||||
m_SmoothTo = to;
|
||||
m_SmoothDuration = durationSeconds;
|
||||
m_CurrentSmoothTime = 0;
|
||||
}
|
||||
|
||||
protected override void OnBeforeUpdateTransformState()
|
||||
{
|
||||
// this is called when new data comes from the server
|
||||
m_LastAuthorityUpdateCounter = NetworkManager.AnticipationSystem.LastAnticipationAck;
|
||||
m_OutstandingAuthorityChange = true;
|
||||
}
|
||||
|
||||
protected override void OnNetworkTransformStateUpdated(ref NetworkTransformState oldState, ref NetworkTransformState newState)
|
||||
{
|
||||
base.OnNetworkTransformStateUpdated(ref oldState, ref newState);
|
||||
ApplyAuthoritativeState();
|
||||
}
|
||||
|
||||
protected override void OnTransformUpdated()
|
||||
{
|
||||
if (CanCommitToTransform || m_AnticipatedObject == null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
// this is called pretty much every frame and will change the transform
|
||||
// If we've overridden the transform with an anticipated state, we need to be able to change it back
|
||||
// to the anticipated state (while updating the authority state accordingly) or else
|
||||
// mark this transform for reanticipation
|
||||
var transform_ = transform;
|
||||
|
||||
var previousAnticipatedTransform = m_AnticipatedTransform;
|
||||
|
||||
// Update authority state to catch any possible interpolation data
|
||||
m_AuthoritativeTransform.Position = transform_.position;
|
||||
m_AuthoritativeTransform.Rotation = transform_.rotation;
|
||||
m_AuthoritativeTransform.Scale = transform_.localScale;
|
||||
|
||||
if (!m_OutstandingAuthorityChange)
|
||||
{
|
||||
// Keep the anticipated value unchanged, we have no updates from the server at all.
|
||||
transform_.position = previousAnticipatedTransform.Position;
|
||||
transform_.localScale = previousAnticipatedTransform.Scale;
|
||||
transform_.rotation = previousAnticipatedTransform.Rotation;
|
||||
return;
|
||||
}
|
||||
|
||||
if (StaleDataHandling == StaleDataHandling.Ignore && m_LastAnticipaionCounter > m_LastAuthorityUpdateCounter)
|
||||
{
|
||||
// Keep the anticipated value unchanged because it is more recent than the authoritative one.
|
||||
transform_.position = previousAnticipatedTransform.Position;
|
||||
transform_.localScale = previousAnticipatedTransform.Scale;
|
||||
transform_.rotation = previousAnticipatedTransform.Rotation;
|
||||
return;
|
||||
}
|
||||
|
||||
m_SmoothDuration = 0;
|
||||
m_CurrentSmoothTime = 0;
|
||||
m_OutstandingAuthorityChange = false;
|
||||
m_AnticipatedTransform = m_AuthoritativeTransform;
|
||||
|
||||
ShouldReanticipate = true;
|
||||
NetworkManager.AnticipationSystem.ObjectsToReanticipate.Add(m_AnticipatedObject);
|
||||
}
|
||||
}
|
||||
}
|
||||
2
Runtime/Components/AnticipatedNetworkTransform.cs.meta
Normal file
2
Runtime/Components/AnticipatedNetworkTransform.cs.meta
Normal file
@@ -0,0 +1,2 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 5abfce83aadd948498d4990c645a017b
|
||||
@@ -8,7 +8,7 @@ namespace Unity.Netcode.Components
|
||||
/// Half float precision <see cref="Vector3"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The Vector3T<ushort> values are half float values returned by <see cref="Mathf.FloatToHalf(float)"/> for each
|
||||
/// The Vector3T<ushort> values are half float values returned by <see cref="Mathf.FloatToHalf(float)"/> for each
|
||||
/// individual axis and the 16 bits of the half float are stored as <see cref="ushort"/> values since C# does not have
|
||||
/// a half float type.
|
||||
/// </remarks>
|
||||
@@ -8,7 +8,7 @@ namespace Unity.Netcode.Components
|
||||
/// Half Precision <see cref="Vector4"/> that can also be used to convert a <see cref="Quaternion"/> to half precision.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The Vector4T<ushort> values are half float values returned by <see cref="Mathf.FloatToHalf(float)"/> for each
|
||||
/// The Vector4T<ushort> values are half float values returned by <see cref="Mathf.FloatToHalf(float)"/> for each
|
||||
/// individual axis and the 16 bits of the half float are stored as <see cref="ushort"/> values since C# does not have
|
||||
/// a half float type.
|
||||
/// </remarks>
|
||||
@@ -5,7 +5,7 @@ using UnityEngine;
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// Solves for incoming values that are jittered
|
||||
/// Solves for incoming values that are jittered.
|
||||
/// Partially solves for message loss. Unclamped lerping helps hide this, but not completely
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of interpolated value</typeparam>
|
||||
@@ -195,7 +195,9 @@ namespace Unity.Netcode
|
||||
double range = m_EndTimeConsumed - m_StartTimeConsumed;
|
||||
if (range > k_SmallValue)
|
||||
{
|
||||
t = (float)((renderTime - m_StartTimeConsumed) / range);
|
||||
var rangeFactor = 1.0f / (float)range;
|
||||
|
||||
t = ((float)renderTime - (float)m_StartTimeConsumed) * rangeFactor;
|
||||
|
||||
if (t < 0.0f)
|
||||
{
|
||||
@@ -25,26 +25,48 @@ namespace Unity.Netcode.Components
|
||||
{
|
||||
foreach (var animationUpdate in m_SendAnimationUpdates)
|
||||
{
|
||||
m_NetworkAnimator.SendAnimStateClientRpc(animationUpdate.AnimationMessage, animationUpdate.ClientRpcParams);
|
||||
|
||||
if (m_NetworkAnimator.NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
m_NetworkAnimator.SendAnimStateRpc(animationUpdate.AnimationMessage);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_NetworkAnimator.SendAnimStateClientRpc(animationUpdate.AnimationMessage, animationUpdate.ClientRpcParams);
|
||||
}
|
||||
}
|
||||
|
||||
m_SendAnimationUpdates.Clear();
|
||||
|
||||
foreach (var sendEntry in m_SendParameterUpdates)
|
||||
{
|
||||
m_NetworkAnimator.SendParametersUpdateClientRpc(sendEntry.ParametersUpdateMessage, sendEntry.ClientRpcParams);
|
||||
if (m_NetworkAnimator.NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
m_NetworkAnimator.SendParametersUpdateRpc(sendEntry.ParametersUpdateMessage);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_NetworkAnimator.SendParametersUpdateClientRpc(sendEntry.ParametersUpdateMessage, sendEntry.ClientRpcParams);
|
||||
}
|
||||
}
|
||||
m_SendParameterUpdates.Clear();
|
||||
|
||||
foreach (var sendEntry in m_SendTriggerUpdates)
|
||||
{
|
||||
if (!sendEntry.SendToServer)
|
||||
if (m_NetworkAnimator.NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
m_NetworkAnimator.SendAnimTriggerClientRpc(sendEntry.AnimationTriggerMessage, sendEntry.ClientRpcParams);
|
||||
m_NetworkAnimator.SendAnimTriggerRpc(sendEntry.AnimationTriggerMessage);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_NetworkAnimator.SendAnimTriggerServerRpc(sendEntry.AnimationTriggerMessage);
|
||||
if (!sendEntry.SendToServer)
|
||||
{
|
||||
m_NetworkAnimator.SendAnimTriggerClientRpc(sendEntry.AnimationTriggerMessage, sendEntry.ClientRpcParams);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_NetworkAnimator.SendAnimTriggerServerRpc(sendEntry.AnimationTriggerMessage);
|
||||
}
|
||||
}
|
||||
}
|
||||
m_SendTriggerUpdates.Clear();
|
||||
@@ -164,7 +186,6 @@ namespace Unity.Netcode.Components
|
||||
/// NetworkAnimator enables remote synchronization of <see cref="UnityEngine.Animator"/> state for on network objects.
|
||||
/// </summary>
|
||||
[AddComponentMenu("Netcode/Network Animator")]
|
||||
[RequireComponent(typeof(Animator))]
|
||||
public class NetworkAnimator : NetworkBehaviour, ISerializationCallbackReceiver
|
||||
{
|
||||
[Serializable]
|
||||
@@ -652,17 +673,14 @@ namespace Unity.Netcode.Components
|
||||
NetworkLog.LogWarningServer($"[{gameObject.name}][{nameof(NetworkAnimator)}] {nameof(Animator)} is not assigned! Animation synchronization will not work for this instance!");
|
||||
}
|
||||
|
||||
if (IsServer)
|
||||
m_ClientSendList = new List<ulong>(128);
|
||||
m_ClientRpcParams = new ClientRpcParams
|
||||
{
|
||||
m_ClientSendList = new List<ulong>(128);
|
||||
m_ClientRpcParams = new ClientRpcParams
|
||||
Send = new ClientRpcSendParams
|
||||
{
|
||||
Send = new ClientRpcSendParams
|
||||
{
|
||||
TargetClientIds = m_ClientSendList
|
||||
}
|
||||
};
|
||||
}
|
||||
TargetClientIds = m_ClientSendList
|
||||
}
|
||||
};
|
||||
|
||||
// Create a handler for state changes
|
||||
m_NetworkAnimatorStateChangeHandler = new NetworkAnimatorStateChangeHandler(this);
|
||||
@@ -833,8 +851,7 @@ namespace Unity.Netcode.Components
|
||||
stateChangeDetected = true;
|
||||
//Debug.Log($"[Cross-Fade] To-Hash: {nt.fullPathHash} | TI-Duration: ({tt.duration}) | TI-Norm: ({tt.normalizedTime}) | From-Hash: ({m_AnimationHash[layer]}) | SI-FPHash: ({st.fullPathHash}) | SI-Norm: ({st.normalizedTime})");
|
||||
}
|
||||
else
|
||||
if (!tt.anyState && tt.fullPathHash != m_TransitionHash[layer])
|
||||
else if (!tt.anyState && tt.fullPathHash != m_TransitionHash[layer])
|
||||
{
|
||||
// first time in this transition for this layer
|
||||
m_TransitionHash[layer] = tt.fullPathHash;
|
||||
@@ -909,6 +926,11 @@ namespace Unity.Netcode.Components
|
||||
// Send an AnimationMessage only if there are dirty AnimationStates to send
|
||||
if (m_AnimationMessage.IsDirtyCount > 0)
|
||||
{
|
||||
if (NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
SendAnimStateRpc(m_AnimationMessage);
|
||||
}
|
||||
else
|
||||
if (!IsServer && IsOwner)
|
||||
{
|
||||
SendAnimStateServerRpc(m_AnimationMessage);
|
||||
@@ -933,20 +955,33 @@ namespace Unity.Netcode.Components
|
||||
{
|
||||
Parameters = m_ParameterWriter.ToArray()
|
||||
};
|
||||
|
||||
if (!IsServer)
|
||||
if (NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
SendParametersUpdateServerRpc(parametersMessage);
|
||||
}
|
||||
else
|
||||
{
|
||||
if (sendDirect)
|
||||
if (IsOwner)
|
||||
{
|
||||
SendParametersUpdateClientRpc(parametersMessage, clientRpcParams);
|
||||
SendParametersUpdateRpc(parametersMessage);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_NetworkAnimatorStateChangeHandler.SendParameterUpdate(parametersMessage, clientRpcParams);
|
||||
Debug.LogError($"[{name}][Client-{NetworkManager.LocalClientId}] Attempting to send parameter updates but not the owner!");
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if (!IsServer)
|
||||
{
|
||||
SendParametersUpdateServerRpc(parametersMessage);
|
||||
}
|
||||
else
|
||||
{
|
||||
if (sendDirect)
|
||||
{
|
||||
SendParametersUpdateClientRpc(parametersMessage, clientRpcParams);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_NetworkAnimatorStateChangeHandler.SendParameterUpdate(parametersMessage, clientRpcParams);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1053,8 +1088,7 @@ namespace Unity.Netcode.Components
|
||||
BytePacker.WriteValuePacked(writer, valueBool);
|
||||
}
|
||||
}
|
||||
else
|
||||
if (cacheValue.Type == AnimationParamEnumWrapper.AnimatorControllerParameterFloat)
|
||||
else if (cacheValue.Type == AnimationParamEnumWrapper.AnimatorControllerParameterFloat)
|
||||
{
|
||||
var valueFloat = m_Animator.GetFloat(hash);
|
||||
fixed (void* value = cacheValue.Value)
|
||||
@@ -1227,10 +1261,19 @@ namespace Unity.Netcode.Components
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Updates the client's animator's parameters
|
||||
/// Distributed Authority: Updates the client's animator's parameters
|
||||
/// </summary>
|
||||
[Rpc(SendTo.NotAuthority)]
|
||||
internal void SendParametersUpdateRpc(ParametersUpdateMessage parametersUpdate)
|
||||
{
|
||||
m_NetworkAnimatorStateChangeHandler.ProcessParameterUpdate(parametersUpdate);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Client-Server: Updates the client's animator's parameters
|
||||
/// </summary>
|
||||
[ClientRpc]
|
||||
internal unsafe void SendParametersUpdateClientRpc(ParametersUpdateMessage parametersUpdate, ClientRpcParams clientRpcParams = default)
|
||||
internal void SendParametersUpdateClientRpc(ParametersUpdateMessage parametersUpdate, ClientRpcParams clientRpcParams = default)
|
||||
{
|
||||
var isServerAuthoritative = IsServerAuthoritative();
|
||||
if (!isServerAuthoritative && !IsOwner || isServerAuthoritative)
|
||||
@@ -1244,7 +1287,7 @@ namespace Unity.Netcode.Components
|
||||
/// The server sets its local state and then forwards the message to the remaining clients
|
||||
/// </summary>
|
||||
[ServerRpc]
|
||||
private unsafe void SendAnimStateServerRpc(AnimationMessage animationMessage, ServerRpcParams serverRpcParams = default)
|
||||
private void SendAnimStateServerRpc(AnimationMessage animationMessage, ServerRpcParams serverRpcParams = default)
|
||||
{
|
||||
if (IsServerAuthoritative())
|
||||
{
|
||||
@@ -1275,26 +1318,44 @@ namespace Unity.Netcode.Components
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Internally-called RPC client receiving function to update some animation state on a client
|
||||
/// Client-Server: Internally-called RPC client-side receiving function to update animation states
|
||||
/// </summary>
|
||||
[ClientRpc]
|
||||
internal unsafe void SendAnimStateClientRpc(AnimationMessage animationMessage, ClientRpcParams clientRpcParams = default)
|
||||
internal void SendAnimStateClientRpc(AnimationMessage animationMessage, ClientRpcParams clientRpcParams = default)
|
||||
{
|
||||
// This should never happen
|
||||
if (IsHost)
|
||||
ProcessAnimStates(animationMessage);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Distributed Authority: Internally-called RPC non-authority receiving function to update animation states
|
||||
/// </summary>
|
||||
[Rpc(SendTo.NotAuthority)]
|
||||
internal void SendAnimStateRpc(AnimationMessage animationMessage)
|
||||
{
|
||||
ProcessAnimStates(animationMessage);
|
||||
}
|
||||
|
||||
private void ProcessAnimStates(AnimationMessage animationMessage)
|
||||
{
|
||||
if (HasAuthority)
|
||||
{
|
||||
if (NetworkManager.LogLevel == LogLevel.Developer)
|
||||
{
|
||||
NetworkLog.LogWarning("Detected the Host is sending itself animation updates! Please report this issue.");
|
||||
var hostOrOwner = NetworkManager.DistributedAuthorityMode ? "Owner" : "Host";
|
||||
var clientServerOrDAMode = NetworkManager.DistributedAuthorityMode ? "distributed authority" : "client-server";
|
||||
NetworkLog.LogWarning($"Detected the {hostOrOwner} is sending itself animation updates in {clientServerOrDAMode} mode! Please report this issue.");
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (var animationState in animationMessage.AnimationStates)
|
||||
{
|
||||
UpdateAnimationState(animationState);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Server-side trigger state update request
|
||||
/// The server sets its local state and then forwards the message to the remaining clients
|
||||
@@ -1339,7 +1400,18 @@ namespace Unity.Netcode.Components
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Internally-called RPC client receiving function to update a trigger when the server wants to forward
|
||||
/// Distributed Authority: Internally-called RPC client receiving function to update a trigger when the server wants to forward
|
||||
/// a trigger for a client to play / reset
|
||||
/// </summary>
|
||||
/// <param name="animationTriggerMessage">the payload containing the trigger data to apply</param>
|
||||
[Rpc(SendTo.NotAuthority)]
|
||||
internal void SendAnimTriggerRpc(AnimationTriggerMessage animationTriggerMessage)
|
||||
{
|
||||
InternalSetTrigger(animationTriggerMessage.Hash, animationTriggerMessage.IsTriggerSet);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Client Server: Internally-called RPC client receiving function to update a trigger when the server wants to forward
|
||||
/// a trigger for a client to play / reset
|
||||
/// </summary>
|
||||
/// <param name="animationTriggerMessage">the payload containing the trigger data to apply</param>
|
||||
@@ -1364,15 +1436,26 @@ namespace Unity.Netcode.Components
|
||||
/// <param name="setTrigger">sets (true) or resets (false) the trigger. The default is to set it (true).</param>
|
||||
public void SetTrigger(int hash, bool setTrigger = true)
|
||||
{
|
||||
if (!IsSpawned)
|
||||
{
|
||||
NetworkLog.LogError($"[{gameObject.name}] Cannot set a synchronized trigger when the {nameof(NetworkObject)} is not spawned!");
|
||||
return;
|
||||
}
|
||||
|
||||
// MTT-3564:
|
||||
// After fixing the issue with trigger controlled Transitions being synchronized twice,
|
||||
// it exposed additional issues with this logic. Now, either the owner or the server can
|
||||
// update triggers. Since server-side RPCs are immediately invoked, for a host a trigger
|
||||
// will happen when SendAnimTriggerClientRpc is called. For a client owner, we call the
|
||||
// SendAnimTriggerServerRpc and then trigger locally when running in owner authority mode.
|
||||
if (IsOwner || IsServer)
|
||||
var animTriggerMessage = new AnimationTriggerMessage() { Hash = hash, IsTriggerSet = setTrigger };
|
||||
if (NetworkManager.DistributedAuthorityMode && HasAuthority)
|
||||
{
|
||||
m_NetworkAnimatorStateChangeHandler.QueueTriggerUpdateToClient(animTriggerMessage);
|
||||
InternalSetTrigger(hash, setTrigger);
|
||||
}
|
||||
else if (!NetworkManager.DistributedAuthorityMode && (IsOwner || IsServer))
|
||||
{
|
||||
var animTriggerMessage = new AnimationTriggerMessage() { Hash = hash, IsTriggerSet = setTrigger };
|
||||
if (IsServer)
|
||||
{
|
||||
/// <see cref="UpdatePendingTriggerStates"/> as to why we queue
|
||||
@@ -23,12 +23,24 @@ namespace Unity.Netcode.Components
|
||||
internal Vector3 DeltaPosition;
|
||||
internal int NetworkTick;
|
||||
|
||||
internal bool SynchronizeBase;
|
||||
|
||||
internal bool CollapsedDeltaIntoBase;
|
||||
|
||||
/// <summary>
|
||||
/// The serialization implementation of <see cref="INetworkSerializable"/>
|
||||
/// </summary>
|
||||
public void NetworkSerialize<T>(BufferSerializer<T> serializer) where T : IReaderWriter
|
||||
{
|
||||
HalfVector3.NetworkSerialize(serializer);
|
||||
if (!SynchronizeBase)
|
||||
{
|
||||
HalfVector3.NetworkSerialize(serializer);
|
||||
}
|
||||
else
|
||||
{
|
||||
serializer.SerializeValue(ref DeltaPosition);
|
||||
serializer.SerializeValue(ref CurrentBasePosition);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -122,6 +134,7 @@ namespace Unity.Netcode.Components
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void UpdateFrom(ref Vector3 vector3, int networkTick)
|
||||
{
|
||||
CollapsedDeltaIntoBase = false;
|
||||
NetworkTick = networkTick;
|
||||
DeltaPosition = (vector3 + PrecisionLossDelta) - CurrentBasePosition;
|
||||
for (int i = 0; i < HalfVector3.Length; i++)
|
||||
@@ -136,6 +149,7 @@ namespace Unity.Netcode.Components
|
||||
CurrentBasePosition[i] += HalfDeltaConvertedBack[i];
|
||||
HalfDeltaConvertedBack[i] = 0.0f;
|
||||
DeltaPosition[i] = 0.0f;
|
||||
CollapsedDeltaIntoBase = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -164,6 +178,8 @@ namespace Unity.Netcode.Components
|
||||
DeltaPosition = Vector3.zero;
|
||||
HalfDeltaConvertedBack = Vector3.zero;
|
||||
HalfVector3 = new HalfVector3(vector3, axisToSynchronize);
|
||||
SynchronizeBase = false;
|
||||
CollapsedDeltaIntoBase = false;
|
||||
UpdateFrom(ref vector3, networkTick);
|
||||
}
|
||||
|
||||
876
Runtime/Components/NetworkRigidBodyBase.cs
Normal file
876
Runtime/Components/NetworkRigidBodyBase.cs
Normal file
@@ -0,0 +1,876 @@
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
using System.Runtime.CompilerServices;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
/// <summary>
|
||||
/// NetworkRigidbodyBase is a unified <see cref="Rigidbody"/> and <see cref="Rigidbody2D"/> integration that helps to synchronize physics motion, collision, and interpolation
|
||||
/// when used with a <see cref="NetworkTransform"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// For a customizable netcode Rigidbody, create your own component from this class and use <see cref="Initialize(RigidbodyTypes, NetworkTransform, Rigidbody2D, Rigidbody)"/>
|
||||
/// during instantiation (i.e. invoked from within the Awake method). You can re-initialize after having initialized but only when the <see cref="NetworkObject"/> is not spawned.
|
||||
/// </remarks>
|
||||
public abstract class NetworkRigidbodyBase : NetworkBehaviour
|
||||
{
|
||||
/// <summary>
|
||||
/// When enabled, the associated <see cref="NetworkTransform"/> will use the Rigidbody/Rigidbody2D to apply and synchronize changes in position, rotation, and
|
||||
/// allows for the use of Rigidbody interpolation/extrapolation.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// If <see cref="NetworkTransform.Interpolate"/> is enabled, non-authoritative instances can only use Rigidbody interpolation. If a network prefab is set to
|
||||
/// extrapolation and <see cref="NetworkTransform.Interpolate"/> is enabled, then non-authoritative instances will automatically be adjusted to use Rigidbody
|
||||
/// interpolation while the authoritative instance will still use extrapolation.
|
||||
/// </remarks>
|
||||
[Tooltip("When enabled and a NetworkTransform component is attached, the NetworkTransform will use the rigid body for motion and detecting changes in state.")]
|
||||
public bool UseRigidBodyForMotion;
|
||||
|
||||
/// <summary>
|
||||
/// When enabled (default), automatically set the Kinematic state of the Rigidbody based on ownership.
|
||||
/// When disabled, Kinematic state needs to be set by external script(s).
|
||||
/// </summary>
|
||||
public bool AutoUpdateKinematicState = true;
|
||||
|
||||
/// <summary>
|
||||
/// Primarily applies to the <see cref="AutoUpdateKinematicState"/> property when disabled but you still want
|
||||
/// the Rigidbody to be automatically set to Kinematic when despawned.
|
||||
/// </summary>
|
||||
public bool AutoSetKinematicOnDespawn = true;
|
||||
|
||||
// Determines if this is a Rigidbody or Rigidbody2D implementation
|
||||
private bool m_IsRigidbody2D => RigidbodyType == RigidbodyTypes.Rigidbody2D;
|
||||
// Used to cache the authority state of this Rigidbody during the last frame
|
||||
private bool m_IsAuthority;
|
||||
private Rigidbody m_Rigidbody;
|
||||
private Rigidbody2D m_Rigidbody2D;
|
||||
internal NetworkTransform NetworkTransform;
|
||||
private float m_TickFrequency;
|
||||
private float m_TickRate;
|
||||
|
||||
private enum InterpolationTypes
|
||||
{
|
||||
None,
|
||||
Interpolate,
|
||||
Extrapolate
|
||||
}
|
||||
private InterpolationTypes m_OriginalInterpolation;
|
||||
|
||||
/// <summary>
|
||||
/// Used to define the type of Rigidbody implemented.
|
||||
/// <see cref=""/>
|
||||
/// </summary>
|
||||
public enum RigidbodyTypes
|
||||
{
|
||||
Rigidbody,
|
||||
Rigidbody2D,
|
||||
}
|
||||
|
||||
public RigidbodyTypes RigidbodyType { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Initializes the networked Rigidbody based on the <see cref="RigidbodyTypes"/>
|
||||
/// passed in as a parameter.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Cannot be initialized while the associated <see cref="NetworkObject"/> is spawned.
|
||||
/// </remarks>
|
||||
/// <param name="rigidbodyType">type of rigid body being initialized</param>
|
||||
/// <param name="rigidbody2D">(optional) The <see cref="Rigidbody2D"/> to be used</param>
|
||||
/// <param name="rigidbody">(optional) The <see cref="Rigidbody"/> to be used</param>
|
||||
protected void Initialize(RigidbodyTypes rigidbodyType, NetworkTransform networkTransform = null, Rigidbody2D rigidbody2D = null, Rigidbody rigidbody = null)
|
||||
{
|
||||
// Don't initialize if already spawned
|
||||
if (IsSpawned)
|
||||
{
|
||||
Debug.LogError($"[{name}] Attempting to initialize while spawned is not allowed.");
|
||||
return;
|
||||
}
|
||||
RigidbodyType = rigidbodyType;
|
||||
m_Rigidbody2D = rigidbody2D;
|
||||
m_Rigidbody = rigidbody;
|
||||
NetworkTransform = networkTransform;
|
||||
|
||||
if (m_IsRigidbody2D && m_Rigidbody2D == null)
|
||||
{
|
||||
m_Rigidbody2D = GetComponent<Rigidbody2D>();
|
||||
|
||||
}
|
||||
else if (m_Rigidbody == null)
|
||||
{
|
||||
m_Rigidbody = GetComponent<Rigidbody>();
|
||||
}
|
||||
|
||||
SetOriginalInterpolation();
|
||||
|
||||
if (NetworkTransform == null)
|
||||
{
|
||||
NetworkTransform = GetComponent<NetworkTransform>();
|
||||
}
|
||||
|
||||
if (NetworkTransform != null)
|
||||
{
|
||||
NetworkTransform.RegisterRigidbody(this);
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new System.Exception($"[Missing {nameof(NetworkTransform)}] No {nameof(NetworkTransform)} is assigned or can be found during initialization!");
|
||||
}
|
||||
|
||||
if (AutoUpdateKinematicState)
|
||||
{
|
||||
SetIsKinematic(true);
|
||||
}
|
||||
}
|
||||
|
||||
internal Vector3 GetAdjustedPositionThreshold()
|
||||
{
|
||||
// Since the threshold is a measurement of unity world space units per tick, we will allow for the maximum threshold
|
||||
// to be no greater than the threshold measured in unity world space units per second
|
||||
var thresholdMax = NetworkTransform.PositionThreshold * m_TickRate;
|
||||
// Get the velocity in unity world space units per tick
|
||||
var perTickVelocity = GetLinearVelocity() * m_TickFrequency;
|
||||
// Since a rigid body can have "micro-motion" when allowed to come to rest (based on friction etc), we will allow for
|
||||
// no less than 1/10th the threshold value.
|
||||
var minThreshold = NetworkTransform.PositionThreshold * 0.1f;
|
||||
|
||||
// Finally, we adjust the threshold based on the body's current velocity
|
||||
perTickVelocity.x = Mathf.Clamp(Mathf.Abs(perTickVelocity.x), minThreshold, thresholdMax);
|
||||
perTickVelocity.y = Mathf.Clamp(Mathf.Abs(perTickVelocity.y), minThreshold, thresholdMax);
|
||||
// 2D Rigidbody only moves on x & y axis
|
||||
if (!m_IsRigidbody2D)
|
||||
{
|
||||
perTickVelocity.z = Mathf.Clamp(Mathf.Abs(perTickVelocity.z), minThreshold, thresholdMax);
|
||||
}
|
||||
|
||||
return perTickVelocity;
|
||||
}
|
||||
|
||||
internal Vector3 GetAdjustedRotationThreshold()
|
||||
{
|
||||
// Since the rotation threshold is a measurement pf degrees per tick, we get the maximum threshold
|
||||
// by calculating the threshold in degrees per second.
|
||||
var thresholdMax = NetworkTransform.RotAngleThreshold * m_TickRate;
|
||||
// Angular velocity is expressed in radians per second where as the rotation being checked is in degrees.
|
||||
// Convert the angular velocity to degrees per second and then convert that to degrees per tick.
|
||||
var rotationPerTick = (GetAngularVelocity() * Mathf.Rad2Deg) * m_TickFrequency;
|
||||
var minThreshold = NetworkTransform.RotAngleThreshold * m_TickFrequency;
|
||||
|
||||
// 2D Rigidbody only rotates around Z axis
|
||||
if (!m_IsRigidbody2D)
|
||||
{
|
||||
rotationPerTick.x = Mathf.Clamp(Mathf.Abs(rotationPerTick.x), minThreshold, thresholdMax);
|
||||
rotationPerTick.y = Mathf.Clamp(Mathf.Abs(rotationPerTick.y), minThreshold, thresholdMax);
|
||||
}
|
||||
rotationPerTick.z = Mathf.Clamp(Mathf.Abs(rotationPerTick.z), minThreshold, thresholdMax);
|
||||
|
||||
return rotationPerTick;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the linear velocity of the Rigidbody.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// For <see cref="Rigidbody2D"/>, only the x and y components of the <see cref="Vector3"/> are applied.
|
||||
/// </remarks>
|
||||
public void SetLinearVelocity(Vector3 linearVelocity)
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
#if COM_UNITY_MODULES_PHYSICS2D_LINEAR
|
||||
m_Rigidbody2D.linearVelocity = linearVelocity;
|
||||
#else
|
||||
m_Rigidbody2D.velocity = linearVelocity;
|
||||
#endif
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.linearVelocity = linearVelocity;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the linear velocity of the Rigidbody.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// For <see cref="Rigidbody2D"/>, the <see cref="Vector3"/> velocity returned is only applied to the x and y components.
|
||||
/// </remarks>
|
||||
/// <returns><see cref="Vector3"/> as the linear velocity</returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector3 GetLinearVelocity()
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
#if COM_UNITY_MODULES_PHYSICS2D_LINEAR
|
||||
return m_Rigidbody2D.linearVelocity;
|
||||
#else
|
||||
return m_Rigidbody2D.velocity;
|
||||
#endif
|
||||
}
|
||||
else
|
||||
{
|
||||
return m_Rigidbody.linearVelocity;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the angular velocity for the Rigidbody.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// For <see cref="Rigidbody2D"/>, the z component of <param name="angularVelocity"/> is only used to set the angular velocity.
|
||||
/// A quick way to pass in a 2D angular velocity component is: <see cref="Vector3.forward"/> * angularVelocity (where angularVelocity is a float)
|
||||
/// </remarks>
|
||||
/// <param name="angularVelocity">the angular velocity to apply to the body</param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void SetAngularVelocity(Vector3 angularVelocity)
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.angularVelocity = angularVelocity.z;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.angularVelocity = angularVelocity;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the angular velocity for the Rigidbody.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// For <see cref="Rigidbody2D"/>, the z component of the <see cref="Vector3"/> returned is the angular velocity of the object.
|
||||
/// </remarks>
|
||||
/// <returns>angular velocity as a <see cref="Vector3"/></returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector3 GetAngularVelocity()
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
return Vector3.forward * m_Rigidbody2D.angularVelocity;
|
||||
}
|
||||
else
|
||||
{
|
||||
return m_Rigidbody.angularVelocity;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the position of the Rigidbody
|
||||
/// </summary>
|
||||
/// <returns><see cref="Vector3"/></returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector3 GetPosition()
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
return m_Rigidbody2D.position;
|
||||
}
|
||||
else
|
||||
{
|
||||
return m_Rigidbody.position;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the rotation of the Rigidbody
|
||||
/// </summary>
|
||||
/// <returns><see cref="Quaternion"/></returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Quaternion GetRotation()
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
var quaternion = Quaternion.identity;
|
||||
var angles = quaternion.eulerAngles;
|
||||
angles.z = m_Rigidbody2D.rotation;
|
||||
quaternion.eulerAngles = angles;
|
||||
return quaternion;
|
||||
}
|
||||
else
|
||||
{
|
||||
return m_Rigidbody.rotation;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Moves the rigid body
|
||||
/// </summary>
|
||||
/// <param name="position">The <see cref="Vector3"/> position to move towards</param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void MovePosition(Vector3 position)
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.MovePosition(position);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.MovePosition(position);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Directly applies a position (like teleporting)
|
||||
/// </summary>
|
||||
/// <param name="position"><see cref="Vector3"/> position to apply to the Rigidbody</param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void SetPosition(Vector3 position)
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.position = position;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.position = position;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Applies the rotation and position of the <see cref="GameObject"/>'s <see cref="Transform"/>
|
||||
/// </summary>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void ApplyCurrentTransform()
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.position = transform.position;
|
||||
m_Rigidbody2D.rotation = transform.eulerAngles.z;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.position = transform.position;
|
||||
m_Rigidbody.rotation = transform.rotation;
|
||||
}
|
||||
}
|
||||
|
||||
// Used for Rigidbody only (see info on normalized below)
|
||||
private Vector4 m_QuaternionCheck = Vector4.zero;
|
||||
|
||||
/// <summary>
|
||||
/// Rotatates the Rigidbody towards a specified rotation
|
||||
/// </summary>
|
||||
/// <param name="rotation">The rotation expressed as a <see cref="Quaternion"/></param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void MoveRotation(Quaternion rotation)
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
var quaternion = Quaternion.identity;
|
||||
var angles = quaternion.eulerAngles;
|
||||
angles.z = m_Rigidbody2D.rotation;
|
||||
quaternion.eulerAngles = angles;
|
||||
m_Rigidbody2D.MoveRotation(quaternion);
|
||||
}
|
||||
else
|
||||
{
|
||||
// Evidently we need to check to make sure the quaternion is a perfect
|
||||
// magnitude of 1.0f when applying the rotation to a rigid body.
|
||||
m_QuaternionCheck.x = rotation.x;
|
||||
m_QuaternionCheck.y = rotation.y;
|
||||
m_QuaternionCheck.z = rotation.z;
|
||||
m_QuaternionCheck.w = rotation.w;
|
||||
// If the magnitude is greater than 1.0f (even by a very small fractional value), then normalize the quaternion
|
||||
if (m_QuaternionCheck.magnitude != 1.0f)
|
||||
{
|
||||
rotation.Normalize();
|
||||
}
|
||||
m_Rigidbody.MoveRotation(rotation);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Applies a rotation to the Rigidbody
|
||||
/// </summary>
|
||||
/// <param name="rotation">The rotation to apply expressed as a <see cref="Quaternion"/></param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void SetRotation(Quaternion rotation)
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.rotation = rotation.eulerAngles.z;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.rotation = rotation;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the original interpolation of the Rigidbody while taking the Rigidbody type into consideration
|
||||
/// </summary>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
private void SetOriginalInterpolation()
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
switch (m_Rigidbody2D.interpolation)
|
||||
{
|
||||
case RigidbodyInterpolation2D.None:
|
||||
{
|
||||
m_OriginalInterpolation = InterpolationTypes.None;
|
||||
break;
|
||||
}
|
||||
case RigidbodyInterpolation2D.Interpolate:
|
||||
{
|
||||
m_OriginalInterpolation = InterpolationTypes.Interpolate;
|
||||
break;
|
||||
}
|
||||
case RigidbodyInterpolation2D.Extrapolate:
|
||||
{
|
||||
m_OriginalInterpolation = InterpolationTypes.Extrapolate;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
switch (m_Rigidbody.interpolation)
|
||||
{
|
||||
case RigidbodyInterpolation.None:
|
||||
{
|
||||
m_OriginalInterpolation = InterpolationTypes.None;
|
||||
break;
|
||||
}
|
||||
case RigidbodyInterpolation.Interpolate:
|
||||
{
|
||||
m_OriginalInterpolation = InterpolationTypes.Interpolate;
|
||||
break;
|
||||
}
|
||||
case RigidbodyInterpolation.Extrapolate:
|
||||
{
|
||||
m_OriginalInterpolation = InterpolationTypes.Extrapolate;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Wakes the Rigidbody if it is sleeping
|
||||
/// </summary>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void WakeIfSleeping()
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
if (m_Rigidbody2D.IsSleeping())
|
||||
{
|
||||
m_Rigidbody2D.WakeUp();
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if (m_Rigidbody.IsSleeping())
|
||||
{
|
||||
m_Rigidbody.WakeUp();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Puts the Rigidbody to sleep
|
||||
/// </summary>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void SleepRigidbody()
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.Sleep();
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.Sleep();
|
||||
}
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public bool IsKinematic()
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
return m_Rigidbody2D.bodyType == RigidbodyType2D.Kinematic;
|
||||
}
|
||||
else
|
||||
{
|
||||
return m_Rigidbody.isKinematic;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the kinematic state of the Rigidbody and handles updating the Rigidbody's
|
||||
/// interpolation setting based on the Kinematic state.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// When using the Rigidbody for <see cref="NetworkTransform"/> motion, this automatically
|
||||
/// adjusts from extrapolation to interpolation if:
|
||||
/// - The Rigidbody was originally set to extrapolation
|
||||
/// - The NetworkTransform is set to interpolate
|
||||
/// When the two above conditions are true:
|
||||
/// - When switching from non-kinematic to kinematic this will automatically
|
||||
/// switch the Rigidbody from extrapolation to interpolate.
|
||||
/// - When switching from kinematic to non-kinematic this will automatically
|
||||
/// switch the Rigidbody from interpolation back to extrapolation.
|
||||
/// </remarks>
|
||||
/// <param name="isKinematic"></param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void SetIsKinematic(bool isKinematic)
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.bodyType = isKinematic ? RigidbodyType2D.Kinematic : RigidbodyType2D.Dynamic;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.isKinematic = isKinematic;
|
||||
}
|
||||
|
||||
// If we are not spawned, then exit early
|
||||
if (!IsSpawned)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (UseRigidBodyForMotion)
|
||||
{
|
||||
// Only if the NetworkTransform is set to interpolate do we need to check for extrapolation
|
||||
if (NetworkTransform.Interpolate && m_OriginalInterpolation == InterpolationTypes.Extrapolate)
|
||||
{
|
||||
if (IsKinematic())
|
||||
{
|
||||
// If not already set to interpolate then set the Rigidbody to interpolate
|
||||
if (m_Rigidbody.interpolation == RigidbodyInterpolation.Extrapolate)
|
||||
{
|
||||
// Sleep until the next fixed update when switching from extrapolation to interpolation
|
||||
SleepRigidbody();
|
||||
SetInterpolation(InterpolationTypes.Interpolate);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// Switch it back to the original interpolation if non-kinematic (doesn't require sleep).
|
||||
SetInterpolation(m_OriginalInterpolation);
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
SetInterpolation(m_IsAuthority ? m_OriginalInterpolation : (NetworkTransform.Interpolate ? InterpolationTypes.None : m_OriginalInterpolation));
|
||||
}
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
private void SetInterpolation(InterpolationTypes interpolationType)
|
||||
{
|
||||
switch (interpolationType)
|
||||
{
|
||||
case InterpolationTypes.None:
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.interpolation = RigidbodyInterpolation2D.None;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.interpolation = RigidbodyInterpolation.None;
|
||||
}
|
||||
break;
|
||||
}
|
||||
case InterpolationTypes.Interpolate:
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.interpolation = RigidbodyInterpolation2D.Interpolate;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.interpolation = RigidbodyInterpolation.Interpolate;
|
||||
}
|
||||
break;
|
||||
}
|
||||
case InterpolationTypes.Extrapolate:
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
m_Rigidbody2D.interpolation = RigidbodyInterpolation2D.Extrapolate;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_Rigidbody.interpolation = RigidbodyInterpolation.Extrapolate;
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void ResetInterpolation()
|
||||
{
|
||||
SetInterpolation(m_OriginalInterpolation);
|
||||
}
|
||||
|
||||
protected override void OnOwnershipChanged(ulong previous, ulong current)
|
||||
{
|
||||
UpdateOwnershipAuthority();
|
||||
base.OnOwnershipChanged(previous, current);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the authority based on whether it is server or owner authoritative
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Distributed authority sessions will always be owner authoritative.
|
||||
/// </remarks>
|
||||
internal void UpdateOwnershipAuthority()
|
||||
{
|
||||
if (NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
// When in distributed authority mode, always use HasAuthority
|
||||
m_IsAuthority = HasAuthority;
|
||||
}
|
||||
else
|
||||
{
|
||||
if (NetworkTransform.IsServerAuthoritative())
|
||||
{
|
||||
m_IsAuthority = NetworkManager.IsServer;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_IsAuthority = IsOwner;
|
||||
}
|
||||
}
|
||||
|
||||
if (AutoUpdateKinematicState)
|
||||
{
|
||||
SetIsKinematic(!m_IsAuthority);
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public override void OnNetworkSpawn()
|
||||
{
|
||||
m_TickFrequency = 1.0f / NetworkManager.NetworkConfig.TickRate;
|
||||
m_TickRate = NetworkManager.NetworkConfig.TickRate;
|
||||
UpdateOwnershipAuthority();
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public override void OnNetworkDespawn()
|
||||
{
|
||||
if (UseRigidBodyForMotion && HasAuthority)
|
||||
{
|
||||
DetachFromFixedJoint();
|
||||
NetworkRigidbodyConnections.Clear();
|
||||
}
|
||||
|
||||
// If we are automatically handling the kinematic state...
|
||||
if (AutoUpdateKinematicState || AutoSetKinematicOnDespawn)
|
||||
{
|
||||
// Turn off physics for the rigid body until spawned, otherwise
|
||||
// non-owners can run fixed updates before the first full
|
||||
// NetworkTransform update and physics will be applied (i.e. gravity, etc)
|
||||
SetIsKinematic(true);
|
||||
}
|
||||
SetInterpolation(m_OriginalInterpolation);
|
||||
}
|
||||
|
||||
// TODO: Possibly provide a NetworkJoint that allows for more options than fixed.
|
||||
// Rigidbodies do not have the concept of "local space", and as such using a fixed joint will hold the object
|
||||
// in place relative to the parent so jitter/stutter does not occur.
|
||||
// Alternately, users can affix the fixed joint to a child GameObject (without a rigid body) of the parent NetworkObject
|
||||
// and then add a NetworkTransform to that in order to get the parented child NetworkObject to move around in "local space"
|
||||
public FixedJoint FixedJoint { get; private set; }
|
||||
public FixedJoint2D FixedJoint2D { get; private set; }
|
||||
|
||||
internal System.Collections.Generic.List<NetworkRigidbodyBase> NetworkRigidbodyConnections = new System.Collections.Generic.List<NetworkRigidbodyBase>();
|
||||
internal NetworkRigidbodyBase ParentBody;
|
||||
|
||||
private bool m_FixedJoint2DUsingGravity;
|
||||
private bool m_OriginalGravitySetting;
|
||||
private float m_OriginalGravityScale;
|
||||
|
||||
/// <summary>
|
||||
/// When using a custom <see cref="NetworkRigidbodyBase"/>, this virtual method is invoked when the
|
||||
/// <see cref="FixedJoint"/> is created in the event any additional adjustments are needed.
|
||||
/// </summary>
|
||||
protected virtual void OnFixedJointCreated()
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// When using a custom <see cref="NetworkRigidbodyBase"/>, this virtual method is invoked when the
|
||||
/// <see cref="FixedJoint2D"/> is created in the event any additional adjustments are needed.
|
||||
/// </summary>
|
||||
protected virtual void OnFixedJoint2DCreated()
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
private void ApplyFixedJoint2D(NetworkRigidbodyBase bodyToConnect, Vector3 position, float connectedMassScale = 0.0f, float massScale = 1.0f, bool useGravity = false, bool zeroVelocity = true)
|
||||
{
|
||||
transform.position = position;
|
||||
m_Rigidbody2D.position = position;
|
||||
m_OriginalGravitySetting = bodyToConnect.m_Rigidbody.useGravity;
|
||||
m_FixedJoint2DUsingGravity = useGravity;
|
||||
|
||||
if (!useGravity)
|
||||
{
|
||||
m_OriginalGravityScale = m_Rigidbody2D.gravityScale;
|
||||
m_Rigidbody2D.gravityScale = 0.0f;
|
||||
}
|
||||
|
||||
if (zeroVelocity)
|
||||
{
|
||||
#if COM_UNITY_MODULES_PHYSICS2D_LINEAR
|
||||
m_Rigidbody2D.linearVelocity = Vector2.zero;
|
||||
#else
|
||||
m_Rigidbody2D.velocity = Vector2.zero;
|
||||
#endif
|
||||
m_Rigidbody2D.angularVelocity = 0.0f;
|
||||
}
|
||||
|
||||
FixedJoint2D = gameObject.AddComponent<FixedJoint2D>();
|
||||
FixedJoint2D.connectedBody = bodyToConnect.m_Rigidbody2D;
|
||||
OnFixedJoint2DCreated();
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
private void ApplyFixedJoint(NetworkRigidbodyBase bodyToConnectTo, Vector3 position, float connectedMassScale = 0.0f, float massScale = 1.0f, bool useGravity = false, bool zeroVelocity = true)
|
||||
{
|
||||
transform.position = position;
|
||||
m_Rigidbody.position = position;
|
||||
if (zeroVelocity)
|
||||
{
|
||||
m_Rigidbody.linearVelocity = Vector3.zero;
|
||||
m_Rigidbody.angularVelocity = Vector3.zero;
|
||||
}
|
||||
m_OriginalGravitySetting = m_Rigidbody.useGravity;
|
||||
m_Rigidbody.useGravity = useGravity;
|
||||
FixedJoint = gameObject.AddComponent<FixedJoint>();
|
||||
FixedJoint.connectedBody = bodyToConnectTo.m_Rigidbody;
|
||||
FixedJoint.connectedMassScale = connectedMassScale;
|
||||
FixedJoint.massScale = massScale;
|
||||
OnFixedJointCreated();
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Authority Only:
|
||||
/// When invoked and not already attached to a fixed joint, this will connect two rigid bodies with <see cref="UseRigidBodyForMotion"/> enabled.
|
||||
/// Invoke this method on the rigid body you wish to attach to another (i.e. weapon to player, sticky bomb to player/object, etc).
|
||||
/// <seealso cref="FixedJoint"/>
|
||||
/// <seealso cref="FixedJoint2D"/>
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Parenting relative:
|
||||
/// - This instance can be viewed as the child.
|
||||
/// - The <param name="objectToConnectTo"/> can be viewed as the parent.
|
||||
/// <br/>
|
||||
/// This is the recommended way, as opposed to parenting, to attached/detatch two rigid bodies to one another when <see cref="UseRigidBodyForMotion"/> is enabled.
|
||||
/// For more details on using <see cref="UnityEngine.FixedJoint"/> and <see cref="UnityEngine.FixedJoint2D"/>.
|
||||
/// <br/>
|
||||
/// This provides a simple joint solution between two rigid bodies and serves as an example. You can add different joint types by creating a customized/derived
|
||||
/// version of <see cref="NetworkRigidbodyBase"/>.
|
||||
/// </remarks>
|
||||
/// <param name="objectToConnectTo">The target object to attach to.</param>
|
||||
/// <param name="positionOfConnection">The position of the connection (i.e. where you want the object to be affixed).</param>
|
||||
/// <param name="connectedMassScale">The target object's mass scale relative to this object being attached.</param>
|
||||
/// <param name="massScale">This object's mass scale relative to the target object's.</param>
|
||||
/// <param name="useGravity">Determines if this object will have gravity applied to it along with the object you are connecting this one to (the default is to not use gravity for this object)</param>
|
||||
/// <param name="zeroVelocity">When true (the default), both linear and angular velocities of this object are set to zero.</param>
|
||||
/// <param name="teleportObject">When true (the default), this object will teleport itself to the position of connection.</param>
|
||||
/// <returns>true (success) false (failed)</returns>
|
||||
public bool AttachToFixedJoint(NetworkRigidbodyBase objectToConnectTo, Vector3 positionOfConnection, float connectedMassScale = 0.0f, float massScale = 1.0f, bool useGravity = false, bool zeroVelocity = true, bool teleportObject = true)
|
||||
{
|
||||
if (!UseRigidBodyForMotion)
|
||||
{
|
||||
Debug.LogError($"[{GetType().Name}] {name} does not have {nameof(UseRigidBodyForMotion)} set! Either enable {nameof(UseRigidBodyForMotion)} on this component or do not use a {nameof(FixedJoint)} when parenting under a {nameof(NetworkObject)}.");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (IsKinematic())
|
||||
{
|
||||
Debug.LogError($"[{GetType().Name}] {name} is currently kinematic! You cannot use a {nameof(FixedJoint)} with Kinematic bodies!");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (objectToConnectTo != null)
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
ApplyFixedJoint2D(objectToConnectTo, positionOfConnection, connectedMassScale, massScale, useGravity, zeroVelocity);
|
||||
}
|
||||
else
|
||||
{
|
||||
ApplyFixedJoint(objectToConnectTo, positionOfConnection, connectedMassScale, massScale, useGravity, zeroVelocity);
|
||||
}
|
||||
|
||||
ParentBody = objectToConnectTo;
|
||||
ParentBody.NetworkRigidbodyConnections.Add(this);
|
||||
if (teleportObject)
|
||||
{
|
||||
NetworkTransform.SetState(teleportDisabled: false);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
private void RemoveFromParentBody()
|
||||
{
|
||||
ParentBody.NetworkRigidbodyConnections.Remove(this);
|
||||
ParentBody = null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Authority Only:
|
||||
/// When invoked and already connected to an object via <see cref="FixedJoint"/> or <see cref="FixedJoint2D"/> (depending upon the type of rigid body),
|
||||
/// this will detach from the fixed joint and destroy the fixed joint component.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is the recommended way, as opposed to parenting, to attached/detatch two rigid bodies to one another when <see cref="UseRigidBodyForMotion"/> is enabled.
|
||||
/// </remarks>
|
||||
public void DetachFromFixedJoint()
|
||||
{
|
||||
if (!HasAuthority)
|
||||
{
|
||||
Debug.LogError($"[{name}] Only authority can invoke {nameof(DetachFromFixedJoint)}!");
|
||||
}
|
||||
if (UseRigidBodyForMotion)
|
||||
{
|
||||
if (m_IsRigidbody2D)
|
||||
{
|
||||
if (FixedJoint2D != null)
|
||||
{
|
||||
if (!m_FixedJoint2DUsingGravity)
|
||||
{
|
||||
FixedJoint2D.connectedBody.gravityScale = m_OriginalGravityScale;
|
||||
}
|
||||
FixedJoint2D.connectedBody = null;
|
||||
Destroy(FixedJoint2D);
|
||||
FixedJoint2D = null;
|
||||
ResetInterpolation();
|
||||
RemoveFromParentBody();
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if (FixedJoint != null)
|
||||
{
|
||||
FixedJoint.connectedBody = null;
|
||||
m_Rigidbody.useGravity = m_OriginalGravitySetting;
|
||||
Destroy(FixedJoint);
|
||||
FixedJoint = null;
|
||||
ResetInterpolation();
|
||||
RemoveFromParentBody();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif // COM_UNITY_MODULES_PHYSICS
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 5b8086dc75d86473f9e3c928dd773733
|
||||
guid: 8c4434f0563fb7f42b3b2993c97ae81a
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
21
Runtime/Components/NetworkRigidbody.cs
Normal file
21
Runtime/Components/NetworkRigidbody.cs
Normal file
@@ -0,0 +1,21 @@
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
/// <summary>
|
||||
/// NetworkRigidbody allows for the use of <see cref="Rigidbody"/> on network objects. By controlling the kinematic
|
||||
/// mode of the <see cref="Rigidbody"/> and disabling it on all peers but the authoritative one.
|
||||
/// </summary>
|
||||
[RequireComponent(typeof(NetworkTransform))]
|
||||
[RequireComponent(typeof(Rigidbody))]
|
||||
[AddComponentMenu("Netcode/Network Rigidbody")]
|
||||
public class NetworkRigidbody : NetworkRigidbodyBase
|
||||
{
|
||||
protected virtual void Awake()
|
||||
{
|
||||
Initialize(RigidbodyTypes.Rigidbody);
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif // COM_UNITY_MODULES_PHYSICS
|
||||
21
Runtime/Components/NetworkRigidbody2D.cs
Normal file
21
Runtime/Components/NetworkRigidbody2D.cs
Normal file
@@ -0,0 +1,21 @@
|
||||
#if COM_UNITY_MODULES_PHYSICS2D
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
/// <summary>
|
||||
/// NetworkRigidbody allows for the use of <see cref="Rigidbody2D"/> on network objects. By controlling the kinematic
|
||||
/// mode of the rigidbody and disabling it on all peers but the authoritative one.
|
||||
/// </summary>
|
||||
[RequireComponent(typeof(NetworkTransform))]
|
||||
[RequireComponent(typeof(Rigidbody2D))]
|
||||
[AddComponentMenu("Netcode/Network Rigidbody 2D")]
|
||||
public class NetworkRigidbody2D : NetworkRigidbodyBase
|
||||
{
|
||||
protected virtual void Awake()
|
||||
{
|
||||
Initialize(RigidbodyTypes.Rigidbody2D);
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif // COM_UNITY_MODULES_PHYSICS2D
|
||||
File diff suppressed because it is too large
Load Diff
@@ -14,7 +14,7 @@ namespace Unity.Netcode
|
||||
/// M = 1.0f (which M * M would still yield 1.0f)
|
||||
/// w*w = M*M - (x*x + y*y + z*z) or Mathf.Sqrt(1.0f - (x*x + y*y + z*z))
|
||||
/// w = Math.Sqrt(1.0f - (x*x + y*y + z*z))
|
||||
/// Using the largest the number avoids potential loss of precision in the smallest three values.
|
||||
/// Using the largest number avoids potential loss of precision in the smallest three values.
|
||||
/// </remarks>
|
||||
public static class QuaternionCompressor
|
||||
{
|
||||
230
Runtime/Components/RigidbodyContactEventManager.cs
Normal file
230
Runtime/Components/RigidbodyContactEventManager.cs
Normal file
@@ -0,0 +1,230 @@
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
using System.Collections.Generic;
|
||||
using Unity.Collections;
|
||||
using Unity.Jobs;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
public interface IContactEventHandler
|
||||
{
|
||||
Rigidbody GetRigidbody();
|
||||
|
||||
void ContactEvent(ulong eventId, Vector3 averagedCollisionNormal, Rigidbody collidingBody, Vector3 contactPoint, bool hasCollisionStay = false, Vector3 averagedCollisionStayNormal = default);
|
||||
}
|
||||
|
||||
[AddComponentMenu("Netcode/Rigidbody Contact Event Manager")]
|
||||
public class RigidbodyContactEventManager : MonoBehaviour
|
||||
{
|
||||
public static RigidbodyContactEventManager Instance { get; private set; }
|
||||
|
||||
private struct JobResultStruct
|
||||
{
|
||||
public bool HasCollisionStay;
|
||||
public int ThisInstanceID;
|
||||
public int OtherInstanceID;
|
||||
public Vector3 AverageNormal;
|
||||
public Vector3 AverageCollisionStayNormal;
|
||||
public Vector3 ContactPoint;
|
||||
}
|
||||
|
||||
private NativeArray<JobResultStruct> m_ResultsArray;
|
||||
private int m_Count = 0;
|
||||
private JobHandle m_JobHandle;
|
||||
|
||||
private readonly Dictionary<int, Rigidbody> m_RigidbodyMapping = new Dictionary<int, Rigidbody>();
|
||||
private readonly Dictionary<int, IContactEventHandler> m_HandlerMapping = new Dictionary<int, IContactEventHandler>();
|
||||
|
||||
private void OnEnable()
|
||||
{
|
||||
m_ResultsArray = new NativeArray<JobResultStruct>(16, Allocator.Persistent);
|
||||
Physics.ContactEvent += Physics_ContactEvent;
|
||||
if (Instance != null)
|
||||
{
|
||||
NetworkLog.LogError($"[Invalid][Multiple Instances] Found more than one instance of {nameof(RigidbodyContactEventManager)}: {name} and {Instance.name}");
|
||||
NetworkLog.LogError($"[Disable][Additional Instance] Disabling {name} instance!");
|
||||
gameObject.SetActive(false);
|
||||
return;
|
||||
}
|
||||
Instance = this;
|
||||
}
|
||||
|
||||
public void RegisterHandler(IContactEventHandler contactEventHandler, bool register = true)
|
||||
{
|
||||
var rigidbody = contactEventHandler.GetRigidbody();
|
||||
var instanceId = rigidbody.GetInstanceID();
|
||||
if (register)
|
||||
{
|
||||
if (!m_RigidbodyMapping.ContainsKey(instanceId))
|
||||
{
|
||||
m_RigidbodyMapping.Add(instanceId, rigidbody);
|
||||
}
|
||||
|
||||
if (!m_HandlerMapping.ContainsKey(instanceId))
|
||||
{
|
||||
m_HandlerMapping.Add(instanceId, contactEventHandler);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
m_RigidbodyMapping.Remove(instanceId);
|
||||
m_HandlerMapping.Remove(instanceId);
|
||||
}
|
||||
}
|
||||
|
||||
private void OnDisable()
|
||||
{
|
||||
m_JobHandle.Complete();
|
||||
m_ResultsArray.Dispose();
|
||||
|
||||
Physics.ContactEvent -= Physics_ContactEvent;
|
||||
|
||||
m_RigidbodyMapping.Clear();
|
||||
Instance = null;
|
||||
}
|
||||
|
||||
private bool m_HasCollisions;
|
||||
private int m_CurrentCount = 0;
|
||||
|
||||
private void ProcessCollisions()
|
||||
{
|
||||
// Process all collisions
|
||||
for (int i = 0; i < m_Count; i++)
|
||||
{
|
||||
var thisInstanceID = m_ResultsArray[i].ThisInstanceID;
|
||||
var otherInstanceID = m_ResultsArray[i].OtherInstanceID;
|
||||
var rb0Valid = thisInstanceID != 0 && m_RigidbodyMapping.ContainsKey(thisInstanceID);
|
||||
var rb1Valid = otherInstanceID != 0 && m_RigidbodyMapping.ContainsKey(otherInstanceID);
|
||||
// Only notify registered rigid bodies.
|
||||
if (!rb0Valid || !rb1Valid || !m_HandlerMapping.ContainsKey(thisInstanceID))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
if (m_ResultsArray[i].HasCollisionStay)
|
||||
{
|
||||
m_HandlerMapping[thisInstanceID].ContactEvent(m_EventId, m_ResultsArray[i].AverageNormal, m_RigidbodyMapping[otherInstanceID], m_ResultsArray[i].ContactPoint, m_ResultsArray[i].HasCollisionStay, m_ResultsArray[i].AverageCollisionStayNormal);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_HandlerMapping[thisInstanceID].ContactEvent(m_EventId, m_ResultsArray[i].AverageNormal, m_RigidbodyMapping[otherInstanceID], m_ResultsArray[i].ContactPoint);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void FixedUpdate()
|
||||
{
|
||||
// Only process new collisions
|
||||
if (!m_HasCollisions && m_CurrentCount == 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
// This assures we won't process the same collision
|
||||
// set after it has been processed.
|
||||
if (m_HasCollisions)
|
||||
{
|
||||
m_CurrentCount = m_Count;
|
||||
m_HasCollisions = false;
|
||||
m_JobHandle.Complete();
|
||||
}
|
||||
ProcessCollisions();
|
||||
}
|
||||
|
||||
private void LateUpdate()
|
||||
{
|
||||
m_CurrentCount = 0;
|
||||
}
|
||||
|
||||
private ulong m_EventId;
|
||||
private void Physics_ContactEvent(PhysicsScene scene, NativeArray<ContactPairHeader>.ReadOnly pairHeaders)
|
||||
{
|
||||
m_EventId++;
|
||||
m_HasCollisions = true;
|
||||
int n = pairHeaders.Length;
|
||||
if (m_ResultsArray.Length < n)
|
||||
{
|
||||
m_ResultsArray.Dispose();
|
||||
m_ResultsArray = new NativeArray<JobResultStruct>(Mathf.NextPowerOfTwo(n), Allocator.Persistent);
|
||||
}
|
||||
m_Count = n;
|
||||
var job = new GetCollisionsJob()
|
||||
{
|
||||
PairedHeaders = pairHeaders,
|
||||
ResultsArray = m_ResultsArray
|
||||
};
|
||||
m_JobHandle = job.Schedule(n, 256);
|
||||
}
|
||||
|
||||
private struct GetCollisionsJob : IJobParallelFor
|
||||
{
|
||||
[ReadOnly]
|
||||
public NativeArray<ContactPairHeader>.ReadOnly PairedHeaders;
|
||||
|
||||
public NativeArray<JobResultStruct> ResultsArray;
|
||||
|
||||
public void Execute(int index)
|
||||
{
|
||||
Vector3 averageNormal = Vector3.zero;
|
||||
Vector3 averagePoint = Vector3.zero;
|
||||
Vector3 averageCollisionStay = Vector3.zero;
|
||||
int count = 0;
|
||||
int collisionStaycount = 0;
|
||||
int positionCount = 0;
|
||||
for (int j = 0; j < PairedHeaders[index].pairCount; j++)
|
||||
{
|
||||
ref readonly var pair = ref PairedHeaders[index].GetContactPair(j);
|
||||
|
||||
if (pair.isCollisionExit)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
for (int k = 0; k < pair.contactCount; k++)
|
||||
{
|
||||
ref readonly var contact = ref pair.GetContactPoint(k);
|
||||
averagePoint += contact.position;
|
||||
positionCount++;
|
||||
if (!pair.isCollisionStay)
|
||||
{
|
||||
averageNormal += contact.normal;
|
||||
count++;
|
||||
}
|
||||
else
|
||||
{
|
||||
averageCollisionStay += contact.normal;
|
||||
collisionStaycount++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (count != 0)
|
||||
{
|
||||
averageNormal /= count;
|
||||
}
|
||||
|
||||
if (collisionStaycount != 0)
|
||||
{
|
||||
averageCollisionStay /= collisionStaycount;
|
||||
}
|
||||
|
||||
if (positionCount != 0)
|
||||
{
|
||||
averagePoint /= positionCount;
|
||||
}
|
||||
|
||||
var result = new JobResultStruct()
|
||||
{
|
||||
ThisInstanceID = PairedHeaders[index].bodyInstanceID,
|
||||
OtherInstanceID = PairedHeaders[index].otherBodyInstanceID,
|
||||
AverageNormal = averageNormal,
|
||||
HasCollisionStay = collisionStaycount != 0,
|
||||
AverageCollisionStayNormal = averageCollisionStay,
|
||||
ContactPoint = averagePoint
|
||||
};
|
||||
|
||||
ResultsArray[index] = result;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif
|
||||
11
Runtime/Components/RigidbodyContactEventManager.cs.meta
Normal file
11
Runtime/Components/RigidbodyContactEventManager.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 739e5cee846b6384988f9a47e4691836
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -129,10 +129,10 @@ namespace Unity.Netcode
|
||||
public int LoadSceneTimeOut = 120;
|
||||
|
||||
/// <summary>
|
||||
/// The amount of time a message should be buffered if the asset or object needed to process it doesn't exist yet. If the asset is not added/object is not spawned within this time, it will be dropped.
|
||||
/// The amount of time a message will be held (deferred) if the destination NetworkObject needed to process the message doesn't exist yet. If the NetworkObject is not spawned within this time period, all deferred messages for that NetworkObject will be dropped.
|
||||
/// </summary>
|
||||
[Tooltip("The amount of time a message should be buffered if the asset or object needed to process it doesn't exist yet. If the asset is not added/object is not spawned within this time, it will be dropped")]
|
||||
public float SpawnTimeout = 1f;
|
||||
[Tooltip("The amount of time a message will be held (deferred) if the destination NetworkObject needed to process the message doesn't exist yet. If the NetworkObject is not spawned within this time period, all deferred messages for that NetworkObject will be dropped.")]
|
||||
public float SpawnTimeout = 10f;
|
||||
|
||||
/// <summary>
|
||||
/// Whether or not to enable network logs.
|
||||
@@ -149,6 +149,33 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
public const int RttWindowSize = 64; // number of slots to use for RTT computations (max number of in-flight packets)
|
||||
|
||||
[Tooltip("Determines whether to use the client-server or distributed authority network topology.")]
|
||||
public NetworkTopologyTypes NetworkTopology;
|
||||
|
||||
[HideInInspector]
|
||||
public bool UseCMBService;
|
||||
|
||||
[Tooltip("When enabled (default), the player prefab will automatically be spawned (client-side) upon the client being approved and synchronized.")]
|
||||
public bool AutoSpawnPlayerPrefabClientSide = true;
|
||||
|
||||
#if MULTIPLAYER_TOOLS
|
||||
/// <summary>
|
||||
/// Controls whether network messaging metrics will be gathered. (defaults to true)
|
||||
/// There is a slight performance cost to having this enabled, and can increase in processing time based on network message traffic.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The Realtime Network Stats Monitoring tool requires this to be enabled.
|
||||
/// </remarks>
|
||||
[Tooltip("Enable (default) if you want to gather messaging metrics. Realtime Network Stats Monitor requires this to be enabled. Disabling this can improve performance in release builds.")]
|
||||
public bool NetworkMessageMetrics = true;
|
||||
#endif
|
||||
/// <summary>
|
||||
/// When enabled (default, this enables network profiling information. This does come with a per message processing cost.
|
||||
/// Network profiling information is automatically disabled in release builds.
|
||||
/// </summary>
|
||||
[Tooltip("Enable (default) if you want to profile network messages with development builds and defaults to being disabled in release builds. When disabled, network messaging profiling will be disabled in development builds.")]
|
||||
public bool NetworkProfilingMetrics = true;
|
||||
|
||||
/// <summary>
|
||||
/// Returns a base64 encoded version of the configuration
|
||||
/// </summary>
|
||||
|
||||
@@ -30,6 +30,12 @@ namespace Unity.Netcode
|
||||
[NonSerialized]
|
||||
public Dictionary<uint, NetworkPrefab> NetworkPrefabOverrideLinks = new Dictionary<uint, NetworkPrefab>();
|
||||
|
||||
/// <summary>
|
||||
/// This is used for the legacy way of spawning NetworkPrefabs with an override when manually instantiating and spawning.
|
||||
/// To handle multiple source NetworkPrefab overrides that all point to the same target NetworkPrefab use
|
||||
/// <see cref="NetworkSpawnManager.InstantiateAndSpawn(NetworkObject, ulong, bool, bool, bool, Vector3, Quaternion)"/>
|
||||
/// or <see cref="NetworkObject.InstantiateAndSpawn(NetworkManager, ulong, bool, bool, bool, Vector3, Quaternion)"/>
|
||||
/// </summary>
|
||||
[NonSerialized]
|
||||
public Dictionary<uint, uint> OverrideToNetworkPrefab = new Dictionary<uint, uint>();
|
||||
|
||||
@@ -234,7 +240,8 @@ namespace Unity.Netcode
|
||||
{
|
||||
for (int i = 0; i < m_Prefabs.Count; i++)
|
||||
{
|
||||
if (m_Prefabs[i].Prefab == prefab)
|
||||
// Check both values as Prefab and be different than SourcePrefabToOverride
|
||||
if (m_Prefabs[i].Prefab == prefab || m_Prefabs[i].SourcePrefabToOverride == prefab)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
@@ -262,7 +269,7 @@ namespace Unity.Netcode
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Configures <see cref="NetworkPrefabOverrideLinks"/> and <see cref="OverrideToNetworkPrefab"/> for the given <see cref="NetworkPrefab"/>
|
||||
/// Configures <see cref="NetworkPrefabOverrideLinks"/> for the given <see cref="NetworkPrefab"/>
|
||||
/// </summary>
|
||||
private bool AddPrefabRegistration(NetworkPrefab networkPrefab)
|
||||
{
|
||||
@@ -296,28 +303,16 @@ namespace Unity.Netcode
|
||||
return true;
|
||||
}
|
||||
|
||||
// Make sure we don't have several overrides targeting the same prefab. Apparently we don't support that... shame.
|
||||
if (OverrideToNetworkPrefab.ContainsKey(target))
|
||||
{
|
||||
var networkObject = networkPrefab.Prefab.GetComponent<NetworkObject>();
|
||||
|
||||
// This can happen if a user tries to make several GlobalObjectIdHash values point to the same target
|
||||
Debug.LogError($"{nameof(NetworkPrefab)} (\"{networkObject.name}\") has a duplicate {nameof(NetworkObject.GlobalObjectIdHash)} target entry value of: {target}!");
|
||||
return false;
|
||||
}
|
||||
|
||||
switch (networkPrefab.Override)
|
||||
{
|
||||
case NetworkPrefabOverride.Prefab:
|
||||
{
|
||||
NetworkPrefabOverrideLinks.Add(source, networkPrefab);
|
||||
OverrideToNetworkPrefab.Add(target, source);
|
||||
}
|
||||
break;
|
||||
case NetworkPrefabOverride.Hash:
|
||||
{
|
||||
NetworkPrefabOverrideLinks.Add(source, networkPrefab);
|
||||
OverrideToNetworkPrefab.Add(target, source);
|
||||
if (!OverrideToNetworkPrefab.ContainsKey(target))
|
||||
{
|
||||
OverrideToNetworkPrefab.Add(target, source);
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
using System.Collections.Generic;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// A NetworkClient
|
||||
/// </summary>
|
||||
@@ -33,6 +34,15 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
internal bool IsApproved { get; set; }
|
||||
|
||||
public NetworkTopologyTypes NetworkTopologyType { get; internal set; }
|
||||
|
||||
public bool DAHost { get; internal set; }
|
||||
|
||||
/// <summary>
|
||||
/// Is true when the client has been assigned session ownership in distributed authority mode
|
||||
/// </summary>
|
||||
public bool IsSessionOwner { get; internal set; }
|
||||
|
||||
/// <summary>
|
||||
/// The ClientId of the NetworkClient
|
||||
/// </summary>
|
||||
@@ -44,27 +54,60 @@ namespace Unity.Netcode
|
||||
public NetworkObject PlayerObject;
|
||||
|
||||
/// <summary>
|
||||
/// The list of NetworkObject's owned by this client instance
|
||||
/// The NetworkObject's owned by this client instance
|
||||
/// </summary>
|
||||
public List<NetworkObject> OwnedObjects => IsConnected ? SpawnManager.GetClientOwnedObjects(ClientId) : new List<NetworkObject>();
|
||||
public NetworkObject[] OwnedObjects => IsConnected ? SpawnManager.GetClientOwnedObjects(ClientId) : new NetworkObject[] { };
|
||||
|
||||
internal NetworkSpawnManager SpawnManager { get; private set; }
|
||||
|
||||
internal void SetRole(bool isServer, bool isClient, NetworkManager networkManager = null)
|
||||
internal bool SetRole(bool isServer, bool isClient, NetworkManager networkManager = null)
|
||||
{
|
||||
ResetClient(isServer, isClient);
|
||||
|
||||
IsServer = isServer;
|
||||
IsClient = isClient;
|
||||
if (!IsServer && !isClient)
|
||||
|
||||
if (networkManager != null)
|
||||
{
|
||||
SpawnManager = networkManager.SpawnManager;
|
||||
NetworkTopologyType = networkManager.NetworkConfig.NetworkTopology;
|
||||
|
||||
if (NetworkTopologyType == NetworkTopologyTypes.DistributedAuthority)
|
||||
{
|
||||
DAHost = IsClient && IsServer;
|
||||
|
||||
// DANGO-TODO: We might allow a dedicated mock CMB server, but for now do not allow this
|
||||
if (!IsClient && IsServer)
|
||||
{
|
||||
Debug.LogError("You cannot start NetworkManager as a server when operating in distributed authority mode!");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (DAHost && networkManager.CMBServiceConnection)
|
||||
{
|
||||
Debug.LogError("You cannot start a host when connecting to a distributed authority CMB Service!");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Only to be invoked when setting the role.
|
||||
/// This resets the current NetworkClient's properties.
|
||||
/// </summary>
|
||||
private void ResetClient(bool isServer, bool isClient)
|
||||
{
|
||||
// If we are niether client nor server, then reset properties (i.e. client has no role)
|
||||
if (!IsServer && !IsClient)
|
||||
{
|
||||
PlayerObject = null;
|
||||
ClientId = 0;
|
||||
IsConnected = false;
|
||||
IsApproved = false;
|
||||
}
|
||||
|
||||
if (networkManager != null)
|
||||
{
|
||||
SpawnManager = networkManager.SpawnManager;
|
||||
SpawnManager = null;
|
||||
DAHost = false;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,15 +1,47 @@
|
||||
using System;
|
||||
using System.Collections;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Runtime.CompilerServices;
|
||||
using Unity.Collections;
|
||||
using Unity.Collections.LowLevel.Unsafe;
|
||||
using Unity.Profiling;
|
||||
using UnityEngine;
|
||||
using Object = UnityEngine.Object;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
|
||||
public enum ConnectionEvent
|
||||
{
|
||||
ClientConnected,
|
||||
PeerConnected,
|
||||
ClientDisconnected,
|
||||
PeerDisconnected
|
||||
}
|
||||
|
||||
public struct ConnectionEventData
|
||||
{
|
||||
public ConnectionEvent EventType;
|
||||
|
||||
/// <summary>
|
||||
/// The client ID for the client that just connected
|
||||
/// For the <see cref="ConnectionEvent.ClientConnected"/> and <see cref="ConnectionEvent.ClientDisconnected"/>
|
||||
/// events on the client side, this will be LocalClientId.
|
||||
/// On the server side, this will be the ID of the client that just connected.
|
||||
///
|
||||
/// For the <see cref="ConnectionEvent.PeerConnected"/> and <see cref="ConnectionEvent.PeerDisconnected"/>
|
||||
/// events on the client side, this will be the client ID assigned by the server to the remote peer.
|
||||
/// </summary>
|
||||
public ulong ClientId;
|
||||
|
||||
/// <summary>
|
||||
/// This is only populated in <see cref="ConnectionEvent.ClientConnected"/> on the client side, and
|
||||
/// contains the list of other peers who were present before you connected. In all other situations,
|
||||
/// this array will be uninitialized.
|
||||
/// </summary>
|
||||
public NativeArray<ulong> PeerClientIds;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The NGO connection manager handles:
|
||||
/// - Client Connections
|
||||
@@ -42,7 +74,105 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
public event Action<ulong> OnClientDisconnectCallback = null;
|
||||
|
||||
internal void InvokeOnClientConnectedCallback(ulong clientId) => OnClientConnectedCallback?.Invoke(clientId);
|
||||
/// <summary>
|
||||
/// The callback to invoke once a peer connects. This callback is only ran on the server and on the local client that connects.
|
||||
/// </summary>
|
||||
public event Action<NetworkManager, ConnectionEventData> OnConnectionEvent = null;
|
||||
|
||||
|
||||
internal void InvokeOnClientConnectedCallback(ulong clientId)
|
||||
{
|
||||
try
|
||||
{
|
||||
OnClientConnectedCallback?.Invoke(clientId);
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
Debug.LogException(exception);
|
||||
}
|
||||
|
||||
if (!NetworkManager.IsServer)
|
||||
{
|
||||
var peerClientIds = new NativeArray<ulong>(Math.Max(NetworkManager.ConnectedClientsIds.Count - 1, 0), Allocator.Temp);
|
||||
// `using var peerClientIds` or `using(peerClientIds)` renders it immutable...
|
||||
using var sentinel = peerClientIds;
|
||||
|
||||
var idx = 0;
|
||||
foreach (var peerId in NetworkManager.ConnectedClientsIds)
|
||||
{
|
||||
if (peerId == NetworkManager.LocalClientId)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
peerClientIds[idx] = peerId;
|
||||
++idx;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
OnConnectionEvent?.Invoke(NetworkManager, new ConnectionEventData { ClientId = NetworkManager.LocalClientId, EventType = ConnectionEvent.ClientConnected, PeerClientIds = peerClientIds });
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
Debug.LogException(exception);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
try
|
||||
{
|
||||
OnConnectionEvent?.Invoke(NetworkManager, new ConnectionEventData { ClientId = clientId, EventType = ConnectionEvent.ClientConnected });
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
Debug.LogException(exception);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
internal void InvokeOnClientDisconnectCallback(ulong clientId)
|
||||
{
|
||||
try
|
||||
{
|
||||
OnClientDisconnectCallback?.Invoke(clientId);
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
Debug.LogException(exception);
|
||||
}
|
||||
try
|
||||
{
|
||||
OnConnectionEvent?.Invoke(NetworkManager, new ConnectionEventData { ClientId = clientId, EventType = ConnectionEvent.ClientDisconnected });
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
Debug.LogException(exception);
|
||||
}
|
||||
}
|
||||
|
||||
internal void InvokeOnPeerConnectedCallback(ulong clientId)
|
||||
{
|
||||
try
|
||||
{
|
||||
OnConnectionEvent?.Invoke(NetworkManager, new ConnectionEventData { ClientId = clientId, EventType = ConnectionEvent.PeerConnected });
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
Debug.LogException(exception);
|
||||
}
|
||||
}
|
||||
internal void InvokeOnPeerDisconnectedCallback(ulong clientId)
|
||||
{
|
||||
try
|
||||
{
|
||||
OnConnectionEvent?.Invoke(NetworkManager, new ConnectionEventData { ClientId = clientId, EventType = ConnectionEvent.PeerDisconnected });
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
Debug.LogException(exception);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The callback to invoke if the <see cref="NetworkTransport"/> fails.
|
||||
@@ -217,7 +347,7 @@ namespace Unity.Netcode
|
||||
// When this happens, the client will not have an entry within the m_TransportIdToClientIdMap or m_ClientIdToTransportIdMap lookup tables so we exit early and just return 0 to be used for the disconnect event.
|
||||
if (!LocalClient.IsServer && !TransportIdToClientIdMap.ContainsKey(transportId))
|
||||
{
|
||||
return 0;
|
||||
return NetworkManager.LocalClientId;
|
||||
}
|
||||
|
||||
var clientId = TransportIdToClientId(transportId);
|
||||
@@ -236,6 +366,10 @@ namespace Unity.Netcode
|
||||
{
|
||||
networkEvent = NetworkManager.NetworkConfig.NetworkTransport.PollEvent(out ulong transportClientId, out ArraySegment<byte> payload, out float receiveTime);
|
||||
HandleNetworkEvent(networkEvent, transportClientId, payload, receiveTime);
|
||||
if (networkEvent == NetworkEvent.Disconnect || networkEvent == NetworkEvent.TransportFailure)
|
||||
{
|
||||
break;
|
||||
}
|
||||
// Only do another iteration if: there are no more messages AND (there is no limit to max events or we have processed less than the maximum)
|
||||
} while (NetworkManager.IsListening && networkEvent != NetworkEvent.Nothing);
|
||||
|
||||
@@ -300,16 +434,17 @@ namespace Unity.Netcode
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
|
||||
{
|
||||
NetworkLog.LogInfo("Client Connected");
|
||||
var hostServer = NetworkManager.IsHost ? "Host" : "Server";
|
||||
NetworkLog.LogInfo($"[{hostServer}-Side] Transport connection established with pending Client-{clientId}.");
|
||||
}
|
||||
|
||||
AddPendingClient(clientId);
|
||||
}
|
||||
else
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
|
||||
{
|
||||
NetworkLog.LogInfo("Connected");
|
||||
var serverOrService = NetworkManager.DistributedAuthorityMode ? NetworkManager.CMBServiceConnection ? "service" : "DAHost" : "server";
|
||||
NetworkLog.LogInfo($"[Approval Pending][Client] Transport connection with {serverOrService} established! Awaiting connection approval...");
|
||||
}
|
||||
|
||||
SendConnectionRequest();
|
||||
@@ -346,31 +481,38 @@ namespace Unity.Netcode
|
||||
s_TransportDisconnect.Begin();
|
||||
#endif
|
||||
var clientId = TransportIdCleanUp(transportClientId);
|
||||
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
|
||||
{
|
||||
NetworkLog.LogInfo($"Disconnect Event From {clientId}");
|
||||
}
|
||||
|
||||
// If we are a client and we have gotten the ServerClientId back, then use our assigned local id as the client that was
|
||||
// disconnected (either the user disconnected or the server disconnected, but the client that disconnected is the LocalClientId)
|
||||
if (!NetworkManager.IsServer && clientId == NetworkManager.ServerClientId)
|
||||
{
|
||||
clientId = NetworkManager.LocalClientId;
|
||||
}
|
||||
|
||||
// Process the incoming message queue so that we get everything from the server disconnecting us or, if we are the server, so we got everything from that client.
|
||||
MessageManager.ProcessIncomingMessageQueue();
|
||||
|
||||
try
|
||||
InvokeOnClientDisconnectCallback(clientId);
|
||||
|
||||
if (LocalClient.IsHost)
|
||||
{
|
||||
OnClientDisconnectCallback?.Invoke(clientId);
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
Debug.LogException(exception);
|
||||
InvokeOnPeerDisconnectedCallback(clientId);
|
||||
}
|
||||
|
||||
if (LocalClient.IsServer)
|
||||
{
|
||||
OnClientDisconnectFromServer(clientId);
|
||||
}
|
||||
else
|
||||
else // As long as we are not in the middle of a shutdown
|
||||
if (!NetworkManager.ShutdownInProgress)
|
||||
{
|
||||
// We must pass true here and not process any sends messages as we are no longer connected and thus there is no one to send any messages to and this will cause an exception within UnityTransport as the client ID is no longer valid.
|
||||
// We must pass true here and not process any sends messages as we are no longer connected.
|
||||
// Otherwise, attempting to process messages here can cause an exception within UnityTransport
|
||||
// as the client ID is no longer valid.
|
||||
NetworkManager.Shutdown(true);
|
||||
}
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
@@ -409,6 +551,10 @@ namespace Unity.Netcode
|
||||
{
|
||||
var message = new ConnectionRequestMessage
|
||||
{
|
||||
CMBServiceConnection = NetworkManager.CMBServiceConnection,
|
||||
TickRate = NetworkManager.NetworkConfig.TickRate,
|
||||
EnableSceneManagement = NetworkManager.NetworkConfig.EnableSceneManagement,
|
||||
|
||||
// Since only a remote client will send a connection request, we should always force the rebuilding of the NetworkConfig hash value
|
||||
ConfigHash = NetworkManager.NetworkConfig.GetConfig(false),
|
||||
ShouldSendConnectionData = NetworkManager.NetworkConfig.ConnectionApproval,
|
||||
@@ -564,6 +710,12 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adding this because message hooks cannot happen fast enough under certain scenarios
|
||||
/// where the message is sent and responded to before the hook is in place.
|
||||
/// </summary>
|
||||
internal bool MockSkippingApproval;
|
||||
|
||||
/// <summary>
|
||||
/// Server Side: Handles the approval of a client
|
||||
/// </summary>
|
||||
@@ -575,12 +727,15 @@ namespace Unity.Netcode
|
||||
LocalClient.IsApproved = response.Approved;
|
||||
if (response.Approved)
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
|
||||
{
|
||||
NetworkLog.LogInfo($"[Server-Side] Pending Client-{ownerClientId} connection approved!");
|
||||
}
|
||||
// The client was approved, stop the server-side approval time out coroutine
|
||||
RemovePendingClient(ownerClientId);
|
||||
|
||||
var client = AddClient(ownerClientId);
|
||||
|
||||
if (response.CreatePlayerObject)
|
||||
if (!NetworkManager.DistributedAuthorityMode && response.CreatePlayerObject && NetworkManager.NetworkConfig.PlayerPrefab != null)
|
||||
{
|
||||
var prefabNetworkObject = NetworkManager.NetworkConfig.PlayerPrefab.GetComponent<NetworkObject>();
|
||||
var playerPrefabHash = response.PlayerPrefabHash ?? prefabNetworkObject.GlobalObjectIdHash;
|
||||
@@ -595,6 +750,7 @@ namespace Unity.Netcode
|
||||
HasTransform = prefabNetworkObject.SynchronizeTransform,
|
||||
Hash = playerPrefabHash,
|
||||
TargetClientId = ownerClientId,
|
||||
DontDestroyWithOwner = prefabNetworkObject.DontDestroyWithOwner,
|
||||
Transform = new NetworkObject.SceneObject.TransformData
|
||||
{
|
||||
Position = response.Position.GetValueOrDefault(),
|
||||
@@ -623,8 +779,18 @@ namespace Unity.Netcode
|
||||
var message = new ConnectionApprovedMessage
|
||||
{
|
||||
OwnerClientId = ownerClientId,
|
||||
NetworkTick = NetworkManager.LocalTime.Tick
|
||||
NetworkTick = NetworkManager.LocalTime.Tick,
|
||||
IsDistributedAuthority = NetworkManager.DistributedAuthorityMode,
|
||||
ConnectedClientIds = new NativeArray<ulong>(ConnectedClientIds.Count, Allocator.Temp)
|
||||
};
|
||||
|
||||
var i = 0;
|
||||
foreach (var clientId in ConnectedClientIds)
|
||||
{
|
||||
message.ConnectedClientIds[i] = clientId;
|
||||
++i;
|
||||
}
|
||||
|
||||
if (!NetworkManager.NetworkConfig.EnableSceneManagement)
|
||||
{
|
||||
// Update the observed spawned NetworkObjects for the newly connected player when scene management is disabled
|
||||
@@ -648,19 +814,43 @@ namespace Unity.Netcode
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
SendMessage(ref message, NetworkDelivery.ReliableFragmentedSequenced, ownerClientId);
|
||||
if (!MockSkippingApproval)
|
||||
{
|
||||
SendMessage(ref message, NetworkDelivery.ReliableFragmentedSequenced, ownerClientId);
|
||||
}
|
||||
else
|
||||
{
|
||||
NetworkLog.LogInfo("Mocking server not responding with connection approved...");
|
||||
}
|
||||
message.MessageVersions.Dispose();
|
||||
message.ConnectedClientIds.Dispose();
|
||||
if (MockSkippingApproval)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
// If scene management is disabled, then we are done and notify the local host-server the client is connected
|
||||
if (!NetworkManager.NetworkConfig.EnableSceneManagement)
|
||||
{
|
||||
NetworkManager.ConnectedClients[ownerClientId].IsConnected = true;
|
||||
InvokeOnClientConnectedCallback(ownerClientId);
|
||||
if (LocalClient.IsHost)
|
||||
{
|
||||
InvokeOnPeerConnectedCallback(ownerClientId);
|
||||
}
|
||||
NetworkManager.SpawnManager.DistributeNetworkObjects(ownerClientId);
|
||||
|
||||
}
|
||||
else // Otherwise, let NetworkSceneManager handle the initial scene and NetworkObject synchronization
|
||||
{
|
||||
NetworkManager.SceneManager.SynchronizeNetworkObjects(ownerClientId);
|
||||
if (NetworkManager.DistributedAuthorityMode && NetworkManager.LocalClient.IsSessionOwner)
|
||||
{
|
||||
NetworkManager.SceneManager.SynchronizeNetworkObjects(ownerClientId);
|
||||
}
|
||||
else if (!NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
NetworkManager.SceneManager.SynchronizeNetworkObjects(ownerClientId);
|
||||
}
|
||||
}
|
||||
}
|
||||
else // Server just adds itself as an observer to all spawned NetworkObjects
|
||||
@@ -668,6 +858,17 @@ namespace Unity.Netcode
|
||||
LocalClient = client;
|
||||
NetworkManager.SpawnManager.UpdateObservedNetworkObjects(ownerClientId);
|
||||
LocalClient.IsConnected = true;
|
||||
// If running mock service, then set the instance as the default session owner
|
||||
if (NetworkManager.DistributedAuthorityMode && NetworkManager.DAHost)
|
||||
{
|
||||
NetworkManager.SetSessionOwner(NetworkManager.LocalClientId);
|
||||
NetworkManager.SceneManager.InitializeScenesLoaded();
|
||||
}
|
||||
|
||||
if (NetworkManager.DistributedAuthorityMode && NetworkManager.AutoSpawnPlayerPrefabClientSide)
|
||||
{
|
||||
CreateAndSpawnPlayer(ownerClientId);
|
||||
}
|
||||
}
|
||||
|
||||
if (!response.CreatePlayerObject || (response.PlayerPrefabHash == null && NetworkManager.NetworkConfig.PlayerPrefab == null))
|
||||
@@ -675,6 +876,11 @@ namespace Unity.Netcode
|
||||
return;
|
||||
}
|
||||
|
||||
// Players are always spawned by their respective client, exit early. (DAHost mode anyway, CMB Service will never spawn player prefab)
|
||||
if (NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
return;
|
||||
}
|
||||
// Separating this into a contained function call for potential further future separation of when this notification is sent.
|
||||
ApprovedPlayerSpawn(ownerClientId, response.PlayerPrefabHash ?? NetworkManager.NetworkConfig.PlayerPrefab.GetComponent<NetworkObject>().GlobalObjectIdHash);
|
||||
}
|
||||
@@ -689,11 +895,28 @@ namespace Unity.Netcode
|
||||
SendMessage(ref disconnectReason, NetworkDelivery.Reliable, ownerClientId);
|
||||
MessageManager.ProcessSendQueues();
|
||||
}
|
||||
|
||||
DisconnectRemoteClient(ownerClientId);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Client-Side Spawning in distributed authority mode uses this to spawn the player.
|
||||
/// </summary>
|
||||
internal void CreateAndSpawnPlayer(ulong ownerId, Vector3 position = default, Quaternion rotation = default)
|
||||
{
|
||||
if (NetworkManager.DistributedAuthorityMode && NetworkManager.AutoSpawnPlayerPrefabClientSide)
|
||||
{
|
||||
var playerPrefab = NetworkManager.FetchLocalPlayerPrefabToSpawn();
|
||||
if (playerPrefab != null)
|
||||
{
|
||||
var globalObjectIdHash = playerPrefab.GetComponent<NetworkObject>().GlobalObjectIdHash;
|
||||
var networkObject = NetworkManager.SpawnManager.GetNetworkObjectToSpawn(globalObjectIdHash, ownerId, position, rotation);
|
||||
networkObject.IsSceneObject = false;
|
||||
networkObject.SpawnAsPlayerObject(ownerId, networkObject.DestroyWithScene);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Spawns the newly approved player
|
||||
/// </summary>
|
||||
@@ -713,8 +936,10 @@ namespace Unity.Netcode
|
||||
|
||||
var message = new CreateObjectMessage
|
||||
{
|
||||
ObjectInfo = ConnectedClients[clientId].PlayerObject.GetMessageSceneObject(clientPair.Key)
|
||||
ObjectInfo = ConnectedClients[clientId].PlayerObject.GetMessageSceneObject(clientPair.Key),
|
||||
IncludesSerializedObject = true,
|
||||
};
|
||||
|
||||
message.ObjectInfo.Hash = playerPrefabHash;
|
||||
message.ObjectInfo.IsSceneObject = false;
|
||||
message.ObjectInfo.HasParent = false;
|
||||
@@ -732,18 +957,92 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
internal NetworkClient AddClient(ulong clientId)
|
||||
{
|
||||
if (ConnectedClients.ContainsKey(clientId) && ConnectedClientIds.Contains(clientId) && ConnectedClientsList.Contains(ConnectedClients[clientId]))
|
||||
{
|
||||
return ConnectedClients[clientId];
|
||||
}
|
||||
|
||||
var networkClient = LocalClient;
|
||||
|
||||
networkClient = new NetworkClient();
|
||||
// If this is not the local client then create a new one
|
||||
if (clientId != NetworkManager.LocalClientId)
|
||||
{
|
||||
networkClient = new NetworkClient();
|
||||
}
|
||||
networkClient.SetRole(clientId == NetworkManager.ServerClientId, isClient: true, NetworkManager);
|
||||
networkClient.ClientId = clientId;
|
||||
if (!ConnectedClients.ContainsKey(clientId))
|
||||
{
|
||||
ConnectedClients.Add(clientId, networkClient);
|
||||
}
|
||||
if (!ConnectedClientsList.Contains(networkClient))
|
||||
{
|
||||
ConnectedClientsList.Add(networkClient);
|
||||
}
|
||||
|
||||
if (NetworkManager.LocalClientId != clientId)
|
||||
{
|
||||
if ((!NetworkManager.DistributedAuthorityMode && NetworkManager.IsServer) ||
|
||||
(NetworkManager.DistributedAuthorityMode && NetworkManager.NetworkConfig.EnableSceneManagement && NetworkManager.DAHost && NetworkManager.LocalClient.IsSessionOwner))
|
||||
{
|
||||
var message = new ClientConnectedMessage { ClientId = clientId };
|
||||
NetworkManager.MessageManager.SendMessage(ref message, NetworkDelivery.ReliableSequenced, ConnectedClientIds.Where((c) => c != NetworkManager.LocalClientId).ToArray());
|
||||
}
|
||||
else if (NetworkManager.DistributedAuthorityMode && NetworkManager.NetworkConfig.EnableSceneManagement && NetworkManager.DAHost && !NetworkManager.LocalClient.IsSessionOwner)
|
||||
{
|
||||
var message = new ClientConnectedMessage
|
||||
{
|
||||
ShouldSynchronize = true,
|
||||
ClientId = clientId
|
||||
};
|
||||
NetworkManager.MessageManager.SendMessage(ref message, NetworkDelivery.ReliableSequenced, NetworkManager.CurrentSessionOwner);
|
||||
}
|
||||
}
|
||||
if (!ConnectedClientIds.Contains(clientId))
|
||||
{
|
||||
ConnectedClientIds.Add(clientId);
|
||||
}
|
||||
|
||||
foreach (var networkObject in NetworkManager.SpawnManager.SpawnedObjectsList)
|
||||
{
|
||||
if (networkObject.SpawnWithObservers)
|
||||
{
|
||||
networkObject.Observers.Add(clientId);
|
||||
}
|
||||
}
|
||||
|
||||
ConnectedClients.Add(clientId, networkClient);
|
||||
ConnectedClientsList.Add(networkClient);
|
||||
ConnectedClientIds.Add(clientId);
|
||||
return networkClient;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Invoked on clients when another client disconnects
|
||||
/// </summary>
|
||||
/// <param name="clientId">the client identifier to remove</param>
|
||||
internal void RemoveClient(ulong clientId)
|
||||
{
|
||||
if (ConnectedClientIds.Contains(clientId))
|
||||
{
|
||||
ConnectedClientIds.Remove(clientId);
|
||||
}
|
||||
if (ConnectedClients.ContainsKey(clientId))
|
||||
{
|
||||
ConnectedClientsList.Remove(ConnectedClients[clientId]);
|
||||
}
|
||||
|
||||
ConnectedClients.Remove(clientId);
|
||||
|
||||
foreach (var networkObject in NetworkManager.SpawnManager.SpawnedObjectsList)
|
||||
{
|
||||
networkObject.Observers.Remove(clientId);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// DANGO-TODO: Until we have the CMB Server end-to-end with all features verified working via integration tests,
|
||||
/// I am keeping this debug toggle available. (NSS)
|
||||
/// </summary>
|
||||
internal bool EnableDistributeLogging;
|
||||
|
||||
/// <summary>
|
||||
/// Server-Side:
|
||||
/// Invoked when a client is disconnected from a server-host
|
||||
@@ -757,6 +1056,7 @@ namespace Unity.Netcode
|
||||
|
||||
// If we are shutting down and this is the server or host disconnecting, then ignore
|
||||
// clean up as everything that needs to be destroyed will be during shutdown.
|
||||
|
||||
if (NetworkManager.ShutdownInProgress && clientId == NetworkManager.ServerClientId)
|
||||
{
|
||||
return;
|
||||
@@ -769,25 +1069,55 @@ namespace Unity.Netcode
|
||||
{
|
||||
if (!playerObject.DontDestroyWithOwner)
|
||||
{
|
||||
if (NetworkManager.PrefabHandler.ContainsHandler(ConnectedClients[clientId].PlayerObject.GlobalObjectIdHash))
|
||||
// DANGO-TODO: This is something that would be best for CMB Service to handle as it is part of the disconnection process
|
||||
// If a player NetworkObject is being despawned, make sure to remove all children if they are marked to not be destroyed
|
||||
// with the owner.
|
||||
if (NetworkManager.DistributedAuthorityMode && NetworkManager.DAHost)
|
||||
{
|
||||
NetworkManager.PrefabHandler.HandleNetworkPrefabDestroy(ConnectedClients[clientId].PlayerObject);
|
||||
// Remove any children from the player object if they are not going to be destroyed with the owner
|
||||
var childNetworkObjects = playerObject.GetComponentsInChildren<NetworkObject>();
|
||||
foreach (var child in childNetworkObjects)
|
||||
{
|
||||
// TODO: We have always just removed all children, but we might think about changing this to preserve the nested child
|
||||
// hierarchy.
|
||||
if (child.DontDestroyWithOwner && child.transform.transform.parent != null)
|
||||
{
|
||||
// If we are here, then we are running in DAHost mode and have the authority to remove the child from its parent
|
||||
child.AuthorityAppliedParenting = true;
|
||||
child.TryRemoveParentCachedWorldPositionStays();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (NetworkManager.PrefabHandler.ContainsHandler(playerObject.GlobalObjectIdHash))
|
||||
{
|
||||
if (NetworkManager.DAHost && NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
NetworkManager.SpawnManager.DespawnObject(playerObject, true, NetworkManager.DistributedAuthorityMode);
|
||||
}
|
||||
else
|
||||
{
|
||||
NetworkManager.PrefabHandler.HandleNetworkPrefabDestroy(playerObject);
|
||||
}
|
||||
}
|
||||
else if (playerObject.IsSpawned)
|
||||
{
|
||||
// Call despawn to assure NetworkBehaviour.OnNetworkDespawn is invoked on the server-side (when the client side disconnected).
|
||||
// This prevents the issue (when just destroying the GameObject) where any NetworkBehaviour component(s) destroyed before the NetworkObject would not have OnNetworkDespawn invoked.
|
||||
NetworkManager.SpawnManager.DespawnObject(playerObject, true);
|
||||
NetworkManager.SpawnManager.DespawnObject(playerObject, true, NetworkManager.DistributedAuthorityMode);
|
||||
}
|
||||
}
|
||||
else
|
||||
else if (!NetworkManager.ShutdownInProgress)
|
||||
{
|
||||
playerObject.RemoveOwnership();
|
||||
if (!NetworkManager.ShutdownInProgress)
|
||||
{
|
||||
playerObject.RemoveOwnership();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Get the NetworkObjects owned by the disconnected client
|
||||
var clientOwnedObjects = NetworkManager.SpawnManager.GetClientOwnedObjects(clientId);
|
||||
var clientOwnedObjects = NetworkManager.SpawnManager.SpawnedObjectsList.Where((c) => c.OwnerClientId == clientId).ToList();
|
||||
if (clientOwnedObjects == null)
|
||||
{
|
||||
// This could happen if a client is never assigned a player object and is disconnected
|
||||
@@ -799,7 +1129,10 @@ namespace Unity.Netcode
|
||||
}
|
||||
else
|
||||
{
|
||||
// Handle changing ownership and prefab handlers
|
||||
// Handle changing ownership and prefab handlers
|
||||
var clientCounter = 0;
|
||||
var predictedClientCount = ConnectedClientsList.Count - 1;
|
||||
var remainingClients = NetworkManager.DistributedAuthorityMode ? ConnectedClientsList.Where((c) => c.ClientId != clientId).ToList() : null;
|
||||
for (int i = clientOwnedObjects.Count - 1; i >= 0; i--)
|
||||
{
|
||||
var ownedObject = clientOwnedObjects[i];
|
||||
@@ -809,16 +1142,72 @@ namespace Unity.Netcode
|
||||
{
|
||||
if (NetworkManager.PrefabHandler.ContainsHandler(clientOwnedObjects[i].GlobalObjectIdHash))
|
||||
{
|
||||
NetworkManager.SpawnManager.DespawnObject(ownedObject, true, true);
|
||||
NetworkManager.PrefabHandler.HandleNetworkPrefabDestroy(clientOwnedObjects[i]);
|
||||
}
|
||||
else
|
||||
{
|
||||
Object.Destroy(ownedObject.gameObject);
|
||||
NetworkManager.SpawnManager.DespawnObject(ownedObject, true, true);
|
||||
}
|
||||
}
|
||||
else
|
||||
else if (!NetworkManager.ShutdownInProgress)
|
||||
{
|
||||
ownedObject.RemoveOwnership();
|
||||
// NOTE: All of the below code only handles ownership transfer.
|
||||
// For client-server, we just remove the ownership.
|
||||
// For distributed authority, we need to change ownership based on parenting
|
||||
if (NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
// Only NetworkObjects that have the OwnershipStatus.Distributable flag set and no parent
|
||||
// (ownership is transferred to all children) will have their ownership redistributed.
|
||||
if (ownedObject.IsOwnershipDistributable && ownedObject.GetCachedParent() == null)
|
||||
{
|
||||
if (ownedObject.IsOwnershipLocked)
|
||||
{
|
||||
ownedObject.SetOwnershipLock(false);
|
||||
}
|
||||
|
||||
// DANGO-TODO: We will want to match how the CMB service handles this. For now, we just try to evenly distribute
|
||||
// ownership.
|
||||
var targetOwner = NetworkManager.ServerClientId;
|
||||
if (predictedClientCount > 1)
|
||||
{
|
||||
clientCounter++;
|
||||
clientCounter = clientCounter % predictedClientCount;
|
||||
targetOwner = remainingClients[clientCounter].ClientId;
|
||||
}
|
||||
if (EnableDistributeLogging)
|
||||
{
|
||||
Debug.Log($"[Disconnected][Client-{clientId}][NetworkObjectId-{ownedObject.NetworkObjectId} Distributed to Client-{targetOwner}");
|
||||
}
|
||||
NetworkManager.SpawnManager.ChangeOwnership(ownedObject, targetOwner, true);
|
||||
// DANGO-TODO: Should we try handling inactive NetworkObjects?
|
||||
// Ownership gets passed down to all children
|
||||
var childNetworkObjects = ownedObject.GetComponentsInChildren<NetworkObject>();
|
||||
foreach (var childObject in childNetworkObjects)
|
||||
{
|
||||
// We already changed ownership for this
|
||||
if (childObject == ownedObject)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
// If the client owner disconnected, it is ok to unlock this at this point in time.
|
||||
if (childObject.IsOwnershipLocked)
|
||||
{
|
||||
childObject.SetOwnershipLock(false);
|
||||
}
|
||||
|
||||
NetworkManager.SpawnManager.ChangeOwnership(childObject, targetOwner, true);
|
||||
if (EnableDistributeLogging)
|
||||
{
|
||||
Debug.Log($"[Disconnected][Client-{clientId}][Child of {ownedObject.NetworkObjectId}][NetworkObjectId-{ownedObject.NetworkObjectId} Distributed to Client-{targetOwner}");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
ownedObject.RemoveOwnership();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -837,6 +1226,42 @@ namespace Unity.Netcode
|
||||
}
|
||||
|
||||
ConnectedClientIds.Remove(clientId);
|
||||
var message = new ClientDisconnectedMessage { ClientId = clientId };
|
||||
MessageManager?.SendMessage(ref message, NetworkDelivery.ReliableFragmentedSequenced, ConnectedClientIds);
|
||||
|
||||
// Used for testing/validation purposes only
|
||||
#if ENABLE_DAHOST_AUTOPROMOTE_SESSION_OWNER
|
||||
if (NetworkManager.DistributedAuthorityMode && !NetworkManager.ShutdownInProgress && NetworkManager.IsListening)
|
||||
{
|
||||
var newSessionOwner = NetworkManager.LocalClientId;
|
||||
if (ConnectedClientIds.Count > 1)
|
||||
{
|
||||
var lowestRTT = ulong.MaxValue;
|
||||
var unityTransport = NetworkManager.NetworkConfig.NetworkTransport as Transports.UTP.UnityTransport;
|
||||
|
||||
foreach (var identifier in ConnectedClientIds)
|
||||
{
|
||||
if (identifier == NetworkManager.LocalClientId)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
var rtt = unityTransport.GetCurrentRtt(identifier);
|
||||
if (rtt < lowestRTT)
|
||||
{
|
||||
newSessionOwner = identifier;
|
||||
lowestRTT = rtt;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var sessionOwnerMessage = new SessionOwnerMessage()
|
||||
{
|
||||
SessionOwner = newSessionOwner,
|
||||
};
|
||||
MessageManager?.SendMessage(ref sessionOwnerMessage, NetworkDelivery.ReliableFragmentedSequenced, ConnectedClientIds);
|
||||
NetworkManager.SetSessionOwner(newSessionOwner);
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
// If the client ID transport map exists
|
||||
@@ -845,13 +1270,11 @@ namespace Unity.Netcode
|
||||
var transportId = ClientIdToTransportId(clientId);
|
||||
NetworkManager.NetworkConfig.NetworkTransport.DisconnectRemoteClient(transportId);
|
||||
|
||||
try
|
||||
InvokeOnClientDisconnectCallback(clientId);
|
||||
|
||||
if (LocalClient.IsHost)
|
||||
{
|
||||
OnClientDisconnectCallback?.Invoke(clientId);
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
Debug.LogException(exception);
|
||||
InvokeOnPeerDisconnectedCallback(clientId);
|
||||
}
|
||||
|
||||
// Clean up the transport to client (and vice versa) mappings
|
||||
@@ -889,6 +1312,12 @@ namespace Unity.Netcode
|
||||
throw new NotServerException($"Only server can disconnect remote clients. Please use `{nameof(Shutdown)}()` instead.");
|
||||
}
|
||||
|
||||
if (clientId == NetworkManager.ServerClientId)
|
||||
{
|
||||
Debug.LogWarning($"Disconnecting the local server-host client is not allowed. Use NetworkManager.Shutdown instead.");
|
||||
return;
|
||||
}
|
||||
|
||||
if (!string.IsNullOrEmpty(reason))
|
||||
{
|
||||
var disconnectReason = new DisconnectReasonMessage
|
||||
@@ -933,13 +1362,8 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
internal void Shutdown()
|
||||
{
|
||||
LocalClient.IsApproved = false;
|
||||
LocalClient.IsConnected = false;
|
||||
if (LocalClient.IsServer)
|
||||
{
|
||||
// make sure all messages are flushed before transport disconnect clients
|
||||
MessageManager?.ProcessSendQueues();
|
||||
|
||||
// Build a list of all client ids to be disconnected
|
||||
var disconnectedIds = new HashSet<ulong>();
|
||||
|
||||
@@ -975,9 +1399,15 @@ namespace Unity.Netcode
|
||||
{
|
||||
DisconnectRemoteClient(clientId);
|
||||
}
|
||||
|
||||
// make sure all messages are flushed before transport disconnects clients
|
||||
MessageManager?.ProcessSendQueues();
|
||||
}
|
||||
else if (NetworkManager != null && NetworkManager.IsListening && LocalClient.IsClient)
|
||||
{
|
||||
// make sure all messages are flushed before disconnecting
|
||||
MessageManager?.ProcessSendQueues();
|
||||
|
||||
// Client only, send disconnect and if transport throws and exception, log the exception and continue the shutdown sequence (or forever be shutting down)
|
||||
try
|
||||
{
|
||||
@@ -989,6 +1419,12 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
LocalClient.IsApproved = false;
|
||||
LocalClient.IsConnected = false;
|
||||
ConnectedClients.Clear();
|
||||
ConnectedClientIds.Clear();
|
||||
ConnectedClientsList.Clear();
|
||||
|
||||
if (NetworkManager != null && NetworkManager.NetworkConfig?.NetworkTransport != null)
|
||||
{
|
||||
NetworkManager.NetworkConfig.NetworkTransport.OnTransportEvent -= HandleNetworkEvent;
|
||||
@@ -1092,8 +1528,8 @@ namespace Unity.Netcode
|
||||
internal int SendMessage<T>(ref T message, NetworkDelivery delivery, ulong clientId)
|
||||
where T : INetworkMessage
|
||||
{
|
||||
// Prevent server sending to itself
|
||||
if (LocalClient.IsServer && clientId == NetworkManager.ServerClientId)
|
||||
// Prevent server sending to itself or if there is no MessageManager yet then exit early
|
||||
if ((LocalClient.IsServer && clientId == NetworkManager.ServerClientId) || MessageManager == null)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -11,6 +11,7 @@ namespace Unity.Netcode
|
||||
private NetworkManager m_NetworkManager;
|
||||
private NetworkConnectionManager m_ConnectionManager;
|
||||
private HashSet<NetworkObject> m_DirtyNetworkObjects = new HashSet<NetworkObject>();
|
||||
private HashSet<NetworkObject> m_PendingDirtyNetworkObjects = new HashSet<NetworkObject>();
|
||||
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
private ProfilerMarker m_NetworkBehaviourUpdate = new ProfilerMarker($"{nameof(NetworkBehaviour)}.{nameof(NetworkBehaviourUpdate)}");
|
||||
@@ -18,7 +19,7 @@ namespace Unity.Netcode
|
||||
|
||||
internal void AddForUpdate(NetworkObject networkObject)
|
||||
{
|
||||
m_DirtyNetworkObjects.Add(networkObject);
|
||||
m_PendingDirtyNetworkObjects.Add(networkObject);
|
||||
}
|
||||
|
||||
internal void NetworkBehaviourUpdate()
|
||||
@@ -28,6 +29,9 @@ namespace Unity.Netcode
|
||||
#endif
|
||||
try
|
||||
{
|
||||
m_DirtyNetworkObjects.UnionWith(m_PendingDirtyNetworkObjects);
|
||||
m_PendingDirtyNetworkObjects.Clear();
|
||||
|
||||
// NetworkObject references can become null, when hidden or despawned. Once NUll, there is no point
|
||||
// trying to process them, even if they were previously marked as dirty.
|
||||
m_DirtyNetworkObjects.RemoveWhere((sobj) => sobj == null);
|
||||
@@ -44,13 +48,12 @@ namespace Unity.Netcode
|
||||
for (int i = 0; i < m_ConnectionManager.ConnectedClientsList.Count; i++)
|
||||
{
|
||||
var client = m_ConnectionManager.ConnectedClientsList[i];
|
||||
|
||||
if (dirtyObj.IsNetworkVisibleTo(client.ClientId))
|
||||
if (m_NetworkManager.DistributedAuthorityMode || dirtyObj.IsNetworkVisibleTo(client.ClientId))
|
||||
{
|
||||
// Sync just the variables for just the objects this client sees
|
||||
for (int k = 0; k < dirtyObj.ChildNetworkBehaviours.Count; k++)
|
||||
{
|
||||
dirtyObj.ChildNetworkBehaviours[k].VariableUpdate(client.ClientId);
|
||||
dirtyObj.ChildNetworkBehaviours[k].NetworkVariableUpdate(client.ClientId);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -69,7 +72,7 @@ namespace Unity.Netcode
|
||||
}
|
||||
for (int k = 0; k < sobj.ChildNetworkBehaviours.Count; k++)
|
||||
{
|
||||
sobj.ChildNetworkBehaviours[k].VariableUpdate(NetworkManager.ServerClientId);
|
||||
sobj.ChildNetworkBehaviours[k].NetworkVariableUpdate(NetworkManager.ServerClientId);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -95,6 +98,8 @@ namespace Unity.Netcode
|
||||
foreach (var dirtyobj in m_DirtyNetworkObjects)
|
||||
{
|
||||
dirtyobj.PostNetworkVariableWrite();
|
||||
// Once done processing, we set the previous owner id to the current owner id
|
||||
dirtyobj.PreviousOwnerId = dirtyobj.OwnerClientId;
|
||||
}
|
||||
m_DirtyNetworkObjects.Clear();
|
||||
}
|
||||
|
||||
@@ -1,11 +1,14 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Unity.Collections;
|
||||
using System.Linq;
|
||||
using UnityEngine;
|
||||
#if UNITY_EDITOR
|
||||
using UnityEditor;
|
||||
#endif
|
||||
using UnityEngine.SceneManagement;
|
||||
using Debug = UnityEngine.Debug;
|
||||
using Unity.Netcode.Components;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
@@ -26,33 +29,311 @@ namespace Unity.Netcode
|
||||
// RuntimeAccessModifiersILPP will make this `public`
|
||||
internal static readonly Dictionary<uint, RpcReceiveHandler> __rpc_func_table = new Dictionary<uint, RpcReceiveHandler>();
|
||||
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR || UNITY_MP_TOOLS_NET_STATS_MONITOR_ENABLED_IN_RELEASE
|
||||
// RuntimeAccessModifiersILPP will make this `public`
|
||||
internal static readonly Dictionary<uint, string> __rpc_name_table = new Dictionary<uint, string>();
|
||||
#endif
|
||||
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
private static List<Type> s_SerializedType = new List<Type>();
|
||||
// This is used to control the serialized type not optimized messaging for integration test purposes
|
||||
internal static bool DisableNotOptimizedSerializedType;
|
||||
/// <summary>
|
||||
/// Until all serialized types are optimized for the distributed authority network topology,
|
||||
/// this will handle the notification to the user that the type being serialized is not yet
|
||||
/// optimized but will only log the message once to prevent log spamming.
|
||||
/// </summary>
|
||||
internal static void LogSerializedTypeNotOptimized<T>()
|
||||
{
|
||||
if (DisableNotOptimizedSerializedType)
|
||||
{
|
||||
return;
|
||||
}
|
||||
var type = typeof(T);
|
||||
if (!s_SerializedType.Contains(type))
|
||||
{
|
||||
s_SerializedType.Add(type);
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
|
||||
{
|
||||
Debug.LogWarning($"[{type.Name}] Serialized type has not been optimized for use with Distributed Authority!");
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
internal static bool IsDistributedAuthority;
|
||||
|
||||
/// <summary>
|
||||
/// Distributed Authority Mode
|
||||
/// Returns true if the current session is running in distributed authority mode.
|
||||
/// </summary>
|
||||
public bool DistributedAuthorityMode { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Distributed Authority Mode
|
||||
/// Gets whether the NetworkManager is connected to a distributed authority state service.
|
||||
/// <see cref="NetworkClient.DAHost"/> to determine if the instance is mocking the state service.
|
||||
/// </summary>
|
||||
public bool CMBServiceConnection
|
||||
{
|
||||
get
|
||||
{
|
||||
return NetworkConfig.UseCMBService;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Distributed Authority Mode
|
||||
/// When enabled, the player prefab will be automatically spawned on the newly connected client-side.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Refer to <see cref="NetworkConfig.AutoSpawnPlayerPrefabClientSide"/> to enable/disable automatic spawning of the player prefab.
|
||||
/// Alternately, override the <see cref="FetchLocalPlayerPrefabToSpawn"/> to control what prefab the player should spawn.
|
||||
/// </remarks>
|
||||
public bool AutoSpawnPlayerPrefabClientSide
|
||||
{
|
||||
get
|
||||
{
|
||||
return NetworkConfig.AutoSpawnPlayerPrefabClientSide;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Distributed Authority Mode
|
||||
/// Delegate definition for <see cref="FetchLocalPlayerPrefabToSpawn"/>
|
||||
/// </summary>
|
||||
/// <returns>Player Prefab <see cref="GameObject"/></returns>
|
||||
public delegate GameObject OnFetchLocalPlayerPrefabToSpawnDelegateHandler();
|
||||
|
||||
/// <summary>
|
||||
/// Distributed Authority Mode
|
||||
/// When a callback is assigned, this provides control over what player prefab a client will be using.
|
||||
/// This is invoked only when <see cref="NetworkConfig.AutoSpawnPlayerPrefabClientSide"/> is enabled.
|
||||
/// </summary>
|
||||
public OnFetchLocalPlayerPrefabToSpawnDelegateHandler OnFetchLocalPlayerPrefabToSpawn;
|
||||
|
||||
internal GameObject FetchLocalPlayerPrefabToSpawn()
|
||||
{
|
||||
if (!AutoSpawnPlayerPrefabClientSide)
|
||||
{
|
||||
Debug.LogError($"[{nameof(FetchLocalPlayerPrefabToSpawn)}] Invoked when {nameof(NetworkConfig.AutoSpawnPlayerPrefabClientSide)} was not set! Check call paths!");
|
||||
return null;
|
||||
}
|
||||
if (OnFetchLocalPlayerPrefabToSpawn == null && NetworkConfig.PlayerPrefab == null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
if (OnFetchLocalPlayerPrefabToSpawn != null)
|
||||
{
|
||||
return OnFetchLocalPlayerPrefabToSpawn();
|
||||
}
|
||||
return NetworkConfig.PlayerPrefab;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Distributed Authority Mode
|
||||
/// Gets whether the current NetworkManager is running as a mock distributed authority state service (DAHost)
|
||||
/// </summary>
|
||||
public bool DAHost
|
||||
{
|
||||
get
|
||||
{
|
||||
return LocalClient.DAHost;
|
||||
}
|
||||
}
|
||||
|
||||
// DANGO-TODO-MVP: Remove these properties once the service handles object distribution
|
||||
internal ulong ClientToRedistribute;
|
||||
internal bool RedistributeToClient;
|
||||
internal int TickToRedistribute;
|
||||
|
||||
internal List<NetworkObject> DeferredDespawnObjects = new List<NetworkObject>();
|
||||
|
||||
public ulong CurrentSessionOwner { get; internal set; }
|
||||
|
||||
/// <summary>
|
||||
/// Delegate declaration for <see cref="OnSessionOwnerPromoted"/>
|
||||
/// </summary>
|
||||
/// <param name="sessionOwnerPromoted">the new session owner client identifier</param>
|
||||
public delegate void OnSessionOwnerPromotedDelegateHandler(ulong sessionOwnerPromoted);
|
||||
|
||||
/// <summary>
|
||||
/// Network Topology: Distributed Authority
|
||||
/// When a new session owner is promoted, this event is triggered on all connected clients
|
||||
/// </summary>
|
||||
public event OnSessionOwnerPromotedDelegateHandler OnSessionOwnerPromoted;
|
||||
|
||||
internal void SetSessionOwner(ulong sessionOwner)
|
||||
{
|
||||
var previousSessionOwner = CurrentSessionOwner;
|
||||
CurrentSessionOwner = sessionOwner;
|
||||
LocalClient.IsSessionOwner = LocalClientId == sessionOwner;
|
||||
if (LocalClient.IsSessionOwner)
|
||||
{
|
||||
foreach (var networkObjectEntry in SpawnManager.SpawnedObjects)
|
||||
{
|
||||
var networkObject = networkObjectEntry.Value;
|
||||
if (networkObject.IsSceneObject == null || !networkObject.IsSceneObject.Value)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
if (networkObject.OwnerClientId != LocalClientId)
|
||||
{
|
||||
SpawnManager.ChangeOwnership(networkObject, LocalClientId, true);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
OnSessionOwnerPromoted?.Invoke(sessionOwner);
|
||||
}
|
||||
|
||||
// TODO: Make this internal after testing
|
||||
internal void PromoteSessionOwner(ulong clientId)
|
||||
{
|
||||
if (!DistributedAuthorityMode)
|
||||
{
|
||||
NetworkLog.LogErrorServer($"[SceneManagement][NotDA] Invoking promote session owner while not in distributed authority mode!");
|
||||
return;
|
||||
}
|
||||
if (!DAHost)
|
||||
{
|
||||
NetworkLog.LogErrorServer($"[SceneManagement][NotDAHost] Client is attempting to promote another client as the session owner!");
|
||||
return;
|
||||
}
|
||||
SetSessionOwner(clientId);
|
||||
var sessionOwnerMessage = new SessionOwnerMessage()
|
||||
{
|
||||
SessionOwner = clientId,
|
||||
};
|
||||
var clients = ConnectionManager.ConnectedClientIds.Where(c => c != LocalClientId).ToArray();
|
||||
foreach (var targetClient in clients)
|
||||
{
|
||||
ConnectionManager.SendMessage(ref sessionOwnerMessage, NetworkDelivery.ReliableSequenced, targetClient);
|
||||
}
|
||||
}
|
||||
|
||||
internal Dictionary<ulong, NetworkTransform> NetworkTransformUpdate = new Dictionary<ulong, NetworkTransform>();
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
internal Dictionary<ulong, NetworkTransform> NetworkTransformFixedUpdate = new Dictionary<ulong, NetworkTransform>();
|
||||
#endif
|
||||
|
||||
internal void NetworkTransformRegistration(NetworkTransform networkTransform, bool forUpdate = true, bool register = true)
|
||||
{
|
||||
if (forUpdate)
|
||||
{
|
||||
if (register)
|
||||
{
|
||||
if (!NetworkTransformUpdate.ContainsKey(networkTransform.NetworkObjectId))
|
||||
{
|
||||
NetworkTransformUpdate.Add(networkTransform.NetworkObjectId, networkTransform);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
NetworkTransformUpdate.Remove(networkTransform.NetworkObjectId);
|
||||
}
|
||||
}
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
else
|
||||
{
|
||||
if (register)
|
||||
{
|
||||
if (!NetworkTransformFixedUpdate.ContainsKey(networkTransform.NetworkObjectId))
|
||||
{
|
||||
NetworkTransformFixedUpdate.Add(networkTransform.NetworkObjectId, networkTransform);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
NetworkTransformFixedUpdate.Remove(networkTransform.NetworkObjectId);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
private void UpdateTopology()
|
||||
{
|
||||
var transportTopology = IsListening ? NetworkConfig.NetworkTransport.CurrentTopology() : NetworkConfig.NetworkTopology;
|
||||
if (transportTopology != NetworkConfig.NetworkTopology)
|
||||
{
|
||||
NetworkLog.LogErrorServer($"[Topology Mismatch] Transport detected an issue with the topology ({transportTopology} | {NetworkConfig.NetworkTopology}) usage or setting! Disconnecting from session.");
|
||||
Shutdown();
|
||||
}
|
||||
else
|
||||
{
|
||||
IsDistributedAuthority = DistributedAuthorityMode = transportTopology == NetworkTopologyTypes.DistributedAuthority;
|
||||
}
|
||||
}
|
||||
|
||||
public void NetworkUpdate(NetworkUpdateStage updateStage)
|
||||
{
|
||||
switch (updateStage)
|
||||
{
|
||||
case NetworkUpdateStage.EarlyUpdate:
|
||||
{
|
||||
UpdateTopology();
|
||||
ConnectionManager.ProcessPendingApprovals();
|
||||
ConnectionManager.PollAndHandleNetworkEvents();
|
||||
|
||||
DeferredMessageManager.ProcessTriggers(IDeferredNetworkMessageManager.TriggerType.OnNextFrame, 0);
|
||||
|
||||
AnticipationSystem.SetupForUpdate();
|
||||
MessageManager.ProcessIncomingMessageQueue();
|
||||
MessageManager.CleanupDisconnectedClients();
|
||||
AnticipationSystem.ProcessReanticipation();
|
||||
}
|
||||
break;
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
case NetworkUpdateStage.FixedUpdate:
|
||||
{
|
||||
foreach (var networkTransformEntry in NetworkTransformFixedUpdate)
|
||||
{
|
||||
if (networkTransformEntry.Value.gameObject.activeInHierarchy && networkTransformEntry.Value.IsSpawned)
|
||||
{
|
||||
networkTransformEntry.Value.OnFixedUpdate();
|
||||
}
|
||||
}
|
||||
}
|
||||
break;
|
||||
#endif
|
||||
case NetworkUpdateStage.PreUpdate:
|
||||
{
|
||||
NetworkTimeSystem.UpdateTime();
|
||||
AnticipationSystem.Update();
|
||||
}
|
||||
break;
|
||||
case NetworkUpdateStage.PreLateUpdate:
|
||||
{
|
||||
// Non-physics based non-authority NetworkTransforms update their states after all other components
|
||||
foreach (var networkTransformEntry in NetworkTransformUpdate)
|
||||
{
|
||||
if (networkTransformEntry.Value.gameObject.activeInHierarchy && networkTransformEntry.Value.IsSpawned)
|
||||
{
|
||||
networkTransformEntry.Value.OnUpdate();
|
||||
}
|
||||
}
|
||||
}
|
||||
break;
|
||||
case NetworkUpdateStage.PostScriptLateUpdate:
|
||||
{
|
||||
AnticipationSystem.Sync();
|
||||
AnticipationSystem.SetupForRender();
|
||||
}
|
||||
break;
|
||||
case NetworkUpdateStage.PostLateUpdate:
|
||||
{
|
||||
// Handle deferred despawning
|
||||
if (DistributedAuthorityMode)
|
||||
{
|
||||
SpawnManager.DeferredDespawnUpdate(ServerTime);
|
||||
}
|
||||
|
||||
// Update any NetworkObject's registered to notify of scene migration changes.
|
||||
NetworkObject.UpdateNetworkObjectSceneChanges();
|
||||
|
||||
// This should be invoked just prior to the MessageManager processes its outbound queue.
|
||||
SceneManager.CheckForAndSendNetworkObjectSceneChanged();
|
||||
|
||||
@@ -68,15 +349,101 @@ namespace Unity.Netcode
|
||||
// This is "ok" to invoke when not processing messages since it is just cleaning up messages that never got handled within their timeout period.
|
||||
DeferredMessageManager.CleanupStaleTriggers();
|
||||
|
||||
// DANGO-TODO-MVP: Remove this once the service handles object distribution
|
||||
// NOTE: This needs to be the last thing done and should happen exactly at this point
|
||||
// in the update
|
||||
if (RedistributeToClient && ServerTime.Tick <= TickToRedistribute)
|
||||
{
|
||||
RedistributeToClient = false;
|
||||
SpawnManager.DistributeNetworkObjects(ClientToRedistribute);
|
||||
ClientToRedistribute = 0;
|
||||
}
|
||||
|
||||
if (m_ShuttingDown)
|
||||
{
|
||||
ShutdownInternal();
|
||||
// Host-server will disconnect any connected clients prior to finalizing its shutdown
|
||||
if (IsServer)
|
||||
{
|
||||
ProcessServerShutdown();
|
||||
}
|
||||
else
|
||||
{
|
||||
// Clients just disconnect immediately
|
||||
ShutdownInternal();
|
||||
}
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Used to provide a graceful shutdown sequence
|
||||
/// </summary>
|
||||
internal enum ServerShutdownStates
|
||||
{
|
||||
None,
|
||||
WaitForClientDisconnects,
|
||||
InternalShutdown,
|
||||
ShuttingDown,
|
||||
};
|
||||
|
||||
internal ServerShutdownStates ServerShutdownState;
|
||||
private float m_ShutdownTimeout;
|
||||
|
||||
/// <summary>
|
||||
/// This is a "soft shutdown" where the host or server will disconnect
|
||||
/// all clients, with a provided reasons, prior to invoking its final
|
||||
/// internal shutdown.
|
||||
/// </summary>
|
||||
internal void ProcessServerShutdown()
|
||||
{
|
||||
var minClientCount = IsHost ? 2 : 1;
|
||||
switch (ServerShutdownState)
|
||||
{
|
||||
case ServerShutdownStates.None:
|
||||
{
|
||||
if (ConnectedClients.Count >= minClientCount)
|
||||
{
|
||||
var hostServer = IsHost ? "host" : "server";
|
||||
var disconnectReason = $"Disconnected due to {hostServer} shutting down.";
|
||||
for (int i = ConnectedClientsIds.Count - 1; i >= 0; i--)
|
||||
{
|
||||
var clientId = ConnectedClientsIds[i];
|
||||
if (clientId == ServerClientId)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
ConnectionManager.DisconnectClient(clientId, disconnectReason);
|
||||
}
|
||||
ServerShutdownState = ServerShutdownStates.WaitForClientDisconnects;
|
||||
m_ShutdownTimeout = Time.realtimeSinceStartup + 5.0f;
|
||||
}
|
||||
else
|
||||
{
|
||||
ServerShutdownState = ServerShutdownStates.InternalShutdown;
|
||||
ProcessServerShutdown();
|
||||
}
|
||||
break;
|
||||
}
|
||||
case ServerShutdownStates.WaitForClientDisconnects:
|
||||
{
|
||||
if (ConnectedClients.Count < minClientCount || m_ShutdownTimeout < Time.realtimeSinceStartup)
|
||||
{
|
||||
ServerShutdownState = ServerShutdownStates.InternalShutdown;
|
||||
ProcessServerShutdown();
|
||||
}
|
||||
break;
|
||||
}
|
||||
case ServerShutdownStates.InternalShutdown:
|
||||
{
|
||||
ServerShutdownState = ServerShutdownStates.ShuttingDown;
|
||||
ShutdownInternal();
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The client id used to represent the server
|
||||
/// </summary>
|
||||
@@ -92,19 +459,19 @@ namespace Unity.Netcode
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a dictionary of connected clients and their clientId keys. This is only accessible on the server.
|
||||
/// Gets a dictionary of connected clients and their clientId keys.
|
||||
/// </summary>
|
||||
public IReadOnlyDictionary<ulong, NetworkClient> ConnectedClients => IsServer ? ConnectionManager.ConnectedClients : throw new NotServerException($"{nameof(ConnectionManager.ConnectedClients)} should only be accessed on server.");
|
||||
public IReadOnlyDictionary<ulong, NetworkClient> ConnectedClients => ConnectionManager.ConnectedClients;
|
||||
|
||||
/// <summary>
|
||||
/// Gets a list of connected clients. This is only accessible on the server.
|
||||
/// Gets a list of connected clients.
|
||||
/// </summary>
|
||||
public IReadOnlyList<NetworkClient> ConnectedClientsList => IsServer ? ConnectionManager.ConnectedClientsList : throw new NotServerException($"{nameof(ConnectionManager.ConnectedClientsList)} should only be accessed on server.");
|
||||
public IReadOnlyList<NetworkClient> ConnectedClientsList => ConnectionManager.ConnectedClientsList;
|
||||
|
||||
/// <summary>
|
||||
/// Gets a list of just the IDs of all connected clients. This is only accessible on the server.
|
||||
/// Gets a list of just the IDs of all connected clients.
|
||||
/// </summary>
|
||||
public IReadOnlyList<ulong> ConnectedClientsIds => IsServer ? ConnectionManager.ConnectedClientIds : throw new NotServerException($"{nameof(ConnectionManager.ConnectedClientIds)} should only be accessed on server.");
|
||||
public IReadOnlyList<ulong> ConnectedClientsIds => ConnectionManager.ConnectedClientIds;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the local <see cref="NetworkClient"/> for this client.
|
||||
@@ -122,6 +489,11 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
public bool IsServer => ConnectionManager.LocalClient.IsServer;
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether or not the current server (local or remote) is a host - i.e., also a client
|
||||
/// </summary>
|
||||
public bool ServerIsHost => ConnectionManager.ConnectedClientIds.Contains(ServerClientId);
|
||||
|
||||
/// <summary>
|
||||
/// Gets Whether or not a client is running
|
||||
/// </summary>
|
||||
@@ -190,6 +562,25 @@ namespace Unity.Netcode
|
||||
remove => ConnectionManager.OnTransportFailure -= value;
|
||||
}
|
||||
|
||||
public delegate void ReanticipateDelegate(double lastRoundTripTime);
|
||||
|
||||
/// <summary>
|
||||
/// This callback is called after all individual OnReanticipate calls on AnticipatedNetworkVariable
|
||||
/// and AnticipatedNetworkTransform values have been invoked. The first parameter is a hash set of
|
||||
/// all the variables that have been changed on this frame (you can detect a particular variable by
|
||||
/// checking if the set contains it), while the second parameter is a set of all anticipated network
|
||||
/// transforms that have been changed. Both are passed as their base class type.
|
||||
///
|
||||
/// The third parameter is the local time corresponding to the current authoritative server state
|
||||
/// (i.e., to determine the amount of time that needs to be re-simulated, you will use
|
||||
/// NetworkManager.LocalTime.Time - authorityTime).
|
||||
/// </summary>
|
||||
public event ReanticipateDelegate OnReanticipate
|
||||
{
|
||||
add => AnticipationSystem.OnReanticipate += value;
|
||||
remove => AnticipationSystem.OnReanticipate -= value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The callback to invoke during connection approval. Allows client code to decide whether or not to allow incoming client connection
|
||||
/// </summary>
|
||||
@@ -209,6 +600,8 @@ namespace Unity.Netcode
|
||||
|
||||
/// <summary>
|
||||
/// The callback to invoke once a client connects. This callback is only ran on the server and on the local client that connects.
|
||||
///
|
||||
/// It is recommended to use OnConnectionEvent instead, as this will eventually be deprecated
|
||||
/// </summary>
|
||||
public event Action<ulong> OnClientConnectedCallback
|
||||
{
|
||||
@@ -218,6 +611,8 @@ namespace Unity.Netcode
|
||||
|
||||
/// <summary>
|
||||
/// The callback to invoke when a client disconnects. This callback is only ran on the server and on the local client that disconnects.
|
||||
///
|
||||
/// It is recommended to use OnConnectionEvent instead, as this will eventually be deprecated
|
||||
/// </summary>
|
||||
public event Action<ulong> OnClientDisconnectCallback
|
||||
{
|
||||
@@ -225,6 +620,16 @@ namespace Unity.Netcode
|
||||
remove => ConnectionManager.OnClientDisconnectCallback -= value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The callback to invoke on any connection event. See <see cref="ConnectionEvent"/> and <see cref="ConnectionEventData"/>
|
||||
/// for more info.
|
||||
/// </summary>
|
||||
public event Action<NetworkManager, ConnectionEventData> OnConnectionEvent
|
||||
{
|
||||
add => ConnectionManager.OnConnectionEvent += value;
|
||||
remove => ConnectionManager.OnConnectionEvent -= value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The current host name we are connected to, used to validate certificate
|
||||
/// </summary>
|
||||
@@ -379,6 +784,24 @@ namespace Unity.Netcode
|
||||
|
||||
internal IDeferredNetworkMessageManager DeferredMessageManager { get; private set; }
|
||||
|
||||
// This erroneously tries to simplify these method references but the docs do not pick it up correctly
|
||||
// because they try to resolve it on the field rather than the class of the same name.
|
||||
#pragma warning disable IDE0001
|
||||
/// <summary>
|
||||
/// Provides access to the various <see cref="SendTo"/> targets at runtime, as well as
|
||||
/// runtime-bound targets like <see cref="Unity.Netcode.RpcTarget.Single"/>,
|
||||
/// <see cref="Unity.Netcode.RpcTarget.Group(NativeArray{ulong})"/>,
|
||||
/// <see cref="Unity.Netcode.RpcTarget.Group(NativeList{ulong})"/>,
|
||||
/// <see cref="Unity.Netcode.RpcTarget.Group(ulong[])"/>,
|
||||
/// <see cref="Unity.Netcode.RpcTarget.Group{T}(T)"/>, <see cref="Unity.Netcode.RpcTarget.Not(ulong)"/>,
|
||||
/// <see cref="Unity.Netcode.RpcTarget.Not(NativeArray{ulong})"/>,
|
||||
/// <see cref="Unity.Netcode.RpcTarget.Not(NativeList{ulong})"/>,
|
||||
/// <see cref="Unity.Netcode.RpcTarget.Not(ulong[])"/>, and
|
||||
/// <see cref="Unity.Netcode.RpcTarget.Not{T}(T)"/>
|
||||
/// </summary>
|
||||
#pragma warning restore IDE0001
|
||||
public RpcTarget RpcTarget;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the CustomMessagingManager for this NetworkManager
|
||||
/// </summary>
|
||||
@@ -402,6 +825,8 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
public NetworkTickSystem NetworkTickSystem { get; private set; }
|
||||
|
||||
internal AnticipationSystem AnticipationSystem { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Used for time mocking in tests
|
||||
/// </summary>
|
||||
@@ -412,6 +837,19 @@ namespace Unity.Netcode
|
||||
internal NetworkConnectionManager ConnectionManager = new NetworkConnectionManager();
|
||||
internal NetworkMessageManager MessageManager = null;
|
||||
|
||||
internal struct Override<T>
|
||||
{
|
||||
private T m_Value;
|
||||
public bool Overidden { get; private set; }
|
||||
internal T Value
|
||||
{
|
||||
get { return Overidden ? m_Value : default(T); }
|
||||
set { Overidden = true; m_Value = value; }
|
||||
}
|
||||
};
|
||||
|
||||
internal Override<ushort> PortOverride;
|
||||
|
||||
#if UNITY_EDITOR
|
||||
internal static INetworkManagerHelper NetworkManagerHelper;
|
||||
|
||||
@@ -651,6 +1089,29 @@ namespace Unity.Netcode
|
||||
|
||||
internal void Initialize(bool server)
|
||||
{
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
if (!DisableNotOptimizedSerializedType)
|
||||
{
|
||||
s_SerializedType.Clear();
|
||||
}
|
||||
#endif
|
||||
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
NetworkTransformFixedUpdate.Clear();
|
||||
#endif
|
||||
NetworkTransformUpdate.Clear();
|
||||
|
||||
UpdateTopology();
|
||||
|
||||
//DANGOEXP TODO: Remove this before finalizing the experimental release
|
||||
NetworkConfig.AutoSpawnPlayerPrefabClientSide = DistributedAuthorityMode;
|
||||
|
||||
// Make sure the ServerShutdownState is reset when initializing
|
||||
if (server)
|
||||
{
|
||||
ServerShutdownState = ServerShutdownStates.None;
|
||||
}
|
||||
|
||||
// Don't allow the user to start a network session if the NetworkManager is
|
||||
// still parented under another GameObject
|
||||
if (NetworkManagerCheckForParent(true))
|
||||
@@ -658,6 +1119,8 @@ namespace Unity.Netcode
|
||||
return;
|
||||
}
|
||||
|
||||
ParseCommandLineOptions();
|
||||
|
||||
if (NetworkConfig.NetworkTransport == null)
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
|
||||
@@ -675,7 +1138,12 @@ namespace Unity.Netcode
|
||||
}
|
||||
|
||||
this.RegisterNetworkUpdate(NetworkUpdateStage.EarlyUpdate);
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
this.RegisterNetworkUpdate(NetworkUpdateStage.FixedUpdate);
|
||||
#endif
|
||||
this.RegisterNetworkUpdate(NetworkUpdateStage.PreUpdate);
|
||||
this.RegisterNetworkUpdate(NetworkUpdateStage.PostScriptLateUpdate);
|
||||
this.RegisterNetworkUpdate(NetworkUpdateStage.PreLateUpdate);
|
||||
this.RegisterNetworkUpdate(NetworkUpdateStage.PostLateUpdate);
|
||||
|
||||
// ComponentFactory needs to set its defaults next
|
||||
@@ -691,11 +1159,17 @@ namespace Unity.Netcode
|
||||
MessageManager.Hook(new NetworkManagerHooks(this));
|
||||
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
MessageManager.Hook(new ProfilingHooks());
|
||||
if (NetworkConfig.NetworkProfilingMetrics)
|
||||
{
|
||||
MessageManager.Hook(new ProfilingHooks());
|
||||
}
|
||||
#endif
|
||||
|
||||
#if MULTIPLAYER_TOOLS
|
||||
MessageManager.Hook(new MetricHooks(this));
|
||||
if (NetworkConfig.NetworkMessageMetrics)
|
||||
{
|
||||
MessageManager.Hook(new MetricHooks(this));
|
||||
}
|
||||
#endif
|
||||
|
||||
// Assures there is a server message queue available
|
||||
@@ -708,12 +1182,15 @@ namespace Unity.Netcode
|
||||
// The remaining systems can then be initialized
|
||||
NetworkTimeSystem = server ? NetworkTimeSystem.ServerTimeSystem() : new NetworkTimeSystem(1.0 / NetworkConfig.TickRate);
|
||||
NetworkTickSystem = NetworkTimeSystem.Initialize(this);
|
||||
AnticipationSystem = new AnticipationSystem(this);
|
||||
|
||||
// Create spawn manager instance
|
||||
SpawnManager = new NetworkSpawnManager(this);
|
||||
|
||||
DeferredMessageManager = ComponentFactory.Create<IDeferredNetworkMessageManager>(this);
|
||||
|
||||
RpcTarget = new RpcTarget(this);
|
||||
|
||||
CustomMessagingManager = new CustomMessagingManager(this);
|
||||
|
||||
SceneManager = new NetworkSceneManager(this);
|
||||
@@ -791,7 +1268,10 @@ namespace Unity.Netcode
|
||||
return false;
|
||||
}
|
||||
|
||||
ConnectionManager.LocalClient.SetRole(true, false, this);
|
||||
if (!ConnectionManager.LocalClient.SetRole(true, false, this))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
ConnectionManager.LocalClient.ClientId = ServerClientId;
|
||||
|
||||
Initialize(true);
|
||||
@@ -804,6 +1284,8 @@ namespace Unity.Netcode
|
||||
{
|
||||
SpawnManager.ServerSpawnSceneObjectsOnStartSweep();
|
||||
|
||||
// Notify the server that everything should be synchronized/spawned at this time.
|
||||
SpawnManager.NotifyNetworkObjectsSynchronized();
|
||||
OnServerStarted?.Invoke();
|
||||
ConnectionManager.LocalClient.IsApproved = true;
|
||||
return true;
|
||||
@@ -837,7 +1319,10 @@ namespace Unity.Netcode
|
||||
return false;
|
||||
}
|
||||
|
||||
ConnectionManager.LocalClient.SetRole(false, true, this);
|
||||
if (!ConnectionManager.LocalClient.SetRole(false, true, this))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
Initialize(false);
|
||||
|
||||
@@ -880,7 +1365,11 @@ namespace Unity.Netcode
|
||||
return false;
|
||||
}
|
||||
|
||||
ConnectionManager.LocalClient.SetRole(true, true, this);
|
||||
if (!ConnectionManager.LocalClient.SetRole(true, true, this))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
Initialize(true);
|
||||
try
|
||||
{
|
||||
@@ -914,6 +1403,7 @@ namespace Unity.Netcode
|
||||
{
|
||||
LocalClientId = ServerClientId;
|
||||
NetworkMetrics.SetConnectionId(LocalClientId);
|
||||
MessageManager.SetLocalClientId(LocalClientId);
|
||||
|
||||
if (NetworkConfig.ConnectionApproval && ConnectionApprovalCallback != null)
|
||||
{
|
||||
@@ -935,13 +1425,17 @@ namespace Unity.Netcode
|
||||
var response = new ConnectionApprovalResponse
|
||||
{
|
||||
Approved = true,
|
||||
CreatePlayerObject = NetworkConfig.PlayerPrefab != null
|
||||
// Distributed authority always returns true since the client side handles spawning (whether automatically or manually)
|
||||
CreatePlayerObject = DistributedAuthorityMode || NetworkConfig.PlayerPrefab != null,
|
||||
};
|
||||
ConnectionManager.HandleConnectionApproval(ServerClientId, response);
|
||||
}
|
||||
|
||||
SpawnManager.ServerSpawnSceneObjectsOnStartSweep();
|
||||
|
||||
// Notify the host that everything should be synchronized/spawned at this time.
|
||||
SpawnManager.NotifyNetworkObjectsSynchronized();
|
||||
|
||||
OnServerStarted?.Invoke();
|
||||
OnClientStarted?.Invoke();
|
||||
|
||||
@@ -992,11 +1486,6 @@ namespace Unity.Netcode
|
||||
MessageManager.StopProcessing = discardMessageQueue;
|
||||
}
|
||||
}
|
||||
|
||||
if (NetworkConfig != null && NetworkConfig.NetworkTransport != null)
|
||||
{
|
||||
NetworkConfig.NetworkTransport.OnTransportEvent -= ConnectionManager.HandleNetworkEvent;
|
||||
}
|
||||
}
|
||||
|
||||
// Ensures that the NetworkManager is cleaned up before OnDestroy is run on NetworkObjects and NetworkBehaviours when unloading a scene with a NetworkManager
|
||||
@@ -1021,6 +1510,9 @@ namespace Unity.Netcode
|
||||
DeferredMessageManager?.CleanupAllTriggers();
|
||||
CustomMessagingManager = null;
|
||||
|
||||
RpcTarget?.Dispose();
|
||||
RpcTarget = null;
|
||||
|
||||
BehaviourUpdater?.Shutdown();
|
||||
BehaviourUpdater = null;
|
||||
|
||||
@@ -1047,6 +1539,12 @@ namespace Unity.Netcode
|
||||
IsListening = false;
|
||||
m_ShuttingDown = false;
|
||||
|
||||
// Generate a local notification that the host client is disconnected
|
||||
if (IsHost)
|
||||
{
|
||||
ConnectionManager.InvokeOnClientDisconnectCallback(LocalClientId);
|
||||
}
|
||||
|
||||
if (ConnectionManager.LocalClient.IsClient)
|
||||
{
|
||||
// If we were a client, we want to know if we were a host
|
||||
@@ -1080,6 +1578,7 @@ namespace Unity.Netcode
|
||||
NetworkTickSystem = null;
|
||||
}
|
||||
|
||||
|
||||
// Ensures that the NetworkManager is cleaned up before OnDestroy is run on NetworkObjects and NetworkBehaviours when quitting the application.
|
||||
private void OnApplicationQuit()
|
||||
{
|
||||
@@ -1100,5 +1599,39 @@ namespace Unity.Netcode
|
||||
Singleton = null;
|
||||
}
|
||||
}
|
||||
|
||||
// Command line options
|
||||
private const string k_OverridePortArg = "-port";
|
||||
|
||||
private string GetArg(string[] commandLineArgs, string arg)
|
||||
{
|
||||
var argIndex = Array.IndexOf(commandLineArgs, arg);
|
||||
if (argIndex >= 0 && argIndex < commandLineArgs.Length - 1)
|
||||
{
|
||||
return commandLineArgs[argIndex + 1];
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private void ParseArg<T>(string arg, ref Override<T> value)
|
||||
{
|
||||
if (GetArg(Environment.GetCommandLineArgs(), arg) is string argValue)
|
||||
{
|
||||
value.Value = (T)Convert.ChangeType(argValue, typeof(T));
|
||||
}
|
||||
}
|
||||
|
||||
private void ParseCommandLineOptions()
|
||||
{
|
||||
#if UNITY_SERVER && UNITY_DEDICATED_SERVER_ARGUMENTS_PRESENT
|
||||
if ( UnityEngine.DedicatedServer.Arguments.Port != null)
|
||||
{
|
||||
PortOverride.Value = (ushort)UnityEngine.DedicatedServer.Arguments.Port;
|
||||
}
|
||||
#else
|
||||
ParseArg(k_OverridePortArg, ref PortOverride);
|
||||
#endif
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -54,6 +54,12 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
PreLateUpdate = 6,
|
||||
/// <summary>
|
||||
/// Updated after Monobehaviour.LateUpdate, but BEFORE rendering
|
||||
/// </summary>
|
||||
// Yes, these numbers are out of order due to backward compatibility requirements.
|
||||
// The enum values are listed in the order they will be called.
|
||||
PostScriptLateUpdate = 8,
|
||||
/// <summary>
|
||||
/// Updated after the Monobehaviour.LateUpdate for all components is invoked
|
||||
/// </summary>
|
||||
PostLateUpdate = 7
|
||||
@@ -258,6 +264,18 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
internal struct NetworkPostScriptLateUpdate
|
||||
{
|
||||
public static PlayerLoopSystem CreateLoopSystem()
|
||||
{
|
||||
return new PlayerLoopSystem
|
||||
{
|
||||
type = typeof(NetworkPostScriptLateUpdate),
|
||||
updateDelegate = () => RunNetworkUpdateStage(NetworkUpdateStage.PostScriptLateUpdate)
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
internal struct NetworkPostLateUpdate
|
||||
{
|
||||
public static PlayerLoopSystem CreateLoopSystem()
|
||||
@@ -399,6 +417,7 @@ namespace Unity.Netcode
|
||||
else if (currentSystem.type == typeof(PreLateUpdate))
|
||||
{
|
||||
TryAddLoopSystem(ref currentSystem, NetworkPreLateUpdate.CreateLoopSystem(), typeof(PreLateUpdate.ScriptRunBehaviourLateUpdate), LoopSystemPosition.Before);
|
||||
TryAddLoopSystem(ref currentSystem, NetworkPostScriptLateUpdate.CreateLoopSystem(), typeof(PreLateUpdate.ScriptRunBehaviourLateUpdate), LoopSystemPosition.After);
|
||||
}
|
||||
else if (currentSystem.type == typeof(PostLateUpdate))
|
||||
{
|
||||
@@ -440,6 +459,7 @@ namespace Unity.Netcode
|
||||
else if (currentSystem.type == typeof(PreLateUpdate))
|
||||
{
|
||||
TryRemoveLoopSystem(ref currentSystem, typeof(NetworkPreLateUpdate));
|
||||
TryRemoveLoopSystem(ref currentSystem, typeof(NetworkPostScriptLateUpdate));
|
||||
}
|
||||
else if (currentSystem.type == typeof(PostLateUpdate))
|
||||
{
|
||||
|
||||
@@ -39,6 +39,12 @@ namespace Unity.Netcode
|
||||
/// <param name="message">The message to log</param>
|
||||
public static void LogInfoServer(string message) => LogServer(message, LogType.Info);
|
||||
|
||||
/// <summary>
|
||||
/// Logs an info log locally and on the session owner if possible.
|
||||
/// </summary>
|
||||
/// <param name="message">The message to log</param>
|
||||
public static void LogInfoSessionOwner(string message) => LogServer(message, LogType.Info);
|
||||
|
||||
/// <summary>
|
||||
/// Logs a warning log locally and on the server if possible.
|
||||
/// </summary>
|
||||
@@ -58,7 +64,8 @@ namespace Unity.Netcode
|
||||
var networkManager = NetworkManagerOverride ??= NetworkManager.Singleton;
|
||||
// Get the sender of the local log
|
||||
ulong localId = networkManager?.LocalClientId ?? 0;
|
||||
bool isServer = networkManager?.IsServer ?? true;
|
||||
bool isServer = networkManager && networkManager.DistributedAuthorityMode ? networkManager.LocalClient.IsSessionOwner :
|
||||
networkManager && !networkManager.DistributedAuthorityMode ? networkManager.IsServer : true;
|
||||
switch (logType)
|
||||
{
|
||||
case LogType.Info:
|
||||
@@ -98,7 +105,8 @@ namespace Unity.Netcode
|
||||
var networkMessage = new ServerLogMessage
|
||||
{
|
||||
LogType = logType,
|
||||
Message = message
|
||||
Message = message,
|
||||
SenderId = localId
|
||||
};
|
||||
var size = networkManager.ConnectionManager.SendMessage(ref networkMessage, NetworkDelivery.ReliableFragmentedSequenced, NetworkManager.ServerClientId);
|
||||
|
||||
@@ -106,9 +114,19 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
internal static void LogInfoServerLocal(string message, ulong sender) => Debug.Log($"[Netcode-Server Sender={sender}] {message}");
|
||||
internal static void LogWarningServerLocal(string message, ulong sender) => Debug.LogWarning($"[Netcode-Server Sender={sender}] {message}");
|
||||
internal static void LogErrorServerLocal(string message, ulong sender) => Debug.LogError($"[Netcode-Server Sender={sender}] {message}");
|
||||
private static string Header()
|
||||
{
|
||||
var networkManager = NetworkManagerOverride ??= NetworkManager.Singleton;
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
return "Session-Owner";
|
||||
}
|
||||
return "Netcode-Server";
|
||||
}
|
||||
|
||||
internal static void LogInfoServerLocal(string message, ulong sender) => Debug.Log($"[{Header()} Sender={sender}] {message}");
|
||||
internal static void LogWarningServerLocal(string message, ulong sender) => Debug.LogWarning($"[{Header()} Sender={sender}] {message}");
|
||||
internal static void LogErrorServerLocal(string message, ulong sender) => Debug.LogError($"[{Header()} Sender={sender}] {message}");
|
||||
|
||||
internal enum LogType : byte
|
||||
{
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Unity.Collections;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
@@ -62,16 +63,39 @@ namespace Unity.Netcode
|
||||
/// <param name="networkDelivery">The delivery type (QoS) to send data with</param>
|
||||
public void SendUnnamedMessage(IReadOnlyList<ulong> clientIds, FastBufferWriter messageBuffer, NetworkDelivery networkDelivery = NetworkDelivery.ReliableSequenced)
|
||||
{
|
||||
if (!m_NetworkManager.IsServer)
|
||||
{
|
||||
throw new InvalidOperationException("Can not send unnamed messages to multiple users as a client");
|
||||
}
|
||||
|
||||
if (clientIds == null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(clientIds), "You must pass in a valid clientId List");
|
||||
throw new ArgumentNullException(nameof(clientIds), "You must pass in a valid clientId List!");
|
||||
}
|
||||
|
||||
if (!m_NetworkManager.DistributedAuthorityMode && !m_NetworkManager.IsServer)
|
||||
{
|
||||
if (clientIds.Count > 1 || (clientIds.Count == 1 && clientIds[0] != NetworkManager.ServerClientId))
|
||||
{
|
||||
Debug.LogError("Clients cannot send unnamed messages to other clients!");
|
||||
return;
|
||||
}
|
||||
else if (clientIds.Count == 1)
|
||||
{
|
||||
SendUnnamedMessage(clientIds[0], messageBuffer, networkDelivery);
|
||||
}
|
||||
}
|
||||
else if (m_NetworkManager.DistributedAuthorityMode && !m_NetworkManager.DAHost)
|
||||
{
|
||||
if (clientIds.Count > 1)
|
||||
{
|
||||
Debug.LogError("Sending an unnamed message to multiple clients is not yet supported in distributed authority.");
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if (clientIds.Count == 0)
|
||||
{
|
||||
Debug.LogError($"{nameof(clientIds)} is empty! No clients to send to.");
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
if (m_NetworkManager.IsHost)
|
||||
{
|
||||
for (var i = 0; i < clientIds.Count; ++i)
|
||||
@@ -151,18 +175,14 @@ namespace Unity.Netcode
|
||||
// We dont know what size to use. Try every (more collision prone)
|
||||
if (m_NamedMessageHandlers32.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler32))
|
||||
{
|
||||
// handler can remove itself, cache the name for metrics
|
||||
string messageName = m_MessageHandlerNameLookup32[hash];
|
||||
messageHandler32(sender, reader);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, messageName, bytesCount);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup32[hash], bytesCount);
|
||||
}
|
||||
|
||||
if (m_NamedMessageHandlers64.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler64))
|
||||
{
|
||||
// handler can remove itself, cache the name for metrics
|
||||
string messageName = m_MessageHandlerNameLookup64[hash];
|
||||
messageHandler64(sender, reader);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, messageName, bytesCount);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup64[hash], bytesCount);
|
||||
}
|
||||
}
|
||||
else
|
||||
@@ -173,19 +193,15 @@ namespace Unity.Netcode
|
||||
case HashSize.VarIntFourBytes:
|
||||
if (m_NamedMessageHandlers32.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler32))
|
||||
{
|
||||
// handler can remove itself, cache the name for metrics
|
||||
string messageName = m_MessageHandlerNameLookup32[hash];
|
||||
messageHandler32(sender, reader);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, messageName, bytesCount);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup32[hash], bytesCount);
|
||||
}
|
||||
break;
|
||||
case HashSize.VarIntEightBytes:
|
||||
if (m_NamedMessageHandlers64.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler64))
|
||||
{
|
||||
// handler can remove itself, cache the name for metrics
|
||||
string messageName = m_MessageHandlerNameLookup64[hash];
|
||||
messageHandler64(sender, reader);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, messageName, bytesCount);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup64[hash], bytesCount);
|
||||
}
|
||||
break;
|
||||
}
|
||||
@@ -199,9 +215,25 @@ namespace Unity.Netcode
|
||||
/// <param name="callback">The callback to run when a named message is received.</param>
|
||||
public void RegisterNamedMessageHandler(string name, HandleNamedMessageDelegate callback)
|
||||
{
|
||||
if (string.IsNullOrEmpty(name))
|
||||
{
|
||||
if (m_NetworkManager.LogLevel <= LogLevel.Error)
|
||||
{
|
||||
Debug.LogError($"[{nameof(RegisterNamedMessageHandler)}] Cannot register a named message of type null or empty!");
|
||||
}
|
||||
return;
|
||||
}
|
||||
var hash32 = XXHash.Hash32(name);
|
||||
var hash64 = XXHash.Hash64(name);
|
||||
|
||||
if (m_NetworkManager.LogLevel <= LogLevel.Developer)
|
||||
{
|
||||
if (m_MessageHandlerNameLookup32.ContainsKey(hash32) || m_MessageHandlerNameLookup64.ContainsKey(hash64))
|
||||
{
|
||||
Debug.LogWarning($"Registering {name} named message over existing registration! Your previous registration's callback is being overwritten!");
|
||||
}
|
||||
}
|
||||
|
||||
m_NamedMessageHandlers32[hash32] = callback;
|
||||
m_NamedMessageHandlers64[hash64] = callback;
|
||||
|
||||
@@ -215,6 +247,15 @@ namespace Unity.Netcode
|
||||
/// <param name="name">The name of the message.</param>
|
||||
public void UnregisterNamedMessageHandler(string name)
|
||||
{
|
||||
if (string.IsNullOrEmpty(name))
|
||||
{
|
||||
if (m_NetworkManager.LogLevel <= LogLevel.Error)
|
||||
{
|
||||
Debug.LogError($"[{nameof(UnregisterNamedMessageHandler)}] Cannot unregister a named message of type null or empty!");
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
var hash32 = XXHash.Hash32(name);
|
||||
var hash64 = XXHash.Hash64(name);
|
||||
|
||||
@@ -293,14 +334,37 @@ namespace Unity.Netcode
|
||||
/// <param name="networkDelivery">The delivery type (QoS) to send data with</param>
|
||||
public void SendNamedMessage(string messageName, IReadOnlyList<ulong> clientIds, FastBufferWriter messageStream, NetworkDelivery networkDelivery = NetworkDelivery.ReliableSequenced)
|
||||
{
|
||||
if (!m_NetworkManager.IsServer)
|
||||
{
|
||||
throw new InvalidOperationException("Can not send unnamed messages to multiple users as a client");
|
||||
}
|
||||
|
||||
if (clientIds == null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(clientIds), "You must pass in a valid clientId List");
|
||||
throw new ArgumentNullException(nameof(clientIds), "Client list is null! You must pass in a valid clientId list to send a named message.");
|
||||
}
|
||||
|
||||
if (!m_NetworkManager.DistributedAuthorityMode && !m_NetworkManager.IsServer)
|
||||
{
|
||||
if (clientIds.Count > 1 || (clientIds.Count == 1 && clientIds[0] != NetworkManager.ServerClientId))
|
||||
{
|
||||
Debug.LogError("Clients cannot send named messages to other clients!");
|
||||
return;
|
||||
}
|
||||
else if (clientIds.Count == 1)
|
||||
{
|
||||
SendNamedMessage(messageName, clientIds[0], messageStream, networkDelivery);
|
||||
return;
|
||||
}
|
||||
}
|
||||
else if (m_NetworkManager.DistributedAuthorityMode && !m_NetworkManager.DAHost)
|
||||
{
|
||||
if (clientIds.Count > 1)
|
||||
{
|
||||
Debug.LogError("Sending a named message to multiple clients is not yet supported in distributed authority.");
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if (clientIds.Count == 0)
|
||||
{
|
||||
Debug.LogError($"{nameof(clientIds)} is empty! No clients to send the named message {messageName} to!");
|
||||
return;
|
||||
}
|
||||
|
||||
ulong hash = 0;
|
||||
|
||||
@@ -15,6 +15,7 @@ namespace Unity.Netcode
|
||||
}
|
||||
protected struct TriggerInfo
|
||||
{
|
||||
public string MessageType;
|
||||
public float Expiry;
|
||||
public NativeList<TriggerData> TriggerData;
|
||||
}
|
||||
@@ -36,7 +37,7 @@ namespace Unity.Netcode
|
||||
/// There is a one second maximum lifetime of triggers to avoid memory leaks. After one second has passed
|
||||
/// without the requested object ID being spawned, the triggers for it are automatically deleted.
|
||||
/// </summary>
|
||||
public virtual unsafe void DeferMessage(IDeferredNetworkMessageManager.TriggerType trigger, ulong key, FastBufferReader reader, ref NetworkContext context)
|
||||
public virtual unsafe void DeferMessage(IDeferredNetworkMessageManager.TriggerType trigger, ulong key, FastBufferReader reader, ref NetworkContext context, string messageType)
|
||||
{
|
||||
if (!m_Triggers.TryGetValue(trigger, out var triggers))
|
||||
{
|
||||
@@ -48,6 +49,7 @@ namespace Unity.Netcode
|
||||
{
|
||||
triggerInfo = new TriggerInfo
|
||||
{
|
||||
MessageType = messageType,
|
||||
Expiry = m_NetworkManager.RealTimeProvider.RealTimeSinceStartup + m_NetworkManager.NetworkConfig.SpawnTimeout,
|
||||
TriggerData = new NativeList<TriggerData>(Allocator.Persistent)
|
||||
};
|
||||
@@ -90,11 +92,29 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Used for testing purposes
|
||||
/// </summary>
|
||||
internal static bool IncludeMessageType = true;
|
||||
|
||||
private string GetWarningMessage(IDeferredNetworkMessageManager.TriggerType triggerType, ulong key, TriggerInfo triggerInfo, float spawnTimeout)
|
||||
{
|
||||
if (IncludeMessageType)
|
||||
{
|
||||
return $"[Deferred {triggerType}] Messages were received for a trigger of type {triggerInfo.MessageType} associated with id ({key}), but the {nameof(NetworkObject)} was not received within the timeout period {spawnTimeout} second(s).";
|
||||
}
|
||||
else
|
||||
{
|
||||
return $"Deferred messages were received for a trigger of type {triggerType} associated with id ({key}), but the {nameof(NetworkObject)} was not received within the timeout period {spawnTimeout} second(s).";
|
||||
}
|
||||
}
|
||||
|
||||
protected virtual void PurgeTrigger(IDeferredNetworkMessageManager.TriggerType triggerType, ulong key, TriggerInfo triggerInfo)
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
var logLevel = m_NetworkManager.DistributedAuthorityMode ? LogLevel.Developer : LogLevel.Normal;
|
||||
if (NetworkLog.CurrentLogLevel <= logLevel)
|
||||
{
|
||||
NetworkLog.LogWarning($"Deferred messages were received for a trigger of type {triggerType} with key {key}, but that trigger was not received within within {m_NetworkManager.NetworkConfig.SpawnTimeout} second(s).");
|
||||
NetworkLog.LogWarning(GetWarningMessage(triggerType, key, triggerInfo, m_NetworkManager.NetworkConfig.SpawnTimeout));
|
||||
}
|
||||
|
||||
foreach (var data in triggerInfo.TriggerData)
|
||||
@@ -113,6 +133,7 @@ namespace Unity.Netcode
|
||||
// processed before the object is fully spawned. This must be the last thing done in the spawn process.
|
||||
if (triggers.TryGetValue(key, out var triggerInfo))
|
||||
{
|
||||
triggers.Remove(key);
|
||||
foreach (var deferredMessage in triggerInfo.TriggerData)
|
||||
{
|
||||
// Reader will be disposed within HandleMessage
|
||||
@@ -120,7 +141,6 @@ namespace Unity.Netcode
|
||||
}
|
||||
|
||||
triggerInfo.TriggerData.Dispose();
|
||||
triggers.Remove(key);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal interface IDeferredNetworkMessageManager
|
||||
@@ -6,6 +7,7 @@ namespace Unity.Netcode
|
||||
{
|
||||
OnSpawn,
|
||||
OnAddPrefab,
|
||||
OnNextFrame,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -16,7 +18,7 @@ namespace Unity.Netcode
|
||||
/// There is a one second maximum lifetime of triggers to avoid memory leaks. After one second has passed
|
||||
/// without the requested object ID being spawned, the triggers for it are automatically deleted.
|
||||
/// </summary>
|
||||
void DeferMessage(TriggerType trigger, ulong key, FastBufferReader reader, ref NetworkContext context);
|
||||
void DeferMessage(TriggerType trigger, ulong key, FastBufferReader reader, ref NetworkContext context, string messageType = null);
|
||||
|
||||
/// <summary>
|
||||
/// Cleans up any trigger that's existed for more than a second.
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
#if UNITY_EDITOR
|
||||
using UnityEditor;
|
||||
@@ -12,9 +13,121 @@ namespace Unity.Netcode
|
||||
internal static readonly List<NetworkMessageManager.MessageWithHandler> __network_message_types = new List<NetworkMessageManager.MessageWithHandler>();
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
|
||||
/// <summary>
|
||||
/// Enum representing the different types of messages that can be sent over the network.
|
||||
/// The values cannot be changed, as they are used to serialize and deserialize messages.
|
||||
/// Adding new messages should be done by adding new values to the end of the enum
|
||||
/// using the next free value.
|
||||
/// </summary>
|
||||
/// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
/// Add any new Message types to this table at the END with incremented index value
|
||||
/// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
internal enum NetworkMessageTypes : uint
|
||||
{
|
||||
ConnectionApproved = 0,
|
||||
ConnectionRequest = 1,
|
||||
ChangeOwnership = 2,
|
||||
ClientConnected = 3,
|
||||
ClientDisconnected = 4,
|
||||
ClientRpc = 5,
|
||||
CreateObject = 6,
|
||||
DestroyObject = 7,
|
||||
DisconnectReason = 8,
|
||||
ForwardClientRpc = 9,
|
||||
ForwardServerRpc = 10,
|
||||
NamedMessage = 11,
|
||||
NetworkTransformMessage = 12,
|
||||
NetworkVariableDelta = 13,
|
||||
ParentSync = 14,
|
||||
Proxy = 15,
|
||||
Rpc = 16,
|
||||
SceneEvent = 17,
|
||||
ServerLog = 18,
|
||||
ServerRpc = 19,
|
||||
SessionOwner = 20,
|
||||
TimeSync = 21,
|
||||
Unnamed = 22,
|
||||
AnticipationCounterSyncPingMessage = 23,
|
||||
AnticipationCounterSyncPongMessage = 24,
|
||||
}
|
||||
|
||||
|
||||
// Enable this for integration tests that need no message types defined
|
||||
internal static bool IntegrationTestNoMessages;
|
||||
|
||||
public List<NetworkMessageManager.MessageWithHandler> GetMessages()
|
||||
{
|
||||
return __network_message_types;
|
||||
// return no message types when defined for integration tests
|
||||
if (IntegrationTestNoMessages)
|
||||
{
|
||||
return new List<NetworkMessageManager.MessageWithHandler>();
|
||||
}
|
||||
var messageTypeCount = Enum.GetValues(typeof(NetworkMessageTypes)).Length;
|
||||
// Assure the allowed types count is the same as our NetworkMessageType enum count
|
||||
if (__network_message_types.Count != messageTypeCount)
|
||||
{
|
||||
throw new Exception($"Allowed types is not equal to the number of message type indices! Allowed Count: {__network_message_types.Count} | Index Count: {messageTypeCount}");
|
||||
}
|
||||
|
||||
// Populate with blanks to be replaced later
|
||||
var adjustedMessageTypes = new List<NetworkMessageManager.MessageWithHandler>();
|
||||
var blank = new NetworkMessageManager.MessageWithHandler();
|
||||
for (int i = 0; i < messageTypeCount; i++)
|
||||
{
|
||||
adjustedMessageTypes.Add(blank);
|
||||
}
|
||||
|
||||
// Create a type to enum index lookup table
|
||||
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
// Add new Message types to this table paired with its new NetworkMessageTypes enum
|
||||
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
var messageTypes = new Dictionary<Type, NetworkMessageTypes>
|
||||
{
|
||||
{ typeof(ConnectionApprovedMessage), NetworkMessageTypes.ConnectionApproved }, // This MUST be first
|
||||
{ typeof(ConnectionRequestMessage), NetworkMessageTypes.ConnectionRequest }, // This MUST be second
|
||||
{ typeof(ChangeOwnershipMessage), NetworkMessageTypes.ChangeOwnership },
|
||||
{ typeof(ClientConnectedMessage), NetworkMessageTypes.ClientConnected },
|
||||
{ typeof(ClientDisconnectedMessage), NetworkMessageTypes.ClientDisconnected },
|
||||
{ typeof(ClientRpcMessage), NetworkMessageTypes.ClientRpc },
|
||||
{ typeof(CreateObjectMessage), NetworkMessageTypes.CreateObject },
|
||||
{ typeof(DestroyObjectMessage), NetworkMessageTypes.DestroyObject },
|
||||
{ typeof(DisconnectReasonMessage), NetworkMessageTypes.DisconnectReason },
|
||||
{ typeof(ForwardClientRpcMessage), NetworkMessageTypes.ForwardClientRpc },
|
||||
{ typeof(ForwardServerRpcMessage), NetworkMessageTypes.ForwardServerRpc },
|
||||
{ typeof(NamedMessage), NetworkMessageTypes.NamedMessage },
|
||||
{ typeof(NetworkTransformMessage), NetworkMessageTypes.NetworkTransformMessage },
|
||||
{ typeof(NetworkVariableDeltaMessage), NetworkMessageTypes.NetworkVariableDelta },
|
||||
{ typeof(ParentSyncMessage), NetworkMessageTypes.ParentSync },
|
||||
{ typeof(ProxyMessage), NetworkMessageTypes.Proxy },
|
||||
{ typeof(RpcMessage), NetworkMessageTypes.Rpc },
|
||||
{ typeof(SceneEventMessage), NetworkMessageTypes.SceneEvent },
|
||||
{ typeof(ServerLogMessage), NetworkMessageTypes.ServerLog },
|
||||
{ typeof(ServerRpcMessage), NetworkMessageTypes.ServerRpc },
|
||||
{ typeof(TimeSyncMessage), NetworkMessageTypes.TimeSync },
|
||||
{ typeof(UnnamedMessage), NetworkMessageTypes.Unnamed },
|
||||
{ typeof(SessionOwnerMessage), NetworkMessageTypes.SessionOwner },
|
||||
{ typeof(AnticipationCounterSyncPingMessage), NetworkMessageTypes.AnticipationCounterSyncPingMessage},
|
||||
{ typeof(AnticipationCounterSyncPongMessage), NetworkMessageTypes.AnticipationCounterSyncPongMessage},
|
||||
};
|
||||
|
||||
// Assure the type to lookup table count and NetworkMessageType enum count matches (i.e. to catch human error when adding new messages)
|
||||
if (messageTypes.Count != messageTypeCount)
|
||||
{
|
||||
throw new Exception($"Message type to Message type index count mistmatch! Table Count: {messageTypes.Count} | Index Count: {messageTypeCount}");
|
||||
}
|
||||
|
||||
// Now order the allowed types list based on the order of the NetworkMessageType enum
|
||||
foreach (var messageHandler in __network_message_types)
|
||||
{
|
||||
if (!messageTypes.ContainsKey(messageHandler.MessageType))
|
||||
{
|
||||
throw new Exception($"Missing message type from lookup table: {messageHandler.MessageType}");
|
||||
}
|
||||
adjustedMessageTypes[(int)messageTypes[messageHandler.MessageType]] = messageHandler;
|
||||
}
|
||||
|
||||
// return the NetworkMessageType enum ordered list
|
||||
return adjustedMessageTypes;
|
||||
}
|
||||
|
||||
#if UNITY_EDITOR
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct AnticipationCounterSyncPingMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
public ulong Counter;
|
||||
public double Time;
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
BytePacker.WriteValuePacked(writer, Counter);
|
||||
writer.WriteValueSafe(Time);
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (!networkManager.IsServer)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
ByteUnpacker.ReadValuePacked(reader, out Counter);
|
||||
reader.ReadValueSafe(out Time);
|
||||
return true;
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (networkManager.IsListening && !networkManager.ShutdownInProgress && networkManager.ConnectedClients.ContainsKey(context.SenderId))
|
||||
{
|
||||
var message = new AnticipationCounterSyncPongMessage { Counter = Counter, Time = Time };
|
||||
networkManager.MessageManager.SendMessage(ref message, NetworkDelivery.Reliable, context.SenderId);
|
||||
}
|
||||
}
|
||||
}
|
||||
internal struct AnticipationCounterSyncPongMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
public ulong Counter;
|
||||
public double Time;
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
BytePacker.WriteValuePacked(writer, Counter);
|
||||
writer.WriteValueSafe(Time);
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (!networkManager.IsClient)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
ByteUnpacker.ReadValuePacked(reader, out Counter);
|
||||
reader.ReadValueSafe(out Time);
|
||||
return true;
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
networkManager.AnticipationSystem.LastAnticipationAck = Counter;
|
||||
networkManager.AnticipationSystem.LastAnticipationAckTime = Time;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,2 @@
|
||||
fileFormatVersion: 2
|
||||
guid: b7d5c92979ad7e646a078aaf058b53a9
|
||||
@@ -1,16 +1,154 @@
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct ChangeOwnershipMessage : INetworkMessage, INetworkSerializeByMemcpy
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
private const string k_Name = "ChangeOwnershipMessage";
|
||||
|
||||
public ulong NetworkObjectId;
|
||||
public ulong OwnerClientId;
|
||||
// DANGOEXP TODO: Remove these notes or change their format
|
||||
// SERVICE NOTES:
|
||||
// When forwarding the message to clients on the CMB Service side,
|
||||
// you can set the ClientIdCount to 0 and skip writing the ClientIds.
|
||||
// See the NetworkObjet.OwnershipRequest for more potential service side additions
|
||||
|
||||
/// <summary>
|
||||
/// When requesting, RequestClientId is the requestor.
|
||||
/// When approving, RequestClientId is the owner that approved.
|
||||
/// When responding (only for denied), RequestClientId is the requestor
|
||||
/// </summary>
|
||||
internal ulong RequestClientId;
|
||||
internal int ClientIdCount;
|
||||
internal ulong[] ClientIds;
|
||||
internal bool DistributedAuthorityMode;
|
||||
internal ushort OwnershipFlags;
|
||||
internal byte OwnershipRequestResponseStatus;
|
||||
private byte m_OwnershipMessageTypeFlags;
|
||||
|
||||
private const byte k_OwnershipChanging = 0x01;
|
||||
private const byte k_OwnershipFlagsUpdate = 0x02;
|
||||
private const byte k_RequestOwnership = 0x04;
|
||||
private const byte k_RequestApproved = 0x08;
|
||||
private const byte k_RequestDenied = 0x10;
|
||||
|
||||
// If no flags are set, then ownership is changing
|
||||
internal bool OwnershipIsChanging
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetFlag(k_OwnershipChanging);
|
||||
}
|
||||
|
||||
set
|
||||
{
|
||||
SetFlag(value, k_OwnershipChanging);
|
||||
}
|
||||
}
|
||||
|
||||
internal bool OwnershipFlagsUpdate
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetFlag(k_OwnershipFlagsUpdate);
|
||||
}
|
||||
|
||||
set
|
||||
{
|
||||
SetFlag(value, k_OwnershipFlagsUpdate);
|
||||
}
|
||||
}
|
||||
|
||||
internal bool RequestOwnership
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetFlag(k_RequestOwnership);
|
||||
}
|
||||
|
||||
set
|
||||
{
|
||||
SetFlag(value, k_RequestOwnership);
|
||||
}
|
||||
}
|
||||
|
||||
internal bool RequestApproved
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetFlag(k_RequestApproved);
|
||||
}
|
||||
|
||||
set
|
||||
{
|
||||
SetFlag(value, k_RequestApproved);
|
||||
}
|
||||
}
|
||||
|
||||
internal bool RequestDenied
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetFlag(k_RequestDenied);
|
||||
}
|
||||
|
||||
set
|
||||
{
|
||||
SetFlag(value, k_RequestDenied);
|
||||
}
|
||||
}
|
||||
|
||||
private bool GetFlag(int flag)
|
||||
{
|
||||
return (m_OwnershipMessageTypeFlags & flag) != 0;
|
||||
}
|
||||
|
||||
private void SetFlag(bool set, byte flag)
|
||||
{
|
||||
if (set) { m_OwnershipMessageTypeFlags = (byte)(m_OwnershipMessageTypeFlags | flag); }
|
||||
else { m_OwnershipMessageTypeFlags = (byte)(m_OwnershipMessageTypeFlags & ~flag); }
|
||||
}
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
BytePacker.WriteValueBitPacked(writer, NetworkObjectId);
|
||||
BytePacker.WriteValueBitPacked(writer, OwnerClientId);
|
||||
if (DistributedAuthorityMode)
|
||||
{
|
||||
BytePacker.WriteValueBitPacked(writer, ClientIdCount);
|
||||
if (ClientIdCount > 0)
|
||||
{
|
||||
if (ClientIdCount != ClientIds.Length)
|
||||
{
|
||||
throw new System.Exception($"[{nameof(ChangeOwnershipMessage)}] ClientIdCount is {ClientIdCount} but the ClientIds length is {ClientIds.Length}!");
|
||||
}
|
||||
foreach (var clientId in ClientIds)
|
||||
{
|
||||
BytePacker.WriteValueBitPacked(writer, clientId);
|
||||
}
|
||||
}
|
||||
|
||||
writer.WriteValueSafe(m_OwnershipMessageTypeFlags);
|
||||
if (OwnershipFlagsUpdate || OwnershipIsChanging)
|
||||
{
|
||||
writer.WriteValueSafe(OwnershipFlags);
|
||||
}
|
||||
|
||||
// When requesting, it is the requestor
|
||||
// When approving, it is the owner that approved
|
||||
// When denied, it is the requestor
|
||||
if (RequestOwnership || RequestApproved || RequestDenied)
|
||||
{
|
||||
writer.WriteValueSafe(RequestClientId);
|
||||
|
||||
if (RequestDenied)
|
||||
{
|
||||
writer.WriteValueSafe(OwnershipRequestResponseStatus);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
@@ -22,46 +160,241 @@ namespace Unity.Netcode
|
||||
}
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out NetworkObjectId);
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out OwnerClientId);
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.ContainsKey(NetworkObjectId))
|
||||
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context);
|
||||
return false;
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out ClientIdCount);
|
||||
if (ClientIdCount > 0)
|
||||
{
|
||||
ClientIds = new ulong[ClientIdCount];
|
||||
var clientId = (ulong)0;
|
||||
for (int i = 0; i < ClientIdCount; i++)
|
||||
{
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out clientId);
|
||||
ClientIds[i] = clientId;
|
||||
}
|
||||
}
|
||||
|
||||
reader.ReadValueSafe(out m_OwnershipMessageTypeFlags);
|
||||
if (OwnershipFlagsUpdate || OwnershipIsChanging)
|
||||
{
|
||||
reader.ReadValueSafe(out OwnershipFlags);
|
||||
}
|
||||
|
||||
// When requesting, it is the requestor
|
||||
// When approving, it is the owner that approved
|
||||
// When denied, it is the requestor
|
||||
if (RequestOwnership || RequestApproved || RequestDenied)
|
||||
{
|
||||
reader.ReadValueSafe(out RequestClientId);
|
||||
|
||||
if (RequestDenied)
|
||||
{
|
||||
reader.ReadValueSafe(out OwnershipRequestResponseStatus);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If we are not a DAHost instance and the NetworkObject does not exist then defer it as it very likely is not spawned yet.
|
||||
// Otherwise if we are the DAHost and it does not exist then we want to forward this message because when the NetworkObject
|
||||
// is made visible again, the ownership flags and owner information will be synchronized with the DAHost by the current
|
||||
// authority of the NetworkObject in question.
|
||||
if (!networkManager.DAHost && !networkManager.SpawnManager.SpawnedObjects.ContainsKey(NetworkObjectId))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context, k_Name);
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
var networkObject = networkManager.SpawnManager.SpawnedObjects[NetworkObjectId];
|
||||
var originalOwner = networkObject.OwnerClientId;
|
||||
|
||||
// If we are the DAHost then forward this message
|
||||
if (networkManager.DAHost)
|
||||
{
|
||||
var clientList = ClientIdCount > 0 ? ClientIds : networkManager.ConnectedClientsIds;
|
||||
|
||||
var message = new ChangeOwnershipMessage()
|
||||
{
|
||||
NetworkObjectId = NetworkObjectId,
|
||||
OwnerClientId = OwnerClientId,
|
||||
DistributedAuthorityMode = true,
|
||||
OwnershipFlags = OwnershipFlags,
|
||||
RequestClientId = RequestClientId,
|
||||
ClientIdCount = 0,
|
||||
m_OwnershipMessageTypeFlags = m_OwnershipMessageTypeFlags,
|
||||
};
|
||||
|
||||
if (RequestDenied)
|
||||
{
|
||||
// If the local DAHost's client is not the target, then forward to the target
|
||||
if (RequestClientId != networkManager.LocalClientId)
|
||||
{
|
||||
message.OwnershipRequestResponseStatus = OwnershipRequestResponseStatus;
|
||||
networkManager.ConnectionManager.SendMessage(ref message, NetworkDelivery.Reliable, RequestClientId);
|
||||
// We don't want the local DAHost's client to process this message, so exit early
|
||||
return;
|
||||
}
|
||||
}
|
||||
else if (RequestOwnership)
|
||||
{
|
||||
// If the DAHost client is not authority, just forward the message to the authority
|
||||
if (OwnerClientId != networkManager.LocalClientId)
|
||||
{
|
||||
networkManager.ConnectionManager.SendMessage(ref message, NetworkDelivery.Reliable, OwnerClientId);
|
||||
// We don't want the local DAHost's client to process this message, so exit early
|
||||
return;
|
||||
}
|
||||
// Otherwise, fall through and process the request.
|
||||
}
|
||||
else
|
||||
{
|
||||
foreach (var clientId in clientList)
|
||||
{
|
||||
if (clientId == networkManager.LocalClientId)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
// If ownership is changing and this is not an ownership request approval then ignore the OnwerClientId
|
||||
// If it is just updating flags then ignore sending to the owner
|
||||
// If it is a request or approving request, then ignore the RequestClientId
|
||||
if ((OwnershipIsChanging && !RequestApproved && OwnerClientId == clientId) || (OwnershipFlagsUpdate && clientId == OwnerClientId)
|
||||
|| ((RequestOwnership || RequestApproved) && clientId == RequestClientId))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
networkManager.ConnectionManager.SendMessage(ref message, NetworkDelivery.Reliable, clientId);
|
||||
}
|
||||
}
|
||||
// If the NetworkObject is not visible to the DAHost client, then exit early
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.ContainsKey(NetworkObjectId))
|
||||
{
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If ownership is changing, then run through the ownershipd changed sequence
|
||||
// Note: There is some extended ownership script at the bottom of HandleOwnershipChange
|
||||
// If not in distributed authority mode, then always go straight to HandleOwnershipChange
|
||||
if (OwnershipIsChanging || !networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
HandleOwnershipChange(ref context);
|
||||
}
|
||||
else if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
// Otherwise, we handle and extended ownership update
|
||||
HandleExtendedOwnershipUpdate(ref context);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Handle the
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
private void HandleExtendedOwnershipUpdate(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
|
||||
// Handle the extended ownership message types
|
||||
var networkObject = networkManager.SpawnManager.SpawnedObjects[NetworkObjectId];
|
||||
|
||||
if (OwnershipFlagsUpdate)
|
||||
{
|
||||
// Just update the ownership flags
|
||||
networkObject.Ownership = (NetworkObject.OwnershipStatus)OwnershipFlags;
|
||||
}
|
||||
else if (RequestOwnership)
|
||||
{
|
||||
// Requesting ownership, if allowed it will automatically send the ownership change message
|
||||
networkObject.OwnershipRequest(RequestClientId);
|
||||
}
|
||||
else if (RequestDenied)
|
||||
{
|
||||
networkObject.OwnershipRequestResponse((NetworkObject.OwnershipRequestResponseStatus)OwnershipRequestResponseStatus);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Handle the traditional change in ownership message type logic
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
private void HandleOwnershipChange(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
var networkObject = networkManager.SpawnManager.SpawnedObjects[NetworkObjectId];
|
||||
|
||||
// DANGO-TODO: This probably shouldn't be allowed to happen.
|
||||
if (networkObject.OwnerClientId == OwnerClientId)
|
||||
{
|
||||
UnityEngine.Debug.LogWarning($"Unnecessary ownership changed message for {NetworkObjectId}");
|
||||
}
|
||||
|
||||
var originalOwner = networkObject.OwnerClientId;
|
||||
networkObject.OwnerClientId = OwnerClientId;
|
||||
|
||||
// We are current owner.
|
||||
if (originalOwner == networkManager.LocalClientId)
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
networkObject.Ownership = (NetworkObject.OwnershipStatus)OwnershipFlags;
|
||||
}
|
||||
|
||||
// We are current owner (client-server) or running in distributed authority mode
|
||||
if (originalOwner == networkManager.LocalClientId || networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
networkObject.InvokeBehaviourOnLostOwnership();
|
||||
}
|
||||
|
||||
// We are new owner.
|
||||
if (OwnerClientId == networkManager.LocalClientId)
|
||||
// We are new owner or (client-server) or running in distributed authority mode
|
||||
if (OwnerClientId == networkManager.LocalClientId || networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
networkObject.InvokeBehaviourOnGainedOwnership();
|
||||
}
|
||||
|
||||
// For all other clients that are neither the former or current owner, update the behaviours' properties
|
||||
if (OwnerClientId != networkManager.LocalClientId && originalOwner != networkManager.LocalClientId)
|
||||
// If in distributed authority mode
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
// Always update the network properties in distributed authority mode
|
||||
for (int i = 0; i < networkObject.ChildNetworkBehaviours.Count; i++)
|
||||
{
|
||||
networkObject.ChildNetworkBehaviours[i].UpdateNetworkProperties();
|
||||
}
|
||||
}
|
||||
else // Otherwise update properties like we would in client-server
|
||||
{
|
||||
// For all other clients that are neither the former or current owner, update the behaviours' properties
|
||||
if (OwnerClientId != networkManager.LocalClientId && originalOwner != networkManager.LocalClientId)
|
||||
{
|
||||
for (int i = 0; i < networkObject.ChildNetworkBehaviours.Count; i++)
|
||||
{
|
||||
networkObject.ChildNetworkBehaviours[i].UpdateNetworkProperties();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Always invoke ownership change notifications
|
||||
networkObject.InvokeOwnershipChanged(originalOwner, OwnerClientId);
|
||||
|
||||
// If this change was requested, then notify that the request was approved (doing this last so all ownership
|
||||
// changes have already been applied if the callback is invoked)
|
||||
if (networkManager.DistributedAuthorityMode && networkManager.LocalClientId == OwnerClientId)
|
||||
{
|
||||
if (RequestApproved)
|
||||
{
|
||||
networkObject.OwnershipRequestResponse(NetworkObject.OwnershipRequestResponseStatus.Approved);
|
||||
}
|
||||
|
||||
// If the NetworkObject changed ownership and the Requested flag was set (i.e. it was an ownership request),
|
||||
// then the new owner granted ownership removes the Requested flag and sends out an ownership status update.
|
||||
if (networkObject.HasExtendedOwnershipStatus(NetworkObject.OwnershipStatusExtended.Requested))
|
||||
{
|
||||
networkObject.RemoveOwnershipExtended(NetworkObject.OwnershipStatusExtended.Requested);
|
||||
networkObject.SendOwnershipStatusUpdate();
|
||||
}
|
||||
}
|
||||
|
||||
networkManager.NetworkMetrics.TrackOwnershipChangeReceived(context.SenderId, networkObject, context.MessageSize);
|
||||
}
|
||||
}
|
||||
|
||||
66
Runtime/Messaging/Messages/ClientConnectedMessage.cs
Normal file
66
Runtime/Messaging/Messages/ClientConnectedMessage.cs
Normal file
@@ -0,0 +1,66 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct ClientConnectedMessage : INetworkMessage, INetworkSerializeByMemcpy
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
public ulong ClientId;
|
||||
|
||||
public bool ShouldSynchronize;
|
||||
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
BytePacker.WriteValueBitPacked(writer, ClientId);
|
||||
writer.WriteValueSafe(ShouldSynchronize);
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (!networkManager.IsClient)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out ClientId);
|
||||
reader.ReadValueSafe(out ShouldSynchronize);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (ShouldSynchronize && networkManager.NetworkConfig.EnableSceneManagement && networkManager.DistributedAuthorityMode && networkManager.LocalClient.IsSessionOwner)
|
||||
{
|
||||
networkManager.SceneManager.SynchronizeNetworkObjects(ClientId);
|
||||
}
|
||||
else
|
||||
{
|
||||
// All modes support adding NetworkClients
|
||||
networkManager.ConnectionManager.AddClient(ClientId);
|
||||
}
|
||||
if (!networkManager.ConnectionManager.ConnectedClientIds.Contains(ClientId))
|
||||
{
|
||||
networkManager.ConnectionManager.ConnectedClientIds.Add(ClientId);
|
||||
}
|
||||
if (networkManager.IsConnectedClient)
|
||||
{
|
||||
networkManager.ConnectionManager.InvokeOnPeerConnectedCallback(ClientId);
|
||||
}
|
||||
|
||||
// DANGO-TODO: Remove the session owner object distribution check once the service handles object distribution
|
||||
if (networkManager.DistributedAuthorityMode && networkManager.CMBServiceConnection && !networkManager.NetworkConfig.EnableSceneManagement)
|
||||
{
|
||||
// Don't redistribute for the local instance
|
||||
if (ClientId != networkManager.LocalClientId)
|
||||
{
|
||||
// We defer redistribution to the end of the NetworkUpdateStage.PostLateUpdate
|
||||
networkManager.RedistributeToClient = true;
|
||||
networkManager.ClientToRedistribute = ClientId;
|
||||
networkManager.TickToRedistribute = networkManager.ServerTime.Tick + 20;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 158454105806474cba54a4ea5a0bfb12
|
||||
timeCreated: 1697836112
|
||||
37
Runtime/Messaging/Messages/ClientDisconnectedMessage.cs
Normal file
37
Runtime/Messaging/Messages/ClientDisconnectedMessage.cs
Normal file
@@ -0,0 +1,37 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct ClientDisconnectedMessage : INetworkMessage, INetworkSerializeByMemcpy
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
public ulong ClientId;
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
BytePacker.WriteValueBitPacked(writer, ClientId);
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (!networkManager.IsClient)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out ClientId);
|
||||
return true;
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
// All modes support removing NetworkClients
|
||||
networkManager.ConnectionManager.RemoveClient(ClientId);
|
||||
networkManager.ConnectionManager.ConnectedClientIds.Remove(ClientId);
|
||||
if (networkManager.IsConnectedClient)
|
||||
{
|
||||
networkManager.ConnectionManager.InvokeOnPeerDisconnectedCallback(ClientId);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 8f91296c8e5f40b1a2a03d74a31526b6
|
||||
timeCreated: 1697836161
|
||||
@@ -5,10 +5,16 @@ namespace Unity.Netcode
|
||||
{
|
||||
internal struct ConnectionApprovedMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
private const int k_VersionAddClientIds = 1;
|
||||
public int Version => k_VersionAddClientIds;
|
||||
|
||||
public ulong OwnerClientId;
|
||||
public int NetworkTick;
|
||||
// The cloud state service should set this if we are restoring a session
|
||||
public bool IsRestoredSession;
|
||||
public ulong CurrentSessionOwner;
|
||||
// Not serialized
|
||||
public bool IsDistributedAuthority;
|
||||
|
||||
// Not serialized, held as references to serialize NetworkVariable data
|
||||
public HashSet<NetworkObject> SpawnedObjectsList;
|
||||
@@ -17,6 +23,8 @@ namespace Unity.Netcode
|
||||
|
||||
public NativeArray<MessageVersionData> MessageVersions;
|
||||
|
||||
public NativeArray<ulong> ConnectedClientIds;
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
// ============================================================
|
||||
@@ -35,6 +43,16 @@ namespace Unity.Netcode
|
||||
|
||||
BytePacker.WriteValueBitPacked(writer, OwnerClientId);
|
||||
BytePacker.WriteValueBitPacked(writer, NetworkTick);
|
||||
if (IsDistributedAuthority)
|
||||
{
|
||||
writer.WriteValueSafe(IsRestoredSession);
|
||||
BytePacker.WriteValueBitPacked(writer, CurrentSessionOwner);
|
||||
}
|
||||
|
||||
if (targetVersion >= k_VersionAddClientIds)
|
||||
{
|
||||
writer.WriteValueSafe(ConnectedClientIds);
|
||||
}
|
||||
|
||||
uint sceneObjectCount = 0;
|
||||
|
||||
@@ -51,7 +69,8 @@ namespace Unity.Netcode
|
||||
if (sobj.SpawnWithObservers && (sobj.CheckObjectVisibility == null || sobj.CheckObjectVisibility(OwnerClientId)))
|
||||
{
|
||||
sobj.Observers.Add(OwnerClientId);
|
||||
var sceneObject = sobj.GetMessageSceneObject(OwnerClientId);
|
||||
// In distributed authority mode, we send the currently known observers of each NetworkObject to the client being synchronized.
|
||||
var sceneObject = sobj.GetMessageSceneObject(OwnerClientId, IsDistributedAuthority);
|
||||
sceneObject.Serialize(writer);
|
||||
++sceneObjectCount;
|
||||
}
|
||||
@@ -106,6 +125,21 @@ namespace Unity.Netcode
|
||||
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out OwnerClientId);
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out NetworkTick);
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
reader.ReadValueSafe(out IsRestoredSession);
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out CurrentSessionOwner);
|
||||
}
|
||||
|
||||
if (receivedMessageVersion >= k_VersionAddClientIds)
|
||||
{
|
||||
reader.ReadValueSafe(out ConnectedClientIds, Allocator.TempJob);
|
||||
}
|
||||
else
|
||||
{
|
||||
ConnectedClientIds = new NativeArray<ulong>(0, Allocator.TempJob);
|
||||
}
|
||||
|
||||
m_ReceivedSceneObjectData = reader;
|
||||
return true;
|
||||
}
|
||||
@@ -113,9 +147,23 @@ namespace Unity.Netcode
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
|
||||
{
|
||||
NetworkLog.LogInfo($"[Client-{OwnerClientId}] Connection approved! Synchronizing...");
|
||||
}
|
||||
networkManager.LocalClientId = OwnerClientId;
|
||||
networkManager.MessageManager.SetLocalClientId(networkManager.LocalClientId);
|
||||
networkManager.NetworkMetrics.SetConnectionId(networkManager.LocalClientId);
|
||||
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
networkManager.SetSessionOwner(CurrentSessionOwner);
|
||||
if (networkManager.LocalClient.IsSessionOwner && networkManager.NetworkConfig.EnableSceneManagement)
|
||||
{
|
||||
networkManager.SceneManager.InitializeScenesLoaded();
|
||||
}
|
||||
}
|
||||
|
||||
var time = new NetworkTime(networkManager.NetworkTickSystem.TickRate, NetworkTick);
|
||||
networkManager.NetworkTimeSystem.Reset(time.Time, 0.15f); // Start with a constant RTT of 150 until we receive values from the transport.
|
||||
networkManager.NetworkTickSystem.Reset(networkManager.NetworkTimeSystem.LocalTime, networkManager.NetworkTimeSystem.ServerTime);
|
||||
@@ -126,10 +174,29 @@ namespace Unity.Netcode
|
||||
// Stop the client-side approval timeout coroutine since we are approved.
|
||||
networkManager.ConnectionManager.StopClientApprovalCoroutine();
|
||||
|
||||
networkManager.ConnectionManager.ConnectedClientIds.Clear();
|
||||
foreach (var clientId in ConnectedClientIds)
|
||||
{
|
||||
if (!networkManager.ConnectionManager.ConnectedClientIds.Contains(clientId))
|
||||
{
|
||||
networkManager.ConnectionManager.AddClient(clientId);
|
||||
}
|
||||
}
|
||||
|
||||
// Only if scene management is disabled do we handle NetworkObject synchronization at this point
|
||||
if (!networkManager.NetworkConfig.EnableSceneManagement)
|
||||
{
|
||||
networkManager.SpawnManager.DestroySceneObjects();
|
||||
// DANGO-TODO: This is a temporary fix for no DA CMB scene event handling.
|
||||
// We will either use this same concept or provide some way for the CMB state plugin to handle it.
|
||||
if (networkManager.DistributedAuthorityMode && networkManager.LocalClient.IsSessionOwner)
|
||||
{
|
||||
networkManager.SpawnManager.ServerSpawnSceneObjectsOnStartSweep();
|
||||
}
|
||||
else
|
||||
{
|
||||
networkManager.SpawnManager.DestroySceneObjects();
|
||||
}
|
||||
|
||||
m_ReceivedSceneObjectData.ReadValueSafe(out uint sceneObjectCount);
|
||||
|
||||
// Deserializing NetworkVariable data is deferred from Receive() to Handle to avoid needing
|
||||
@@ -143,9 +210,59 @@ namespace Unity.Netcode
|
||||
|
||||
// Mark the client being connected
|
||||
networkManager.IsConnectedClient = true;
|
||||
|
||||
if (networkManager.AutoSpawnPlayerPrefabClientSide)
|
||||
{
|
||||
networkManager.ConnectionManager.CreateAndSpawnPlayer(OwnerClientId);
|
||||
}
|
||||
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
|
||||
{
|
||||
NetworkLog.LogInfo($"[Client-{OwnerClientId}][Scene Management Disabled] Synchronization complete!");
|
||||
}
|
||||
// When scene management is disabled we notify after everything is synchronized
|
||||
networkManager.ConnectionManager.InvokeOnClientConnectedCallback(context.SenderId);
|
||||
|
||||
// For convenience, notify all NetworkBehaviours that synchronization is complete.
|
||||
networkManager.SpawnManager.NotifyNetworkObjectsSynchronized();
|
||||
}
|
||||
else
|
||||
{
|
||||
if (networkManager.DistributedAuthorityMode && networkManager.CMBServiceConnection && networkManager.LocalClient.IsSessionOwner && networkManager.NetworkConfig.EnableSceneManagement)
|
||||
{
|
||||
// Mark the client being connected
|
||||
networkManager.IsConnectedClient = true;
|
||||
|
||||
networkManager.SceneManager.IsRestoringSession = IsRestoredSession;
|
||||
|
||||
if (!IsRestoredSession)
|
||||
{
|
||||
// Synchronize the service with the initial session owner's loaded scenes and spawned objects
|
||||
networkManager.SceneManager.SynchronizeNetworkObjects(NetworkManager.ServerClientId);
|
||||
|
||||
// Spawn any in-scene placed NetworkObjects
|
||||
networkManager.SpawnManager.ServerSpawnSceneObjectsOnStartSweep();
|
||||
|
||||
// Spawn the local player of the session owner
|
||||
if (networkManager.AutoSpawnPlayerPrefabClientSide)
|
||||
{
|
||||
networkManager.ConnectionManager.CreateAndSpawnPlayer(OwnerClientId);
|
||||
}
|
||||
|
||||
// Synchronize the service with the initial session owner's loaded scenes and spawned objects
|
||||
networkManager.SceneManager.SynchronizeNetworkObjects(NetworkManager.ServerClientId);
|
||||
|
||||
// With scene management enabled and since the session owner doesn't send a Synchronize scene event synchronize itself,
|
||||
// we need to notify the session owner that everything should be synchronized/spawned at this time.
|
||||
networkManager.SpawnManager.NotifyNetworkObjectsSynchronized();
|
||||
|
||||
// When scene management is enabled and since the session owner is synchronizing the service (i.e. acting like host),
|
||||
// we need to locallyh invoke the OnClientConnected callback at this point in time.
|
||||
networkManager.ConnectionManager.InvokeOnClientConnectedCallback(OwnerClientId);
|
||||
}
|
||||
}
|
||||
}
|
||||
ConnectedClientIds.Dispose();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,6 +8,10 @@ namespace Unity.Netcode
|
||||
|
||||
public ulong ConfigHash;
|
||||
|
||||
public bool CMBServiceConnection;
|
||||
public uint TickRate;
|
||||
public bool EnableSceneManagement;
|
||||
|
||||
public byte[] ConnectionData;
|
||||
|
||||
public bool ShouldSendConnectionData;
|
||||
@@ -30,6 +34,12 @@ namespace Unity.Netcode
|
||||
// END FORBIDDEN SEGMENT
|
||||
// ============================================================
|
||||
|
||||
if (CMBServiceConnection)
|
||||
{
|
||||
writer.WriteValueSafe(TickRate);
|
||||
writer.WriteValueSafe(EnableSceneManagement);
|
||||
}
|
||||
|
||||
if (ShouldSendConnectionData)
|
||||
{
|
||||
writer.WriteValueSafe(ConfigHash);
|
||||
@@ -151,7 +161,7 @@ namespace Unity.Netcode
|
||||
var response = new NetworkManager.ConnectionApprovalResponse
|
||||
{
|
||||
Approved = true,
|
||||
CreatePlayerObject = networkManager.NetworkConfig.PlayerPrefab != null
|
||||
CreatePlayerObject = networkManager.DistributedAuthorityMode && networkManager.AutoSpawnPlayerPrefabClientSide ? false : networkManager.NetworkConfig.PlayerPrefab != null
|
||||
};
|
||||
networkManager.ConnectionManager.HandleConnectionApproval(senderId, response);
|
||||
}
|
||||
|
||||
@@ -1,15 +1,120 @@
|
||||
using System.Linq;
|
||||
using System.Runtime.CompilerServices;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct CreateObjectMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
private const string k_Name = "CreateObjectMessage";
|
||||
|
||||
public NetworkObject.SceneObject ObjectInfo;
|
||||
private FastBufferReader m_ReceivedNetworkVariableData;
|
||||
|
||||
// DA - NGO CMB SERVICE NOTES:
|
||||
// The ObserverIds and ExistingObserverIds will only be populated if k_UpdateObservers is set
|
||||
// ObserverIds is the full list of observers (see below)
|
||||
internal ulong[] ObserverIds;
|
||||
|
||||
// While this does consume a bit more bandwidth, this is only sent by the authority/owner
|
||||
// and can be used to determine which clients should receive the ObjectInfo serialized data.
|
||||
// All other already existing observers just need to receive the NewObserverIds and the
|
||||
// NetworkObjectId
|
||||
internal ulong[] NewObserverIds;
|
||||
|
||||
// If !IncludesSerializedObject then the NetworkObjectId will be serialized.
|
||||
// This happens when we are just sending an update to the observers list
|
||||
// to clients that already have the NetworkObject spawned
|
||||
internal ulong NetworkObjectId;
|
||||
|
||||
private const byte k_IncludesSerializedObject = 0x01;
|
||||
private const byte k_UpdateObservers = 0x02;
|
||||
private const byte k_UpdateNewObservers = 0x04;
|
||||
|
||||
|
||||
private byte m_CreateObjectMessageTypeFlags;
|
||||
|
||||
internal bool IncludesSerializedObject
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetFlag(k_IncludesSerializedObject);
|
||||
}
|
||||
|
||||
set
|
||||
{
|
||||
SetFlag(value, k_IncludesSerializedObject);
|
||||
}
|
||||
}
|
||||
|
||||
internal bool UpdateObservers
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetFlag(k_UpdateObservers);
|
||||
}
|
||||
|
||||
set
|
||||
{
|
||||
SetFlag(value, k_UpdateObservers);
|
||||
}
|
||||
}
|
||||
|
||||
internal bool UpdateNewObservers
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetFlag(k_UpdateNewObservers);
|
||||
}
|
||||
|
||||
set
|
||||
{
|
||||
SetFlag(value, k_UpdateNewObservers);
|
||||
}
|
||||
}
|
||||
|
||||
private bool GetFlag(int flag)
|
||||
{
|
||||
return (m_CreateObjectMessageTypeFlags & flag) != 0;
|
||||
}
|
||||
|
||||
private void SetFlag(bool set, byte flag)
|
||||
{
|
||||
if (set) { m_CreateObjectMessageTypeFlags = (byte)(m_CreateObjectMessageTypeFlags | flag); }
|
||||
else { m_CreateObjectMessageTypeFlags = (byte)(m_CreateObjectMessageTypeFlags & ~flag); }
|
||||
}
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
ObjectInfo.Serialize(writer);
|
||||
writer.WriteValueSafe(m_CreateObjectMessageTypeFlags);
|
||||
|
||||
if (UpdateObservers)
|
||||
{
|
||||
BytePacker.WriteValuePacked(writer, ObserverIds.Length);
|
||||
foreach (var clientId in ObserverIds)
|
||||
{
|
||||
BytePacker.WriteValuePacked(writer, clientId);
|
||||
}
|
||||
}
|
||||
|
||||
if (UpdateNewObservers)
|
||||
{
|
||||
BytePacker.WriteValuePacked(writer, NewObserverIds.Length);
|
||||
foreach (var clientId in NewObserverIds)
|
||||
{
|
||||
BytePacker.WriteValuePacked(writer, clientId);
|
||||
}
|
||||
}
|
||||
|
||||
if (IncludesSerializedObject)
|
||||
{
|
||||
ObjectInfo.Serialize(writer);
|
||||
}
|
||||
else
|
||||
{
|
||||
BytePacker.WriteValuePacked(writer, NetworkObjectId);
|
||||
}
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
@@ -20,10 +125,45 @@ namespace Unity.Netcode
|
||||
return false;
|
||||
}
|
||||
|
||||
ObjectInfo.Deserialize(reader);
|
||||
reader.ReadValueSafe(out m_CreateObjectMessageTypeFlags);
|
||||
if (UpdateObservers)
|
||||
{
|
||||
var length = 0;
|
||||
ByteUnpacker.ReadValuePacked(reader, out length);
|
||||
ObserverIds = new ulong[length];
|
||||
var clientId = (ulong)0;
|
||||
for (int i = 0; i < length; i++)
|
||||
{
|
||||
ByteUnpacker.ReadValuePacked(reader, out clientId);
|
||||
ObserverIds[i] = clientId;
|
||||
}
|
||||
}
|
||||
|
||||
if (UpdateNewObservers)
|
||||
{
|
||||
var length = 0;
|
||||
ByteUnpacker.ReadValuePacked(reader, out length);
|
||||
NewObserverIds = new ulong[length];
|
||||
var clientId = (ulong)0;
|
||||
for (int i = 0; i < length; i++)
|
||||
{
|
||||
ByteUnpacker.ReadValuePacked(reader, out clientId);
|
||||
NewObserverIds[i] = clientId;
|
||||
}
|
||||
}
|
||||
|
||||
if (IncludesSerializedObject)
|
||||
{
|
||||
ObjectInfo.Deserialize(reader);
|
||||
}
|
||||
else
|
||||
{
|
||||
ByteUnpacker.ReadValuePacked(reader, out NetworkObjectId);
|
||||
}
|
||||
|
||||
if (!networkManager.NetworkConfig.ForceSamePrefabs && !networkManager.SpawnManager.HasPrefab(ObjectInfo))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnAddPrefab, ObjectInfo.Hash, reader, ref context);
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnAddPrefab, ObjectInfo.Hash, reader, ref context, k_Name);
|
||||
return false;
|
||||
}
|
||||
m_ReceivedNetworkVariableData = reader;
|
||||
@@ -34,9 +174,138 @@ namespace Unity.Netcode
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
var networkObject = NetworkObject.AddSceneObject(ObjectInfo, m_ReceivedNetworkVariableData, networkManager);
|
||||
// If a client receives a create object message and it is still synchronizing, then defer the object creation until it has finished synchronizing
|
||||
if (networkManager.SceneManager.ShouldDeferCreateObject())
|
||||
{
|
||||
networkManager.SceneManager.DeferCreateObject(context.SenderId, context.MessageSize, ObjectInfo, m_ReceivedNetworkVariableData, ObserverIds, NewObserverIds);
|
||||
}
|
||||
else
|
||||
{
|
||||
if (networkManager.DistributedAuthorityMode && !IncludesSerializedObject && UpdateObservers)
|
||||
{
|
||||
ObjectInfo = new NetworkObject.SceneObject()
|
||||
{
|
||||
NetworkObjectId = NetworkObjectId,
|
||||
};
|
||||
}
|
||||
CreateObject(ref networkManager, context.SenderId, context.MessageSize, ObjectInfo, m_ReceivedNetworkVariableData, ObserverIds, NewObserverIds);
|
||||
}
|
||||
}
|
||||
|
||||
networkManager.NetworkMetrics.TrackObjectSpawnReceived(context.SenderId, networkObject, context.MessageSize);
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
internal static void CreateObject(ref NetworkManager networkManager, ref NetworkSceneManager.DeferredObjectCreation deferredObjectCreation)
|
||||
{
|
||||
var senderId = deferredObjectCreation.SenderId;
|
||||
var observerIds = deferredObjectCreation.ObserverIds;
|
||||
var newObserverIds = deferredObjectCreation.NewObserverIds;
|
||||
var messageSize = deferredObjectCreation.MessageSize;
|
||||
var sceneObject = deferredObjectCreation.SceneObject;
|
||||
var networkVariableData = deferredObjectCreation.FastBufferReader;
|
||||
CreateObject(ref networkManager, senderId, messageSize, sceneObject, networkVariableData, observerIds, newObserverIds);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
internal static void CreateObject(ref NetworkManager networkManager, ulong senderId, uint messageSize, NetworkObject.SceneObject sceneObject, FastBufferReader networkVariableData, ulong[] observerIds, ulong[] newObserverIds)
|
||||
{
|
||||
var networkObject = (NetworkObject)null;
|
||||
try
|
||||
{
|
||||
if (!networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
networkObject = NetworkObject.AddSceneObject(sceneObject, networkVariableData, networkManager);
|
||||
}
|
||||
else
|
||||
{
|
||||
var hasObserverIdList = observerIds != null && observerIds.Length > 0;
|
||||
var hasNewObserverIdList = newObserverIds != null && newObserverIds.Length > 0;
|
||||
// Depending upon visibility of the NetworkObject and the client in question, it could be that
|
||||
// this client already has visibility of this NetworkObject
|
||||
if (networkManager.SpawnManager.SpawnedObjects.ContainsKey(sceneObject.NetworkObjectId))
|
||||
{
|
||||
// If so, then just get the local instance
|
||||
networkObject = networkManager.SpawnManager.SpawnedObjects[sceneObject.NetworkObjectId];
|
||||
|
||||
// This should not happen, logging error just in case
|
||||
if (hasNewObserverIdList && newObserverIds.Contains(networkManager.LocalClientId))
|
||||
{
|
||||
NetworkLog.LogErrorServer($"[{nameof(CreateObjectMessage)}][Duplicate-Broadcast] Detected duplicated object creation for {sceneObject.NetworkObjectId}!");
|
||||
}
|
||||
else // Trap to make sure the owner is not receiving any messages it sent
|
||||
if (networkManager.CMBServiceConnection && networkManager.LocalClientId == networkObject.OwnerClientId)
|
||||
{
|
||||
NetworkLog.LogWarning($"[{nameof(CreateObjectMessage)}][Client-{networkManager.LocalClientId}][Duplicate-CreateObjectMessage][Client Is Owner] Detected duplicated object creation for {networkObject.name}-{sceneObject.NetworkObjectId}!");
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
networkObject = NetworkObject.AddSceneObject(sceneObject, networkVariableData, networkManager, true);
|
||||
}
|
||||
|
||||
// DA - NGO CMB SERVICE NOTES:
|
||||
// It is possible for two clients to connect at the exact same time which, due to client-side spawning, can cause each client
|
||||
// to miss their spawns. For now, all player NetworkObject spawns will always be visible to all known connected clients
|
||||
var clientList = hasObserverIdList && !networkObject.IsPlayerObject ? observerIds : networkManager.ConnectedClientsIds;
|
||||
|
||||
// Update the observers for this instance
|
||||
foreach (var clientId in clientList)
|
||||
{
|
||||
networkObject.Observers.Add(clientId);
|
||||
}
|
||||
|
||||
// Mock CMB Service and forward to all clients
|
||||
if (networkManager.DAHost)
|
||||
{
|
||||
// DA - NGO CMB SERVICE NOTES:
|
||||
// (*** See above notes fist ***)
|
||||
// If it is a player object freshly spawning and one or more clients all connect at the exact same time (i.e. received on effectively
|
||||
// the same frame), then we need to check the observers list to make sure all players are visible upon first spawning. At a later date,
|
||||
// for area of interest we will need to have some form of follow up "observer update" message to cull out players not within each
|
||||
// player's AOI.
|
||||
if (networkObject.IsPlayerObject && hasNewObserverIdList && clientList.Count != observerIds.Length)
|
||||
{
|
||||
// For same-frame newly spawned players that might not be aware of all other players, update the player's observer
|
||||
// list.
|
||||
observerIds = clientList.ToArray();
|
||||
}
|
||||
|
||||
var createObjectMessage = new CreateObjectMessage()
|
||||
{
|
||||
ObjectInfo = sceneObject,
|
||||
m_ReceivedNetworkVariableData = networkVariableData,
|
||||
ObserverIds = hasObserverIdList ? observerIds : null,
|
||||
NetworkObjectId = networkObject.NetworkObjectId,
|
||||
IncludesSerializedObject = true,
|
||||
};
|
||||
foreach (var clientId in clientList)
|
||||
{
|
||||
// DA - NGO CMB SERVICE NOTES:
|
||||
// If the authority did not specify the list of clients and the client is not an observer or we are the owner/originator
|
||||
// or we are the DAHost, then we skip sending the message.
|
||||
if ((!hasObserverIdList && (!networkObject.Observers.Contains(clientId)) ||
|
||||
clientId == networkObject.OwnerClientId || clientId == NetworkManager.ServerClientId))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
// DA - NGO CMB SERVICE NOTES:
|
||||
// If this included a list of new observers and the targeted clientId is one of the observers, then send the serialized data.
|
||||
// Otherwise, the targeted clientId has already has visibility (i.e. it is already spawned) and so just send the updated
|
||||
// observers list to that client's instance.
|
||||
createObjectMessage.IncludesSerializedObject = hasNewObserverIdList && newObserverIds.Contains(clientId);
|
||||
|
||||
networkManager.SpawnManager.SendSpawnCallForObject(clientId, networkObject);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (networkObject != null)
|
||||
{
|
||||
networkManager.NetworkMetrics.TrackObjectSpawnReceived(senderId, networkObject, messageSize);
|
||||
}
|
||||
}
|
||||
catch (System.Exception ex)
|
||||
{
|
||||
UnityEngine.Debug.LogException(ex);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,15 +1,62 @@
|
||||
using System.Linq;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct DestroyObjectMessage : INetworkMessage, INetworkSerializeByMemcpy
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
private const string k_Name = "DestroyObjectMessage";
|
||||
|
||||
public ulong NetworkObjectId;
|
||||
public bool DestroyGameObject;
|
||||
private byte m_DestroyFlags;
|
||||
|
||||
internal int DeferredDespawnTick;
|
||||
// Temporary until we make this a list
|
||||
internal ulong TargetClientId;
|
||||
|
||||
internal bool IsDistributedAuthority;
|
||||
|
||||
internal const byte ClientTargetedDestroy = 0x01;
|
||||
|
||||
internal bool IsTargetedDestroy
|
||||
{
|
||||
get
|
||||
{
|
||||
return GetFlag(ClientTargetedDestroy);
|
||||
}
|
||||
|
||||
set
|
||||
{
|
||||
SetFlag(value, ClientTargetedDestroy);
|
||||
}
|
||||
}
|
||||
|
||||
private bool GetFlag(int flag)
|
||||
{
|
||||
return (m_DestroyFlags & flag) != 0;
|
||||
}
|
||||
|
||||
private void SetFlag(bool set, byte flag)
|
||||
{
|
||||
if (set) { m_DestroyFlags = (byte)(m_DestroyFlags | flag); }
|
||||
else { m_DestroyFlags = (byte)(m_DestroyFlags & ~flag); }
|
||||
}
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
BytePacker.WriteValueBitPacked(writer, NetworkObjectId);
|
||||
if (IsDistributedAuthority)
|
||||
{
|
||||
writer.WriteByteSafe(m_DestroyFlags);
|
||||
|
||||
if (IsTargetedDestroy)
|
||||
{
|
||||
BytePacker.WriteValueBitPacked(writer, TargetClientId);
|
||||
}
|
||||
BytePacker.WriteValueBitPacked(writer, DeferredDespawnTick);
|
||||
}
|
||||
writer.WriteValueSafe(DestroyGameObject);
|
||||
}
|
||||
|
||||
@@ -22,12 +69,25 @@ namespace Unity.Netcode
|
||||
}
|
||||
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out NetworkObjectId);
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
reader.ReadByteSafe(out m_DestroyFlags);
|
||||
if (IsTargetedDestroy)
|
||||
{
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out TargetClientId);
|
||||
}
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out DeferredDespawnTick);
|
||||
}
|
||||
|
||||
reader.ReadValueSafe(out DestroyGameObject);
|
||||
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.TryGetValue(NetworkObjectId, out var networkObject))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context);
|
||||
return false;
|
||||
// Client-Server mode we always defer where in distributed authority mode we only defer if it is not a targeted destroy
|
||||
if (!networkManager.DistributedAuthorityMode || (networkManager.DistributedAuthorityMode && !IsTargetedDestroy))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context, k_Name);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
@@ -35,14 +95,80 @@ namespace Unity.Netcode
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.TryGetValue(NetworkObjectId, out var networkObject))
|
||||
|
||||
var networkObject = (NetworkObject)null;
|
||||
if (!networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
// This is the same check and log message that happens inside OnDespawnObject, but we have to do it here
|
||||
return;
|
||||
// If this NetworkObject does not exist on this instance then exit early
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.TryGetValue(NetworkObjectId, out networkObject))
|
||||
{
|
||||
return;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
networkManager.SpawnManager.SpawnedObjects.TryGetValue(NetworkObjectId, out networkObject);
|
||||
if (!networkManager.DAHost && networkObject == null)
|
||||
{
|
||||
// If this NetworkObject does not exist on this instance then exit early
|
||||
return;
|
||||
}
|
||||
}
|
||||
// DANGO-TODO: This is just a quick way to foward despawn messages to the remaining clients
|
||||
if (networkManager.DistributedAuthorityMode && networkManager.DAHost)
|
||||
{
|
||||
var message = new DestroyObjectMessage
|
||||
{
|
||||
NetworkObjectId = NetworkObjectId,
|
||||
DestroyGameObject = DestroyGameObject,
|
||||
IsDistributedAuthority = true,
|
||||
IsTargetedDestroy = IsTargetedDestroy,
|
||||
TargetClientId = TargetClientId, // Just always populate this value whether we write it or not
|
||||
DeferredDespawnTick = DeferredDespawnTick,
|
||||
};
|
||||
var ownerClientId = networkObject == null ? context.SenderId : networkObject.OwnerClientId;
|
||||
var clientIds = networkObject == null ? networkManager.ConnectedClientsIds.ToList() : networkObject.Observers.ToList();
|
||||
|
||||
foreach (var clientId in clientIds)
|
||||
{
|
||||
if (clientId == networkManager.LocalClientId || clientId == ownerClientId)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
networkManager.ConnectionManager.SendMessage(ref message, NetworkDelivery.ReliableSequenced, clientId);
|
||||
}
|
||||
}
|
||||
|
||||
networkManager.NetworkMetrics.TrackObjectDestroyReceived(context.SenderId, networkObject, context.MessageSize);
|
||||
networkManager.SpawnManager.OnDespawnObject(networkObject, DestroyGameObject);
|
||||
// If we are deferring the despawn, then add it to the deferred despawn queue
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
if (DeferredDespawnTick > 0)
|
||||
{
|
||||
// Clients always add it to the queue while DAHost will only add it to the queue if it is not a targeted destroy or it is and the target is the
|
||||
// DAHost client.
|
||||
if (!networkManager.DAHost || (networkManager.DAHost && (!IsTargetedDestroy || (IsTargetedDestroy && TargetClientId == 0))))
|
||||
{
|
||||
networkObject.DeferredDespawnTick = DeferredDespawnTick;
|
||||
var hasCallback = networkObject.OnDeferredDespawnComplete != null;
|
||||
networkManager.SpawnManager.DeferDespawnNetworkObject(NetworkObjectId, DeferredDespawnTick, hasCallback);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If this is targeted and we are not the target, then just update our local observers for this object
|
||||
if (IsTargetedDestroy && TargetClientId != networkManager.LocalClientId && networkObject != null)
|
||||
{
|
||||
networkObject.Observers.Remove(TargetClientId);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if (networkObject != null)
|
||||
{
|
||||
// Otherwise just despawn the NetworkObject right now
|
||||
networkManager.SpawnManager.OnDespawnObject(networkObject, DestroyGameObject);
|
||||
networkManager.NetworkMetrics.TrackObjectDestroyReceived(context.SenderId, networkObject, context.MessageSize);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -25,9 +25,9 @@ namespace Unity.Netcode
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (!networkManager.ShutdownInProgress)
|
||||
if (!networkManager.ShutdownInProgress && networkManager.CustomMessagingManager != null)
|
||||
{
|
||||
((NetworkManager)context.SystemOwner).CustomMessagingManager.InvokeNamedMessage(Hash, context.SenderId, m_ReceiveData, context.SerializedHeaderSize);
|
||||
networkManager.CustomMessagingManager.InvokeNamedMessage(Hash, context.SenderId, m_ReceiveData, context.SerializedHeaderSize);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
193
Runtime/Messaging/Messages/NetworkTransformMessage.cs
Normal file
193
Runtime/Messaging/Messages/NetworkTransformMessage.cs
Normal file
@@ -0,0 +1,193 @@
|
||||
using Unity.Netcode.Components;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// NetworkTransform State Update Message
|
||||
/// </summary>
|
||||
internal struct NetworkTransformMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
private const string k_Name = "NetworkTransformMessage";
|
||||
|
||||
internal NetworkTransform NetworkTransform;
|
||||
|
||||
// Only used for DAHost
|
||||
internal NetworkTransform.NetworkTransformState State;
|
||||
private FastBufferReader m_CurrentReader;
|
||||
|
||||
internal int BytesWritten;
|
||||
|
||||
private unsafe void CopyPayload(ref FastBufferWriter writer)
|
||||
{
|
||||
writer.WriteBytesSafe(m_CurrentReader.GetUnsafePtrAtCurrentPosition(), m_CurrentReader.Length - m_CurrentReader.Position);
|
||||
}
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
if (m_CurrentReader.IsInitialized)
|
||||
{
|
||||
CopyPayload(ref writer);
|
||||
}
|
||||
else
|
||||
{
|
||||
BytesWritten = NetworkTransform.SerializeMessage(writer, targetVersion);
|
||||
}
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
var networkManager = context.SystemOwner as NetworkManager;
|
||||
if (networkManager == null)
|
||||
{
|
||||
Debug.LogError($"[{nameof(NetworkTransformMessage)}] System owner context was not of type {nameof(NetworkManager)}!");
|
||||
return false;
|
||||
}
|
||||
var currentPosition = reader.Position;
|
||||
var networkObjectId = (ulong)0;
|
||||
var networkBehaviourId = 0;
|
||||
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out networkObjectId);
|
||||
var isSpawnedLocally = networkManager.SpawnManager.SpawnedObjects.ContainsKey(networkObjectId);
|
||||
|
||||
// Only defer if the NetworkObject is not spawned yet and the local NetworkManager is not running as a DAHost.
|
||||
if (!isSpawnedLocally && !networkManager.DAHost)
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, networkObjectId, reader, ref context, k_Name);
|
||||
return false;
|
||||
}
|
||||
|
||||
// While the below check and assignment might seem out of place, this is specific to running in DAHost mode when a NetworkObject is
|
||||
// hidden from the DAHost but is visible to other clients. Since the DAHost needs to forward updates to the clients, we ignore processing
|
||||
// this message locally
|
||||
var networkObject = (NetworkObject)null;
|
||||
var isServerAuthoritative = false;
|
||||
var ownerAuthoritativeServerSide = false;
|
||||
|
||||
// Get the behaviour index
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out networkBehaviourId);
|
||||
|
||||
if (isSpawnedLocally)
|
||||
{
|
||||
networkObject = networkManager.SpawnManager.SpawnedObjects[networkObjectId];
|
||||
// Get the target NetworkTransform
|
||||
NetworkTransform = networkObject.ChildNetworkBehaviours[networkBehaviourId] as NetworkTransform;
|
||||
isServerAuthoritative = NetworkTransform.IsServerAuthoritative();
|
||||
ownerAuthoritativeServerSide = !isServerAuthoritative && networkManager.IsServer;
|
||||
|
||||
reader.ReadNetworkSerializableInPlace(ref NetworkTransform.InboundState);
|
||||
NetworkTransform.InboundState.LastSerializedSize = reader.Position - currentPosition;
|
||||
}
|
||||
else
|
||||
{
|
||||
// Deserialize the state
|
||||
reader.ReadNetworkSerializableInPlace(ref State);
|
||||
}
|
||||
|
||||
unsafe
|
||||
{
|
||||
if (ownerAuthoritativeServerSide)
|
||||
{
|
||||
var targetCount = 1;
|
||||
|
||||
if (networkManager.DistributedAuthorityMode && networkManager.DAHost)
|
||||
{
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out targetCount);
|
||||
}
|
||||
|
||||
var targetIds = stackalloc ulong[targetCount];
|
||||
|
||||
if (networkManager.DistributedAuthorityMode && networkManager.DAHost)
|
||||
{
|
||||
var targetId = (ulong)0;
|
||||
for (int i = 0; i < targetCount; i++)
|
||||
{
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out targetId);
|
||||
targetIds[i] = targetId;
|
||||
}
|
||||
|
||||
if (!isSpawnedLocally)
|
||||
{
|
||||
// If we are the DAHost and the NetworkObject is hidden from the host we still need to forward this message
|
||||
ownerAuthoritativeServerSide = networkManager.DAHost && !isSpawnedLocally;
|
||||
}
|
||||
}
|
||||
|
||||
var ownerClientId = (ulong)0;
|
||||
|
||||
if (networkObject != null)
|
||||
{
|
||||
ownerClientId = networkObject.OwnerClientId;
|
||||
if (ownerClientId == NetworkManager.ServerClientId)
|
||||
{
|
||||
// Ownership must have changed, ignore any additional pending messages that might have
|
||||
// come from a previous owner client.
|
||||
return true;
|
||||
}
|
||||
}
|
||||
else if (networkManager.DAHost)
|
||||
{
|
||||
// Specific to distributed authority mode, the only sender of state updates will be the owner
|
||||
ownerClientId = context.SenderId;
|
||||
}
|
||||
|
||||
var networkDelivery = State.IsReliableStateUpdate() ? NetworkDelivery.ReliableSequenced : NetworkDelivery.UnreliableSequenced;
|
||||
|
||||
// Forward the state update if there are any remote clients to foward it to
|
||||
if (networkManager.ConnectionManager.ConnectedClientsList.Count > (networkManager.IsHost ? 2 : 1))
|
||||
{
|
||||
var clientCount = networkManager.DistributedAuthorityMode ? targetCount : networkManager.ConnectionManager.ConnectedClientsList.Count;
|
||||
if (clientCount == 0)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
// This is only to copy the existing and already serialized struct for forwarding purposes only.
|
||||
// This will not include any changes made to this struct at this particular stage of processing the message.
|
||||
var currentMessage = this;
|
||||
// Create a new reader that replicates this message
|
||||
currentMessage.m_CurrentReader = new FastBufferReader(reader, Collections.Allocator.None);
|
||||
// Rewind the new reader to the beginning of the message's payload
|
||||
currentMessage.m_CurrentReader.Seek(currentPosition);
|
||||
// Forward the message to all connected clients that are observers of the associated NetworkObject
|
||||
|
||||
for (int i = 0; i < clientCount; i++)
|
||||
{
|
||||
var clientId = networkManager.DistributedAuthorityMode ? targetIds[i] : networkManager.ConnectionManager.ConnectedClientsList[i].ClientId;
|
||||
if (NetworkManager.ServerClientId == clientId || (!isServerAuthoritative && clientId == ownerClientId) ||
|
||||
(!networkManager.DistributedAuthorityMode && !networkObject.Observers.Contains(clientId)))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
networkManager.MessageManager.SendMessage(ref currentMessage, networkDelivery, clientId);
|
||||
}
|
||||
// Dispose of the reader used for forwarding
|
||||
currentMessage.m_CurrentReader.Dispose();
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = context.SystemOwner as NetworkManager;
|
||||
// Only if the local NetworkManager instance is running as the DAHost we just exit if there is no local
|
||||
// NetworkTransform component to apply the state update to (i.e. it is hidden from the DAHost and it
|
||||
// just forwarded the state update to any other connected client)
|
||||
if (networkManager.DAHost && NetworkTransform == null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (NetworkTransform == null)
|
||||
{
|
||||
Debug.LogError($"[{nameof(NetworkTransformMessage)}][Dropped] Reciever {nameof(NetworkTransform)} was not set!");
|
||||
return;
|
||||
}
|
||||
NetworkTransform.TransformStateUpdate(context.SenderId);
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Runtime/Messaging/Messages/NetworkTransformMessage.cs.meta
Normal file
11
Runtime/Messaging/Messages/NetworkTransformMessage.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: dcfc8ac43fef97e42adb19b998d70c37
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -23,6 +23,10 @@ namespace Unity.Netcode
|
||||
|
||||
private FastBufferReader m_ReceivedNetworkVariableData;
|
||||
|
||||
private const string k_Name = "NetworkVariableDeltaMessage";
|
||||
|
||||
// DANGO-TODO: Made some modifications here that overlap/won't play nice with EnsureNetworkVariableLenghtSafety.
|
||||
// Worth either merging or more cleanly separating these codepaths.
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
if (!writer.TryBeginWrite(FastBufferWriter.GetWriteSize(NetworkObjectId) + FastBufferWriter.GetWriteSize(NetworkBehaviourIndex)))
|
||||
@@ -30,15 +34,26 @@ namespace Unity.Netcode
|
||||
throw new OverflowException($"Not enough space in the buffer to write {nameof(NetworkVariableDeltaMessage)}");
|
||||
}
|
||||
|
||||
var obj = NetworkBehaviour.NetworkObject;
|
||||
var networkManager = obj.NetworkManagerOwner;
|
||||
|
||||
BytePacker.WriteValueBitPacked(writer, NetworkObjectId);
|
||||
BytePacker.WriteValueBitPacked(writer, NetworkBehaviourIndex);
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
writer.WriteValueSafe((ushort)NetworkBehaviour.NetworkVariableFields.Count);
|
||||
}
|
||||
|
||||
for (int i = 0; i < NetworkBehaviour.NetworkVariableFields.Count; i++)
|
||||
{
|
||||
if (!DeliveryMappedNetworkVariableIndex.Contains(i))
|
||||
{
|
||||
// This var does not belong to the currently iterating delivery group.
|
||||
if (NetworkBehaviour.NetworkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
writer.WriteValueSafe<ushort>(0);
|
||||
}
|
||||
else if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
||||
{
|
||||
BytePacker.WriteValueBitPacked(writer, (ushort)0);
|
||||
}
|
||||
@@ -54,7 +69,8 @@ namespace Unity.Netcode
|
||||
var networkVariable = NetworkBehaviour.NetworkVariableFields[i];
|
||||
var shouldWrite = networkVariable.IsDirty() &&
|
||||
networkVariable.CanClientRead(TargetClientId) &&
|
||||
(NetworkBehaviour.NetworkManager.IsServer || networkVariable.CanClientWrite(NetworkBehaviour.NetworkManager.LocalClientId));
|
||||
(networkManager.IsServer || networkVariable.CanClientWrite(networkManager.LocalClientId)) &&
|
||||
networkVariable.CanSend();
|
||||
|
||||
// Prevent the server from writing to the client that owns a given NetworkVariable
|
||||
// Allowing the write would send an old value to the client and cause jitter
|
||||
@@ -67,14 +83,21 @@ namespace Unity.Netcode
|
||||
// The object containing the behaviour we're about to process is about to be shown to this client
|
||||
// As a result, the client will get the fully serialized NetworkVariable and would be confused by
|
||||
// an extraneous delta
|
||||
if (NetworkBehaviour.NetworkManager.SpawnManager.ObjectsToShowToClient.ContainsKey(TargetClientId) &&
|
||||
NetworkBehaviour.NetworkManager.SpawnManager.ObjectsToShowToClient[TargetClientId]
|
||||
.Contains(NetworkBehaviour.NetworkObject))
|
||||
if (networkManager.SpawnManager.ObjectsToShowToClient.ContainsKey(TargetClientId) &&
|
||||
networkManager.SpawnManager.ObjectsToShowToClient[TargetClientId]
|
||||
.Contains(obj))
|
||||
{
|
||||
shouldWrite = false;
|
||||
}
|
||||
|
||||
if (NetworkBehaviour.NetworkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
if (!shouldWrite)
|
||||
{
|
||||
writer.WriteValueSafe<ushort>(0);
|
||||
}
|
||||
}
|
||||
else if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
||||
{
|
||||
if (!shouldWrite)
|
||||
{
|
||||
@@ -88,9 +111,9 @@ namespace Unity.Netcode
|
||||
|
||||
if (shouldWrite)
|
||||
{
|
||||
if (NetworkBehaviour.NetworkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
||||
if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
||||
{
|
||||
var tempWriter = new FastBufferWriter(NetworkBehaviour.NetworkManager.MessageManager.NonFragmentedMessageMaxSize, Allocator.Temp, NetworkBehaviour.NetworkManager.MessageManager.FragmentedMessageMaxSize);
|
||||
var tempWriter = new FastBufferWriter(networkManager.MessageManager.NonFragmentedMessageMaxSize, Allocator.Temp, networkManager.MessageManager.FragmentedMessageMaxSize);
|
||||
NetworkBehaviour.NetworkVariableFields[i].WriteDelta(tempWriter);
|
||||
BytePacker.WriteValueBitPacked(writer, tempWriter.Length);
|
||||
|
||||
@@ -103,11 +126,30 @@ namespace Unity.Netcode
|
||||
}
|
||||
else
|
||||
{
|
||||
networkVariable.WriteDelta(writer);
|
||||
// DANGO-TODO:
|
||||
// Complex types with custom type serialization (either registered custom types or INetworkSerializable implementations) will be problematic
|
||||
// Non-complex types always provide a full state update per delta
|
||||
// DANGO-TODO: Add NetworkListEvent<T>.EventType awareness to the cloud-state server
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
var size_marker = writer.Position;
|
||||
writer.WriteValueSafe<ushort>(0);
|
||||
var start_marker = writer.Position;
|
||||
networkVariable.WriteDelta(writer);
|
||||
var end_marker = writer.Position;
|
||||
writer.Seek(size_marker);
|
||||
var size = end_marker - start_marker;
|
||||
writer.WriteValueSafe((ushort)size);
|
||||
writer.Seek(end_marker);
|
||||
}
|
||||
else
|
||||
{
|
||||
networkVariable.WriteDelta(writer);
|
||||
}
|
||||
}
|
||||
NetworkBehaviour.NetworkManager.NetworkMetrics.TrackNetworkVariableDeltaSent(
|
||||
networkManager.NetworkMetrics.TrackNetworkVariableDeltaSent(
|
||||
TargetClientId,
|
||||
NetworkBehaviour.NetworkObject,
|
||||
obj,
|
||||
networkVariable.Name,
|
||||
NetworkBehaviour.__getTypeName(),
|
||||
writer.Length - startingSize);
|
||||
@@ -125,6 +167,8 @@ namespace Unity.Netcode
|
||||
return true;
|
||||
}
|
||||
|
||||
// DANGO-TODO: Made some modifications here that overlap/won't play nice with EnsureNetworkVariableLenghtSafety.
|
||||
// Worth either merging or more cleanly separating these codepaths.
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
@@ -142,10 +186,29 @@ namespace Unity.Netcode
|
||||
}
|
||||
else
|
||||
{
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
m_ReceivedNetworkVariableData.ReadValueSafe(out ushort variableCount);
|
||||
if (variableCount != networkBehaviour.NetworkVariableFields.Count)
|
||||
{
|
||||
UnityEngine.Debug.LogError("Variable count mismatch");
|
||||
}
|
||||
}
|
||||
|
||||
for (int i = 0; i < networkBehaviour.NetworkVariableFields.Count; i++)
|
||||
{
|
||||
int varSize = 0;
|
||||
if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
m_ReceivedNetworkVariableData.ReadValueSafe(out ushort variableSize);
|
||||
varSize = variableSize;
|
||||
|
||||
if (varSize == 0)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
}
|
||||
else if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
||||
{
|
||||
ByteUnpacker.ReadValueBitPacked(m_ReceivedNetworkVariableData, out varSize);
|
||||
|
||||
@@ -197,6 +260,7 @@ namespace Unity.Netcode
|
||||
}
|
||||
int readStartPos = m_ReceivedNetworkVariableData.Position;
|
||||
|
||||
// Read Delta so we also notify any subscribers to a change in the NetworkVariable
|
||||
networkVariable.ReadDelta(m_ReceivedNetworkVariableData, networkManager.IsServer);
|
||||
|
||||
networkManager.NetworkMetrics.TrackNetworkVariableDeltaReceived(
|
||||
@@ -206,7 +270,7 @@ namespace Unity.Netcode
|
||||
networkBehaviour.__getTypeName(),
|
||||
context.MessageSize);
|
||||
|
||||
if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
|
||||
if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety || networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
if (m_ReceivedNetworkVariableData.Position > (readStartPos + varSize))
|
||||
{
|
||||
@@ -232,7 +296,10 @@ namespace Unity.Netcode
|
||||
}
|
||||
else
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, m_ReceivedNetworkVariableData, ref context);
|
||||
// DANGO-TODO: Fix me!
|
||||
// When a client-spawned NetworkObject is despawned by the owner client, the owner client will still get messages for deltas and cause this to
|
||||
// log a warning. The issue is primarily how NetworkVariables handle updating and will require some additional re-factoring.
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, m_ReceivedNetworkVariableData, ref context, k_Name);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,6 +6,8 @@ namespace Unity.Netcode
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
private const string k_Name = "DestroyObjectMessage";
|
||||
|
||||
public ulong NetworkObjectId;
|
||||
|
||||
private byte m_BitField;
|
||||
@@ -33,6 +35,12 @@ namespace Unity.Netcode
|
||||
set => ByteUtility.SetBit(ref m_BitField, 2, value);
|
||||
}
|
||||
|
||||
public bool AuthorityApplied
|
||||
{
|
||||
get => ByteUtility.GetBit(m_BitField, 3);
|
||||
set => ByteUtility.SetBit(ref m_BitField, 3, value);
|
||||
}
|
||||
|
||||
// These additional properties are used to synchronize clients with the current position,
|
||||
// rotation, and scale after parenting/de-parenting (world/local space relative). This
|
||||
// allows users to control the final child's transform values without having to have a
|
||||
@@ -83,9 +91,10 @@ namespace Unity.Netcode
|
||||
reader.ReadValueSafe(out Rotation);
|
||||
reader.ReadValueSafe(out Scale);
|
||||
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.ContainsKey(NetworkObjectId))
|
||||
// If the target NetworkObject does not exist =or= the target latest parent does not exist then defer the message
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.ContainsKey(NetworkObjectId) || (LatestParent.HasValue && !networkManager.SpawnManager.SpawnedObjects.ContainsKey(LatestParent.Value)))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context);
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context, k_Name);
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
@@ -95,6 +104,16 @@ namespace Unity.Netcode
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
var networkObject = networkManager.SpawnManager.SpawnedObjects[NetworkObjectId];
|
||||
|
||||
// For either DA or Client-Server modes, parenting is only valid if the parent was owned by a different authority (i.e. AuthorityApplied) or the sender is from the owner (DA mode)
|
||||
// or the server (client-server mode).
|
||||
networkObject.AuthorityAppliedParenting = AuthorityApplied || context.SenderId == networkObject.OwnerClientId || context.SenderId == NetworkManager.ServerClientId;
|
||||
if (!networkObject.AuthorityAppliedParenting && networkManager.LogLevel <= LogLevel.Normal)
|
||||
{
|
||||
NetworkLog.LogWarningServer($"Client-{context.SenderId} sent a ParentSyncMessage but is not the authority of {networkObject.gameObject.name}'s {nameof(NetworkObject)} component!");
|
||||
// DANGO-TODO: Still determining if we should not apply this change (I am leaning towards not allowing it).
|
||||
}
|
||||
|
||||
networkObject.SetNetworkParenting(LatestParent, WorldPositionStays);
|
||||
networkObject.ApplyNetworkParenting(RemoveParent);
|
||||
|
||||
@@ -111,6 +130,30 @@ namespace Unity.Netcode
|
||||
networkObject.transform.rotation = Rotation;
|
||||
}
|
||||
networkObject.transform.localScale = Scale;
|
||||
|
||||
// If in distributed authority mode and we are running a DAHost and this is the DAHost, then forward the parent changed message to any remaining clients
|
||||
if (networkManager.DistributedAuthorityMode && !networkManager.CMBServiceConnection && networkManager.DAHost)
|
||||
{
|
||||
var size = 0;
|
||||
var message = this;
|
||||
|
||||
foreach (var client in networkManager.ConnectedClients)
|
||||
{
|
||||
if (client.Value.ClientId == networkObject.OwnerClientId || client.Value.ClientId == networkManager.LocalClientId)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
if (networkObject.IsNetworkVisibleTo(client.Value.ClientId))
|
||||
{
|
||||
size = networkManager.ConnectionManager.SendMessage(ref message, NetworkDelivery.ReliableSequenced, client.Value.ClientId);
|
||||
networkManager.NetworkMetrics.TrackOwnershipChangeSent(client.Key, networkObject, size);
|
||||
}
|
||||
else
|
||||
{
|
||||
Debug.Log($"[DAHost][ParentingProxy] Client-{client.Value.ClientId} has no visibility to {networkObject.name}!");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
83
Runtime/Messaging/Messages/ProxyMessage.cs
Normal file
83
Runtime/Messaging/Messages/ProxyMessage.cs
Normal file
@@ -0,0 +1,83 @@
|
||||
using System;
|
||||
using Unity.Collections;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct ProxyMessage : INetworkMessage
|
||||
{
|
||||
public NativeArray<ulong> TargetClientIds;
|
||||
public NetworkDelivery Delivery;
|
||||
public RpcMessage WrappedMessage;
|
||||
|
||||
// Version of ProxyMessage and RpcMessage must always match.
|
||||
// If ProxyMessage needs to change, increment RpcMessage's version
|
||||
public int Version => new RpcMessage().Version;
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
writer.WriteValueSafe(TargetClientIds);
|
||||
BytePacker.WriteValuePacked(writer, Delivery);
|
||||
WrappedMessage.Serialize(writer, targetVersion);
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
reader.ReadValueSafe(out TargetClientIds, Allocator.Temp);
|
||||
ByteUnpacker.ReadValuePacked(reader, out Delivery);
|
||||
WrappedMessage = new RpcMessage();
|
||||
WrappedMessage.Deserialize(reader, ref context, receivedMessageVersion);
|
||||
return true;
|
||||
}
|
||||
|
||||
public unsafe void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.TryGetValue(WrappedMessage.Metadata.NetworkObjectId, out var networkObject))
|
||||
{
|
||||
// With distributed authority mode, we can send Rpcs before we have been notified the NetworkObject is despawned.
|
||||
// DANGO-TODO: Should the CMB Service cull out any Rpcs targeting recently despawned NetworkObjects?
|
||||
// DANGO-TODO: This would require the service to keep track of despawned NetworkObjects since we re-use NetworkObject identifiers.
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
if (networkManager.LogLevel == LogLevel.Developer)
|
||||
{
|
||||
NetworkLog.LogWarning($"[{WrappedMessage.Metadata.NetworkObjectId}, {WrappedMessage.Metadata.NetworkBehaviourId}, {WrappedMessage.Metadata.NetworkRpcMethodId}]An RPC called on a {nameof(NetworkObject)} that is not in the spawned objects list. Please make sure the {nameof(NetworkObject)} is spawned before calling RPCs.");
|
||||
}
|
||||
return;
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new InvalidOperationException($"[{WrappedMessage.Metadata.NetworkObjectId}, {WrappedMessage.Metadata.NetworkBehaviourId}, {WrappedMessage.Metadata.NetworkRpcMethodId}]An RPC called on a {nameof(NetworkObject)} that is not in the spawned objects list. Please make sure the {nameof(NetworkObject)} is spawned before calling RPCs.");
|
||||
}
|
||||
}
|
||||
|
||||
var observers = networkObject.Observers;
|
||||
|
||||
var nonServerIds = new NativeList<ulong>(Allocator.Temp);
|
||||
for (var i = 0; i < TargetClientIds.Length; ++i)
|
||||
{
|
||||
if (!observers.Contains(TargetClientIds[i]))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (TargetClientIds[i] == NetworkManager.ServerClientId)
|
||||
{
|
||||
WrappedMessage.Handle(ref context);
|
||||
}
|
||||
else
|
||||
{
|
||||
nonServerIds.Add(TargetClientIds[i]);
|
||||
}
|
||||
}
|
||||
|
||||
WrappedMessage.WriteBuffer = new FastBufferWriter(WrappedMessage.ReadBuffer.Length, Allocator.Temp);
|
||||
|
||||
using (WrappedMessage.WriteBuffer)
|
||||
{
|
||||
WrappedMessage.WriteBuffer.WriteBytesSafe(WrappedMessage.ReadBuffer.GetUnsafePtr(), WrappedMessage.ReadBuffer.Length);
|
||||
networkManager.MessageManager.SendMessage(ref WrappedMessage, Delivery, nonServerIds);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
3
Runtime/Messaging/Messages/ProxyMessage.cs.meta
Normal file
3
Runtime/Messaging/Messages/ProxyMessage.cs.meta
Normal file
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: e9ee0457d5b740b38dfe6542658fb522
|
||||
timeCreated: 1697825043
|
||||
@@ -14,7 +14,7 @@ namespace Unity.Netcode
|
||||
writer.WriteBytesSafe(payload.GetUnsafePtr(), payload.Length);
|
||||
}
|
||||
|
||||
public static unsafe bool Deserialize(ref FastBufferReader reader, ref NetworkContext context, ref RpcMetadata metadata, ref FastBufferReader payload)
|
||||
public static unsafe bool Deserialize(ref FastBufferReader reader, ref NetworkContext context, ref RpcMetadata metadata, ref FastBufferReader payload, string messageType)
|
||||
{
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out metadata.NetworkObjectId);
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out metadata.NetworkBehaviourId);
|
||||
@@ -23,7 +23,7 @@ namespace Unity.Netcode
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.ContainsKey(metadata.NetworkObjectId))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, metadata.NetworkObjectId, reader, ref context);
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, metadata.NetworkObjectId, reader, ref context, messageType);
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -41,7 +41,7 @@ namespace Unity.Netcode
|
||||
|
||||
payload = new FastBufferReader(reader.GetUnsafePtrAtCurrentPosition(), Allocator.None, reader.Length - reader.Position);
|
||||
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR || UNITY_MP_TOOLS_NET_STATS_MONITOR_ENABLED_IN_RELEASE
|
||||
if (NetworkBehaviour.__rpc_name_table[networkBehaviour.GetType()].TryGetValue(metadata.NetworkRpcMethodId, out var rpcMethodName))
|
||||
{
|
||||
networkManager.NetworkMetrics.TrackRpcReceived(
|
||||
@@ -52,7 +52,6 @@ namespace Unity.Netcode
|
||||
reader.Length);
|
||||
}
|
||||
#endif
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
@@ -100,6 +99,8 @@ namespace Unity.Netcode
|
||||
public FastBufferWriter WriteBuffer;
|
||||
public FastBufferReader ReadBuffer;
|
||||
|
||||
private const string k_Name = "ServerRpcMessage";
|
||||
|
||||
public unsafe void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
RpcMessageHelpers.Serialize(ref writer, ref Metadata, ref WriteBuffer);
|
||||
@@ -107,7 +108,7 @@ namespace Unity.Netcode
|
||||
|
||||
public unsafe bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
return RpcMessageHelpers.Deserialize(ref reader, ref context, ref Metadata, ref ReadBuffer);
|
||||
return RpcMessageHelpers.Deserialize(ref reader, ref context, ref Metadata, ref ReadBuffer, k_Name);
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
@@ -135,6 +136,8 @@ namespace Unity.Netcode
|
||||
public FastBufferWriter WriteBuffer;
|
||||
public FastBufferReader ReadBuffer;
|
||||
|
||||
private const string k_Name = "ClientRpcMessage";
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
RpcMessageHelpers.Serialize(ref writer, ref Metadata, ref WriteBuffer);
|
||||
@@ -142,7 +145,7 @@ namespace Unity.Netcode
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
return RpcMessageHelpers.Deserialize(ref reader, ref context, ref Metadata, ref ReadBuffer);
|
||||
return RpcMessageHelpers.Deserialize(ref reader, ref context, ref Metadata, ref ReadBuffer, k_Name);
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
@@ -159,4 +162,179 @@ namespace Unity.Netcode
|
||||
RpcMessageHelpers.Handle(ref context, ref Metadata, ref ReadBuffer, ref rpcParams);
|
||||
}
|
||||
}
|
||||
|
||||
internal struct RpcMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
public RpcMetadata Metadata;
|
||||
public ulong SenderClientId;
|
||||
|
||||
public FastBufferWriter WriteBuffer;
|
||||
public FastBufferReader ReadBuffer;
|
||||
|
||||
private const string k_Name = "RpcMessage";
|
||||
|
||||
public unsafe void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
BytePacker.WriteValuePacked(writer, SenderClientId);
|
||||
RpcMessageHelpers.Serialize(ref writer, ref Metadata, ref WriteBuffer);
|
||||
}
|
||||
|
||||
public unsafe bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
ByteUnpacker.ReadValuePacked(reader, out SenderClientId);
|
||||
|
||||
return RpcMessageHelpers.Deserialize(ref reader, ref context, ref Metadata, ref ReadBuffer, k_Name);
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var rpcParams = new __RpcParams
|
||||
{
|
||||
Ext = new RpcParams
|
||||
{
|
||||
Receive = new RpcReceiveParams
|
||||
{
|
||||
SenderClientId = SenderClientId
|
||||
}
|
||||
}
|
||||
};
|
||||
RpcMessageHelpers.Handle(ref context, ref Metadata, ref ReadBuffer, ref rpcParams);
|
||||
}
|
||||
}
|
||||
|
||||
// DANGO-EXP TODO: REMOVE THIS
|
||||
internal struct ForwardServerRpcMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
public ulong OwnerId;
|
||||
public NetworkDelivery NetworkDelivery;
|
||||
public ServerRpcMessage ServerRpcMessage;
|
||||
|
||||
public unsafe void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
writer.WriteValueSafe(OwnerId);
|
||||
writer.WriteValueSafe(NetworkDelivery);
|
||||
ServerRpcMessage.Serialize(writer, targetVersion);
|
||||
}
|
||||
|
||||
public unsafe bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
reader.ReadValueSafe(out OwnerId);
|
||||
reader.ReadValueSafe(out NetworkDelivery);
|
||||
ServerRpcMessage.ReadBuffer = new FastBufferReader(reader, Allocator.Persistent, reader.Length - reader.Position, sizeof(RpcMetadata));
|
||||
|
||||
// If deserializing failed or this message was deferred.
|
||||
if (!ServerRpcMessage.Deserialize(reader, ref context, receivedMessageVersion))
|
||||
{
|
||||
// release this reader as the handler will either be invoked later (deferred) or will not be invoked at all.
|
||||
ServerRpcMessage.ReadBuffer.Dispose();
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (networkManager.DAHost)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Since this is temporary, we will not be collection metrics for this.
|
||||
// DAHost just forwards the message to the owner
|
||||
ServerRpcMessage.WriteBuffer = new FastBufferWriter(ServerRpcMessage.ReadBuffer.Length, Allocator.TempJob);
|
||||
ServerRpcMessage.WriteBuffer.WriteBytesSafe(ServerRpcMessage.ReadBuffer.ToArray());
|
||||
networkManager.ConnectionManager.SendMessage(ref ServerRpcMessage, NetworkDelivery, OwnerId);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Debug.LogException(ex);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
NetworkLog.LogErrorServer($"Received {nameof(ForwardServerRpcMessage)} on client-{networkManager.LocalClientId}! Only DAHost may forward RPC messages!");
|
||||
}
|
||||
ServerRpcMessage.ReadBuffer.Dispose();
|
||||
ServerRpcMessage.WriteBuffer.Dispose();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// DANGO-EXP TODO: REMOVE THIS
|
||||
internal struct ForwardClientRpcMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
public bool BroadCast;
|
||||
public ulong[] TargetClientIds;
|
||||
public NetworkDelivery NetworkDelivery;
|
||||
public ClientRpcMessage ClientRpcMessage;
|
||||
|
||||
public unsafe void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
if (TargetClientIds == null)
|
||||
{
|
||||
BroadCast = true;
|
||||
writer.WriteValueSafe(BroadCast);
|
||||
}
|
||||
else
|
||||
{
|
||||
BroadCast = false;
|
||||
writer.WriteValueSafe(BroadCast);
|
||||
writer.WriteValueSafe(TargetClientIds);
|
||||
}
|
||||
writer.WriteValueSafe(NetworkDelivery);
|
||||
ClientRpcMessage.Serialize(writer, targetVersion);
|
||||
}
|
||||
|
||||
public unsafe bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
reader.ReadValueSafe(out BroadCast);
|
||||
|
||||
if (!BroadCast)
|
||||
{
|
||||
reader.ReadValueSafe(out TargetClientIds);
|
||||
}
|
||||
|
||||
reader.ReadValueSafe(out NetworkDelivery);
|
||||
|
||||
ClientRpcMessage.ReadBuffer = new FastBufferReader(reader, Allocator.Persistent, reader.Length - reader.Position, sizeof(RpcMetadata));
|
||||
// If deserializing failed or this message was deferred.
|
||||
if (!ClientRpcMessage.Deserialize(reader, ref context, receivedMessageVersion))
|
||||
{
|
||||
// release this reader as the handler will either be invoked later (deferred) or will not be invoked at all.
|
||||
ClientRpcMessage.ReadBuffer.Dispose();
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (networkManager.DAHost)
|
||||
{
|
||||
ClientRpcMessage.WriteBuffer = new FastBufferWriter(ClientRpcMessage.ReadBuffer.Length, Allocator.TempJob);
|
||||
ClientRpcMessage.WriteBuffer.WriteBytesSafe(ClientRpcMessage.ReadBuffer.ToArray());
|
||||
// Since this is temporary, we will not be collection metrics for this.
|
||||
// DAHost just forwards the message to the clients
|
||||
if (BroadCast)
|
||||
{
|
||||
networkManager.ConnectionManager.SendMessage(ref ClientRpcMessage, NetworkDelivery, networkManager.ConnectedClientsIds);
|
||||
}
|
||||
else
|
||||
{
|
||||
networkManager.ConnectionManager.SendMessage(ref ClientRpcMessage, NetworkDelivery, TargetClientIds);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
NetworkLog.LogErrorServer($"Received {nameof(ForwardClientRpcMessage)} on client-{networkManager.LocalClientId}! Only DAHost may forward RPC messages!");
|
||||
}
|
||||
ClientRpcMessage.WriteBuffer.Dispose();
|
||||
ClientRpcMessage.ReadBuffer.Dispose();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
// Todo: Would be lovely to get this one nicely formatted with all the data it sends in the struct
|
||||
@@ -8,6 +9,7 @@ namespace Unity.Netcode
|
||||
|
||||
public SceneEventData EventData;
|
||||
|
||||
|
||||
private FastBufferReader m_ReceivedData;
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
@@ -23,7 +25,8 @@ namespace Unity.Netcode
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
((NetworkManager)context.SystemOwner).SceneManager.HandleSceneEvent(context.SenderId, m_ReceivedData);
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
networkManager.SceneManager.HandleSceneEvent(context.SenderId, m_ReceivedData);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,6 +4,8 @@ namespace Unity.Netcode
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
public ulong SenderId;
|
||||
|
||||
public NetworkLog.LogType LogType;
|
||||
// It'd be lovely to be able to replace this with FixedString or NativeArray...
|
||||
// But it's not really practical. On the sending side, the user is likely to want
|
||||
@@ -12,30 +14,39 @@ namespace Unity.Netcode
|
||||
// So an allocation is unavoidable here on both sides.
|
||||
public string Message;
|
||||
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
writer.WriteValueSafe(LogType);
|
||||
BytePacker.WriteValuePacked(writer, Message);
|
||||
BytePacker.WriteValueBitPacked(writer, SenderId);
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (networkManager.IsServer && networkManager.NetworkConfig.EnableNetworkLogs)
|
||||
|
||||
if ((networkManager.IsServer || networkManager.LocalClient.IsSessionOwner) && networkManager.NetworkConfig.EnableNetworkLogs)
|
||||
{
|
||||
reader.ReadValueSafe(out LogType);
|
||||
ByteUnpacker.ReadValuePacked(reader, out Message);
|
||||
ByteUnpacker.ReadValuePacked(reader, out SenderId);
|
||||
// If in distributed authority mode and the DAHost is not the session owner, then the DAHost will just forward the message.
|
||||
if (networkManager.DAHost && networkManager.CurrentSessionOwner != networkManager.LocalClientId)
|
||||
{
|
||||
var message = this;
|
||||
var size = networkManager.ConnectionManager.SendMessage(ref message, NetworkDelivery.ReliableFragmentedSequenced, networkManager.CurrentSessionOwner);
|
||||
networkManager.NetworkMetrics.TrackServerLogSent(networkManager.CurrentSessionOwner, (uint)LogType, size);
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
var senderId = context.SenderId;
|
||||
var senderId = networkManager.DistributedAuthorityMode ? SenderId : context.SenderId;
|
||||
|
||||
networkManager.NetworkMetrics.TrackServerLogReceived(senderId, (uint)LogType, context.MessageSize);
|
||||
|
||||
|
||||
26
Runtime/Messaging/Messages/SessionOwnerMessage.cs
Normal file
26
Runtime/Messaging/Messages/SessionOwnerMessage.cs
Normal file
@@ -0,0 +1,26 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct SessionOwnerMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
|
||||
public ulong SessionOwner;
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
BytePacker.WriteValuePacked(writer, SessionOwner);
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
ByteUnpacker.ReadValuePacked(reader, out SessionOwner);
|
||||
return true;
|
||||
}
|
||||
|
||||
public unsafe void Handle(ref NetworkContext context)
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
networkManager.SetSessionOwner(SessionOwner);
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Runtime/Messaging/Messages/SessionOwnerMessage.cs.meta
Normal file
11
Runtime/Messaging/Messages/SessionOwnerMessage.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 8e02985965397ab44809c99406914311
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -1,4 +1,5 @@
|
||||
using System;
|
||||
using Unity.Netcode.Transports.UTP;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
@@ -56,7 +57,8 @@ namespace Unity.Netcode
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
{
|
||||
NetworkLog.LogError($"A {nameof(ConnectionApprovedMessage)} was received from a client on the server side. This should not happen. Please report this to the Netcode for GameObjects team at https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/issues and include the following data: Message Size: {messageContent.Length}. Message Content: {NetworkMessageManager.ByteArrayToString(messageContent.ToArray(), 0, messageContent.Length)}");
|
||||
var transportErrorMsg = GetTransportErrorMessage(messageContent, m_NetworkManager);
|
||||
NetworkLog.LogError($"A {nameof(ConnectionApprovedMessage)} was received from a client on the server side. {transportErrorMsg}");
|
||||
}
|
||||
|
||||
return false;
|
||||
@@ -66,7 +68,7 @@ namespace Unity.Netcode
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
{
|
||||
NetworkLog.LogWarning($"Message received from {nameof(senderId)}={senderId} before it has been accepted");
|
||||
NetworkLog.LogWarning($"Message received from {nameof(senderId)}={senderId} before it has been accepted.");
|
||||
}
|
||||
|
||||
return false;
|
||||
@@ -76,7 +78,8 @@ namespace Unity.Netcode
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
{
|
||||
NetworkLog.LogError($"A {nameof(ConnectionRequestMessage)} was received from a client when the connection has already been established. This should not happen. Please report this to the Netcode for GameObjects team at https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/issues and include the following data: Message Size: {messageContent.Length}. Message Content: {NetworkMessageManager.ByteArrayToString(messageContent.ToArray(), 0, messageContent.Length)}");
|
||||
var transportErrorMsg = GetTransportErrorMessage(messageContent, m_NetworkManager);
|
||||
NetworkLog.LogError($"A {nameof(ConnectionRequestMessage)} was received from a client when the connection has already been established. {transportErrorMsg}");
|
||||
}
|
||||
|
||||
return false;
|
||||
@@ -88,7 +91,8 @@ namespace Unity.Netcode
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
{
|
||||
NetworkLog.LogError($"A {nameof(ConnectionRequestMessage)} was received from the server on the client side. This should not happen. Please report this to the Netcode for GameObjects team at https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/issues and include the following data: Message Size: {messageContent.Length}. Message Content: {NetworkMessageManager.ByteArrayToString(messageContent.ToArray(), 0, messageContent.Length)}");
|
||||
var transportErrorMsg = GetTransportErrorMessage(messageContent, m_NetworkManager);
|
||||
NetworkLog.LogError($"A {nameof(ConnectionRequestMessage)} was received from the server on the client side. {transportErrorMsg}");
|
||||
}
|
||||
|
||||
return false;
|
||||
@@ -98,7 +102,8 @@ namespace Unity.Netcode
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
{
|
||||
NetworkLog.LogError($"A {nameof(ConnectionApprovedMessage)} was received from the server when the connection has already been established. This should not happen. Please report this to the Netcode for GameObjects team at https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/issues and include the following data: Message Size: {messageContent.Length}. Message Content: {NetworkMessageManager.ByteArrayToString(messageContent.ToArray(), 0, messageContent.Length)}");
|
||||
var transportErrorMsg = GetTransportErrorMessage(messageContent, m_NetworkManager);
|
||||
NetworkLog.LogError($"A {nameof(ConnectionApprovedMessage)} was received from the server when the connection has already been established. {transportErrorMsg}");
|
||||
}
|
||||
|
||||
return false;
|
||||
@@ -108,6 +113,28 @@ namespace Unity.Netcode
|
||||
return !m_NetworkManager.MessageManager.StopProcessing;
|
||||
}
|
||||
|
||||
private static string GetTransportErrorMessage(FastBufferReader messageContent, NetworkManager networkManager)
|
||||
{
|
||||
if (networkManager.NetworkConfig.NetworkTransport is not UnityTransport)
|
||||
{
|
||||
return $"NetworkTransport: {networkManager.NetworkConfig.NetworkTransport.GetType()}. Please report this to the maintainer of transport layer.";
|
||||
}
|
||||
|
||||
var transportVersion = GetTransportVersion(networkManager);
|
||||
return $"{transportVersion}. This should not happen. Please report this to the Netcode for GameObjects team at https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/issues and include the following data: Message Size: {messageContent.Length}. Message Content: {NetworkMessageManager.ByteArrayToString(messageContent.ToArray(), 0, messageContent.Length)}";
|
||||
}
|
||||
|
||||
private static string GetTransportVersion(NetworkManager networkManager)
|
||||
{
|
||||
var transportVersion = "NetworkTransport: " + networkManager.NetworkConfig.NetworkTransport.GetType();
|
||||
if (networkManager.NetworkConfig.NetworkTransport is UnityTransport unityTransport)
|
||||
{
|
||||
transportVersion += " UnityTransportProtocol: " + unityTransport.Protocol;
|
||||
}
|
||||
|
||||
return transportVersion;
|
||||
}
|
||||
|
||||
public void OnBeforeHandleMessage<T>(ref T message, ref NetworkContext context) where T : INetworkMessage
|
||||
{
|
||||
}
|
||||
|
||||
@@ -34,6 +34,9 @@ namespace Unity.Netcode
|
||||
internal class NetworkMessageManager : IDisposable
|
||||
{
|
||||
public bool StopProcessing = false;
|
||||
private static Type s_ConnectionApprovedType = typeof(ConnectionApprovedMessage);
|
||||
private static Type s_ConnectionRequestType = typeof(ConnectionRequestMessage);
|
||||
private static Type s_DisconnectReasonType = typeof(DisconnectReasonMessage);
|
||||
|
||||
private struct ReceiveQueueItem
|
||||
{
|
||||
@@ -85,6 +88,8 @@ namespace Unity.Netcode
|
||||
private INetworkMessageSender m_Sender;
|
||||
private bool m_Disposed;
|
||||
|
||||
private ulong m_LocalClientId;
|
||||
|
||||
internal Type[] MessageTypes => m_ReverseTypeMap;
|
||||
internal MessageHandler[] MessageHandlers => m_MessageHandlers;
|
||||
|
||||
@@ -95,6 +100,16 @@ namespace Unity.Netcode
|
||||
return m_MessageTypes[t];
|
||||
}
|
||||
|
||||
internal object GetOwner()
|
||||
{
|
||||
return m_Owner;
|
||||
}
|
||||
|
||||
internal void SetLocalClientId(ulong id)
|
||||
{
|
||||
m_LocalClientId = id;
|
||||
}
|
||||
|
||||
public const int DefaultNonFragmentedMessageMaxSize = 1300 & ~7; // Round down to nearest word aligned size (1296)
|
||||
public int NonFragmentedMessageMaxSize = DefaultNonFragmentedMessageMaxSize;
|
||||
public int FragmentedMessageMaxSize = int.MaxValue;
|
||||
@@ -108,53 +123,46 @@ namespace Unity.Netcode
|
||||
public VersionGetter GetVersion;
|
||||
}
|
||||
|
||||
internal List<MessageWithHandler> PrioritizeMessageOrder(List<MessageWithHandler> allowedTypes)
|
||||
{
|
||||
var prioritizedTypes = new List<MessageWithHandler>();
|
||||
|
||||
// First pass puts the priority message in the first indices
|
||||
// Those are the messages that must be delivered in order to allow re-ordering the others later
|
||||
foreach (var t in allowedTypes)
|
||||
{
|
||||
if (t.MessageType.FullName == typeof(ConnectionRequestMessage).FullName ||
|
||||
t.MessageType.FullName == typeof(ConnectionApprovedMessage).FullName)
|
||||
{
|
||||
prioritizedTypes.Add(t);
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var t in allowedTypes)
|
||||
{
|
||||
if (t.MessageType.FullName != typeof(ConnectionRequestMessage).FullName &&
|
||||
t.MessageType.FullName != typeof(ConnectionApprovedMessage).FullName)
|
||||
{
|
||||
prioritizedTypes.Add(t);
|
||||
}
|
||||
}
|
||||
|
||||
return prioritizedTypes;
|
||||
}
|
||||
|
||||
public NetworkMessageManager(INetworkMessageSender sender, object owner, INetworkMessageProvider provider = null)
|
||||
{
|
||||
try
|
||||
{
|
||||
m_Sender = sender;
|
||||
m_Owner = owner;
|
||||
|
||||
if (provider == null)
|
||||
{
|
||||
provider = new ILPPMessageProvider();
|
||||
}
|
||||
|
||||
// Get the presorted message types returned by the provider
|
||||
var allowedTypes = provider.GetMessages();
|
||||
|
||||
allowedTypes.Sort((a, b) => string.CompareOrdinal(a.MessageType.FullName, b.MessageType.FullName));
|
||||
allowedTypes = PrioritizeMessageOrder(allowedTypes);
|
||||
foreach (var type in allowedTypes)
|
||||
{
|
||||
RegisterMessageType(type);
|
||||
}
|
||||
|
||||
#if UNITY_EDITOR
|
||||
if (EnableMessageOrderConsoleLog)
|
||||
{
|
||||
// DANGO-TODO: Remove this when we have some form of message type indices stability in place
|
||||
// For now, just log the messages and their assigned types for reference purposes.
|
||||
var networkManager = m_Owner as NetworkManager;
|
||||
if (networkManager != null)
|
||||
{
|
||||
if (networkManager.DistributedAuthorityMode)
|
||||
{
|
||||
var messageListing = new StringBuilder();
|
||||
messageListing.AppendLine("NGO Message Index to Type Listing:");
|
||||
foreach (var message in m_MessageTypes)
|
||||
{
|
||||
messageListing.AppendLine($"[{message.Value}][{message.Key.Name}]");
|
||||
}
|
||||
Debug.Log(messageListing);
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
catch (Exception)
|
||||
{
|
||||
@@ -163,6 +171,8 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
internal static bool EnableMessageOrderConsoleLog = false;
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
if (m_Disposed)
|
||||
@@ -517,6 +527,7 @@ namespace Unity.Netcode
|
||||
return new T().Version;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
internal int GetMessageVersion(Type type, ulong clientId, bool forReceive = false)
|
||||
{
|
||||
if (!m_PerClientMessageVersions.TryGetValue(clientId, out var versionMap))
|
||||
@@ -544,16 +555,20 @@ namespace Unity.Netcode
|
||||
return messageVersion;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public static void ReceiveMessage<T>(FastBufferReader reader, ref NetworkContext context, NetworkMessageManager manager) where T : INetworkMessage, new()
|
||||
{
|
||||
var messageType = typeof(T);
|
||||
var message = new T();
|
||||
var messageVersion = 0;
|
||||
|
||||
// Special cases because these are the messages that carry the version info - thus the version info isn't
|
||||
// populated yet when we get these. The first part of these messages always has to be the version data
|
||||
// and can't change.
|
||||
if (typeof(T) != typeof(ConnectionRequestMessage) && typeof(T) != typeof(ConnectionApprovedMessage) && typeof(T) != typeof(DisconnectReasonMessage))
|
||||
if (messageType != s_ConnectionRequestType && messageType != s_ConnectionApprovedType && messageType != s_DisconnectReasonType && context.SenderId != manager.m_LocalClientId)
|
||||
{
|
||||
messageVersion = manager.GetMessageVersion(typeof(T), context.SenderId, true);
|
||||
messageVersion = manager.GetMessageVersion(messageType, context.SenderId, true);
|
||||
if (messageVersion < 0)
|
||||
{
|
||||
return;
|
||||
@@ -605,7 +620,7 @@ namespace Unity.Netcode
|
||||
var messageVersion = 0;
|
||||
// Special case because this is the message that carries the version info - thus the version info isn't populated yet when we get this.
|
||||
// The first part of this message always has to be the version data and can't change.
|
||||
if (typeof(TMessageType) != typeof(ConnectionRequestMessage))
|
||||
if (typeof(TMessageType) != s_ConnectionRequestType)
|
||||
{
|
||||
messageVersion = GetMessageVersion(typeof(TMessageType), clientIds[i]);
|
||||
if (messageVersion < 0)
|
||||
@@ -659,7 +674,7 @@ namespace Unity.Netcode
|
||||
|
||||
// Special case because this is the message that carries the version info - thus the version info isn't populated yet when we get this.
|
||||
// The first part of this message always has to be the version data and can't change.
|
||||
if (typeof(TMessageType) != typeof(ConnectionRequestMessage))
|
||||
if (typeof(TMessageType) != s_ConnectionRequestType)
|
||||
{
|
||||
var messageVersion = GetMessageVersion(typeof(TMessageType), clientIds[i]);
|
||||
if (messageVersion < 0)
|
||||
@@ -739,7 +754,7 @@ namespace Unity.Netcode
|
||||
// Special case because this is the message that carries the version info - thus the version info isn't
|
||||
// populated yet when we get this. The first part of this message always has to be the version data
|
||||
// and can't change.
|
||||
if (typeof(TMessageType) != typeof(ConnectionRequestMessage))
|
||||
if (typeof(TMessageType) != s_ConnectionRequestType)
|
||||
{
|
||||
messageVersion = GetMessageVersion(typeof(TMessageType), clientId);
|
||||
if (messageVersion < 0)
|
||||
@@ -808,6 +823,16 @@ namespace Unity.Netcode
|
||||
return SendMessage(ref message, delivery, new PointerListWrapper<ulong>((ulong*)clientIds.GetUnsafePtr(), clientIds.Length));
|
||||
}
|
||||
|
||||
internal unsafe int SendMessage<T>(ref T message, NetworkDelivery delivery, in NativeList<ulong> clientIds)
|
||||
where T : INetworkMessage
|
||||
{
|
||||
#if UTP_TRANSPORT_2_0_ABOVE
|
||||
return SendMessage(ref message, delivery, new PointerListWrapper<ulong>(clientIds.GetUnsafePtr(), clientIds.Length));
|
||||
#else
|
||||
return SendMessage(ref message, delivery, new PointerListWrapper<ulong>((ulong*)clientIds.GetUnsafePtr(), clientIds.Length));
|
||||
#endif
|
||||
}
|
||||
|
||||
internal unsafe void ProcessSendQueues()
|
||||
{
|
||||
if (StopProcessing)
|
||||
|
||||
@@ -21,12 +21,36 @@ namespace Unity.Netcode
|
||||
/// <summary>
|
||||
/// <para>Represents the common base class for Rpc attributes.</para>
|
||||
/// </summary>
|
||||
public abstract class RpcAttribute : Attribute
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class RpcAttribute : Attribute
|
||||
{
|
||||
// Must match the set of parameters below
|
||||
public struct RpcAttributeParams
|
||||
{
|
||||
public RpcDelivery Delivery;
|
||||
public bool RequireOwnership;
|
||||
public bool DeferLocal;
|
||||
public bool AllowTargetOverride;
|
||||
}
|
||||
|
||||
// Must match the fields in RemoteAttributeParams
|
||||
/// <summary>
|
||||
/// Type of RPC delivery method
|
||||
/// </summary>
|
||||
public RpcDelivery Delivery = RpcDelivery.Reliable;
|
||||
public bool RequireOwnership;
|
||||
public bool DeferLocal;
|
||||
public bool AllowTargetOverride;
|
||||
|
||||
public RpcAttribute(SendTo target)
|
||||
{
|
||||
}
|
||||
|
||||
// To get around an issue with the release validator, RuntimeAccessModifiersILPP will make this 'public'
|
||||
private RpcAttribute()
|
||||
{
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -36,10 +60,12 @@ namespace Unity.Netcode
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class ServerRpcAttribute : RpcAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Whether or not the ServerRpc should only be run if executed by the owner of the object
|
||||
/// </summary>
|
||||
public bool RequireOwnership = true;
|
||||
public new bool RequireOwnership;
|
||||
|
||||
public ServerRpcAttribute() : base(SendTo.Server)
|
||||
{
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -47,5 +73,11 @@ namespace Unity.Netcode
|
||||
/// <para>A ClientRpc marked method will be fired by the server but executed on clients.</para>
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class ClientRpcAttribute : RpcAttribute { }
|
||||
public class ClientRpcAttribute : RpcAttribute
|
||||
{
|
||||
public ClientRpcAttribute() : base(SendTo.NotServer)
|
||||
{
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,6 +3,60 @@ using Unity.Collections;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
public enum LocalDeferMode
|
||||
{
|
||||
Default,
|
||||
Defer,
|
||||
SendImmediate
|
||||
}
|
||||
/// <summary>
|
||||
/// Generic RPC
|
||||
/// </summary>
|
||||
public struct RpcSendParams
|
||||
{
|
||||
public BaseRpcTarget Target;
|
||||
|
||||
public LocalDeferMode LocalDeferMode;
|
||||
|
||||
public static implicit operator RpcSendParams(BaseRpcTarget target) => new RpcSendParams { Target = target };
|
||||
public static implicit operator RpcSendParams(LocalDeferMode deferMode) => new RpcSendParams { LocalDeferMode = deferMode };
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The receive parameters for server-side remote procedure calls
|
||||
/// </summary>
|
||||
public struct RpcReceiveParams
|
||||
{
|
||||
/// <summary>
|
||||
/// Server-Side RPC
|
||||
/// The client identifier of the sender
|
||||
/// </summary>
|
||||
public ulong SenderClientId;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Server-Side RPC
|
||||
/// Can be used with any sever-side remote procedure call
|
||||
/// Note: typically this is use primarily for the <see cref="ServerRpcReceiveParams"/>
|
||||
/// </summary>
|
||||
public struct RpcParams
|
||||
{
|
||||
/// <summary>
|
||||
/// The server RPC send parameters (currently a place holder)
|
||||
/// </summary>
|
||||
public RpcSendParams Send;
|
||||
|
||||
/// <summary>
|
||||
/// The client RPC receive parameters provides you with the sender's identifier
|
||||
/// </summary>
|
||||
public RpcReceiveParams Receive;
|
||||
|
||||
public static implicit operator RpcParams(RpcSendParams send) => new RpcParams { Send = send };
|
||||
public static implicit operator RpcParams(BaseRpcTarget target) => new RpcParams { Send = new RpcSendParams { Target = target } };
|
||||
public static implicit operator RpcParams(LocalDeferMode deferMode) => new RpcParams { Send = new RpcSendParams { LocalDeferMode = deferMode } };
|
||||
public static implicit operator RpcParams(RpcReceiveParams receive) => new RpcParams { Receive = receive };
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Server-Side RPC
|
||||
/// Place holder. <see cref="ServerRpcParams"/>
|
||||
@@ -99,6 +153,7 @@ namespace Unity.Netcode
|
||||
internal struct __RpcParams
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
{
|
||||
public RpcParams Ext;
|
||||
public ServerRpcParams Server;
|
||||
public ClientRpcParams Client;
|
||||
}
|
||||
|
||||
3
Runtime/Messaging/RpcTargets.meta
Normal file
3
Runtime/Messaging/RpcTargets.meta
Normal file
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: b02186acd1144e20acbd0dcb69b14938
|
||||
timeCreated: 1697824888
|
||||
75
Runtime/Messaging/RpcTargets/AuthorityRpcTarget.cs
Normal file
75
Runtime/Messaging/RpcTargets/AuthorityRpcTarget.cs
Normal file
@@ -0,0 +1,75 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal class AuthorityRpcTarget : ServerRpcTarget
|
||||
{
|
||||
private ProxyRpcTarget m_AuthorityTarget;
|
||||
private DirectSendRpcTarget m_DirectSendTarget;
|
||||
|
||||
public override void Dispose()
|
||||
{
|
||||
if (m_AuthorityTarget != null)
|
||||
{
|
||||
m_AuthorityTarget.Dispose();
|
||||
m_AuthorityTarget = null;
|
||||
}
|
||||
|
||||
if (m_DirectSendTarget != null)
|
||||
{
|
||||
m_DirectSendTarget.Dispose();
|
||||
m_DirectSendTarget = null;
|
||||
}
|
||||
|
||||
base.Dispose();
|
||||
}
|
||||
|
||||
internal override void Send(NetworkBehaviour behaviour, ref RpcMessage message, NetworkDelivery delivery, RpcParams rpcParams)
|
||||
{
|
||||
if (behaviour.NetworkManager.DistributedAuthorityMode)
|
||||
{
|
||||
// If invoked locally, then send locally
|
||||
if (behaviour.HasAuthority)
|
||||
{
|
||||
if (m_UnderlyingTarget == null)
|
||||
{
|
||||
m_UnderlyingTarget = new LocalSendRpcTarget(m_NetworkManager);
|
||||
}
|
||||
m_UnderlyingTarget.Send(behaviour, ref message, delivery, rpcParams);
|
||||
}
|
||||
else if (behaviour.NetworkManager.DAHost)
|
||||
{
|
||||
if (m_DirectSendTarget == null)
|
||||
{
|
||||
m_DirectSendTarget = new DirectSendRpcTarget(behaviour.OwnerClientId, m_NetworkManager);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_DirectSendTarget.ClientId = behaviour.OwnerClientId;
|
||||
}
|
||||
m_DirectSendTarget.Send(behaviour, ref message, delivery, rpcParams);
|
||||
}
|
||||
else // Otherwise (for now), we always proxy the RPC messages to the owner
|
||||
{
|
||||
if (m_AuthorityTarget == null)
|
||||
{
|
||||
m_AuthorityTarget = new ProxyRpcTarget(behaviour.OwnerClientId, m_NetworkManager);
|
||||
}
|
||||
else
|
||||
{
|
||||
// Since the owner can change, for now we will just clear and set the owner each time
|
||||
m_AuthorityTarget.SetClientId(behaviour.OwnerClientId);
|
||||
}
|
||||
m_AuthorityTarget.Send(behaviour, ref message, delivery, rpcParams);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// If we are not in distributed authority mode, then we invoke the normal ServerRpc code.
|
||||
base.Send(behaviour, ref message, delivery, rpcParams);
|
||||
}
|
||||
}
|
||||
|
||||
internal AuthorityRpcTarget(NetworkManager manager) : base(manager)
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Runtime/Messaging/RpcTargets/AuthorityRpcTarget.cs.meta
Normal file
11
Runtime/Messaging/RpcTargets/AuthorityRpcTarget.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 6b8f28b7a617fd34faee91e5f88e89ac
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
57
Runtime/Messaging/RpcTargets/BaseRpcTarget.cs
Normal file
57
Runtime/Messaging/RpcTargets/BaseRpcTarget.cs
Normal file
@@ -0,0 +1,57 @@
|
||||
using System;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
public abstract class BaseRpcTarget : IDisposable
|
||||
{
|
||||
protected NetworkManager m_NetworkManager;
|
||||
private bool m_Locked;
|
||||
|
||||
internal void Lock()
|
||||
{
|
||||
m_Locked = true;
|
||||
}
|
||||
|
||||
internal void Unlock()
|
||||
{
|
||||
m_Locked = false;
|
||||
}
|
||||
|
||||
internal BaseRpcTarget(NetworkManager manager)
|
||||
{
|
||||
m_NetworkManager = manager;
|
||||
}
|
||||
|
||||
protected void CheckLockBeforeDispose()
|
||||
{
|
||||
if (m_Locked)
|
||||
{
|
||||
throw new Exception($"RPC targets obtained through {nameof(RpcTargetUse)}.{RpcTargetUse.Temp} may not be disposed.");
|
||||
}
|
||||
}
|
||||
|
||||
public abstract void Dispose();
|
||||
|
||||
internal abstract void Send(NetworkBehaviour behaviour, ref RpcMessage message, NetworkDelivery delivery, RpcParams rpcParams);
|
||||
|
||||
private protected void SendMessageToClient(NetworkBehaviour behaviour, ulong clientId, ref RpcMessage message, NetworkDelivery delivery)
|
||||
{
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR || UNITY_MP_TOOLS_NET_STATS_MONITOR_ENABLED_IN_RELEASE
|
||||
var size =
|
||||
#endif
|
||||
behaviour.NetworkManager.MessageManager.SendMessage(ref message, delivery, clientId);
|
||||
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR || UNITY_MP_TOOLS_NET_STATS_MONITOR_ENABLED_IN_RELEASE
|
||||
if (NetworkBehaviour.__rpc_name_table[behaviour.GetType()].TryGetValue(message.Metadata.NetworkRpcMethodId, out var rpcMethodName))
|
||||
{
|
||||
behaviour.NetworkManager.NetworkMetrics.TrackRpcSent(
|
||||
clientId,
|
||||
behaviour.NetworkObject,
|
||||
rpcMethodName,
|
||||
behaviour.__getTypeName(),
|
||||
size);
|
||||
}
|
||||
#endif
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Runtime/Messaging/RpcTargets/BaseRpcTarget.cs.meta
Normal file
11
Runtime/Messaging/RpcTargets/BaseRpcTarget.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 07c2620262e24eb5a426b521c09b3091
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
37
Runtime/Messaging/RpcTargets/ClientsAndHostRpcTarget.cs
Normal file
37
Runtime/Messaging/RpcTargets/ClientsAndHostRpcTarget.cs
Normal file
@@ -0,0 +1,37 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal class ClientsAndHostRpcTarget : BaseRpcTarget
|
||||
{
|
||||
private BaseRpcTarget m_UnderlyingTarget;
|
||||
|
||||
public override void Dispose()
|
||||
{
|
||||
m_UnderlyingTarget = null;
|
||||
}
|
||||
|
||||
internal override void Send(NetworkBehaviour behaviour, ref RpcMessage message, NetworkDelivery delivery, RpcParams rpcParams)
|
||||
{
|
||||
if (m_UnderlyingTarget == null)
|
||||
{
|
||||
// NotServer treats a host as being a server and will not send to it
|
||||
// ClientsAndHost sends to everyone who runs any client logic
|
||||
// So if the server is a host, this target includes it (as hosts run client logic)
|
||||
// If the server is not a host, this target leaves it out, ergo the selection of NotServer.
|
||||
if (behaviour.NetworkManager.ServerIsHost)
|
||||
{
|
||||
m_UnderlyingTarget = behaviour.RpcTarget.Everyone;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_UnderlyingTarget = behaviour.RpcTarget.NotServer;
|
||||
}
|
||||
}
|
||||
|
||||
m_UnderlyingTarget.Send(behaviour, ref message, delivery, rpcParams);
|
||||
}
|
||||
|
||||
internal ClientsAndHostRpcTarget(NetworkManager manager) : base(manager)
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: c9f883d678ec4715b160dd9497d5f42d
|
||||
timeCreated: 1699481382
|
||||
34
Runtime/Messaging/RpcTargets/DirectSendRpcTarget.cs
Normal file
34
Runtime/Messaging/RpcTargets/DirectSendRpcTarget.cs
Normal file
@@ -0,0 +1,34 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal class DirectSendRpcTarget : BaseRpcTarget, IIndividualRpcTarget
|
||||
{
|
||||
public BaseRpcTarget Target => this;
|
||||
|
||||
internal ulong ClientId;
|
||||
|
||||
public override void Dispose()
|
||||
{
|
||||
CheckLockBeforeDispose();
|
||||
}
|
||||
|
||||
internal override void Send(NetworkBehaviour behaviour, ref RpcMessage message, NetworkDelivery delivery, RpcParams rpcParams)
|
||||
{
|
||||
SendMessageToClient(behaviour, ClientId, ref message, delivery);
|
||||
}
|
||||
|
||||
public void SetClientId(ulong clientId)
|
||||
{
|
||||
ClientId = clientId;
|
||||
}
|
||||
|
||||
internal DirectSendRpcTarget(NetworkManager manager) : base(manager)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
internal DirectSendRpcTarget(ulong clientId, NetworkManager manager) : base(manager)
|
||||
{
|
||||
ClientId = clientId;
|
||||
}
|
||||
}
|
||||
}
|
||||
3
Runtime/Messaging/RpcTargets/DirectSendRpcTarget.cs.meta
Normal file
3
Runtime/Messaging/RpcTargets/DirectSendRpcTarget.cs.meta
Normal file
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 077544cfd0b94cfc8a2a55d3828b74bb
|
||||
timeCreated: 1697824873
|
||||
40
Runtime/Messaging/RpcTargets/EveryoneRpcTarget.cs
Normal file
40
Runtime/Messaging/RpcTargets/EveryoneRpcTarget.cs
Normal file
@@ -0,0 +1,40 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal class EveryoneRpcTarget : BaseRpcTarget
|
||||
{
|
||||
private NotServerRpcTarget m_NotServerRpcTarget;
|
||||
private ServerRpcTarget m_ServerRpcTarget;
|
||||
private NotAuthorityRpcTarget m_NotAuthorityRpcTarget;
|
||||
private AuthorityRpcTarget m_AuthorityRpcTarget;
|
||||
|
||||
public override void Dispose()
|
||||
{
|
||||
m_NotServerRpcTarget.Dispose();
|
||||
m_ServerRpcTarget.Dispose();
|
||||
m_NotAuthorityRpcTarget.Dispose();
|
||||
m_AuthorityRpcTarget.Dispose();
|
||||
}
|
||||
|
||||
internal override void Send(NetworkBehaviour behaviour, ref RpcMessage message, NetworkDelivery delivery, RpcParams rpcParams)
|
||||
{
|
||||
if (NetworkManager.IsDistributedAuthority)
|
||||
{
|
||||
m_NotAuthorityRpcTarget.Send(behaviour, ref message, delivery, rpcParams);
|
||||
m_AuthorityRpcTarget.Send(behaviour, ref message, delivery, rpcParams);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_NotServerRpcTarget.Send(behaviour, ref message, delivery, rpcParams);
|
||||
m_ServerRpcTarget.Send(behaviour, ref message, delivery, rpcParams);
|
||||
}
|
||||
}
|
||||
|
||||
internal EveryoneRpcTarget(NetworkManager manager) : base(manager)
|
||||
{
|
||||
m_NotServerRpcTarget = new NotServerRpcTarget(manager);
|
||||
m_ServerRpcTarget = new ServerRpcTarget(manager);
|
||||
m_NotAuthorityRpcTarget = new NotAuthorityRpcTarget(manager);
|
||||
m_AuthorityRpcTarget = new AuthorityRpcTarget(manager);
|
||||
}
|
||||
}
|
||||
}
|
||||
3
Runtime/Messaging/RpcTargets/EveryoneRpcTarget.cs.meta
Normal file
3
Runtime/Messaging/RpcTargets/EveryoneRpcTarget.cs.meta
Normal file
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 675d4a5c79fc47078092ac15d255745d
|
||||
timeCreated: 1697824941
|
||||
9
Runtime/Messaging/RpcTargets/IGroupRpcTarget.cs
Normal file
9
Runtime/Messaging/RpcTargets/IGroupRpcTarget.cs
Normal file
@@ -0,0 +1,9 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal interface IGroupRpcTarget
|
||||
{
|
||||
void Add(ulong clientId);
|
||||
void Clear();
|
||||
BaseRpcTarget Target { get; }
|
||||
}
|
||||
}
|
||||
3
Runtime/Messaging/RpcTargets/IGroupRpcTarget.cs.meta
Normal file
3
Runtime/Messaging/RpcTargets/IGroupRpcTarget.cs.meta
Normal file
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: beb19a6bb1334252a89b21c8490f7cbe
|
||||
timeCreated: 1697825109
|
||||
8
Runtime/Messaging/RpcTargets/IIndividualRpcTarget.cs
Normal file
8
Runtime/Messaging/RpcTargets/IIndividualRpcTarget.cs
Normal file
@@ -0,0 +1,8 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal interface IIndividualRpcTarget
|
||||
{
|
||||
void SetClientId(ulong clientId);
|
||||
BaseRpcTarget Target { get; }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: c658d9641f564d9890bef4f558f1cea6
|
||||
timeCreated: 1697825115
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user