charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 11:00:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
cfbec28c60
Mirror/docs/Classes/index.md

27 lines
1.6 KiB
Markdown
Raw Normal View History

New Documentation (#184) * Documentation Outline * Spacing adjustments * Captured old wiki content * yml fix * Docs work * resize images * Replaced images * Removed md from links * Renamed Misty to Fizzy * Captured Unity docs * links cleanup * clear links * Cleanup and moved NetworkBehavior to Classes. * added slashes to yml paths * reverted slashes * Fixes bad link * Update Ignorance.md This should be enough documentation for now, yeah? * Localized images * Update Ignorance.md formatting updates * Lots of Cleanup * fix link * Formatting * fix code blocks * Lots of content and cleanup * fixed yml * Added blank line * Added spaces in titles * tightened bullets * Fixed bullet spacing * Fixed more bullets * unbolded content * Cleanup and removal of empty pages Updated README with links to docs pages * Restored prior version * Contributing * Improvements to content * lower case fix * fix link * renamed Contributions * fixed link * home page content * Fixed Encoding * Moved Why TCP * Replaced Unity with Mirror * Telepathy Description * changed to h2 * Moved Sample down * Removed dead links * Copied Contributions Added Test Fixed h3's * Fixed headings * added to Test * Fixed image alts and links * fixed last alt
2018-12-26 22:07:24 +00:00
# Classes Overview
General description of Classes
- [NetworkServer](NetworkServer)
NetworkServer is a High-Level-API class that manages connections from multiple clients.
- [NetworkClient](NetworkClient)
NetworkClient 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)
NetworkConnection is a high-level API class that encapsulates a network connection.
- [NetworkBehavior](NetworkBehavior)
NetworkBehaviour scripts work with GameObjects that have a NetworkIdentity component. These scripts can perform high-level API functions such as Commands, ClientRPCs, SyncEvents and SyncVars.
- [Attributes](Attributes)
Networking attributes are added to member functions of NetworkBehaviour scripts, to make them run on either the client or server.
Update index.md
2019-03-30 13:47:15 +00:00
- [SyncVars](SyncVars)
Update index.md
2019-03-30 13:32:20 +00:00
SyncVars are variables of scripts that inherit from NetworkBehaviour, which are synchronized from the server to clients.
Update index.md
2019-03-30 13:49:28 +00:00
- [SyncEvents](SyncEvent)
Update index.md
2019-03-30 13:38:31 +00:00
SyncEvents are networked events like ClientRpc’s, but instead of calling a function on the GameObject, they trigger Events instead.
New Documentation (#184) * Documentation Outline * Spacing adjustments * Captured old wiki content * yml fix * Docs work * resize images * Replaced images * Removed md from links * Renamed Misty to Fizzy * Captured Unity docs * links cleanup * clear links * Cleanup and moved NetworkBehavior to Classes. * added slashes to yml paths * reverted slashes * Fixes bad link * Update Ignorance.md This should be enough documentation for now, yeah? * Localized images * Update Ignorance.md formatting updates * Lots of Cleanup * fix link * Formatting * fix code blocks * Lots of content and cleanup * fixed yml * Added blank line * Added spaces in titles * tightened bullets * Fixed bullet spacing * Fixed more bullets * unbolded content * Cleanup and removal of empty pages Updated README with links to docs pages * Restored prior version * Contributing * Improvements to content * lower case fix * fix link * renamed Contributions * fixed link * home page content * Fixed Encoding * Moved Why TCP * Replaced Unity with Mirror * Telepathy Description * changed to h2 * Moved Sample down * Removed dead links * Copied Contributions Added Test Fixed h3's * Fixed headings * added to Test * Fixed image alts and links * fixed last alt
2018-12-26 22:07:24 +00:00
- [SyncLists](SyncLists)
docs: improve synclist elevator statement
2019-03-23 12:26:33 +00:00
SyncLists contain lists of values and synchronize data from servers to clients.
Update index.md
2019-03-30 12:15:33 +00:00
- [SyncDictionary](SyncDictionary)
Update index.md
2019-03-30 12:23:39 +00:00
A SyncDictionary is an associative array containing an unordered list of key, value pairs.
Update index.md
2019-03-30 12:15:33 +00:00
- [SyncHashSet](SyncHashSet)
Description Needed
- [SyncSortedSet](SyncSortedSet)
Description Needed
Reference in New Issue Copy Permalink