Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

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

AnimatorOverrideController

class in UnityEngine

/

Inherits from:RuntimeAnimatorController

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

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.

Close

Cancel

Description

Interface to control AnimatorOverrideController.

AnimatorOverrideController is used to override clips from a controller to specialize some animations for a given avatar.
Swapping Animator.runtimeAnimatorController with an AnimatorOverrideController based on the same AnimatorController at runtime doesn't reset state machine's current state.

#pragma strict
public class SetupAnimatorOverrideController extends MonoBehaviour {
	public function GetEffectiveController(animator: Animator) {
		var controller: RuntimeAnimatorController = animator.runtimeAnimatorController;
		var overrideController: AnimatorOverrideController = controller as AnimatorOverrideController;
		while ( overrideController != null ) {
			controller = overrideController.runtimeAnimatorController;
			overrideController = controller as AnimatorOverrideController;
		}
		return controller;
	}
	public function OverrideAnimationClip(name: String, clip: AnimationClip) {
		var animator: Animator = GetComponent.<Animator>();
		var overrideController: AnimatorOverrideController = new AnimatorOverrideController();
		overrideController.runtimeAnimatorController = GetEffectiveController(animator);
		overrideController[name] = clip;
		animator.runtimeAnimatorController = overrideController;
	}
}
using UnityEngine;

public class SetupAnimatorOverrideController : MonoBehaviour { public RuntimeAnimatorController GetEffectiveController(Animator animator) { RuntimeAnimatorController controller = animator.runtimeAnimatorController;

AnimatorOverrideController overrideController = controller as AnimatorOverrideController; while (overrideController != null) { controller = overrideController.runtimeAnimatorController; overrideController = controller as AnimatorOverrideController; }

return controller; }

public void OverrideAnimationClip(string name, AnimationClip clip) { Animator animator = GetComponent<Animator>();

AnimatorOverrideController overrideController = new AnimatorOverrideController(); overrideController.runtimeAnimatorController = GetEffectiveController(animator); overrideController[name] = clip; animator.runtimeAnimatorController = overrideController; } }

Variables

clipsReturns the list of orignal clip from the controller and their override clip.
runtimeAnimatorControllerThe Controller that the AnimatorOverrideController overrides.
this[string]Returns either the overriding clip if set or the original clip named name.

Inherited members

Variables

hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.
animationClipsRetrieves all AnimationClip used by the controller.

Public Functions

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.