Sprites

Sprites

SplashKit Sprites allows you to create images you can easily move and animate.

Functions

Call For All Sprites

Note

This function is overloaded. The following versions exist:

• Call For All Sprites (fn: sprite_float_function, val: float)
• Call For All Sprites (fn: sprite_function)

Call For All Sprites

Call the supplied function for all sprites in the current pack.

Parameters:

Name	Type	Description
fn	Sprite Float Function	The sprite function to call on all sprites.
val	Float	The value passed to the function for each sprite.

Signatures:

C++

void call_for_all_sprites(sprite_float_function *fn, float val)

C#

public static void SplashKit.CallForAllSprites(SpriteFloatFunction fn, float val);

Python

def call_for_all_sprites_with_value(fn, val):

Pascal

procedure CallForAllSprites(fn: SpriteFloatFunction; val: Single)

---

Call For All Sprites

Call the supplied function for all sprites in the current pack.

Parameters:

Name	Type	Description
fn	Sprite Function	The sprite function to call on all sprites.

Signatures:

C++

void call_for_all_sprites(sprite_function *fn)

C#

public static void SplashKit.CallForAllSprites(SpriteFunction fn);

Python

def call_for_all_sprites(fn):

Pascal

procedure CallForAllSprites(fn: SpriteFunction)

---

Call On Sprite Event

Register a procedure to be called when an events occur on any sprite.

Parameters:

Name	Type	Description
handler	Sprite Event Handler	The function to call when any sprite raises an event

Signatures:

C++

void call_on_sprite_event(sprite_event_handler *handler)

C#

public static void SplashKit.CallOnSpriteEvent(SpriteEventHandler handler);

Python

def call_on_sprite_event(handler):

Pascal

procedure CallOnSpriteEvent(handler: SpriteEventHandler)

---

Create Sprite  {</>}

Note

This function is overloaded. The following versions exist:

• Create Sprite (layer: bitmap)  {</>}
• Create Sprite (layer: bitmap, ani: animation_script)
• Create Sprite (bitmap_name: string)
• Create Sprite (name: string, layer: bitmap)
• Create Sprite (name: string, layer: bitmap, ani: animation_script)
• Create Sprite (bitmap_name: string, animation_name: string)

Create Sprite  {</>}

Creates a sprite for the passed in bitmap image. The sprite will use the cell information within the bitmap if it is animated at a later stage. This version of create_sprite will initialise the sprite to use pixel level collisions, no animations, and have one layer named ‘layer1’. This version of the constructor will assign a default name to the sprite for resource management purposes.

Parameters:

Name	Type	Description
layer	Bitmap	The bitmap for the sprite’s image.

Return Type: Sprite

Signatures:

C++

sprite create_sprite(bitmap layer)

C#

public static Sprite SplashKit.CreateSprite(Bitmap layer);
public Sprite(Bitmap layer);

Python

def create_sprite(layer):

Pascal

function CreateSprite(layer: Bitmap): Sprite

Usage:  {</>}

See Code Examples

Example 1: Creating a Player Sprite

Note

To test this example code you can download these Resources.

C++

#include "splashkit.h"

int main()
{
    open_window("create_sprite", 600, 600);

    // Load the bitmap for creating a sprite
    bitmap player = load_bitmap("player_bitmap", "player.png");

    // Create the player sprite
    sprite player_sprite = create_sprite(player);

    sprite_set_x(player_sprite, 300);
    sprite_set_y(player_sprite, 300);

    clear_screen(COLOR_BLACK);
    draw_sprite(player_sprite);
    refresh_screen();
    delay(5000);

    close_all_windows();

    return 0;
}

C#

Top-level Statements

using SplashKitSDK;
using static SplashKitSDK.SplashKit;

OpenWindow("create_sprite", 600, 600);

// Load the bitmap for creating a sprite
Bitmap player = LoadBitmap("player_bitmap", "player.png");

// Create the player sprite
Sprite playerSprite = CreateSprite(player);

SpriteSetX(playerSprite, 300);
SpriteSetY(playerSprite, 300);

ClearScreen(ColorBlack());
DrawSprite(playerSprite);
RefreshScreen();
Delay(5000);

CloseAllWindows();

Object-Oriented

using SplashKitSDK;

namespace CreateSpriteExample
{
    public class Program
    {
        public static void Main()
        {
            Window start = SplashKit.OpenWindow("create_sprite", 600, 600);

            // Load the bitmap for creating a sprite
            Bitmap player = SplashKit.LoadBitmap("player_bitmap", "player.png");

            // Create the player sprite
            Sprite playerSprite = SplashKit.CreateSprite(player);

            playerSprite.X = 300;
            playerSprite.Y = 300;

            SplashKit.ClearScreen(Color.Black);
            SplashKit.DrawSprite(playerSprite);
            SplashKit.RefreshScreen();
            SplashKit.Delay(5000);

            SplashKit.CloseAllWindows();
        }
    }
}

Python

from splashkit import *

open_window("create_sprite", 600, 600)

# Load the bitmap for creating a sprite
player = load_bitmap("player_bitmap", "player.png")
player_sprite = create_sprite(player)

# Setting the x coordinate in reference to the window
sprite_set_x(player_sprite, 300)
sprite_set_y(player_sprite, 300)

# Retrieve the y position using sprite_x function
x_position = sprite_x(player_sprite)

clear_screen(color_black())
draw_sprite(player_sprite)
refresh_screen()
delay(5000)

close_all_windows()

Output:

---

Create Sprite

Creates a sprite for the passed in bitmap image. The sprite will use the cell information within the bitmap if it is animated at a later stage. This version of Create Sprite will initialise the sprite to use pixel level collisions, the specified animation template, the layer have name ‘layer1’. This version of the constructor will assign a default name to the sprite for resource management purposes.

Parameters:

Name	Type	Description
layer	Bitmap	The bitmap for the sprite’s image.
ani	Animation Script	The animation script for the sprite’s animations.

Return Type: Sprite

Signatures:

C++

sprite create_sprite(bitmap layer, animation_script ani)

C#

public static Sprite SplashKit.CreateSprite(Bitmap layer, AnimationScript ani);
public Sprite(Bitmap layer, AnimationScript ani);

Python

def create_sprite_with_animation(layer, ani):

Pascal

function CreateSprite(layer: Bitmap; ani: AnimationScript): Sprite

---

Create Sprite

Creates a sprite for the passed in bitmap image. The sprite will use the cell information within the bitmap if it is animated at a later stage. This version of create_sprite will initialise the sprite to use pixel level collisions, no animations, and have one layer named ‘layer1’. This version of the constructor will assign a default name to the sprite for resource management purposes.

Parameters:

Name	Type	Description
bitmap_name	String	The name of the bitmap to use as the sprite’s layer

Return Type: Sprite

Signatures:

C++

sprite create_sprite(const string &bitmap_name)

C#

public static Sprite SplashKit.CreateSprite(string bitmapName);
public Sprite(string bitmapName);

Python

def create_sprite_with_bitmap_named(bitmap_name):

Pascal

function CreateSprite(const bitmapName: String): Sprite

---

Create Sprite

Creates a sprite for the passed in bitmap image. The sprite will use the cell information within the sprite if it is animated at a later stage. This version of create_sprite will initialise the sprite to use pixel level collisions, no animation, the layer have name ‘layer1’.

Parameters:

Name	Type	Description
name	String	The name of the sprite for resource management.
layer	Bitmap	The bitmap for the sprite’s image.

Return Type: Sprite

Signatures:

C++

sprite create_sprite(const string &name, bitmap layer)

C#

public static Sprite SplashKit.CreateSprite(string name, Bitmap layer);
public Sprite(string name, Bitmap layer);

Python

def create_sprite_named(name, layer):

Pascal

function CreateSprite(const name: String; layer: Bitmap): Sprite

---

Create Sprite

Creates a sprite for the passed in bitmap image. The sprite will use the cell information within the sprite if it is animated at a later stage. This version of create_sprite will initialise the sprite to use pixel level collisions, the specified animation template, the layer have name ‘layer1’.

Parameters:

Name	Type	Description
name	String	The name of the sprite for resource management.
layer	Bitmap	The bitmap for the sprite’s image.
ani	Animation Script	The animation script for the sprite’s animations.

Return Type: Sprite

Signatures:

C++

sprite create_sprite(const string &name, bitmap layer, animation_script ani)

C#

public static Sprite SplashKit.CreateSprite(string name, Bitmap layer, AnimationScript ani);
public Sprite(string name, Bitmap layer, AnimationScript ani);

Python

def create_sprite_named_with_animation(name, layer, ani):

Pascal

function CreateSprite(const name: String; layer: Bitmap; ani: AnimationScript): Sprite

---

Create Sprite

Creates a sprite. The bitmap_name is used to indicate the bitmap the sprite will use, and the animation_name is used to indicate which animation_script to use.

Parameters:

Name	Type	Description
bitmap_name	String	The name of the bitmap to use as the sprite’s image.
animation_name	String	The name of the animation script to use for this sprite.

Return Type: Sprite

Signatures:

C++

sprite create_sprite(const string &bitmap_name, const string &animation_name)

C#

public static Sprite SplashKit.CreateSprite(string bitmapName, string animationName);
public Sprite(string bitmapName, string animationName);

Python

def create_sprite_with_bitmap_and_animation_named(bitmap_name, animation_name):

Pascal

function CreateSprite(const bitmapName: String; const animationName: String): Sprite

---

Create Sprite Pack

Create a new sprite_pack with a given name. This pack can then be selected and used to control which sprites are drawn/updated in the calls to draw_all_sprites and update_all_sprites.

Parameters:

Name	Type	Description
name	String	The name of the new sprite pack.

Signatures:

C++

void create_sprite_pack(const string &name)

C#

public static void SplashKit.CreateSpritePack(string name);

Python

def create_sprite_pack(name):

Pascal

procedure CreateSpritePack(const name: String)

---

Current Sprite Pack

Returns the name of the currently selected sprite_pack.

Return Type: String

Signatures:

C++

string current_sprite_pack()

C#

public static string SplashKit.CurrentSpritePack();

Python

def current_sprite_pack():

Pascal

function CurrentSpritePack(): String

---

Draw All Sprites

draws all of the sprites in the current sprite pack. Packs can be switched to select between different sets of sprites.

Signatures:

C++

void draw_all_sprites()

C#

public static void SplashKit.DrawAllSprites();

Python

def draw_all_sprites():

Pascal

procedure DrawAllSprites()

---

Draw Sprite  {</>}

Note

This function is overloaded. The following versions exist:

• Draw Sprite (s: sprite, offset: vector_2d)
• Draw Sprite (s: sprite)  {</>}
• Draw Sprite (s: sprite, x_offset: double, y_offset: double)

Draw Sprite

Draws the sprite at its position in the game offset by a given amount. Only use this method when you want to draw the sprite displaced from its location in your game. Otherwise you should change the sprite’s location and then use the standard ”draw_sprite” routine.

Parameters:

Name	Type	Description
s	Sprite	The sprite to draw.
offset	Vector 2d	The amount to offset the sprite.

Signatures:

C++

void draw_sprite(sprite s, const vector_2d &offset)

C#

public void Sprite.Draw(Vector2D offset);
public static void SplashKit.DrawSprite(Sprite s, Vector2D offset);

Python

def draw_sprite_offset_by(s, offset):

Pascal

procedure DrawSprite(s: Sprite; const offset: Vector2D)

---

Draw Sprite  {</>}

Draws the sprite at its location in the world. This is affected by the position of the camera and the sprites current location. This is the standard routine for drawing sprites to the screen and should be used in most cases.

Parameters:

Name	Type	Description
s	Sprite	The sprite to draw.

Signatures:

C++

void draw_sprite(sprite s)

C#

public void Sprite.Draw();
public static void SplashKit.DrawSprite(Sprite s);

Python

def draw_sprite(s):

Pascal

procedure DrawSprite(s: Sprite)

Usage:  {</>}

See Code Examples

Example 1: Drawing a Player Sprite

Note

To test this example code you can download these Resources.

C++

#include "splashkit.h"

int main()
{
    window start = open_window("Drawing a Player Sprite", 600, 600);

    load_bitmap("player", "player.png");
    sprite player_sprite = create_sprite(bitmap_named("player"));
    sprite_set_x(player_sprite, 300);
    sprite_set_y(player_sprite, 300);

    clear_screen(COLOR_BLACK);

    // Draw the sprite
    draw_sprite(player_sprite);

    refresh_screen();
    delay(5000);
    close_all_windows();

    return 0;
}

C#

Top-level Statements

using static SplashKitSDK.SplashKit;
using SplashKitSDK;

OpenWindow("Drawing a Player Sprite", 600, 600);

LoadBitmap("player", "player.png");
Sprite playerSprite = CreateSprite(BitmapNamed("player"));
SpriteSetX(playerSprite, 300);
SpriteSetY(playerSprite, 300);

ClearScreen(ColorBlack());

// Draw the sprite
DrawSprite(playerSprite);

