Class Animation

Inheritance
Object
Object
Component
Behaviour
Animation
Implements
Inherited Members
Namespace: UnityEngine
Assembly: UnityEngine.dll
Syntax
public sealed class Animation : Behaviour, IEnumerable

Properties

animateOnlyIfVisible

Declaration
[Obsolete("Use cullingType instead")]
public bool animateOnlyIfVisible { get; set; }
Property Value
Type Description
Boolean

animatePhysics

Declaration
public bool animatePhysics { get; set; }
Property Value
Type Description
Boolean

clip

Declaration
public AnimationClip clip { get; set; }
Property Value
Type Description
AnimationClip

cullingType

Declaration
public AnimationCullingType cullingType { get; set; }
Property Value
Type Description
AnimationCullingType

isPlaying

Declaration
public bool isPlaying { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Item[String]

Declaration
public AnimationState this[string name] { get; }
Parameters
Type Name Description
String name
Property Value
Type Description
AnimationState
| Improve this Doc View Source

localBounds

Declaration
public Bounds localBounds { get; set; }
Property Value
Type Description
Bounds

playAutomatically

Declaration
public bool playAutomatically { get; set; }
Property Value
Type Description
Boolean

wrapMode

Declaration
public WrapMode wrapMode { get; set; }
Property Value
Type Description
WrapMode

Methods

| Improve this Doc View Source

AddClip(AnimationClip, String)

Declaration
public void AddClip(AnimationClip clip, string newName)
Parameters
Type Name Description
AnimationClip clip
String newName
| Improve this Doc View Source

AddClip(AnimationClip, String, Int32, Int32)

Declaration
[ExcludeFromDocs]
public void AddClip(AnimationClip clip, string newName, int firstFrame, int lastFrame)
Parameters
Type Name Description
AnimationClip clip
String newName
Int32 firstFrame
Int32 lastFrame

AddClip(AnimationClip, String, Int32, Int32, Boolean)

Declaration
public void AddClip(AnimationClip clip, string newName, int firstFrame, int lastFrame, [DefaultValue("false")] bool addLoopFrame)
Parameters
Type Name Description
AnimationClip clip
String newName
Int32 firstFrame
Int32 lastFrame
Boolean addLoopFrame
| Improve this Doc View Source

Blend(String)

Declaration
[ExcludeFromDocs]
public void Blend(string animation)
Parameters
Type Name Description
String animation
| Improve this Doc View Source

Blend(String, Single)

Declaration
[ExcludeFromDocs]
public void Blend(string animation, float targetWeight)
Parameters
Type Name Description
String animation
Single targetWeight

Blend(String, Single, Single)

Declaration
public void Blend(string animation, [DefaultValue("1.0F")] float targetWeight, [DefaultValue("0.3F")] float fadeLength)
Parameters
Type Name Description
String animation
Single targetWeight
Single fadeLength
| Improve this Doc View Source

CrossFade(String)

Declaration
[ExcludeFromDocs]
public void CrossFade(string animation)
Parameters
Type Name Description
String animation
| Improve this Doc View Source

CrossFade(String, Single)

Declaration
[ExcludeFromDocs]
public void CrossFade(string animation, float fadeLength)
Parameters
Type Name Description
String animation
Single fadeLength

CrossFade(String, Single, PlayMode)

Declaration
public void CrossFade(string animation, [DefaultValue("0.3F")] float fadeLength, [DefaultValue("PlayMode.StopSameLayer")] PlayMode mode)
Parameters
Type Name Description
String animation
Single fadeLength
PlayMode mode
| Improve this Doc View Source

CrossFadeQueued(String)

Declaration
[ExcludeFromDocs]
public AnimationState CrossFadeQueued(string animation)
Parameters
Type Name Description
String animation
Returns
Type Description
AnimationState
| Improve this Doc View Source

CrossFadeQueued(String, Single)

Declaration
[ExcludeFromDocs]
public AnimationState CrossFadeQueued(string animation, float fadeLength)
Parameters
Type Name Description
String animation
Single fadeLength
Returns
Type Description
AnimationState
| Improve this Doc View Source

CrossFadeQueued(String, Single, QueueMode)

Declaration
[ExcludeFromDocs]
public AnimationState CrossFadeQueued(string animation, float fadeLength, QueueMode queue)
Parameters
Type Name Description
String animation
Single fadeLength
QueueMode queue
Returns
Type Description
AnimationState

CrossFadeQueued(String, Single, QueueMode, PlayMode)

Declaration
public AnimationState CrossFadeQueued(string animation, [DefaultValue("0.3F")] float fadeLength, [DefaultValue("QueueMode.CompleteOthers")] QueueMode queue, [DefaultValue("PlayMode.StopSameLayer")] PlayMode mode)
Parameters
Type Name Description
String animation
Single fadeLength
QueueMode queue
PlayMode mode
Returns
Type Description
AnimationState
| Improve this Doc View Source

GetClip(String)

Declaration
public AnimationClip GetClip(string name)
Parameters
Type Name Description
String name
Returns
Type Description
AnimationClip

GetClipCount()

Declaration
public int GetClipCount()
Returns
Type Description
Int32
| Improve this Doc View Source

GetEnumerator()

Declaration
public IEnumerator GetEnumerator()
Returns
Type Description
IEnumerator

IsPlaying(String)

Declaration
public bool IsPlaying(string name)
Parameters
Type Name Description
String name
Returns
Type Description
Boolean
| Improve this Doc View Source

Play()

Declaration
[ExcludeFromDocs]
public bool Play()
Returns
Type Description
Boolean
| Improve this Doc View Source

Play(String)

Declaration
[ExcludeFromDocs]
public bool Play(string animation)
Parameters
Type Name Description
String animation
Returns
Type Description
Boolean
| Improve this Doc View Source

Play(String, AnimationPlayMode)

Declaration
[Obsolete("use PlayMode instead of AnimationPlayMode.")]
public bool Play(string animation, AnimationPlayMode mode)
Parameters
Type Name Description
String animation
AnimationPlayMode mode
Returns
Type Description
Boolean

Play(String, PlayMode)

Declaration
public bool Play(string animation, [DefaultValue("PlayMode.StopSameLayer")] PlayMode mode)
Parameters
Type Name Description
String animation
PlayMode mode
Returns
Type Description
Boolean
| Improve this Doc View Source

Play(AnimationPlayMode)

Declaration
[Obsolete("use PlayMode instead of AnimationPlayMode.")]
public bool Play(AnimationPlayMode mode)
Parameters
Type Name Description
AnimationPlayMode mode
Returns
Type Description
Boolean
| Improve this Doc View Source

Play(PlayMode)

Declaration
public bool Play([DefaultValue("PlayMode.StopSameLayer")] PlayMode mode)
Parameters
Type Name Description
PlayMode mode
Returns
Type Description
Boolean
| Improve this Doc View Source

PlayQueued(String)

Declaration
[ExcludeFromDocs]
public AnimationState PlayQueued(string animation)
Parameters
Type Name Description
String animation
Returns
Type Description
AnimationState
| Improve this Doc View Source

PlayQueued(String, QueueMode)

Declaration
[ExcludeFromDocs]
public AnimationState PlayQueued(string animation, QueueMode queue)
Parameters
Type Name Description
String animation
QueueMode queue
Returns
Type Description
AnimationState

PlayQueued(String, QueueMode, PlayMode)

Declaration
public AnimationState PlayQueued(string animation, [DefaultValue("QueueMode.CompleteOthers")] QueueMode queue, [DefaultValue("PlayMode.StopSameLayer")] PlayMode mode)
Parameters
Type Name Description
String animation
QueueMode queue
PlayMode mode
Returns
Type Description
AnimationState
| Improve this Doc View Source

RemoveClip(String)

Declaration
public void RemoveClip(string clipName)
Parameters
Type Name Description
String clipName

RemoveClip(AnimationClip)

Declaration
public void RemoveClip(AnimationClip clip)
Parameters
Type Name Description
AnimationClip clip
| Improve this Doc View Source

Rewind()

Declaration
public void Rewind()
| Improve this Doc View Source

Rewind(String)

Declaration
public void Rewind(string name)
Parameters
Type Name Description
String name
| Improve this Doc View Source

Sample()

Declaration
public void Sample()
| Improve this Doc View Source

Stop()

Declaration
public void Stop()
| Improve this Doc View Source

Stop(String)

Declaration
public void Stop(string name)
Parameters
Type Name Description
String name
| Improve this Doc View Source

SyncLayer(Int32)

Declaration
public void SyncLayer(int layer)
Parameters
Type Name Description
Int32 layer

Implements

Extension Methods