C# Class SpriteAnimationPump, marblemadness

Drives all sprite animation using a coroutine. A SpriteAnimationPump instance will be automatically created by the first sprite created in the scene.
Inheritance: MonoBehaviour
Exibir arquivo Open project: MtvnGames/marblemadness Class Usage Examples

Public Properties

Property Type Description
animationPumpInterval float

Protected Properties

Property Type Description
cur ISpriteAnimatable
head ISpriteAnimatable
pumpIsDone bool
pumpIsRunning bool

Public Methods

Method Description
Add ( ISpriteAnimatable s ) : void
OnDestroy ( ) : void
Remove ( ISpriteAnimatable s ) : void
StartAnimationPump ( ) : void

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.
StopAnimationPump ( ) : void

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.

Protected Methods

Method Description
AnimationPump ( ) : IEnumerator
PumpStarter ( ) : IEnumerator

Private Methods

Method Description
Awake ( ) : void
OnApplicationPause ( bool paused ) : void

Method Details

Add() public static method

public static Add ( ISpriteAnimatable s ) : void
s ISpriteAnimatable
return void

AnimationPump() protected static method

protected static AnimationPump ( ) : IEnumerator
return IEnumerator

OnDestroy() public method

public OnDestroy ( ) : void
return void

PumpStarter() protected method

protected PumpStarter ( ) : IEnumerator
return IEnumerator

Remove() public static method

public static Remove ( ISpriteAnimatable s ) : void
s ISpriteAnimatable
return void

StartAnimationPump() public method

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.
public StartAnimationPump ( ) : void
return void

StopAnimationPump() public static method

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.
public static StopAnimationPump ( ) : void
return void

Property Details

animationPumpInterval public_oe static_oe property

The interval between animation coroutine updates. Defaults to 0.03333f (30 frames per second).
public static float animationPumpInterval
return float

cur protected_oe static_oe property

protected static ISpriteAnimatable cur
return ISpriteAnimatable

head protected_oe static_oe property

protected static ISpriteAnimatable head
return ISpriteAnimatable

pumpIsDone protected_oe static_oe property

protected static bool pumpIsDone
return bool

pumpIsRunning protected_oe static_oe property

protected static bool pumpIsRunning
return bool