RefreshScreen();
Delay(5000);
CloseAllWindows();

Object-Oriented

using SplashKitSDK;

namespace DrawSpriteExample
{
    public class Program
    {
        public static void Main()
        {
            SplashKit.OpenWindow("Drawing a Player Sprite", 600, 600);

            SplashKit.LoadBitmap("player", "player.png");
            Sprite playerSprite = SplashKit.CreateSprite(SplashKit.BitmapNamed("player"));
            SplashKit.SpriteSetX(playerSprite, 300);
            SplashKit.SpriteSetY(playerSprite, 300);
            SplashKit.ClearScreen(SplashKit.ColorBlack());

            // Draw the sprite
            SplashKit.DrawSprite(playerSprite);

            SplashKit.RefreshScreen();
            SplashKit.Delay(5000);
            SplashKit.CloseAllWindows();
        }
    }
}

Python

from splashkit import *

start = open_window("Drawing a Player Sprite", 600, 600)

load_bitmap("player", "player.png")
player_sprite = create_sprite(bitmap_named("player"))
sprite_set_x(player_sprite, 300)
sprite_set_y(player_sprite, 300)

clear_screen(color_black())

# Draw the sprite
draw_sprite(player_sprite)

refresh_screen()
delay(5000)
close_all_windows()

Output:

---

Draw Sprite

Draws the sprite at its position in the game offset by a given amount. Only use this method when you want to draw the sprite displaced from its location in your game. Otherwise you should change the sprite’s location and then use the standard Draw Sprite routine.

Parameters:

Name	Type	Description
s	Sprite	The sprite to draw.
x_offset	Double	The amount to offset on the x axis.
y_offset	Double	The amount to offset on the y axis.

Signatures:

C++

void draw_sprite(sprite s, double x_offset, double y_offset)

C#

public void Sprite.Draw(double xOffset, double yOffset);
public static void SplashKit.DrawSprite(Sprite s, double xOffset, double yOffset);

Python

def draw_sprite_offset_x_y(s, x_offset, y_offset):

Pascal

procedure DrawSprite(s: Sprite; xOffset: Double; yOffset: Double)

---

Free All Sprites

Releases all of the sprites that have been loaded.

Signatures:

C++

void free_all_sprites()

C#

public static void SplashKit.FreeAllSprites();

Python

def free_all_sprites():

Pascal

procedure FreeAllSprites()

---

Free Sprite  {</>}

Free the resources associated with a sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to be destroyed.

Signatures:

C++

void free_sprite(sprite s)

C#

public static void SplashKit.FreeSprite(Sprite s);

Python

def free_sprite(s):

Pascal

procedure FreeSprite(s: Sprite)

Usage:  {</>}

See Code Examples

Example 1: Freeing a Sprite

Note

To test this example code you can download these Resources.

C++

#include "splashkit.h"

int main()
{
    open_window("Free Sprite Memory Resource", 600, 600);

    bitmap player = load_bitmap("player", "player.png");
    sprite player_sprite = create_sprite(bitmap_named("player"));
    sprite_set_x(player_sprite, 300);
    sprite_set_y(player_sprite, 300);

    bool sprite_exists = true; // Track if the sprite exists

    while (!quit_requested())
    {
        process_events();

        clear_screen(COLOR_BLACK);
        if (sprite_exists)
        {
            draw_sprite(player_sprite);
            update_sprite(player_sprite);
        }
        refresh_screen();

        // If UP key is typed, the sprite is removed
        if (sprite_exists && key_typed(UP_KEY))
        {
            free_sprite(player_sprite);
            sprite_exists = false; // Set bool to false to stop drawing/updating
        }
    }

    // Clean up
    if (sprite_exists)
    {
        free_sprite(player_sprite);
    }

    close_all_windows();

    return 0;
}

C#

Top-level Statements

using static SplashKitSDK.SplashKit;
using SplashKitSDK;

OpenWindow("Free Sprite Memory Resource", 600, 600);

LoadBitmap("player", "player.png");
Sprite playerSprite = CreateSprite(BitmapNamed("player"));
SpriteSetX(playerSprite, 300);
SpriteSetY(playerSprite, 300);

bool spriteExists = true; // Track if the sprite exists

while (!QuitRequested())
{
    ProcessEvents();

    ClearScreen(ColorBlack());
    if (spriteExists)
    {
        DrawSprite(playerSprite);
        UpdateSprite(playerSprite);
    }
    RefreshScreen();

    // If UP key is typed, the sprite is removed
    if (spriteExists && KeyTyped(KeyCode.UpKey))
    {
        FreeSprite(playerSprite);
        spriteExists = false; // Set bool to false to stop drawing/updating
    }
}

// Clean up
if (spriteExists)
{
    FreeSprite(playerSprite);
}

CloseAllWindows();

Object-Oriented

using SplashKitSDK;

namespace FreeSpriteExample
{
    public class Program
    {
        public static void Main()
        {
            SplashKit.OpenWindow("Free Sprite Memory Resource", 600, 600);

            SplashKit.LoadBitmap("player", "player.png");
            Sprite playerSprite = SplashKit.CreateSprite(SplashKit.BitmapNamed("player"));
            SplashKit.SpriteSetX(playerSprite, 300);
            SplashKit.SpriteSetY(playerSprite, 300);

            bool spriteExists = true; // Track if the sprite exists

            while (!SplashKit.QuitRequested())
            {
                SplashKit.ProcessEvents();

                SplashKit.ClearScreen(Color.Black);
                if (spriteExists)
                {
                    SplashKit.DrawSprite(playerSprite);
                    SplashKit.UpdateSprite(playerSprite);
                }
                SplashKit.RefreshScreen();

                // If UP key is typed, the sprite is removed
                if (spriteExists && SplashKit.KeyTyped(KeyCode.UpKey))
                {
                    SplashKit.FreeSprite(playerSprite);
                    spriteExists = false; // Set bool to false to stop drawing/updating
                }
            }

            // Clean up
            if (spriteExists)
            {
                SplashKit.FreeSprite(playerSprite);
            }

            SplashKit.CloseAllWindows();
        }
    }
}

Python

from splashkit import *

open_window("Free Sprite Memory Resource", 600, 600)

player = load_bitmap("player", "player.png")
player_sprite = create_sprite(bitmap_named("player"))
sprite_set_x(player_sprite, 300)
sprite_set_y(player_sprite, 300)

sprite_exists = True # Track if the sprite exists

while (not quit_requested()):
    process_events()

    clear_screen(color_black())
    if (sprite_exists):
        draw_sprite(player_sprite)
        update_sprite(player_sprite)
    refresh_screen()

    # If UP key is typed, the sprite is removed
    if (sprite_exists and key_typed(KeyCode.up_key)):
        free_sprite(player_sprite)
        sprite_exists = False # Set bool to false to stop drawing/updating

# Clean up
if (sprite_exists):
    free_sprite(player_sprite)

close_all_windows()

Output:

---

Free Sprite Pack

Frees the sprite pack and all of its sprites.

Parameters:

Name	Type	Description
name	String	The name of the sprite pack to destroy.

Signatures:

C++

void free_sprite_pack(const string &name)

C#

public static void SplashKit.FreeSpritePack(string name);

Python

def free_sprite_pack(name):

Pascal

procedure FreeSpritePack(const name: String)

---

Has Sprite

Determines if SplashKit has a sprite for the supplied name. This checks against all sprites, those loaded without a name are assigned a default.

Parameters:

Name	Type	Description
name	String	The name of the sprite to locate.

Return Type: Boolean

Signatures:

C++

bool has_sprite(const string &name)

C#

public static bool SplashKit.HasSprite(string name);

Python

def has_sprite(name):

Pascal

function HasSprite(const name: String): Boolean

---

Has Sprite Pack

Indicates if a given sprite_pack has already been created.

Parameters:

Name	Type	Description
name	String	The name for the sprite pack.

Return Type: Boolean

Signatures:

C++

bool has_sprite_pack(const string &name)

C#

public static bool SplashKit.HasSpritePack(string name);

Python

def has_sprite_pack(name):

Pascal

function HasSpritePack(const name: String): Boolean

---

Move Sprite

Note

This function is overloaded. The following versions exist:

• Move Sprite (s: sprite)
• Move Sprite (s: sprite, distance: vector_2d)
• Move Sprite (s: sprite, distance: vector_2d, pct: float)
• Move Sprite (s: sprite, pct: float)

Move Sprite

moves the sprite as indicated by its velocity. You can call this directly ot alternatively, this action is performed when the sprite is updated using the ”update_sprite” routine.

Parameters:

Name	Type	Description
s	Sprite	The sprite to move.

Signatures:

C++

void move_sprite(sprite s)

C#

public void Sprite.Move();
public static void SplashKit.MoveSprite(Sprite s);

Python

def move_sprite(s):

Pascal

procedure MoveSprite(s: Sprite)

---

Move Sprite

Moves the sprite a given distance based on the value passed in rather than based on the sprite’s velocity. Typically this method is used to apply other movement actions to the sprite and the velocity of the sprite is used the intended movement of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to move.
distance	Vector 2d	The vector that represents the direction and distance to move the sprite.

Signatures:

C++

void move_sprite(sprite s, const vector_2d &distance)

C#

public void Sprite.Move(Vector2D distance);
public static void SplashKit.MoveSprite(Sprite s, Vector2D distance);

Python

def move_sprite_by_vector(s, distance):

Pascal

procedure MoveSprite(s: Sprite; const distance: Vector2D)

---

Move Sprite

Moves the sprite a percentage of a given distance based on the value passed in rather than based on the sprite’s velocity. Typically this method is used to apply other movement actions to the sprite and the velocity of the sprite is used the intended movement of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to move.
distance	Vector 2d	The vector that represents the direction and distance to move the sprite.
pct	Float	The percentage of the distance to move the sprite.

Signatures:

C++

void move_sprite(sprite s, const vector_2d &distance, float pct)

C#

public void Sprite.Move(Vector2D distance, float pct);
public static void SplashKit.MoveSprite(Sprite s, Vector2D distance, float pct);

Python

def move_sprite_by_vector_percent(s, distance, pct):

Pascal

procedure MoveSprite(s: Sprite; const distance: Vector2D; pct: Single)

---

Move Sprite

Moves the sprite as indicated by a percentage of its velocity. You can call this directly ot alternatively, this action is performed when the sprite is updated using the ”update_sprite” routines that require a percentage.

Parameters:

Name	Type	Description
s	Sprite	The sprite to move.
pct	Float	The percentage of the sprite’s velocity to move.

Signatures:

C++

void move_sprite(sprite s, float pct)

C#

public void Sprite.Move(float pct);
public static void SplashKit.MoveSprite(Sprite s, float pct);

Python

def move_sprite_percent(s, pct):

Pascal

procedure MoveSprite(s: Sprite; pct: Single)

---

Move Sprite To

This method moves a sprite to a given position in the game.

Parameters:

Name	Type	Description
s	Sprite	The sprite to move.
x	Double	The sprite’s new x location.
y	Double	The sprite’s new y location.

Signatures:

C++

void move_sprite_to(sprite s, double x, double y)

C#

public void Sprite.MoveTo(double x, double y);
public static void SplashKit.MoveSpriteTo(Sprite s, double x, double y);

Python

def move_sprite_to(s, x, y):

Pascal

procedure MoveSpriteTo(s: Sprite; x: Double; y: Double)

---

Select Sprite Pack

Selects the named sprite_pack (if it has been created). The selected sprite_pack determines which sprites are drawn and updated with the draw_all_sprites and update_all_sprites code.

Parameters:

Name	Type	Description
name	String	The name of the sprite pack to select.

Signatures:

C++

void select_sprite_pack(const string &name)

C#

public static void SplashKit.SelectSpritePack(string name);

Python

def select_sprite_pack(name):

Pascal

procedure SelectSpritePack(const name: String)

---

Sprite Add Layer

Adds a new layer to the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to add the layer to.
new_layer	Bitmap	The new layer’s bitmap.
layer_name	String	The name of the new layer.

Return Type: Integer

Signatures:

C++

int sprite_add_layer(sprite s, bitmap new_layer, const string &layer_name)

C#

public int Sprite.AddLayer(Bitmap newLayer, string layerName);
public static int SplashKit.SpriteAddLayer(Sprite s, Bitmap newLayer, string layerName);

Python

def sprite_add_layer(s, new_layer, layer_name):

Pascal

function SpriteAddLayer(s: Sprite; newLayer: Bitmap; const layerName: String): Integer

---

Sprite Add To Velocity

Alters the current velocity of the sprite, adding the passed in vector_2d to the current velocity. When the sprite is updated (see Update Sprite) this vector_2d is used to move the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Vector 2d	The amount to add to the sprite’s velocity.

Signatures:

C++

void sprite_add_to_velocity(sprite s, const vector_2d &value)

C#

public void Sprite.AddToVelocity(Vector2D value);
public static void SplashKit.SpriteAddToVelocity(Sprite s, Vector2D value);

Python

def sprite_add_to_velocity(s, value):

Pascal

