Mirror/doc/articles/Components/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

33 lines
2.6 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Components Overview
General description of Components
- [NetworkManager](NetworkManager.md)
The Network Manager is a component for managing the networking aspects of a multiplayer game.
- [NetworkLobbyManager](NetworkLobbyManager.md)
The Network Lobby Manager is an extension component of Network Manager that provides a basic functional lobby.
- [NetworkLobbyPlayer](NetworkLobbyPlayer.md)
The Network Lobby Player is a component that's required on Player prefabs used in the Lobby Scene with the Network Lobby Manager above.
- [NetworkManagerHUD](NetworkManagerHUD.md)
The Network Manager HUD is a quick-start tool to help you start building your multiplayer game straight away, without first having to build a user interface for game creation/connection/joining. It allows you to jump straight into your gameplay programming, and means you can build your own version of these controls later in your development schedule.
- [NetworkIdentity](NetworkIdentity.md)
The Network Identity component is at the heart of the Mirror networking high-level API. It controls a game objects unique identity on the network, and it uses that identity to make the networking system aware of the game object. It offers two different options for configuration and they are mutually exclusive, which means either one of the options or none can be checked.
- [NetworkStartPosition](NetworkStartPosition.md)
Network Start Position is used by the Network Manager when creating player objects. The position and rotation of the Network Start Position are used to place the newly created player object.
- [NetworkProximityChecker](NetworkProximityChecker.md)
The Network Proximity Checker component controls the visibility of game objects for network clients, based on proximity to players.
- [NetworkTransform](NetworkTransform.md)
The Network Transform component synchronizes the movement and rotation of game objects across the network. Note that the network Transform component only synchronizes spawned networked game objects.
- [NetworkTransformChild](NetworkTransformChild.md)
The Network Transform Child component synchronizes the position and rotation of the child game object of a game object with a Network Transform component.
- [NetworkAnimator](NetworkAnimator.md)
The Network Animator component allows you to synchronize animation states for networked objects. It synchronizes state and parameters from an Animator Controller.
- [NetworkNavMeshAgent](NetworkNavMeshAgent.md)
Coming Soon
- [NetworkController](NetworkController.md)
Coming Soon
- [NetworkRigidbody](NetworkRigidbody.md)
Coming Soon