SpriteAnimationPump Class Reference

Inherits MonoBehaviour.

Public Member Functions
void	StartAnimationPump ()
	Starts the animation pump coroutine. Normally, there is no need to call this directly. Only use this if you have manually stopped the pump to pause all animations or something. More...

Static Public Member Functions
static void	StopAnimationPump ()
	Stops the animation pump from running. Normally, there is no need to call this directly. Only use this if you want to pause all animations or something. More...

Static Public Attributes
static float	animationPumpInterval = 0.03333f
	The interval between animation coroutine updates. Defaults to 0.03333f (30 frames per second). More...

Properties
bool	IsRunning [get]
	Returns whether or not the pump is currently running. More...
static float	timeScale [get, set]
	Works like Time.timeScale, only it still works when using realtime tracking. When USE_DELTA_TIME is defined, this just acts as an alias for Time.timeScale. Otherwise, it is an independent value that only affects the rate of sprite animations. More...

Detailed Description

Drives all sprite animation using a coroutine. A SpriteAnimationPump instance will be automatically created by the first sprite created in the scene.

Definition at line 23 of file SpriteAnimationPump.cs.

Member Function Documentation

void SpriteAnimationPump.StartAnimationPump

(

)

Starts the animation pump coroutine. Normally, there is no need to call this directly. Only use this if you have manually stopped the pump to pause all animations or something.

Definition at line 135 of file SpriteAnimationPump.cs.

static void SpriteAnimationPump.StopAnimationPump ( )

static

Stops the animation pump from running. Normally, there is no need to call this directly. Only use this if you want to pause all animations or something.

Definition at line 164 of file SpriteAnimationPump.cs.

Member Data Documentation

float SpriteAnimationPump.animationPumpInterval = 0.03333f

static

The interval between animation coroutine updates. Defaults to 0.03333f (30 frames per second).

Definition at line 92 of file SpriteAnimationPump.cs.

Property Documentation

bool SpriteAnimationPump.IsRunning

get

Returns whether or not the pump is currently running.

Definition at line 55 of file SpriteAnimationPump.cs.

float SpriteAnimationPump.timeScale

staticgetset

Works like Time.timeScale, only it still works when using realtime tracking. When USE_DELTA_TIME is defined, this just acts as an alias for Time.timeScale. Otherwise, it is an independent value that only affects the rate of sprite animations.

Definition at line 67 of file SpriteAnimationPump.cs.

---

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

• SpriteAnimationPump.cs