procedure SpriteAddToVelocity(s: Sprite; const value: Vector2D)

---

Sprite Add Value

Note

This function is overloaded. The following versions exist:

• Sprite Add Value (s: sprite, name: string)
• Sprite Add Value (s: sprite, name: string, init_val: float)

Sprite Add Value

Adds a new kind of value to the sprite

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
name	String	The name of the new value to store in the sprite.

Signatures:

C++

void sprite_add_value(sprite s, const string &name)

C#

public void Sprite.AddValue(string name);
public static void SplashKit.SpriteAddValue(Sprite s, string name);

Python

def sprite_add_value(s, name):

Pascal

procedure SpriteAddValue(s: Sprite; const name: String)

---

Sprite Add Value

Adds a new kind of value to the sprite, setting the initial value to the value passed in.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
name	String	The name of the new value to store in the sprite.
init_val	Float	The initial value.

Signatures:

C++

void sprite_add_value(sprite s, const string &name, float init_val)

C#

public void Sprite.AddValue(string name, float initVal);
public static void SplashKit.SpriteAddValue(Sprite s, string name, float initVal);

Python

def sprite_add_value_with_default(s, name, init_val):

Pascal

procedure SpriteAddValue(s: Sprite; const name: String; initVal: Single)

---

Sprite Anchor Point

Returns the anchor point of the sprite. This is the point around which the sprite rotates. This is in sprite coordinates, so as if the sprite is drawn at 0,0.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Point 2d

Signatures:

C++

point_2d sprite_anchor_point(sprite s)

C#

public Point2D Sprite.AnchorPoint { get }
public static Point2D SplashKit.SpriteAnchorPoint(Sprite s);

Python

def sprite_anchor_point(s):

Pascal

function SpriteAnchorPoint(s: Sprite): Point2D

---

Sprite Anchor Position

The sprite anchor position, is the location of the anchor point in world coordinates, based upon the position of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to find where the anchor is in world coordinates

Return Type: Point 2d

Signatures:

C++

point_2d sprite_anchor_position(sprite s)

C#

public static Point2D SplashKit.SpriteAnchorPosition(Sprite s);

Python

def sprite_anchor_position(s):

Pascal

function SpriteAnchorPosition(s: Sprite): Point2D

---

Sprite Animation Has Ended

Indicates if the sprites animation has ended.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Boolean

Signatures:

C++

bool sprite_animation_has_ended(sprite s)

C#

public bool Sprite.AnimationHasEnded { get }
public static bool SplashKit.SpriteAnimationHasEnded(Sprite s);

Python

def sprite_animation_has_ended(s):

Pascal

function SpriteAnimationHasEnded(s: Sprite): Boolean

---

Sprite Animation Name

Returns the name of the sprite’s current animation.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: String

Signatures:

C++

string sprite_animation_name(sprite s)

C#

public string Sprite.AnimationName();
public static string SplashKit.SpriteAnimationName(Sprite s);

Python

def sprite_animation_name(s):

Pascal

function SpriteAnimationName(s: Sprite): String

---

Sprite At

Determines if a sprite is at a given point.

Parameters:

Name	Type	Description
s	Sprite	The sprite to test
pt	Point 2d	The point to check (in world coordinates)

Return Type: Boolean

Signatures:

C++

bool sprite_at(sprite s, const point_2d &pt)

C#

public static bool SplashKit.SpriteAt(Sprite s, Point2D pt);

Python

def sprite_at(s, pt):

Pascal

function SpriteAt(s: Sprite; const pt: Point2D): Boolean

---

Sprite Bring Layer Forward

Sends the layer specified forward in the visible layer order.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change
visible_layer	Integer	The visible layer to bring forward

Signatures:

C++

void sprite_bring_layer_forward(sprite s, int visible_layer)

C#

public void Sprite.SendLayerForward(int visibleLayer);
public static void SplashKit.SpriteBringLayerForward(Sprite s, int visibleLayer);

Python

def sprite_bring_layer_forward(s, visible_layer):

Pascal

procedure SpriteBringLayerForward(s: Sprite; visibleLayer: Integer)

---

Sprite Bring Layer To Front

Sends the layer specified to the front in the visible layer order.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change
visible_layer	Integer	The visible layer to bring to the front

Signatures:

C++

void sprite_bring_layer_to_front(sprite s, int visible_layer)

C#

public void Sprite.SendLayerTofront(int visibleLayer);
public static void SplashKit.SpriteBringLayerToFront(Sprite s, int visibleLayer);

Python

def sprite_bring_layer_to_front(s, visible_layer):

Pascal

procedure SpriteBringLayerToFront(s: Sprite; visibleLayer: Integer)

---

Sprite Call On Event

Register a procedure to call when events occur on the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to add the handler to.
handler	Sprite Event Handler	The function to call when this sprite raises an event.

Signatures:

C++

void sprite_call_on_event(sprite s, sprite_event_handler *handler)

C#

public void Sprite.CallOnEvent(SpriteEventHandler handler);
public static void SplashKit.SpriteCallOnEvent(Sprite s, SpriteEventHandler handler);

Python

def sprite_call_on_event(s, handler):

Pascal

procedure SpriteCallOnEvent(s: Sprite; handler: SpriteEventHandler)

---

Sprite Center Point

Returns the center point of the passed in sprite. This is based on the sprite’s Position, Width and Height.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Point 2d

Signatures:

C++

point_2d sprite_center_point(sprite s)

C#

public Point2D Sprite.SpriteCenterPoint { get }
public static Point2D SplashKit.SpriteCenterPoint(Sprite s);

Python

def sprite_center_point(s):

Pascal

function SpriteCenterPoint(s: Sprite): Point2D

---

Sprite Circle

Gets a circle in the bounds of the base layer of the indicated sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Circle

Signatures:

C++

circle sprite_circle(sprite s)

C#

public Circle Sprite.Circle();
public static Circle SplashKit.SpriteCircle(Sprite s);

Python

def sprite_circle(s):

Pascal

function SpriteCircle(s: Sprite): Circle

---

Sprite Collision Bitmap

Returns the bitmap used by the sprite to determine if it has collided with other objects in the game.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Bitmap

Signatures:

C++

bitmap sprite_collision_bitmap(sprite s)

C#

public Bitmap Sprite.CollisionBitmap { get }
public static Bitmap SplashKit.SpriteCollisionBitmap(Sprite s);

Python

def sprite_collision_bitmap(s):

Pascal

function SpriteCollisionBitmap(s: Sprite): Bitmap

---

Sprite Collision Circle

Gets a circle in the bounds of the indicated sprite’s collision rectangle.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Circle

Signatures:

C++

circle sprite_collision_circle(sprite s)

C#

public Circle Sprite.CollisionCircle();
public static Circle SplashKit.SpriteCollisionCircle(Sprite s);

Python

def sprite_collision_circle(s):

Pascal

function SpriteCollisionCircle(s: Sprite): Circle

---

Sprite Collision Kind

Returns the kind of collision used with this sprite. This is used when determining if the sprite has collided with other objects in the game.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Collision Test Kind

Signatures:

C++

collision_test_kind sprite_collision_kind(sprite s)

C#

public CollisionTestKind Sprite.CollisionKind { get }
public static CollisionTestKind SplashKit.SpriteCollisionKind(Sprite s);

Python

def sprite_collision_kind(s):

Pascal

function SpriteCollisionKind(s: Sprite): CollisionTestKind

---

Sprite Collision Rectangle

Returns the collision rectangle for the specified sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Rectangle

Signatures:

C++

rectangle sprite_collision_rectangle(sprite s)

C#

public Rectangle Sprite.CollisionRectangle { get }
public static Rectangle SplashKit.SpriteCollisionRectangle(Sprite s);

Python

def sprite_collision_rectangle(s):

Pascal

function SpriteCollisionRectangle(s: Sprite): Rectangle

---

Sprite Current Cell

Returns the current animation cell for an animated sprite. The cell is updated when the sprite’s animation data is updated.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Integer

Signatures:

C++

int sprite_current_cell(sprite s)

C#

public int Sprite.CurrentCell { get }
public static int SplashKit.SpriteCurrentCell(Sprite s);

Python

def sprite_current_cell(s):

Pascal

function SpriteCurrentCell(s: Sprite): Integer

---

Sprite Current Cell Rectangle

Returns a rectangle of the current cell within the sprite’s image. This is used to determine what part of the bitmap should be used when the sprite is drawn.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Rectangle

Signatures:

C++

rectangle sprite_current_cell_rectangle(sprite s)

C#

public Rectangle Sprite.CurrentCellRectangle { get }
public static Rectangle SplashKit.SpriteCurrentCellRectangle(Sprite s);

Python

def sprite_current_cell_rectangle(s):

Pascal

function SpriteCurrentCellRectangle(s: Sprite): Rectangle

---

Sprite Dx

Returns the X value of the sprite’s velocity.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Double

Signatures:

C++

double sprite_dx(sprite s)

C#

public double Sprite.Dx { get }
public static double SplashKit.SpriteDx(Sprite s);

Python

def sprite_dx(s):

Pascal

function SpriteDx(s: Sprite): Double

---

Sprite Dy

Returns the Y value of the sprite’s velocity.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Double

Signatures:

C++

double sprite_dy(sprite s)

C#

public double Sprite.Dy { get }
public static double SplashKit.SpriteDy(Sprite s);

Python

def sprite_dy(s):

Pascal

function SpriteDy(s: Sprite): Double

---

Sprite Has Value

Indicates if the sprite has a value with the given name.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
name	String	The name of the value to check.

Return Type: Boolean

Signatures:

C++

bool sprite_has_value(sprite s, string name)

C#

public static bool SplashKit.SpriteHasValue(Sprite s, string name);

Python

def sprite_has_value(s, name):

Pascal

function SpriteHasValue(s: Sprite; name: String): Boolean

---

Sprite Heading

Returns the direction the sprite is heading in degrees.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Float

Signatures:

C++

float sprite_heading(sprite s)

C#

public float Sprite.Heading { get }
public static float SplashKit.SpriteHeading(Sprite s);

Python

def sprite_heading(s):

Pascal

function SpriteHeading(s: Sprite): Single

---

Sprite Height

The current height of the sprite (aligned to the Y axis).

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Integer

Signatures:

C++

int sprite_height(sprite s)

C#

public int Sprite.Height { get }
public static int SplashKit.SpriteHeight(Sprite s);

Python

def sprite_height(s):

Pascal

function SpriteHeight(s: Sprite): Integer

---

Sprite Hide Layer

Note

This function is overloaded. The following versions exist:

• Sprite Hide Layer (s: sprite, name: string)
• Sprite Hide Layer (s: sprite, id: int)

Sprite Hide Layer

Hide the specified layer of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to hide the layer of.
name	String	The name of the layer to hide.

Signatures:

C++

void sprite_hide_layer(sprite s, const string &name)

C#

public void Sprite.HideLayer(string name);
public static void SplashKit.SpriteHideLayer(Sprite s, string name);

Python

def sprite_hide_layer_named(s, name):

Pascal

procedure SpriteHideLayer(s: Sprite; const name: String)

---

Sprite Hide Layer

Hide the specified layer of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to hide the layer of.
id	Integer	The index of the layer to hide.

Signatures:

C++

void sprite_hide_layer(sprite s, int id)

C#

public void Sprite.HideLayer(int id);
public static void SplashKit.SpriteHideLayer(Sprite s, int id);

Python

def sprite_hide_layer(s, id):

Pascal

procedure SpriteHideLayer(s: Sprite; id: Integer)

---

Sprite Layer

Note

This function is overloaded. The following versions exist:

• Sprite Layer (s: sprite, name: string)
• Sprite Layer (s: sprite, idx: int)

Sprite Layer

Returns the bitmap of the indicated layer of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the layer from
name	String	The name of the layer to fetch

Return Type: Bitmap

Signatures:

C++

bitmap sprite_layer(sprite s, const string &name)

C#

public Bitmap Sprite.Layer(string name);
public static Bitmap SplashKit.SpriteLayer(Sprite s, string name);

Python

def sprite_layer_named(s, name):

Pascal

function SpriteLayer(s: Sprite; const name: String): Bitmap

---

Sprite Layer

Returns the bitmap of the indicated layer of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the layer from
idx	Integer	The index of the layer

Return Type: Bitmap

Signatures:

C++

bitmap sprite_layer(sprite s, int idx)

C#

public Bitmap Sprite.Layer(int idx);
public static Bitmap SplashKit.SpriteLayer(Sprite s, int idx);

Python

def sprite_layer_at_index(s, idx):

Pascal

function SpriteLayer(s: Sprite; idx: Integer): Bitmap

---

Sprite Layer Circle

Note

This function is overloaded. The following versions exist:

• Sprite Layer Circle (s: sprite, name: string)
• Sprite Layer Circle (s: sprite, idx: int)

Sprite Layer Circle

Gets a circle in the bounds of the indicated layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
name	String	The name of the layer.

Return Type: Circle

Signatures:

C++

