Mirror/doc/articles/Concepts/index.md
Paul Pacheco 35fee94d56
docs: switch to docfx for documentation (#1026)
* Moved doc files to docfx folder

* load csproj

* doc generation

* Run docfx

* Add docfx

* Deploy docs to mirror-networking.com

* use deploy phase

* deploy whole generated site

* Fixed the semantic release command

* Is last \ required?

* show debug log

* using lftp for site deploy

* Testing lftp

* Show current folder

* try -e command option

* Show me the files

* use plain ftp

* use choco install instead of cinst

* fix ssl certificate validation

* fix username

* Upload site to xmldocs folder

* no need to archive docs

* No need for debug output

* Fix file permissions

* show me .htaccess

* Show me contents

* Wipe out folder to fix permissions

* Set file permissions

* Fix file permissions

* complete toc list

* Migrated intro page

* Remove old docs

* Update link to docs

* Add link to github

* Only update docs for stuff in master

* This is a powershell command

* Update doc/articles/Concepts/Communications/RemoteActions.md

* Update doc/articles/Concepts/VisibilityCustom.md

* Update doc/articles/Concepts/Authority.md

* Update doc/articles/Concepts/GameObjects/SpawnObjectCustom.md

* Update doc/articles/Concepts/Authority.md

* Update doc/articles/Classes/SyncVars.md

* No need to run semver twice
2019-08-24 10:20:33 -05:00

1.3 KiB
Raw Blame History

Networking Concepts Overview

High level scripting API

Mirrors networking has a “high-level” scripting API (which well refer to as the HLAPI). Using this means you get access to commands which cover most of the common requirements for multiuser games without needing to worry about the “lower level” implementation details. The HLAPI allows you to:

  • Control the networked state of the game using a “Network Manager”.
  • Operate “client hosted” games, where the host is also a player client.
  • Serialize data using a general-purpose serializer.
  • Send and receive network messages.
  • Send networked commands from clients to servers.
  • Make remote procedure calls (RPCs) from servers to clients.
  • Send networked events from servers to clients.

Engine and Editor integration

Mirrors networking is integrated into the engine and the editor, allowing you to work with components and visual aids to build your multiplayer game. It provides:

  • A NetworkIdentity component for networked objects.
  • A NetworkBehaviour for networked scripts.
  • Configurable automatic synchronization of object transforms.
  • Automatic synchronization of script variables.
  • Support for placing networked objects in Unity scenes.
  • Network components