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

Updated NetworkBehaviour doc

Browse Source
This commit is contained in:
Chris Langsenkamp 2019-12-22 17:30:14 -05:00
parent 92d19cf6ef
commit 7a138b9926
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/Guides/NetworkBehaviour.md
View File

@ -19,8 +19,8 @@ With the server-authoritative system of Mirror, the server must use the `Network
Returns true if this client has [ownership](Authority.md) over this game object. It is normally false in the server, except if the server is also a client (host mode).
- **netId**
The unique network ID of this game object. The server assigns this at run time. It is unique for all game objects in that network session.
- **playerControllerId**
The ID of the player associated with this NetworkBehaviour script. This is only valid if the object is a local player.
- **netIdentity**
Returns the NetworkIdentity of this object
- **connectionToServer**
The NetworkConnection associated with the Network Identity component attached to this game object. This is only valid for **player objects** on the client.
- **connectionToClient**
@ -62,6 +62,7 @@ The built-in callbacks are:
- **OnDeSerialize** called to apply state to game objects on clients
- **OnNetworkDestroy** called on clients when the server destroys the game object
- **OnStartLocalPlayer** called on clients for player game objects on the local client (only)
- **OnStartAuthority** called on clients for behaviours that have authority, based on context and hasAuthority.
- **OnRebuildObservers** called on the server when the set of observers for a game objects is rebuilt
- **OnSetLocalVisibility** called on the client and/or server when the visibility of a game object changes for the local client
- **OnCheckObserver** called on the server to check visibility state for a new client