Animations

Animations

Animations in SplashKit can be used to move between cells in bitmaps and sprites. Each animation generates a number sequence that can then be used when drawing bitmaps.

Functions

Animation Count

Returns the number of Animations within an Animation Script.

Parameters:

Name	Type	Description
script	Animation Script	The Animation Script to count the animations in.

Return Type: Integer

Signatures:

C++

int animation_count(animation_script script)

C#

public int AnimationScript.AnimationCount { get }
public static int SplashKit.AnimationCount(AnimationScript script);

Python

def animation_count(script):

Pascal

function AnimationCount(script: AnimationScript): Integer

---

Animation Current Cell

Returns the current cell (the part of the image or sprite) of this animation. This can be used to animate an image or sprite.

Parameters:

Name	Type	Description
anim	Animation	The Animation to return the cell of.

Return Type: Integer

Signatures:

C++

int animation_current_cell(animation anim)

C#

public int Animation.CurrentCell { get }
public static int SplashKit.AnimationCurrentCell(Animation anim);

Python

def animation_current_cell(anim):

Pascal

function AnimationCurrentCell(anim: Animation): Integer

---

Animation Current Vector

Returns the Vector 2d assigned to the current frame in the animation.

Parameters:

Name	Type	Description
anim	Animation	The animation to check the vector of.

Return Type: Vector 2d

Signatures:

C++

vector_2d animation_current_vector(animation anim)

C#

public Vector2D Animation.CurrentVector { get }
public static Vector2D SplashKit.AnimationCurrentVector(Animation anim);

Python

def animation_current_vector(anim):

Pascal

function AnimationCurrentVector(anim: Animation): Vector2D

---

Animation Ended

Checks if an Animation has ended.

Parameters:

Name	Type	Description
anim	Animation	The animation to check.

Return Type: Boolean

Signatures:

C++

bool animation_ended(animation anim)

C#

public bool Animation.Ended { get }
public static bool SplashKit.AnimationEnded(Animation anim);

Python

def animation_ended(anim):

Pascal

function AnimationEnded(anim: Animation): Boolean

---

Animation Entered Frame

Returns true if the Animation entered a new frame on its last update. This can be used to trigger actions on frames within an animation.

Parameters:

Name	Type	Description
anim	Animation	The animation to check.

Return Type: Boolean

Signatures:

C++

bool animation_entered_frame(animation anim)

C#

public bool Animation.EnteredFrame { get }
public static bool SplashKit.AnimationEnteredFrame(Animation anim);

Python

def animation_entered_frame(anim):

Pascal

function AnimationEnteredFrame(anim: Animation): Boolean

---

Animation Frame Time

Returns the amount of time spent in the current frame. When this exceeds the frames duration the animation moves to the next frame.

Parameters:

Name	Type	Description
anim	Animation	The animation to check.

Return Type: Float

Signatures:

C++

float animation_frame_time(animation anim)

C#

public float Animation.FrameTime { get }
public static float SplashKit.AnimationFrameTime(Animation anim);

Python

def animation_frame_time(anim):

Pascal

function AnimationFrameTime(anim: Animation): Single

---

Animation Index

Searches an Animation Script for an Animation and returns its index.

Parameters:

Name	Type	Description
script	Animation Script	The Animation Script to look for the Animation in.
name	String	The name of the Animation to look for.

Return Type: Integer

Signatures:

C++

int animation_index(animation_script script, const string &name)

C#

public int AnimationScript.AnimationIndex(string name);
public static int SplashKit.AnimationIndex(AnimationScript script, string name);

Python

def animation_index(script, name):

Pascal

function AnimationIndex(script: AnimationScript; const name: String): Integer

---

Animation Name

Searches an Animation Script for an animation and returns its name.

Parameters:

Name	Type	Description
temp	Animation	The Animation to search for.

Return Type: String

Signatures:

C++

string animation_name(animation temp)

C#

public string Animation.Name { get }
public static string SplashKit.AnimationName(Animation temp);

Python

def animation_name(temp):

Pascal

function AnimationName(temp: Animation): String

Usage:

See Implementations in Guides

• Using Animations in SplashKit

---

Animation Script Name

Retuns the name of an Animation Script.

Parameters:

Name	Type	Description
script	Animation Script	The Animation Script to return the name of.

Return Type: String

Signatures:

C++

string animation_script_name(animation_script script)

C#

public string AnimationScript.Name { get }
public static string SplashKit.AnimationScriptName(AnimationScript script);

Python

def animation_script_name(script):

Pascal

function AnimationScriptName(script: AnimationScript): String

---

