feat: add NetworkObject and NetworkBehaviour reference types
#1173
Conversation
| /// A helper struct for serializing <see cref="NetworkBehaviour"/>s over the network. Can be used in RPCs and <see cref="NetworkVariable{T}"/>. | ||
| /// Note: network ids get recycled by the NetworkManager after a while. So a reference pointing to | ||
| /// </summary> | ||
| public struct NetworkBehaviourReference : INetworkSerializable, IEquatable<NetworkBehaviourReference> |
There was a problem hiding this comment.
wrt:
The fix for this would be to cache the NetworkObject inside the reference after resolving it for the first time but this does not work with NetworkVariable as the struct would no longer be unmanaged.
I think this being a struct, value type and let's say documented with its proper usage etc would be good enough IMHO.
Maybe exposing internal m_NetworkBehaviourId over a public get-only ulong property would give more clues about this thing is actually working inside (+ maybe another TryGet API that accepts that ID too?).
To be fair, I'd like people to use this like: MyServerRpc(new NetworkBehaviourReference(MyNetworkBehaviour)); etc (you get the idea).
long story short, I wouldn't worry about it too much :P
There was a problem hiding this comment.
also what about super-generic GameObject one where we try to get NetworkObject or NetworkBehaviour component from it to serialize over the network? 👀
There was a problem hiding this comment.
You can actually do MyServerRpc(MyNetworkBehaviour) and the implicit operator will make it work automagically as long as the parameter on the RPC function itself uses the reference.
Regarding the GameObject one. I think taking a NetworkBehaviour from it would be a bit too far fetched so I'm afraid people might get confused as to why they can send some GameObjectReferences and not others. NetworkObjectReference also has implicit operators from/to GameObject so you can pass an GameObject into an RPC with a NetworkObjectReference parameter.
There was a problem hiding this comment.
oh this implicit operator, just saw this :)
public static implicit operator NetworkObjectReference(GameObject gameObject) => new NetworkObjectReference(gameObject);There was a problem hiding this comment.
I agree with your second point too!
There was a problem hiding this comment.
actually, what about adding a few other RPCs for these implicit operators into tests you implemented in this PR?
that way, they'll be tested + will be good sample code as well — what do you think?
| using UnityEngine.TestTools; | ||
| using Object = UnityEngine.Object; | ||
|
|
||
| namespace Unity.Netcode.RuntimeTests.Serialization |
There was a problem hiding this comment.
let's not put tests under specific/separate namespaces and keep using the common top-level one?
| namespace Unity.Netcode.RuntimeTests.Serialization | |
| namespace Unity.Netcode.RuntimeTests |
There was a problem hiding this comment.
But then they are not nicely sorted into a single place in the test window. E.g. right now I can simply run all serialization tests.
There was a problem hiding this comment.
ugh, we're going to play "find where my tests are" game with foldout menus instead of a flat hierarchy :P
it's fine though, it's kind of a personal preference — I just wanted to follow the same "per-asmdef namespaces" here too but can live without it.
0xFA11
changed the title
NetworkObject and NetworkBehaviour reference types
…ect-ref # Conflicts: # com.unity.netcode.gameobjects/Tests/Editor/Serialization.meta
|
Is this just to get around the problems that prevent us from being able to pass NetworkObject and NetworkBehaviour directly in RPCs? If so, those problems are corrected in INetworkMessage - INetworkMessage allows implementing extension methods for the serializers that allow doing exactly this without needing to create wrapper classes. |
No, we intentionally wanted to have these reference types so that things won't look like they are serializing |
* develop: feat: interpolation for network transform (#1060) feat: add `NetworkObject` and `NetworkBehaviour` reference types (#1173) # Conflicts: # com.unity.netcode.gameobjects/Components/Interpolator.meta # com.unity.netcode.gameobjects/Components/Interpolator/BufferedLinearInterpolator.cs # com.unity.netcode.gameobjects/Components/NetworkTransform.cs # com.unity.netcode.gameobjects/Tests/Runtime/NetworkTransform/NetworkTransformStateTests.cs # testproject/Assets/Prefabs/PlayerCube.prefab # testproject/Assets/Scenes/ZooSam.unity # testproject/Assets/Scripts/MoveInCircle.cs
…ty-Technologies#1173) * feat: make networkobjectref not stateful * fix docs * standards.py “¯\_(ツ)_/¯“ * standards.py * refactor: standards.py now applied correctly * Tests for implict operators and NetworkVariable Co-authored-by: M. Fatih MAR <mfatihmar@gmail.com>
Implements helper structs for using NetworkObjects and NetworkBehaviours in RPCs and NetworkVariables.
One thing to note about this implementation is that the resolving is stateless. This can be a problem because netcode recycles the networkids so in theory the reference can end up pointing to a different object if the original one gets despawned. The fix for this would be to cache the NetworkObject inside the reference after resolving it for the first time but this does not work with
NetworkVariableas the struct would no longer be unmanaged.