tk2dSpriteAnimation Class Reference

Holds a collection of clips. More...

List of all members.

Public Member Functions
tk2dSpriteAnimationClip	GetClipByName (string name)
	Resolves an animation clip by name and returns a reference to it.
tk2dSpriteAnimationClip	GetClipById (int id)
	Resolves an animation clip by id and returns a reference to it.
int	GetClipIdByName (string name)
	Resolves an animation clip by name and returns a clipId.
int	GetClipIdByName (tk2dSpriteAnimationClip clip)
	Gets a clip id from a clip.
Public Attributes
tk2dSpriteAnimationClip[]	clips
	Array of clips
Properties
tk2dSpriteAnimationClip	FirstValidClip [get]
	The first valid clip in the animation collection. Null if no valid clips are found.

---

Detailed Description

Holds a collection of clips.

---

Member Function Documentation

tk2dSpriteAnimationClip tk2dSpriteAnimation.GetClipById

(

int

id

)

Resolves an animation clip by id and returns a reference to it.

Returns:

tk2dSpriteAnimationClip reference, null if not found

tk2dSpriteAnimationClip tk2dSpriteAnimation.GetClipByName

(

string

name

)

Resolves an animation clip by name and returns a reference to it.

Returns:

tk2dSpriteAnimationClip reference, null if not found

Parameters:

name	Case sensitive clip name, as defined in tk2dSpriteAnimationClip.

int tk2dSpriteAnimation.GetClipIdByName

(

string

name

)

Resolves an animation clip by name and returns a clipId.

Returns:

Unique clip id, -1 if not found

Parameters:

name	Case sensitive clip name, as defined in tk2dSpriteAnimationClip.

int tk2dSpriteAnimation.GetClipIdByName

(

tk2dSpriteAnimationClip

clip

)

Gets a clip id from a clip.

Returns:

Unique clip id, -1 if not found in the animation collection

---

Member Data Documentation

tk2dSpriteAnimationClip [] tk2dSpriteAnimation.clips

Array of clips

---

Property Documentation

tk2dSpriteAnimationClip tk2dSpriteAnimation.FirstValidClip [get]

The first valid clip in the animation collection. Null if no valid clips are found.