circle sprite_layer_circle(sprite s, const string &name)

C#

public Circle Sprite.LayerCircle(string name);
public static Circle SplashKit.SpriteLayerCircle(Sprite s, string name);

Python

def sprite_layer_circle_named(s, name):

Pascal

function SpriteLayerCircle(s: Sprite; const name: String): Circle

---

Sprite Layer Circle

Gets a circle in the bounds of the indicated layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
idx	Integer	The index of the layer.

Return Type: Circle

Signatures:

C++

circle sprite_layer_circle(sprite s, int idx)

C#

public Circle Sprite.LayerCircle(int idx);
public static Circle SplashKit.SpriteLayerCircle(Sprite s, int idx);

Python

def sprite_layer_circle_at_index(s, idx):

Pascal

function SpriteLayerCircle(s: Sprite; idx: Integer): Circle

---

Sprite Layer Count

Returns the number of layers within the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the layer count from.

Return Type: Integer

Signatures:

C++

int sprite_layer_count(sprite s)

C#

public int Sprite.LayerCount { get }
public static int SplashKit.SpriteLayerCount(Sprite s);

Python

def sprite_layer_count(s):

Pascal

function SpriteLayerCount(s: Sprite): Integer

---

Sprite Layer Height

Note

This function is overloaded. The following versions exist:

• Sprite Layer Height (s: sprite, name: string)
• Sprite Layer Height (s: sprite, idx: int)

Sprite Layer Height

The height of a given layer of the sprite (aligned to the Y axis).

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
name	String	The name of the layer to get the details of.

Return Type: Integer

Signatures:

C++

int sprite_layer_height(sprite s, const string &name)

C#

public int Sprite.LayerHeight(string name);
public static int SplashKit.SpriteLayerHeight(Sprite s, string name);

Python

def sprite_layer_height_named(s, name):

Pascal

function SpriteLayerHeight(s: Sprite; const name: String): Integer

---

Sprite Layer Height

The height of a given layer of the sprite (aligned to the Y axis).

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
idx	Integer	The index of the layer to get the details of.

Return Type: Integer

Signatures:

C++

int sprite_layer_height(sprite s, int idx)

C#

public int Sprite.LayerHeight(int idx);
public static int SplashKit.SpriteLayerHeight(Sprite s, int idx);

Python

def sprite_layer_height(s, idx):

Pascal

function SpriteLayerHeight(s: Sprite; idx: Integer): Integer

---

Sprite Layer Index

Returns the index of the specified layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the layer from
name	String	The name of the layer to get the index of

Return Type: Integer

Signatures:

C++

int sprite_layer_index(sprite s, const string &name)

C#

public int Sprite.IndexOfLayer(string name);
public static int SplashKit.SpriteLayerIndex(Sprite s, string name);

Python

def sprite_layer_index(s, name):

Pascal

function SpriteLayerIndex(s: Sprite; const name: String): Integer

---

Sprite Layer Name

Returns the name of the specified layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the layer name from
idx	Integer	The index of the layer you want the name of

Return Type: String

Signatures:

C++

string sprite_layer_name(sprite s, int idx)

C#

public string Sprite.LayerName(int idx);
public static string SplashKit.SpriteLayerName(Sprite s, int idx);

Python

def sprite_layer_name(s, idx):

Pascal

function SpriteLayerName(s: Sprite; idx: Integer): String

---

Sprite Layer Offset

Note

This function is overloaded. The following versions exist:

• Sprite Layer Offset (s: sprite, name: string)
• Sprite Layer Offset (s: sprite, idx: int)

Sprite Layer Offset

Gets the offset of the specified layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
name	String	The name of the layer to get the offset of.

Return Type: Vector 2d

Signatures:

C++

vector_2d sprite_layer_offset(sprite s, const string &name)

C#

public Vector2D Sprite.LayerOffset(string name);
public static Vector2D SplashKit.SpriteLayerOffset(Sprite s, string name);

Python

def sprite_layer_offset_named(s, name):

Pascal

function SpriteLayerOffset(s: Sprite; const name: String): Vector2D

---

Sprite Layer Offset

Gets the offset of the specified layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
idx	Integer	The index of the layer to get the offset of.

Return Type: Vector 2d

Signatures:

C++

vector_2d sprite_layer_offset(sprite s, int idx)

C#

public Vector2D Sprite.LayerOffset(int idx);
public static Vector2D SplashKit.SpriteLayerOffset(Sprite s, int idx);

Python

def sprite_layer_offset(s, idx):

Pascal

function SpriteLayerOffset(s: Sprite; idx: Integer): Vector2D

---

Sprite Layer Rectangle

Note

This function is overloaded. The following versions exist:

• Sprite Layer Rectangle (s: sprite, name: string)
• Sprite Layer Rectangle (s: sprite, idx: int)

Sprite Layer Rectangle

Gets a rectangle that surrounds the indicated layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
name	String	The name of the layer.

Return Type: Rectangle

Signatures:

C++

rectangle sprite_layer_rectangle(sprite s, const string &name)

C#

public Rectangle Sprite.LayerRectangle(string name);
public static Rectangle SplashKit.SpriteLayerRectangle(Sprite s, string name);

Python

def sprite_layer_rectangle_named(s, name):

Pascal

function SpriteLayerRectangle(s: Sprite; const name: String): Rectangle

---

Sprite Layer Rectangle

Gets a rectangle that surrounds the indicated layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
idx	Integer	The index of the layer.

Return Type: Rectangle

Signatures:

C++

rectangle sprite_layer_rectangle(sprite s, int idx)

C#

public Rectangle Sprite.LayerRectangle(int idx);
public static Rectangle SplashKit.SpriteLayerRectangle(Sprite s, int idx);

Python

def sprite_layer_rectangle_at_index(s, idx):

Pascal

function SpriteLayerRectangle(s: Sprite; idx: Integer): Rectangle

---

Sprite Layer Width

Note

This function is overloaded. The following versions exist:

• Sprite Layer Width (s: sprite, name: string)
• Sprite Layer Width (s: sprite, idx: int)

Sprite Layer Width

The width of a given layer of the sprite (aligned to the X axis).

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
name	String	The name of the layer to get the details of.

Return Type: Integer

Signatures:

C++

int sprite_layer_width(sprite s, const string &name)

C#

public int Sprite.LayerWidth(string name);
public static int SplashKit.SpriteLayerWidth(Sprite s, string name);

Python

def sprite_layer_width_named(s, name):

Pascal

function SpriteLayerWidth(s: Sprite; const name: String): Integer

---

Sprite Layer Width

The width of a given layer of the sprite (aligned to the X axis).

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
idx	Integer	The index of the layer to get the details of.

Return Type: Integer

Signatures:

C++

int sprite_layer_width(sprite s, int idx)

C#

public int Sprite.LayerWidth(int idx);
public static int SplashKit.SpriteLayerWidth(Sprite s, int idx);

Python

def sprite_layer_width(s, idx):

Pascal

function SpriteLayerWidth(s: Sprite; idx: Integer): Integer

---

Sprite Location Matrix

Returns a matrix that can be used to transform points into the coordinate space of the passed in sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Matrix 2d

Signatures:

C++

matrix_2d sprite_location_matrix(sprite s)

C#

public Matrix2D Sprite.LocationMatrix { get }
public static Matrix2D SplashKit.SpriteLocationMatrix(Sprite s);

Python

def sprite_location_matrix(s):

Pascal

function SpriteLocationMatrix(s: Sprite): Matrix2D

---

Sprite Mass

This indicates the mass of the sprite for any of the collide methods from Physics. The mass of two colliding sprites will determine the relative velocitys after the collision.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Float

Signatures:

C++

float sprite_mass(sprite s)

C#

public float Sprite.Mass { get }
public static float SplashKit.SpriteMass(Sprite s);

Python

def sprite_mass(s):

Pascal

function SpriteMass(s: Sprite): Single

---

Sprite Move From Anchor Point

Indicates if the sprite is moved from its anchor point, or from its top left. When this returns true the location of the sprite will indicate its anchor point. When this returns false the location of the sprite is its top left corner.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details of.

Return Type: Boolean

Signatures:

C++

bool sprite_move_from_anchor_point(sprite s)

C#

public bool Sprite.MoveFromAnchorPoint { get }
public static bool SplashKit.SpriteMoveFromAnchorPoint(Sprite s);

Python

def sprite_move_from_anchor_point(s):

Pascal

function SpriteMoveFromAnchorPoint(s: Sprite): Boolean

---

Sprite Move To

This void starts the sprite moving to the indicated destination point, over a specified number of seconds. When the sprite arrives it will raise the sprite_arrived event.

Parameters:

Name	Type	Description
s	Sprite	The sprite to move.
pt	Point 2d	The sprite’s destination.
taking_seconds	Float	The time the sprite should take to get to pt.

Signatures:

C++

void sprite_move_to(sprite s, const point_2d &pt, float taking_seconds)

C#

public void Sprite.MoveTo(Point2D pt, float takingSeconds);
public static void SplashKit.SpriteMoveTo(Sprite s, Point2D pt, float takingSeconds);

Python

def sprite_move_to_taking_seconds(s, pt, taking_seconds):

Pascal

procedure SpriteMoveTo(s: Sprite; const pt: Point2D; takingSeconds: Single)

---

Sprite Name

Returns the name of the sprite. This name is used for resource management and can be used to interact with the sprite in various routines.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: String

Signatures:

C++

string sprite_name(sprite s)

C#

public string Sprite.Name { get }
public static string SplashKit.SpriteName(Sprite s);

Python

def sprite_name(s):

Pascal

function SpriteName(s: Sprite): String

---

Sprite Named

Returns the Sprite with the specified name.

Parameters:

Name	Type	Description
name	String	The name of the sprite to locate.

Return Type: Sprite

Signatures:

C++

sprite sprite_named(const string &name)

C#

public static Sprite SplashKit.SpriteNamed(string name);

Python

def sprite_named(name):

Pascal

function SpriteNamed(const name: String): Sprite

---

Sprite Offscreen

Returns true if the sprite is entirely off the current screen.

Parameters:

Name	Type	Description
s	Sprite	The sprite to test.

Return Type: Boolean

Signatures:

C++

bool sprite_offscreen(sprite s)

C#

public bool Sprite.Offscreen();
public static bool SplashKit.SpriteOffscreen(Sprite s);

Python

def sprite_offscreen(s):

Pascal

function SpriteOffscreen(s: Sprite): Boolean

---

Sprite On Screen At

Note

This function is overloaded. The following versions exist:

• Sprite On Screen At (s: sprite, pt: point_2d)
• Sprite On Screen At (s: sprite, x: double, y: double)

Sprite On Screen At

Returns true if a pixel of the Sprite s is at the screen location specified (pt), which is converted to a world location.

Parameters:

Name	Type	Description
s	Sprite	The sprite to test.
pt	Point 2d	The location in screen coordinates to check.

Return Type: Boolean

Signatures:

C++

bool sprite_on_screen_at(sprite s, const point_2d &pt)

C#

public bool Sprite.OnScreenAt(Point2D pt);
public static bool SplashKit.SpriteOnScreenAt(Sprite s, Point2D pt);

Python

def sprite_on_screen_at_point(s, pt):

Pascal

function SpriteOnScreenAt(s: Sprite; const pt: Point2D): Boolean

---

Sprite On Screen At

Returns true if a pixel of the Sprite s is at the screen location specified.

Parameters:

Name	Type	Description
s	Sprite	The sprite to test.
x	Double	The x location in screen coordinates to check.
y	Double	The y location in screen coordinates to check.

Return Type: Boolean

Signatures:

C++

bool sprite_on_screen_at(sprite s, double x, double y)

C#

public bool Sprite.OnScreenAt(double x, double y);
public static bool SplashKit.SpriteOnScreenAt(Sprite s, double x, double y);

Python

def sprite_on_screen_at(s, x, y):

Pascal

function SpriteOnScreenAt(s: Sprite; x: Double; y: Double): Boolean

---

Sprite Position

Returns the sprite’s position.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Point 2d

Signatures:

C++

point_2d sprite_position(sprite s)

C#

public Point2D Sprite.Position { get }
public static Point2D SplashKit.SpritePosition(Sprite s);

Python

def sprite_position(s):

Pascal

function SpritePosition(s: Sprite): Point2D

---

Sprite Replay Animation

Note

This function is overloaded. The following versions exist:

• Sprite Replay Animation (s: sprite)
• Sprite Replay Animation (s: sprite, with_sound: bool)

Sprite Replay Animation

Restart the sprite’s current animation, this will play a sound if the first cell of the animation is associated with a sound effect.

Parameters:

Name	Type	Description
s	Sprite	The sprite to replay the animation of.

Signatures:

C++

void sprite_replay_animation(sprite s)

C#

public void Sprite.ReplayAnimation();
public static void SplashKit.SpriteReplayAnimation(Sprite s);

Python

def sprite_replay_animation(s):

Pascal

procedure SpriteReplayAnimation(s: Sprite)

---

Sprite Replay Animation

