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

Browse Source
This commit is contained in:
MrGadget 2019-03-30 10:30:30 -04:00 committed by GitHub
parent 7c2d92235f
commit 6e19a5b664
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Classes/Attributes.md
View File

@ -12,14 +12,14 @@ These attributes can be used for Unity game loop methods like Start or Update, a
A Custom Attribute that can be added to member functions of NetworkBehaviour scripts, to make them only run on servers.
- **Client**
means don't allow a server to call that method (throws a warning or an error when called on the server).
- **ClientRpc**
The server uses an Rpc to run that function on clients.
- **ClientCallback**
A Custom Attribute that can be added to member functions of NetworkBehaviour scripts, to make them only run on clients, but not generate warnings.
- **ClientRpc**
The server uses an Rpc to run that function on clients. See also: [Remote Actions](../Concepts/Communications/RemoteActions)
- **TargetRpc**
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.
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. See also: [Remote Actions](../Concepts/Communications/RemoteActions)
- **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. See also: [Remote Actions](../Concepts/Communications/RemoteActions)
The allowed argument types are;
- Basic type (byte, int, float, string, UInt64, etc)
- Built-in Unity math type (Vector3, Quaternion, etc),
@ -28,6 +28,6 @@ These attributes can be used for Unity game loop methods like Start or Update, a
- NetworkIdentity
- GameObject with a NetworkIdentity component attached.
- **SyncVar**
SyncVars are used to synchronize a variable from the server to all clients automatically. Don't assign them from a client, it's pointless. Don't let them be null, you will get errors. You can use int, long, float, string, Vector3 etc. (all simple types) and NetworkIdentity and GameObject if the GameObject has a NetworkIdentity attached to it. You can use [hooks](SyncVarHook).
[SyncVars](SyncVars) are used to synchronize a variable from the server to all clients automatically. Don't assign them from a client, it's pointless. Don't let them be null, you will get errors. You can use int, long, float, string, Vector3 etc. (all simple types) and NetworkIdentity and GameObject if the GameObject has a NetworkIdentity attached to it. You can use [hooks](SyncVarHook).
- **SyncEvent**
Networked events like ClientRpc's, but instead of calling a function on the GameObject, they trigger Events instead.
[SyncEvents](SyncEvents) are networked events like ClientRpc's, but instead of calling a function on the GameObject, they trigger Events instead.