Class ChildObjectComponent

Helper component for NetworkTransform parenting tests

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
NetworkBehaviour
NetworkTransform
ChildObjectComponent
SubChildObjectComponent
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: Unity.Netcode.RuntimeTests
Assembly: Unity.Netcode.RuntimeTests.dll
Syntax
public class ChildObjectComponent : NetworkTransform

Fields

ClientInstances

Declaration
public static readonly Dictionary<ulong, NetworkObject> ClientInstances
Field Value
Type Description
Dictionary<ulong, NetworkObject>

ClientSubChildInstances

Declaration
public static readonly Dictionary<ulong, NetworkObject> ClientSubChildInstances
Field Value
Type Description
Dictionary<ulong, NetworkObject>

EnableChildLog

Declaration
public static bool EnableChildLog
Field Value
Type Description
bool

HasSubChild

Declaration
public static bool HasSubChild
Field Value
Type Description
bool

Instances

Declaration
public static readonly List<ChildObjectComponent> Instances
Field Value
Type Description
List<ChildObjectComponent>

InstancesWithLogging

Declaration
public static readonly List<ChildObjectComponent> InstancesWithLogging
Field Value
Type Description
List<ChildObjectComponent>

ServerAuthority

Declaration
public bool ServerAuthority
Field Value
Type Description
bool

SubInstances

Declaration
public static readonly List<ChildObjectComponent> SubInstances
Field Value
Type Description
List<ChildObjectComponent>

TestCount

Declaration
public static int TestCount
Field Value
Type Description
int

Properties

AuthorityInstance

Declaration
public static ChildObjectComponent AuthorityInstance { get; }
Property Value
Type Description
ChildObjectComponent

AuthoritySubInstance

Declaration
public static ChildObjectComponent AuthoritySubInstance { get; }
Property Value
Type Description
ChildObjectComponent

Methods

IsSubChild()

Declaration
protected virtual bool IsSubChild()
Returns
Type Description
bool

OnAuthorityPushTransformState(ref NetworkTransformState)

Invoked just prior to being pushed to non-authority instances.

Declaration
protected override void OnAuthorityPushTransformState(ref NetworkTransform.NetworkTransformState networkTransformState)
Parameters
Type Name Description
NetworkTransform.NetworkTransformState networkTransformState

the state being pushed
Overrides
Remarks

This is useful to know the exact position, rotation, or scale values sent to non-authoritative instances. This is only invoked on the authoritative instance.

OnIsServerAuthoritative()

Override this method and return false to switch to owner authoritative mode

Declaration
protected override bool OnIsServerAuthoritative()
Returns
Type Description
bool

(true or false) where when false it runs as owner-client authoritative
Overrides

OnNetworkDespawn()

Gets called when the NetworkObject gets despawned. Is called both on the server and clients.

Declaration
public override void OnNetworkDespawn()
Overrides

OnNetworkObjectParentChanged(NetworkObject)

Gets called when the parent NetworkObject of this NetworkBehaviour's NetworkObject has changed

Declaration
public override void OnNetworkObjectParentChanged(NetworkObject parentNetworkObject)
Parameters
Type Name Description
NetworkObject parentNetworkObject

the new NetworkObject parent
Overrides
Remarks

When a parent changes, non-authoritative instances should:

  • Apply the resultant position, rotation, and scale from the parenting action.
  • Clear interpolators (even if not enabled on this frame)
  • Reset the interpolators to the position, rotation, and scale resultant values. This prevents interpolation visual anomalies and issues during initial synchronization

OnNetworkSpawn()

Gets called when the NetworkObject gets spawned, message handlers are ready to be registered and the network is setup.

Declaration
public override void OnNetworkSpawn()
Overrides

OnNetworkTransformStateUpdated(ref NetworkTransformState, ref NetworkTransformState)

Invoked on the non-authoritative side when the NetworkTransformState has been updated

Declaration
protected override void OnNetworkTransformStateUpdated(ref NetworkTransform.NetworkTransformState oldState, ref NetworkTransform.NetworkTransformState newState)
Parameters
Type Name Description
NetworkTransform.NetworkTransformState oldState

the previous NetworkTransform.NetworkTransformState
NetworkTransform.NetworkTransformState newState

the new NetworkTransform.NetworkTransformState
Overrides

OnSynchronize<T>(ref BufferSerializer<T>)

This is invoked when a new client joins (server and client sides) Server Side: Serializes as if we were teleporting (everything is sent via NetworkTransformState) Client Side: Adds the interpolated state which applies the NetworkTransformState as well

Declaration
protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer) where T : IReaderWriter
Parameters
Type Name Description
BufferSerializer<T> serializer
Type Parameters
Name Description
T
Overrides
Remarks

If a derived class overrides this, then make sure to invoke this base method!

Reset()

Declaration
public static void Reset()