Restart the sprite’s current animation, this will play a sound if with_sound is true and the first cell of the animation is associated with a sound effect.

Parameters:

Name	Type	Description
s	Sprite	The sprite to replay the animation of.
with_sound	Boolean	If false, the animation will not play associated sound effects when restarted.

Signatures:

C++

void sprite_replay_animation(sprite s, bool with_sound)

C#

public void Sprite.ReplayAnimation(bool withSound);
public static void SplashKit.SpriteReplayAnimation(Sprite s, bool withSound);

Python

def sprite_replay_animation_with_sound(s, with_sound):

Pascal

procedure SpriteReplayAnimation(s: Sprite; withSound: Boolean)

---

Sprite Rotation

This indicates the angle of rotation of the sprite. This will rotate any images of the sprite before drawing, which can be very slow. avoid using this method with bitmap based sprites where possible.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Float

Signatures:

C++

float sprite_rotation(sprite s)

C#

public float Sprite.Rotation { get }
public static float SplashKit.SpriteRotation(Sprite s);

Python

def sprite_rotation(s):

Pascal

function SpriteRotation(s: Sprite): Single

---

Sprite Scale

This indicates the scale of the sprite. This will scale any images of the sprite before drawing, which can be very slow. avoid using this method with bitmap based sprites where possible.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Float

Signatures:

C++

float sprite_scale(sprite s)

C#

public float Sprite.Scale { get }
public static float SplashKit.SpriteScale(Sprite s);

Python

def sprite_scale(s):

Pascal

function SpriteScale(s: Sprite): Single

---

Sprite Screen Rectangle

Returns the rectangle representing the location of the sprite on the screen.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Rectangle

Signatures:

C++

rectangle sprite_screen_rectangle(sprite s)

C#

public Rectangle Sprite.ScreenRectangle { get }
public static Rectangle SplashKit.SpriteScreenRectangle(Sprite s);

Python

def sprite_screen_rectangle(s):

Pascal

function SpriteScreenRectangle(s: Sprite): Rectangle

---

Sprite Send Layer Backward

Sends the layer specified backward in the visible layer order.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change
visible_layer	Integer	The visible layer to send to backward

Signatures:

C++

void sprite_send_layer_backward(sprite s, int visible_layer)

C#

public void Sprite.SendLayerTobackward(int visibleLayer);
public static void SplashKit.SpriteSendLayerBackward(Sprite s, int visibleLayer);

Python

def sprite_send_layer_backward(s, visible_layer):

Pascal

procedure SpriteSendLayerBackward(s: Sprite; visibleLayer: Integer)

---

Sprite Send Layer To Back

Sends the layer specified to the back in the visible layer order.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change
visible_layer	Integer	The visible layer to send to back

Signatures:

C++

void sprite_send_layer_to_back(sprite s, int visible_layer)

C#

public void Sprite.SendLayerToBack(int visibleLayer);
public static void SplashKit.SpriteSendLayerToBack(Sprite s, int visibleLayer);

Python

def sprite_send_layer_to_back(s, visible_layer):

Pascal

procedure SpriteSendLayerToBack(s: Sprite; visibleLayer: Integer)

---

Sprite Set Anchor Point

Allows you to set the anchor point for the sprite. This is the point around which the sprite rotates. This is in sprite coordinates, as if the sprite is drawn at 0,0.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
pt	Point 2d	The new anchor point in sprite coordinates.

Signatures:

C++

void sprite_set_anchor_point(sprite s, const point_2d &pt)

C#

public void Sprite.AnchorPoint { set }
public static void SplashKit.SpriteSetAnchorPoint(Sprite s, Point2D pt);

Python

def sprite_set_anchor_point(s, pt):

Pascal

procedure SpriteSetAnchorPoint(s: Sprite; const pt: Point2D)

---

Sprite Set Collision Bitmap

Sets the bitmap used by the sprite to determine if it has collided with other objects in the game. By default the collision_bitmap is set to the bitmap from the sprite’s first layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
bmp	Bitmap	The new collision bitmap for the sprite.

Signatures:

C++

void sprite_set_collision_bitmap(sprite s, bitmap bmp)

C#

public void Sprite.CollisionBitmap { set }
public static void SplashKit.SpriteSetCollisionBitmap(Sprite s, Bitmap bmp);

Python

def sprite_set_collision_bitmap(s, bmp):

Pascal

procedure SpriteSetCollisionBitmap(s: Sprite; bmp: Bitmap)

---

Sprite Set Collision Kind

Sets the kind of collision used with this sprite. This is used when determining if the sprite has collided with other objects in the game.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Collision Test Kind	The new kind of collision test for this sprite.

Signatures:

C++

void sprite_set_collision_kind(sprite s, collision_test_kind value)

C#

public void Sprite.CollisionKind { set }
public static void SplashKit.SpriteSetCollisionKind(Sprite s, CollisionTestKind value);

Python

def sprite_set_collision_kind(s, value):

Pascal

procedure SpriteSetCollisionKind(s: Sprite; value: CollisionTestKind)

---

Sprite Set Dx

Sets the X value of the sprite’s velocity.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Double	The new x component of the sprite’s velocity.

Signatures:

C++

void sprite_set_dx(sprite s, double value)

C#

public void Sprite.Dx { set }
public static void SplashKit.SpriteSetDx(Sprite s, double value);

Python

def sprite_set_dx(s, value):

Pascal

procedure SpriteSetDx(s: Sprite; value: Double)

---

Sprite Set Dy

Sets the Y value of the sprite’s velocity.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Double	The new y component of the sprite’s velocity.

Signatures:

C++

void sprite_set_dy(sprite s, double value)

C#

public void Sprite.Dy { set }
public static void SplashKit.SpriteSetDy(Sprite s, double value);

Python

def sprite_set_dy(s, value):

Pascal

procedure SpriteSetDy(s: Sprite; value: Double)

---

Sprite Set Heading

Alters the direction the sprite is heading without changing the speed.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Float	The new angle for the sprite’s velocity — distance remains the same.

Signatures:

C++

void sprite_set_heading(sprite s, float value)

C#

public void Sprite.Heading { set }
public static void SplashKit.SpriteSetHeading(Sprite s, float value);

Python

def sprite_set_heading(s, value):

Pascal

procedure SpriteSetHeading(s: Sprite; value: Single)

---

Sprite Set Layer Offset

Note

This function is overloaded. The following versions exist:

• Sprite Set Layer Offset (s: sprite, name: string, value: vector_2d)
• Sprite Set Layer Offset (s: sprite, idx: int, value: vector_2d)

Sprite Set Layer Offset

Sets the offset of the specified layer. The offset is used when the layer is drawn in the sprite, and moves the image relative to the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
name	String	The name of the layer to change.
value	Vector 2d	The new offset.

Signatures:

C++

void sprite_set_layer_offset(sprite s, const string &name, const vector_2d &value)

C#

public void Sprite.SetLayerOffset(string name, Vector2D value);
public static void SplashKit.SpriteSetLayerOffset(Sprite s, string name, Vector2D value);

Python

def sprite_set_layer_offset_named(s, name, value):

Pascal

procedure SpriteSetLayerOffset(s: Sprite; const name: String; const value: Vector2D)

---

Sprite Set Layer Offset

Sets the offset of the specified layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
idx	Integer	The index of the layer to change.
value	Vector 2d	The new offset.

Signatures:

C++

void sprite_set_layer_offset(sprite s, int idx, const vector_2d &value)

C#

public void Sprite.SetLayerOffset(int idx, Vector2D value);
public static void SplashKit.SpriteSetLayerOffset(Sprite s, int idx, Vector2D value);

Python

def sprite_set_layer_offset_at_index(s, idx, value):

Pascal

procedure SpriteSetLayerOffset(s: Sprite; idx: Integer; const value: Vector2D)

---

Sprite Set Mass

Allows you to change the mass of a sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Float	The new mass for the sprite.

Signatures:

C++

void sprite_set_mass(sprite s, float value)

C#

public void Sprite.Mass { set }
public static void SplashKit.SpriteSetMass(Sprite s, float value);

Python

def sprite_set_mass(s, value):

Pascal

procedure SpriteSetMass(s: Sprite; value: Single)

---

Sprite Set Move From Anchor Point

Allows you to indicate if the sprite is moved from its anchor point, or from its top left. When set to true the location of the sprite will be its anchor point. When set to false the location of the sprite is its top left corner.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Boolean	The value to set this option.

Signatures:

C++

void sprite_set_move_from_anchor_point(sprite s, bool value)

C#

public void Sprite.MoveFromAnchorPoint { set }
public static void SplashKit.SpriteSetMoveFromAnchorPoint(Sprite s, bool value);

Python

def sprite_set_move_from_anchor_point(s, value):

Pascal

procedure SpriteSetMoveFromAnchorPoint(s: Sprite; value: Boolean)

---

Sprite Set Position  {</>}

Sets the sprite’s position.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Point 2d	The new location for the sprite.

Signatures:

C++

void sprite_set_position(sprite s, const point_2d &value)

C#

public void Sprite.Position { set }
public static void SplashKit.SpriteSetPosition(Sprite s, Point2D value);

Python

def sprite_set_position(s, value):

Pascal

procedure SpriteSetPosition(s: Sprite; const value: Point2D)

Usage:  {</>}

See Code Examples

Example 1: Setting Sprite Position

Note

To test this example code you can download these Resources.

C++

#include "splashkit.h"

int main()
{
    open_window("sprite_set_position", 600, 600);

    load_bitmap("player", "player-run.png");
    sprite player_sprite = create_sprite(bitmap_named("player"));
    sprite_set_x(player_sprite, 200);
    sprite_set_y(player_sprite, 300);

    clear_screen(COLOR_BLACK);
    draw_sprite(player_sprite);
    refresh_screen();
    delay(2000);

    // Create point_2d object which stores the new coordinates
    point_2d pos = point_at(450, 300);

    // Set the new sprite position
    sprite_set_position(player_sprite, pos);

    clear_screen(COLOR_BLACK);
    draw_sprite(player_sprite);
    refresh_screen();
    delay(5000);

    close_all_windows();

    return 0;
}

C#

Top-level Statements

using static SplashKitSDK.SplashKit;
using SplashKitSDK;

OpenWindow("sprite_set_position", 600, 600);

LoadBitmap("player", "player-run.png");
Sprite playerSprite = CreateSprite(BitmapNamed("player"));
SpriteSetX(playerSprite, 200);
SpriteSetY(playerSprite, 300);

ClearScreen(ColorBlack());
DrawSprite(playerSprite);
RefreshScreen();
Delay(2000);

// Create Point2D object which stores the new coordinates
Point2D pos = PointAt(450, 300);

// Set the new sprite position
SpriteSetPosition(playerSprite, pos);

ClearScreen(ColorBlack());
DrawSprite(playerSprite);
RefreshScreen();
Delay(5000);

CloseAllWindows();

Object-Oriented

using SplashKitSDK;

namespace SpriteSetPosition
{
  public class Program
  {
    public static void Main()
    {
      SplashKit.OpenWindow("sprite_set_position", 600, 600);

      SplashKit.LoadBitmap("player", "player-run.png");
      Sprite playerSprite = SplashKit.CreateSprite(SplashKit.BitmapNamed("player"));
      SplashKit.SpriteSetX(playerSprite, 200);
      SplashKit.SpriteSetY(playerSprite, 300);

      SplashKit.ClearScreen(SplashKit.ColorBlack());
      SplashKit.DrawSprite(playerSprite);
      SplashKit.RefreshScreen();
      SplashKit.Delay(2000);

      // Create Point2D object which stores the new coordinates
      Point2D pos = SplashKit.PointAt(450, 300);

      // Set the new sprite position
      SplashKit.SpriteSetPosition(playerSprite, pos);

      SplashKit.ClearScreen(SplashKit.ColorBlack());
      SplashKit.DrawSprite(playerSprite);
      SplashKit.RefreshScreen();
      SplashKit.Delay(5000);

      SplashKit.CloseAllWindows();
    }
  }
}

Python

from splashkit import *

open_window("sprite_set_position", 600, 600)

load_bitmap("player", "player-run.png")
player_sprite = create_sprite(bitmap_named("player"))
sprite_set_x(player_sprite, 200)
sprite_set_y(player_sprite, 300)

clear_screen(color_black())
draw_sprite(player_sprite)
refresh_screen()
delay(2000)

# Create Point2D object which stores the new coordinates
pos = point_at(450, 300)

# Set the new sprite position
sprite_set_position(player_sprite, pos)

clear_screen(color_black())
draw_sprite(player_sprite)
refresh_screen()
delay(5000)

close_all_windows()

Output:

---

Sprite Set Rotation

Allows you to change the rotation of a sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Float	The new rotation angle for the sprite

Signatures:

C++

void sprite_set_rotation(sprite s, float value)

C#

public void Sprite.Rotation { set }
public static void SplashKit.SpriteSetRotation(Sprite s, float value);

Python

def sprite_set_rotation(s, value):

Pascal

