Mirror/docs/Classes/index.md
2019-06-25 19:43:56 -04:00

1.6 KiB
Raw Blame History

Classes Overview

Mirror includes the following classes:

  • NetworkServer
    Network Server is a High-Level-API class that manages connections from multiple clients.

  • NetworkClient
    Network Client is a high-level API class that manages a network connection from a client to a server, and can send and receive messages between the client and the server.

  • NetworkConnection
    Network Connection is a high-level API class that encapsulates a network connection.

  • NetworkBehavior
    Network Behaviour scripts work with game objects that have a NetworkIdentity component. These scripts can perform high-level API functions such as Commands, ClientRpcs, SyncEvents and SyncVars.

  • Attributes
    Networking attributes are added to member functions of NetworkBehaviour scripts, to make them run on either the client or server.

  • SyncVars
    SyncVars are variables of scripts that inherit from NetworkBehaviour, which are synchronized from the server to clients.

  • SyncEvents
    SyncEvents are networked events like ClientRpcs, but instead of calling a function on the game object, they trigger Events instead.

  • SyncLists
    SyncLists contain lists of values and synchronize data from servers to clients.

  • SyncDictionary
    A SyncDictionary is an associative array containing an unordered list of key, value pairs.

  • SyncHashSet
    An unordered set of values that do not repeat.

  • SyncSortedSet
    A sorted set of values tha do not repeat.