Animation Script Named

Loads and returns a Animation Script. The supplied filename is used to locate the Animation Script to load. The supplied name indicates the name to use to refer to this in SplashKit. The Animation Script can then be retrieved by passing this name to the animation_script_named method.

Parameters:

Name	Type	Description
name	String	Indicates the name used to locate the animation_script to load

Return Type: Animation Script

Signatures:

C++

animation_script animation_script_named(const string &name)

C#

public static AnimationScript SplashKit.AnimationScriptNamed(string name);

Python

def animation_script_named(name):

Pascal

function AnimationScriptNamed(const name: String): AnimationScript

Usage:

See Implementations in Guides

• Using Animations in SplashKit

---

Assign Animation

Note

This function is overloaded. The following versions exist:

• Assign Animation (anim: animation, script: animation_script, name: string)
• Assign Animation (anim: animation, script: animation_script, name: string, with_sound: bool)
• Assign Animation (anim: animation, script: animation_script, idx: int)
• Assign Animation (anim: animation, script: animation_script, idx: int, with_sound: bool)
• Assign Animation (anim: animation, script_name: string, name: string)
• Assign Animation (anim: animation, script_name: string, name: string, with_sound: bool)
• Assign Animation (anim: animation, idx: int)
• Assign Animation (anim: animation, idx: int, with_sound: bool)
• Assign Animation (anim: animation, name: string)
• Assign Animation (anim: animation, name: string, with_sound: bool)

Assign Animation

Setup an Animation to follow the script from an indicated name. This will switch the animation to use the supplied script. It locates the name of the animation with the animation script and sets the anim to start at that point in the script.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
script	Animation Script	The Animation Script to assign the Animation to.
name	String	The name of the Animation to be assigned.

Signatures:

C++

void assign_animation(animation anim, animation_script script, const string &name)

C#

public void Animation.Assign(AnimationScript script, string name);
public static void SplashKit.AssignAnimation(Animation anim, AnimationScript script, string name);

Python

def assign_animation_with_script(anim, script, name):

Pascal

procedure AssignAnimation(anim: Animation; script: AnimationScript; const name: String)

---

Assign Animation

Assigns an Animation to an Animation Script. This may play a sound effect if the animation is set to play a sound effect on its first frame.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
script	Animation Script	The Animation Script to assign the Animation to.
name	String	The name of the Animation to be assigned.
with_sound	Boolean	Denotes whether the Animation should play audio.

Signatures:

C++

void assign_animation(animation anim, animation_script script, const string &name, bool with_sound)

C#

public void Animation.Assign(AnimationScript script, string name, bool withSound);
public static void SplashKit.AssignAnimation(Animation anim, AnimationScript script, string name, bool withSound);

Python

def assign_animation_with_script_and_sound(anim, script, name, with_sound):

Pascal

procedure AssignAnimation(anim: Animation; script: AnimationScript; const name: String; withSound: Boolean)

---

Assign Animation

Assigns an Animation to an Animation Script.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
script	Animation Script	The Animation Script to assign the Animation to.
idx	Integer	The index of the Animation to create.

Signatures:

C++

void assign_animation(animation anim, animation_script script, int idx)

C#

public void Animation.Assign(AnimationScript script, int idx);
public static void SplashKit.AssignAnimation(Animation anim, AnimationScript script, int idx);

Python

def assign_animation_index_with_script(anim, script, idx):

Pascal

procedure AssignAnimation(anim: Animation; script: AnimationScript; idx: Integer)

---

Assign Animation

Assigns an Animation to an Animation Script. This may play a sound effect if the animation is set to play a sound effect on its first frame.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
script	Animation Script	The Animation Script to assign the Animation to.
idx	Integer	The index of the Animation to create.
with_sound	Boolean	Denotes whether the Animation should play audio.

Signatures:

C++

void assign_animation(animation anim, animation_script script, int idx, bool with_sound)

C#

public void Animation.Assign(AnimationScript script, int idx, bool withSound);
public static void SplashKit.AssignAnimation(Animation anim, AnimationScript script, int idx, bool withSound);

Python

def assign_animation_index_with_script_and_sound(anim, script, idx, with_sound):

Pascal

procedure AssignAnimation(anim: Animation; script: AnimationScript; idx: Integer; withSound: Boolean)

---

Assign Animation

Assigns an Animation to an Animation Script.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
script_name	String	The name of the Animation Script to assign the Animation to.
name	String	The name of the Animation to be assigned.

Signatures:

C++

void assign_animation(animation anim, const string &script_name, const string &name)

C#

