charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 19:10:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(NetworkBehaviour): Skip OnValidate in Editor Play Mode (#3852)

Browse Source 
OnValidate only runs in Editor, but can get invoked in PlayMode if user fiddles with the inspector or by other Unity activities.
This commit is contained in:
MrGadget 2024-06-29 15:09:50 -04:00
parent 0fcd3a28a5
commit 7eabb5c5f9
6 changed files with 99 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable.cs
View File

@ -11,6 +11,21 @@ public class NetworkRigidbodyReliable : NetworkTransformReliable
Rigidbody rb;
bool wasKinematic;
protected override void OnValidate()
{
// Skip if Editor is in Play mode
if (Application.isPlaying) return;
base.OnValidate();
// we can't overwrite .target to be a Rigidbody.
// but we can ensure that .target has a Rigidbody, and use it.
if (target.GetComponent<Rigidbody>() == null)
{
Debug.LogWarning($"{name}'s NetworkRigidbody.target {target.name} is missing a Rigidbody", this);
}
}
// cach Rigidbody and original isKinematic setting
protected override void Awake()
{
@ -82,18 +97,6 @@ void FixedUpdate()
}
}
protected override void OnValidate()
{
base.OnValidate();
// we can't overwrite .target to be a Rigidbody.
// but we can ensure that .target has a Rigidbody, and use it.
if (target.GetComponent<Rigidbody>() == null)
{
Debug.LogWarning($"{name}'s NetworkRigidbody.target {target.name} is missing a Rigidbody", this);
}
}
protected override void OnTeleport(Vector3 destination)
{
base.OnTeleport(destination);

26
Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyReliable2D.cs
View File

@ -11,6 +11,20 @@ public class NetworkRigidbodyReliable2D : NetworkTransformReliable
Rigidbody2D rb;
bool wasKinematic;
protected override void OnValidate()
{
if (Application.isPlaying) return;
base.OnValidate();
// we can't overwrite .target to be a Rigidbody.
// but we can ensure that .target has a Rigidbody, and use it.
if (target.GetComponent<Rigidbody2D>() == null)
{
Debug.LogWarning($"{name}'s NetworkRigidbody2D.target {target.name} is missing a Rigidbody2D", this);
}
}
// cach Rigidbody and original isKinematic setting
protected override void Awake()
{
@ -82,18 +96,6 @@ void FixedUpdate()
}
}
protected override void OnValidate()
{
base.OnValidate();
// we can't overwrite .target to be a Rigidbody.
// but we can ensure that .target has a Rigidbody, and use it.
if (target.GetComponent<Rigidbody2D>() == null)
{
Debug.LogWarning($"{name}'s NetworkRigidbody2D.target {target.name} is missing a Rigidbody2D", this);
}
}
protected override void OnTeleport(Vector3 destination)
{
base.OnTeleport(destination);

27
Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable.cs
View File

@ -11,6 +11,21 @@ public class NetworkRigidbodyUnreliable : NetworkTransformUnreliable
Rigidbody rb;
bool wasKinematic;
protected override void OnValidate()
{
// Skip if Editor is in Play mode
if (Application.isPlaying) return;
base.OnValidate();
// we can't overwrite .target to be a Rigidbody.
// but we can ensure that .target has a Rigidbody, and use it.
if (target.GetComponent<Rigidbody>() == null)
{
Debug.LogWarning($"{name}'s NetworkRigidbody.target {target.name} is missing a Rigidbody", this);
}
}
// cach Rigidbody and original isKinematic setting
protected override void Awake()
{
@ -82,18 +97,6 @@ void FixedUpdate()
}
}
protected override void OnValidate()
{
base.OnValidate();
// we can't overwrite .target to be a Rigidbody.
// but we can ensure that .target has a Rigidbody, and use it.
if (target.GetComponent<Rigidbody>() == null)
{
Debug.LogWarning($"{name}'s NetworkRigidbody.target {target.name} is missing a Rigidbody", this);
}
}
protected override void OnTeleport(Vector3 destination)
{
base.OnTeleport(destination);

27
Assets/Mirror/Components/NetworkRigidbody/NetworkRigidbodyUnreliable2D.cs
View File

@ -11,6 +11,21 @@ public class NetworkRigidbodyUnreliable2D : NetworkTransformUnreliable
Rigidbody2D rb;
bool wasKinematic;
protected override void OnValidate()
{
// Skip if Editor is in Play mode
if (Application.isPlaying) return;
base.OnValidate();
// we can't overwrite .target to be a Rigidbody.
// but we can ensure that .target has a Rigidbody, and use it.
if (target.GetComponent<Rigidbody2D>() == null)
{
Debug.LogWarning($"{name}'s NetworkRigidbody2D.target {target.name} is missing a Rigidbody2D", this);
}
}
// cach Rigidbody and original isKinematic setting
protected override void Awake()
{
@ -82,18 +97,6 @@ void FixedUpdate()
}
}
protected override void OnValidate()
{
base.OnValidate();
// we can't overwrite .target to be a Rigidbody.
// but we can ensure that .target has a Rigidbody, and use it.
if (target.GetComponent<Rigidbody2D>() == null)
{
Debug.LogWarning($"{name}'s NetworkRigidbody2D.target {target.name} is missing a Rigidbody2D", this);
}
}
protected override void OnTeleport(Vector3 destination)
{
base.OnTeleport(destination);

19
Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs
View File

@ -98,6 +98,17 @@ public abstract class NetworkTransformBase : NetworkBehaviour
public bool showOverlay;
public Color overlayColor = new Color(0, 0, 0, 0.5f);
protected override void OnValidate()
{
// Skip if Editor is in Play mode
if (Application.isPlaying) return;
base.OnValidate();
// configure in awake
Configure();
}
// initialization //////////////////////////////////////////////////////
// forcec configuration of some settings
protected virtual void Configure()
@ -125,14 +136,6 @@ protected virtual void Awake()
Configure();
}
protected override void OnValidate()
{
base.OnValidate();
// configure in awake
Configure();
}
// snapshot functions //////////////////////////////////////////////////
// get local/world position
protected virtual Vector3 GetPosition() =>

57
Assets/Mirror/Core/NetworkBehaviour.cs
View File

@ -149,6 +149,35 @@ public bool authority
// hook guard prevents that.
ulong syncVarHookGuard;
protected virtual void OnValidate()
{
// Skip if Editor is in Play mode
if (Application.isPlaying) return;
// we now allow child NetworkBehaviours.
// we can not [RequireComponent(typeof(NetworkIdentity))] anymore.
// instead, we need to ensure a NetworkIdentity is somewhere in the
// parents.
// only run this in Editor. don't add more runtime overhead.
// GetComponentInParent(includeInactive) is needed because Prefabs are not
// considered active, so this check requires to scan inactive.
#if UNITY_2021_3_OR_NEWER // 2021 has GetComponentInParent(bool includeInactive = false)
if (GetComponent<NetworkIdentity>() == null &&
GetComponentInParent<NetworkIdentity>(true) == null)
{
Debug.LogError($"{GetType()} on {name} requires a NetworkIdentity. Please add a NetworkIdentity component to {name} or it's parents.", this);
}
#elif UNITY_2020_3_OR_NEWER // 2020 only has GetComponentsInParent(bool includeInactive = false), we can use this too
NetworkIdentity[] parentsIds = GetComponentsInParent<NetworkIdentity>(true);
int parentIdsCount = parentsIds != null ? parentsIds.Length : 0;
if (GetComponent<NetworkIdentity>() == null && parentIdsCount == 0)
{
Debug.LogError($"{GetType()} on {name} requires a NetworkIdentity. Please add a NetworkIdentity component to {name} or it's parents.", this);
}
#endif
}
// USED BY WEAVER to set syncvars in host mode without deadlocking
protected bool GetSyncVarHookGuard(ulong dirtyBit) =>
(syncVarHookGuard & dirtyBit) != 0UL;
@ -302,34 +331,6 @@ protected void InitSyncObject(SyncObject syncObject)
};
}
protected virtual void OnValidate()
{
// we now allow child NetworkBehaviours.
// we can not [RequireComponent(typeof(NetworkIdentity))] anymore.
// instead, we need to ensure a NetworkIdentity is somewhere in the
// parents.
// only run this in Editor. don't add more runtime overhead.
// GetComponentInParent(includeInactive) is needed because Prefabs are not
// considered active, so this check requires to scan inactive.
#if UNITY_EDITOR
#if UNITY_2021_3_OR_NEWER // 2021 has GetComponentInParent(bool includeInactive = false)
if (GetComponent<NetworkIdentity>() == null &&
GetComponentInParent<NetworkIdentity>(true) == null)
{
Debug.LogError($"{GetType()} on {name} requires a NetworkIdentity. Please add a NetworkIdentity component to {name} or it's parents.", this);
}
#elif UNITY_2020_3_OR_NEWER // 2020 only has GetComponentsInParent(bool includeInactive = false), we can use this too
NetworkIdentity[] parentsIds = GetComponentsInParent<NetworkIdentity>(true);
int parentIdsCount = parentsIds != null ? parentsIds.Length : 0;
if (GetComponent<NetworkIdentity>() == null && parentIdsCount == 0)
{
Debug.LogError($"{GetType()} on {name} requires a NetworkIdentity. Please add a NetworkIdentity component to {name} or it's parents.", this);
}
#endif
#endif
}
// pass full function name to avoid ClassA.Func <-> ClassB.Func collisions
protected void SendCommandInternal(string functionFullName, int functionHashCode, NetworkWriter writer, int channelId, bool requiresAuthority = true)
{