Class NetworkAnimator

A component to synchronize Mecanim animation states for networked objects.

The animation of game objects can be networked by this component. There are two models of authority for networked movement:

If the object has authority on the client, then it should animated locally on the owning client. The animation state information will be sent from the owning client to the server, then broadcast to all of the other clients. This is common for player objects.

If the object has authority on the server, then it should be animated on the server and state information will be sent to all clients. This is common for objects not related to a specific client, such as an enemy unit.

The NetworkAnimator synchronizes the animation parameters that are checked in the inspector view. It does not automatically sychronize triggers. The function SetTrigger can by used by an object with authority to fire an animation trigger on other clients.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
NetworkBehaviour
NetworkAnimator
Inherited Members
Namespace: UnityEngine.Networking
Assembly: com.unity.multiplayer-hlapi.Runtime.dll
Syntax
[DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkAnimator")]
[RequireComponent(typeof(NetworkIdentity))]
[RequireComponent(typeof(Animator))]
[Obsolete("The high level API classes are deprecated and will be removed in the future.")]
public class NetworkAnimator : NetworkBehaviour

Fields

param0

Declaration
public string param0
Field Value
Type Description
string

param1

Declaration
public string param1
Field Value
Type Description
string

param2

Declaration
public string param2
Field Value
Type Description
string

param3

Declaration
public string param3
Field Value
Type Description
string

param4

Declaration
public string param4
Field Value
Type Description
string

param5

Declaration
public string param5
Field Value
Type Description
string

Properties

animator

The animator component to synchronize.

Declaration
public Animator animator { get; set; }
Property Value
Type Description
Animator

Methods

GetParameterAutoSend(int)

Gets whether an animation parameter should be auto sent.

Declaration
public bool GetParameterAutoSend(int index)
Parameters
Type Name Description
int index

Index of the parameter in the Animator.
Returns
Type Description
bool

True if the parameter should be sent.

OnDeserialize(NetworkReader, bool)

Virtual function to override to receive custom serialization data. The corresponding function to send serialization data is OnSerialize().

Declaration
public override void OnDeserialize(NetworkReader reader, bool initialState)
Parameters
Type Name Description
NetworkReader reader

Reader to read from the stream.
bool initialState

True if being sent initial state.
Overrides

OnSerialize(NetworkWriter, bool)

Virtual function to override to send custom serialization data. The corresponding function to send serialization data is OnDeserialize().

The initialState flag is useful to differentiate between the first time an object is serialized and when incremental updates can be sent. The first time an object is sent to a client, it must include a full state snapshot, but subsequent updates can save on bandwidth by including only incremental changes. Note that SyncVar hook functions are not called when initialState is true, only for incremental updates.

If a class has SyncVars, then an implementation of this function and OnDeserialize() are added automatically to the class. So a class that has SyncVars cannot also have custom serialization functions.

The OnSerialize function should return true to indicate that an update should be sent. If it returns true, then the dirty bits for that script are set to zero, if it returns false then the dirty bits are not changed. This allows multiple changes to a script to be accumulated over time and sent when the system is ready, instead of every frame.

Declaration
public override bool OnSerialize(NetworkWriter writer, bool forceAll)
Parameters
Type Name Description
NetworkWriter writer

Writer to use to write to the stream.
bool forceAll
Returns
Type Description
bool

True if data was written.
Overrides

SetParameterAutoSend(int, bool)

Sets whether an animation parameter should be auto sent.

Declaration
public void SetParameterAutoSend(int index, bool value)
Parameters
Type Name Description
int index

Index of the parameter in the Animator.
bool value

The new value.

SetTrigger(int)

Declaration
public void SetTrigger(int hash)
Parameters
Type Name Description
int hash

Hash id of trigger (from the Animator).

SetTrigger(string)

Causes an animation trigger to be invoked for a networked object.

If local authority is set, and this is called from the client, then the trigger will be invoked on the server and all clients. If not, then this is called on the server, and the trigger will be called on all clients.

Declaration
public void SetTrigger(string triggerName)
Parameters
Type Name Description
string triggerName

Name of trigger.