AnimationScript? * CreateAnimationScript(
std::string _Name,
Sprockets * _AnimationSprocket,
PlayScrtipFuntionPointer?* _ScrtipFuntionPointer,
int _z,
int _TotalNumberOfFrames,
int _fps,
int _StartFrame,
int _Loop,
bool _StartNow,
std::string _AddtoCurrentRenderlist
);
Public function of the Epee Engine Class
Description:
Creates an AnimationScript? and adds it to the rendable list _AddtoCurrentRenderlist
Arguments:
Required:
std::string _Name
Name of AnimationScript?
Sprockets * _AnimationSprocket
Pointer to the sprocket that the script will effect
PlayScrtipFuntionPointer?* _ScrtipFuntionPointer
Pointer to the function that will be called each frame
pass in NULL to use animation script function Script insted
int _z
location in the render list should be less that the z value of _AnimationSprocket
int _TotalNumberOfFrames
Number of frame to complete the script pass in -1 to run the script until the animation function return true
Optional:
int _fps
Frames per second to run the script at
defaults to 30
int _StartFrame
Frame to start the script at if _TotalNumberOfFrames is -1 then this is ignored
Defaults to 0
int _Loop
Number of times to play the script
passing in zero makes the script loop forever
Defaults to 1
bool _StartNow
if this is true the script starts playing after being created
defaults to true
std::string _AddtoCurrentRenderlist
render list to add the animation script to
defaults to "Current" the current active render list
Return Value:
if successful returns a pointer to the newly created animation script, otherwise returns a NULL pointer