public void Animation.Assign(string scriptName, string name);
public static void SplashKit.AssignAnimation(Animation anim, string scriptName, string name);

Python

def assign_animation_with_script_named(anim, script_name, name):

Pascal

procedure AssignAnimation(anim: Animation; const scriptName: String; const name: String)

---

Assign Animation

Assigns an Animation to an Animation Script. This may play a sound effect if the animation is set to play a sound effect on its first frame.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
script_name	String	The name of the Animation Script to assign the Animation to.
name	String	The name of the Animation to be assigned
with_sound	Boolean	Denotes whether the Animation should play audio.

Signatures:

C++

void assign_animation(animation anim, const string &script_name, const string &name, bool with_sound)

C#

public void Animation.Assign(string scriptName, string name, bool withSound);
public static void SplashKit.AssignAnimation(Animation anim, string scriptName, string name, bool withSound);

Python

def assign_animation_with_script_named_and_sound(anim, script_name, name, with_sound):

Pascal

procedure AssignAnimation(anim: Animation; const scriptName: String; const name: String; withSound: Boolean)

---

Assign Animation

Setup an Animation to follow the script from an indicated index. This uses the index from the current animation script and sets the supplied animation to start at that point in the script.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
idx	Integer	The index of the animation to use from its current script.

Signatures:

C++

void assign_animation(animation anim, int idx)

C#

public void Animation.Assign(int idx);
public static void SplashKit.AssignAnimation(Animation anim, int idx);

Python

def assign_animation_index(anim, idx):

Pascal

procedure AssignAnimation(anim: Animation; idx: Integer)

---

Assign Animation

Setup an Animation to follow the script from an indicated index. This uses the index from the current animation script and sets the supplied animation to start at that point in the script.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
idx	Integer	The index of the animation to use from its current script.
with_sound	Boolean	Denotes whether the Animation should play audio.

Signatures:

C++

void assign_animation(animation anim, int idx, bool with_sound)

C#

public void Animation.Assign(int idx, bool withSound);
public static void SplashKit.AssignAnimation(Animation anim, int idx, bool withSound);

Python

def assign_animation_index_with_sound(anim, idx, with_sound):

Pascal

procedure AssignAnimation(anim: Animation; idx: Integer; withSound: Boolean)

---

Assign Animation

Setup an Animation to follow the script from an indicated name. This locates the name of the animation from the current animation script and sets the supplied animation to start at that point in the script.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
name	String	The name of the animation to use from its current script.

Signatures:

C++

void assign_animation(animation anim, string name)

C#

public void Animation.Assign(string name);
public static void SplashKit.AssignAnimation(Animation anim, string name);

Python

def assign_animation(anim, name):

Pascal

procedure AssignAnimation(anim: Animation; name: String)

Usage:

See Implementations in Guides

• Using Animations in SplashKit

---

Assign Animation

Setup an Animation to follow the script from an indicated name. This locates the name of the animation from the current animation script and sets the supplied animation to start at that point in the script.

Parameters:

Name	Type	Description
anim	Animation	The Animation to be assigned.
name	String	The name of the animation to use from its current script.
with_sound	Boolean	Denotes whether the Animation should play audio.

Signatures:

C++

void assign_animation(animation anim, string name, bool with_sound)

C#

public void Animation.Assign(string name, bool withSound);
public static void SplashKit.AssignAnimation(Animation anim, string name, bool withSound);

Python

def assign_animation_with_sound(anim, name, with_sound):

Pascal

procedure AssignAnimation(anim: Animation; name: String; withSound: Boolean)

---

Create Animation

Note

This function is overloaded. The following versions exist:

• Create Animation (script: animation_script, idx: int, with_sound: bool)
• Create Animation (script: animation_script, name: string)
• Create Animation (script: animation_script, name: string, with_sound: bool)
• Create Animation (script_name: string, name: string)
• Create Animation (script_name: string, name: string, with_sound: bool)

Create Animation

Creates an animation from an Animation Script. This may play a sound effect if the animation is set to play a sound effect on its first frame.

Parameters:

Name	Type	Description
script	Animation Script	The Animation Script to create the Animation from.
idx	Integer	The index of the Animation to create.
with_sound	Boolean	Denotes whether the Animation should play audio.

Return Type: Animation

Signatures:

C++

animation create_animation(animation_script script, int idx, bool with_sound)

C#

public static Animation SplashKit.CreateAnimation(AnimationScript script, int idx, bool withSound);

Python

def create_animation_from_index_with_sound(script, idx, with_sound):

Pascal

function CreateAnimation(script: AnimationScript; idx: Integer; withSound: Boolean): Animation

