Mirror/doc/articles/Classes/index.md

37 lines
1.7 KiB
Markdown
Raw Normal View History

# Classes Overview
2019-06-25 23:43:56 +00:00
Mirror includes the following classes:
- [NetworkServer](NetworkServer.md)
2019-06-25 23:43:56 +00:00
Network Server is a High-Level-API class that manages connections from multiple clients.
- [NetworkClient](NetworkClient.md)
2019-06-25 23:43:56 +00:00
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](NetworkConnection.md)
2019-06-25 23:43:56 +00:00
Network Connection is a high-level API class that encapsulates a network connection.
- [NetworkBehaviour](NetworkBehaviour.md)
2019-06-25 23:43:56 +00:00
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](Attributes.md)
2019-06-25 23:43:56 +00:00
Networking attributes are added to member functions of NetworkBehaviour scripts, to make them run on either the client or server.
- [SyncVars](SyncVars.md)
2019-06-25 23:43:56 +00:00
SyncVars are variables of scripts that inherit from NetworkBehaviour, which are synchronized from the server to clients.
- [SyncEvents](SyncEvent.md)
2019-06-25 23:43:56 +00:00
SyncEvents are networked events like ClientRpcs, but instead of calling a function on the game object, they trigger Events instead.
- [SyncLists](SyncLists.md)
SyncLists contain lists of values and synchronize data from servers to clients.
2019-06-25 23:43:56 +00:00
- [SyncDictionary](SyncDictionary.md)
2019-03-30 12:23:39 +00:00
A SyncDictionary is an associative array containing an unordered list of key, value pairs.
2019-06-25 23:43:56 +00:00
- [SyncHashSet](SyncHashSet.md)
An unordered set of values that do not repeat.
2019-06-25 23:43:56 +00:00
- [SyncSortedSet](SyncSortedSet.md)
A sorted set of values tha do not repeat.