Version: 2019.2
  • C#
Experimental: this API is experimental and might be changed or removed in the future.


struct in UnityEngine.Experimental.Animations


Implemented in:UnityEngine.AnimationModule

Suggest a change


Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.


Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.




Handle for a muscle in the AnimationHumanStream.

MuscleHandle can only be used on AnimationHumanStream, otherwise an InvalidOperationException is thrown.

using UnityEngine;
using UnityEngine.Animations;
using UnityEngine.Playables;
using UnityEngine.Experimental.Animations;

public struct MuscleHandleExampleJob : IAnimationJob { public MuscleHandle muscleHandle;

public void ProcessRootMotion(AnimationStream stream) {} public void ProcessAnimation(AnimationStream stream) { AnimationHumanStream humanStream = stream.AsHuman();

// Get a muscle value. float muscleValue = humanStream.GetMuscle(muscleHandle);

// Set a muscle value. humanStream.SetMuscle(muscleHandle, muscleValue); } }

[RequireComponent(typeof(Animator))] public class MuscleHandleExample : MonoBehaviour { void Start() { var graph = PlayableGraph.Create(); var output = AnimationPlayableOutput.Create(graph, "output", GetComponent<Animator>());

var job = new MuscleHandleExampleJob(); job.muscleHandle = new MuscleHandle(HumanPartDof.LeftArm, ArmDof.HandDownUp);

var scriptPlayable = AnimationScriptPlayable.Create(graph, job); output.SetSourcePlayable(scriptPlayable);


graph.Destroy(); } }

Static Properties

muscleHandleCountThe total number of DoF parts in a humanoid. (Read Only)


dofThe muscle human sub-part. (Read Only)
humanPartDofThe muscle human part. (Read Only)
nameThe name of the muscle. (Read Only)


MuscleHandleThe different constructors that creates the muscle handle.

Static Methods

GetMuscleHandlesFills the array with all the possible muscle handles on a humanoid.

Did you find this page useful? Please give it a rating: