Mirror/doc/Components/index.md
James Frowen 7e93030849
feat: adding script that displays ping (#1975)
* adding script that displays ping

* fixing style

* adding mirror icon

* Update Assets/Mirror/Components/NetworkPingDisplay.cs

Co-authored-by: MrGadget <chris@clevertech.net>

* adding DisallowMultipleComponent

* adding docs on NetworkPingDisplay

Co-authored-by: MrGadget <chris@clevertech.net>
2020-06-10 14:31:13 +01:00

3.4 KiB
Raw Blame History

Components Overview

These core components are included in Mirror:

  • Network Animator
    The Network Animator component allows you to synchronize animation states for networked objects. It synchronizes state and parameters from an Animator Controller.
  • Network Authenticator
    Network Authenticators facilitate integration of user accounts and credentials into your application.
  • Network Discovery
    Network Discovery uses a UDP broadcast on the LAN enabling clients to find the running server and connect to it.
  • Network Ping Display Network Ping Display shows the Ping time for clients using OnGUI
  • Network Identity
    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.
  • Network Log Settings
    The Network Log Settings component allows you to configure logging levels and load the settings in a build.
  • Network Manager
    The Network Manager is a component for managing the networking aspects of a multiplayer game.
  • Network Manager HUD
    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.
  • Network Match Checker
    The Network Match Checker component controls visibility of networked objects based on match id.
  • Network Proximity Checker
    The Network Proximity Checker component controls the visibility of game objects for network clients, based on proximity to players.
  • Network Room Manager
    The Network Room Manager is an extension component of Network Manager that provides a basic functional room.
  • Network Room Player
    The Network Room Player is a component that's required on Player prefabs used in the Room Scene with the Network Room Manager above.
  • Network Scene Checker
    The Network Scene Checker component controls visibility of networked objects between scenes.
  • Network Start Position
    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.
  • Network Transform
    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.
  • Network Transform Child
    The Network Transform Child component synchronizes the position and rotation of the child game object of a game object with a Network Transform component.