procedure SpriteSetRotation(s: Sprite; value: Single)

---

Sprite Set Scale

Allows you to change the scale of a sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Float	The new scale for the sprite.

Signatures:

C++

void sprite_set_scale(sprite s, float value)

C#

public void Sprite.Scale { set }
public static void SplashKit.SpriteSetScale(Sprite s, float value);

Python

def sprite_set_scale(s, value):

Pascal

procedure SpriteSetScale(s: Sprite; value: Single)

---

Sprite Set Speed

Alters the speed of the sprite without effecting the direction.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Double	The new speed of the sprite — direction will remain the same.

Signatures:

C++

void sprite_set_speed(sprite s, double value)

C#

public void Sprite.Speed { set }
public static void SplashKit.SpriteSetSpeed(Sprite s, double value);

Python

def sprite_set_speed(s, value):

Pascal

procedure SpriteSetSpeed(s: Sprite; value: Double)

---

Sprite Set Value

Assigns a value to the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
name	String	The name of the value to change
val	Float	The new value.

Signatures:

C++

void sprite_set_value(sprite s, const string &name, float val)

C#

public void Sprite.SetValue(string name, float val);
public static void SplashKit.SpriteSetValue(Sprite s, string name, float val);

Python

def sprite_set_value_named(s, name, val):

Pascal

procedure SpriteSetValue(s: Sprite; const name: String; val: Single)

---

Sprite Set Velocity  {</>}

Sets the current velocity of the sprite. When the sprite is updated (see Update Sprite) this vector_2d is used to move the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Vector 2d	The new sprite velocity.

Signatures:

C++

void sprite_set_velocity(sprite s, const vector_2d &value)

C#

public void Sprite.Velocity { set }
public static void SplashKit.SpriteSetVelocity(Sprite s, Vector2D value);

Python

def sprite_set_velocity(s, value):

Pascal

procedure SpriteSetVelocity(s: Sprite; const value: Vector2D)

Usage:  {</>}

See Code Examples

Example 1: Setting Velocity of Sprite

Note

To test this example code you can download these Resources.

C++

#include "splashkit.h"

int main()
{
    open_window("sprite-set-velocity", 600, 600);

    load_bitmap("player", "player-run.png");
    sprite player_sprite = create_sprite(bitmap_named("player"));
    sprite_set_x(player_sprite, 300);
    sprite_set_y(player_sprite, 300);

    // Create vector for sprite's velocity
    vector_2d vel = vector_to(0.01,0);

    while (!quit_requested())
    {
        process_events();

        // Set sprite velocity and update sprite
        sprite_set_velocity(player_sprite, vel);
        update_sprite(player_sprite);

        clear_screen(COLOR_BLACK);
        draw_sprite(player_sprite);
        refresh_screen();
    }

    close_all_windows();

    return 0;
}

C#

Top-level Statements

using static SplashKitSDK.SplashKit;
using SplashKitSDK;

OpenWindow("sprite-set-velocity", 600, 600);

LoadBitmap("player", "player-run.png");
Sprite playerSprite = CreateSprite(BitmapNamed("player"));
SpriteSetX(playerSprite, 300);
SpriteSetY(playerSprite, 300);

// Create vector for sprite's velocity
Vector2D vel = VectorTo(0.01,0);

while (!QuitRequested())
{
    ProcessEvents();

    // Set sprite velocity and update sprite
    SpriteSetVelocity(playerSprite, vel);
    UpdateSprite(playerSprite);

    ClearScreen(ColorBlack());
    DrawSprite(playerSprite);
    RefreshScreen();
}

CloseAllWindows();

Object-Oriented

using SplashKitSDK;

namespace SpriteSetVelocityExample
{
    public class Program
    {
        public static void Main()
        {
            SplashKit.OpenWindow("sprite-set-velocity", 600, 600);

            SplashKit.LoadBitmap("player", "player-run.png");
            Sprite playerSprite = SplashKit.CreateSprite(SplashKit.BitmapNamed("player"));
            SplashKit.SpriteSetX(playerSprite, 300);
            SplashKit.SpriteSetY(playerSprite, 300);

            // Create vector for sprite's velocity
            Vector2D vel = SplashKit.VectorTo(0.01, 0);

            while (!SplashKit.QuitRequested())
            {
                SplashKit.ProcessEvents();

                // Set sprite velocity and update sprite
                SplashKit.SpriteSetVelocity(playerSprite, vel);
                SplashKit.UpdateSprite(playerSprite);

                SplashKit.ClearScreen(Color.Black);
                SplashKit.DrawSprite(playerSprite);
                SplashKit.RefreshScreen();
            }

            SplashKit.CloseAllWindows();
        }
    }
}

Python

from splashkit import *

open_window("sprite-set-velocity", 600, 600)

load_bitmap("player", "player-run.png")
player_sprite = create_sprite(bitmap_named("player"))
sprite_set_x(player_sprite, 300)
sprite_set_y(player_sprite, 300)

# Create vector for sprite's velocity
vel = vector_to(0.01,0)

while(not quit_requested()):
    process_events()

    # Set sprite velocity and update sprite
    sprite_set_velocity(player_sprite, vel)
    update_sprite(player_sprite)

    clear_screen(color_black())
    draw_sprite(player_sprite)
    refresh_screen()

close_all_windows()

Output:

---

Sprite Set X  {</>}

Sets the X position of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Double	The new x location.

Signatures:

C++

void sprite_set_x(sprite s, double value)

C#

public void Sprite.X { set }
public static void SplashKit.SpriteSetX(Sprite s, double value);

Python

def sprite_set_x(s, value):

Pascal

procedure SpriteSetX(s: Sprite; value: Double)

Usage:  {</>}

See Code Examples

Example 1: Setting Sprite X-coordinate

Note

To test this example code you can download these Resources.

C++

#include "splashkit.h"

int main()
{
    open_window("sprite_set_x", 600, 600);

    load_bitmap("player", "player-run.png");
    sprite player_sprite = create_sprite(bitmap_named("player"));

    // Setting the x coordinate in refrence to the window
    sprite_set_x(player_sprite, 300);

    clear_screen(COLOR_BLACK);
    draw_sprite(player_sprite);
    refresh_screen();
    delay(5000);

    close_all_windows();

    return 0;
}

C#

Top-level Statements

using static SplashKitSDK.SplashKit;
using SplashKitSDK;

OpenWindow("sprite_set_x", 600, 600);

LoadBitmap("player", "player-run.png");
Sprite playerSprite = CreateSprite(BitmapNamed("player"));

// Setting the x coordinate in reference to the window
SpriteSetX(playerSprite, 300);

ClearScreen(ColorBlack());
DrawSprite(playerSprite);
RefreshScreen();
Delay(5000);

CloseAllWindows();

Object-Oriented

using SplashKitSDK;

namespace SpriteSetXExample
{
    public class Program
    {
        public static void Main()
        {
            SplashKit.OpenWindow("sprite_set_x", 600, 600);

            SplashKit.LoadBitmap("player", "player-run.png");
            Sprite playerSprite = SplashKit.CreateSprite(SplashKit.BitmapNamed("player"));

            // Setting the x coordinate in reference to the window
            SplashKit.SpriteSetX(playerSprite, 300);

            SplashKit.ClearScreen(Color.Black);
            SplashKit.DrawSprite(playerSprite);
            SplashKit.RefreshScreen();
            SplashKit.Delay(5000);

            SplashKit.CloseAllWindows();
        }
    }
}

Python

from splashkit import *

open_window("sprite_set_x", 600, 600)

load_bitmap("player", "player-run.png")
player_sprite = create_sprite(bitmap_named("player"))

# Setting the x coordinate in reference to the window
sprite_set_x(player_sprite, 300)

clear_screen(color_black())
draw_sprite(player_sprite)
refresh_screen()
delay(5000)

close_all_windows()

Output:

---

Sprite Set Y  {</>}

Sets the Y position of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
value	Double	The new sprite y.

Signatures:

C++

void sprite_set_y(sprite s, double value)

C#

public void Sprite.Y { set }
public static void SplashKit.SpriteSetY(Sprite s, double value);

Python

def sprite_set_y(s, value):

Pascal

procedure SpriteSetY(s: Sprite; value: Double)

Usage:  {</>}

See Code Examples

Example 1: Setting Sprite Y-coordinate

Note

To test this example code you can download these Resources.

C++

#include "splashkit.h"

int main()
{
    open_window("sprite_set_y", 600, 600);

    load_bitmap("player", "player-run.png");
    sprite player_sprite = create_sprite(bitmap_named("player"));

    // Setting the y coordinate in reference to the window
    sprite_set_y(player_sprite, 300);

    clear_screen(COLOR_BLACK);
    draw_sprite(player_sprite);
    refresh_screen();
    delay(5000);

    close_all_windows();

    return 0;
}

C#

Top-level Statements

using static SplashKitSDK.SplashKit;
using SplashKitSDK;

OpenWindow("sprite_set_y", 600, 600);

LoadBitmap("player", "player-run.png");
Sprite playerSprite = CreateSprite(BitmapNamed("player"));

// Setting the y coordinate in reference to the window
SpriteSetY(playerSprite, 300);

ClearScreen(ColorBlack());
DrawSprite(playerSprite);
RefreshScreen();
Delay(5000);

CloseAllWindows();

Object-Oriented

using SplashKitSDK;

public class Program
{
    public static void Main()
    {
        SplashKit.OpenWindow("sprite_set_y", 600, 600);

        SplashKit.LoadBitmap("player", "player-run.png");
        Sprite playerSprite = SplashKit.CreateSprite(SplashKit.BitmapNamed("player"));

        // Setting the x coordinate in reference to the window
        SplashKit.SpriteSetY(playerSprite, 300);

        SplashKit.ClearScreen(Color.Black);
        SplashKit.DrawSprite(playerSprite);
        SplashKit.RefreshScreen();
        SplashKit.Delay(5000);

        SplashKit.CloseAllWindows();
    }
}

Python

from splashkit import *

open_window("sprite_set_y", 600, 600)

load_bitmap("player", "player-run.png")
player_sprite = create_sprite(bitmap_named("player"))

# Setting the x coordinate in refrence to the window
sprite_set_y(player_sprite, 300)

clear_screen(color_black())
draw_sprite(player_sprite)
refresh_screen()
delay(5000)

close_all_windows()

Output:

---

Sprite Show Layer

Note

This function is overloaded. The following versions exist:

• Sprite Show Layer (s: sprite, name: string)
• Sprite Show Layer (s: sprite, id: int)

Sprite Show Layer

Show the specified layer of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to show the layer of.
name	String	The layer to show.

Return Type: Integer

Signatures:

C++

int sprite_show_layer(sprite s, const string &name)

C#

public int Sprite.ShowLayer(string name);
public static int SplashKit.SpriteShowLayer(Sprite s, string name);

Python

def sprite_show_layer_named(s, name):

Pascal

function SpriteShowLayer(s: Sprite; const name: String): Integer

---

Sprite Show Layer

Show the specified layer of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to show the layer of.
id	Integer	The index to show.

Return Type: Integer

Signatures:

C++

int sprite_show_layer(sprite s, int id)

C#

public int Sprite.ShowLayer(int id);
public static int SplashKit.SpriteShowLayer(Sprite s, int id);

Python

def sprite_show_layer(s, id):

Pascal

function SpriteShowLayer(s: Sprite; id: Integer): Integer

---

Sprite Speed

Returns the current speed (distance travelled per update) of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Double

Signatures:

C++

double sprite_speed(sprite s)

C#

public double Sprite.Speed { get }
public static double SplashKit.SpriteSpeed(Sprite s);

Python

def sprite_speed(s):

Pascal

function SpriteSpeed(s: Sprite): Double

---

Sprite Start Animation

Note

This function is overloaded. The following versions exist:

• Sprite Start Animation (s: sprite, named: string)
• Sprite Start Animation (s: sprite, named: string, with_sound: bool)
• Sprite Start Animation (s: sprite, idx: int)
• Sprite Start Animation (s: sprite, idx: int, with_sound: bool)

Sprite Start Animation

Start playing an animation from the sprite’s animation template. This will play a sound effect if the first cell of the animation has a sound.

Parameters:

Name	Type	Description
s	Sprite	The sprite to start the animation of.
named	String	The name of the animation to start from the animation script.

Signatures:

C++

void sprite_start_animation(sprite s, const string &named)

C#

public void Sprite.StartAnimation(string named);
public static void SplashKit.SpriteStartAnimation(Sprite s, string named);

Python

def sprite_start_animation_named(s, named):

Pascal

procedure SpriteStartAnimation(s: Sprite; const named: String)

---

Sprite Start Animation

Start playing an animation from the sprite’s animation template. The with_sound parameter determines whether to play a sound effect if the first cell of the animation has a sound.

Parameters:

Name	Type	Description
s	Sprite	The sprite to start the animation of.
named	String	The name of the animation to start from the animation script.
with_sound	Boolean	If false, the animation will not play associated sound effects when started.

Signatures:

C++

