sprite_assign

Assigns one sprite to another sprite index.

Syntax:

sprite_assign(index, sprite);


Argument Description
index The index of the sprite to be copied to (ie: overwritten).
sprite The sprite to be copied from.


Returns: N/A


Description

This function takes two previously created (or included) sprite indexes, and copies the image from one to the other. In this way you can copy (or "clone") one sprite into another index. Note that you cannot copy to a game resource. You have to have created the sprite to be copied to previously using the sprite_add or sprite_duplicate functions.


Example:

if sprite_exists(global.Player_Sprite)
   {
   var t_spr = sprite_add("player.png", 16, true, true, 0, 0);
   sprite_assign(global.Player_Sprite, t_spr);
   sprite_delete(t_spr);
   }
else
   {
   global.Player_Sprite = sprite_add("player.png", 16, true, true, 0, 0);
   }

The above code checks to see if the global variable "Player_Sprite" contains a sprite and if it does it uses sprite_assign to change it for one that has been loaded from an external file. If it does not contain a sprite one is loaded and its index is stored in that variable.


Back: Sprites
Next: sprite_merge
© Copyright YoYo Games Ltd. 2018 All Rights Reserved