Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Animation.CrossFade

Suggest a change

Success!

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.

Close

Sumbission failed

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

Close

Cancel

Switch to Manual
public function CrossFade(animation: string, fadeLength: float = 0.3F, mode: PlayMode = PlayMode.StopSameLayer): void;
public void CrossFade(string animation, float fadeLength = 0.3F, PlayMode mode = PlayMode.StopSameLayer);
public def CrossFade(animation as string, fadeLength as float = 0.3F, mode as PlayMode = PlayMode.StopSameLayer) as void

Description

Fades the animation with name animation in over a period of time seconds and fades other animations out.

If mode is PlayMode.StopSameLayer, animations in the same layer as animation will be faded out while animation is faded in. if mode is PlayMode.StopAll, all animations will be faded out while animation is faded in.

If the animation is not set to be looping it will be stopped and rewinded after playing.

	// Fade the walk cycle in and fade all other animations in the same layer out.
	// Complete the fade within 0.2 seconds.
	animation.CrossFade("Walk", 0.2);
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Example() {
        animation.CrossFade("Walk", 0.2F);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Example() as void:
		animation.CrossFade('Walk', 0.2F)

Another example:

	// Makes a character contains a Run and Idle animation 
	// fade between them when the player wants to move
	function Update () {
		if (Mathf.Abs(Input.GetAxis("Vertical")) > 0.1)
			animation.CrossFade("Run");
		else
			animation.CrossFade("Idle");
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Update() {
        if (Mathf.Abs(Input.GetAxis("Vertical")) > 0.1F)
            animation.CrossFade("Run");
        else
            animation.CrossFade("Idle");
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Update() as void:
		if Mathf.Abs(Input.GetAxis('Vertical')) > 0.1F:
			animation.CrossFade('Run')
		else:
			animation.CrossFade('Idle')