---

Create Animation

Creates an animation from an Animation Script.

Parameters:

Name	Type	Description
script	Animation Script	The Animation Script to create the Animation from
name	String	The name for the new Animation

Return Type: Animation

Signatures:

C++

animation create_animation(animation_script script, const string &name)

C#

public Animation AnimationScript.CreateAnimation(string name);
public static Animation SplashKit.CreateAnimation(AnimationScript script, string name);

Python

def create_animation(script, name):

Pascal

function CreateAnimation(script: AnimationScript; const name: String): Animation

---

Create Animation

Creates an animation from a Animation Script. This may play a sound effect if the animation is set to play a sound effect on its first frame.

Parameters:

Name	Type	Description
script	Animation Script	The Animation Script to create the Animation from
name	String	The name for the new Animation
with_sound	Boolean	Denotes whether the Animation should play audio.

Return Type: Animation

Signatures:

C++

animation create_animation(animation_script script, const string &name, bool with_sound)

C#

public Animation AnimationScript.CreateAnimation(string name, bool withSound);
public static Animation SplashKit.CreateAnimation(AnimationScript script, string name, bool withSound);

Python

def create_animation_with_sound(script, name, with_sound):

Pascal

function CreateAnimation(script: AnimationScript; const name: String; withSound: Boolean): Animation

---

Create Animation

Creates an animation from an Animation Script’s name. This may play a sound effect if the animation is set to play a sound effect on its first frame.

Parameters:

Name	Type	Description
script_name	String	The name of the Animation Script to create the Animation from
name	String	The name for the new Animation

Return Type: Animation

Signatures:

C++

animation create_animation(const string &script_name, const string &name)

C#

public static Animation SplashKit.CreateAnimation(string scriptName, string name);

Python

def create_animation_from_script_named(script_name, name):

Pascal

function CreateAnimation(const scriptName: String; const name: String): Animation

Usage:

See Implementations in Guides

• Using Animations in SplashKit

---

Create Animation

Creates an animation from an Animation Script’s name. This may play a sound effect if the animation is set to play a sound effect on its first frame.

Parameters:

Name	Type	Description
script_name	String	The name of the Animation Script to create the Animation from
name	String	The name for the new Animation
with_sound	Boolean	Denotes whether the Animation should play audio.

Return Type: Animation

Signatures:

C++

animation create_animation(const string &script_name, const string &name, bool with_sound)

C#

public static Animation SplashKit.CreateAnimation(string scriptName, string name, bool withSound);

Python

def create_animation_from_script_named_with_sound(script_name, name, with_sound):

Pascal

function CreateAnimation(const scriptName: String; const name: String; withSound: Boolean): Animation

---

Free All Animation Scripts

Frees all loaded Animation Scripts.

Signatures:

C++

void free_all_animation_scripts()

C#

public static void Animation.FreeAll();
public static void SplashKit.FreeAllAnimationScripts();

Python

def free_all_animation_scripts():

Pascal

procedure FreeAllAnimationScripts()

---

Free Animation

Disposes of the resources used in the animation.

Parameters:

Name	Type	Description
ani	Animation	The Animation to be disposed of.

Signatures:

C++

void free_animation(animation ani)

C#

public static void SplashKit.FreeAnimation(Animation ani);

Python

def free_animation(ani):

Pascal

procedure FreeAnimation(ani: Animation)

---

Free Animation Script

Note

This function is overloaded. The following versions exist:

• Free Animation Script (script_to_free: animation_script)
• Free Animation Script (name: string)

Free Animation Script

Frees loaded animation frames data. Use this when you will no longer be using the animation for any purpose, including within sprite.

Parameters:

Name	Type	Description
script_to_free	Animation Script	The Animation Script to be freed.

Signatures:

C++

void free_animation_script(animation_script script_to_free)

C#

public static void SplashKit.FreeAnimationScript(AnimationScript scriptToFree);

Python

def free_animation_script(script_to_free):

Pascal

procedure FreeAnimationScript(scriptToFree: AnimationScript)

---

Free Animation Script

Frees loaded Animation Script data. Use this when you will no longer be using the animation for any purpose, including within sprite.

Parameters:

Name	Type	Description
name	String	The name of the Animation Script to be freed.

Signatures:

C++

void free_animation_script(const string &name)

C#

public static void SplashKit.FreeAnimationScript(string name);

Python

def free_animation_script_with_name(name):

Pascal

procedure FreeAnimationScript(const name: String)

---

Has Animation Named

Returns whether an Animation Script has been loaded with the given name.

Parameters:

