Class NetworkTransformTests

Integration tests for NetworkTransform that will test both server and host operating modes and will test both authoritative models for each operating mode.

Inheritance
Object
NetcodeIntegrationTest
NetworkTransformTests
Inherited Members
Namespace: Unity.Netcode.RuntimeTests
Syntax
public class NetworkTransformTests : NetcodeIntegrationTest

Constructors

NetworkTransformTests(NetcodeIntegrationTest.HostOrServer, NetworkTransformTests.Authority)

Constructor

Declaration
public NetworkTransformTests(NetcodeIntegrationTest.HostOrServer testWithHost, NetworkTransformTests.Authority authority)
Parameters
Type Name Description
NetcodeIntegrationTest.HostOrServer testWithHost

Value is set by TestFixture
NetworkTransformTests.Authority authority

Properties

NumberOfClients

Declaration
protected override int NumberOfClients { get; }
Property Value
Type Description
Int32
Overrides

Methods

NetworkTransformMultipleChangesOverTime(NetworkTransformTests.TransformSpace, NetworkTransformTests.OverrideState)

This validates that multiple changes can occur within the same tick or over several ticks while still keeping non-authoritative instances synchronized.

Declaration
public IEnumerator NetworkTransformMultipleChangesOverTime(NetworkTransformTests.TransformSpace testLocalTransform, NetworkTransformTests.OverrideState overideState)
Parameters
Type Name Description
NetworkTransformTests.TransformSpace testLocalTransform
NetworkTransformTests.OverrideState overideState
Returns
Type Description
IEnumerator

NetworkTransformParentedLocalSpaceTest(NetworkTransformTests.Interpolation)

Validates that local space transform values remain the same when a NetworkTransform is parented under another NetworkTransform

Declaration
public IEnumerator NetworkTransformParentedLocalSpaceTest(NetworkTransformTests.Interpolation interpolation)
Parameters
Type Name Description
NetworkTransformTests.Interpolation interpolation
Returns
Type Description
IEnumerator

NonAuthorityOwnerSettingStateTest(NetworkTransformTests.Interpolation)

This test validates the SetState(Nullable<Vector3>, Nullable<Quaternion>, Nullable<Vector3>, Boolean) method usage for the non-authoritative side. It will either be the owner or the server making/requesting state changes. This validates that:

  • The owner authoritative mode can still be controlled by the server (i.e. owner authoritative with server authority override capabilities)
  • The server authoritative mode can still be directed by the client owner.
Declaration
public IEnumerator NonAuthorityOwnerSettingStateTest(NetworkTransformTests.Interpolation interpolation)
Parameters
Type Name Description
NetworkTransformTests.Interpolation interpolation
Returns
Type Description
IEnumerator
Remarks

This also tests that the original server authoritative model with client-owner driven NetworkTransforms is preserved.

OnCreatePlayerPrefab()

Declaration
protected override void OnCreatePlayerPrefab()
Overrides

OnNewClientCreated(NetworkManager)

Declaration
protected override void OnNewClientCreated(NetworkManager networkManager)
Parameters
Type Name Description
NetworkManager networkManager
Overrides

OnServerAndClientsConnected()

Declaration
protected override IEnumerator OnServerAndClientsConnected()
Returns
Type Description
IEnumerator
Overrides

OnServerAndClientsCreated()

Declaration
protected override void OnServerAndClientsCreated()
Overrides

OnSetup()

Declaration
protected override IEnumerator OnSetup()
Returns
Type Description
IEnumerator
Overrides

OnTearDown()

Declaration
protected override IEnumerator OnTearDown()
Returns
Type Description
IEnumerator
Overrides

TeleportTest(NetworkTransformTests.Interpolation)

The tests teleporting with and without interpolation

Declaration
public IEnumerator TeleportTest(NetworkTransformTests.Interpolation interpolation)
Parameters
Type Name Description
NetworkTransformTests.Interpolation interpolation
Returns
Type Description
IEnumerator

TestAuthoritativeTransformChangeOneAtATime(NetworkTransformTests.TransformSpace, NetworkTransformTests.Interpolation, NetworkTransformTests.OverrideState)

Tests changing all axial values one at a time. These tests are performed:

  • While in local space and world space
  • While interpolation is enabled and disabled
  • Using the TryCommitTransformToServer "override" that can be used from a child derived or external class.
Declaration
public IEnumerator TestAuthoritativeTransformChangeOneAtATime(NetworkTransformTests.TransformSpace testLocalTransform, NetworkTransformTests.Interpolation interpolation, NetworkTransformTests.OverrideState overideState)
Parameters
Type Name Description
NetworkTransformTests.TransformSpace testLocalTransform
NetworkTransformTests.Interpolation interpolation
NetworkTransformTests.OverrideState overideState
Returns
Type Description
IEnumerator

TestBitsetValue(NetworkTransformTests.Interpolation)

Test to make sure that the bitset value is updated properly

Declaration
public IEnumerator TestBitsetValue(NetworkTransformTests.Interpolation interpolation)
Parameters
Type Name Description
NetworkTransformTests.Interpolation interpolation
Returns
Type Description
IEnumerator

TestRotationThresholdDeltaCheck(NetworkTransformTests.Interpolation)

Validates that rotation checks don't produce false positive results when rolling over between 0 and 360 degrees

Declaration
public IEnumerator TestRotationThresholdDeltaCheck(NetworkTransformTests.Interpolation interpolation)
Parameters
Type Name Description
NetworkTransformTests.Interpolation interpolation
Returns
Type Description
IEnumerator

VerifyNonAuthorityCantChangeTransform(NetworkTransformTests.Interpolation)

Test to verify nonAuthority cannot change the transform directly

Declaration
public IEnumerator VerifyNonAuthorityCantChangeTransform(NetworkTransformTests.Interpolation interpolation)
Parameters
Type Name Description
NetworkTransformTests.Interpolation interpolation
Returns
Type Description
IEnumerator