void sprite_start_animation(sprite s, const string &named, bool with_sound)

C#

public void Sprite.StartAnimation(string named, bool withSound);
public static void SplashKit.SpriteStartAnimation(Sprite s, string named, bool withSound);

Python

def sprite_start_animation_named_with_sound(s, named, with_sound):

Pascal

procedure SpriteStartAnimation(s: Sprite; const named: String; withSound: Boolean)

---

Sprite Start Animation

Start playing an animation from the sprite’s animation template. This will play a sound effect if the first cell of the animation has a sound.

Parameters:

Name	Type	Description
s	Sprite	The sprite to start the animation of.
idx	Integer	The index of the animation to start from the animation script.

Signatures:

C++

void sprite_start_animation(sprite s, int idx)

C#

public void Sprite.StartAnimation(int idx);
public static void SplashKit.SpriteStartAnimation(Sprite s, int idx);

Python

def sprite_start_animation(s, idx):

Pascal

procedure SpriteStartAnimation(s: Sprite; idx: Integer)

---

Sprite Start Animation

Start playing an animation from the sprite’s animation template. The with_sound parameter determines whether to play a sound effect if the first cell of the animation has a sound.

Parameters:

Name	Type	Description
s	Sprite	The sprite to start the animation of.
idx	Integer	The index of the animation to start from the animation script.
with_sound	Boolean	If false, the animation will not play associated sound effects when started.

Signatures:

C++

void sprite_start_animation(sprite s, int idx, bool with_sound)

C#

public void Sprite.StartAnimation(int idx, bool withSound);
public static void SplashKit.SpriteStartAnimation(Sprite s, int idx, bool withSound);

Python

def sprite_start_animation_with_sound(s, idx, with_sound):

Pascal

procedure SpriteStartAnimation(s: Sprite; idx: Integer; withSound: Boolean)

---

Sprite Stop Calling On Event

Removes an event handler from the sprite, stopping events from this sprite calling the indicated method.

Parameters:

Name	Type	Description
s	Sprite	The sprite to remove the handler from
handler	Sprite Event Handler	The function to remove from this sprites handlers

Signatures:

C++

void sprite_stop_calling_on_event(sprite s, sprite_event_handler *handler)

C#

public void Sprite.StopCallingOnEvent(SpriteEventHandler handler);
public static void SplashKit.SpriteStopCallingOnEvent(Sprite s, SpriteEventHandler handler);

Python

def sprite_stop_calling_on_event(s, handler):

Pascal

procedure SpriteStopCallingOnEvent(s: Sprite; handler: SpriteEventHandler)

---

Sprite Toggle Layer Visible

Note

This function is overloaded. The following versions exist:

• Sprite Toggle Layer Visible (s: sprite, name: string)
• Sprite Toggle Layer Visible (s: sprite, id: int)

Sprite Toggle Layer Visible

Toggle the visibility of the specified layer of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
name	String	The name of the layer to toggle.

Signatures:

C++

void sprite_toggle_layer_visible(sprite s, const string &name)

C#

public void Sprite.ToggleLayerVisible(string name);
public static void SplashKit.SpriteToggleLayerVisible(Sprite s, string name);

Python

def sprite_toggle_layer_visible_named(s, name):

Pascal

procedure SpriteToggleLayerVisible(s: Sprite; const name: String)

---

Sprite Toggle Layer Visible

Toggle the visibility of the specified layer of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to change.
id	Integer	The index of the layer to toggle.

Signatures:

C++

void sprite_toggle_layer_visible(sprite s, int id)

C#

public void Sprite.ToggleLayerVisible(int id);
public static void SplashKit.SpriteToggleLayerVisible(Sprite s, int id);

Python

def sprite_toggle_layer_visible(s, id):

Pascal

procedure SpriteToggleLayerVisible(s: Sprite; id: Integer)

---

Sprite Value

Returns the indicated value of the sprite

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
name	String	The name of the value to fetch.

Return Type: Float

Signatures:

C++

float sprite_value(sprite s, const string &name)

C#

public float Sprite.Value(string name);
public static float SplashKit.SpriteValue(Sprite s, string name);

Python

def sprite_value(s, name):

Pascal

function SpriteValue(s: Sprite; const name: String): Single

---

Sprite Value Count

Returns the number of sprite’s values.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Integer

Signatures:

C++

int sprite_value_count(sprite s)

C#

public int Sprite.ValueCount { get }
public static int SplashKit.SpriteValueCount(Sprite s);

Python

def sprite_value_count(s):

Pascal

function SpriteValueCount(s: Sprite): Integer

---

Sprite Velocity

Returns the current velocity of the sprite. When the sprite is updated (see Update Sprite) this vector_2d is used to move the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Vector 2d

Signatures:

C++

vector_2d sprite_velocity(sprite s)

C#

public Vector2D Sprite.Velocity { get }
public static Vector2D SplashKit.SpriteVelocity(Sprite s);

Python

def sprite_velocity(s):

Pascal

function SpriteVelocity(s: Sprite): Vector2D

---

Sprite Visible Index Of Layer

Note

This function is overloaded. The following versions exist:

• Sprite Visible Index Of Layer (s: sprite, name: string)
• Sprite Visible Index Of Layer (s: sprite, id: int)

Sprite Visible Index Of Layer

Returns the index (z-order) of the sprite’s layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
name	String	The name of the layer to get the z index of.

Return Type: Integer

Signatures:

C++

int sprite_visible_index_of_layer(sprite s, const string &name)

C#

public int Sprite.VisibleIndexOfLayer(string name);
public static int SplashKit.SpriteVisibleIndexOfLayer(Sprite s, string name);

Python

def sprite_visible_index_of_layer_named(s, name):

Pascal

function SpriteVisibleIndexOfLayer(s: Sprite; const name: String): Integer

---

Sprite Visible Index Of Layer

Returns the index (z-order) of the sprite’s layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
id	Integer	The index of the layer to get the z index of.

Return Type: Integer

Signatures:

C++

int sprite_visible_index_of_layer(sprite s, int id)

C#

public int Sprite.VisibleIndexOfLayer(int id);
public static int SplashKit.SpriteVisibleIndexOfLayer(Sprite s, int id);

Python

def sprite_visible_index_of_layer(s, id):

Pascal

function SpriteVisibleIndexOfLayer(s: Sprite; id: Integer): Integer

---

Sprite Visible Layer

Returns the index of the n’th (idx parameter) visible layer.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
idx	Integer	The index of the visible layer to fetch.

Return Type: Integer

Signatures:

C++

int sprite_visible_layer(sprite s, int idx)

C#

public int Sprite.VisibleLayer(int idx);
public static int SplashKit.SpriteVisibleLayer(Sprite s, int idx);

Python

def sprite_visible_layer(s, idx):

Pascal

function SpriteVisibleLayer(s: Sprite; idx: Integer): Integer

---

Sprite Visible Layer Count

Returns the number of layers that are currently visible for the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Integer

Signatures:

C++

int sprite_visible_layer_count(sprite s)

C#

public int Sprite.VisibleLayerCount { get }
public static int SplashKit.SpriteVisibleLayerCount(Sprite s);

Python

def sprite_visible_layer_count(s):

Pascal

function SpriteVisibleLayerCount(s: Sprite): Integer

---

Sprite Visible Layer Id

Returns the id of the layer at index idx that is currently visible. Index 0 is the background, with larger indexes moving toward the foreground. This returns -1 if there are no visible layers.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.
idx	Integer	The index of the visible layer.

Return Type: Integer

Signatures:

C++

int sprite_visible_layer_id(sprite s, int idx)

C#

public int Sprite.VisibleLayerIdAt(int idx);
public static int SplashKit.SpriteVisibleLayerId(Sprite s, int idx);

Python

def sprite_visible_layer_id(s, idx):

Pascal

function SpriteVisibleLayerId(s: Sprite; idx: Integer): Integer

---

Sprite Width

The current Width of the sprite (aligned to the X axis).

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Integer

Signatures:

C++

int sprite_width(sprite s)

C#

public int Sprite.Width { get }
public static int SplashKit.SpriteWidth(Sprite s);

Python

def sprite_width(s):

Pascal

function SpriteWidth(s: Sprite): Integer

---

Sprite X  {</>}

Returns the X position of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Double

Signatures:

C++

double sprite_x(sprite s)

C#

public double Sprite.X { get }
public static double SplashKit.SpriteX(Sprite s);

Python

def sprite_x(s):

Pascal

function SpriteX(s: Sprite): Double

Usage:  {</>}

See Code Examples

Example 1: Sprite x-coordinate

Note

To test this example code you can download these Resources.

C++

#include "splashkit.h"

int main()
{
    open_window("sprite_x", 600, 600);

    load_bitmap("player", "player-run.png");
    sprite player_sprite = create_sprite(bitmap_named("player"));

    // Setting the x coordinate in reference to the window
    sprite_set_x(player_sprite, 300);

    // Retrieve the x position
    double x_position = sprite_x(player_sprite);

    clear_screen(COLOR_BLACK);
    draw_sprite(player_sprite);
    draw_text("Sprite X: " + std::to_string((int)x_position), COLOR_WHITE, 10, 10);
    refresh_screen();
    delay(5000);

    close_all_windows();

    return 0;
}

C#

Top-level Statements

using SplashKitSDK;
using static SplashKitSDK.SplashKit;

OpenWindow("sprite_x", 600, 600);

LoadBitmap("player", "player-run.png");
Sprite playerSprite = CreateSprite(BitmapNamed("player"));

// Setting the x coordinate in reference to the window
SpriteSetX(playerSprite, 300);

// Retrieve the x position
double xPosition = SpriteX(playerSprite);

ClearScreen(ColorBlack());
DrawSprite(playerSprite);
DrawText("Sprite X: " + xPosition.ToString(), ColorWhite(), 10, 10);
RefreshScreen();
Delay(5000);

CloseAllWindows();

Object-Oriented

using SplashKitSDK;

namespace SpriteXExample
{
    public class Program
    {
        public static void Main()
        {
            SplashKit.OpenWindow("sprite_x", 600, 600);

            SplashKit.LoadBitmap("player", "player-run.png");
            Sprite playerSprite = SplashKit.CreateSprite(SplashKit.BitmapNamed("player"));

            // Setting the x coordinate in reference to the window
            playerSprite.X = 300;

            // Retrieve the x position
            double xPosition = SplashKit.SpriteX(playerSprite);

            SplashKit.ClearScreen(Color.Black);
            SplashKit.DrawSprite(playerSprite);
            SplashKit.DrawText("Sprite X: " + xPosition.ToString(), Color.White, 10, 10);
            SplashKit.RefreshScreen();
            SplashKit.Delay(5000);

            SplashKit.CloseAllWindows();
        }
    }
}

Python

from splashkit import *

open_window("sprite_x", 600, 600)

load_bitmap("player", "player-run.png")
player_sprite = create_sprite(bitmap_named("player"))

# Setting the x coordinate in reference to the window
sprite_set_x(player_sprite, 300)

# Retrieve the y position using sprite_x function
x_position = sprite_x(player_sprite)

clear_screen(color_black())
draw_sprite(player_sprite)
draw_text_no_font_no_size("Sprite X: " + str(int(x_position)), color_white(), 10, 10)
refresh_screen()
delay(5000)

close_all_windows()

Output:

---

Sprite Y  {</>}

Returns the Y position of the sprite.

Parameters:

Name	Type	Description
s	Sprite	The sprite to get the details from.

Return Type: Double

Signatures:

C++

double sprite_y(sprite s)

C#

public double Sprite.Y { get }
public static double SplashKit.SpriteY(Sprite s);

Python

def sprite_y(s):

Pascal

function SpriteY(s: Sprite): Double

Usage:  {</>}

See Code Examples

Example 1: Sprite y-coordinate

Note

To test this example code you can download these Resources.

C++

#include "splashkit.h"

int main()
{
    open_window("spriteY", 600, 600);

    load_bitmap("player", "player-run.png");
    sprite player_sprite = create_sprite(bitmap_named("player"));

    // Setting the x and y coordinate in reference to the window
    sprite_set_x(player_sprite, 300);
    sprite_set_y(player_sprite, 300);

    // Retrieve the y position
    double y_position = sprite_y(player_sprite);

    clear_screen(COLOR_BLACK);
    draw_sprite(player_sprite);
    draw_text("Sprite Y: " + std::to_string((int)y_position), COLOR_WHITE, 10, 10);
    refresh_screen();
    delay(5000);

    close_all_windows();

    return 0;
}

C#

Top-level Statements

using SplashKitSDK;
using static SplashKitSDK.SplashKit;

OpenWindow("spriteY", 600, 600);

LoadBitmap("player", "player-run.png");
Sprite playerSprite = CreateSprite(BitmapNamed("player"));

// Setting the x and y coordinate in reference to the window
SpriteSetX(playerSprite, 300);
SpriteSetY(playerSprite, 300);

// Retrieve the y position
double yPosition = SpriteY(playerSprite);

