fix: networktransform SwitchTransformSpaceWhenParented forces updates when InLocalSpace is true

[NoelStephensUnity]

Purpose of this PR

This PR resolves the issue where setting SwitchTransformSpaceWhenParented to true and then setting InLocalSpace to true will force the motion authority to continually send updates each tick (whether there is a delta or not).

Jira ticket

MTTB-1584

fix: #3653
fix: #3646
fix: #3645

Changelog

• Added: NetworkRigidbody documentation section.
• Fixed: NetworkTransform state synchronization issue when NetworkTransform.SwitchTransformSpaceWhenParented is enabled and the associated NetworkObject is parented multiple times in a single frame or within a couple of frames.
• Fixed: Issue when spawning, parenting, and immediately re-parenting.
• Changed: NetworkShow sends a message and forces a NetworkVariable synchronization at the end of the frame prior to generating the CreateObjectMessage as opposed to waiting until the next network tick to synchronize the show with the update to NetworkVariables.
• Changed: NetworkTransform now synchronizes NetworkTransform.SwitchTransformSpaceWhenParented when it is updated by the motion model authority.
• Changed: NetworkObjects pending to be shown to clients can now occur on partial network ticks. If any pending NetworkObjects pending to be shown to clients happens to be ready on a new network tick they still are shown after network variable deltas have been processed.
• Changed: The default NetworkDelivery used by all messages is now reliable fragmented sequenced with the exception of named, unnamed, and any messages sent with a user specified network delivery type. This assures certain order of operations to be preserved when same call-stack changes are applied to a newly spawned, authority side, NetworkObject.
• Changed: NetworkTransform documentation to better reflect the Teleport methods intended usage along with updates to NetworkObject and physics areas of the documentation.

Documentation Included

• Includes documentation for existing public API entry points:
  • Updates to the SwitchTransformSpaceWhenParented XML API that provides additional information about usage.
  • Updates to the SetState and Teleport for more clarity on intended usage for both network topologies.
  • Updates to NetworkObject.SpawnWithOwnership to call out how spawning with ownership can impact things like NetworkTransform during the spawning sequence when using a client-server topology.
• Includes updates to existing documentation:
  • Updates to NetworkTransform regarding the use of SwitchTransformSpaceWhenParented.
    • Add section covering spawning, order of operations, and how timing and network topology can impact the end result.
      • Include SetState/Teleport, spawning (with or without) ownership, and the authority motion model.
  • Updates to the NetworkObject spawning section
    • Expand the coverage to include:
      • Spawning then changing ownership vs SpawnWithOwnership
      • Spawning, NetworkTransform, and parenting.
  • Updated physics
    • Includes parenting physics objects using attachables.
  • Added a first pass (still could use some additions in the future) NetworkRigidbody section (pulled this part out of physics).

Testing & QA (How your changes can be verified during release Playtest)

• Includes an integration test to validate the fix (NetworkTransformAutoParenting)
• Includes several additional integration tests via NetworkTransformOrderOfOperations to validate other edge case scenarios:
  • Test-1:
    • Server-> Spawn, change ownership, (wait), parent
  • Test-2:
    • Server-> Spawn, change parent, change ownership
  • Test-3:
    • Server-> Spawn, change parent (1), change ownership
    • Client-> PostSpawn re-parent (2)
  • Test-4:
    • Server-> Spawn no observers, change parents (multiple), NetworkShow, change ownership, Teleport RPC
    • Client-> Teleport RPC
  • Test-5:
    • Server-> Spawn, change parent (1), change ownership, Teleport RPC with NetworkBehaviourReference
    • Client-> Teleport RPC using NetworkBehaviourReference
  • Test-6:
    • Server-> Spawn, change ownership, change parent (1), Teleport RPC with NetworkBehaviourReference
    • Client-> Teleport RPC using NetworkBehaviourReference
  • Test-7:
    • Server-> Spawn with ownership, change parent (1), Teleport RPC with NetworkBehaviourReference
    • Client-> Teleport RPC using NetworkBehaviourReference
  • Test 8:
    • Server-> Start coroutine:
      • Coroutine: Spawn with no observers, change parent (1), NetworkShow, change ownership, Teleport RPC with NetworkBehaviourReference
    • Client-> Teleport RPC using NetworkBehaviourReference.
  • Test 9:
    • Server-> Start coroutine:
      • Coroutine: Spawn with no observers, NetworkShow, change parent (1)
  • Test 10:
    • Server-> Spawn with ownership, change parent (1), Wait (1), Parent RPC with NetworkObjectReference
    • Client-> Re-parent (2) RPC using NetworkObjectReference
  • Test 11:
    • Server-> Spawn with ownership, Parent RPC with NetworkObjectReference,
    • Client-> Parent (1) RPC using NetworkObjectReference
    • Server-> Parent changed --> parent under 2nd object (was a delay, but the recommended way will be to wait if you know the client is going to parent.
• Includes a manual test (need to import this small test into our manual tests)

Functional Testing

Manual testing :

• [ X ] Manual testing done
  • The original CharacterControllerMovingBodies project.
    • This verifies the existing functionality was not broken.
  • The manual test mentioned above that was used to replicate the user's issues and fix them.
    • This verifies (n) parenting events can occur on a single frame and it will be synchronized.

Automated tests:

• Covered by existing automated tests
• [ X ] Covered by new automated tests
  • (wip)

Does the change require QA team to:

• Review automated tests?
• Execute manual tests?
• Provide feedback about the PR?

If any boxes above are checked the QA team will be automatically added as a PR reviewer.

Backports

This is an NGO v2.x.x specific issue. No backport is required.

[jabbacakes]

Left suggestions on the smaller changes - have pushed a commit with changes to the larger new additions to the NetworkTransform page, mostly just trying to improve clarity and reduce verbiage.

This page is getting very long, might break it up at some point, but will do that in a separate PR.

[NoelStephensUnity]

/ci ngo

[NoelStephensUnity]

/ci ngo

[NoelStephensUnity]

/ci ngo

[NoelStephensUnity]

/ci ngo

[EmandM]

This PR was genuinely a joy to review

So many nice things in here I couldn't begin to list them all. Most of my comments are small nit picks. Overall this looks so clean and nice and wonderful I don't even have enough words to say how much I like it.