Skip to content
This repository was archived by the owner on Jul 23, 2025. It is now read-only.

chore: Managed Netvar documentation #818

Merged
merged 16 commits into from
Dec 6, 2022

Conversation

ShadauxCat
Copy link
Contributor

Select the type of change:

  • Small Changes - Typos, formatting, slight revisions
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - Updates, maintenance, and new packages for the site and Docusaurus

Purpose of the Pull Request:
Updates the NetworkVariable documentation to remove references to the unmanaged type limitation and update surrounding documentation to be more accurate to the current state.

Adds information about using managed types in NetworkVariable, and about custom serialization for types we don't natively support.

Adds information in our serialization section about INetworkSerializeByMemcpy and FixedString.

Fixes a few spelling and grammar errors.

Issue Number:
MTT-4771

@chrispope chrispope changed the base branch from main to develop October 10, 2022 08:13
Copy link
Collaborator

@chrispope chrispope left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestions to the copy

@chrispope chrispope requested a review from armstrongl October 10, 2022 08:22
@@ -30,7 +32,7 @@ public static class SerializationExtensions

public static void WriteValueSafe(this FastBufferWriter writer, in Url value)
{
writer.WriteValueSafe(instance.Value);
writer.WriteValueSafe(value.Value);
Copy link
Contributor

@NoelStephensUnity NoelStephensUnity Oct 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor nit-pick.
could we change this:
in Url value
To something like this:
in Url url

(just trying to avoid value.Value...something like url.Value is easier to follow)

`NetworkVariable` goes through a slightly different pipeline than `RPC`s and relies on a different process for determining how to serialize its types. As a result, making a custom type available to the `RPC` pipeline doesn't automatically make it available to the `NetworkVariable` pipeline, and vice-versa. The same method can be used for both, but currently, `NetworkVariable` requires an additional runtime step to make it aware of the methods.

To add custom serialization support in `NetworkVariable`, follow the steps from the "For RPCs" section to write extension methods for `FastBufferReader` and `FastBufferWriter`; then, somewhere in your application startup (before any `NetworkVariable`s using the affected types will be serialized) add the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you provide a relative link to the "For RPCs" section reference?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I provide a link to a heading in the same file?

public NetworkVariable<ForceNetworkSerializeByMemcpy<Guid>> GuidVar;
```

:::note
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps this should be a
:::caution
?

:::


## Strings: NetworkVariable or Custom NetworkVariable?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😻
Yay for managed types!!!

Copy link
Contributor

@armstrongl armstrongl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few suggestions related to readability, but it looks good!

Copy link
Contributor

@armstrongl armstrongl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@ShadauxCat ShadauxCat merged commit 3bbf536 into develop Dec 6, 2022
@ShadauxCat ShadauxCat deleted the chore/update_docs_with_managed_netvar_support branch December 6, 2022 19:51
armstrongl pushed a commit that referenced this pull request Dec 8, 2022
* Sync develop with main (#868)

* Publish staged content (#852)

* Merging Develop with Main (#813) (#826)

* Updating docs page in 2D space shooter (#810)

Updating docs page in 2D space shooter which has a reference to an unconfirmed feature (Prediction)

* updating boss room example used in mid-game reconnecting doc (#725)

Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>

* Update getting-started-boss-room.md (#812)

Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* small fixes for tutorials (#829)

* renamed command line argument and variable in helloworld code snippet

* fixing broken link in gp module 2

* fixing indentation issues in gp 1 code snippets

* fixing log not corresponding to code example

* updating gp table of contents

* removing unneeded instructions

* Update NGO changelog to 1.1.0 (#834)

* Update NGO changelog to 1.1.0

* Add PR and issue links

* In-Scene Placed NetworkObject updates for v1.1.0 (#816)

* Merging Develop with Main (#813)

* Updating docs page in 2D space shooter (#810)

Updating docs page in 2D space shooter which has a reference to an unconfirmed feature (Prediction)

* updating boss room example used in mid-game reconnecting doc (#725)

Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>

* Update getting-started-boss-room.md (#812)

Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* Start 1.1.0 updates

Just creating a branch to start working on v1.1.0 updates

* update

updated the spawning and despawning portion.

* update

Final first pass for in-scene placed NetworkObject documentation updates.

* update

adding temporary warning to users about in-scene placed NetworkObject parenting.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* WorldPositionStays update (#778)

* WorldPositionStays update 

The update to this documentation requires NGO SDK PR-2146 before it should be made public/merged.

* update

Still WIP

* update

additions and adjustments.

* update

* update

final pass adjustments for the PRs suggested updates.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Remove internal comment (#830)

* update ClientNetworkTransform information (#791)

* update ClientNetworkTransform information

This just provides users with a bit more information about setting NetworkTransform into owner/client authoritative mode,

* update

adjusting the text copy and pointing the example of the ClientNetworkTransform to the co-op samples version

* update

Applying suggested update for section that outlines how to add the multiplayer samples utilities package to your project.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Updated existing or added missing dark themes to our sequence and scene diagrams! (#838)

Co-authored-by: Larah Armstrong <[email protected]>

* Add NGO 1.1.0 documentation (#839)

* Bump version

* update

Adjusting the code example to be compliant with the recent updates.
Adding additional information about the example in the note.

* parenting update

Adding some additional language to the parenting related documents and fixing a minor spelling issue.

Co-authored-by: NoelStephensUnity <[email protected]>

* NGO 1.1.0 release notes (#843)

* Fix version drop-down order

* Add NGO 1.1.0 release notes

* fix: tutorial improvements (#840)

* fixing typos and broken links

* clarifying the Testing Hello World section

* Clarified the usage of OnNetworkSpawn in HelloWorldPlayer

* clarified Adding Editor Modes section in GP1

* clarified use of command line helper

* Adding high-level explanation of what NetworkManager and UTP are in HelloWorld tutorial, with links to detailed docs

* restructured GP1 to have instructions to add script after description of why we add them

* adding links to gp_intro

Co-authored-by: Larah Armstrong <[email protected]>

* Add "coming soon" note to empty pages (#845)

* Add Optimizing Boss Room Performance

* Revert "Add Optimizing Boss Room Performance"

This reverts commit 427c1f2.

* Add Optimizing Boss Room Performance (#848)

* Add Optimizing Boss Room Performance

* Minor fixes

* Implement feedback

* Fix SceneEventType Typo (#850)

* Publish staged content (#844)

* Merging Develop with Main (#813) (#826)

* Updating docs page in 2D space shooter (#810)

Updating docs page in 2D space shooter which has a reference to an unconfirmed feature (Prediction)

* updating boss room example used in mid-game reconnecting doc (#725)

Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>

* Update getting-started-boss-room.md (#812)

Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* small fixes for tutorials (#829)

* renamed command line argument and variable in helloworld code snippet

* fixing broken link in gp module 2

* fixing indentation issues in gp 1 code snippets

* fixing log not corresponding to code example

* updating gp table of contents

* removing unneeded instructions

* Update NGO changelog to 1.1.0 (#834)

* Update NGO changelog to 1.1.0

* Add PR and issue links

* In-Scene Placed NetworkObject updates for v1.1.0 (#816)

* Merging Develop with Main (#813)

* Updating docs page in 2D space shooter (#810)

Updating docs page in 2D space shooter which has a reference to an unconfirmed feature (Prediction)

* updating boss room example used in mid-game reconnecting doc (#725)

Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>

* Update getting-started-boss-room.md (#812)

Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* Start 1.1.0 updates

Just creating a branch to start working on v1.1.0 updates

* update

updated the spawning and despawning portion.

* update

Final first pass for in-scene placed NetworkObject documentation updates.

* update

adding temporary warning to users about in-scene placed NetworkObject parenting.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* WorldPositionStays update (#778)

* WorldPositionStays update 

The update to this documentation requires NGO SDK PR-2146 before it should be made public/merged.

* update

Still WIP

* update

additions and adjustments.

* update

* update

final pass adjustments for the PRs suggested updates.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Remove internal comment (#830)

* update ClientNetworkTransform information (#791)

* update ClientNetworkTransform information

This just provides users with a bit more information about setting NetworkTransform into owner/client authoritative mode,

* update

adjusting the text copy and pointing the example of the ClientNetworkTransform to the co-op samples version

* update

Applying suggested update for section that outlines how to add the multiplayer samples utilities package to your project.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Updated existing or added missing dark themes to our sequence and scene diagrams! (#838)

Co-authored-by: Larah Armstrong <[email protected]>

* Add NGO 1.1.0 documentation (#839)

* Bump version

* update

Adjusting the code example to be compliant with the recent updates.
Adding additional information about the example in the note.

* parenting update

Adding some additional language to the parenting related documents and fixing a minor spelling issue.

Co-authored-by: NoelStephensUnity <[email protected]>

* NGO 1.1.0 release notes (#843)

* Fix version drop-down order

* Add NGO 1.1.0 release notes

* fix: tutorial improvements (#840)

* fixing typos and broken links

* clarifying the Testing Hello World section

* Clarified the usage of OnNetworkSpawn in HelloWorldPlayer

* clarified Adding Editor Modes section in GP1

* clarified use of command line helper

* Adding high-level explanation of what NetworkManager and UTP are in HelloWorld tutorial, with links to detailed docs

* restructured GP1 to have instructions to add script after description of why we add them

* adding links to gp_intro

Co-authored-by: Larah Armstrong <[email protected]>

* Add "coming soon" note to empty pages (#845)

* Add Optimizing Boss Room Performance

* Revert "Add Optimizing Boss Room Performance"

This reverts commit 427c1f2.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>

* Fix SceneEventType Typo

LoadEvenetCompleted should be LoadEventCompleted.
Refer to: https://docs-multiplayer.unity3d.com/netcode/current/api/Unity.Netcode.SceneEventType/index.html

Co-authored-by: Larah Armstrong <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>

* Simplify Boss Room Get started page (#851)

* Make Get started reflect the README

* Implement suggestions

* Info about ParrelSync with Unity Authentication (#795)

* Info about ParrelSync with Unity Authentication

Add some information about using ParrelSync with Unity Authentication.
Include a code snippet showing how to use the ClonesManager to automatically switch player profiles.

* Implement suggested changes

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Add Network Simulator documentation (#853)

* Add Network Simulator docs

* Add to sidebar

* Fix hard line breaks

* Implement suggested changes

* Implement suggested changes

* Add versioning for Tools and switch the latest to 1.1.0

* Add Tools 1.1.0 SDK documentation

* Remove test pages (#862)

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>
Co-authored-by: Hunter <[email protected]>
Co-authored-by: Ben Randall <[email protected]>

* Fixed typo in messaging-system.md (#864)

NetworkVariables was spelt *Newt*orkVariable (lol)

* Update networkobject.md (#860)

Co-authored-by: Larah Armstrong <[email protected]>

* docs: fix broken copy/paste link (#855)

This fixes the broken copy/paste link for adding the Multiplayer Samples Utilities package.

Co-authored-by: Larah Armstrong <[email protected]>

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>
Co-authored-by: Hunter <[email protected]>
Co-authored-by: Ben Randall <[email protected]>
Co-authored-by: Walter Hulsebos <[email protected]>
Co-authored-by: Alex Robinson <[email protected]>
Co-authored-by: Jonas Lagoni <[email protected]>

* Update PR template with warning (#869)

* Fixed misleading example about NetworkList (#854)

Fixed misleading example about NetworkList, and added a more extensive example to display how to react on NetworkList changes specifically on the server/client

Co-authored-by: Larah Armstrong <[email protected]>

* Update ClientDriven.md with updated scripting references (#865)

Co-authored-by: Larah Armstrong <[email protected]>

* chore: Managed Netvar documentation (#818)

* Update UTP 2.0 documentation (#875)

* Update UTP 2.0 documentation

* Add images

* Fix pipeline image

* Swap pipeline image order

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>
Co-authored-by: Hunter <[email protected]>
Co-authored-by: Ben Randall <[email protected]>
Co-authored-by: Walter Hulsebos <[email protected]>
Co-authored-by: Alex Robinson <[email protected]>
Co-authored-by: Jonas Lagoni <[email protected]>
Co-authored-by: Paolo Abela <[email protected]>
Co-authored-by: Fernando Cortez <[email protected]>
Co-authored-by: Kitty Draper <[email protected]>
armstrongl pushed a commit that referenced this pull request Dec 13, 2022
* Sync develop with main (#868)

* Publish staged content (#852)

* Merging Develop with Main (#813) (#826)

* Updating docs page in 2D space shooter (#810)

Updating docs page in 2D space shooter which has a reference to an unconfirmed feature (Prediction)

* updating boss room example used in mid-game reconnecting doc (#725)

Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>

* Update getting-started-boss-room.md (#812)

Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* small fixes for tutorials (#829)

* renamed command line argument and variable in helloworld code snippet

* fixing broken link in gp module 2

* fixing indentation issues in gp 1 code snippets

* fixing log not corresponding to code example

* updating gp table of contents

* removing unneeded instructions

* Update NGO changelog to 1.1.0 (#834)

* Update NGO changelog to 1.1.0

* Add PR and issue links

* In-Scene Placed NetworkObject updates for v1.1.0 (#816)

* Merging Develop with Main (#813)

* Updating docs page in 2D space shooter (#810)

Updating docs page in 2D space shooter which has a reference to an unconfirmed feature (Prediction)

* updating boss room example used in mid-game reconnecting doc (#725)

Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>

* Update getting-started-boss-room.md (#812)

Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* Start 1.1.0 updates

Just creating a branch to start working on v1.1.0 updates

* update

updated the spawning and despawning portion.

* update

Final first pass for in-scene placed NetworkObject documentation updates.

* update

adding temporary warning to users about in-scene placed NetworkObject parenting.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* WorldPositionStays update (#778)

* WorldPositionStays update 

The update to this documentation requires NGO SDK PR-2146 before it should be made public/merged.

* update

Still WIP

* update

additions and adjustments.

* update

* update

final pass adjustments for the PRs suggested updates.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Remove internal comment (#830)

* update ClientNetworkTransform information (#791)

* update ClientNetworkTransform information

This just provides users with a bit more information about setting NetworkTransform into owner/client authoritative mode,

* update

adjusting the text copy and pointing the example of the ClientNetworkTransform to the co-op samples version

* update

Applying suggested update for section that outlines how to add the multiplayer samples utilities package to your project.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Updated existing or added missing dark themes to our sequence and scene diagrams! (#838)

Co-authored-by: Larah Armstrong <[email protected]>

* Add NGO 1.1.0 documentation (#839)

* Bump version

* update

Adjusting the code example to be compliant with the recent updates.
Adding additional information about the example in the note.

* parenting update

Adding some additional language to the parenting related documents and fixing a minor spelling issue.

Co-authored-by: NoelStephensUnity <[email protected]>

* NGO 1.1.0 release notes (#843)

* Fix version drop-down order

* Add NGO 1.1.0 release notes

* fix: tutorial improvements (#840)

* fixing typos and broken links

* clarifying the Testing Hello World section

* Clarified the usage of OnNetworkSpawn in HelloWorldPlayer

* clarified Adding Editor Modes section in GP1

* clarified use of command line helper

* Adding high-level explanation of what NetworkManager and UTP are in HelloWorld tutorial, with links to detailed docs

* restructured GP1 to have instructions to add script after description of why we add them

* adding links to gp_intro

Co-authored-by: Larah Armstrong <[email protected]>

* Add "coming soon" note to empty pages (#845)

* Add Optimizing Boss Room Performance

* Revert "Add Optimizing Boss Room Performance"

This reverts commit 427c1f2.

* Add Optimizing Boss Room Performance (#848)

* Add Optimizing Boss Room Performance

* Minor fixes

* Implement feedback

* Fix SceneEventType Typo (#850)

* Publish staged content (#844)

* Merging Develop with Main (#813) (#826)

* Updating docs page in 2D space shooter (#810)

Updating docs page in 2D space shooter which has a reference to an unconfirmed feature (Prediction)

* updating boss room example used in mid-game reconnecting doc (#725)

Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>

* Update getting-started-boss-room.md (#812)

Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* small fixes for tutorials (#829)

* renamed command line argument and variable in helloworld code snippet

* fixing broken link in gp module 2

* fixing indentation issues in gp 1 code snippets

* fixing log not corresponding to code example

* updating gp table of contents

* removing unneeded instructions

* Update NGO changelog to 1.1.0 (#834)

* Update NGO changelog to 1.1.0

* Add PR and issue links

* In-Scene Placed NetworkObject updates for v1.1.0 (#816)

* Merging Develop with Main (#813)

* Updating docs page in 2D space shooter (#810)

Updating docs page in 2D space shooter which has a reference to an unconfirmed feature (Prediction)

* updating boss room example used in mid-game reconnecting doc (#725)

Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>

* Update getting-started-boss-room.md (#812)

Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* Start 1.1.0 updates

Just creating a branch to start working on v1.1.0 updates

* update

updated the spawning and despawning portion.

* update

Final first pass for in-scene placed NetworkObject documentation updates.

* update

adding temporary warning to users about in-scene placed NetworkObject parenting.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>

* WorldPositionStays update (#778)

* WorldPositionStays update 

The update to this documentation requires NGO SDK PR-2146 before it should be made public/merged.

* update

Still WIP

* update

additions and adjustments.

* update

* update

final pass adjustments for the PRs suggested updates.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Remove internal comment (#830)

* update ClientNetworkTransform information (#791)

* update ClientNetworkTransform information

This just provides users with a bit more information about setting NetworkTransform into owner/client authoritative mode,

* update

adjusting the text copy and pointing the example of the ClientNetworkTransform to the co-op samples version

* update

Applying suggested update for section that outlines how to add the multiplayer samples utilities package to your project.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Updated existing or added missing dark themes to our sequence and scene diagrams! (#838)

Co-authored-by: Larah Armstrong <[email protected]>

* Add NGO 1.1.0 documentation (#839)

* Bump version

* update

Adjusting the code example to be compliant with the recent updates.
Adding additional information about the example in the note.

* parenting update

Adding some additional language to the parenting related documents and fixing a minor spelling issue.

Co-authored-by: NoelStephensUnity <[email protected]>

* NGO 1.1.0 release notes (#843)

* Fix version drop-down order

* Add NGO 1.1.0 release notes

* fix: tutorial improvements (#840)

* fixing typos and broken links

* clarifying the Testing Hello World section

* Clarified the usage of OnNetworkSpawn in HelloWorldPlayer

* clarified Adding Editor Modes section in GP1

* clarified use of command line helper

* Adding high-level explanation of what NetworkManager and UTP are in HelloWorld tutorial, with links to detailed docs

* restructured GP1 to have instructions to add script after description of why we add them

* adding links to gp_intro

Co-authored-by: Larah Armstrong <[email protected]>

* Add "coming soon" note to empty pages (#845)

* Add Optimizing Boss Room Performance

* Revert "Add Optimizing Boss Room Performance"

This reverts commit 427c1f2.

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>

* Fix SceneEventType Typo

LoadEvenetCompleted should be LoadEventCompleted.
Refer to: https://docs-multiplayer.unity3d.com/netcode/current/api/Unity.Netcode.SceneEventType/index.html

Co-authored-by: Larah Armstrong <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>

* Simplify Boss Room Get started page (#851)

* Make Get started reflect the README

* Implement suggestions

* Info about ParrelSync with Unity Authentication (#795)

* Info about ParrelSync with Unity Authentication

Add some information about using ParrelSync with Unity Authentication.
Include a code snippet showing how to use the ClonesManager to automatically switch player profiles.

* Implement suggested changes

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>
Co-authored-by: Larah Armstrong <[email protected]>

* Add Network Simulator documentation (#853)

* Add Network Simulator docs

* Add to sidebar

* Fix hard line breaks

* Implement suggested changes

* Implement suggested changes

* Add versioning for Tools and switch the latest to 1.1.0

* Add Tools 1.1.0 SDK documentation

* Remove test pages (#862)

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>
Co-authored-by: Hunter <[email protected]>
Co-authored-by: Ben Randall <[email protected]>

* Fixed typo in messaging-system.md (#864)

NetworkVariables was spelt *Newt*orkVariable (lol)

* Update networkobject.md (#860)

Co-authored-by: Larah Armstrong <[email protected]>

* docs: fix broken copy/paste link (#855)

This fixes the broken copy/paste link for adding the Multiplayer Samples Utilities package.

Co-authored-by: Larah Armstrong <[email protected]>

Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>
Co-authored-by: Hunter <[email protected]>
Co-authored-by: Ben Randall <[email protected]>
Co-authored-by: Walter Hulsebos <[email protected]>
Co-authored-by: Alex Robinson <[email protected]>
Co-authored-by: Jonas Lagoni <[email protected]>

* Update PR template with warning (#869)

* Fixed misleading example about NetworkList (#854)

Fixed misleading example about NetworkList, and added a more extensive example to display how to react on NetworkList changes specifically on the server/client

Co-authored-by: Larah Armstrong <[email protected]>

* Update ClientDriven.md with updated scripting references (#865)

Co-authored-by: Larah Armstrong <[email protected]>

* chore: Managed Netvar documentation (#818)

* Update UTP 2.0 documentation (#875)

* Update UTP 2.0 documentation

* Add images

* Fix pipeline image

* Swap pipeline image order

* Bump loader-utils from 1.4.0 to 1.4.1 (#847)

Bumps [loader-utils](https://github.com/webpack/loader-utils) from 1.4.0 to 1.4.1.
- [Release notes](https://github.com/webpack/loader-utils/releases)
- [Changelog](https://github.com/webpack/loader-utils/blob/v1.4.1/CHANGELOG.md)
- [Commits](webpack/loader-utils@v1.4.0...v1.4.1)

---
updated-dependencies:
- dependency-name: loader-utils
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Larah Armstrong <[email protected]>

* Bump decode-uri-component from 0.2.0 to 0.2.2 (#874)

Bumps [decode-uri-component](https://github.com/SamVerschueren/decode-uri-component) from 0.2.0 to 0.2.2.
- [Release notes](https://github.com/SamVerschueren/decode-uri-component/releases)
- [Commits](SamVerschueren/decode-uri-component@v0.2.0...v0.2.2)

---
updated-dependencies:
- dependency-name: decode-uri-component
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Larah Armstrong <[email protected]>

* Add MPPM documentation (#881)

* Update NGO about topic (#886)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Christopher Pope <[email protected]>
Co-authored-by: LPLafontaineB <[email protected]>
Co-authored-by: Sara [Unity] <[email protected]>
Co-authored-by: Sam Bellomo <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
Co-authored-by: Jil Franco <[email protected]>
Co-authored-by: NoelStephensUnity <[email protected]>
Co-authored-by: Hunter <[email protected]>
Co-authored-by: Ben Randall <[email protected]>
Co-authored-by: Walter Hulsebos <[email protected]>
Co-authored-by: Alex Robinson <[email protected]>
Co-authored-by: Jonas Lagoni <[email protected]>
Co-authored-by: Paolo Abela <[email protected]>
Co-authored-by: Fernando Cortez <[email protected]>
Co-authored-by: Kitty Draper <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants