Class Index | File Index

Classes


Class VENISON.GRAPHICS.AnimationManager

Singleton used for updating animations and storing animation image data.
Defined in: venison_engine.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
fnPlayAnimation(iAnimationName, iEntity, iFrameRate, iStartFrame, iLoop, iCallbackFunction)
Function used to play animations.
 
fnRegisterAnimation(iAnimationName, iAnimation, iFrameRate)
Register animations and stores them in the AnimationManager.
 
fnSetAnimationPaused(iEntityID, iPaused)
Pause or unpause the animation currently playing for the entity with ID iEntityID.
Class Detail
VENISON.GRAPHICS.AnimationManager()
Method Detail
fnPlayAnimation(iAnimationName, iEntity, iFrameRate, iStartFrame, iLoop, iCallbackFunction)
Function used to play animations.
Parameters:
{String} iAnimationName
The name of the animation to play.
{Object} iEntity
The entity that wants to play the animation.
{Number} iFrameRate
Number of frames per second, if no value is given (or the value is 0) the default framerate for the animation will be used.
{Number} iStartFrame
The frame to begin playing the animation from, has to be a valid frame.
{Boolean} iLoop
true if animation should loop.
{Function} iCallbackFunction
The function to call when animation is finished.

fnRegisterAnimation(iAnimationName, iAnimation, iFrameRate)
Register animations and stores them in the AnimationManager.
Parameters:
{String} iAnimationName
Name of the animation.
{Array} iAnimation
Contains every image in the animation in order.
{Number} iFrameRate
Default framerate for the animation.

fnSetAnimationPaused(iEntityID, iPaused)
Pause or unpause the animation currently playing for the entity with ID iEntityID.
Parameters:
{Number} iEntityID
The id of the entity whose animation's pause state should be set.
{Boolean} iPaused
true if the animation should be paused, otherwise false.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu May 05 2011 18:47:28 GMT+0200 (CEST)