mirror of
https://github.com/MirrorNetworking/Mirror.git
synced 2024-11-18 19:10:32 +00:00
76b75dbb9b
* 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
25 lines
1.0 KiB
Markdown
25 lines
1.0 KiB
Markdown
# 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. The `NetworkClient` class also helps to manage spawned network GameObjects, and routing of RPC message and network events.
|
|
|
|
See the [NetworkClient](#networkclient) script reference for more information.
|
|
|
|
## Properties
|
|
|
|
- **serverIP**
|
|
The IP address of the server that this client is connected to.
|
|
- **serverPort**
|
|
The port of the server that this client is connected to.
|
|
- **connection**
|
|
The NetworkConnection GameObject this `NetworkClient` instance is using.
|
|
- **handlers**
|
|
The set of registered message handler functions.
|
|
- **numChannels**
|
|
The number of configured NetworkTransport QoS channels.
|
|
- **isConnected**
|
|
True if the client is connected to a server.
|
|
- **allClients**
|
|
List of active NetworkClients (static).
|
|
- **active**
|
|
True if any NetworkClients are active (static).
|