ClearScreen(ColorBlack());
DrawSprite(playerSprite);
DrawText("Sprite Y: " + yPosition.ToString(), ColorWhite(), 10, 10);
RefreshScreen();
Delay(5000);

CloseAllWindows();

Object-Oriented

using SplashKitSDK;

namespace SpriteYExample
{
    public class Program
    {
        public static void Main()
        {
            SplashKit.OpenWindow("spriteY", 600, 600);

            SplashKit.LoadBitmap("player", "player-run.png");
            Sprite playerSprite = SplashKit.CreateSprite(SplashKit.BitmapNamed("player"));

            // Setting the x and y coordinate in reference to the window
            playerSprite.X = 300;
            playerSprite.Y = 300;

            // Retrieve the y position
            double yPosition = SplashKit.SpriteY(playerSprite);

            SplashKit.ClearScreen(Color.Black);
            SplashKit.DrawSprite(playerSprite);
            SplashKit.DrawText("Sprite Y: " + yPosition.ToString(), Color.White, 10, 10);
            SplashKit.RefreshScreen();
            SplashKit.Delay(5000);

            SplashKit.CloseAllWindows();
        }
    }
}

Python

from splashkit import *

open_window("spriteY", 600, 600)

load_bitmap("player", "player-run.png")
player_sprite = create_sprite(bitmap_named("player"))

# Setting the x and y coordinate in reference to the window
sprite_set_x(player_sprite, 300)
sprite_set_y(player_sprite, 300)

# Retrieve the y position
y_position = sprite_y(player_sprite)

clear_screen(color_black())
draw_sprite(player_sprite)
draw_text_no_font_no_size("Sprite Y: " + str(y_position), color_white(), 10, 10)
refresh_screen()
delay(5000)

close_all_windows()

Output:

---

Stop Calling On Sprite Event

Removes an global event handler, stopping events calling the indicated void.

Parameters:

Name	Type	Description
handler	Sprite Event Handler	The function to remove from the list of sprite event handlers.

Signatures:

C++

void stop_calling_on_sprite_event(sprite_event_handler *handler)

C#

public static void SplashKit.StopCallingOnSpriteEvent(SpriteEventHandler handler);

Python

def stop_calling_on_sprite_event(handler):

Pascal

procedure StopCallingOnSpriteEvent(handler: SpriteEventHandler)

---

Update All Sprites

Note

This function is overloaded. The following versions exist:

• Update All Sprites ()
• Update All Sprites (pct: float)

Update All Sprites

Update all of the sprites in the current sprite pack.

Signatures:

C++

void update_all_sprites()

C#

public static void SplashKit.UpdateAllSprites();

Python

def update_all_sprites():

Pascal

procedure UpdateAllSprites()

---

Update All Sprites

Update all of the sprites in the current sprite pack, passing in a percentage value to indicate the percentage to update.

Parameters:

Name	Type	Description
pct	Float	The percentage of the update to apply.

Signatures:

C++

void update_all_sprites(float pct)

C#

public static void SplashKit.UpdateAllSprites(float pct);

Python

def update_all_sprites_percent(pct):

Pascal

procedure UpdateAllSprites(pct: Single)

---

Update Sprite

Note

This function is overloaded. The following versions exist:

• Update Sprite (s: sprite)
• Update Sprite (s: sprite, with_sound: bool)
• Update Sprite (s: sprite, pct: float)
• Update Sprite (s: sprite, pct: float, with_sound: bool)

Update Sprite

Update the position and animation details of the sprite. This will play a sound effect if the new cell of the animation has a sound.

Parameters:

Name	Type	Description
s	Sprite	The sprite to update.

Signatures:

C++

void update_sprite(sprite s)

C#

public void Sprite.Update();
public static void SplashKit.UpdateSprite(Sprite s);

Python

def update_sprite(s):

Pascal

procedure UpdateSprite(s: Sprite)

---

Update Sprite

Update the position and animation details of the sprite. This will play a sound effect if the new cell of the animation has a sound and with_sound is true.

Parameters:

Name	Type	Description
s	Sprite	The sprite to update
with_sound	Boolean	If false, animations will not play associated sound effects when updated.

Signatures:

C++

void update_sprite(sprite s, bool with_sound)

C#

public void Sprite.Update(bool withSound);
public static void SplashKit.UpdateSprite(Sprite s, bool withSound);

Python

def update_sprite_with_sound(s, with_sound):

Pascal

procedure UpdateSprite(s: Sprite; withSound: Boolean)

---

Update Sprite

Update the position and animation details of the sprite by a given percentage of a single unit of movement/animation. This will play a sound effect if the new cell of the animation has a sound.

Parameters:

Name	Type	Description
s	Sprite	The sprite to update.
pct	Float	The percent to update.

Signatures:

C++

void update_sprite(sprite s, float pct)

C#

public void Sprite.Update(float pct);
public static void SplashKit.UpdateSprite(Sprite s, float pct);

Python

def update_sprite_percent(s, pct):

Pascal

procedure UpdateSprite(s: Sprite; pct: Single)

---

Update Sprite

Update the position and animation details of the sprite by a given percentage of a single unit of movement/animation. This will play a sound effect if the new cell of the animation has a sound and with_sound is true.

Parameters:

Name	Type	Description
s	Sprite	The sprite to update.
pct	Float	The percent to update.
with_sound	Boolean	If false, animations will not play associated sound effects when updated.

Signatures:

C++

void update_sprite(sprite s, float pct, bool with_sound)

C#

public void Sprite.Update(float pct, bool withSound);
public static void SplashKit.UpdateSprite(Sprite s, float pct, bool withSound);

Python

def update_sprite_percent_with_sound(s, pct, with_sound):

Pascal

procedure UpdateSprite(s: Sprite; pct: Single; withSound: Boolean)

---

Update Sprite Animation

Note

This function is overloaded. The following versions exist:

• Update Sprite Animation (s: sprite)
• Update Sprite Animation (s: sprite, with_sound: bool)
• Update Sprite Animation (s: sprite, pct: float)
• Update Sprite Animation (s: sprite, pct: float, with_sound: bool)

Update Sprite Animation

Updates the animation details of the sprite. This will play a sound effect if the new cell of the animation has a sound.

Parameters:

Name	Type	Description
s	Sprite	The sprite to update.

Signatures:

C++

void update_sprite_animation(sprite s)

C#

public void Sprite.UpdateAnimation();
public static void SplashKit.UpdateSpriteAnimation(Sprite s);

Python

def update_sprite_animation(s):

Pascal

procedure UpdateSpriteAnimation(s: Sprite)

---

Update Sprite Animation

Update the animation details of the sprite. This will play a sound effect if the new cell of the animation has a sound and with_sound is true.

Parameters:

Name	Type	Description
s	Sprite	The sprite to update.
with_sound	Boolean	If false, animations will not play associated sound effects when updated.

Signatures:

C++

void update_sprite_animation(sprite s, bool with_sound)

C#

public void Sprite.UpdateAnimation(bool withSound);
public static void SplashKit.UpdateSpriteAnimation(Sprite s, bool withSound);

Python

def update_sprite_animation_with_sound(s, with_sound):

Pascal

procedure UpdateSpriteAnimation(s: Sprite; withSound: Boolean)

---

Update Sprite Animation

Update the animation details of the sprite by a given percentage of a single unit of movement/animation. This will play a sound effect if the new cell of the animation has a sound.

Parameters:

Name	Type	Description
s	Sprite	The sprite to update.
pct	Float	The percent to update.

Signatures:

C++

void update_sprite_animation(sprite s, float pct)

C#

public void Sprite.UpdateAnimation(float pct);
public static void SplashKit.UpdateSpriteAnimation(Sprite s, float pct);

Python

def update_sprite_animation_percent(s, pct):

Pascal

procedure UpdateSpriteAnimation(s: Sprite; pct: Single)

---

Update Sprite Animation

Update the position and animation details of the sprite by a given percentage of a single unit of movement/animation. This will play a sound effect if the new cell of the animation has a sound and with_sound is true.

Parameters:

Name	Type	Description
s	Sprite	The sprite to update.
pct	Float	The percent to update.
with_sound	Boolean	If false, animations will not play associated sound effects when updated.

Signatures:

C++

void update_sprite_animation(sprite s, float pct, bool with_sound)

C#

public void Sprite.UpdateAnimation(float pct, bool withSound);
public static void SplashKit.UpdateSpriteAnimation(Sprite s, float pct, bool withSound);

Python

def update_sprite_animation_percent_with_sound(s, pct, with_sound):

Pascal

procedure UpdateSpriteAnimation(s: Sprite; pct: Single; withSound: Boolean)

---

Vector From Center Sprite To Point

Returns a Vector 2d that is the difference in location from the center of the sprite s to the point pt.

Parameters:

Name	Type	Description
s	Sprite	The sprite that is at the start of the vector.
pt	Point 2d	The point that is at the end of the vector.

Return Type: Vector 2d

Signatures:

C++

vector_2d vector_from_center_sprite_to_point(sprite s, const point_2d &pt)

C#

public Vector2D Sprite.VectorTo(Point2D pt);
public static Vector2D SplashKit.VectorFromCenterSpriteToPoint(Sprite s, Point2D pt);

Python

def vector_from_center_sprite_to_point_point(s, pt):

Pascal

function VectorFromCenterSpriteToPoint(s: Sprite; const pt: Point2D): Vector2D

---

Vector From To

Returns a Vector 2d that is the difference in the position of two sprites (s1 and s2).

Parameters:

Name	Type	Description
s1	Sprite	The sprite that is at the start of the vector.
s2	Sprite	The sprite that is at the end of the vector.

Return Type: Vector 2d

Signatures:

C++

vector_2d vector_from_to(sprite s1, sprite s2)

C#

public Vector2D Sprite.VectorTo(Sprite s2);
public static Vector2D SplashKit.VectorFromTo(Sprite s1, Sprite s2);

Python

def vector_from_to(s1, s2):

Pascal

function VectorFromTo(s1: Sprite; s2: Sprite): Vector2D

---

Types

Collision Test Kind

This enumeration can be used to set the kind of collisions a sprite will check for.

C++

Constant	Description
PIXEL_COLLISIONS	The sprite will check for collisions with its collision bitmap.
AABB_COLLISIONS	The sprite will check for collisions with a bounding box around the sprite.

C#

Constant	Description
CollisionTestKind.PixelCollisions	The sprite will check for collisions with its collision bitmap.
CollisionTestKind.AabbCollisions	The sprite will check for collisions with a bounding box around the sprite.

Python

Constant	Description
CollisionTestKind.pixel_collisions	The sprite will check for collisions with its collision bitmap.
CollisionTestKind.aabb_collisions	The sprite will check for collisions with a bounding box around the sprite.

Pascal

Constant	Description
CollisionTestKind.PixelCollisions	The sprite will check for collisions with its collision bitmap.
CollisionTestKind.AabbCollisions	The sprite will check for collisions with a bounding box around the sprite.

---

Sprite

Sprites combine an image, with position and animation details. You can create a sprite using Create Sprite, draw it with Draw Sprite, move it using the Sprite Velocity with Update Sprite, and animate it using an Animation Script.

---

Sprite Event Handler

The sprite_event_handler function pointer is used when you want to register to receive events from a Sprite.

---

Sprite Event Kind

This enumeration contains a list of all of the different kinds of events that a Sprite can raise. When the event is raised the assocated sprite_event_kind value passed to the event handler to indicate the kind of event that has occurred.

C++

Constant	Description
SPRITE_ARRIVED_EVENT	The sprite has arrived at the end of a move
SPRITE_ANIMATION_ENDED_EVENT	The Sprite’s animation has ended.
SPRITE_TOUCHED_EVENT	The Sprite was touched
SPRITE_CLICKED_EVENT	The Sprite was touched

C#

Constant	Description
SpriteEventKind.SpriteArrivedEvent	The sprite has arrived at the end of a move
SpriteEventKind.SpriteAnimationEndedEvent	The Sprite’s animation has ended.
SpriteEventKind.SpriteTouchedEvent	The Sprite was touched
SpriteEventKind.SpriteClickedEvent	The Sprite was touched

Python

Constant	Description
SpriteEventKind.sprite_arrived_event	The sprite has arrived at the end of a move
SpriteEventKind.sprite_animation_ended_event	The Sprite’s animation has ended.
SpriteEventKind.sprite_touched_event	The Sprite was touched
SpriteEventKind.sprite_clicked_event	The Sprite was touched

Pascal

Constant	Description
SpriteEventKind.SpriteArrivedEvent	The sprite has arrived at the end of a move
SpriteEventKind.SpriteAnimationEndedEvent	The Sprite’s animation has ended.
SpriteEventKind.SpriteTouchedEvent	The Sprite was touched
SpriteEventKind.SpriteClickedEvent	The Sprite was touched

---

Sprite Float Function

The sprite single function is used with sprite packs to provide a procedure to be called for each of the Sprites in the sprite pack, where a float value is required.

---

Sprite Function

sprite_function is used with SpritePacks to provide a procedure to be called for each of the Sprites in the SpritePack.

---