FalcoEngine.Animation Class Reference

Inheritance diagram for FalcoEngine.Animation:

Public Member Functions
delegate void	AnimationEvent (Animation sender, string animName)
void	Play (string name)
	Play animation clip by name More...
void	CrossFade (string name, float duration=1.0f)
	Play animation clip by name with smooth transition between this and previous clips More...
void	Stop ()
	Stop playing More...
void	SetLoop (string name, bool loop)
	Set animation clip is looping by name More...
bool	GetLoop (string name)
	Get animation clip is looping by name More...
bool	IsPlaying (string name)
	Returns if the animation clip is playing More...
AnimationClipInfo	GetAnimationClipInfo (int index)
	Returns animation clip info by its name More...

Properties
bool	isPlaying [get]
	Returns if any of animation clips attached to this component is playing More...
int	numAnimationClips [get]
	Get animation clips count More...
Properties inherited from FalcoEngine.Component
bool	enabled [getset]
	Enable or disable this component More...
GameObject	gameObject [get]
	Get game object at which this component is attached More...
bool	isUiComponent [get]
	Returns if this component is derived from UIElement (or this is a canvas) or not More...

Events
AnimationEvent	onEnded

Additional Inherited Members
Protected Member Functions inherited from FalcoEngine.Component
	Component ()

Detailed Description

Definition at line 8 of file Animation.cs.

Member Function Documentation

AnimationEvent()

delegate void FalcoEngine.Animation.AnimationEvent	(	Animation	sender,
		string	animName
	)

CrossFade()

void FalcoEngine.Animation.CrossFade	(	string	name,
		float	duration = 1.0f
	)

Play animation clip by name with smooth transition between this and previous clips

Parameters

name
duration

Definition at line 41 of file Animation.cs.

GetAnimationClipInfo()

AnimationClipInfo FalcoEngine.Animation.GetAnimationClipInfo

(

int

index

)

Returns animation clip info by its name

Parameters

index

Returns

Definition at line 89 of file Animation.cs.

GetLoop()

bool FalcoEngine.Animation.GetLoop

(

string

name

)

Get animation clip is looping by name

Parameters

name

Returns

Definition at line 69 of file Animation.cs.

IsPlaying()

bool FalcoEngine.Animation.IsPlaying

(

string

name

)

Returns if the animation clip is playing

Parameters

name

Returns

Definition at line 79 of file Animation.cs.

Play()

void FalcoEngine.Animation.Play

(

string

name

)

Play animation clip by name

Parameters

name

Definition at line 31 of file Animation.cs.

SetLoop()

void FalcoEngine.Animation.SetLoop	(	string	name,
		bool	loop
	)

Set animation clip is looping by name

Parameters

name
loop

Definition at line 59 of file Animation.cs.

Stop()

void FalcoEngine.Animation.Stop

(

)

Stop playing

Definition at line 49 of file Animation.cs.

Property Documentation

isPlaying

bool FalcoEngine.Animation.isPlaying

get

Returns if any of animation clips attached to this component is playing

Definition at line 20 of file Animation.cs.

numAnimationClips

int FalcoEngine.Animation.numAnimationClips

get

Get animation clips count

Definition at line 25 of file Animation.cs.

Event Documentation

onEnded

AnimationEvent FalcoEngine.Animation.onEnded

Definition at line 15 of file Animation.cs.

---

The documentation for this class was generated from the following file:

• API/Components/Animation/Animation.cs