Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
158f26b913 | ||
|
|
f8ebf679ec | ||
|
|
07f206ff9e | ||
|
|
514166e159 | ||
|
|
ffef45b50f | ||
|
|
b3bd4727ab | ||
|
|
0581a42b70 | ||
|
|
4d70c198bd | ||
|
|
b5abc3ff7c | ||
|
|
8060718e04 |
277
CHANGELOG.md
277
CHANGELOG.md
@@ -6,6 +6,281 @@ 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).
|
||||
|
||||
## [1.9.1] - 2024-04-18
|
||||
|
||||
### Added
|
||||
- Added AnticipatedNetworkVariable<T>, which adds support for client anticipation of NetworkVariable values, allowing for more responsive gameplay (#2820)
|
||||
- Added AnticipatedNetworkTransform, which adds support for client anticipation of NetworkTransforms (#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)
|
||||
- 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. (#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
|
||||
|
||||
- exposed NetworkObject.GetNetworkBehaviourAtOrderIndex as a public API (#2724)
|
||||
- Added context menu tool that provides users with the ability to quickly update the GlobalObjectIdHash value for all in-scene placed prefab instances that were created prior to adding a NetworkObject component to it. (#2707)
|
||||
- Added methods NetworkManager.SetPeerMTU and NetworkManager.GetPeerMTU to be able to set MTU sizes per-peer (#2676)
|
||||
- Added `GenerateSerializationForGenericParameterAttribute`, which can be applied to user-created Network Variable types to ensure the codegen generates serialization for the generic types they wrap. (#2694)
|
||||
- Added `GenerateSerializationForTypeAttribute`, which can be applied to any class or method to ensure the codegen generates serialization for the specific provided type. (#2694)
|
||||
- Exposed `NetworkVariableSerialization<T>.Read`, `NetworkVariableSerialization<T>.Write`, `NetworkVariableSerialization<T>.AreEqual`, and `NetworkVariableSerialization<T>.Duplicate` to further support the creation of user-created network variables by allowing users to access the generated serialization methods and serialize generic types efficiently without boxing. (#2694)
|
||||
- Added `NetworkVariableBase.MarkNetworkBehaviourDirty` so that user-created network variable types can mark their containing `NetworkBehaviour` to be processed by the update loop. (#2694)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where the server side `NetworkSceneManager` instance was not adding the currently active scene to its list of scenes loaded. (#2723)
|
||||
- Generic NetworkBehaviour types no longer result in compile errors or runtime errors (#2720)
|
||||
- Rpcs within Generic NetworkBehaviour types can now serialize parameters of the class's generic types (but may not have generic types of their own) (#2720)
|
||||
- Errors are no longer thrown when entering play mode with domain reload disabled (#2720)
|
||||
- NetworkSpawn is now correctly called each time when entering play mode with scene reload disabled (#2720)
|
||||
- NetworkVariables of non-integer types will no longer break the inspector (#2714)
|
||||
- NetworkVariables with NonSerializedAttribute will not appear in the inspector (#2714)
|
||||
- Fixed issue where `UnityTransport` would attempt to establish WebSocket connections even if using UDP/DTLS Relay allocations when the build target was WebGL. This only applied to working in the editor since UDP/DTLS can't work in the browser. (#2695)
|
||||
- Fixed issue where a `NetworkBehaviour` component's `OnNetworkDespawn` was not being invoked on the host-server side for an in-scene placed `NetworkObject` when a scene was unloaded (during a scene transition) and the `NetworkBehaviour` component was positioned/ordered before the `NetworkObject` component. (#2685)
|
||||
- Fixed issue where `SpawnWithObservers` was not being honored when `NetworkConfig.EnableSceneManagement` was disabled. (#2682)
|
||||
- Fixed issue where `NetworkAnimator` was not internally tracking changes to layer weights which prevented proper layer weight synchronization back to the original layer weight value. (#2674)
|
||||
- Fixed "writing past the end of the buffer" error when calling ResetDirty() on managed network variables that are larger than 256 bytes when serialized. (#2670)
|
||||
- Fixed issue where generation of the `DefaultNetworkPrefabs` asset was not enabled by default. (#2662)
|
||||
- Fixed issue where the `GlobalObjectIdHash` value could be updated but the asset not marked as dirty. (#2662)
|
||||
- Fixed issue where the `GlobalObjectIdHash` value of a (network) prefab asset could be assigned an incorrect value when editing the prefab in a temporary scene. (#2662)
|
||||
- Fixed issue where the `GlobalObjectIdHash` value generated after creating a (network) prefab from an object constructed within the scene would not be the correct final value in a stand alone build. (#2662)
|
||||
|
||||
### Changed
|
||||
|
||||
- Updated dependency on `com.unity.transport` to version 1.4.0. (#2716)
|
||||
|
||||
## [1.6.0] - 2023-08-09
|
||||
|
||||
### Added
|
||||
|
||||
- Added a protected virtual method `NetworkTransform.OnInitialize(ref NetworkTransformState replicatedState)` that just returns the replicated state reference.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where invoking `NetworkManager.Shutdown` within `NetworkManager.OnClientStopped` or `NetworkManager.OnServerStopped` would force `NetworkManager.ShutdownInProgress` to remain true after completing the shutdown process. (#2661)
|
||||
- Fixed issue where ARMv7 Android builds would crash when trying to validate the batch header. (#2654)
|
||||
- Fixed issue with client synchronization of position when using half precision and the delta position reaches the maximum value and is collapsed on the host prior to being forwarded to the non-owner clients. (#2636)
|
||||
- Fixed issue with scale not synchronizing properly depending upon the spawn order of NetworkObjects. (#2636)
|
||||
- Fixed issue position was not properly transitioning between ownership changes with an owner authoritative NetworkTransform. (#2636)
|
||||
- Fixed issue where a late joining non-owner client could update an owner authoritative NetworkTransform if ownership changed without any updates to position prior to the non-owner client joining. (#2636)
|
||||
|
||||
### Changed
|
||||
|
||||
## [1.5.2] - 2023-07-24
|
||||
|
||||
### 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)
|
||||
- Fixed issue where `NetworkObject.SpawnWithObservers` was not being honored for late joining clients. (#2623)
|
||||
- Fixed issue where invoking `NetworkManager.Shutdown` multiple times, depending upon the timing, could cause an exception. (#2622)
|
||||
- Fixed issue where removing ownership would not notify the server that it gained ownership. This also resolves the issue where an owner authoritative NetworkTransform would not properly initialize upon removing ownership from a remote client. (#2618)
|
||||
- Fixed ILPP issues when using CoreCLR and for certain dedicated server builds. (#2614)
|
||||
- Fixed an ILPP compile error when creating a generic NetworkBehaviour singleton with a static T instance. (#2603)
|
||||
|
||||
### Changed
|
||||
|
||||
## [1.5.1] - 2023-06-07
|
||||
|
||||
### Added
|
||||
|
||||
- Added support for serializing `NativeArray<>` and `NativeList<>` in `FastBufferReader`/`FastBufferWriter`, `BufferSerializer`, `NetworkVariable`, and RPCs. (To use `NativeList<>`, add `UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT` to your Scripting Define Symbols in `Project Settings > Player`) (#2375)
|
||||
- The location of the automatically-created default network prefab list can now be configured (#2544)
|
||||
- Added: Message size limits (max single message and max fragmented message) can now be set using NetworkManager.MaximumTransmissionUnitSize and NetworkManager.MaximumFragmentedMessageSize for transports that don't work with the default values (#2530)
|
||||
- Added `NetworkObject.SpawnWithObservers` property (default is true) that when set to false will spawn a `NetworkObject` with no observers and will not be spawned on any client until `NetworkObject.NetworkShow` is invoked. (#2568)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed: Fixed a null reference in codegen in some projects (#2581)
|
||||
- Fixed issue where the `OnClientDisconnected` client identifier was incorrect after a pending client connection was denied. (#2569)
|
||||
- Fixed warning "Runtime Network Prefabs was not empty at initialization time." being erroneously logged when no runtime network prefabs had been added (#2565)
|
||||
- Fixed issue where some temporary debug console logging was left in a merged PR. (#2562)
|
||||
- Fixed the "Generate Default Network Prefabs List" setting not loading correctly and always reverting to being checked. (#2545)
|
||||
- Fixed issue where users could not use NetworkSceneManager.VerifySceneBeforeLoading to exclude runtime generated scenes from client synchronization. (#2550)
|
||||
- Fixed missing value on `NetworkListEvent` for `EventType.RemoveAt` events. (#2542,#2543)
|
||||
- Fixed issue where parenting a NetworkTransform under a transform with a scale other than Vector3.one would result in incorrect values on non-authoritative instances. (#2538)
|
||||
- Fixed issue where a server would include scene migrated and then despawned NetworkObjects to a client that was being synchronized. (#2532)
|
||||
- Fixed the inspector throwing exceptions when attempting to render `NetworkVariable`s of enum types. (#2529)
|
||||
- Making a `NetworkVariable` with an `INetworkSerializable` type that doesn't meet the `new()` constraint will now create a compile-time error instead of an editor crash (#2528)
|
||||
- Fixed Multiplayer Tools package installation docs page link on the NetworkManager popup. (#2526)
|
||||
- Fixed an exception and error logging when two different objects are shown and hidden on the same frame (#2524)
|
||||
- Fixed a memory leak in `UnityTransport` that occurred if `StartClient` failed. (#2518)
|
||||
- Fixed issue where a client could throw an exception if abruptly disconnected from a network session with one or more spawned `NetworkObject`(s). (#2510)
|
||||
- Fixed issue where invalid endpoint addresses were not being detected and returning false from NGO UnityTransport. (#2496)
|
||||
- Fixed some errors that could occur if a connection is lost and the loss is detected when attempting to write to the socket. (#2495)
|
||||
|
||||
## Changed
|
||||
|
||||
- Adding network prefabs before NetworkManager initialization is now supported. (#2565)
|
||||
- Connecting clients being synchronized now switch to the server's active scene before spawning and synchronizing NetworkObjects. (#2532)
|
||||
- Updated `UnityTransport` dependency on `com.unity.transport` to 1.3.4. (#2533)
|
||||
- Improved performance of NetworkBehaviour initialization by replacing reflection when initializing NetworkVariables with compile-time code generation, which should help reduce hitching during additive scene loads. (#2522)
|
||||
|
||||
## [1.4.0] - 2023-04-10
|
||||
|
||||
### Added
|
||||
|
||||
- Added a way to access the GlobalObjectIdHash via PrefabIdHash for use in the Connection Approval Callback. (#2437)
|
||||
- Added `OnServerStarted` and `OnServerStopped` events that will trigger only on the server (or host player) to notify that the server just started or is no longer active (#2420)
|
||||
- Added `OnClientStarted` and `OnClientStopped` events that will trigger only on the client (or host player) to notify that the client just started or is no longer active (#2420)
|
||||
- Added `NetworkTransform.UseHalfFloatPrecision` property that, when enabled, will use half float values for position, rotation, and scale. This yields a 50% bandwidth savings a the cost of precision. (#2388)
|
||||
- Added `NetworkTransform.UseQuaternionSynchronization` property that, when enabled, will synchronize the entire quaternion. (#2388)
|
||||
- Added `NetworkTransform.UseQuaternionCompression` property that, when enabled, will use a smallest three implementation reducing a full quaternion synchronization update to the size of an unsigned integer. (#2388)
|
||||
- Added `NetworkTransform.SlerpPosition` property that, when enabled along with interpolation being enabled, will interpolate using `Vector3.Slerp`. (#2388)
|
||||
- Added `BufferedLinearInterpolatorVector3` that replaces the float version, is now used by `NetworkTransform`, and provides the ability to enable or disable `Slerp`. (#2388)
|
||||
- Added `HalfVector3` used for scale when half float precision is enabled. (#2388)
|
||||
- Added `HalfVector4` used for rotation when half float precision and quaternion synchronization is enabled. (#2388)
|
||||
- Added `HalfVector3DeltaPosition` used for position when half float precision is enabled. This handles loss in position precision by updating only the delta position as opposed to the full position. (#2388)
|
||||
- Added `NetworkTransform.GetSpaceRelativePosition` and `NetworkTransform.GetSpaceRelativeRotation` helper methods to return the proper values depending upon whether local or world space. (#2388)
|
||||
- Added `NetworkTransform.OnAuthorityPushTransformState` virtual method that is invoked just prior to sending the `NetworkTransformState` to non-authoritative instances. This provides users with the ability to obtain more precise delta values for prediction related calculations. (#2388)
|
||||
- Added `NetworkTransform.OnNetworkTransformStateUpdated` virtual method that is invoked just after the authoritative `NetworkTransformState` is applied. This provides users with the ability to obtain more precise delta values for prediction related calculations. (#2388)
|
||||
- Added `NetworkTransform.OnInitialize`virtual method that is invoked after the `NetworkTransform` has been initialized or re-initialized when ownership changes. This provides for a way to make adjustments when `NetworkTransform` is initialized (i.e. resetting client prediction etc) (#2388)
|
||||
- Added `NetworkObject.SynchronizeTransform` property (default is true) that provides users with another way to help with bandwidth optimizations where, when set to false, the `NetworkObject`'s associated transform will not be included when spawning and/or synchronizing late joining players. (#2388)
|
||||
- Added `NetworkSceneManager.ActiveSceneSynchronizationEnabled` property, disabled by default, that enables client synchronization of server-side active scene changes. (#2383)
|
||||
- Added `NetworkObject.ActiveSceneSynchronization`, disabled by default, that will automatically migrate a `NetworkObject` to a newly assigned active scene. (#2383)
|
||||
- Added `NetworkObject.SceneMigrationSynchronization`, enabled by default, that will synchronize client(s) when a `NetworkObject` is migrated into a new scene on the server side via `SceneManager.MoveGameObjectToScene`. (#2383)
|
||||
|
||||
### Changed
|
||||
|
||||
- Made sure the `CheckObjectVisibility` delegate is checked and applied, upon `NetworkShow` attempt. Found while supporting (#2454), although this is not a fix for this (already fixed) issue. (#2463)
|
||||
- Changed `NetworkTransform` authority handles delta checks on each new network tick and no longer consumes processing cycles checking for deltas for all frames in-between ticks. (#2388)
|
||||
- Changed the `NetworkTransformState` structure is now public and now has public methods that provide access to key properties of the `NetworkTransformState` structure. (#2388)
|
||||
- Changed `NetworkTransform` interpolation adjusts its interpolation "ticks ago" to be 2 ticks latent if it is owner authoritative and the instance is not the server or 1 tick latent if the instance is the server and/or is server authoritative. (#2388)
|
||||
- Updated `NetworkSceneManager` to migrate dynamically spawned `NetworkObject`s with `DestroyWithScene` set to false into the active scene if their current scene is unloaded. (#2383)
|
||||
- Updated the server to synchronize its local `NetworkSceneManager.ClientSynchronizationMode` during the initial client synchronization. (#2383)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where during client synchronization the synchronizing client could receive a ObjectSceneChanged message before the client-side NetworkObject instance had been instantiated and spawned. (#2502)
|
||||
- Fixed issue where `NetworkAnimator` was building client RPC parameters to exclude the host from sending itself messages but was not including it in the ClientRpc parameters. (#2492)
|
||||
- Fixed issue where `NetworkAnimator` was not properly detecting and synchronizing cross fade initiated transitions. (#2481)
|
||||
- Fixed issue where `NetworkAnimator` was not properly synchronizing animation state updates. (#2481)
|
||||
- Fixed float NetworkVariables not being rendered properly in the inspector of NetworkObjects. (#2441)
|
||||
- Fixed an issue where Named Message Handlers could remove themselves causing an exception when the metrics tried to access the name of the message.(#2426)
|
||||
- Fixed registry of public `NetworkVariable`s in derived `NetworkBehaviour`s (#2423)
|
||||
- Fixed issue where runtime association of `Animator` properties to `AnimationCurve`s would cause `NetworkAnimator` to attempt to update those changes. (#2416)
|
||||
- Fixed issue where `NetworkAnimator` would not check if its associated `Animator` was valid during serialization and would spam exceptions in the editor console. (#2416)
|
||||
- Fixed issue with a child's rotation rolling over when interpolation is enabled on a `NetworkTransform`. Now using half precision or full quaternion synchronization will always update all axis. (#2388)
|
||||
- Fixed issue where `NetworkTransform` was not setting the teleport flag when the `NetworkTransform.InLocalSpace` value changed. This issue only impacted `NetworkTransform` when interpolation was enabled. (#2388)
|
||||
- Fixed issue when the `NetworkSceneManager.ClientSynchronizationMode` is `LoadSceneMode.Additive` and the server changes the currently active scene prior to a client connecting then upon a client connecting and being synchronized the NetworkSceneManager would clear its internal ScenePlacedObjects list that could already be populated. (#2383)
|
||||
- Fixed issue where a client would load duplicate scenes of already preloaded scenes during the initial client synchronization and `NetworkSceneManager.ClientSynchronizationMode` was set to `LoadSceneMode.Additive`. (#2383)
|
||||
|
||||
## [1.3.1] - 2023-03-27
|
||||
|
||||
### Added
|
||||
|
||||
- Added detection and graceful handling of corrupt packets for additional safety. (#2419)
|
||||
|
||||
### Changed
|
||||
|
||||
- The UTP component UI has been updated to be more user-friendly for new users by adding a simple toggle to switch between local-only (127.0.0.1) and remote (0.0.0.0) binding modes, using the toggle "Allow Remote Connections" (#2408)
|
||||
- Updated `UnityTransport` dependency on `com.unity.transport` to 1.3.3. (#2450)
|
||||
- `NetworkShow()` of `NetworkObject`s are delayed until the end of the frame to ensure consistency of delta-driven variables like `NetworkList`.
|
||||
- Dirty `NetworkObject` are reset at end-of-frame and not at serialization time.
|
||||
- `NetworkHide()` of an object that was just `NetworkShow()`n produces a warning, as remote clients will _not_ get a spawn/despawn pair.
|
||||
- Renamed the NetworkTransform.SetState parameter `shouldGhostsInterpolate` to `teleportDisabled` for better clarity of what that parameter does. (#2228)
|
||||
- Network prefabs are now stored in a ScriptableObject that can be shared between NetworkManagers, and have been exposed for public access. By default, a Default Prefabs List is created that contains all NetworkObject prefabs in the project, and new NetworkManagers will default to using that unless that option is turned off in the Netcode for GameObjects settings. Existing NetworkManagers will maintain their existing lists, which can be migrated to the new format via a button in their inspector. (#2322)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where changes to a layer's weight would not synchronize unless a state transition was occurring.(#2399)
|
||||
- Fixed issue where `NetworkManager.LocalClientId` was returning the `NetworkTransport.ServerClientId` as opposed to the `NetworkManager.m_LocalClientId`. (#2398)
|
||||
- Fixed issue where a dynamically spawned `NetworkObject` parented under an in-scene placed `NetworkObject` would have its `InScenePlaced` value changed to `true`. This would result in a soft synchronization error for late joining clients. (#2396)
|
||||
- Fixed a UTP test that was failing when you install Unity Transport package 2.0.0 or newer. (#2347)
|
||||
- Fixed issue where `NetcodeSettingsProvider` would throw an exception in Unity 2020.3.x versions. (#2345)
|
||||
- Fixed server side issue where, depending upon component ordering, some NetworkBehaviour components might not have their OnNetworkDespawn method invoked if the client side disconnected. (#2323)
|
||||
- Fixed a case where data corruption could occur when using UnityTransport when reaching a certain level of send throughput. (#2332)
|
||||
- Fixed an issue in `UnityTransport` where an exception would be thrown if starting a Relay host/server on WebGL. This exception should only be thrown if using direct connections (where WebGL can't act as a host/server). (#2321)
|
||||
- Fixed `NetworkAnimator` issue where it was not checking for `AnimatorStateTtansition.destinationStateMachine` and any possible sub-states defined within it. (#2309)
|
||||
- Fixed `NetworkAnimator` issue where the host client was receiving the ClientRpc animation updates when the host was the owner.(#2309)
|
||||
- Fixed `NetworkAnimator` issue with using pooled objects and when specific properties are cleaned during despawn and destroy.(#2309)
|
||||
- Fixed issue where `NetworkAnimator` was checking for animation changes when the associated `NetworkObject` was not spawned.(#2309)
|
||||
- Corrected an issue with the documentation for BufferSerializer (#2401)
|
||||
|
||||
## [1.2.0] - 2022-11-21
|
||||
|
||||
### Added
|
||||
@@ -22,7 +297,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
|
||||
- Optimized bandwidth usage by encoding most integer fields using variable-length encoding. (#2276)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed `IsSpawnedObjectsPendingInDontDestroyOnLoad` is only set to true when loading a scene using `LoadSceneMode.Singleonly`. (#2330)
|
||||
- Fixed issue where `NetworkTransform` components nested under a parent with a `NetworkObject` component (i.e. network prefab) would not have their associated `GameObject`'s transform synchronized. (#2298)
|
||||
- Fixed issue where `NetworkObject`s that failed to instantiate could cause the entire synchronization pipeline to be disrupted/halted for a connecting client. (#2298)
|
||||
- Fixed issue where in-scene placed `NetworkObject`s nested under a `GameObject` would be added to the orphaned children list causing continual console warning log messages. (#2298)
|
||||
|
||||
500
Components/AnticipatedNetworkTransform.cs
Normal file
500
Components/AnticipatedNetworkTransform.cs
Normal file
@@ -0,0 +1,500 @@
|
||||
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")]
|
||||
[DefaultExecutionOrder(100000)] // this is needed to catch the update time after the transform was updated by user scripts
|
||||
public class AnticipatedNetworkTransform : NetworkTransform
|
||||
{
|
||||
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 double m_LastAnticipationTime;
|
||||
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_LastAnticipationTime = NetworkManager.LocalTime.Time;
|
||||
|
||||
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_LastAnticipationTime = NetworkManager.LocalTime.Time;
|
||||
|
||||
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_LastAnticipationTime = NetworkManager.LocalTime.Time;
|
||||
|
||||
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_LastAnticipaionCounter = NetworkManager.AnticipationSystem.AnticipationCounter;
|
||||
m_LastAnticipationTime = NetworkManager.LocalTime.Time;
|
||||
|
||||
m_SmoothDuration = 0;
|
||||
m_CurrentSmoothTime = 0;
|
||||
}
|
||||
|
||||
protected override void Update()
|
||||
{
|
||||
// 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
|
||||
// Update()
|
||||
//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 NetworkBehaviour.Update
|
||||
}
|
||||
|
||||
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()
|
||||
{
|
||||
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);
|
||||
}
|
||||
}
|
||||
}
|
||||
3
Components/AnticipatedNetworkTransform.cs.meta
Normal file
3
Components/AnticipatedNetworkTransform.cs.meta
Normal file
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 97616b67982a4be48d957d421e422433
|
||||
timeCreated: 1705597211
|
||||
@@ -1,10 +1,15 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
|
||||
#if UNITY_EDITOR
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.EditorTests")]
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Editor.CodeGen")]
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Editor")]
|
||||
[assembly: InternalsVisibleTo("TestProject.EditorTests")]
|
||||
[assembly: InternalsVisibleTo("TestProject.RuntimeTests")]
|
||||
#endif
|
||||
[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
|
||||
|
||||
170
Components/HalfVector3.cs
Normal file
170
Components/HalfVector3.cs
Normal file
@@ -0,0 +1,170 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
using Unity.Mathematics;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
/// <summary>
|
||||
/// 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
|
||||
/// 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>
|
||||
public struct HalfVector3 : INetworkSerializable
|
||||
{
|
||||
internal const int Length = 3;
|
||||
|
||||
/// <summary>
|
||||
/// The half float precision value of the x-axis as a <see cref="half"/>.
|
||||
/// </summary>
|
||||
public half X => Axis.x;
|
||||
/// <summary>
|
||||
/// The half float precision value of the y-axis as a <see cref="half"/>.
|
||||
/// </summary>
|
||||
public half Y => Axis.y;
|
||||
/// <summary>
|
||||
/// The half float precision value of the z-axis as a <see cref="half"/>.
|
||||
/// </summary>
|
||||
public half Z => Axis.z;
|
||||
|
||||
/// <summary>
|
||||
/// Used to store the half float precision values as a <see cref="half3"/>
|
||||
/// </summary>
|
||||
public half3 Axis;
|
||||
|
||||
/// <summary>
|
||||
/// Determine which axis will be synchronized during serialization
|
||||
/// </summary>
|
||||
public bool3 AxisToSynchronize;
|
||||
|
||||
/// <summary>
|
||||
/// Directly sets each axial value to the passed in full precision values
|
||||
/// that are converted to half precision
|
||||
/// </summary>
|
||||
internal void Set(float x, float y, float z)
|
||||
{
|
||||
Axis.x = math.half(x);
|
||||
Axis.y = math.half(y);
|
||||
Axis.z = math.half(z);
|
||||
}
|
||||
|
||||
private void SerializeWrite(FastBufferWriter writer)
|
||||
{
|
||||
for (int i = 0; i < Length; i++)
|
||||
{
|
||||
if (AxisToSynchronize[i])
|
||||
{
|
||||
writer.WriteUnmanagedSafe(Axis[i]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void SerializeRead(FastBufferReader reader)
|
||||
{
|
||||
for (int i = 0; i < Length; i++)
|
||||
{
|
||||
if (AxisToSynchronize[i])
|
||||
{
|
||||
var axisValue = Axis[i];
|
||||
reader.ReadUnmanagedSafe(out axisValue);
|
||||
Axis[i] = axisValue;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The serialization implementation of <see cref="INetworkSerializable"/>.
|
||||
/// </summary>
|
||||
public void NetworkSerialize<T>(BufferSerializer<T> serializer) where T : IReaderWriter
|
||||
{
|
||||
if (serializer.IsReader)
|
||||
{
|
||||
SerializeRead(serializer.GetFastBufferReader());
|
||||
}
|
||||
else
|
||||
{
|
||||
SerializeWrite(serializer.GetFastBufferWriter());
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the full precision value as a <see cref="Vector3"/>.
|
||||
/// </summary>
|
||||
/// <returns>a <see cref="Vector3"/> as the full precision value.</returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector3 ToVector3()
|
||||
{
|
||||
Vector3 fullPrecision = Vector3.zero;
|
||||
Vector3 fullConversion = math.float3(Axis);
|
||||
for (int i = 0; i < Length; i++)
|
||||
{
|
||||
if (AxisToSynchronize[i])
|
||||
{
|
||||
fullPrecision[i] = fullConversion[i];
|
||||
}
|
||||
}
|
||||
return fullPrecision;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Converts a full precision <see cref="Vector3"/> to half precision and updates the current instance.
|
||||
/// </summary>
|
||||
/// <param name="vector3">The <see cref="Vector3"/> to convert.</param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void UpdateFrom(ref Vector3 vector3)
|
||||
{
|
||||
var half3Full = math.half3(vector3);
|
||||
for (int i = 0; i < Length; i++)
|
||||
{
|
||||
if (AxisToSynchronize[i])
|
||||
{
|
||||
Axis[i] = half3Full[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="vector3">The initial axial values (converted to half floats) when instantiated.</param>
|
||||
/// <param name="vector3AxisToSynchronize">The axis to synchronize.</param>
|
||||
public HalfVector3(Vector3 vector3, bool3 axisToSynchronize)
|
||||
{
|
||||
Axis = half3.zero;
|
||||
AxisToSynchronize = axisToSynchronize;
|
||||
UpdateFrom(ref vector3);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor that defaults to all axis being synchronized.
|
||||
/// </summary>
|
||||
/// <param name="vector3">The initial axial values (converted to half floats) when instantiated.</param>
|
||||
public HalfVector3(Vector3 vector3) : this(vector3, math.bool3(true))
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="x">The initial x axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="y">The initial y axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="z">The initial z axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="axisToSynchronize">The axis to synchronize.</param>
|
||||
public HalfVector3(float x, float y, float z, bool3 axisToSynchronize) : this(new Vector3(x, y, z), axisToSynchronize)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor that defaults to all axis being synchronized.
|
||||
/// </summary>
|
||||
/// <param name="x">The initial x axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="y">The initial y axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="z">The initial z axis (converted to half float) value when instantiated.</param>
|
||||
public HalfVector3(float x, float y, float z) : this(new Vector3(x, y, z), math.bool3(true))
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Components/HalfVector3.cs.meta
Normal file
11
Components/HalfVector3.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: b0e371533eaeac446b16b10886f64f84
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
137
Components/HalfVector4.cs
Normal file
137
Components/HalfVector4.cs
Normal file
@@ -0,0 +1,137 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
using Unity.Mathematics;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
/// <summary>
|
||||
/// 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
|
||||
/// 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>
|
||||
public struct HalfVector4 : INetworkSerializable
|
||||
{
|
||||
internal const int Length = 4;
|
||||
/// <summary>
|
||||
/// The half float precision value of the x-axis as a <see cref="half"/>.
|
||||
/// </summary>
|
||||
public half X => Axis.x;
|
||||
|
||||
/// <summary>
|
||||
/// The half float precision value of the y-axis as a <see cref="half"/>.
|
||||
/// </summary>
|
||||
public half Y => Axis.y;
|
||||
|
||||
/// <summary>
|
||||
/// The half float precision value of the z-axis as a <see cref="half"/>.
|
||||
/// </summary>
|
||||
public half Z => Axis.z;
|
||||
|
||||
/// <summary>
|
||||
/// The half float precision value of the w-axis as a <see cref="half"/>.
|
||||
/// </summary>
|
||||
public half W => Axis.w;
|
||||
|
||||
/// <summary>
|
||||
/// Used to store the half float precision values as a <see cref="half4"/>
|
||||
/// </summary>
|
||||
public half4 Axis;
|
||||
|
||||
private void SerializeWrite(FastBufferWriter writer)
|
||||
{
|
||||
for (int i = 0; i < Length; i++)
|
||||
{
|
||||
writer.WriteUnmanagedSafe(Axis[i]);
|
||||
}
|
||||
}
|
||||
|
||||
private void SerializeRead(FastBufferReader reader)
|
||||
{
|
||||
for (int i = 0; i < Length; i++)
|
||||
{
|
||||
var axisValue = Axis[i];
|
||||
reader.ReadUnmanagedSafe(out axisValue);
|
||||
Axis[i] = axisValue;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The serialization implementation of <see cref="INetworkSerializable"/>.
|
||||
/// </summary>
|
||||
public void NetworkSerialize<T>(BufferSerializer<T> serializer) where T : IReaderWriter
|
||||
{
|
||||
if (serializer.IsReader)
|
||||
{
|
||||
SerializeRead(serializer.GetFastBufferReader());
|
||||
}
|
||||
else
|
||||
{
|
||||
SerializeWrite(serializer.GetFastBufferWriter());
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Converts this instance to a full precision <see cref="Vector4"/>.
|
||||
/// </summary>
|
||||
/// <returns>A <see cref="Vector4"/> as the full precision value.</returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector4 ToVector4()
|
||||
{
|
||||
return math.float4(Axis);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Converts this instance to a full precision <see cref="Quaternion"/>.
|
||||
/// </summary>
|
||||
/// <returns>A <see cref="Quaternion"/> as the full precision value.</returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Quaternion ToQuaternion()
|
||||
{
|
||||
return math.quaternion(Axis);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Converts a full precision <see cref="Vector4"/> to half precision and updates the current instance.
|
||||
/// </summary>
|
||||
/// <param name="vector4">The <see cref="Vector4"/> to convert and update this instance with.</param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void UpdateFrom(ref Vector4 vector4)
|
||||
{
|
||||
Axis = math.half4(vector4);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Converts a full precision <see cref="Vector4"/> to half precision and updates the current instance.
|
||||
/// </summary>
|
||||
/// <param name="quaternion">The <see cref="Quaternion"/> to convert and update this instance with.</param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void UpdateFrom(ref Quaternion quaternion)
|
||||
{
|
||||
Axis = math.half4(math.half(quaternion.x), math.half(quaternion.y), math.half(quaternion.z), math.half(quaternion.w));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="vector4">The initial axial values (converted to half floats) when instantiated.</param>
|
||||
public HalfVector4(Vector4 vector4)
|
||||
{
|
||||
Axis = default;
|
||||
UpdateFrom(ref vector4);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="x">The initial x axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="y">The initial y axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="z">The initial z axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="w">The initial w axis (converted to half float) value when instantiated.</param>
|
||||
public HalfVector4(float x, float y, float z, float w) : this(new Vector4(x, y, z, w))
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Components/HalfVector4.cs.meta
Normal file
11
Components/HalfVector4.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 03c78136f41ff84499e2a6ac4a7dd7a5
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -312,20 +312,79 @@ namespace Unity.Netcode
|
||||
/// </remarks>
|
||||
public class BufferedLinearInterpolatorQuaternion : BufferedLinearInterpolator<Quaternion>
|
||||
{
|
||||
/// <summary>
|
||||
/// Use <see cref="Quaternion.Slerp"/> when <see cref="true"/>.
|
||||
/// Use <see cref="Quaternion.Lerp"/> when <see cref="false"/>
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// When using half precision (due to the imprecision) using <see cref="Quaternion.Lerp"/> is
|
||||
/// less processor intensive (i.e. precision is already "imprecise").
|
||||
/// When using full precision (to maintain precision) using <see cref="Quaternion.Slerp"/> is
|
||||
/// more processor intensive yet yields more precise results.
|
||||
/// </remarks>
|
||||
public bool IsSlerp;
|
||||
|
||||
/// <inheritdoc />
|
||||
protected override Quaternion InterpolateUnclamped(Quaternion start, Quaternion end, float time)
|
||||
{
|
||||
// Disabling Extrapolation:
|
||||
// TODO: Add Jira Ticket
|
||||
return Quaternion.Slerp(start, end, time);
|
||||
if (IsSlerp)
|
||||
{
|
||||
return Quaternion.Slerp(start, end, time);
|
||||
}
|
||||
else
|
||||
{
|
||||
return Quaternion.Lerp(start, end, time);
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
protected override Quaternion Interpolate(Quaternion start, Quaternion end, float time)
|
||||
{
|
||||
// Disabling Extrapolation:
|
||||
// TODO: Add Jira Ticket
|
||||
return Quaternion.Slerp(start, end, time);
|
||||
if (IsSlerp)
|
||||
{
|
||||
return Quaternion.Slerp(start, end, time);
|
||||
}
|
||||
else
|
||||
{
|
||||
return Quaternion.Lerp(start, end, time);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A <see cref="BufferedLinearInterpolator<T>"/> <see cref="Vector3"/> implementation.
|
||||
/// </summary>
|
||||
public class BufferedLinearInterpolatorVector3 : BufferedLinearInterpolator<Vector3>
|
||||
{
|
||||
/// <summary>
|
||||
/// Use <see cref="Vector3.Slerp"/> when <see cref="true"/>.
|
||||
/// Use <see cref="Vector3.Lerp"/> when <see cref="false"/>
|
||||
/// </summary>
|
||||
public bool IsSlerp;
|
||||
/// <inheritdoc />
|
||||
protected override Vector3 InterpolateUnclamped(Vector3 start, Vector3 end, float time)
|
||||
{
|
||||
if (IsSlerp)
|
||||
{
|
||||
return Vector3.Slerp(start, end, time);
|
||||
}
|
||||
else
|
||||
{
|
||||
return Vector3.Lerp(start, end, time);
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
protected override Vector3 Interpolate(Vector3 start, Vector3 end, float time)
|
||||
{
|
||||
if (IsSlerp)
|
||||
{
|
||||
return Vector3.Slerp(start, end, time);
|
||||
}
|
||||
else
|
||||
{
|
||||
return Vector3.Lerp(start, end, time);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
8
Components/Messages.meta
Normal file
8
Components/Messages.meta
Normal file
@@ -0,0 +1,8 @@
|
||||
fileFormatVersion: 2
|
||||
guid: a9db1d18fa0117f4da5e8e65386b894a
|
||||
folderAsset: yes
|
||||
DefaultImporter:
|
||||
externalObjects: {}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
116
Components/Messages/NetworkTransformMessage.cs
Normal file
116
Components/Messages/NetworkTransformMessage.cs
Normal file
@@ -0,0 +1,116 @@
|
||||
using Unity.Netcode.Components;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// NetworkTransform State Update Message
|
||||
/// </summary>
|
||||
internal struct NetworkTransformMessage : INetworkMessage
|
||||
{
|
||||
public int Version => 0;
|
||||
public ulong NetworkObjectId;
|
||||
public int NetworkBehaviourId;
|
||||
public NetworkTransform.NetworkTransformState State;
|
||||
|
||||
private NetworkTransform m_ReceiverNetworkTransform;
|
||||
private FastBufferReader m_CurrentReader;
|
||||
|
||||
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
|
||||
{
|
||||
BytePacker.WriteValueBitPacked(writer, NetworkObjectId);
|
||||
BytePacker.WriteValueBitPacked(writer, NetworkBehaviourId);
|
||||
writer.WriteNetworkSerializable(State);
|
||||
}
|
||||
}
|
||||
|
||||
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;
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out NetworkObjectId);
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.ContainsKey(NetworkObjectId))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context);
|
||||
return false;
|
||||
}
|
||||
// Get the behaviour index
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out NetworkBehaviourId);
|
||||
|
||||
// Deserialize the state
|
||||
reader.ReadNetworkSerializable(out State);
|
||||
|
||||
var networkObject = networkManager.SpawnManager.SpawnedObjects[NetworkObjectId];
|
||||
|
||||
// Get the target NetworkTransform
|
||||
m_ReceiverNetworkTransform = networkObject.ChildNetworkBehaviours[NetworkBehaviourId] as NetworkTransform;
|
||||
|
||||
var isServerAuthoritative = m_ReceiverNetworkTransform.IsServerAuthoritative();
|
||||
var ownerAuthoritativeServerSide = !isServerAuthoritative && networkManager.IsServer;
|
||||
if (ownerAuthoritativeServerSide)
|
||||
{
|
||||
var 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;
|
||||
}
|
||||
|
||||
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))
|
||||
{
|
||||
// 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
|
||||
var clientCount = networkManager.ConnectionManager.ConnectedClientsList.Count;
|
||||
for (int i = 0; i < clientCount; i++)
|
||||
{
|
||||
var clientId = networkManager.ConnectionManager.ConnectedClientsList[i].ClientId;
|
||||
if (NetworkManager.ServerClientId == clientId || (!isServerAuthoritative && clientId == ownerClientId) || !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)
|
||||
{
|
||||
if (m_ReceiverNetworkTransform == null)
|
||||
{
|
||||
Debug.LogError($"[{nameof(NetworkTransformMessage)}][Dropped] Reciever {nameof(NetworkTransform)} was not set!");
|
||||
return;
|
||||
}
|
||||
m_ReceiverNetworkTransform.TransformStateUpdate(ref State);
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Components/Messages/NetworkTransformMessage.cs.meta
Normal file
11
Components/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:
|
||||
File diff suppressed because it is too large
Load Diff
217
Components/NetworkDeltaPosition.cs
Normal file
217
Components/NetworkDeltaPosition.cs
Normal file
@@ -0,0 +1,217 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
using Unity.Mathematics;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Components
|
||||
{
|
||||
/// <summary>
|
||||
/// Used to synchromnize delta position when half float precision is enabled
|
||||
/// </summary>
|
||||
public struct NetworkDeltaPosition : INetworkSerializable
|
||||
{
|
||||
internal const float MaxDeltaBeforeAdjustment = 64f;
|
||||
|
||||
/// <summary>
|
||||
/// The HalfVector3 used to synchronize the delta in position
|
||||
/// </summary>
|
||||
public HalfVector3 HalfVector3;
|
||||
|
||||
internal Vector3 CurrentBasePosition;
|
||||
internal Vector3 PrecisionLossDelta;
|
||||
internal Vector3 HalfDeltaConvertedBack;
|
||||
internal Vector3 PreviousPosition;
|
||||
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)
|
||||
{
|
||||
serializer.SerializeValue(ref CurrentBasePosition);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the full precision value of Vector3 position while also potentially updating the current base position.
|
||||
/// </summary>
|
||||
/// <param name="networkTick">Use the current network tick value.</param>
|
||||
/// <returns>The full position as a <see cref="Vector3"/>.</returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector3 ToVector3(int networkTick)
|
||||
{
|
||||
// When synchronizing, it is possible to have a state update arrive
|
||||
// for the same synchronization network tick. Under this scenario,
|
||||
// we only want to return the existing CurrentBasePosition + DeltaPosition
|
||||
// values and not process the X, Y, or Z values.
|
||||
// (See the constructors below)
|
||||
if (networkTick == NetworkTick)
|
||||
{
|
||||
return CurrentBasePosition + DeltaPosition;
|
||||
}
|
||||
for (int i = 0; i < HalfVector3.Length; i++)
|
||||
{
|
||||
if (HalfVector3.AxisToSynchronize[i])
|
||||
{
|
||||
DeltaPosition[i] = Mathf.HalfToFloat(HalfVector3.Axis[i].value);
|
||||
// If we exceed or are equal to the maximum delta value then we need to
|
||||
// apply the delta to the CurrentBasePosition value and reset the delta
|
||||
// position for the axis.
|
||||
if (Mathf.Abs(DeltaPosition[i]) >= MaxDeltaBeforeAdjustment)
|
||||
{
|
||||
CurrentBasePosition[i] += DeltaPosition[i];
|
||||
DeltaPosition[i] = 0.0f;
|
||||
HalfVector3.Axis[i] = half.zero;
|
||||
}
|
||||
}
|
||||
}
|
||||
return CurrentBasePosition + DeltaPosition;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the current base position (excluding the delta position offset).
|
||||
/// </summary>
|
||||
/// <returns>The current base position as a <see cref="Vector3"/></returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector3 GetCurrentBasePosition()
|
||||
{
|
||||
return CurrentBasePosition;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the full position which includes the delta offset position.
|
||||
/// </summary>
|
||||
/// <returns>The full position as a <see cref="Vector3"/>.</returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector3 GetFullPosition()
|
||||
{
|
||||
return CurrentBasePosition + DeltaPosition;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The half float vector3 version of the current delta position.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Only applies to the authoritative side for <see cref="NetworkTransform"/> instances.
|
||||
/// </remarks>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector3 GetConvertedDelta()
|
||||
{
|
||||
return HalfDeltaConvertedBack;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The full precision current delta position.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Authoritative: Will have no precision loss
|
||||
/// Non-Authoritative: Has the current network tick's loss of precision.
|
||||
/// Precision loss adjustments are one network tick behind on the
|
||||
/// non-authoritative side.
|
||||
/// </remarks>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public Vector3 GetDeltaPosition()
|
||||
{
|
||||
return DeltaPosition;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Updates the position delta based off of the current base position.
|
||||
/// </summary>
|
||||
/// <param name="vector3">The full precision <see cref="Vector3"/> value to (converted to half floats) used to determine the delta offset positon.</param>
|
||||
/// <param name="networkTick">Set the current network tick value when updating.</param>
|
||||
[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++)
|
||||
{
|
||||
if (HalfVector3.AxisToSynchronize[i])
|
||||
{
|
||||
HalfVector3.Axis[i] = math.half(DeltaPosition[i]);
|
||||
HalfDeltaConvertedBack[i] = Mathf.HalfToFloat(HalfVector3.Axis[i].value);
|
||||
PrecisionLossDelta[i] = DeltaPosition[i] - HalfDeltaConvertedBack[i];
|
||||
if (Mathf.Abs(HalfDeltaConvertedBack[i]) >= MaxDeltaBeforeAdjustment)
|
||||
{
|
||||
CurrentBasePosition[i] += HalfDeltaConvertedBack[i];
|
||||
HalfDeltaConvertedBack[i] = 0.0f;
|
||||
DeltaPosition[i] = 0.0f;
|
||||
CollapsedDeltaIntoBase = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for (int i = 0; i < HalfVector3.Length; i++)
|
||||
{
|
||||
if (HalfVector3.AxisToSynchronize[i])
|
||||
{
|
||||
PreviousPosition[i] = vector3[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="vector3">The initial axial values (converted to half floats) when instantiated.</param>
|
||||
/// <param name="networkTick">Set the network tick value to the current network tick when instantiating.</param>
|
||||
/// <param name="axisToSynchronize">The axis to be synchronized.</param>
|
||||
public NetworkDeltaPosition(Vector3 vector3, int networkTick, bool3 axisToSynchronize)
|
||||
{
|
||||
NetworkTick = networkTick;
|
||||
CurrentBasePosition = vector3;
|
||||
PreviousPosition = vector3;
|
||||
PrecisionLossDelta = Vector3.zero;
|
||||
DeltaPosition = Vector3.zero;
|
||||
HalfDeltaConvertedBack = Vector3.zero;
|
||||
HalfVector3 = new HalfVector3(vector3, axisToSynchronize);
|
||||
SynchronizeBase = false;
|
||||
CollapsedDeltaIntoBase = false;
|
||||
UpdateFrom(ref vector3, networkTick);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor that defaults to all axis being synchronized.
|
||||
/// </summary>
|
||||
/// <param name="vector3">The initial axial values (converted to half floats) when instantiated.</param>
|
||||
/// <param name="networkTick">Set the network tick value to the current network tick when instantiating.</param>
|
||||
public NetworkDeltaPosition(Vector3 vector3, int networkTick) : this(vector3, networkTick, math.bool3(true))
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="x">The initial x axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="y">The initial y axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="z">The initial z axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="networkTick">Set the network tick value to the current network tick when instantiating.</param>
|
||||
/// <param name="axisToSynchronize">The axis to be synchronized.</param>
|
||||
public NetworkDeltaPosition(float x, float y, float z, int networkTick, bool3 axisToSynchronize) :
|
||||
this(new Vector3(x, y, z), networkTick, axisToSynchronize)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="x">The initial x axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="y">The initial y axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="z">The initial z axis (converted to half float) value when instantiated.</param>
|
||||
/// <param name="networkTick">Set the network tick value to the current network tick when instantiating.</param>
|
||||
public NetworkDeltaPosition(float x, float y, float z, int networkTick) :
|
||||
this(new Vector3(x, y, z), networkTick, math.bool3(true))
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Components/NetworkDeltaPosition.cs.meta
Normal file
11
Components/NetworkDeltaPosition.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: e45e6886578116f4c92fa0fe0d77fb85
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -29,15 +29,25 @@ namespace Unity.Netcode.Components
|
||||
m_NetworkTransform = GetComponent<NetworkTransform>();
|
||||
m_IsServerAuthoritative = m_NetworkTransform.IsServerAuthoritative();
|
||||
|
||||
SetupRigidBody();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// If the current <see cref="NetworkTransform"/> has authority,
|
||||
/// then use the <see cref="RigidBody"/> interpolation strategy,
|
||||
/// if the <see cref="NetworkTransform"/> is handling interpolation,
|
||||
/// set interpolation to none on the <see cref="RigidBody"/>
|
||||
/// <br/>
|
||||
/// Turn off physics for the rigid body until spawned, otherwise
|
||||
/// clients can run fixed update before the first
|
||||
/// full <see cref="NetworkTransform"/> update
|
||||
/// </summary>
|
||||
private void SetupRigidBody()
|
||||
{
|
||||
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.interpolation = m_IsAuthority ? m_OriginalInterpolation : (m_NetworkTransform.Interpolate ? RigidbodyInterpolation.None : m_OriginalInterpolation);
|
||||
m_Rigidbody.isKinematic = true;
|
||||
}
|
||||
|
||||
|
||||
@@ -30,6 +30,11 @@ namespace Unity.Netcode.Components
|
||||
{
|
||||
m_Rigidbody = GetComponent<Rigidbody2D>();
|
||||
m_NetworkTransform = GetComponent<NetworkTransform>();
|
||||
|
||||
// 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;
|
||||
}
|
||||
|
||||
private void FixedUpdate()
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
123
Components/QuaternionCompressor.cs
Normal file
123
Components/QuaternionCompressor.cs
Normal file
@@ -0,0 +1,123 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// A Smallest Three Quaternion Compressor Implementation
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Explanation of why "The smallest three":
|
||||
/// Since a normalized Quaternion's unit value is 1.0f:
|
||||
/// x*x + y*y + z*z + w*w = M*M (where M is the magnitude of the vector)
|
||||
/// If w was the largest value and the quaternion is normalized:
|
||||
/// 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.
|
||||
/// </remarks>
|
||||
public static class QuaternionCompressor
|
||||
{
|
||||
private const ushort k_PrecisionMask = (1 << 9) - 1;
|
||||
|
||||
// Square root of 2 over 2 (Mathf.Sqrt(2.0f) / 2.0f == 1.0f / Mathf.Sqrt(2.0f))
|
||||
// This provides encoding the smallest three components into a (+/-) Mathf.Sqrt(2.0f) / 2.0f range
|
||||
private const float k_SqrtTwoOverTwoEncoding = 0.70710678118654752440084436210485f;
|
||||
|
||||
// We can further improve the encoding compression by dividing k_SqrtTwoOverTwo into 1.0f and multiplying that
|
||||
// by the precision mask (minor reduction of runtime calculations)
|
||||
private const float k_CompressionEcodingMask = (1.0f / k_SqrtTwoOverTwoEncoding) * k_PrecisionMask;
|
||||
|
||||
// Used to shift the negative bit to the 10th bit position when compressing and encoding
|
||||
private const ushort k_ShiftNegativeBit = 9;
|
||||
|
||||
// We can do the same for our decoding and decompression by dividing k_PrecisionMask into 1.0 and multiplying
|
||||
// that by k_SqrtTwoOverTwo (minor reduction of runtime calculations)
|
||||
private const float k_DcompressionDecodingMask = (1.0f / k_PrecisionMask) * k_SqrtTwoOverTwoEncoding;
|
||||
|
||||
// The sign bit position (10th bit) used when decompressing and decoding
|
||||
private const ushort k_NegShortBit = 0x200;
|
||||
|
||||
// Negative bit set values
|
||||
private const ushort k_True = 1;
|
||||
private const ushort k_False = 0;
|
||||
|
||||
// Used to store the absolute value of the 4 quaternion elements
|
||||
private static Quaternion s_QuatAbsValues = Quaternion.identity;
|
||||
|
||||
/// <summary>
|
||||
/// Compresses a Quaternion into an unsigned integer
|
||||
/// </summary>
|
||||
/// <param name="quaternion">the <see cref="Quaternion"/> to be compressed</param>
|
||||
/// <returns>the <see cref="Quaternion"/> compressed as an unsigned integer</returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static uint CompressQuaternion(ref Quaternion quaternion)
|
||||
{
|
||||
// Store off the absolute value for each Quaternion element
|
||||
s_QuatAbsValues[0] = Mathf.Abs(quaternion[0]);
|
||||
s_QuatAbsValues[1] = Mathf.Abs(quaternion[1]);
|
||||
s_QuatAbsValues[2] = Mathf.Abs(quaternion[2]);
|
||||
s_QuatAbsValues[3] = Mathf.Abs(quaternion[3]);
|
||||
|
||||
// Get the largest element value of the quaternion to know what the remaining "Smallest Three" values are
|
||||
var quatMax = Mathf.Max(s_QuatAbsValues[0], s_QuatAbsValues[1], s_QuatAbsValues[2], s_QuatAbsValues[3]);
|
||||
|
||||
// Find the index of the largest element so we can skip that element while compressing and decompressing
|
||||
var indexToSkip = (ushort)(s_QuatAbsValues[0] == quatMax ? 0 : s_QuatAbsValues[1] == quatMax ? 1 : s_QuatAbsValues[2] == quatMax ? 2 : 3);
|
||||
|
||||
// Get the sign of the largest element which is all that is needed when calculating the sum of squares of a normalized quaternion.
|
||||
|
||||
var quatMaxSign = (quaternion[indexToSkip] < 0 ? k_True : k_False);
|
||||
|
||||
// Start with the index to skip which will be shifted to the highest two bits
|
||||
var compressed = (uint)indexToSkip;
|
||||
|
||||
// Step 1: Start with the first element
|
||||
var currentIndex = 0;
|
||||
|
||||
// Step 2: If we are on the index to skip preserve the current compressed value, otherwise proceed to step 3 and 4
|
||||
// Step 3: Get the sign of the element we are processing. If it is the not the same as the largest value's sign bit then we set the bit
|
||||
// Step 4: Get the compressed and encoded value by multiplying the absolute value of the current element by k_CompressionEcodingMask and round that result up
|
||||
compressed = currentIndex != indexToSkip ? (compressed << 10) | (uint)((quaternion[currentIndex] < 0 ? k_True : k_False) != quatMaxSign ? k_True : k_False) << k_ShiftNegativeBit | (ushort)Mathf.Round(k_CompressionEcodingMask * s_QuatAbsValues[currentIndex]) : compressed;
|
||||
currentIndex++;
|
||||
// Repeat the last 3 steps for the remaining elements
|
||||
compressed = currentIndex != indexToSkip ? (compressed << 10) | (uint)((quaternion[currentIndex] < 0 ? k_True : k_False) != quatMaxSign ? k_True : k_False) << k_ShiftNegativeBit | (ushort)Mathf.Round(k_CompressionEcodingMask * s_QuatAbsValues[currentIndex]) : compressed;
|
||||
currentIndex++;
|
||||
compressed = currentIndex != indexToSkip ? (compressed << 10) | (uint)((quaternion[currentIndex] < 0 ? k_True : k_False) != quatMaxSign ? k_True : k_False) << k_ShiftNegativeBit | (ushort)Mathf.Round(k_CompressionEcodingMask * s_QuatAbsValues[currentIndex]) : compressed;
|
||||
currentIndex++;
|
||||
compressed = currentIndex != indexToSkip ? (compressed << 10) | (uint)((quaternion[currentIndex] < 0 ? k_True : k_False) != quatMaxSign ? k_True : k_False) << k_ShiftNegativeBit | (ushort)Mathf.Round(k_CompressionEcodingMask * s_QuatAbsValues[currentIndex]) : compressed;
|
||||
|
||||
// Return the compress quaternion
|
||||
return compressed;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Decompress a compressed quaternion
|
||||
/// </summary>
|
||||
/// <param name="quaternion">quaternion to store the decompressed values within</param>
|
||||
/// <param name="compressed">the compressed quaternion</param>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static void DecompressQuaternion(ref Quaternion quaternion, uint compressed)
|
||||
{
|
||||
// Get the last two bits for the index to skip (0-3)
|
||||
var indexToSkip = (int)(compressed >> 30);
|
||||
|
||||
// Reverse out the values while skipping over the largest value index
|
||||
var sumOfSquaredMagnitudes = 0.0f;
|
||||
for (int i = 3; i >= 0; --i)
|
||||
{
|
||||
if (i == indexToSkip)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
// Check the negative bit and multiply that result with the decompressed and decoded value
|
||||
quaternion[i] = ((compressed & k_NegShortBit) > 0 ? -1.0f : 1.0f) * ((compressed & k_PrecisionMask) * k_DcompressionDecodingMask);
|
||||
sumOfSquaredMagnitudes += quaternion[i] * quaternion[i];
|
||||
compressed = compressed >> 10;
|
||||
}
|
||||
// Since a normalized quaternion's magnitude is 1.0f, we subtract the sum of the squared smallest three from the unit value and take
|
||||
// the square root of the difference to find the final largest value
|
||||
quaternion[indexToSkip] = Mathf.Sqrt(1.0f - sumOfSquaredMagnitudes);
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Components/QuaternionCompressor.cs.meta
Normal file
11
Components/QuaternionCompressor.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: bb9d8b98d3c8bca469c8ee152353336f
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -3,7 +3,8 @@
|
||||
"rootNamespace": "Unity.Netcode.Components",
|
||||
"references": [
|
||||
"Unity.Netcode.Runtime",
|
||||
"Unity.Collections"
|
||||
"Unity.Collections",
|
||||
"Unity.Mathematics"
|
||||
],
|
||||
"allowUnsafeCode": true,
|
||||
"versionDefines": [
|
||||
|
||||
@@ -7,16 +7,16 @@ Netcode for GameObjects is a Unity package that provides networking capabilities
|
||||
See guides below to install Unity Netcode for GameObjects, set up your project, and get started with your first networked game:
|
||||
|
||||
- [Documentation](https://docs-multiplayer.unity3d.com/netcode/current/about)
|
||||
- [Installation](https://docs-multiplayer.unity3d.com/netcode/current/migration/install)
|
||||
- [First Steps](https://docs-multiplayer.unity3d.com/netcode/current/tutorials/helloworld/helloworldintro)
|
||||
- [API Reference](https://docs-multiplayer.unity3d.com/netcode/current/api/introduction)
|
||||
- [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.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
|
||||
@@ -32,4 +32,4 @@ On the following runtime platforms:
|
||||
|June 3, 2021|Update document to acknowledge Unity min version change. Matches package version 0.2.0|
|
||||
|August 5, 2021|Update product/package name|
|
||||
|September 9,2021|Updated the links and name of the file.|
|
||||
|April 20, 2022|Updated links|
|
||||
|April 20, 2022|Updated links|
|
||||
|
||||
14
Editor/AnticipatedNetworkTransformEditor.cs
Normal file
14
Editor/AnticipatedNetworkTransformEditor.cs
Normal file
@@ -0,0 +1,14 @@
|
||||
using Unity.Netcode.Components;
|
||||
using UnityEditor;
|
||||
|
||||
namespace Unity.Netcode.Editor
|
||||
{
|
||||
/// <summary>
|
||||
/// The <see cref="CustomEditor"/> for <see cref="AnticipatedNetworkTransform"/>
|
||||
/// </summary>
|
||||
[CustomEditor(typeof(AnticipatedNetworkTransform), true)]
|
||||
public class AnticipatedNetworkTransformEditor : NetworkTransformEditor
|
||||
{
|
||||
public override bool HideInterpolateValue => true;
|
||||
}
|
||||
}
|
||||
3
Editor/AnticipatedNetworkTransformEditor.cs.meta
Normal file
3
Editor/AnticipatedNetworkTransformEditor.cs.meta
Normal file
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 34bc168605014eeeadf97b12080e11fa
|
||||
timeCreated: 1707514321
|
||||
@@ -1,3 +1,7 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
|
||||
#if UNITY_INCLUDE_TESTS
|
||||
#if UNITY_EDITOR
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.EditorTests")]
|
||||
#endif // UNITY_EDITOR
|
||||
#endif // UNITY_INCLUDE_TESTS
|
||||
|
||||
@@ -10,6 +10,7 @@ using Unity.Collections;
|
||||
using Unity.CompilationPipeline.Common.Diagnostics;
|
||||
using Unity.CompilationPipeline.Common.ILPostProcessing;
|
||||
using UnityEngine;
|
||||
using Object = System.Object;
|
||||
|
||||
namespace Unity.Netcode.Editor.CodeGen
|
||||
{
|
||||
@@ -20,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;
|
||||
@@ -58,7 +62,7 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
|
||||
public static bool IsSubclassOf(this TypeDefinition typeDefinition, string classTypeFullName)
|
||||
{
|
||||
if (!typeDefinition.IsClass)
|
||||
if (typeDefinition == null || !typeDefinition.IsClass)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
@@ -112,6 +116,64 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
|
||||
return name;
|
||||
}
|
||||
public static TypeReference MakeGenericType(this TypeReference self, params TypeReference[] arguments)
|
||||
{
|
||||
if (self.GenericParameters.Count != arguments.Length)
|
||||
{
|
||||
throw new ArgumentException();
|
||||
}
|
||||
|
||||
var instance = new GenericInstanceType(self);
|
||||
foreach (var argument in arguments)
|
||||
{
|
||||
instance.GenericArguments.Add(argument);
|
||||
}
|
||||
|
||||
return instance;
|
||||
}
|
||||
|
||||
public static MethodReference MakeGeneric(this MethodReference self, params TypeReference[] arguments)
|
||||
{
|
||||
var reference = new MethodReference(self.Name, self.ReturnType)
|
||||
{
|
||||
DeclaringType = self.DeclaringType.MakeGenericType(arguments),
|
||||
HasThis = self.HasThis,
|
||||
ExplicitThis = self.ExplicitThis,
|
||||
CallingConvention = self.CallingConvention,
|
||||
};
|
||||
|
||||
foreach (var parameter in self.Parameters)
|
||||
{
|
||||
reference.Parameters.Add(new ParameterDefinition(parameter.ParameterType));
|
||||
}
|
||||
|
||||
foreach (var generic_parameter in self.GenericParameters)
|
||||
{
|
||||
reference.GenericParameters.Add(new GenericParameter(generic_parameter.Name, reference));
|
||||
}
|
||||
|
||||
return reference;
|
||||
}
|
||||
|
||||
public static bool IsSubclassOf(this TypeReference typeReference, TypeReference baseClass)
|
||||
{
|
||||
if (typeReference == null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
var type = typeReference.Resolve();
|
||||
if (type?.BaseType == null || type.BaseType.Name == nameof(Object))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (type.BaseType.Resolve() == baseClass.Resolve())
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
return type.BaseType.IsSubclassOf(baseClass);
|
||||
}
|
||||
|
||||
public static bool HasInterface(this TypeReference typeReference, string interfaceTypeFullName)
|
||||
{
|
||||
|
||||
@@ -1,12 +1,13 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Collections.Generic;
|
||||
using Mono.Cecil;
|
||||
using Mono.Cecil.Cil;
|
||||
using Mono.Cecil.Rocks;
|
||||
using Unity.CompilationPipeline.Common.Diagnostics;
|
||||
using Unity.CompilationPipeline.Common.ILPostProcessing;
|
||||
using UnityEngine;
|
||||
using ILPPInterface = Unity.CompilationPipeline.Common.ILPostProcessing.ILPostProcessor;
|
||||
using MethodAttributes = Mono.Cecil.MethodAttributes;
|
||||
|
||||
@@ -16,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>();
|
||||
|
||||
@@ -101,54 +102,54 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
private ModuleDefinition m_NetcodeModule;
|
||||
private PostProcessorAssemblyResolver m_AssemblyResolver;
|
||||
|
||||
private MethodReference m_MessagingSystem_ReceiveMessage_MethodRef;
|
||||
private MethodReference m_MessagingSystem_CreateMessageAndGetVersion_MethodRef;
|
||||
private TypeReference m_MessagingSystem_MessageWithHandler_TypeRef;
|
||||
private MethodReference m_MessagingSystem_MessageHandler_Constructor_TypeRef;
|
||||
private MethodReference m_MessagingSystem_VersionGetter_Constructor_TypeRef;
|
||||
private MethodReference m_RuntimeInitializeOnLoadAttribute_Ctor;
|
||||
|
||||
private MethodReference m_MessageManager_ReceiveMessage_MethodRef;
|
||||
private MethodReference m_MessageManager_CreateMessageAndGetVersion_MethodRef;
|
||||
private TypeReference m_MessageManager_MessageWithHandler_TypeRef;
|
||||
private MethodReference m_MessageManager_MessageHandler_Constructor_TypeRef;
|
||||
private MethodReference m_MessageManager_VersionGetter_Constructor_TypeRef;
|
||||
private FieldReference m_ILPPMessageProvider___network_message_types_FieldRef;
|
||||
private FieldReference m_MessagingSystem_MessageWithHandler_MessageType_FieldRef;
|
||||
private FieldReference m_MessagingSystem_MessageWithHandler_Handler_FieldRef;
|
||||
private FieldReference m_MessagingSystem_MessageWithHandler_GetVersion_FieldRef;
|
||||
private FieldReference m_MessageManager_MessageWithHandler_MessageType_FieldRef;
|
||||
private FieldReference m_MessageManager_MessageWithHandler_Handler_FieldRef;
|
||||
private FieldReference m_MessageManager_MessageWithHandler_GetVersion_FieldRef;
|
||||
private MethodReference m_Type_GetTypeFromHandle_MethodRef;
|
||||
private MethodReference m_List_Add_MethodRef;
|
||||
|
||||
private const string k_ReceiveMessageName = nameof(MessagingSystem.ReceiveMessage);
|
||||
private const string k_CreateMessageAndGetVersionName = nameof(MessagingSystem.CreateMessageAndGetVersion);
|
||||
private const string k_ReceiveMessageName = nameof(NetworkMessageManager.ReceiveMessage);
|
||||
private const string k_CreateMessageAndGetVersionName = nameof(NetworkMessageManager.CreateMessageAndGetVersion);
|
||||
|
||||
private bool ImportReferences(ModuleDefinition moduleDefinition)
|
||||
{
|
||||
// Different environments seem to have different situations...
|
||||
// Some have these definitions in netstandard.dll...
|
||||
// some seem to have them elsewhere...
|
||||
// Since they're standard .net classes they're not going to cause
|
||||
// the same issues as referencing other assemblies, in theory, since
|
||||
// the definitions should be standard and consistent across platforms
|
||||
// (i.e., there's no #if UNITY_EDITOR in them that could create
|
||||
// invalid IL code)
|
||||
// Some have these definitions in netstandard.dll, some seem to have them elsewhere...
|
||||
// Since they're standard .net classes they're not going to cause the same issues as referencing other assemblies,
|
||||
// in theory, since the definitions should be standard and consistent across platforms
|
||||
// (i.e., there's no #if UNITY_EDITOR in them that could create invalid IL code)
|
||||
TypeDefinition typeTypeDef = moduleDefinition.ImportReference(typeof(Type)).Resolve();
|
||||
TypeDefinition listTypeDef = moduleDefinition.ImportReference(typeof(List<>)).Resolve();
|
||||
m_RuntimeInitializeOnLoadAttribute_Ctor = moduleDefinition.ImportReference(typeof(RuntimeInitializeOnLoadMethodAttribute).GetConstructor(new Type[] { }));
|
||||
|
||||
TypeDefinition messageHandlerTypeDef = null;
|
||||
TypeDefinition versionGetterTypeDef = null;
|
||||
TypeDefinition messageWithHandlerTypeDef = null;
|
||||
TypeDefinition ilppMessageProviderTypeDef = null;
|
||||
TypeDefinition messagingSystemTypeDef = null;
|
||||
TypeDefinition messageManagerSystemTypeDef = null;
|
||||
foreach (var netcodeTypeDef in m_NetcodeModule.GetAllTypes())
|
||||
{
|
||||
if (messageHandlerTypeDef == null && netcodeTypeDef.Name == nameof(MessagingSystem.MessageHandler))
|
||||
if (messageHandlerTypeDef == null && netcodeTypeDef.Name == nameof(NetworkMessageManager.MessageHandler))
|
||||
{
|
||||
messageHandlerTypeDef = netcodeTypeDef;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (versionGetterTypeDef == null && netcodeTypeDef.Name == nameof(MessagingSystem.VersionGetter))
|
||||
if (versionGetterTypeDef == null && netcodeTypeDef.Name == nameof(NetworkMessageManager.VersionGetter))
|
||||
{
|
||||
versionGetterTypeDef = netcodeTypeDef;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (messageWithHandlerTypeDef == null && netcodeTypeDef.Name == nameof(MessagingSystem.MessageWithHandler))
|
||||
if (messageWithHandlerTypeDef == null && netcodeTypeDef.Name == nameof(NetworkMessageManager.MessageWithHandler))
|
||||
{
|
||||
messageWithHandlerTypeDef = netcodeTypeDef;
|
||||
continue;
|
||||
@@ -160,29 +161,29 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
continue;
|
||||
}
|
||||
|
||||
if (messagingSystemTypeDef == null && netcodeTypeDef.Name == nameof(MessagingSystem))
|
||||
if (messageManagerSystemTypeDef == null && netcodeTypeDef.Name == nameof(NetworkMessageManager))
|
||||
{
|
||||
messagingSystemTypeDef = netcodeTypeDef;
|
||||
messageManagerSystemTypeDef = netcodeTypeDef;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
m_MessagingSystem_MessageHandler_Constructor_TypeRef = moduleDefinition.ImportReference(messageHandlerTypeDef.GetConstructors().First());
|
||||
m_MessagingSystem_VersionGetter_Constructor_TypeRef = moduleDefinition.ImportReference(versionGetterTypeDef.GetConstructors().First());
|
||||
m_MessageManager_MessageHandler_Constructor_TypeRef = moduleDefinition.ImportReference(messageHandlerTypeDef.GetConstructors().First());
|
||||
m_MessageManager_VersionGetter_Constructor_TypeRef = moduleDefinition.ImportReference(versionGetterTypeDef.GetConstructors().First());
|
||||
|
||||
m_MessagingSystem_MessageWithHandler_TypeRef = moduleDefinition.ImportReference(messageWithHandlerTypeDef);
|
||||
m_MessageManager_MessageWithHandler_TypeRef = moduleDefinition.ImportReference(messageWithHandlerTypeDef);
|
||||
foreach (var fieldDef in messageWithHandlerTypeDef.Fields)
|
||||
{
|
||||
switch (fieldDef.Name)
|
||||
{
|
||||
case nameof(MessagingSystem.MessageWithHandler.MessageType):
|
||||
m_MessagingSystem_MessageWithHandler_MessageType_FieldRef = moduleDefinition.ImportReference(fieldDef);
|
||||
case nameof(NetworkMessageManager.MessageWithHandler.MessageType):
|
||||
m_MessageManager_MessageWithHandler_MessageType_FieldRef = moduleDefinition.ImportReference(fieldDef);
|
||||
break;
|
||||
case nameof(MessagingSystem.MessageWithHandler.Handler):
|
||||
m_MessagingSystem_MessageWithHandler_Handler_FieldRef = moduleDefinition.ImportReference(fieldDef);
|
||||
case nameof(NetworkMessageManager.MessageWithHandler.Handler):
|
||||
m_MessageManager_MessageWithHandler_Handler_FieldRef = moduleDefinition.ImportReference(fieldDef);
|
||||
break;
|
||||
case nameof(MessagingSystem.MessageWithHandler.GetVersion):
|
||||
m_MessagingSystem_MessageWithHandler_GetVersion_FieldRef = moduleDefinition.ImportReference(fieldDef);
|
||||
case nameof(NetworkMessageManager.MessageWithHandler.GetVersion):
|
||||
m_MessageManager_MessageWithHandler_GetVersion_FieldRef = moduleDefinition.ImportReference(fieldDef);
|
||||
break;
|
||||
}
|
||||
}
|
||||
@@ -219,15 +220,15 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var methodDef in messagingSystemTypeDef.Methods)
|
||||
foreach (var methodDef in messageManagerSystemTypeDef.Methods)
|
||||
{
|
||||
switch (methodDef.Name)
|
||||
{
|
||||
case k_ReceiveMessageName:
|
||||
m_MessagingSystem_ReceiveMessage_MethodRef = moduleDefinition.ImportReference(methodDef);
|
||||
m_MessageManager_ReceiveMessage_MethodRef = moduleDefinition.ImportReference(methodDef);
|
||||
break;
|
||||
case k_CreateMessageAndGetVersionName:
|
||||
m_MessagingSystem_CreateMessageAndGetVersion_MethodRef = moduleDefinition.ImportReference(methodDef);
|
||||
m_MessageManager_CreateMessageAndGetVersion_MethodRef = moduleDefinition.ImportReference(methodDef);
|
||||
break;
|
||||
}
|
||||
}
|
||||
@@ -235,48 +236,29 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
return true;
|
||||
}
|
||||
|
||||
private MethodDefinition GetOrCreateStaticConstructor(TypeDefinition typeDefinition)
|
||||
{
|
||||
var staticCtorMethodDef = typeDefinition.GetStaticConstructor();
|
||||
if (staticCtorMethodDef == null)
|
||||
{
|
||||
staticCtorMethodDef = new MethodDefinition(
|
||||
".cctor", // Static Constructor (constant-constructor)
|
||||
MethodAttributes.HideBySig |
|
||||
MethodAttributes.SpecialName |
|
||||
MethodAttributes.RTSpecialName |
|
||||
MethodAttributes.Static,
|
||||
typeDefinition.Module.TypeSystem.Void);
|
||||
staticCtorMethodDef.Body.Instructions.Add(Instruction.Create(OpCodes.Ret));
|
||||
typeDefinition.Methods.Add(staticCtorMethodDef);
|
||||
}
|
||||
|
||||
return staticCtorMethodDef;
|
||||
}
|
||||
|
||||
private void CreateInstructionsToRegisterType(ILProcessor processor, List<Instruction> instructions, TypeReference type, MethodReference receiveMethod, MethodReference versionMethod)
|
||||
{
|
||||
// MessagingSystem.__network_message_types.Add(new MessagingSystem.MessageWithHandler{MessageType=typeof(type), Handler=type.Receive});
|
||||
processor.Body.Variables.Add(new VariableDefinition(m_MessagingSystem_MessageWithHandler_TypeRef));
|
||||
// NetworkMessageManager.__network_message_types.Add(new NetworkMessageManager.MessageWithHandler{MessageType=typeof(type), Handler=type.Receive});
|
||||
processor.Body.Variables.Add(new VariableDefinition(m_MessageManager_MessageWithHandler_TypeRef));
|
||||
int messageWithHandlerLocIdx = processor.Body.Variables.Count - 1;
|
||||
|
||||
instructions.Add(processor.Create(OpCodes.Ldsfld, m_ILPPMessageProvider___network_message_types_FieldRef));
|
||||
instructions.Add(processor.Create(OpCodes.Ldloca, messageWithHandlerLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Initobj, m_MessagingSystem_MessageWithHandler_TypeRef));
|
||||
instructions.Add(processor.Create(OpCodes.Initobj, m_MessageManager_MessageWithHandler_TypeRef));
|
||||
|
||||
// tmp.MessageType = typeof(type);
|
||||
instructions.Add(processor.Create(OpCodes.Ldloca, messageWithHandlerLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Ldtoken, type));
|
||||
instructions.Add(processor.Create(OpCodes.Call, m_Type_GetTypeFromHandle_MethodRef));
|
||||
instructions.Add(processor.Create(OpCodes.Stfld, m_MessagingSystem_MessageWithHandler_MessageType_FieldRef));
|
||||
instructions.Add(processor.Create(OpCodes.Stfld, m_MessageManager_MessageWithHandler_MessageType_FieldRef));
|
||||
|
||||
// tmp.Handler = MessageHandler.ReceveMessage<type>
|
||||
instructions.Add(processor.Create(OpCodes.Ldloca, messageWithHandlerLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Ldnull));
|
||||
|
||||
instructions.Add(processor.Create(OpCodes.Ldftn, receiveMethod));
|
||||
instructions.Add(processor.Create(OpCodes.Newobj, m_MessagingSystem_MessageHandler_Constructor_TypeRef));
|
||||
instructions.Add(processor.Create(OpCodes.Stfld, m_MessagingSystem_MessageWithHandler_Handler_FieldRef));
|
||||
instructions.Add(processor.Create(OpCodes.Newobj, m_MessageManager_MessageHandler_Constructor_TypeRef));
|
||||
instructions.Add(processor.Create(OpCodes.Stfld, m_MessageManager_MessageWithHandler_Handler_FieldRef));
|
||||
|
||||
|
||||
// tmp.GetVersion = MessageHandler.CreateMessageAndGetVersion<type>
|
||||
@@ -284,43 +266,46 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
instructions.Add(processor.Create(OpCodes.Ldnull));
|
||||
|
||||
instructions.Add(processor.Create(OpCodes.Ldftn, versionMethod));
|
||||
instructions.Add(processor.Create(OpCodes.Newobj, m_MessagingSystem_VersionGetter_Constructor_TypeRef));
|
||||
instructions.Add(processor.Create(OpCodes.Stfld, m_MessagingSystem_MessageWithHandler_GetVersion_FieldRef));
|
||||
instructions.Add(processor.Create(OpCodes.Newobj, m_MessageManager_VersionGetter_Constructor_TypeRef));
|
||||
instructions.Add(processor.Create(OpCodes.Stfld, m_MessageManager_MessageWithHandler_GetVersion_FieldRef));
|
||||
|
||||
// ILPPMessageProvider.__network_message_types.Add(tmp);
|
||||
instructions.Add(processor.Create(OpCodes.Ldloc, messageWithHandlerLocIdx));
|
||||
instructions.Add(processor.Create(OpCodes.Callvirt, m_List_Add_MethodRef));
|
||||
}
|
||||
|
||||
// Creates a static module constructor (which is executed when the module is loaded) that registers all the message types in the assembly with MessagingSystem.
|
||||
// Creates a static module constructor (which is executed when the module is loaded) that registers all the message types in the assembly with NetworkMessageManager.
|
||||
// This is the same behavior as annotating a static method with [ModuleInitializer] in standardized C# (that attribute doesn't exist in Unity, but the static module constructor still works).
|
||||
// https://docs.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.moduleinitializerattribute?view=net-5.0
|
||||
// https://web.archive.org/web/20100212140402/http://blogs.msdn.com/junfeng/archive/2005/11/19/494914.aspx
|
||||
private void CreateModuleInitializer(AssemblyDefinition assembly, List<TypeDefinition> networkMessageTypes)
|
||||
{
|
||||
foreach (var typeDefinition in assembly.MainModule.Types)
|
||||
var typeDefinition = new TypeDefinition("__GEN", "INetworkMessageHelper", TypeAttributes.NotPublic | TypeAttributes.AnsiClass | TypeAttributes.BeforeFieldInit, assembly.MainModule.TypeSystem.Object);
|
||||
|
||||
var staticCtorMethodDef = new MethodDefinition(
|
||||
$"InitializeMessages",
|
||||
MethodAttributes.Assembly |
|
||||
MethodAttributes.Static,
|
||||
assembly.MainModule.TypeSystem.Void);
|
||||
staticCtorMethodDef.Body.Instructions.Add(Instruction.Create(OpCodes.Ret));
|
||||
staticCtorMethodDef.CustomAttributes.Add(new CustomAttribute(m_RuntimeInitializeOnLoadAttribute_Ctor));
|
||||
typeDefinition.Methods.Add(staticCtorMethodDef);
|
||||
|
||||
var instructions = new List<Instruction>();
|
||||
var processor = staticCtorMethodDef.Body.GetILProcessor();
|
||||
|
||||
foreach (var type in networkMessageTypes)
|
||||
{
|
||||
if (typeDefinition.FullName == "<Module>")
|
||||
{
|
||||
var staticCtorMethodDef = GetOrCreateStaticConstructor(typeDefinition);
|
||||
|
||||
var processor = staticCtorMethodDef.Body.GetILProcessor();
|
||||
|
||||
var instructions = new List<Instruction>();
|
||||
|
||||
foreach (var type in networkMessageTypes)
|
||||
{
|
||||
var receiveMethod = new GenericInstanceMethod(m_MessagingSystem_ReceiveMessage_MethodRef);
|
||||
receiveMethod.GenericArguments.Add(type);
|
||||
var versionMethod = new GenericInstanceMethod(m_MessagingSystem_CreateMessageAndGetVersion_MethodRef);
|
||||
versionMethod.GenericArguments.Add(type);
|
||||
CreateInstructionsToRegisterType(processor, instructions, type, receiveMethod, versionMethod);
|
||||
}
|
||||
|
||||
instructions.ForEach(instruction => processor.Body.Instructions.Insert(processor.Body.Instructions.Count - 1, instruction));
|
||||
break;
|
||||
}
|
||||
var receiveMethod = new GenericInstanceMethod(m_MessageManager_ReceiveMessage_MethodRef);
|
||||
receiveMethod.GenericArguments.Add(type);
|
||||
var versionMethod = new GenericInstanceMethod(m_MessageManager_CreateMessageAndGetVersion_MethodRef);
|
||||
versionMethod.GenericArguments.Add(type);
|
||||
CreateInstructionsToRegisterType(processor, instructions, type, receiveMethod, versionMethod);
|
||||
}
|
||||
|
||||
instructions.ForEach(instruction => processor.Body.Instructions.Insert(processor.Body.Instructions.Count - 1, instruction));
|
||||
|
||||
assembly.MainModule.Types.Add(typeDefinition);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Collections.Generic;
|
||||
using Mono.Cecil;
|
||||
using Mono.Cecil.Cil;
|
||||
using Unity.CompilationPipeline.Common.Diagnostics;
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -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,7 +53,17 @@ 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;
|
||||
break;
|
||||
}
|
||||
@@ -79,6 +90,9 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
return new ILPostProcessResult(new InMemoryAssembly(pe.ToArray(), pdb.ToArray()), m_Diagnostics);
|
||||
}
|
||||
|
||||
// TODO: Deprecate...
|
||||
// This is changing accessibility for values that are no longer used, but since our validator runs
|
||||
// after ILPP and sees those values as public, they cannot be removed until a major version change.
|
||||
private void ProcessNetworkManager(TypeDefinition typeDefinition, string[] assemblyDefines)
|
||||
{
|
||||
foreach (var fieldDefinition in typeDefinition.Fields)
|
||||
@@ -98,6 +112,14 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
fieldDefinition.IsPublic = true;
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var nestedTypeDefinition in typeDefinition.NestedTypes)
|
||||
{
|
||||
if (nestedTypeDefinition.Name == nameof(NetworkManager.RpcReceiveHandler))
|
||||
{
|
||||
nestedTypeDefinition.IsNestedPublic = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void ProcessNetworkBehaviour(TypeDefinition typeDefinition)
|
||||
@@ -108,13 +130,31 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
{
|
||||
nestedType.IsNestedFamily = true;
|
||||
}
|
||||
if (nestedType.Name == nameof(NetworkBehaviour.RpcReceiveHandler))
|
||||
{
|
||||
nestedType.IsNestedPublic = true;
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var fieldDefinition in typeDefinition.Fields)
|
||||
{
|
||||
if (fieldDefinition.Name == nameof(NetworkBehaviour.__rpc_exec_stage))
|
||||
if (fieldDefinition.Name == nameof(NetworkBehaviour.__rpc_exec_stage) || fieldDefinition.Name == nameof(NetworkBehaviour.NetworkVariableFields))
|
||||
{
|
||||
fieldDefinition.IsFamily = true;
|
||||
fieldDefinition.IsFamilyOrAssembly = true;
|
||||
}
|
||||
if (fieldDefinition.Name == nameof(NetworkBehaviour.__rpc_func_table))
|
||||
{
|
||||
fieldDefinition.IsFamilyOrAssembly = true;
|
||||
}
|
||||
|
||||
if (fieldDefinition.Name == nameof(NetworkBehaviour.RpcReceiveHandler))
|
||||
{
|
||||
fieldDefinition.IsFamilyOrAssembly = true;
|
||||
}
|
||||
|
||||
if (fieldDefinition.Name == nameof(NetworkBehaviour.__rpc_name_table))
|
||||
{
|
||||
fieldDefinition.IsFamilyOrAssembly = true;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -123,10 +163,22 @@ namespace Unity.Netcode.Editor.CodeGen
|
||||
if (methodDefinition.Name == nameof(NetworkBehaviour.__beginSendServerRpc) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__endSendServerRpc) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__beginSendClientRpc) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__endSendClientRpc))
|
||||
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) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__nameNetworkVariable) ||
|
||||
methodDefinition.Name == nameof(NetworkBehaviour.__createNativeList))
|
||||
{
|
||||
methodDefinition.IsFamily = true;
|
||||
}
|
||||
|
||||
if (methodDefinition.Name == nameof(NetworkBehaviour.__getTypeName))
|
||||
{
|
||||
methodDefinition.IsFamilyOrAssembly = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 52153943c346dd04e8712ab540ab9c22
|
||||
folderAsset: yes
|
||||
DefaultImporter:
|
||||
externalObjects: {}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
guid: b2f70916f7024c66aa5dfe1e43c151a2
|
||||
timeCreated: 1654274400
|
||||
30
Editor/Configuration/NetcodeForGameObjectsProjectSettings.cs
Normal file
30
Editor/Configuration/NetcodeForGameObjectsProjectSettings.cs
Normal file
@@ -0,0 +1,30 @@
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Editor.Configuration
|
||||
{
|
||||
[FilePath("ProjectSettings/NetcodeForGameObjects.asset", FilePathAttribute.Location.ProjectFolder)]
|
||||
public class NetcodeForGameObjectsProjectSettings : ScriptableSingleton<NetcodeForGameObjectsProjectSettings>
|
||||
{
|
||||
internal static readonly string DefaultNetworkPrefabsPath = "Assets/DefaultNetworkPrefabs.asset";
|
||||
[SerializeField] public string NetworkPrefabsPath = DefaultNetworkPrefabsPath;
|
||||
public string TempNetworkPrefabsPath;
|
||||
|
||||
private void OnEnable()
|
||||
{
|
||||
if (NetworkPrefabsPath == "")
|
||||
{
|
||||
NetworkPrefabsPath = DefaultNetworkPrefabsPath;
|
||||
}
|
||||
TempNetworkPrefabsPath = NetworkPrefabsPath;
|
||||
}
|
||||
|
||||
[SerializeField]
|
||||
public bool GenerateDefaultNetworkPrefabs = true;
|
||||
|
||||
internal void SaveSettings()
|
||||
{
|
||||
Save(true);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 2727d53a542a4c1aa312905c3a02d807
|
||||
timeCreated: 1685564945
|
||||
@@ -1,9 +1,8 @@
|
||||
using UnityEditor;
|
||||
|
||||
|
||||
namespace Unity.Netcode.Editor.Configuration
|
||||
{
|
||||
internal class NetcodeForGameObjectsSettings
|
||||
internal class NetcodeForGameObjectsEditorSettings
|
||||
{
|
||||
internal const string AutoAddNetworkObjectIfNoneExists = "AutoAdd-NetworkObject-When-None-Exist";
|
||||
internal const string InstallMultiplayerToolsTipDismissedPlayerPrefKey = "Netcode_Tip_InstallMPTools_Dismissed";
|
||||
@@ -14,6 +13,7 @@ namespace Unity.Netcode.Editor.Configuration
|
||||
{
|
||||
return EditorPrefs.GetInt(InstallMultiplayerToolsTipDismissedPlayerPrefKey);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
@@ -28,6 +28,7 @@ namespace Unity.Netcode.Editor.Configuration
|
||||
{
|
||||
return EditorPrefs.GetBool(AutoAddNetworkObjectIfNoneExists);
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,10 +1,19 @@
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
using Directory = UnityEngine.Windows.Directory;
|
||||
using File = UnityEngine.Windows.File;
|
||||
|
||||
namespace Unity.Netcode.Editor.Configuration
|
||||
{
|
||||
internal static class NetcodeSettingsProvider
|
||||
{
|
||||
private const float k_MaxLabelWidth = 450f;
|
||||
private static float s_MaxLabelWidth;
|
||||
private static bool s_ShowEditorSettingFields = true;
|
||||
private static bool s_ShowProjectSettingFields = true;
|
||||
|
||||
[SettingsProvider]
|
||||
public static SettingsProvider CreateNetcodeSettingsProvider()
|
||||
{
|
||||
@@ -15,30 +24,170 @@ namespace Unity.Netcode.Editor.Configuration
|
||||
label = "Netcode for GameObjects",
|
||||
keywords = new[] { "netcode", "editor" },
|
||||
guiHandler = OnGuiHandler,
|
||||
deactivateHandler = OnDeactivate
|
||||
};
|
||||
|
||||
return provider;
|
||||
}
|
||||
|
||||
internal static NetcodeSettingsLabel NetworkObjectsSectionLabel = new NetcodeSettingsLabel("NetworkObject Helper Settings", 20);
|
||||
internal static NetcodeSettingsToggle AutoAddNetworkObjectToggle = new NetcodeSettingsToggle("Auto-Add NetworkObjects", "When enabled, NetworkObjects are automatically added to GameObjects when NetworkBehaviours are added first.", 20);
|
||||
internal static NetcodeSettingsLabel MultiplayerToolsLabel = new NetcodeSettingsLabel("Multiplayer Tools", 20);
|
||||
internal static NetcodeSettingsToggle MultiplayerToolTipStatusToggle = new NetcodeSettingsToggle("Multiplayer Tools Install Reminder", "When enabled, the NetworkManager will display " +
|
||||
"the notification to install the multiplayer tools package.", 20);
|
||||
private static void OnDeactivate()
|
||||
{
|
||||
var settings = NetcodeForGameObjectsProjectSettings.instance;
|
||||
if (settings.TempNetworkPrefabsPath != settings.NetworkPrefabsPath)
|
||||
{
|
||||
var newPath = settings.TempNetworkPrefabsPath;
|
||||
if (newPath == "")
|
||||
{
|
||||
newPath = NetcodeForGameObjectsProjectSettings.DefaultNetworkPrefabsPath;
|
||||
settings.TempNetworkPrefabsPath = newPath;
|
||||
}
|
||||
var oldPath = settings.NetworkPrefabsPath;
|
||||
settings.NetworkPrefabsPath = settings.TempNetworkPrefabsPath;
|
||||
var dirName = Path.GetDirectoryName(newPath);
|
||||
if (!Directory.Exists(dirName))
|
||||
{
|
||||
var dirs = dirName.Split(new[] { Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar });
|
||||
var dirsQueue = new Queue<string>(dirs);
|
||||
var parent = dirsQueue.Dequeue();
|
||||
while (dirsQueue.Count != 0)
|
||||
{
|
||||
var child = dirsQueue.Dequeue();
|
||||
var together = Path.Combine(parent, child);
|
||||
if (!Directory.Exists(together))
|
||||
{
|
||||
AssetDatabase.CreateFolder(parent, child);
|
||||
}
|
||||
|
||||
parent = together;
|
||||
}
|
||||
}
|
||||
|
||||
if (Directory.Exists(dirName))
|
||||
{
|
||||
if (File.Exists(oldPath))
|
||||
{
|
||||
AssetDatabase.MoveAsset(oldPath, newPath);
|
||||
if (File.Exists(oldPath))
|
||||
{
|
||||
File.Delete(oldPath);
|
||||
}
|
||||
AssetDatabase.Refresh();
|
||||
}
|
||||
}
|
||||
settings.SaveSettings();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
internal static NetcodeSettingsLabel NetworkObjectsSectionLabel;
|
||||
internal static NetcodeSettingsToggle AutoAddNetworkObjectToggle;
|
||||
internal static NetcodeSettingsLabel MultiplayerToolsLabel;
|
||||
internal static NetcodeSettingsToggle MultiplayerToolTipStatusToggle;
|
||||
|
||||
/// <summary>
|
||||
/// Creates an instance of the settings UI Elements if they don't already exist.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// We have to construct any NetcodeGUISettings derived classes here because in
|
||||
/// version 2020.x.x EditorStyles.label does not exist yet (higher versions it does)
|
||||
/// </remarks>
|
||||
private static void CheckForInitialize()
|
||||
{
|
||||
if (NetworkObjectsSectionLabel == null)
|
||||
{
|
||||
NetworkObjectsSectionLabel = new NetcodeSettingsLabel("NetworkObject Helper Settings", 20);
|
||||
}
|
||||
|
||||
if (AutoAddNetworkObjectToggle == null)
|
||||
{
|
||||
AutoAddNetworkObjectToggle = new NetcodeSettingsToggle("Auto-Add NetworkObject Component", "When enabled, NetworkObject components are automatically added to GameObjects when NetworkBehaviour components are added first.", 20);
|
||||
}
|
||||
|
||||
if (MultiplayerToolsLabel == null)
|
||||
{
|
||||
MultiplayerToolsLabel = new NetcodeSettingsLabel("Multiplayer Tools", 20);
|
||||
}
|
||||
|
||||
if (MultiplayerToolTipStatusToggle == null)
|
||||
{
|
||||
MultiplayerToolTipStatusToggle = new NetcodeSettingsToggle("Multiplayer Tools Install Reminder", "When enabled, the NetworkManager will display the notification to install the multiplayer tools package.", 20);
|
||||
}
|
||||
}
|
||||
|
||||
private static void OnGuiHandler(string obj)
|
||||
{
|
||||
var autoAddNetworkObjectSetting = NetcodeForGameObjectsSettings.GetAutoAddNetworkObjectSetting();
|
||||
var multiplayerToolsTipStatus = NetcodeForGameObjectsSettings.GetNetcodeInstallMultiplayerToolTips() == 0;
|
||||
// Make sure all NetcodeGUISettings derived classes are instantiated first
|
||||
CheckForInitialize();
|
||||
|
||||
var autoAddNetworkObjectSetting = NetcodeForGameObjectsEditorSettings.GetAutoAddNetworkObjectSetting();
|
||||
var multiplayerToolsTipStatus = NetcodeForGameObjectsEditorSettings.GetNetcodeInstallMultiplayerToolTips() == 0;
|
||||
var settings = NetcodeForGameObjectsProjectSettings.instance;
|
||||
var generateDefaultPrefabs = settings.GenerateDefaultNetworkPrefabs;
|
||||
var networkPrefabsPath = settings.TempNetworkPrefabsPath;
|
||||
|
||||
EditorGUI.BeginChangeCheck();
|
||||
NetworkObjectsSectionLabel.DrawLabel();
|
||||
autoAddNetworkObjectSetting = AutoAddNetworkObjectToggle.DrawToggle(autoAddNetworkObjectSetting);
|
||||
MultiplayerToolsLabel.DrawLabel();
|
||||
multiplayerToolsTipStatus = MultiplayerToolTipStatusToggle.DrawToggle(multiplayerToolsTipStatus);
|
||||
|
||||
GUILayout.BeginVertical("Box");
|
||||
s_ShowEditorSettingFields = EditorGUILayout.BeginFoldoutHeaderGroup(s_ShowEditorSettingFields, "Editor Settings");
|
||||
|
||||
if (s_ShowEditorSettingFields)
|
||||
{
|
||||
GUILayout.BeginVertical("Box");
|
||||
NetworkObjectsSectionLabel.DrawLabel();
|
||||
autoAddNetworkObjectSetting = AutoAddNetworkObjectToggle.DrawToggle(autoAddNetworkObjectSetting);
|
||||
GUILayout.EndVertical();
|
||||
|
||||
GUILayout.BeginVertical("Box");
|
||||
MultiplayerToolsLabel.DrawLabel();
|
||||
multiplayerToolsTipStatus = MultiplayerToolTipStatusToggle.DrawToggle(multiplayerToolsTipStatus);
|
||||
GUILayout.EndVertical();
|
||||
}
|
||||
EditorGUILayout.EndFoldoutHeaderGroup();
|
||||
GUILayout.EndVertical();
|
||||
|
||||
GUILayout.BeginVertical("Box");
|
||||
s_ShowProjectSettingFields = EditorGUILayout.BeginFoldoutHeaderGroup(s_ShowProjectSettingFields, "Project Settings");
|
||||
if (s_ShowProjectSettingFields)
|
||||
{
|
||||
GUILayout.BeginVertical("Box");
|
||||
const string generateNetworkPrefabsString = "Generate Default Network Prefabs List";
|
||||
const string networkPrefabsLocationString = "Default Network Prefabs List path";
|
||||
|
||||
if (s_MaxLabelWidth == 0)
|
||||
{
|
||||
s_MaxLabelWidth = EditorStyles.label.CalcSize(new GUIContent(generateNetworkPrefabsString)).x;
|
||||
s_MaxLabelWidth = Mathf.Min(k_MaxLabelWidth, s_MaxLabelWidth);
|
||||
}
|
||||
|
||||
EditorGUIUtility.labelWidth = s_MaxLabelWidth;
|
||||
|
||||
GUILayout.Label("Network Prefabs", EditorStyles.boldLabel);
|
||||
generateDefaultPrefabs = EditorGUILayout.Toggle(
|
||||
new GUIContent(
|
||||
generateNetworkPrefabsString,
|
||||
"When enabled, a default NetworkPrefabsList object will be added to your project and kept up " +
|
||||
"to date with all NetworkObject prefabs."),
|
||||
generateDefaultPrefabs,
|
||||
GUILayout.Width(s_MaxLabelWidth + 20));
|
||||
|
||||
GUI.SetNextControlName("Location");
|
||||
networkPrefabsPath = EditorGUILayout.TextField(
|
||||
new GUIContent(
|
||||
networkPrefabsLocationString,
|
||||
"The path to the asset the default NetworkPrefabList object should be stored in."),
|
||||
networkPrefabsPath,
|
||||
GUILayout.Width(s_MaxLabelWidth + 270));
|
||||
GUILayout.EndVertical();
|
||||
}
|
||||
EditorGUILayout.EndFoldoutHeaderGroup();
|
||||
GUILayout.EndVertical();
|
||||
if (EditorGUI.EndChangeCheck())
|
||||
{
|
||||
NetcodeForGameObjectsSettings.SetAutoAddNetworkObjectSetting(autoAddNetworkObjectSetting);
|
||||
NetcodeForGameObjectsSettings.SetNetcodeInstallMultiplayerToolTips(multiplayerToolsTipStatus ? 0 : 1);
|
||||
NetcodeForGameObjectsEditorSettings.SetAutoAddNetworkObjectSetting(autoAddNetworkObjectSetting);
|
||||
NetcodeForGameObjectsEditorSettings.SetNetcodeInstallMultiplayerToolTips(multiplayerToolsTipStatus ? 0 : 1);
|
||||
settings.GenerateDefaultNetworkPrefabs = generateDefaultPrefabs;
|
||||
settings.TempNetworkPrefabsPath = networkPrefabsPath;
|
||||
settings.SaveSettings();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -56,7 +205,7 @@ namespace Unity.Netcode.Editor.Configuration
|
||||
public NetcodeSettingsLabel(string labelText, float layoutOffset = 0.0f)
|
||||
{
|
||||
m_LabelContent = labelText;
|
||||
AdjustLableSize(labelText, layoutOffset);
|
||||
AdjustLabelSize(labelText, layoutOffset);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -72,7 +221,7 @@ namespace Unity.Netcode.Editor.Configuration
|
||||
|
||||
public NetcodeSettingsToggle(string labelText, string toolTip, float layoutOffset)
|
||||
{
|
||||
AdjustLableSize(labelText, layoutOffset);
|
||||
AdjustLabelSize(labelText, layoutOffset);
|
||||
m_ToggleContent = new GUIContent(labelText, toolTip);
|
||||
}
|
||||
}
|
||||
@@ -84,7 +233,7 @@ namespace Unity.Netcode.Editor.Configuration
|
||||
|
||||
protected GUILayoutOption m_LayoutWidth { get; private set; }
|
||||
|
||||
protected void AdjustLableSize(string labelText, float offset = 0.0f)
|
||||
protected void AdjustLabelSize(string labelText, float offset = 0.0f)
|
||||
{
|
||||
m_LabelSize = Mathf.Min(k_MaxLabelWidth, EditorStyles.label.CalcSize(new GUIContent(labelText)).x);
|
||||
m_LayoutWidth = GUILayout.Width(m_LabelSize + offset);
|
||||
|
||||
186
Editor/Configuration/NetworkPrefabProcessor.cs
Normal file
186
Editor/Configuration/NetworkPrefabProcessor.cs
Normal file
@@ -0,0 +1,186 @@
|
||||
using System.Collections.Generic;
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Editor.Configuration
|
||||
{
|
||||
/// <summary>
|
||||
/// Updates the default <see cref="NetworkPrefabsList"/> instance when prefabs are updated (created, moved, deleted) in the project.
|
||||
/// </summary>
|
||||
public class NetworkPrefabProcessor : AssetPostprocessor
|
||||
{
|
||||
public static string DefaultNetworkPrefabsPath
|
||||
{
|
||||
get
|
||||
{
|
||||
return NetcodeForGameObjectsProjectSettings.instance.NetworkPrefabsPath;
|
||||
}
|
||||
internal set
|
||||
{
|
||||
NetcodeForGameObjectsProjectSettings.instance.NetworkPrefabsPath = value;
|
||||
// Force a recache of the prefab list
|
||||
s_PrefabsList = null;
|
||||
}
|
||||
}
|
||||
private static NetworkPrefabsList s_PrefabsList;
|
||||
private static Dictionary<string, NetworkPrefab> s_PrefabsListPath = new Dictionary<string, NetworkPrefab>();
|
||||
|
||||
private static void OnPostprocessAllAssets(string[] importedAssets, string[] deletedAssets, string[] movedAssets, string[] movedFromAssetPaths)
|
||||
{
|
||||
var settings = NetcodeForGameObjectsProjectSettings.instance;
|
||||
if (!settings.GenerateDefaultNetworkPrefabs)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
bool ProcessImportedAssets(string[] importedAssets1)
|
||||
{
|
||||
var dirty = false;
|
||||
foreach (var assetPath in importedAssets1)
|
||||
{
|
||||
// We only care about GameObjects, skip everything else. Can't use the more targeted
|
||||
// OnPostProcessPrefabs since that's not called for moves or deletes
|
||||
if (AssetDatabase.GetMainAssetTypeAtPath(assetPath) != typeof(GameObject))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
var go = AssetDatabase.LoadAssetAtPath<GameObject>(assetPath);
|
||||
if (go.TryGetComponent<NetworkObject>(out _))
|
||||
{
|
||||
// Make sure we are not duplicating an already existing entry
|
||||
if (s_PrefabsListPath.ContainsKey(assetPath))
|
||||
{
|
||||
// Is the imported asset different from the one we already have in the list?
|
||||
if (s_PrefabsListPath[assetPath].Prefab.GetHashCode() != go.GetHashCode())
|
||||
{
|
||||
// If so remove the one in the list and continue on to add the imported one
|
||||
s_PrefabsList.List.Remove(s_PrefabsListPath[assetPath]);
|
||||
}
|
||||
else // If they are identical, then just ignore the import
|
||||
{
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
s_PrefabsList.List.Add(new NetworkPrefab { Prefab = go });
|
||||
dirty = true;
|
||||
}
|
||||
}
|
||||
|
||||
return dirty;
|
||||
}
|
||||
|
||||
bool ProcessDeletedAssets(string[] strings)
|
||||
{
|
||||
var dirty = false;
|
||||
var deleted = new List<string>(strings);
|
||||
for (int i = s_PrefabsList.List.Count - 1; i >= 0 && deleted.Count > 0; --i)
|
||||
{
|
||||
GameObject prefab;
|
||||
try
|
||||
{
|
||||
prefab = s_PrefabsList.List[i].Prefab;
|
||||
}
|
||||
catch (MissingReferenceException)
|
||||
{
|
||||
s_PrefabsList.List.RemoveAt(i);
|
||||
continue;
|
||||
}
|
||||
if (prefab == null)
|
||||
{
|
||||
s_PrefabsList.List.RemoveAt(i);
|
||||
}
|
||||
else
|
||||
{
|
||||
string noPath = AssetDatabase.GetAssetPath(prefab);
|
||||
for (int j = strings.Length - 1; j >= 0; --j)
|
||||
{
|
||||
if (noPath == strings[j])
|
||||
{
|
||||
s_PrefabsList.List.RemoveAt(i);
|
||||
deleted.RemoveAt(j);
|
||||
dirty = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return dirty;
|
||||
}
|
||||
|
||||
if (s_PrefabsList == null)
|
||||
{
|
||||
s_PrefabsList = GetOrCreateNetworkPrefabs(DefaultNetworkPrefabsPath, out var newList, true);
|
||||
// A new list already processed all existing assets, no need to double-process imports & deletes
|
||||
if (newList)
|
||||
{
|
||||
return;
|
||||
}
|
||||
}
|
||||
// Clear our asset path to prefab table each time
|
||||
s_PrefabsListPath.Clear();
|
||||
|
||||
// Create our asst path to prefab table
|
||||
foreach (var prefabEntry in s_PrefabsList.List)
|
||||
{
|
||||
if (!s_PrefabsListPath.ContainsKey(AssetDatabase.GetAssetPath(prefabEntry.Prefab)))
|
||||
{
|
||||
s_PrefabsListPath.Add(AssetDatabase.GetAssetPath(prefabEntry.Prefab), prefabEntry);
|
||||
}
|
||||
}
|
||||
|
||||
// Process the imported and deleted assets
|
||||
var markDirty = ProcessImportedAssets(importedAssets);
|
||||
markDirty &= ProcessDeletedAssets(deletedAssets);
|
||||
|
||||
if (markDirty)
|
||||
{
|
||||
EditorUtility.SetDirty(s_PrefabsList);
|
||||
}
|
||||
}
|
||||
|
||||
internal static NetworkPrefabsList GetOrCreateNetworkPrefabs(string path, out bool isNew, bool addAll)
|
||||
{
|
||||
var defaultPrefabs = AssetDatabase.LoadAssetAtPath<NetworkPrefabsList>(path);
|
||||
if (defaultPrefabs == null)
|
||||
{
|
||||
isNew = true;
|
||||
defaultPrefabs = ScriptableObject.CreateInstance<NetworkPrefabsList>();
|
||||
defaultPrefabs.IsDefault = true;
|
||||
AssetDatabase.CreateAsset(defaultPrefabs, path);
|
||||
|
||||
if (addAll)
|
||||
{
|
||||
// This could be very expensive in large projects... maybe make it manually triggered via a menu?
|
||||
defaultPrefabs.List = FindAll();
|
||||
}
|
||||
EditorUtility.SetDirty(defaultPrefabs);
|
||||
AssetDatabase.SaveAssetIfDirty(defaultPrefabs);
|
||||
return defaultPrefabs;
|
||||
}
|
||||
|
||||
isNew = false;
|
||||
return defaultPrefabs;
|
||||
}
|
||||
|
||||
private static List<NetworkPrefab> FindAll()
|
||||
{
|
||||
var list = new List<NetworkPrefab>();
|
||||
|
||||
string[] guids = AssetDatabase.FindAssets("t:GameObject");
|
||||
foreach (var guid in guids)
|
||||
{
|
||||
string assetPath = AssetDatabase.GUIDToAssetPath(guid);
|
||||
var go = AssetDatabase.LoadAssetAtPath<GameObject>(assetPath);
|
||||
|
||||
if (go.TryGetComponent(out NetworkObject _))
|
||||
{
|
||||
list.Add(new NetworkPrefab { Prefab = go });
|
||||
}
|
||||
}
|
||||
|
||||
return list;
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Editor/Configuration/NetworkPrefabProcessor.cs.meta
Normal file
11
Editor/Configuration/NetworkPrefabProcessor.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: d8b62a05d80cc444f9c74731c01b8e39
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
97
Editor/Configuration/NetworkPrefabsEditor.cs
Normal file
97
Editor/Configuration/NetworkPrefabsEditor.cs
Normal file
@@ -0,0 +1,97 @@
|
||||
using UnityEditor;
|
||||
using UnityEditorInternal;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Editor
|
||||
{
|
||||
[CustomEditor(typeof(NetworkPrefabsList), true)]
|
||||
[CanEditMultipleObjects]
|
||||
public class NetworkPrefabsEditor : UnityEditor.Editor
|
||||
{
|
||||
private ReorderableList m_NetworkPrefabsList;
|
||||
private SerializedProperty m_IsDefaultBool;
|
||||
|
||||
private void OnEnable()
|
||||
{
|
||||
m_IsDefaultBool = serializedObject.FindProperty(nameof(NetworkPrefabsList.IsDefault));
|
||||
m_NetworkPrefabsList = new ReorderableList(serializedObject, serializedObject.FindProperty("List"), true, true, true, true);
|
||||
m_NetworkPrefabsList.elementHeightCallback = index =>
|
||||
{
|
||||
var networkOverrideInt = 0;
|
||||
if (m_NetworkPrefabsList.count > 0)
|
||||
{
|
||||
var networkPrefab = m_NetworkPrefabsList.serializedProperty.GetArrayElementAtIndex(index);
|
||||
var networkOverrideProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.Override));
|
||||
networkOverrideInt = networkOverrideProp.enumValueIndex;
|
||||
}
|
||||
|
||||
return 8 + (networkOverrideInt == 0 ? EditorGUIUtility.singleLineHeight : (EditorGUIUtility.singleLineHeight * 2) + 5);
|
||||
};
|
||||
m_NetworkPrefabsList.drawElementCallback = (rect, index, isActive, isFocused) =>
|
||||
{
|
||||
rect.y += 5;
|
||||
|
||||
var networkPrefab = m_NetworkPrefabsList.serializedProperty.GetArrayElementAtIndex(index);
|
||||
var networkPrefabProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.Prefab));
|
||||
var networkSourceHashProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.SourceHashToOverride));
|
||||
var networkSourcePrefabProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.SourcePrefabToOverride));
|
||||
var networkTargetPrefabProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.OverridingTargetPrefab));
|
||||
var networkOverrideProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.Override));
|
||||
var networkOverrideInt = networkOverrideProp.enumValueIndex;
|
||||
var networkOverrideEnum = (NetworkPrefabOverride)networkOverrideInt;
|
||||
EditorGUI.LabelField(new Rect(rect.x + rect.width - 70, rect.y, 60, EditorGUIUtility.singleLineHeight), "Override");
|
||||
if (networkOverrideEnum == NetworkPrefabOverride.None)
|
||||
{
|
||||
if (EditorGUI.Toggle(new Rect(rect.x + rect.width - 15, rect.y, 10, EditorGUIUtility.singleLineHeight), false))
|
||||
{
|
||||
networkOverrideProp.enumValueIndex = (int)NetworkPrefabOverride.Prefab;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if (!EditorGUI.Toggle(new Rect(rect.x + rect.width - 15, rect.y, 10, EditorGUIUtility.singleLineHeight), true))
|
||||
{
|
||||
networkOverrideProp.enumValueIndex = 0;
|
||||
networkOverrideEnum = NetworkPrefabOverride.None;
|
||||
}
|
||||
}
|
||||
|
||||
if (networkOverrideEnum == NetworkPrefabOverride.None)
|
||||
{
|
||||
EditorGUI.PropertyField(new Rect(rect.x, rect.y, rect.width - 80, EditorGUIUtility.singleLineHeight), networkPrefabProp, GUIContent.none);
|
||||
}
|
||||
else
|
||||
{
|
||||
networkOverrideProp.enumValueIndex = GUI.Toolbar(new Rect(rect.x, rect.y, 100, EditorGUIUtility.singleLineHeight), networkOverrideInt - 1, new[] { "Prefab", "Hash" }) + 1;
|
||||
|
||||
if (networkOverrideEnum == NetworkPrefabOverride.Prefab)
|
||||
{
|
||||
EditorGUI.PropertyField(new Rect(rect.x + 110, rect.y, rect.width - 190, EditorGUIUtility.singleLineHeight), networkSourcePrefabProp, GUIContent.none);
|
||||
}
|
||||
else
|
||||
{
|
||||
EditorGUI.PropertyField(new Rect(rect.x + 110, rect.y, rect.width - 190, EditorGUIUtility.singleLineHeight), networkSourceHashProp, GUIContent.none);
|
||||
}
|
||||
|
||||
rect.y += EditorGUIUtility.singleLineHeight + 5;
|
||||
|
||||
EditorGUI.LabelField(new Rect(rect.x, rect.y, 100, EditorGUIUtility.singleLineHeight), "Overriding Prefab");
|
||||
EditorGUI.PropertyField(new Rect(rect.x + 110, rect.y, rect.width - 110, EditorGUIUtility.singleLineHeight), networkTargetPrefabProp, GUIContent.none);
|
||||
}
|
||||
};
|
||||
m_NetworkPrefabsList.drawHeaderCallback = rect => EditorGUI.LabelField(rect, "NetworkPrefabs");
|
||||
}
|
||||
|
||||
public override void OnInspectorGUI()
|
||||
{
|
||||
using (new EditorGUI.DisabledScope(true))
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_IsDefaultBool);
|
||||
}
|
||||
|
||||
m_NetworkPrefabsList.DoLayoutList();
|
||||
|
||||
serializedObject.ApplyModifiedProperties();
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Editor/Configuration/NetworkPrefabsEditor.cs.meta
Normal file
11
Editor/Configuration/NetworkPrefabsEditor.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 8d6d0919fa8ff41c9b1d1241256f7364
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -4,6 +4,7 @@ using Unity.Netcode.Transports.UNET;
|
||||
#endif
|
||||
using Unity.Netcode.Transports.UTP;
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Editor
|
||||
{
|
||||
@@ -43,7 +44,109 @@ namespace Unity.Netcode.Editor
|
||||
[CustomEditor(typeof(UnityTransport), true)]
|
||||
public class UnityTransportEditor : HiddenScriptEditor
|
||||
{
|
||||
private static readonly string[] k_HiddenFields = { "m_Script", "ConnectionData" };
|
||||
|
||||
private bool m_AllowIncomingConnections;
|
||||
private bool m_Initialized;
|
||||
|
||||
private UnityTransport m_UnityTransport;
|
||||
|
||||
private SerializedProperty m_ServerAddressProperty;
|
||||
private SerializedProperty m_ServerPortProperty;
|
||||
private SerializedProperty m_OverrideBindIpProperty;
|
||||
|
||||
private const string k_LoopbackIpv4 = "127.0.0.1";
|
||||
private const string k_LoopbackIpv6 = "::1";
|
||||
private const string k_AnyIpv4 = "0.0.0.0";
|
||||
private const string k_AnyIpv6 = "::";
|
||||
|
||||
|
||||
private void Initialize()
|
||||
{
|
||||
if (m_Initialized)
|
||||
{
|
||||
return;
|
||||
}
|
||||
m_Initialized = true;
|
||||
m_UnityTransport = (UnityTransport)target;
|
||||
|
||||
var connectionDataProperty = serializedObject.FindProperty(nameof(UnityTransport.ConnectionData));
|
||||
|
||||
m_ServerAddressProperty = connectionDataProperty.FindPropertyRelative(nameof(UnityTransport.ConnectionAddressData.Address));
|
||||
m_ServerPortProperty = connectionDataProperty.FindPropertyRelative(nameof(UnityTransport.ConnectionAddressData.Port));
|
||||
m_OverrideBindIpProperty = connectionDataProperty.FindPropertyRelative(nameof(UnityTransport.ConnectionAddressData.ServerListenAddress));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Draws inspector properties without the script field.
|
||||
/// </summary>
|
||||
public override void OnInspectorGUI()
|
||||
{
|
||||
Initialize();
|
||||
EditorGUI.BeginChangeCheck();
|
||||
serializedObject.UpdateIfRequiredOrScript();
|
||||
DrawPropertiesExcluding(serializedObject, k_HiddenFields);
|
||||
serializedObject.ApplyModifiedProperties();
|
||||
EditorGUI.EndChangeCheck();
|
||||
|
||||
EditorGUILayout.PropertyField(m_ServerAddressProperty);
|
||||
EditorGUILayout.PropertyField(m_ServerPortProperty);
|
||||
|
||||
serializedObject.ApplyModifiedProperties();
|
||||
|
||||
EditorGUILayout.HelpBox("It's recommended to leave remote connections disabled for local testing to avoid exposing ports on your device.", MessageType.Info);
|
||||
bool allowRemoteConnections = m_UnityTransport.ConnectionData.ServerListenAddress != k_LoopbackIpv4 && m_UnityTransport.ConnectionData.ServerListenAddress != k_LoopbackIpv6 && !string.IsNullOrEmpty(m_UnityTransport.ConnectionData.ServerListenAddress);
|
||||
allowRemoteConnections = EditorGUILayout.Toggle(new GUIContent("Allow Remote Connections?", $"Bind IP: {m_UnityTransport.ConnectionData.ServerListenAddress}"), allowRemoteConnections);
|
||||
|
||||
bool isIpV6 = m_UnityTransport.ConnectionData.IsIpv6;
|
||||
|
||||
if (!allowRemoteConnections)
|
||||
{
|
||||
if (m_UnityTransport.ConnectionData.ServerListenAddress != k_LoopbackIpv4 && m_UnityTransport.ConnectionData.ServerListenAddress != k_LoopbackIpv6)
|
||||
{
|
||||
if (isIpV6)
|
||||
{
|
||||
m_UnityTransport.ConnectionData.ServerListenAddress = k_LoopbackIpv6;
|
||||
}
|
||||
else
|
||||
{
|
||||
m_UnityTransport.ConnectionData.ServerListenAddress = k_LoopbackIpv4;
|
||||
}
|
||||
EditorUtility.SetDirty(m_UnityTransport);
|
||||
}
|
||||
}
|
||||
|
||||
using (new EditorGUI.DisabledScope(!allowRemoteConnections))
|
||||
{
|
||||
string overrideIp = m_UnityTransport.ConnectionData.ServerListenAddress;
|
||||
if (overrideIp == k_AnyIpv4 || overrideIp == k_AnyIpv6 || overrideIp == k_LoopbackIpv4 || overrideIp == k_LoopbackIpv6)
|
||||
{
|
||||
overrideIp = "";
|
||||
}
|
||||
|
||||
overrideIp = EditorGUILayout.TextField("Override Bind IP (optional)", overrideIp);
|
||||
if (allowRemoteConnections)
|
||||
{
|
||||
if (overrideIp == "")
|
||||
{
|
||||
if (isIpV6)
|
||||
{
|
||||
overrideIp = k_AnyIpv6;
|
||||
}
|
||||
else
|
||||
{
|
||||
overrideIp = k_AnyIpv4;
|
||||
}
|
||||
}
|
||||
|
||||
if (m_UnityTransport.ConnectionData.ServerListenAddress != overrideIp)
|
||||
{
|
||||
m_UnityTransport.ConnectionData.ServerListenAddress = overrideIp;
|
||||
EditorUtility.SetDirty(m_UnityTransport);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#if COM_UNITY_MODULES_ANIMATION
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Reflection;
|
||||
using UnityEngine;
|
||||
using UnityEditor;
|
||||
using Unity.Netcode.Editor.Configuration;
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Editor
|
||||
{
|
||||
@@ -20,6 +20,7 @@ namespace Unity.Netcode.Editor
|
||||
private readonly Dictionary<string, object> m_NetworkVariableObjects = new Dictionary<string, object>();
|
||||
|
||||
private GUIContent m_NetworkVariableLabelGuiContent;
|
||||
private GUIContent m_NetworkListLabelGuiContent;
|
||||
|
||||
private void Init(MonoScript script)
|
||||
{
|
||||
@@ -30,12 +31,18 @@ namespace Unity.Netcode.Editor
|
||||
m_NetworkVariableObjects.Clear();
|
||||
|
||||
m_NetworkVariableLabelGuiContent = new GUIContent("NetworkVariable", "This variable is a NetworkVariable. It can not be serialized and can only be changed during runtime.");
|
||||
m_NetworkListLabelGuiContent = new GUIContent("NetworkList", "This variable is a NetworkList. It is rendered, but you can't serialize or change it.");
|
||||
|
||||
var fields = script.GetClass().GetFields(BindingFlags.Public | BindingFlags.Instance | BindingFlags.FlattenHierarchy);
|
||||
for (int i = 0; i < fields.Length; i++)
|
||||
{
|
||||
var ft = fields[i].FieldType;
|
||||
if (ft.IsGenericType && ft.GetGenericTypeDefinition() == typeof(NetworkVariable<>) && !fields[i].IsDefined(typeof(HideInInspector), true))
|
||||
if (ft.IsGenericType && ft.GetGenericTypeDefinition() == typeof(NetworkVariable<>) && !fields[i].IsDefined(typeof(HideInInspector), true) && !fields[i].IsDefined(typeof(NonSerializedAttribute), true))
|
||||
{
|
||||
m_NetworkVariableNames.Add(ObjectNames.NicifyVariableName(fields[i].Name));
|
||||
m_NetworkVariableFields.Add(ObjectNames.NicifyVariableName(fields[i].Name), fields[i]);
|
||||
}
|
||||
if (ft.IsGenericType && ft.GetGenericTypeDefinition() == typeof(NetworkList<>) && !fields[i].IsDefined(typeof(HideInInspector), true) && !fields[i].IsDefined(typeof(NonSerializedAttribute), true))
|
||||
{
|
||||
m_NetworkVariableNames.Add(ObjectNames.NicifyVariableName(fields[i].Name));
|
||||
m_NetworkVariableFields.Add(ObjectNames.NicifyVariableName(fields[i].Name), fields[i]);
|
||||
@@ -72,25 +79,82 @@ namespace Unity.Netcode.Editor
|
||||
EditorGUILayout.BeginHorizontal();
|
||||
if (genericType.IsValueType)
|
||||
{
|
||||
var method = typeof(NetworkBehaviourEditor).GetMethod("RenderNetworkVariableValueType", BindingFlags.Public | BindingFlags.Instance | BindingFlags.FlattenHierarchy | BindingFlags.NonPublic);
|
||||
var isEquatable = false;
|
||||
foreach (var iface in genericType.GetInterfaces())
|
||||
{
|
||||
if (iface.IsGenericType && iface.GetGenericTypeDefinition() == typeof(IEquatable<>))
|
||||
{
|
||||
isEquatable = true;
|
||||
}
|
||||
}
|
||||
|
||||
MethodInfo method;
|
||||
if (isEquatable)
|
||||
{
|
||||
method = typeof(NetworkBehaviourEditor).GetMethod(nameof(RenderNetworkContainerValueTypeIEquatable), BindingFlags.Public | BindingFlags.Instance | BindingFlags.FlattenHierarchy | BindingFlags.NonPublic);
|
||||
}
|
||||
else
|
||||
{
|
||||
method = typeof(NetworkBehaviourEditor).GetMethod(nameof(RenderNetworkContainerValueType), BindingFlags.Public | BindingFlags.Instance | BindingFlags.FlattenHierarchy | BindingFlags.NonPublic);
|
||||
}
|
||||
|
||||
var genericMethod = method.MakeGenericMethod(genericType);
|
||||
genericMethod.Invoke(this, new[] { (object)index });
|
||||
}
|
||||
else
|
||||
{
|
||||
EditorGUILayout.LabelField("Type not renderable");
|
||||
|
||||
GUILayout.Label(m_NetworkVariableLabelGuiContent, EditorStyles.miniLabel, GUILayout.Width(EditorStyles.miniLabel.CalcSize(m_NetworkVariableLabelGuiContent).x));
|
||||
EditorGUILayout.EndHorizontal();
|
||||
}
|
||||
}
|
||||
|
||||
private void RenderNetworkContainerValueType<T>(int index) where T : unmanaged
|
||||
{
|
||||
try
|
||||
{
|
||||
var networkVariable = (NetworkVariable<T>)m_NetworkVariableFields[m_NetworkVariableNames[index]].GetValue(target);
|
||||
RenderNetworkVariableValueType(index, networkVariable);
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
Debug.Log(e);
|
||||
throw;
|
||||
}
|
||||
|
||||
GUILayout.Label(m_NetworkVariableLabelGuiContent, EditorStyles.miniLabel, GUILayout.Width(EditorStyles.miniLabel.CalcSize(m_NetworkVariableLabelGuiContent).x));
|
||||
EditorGUILayout.EndHorizontal();
|
||||
}
|
||||
|
||||
private void RenderNetworkVariableValueType<T>(int index) where T : unmanaged
|
||||
private void RenderNetworkContainerValueTypeIEquatable<T>(int index) where T : unmanaged, IEquatable<T>
|
||||
{
|
||||
try
|
||||
{
|
||||
var networkVariable = (NetworkVariable<T>)m_NetworkVariableFields[m_NetworkVariableNames[index]].GetValue(target);
|
||||
RenderNetworkVariableValueType(index, networkVariable);
|
||||
}
|
||||
catch (Exception)
|
||||
{
|
||||
try
|
||||
{
|
||||
var networkList = (NetworkList<T>)m_NetworkVariableFields[m_NetworkVariableNames[index]].GetValue(target);
|
||||
RenderNetworkListValueType(index, networkList);
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
Debug.Log(e);
|
||||
throw;
|
||||
}
|
||||
}
|
||||
|
||||
EditorGUILayout.EndHorizontal();
|
||||
}
|
||||
|
||||
private void RenderNetworkVariableValueType<T>(int index, NetworkVariable<T> networkVariable) where T : unmanaged
|
||||
{
|
||||
var networkVariable = (NetworkVariable<T>)m_NetworkVariableFields[m_NetworkVariableNames[index]].GetValue(target);
|
||||
var type = typeof(T);
|
||||
object val = networkVariable.Value;
|
||||
string name = m_NetworkVariableNames[index];
|
||||
string variableName = m_NetworkVariableNames[index];
|
||||
|
||||
var behaviour = (NetworkBehaviour)target;
|
||||
|
||||
@@ -99,47 +163,51 @@ namespace Unity.Netcode.Editor
|
||||
{
|
||||
if (type == typeof(int))
|
||||
{
|
||||
val = EditorGUILayout.IntField(name, (int)val);
|
||||
val = EditorGUILayout.IntField(variableName, (int)val);
|
||||
}
|
||||
else if (type == typeof(uint))
|
||||
{
|
||||
val = (uint)EditorGUILayout.LongField(name, (long)((uint)val));
|
||||
val = (uint)EditorGUILayout.LongField(variableName, (uint)val);
|
||||
}
|
||||
else if (type == typeof(short))
|
||||
{
|
||||
val = (short)EditorGUILayout.IntField(name, (int)((short)val));
|
||||
val = (short)EditorGUILayout.IntField(variableName, (short)val);
|
||||
}
|
||||
else if (type == typeof(ushort))
|
||||
{
|
||||
val = (ushort)EditorGUILayout.IntField(name, (int)((ushort)val));
|
||||
val = (ushort)EditorGUILayout.IntField(variableName, (ushort)val);
|
||||
}
|
||||
else if (type == typeof(sbyte))
|
||||
{
|
||||
val = (sbyte)EditorGUILayout.IntField(name, (int)((sbyte)val));
|
||||
val = (sbyte)EditorGUILayout.IntField(variableName, (sbyte)val);
|
||||
}
|
||||
else if (type == typeof(byte))
|
||||
{
|
||||
val = (byte)EditorGUILayout.IntField(name, (int)((byte)val));
|
||||
val = (byte)EditorGUILayout.IntField(variableName, (byte)val);
|
||||
}
|
||||
else if (type == typeof(long))
|
||||
{
|
||||
val = EditorGUILayout.LongField(name, (long)val);
|
||||
val = EditorGUILayout.LongField(variableName, (long)val);
|
||||
}
|
||||
else if (type == typeof(ulong))
|
||||
{
|
||||
val = (ulong)EditorGUILayout.LongField(name, (long)((ulong)val));
|
||||
val = (ulong)EditorGUILayout.LongField(variableName, (long)((ulong)val));
|
||||
}
|
||||
else if (type == typeof(float))
|
||||
{
|
||||
val = EditorGUILayout.FloatField(variableName, (float)((float)val));
|
||||
}
|
||||
else if (type == typeof(bool))
|
||||
{
|
||||
val = EditorGUILayout.Toggle(name, (bool)val);
|
||||
val = EditorGUILayout.Toggle(variableName, (bool)val);
|
||||
}
|
||||
else if (type == typeof(string))
|
||||
{
|
||||
val = EditorGUILayout.TextField(name, (string)val);
|
||||
val = EditorGUILayout.TextField(variableName, (string)val);
|
||||
}
|
||||
else if (type.IsEnum)
|
||||
{
|
||||
val = EditorGUILayout.EnumPopup(name, (Enum)val);
|
||||
val = EditorGUILayout.EnumPopup(variableName, (Enum)val);
|
||||
}
|
||||
else
|
||||
{
|
||||
@@ -150,11 +218,31 @@ namespace Unity.Netcode.Editor
|
||||
}
|
||||
else
|
||||
{
|
||||
EditorGUILayout.LabelField(name, EditorStyles.wordWrappedLabel);
|
||||
EditorGUILayout.LabelField(variableName, EditorStyles.wordWrappedLabel);
|
||||
EditorGUILayout.SelectableLabel(val.ToString(), EditorStyles.wordWrappedLabel);
|
||||
}
|
||||
GUILayout.Label(m_NetworkVariableLabelGuiContent, EditorStyles.miniLabel, GUILayout.Width(EditorStyles.miniLabel.CalcSize(m_NetworkVariableLabelGuiContent).x));
|
||||
}
|
||||
|
||||
private void RenderNetworkListValueType<T>(int index, NetworkList<T> networkList)
|
||||
where T : unmanaged, IEquatable<T>
|
||||
{
|
||||
string variableName = m_NetworkVariableNames[index];
|
||||
|
||||
string value = "";
|
||||
bool addComma = false;
|
||||
foreach (var v in networkList)
|
||||
{
|
||||
if (addComma)
|
||||
{
|
||||
value += ", ";
|
||||
}
|
||||
value += v.ToString();
|
||||
addComma = true;
|
||||
}
|
||||
EditorGUILayout.LabelField(variableName, value);
|
||||
GUILayout.Label(m_NetworkListLabelGuiContent, EditorStyles.miniLabel, GUILayout.Width(EditorStyles.miniLabel.CalcSize(m_NetworkListLabelGuiContent).x));
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override void OnInspectorGUI()
|
||||
@@ -184,7 +272,7 @@ namespace Unity.Netcode.Editor
|
||||
bool expanded = true;
|
||||
while (property.NextVisible(expanded))
|
||||
{
|
||||
if (m_NetworkVariableNames.Contains(property.name))
|
||||
if (m_NetworkVariableNames.Contains(ObjectNames.NicifyVariableName(property.name)))
|
||||
{
|
||||
// Skip rendering of NetworkVars, they have special rendering
|
||||
continue;
|
||||
@@ -257,8 +345,9 @@ namespace Unity.Netcode.Editor
|
||||
/// <param name="networkObjectRemoved">used internally</param>
|
||||
public static void CheckForNetworkObject(GameObject gameObject, bool networkObjectRemoved = false)
|
||||
{
|
||||
// If there are no NetworkBehaviours or no gameObject, then exit early
|
||||
if (gameObject == null || (gameObject.GetComponent<NetworkBehaviour>() == null && gameObject.GetComponentInChildren<NetworkBehaviour>() == null))
|
||||
// If there are no NetworkBehaviours or gameObjects then exit early
|
||||
// If we are in play mode and a user is inspecting something then exit early (we don't add NetworkObjects to something when in play mode)
|
||||
if (EditorApplication.isPlaying || gameObject == null || (gameObject.GetComponent<NetworkBehaviour>() == null && gameObject.GetComponentInChildren<NetworkBehaviour>() == null))
|
||||
{
|
||||
return;
|
||||
}
|
||||
@@ -310,7 +399,7 @@ namespace Unity.Netcode.Editor
|
||||
// and the user has already turned "Auto-Add NetworkObject" on when first notified about the requirement
|
||||
// then just send a reminder to the user why the NetworkObject they just deleted seemingly "re-appeared"
|
||||
// again.
|
||||
if (networkObjectRemoved && NetcodeForGameObjectsSettings.GetAutoAddNetworkObjectSetting())
|
||||
if (networkObjectRemoved && NetcodeForGameObjectsEditorSettings.GetAutoAddNetworkObjectSetting())
|
||||
{
|
||||
Debug.LogWarning($"{gameObject.name} still has {nameof(NetworkBehaviour)}s and Auto-Add NetworkObjects is enabled. A NetworkObject is being added back to {gameObject.name}.");
|
||||
Debug.Log($"To reset Auto-Add NetworkObjects: Select the Netcode->General->Reset Auto-Add NetworkObject menu item.");
|
||||
@@ -319,7 +408,7 @@ namespace Unity.Netcode.Editor
|
||||
// Notify and provide the option to add it one time, always add a NetworkObject, or do nothing and let the user manually add it
|
||||
if (EditorUtility.DisplayDialog($"{nameof(NetworkBehaviour)}s require a {nameof(NetworkObject)}",
|
||||
$"{gameObject.name} does not have a {nameof(NetworkObject)} component. Would you like to add one now?", "Yes", "No (manually add it)",
|
||||
DialogOptOutDecisionType.ForThisMachine, NetcodeForGameObjectsSettings.AutoAddNetworkObjectIfNoneExists))
|
||||
DialogOptOutDecisionType.ForThisMachine, NetcodeForGameObjectsEditorSettings.AutoAddNetworkObjectIfNoneExists))
|
||||
{
|
||||
gameObject.AddComponent<NetworkObject>();
|
||||
var activeScene = UnityEngine.SceneManagement.SceneManager.GetActiveScene();
|
||||
@@ -328,6 +417,48 @@ namespace Unity.Netcode.Editor
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (networkObject != null)
|
||||
{
|
||||
OrderNetworkObject(networkObject);
|
||||
}
|
||||
}
|
||||
|
||||
// Assures the NetworkObject precedes any NetworkBehaviour on the same GameObject as the NetworkObject
|
||||
private static void OrderNetworkObject(NetworkObject networkObject)
|
||||
{
|
||||
var monoBehaviours = networkObject.gameObject.GetComponents<MonoBehaviour>();
|
||||
var networkObjectIndex = 0;
|
||||
var firstNetworkBehaviourIndex = -1;
|
||||
for (int i = 0; i < monoBehaviours.Length; i++)
|
||||
{
|
||||
if (monoBehaviours[i] == networkObject)
|
||||
{
|
||||
networkObjectIndex = i;
|
||||
break;
|
||||
}
|
||||
|
||||
var networkBehaviour = monoBehaviours[i] as NetworkBehaviour;
|
||||
if (networkBehaviour != null)
|
||||
{
|
||||
// Get the index of the first NetworkBehaviour Component
|
||||
if (firstNetworkBehaviourIndex == -1)
|
||||
{
|
||||
firstNetworkBehaviourIndex = i;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (firstNetworkBehaviourIndex != -1 && networkObjectIndex > firstNetworkBehaviourIndex)
|
||||
{
|
||||
var positionsToMove = networkObjectIndex - firstNetworkBehaviourIndex;
|
||||
for (int i = 0; i < positionsToMove; i++)
|
||||
{
|
||||
UnityEditorInternal.ComponentUtility.MoveComponentUp(networkObject);
|
||||
}
|
||||
|
||||
EditorUtility.SetDirty(networkObject.gameObject);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,9 +1,12 @@
|
||||
#if UNITY_2022_3_OR_NEWER && (RELAY_SDK_INSTALLED && !UNITY_WEBGL ) || (RELAY_SDK_INSTALLED && UNITY_WEBGL && UTP_TRANSPORT_2_0_ABOVE)
|
||||
#define RELAY_INTEGRATION_AVAILABLE
|
||||
#endif
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using Unity.Netcode.Editor.Configuration;
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
using UnityEditorInternal;
|
||||
using Unity.Netcode.Editor.Configuration;
|
||||
|
||||
namespace Unity.Netcode.Editor
|
||||
{
|
||||
@@ -40,8 +43,7 @@ namespace Unity.Netcode.Editor
|
||||
private SerializedProperty m_NetworkIdRecycleDelayProperty;
|
||||
private SerializedProperty m_RpcHashSizeProperty;
|
||||
private SerializedProperty m_LoadSceneTimeOutProperty;
|
||||
|
||||
private ReorderableList m_NetworkPrefabsList;
|
||||
private SerializedProperty m_PrefabsList;
|
||||
|
||||
private NetworkManager m_NetworkManager;
|
||||
private bool m_Initialized;
|
||||
@@ -49,6 +51,27 @@ namespace Unity.Netcode.Editor
|
||||
private readonly List<Type> m_TransportTypes = new List<Type>();
|
||||
private string[] m_TransportNames = { "Select transport..." };
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override void OnInspectorGUI()
|
||||
{
|
||||
Initialize();
|
||||
CheckNullProperties();
|
||||
|
||||
#if !MULTIPLAYER_TOOLS
|
||||
DrawInstallMultiplayerToolsTip();
|
||||
#endif
|
||||
|
||||
if (m_NetworkManager.IsServer || m_NetworkManager.IsClient)
|
||||
{
|
||||
DrawDisconnectButton();
|
||||
}
|
||||
else
|
||||
{
|
||||
DrawAllPropertyFields();
|
||||
ShowStartConnectionButtons();
|
||||
}
|
||||
}
|
||||
|
||||
private void ReloadTransports()
|
||||
{
|
||||
m_TransportTypes.Clear();
|
||||
@@ -106,7 +129,9 @@ namespace Unity.Netcode.Editor
|
||||
m_NetworkIdRecycleDelayProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkIdRecycleDelay");
|
||||
m_RpcHashSizeProperty = m_NetworkConfigProperty.FindPropertyRelative("RpcHashSize");
|
||||
m_LoadSceneTimeOutProperty = m_NetworkConfigProperty.FindPropertyRelative("LoadSceneTimeOut");
|
||||
|
||||
m_PrefabsList = m_NetworkConfigProperty
|
||||
.FindPropertyRelative(nameof(NetworkConfig.Prefabs))
|
||||
.FindPropertyRelative(nameof(NetworkPrefabs.NetworkPrefabsLists));
|
||||
|
||||
ReloadTransports();
|
||||
}
|
||||
@@ -132,249 +157,337 @@ namespace Unity.Netcode.Editor
|
||||
m_NetworkIdRecycleDelayProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkIdRecycleDelay");
|
||||
m_RpcHashSizeProperty = m_NetworkConfigProperty.FindPropertyRelative("RpcHashSize");
|
||||
m_LoadSceneTimeOutProperty = m_NetworkConfigProperty.FindPropertyRelative("LoadSceneTimeOut");
|
||||
m_PrefabsList = m_NetworkConfigProperty
|
||||
.FindPropertyRelative(nameof(NetworkConfig.Prefabs))
|
||||
.FindPropertyRelative(nameof(NetworkPrefabs.NetworkPrefabsLists));
|
||||
}
|
||||
|
||||
private void OnEnable()
|
||||
private void DrawAllPropertyFields()
|
||||
{
|
||||
m_NetworkPrefabsList = new ReorderableList(serializedObject, serializedObject.FindProperty(nameof(NetworkManager.NetworkConfig)).FindPropertyRelative(nameof(NetworkConfig.NetworkPrefabs)), true, true, true, true);
|
||||
m_NetworkPrefabsList.elementHeightCallback = index =>
|
||||
serializedObject.Update();
|
||||
EditorGUILayout.PropertyField(m_RunInBackgroundProperty);
|
||||
EditorGUILayout.PropertyField(m_LogLevelProperty);
|
||||
EditorGUILayout.Space();
|
||||
|
||||
EditorGUILayout.PropertyField(m_PlayerPrefabProperty);
|
||||
EditorGUILayout.Space();
|
||||
|
||||
DrawPrefabListField();
|
||||
|
||||
EditorGUILayout.Space();
|
||||
|
||||
EditorGUILayout.LabelField("General", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_ProtocolVersionProperty);
|
||||
|
||||
DrawTransportField();
|
||||
|
||||
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))
|
||||
{
|
||||
var networkOverrideInt = 0;
|
||||
if (m_NetworkPrefabsList.count > 0)
|
||||
{
|
||||
var networkPrefab = m_NetworkPrefabsList.serializedProperty.GetArrayElementAtIndex(index);
|
||||
var networkOverrideProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.Override));
|
||||
networkOverrideInt = networkOverrideProp.enumValueIndex;
|
||||
}
|
||||
EditorGUILayout.PropertyField(m_ClientConnectionBufferTimeoutProperty);
|
||||
}
|
||||
|
||||
return 8 + (networkOverrideInt == 0 ? EditorGUIUtility.singleLineHeight : (EditorGUIUtility.singleLineHeight * 2) + 5);
|
||||
};
|
||||
m_NetworkPrefabsList.drawElementCallback = (rect, index, isActive, isFocused) =>
|
||||
EditorGUILayout.LabelField("Spawning", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_ForceSamePrefabsProperty);
|
||||
|
||||
EditorGUILayout.PropertyField(m_RecycleNetworkIdsProperty);
|
||||
|
||||
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.RecycleNetworkIds))
|
||||
{
|
||||
rect.y += 5;
|
||||
EditorGUILayout.PropertyField(m_NetworkIdRecycleDelayProperty);
|
||||
}
|
||||
|
||||
var networkPrefab = m_NetworkPrefabsList.serializedProperty.GetArrayElementAtIndex(index);
|
||||
var networkPrefabProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.Prefab));
|
||||
var networkSourceHashProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.SourceHashToOverride));
|
||||
var networkSourcePrefabProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.SourcePrefabToOverride));
|
||||
var networkTargetPrefabProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.OverridingTargetPrefab));
|
||||
var networkOverrideProp = networkPrefab.FindPropertyRelative(nameof(NetworkPrefab.Override));
|
||||
var networkOverrideInt = networkOverrideProp.enumValueIndex;
|
||||
var networkOverrideEnum = (NetworkPrefabOverride)networkOverrideInt;
|
||||
EditorGUI.LabelField(new Rect(rect.x + rect.width - 70, rect.y, 60, EditorGUIUtility.singleLineHeight), "Override");
|
||||
if (networkOverrideEnum == NetworkPrefabOverride.None)
|
||||
{
|
||||
if (EditorGUI.Toggle(new Rect(rect.x + rect.width - 15, rect.y, 10, EditorGUIUtility.singleLineHeight), false))
|
||||
{
|
||||
networkOverrideProp.enumValueIndex = (int)NetworkPrefabOverride.Prefab;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if (!EditorGUI.Toggle(new Rect(rect.x + rect.width - 15, rect.y, 10, EditorGUIUtility.singleLineHeight), true))
|
||||
{
|
||||
networkOverrideProp.enumValueIndex = 0;
|
||||
networkOverrideEnum = NetworkPrefabOverride.None;
|
||||
}
|
||||
}
|
||||
EditorGUILayout.LabelField("Bandwidth", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_RpcHashSizeProperty);
|
||||
|
||||
if (networkOverrideEnum == NetworkPrefabOverride.None)
|
||||
{
|
||||
EditorGUI.PropertyField(new Rect(rect.x, rect.y, rect.width - 80, EditorGUIUtility.singleLineHeight), networkPrefabProp, GUIContent.none);
|
||||
}
|
||||
else
|
||||
{
|
||||
networkOverrideProp.enumValueIndex = GUI.Toolbar(new Rect(rect.x, rect.y, 100, EditorGUIUtility.singleLineHeight), networkOverrideInt - 1, new[] { "Prefab", "Hash" }) + 1;
|
||||
EditorGUILayout.LabelField("Scene Management", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_EnableSceneManagementProperty);
|
||||
|
||||
if (networkOverrideEnum == NetworkPrefabOverride.Prefab)
|
||||
{
|
||||
EditorGUI.PropertyField(new Rect(rect.x + 110, rect.y, rect.width - 190, EditorGUIUtility.singleLineHeight), networkSourcePrefabProp, GUIContent.none);
|
||||
}
|
||||
else
|
||||
{
|
||||
EditorGUI.PropertyField(new Rect(rect.x + 110, rect.y, rect.width - 190, EditorGUIUtility.singleLineHeight), networkSourceHashProp, GUIContent.none);
|
||||
}
|
||||
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.EnableSceneManagement))
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_LoadSceneTimeOutProperty);
|
||||
}
|
||||
|
||||
rect.y += EditorGUIUtility.singleLineHeight + 5;
|
||||
|
||||
EditorGUI.LabelField(new Rect(rect.x, rect.y, 100, EditorGUIUtility.singleLineHeight), "Overriding Prefab");
|
||||
EditorGUI.PropertyField(new Rect(rect.x + 110, rect.y, rect.width - 110, EditorGUIUtility.singleLineHeight), networkTargetPrefabProp, GUIContent.none);
|
||||
}
|
||||
};
|
||||
m_NetworkPrefabsList.drawHeaderCallback = rect => EditorGUI.LabelField(rect, "NetworkPrefabs");
|
||||
serializedObject.ApplyModifiedProperties();
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override void OnInspectorGUI()
|
||||
private void DrawTransportField()
|
||||
{
|
||||
Initialize();
|
||||
CheckNullProperties();
|
||||
|
||||
#if !MULTIPLAYER_TOOLS
|
||||
DrawInstallMultiplayerToolsTip();
|
||||
#if RELAY_INTEGRATION_AVAILABLE
|
||||
var useRelay = EditorPrefs.GetBool(m_UseEasyRelayIntegrationKey, false);
|
||||
#else
|
||||
var useRelay = false;
|
||||
#endif
|
||||
|
||||
if (!m_NetworkManager.IsServer && !m_NetworkManager.IsClient)
|
||||
if (useRelay)
|
||||
{
|
||||
serializedObject.Update();
|
||||
EditorGUILayout.PropertyField(m_RunInBackgroundProperty);
|
||||
EditorGUILayout.PropertyField(m_LogLevelProperty);
|
||||
EditorGUILayout.Space();
|
||||
|
||||
EditorGUILayout.PropertyField(m_PlayerPrefabProperty);
|
||||
EditorGUILayout.Space();
|
||||
|
||||
m_NetworkPrefabsList.DoLayoutList();
|
||||
EditorGUILayout.Space();
|
||||
|
||||
EditorGUILayout.LabelField("General", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_ProtocolVersionProperty);
|
||||
|
||||
EditorGUILayout.HelpBox("Test connection with relay is enabled, so the default Unity Transport will be used", MessageType.Info);
|
||||
GUI.enabled = false;
|
||||
EditorGUILayout.PropertyField(m_NetworkTransportProperty);
|
||||
GUI.enabled = true;
|
||||
return;
|
||||
}
|
||||
|
||||
if (m_NetworkTransportProperty.objectReferenceValue == null)
|
||||
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)
|
||||
{
|
||||
EditorGUILayout.HelpBox("You have no transport selected. A transport is required for netcode to work. Which one do you want?", MessageType.Warning);
|
||||
ReloadTransports();
|
||||
|
||||
int selection = EditorGUILayout.Popup(0, m_TransportNames);
|
||||
var transportComponent = m_NetworkManager.gameObject.GetComponent(m_TransportTypes[selection - 1]) ?? m_NetworkManager.gameObject.AddComponent(m_TransportTypes[selection - 1]);
|
||||
m_NetworkTransportProperty.objectReferenceValue = transportComponent;
|
||||
|
||||
if (selection > 0)
|
||||
{
|
||||
ReloadTransports();
|
||||
|
||||
var transportComponent = m_NetworkManager.gameObject.GetComponent(m_TransportTypes[selection - 1]);
|
||||
|
||||
if (transportComponent == null)
|
||||
{
|
||||
transportComponent = m_NetworkManager.gameObject.AddComponent(m_TransportTypes[selection - 1]);
|
||||
}
|
||||
|
||||
m_NetworkTransportProperty.objectReferenceValue = transportComponent;
|
||||
|
||||
Repaint();
|
||||
}
|
||||
Repaint();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
EditorGUILayout.PropertyField(m_TickRateProperty);
|
||||
#if RELAY_INTEGRATION_AVAILABLE
|
||||
private readonly string m_UseEasyRelayIntegrationKey = "NetworkManagerUI_UseRelay_" + Application.dataPath.GetHashCode();
|
||||
private string m_JoinCode = "";
|
||||
private string m_StartConnectionError = null;
|
||||
private string m_Region = "";
|
||||
|
||||
EditorGUILayout.LabelField("Performance", EditorStyles.boldLabel);
|
||||
// wait for next frame so that ImGui finishes the current frame
|
||||
private static void RunNextFrame(Action action) => EditorApplication.delayCall += () => action();
|
||||
#endif
|
||||
|
||||
EditorGUILayout.PropertyField(m_EnsureNetworkVariableLengthSafetyProperty);
|
||||
private void ShowStartConnectionButtons()
|
||||
{
|
||||
EditorGUILayout.LabelField("Start Connection", EditorStyles.boldLabel);
|
||||
|
||||
EditorGUILayout.LabelField("Connection", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_ConnectionApprovalProperty);
|
||||
#if RELAY_INTEGRATION_AVAILABLE
|
||||
// use editor prefs to persist the setting when entering / leaving play mode / exiting Unity
|
||||
var useRelay = EditorPrefs.GetBool(m_UseEasyRelayIntegrationKey, false);
|
||||
GUILayout.BeginHorizontal();
|
||||
useRelay = GUILayout.Toggle(useRelay, "Try Relay in the Editor");
|
||||
|
||||
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.ConnectionApproval))
|
||||
var icon = EditorGUIUtility.IconContent("_Help");
|
||||
icon.tooltip = "This will help you test relay in the Editor. Click here to know how to integrate Relay in your build";
|
||||
if (GUILayout.Button(icon, GUIStyle.none, GUILayout.Width(20)))
|
||||
{
|
||||
Application.OpenURL("https://docs-multiplayer.unity3d.com/netcode/current/relay/");
|
||||
}
|
||||
GUILayout.EndHorizontal();
|
||||
|
||||
EditorPrefs.SetBool(m_UseEasyRelayIntegrationKey, useRelay);
|
||||
if (useRelay && !Application.isPlaying && !CloudProjectSettings.projectBound)
|
||||
{
|
||||
EditorGUILayout.HelpBox("To use relay, you need to setup your project in the Project Settings in the Services section.", MessageType.Warning);
|
||||
if (GUILayout.Button("Open Project settings"))
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_ClientConnectionBufferTimeoutProperty);
|
||||
SettingsService.OpenProjectSettings("Project/Services");
|
||||
}
|
||||
}
|
||||
#else
|
||||
var useRelay = false;
|
||||
#endif
|
||||
|
||||
EditorGUILayout.LabelField("Spawning", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_ForceSamePrefabsProperty);
|
||||
string buttonDisabledReasonSuffix = "";
|
||||
|
||||
if (!EditorApplication.isPlaying)
|
||||
{
|
||||
buttonDisabledReasonSuffix = ". This can only be done in play mode";
|
||||
GUI.enabled = false;
|
||||
}
|
||||
|
||||
EditorGUILayout.PropertyField(m_RecycleNetworkIdsProperty);
|
||||
|
||||
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.RecycleNetworkIds))
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_NetworkIdRecycleDelayProperty);
|
||||
}
|
||||
|
||||
EditorGUILayout.LabelField("Bandwidth", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_RpcHashSizeProperty);
|
||||
|
||||
EditorGUILayout.LabelField("Scene Management", EditorStyles.boldLabel);
|
||||
EditorGUILayout.PropertyField(m_EnableSceneManagementProperty);
|
||||
|
||||
using (new EditorGUI.DisabledScope(!m_NetworkManager.NetworkConfig.EnableSceneManagement))
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_LoadSceneTimeOutProperty);
|
||||
}
|
||||
|
||||
serializedObject.ApplyModifiedProperties();
|
||||
|
||||
|
||||
// Start buttons below
|
||||
{
|
||||
string buttonDisabledReasonSuffix = "";
|
||||
|
||||
if (!EditorApplication.isPlaying)
|
||||
{
|
||||
buttonDisabledReasonSuffix = ". This can only be done in play mode";
|
||||
GUI.enabled = false;
|
||||
}
|
||||
|
||||
if (GUILayout.Button(new GUIContent("Start Host", "Starts a host instance" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_NetworkManager.StartHost();
|
||||
}
|
||||
|
||||
if (GUILayout.Button(new GUIContent("Start Server", "Starts a server instance" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_NetworkManager.StartServer();
|
||||
}
|
||||
|
||||
if (GUILayout.Button(new GUIContent("Start Client", "Starts a client instance" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_NetworkManager.StartClient();
|
||||
}
|
||||
|
||||
if (!EditorApplication.isPlaying)
|
||||
{
|
||||
GUI.enabled = true;
|
||||
}
|
||||
}
|
||||
if (useRelay)
|
||||
{
|
||||
ShowStartConnectionButtons_Relay(buttonDisabledReasonSuffix);
|
||||
}
|
||||
else
|
||||
{
|
||||
string instanceType = string.Empty;
|
||||
ShowStartConnectionButtons_Standard(buttonDisabledReasonSuffix);
|
||||
}
|
||||
|
||||
if (m_NetworkManager.IsHost)
|
||||
{
|
||||
instanceType = "Host";
|
||||
}
|
||||
else if (m_NetworkManager.IsServer)
|
||||
{
|
||||
instanceType = "Server";
|
||||
}
|
||||
else if (m_NetworkManager.IsClient)
|
||||
{
|
||||
instanceType = "Client";
|
||||
}
|
||||
|
||||
EditorGUILayout.HelpBox("You cannot edit the NetworkConfig when a " + instanceType + " is running.", MessageType.Info);
|
||||
|
||||
if (GUILayout.Button(new GUIContent("Stop " + instanceType, "Stops the " + instanceType + " instance.")))
|
||||
{
|
||||
m_NetworkManager.Shutdown();
|
||||
}
|
||||
if (!EditorApplication.isPlaying)
|
||||
{
|
||||
GUI.enabled = true;
|
||||
}
|
||||
}
|
||||
|
||||
private void ShowStartConnectionButtons_Relay(string buttonDisabledReasonSuffix)
|
||||
{
|
||||
#if RELAY_INTEGRATION_AVAILABLE
|
||||
|
||||
void AddStartServerOrHostButton(bool isServer)
|
||||
{
|
||||
var type = isServer ? "Server" : "Host";
|
||||
if (GUILayout.Button(new GUIContent($"Start {type}", $"Starts a {type} instance with Relay{buttonDisabledReasonSuffix}")))
|
||||
{
|
||||
m_StartConnectionError = null;
|
||||
RunNextFrame(async () =>
|
||||
{
|
||||
try
|
||||
{
|
||||
var (joinCode, allocation) = isServer ? await m_NetworkManager.StartServerWithRelay() : await m_NetworkManager.StartHostWithRelay();
|
||||
m_JoinCode = joinCode;
|
||||
m_Region = allocation.Region;
|
||||
Repaint();
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
m_StartConnectionError = e.Message;
|
||||
throw;
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
AddStartServerOrHostButton(isServer: true);
|
||||
AddStartServerOrHostButton(isServer: false);
|
||||
|
||||
GUILayout.Space(8f);
|
||||
m_JoinCode = EditorGUILayout.TextField("Relay Join Code", m_JoinCode);
|
||||
if (GUILayout.Button(new GUIContent("Start Client", "Starts a client instance with Relay" + buttonDisabledReasonSuffix)))
|
||||
{
|
||||
m_StartConnectionError = null;
|
||||
RunNextFrame(async () =>
|
||||
{
|
||||
if (string.IsNullOrEmpty(m_JoinCode))
|
||||
{
|
||||
m_StartConnectionError = "Please provide a join code!";
|
||||
return;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
var allocation = await m_NetworkManager.StartClientWithRelay(m_JoinCode);
|
||||
m_Region = allocation.Region;
|
||||
Repaint();
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
m_StartConnectionError = e.Message;
|
||||
throw;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
if (Application.isPlaying && !string.IsNullOrEmpty(m_StartConnectionError))
|
||||
{
|
||||
EditorGUILayout.HelpBox(m_StartConnectionError, MessageType.Error);
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
private void ShowStartConnectionButtons_Standard(string buttonDisabledReasonSuffix)
|
||||
{
|
||||
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();
|
||||
}
|
||||
}
|
||||
|
||||
private void DrawDisconnectButton()
|
||||
{
|
||||
string instanceType = string.Empty;
|
||||
|
||||
if (m_NetworkManager.IsHost)
|
||||
{
|
||||
instanceType = "Host";
|
||||
}
|
||||
else if (m_NetworkManager.IsServer)
|
||||
{
|
||||
instanceType = "Server";
|
||||
}
|
||||
else if (m_NetworkManager.IsClient)
|
||||
{
|
||||
instanceType = "Client";
|
||||
}
|
||||
|
||||
EditorGUILayout.HelpBox($"You cannot edit the NetworkConfig when a {instanceType} is running.", MessageType.Info);
|
||||
|
||||
#if RELAY_INTEGRATION_AVAILABLE
|
||||
if (!string.IsNullOrEmpty(m_JoinCode) && !string.IsNullOrEmpty(m_Region))
|
||||
{
|
||||
var style = new GUIStyle(EditorStyles.helpBox)
|
||||
{
|
||||
fontSize = 10,
|
||||
alignment = TextAnchor.MiddleCenter,
|
||||
};
|
||||
|
||||
GUILayout.BeginHorizontal(style, GUILayout.ExpandWidth(true), GUILayout.ExpandHeight(false), GUILayout.MaxWidth(800));
|
||||
GUILayout.Label(new GUIContent(EditorGUIUtility.IconContent(k_InfoIconName)), GUILayout.ExpandWidth(false), GUILayout.ExpandHeight(true));
|
||||
GUILayout.Space(25f);
|
||||
GUILayout.BeginVertical();
|
||||
GUILayout.Space(4f);
|
||||
GUILayout.Label($"Connected via relay ({m_Region}).\nJoin code: {m_JoinCode}", EditorStyles.miniLabel, GUILayout.ExpandHeight(true));
|
||||
|
||||
if (GUILayout.Button("Copy code", GUILayout.ExpandHeight(true)))
|
||||
{
|
||||
GUIUtility.systemCopyBuffer = m_JoinCode;
|
||||
}
|
||||
|
||||
GUILayout.Space(4f);
|
||||
GUILayout.EndVertical();
|
||||
GUILayout.Space(2f);
|
||||
GUILayout.EndHorizontal();
|
||||
}
|
||||
#endif
|
||||
|
||||
if (GUILayout.Button(new GUIContent($"Stop {instanceType}", $"Stops the {instanceType} instance.")))
|
||||
{
|
||||
#if RELAY_INTEGRATION_AVAILABLE
|
||||
m_JoinCode = "";
|
||||
#endif
|
||||
m_NetworkManager.Shutdown();
|
||||
}
|
||||
}
|
||||
|
||||
private const string k_InfoIconName = "console.infoicon";
|
||||
private static void DrawInstallMultiplayerToolsTip()
|
||||
{
|
||||
const string getToolsText = "Access additional tools for multiplayer development by installing the Multiplayer Tools package in the Package Manager.";
|
||||
const string openDocsButtonText = "Open Docs";
|
||||
const string dismissButtonText = "Dismiss";
|
||||
const string targetUrl = "https://docs-multiplayer.unity3d.com/netcode/current/tools/install-tools";
|
||||
const string infoIconName = "console.infoicon";
|
||||
const string targetUrl = "https://docs-multiplayer.unity3d.com/tools/current/install-tools";
|
||||
|
||||
if (NetcodeForGameObjectsSettings.GetNetcodeInstallMultiplayerToolTips() != 0)
|
||||
|
||||
if (NetcodeForGameObjectsEditorSettings.GetNetcodeInstallMultiplayerToolTips() != 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (s_CenteredWordWrappedLabelStyle == null)
|
||||
{
|
||||
s_CenteredWordWrappedLabelStyle = new GUIStyle(GUI.skin.label);
|
||||
s_CenteredWordWrappedLabelStyle.wordWrap = true;
|
||||
s_CenteredWordWrappedLabelStyle.alignment = TextAnchor.MiddleLeft;
|
||||
s_CenteredWordWrappedLabelStyle = new GUIStyle(GUI.skin.label)
|
||||
{
|
||||
wordWrap = true,
|
||||
alignment = TextAnchor.MiddleLeft
|
||||
};
|
||||
}
|
||||
|
||||
if (s_HelpBoxStyle == null)
|
||||
{
|
||||
s_HelpBoxStyle = new GUIStyle(EditorStyles.helpBox);
|
||||
s_HelpBoxStyle.padding = new RectOffset(10, 10, 10, 10);
|
||||
s_HelpBoxStyle = new GUIStyle(EditorStyles.helpBox)
|
||||
{
|
||||
padding = new RectOffset(10, 10, 10, 10)
|
||||
};
|
||||
}
|
||||
|
||||
var openDocsButtonStyle = GUI.skin.button;
|
||||
@@ -384,7 +497,7 @@ namespace Unity.Netcode.Editor
|
||||
GUILayout.FlexibleSpace();
|
||||
GUILayout.BeginHorizontal(s_HelpBoxStyle, GUILayout.ExpandWidth(true), GUILayout.ExpandHeight(false), GUILayout.MaxWidth(800));
|
||||
{
|
||||
GUILayout.Label(new GUIContent(EditorGUIUtility.IconContent(infoIconName)), GUILayout.ExpandWidth(false), GUILayout.ExpandHeight(true));
|
||||
GUILayout.Label(new GUIContent(EditorGUIUtility.IconContent(k_InfoIconName)), GUILayout.ExpandWidth(false), GUILayout.ExpandHeight(true));
|
||||
GUILayout.Space(4);
|
||||
GUILayout.Label(getToolsText, s_CenteredWordWrappedLabelStyle, GUILayout.ExpandHeight(true));
|
||||
|
||||
@@ -405,7 +518,7 @@ namespace Unity.Netcode.Editor
|
||||
GUILayout.FlexibleSpace();
|
||||
if (GUILayout.Button(dismissButtonText, dismissButtonStyle, GUILayout.ExpandWidth(false)))
|
||||
{
|
||||
NetcodeForGameObjectsSettings.SetNetcodeInstallMultiplayerToolTips(1);
|
||||
NetcodeForGameObjectsEditorSettings.SetNetcodeInstallMultiplayerToolTips(1);
|
||||
}
|
||||
EditorGUIUtility.AddCursorRect(GUILayoutUtility.GetLastRect(), MouseCursor.Link);
|
||||
GUILayout.FlexibleSpace();
|
||||
@@ -417,5 +530,69 @@ namespace Unity.Netcode.Editor
|
||||
|
||||
GUILayout.Space(10);
|
||||
}
|
||||
|
||||
private void DrawPrefabListField()
|
||||
{
|
||||
if (!m_NetworkManager.NetworkConfig.HasOldPrefabList())
|
||||
{
|
||||
if (m_NetworkManager.NetworkConfig.Prefabs.NetworkPrefabsLists.Count == 0)
|
||||
{
|
||||
EditorGUILayout.HelpBox("You have no prefab list selected. You will have to add your prefabs manually at runtime for netcode to work.", MessageType.Warning);
|
||||
}
|
||||
|
||||
EditorGUILayout.PropertyField(m_PrefabsList);
|
||||
return;
|
||||
}
|
||||
|
||||
// Old format of prefab list
|
||||
EditorGUILayout.HelpBox("Network Prefabs serialized in old format. Migrate to new format to edit the list.", MessageType.Info);
|
||||
if (GUILayout.Button(new GUIContent("Migrate Prefab List", "Converts the old format Network Prefab list to a new Scriptable Object")))
|
||||
{
|
||||
// Default directory
|
||||
var directory = "Assets/";
|
||||
var assetPath = AssetDatabase.GetAssetPath(m_NetworkManager);
|
||||
if (assetPath == "")
|
||||
{
|
||||
assetPath = PrefabUtility.GetPrefabAssetPathOfNearestInstanceRoot(m_NetworkManager);
|
||||
}
|
||||
|
||||
if (assetPath != "")
|
||||
{
|
||||
directory = Path.GetDirectoryName(assetPath);
|
||||
}
|
||||
else
|
||||
{
|
||||
|
||||
#if UNITY_2021_1_OR_NEWER
|
||||
var prefabStage = UnityEditor.SceneManagement.PrefabStageUtility.GetPrefabStage(m_NetworkManager.gameObject);
|
||||
#else
|
||||
var prefabStage = UnityEditor.Experimental.SceneManagement.PrefabStageUtility.GetPrefabStage(m_NetworkManager.gameObject);
|
||||
#endif
|
||||
if (prefabStage != null)
|
||||
{
|
||||
var prefabPath = prefabStage.assetPath;
|
||||
if (!string.IsNullOrEmpty(prefabPath))
|
||||
{
|
||||
directory = Path.GetDirectoryName(prefabPath);
|
||||
}
|
||||
}
|
||||
|
||||
if (m_NetworkManager.gameObject.scene != null)
|
||||
{
|
||||
var scenePath = m_NetworkManager.gameObject.scene.path;
|
||||
if (!string.IsNullOrEmpty(scenePath))
|
||||
{
|
||||
directory = Path.GetDirectoryName(scenePath);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var networkPrefabs = m_NetworkManager.NetworkConfig.MigrateOldNetworkPrefabsToNetworkPrefabsList();
|
||||
string path = Path.Combine(directory, $"NetworkPrefabs-{m_NetworkManager.GetInstanceID()}.asset");
|
||||
Debug.Log("Saving migrated Network Prefabs List to " + path);
|
||||
AssetDatabase.CreateAsset(networkPrefabs, path);
|
||||
EditorUtility.SetDirty(m_NetworkManager);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Unity.Netcode.Editor.Configuration;
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
using UnityEngine.SceneManagement;
|
||||
using UnityEditor;
|
||||
|
||||
namespace Unity.Netcode.Editor
|
||||
{
|
||||
@@ -32,6 +33,24 @@ namespace Unity.Netcode.Editor
|
||||
|
||||
EditorApplication.playModeStateChanged += EditorApplication_playModeStateChanged;
|
||||
EditorApplication.hierarchyChanged += EditorApplication_hierarchyChanged;
|
||||
|
||||
// Initialize default values for new NetworkManagers
|
||||
//
|
||||
// When the default prefab list is enabled, this will default
|
||||
// new NetworkManagers to using it.
|
||||
//
|
||||
// This will get run when new NetworkManagers are added, and
|
||||
// when the user presses the "reset" button on a NetworkManager
|
||||
// in the inspector.
|
||||
NetworkManager.OnNetworkManagerReset = manager =>
|
||||
{
|
||||
var settings = NetcodeForGameObjectsProjectSettings.instance;
|
||||
if (settings.GenerateDefaultNetworkPrefabs)
|
||||
{
|
||||
manager.NetworkConfig = new NetworkConfig();
|
||||
manager.NetworkConfig.Prefabs.NetworkPrefabsLists = new List<NetworkPrefabsList> { NetworkPrefabProcessor.GetOrCreateNetworkPrefabs(NetworkPrefabProcessor.DefaultNetworkPrefabsPath, out _, true) };
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private static void EditorApplication_playModeStateChanged(PlayModeStateChange playModeStateChange)
|
||||
|
||||
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,6 +1,6 @@
|
||||
using System.Collections.Generic;
|
||||
using UnityEngine;
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode.Editor
|
||||
{
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
using Unity.Netcode.Components;
|
||||
using UnityEditor;
|
||||
using UnityEngine;
|
||||
using Unity.Netcode.Components;
|
||||
|
||||
namespace Unity.Netcode.Editor
|
||||
{
|
||||
@@ -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;
|
||||
@@ -25,15 +26,23 @@ namespace Unity.Netcode.Editor
|
||||
private SerializedProperty m_InLocalSpaceProperty;
|
||||
private SerializedProperty m_InterpolateProperty;
|
||||
|
||||
private SerializedProperty m_UseQuaternionSynchronization;
|
||||
private SerializedProperty m_UseQuaternionCompression;
|
||||
private SerializedProperty m_UseHalfFloatPrecision;
|
||||
private SerializedProperty m_SlerpPosition;
|
||||
|
||||
private static int s_ToggleOffset = 45;
|
||||
private static float s_MaxRowWidth = EditorGUIUtility.labelWidth + EditorGUIUtility.fieldWidth + 5;
|
||||
private static GUIContent s_PositionLabel = EditorGUIUtility.TrTextContent("Position");
|
||||
private static GUIContent s_RotationLabel = EditorGUIUtility.TrTextContent("Rotation");
|
||||
private static GUIContent s_ScaleLabel = EditorGUIUtility.TrTextContent("Scale");
|
||||
|
||||
public virtual bool HideInterpolateValue => false;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public 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));
|
||||
@@ -48,6 +57,10 @@ namespace Unity.Netcode.Editor
|
||||
m_ScaleThresholdProperty = serializedObject.FindProperty(nameof(NetworkTransform.ScaleThreshold));
|
||||
m_InLocalSpaceProperty = serializedObject.FindProperty(nameof(NetworkTransform.InLocalSpace));
|
||||
m_InterpolateProperty = serializedObject.FindProperty(nameof(NetworkTransform.Interpolate));
|
||||
m_UseQuaternionSynchronization = serializedObject.FindProperty(nameof(NetworkTransform.UseQuaternionSynchronization));
|
||||
m_UseQuaternionCompression = serializedObject.FindProperty(nameof(NetworkTransform.UseQuaternionCompression));
|
||||
m_UseHalfFloatPrecision = serializedObject.FindProperty(nameof(NetworkTransform.UseHalfFloatPrecision));
|
||||
m_SlerpPosition = serializedObject.FindProperty(nameof(NetworkTransform.SlerpPosition));
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
@@ -71,6 +84,8 @@ namespace Unity.Netcode.Editor
|
||||
|
||||
GUILayout.EndHorizontal();
|
||||
}
|
||||
|
||||
if (!m_UseQuaternionSynchronization.boolValue)
|
||||
{
|
||||
GUILayout.BeginHorizontal();
|
||||
|
||||
@@ -88,6 +103,13 @@ namespace Unity.Netcode.Editor
|
||||
|
||||
GUILayout.EndHorizontal();
|
||||
}
|
||||
else
|
||||
{
|
||||
m_SyncRotationXProperty.boolValue = true;
|
||||
m_SyncRotationYProperty.boolValue = true;
|
||||
m_SyncRotationZProperty.boolValue = true;
|
||||
}
|
||||
|
||||
{
|
||||
GUILayout.BeginHorizontal();
|
||||
|
||||
@@ -111,15 +133,33 @@ namespace Unity.Netcode.Editor
|
||||
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 (!HideInterpolateValue)
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_InterpolateProperty);
|
||||
}
|
||||
|
||||
EditorGUILayout.PropertyField(m_SlerpPosition);
|
||||
EditorGUILayout.PropertyField(m_UseQuaternionSynchronization);
|
||||
if (m_UseQuaternionSynchronization.boolValue)
|
||||
{
|
||||
EditorGUILayout.PropertyField(m_UseQuaternionCompression);
|
||||
}
|
||||
else
|
||||
{
|
||||
m_UseQuaternionCompression.boolValue = false;
|
||||
}
|
||||
EditorGUILayout.PropertyField(m_UseHalfFloatPrecision);
|
||||
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
// if rigidbody is present but network rigidbody is not present
|
||||
var go = ((NetworkTransform)target).gameObject;
|
||||
|
||||
#if COM_UNITY_MODULES_PHYSICS
|
||||
if (go.TryGetComponent<Rigidbody>(out _) && go.TryGetComponent<NetworkRigidbody>(out _) == false)
|
||||
{
|
||||
EditorGUILayout.HelpBox("This GameObject contains a Rigidbody but no NetworkRigidbody.\n" +
|
||||
|
||||
@@ -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,17 @@
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"noEngineReferences": false
|
||||
}
|
||||
@@ -1,15 +1,25 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Components")]
|
||||
#if UNITY_EDITOR
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.EditorTests")]
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Editor.CodeGen")]
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Editor")]
|
||||
[assembly: InternalsVisibleTo("TestProject.EditorTests")]
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Editor.CodeGen")]
|
||||
#endif
|
||||
[assembly: InternalsVisibleTo("TestProject.ToolsIntegration.RuntimeTests")]
|
||||
[assembly: InternalsVisibleTo("TestProject.RuntimeTests")]
|
||||
#endif // UNITY_EDITOR
|
||||
#if MULTIPLAYER_TOOLS
|
||||
[assembly: InternalsVisibleTo("Unity.Multiplayer.Tools.Adapters.Ngo1WithUtp2")]
|
||||
#endif // MULTIPLAYER_TOOLS
|
||||
#if COM_UNITY_NETCODE_ADAPTER_UTP
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Adapter.UTP")]
|
||||
#endif // COM_UNITY_NETCODE_ADAPTER_UTP
|
||||
|
||||
#if UNITY_INCLUDE_TESTS
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.RuntimeTests")]
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.TestHelpers.Runtime")]
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.Adapter.UTP")]
|
||||
[assembly: InternalsVisibleTo("Unity.Multiplayer.Tools.Adapters.Ngo1WithUtp2")]
|
||||
[assembly: InternalsVisibleTo("TestProject.RuntimeTests")]
|
||||
#if UNITY_EDITOR
|
||||
[assembly: InternalsVisibleTo("Unity.Netcode.EditorTests")]
|
||||
[assembly: InternalsVisibleTo("TestProject.EditorTests")]
|
||||
#endif // UNITY_EDITOR
|
||||
#if MULTIPLAYER_TOOLS
|
||||
[assembly: InternalsVisibleTo("TestProject.ToolsIntegration.RuntimeTests")]
|
||||
#endif // MULTIPLAYER_TOOLS
|
||||
#endif // UNITY_INCLUDE_TESTS
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using UnityEngine;
|
||||
using System.Linq;
|
||||
using Unity.Collections;
|
||||
using UnityEngine;
|
||||
using UnityEngine.Serialization;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
@@ -30,20 +31,8 @@ namespace Unity.Netcode
|
||||
[Tooltip("When set, NetworkManager will automatically create and spawn the assigned player prefab. This can be overridden by adding it to the NetworkPrefabs list and selecting override.")]
|
||||
public GameObject PlayerPrefab;
|
||||
|
||||
/// <summary>
|
||||
/// A list of prefabs that can be dynamically spawned.
|
||||
/// </summary>
|
||||
[SerializeField]
|
||||
[Tooltip("The prefabs that can be spawned across the network")]
|
||||
internal List<NetworkPrefab> NetworkPrefabs = new List<NetworkPrefab>();
|
||||
|
||||
/// <summary>
|
||||
/// This dictionary provides a quick way to check and see if a NetworkPrefab has a NetworkPrefab override.
|
||||
/// Generated at runtime and OnValidate
|
||||
/// </summary>
|
||||
internal Dictionary<uint, NetworkPrefab> NetworkPrefabOverrideLinks = new Dictionary<uint, NetworkPrefab>();
|
||||
|
||||
internal Dictionary<uint, uint> OverrideToNetworkPrefab = new Dictionary<uint, uint>();
|
||||
public NetworkPrefabs Prefabs = new NetworkPrefabs();
|
||||
|
||||
|
||||
/// <summary>
|
||||
@@ -143,7 +132,7 @@ namespace Unity.Netcode
|
||||
/// 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.
|
||||
/// </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;
|
||||
public float SpawnTimeout = 10f;
|
||||
|
||||
/// <summary>
|
||||
/// Whether or not to enable network logs.
|
||||
@@ -167,7 +156,7 @@ namespace Unity.Netcode
|
||||
public string ToBase64()
|
||||
{
|
||||
NetworkConfig config = this;
|
||||
var writer = new FastBufferWriter(MessagingSystem.NON_FRAGMENTED_MESSAGE_MAX_SIZE, Allocator.Temp);
|
||||
var writer = new FastBufferWriter(1024, Allocator.Temp);
|
||||
using (writer)
|
||||
{
|
||||
writer.WriteValueSafe(config.ProtocolVersion);
|
||||
@@ -219,6 +208,14 @@ namespace Unity.Netcode
|
||||
|
||||
private ulong? m_ConfigHash = null;
|
||||
|
||||
/// <summary>
|
||||
/// Clears out the configuration hash value generated for a specific network session
|
||||
/// </summary>
|
||||
internal void ClearConfigHash()
|
||||
{
|
||||
m_ConfigHash = null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a SHA256 hash of parts of the NetworkConfig instance
|
||||
/// </summary>
|
||||
@@ -231,7 +228,7 @@ namespace Unity.Netcode
|
||||
return m_ConfigHash.Value;
|
||||
}
|
||||
|
||||
var writer = new FastBufferWriter(MessagingSystem.NON_FRAGMENTED_MESSAGE_MAX_SIZE, Allocator.Temp, int.MaxValue);
|
||||
var writer = new FastBufferWriter(1024, Allocator.Temp, int.MaxValue);
|
||||
using (writer)
|
||||
{
|
||||
writer.WriteValueSafe(ProtocolVersion);
|
||||
@@ -239,7 +236,7 @@ namespace Unity.Netcode
|
||||
|
||||
if (ForceSamePrefabs)
|
||||
{
|
||||
var sortedDictionary = NetworkPrefabOverrideLinks.OrderBy(x => x.Key);
|
||||
var sortedDictionary = Prefabs.NetworkPrefabOverrideLinks.OrderBy(x => x.Key);
|
||||
foreach (var sortedEntry in sortedDictionary)
|
||||
|
||||
{
|
||||
@@ -273,6 +270,75 @@ namespace Unity.Netcode
|
||||
{
|
||||
return hash == GetConfig();
|
||||
}
|
||||
|
||||
internal void InitializePrefabs()
|
||||
{
|
||||
if (HasOldPrefabList())
|
||||
{
|
||||
MigrateOldNetworkPrefabsToNetworkPrefabsList();
|
||||
}
|
||||
|
||||
Prefabs.Initialize();
|
||||
}
|
||||
|
||||
[NonSerialized]
|
||||
private bool m_DidWarnOldPrefabList = false;
|
||||
|
||||
private void WarnOldPrefabList()
|
||||
{
|
||||
if (!m_DidWarnOldPrefabList)
|
||||
{
|
||||
Debug.LogWarning("Using Legacy Network Prefab List. Consider Migrating.");
|
||||
m_DidWarnOldPrefabList = true;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns true if the old List<NetworkPrefab> serialized data is present.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Internal use only to help migrate projects. <seealso cref="MigrateOldNetworkPrefabsToNetworkPrefabsList"/></remarks>
|
||||
internal bool HasOldPrefabList()
|
||||
{
|
||||
return OldPrefabList?.Count > 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Migrate the old format List<NetworkPrefab> prefab registration to the new NetworkPrefabsList ScriptableObject.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// OnAfterDeserialize cannot instantiate new objects (e.g. NetworkPrefabsList SO) since it executes in a thread, so we have to do it later.
|
||||
/// Since NetworkConfig isn't a Unity.Object it doesn't get an Awake callback, so we have to do this in NetworkManager and expose this API.
|
||||
/// </remarks>
|
||||
internal NetworkPrefabsList MigrateOldNetworkPrefabsToNetworkPrefabsList()
|
||||
{
|
||||
if (OldPrefabList == null || OldPrefabList.Count == 0)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
if (Prefabs == null)
|
||||
{
|
||||
throw new Exception("Prefabs field is null.");
|
||||
}
|
||||
|
||||
Prefabs.NetworkPrefabsLists.Add(ScriptableObject.CreateInstance<NetworkPrefabsList>());
|
||||
|
||||
if (OldPrefabList?.Count > 0)
|
||||
{
|
||||
// Migrate legacy types/fields
|
||||
foreach (var networkPrefab in OldPrefabList)
|
||||
{
|
||||
Prefabs.NetworkPrefabsLists[Prefabs.NetworkPrefabsLists.Count - 1].Add(networkPrefab);
|
||||
}
|
||||
}
|
||||
|
||||
OldPrefabList = null;
|
||||
return Prefabs.NetworkPrefabsLists[Prefabs.NetworkPrefabsLists.Count - 1];
|
||||
}
|
||||
|
||||
[FormerlySerializedAs("NetworkPrefabs")]
|
||||
[SerializeField]
|
||||
internal List<NetworkPrefab> OldPrefabList;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -3,10 +3,25 @@ using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal enum NetworkPrefabOverride
|
||||
/// <summary>
|
||||
/// The method of NetworkPrefab override used to identify the source prefab
|
||||
/// </summary>
|
||||
public enum NetworkPrefabOverride
|
||||
{
|
||||
/// <summary>
|
||||
/// No oeverride is present
|
||||
/// </summary>
|
||||
None,
|
||||
|
||||
/// <summary>
|
||||
/// Override the prefab when the given SourcePrefabToOverride is requested
|
||||
/// </summary>
|
||||
Prefab,
|
||||
|
||||
/// <summary>
|
||||
/// Override the prefab when the given SourceHashToOverride is requested
|
||||
/// Used in situations where the server assets do not exist in client builds
|
||||
/// </summary>
|
||||
Hash
|
||||
}
|
||||
|
||||
@@ -14,10 +29,10 @@ namespace Unity.Netcode
|
||||
/// Class that represents a NetworkPrefab
|
||||
/// </summary>
|
||||
[Serializable]
|
||||
internal class NetworkPrefab
|
||||
public class NetworkPrefab
|
||||
{
|
||||
/// <summary>
|
||||
/// The override setttings for this NetworkPrefab
|
||||
/// The override settings for this NetworkPrefab
|
||||
/// </summary>
|
||||
public NetworkPrefabOverride Override;
|
||||
|
||||
@@ -41,5 +56,177 @@ namespace Unity.Netcode
|
||||
/// The prefab to replace (override) the source prefab with
|
||||
/// </summary>
|
||||
public GameObject OverridingTargetPrefab;
|
||||
|
||||
public bool Equals(NetworkPrefab other)
|
||||
{
|
||||
return Override == other.Override &&
|
||||
Prefab == other.Prefab &&
|
||||
SourcePrefabToOverride == other.SourcePrefabToOverride &&
|
||||
SourceHashToOverride == other.SourceHashToOverride &&
|
||||
OverridingTargetPrefab == other.OverridingTargetPrefab;
|
||||
}
|
||||
|
||||
public uint SourcePrefabGlobalObjectIdHash
|
||||
{
|
||||
get
|
||||
{
|
||||
switch (Override)
|
||||
{
|
||||
case NetworkPrefabOverride.None:
|
||||
{
|
||||
if (Prefab != null && Prefab.TryGetComponent(out NetworkObject networkObject))
|
||||
{
|
||||
return networkObject.GlobalObjectIdHash;
|
||||
}
|
||||
|
||||
throw new InvalidOperationException($"Prefab field is not set or is not a {nameof(NetworkObject)}");
|
||||
}
|
||||
case NetworkPrefabOverride.Prefab:
|
||||
{
|
||||
if (SourcePrefabToOverride != null && SourcePrefabToOverride.TryGetComponent(out NetworkObject networkObject))
|
||||
{
|
||||
return networkObject.GlobalObjectIdHash;
|
||||
}
|
||||
|
||||
throw new InvalidOperationException($"Source Prefab field is not set or is not a {nameof(NetworkObject)}");
|
||||
}
|
||||
case NetworkPrefabOverride.Hash:
|
||||
return SourceHashToOverride;
|
||||
default:
|
||||
throw new ArgumentOutOfRangeException();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public uint TargetPrefabGlobalObjectIdHash
|
||||
{
|
||||
get
|
||||
{
|
||||
switch (Override)
|
||||
{
|
||||
case NetworkPrefabOverride.None:
|
||||
return 0;
|
||||
case NetworkPrefabOverride.Prefab:
|
||||
case NetworkPrefabOverride.Hash:
|
||||
{
|
||||
if (OverridingTargetPrefab != null && OverridingTargetPrefab.TryGetComponent(out NetworkObject networkObject))
|
||||
{
|
||||
return networkObject.GlobalObjectIdHash;
|
||||
}
|
||||
|
||||
throw new InvalidOperationException($"Target Prefab field is not set or is not a {nameof(NetworkObject)}");
|
||||
}
|
||||
default:
|
||||
throw new ArgumentOutOfRangeException();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public bool Validate(int index = -1)
|
||||
{
|
||||
NetworkObject networkObject;
|
||||
if (Override == NetworkPrefabOverride.None)
|
||||
{
|
||||
if (Prefab == null)
|
||||
{
|
||||
NetworkLog.LogWarning($"{nameof(NetworkPrefab)} cannot be null ({nameof(NetworkPrefab)} at index: {index})");
|
||||
return false;
|
||||
}
|
||||
|
||||
networkObject = Prefab.GetComponent<NetworkObject>();
|
||||
if (networkObject == null)
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
|
||||
{
|
||||
NetworkLog.LogWarning($"{NetworkPrefabHandler.PrefabDebugHelper(this)} is missing a {nameof(NetworkObject)} component (entry will be ignored).");
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
// Validate source prefab override values first
|
||||
switch (Override)
|
||||
{
|
||||
case NetworkPrefabOverride.Hash:
|
||||
{
|
||||
if (SourceHashToOverride == 0)
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
|
||||
{
|
||||
NetworkLog.LogWarning($"{nameof(NetworkPrefab)} {nameof(SourceHashToOverride)} is zero (entry will be ignored).");
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case NetworkPrefabOverride.Prefab:
|
||||
{
|
||||
if (SourcePrefabToOverride == null)
|
||||
{
|
||||
// This is a leftover side-effect from NetworkManager's OnValidate. It's a usability
|
||||
// adjustment to automatically set the "Prefab" field as the source prefab when a user
|
||||
// swaps from the default Inspector to the override one.
|
||||
if (Prefab != null)
|
||||
{
|
||||
SourcePrefabToOverride = Prefab;
|
||||
}
|
||||
else if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
|
||||
{
|
||||
NetworkLog.LogWarning($"{nameof(NetworkPrefab)} {nameof(SourcePrefabToOverride)} is null (entry will be ignored).");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
if (!SourcePrefabToOverride.TryGetComponent(out networkObject))
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
|
||||
{
|
||||
NetworkLog.LogWarning($"{nameof(NetworkPrefab)} ({SourcePrefabToOverride.name}) is missing a {nameof(NetworkObject)} component (entry will be ignored).");
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Validate target prefab override values next
|
||||
if (OverridingTargetPrefab == null)
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
|
||||
{
|
||||
NetworkLog.LogWarning($"{nameof(NetworkPrefab)} {nameof(OverridingTargetPrefab)} is null!");
|
||||
}
|
||||
|
||||
switch (Override)
|
||||
{
|
||||
case NetworkPrefabOverride.Hash:
|
||||
{
|
||||
Debug.LogWarning($"{nameof(NetworkPrefab)} override entry {SourceHashToOverride} will be removed and ignored.");
|
||||
break;
|
||||
}
|
||||
case NetworkPrefabOverride.Prefab:
|
||||
{
|
||||
Debug.LogWarning($"{nameof(NetworkPrefab)} override entry ({SourcePrefabToOverride.name}) will be removed and ignored.");
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public override string ToString()
|
||||
{
|
||||
return $"{{SourceHash: {SourceHashToOverride}, TargetHash: {TargetPrefabGlobalObjectIdHash}}}";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
323
Runtime/Configuration/NetworkPrefabs.cs
Normal file
323
Runtime/Configuration/NetworkPrefabs.cs
Normal file
@@ -0,0 +1,323 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Text;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// A class that represents the runtime aspect of network prefabs.
|
||||
/// This class contains processed prefabs from the NetworkPrefabsList, as
|
||||
/// well as additional modifications (additions and removals) made at runtime.
|
||||
/// </summary>
|
||||
[Serializable]
|
||||
public class NetworkPrefabs
|
||||
{
|
||||
/// <summary>
|
||||
/// Edit-time scripted object containing a list of NetworkPrefabs.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This field can be null if no prefabs are pre-configured.
|
||||
/// Runtime usages of <see cref="NetworkPrefabs"/> should not depend on this edit-time field for execution.
|
||||
/// </remarks>
|
||||
[SerializeField]
|
||||
public List<NetworkPrefabsList> NetworkPrefabsLists = new List<NetworkPrefabsList>();
|
||||
|
||||
/// <summary>
|
||||
/// This dictionary provides a quick way to check and see if a NetworkPrefab has a NetworkPrefab override.
|
||||
/// Generated at runtime and OnValidate
|
||||
/// </summary>
|
||||
[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>();
|
||||
|
||||
public IReadOnlyList<NetworkPrefab> Prefabs => m_Prefabs;
|
||||
|
||||
[NonSerialized]
|
||||
private List<NetworkPrefab> m_Prefabs = new List<NetworkPrefab>();
|
||||
|
||||
[NonSerialized]
|
||||
private List<NetworkPrefab> m_RuntimeAddedPrefabs = new List<NetworkPrefab>();
|
||||
|
||||
private void AddTriggeredByNetworkPrefabList(NetworkPrefab networkPrefab)
|
||||
{
|
||||
if (AddPrefabRegistration(networkPrefab))
|
||||
{
|
||||
// Don't add this to m_RuntimeAddedPrefabs
|
||||
// This prefab is now in the PrefabList, so if we shutdown and initialize again, we'll pick it up from there.
|
||||
m_Prefabs.Add(networkPrefab);
|
||||
}
|
||||
}
|
||||
|
||||
private void RemoveTriggeredByNetworkPrefabList(NetworkPrefab networkPrefab)
|
||||
{
|
||||
m_Prefabs.Remove(networkPrefab);
|
||||
}
|
||||
|
||||
~NetworkPrefabs()
|
||||
{
|
||||
Shutdown();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Deregister from add and remove events
|
||||
/// Clear the list
|
||||
/// </summary>
|
||||
internal void Shutdown()
|
||||
{
|
||||
foreach (var list in NetworkPrefabsLists)
|
||||
{
|
||||
list.OnAdd -= AddTriggeredByNetworkPrefabList;
|
||||
list.OnRemove -= RemoveTriggeredByNetworkPrefabList;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Processes the <see cref="NetworkPrefabsList"/> if one is present for use during runtime execution,
|
||||
/// else processes <see cref="Prefabs"/>.
|
||||
/// </summary>
|
||||
public void Initialize(bool warnInvalid = true)
|
||||
{
|
||||
m_Prefabs.Clear();
|
||||
foreach (var list in NetworkPrefabsLists)
|
||||
{
|
||||
list.OnAdd += AddTriggeredByNetworkPrefabList;
|
||||
list.OnRemove += RemoveTriggeredByNetworkPrefabList;
|
||||
}
|
||||
|
||||
NetworkPrefabOverrideLinks.Clear();
|
||||
OverrideToNetworkPrefab.Clear();
|
||||
|
||||
var prefabs = new List<NetworkPrefab>();
|
||||
|
||||
if (NetworkPrefabsLists.Count != 0)
|
||||
{
|
||||
foreach (var list in NetworkPrefabsLists)
|
||||
{
|
||||
foreach (var networkPrefab in list.PrefabList)
|
||||
{
|
||||
prefabs.Add(networkPrefab);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
m_Prefabs = new List<NetworkPrefab>();
|
||||
|
||||
List<NetworkPrefab> removeList = null;
|
||||
if (warnInvalid)
|
||||
{
|
||||
removeList = new List<NetworkPrefab>();
|
||||
}
|
||||
|
||||
foreach (var networkPrefab in prefabs)
|
||||
{
|
||||
if (AddPrefabRegistration(networkPrefab))
|
||||
{
|
||||
m_Prefabs.Add(networkPrefab);
|
||||
}
|
||||
else
|
||||
{
|
||||
removeList?.Add(networkPrefab);
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var networkPrefab in m_RuntimeAddedPrefabs)
|
||||
{
|
||||
if (AddPrefabRegistration(networkPrefab))
|
||||
{
|
||||
m_Prefabs.Add(networkPrefab);
|
||||
}
|
||||
else
|
||||
{
|
||||
removeList?.Add(networkPrefab);
|
||||
}
|
||||
}
|
||||
|
||||
// Clear out anything that is invalid or not used
|
||||
if (removeList?.Count > 0)
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
|
||||
{
|
||||
var sb = new StringBuilder("Removing invalid prefabs from Network Prefab registration: ");
|
||||
sb.Append(string.Join(", ", removeList));
|
||||
NetworkLog.LogWarning(sb.ToString());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Add a new NetworkPrefab instance to the list
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.
|
||||
///
|
||||
/// Any modifications made here are not persisted. Permanent configuration changes should be done
|
||||
/// through the <see cref="NetworkPrefabsList"/> scriptable object property.
|
||||
/// </remarks>
|
||||
public bool Add(NetworkPrefab networkPrefab)
|
||||
{
|
||||
if (AddPrefabRegistration(networkPrefab))
|
||||
{
|
||||
m_Prefabs.Add(networkPrefab);
|
||||
m_RuntimeAddedPrefabs.Add(networkPrefab);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Remove a NetworkPrefab instance from the list
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.
|
||||
///
|
||||
/// Any modifications made here are not persisted. Permanent configuration changes should be done
|
||||
/// through the <see cref="NetworkPrefabsList"/> scriptable object property.
|
||||
/// </remarks>
|
||||
public void Remove(NetworkPrefab prefab)
|
||||
{
|
||||
if (prefab == null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(prefab));
|
||||
}
|
||||
|
||||
m_Prefabs.Remove(prefab);
|
||||
m_RuntimeAddedPrefabs.Remove(prefab);
|
||||
OverrideToNetworkPrefab.Remove(prefab.TargetPrefabGlobalObjectIdHash);
|
||||
NetworkPrefabOverrideLinks.Remove(prefab.SourcePrefabGlobalObjectIdHash);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Remove a NetworkPrefab instance with matching <see cref="NetworkPrefab.Prefab"/> from the list
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.
|
||||
///
|
||||
/// Any modifications made here are not persisted. Permanent configuration changes should be done
|
||||
/// through the <see cref="NetworkPrefabsList"/> scriptable object property.
|
||||
/// </remarks>
|
||||
public void Remove(GameObject prefab)
|
||||
{
|
||||
if (prefab == null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(prefab));
|
||||
}
|
||||
|
||||
for (int i = 0; i < m_Prefabs.Count; i++)
|
||||
{
|
||||
if (m_Prefabs[i].Prefab == prefab)
|
||||
{
|
||||
Remove(m_Prefabs[i]);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
for (int i = 0; i < m_RuntimeAddedPrefabs.Count; i++)
|
||||
{
|
||||
if (m_RuntimeAddedPrefabs[i].Prefab == prefab)
|
||||
{
|
||||
Remove(m_RuntimeAddedPrefabs[i]);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Check if the given GameObject is present as a prefab within the list
|
||||
/// </summary>
|
||||
/// <param name="prefab">The prefab to check</param>
|
||||
/// <returns>Whether or not the prefab exists</returns>
|
||||
public bool Contains(GameObject prefab)
|
||||
{
|
||||
for (int i = 0; i < m_Prefabs.Count; i++)
|
||||
{
|
||||
// Check both values as Prefab and be different than SourcePrefabToOverride
|
||||
if (m_Prefabs[i].Prefab == prefab || m_Prefabs[i].SourcePrefabToOverride == prefab)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Check if the given NetworkPrefab is present within the list
|
||||
/// </summary>
|
||||
/// <param name="prefab">The prefab to check</param>
|
||||
/// <returns>Whether or not the prefab exists</returns>
|
||||
public bool Contains(NetworkPrefab prefab)
|
||||
{
|
||||
for (int i = 0; i < m_Prefabs.Count; i++)
|
||||
{
|
||||
if (m_Prefabs[i].Equals(prefab))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Configures <see cref="NetworkPrefabOverrideLinks"/> for the given <see cref="NetworkPrefab"/>
|
||||
/// </summary>
|
||||
private bool AddPrefabRegistration(NetworkPrefab networkPrefab)
|
||||
{
|
||||
if (networkPrefab == null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
// Safeguard validation check since this method is called from outside of NetworkConfig and we can't control what's passed in.
|
||||
if (!networkPrefab.Validate())
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
uint source = networkPrefab.SourcePrefabGlobalObjectIdHash;
|
||||
uint target = networkPrefab.TargetPrefabGlobalObjectIdHash;
|
||||
|
||||
// Make sure the prefab isn't already registered.
|
||||
if (NetworkPrefabOverrideLinks.ContainsKey(source))
|
||||
{
|
||||
var networkObject = networkPrefab.Prefab.GetComponent<NetworkObject>();
|
||||
|
||||
// This should never happen, but in the case it somehow does log an error and remove the duplicate entry
|
||||
Debug.LogError($"{nameof(NetworkPrefab)} ({networkObject.name}) has a duplicate {nameof(NetworkObject.GlobalObjectIdHash)} source entry value of: {source}!");
|
||||
return false;
|
||||
}
|
||||
|
||||
// If we don't have an override configured, registration is simple!
|
||||
if (networkPrefab.Override == NetworkPrefabOverride.None)
|
||||
{
|
||||
NetworkPrefabOverrideLinks.Add(source, networkPrefab);
|
||||
return true;
|
||||
}
|
||||
|
||||
switch (networkPrefab.Override)
|
||||
{
|
||||
case NetworkPrefabOverride.Prefab:
|
||||
case NetworkPrefabOverride.Hash:
|
||||
{
|
||||
NetworkPrefabOverrideLinks.Add(source, networkPrefab);
|
||||
if (!OverrideToNetworkPrefab.ContainsKey(target))
|
||||
{
|
||||
OverrideToNetworkPrefab.Add(target, source);
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Runtime/Configuration/NetworkPrefabs.cs.meta
Normal file
11
Runtime/Configuration/NetworkPrefabs.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 230fc75f5639e46dc91734aa67d56a3e
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
95
Runtime/Configuration/NetworkPrefabsList.cs
Normal file
95
Runtime/Configuration/NetworkPrefabsList.cs
Normal file
@@ -0,0 +1,95 @@
|
||||
using System.Collections.Generic;
|
||||
using UnityEngine;
|
||||
using UnityEngine.Serialization;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// A ScriptableObject for holding a network prefabs list, which can be
|
||||
/// shared between multiple NetworkManagers.
|
||||
///
|
||||
/// When NetworkManagers hold references to this list, modifications to the
|
||||
/// list at runtime will be picked up by all NetworkManagers that reference it.
|
||||
/// </summary>
|
||||
[CreateAssetMenu(fileName = "NetworkPrefabsList", menuName = "Netcode/Network Prefabs List")]
|
||||
public class NetworkPrefabsList : ScriptableObject
|
||||
{
|
||||
internal delegate void OnAddDelegate(NetworkPrefab prefab);
|
||||
internal OnAddDelegate OnAdd;
|
||||
|
||||
internal delegate void OnRemoveDelegate(NetworkPrefab prefab);
|
||||
internal OnRemoveDelegate OnRemove;
|
||||
|
||||
[SerializeField]
|
||||
internal bool IsDefault;
|
||||
|
||||
[FormerlySerializedAs("Prefabs")]
|
||||
[SerializeField]
|
||||
internal List<NetworkPrefab> List = new List<NetworkPrefab>();
|
||||
|
||||
/// <summary>
|
||||
/// Read-only view into the prefabs list, enabling iterating and examining the list.
|
||||
/// Actually modifying the list should be done using <see cref="Add"/>
|
||||
/// and <see cref="Remove"/>.
|
||||
/// </summary>
|
||||
public IReadOnlyList<NetworkPrefab> PrefabList => List;
|
||||
|
||||
/// <summary>
|
||||
/// Adds a prefab to the prefab list. Performing this here will apply the operation to all
|
||||
/// <see cref="NetworkManager"/>s that reference this list.
|
||||
/// </summary>
|
||||
/// <param name="prefab"></param>
|
||||
public void Add(NetworkPrefab prefab)
|
||||
{
|
||||
List.Add(prefab);
|
||||
OnAdd?.Invoke(prefab);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Removes a prefab from the prefab list. Performing this here will apply the operation to all
|
||||
/// <see cref="NetworkManager"/>s that reference this list.
|
||||
/// </summary>
|
||||
/// <param name="prefab"></param>
|
||||
public void Remove(NetworkPrefab prefab)
|
||||
{
|
||||
List.Remove(prefab);
|
||||
OnRemove?.Invoke(prefab);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Check if the given GameObject is present as a prefab within the list
|
||||
/// </summary>
|
||||
/// <param name="prefab">The prefab to check</param>
|
||||
/// <returns>Whether or not the prefab exists</returns>
|
||||
public bool Contains(GameObject prefab)
|
||||
{
|
||||
for (int i = 0; i < List.Count; i++)
|
||||
{
|
||||
if (List[i].Prefab == prefab)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Check if the given NetworkPrefab is present within the list
|
||||
/// </summary>
|
||||
/// <param name="prefab">The prefab to check</param>
|
||||
/// <returns>Whether or not the prefab exists</returns>
|
||||
public bool Contains(NetworkPrefab prefab)
|
||||
{
|
||||
for (int i = 0; i < List.Count; i++)
|
||||
{
|
||||
if (List[i].Equals(prefab))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Runtime/Configuration/NetworkPrefabsList.cs.meta
Normal file
11
Runtime/Configuration/NetworkPrefabsList.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: e651dbb3fbac04af2b8f5abf007ddc23
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -7,6 +7,32 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
public class NetworkClient
|
||||
{
|
||||
/// <summary>
|
||||
/// Returns true if the session instance is considered a server
|
||||
/// </summary>
|
||||
internal bool IsServer { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Returns true if the session instance is considered a client
|
||||
/// </summary>
|
||||
internal bool IsClient { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Returns true if the session instance is considered a host
|
||||
/// </summary>
|
||||
internal bool IsHost => IsClient && IsServer;
|
||||
|
||||
/// <summary>
|
||||
/// When true, the client is connected, approved, and synchronized with
|
||||
/// the server.
|
||||
/// </summary>
|
||||
internal bool IsConnected { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Is true when the client has been approved.
|
||||
/// </summary>
|
||||
internal bool IsApproved { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The ClientId of the NetworkClient
|
||||
/// </summary>
|
||||
@@ -18,19 +44,33 @@ namespace Unity.Netcode
|
||||
public NetworkObject PlayerObject;
|
||||
|
||||
/// <summary>
|
||||
/// The NetworkObject's owned by this Client
|
||||
/// The list of NetworkObject's owned by this client instance
|
||||
/// </summary>
|
||||
public List<NetworkObject> OwnedObjects
|
||||
{
|
||||
get
|
||||
{
|
||||
if (PlayerObject != null && PlayerObject.NetworkManager != null && PlayerObject.NetworkManager.IsListening)
|
||||
{
|
||||
return PlayerObject.NetworkManager.SpawnManager.GetClientOwnedObjects(ClientId);
|
||||
}
|
||||
public List<NetworkObject> OwnedObjects => IsConnected ? SpawnManager.GetClientOwnedObjects(ClientId) : new List<NetworkObject>();
|
||||
|
||||
return new List<NetworkObject>();
|
||||
internal NetworkSpawnManager SpawnManager { get; private set; }
|
||||
|
||||
internal void SetRole(bool isServer, bool isClient, NetworkManager networkManager = null)
|
||||
{
|
||||
IsServer = isServer;
|
||||
IsClient = isClient;
|
||||
if (!IsServer && !isClient)
|
||||
{
|
||||
PlayerObject = null;
|
||||
ClientId = 0;
|
||||
IsConnected = false;
|
||||
IsApproved = false;
|
||||
}
|
||||
|
||||
if (networkManager != null)
|
||||
{
|
||||
SpawnManager = networkManager.SpawnManager;
|
||||
}
|
||||
}
|
||||
|
||||
internal void AssignPlayerObject(ref NetworkObject networkObject)
|
||||
{
|
||||
PlayerObject = networkObject;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
1285
Runtime/Connection/NetworkConnectionManager.cs
Normal file
1285
Runtime/Connection/NetworkConnectionManager.cs
Normal file
File diff suppressed because it is too large
Load Diff
11
Runtime/Connection/NetworkConnectionManager.cs.meta
Normal file
11
Runtime/Connection/NetworkConnectionManager.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: d98eff74d73bc2a42bd5624c47ce8fe1
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -1,10 +1,15 @@
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// Server-Side Only:
|
||||
/// A class representing a client that is currently in the process of connecting
|
||||
/// </summary>
|
||||
public class PendingClient
|
||||
{
|
||||
internal Coroutine ApprovalCoroutine = null;
|
||||
|
||||
/// <summary>
|
||||
/// The ClientId of the client
|
||||
/// </summary>
|
||||
|
||||
@@ -51,7 +51,9 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
public static void SetDefaults()
|
||||
{
|
||||
SetDefault<IDeferredMessageManager>(networkManager => new DeferredMessageManager(networkManager));
|
||||
SetDefault<IDeferredNetworkMessageManager>(networkManager => new DeferredMessageManager(networkManager));
|
||||
|
||||
SetDefault<IRealTimeProvider>(networkManager => new RealTimeProvider());
|
||||
}
|
||||
|
||||
private static void SetDefault<T>(CreateObjectDelegate creator)
|
||||
|
||||
@@ -1,33 +1,56 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using UnityEngine;
|
||||
using System.Reflection;
|
||||
using Unity.Collections;
|
||||
using UnityEngine;
|
||||
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
public class RpcException : Exception
|
||||
{
|
||||
public RpcException(string message) : base(message)
|
||||
{
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The base class to override to write network code. Inherits MonoBehaviour
|
||||
/// </summary>
|
||||
public abstract class NetworkBehaviour : MonoBehaviour
|
||||
{
|
||||
#pragma warning disable IDE1006 // disable naming rule violation check
|
||||
|
||||
// RuntimeAccessModifiersILPP will make this `public`
|
||||
internal delegate void RpcReceiveHandler(NetworkBehaviour behaviour, FastBufferReader reader, __RpcParams parameters);
|
||||
|
||||
// RuntimeAccessModifiersILPP will make this `public`
|
||||
internal static readonly Dictionary<Type, Dictionary<uint, RpcReceiveHandler>> __rpc_func_table = new Dictionary<Type, Dictionary<uint, RpcReceiveHandler>>();
|
||||
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
// RuntimeAccessModifiersILPP will make this `public`
|
||||
internal static readonly Dictionary<Type, Dictionary<uint, string>> __rpc_name_table = new Dictionary<Type, Dictionary<uint, string>>();
|
||||
#endif
|
||||
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
internal enum __RpcExecStage
|
||||
{
|
||||
// Technically will overlap with None and Server
|
||||
// but it doesn't matter since we don't use None and Server
|
||||
Send = 0,
|
||||
Execute = 1,
|
||||
|
||||
// Backward compatibility, not used...
|
||||
None = 0,
|
||||
Server = 1,
|
||||
Client = 2
|
||||
Client = 2,
|
||||
}
|
||||
|
||||
|
||||
// NetworkBehaviourILPP will override this in derived classes to return the name of the concrete type
|
||||
internal virtual string __getTypeName() => nameof(NetworkBehaviour);
|
||||
|
||||
[NonSerialized]
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
internal __RpcExecStage __rpc_exec_stage = __RpcExecStage.None;
|
||||
internal __RpcExecStage __rpc_exec_stage = __RpcExecStage.Send;
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
|
||||
private const int k_RpcMessageDefaultSize = 1024; // 1k
|
||||
@@ -65,7 +88,7 @@ namespace Unity.Netcode
|
||||
networkDelivery = NetworkDelivery.ReliableFragmentedSequenced;
|
||||
break;
|
||||
case RpcDelivery.Unreliable:
|
||||
if (bufferWriter.Length > MessagingSystem.NON_FRAGMENTED_MESSAGE_MAX_SIZE)
|
||||
if (bufferWriter.Length > NetworkManager.MessageManager.NonFragmentedMessageMaxSize)
|
||||
{
|
||||
throw new OverflowException("RPC parameters are too large for unreliable delivery.");
|
||||
}
|
||||
@@ -82,11 +105,11 @@ namespace Unity.Netcode
|
||||
var context = new NetworkContext
|
||||
{
|
||||
SenderId = NetworkManager.ServerClientId,
|
||||
Timestamp = Time.realtimeSinceStartup,
|
||||
Timestamp = NetworkManager.RealTimeProvider.RealTimeSinceStartup,
|
||||
SystemOwner = NetworkManager,
|
||||
// header information isn't valid since it's not a real message.
|
||||
// RpcMessage doesn't access this stuff so it's just left empty.
|
||||
Header = new MessageHeader(),
|
||||
Header = new NetworkMessageHeader(),
|
||||
SerializedHeaderSize = 0,
|
||||
MessageSize = 0
|
||||
};
|
||||
@@ -96,13 +119,12 @@ namespace Unity.Netcode
|
||||
}
|
||||
else
|
||||
{
|
||||
rpcWriteSize = NetworkManager.SendMessage(ref serverRpcMessage, networkDelivery, NetworkManager.ServerClientId);
|
||||
rpcWriteSize = NetworkManager.ConnectionManager.SendMessage(ref serverRpcMessage, networkDelivery, NetworkManager.ServerClientId);
|
||||
}
|
||||
|
||||
bufferWriter.Dispose();
|
||||
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
if (NetworkManager.__rpc_name_table.TryGetValue(rpcMethodId, out var rpcMethodName))
|
||||
if (__rpc_name_table[GetType()].TryGetValue(rpcMethodId, out var rpcMethodName))
|
||||
{
|
||||
NetworkManager.NetworkMetrics.TrackRpcSent(
|
||||
NetworkManager.ServerClientId,
|
||||
@@ -146,7 +168,7 @@ namespace Unity.Netcode
|
||||
networkDelivery = NetworkDelivery.ReliableFragmentedSequenced;
|
||||
break;
|
||||
case RpcDelivery.Unreliable:
|
||||
if (bufferWriter.Length > MessagingSystem.NON_FRAGMENTED_MESSAGE_MAX_SIZE)
|
||||
if (bufferWriter.Length > NetworkManager.MessageManager.NonFragmentedMessageMaxSize)
|
||||
{
|
||||
throw new OverflowException("RPC parameters are too large for unreliable delivery.");
|
||||
}
|
||||
@@ -176,7 +198,7 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
rpcWriteSize = NetworkManager.SendMessage(ref clientRpcMessage, networkDelivery, in clientRpcParams.Send.TargetClientIds);
|
||||
rpcWriteSize = NetworkManager.ConnectionManager.SendMessage(ref clientRpcMessage, networkDelivery, in clientRpcParams.Send.TargetClientIds);
|
||||
}
|
||||
else if (clientRpcParams.Send.TargetClientIdsNativeArray != null)
|
||||
{
|
||||
@@ -195,7 +217,7 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
rpcWriteSize = NetworkManager.SendMessage(ref clientRpcMessage, networkDelivery, clientRpcParams.Send.TargetClientIdsNativeArray.Value);
|
||||
rpcWriteSize = NetworkManager.ConnectionManager.SendMessage(ref clientRpcMessage, networkDelivery, clientRpcParams.Send.TargetClientIdsNativeArray.Value);
|
||||
}
|
||||
else
|
||||
{
|
||||
@@ -208,7 +230,7 @@ namespace Unity.Netcode
|
||||
shouldSendToHost = true;
|
||||
continue;
|
||||
}
|
||||
rpcWriteSize = NetworkManager.MessagingSystem.SendMessage(ref clientRpcMessage, networkDelivery, observerEnumerator.Current);
|
||||
rpcWriteSize = NetworkManager.ConnectionManager.SendMessage(ref clientRpcMessage, networkDelivery, observerEnumerator.Current);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -219,11 +241,11 @@ namespace Unity.Netcode
|
||||
var context = new NetworkContext
|
||||
{
|
||||
SenderId = NetworkManager.ServerClientId,
|
||||
Timestamp = Time.realtimeSinceStartup,
|
||||
Timestamp = NetworkManager.RealTimeProvider.RealTimeSinceStartup,
|
||||
SystemOwner = NetworkManager,
|
||||
// header information isn't valid since it's not a real message.
|
||||
// RpcMessage doesn't access this stuff so it's just left empty.
|
||||
Header = new MessageHeader(),
|
||||
Header = new NetworkMessageHeader(),
|
||||
SerializedHeaderSize = 0,
|
||||
MessageSize = 0
|
||||
};
|
||||
@@ -232,9 +254,8 @@ namespace Unity.Netcode
|
||||
}
|
||||
|
||||
bufferWriter.Dispose();
|
||||
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
if (NetworkManager.__rpc_name_table.TryGetValue(rpcMethodId, out var rpcMethodName))
|
||||
if (__rpc_name_table[GetType()].TryGetValue(rpcMethodId, out var rpcMethodName))
|
||||
{
|
||||
if (clientRpcParams.Send.TargetClientIds != null)
|
||||
{
|
||||
@@ -277,6 +298,107 @@ namespace Unity.Netcode
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
#pragma warning disable IDE1006 // disable naming rule violation check
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
internal FastBufferWriter __beginSendRpc(uint rpcMethodId, RpcParams rpcParams, RpcAttribute.RpcAttributeParams attributeParams, SendTo defaultTarget, RpcDelivery rpcDelivery)
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
{
|
||||
if (attributeParams.RequireOwnership && !IsOwner)
|
||||
{
|
||||
throw new RpcException("This RPC can only be sent by its owner.");
|
||||
}
|
||||
return new FastBufferWriter(k_RpcMessageDefaultSize, Allocator.Temp, k_RpcMessageMaximumSize);
|
||||
}
|
||||
|
||||
#pragma warning disable IDE1006 // disable naming rule violation check
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
internal void __endSendRpc(ref FastBufferWriter bufferWriter, uint rpcMethodId, RpcParams rpcParams, RpcAttribute.RpcAttributeParams attributeParams, SendTo defaultTarget, RpcDelivery rpcDelivery)
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
{
|
||||
var rpcMessage = new RpcMessage
|
||||
{
|
||||
Metadata = new RpcMetadata
|
||||
{
|
||||
NetworkObjectId = NetworkObjectId,
|
||||
NetworkBehaviourId = NetworkBehaviourId,
|
||||
NetworkRpcMethodId = rpcMethodId,
|
||||
},
|
||||
SenderClientId = NetworkManager.LocalClientId,
|
||||
WriteBuffer = bufferWriter
|
||||
};
|
||||
|
||||
NetworkDelivery networkDelivery;
|
||||
switch (rpcDelivery)
|
||||
{
|
||||
default:
|
||||
case RpcDelivery.Reliable:
|
||||
networkDelivery = NetworkDelivery.ReliableFragmentedSequenced;
|
||||
break;
|
||||
case RpcDelivery.Unreliable:
|
||||
if (bufferWriter.Length > NetworkManager.MessageManager.NonFragmentedMessageMaxSize)
|
||||
{
|
||||
throw new OverflowException("RPC parameters are too large for unreliable delivery.");
|
||||
}
|
||||
networkDelivery = NetworkDelivery.Unreliable;
|
||||
break;
|
||||
}
|
||||
|
||||
if (rpcParams.Send.Target == null)
|
||||
{
|
||||
switch (defaultTarget)
|
||||
{
|
||||
case SendTo.Everyone:
|
||||
rpcParams.Send.Target = RpcTarget.Everyone;
|
||||
break;
|
||||
case SendTo.Owner:
|
||||
rpcParams.Send.Target = RpcTarget.Owner;
|
||||
break;
|
||||
case SendTo.Server:
|
||||
rpcParams.Send.Target = RpcTarget.Server;
|
||||
break;
|
||||
case SendTo.NotServer:
|
||||
rpcParams.Send.Target = RpcTarget.NotServer;
|
||||
break;
|
||||
case SendTo.NotMe:
|
||||
rpcParams.Send.Target = RpcTarget.NotMe;
|
||||
break;
|
||||
case SendTo.NotOwner:
|
||||
rpcParams.Send.Target = RpcTarget.NotOwner;
|
||||
break;
|
||||
case SendTo.Me:
|
||||
rpcParams.Send.Target = RpcTarget.Me;
|
||||
break;
|
||||
case SendTo.ClientsAndHost:
|
||||
rpcParams.Send.Target = RpcTarget.ClientsAndHost;
|
||||
break;
|
||||
case SendTo.SpecifiedInParams:
|
||||
throw new RpcException("This method requires a runtime-specified send target.");
|
||||
}
|
||||
}
|
||||
else if (defaultTarget != SendTo.SpecifiedInParams && !attributeParams.AllowTargetOverride)
|
||||
{
|
||||
throw new RpcException("Target override is not allowed for this method.");
|
||||
}
|
||||
|
||||
if (rpcParams.Send.LocalDeferMode == LocalDeferMode.Default)
|
||||
{
|
||||
rpcParams.Send.LocalDeferMode = attributeParams.DeferLocal ? LocalDeferMode.Defer : LocalDeferMode.SendImmediate;
|
||||
}
|
||||
|
||||
rpcParams.Send.Target.Send(this, ref rpcMessage, networkDelivery, rpcParams);
|
||||
|
||||
bufferWriter.Dispose();
|
||||
}
|
||||
|
||||
#pragma warning disable IDE1006 // disable naming rule violation check
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
internal static NativeList<T> __createNativeList<T>() where T : unmanaged
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
{
|
||||
return new NativeList<T>(Allocator.Temp);
|
||||
}
|
||||
|
||||
internal string GenerateObserverErrorMessage(ClientRpcParams clientRpcParams, ulong targetClientId)
|
||||
{
|
||||
var containerNameHoldingId = clientRpcParams.Send.TargetClientIds != null ? nameof(ClientRpcParams.Send.TargetClientIds) : nameof(ClientRpcParams.Send.TargetClientIdsNativeArray);
|
||||
@@ -300,6 +422,24 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
// 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 => NetworkManager.RpcTarget;
|
||||
|
||||
/// <summary>
|
||||
/// If a NetworkObject is assigned, it will return whether or not this NetworkObject
|
||||
/// is the local player object. If no NetworkObject is assigned it will always return false.
|
||||
@@ -314,18 +454,23 @@ namespace Unity.Netcode
|
||||
/// <summary>
|
||||
/// Gets if we are executing as server
|
||||
/// </summary>
|
||||
protected bool IsServer { get; private set; }
|
||||
public bool IsServer { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets if the server (local or remote) is a host - i.e., also a client
|
||||
/// </summary>
|
||||
public bool ServerIsHost { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets if we are executing as client
|
||||
/// </summary>
|
||||
protected bool IsClient { get; private set; }
|
||||
public bool IsClient { get; private set; }
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Gets if we are executing as Host, I.E Server and Client
|
||||
/// </summary>
|
||||
protected bool IsHost { get; private set; }
|
||||
public bool IsHost { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets Whether or not the object has a owner
|
||||
@@ -360,12 +505,14 @@ namespace Unity.Netcode
|
||||
{
|
||||
get
|
||||
{
|
||||
if (m_NetworkObject != null)
|
||||
{
|
||||
return m_NetworkObject;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
if (m_NetworkObject == null)
|
||||
{
|
||||
m_NetworkObject = GetComponentInParent<NetworkObject>();
|
||||
}
|
||||
m_NetworkObject = GetComponentInParent<NetworkObject>();
|
||||
}
|
||||
catch (Exception)
|
||||
{
|
||||
@@ -457,12 +604,13 @@ namespace Unity.Netcode
|
||||
IsHost = NetworkManager.IsListening && NetworkManager.IsHost;
|
||||
IsClient = NetworkManager.IsListening && NetworkManager.IsClient;
|
||||
IsServer = NetworkManager.IsListening && NetworkManager.IsServer;
|
||||
ServerIsHost = NetworkManager.IsListening && NetworkManager.ServerIsHost;
|
||||
}
|
||||
}
|
||||
else // Shouldn't happen, but if so then set the properties to their default value;
|
||||
{
|
||||
OwnerClientId = NetworkObjectId = default;
|
||||
IsOwnedByServer = IsOwner = IsHost = IsClient = IsServer = default;
|
||||
IsOwnedByServer = IsOwner = IsHost = IsClient = IsServer = ServerIsHost = default;
|
||||
NetworkBehaviourId = default;
|
||||
}
|
||||
}
|
||||
@@ -530,6 +678,23 @@ namespace Unity.Netcode
|
||||
OnGainedOwnership();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Invoked on all clients, override this method to be notified of any
|
||||
/// ownership changes (even if the instance was niether the previous or
|
||||
/// newly assigned current owner).
|
||||
/// </summary>
|
||||
/// <param name="previous">the previous owner</param>
|
||||
/// <param name="current">the current owner</param>
|
||||
protected virtual void OnOwnershipChanged(ulong previous, ulong current)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
internal void InternalOnOwnershipChanged(ulong previous, ulong current)
|
||||
{
|
||||
OnOwnershipChanged(previous, current);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets called when we loose ownership of this object
|
||||
/// </summary>
|
||||
@@ -551,38 +716,44 @@ namespace Unity.Netcode
|
||||
|
||||
private readonly List<HashSet<int>> m_DeliveryMappedNetworkVariableIndices = new List<HashSet<int>>();
|
||||
private readonly List<NetworkDelivery> m_DeliveryTypesForNetworkVariableGroups = new List<NetworkDelivery>();
|
||||
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
internal readonly List<NetworkVariableBase> NetworkVariableFields = new List<NetworkVariableBase>();
|
||||
|
||||
private static Dictionary<Type, FieldInfo[]> s_FieldTypes = new Dictionary<Type, FieldInfo[]>();
|
||||
|
||||
private static FieldInfo[] GetFieldInfoForType(Type type)
|
||||
#pragma warning disable IDE1006 // disable naming rule violation check
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
internal virtual void __initializeVariables()
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
{
|
||||
if (!s_FieldTypes.ContainsKey(type))
|
||||
{
|
||||
s_FieldTypes.Add(type, GetFieldInfoForTypeRecursive(type));
|
||||
}
|
||||
|
||||
return s_FieldTypes[type];
|
||||
// ILPP generates code for all NetworkBehaviour subtypes to initialize each type's network variables.
|
||||
}
|
||||
|
||||
private static FieldInfo[] GetFieldInfoForTypeRecursive(Type type, List<FieldInfo> list = null)
|
||||
#pragma warning disable IDE1006 // disable naming rule violation check
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
internal virtual void __initializeRpcs()
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
{
|
||||
if (list == null)
|
||||
{
|
||||
list = new List<FieldInfo>();
|
||||
list.AddRange(type.GetFields(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance));
|
||||
}
|
||||
else
|
||||
{
|
||||
list.AddRange(type.GetFields(BindingFlags.NonPublic | BindingFlags.Instance));
|
||||
}
|
||||
// ILPP generates code for all NetworkBehaviour subtypes to initialize each type's RPCs.
|
||||
}
|
||||
|
||||
if (type.BaseType != null && type.BaseType != typeof(NetworkBehaviour))
|
||||
{
|
||||
return GetFieldInfoForTypeRecursive(type.BaseType, list);
|
||||
}
|
||||
#pragma warning disable IDE1006 // disable naming rule violation check
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
internal void __registerRpc(uint hash, RpcReceiveHandler handler, string rpcMethodName)
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
{
|
||||
__rpc_func_table[GetType()][hash] = handler;
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
__rpc_name_table[GetType()][hash] = rpcMethodName;
|
||||
#endif
|
||||
}
|
||||
|
||||
return list.OrderBy(x => x.Name, StringComparer.Ordinal).ToArray();
|
||||
#pragma warning disable IDE1006 // disable naming rule violation check
|
||||
// RuntimeAccessModifiersILPP will make this `protected`
|
||||
// Using this method here because ILPP doesn't seem to let us do visibility modification on properties.
|
||||
internal void __nameNetworkVariable(NetworkVariableBase variable, string varName)
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
{
|
||||
variable.Name = varName;
|
||||
}
|
||||
|
||||
internal void InitializeVariables()
|
||||
@@ -594,28 +765,15 @@ namespace Unity.Netcode
|
||||
|
||||
m_VarInit = true;
|
||||
|
||||
var sortedFields = GetFieldInfoForType(GetType());
|
||||
for (int i = 0; i < sortedFields.Length; i++)
|
||||
if (!__rpc_func_table.ContainsKey(GetType()))
|
||||
{
|
||||
var fieldType = sortedFields[i].FieldType;
|
||||
if (fieldType.IsSubclassOf(typeof(NetworkVariableBase)))
|
||||
{
|
||||
var instance = (NetworkVariableBase)sortedFields[i].GetValue(this);
|
||||
|
||||
if (instance == null)
|
||||
{
|
||||
throw new Exception($"{GetType().FullName}.{sortedFields[i].Name} cannot be null. All {nameof(NetworkVariableBase)} instances must be initialized.");
|
||||
}
|
||||
|
||||
instance.Initialize(this);
|
||||
|
||||
var instanceNameProperty = fieldType.GetProperty(nameof(NetworkVariableBase.Name));
|
||||
var sanitizedVariableName = sortedFields[i].Name.Replace("<", string.Empty).Replace(">k__BackingField", string.Empty);
|
||||
instanceNameProperty?.SetValue(instance, sanitizedVariableName);
|
||||
|
||||
NetworkVariableFields.Add(instance);
|
||||
}
|
||||
__rpc_func_table[GetType()] = new Dictionary<uint, RpcReceiveHandler>();
|
||||
#if UNITY_EDITOR || DEVELOPMENT_BUILD
|
||||
__rpc_name_table[GetType()] = new Dictionary<uint, string>();
|
||||
#endif
|
||||
__initializeRpcs();
|
||||
}
|
||||
__initializeVariables();
|
||||
|
||||
{
|
||||
// Create index map for delivery types
|
||||
@@ -657,7 +815,16 @@ namespace Unity.Netcode
|
||||
// during OnNetworkSpawn has been sent and needs to be cleared
|
||||
for (int i = 0; i < NetworkVariableFields.Count; i++)
|
||||
{
|
||||
NetworkVariableFields[i].ResetDirty();
|
||||
var networkVariable = NetworkVariableFields[i];
|
||||
if (networkVariable.IsDirty())
|
||||
{
|
||||
if (networkVariable.CanSend())
|
||||
{
|
||||
networkVariable.UpdateLastSentTime();
|
||||
networkVariable.ResetDirty();
|
||||
networkVariable.SetDirty(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
@@ -665,11 +832,18 @@ namespace Unity.Netcode
|
||||
// mark any variables we wrote as no longer dirty
|
||||
for (int i = 0; i < NetworkVariableIndexesToReset.Count; i++)
|
||||
{
|
||||
NetworkVariableFields[NetworkVariableIndexesToReset[i]].ResetDirty();
|
||||
var networkVariable = NetworkVariableFields[NetworkVariableIndexesToReset[i]];
|
||||
if (networkVariable.IsDirty())
|
||||
{
|
||||
if (networkVariable.CanSend())
|
||||
{
|
||||
networkVariable.UpdateLastSentTime();
|
||||
networkVariable.ResetDirty();
|
||||
networkVariable.SetDirty(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
MarkVariablesDirty(false);
|
||||
}
|
||||
|
||||
internal void PreVariableUpdate()
|
||||
@@ -678,7 +852,6 @@ namespace Unity.Netcode
|
||||
{
|
||||
InitializeVariables();
|
||||
}
|
||||
|
||||
PreNetworkVariableWrite();
|
||||
}
|
||||
|
||||
@@ -705,7 +878,10 @@ namespace Unity.Netcode
|
||||
var networkVariable = NetworkVariableFields[k];
|
||||
if (networkVariable.IsDirty() && networkVariable.CanClientRead(targetClientId))
|
||||
{
|
||||
shouldSend = true;
|
||||
if (networkVariable.CanSend())
|
||||
{
|
||||
shouldSend = true;
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
@@ -727,7 +903,7 @@ namespace Unity.Netcode
|
||||
// so we don't have to do this serialization work if we're not going to use the result.
|
||||
if (IsServer && targetClientId == NetworkManager.ServerClientId)
|
||||
{
|
||||
var tmpWriter = new FastBufferWriter(MessagingSystem.NON_FRAGMENTED_MESSAGE_MAX_SIZE, Allocator.Temp, MessagingSystem.FRAGMENTED_MESSAGE_MAX_SIZE);
|
||||
var tmpWriter = new FastBufferWriter(NetworkManager.MessageManager.NonFragmentedMessageMaxSize, Allocator.Temp, NetworkManager.MessageManager.FragmentedMessageMaxSize);
|
||||
using (tmpWriter)
|
||||
{
|
||||
message.Serialize(tmpWriter, message.Version);
|
||||
@@ -735,7 +911,7 @@ namespace Unity.Netcode
|
||||
}
|
||||
else
|
||||
{
|
||||
NetworkManager.SendMessage(ref message, m_DeliveryTypesForNetworkVariableGroups[j], targetClientId);
|
||||
NetworkManager.ConnectionManager.SendMessage(ref message, m_DeliveryTypesForNetworkVariableGroups[j], targetClientId);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -746,9 +922,16 @@ namespace Unity.Netcode
|
||||
// TODO: There should be a better way by reading one dirty variable vs. 'n'
|
||||
for (int i = 0; i < NetworkVariableFields.Count; i++)
|
||||
{
|
||||
if (NetworkVariableFields[i].IsDirty())
|
||||
var networkVariable = NetworkVariableFields[i];
|
||||
if (networkVariable.IsDirty())
|
||||
{
|
||||
return true;
|
||||
if (networkVariable.CanSend())
|
||||
{
|
||||
return true;
|
||||
}
|
||||
// If it's dirty but can't be sent yet, we have to keep monitoring it until one of the
|
||||
// conditions blocking its send changes.
|
||||
NetworkManager.BehaviourUpdater.AddForUpdate(NetworkObject);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -899,11 +1082,28 @@ namespace Unity.Netcode
|
||||
/// Either BufferSerializerReader or BufferSerializerWriter, depending whether the serializer
|
||||
/// is in read mode or write mode.
|
||||
/// </typeparam>
|
||||
/// <param name="targetClientId">the relative client identifier being synchronized</param>
|
||||
protected virtual void OnSynchronize<T>(ref BufferSerializer<T> serializer) where T : IReaderWriter
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
public virtual void OnReanticipate(double lastRoundTripTime)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The relative client identifier targeted for the serialization of this <see cref="NetworkBehaviour"/> instance.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This value will be set prior to <see cref="OnSynchronize{T}(ref BufferSerializer{T})"/> being invoked.
|
||||
/// For writing (server-side), this is useful to know which client will receive the serialized data.
|
||||
/// For reading (client-side), this will be the <see cref="NetworkManager.LocalClientId"/>.
|
||||
/// When synchronization of this instance is complete, this value will be reset to 0
|
||||
/// </remarks>
|
||||
protected ulong m_TargetIdBeingSynchronized { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Internal method that determines if a NetworkBehaviour has additional synchronization data to
|
||||
/// be synchronized when first instantiated prior to its associated NetworkObject being spawned.
|
||||
@@ -913,8 +1113,9 @@ namespace Unity.Netcode
|
||||
/// synchronize any remaining NetworkBehaviours.
|
||||
/// </remarks>
|
||||
/// <returns>true if it wrote synchronization data and false if it did not</returns>
|
||||
internal bool Synchronize<T>(ref BufferSerializer<T> serializer) where T : IReaderWriter
|
||||
internal bool Synchronize<T>(ref BufferSerializer<T> serializer, ulong targetClientId = 0) where T : IReaderWriter
|
||||
{
|
||||
m_TargetIdBeingSynchronized = targetClientId;
|
||||
if (serializer.IsWriter)
|
||||
{
|
||||
// Get the writer to handle seeking and determining how many bytes were written
|
||||
@@ -949,10 +1150,14 @@ namespace Unity.Netcode
|
||||
}
|
||||
var finalPosition = writer.Position;
|
||||
|
||||
// Reset before exiting
|
||||
m_TargetIdBeingSynchronized = default;
|
||||
// If we wrote nothing then skip writing anything for this NetworkBehaviour
|
||||
if (finalPosition == positionBeforeSynchronize || threwException)
|
||||
{
|
||||
writer.Seek(positionBeforeWrite);
|
||||
// Truncate back to the size before
|
||||
writer.Truncate();
|
||||
return false;
|
||||
}
|
||||
else
|
||||
@@ -1002,6 +1207,9 @@ namespace Unity.Netcode
|
||||
synchronizationError = true;
|
||||
}
|
||||
|
||||
// Reset before exiting
|
||||
m_TargetIdBeingSynchronized = default;
|
||||
|
||||
// Skip over the entry if deserialization fails
|
||||
if (synchronizationError)
|
||||
{
|
||||
|
||||
@@ -8,7 +8,10 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
public class NetworkBehaviourUpdater
|
||||
{
|
||||
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)}");
|
||||
@@ -16,21 +19,24 @@ namespace Unity.Netcode
|
||||
|
||||
internal void AddForUpdate(NetworkObject networkObject)
|
||||
{
|
||||
m_DirtyNetworkObjects.Add(networkObject);
|
||||
m_PendingDirtyNetworkObjects.Add(networkObject);
|
||||
}
|
||||
|
||||
internal void NetworkBehaviourUpdate(NetworkManager networkManager)
|
||||
internal void NetworkBehaviourUpdate()
|
||||
{
|
||||
#if DEVELOPMENT_BUILD || UNITY_EDITOR
|
||||
m_NetworkBehaviourUpdate.Begin();
|
||||
#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);
|
||||
|
||||
if (networkManager.IsServer)
|
||||
if (m_ConnectionManager.LocalClient.IsServer)
|
||||
{
|
||||
foreach (var dirtyObj in m_DirtyNetworkObjects)
|
||||
{
|
||||
@@ -39,9 +45,9 @@ namespace Unity.Netcode
|
||||
dirtyObj.ChildNetworkBehaviours[k].PreVariableUpdate();
|
||||
}
|
||||
|
||||
for (int i = 0; i < networkManager.ConnectedClientsList.Count; i++)
|
||||
for (int i = 0; i < m_ConnectionManager.ConnectedClientsList.Count; i++)
|
||||
{
|
||||
var client = networkManager.ConnectedClientsList[i];
|
||||
var client = m_ConnectionManager.ConnectedClientsList[i];
|
||||
|
||||
if (dirtyObj.IsNetworkVisibleTo(client.ClientId))
|
||||
{
|
||||
@@ -72,6 +78,23 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var dirtyObj in m_DirtyNetworkObjects)
|
||||
{
|
||||
for (int k = 0; k < dirtyObj.ChildNetworkBehaviours.Count; k++)
|
||||
{
|
||||
var behaviour = dirtyObj.ChildNetworkBehaviours[k];
|
||||
for (int i = 0; i < behaviour.NetworkVariableFields.Count; i++)
|
||||
{
|
||||
if (behaviour.NetworkVariableFields[i].IsDirty() &&
|
||||
!behaviour.NetworkVariableIndexesToResetSet.Contains(i))
|
||||
{
|
||||
behaviour.NetworkVariableIndexesToResetSet.Add(i);
|
||||
behaviour.NetworkVariableIndexesToReset.Add(i);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// Now, reset all the no-longer-dirty variables
|
||||
foreach (var dirtyobj in m_DirtyNetworkObjects)
|
||||
{
|
||||
@@ -87,5 +110,26 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
internal void Initialize(NetworkManager networkManager)
|
||||
{
|
||||
m_NetworkManager = networkManager;
|
||||
m_ConnectionManager = networkManager.ConnectionManager;
|
||||
m_NetworkManager.NetworkTickSystem.Tick += NetworkBehaviourUpdater_Tick;
|
||||
}
|
||||
|
||||
internal void Shutdown()
|
||||
{
|
||||
m_NetworkManager.NetworkTickSystem.Tick -= NetworkBehaviourUpdater_Tick;
|
||||
}
|
||||
|
||||
// Order of operations requires NetworkVariable updates first then showing NetworkObjects
|
||||
private void NetworkBehaviourUpdater_Tick()
|
||||
{
|
||||
// First update NetworkVariables
|
||||
NetworkBehaviourUpdate();
|
||||
|
||||
// Then show any NetworkObjects queued to be made visible/shown
|
||||
m_NetworkManager.SpawnManager.HandleNetworkObjectShow();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
118
Runtime/Core/NetworkObjectRefreshTool.cs
Normal file
118
Runtime/Core/NetworkObjectRefreshTool.cs
Normal file
@@ -0,0 +1,118 @@
|
||||
#if UNITY_EDITOR
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using UnityEditor.SceneManagement;
|
||||
using UnityEngine;
|
||||
using UnityEngine.SceneManagement;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// This is a helper tool to update all in-scene placed instances of a prefab that
|
||||
/// originally did not have a NetworkObject component but one was added to the prefab
|
||||
/// later.
|
||||
/// </summary>
|
||||
internal class NetworkObjectRefreshTool
|
||||
{
|
||||
private static List<string> s_ScenesToUpdate = new List<string>();
|
||||
private static bool s_ProcessScenes;
|
||||
private static bool s_CloseScenes;
|
||||
|
||||
internal static Action AllScenesProcessed;
|
||||
|
||||
internal static void ProcessScene(string scenePath, bool processScenes = true)
|
||||
{
|
||||
if (!s_ScenesToUpdate.Contains(scenePath))
|
||||
{
|
||||
if (s_ScenesToUpdate.Count == 0)
|
||||
{
|
||||
EditorSceneManager.sceneOpened += EditorSceneManager_sceneOpened;
|
||||
EditorSceneManager.sceneSaved += EditorSceneManager_sceneSaved;
|
||||
}
|
||||
s_ScenesToUpdate.Add(scenePath);
|
||||
}
|
||||
s_ProcessScenes = processScenes;
|
||||
}
|
||||
|
||||
internal static void ProcessActiveScene()
|
||||
{
|
||||
var activeScene = SceneManager.GetActiveScene();
|
||||
if (s_ScenesToUpdate.Contains(activeScene.path) && s_ProcessScenes)
|
||||
{
|
||||
SceneOpened(activeScene);
|
||||
}
|
||||
}
|
||||
|
||||
internal static void ProcessScenes()
|
||||
{
|
||||
if (s_ScenesToUpdate.Count != 0)
|
||||
{
|
||||
s_CloseScenes = true;
|
||||
var scenePath = s_ScenesToUpdate.First();
|
||||
EditorSceneManager.OpenScene(scenePath, OpenSceneMode.Additive);
|
||||
}
|
||||
else
|
||||
{
|
||||
s_CloseScenes = false;
|
||||
EditorSceneManager.sceneSaved -= EditorSceneManager_sceneSaved;
|
||||
EditorSceneManager.sceneOpened -= EditorSceneManager_sceneOpened;
|
||||
AllScenesProcessed?.Invoke();
|
||||
}
|
||||
}
|
||||
|
||||
private static void FinishedProcessingScene(Scene scene, bool refreshed = false)
|
||||
{
|
||||
if (s_ScenesToUpdate.Contains(scene.path))
|
||||
{
|
||||
// Provide a log of all scenes that were modified to the user
|
||||
if (refreshed)
|
||||
{
|
||||
Debug.Log($"Refreshed and saved updates to scene: {scene.name}");
|
||||
}
|
||||
s_ProcessScenes = false;
|
||||
s_ScenesToUpdate.Remove(scene.path);
|
||||
|
||||
if (scene != SceneManager.GetActiveScene())
|
||||
{
|
||||
EditorSceneManager.CloseScene(scene, s_CloseScenes);
|
||||
}
|
||||
ProcessScenes();
|
||||
}
|
||||
}
|
||||
|
||||
private static void EditorSceneManager_sceneSaved(Scene scene)
|
||||
{
|
||||
FinishedProcessingScene(scene, true);
|
||||
}
|
||||
|
||||
private static void SceneOpened(Scene scene)
|
||||
{
|
||||
if (s_ScenesToUpdate.Contains(scene.path))
|
||||
{
|
||||
if (s_ProcessScenes)
|
||||
{
|
||||
if (!EditorSceneManager.MarkSceneDirty(scene))
|
||||
{
|
||||
Debug.Log($"Scene {scene.name} did not get marked as dirty!");
|
||||
FinishedProcessingScene(scene);
|
||||
}
|
||||
else
|
||||
{
|
||||
EditorSceneManager.SaveScene(scene);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
FinishedProcessingScene(scene);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static void EditorSceneManager_sceneOpened(Scene scene, OpenSceneMode mode)
|
||||
{
|
||||
SceneOpened(scene);
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif // UNITY_EDITOR
|
||||
11
Runtime/Core/NetworkObjectRefreshTool.cs.meta
Normal file
11
Runtime/Core/NetworkObjectRefreshTool.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: d24d5e8371c3cca4890e2713bdeda288
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -54,7 +54,14 @@ 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
|
||||
/// and all rendering is complete
|
||||
/// </summary>
|
||||
PostLateUpdate = 7
|
||||
}
|
||||
@@ -167,7 +174,7 @@ namespace Unity.Netcode
|
||||
/// </summary>
|
||||
public static NetworkUpdateStage UpdateStage;
|
||||
|
||||
private static void RunNetworkUpdateStage(NetworkUpdateStage updateStage)
|
||||
internal static void RunNetworkUpdateStage(NetworkUpdateStage updateStage)
|
||||
{
|
||||
UpdateStage = updateStage;
|
||||
|
||||
@@ -258,6 +265,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 +418,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 +460,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))
|
||||
{
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
using System;
|
||||
using System.Text;
|
||||
using System.Runtime.CompilerServices;
|
||||
using System.Text;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
|
||||
@@ -51,35 +51,58 @@ namespace Unity.Netcode
|
||||
/// <param name="message">The message to log</param>
|
||||
public static void LogErrorServer(string message) => LogServer(message, LogType.Error);
|
||||
|
||||
internal static NetworkManager NetworkManagerOverride;
|
||||
|
||||
private static void LogServer(string message, LogType logType)
|
||||
{
|
||||
var networkManager = NetworkManagerOverride ??= NetworkManager.Singleton;
|
||||
// Get the sender of the local log
|
||||
ulong localId = NetworkManager.Singleton != null ? NetworkManager.Singleton.LocalClientId : 0;
|
||||
|
||||
ulong localId = networkManager?.LocalClientId ?? 0;
|
||||
bool isServer = networkManager?.IsServer ?? true;
|
||||
switch (logType)
|
||||
{
|
||||
case LogType.Info:
|
||||
LogInfoServerLocal(message, localId);
|
||||
if (isServer)
|
||||
{
|
||||
LogInfoServerLocal(message, localId);
|
||||
}
|
||||
else
|
||||
{
|
||||
LogInfo(message);
|
||||
}
|
||||
break;
|
||||
case LogType.Warning:
|
||||
LogWarningServerLocal(message, localId);
|
||||
if (isServer)
|
||||
{
|
||||
LogWarningServerLocal(message, localId);
|
||||
}
|
||||
else
|
||||
{
|
||||
LogWarning(message);
|
||||
}
|
||||
break;
|
||||
case LogType.Error:
|
||||
LogErrorServerLocal(message, localId);
|
||||
if (isServer)
|
||||
{
|
||||
LogErrorServerLocal(message, localId);
|
||||
}
|
||||
else
|
||||
{
|
||||
LogError(message);
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
if (NetworkManager.Singleton != null && !NetworkManager.Singleton.IsServer && NetworkManager.Singleton.NetworkConfig.EnableNetworkLogs)
|
||||
if (!isServer && networkManager.NetworkConfig.EnableNetworkLogs)
|
||||
{
|
||||
|
||||
var networkMessage = new ServerLogMessage
|
||||
{
|
||||
LogType = logType,
|
||||
Message = message
|
||||
};
|
||||
var size = NetworkManager.Singleton.SendMessage(ref networkMessage, NetworkDelivery.ReliableFragmentedSequenced, NetworkManager.ServerClientId);
|
||||
var size = networkManager.ConnectionManager.SendMessage(ref networkMessage, NetworkDelivery.ReliableFragmentedSequenced, NetworkManager.ServerClientId);
|
||||
|
||||
NetworkManager.Singleton.NetworkMetrics.TrackServerLogSent(NetworkManager.ServerClientId, (uint)logType, size);
|
||||
networkManager.NetworkMetrics.TrackServerLogSent(NetworkManager.ServerClientId, (uint)logType, size);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// Header placed at the start of each message batch
|
||||
/// </summary>
|
||||
internal struct BatchHeader : INetworkSerializeByMemcpy
|
||||
{
|
||||
/// <summary>
|
||||
/// Total number of messages in the batch.
|
||||
/// </summary>
|
||||
public ushort BatchSize;
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Unity.Collections;
|
||||
using UnityEngine;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
@@ -90,7 +91,7 @@ namespace Unity.Netcode
|
||||
{
|
||||
SendData = messageBuffer
|
||||
};
|
||||
var size = m_NetworkManager.SendMessage(ref message, networkDelivery, clientIds);
|
||||
var size = m_NetworkManager.ConnectionManager.SendMessage(ref message, networkDelivery, clientIds);
|
||||
|
||||
// Size is zero if we were only sending the message to ourself in which case it isn't sent.
|
||||
if (size != 0)
|
||||
@@ -123,7 +124,7 @@ namespace Unity.Netcode
|
||||
{
|
||||
SendData = messageBuffer
|
||||
};
|
||||
var size = m_NetworkManager.SendMessage(ref message, networkDelivery, clientId);
|
||||
var size = m_NetworkManager.ConnectionManager.SendMessage(ref message, networkDelivery, clientId);
|
||||
// Size is zero if we were only sending the message to ourself in which case it isn't sent.
|
||||
if (size != 0)
|
||||
{
|
||||
@@ -151,14 +152,18 @@ 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, m_MessageHandlerNameLookup32[hash], bytesCount);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, messageName, 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, m_MessageHandlerNameLookup64[hash], bytesCount);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, messageName, bytesCount);
|
||||
}
|
||||
}
|
||||
else
|
||||
@@ -169,15 +174,19 @@ 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, m_MessageHandlerNameLookup32[hash], bytesCount);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, messageName, 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, m_MessageHandlerNameLookup64[hash], bytesCount);
|
||||
m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, messageName, bytesCount);
|
||||
}
|
||||
break;
|
||||
}
|
||||
@@ -191,6 +200,14 @@ 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);
|
||||
|
||||
@@ -207,6 +224,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);
|
||||
|
||||
@@ -267,7 +293,7 @@ namespace Unity.Netcode
|
||||
Hash = hash,
|
||||
SendData = messageStream,
|
||||
};
|
||||
var size = m_NetworkManager.SendMessage(ref message, networkDelivery, clientId);
|
||||
var size = m_NetworkManager.ConnectionManager.SendMessage(ref message, networkDelivery, clientId);
|
||||
|
||||
// Size is zero if we were only sending the message to ourself in which case it isn't sent.
|
||||
if (size != 0)
|
||||
@@ -325,7 +351,7 @@ namespace Unity.Netcode
|
||||
Hash = hash,
|
||||
SendData = messageStream
|
||||
};
|
||||
var size = m_NetworkManager.SendMessage(ref message, networkDelivery, clientIds);
|
||||
var size = m_NetworkManager.ConnectionManager.SendMessage(ref message, networkDelivery, clientIds);
|
||||
|
||||
// Size is zero if we were only sending the message to ourself in which case it isn't sent.
|
||||
if (size != 0)
|
||||
|
||||
26
Runtime/Messaging/DefaultMessageSender.cs
Normal file
26
Runtime/Messaging/DefaultMessageSender.cs
Normal file
@@ -0,0 +1,26 @@
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// Default NetworkTransport Message Sender
|
||||
/// <see cref="NetworkMessageManager"/>
|
||||
/// </summary>
|
||||
internal class DefaultMessageSender : INetworkMessageSender
|
||||
{
|
||||
private NetworkTransport m_NetworkTransport;
|
||||
private NetworkConnectionManager m_ConnectionManager;
|
||||
|
||||
public DefaultMessageSender(NetworkManager manager)
|
||||
{
|
||||
m_NetworkTransport = manager.NetworkConfig.NetworkTransport;
|
||||
m_ConnectionManager = manager.ConnectionManager;
|
||||
}
|
||||
|
||||
public void Send(ulong clientId, NetworkDelivery delivery, FastBufferWriter batchData)
|
||||
{
|
||||
var sendBuffer = batchData.ToTempByteArray();
|
||||
|
||||
m_NetworkTransport.Send(m_ConnectionManager.ClientIdToTransportId(clientId), sendBuffer, delivery);
|
||||
}
|
||||
}
|
||||
}
|
||||
11
Runtime/Messaging/DefaultMessageSender.cs.meta
Normal file
11
Runtime/Messaging/DefaultMessageSender.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 5ea6bdd38832d9947bb21c4b35bf61d0
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -1,15 +1,14 @@
|
||||
using System.Collections.Generic;
|
||||
using Unity.Collections;
|
||||
using Time = UnityEngine.Time;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal class DeferredMessageManager : IDeferredMessageManager
|
||||
internal class DeferredMessageManager : IDeferredNetworkMessageManager
|
||||
{
|
||||
protected struct TriggerData
|
||||
{
|
||||
public FastBufferReader Reader;
|
||||
public MessageHeader Header;
|
||||
public NetworkMessageHeader Header;
|
||||
public ulong SenderId;
|
||||
public float Timestamp;
|
||||
public int SerializedHeaderSize;
|
||||
@@ -20,7 +19,7 @@ namespace Unity.Netcode
|
||||
public NativeList<TriggerData> TriggerData;
|
||||
}
|
||||
|
||||
protected readonly Dictionary<IDeferredMessageManager.TriggerType, Dictionary<ulong, TriggerInfo>> m_Triggers = new Dictionary<IDeferredMessageManager.TriggerType, Dictionary<ulong, TriggerInfo>>();
|
||||
protected readonly Dictionary<IDeferredNetworkMessageManager.TriggerType, Dictionary<ulong, TriggerInfo>> m_Triggers = new Dictionary<IDeferredNetworkMessageManager.TriggerType, Dictionary<ulong, TriggerInfo>>();
|
||||
|
||||
private readonly NetworkManager m_NetworkManager;
|
||||
|
||||
@@ -37,7 +36,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(IDeferredMessageManager.TriggerType trigger, ulong key, FastBufferReader reader, ref NetworkContext context)
|
||||
public virtual unsafe void DeferMessage(IDeferredNetworkMessageManager.TriggerType trigger, ulong key, FastBufferReader reader, ref NetworkContext context)
|
||||
{
|
||||
if (!m_Triggers.TryGetValue(trigger, out var triggers))
|
||||
{
|
||||
@@ -49,7 +48,7 @@ namespace Unity.Netcode
|
||||
{
|
||||
triggerInfo = new TriggerInfo
|
||||
{
|
||||
Expiry = Time.realtimeSinceStartup + m_NetworkManager.NetworkConfig.SpawnTimeout,
|
||||
Expiry = m_NetworkManager.RealTimeProvider.RealTimeSinceStartup + m_NetworkManager.NetworkConfig.SpawnTimeout,
|
||||
TriggerData = new NativeList<TriggerData>(Allocator.Persistent)
|
||||
};
|
||||
triggers[key] = triggerInfo;
|
||||
@@ -77,7 +76,7 @@ namespace Unity.Netcode
|
||||
int index = 0;
|
||||
foreach (var kvp2 in kvp.Value)
|
||||
{
|
||||
if (kvp2.Value.Expiry < Time.realtimeSinceStartup)
|
||||
if (kvp2.Value.Expiry < m_NetworkManager.RealTimeProvider.RealTimeSinceStartup)
|
||||
{
|
||||
staleKeys[index++] = kvp2.Key;
|
||||
PurgeTrigger(kvp.Key, kvp2.Key, kvp2.Value);
|
||||
@@ -91,7 +90,7 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
protected virtual void PurgeTrigger(IDeferredMessageManager.TriggerType triggerType, ulong key, TriggerInfo triggerInfo)
|
||||
protected virtual void PurgeTrigger(IDeferredNetworkMessageManager.TriggerType triggerType, ulong key, TriggerInfo triggerInfo)
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
{
|
||||
@@ -106,7 +105,7 @@ namespace Unity.Netcode
|
||||
triggerInfo.TriggerData.Dispose();
|
||||
}
|
||||
|
||||
public virtual void ProcessTriggers(IDeferredMessageManager.TriggerType trigger, ulong key)
|
||||
public virtual void ProcessTriggers(IDeferredNetworkMessageManager.TriggerType trigger, ulong key)
|
||||
{
|
||||
if (m_Triggers.TryGetValue(trigger, out var triggers))
|
||||
{
|
||||
@@ -114,14 +113,14 @@ 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
|
||||
m_NetworkManager.MessagingSystem.HandleMessage(deferredMessage.Header, deferredMessage.Reader, deferredMessage.SenderId, deferredMessage.Timestamp, deferredMessage.SerializedHeaderSize);
|
||||
m_NetworkManager.ConnectionManager.MessageManager.HandleMessage(deferredMessage.Header, deferredMessage.Reader, deferredMessage.SenderId, deferredMessage.Timestamp, deferredMessage.SerializedHeaderSize);
|
||||
}
|
||||
|
||||
triggerInfo.TriggerData.Dispose();
|
||||
triggers.Remove(key);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,17 +8,11 @@ namespace Unity.Netcode
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
string reasonSent = Reason;
|
||||
if (reasonSent == null)
|
||||
{
|
||||
reasonSent = string.Empty;
|
||||
}
|
||||
string reasonSent = Reason ?? string.Empty;
|
||||
|
||||
// Since we don't send a ConnectionApprovedMessage, the version for this message is encded with the message
|
||||
// itself. However, note that we HAVE received a ConnectionRequestMessage, so we DO have a valid targetVersion
|
||||
// on this side of things - we just have to make sure the receiving side knows what version we sent it,
|
||||
// since whoever has the higher version number is responsible for versioning and they may be the one
|
||||
// with the higher version number.
|
||||
// Since we don't send a ConnectionApprovedMessage, the version for this message is encded with the message itself.
|
||||
// However, note that we HAVE received a ConnectionRequestMessage, so we DO have a valid targetVersion on this side of things.
|
||||
// We just have to make sure the receiving side knows what version we sent it, since whoever has the higher version number is responsible for versioning and they may be the one with the higher version number.
|
||||
BytePacker.WriteValueBitPacked(writer, Version);
|
||||
|
||||
if (writer.TryBeginWrite(FastBufferWriter.GetWriteSize(reasonSent)))
|
||||
@@ -28,15 +22,14 @@ namespace Unity.Netcode
|
||||
else
|
||||
{
|
||||
writer.WriteValueSafe(string.Empty);
|
||||
NetworkLog.LogWarning(
|
||||
"Disconnect reason didn't fit. Disconnected without sending a reason. Consider shortening the reason string.");
|
||||
NetworkLog.LogWarning("Disconnect reason didn't fit. Disconnected without sending a reason. Consider shortening the reason string.");
|
||||
}
|
||||
}
|
||||
|
||||
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
||||
{
|
||||
// Since we don't get a ConnectionApprovedMessage, the version for this message is encded with the message
|
||||
// itself. This will override what we got from MessagingSystem... which will always be 0 here.
|
||||
// Since we don't get a ConnectionApprovedMessage, the version for this message is encded with the message itself.
|
||||
// This will override what we got from MessageManager... which will always be 0 here.
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out receivedMessageVersion);
|
||||
reader.ReadValueSafe(out Reason);
|
||||
return true;
|
||||
@@ -44,7 +37,7 @@ namespace Unity.Netcode
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
((NetworkManager)context.SystemOwner).DisconnectReason = Reason;
|
||||
((NetworkManager)context.SystemOwner).ConnectionManager.DisconnectReason = Reason;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
using System;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// Marks a generic parameter in this class as a type that should be serialized through
|
||||
/// <see cref="NetworkVariableSerialization{T}"/>. This enables the use of the following methods to support
|
||||
/// serialization within a Network Variable type:
|
||||
/// <br/>
|
||||
/// <br/>
|
||||
/// <see cref="NetworkVariableSerialization{T}"/>.<see cref="NetworkVariableSerialization{T}.Read"/>
|
||||
/// <br/>
|
||||
/// <see cref="NetworkVariableSerialization{T}"/>.<see cref="NetworkVariableSerialization{T}.Write"/>
|
||||
/// <br/>
|
||||
/// <see cref="NetworkVariableSerialization{T}"/>.<see cref="NetworkVariableSerialization{T}.AreEqual"/>
|
||||
/// <br/>
|
||||
/// <see cref="NetworkVariableSerialization{T}"/>.<see cref="NetworkVariableSerialization{T}.Duplicate"/>
|
||||
/// <br/>
|
||||
/// <br/>
|
||||
/// The parameter is indicated by index (and is 0-indexed); for example:
|
||||
/// <br/>
|
||||
/// <code>
|
||||
/// [SerializesGenericParameter(1)]
|
||||
/// public class MyClass<TTypeOne, TTypeTwo>
|
||||
/// {
|
||||
/// }
|
||||
/// </code>
|
||||
/// <br/>
|
||||
/// This tells the code generation for <see cref="NetworkVariableSerialization{T}"/> to generate
|
||||
/// serialized code for <b>TTypeTwo</b> (generic parameter 1).
|
||||
/// <br/>
|
||||
/// <br/>
|
||||
/// Note that this is primarily intended to support subtypes of <see cref="NetworkVariableBase"/>,
|
||||
/// and as such, the type resolution is done by examining fields of <see cref="NetworkBehaviour"/>
|
||||
/// subclasses. If your type is not used in a <see cref="NetworkBehaviour"/>, the codegen will
|
||||
/// not find the types, even with this attribute.
|
||||
/// <br/>
|
||||
/// <br/>
|
||||
/// This attribute is properly inherited by subclasses. For example:
|
||||
/// <br/>
|
||||
/// <code>
|
||||
/// [SerializesGenericParameter(0)]
|
||||
/// public class MyClass<T>
|
||||
/// {
|
||||
/// }
|
||||
/// <br/>
|
||||
/// public class MySubclass1 : MyClass<Foo>
|
||||
/// {
|
||||
/// }
|
||||
/// <br/>
|
||||
/// public class MySubclass2<T> : MyClass<T>
|
||||
/// {
|
||||
/// }
|
||||
/// <br/>
|
||||
/// [SerializesGenericParameter(1)]
|
||||
/// public class MySubclass3<TTypeOne, TTypeTwo> : MyClass<TTypeOne>
|
||||
/// {
|
||||
/// }
|
||||
/// <br/>
|
||||
/// public class MyBehaviour : NetworkBehaviour
|
||||
/// {
|
||||
/// public MySubclass1 TheValue;
|
||||
/// public MySubclass2<Bar> TheValue;
|
||||
/// public MySubclass3<Baz, Qux> TheValue;
|
||||
/// }
|
||||
/// </code>
|
||||
/// <br/>
|
||||
/// The above code will trigger generation of serialization code for <b>Foo</b> (passed directly to the
|
||||
/// base class), <b>Bar</b> (passed indirectly to the base class), <b>Baz</b> (passed indirectly to the base class),
|
||||
/// and <b>Qux</b> (marked as serializable in the subclass).
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = true)]
|
||||
public class GenerateSerializationForGenericParameterAttribute : Attribute
|
||||
{
|
||||
internal int ParameterIndex;
|
||||
|
||||
public GenerateSerializationForGenericParameterAttribute(int parameterIndex)
|
||||
{
|
||||
ParameterIndex = parameterIndex;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 18cdaa9c2f6446279b0c5948fcd34eec
|
||||
timeCreated: 1694029524
|
||||
26
Runtime/Messaging/GenerateSerializationForTypeAttribute.cs
Normal file
26
Runtime/Messaging/GenerateSerializationForTypeAttribute.cs
Normal file
@@ -0,0 +1,26 @@
|
||||
using System;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
/// <summary>
|
||||
/// Specifies a specific type that needs serialization to be generated by codegen.
|
||||
/// This is only needed in special circumstances where manual serialization is being done.
|
||||
/// If you are making a generic network variable-style class, use <see cref="GenerateSerializationForGenericParameterAttribute"/>.
|
||||
/// <br />
|
||||
/// <br />
|
||||
/// This attribute can be attached to any class or method anywhere in the codebase and
|
||||
/// will trigger codegen to generate serialization code for the provided type. It only needs
|
||||
/// to be included once type per codebase, but including it multiple times for the same type
|
||||
/// is safe.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Method, AllowMultiple = true)]
|
||||
public class GenerateSerializationForTypeAttribute : Attribute
|
||||
{
|
||||
internal Type Type;
|
||||
|
||||
public GenerateSerializationForTypeAttribute(Type type)
|
||||
{
|
||||
Type = type;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 1bd80306706f4054b9ba514a72076df5
|
||||
timeCreated: 1694103021
|
||||
@@ -1,11 +1,12 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal interface IDeferredMessageManager
|
||||
internal interface IDeferredNetworkMessageManager
|
||||
{
|
||||
internal enum TriggerType
|
||||
{
|
||||
OnSpawn,
|
||||
OnAddPrefab,
|
||||
OnNextFrame,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -1,17 +1,39 @@
|
||||
using System.Collections.Generic;
|
||||
#if UNITY_EDITOR
|
||||
using UnityEditor;
|
||||
#endif
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct ILPPMessageProvider : IMessageProvider
|
||||
internal struct ILPPMessageProvider : INetworkMessageProvider
|
||||
{
|
||||
#pragma warning disable IDE1006 // disable naming rule violation check
|
||||
// This is NOT modified by RuntimeAccessModifiersILPP right now, but is populated by ILPP.
|
||||
internal static readonly List<MessagingSystem.MessageWithHandler> __network_message_types = new List<MessagingSystem.MessageWithHandler>();
|
||||
internal static readonly List<NetworkMessageManager.MessageWithHandler> __network_message_types = new List<NetworkMessageManager.MessageWithHandler>();
|
||||
#pragma warning restore IDE1006 // restore naming rule violation check
|
||||
|
||||
public List<MessagingSystem.MessageWithHandler> GetMessages()
|
||||
public List<NetworkMessageManager.MessageWithHandler> GetMessages()
|
||||
{
|
||||
return __network_message_types;
|
||||
}
|
||||
|
||||
#if UNITY_EDITOR
|
||||
[InitializeOnLoadMethod]
|
||||
public static void NotifyOnPlayStateChange()
|
||||
{
|
||||
EditorApplication.playModeStateChanged += OnPlayModeStateChanged;
|
||||
}
|
||||
|
||||
public static void OnPlayModeStateChanged(PlayModeStateChange change)
|
||||
{
|
||||
if (change == PlayModeStateChange.ExitingPlayMode)
|
||||
{
|
||||
// Clear out the network message types, because ILPP-generated RuntimeInitializeOnLoad code will
|
||||
// run again and add more messages to it.
|
||||
__network_message_types.Clear();
|
||||
}
|
||||
}
|
||||
|
||||
#endif
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal interface IMessageProvider
|
||||
{
|
||||
List<MessagingSystem.MessageWithHandler> GetMessages();
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,3 @@
|
||||
using Unity.Collections;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
|
||||
9
Runtime/Messaging/INetworkMessageProvider.cs
Normal file
9
Runtime/Messaging/INetworkMessageProvider.cs
Normal file
@@ -0,0 +1,9 @@
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal interface INetworkMessageProvider
|
||||
{
|
||||
List<NetworkMessageManager.MessageWithHandler> GetMessages();
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal interface IMessageSender
|
||||
internal interface INetworkMessageSender
|
||||
{
|
||||
void Send(ulong clientId, NetworkDelivery delivery, FastBufferWriter batchData);
|
||||
}
|
||||
70
Runtime/Messaging/Messages/AnticipationCounterSync.cs
Normal file
70
Runtime/Messaging/Messages/AnticipationCounterSync.cs
Normal file
@@ -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,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: db5034828a9741ce9bc8ec9a64d5a5b6
|
||||
timeCreated: 1706042908
|
||||
@@ -24,7 +24,7 @@ namespace Unity.Netcode
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out OwnerClientId);
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.ContainsKey(NetworkObjectId))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context);
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context);
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -60,6 +60,8 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
networkObject.InvokeOwnershipChanged(originalOwner, OwnerClientId);
|
||||
|
||||
networkManager.NetworkMetrics.TrackOwnershipChangeReceived(context.SenderId, networkObject, context.MessageSize);
|
||||
}
|
||||
}
|
||||
|
||||
35
Runtime/Messaging/Messages/ClientConnectedMessage.cs
Normal file
35
Runtime/Messaging/Messages/ClientConnectedMessage.cs
Normal file
@@ -0,0 +1,35 @@
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct ClientConnectedMessage : 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;
|
||||
networkManager.ConnectionManager.ConnectedClientIds.Add(ClientId);
|
||||
if (networkManager.IsConnectedClient)
|
||||
{
|
||||
networkManager.ConnectionManager.InvokeOnPeerConnectedCallback(ClientId);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 158454105806474cba54a4ea5a0bfb12
|
||||
timeCreated: 1697836112
|
||||
35
Runtime/Messaging/Messages/ClientDisconnectedMessage.cs
Normal file
35
Runtime/Messaging/Messages/ClientDisconnectedMessage.cs
Normal file
@@ -0,0 +1,35 @@
|
||||
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;
|
||||
networkManager.ConnectionManager.ConnectedClientIds.Remove(ClientId);
|
||||
if (networkManager.IsConnectedClient)
|
||||
{
|
||||
networkManager.ConnectionManager.InvokeOnPeerDisconnectedCallback(ClientId);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 8f91296c8e5f40b1a2a03d74a31526b6
|
||||
timeCreated: 1697836161
|
||||
@@ -5,7 +5,8 @@ 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;
|
||||
@@ -17,6 +18,8 @@ namespace Unity.Netcode
|
||||
|
||||
public NativeArray<MessageVersionData> MessageVersions;
|
||||
|
||||
public NativeArray<ulong> ConnectedClientIds;
|
||||
|
||||
public void Serialize(FastBufferWriter writer, int targetVersion)
|
||||
{
|
||||
// ============================================================
|
||||
@@ -36,7 +39,15 @@ namespace Unity.Netcode
|
||||
BytePacker.WriteValueBitPacked(writer, OwnerClientId);
|
||||
BytePacker.WriteValueBitPacked(writer, NetworkTick);
|
||||
|
||||
if (targetVersion >= k_VersionAddClientIds)
|
||||
{
|
||||
writer.WriteValueSafe(ConnectedClientIds);
|
||||
}
|
||||
|
||||
uint sceneObjectCount = 0;
|
||||
|
||||
// When SpawnedObjectsList is not null then scene management is disabled. Provide a list of
|
||||
// all observed and spawned NetworkObjects that the approved client needs to synchronize.
|
||||
if (SpawnedObjectsList != null)
|
||||
{
|
||||
var pos = writer.Position;
|
||||
@@ -45,7 +56,7 @@ namespace Unity.Netcode
|
||||
// Serialize NetworkVariable data
|
||||
foreach (var sobj in SpawnedObjectsList)
|
||||
{
|
||||
if (sobj.CheckObjectVisibility == null || sobj.CheckObjectVisibility(OwnerClientId))
|
||||
if (sobj.SpawnWithObservers && (sobj.CheckObjectVisibility == null || sobj.CheckObjectVisibility(OwnerClientId)))
|
||||
{
|
||||
sobj.Observers.Add(OwnerClientId);
|
||||
var sceneObject = sobj.GetMessageSceneObject(OwnerClientId);
|
||||
@@ -84,18 +95,18 @@ namespace Unity.Netcode
|
||||
{
|
||||
var messageVersion = new MessageVersionData();
|
||||
messageVersion.Deserialize(reader);
|
||||
networkManager.MessagingSystem.SetVersion(context.SenderId, messageVersion.Hash, messageVersion.Version);
|
||||
networkManager.ConnectionManager.MessageManager.SetVersion(context.SenderId, messageVersion.Hash, messageVersion.Version);
|
||||
messageHashesInOrder[i] = messageVersion.Hash;
|
||||
|
||||
// Update the received version since this message will always be passed version 0, due to the map not
|
||||
// being initialized until just now.
|
||||
var messageType = networkManager.MessagingSystem.GetMessageForHash(messageVersion.Hash);
|
||||
var messageType = networkManager.ConnectionManager.MessageManager.GetMessageForHash(messageVersion.Hash);
|
||||
if (messageType == typeof(ConnectionApprovedMessage))
|
||||
{
|
||||
receivedMessageVersion = messageVersion.Version;
|
||||
}
|
||||
}
|
||||
networkManager.MessagingSystem.SetServerMessageOrder(messageHashesInOrder);
|
||||
networkManager.ConnectionManager.MessageManager.SetServerMessageOrder(messageHashesInOrder);
|
||||
messageHashesInOrder.Dispose();
|
||||
// ============================================================
|
||||
// END FORBIDDEN SEGMENT
|
||||
@@ -103,6 +114,16 @@ namespace Unity.Netcode
|
||||
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out OwnerClientId);
|
||||
ByteUnpacker.ReadValueBitPacked(reader, out NetworkTick);
|
||||
|
||||
if (receivedMessageVersion >= k_VersionAddClientIds)
|
||||
{
|
||||
reader.ReadValueSafe(out ConnectedClientIds, Allocator.TempJob);
|
||||
}
|
||||
else
|
||||
{
|
||||
ConnectedClientIds = new NativeArray<ulong>(0, Allocator.TempJob);
|
||||
}
|
||||
|
||||
m_ReceivedSceneObjectData = reader;
|
||||
return true;
|
||||
}
|
||||
@@ -111,14 +132,24 @@ namespace Unity.Netcode
|
||||
{
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
networkManager.LocalClientId = OwnerClientId;
|
||||
networkManager.MessageManager.SetLocalClientId(networkManager.LocalClientId);
|
||||
networkManager.NetworkMetrics.SetConnectionId(networkManager.LocalClientId);
|
||||
|
||||
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);
|
||||
|
||||
networkManager.LocalClient = new NetworkClient() { ClientId = networkManager.LocalClientId };
|
||||
networkManager.IsApproved = true;
|
||||
networkManager.ConnectionManager.LocalClient.SetRole(false, true, networkManager);
|
||||
networkManager.ConnectionManager.LocalClient.IsApproved = true;
|
||||
networkManager.ConnectionManager.LocalClient.ClientId = OwnerClientId;
|
||||
// Stop the client-side approval timeout coroutine since we are approved.
|
||||
networkManager.ConnectionManager.StopClientApprovalCoroutine();
|
||||
|
||||
networkManager.ConnectionManager.ConnectedClientIds.Clear();
|
||||
foreach (var clientId in ConnectedClientIds)
|
||||
{
|
||||
networkManager.ConnectionManager.ConnectedClientIds.Add(clientId);
|
||||
}
|
||||
|
||||
// Only if scene management is disabled do we handle NetworkObject synchronization at this point
|
||||
if (!networkManager.NetworkConfig.EnableSceneManagement)
|
||||
@@ -138,8 +169,10 @@ namespace Unity.Netcode
|
||||
// Mark the client being connected
|
||||
networkManager.IsConnectedClient = true;
|
||||
// When scene management is disabled we notify after everything is synchronized
|
||||
networkManager.InvokeOnClientConnectedCallback(context.SenderId);
|
||||
networkManager.ConnectionManager.InvokeOnClientConnectedCallback(context.SenderId);
|
||||
}
|
||||
|
||||
ConnectedClientIds.Dispose();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -59,11 +59,11 @@ namespace Unity.Netcode
|
||||
{
|
||||
var messageVersion = new MessageVersionData();
|
||||
messageVersion.Deserialize(reader);
|
||||
networkManager.MessagingSystem.SetVersion(context.SenderId, messageVersion.Hash, messageVersion.Version);
|
||||
networkManager.ConnectionManager.MessageManager.SetVersion(context.SenderId, messageVersion.Hash, messageVersion.Version);
|
||||
|
||||
// Update the received version since this message will always be passed version 0, due to the map not
|
||||
// being initialized until just now.
|
||||
var messageType = networkManager.MessagingSystem.GetMessageForHash(messageVersion.Hash);
|
||||
var messageType = networkManager.ConnectionManager.MessageManager.GetMessageForHash(messageVersion.Hash);
|
||||
if (messageType == typeof(ConnectionRequestMessage))
|
||||
{
|
||||
receivedMessageVersion = messageVersion.Version;
|
||||
@@ -135,7 +135,7 @@ namespace Unity.Netcode
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
var senderId = context.SenderId;
|
||||
|
||||
if (networkManager.PendingClients.TryGetValue(senderId, out PendingClient client))
|
||||
if (networkManager.ConnectionManager.PendingClients.TryGetValue(senderId, out PendingClient client))
|
||||
{
|
||||
// Set to pending approval to prevent future connection requests from being approved
|
||||
client.ConnectionState = PendingClient.State.PendingApproval;
|
||||
@@ -143,17 +143,8 @@ namespace Unity.Netcode
|
||||
|
||||
if (networkManager.NetworkConfig.ConnectionApproval)
|
||||
{
|
||||
// Note: Delegate creation allocates.
|
||||
// Note: ToArray() also allocates. :(
|
||||
var response = new NetworkManager.ConnectionApprovalResponse();
|
||||
networkManager.ClientsToApprove[senderId] = response;
|
||||
|
||||
networkManager.ConnectionApprovalCallback(
|
||||
new NetworkManager.ConnectionApprovalRequest
|
||||
{
|
||||
Payload = ConnectionData,
|
||||
ClientNetworkId = senderId
|
||||
}, response);
|
||||
var messageRequest = this;
|
||||
networkManager.ConnectionManager.ApproveConnection(ref messageRequest, ref context);
|
||||
}
|
||||
else
|
||||
{
|
||||
@@ -162,7 +153,7 @@ namespace Unity.Netcode
|
||||
Approved = true,
|
||||
CreatePlayerObject = networkManager.NetworkConfig.PlayerPrefab != null
|
||||
};
|
||||
networkManager.HandleConnectionApproval(senderId, response);
|
||||
networkManager.ConnectionManager.HandleConnectionApproval(senderId, response);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
namespace Unity.Netcode
|
||||
{
|
||||
internal struct CreateObjectMessage : INetworkMessage
|
||||
@@ -23,7 +24,7 @@ namespace Unity.Netcode
|
||||
ObjectInfo.Deserialize(reader);
|
||||
if (!networkManager.NetworkConfig.ForceSamePrefabs && !networkManager.SpawnManager.HasPrefab(ObjectInfo))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredMessageManager.TriggerType.OnAddPrefab, ObjectInfo.Hash, reader, ref context);
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnAddPrefab, ObjectInfo.Hash, reader, ref context);
|
||||
return false;
|
||||
}
|
||||
m_ReceivedNetworkVariableData = reader;
|
||||
@@ -34,9 +35,29 @@ 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);
|
||||
}
|
||||
else
|
||||
{
|
||||
CreateObject(ref networkManager, context.SenderId, context.MessageSize, ObjectInfo, m_ReceivedNetworkVariableData);
|
||||
}
|
||||
}
|
||||
|
||||
networkManager.NetworkMetrics.TrackObjectSpawnReceived(context.SenderId, networkObject, context.MessageSize);
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
internal static void CreateObject(ref NetworkManager networkManager, ulong senderId, uint messageSize, NetworkObject.SceneObject sceneObject, FastBufferReader networkVariableData)
|
||||
{
|
||||
try
|
||||
{
|
||||
var networkObject = NetworkObject.AddSceneObject(sceneObject, networkVariableData, networkManager);
|
||||
networkManager.NetworkMetrics.TrackObjectSpawnReceived(senderId, networkObject, messageSize);
|
||||
}
|
||||
catch (System.Exception ex)
|
||||
{
|
||||
UnityEngine.Debug.LogException(ex);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -26,7 +26,7 @@ namespace Unity.Netcode
|
||||
|
||||
if (!networkManager.SpawnManager.SpawnedObjects.TryGetValue(NetworkObjectId, out var networkObject))
|
||||
{
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context);
|
||||
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context);
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
|
||||
@@ -24,7 +24,11 @@ namespace Unity.Netcode
|
||||
|
||||
public void Handle(ref NetworkContext context)
|
||||
{
|
||||
((NetworkManager)context.SystemOwner).CustomMessagingManager.InvokeNamedMessage(Hash, context.SenderId, m_ReceiveData, context.SerializedHeaderSize);
|
||||
var networkManager = (NetworkManager)context.SystemOwner;
|
||||
if (!networkManager.ShutdownInProgress && networkManager.CustomMessagingManager != null)
|
||||
{
|
||||
networkManager.CustomMessagingManager.InvokeNamedMessage(Hash, context.SenderId, m_ReceiveData, context.SerializedHeaderSize);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user