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

Update Attributes.md (#363)

Browse Source 
Fixes #335 along with the content added to https://github.com/vis2k/Mirror/blob/master/docs/Concepts/Communications/RemoteActions.md where TargetRpc is fully described with a proper example.

Also filled in the other descriptions.
This commit is contained in:
Chris Langsenkamp 2019-01-30 21:08:47 -05:00 committed by Paul Pacheco
parent bc25f7c587
commit bc857796f5
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Classes/Attributes.md
View File

@ -5,19 +5,19 @@ Networking attributes are added to member functions of NetworkBehaviour scripts,
These attributes can be used for Unity game loop methods like Start or Update, as well as other implemented methods. These attributes can be used for Unity game loop methods like Start or Update, as well as other implemented methods.
- **NetworkSettings** - **NetworkSettings**
Something about this This attribute has been deprecated because `channels` were moved to transports (where applicable) and `interval` was moved to an inspector property
- **Server** - **Server**
means don't allow a client to call that method (throws a warning or an error when called on a client). means don't allow a client to call that method (throws a warning or an error when called on a client).
- **ServerCallback** - **ServerCallback**
Something about this A Custom Attribute that can be added to member functions of NetworkBehaviour scripts, to make them only run on servers.
- **Client** - **Client**
means don't allow a server to call that method (throws a warning or an error when called on the server). means don't allow a server to call that method (throws a warning or an error when called on the server).
- **ClientRpc** - **ClientRpc**
The server uses an Rpc to run that function on clients. The server uses an Rpc to run that function on clients.
- **ClientCallback** - **ClientCallback**
Something about this A Custom Attribute that can be added to member functions of NetworkBehaviour scripts, to make them only run on clients, but not generate warnings.
- **TargetRpc** - **TargetRpc**
Something about this This is an attribute that can be put on methods of NetworkBehaviour classes to allow them to be invoked on clients from a server. Unlike the ClientRpc attribute, these functions are invoked on one individual target client, not all of the ready clients.
- **Command** - **Command**
Call this from a client to run this function on the server. Make sure to validate input etc. It's not possible to call this from a server. Use this as a wrapper around another function, if you want to call it from the server too. Call this from a client to run this function on the server. Make sure to validate input etc. It's not possible to call this from a server. Use this as a wrapper around another function, if you want to call it from the server too.
The allowed argument types are; The allowed argument types are;