Name	Type	Description
script	Animation Script	The Animation Script to check.
name	String	The name of the Animation Script to look for.

Return Type: Boolean

Signatures:

C++

bool has_animation_named(animation_script script, const string &name)

C#

public static bool SplashKit.HasAnimationNamed(AnimationScript script, string name);

Python

def has_animation_named(script, name):

Pascal

function HasAnimationNamed(script: AnimationScript; const name: String): Boolean

---

Has Animation Script

Determines if SplashKit has animation frames loaded for the supplied name. This checks against all loaded animation frames, those loaded without a name are assigned the filename as a default.

Parameters:

Name	Type	Description
name	String	The name of the animation script to look for.

Return Type: Boolean

Signatures:

C++

bool has_animation_script(const string &name)

C#

public static bool SplashKit.HasAnimationScript(string name);

Python

def has_animation_script(name):

Pascal

function HasAnimationScript(const name: String): Boolean

---

Load Animation Script

Load animation details from an animation frames file.

Parameters:

Name	Type	Description
name	String	The name of the Animation Script.
filename	String	The file to load the Animation Script from.

Return Type: Animation Script

Signatures:

C++

animation_script load_animation_script(const string &name, const string &filename)

C#

public static AnimationScript SplashKit.LoadAnimationScript(string name, string filename);
public AnimationScript(string name, string filename);

Python

def load_animation_script(name, filename):

Pascal

function LoadAnimationScript(const name: String; const filename: String): AnimationScript

---

Restart Animation

Note

This function is overloaded. The following versions exist:

• Restart Animation (anim: animation)
• Restart Animation (anim: animation, with_sound: bool)

Restart Animation

Restarts an Animation.

Parameters:

Name	Type	Description
anim	Animation	The Animation to restart.

Signatures:

C++

void restart_animation(animation anim)

C#

public void Animation.Restart();
public static void SplashKit.RestartAnimation(Animation anim);

Python

def restart_animation(anim):

Pascal

procedure RestartAnimation(anim: Animation)

---

Restart Animation

Restarts an Animation. This may play a sound effect if the first frame triggers a sound.

Parameters:

Name	Type	Description
anim	Animation	The Animation to restart.
with_sound	Boolean	Denotes whether the Animation should play audio.

Signatures:

C++

void restart_animation(animation anim, bool with_sound)

C#

public void Animation.Restart(bool withSound);
public static void SplashKit.RestartAnimation(Animation anim, bool withSound);

Python

def restart_animation_with_sound(anim, with_sound):

Pascal

procedure RestartAnimation(anim: Animation; withSound: Boolean)

---

Update Animation

Note

This function is overloaded. The following versions exist:

• Update Animation (anim: animation, pct: float, with_sound: bool)
• Update Animation (anim: animation)
• Update Animation (anim: animation, pct: float)

Update Animation

Updates the animation, updating the time spent and possibly moving to a new frame in the animation. This may play a sound effect if the new frame triggers a sound.

Parameters:

Name	Type	Description
anim	Animation	The Animation to update.
pct	Float	The amount that the frame time will be incremented
with_sound	Boolean	Denotes whether the Animation should play audio.

Signatures:

C++

void update_animation(animation anim, float pct, bool with_sound)

C#

public static void SplashKit.UpdateAnimation(Animation anim, float pct, bool withSound);

Python

def update_animation_percent_with_sound(anim, pct, with_sound):

Pascal

procedure UpdateAnimation(anim: Animation; pct: Single; withSound: Boolean)

---

Update Animation

Updates the animation, updating the time spent and possibly moving to a new frame in the animation. This may play a sound effect if the new frame triggers a sound.

Parameters:

Name	Type	Description
anim	Animation	The Animation to update.

Signatures:

C++

void update_animation(animation anim)

C#

public void Animation.Update();
public static void SplashKit.UpdateAnimation(Animation anim);

Python

def update_animation(anim):

Pascal

procedure UpdateAnimation(anim: Animation)

Usage:

See Implementations in Guides

• Using Animations in SplashKit

---

Update Animation

Updates the animation, updating the time spent and possibly moving to a new frame in the animation. This may play a sound effect if the new frame triggers a sound.

Parameters:

Name	Type	Description
anim	Animation	The Animation to update.
pct	Float	The amount that the frame time will be incremented

Signatures:

C++

void update_animation(animation anim, float pct)

C#

public void Animation.Update(float pct);
public static void SplashKit.UpdateAnimation(Animation anim, float pct);

Python

def update_animation_percent(anim, pct):

Pascal

procedure UpdateAnimation(anim: Animation; pct: Single)

---