src/lib/16_sprit.h

   1 /* Project 16 Source Code~\r
   2  * Copyright (C) 2012-2016 sparky4 & pngwen & andrius4669 & joncampbell123 & yakui-lover\r
   3  *\r
   4  * This file is part of Project 16.\r
   5  *\r
   6  * Project 16 is free software; you can redistribute it and/or modify\r
   7  * it under the terms of the GNU General Public License as published by\r
   8  * the Free Software Foundation; either version 3 of the License, or\r
   9  * (at your option) any later version.\r
  10  *\r
  11  * Project 16 is distributed in the hope that it will be useful,\r
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14  * GNU General Public License for more details.\r
  15  *\r
  16  * You should have received a copy of the GNU General Public License\r
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>, or\r
  18  * write to the Free Software Foundation, Inc., 51 Franklin Street,\r
  19  * Fifth Floor, Boston, MA 02110-1301 USA.\r
  20  *\r
  21  */\r
  22 #ifndef __16_SPRI__\r
  23 #define __16_SPRI__\r
  24 \r
  25 #include "src/lib/16_vrs.h"\r
  26 \r
  27 struct sprite\r
  28 {\r
  29         // VRS container from which we will extract animation and image data\r
  30         struct vrs_container *spritesheet;\r
  31         // Container for a vrl sprite\r
  32         struct vrl_container *sprite_vrl_cont;\r
  33         // Current sprite id\r
  34         int curr_spri_id;\r
  35         // Index of a current sprite in an animation sequence\r
  36         int curr_anim_spri;\r
  37         // Current animation sequence\r
  38         struct vrs_animation_list_entry_t *curr_anim_list;\r
  39         // Index of current animation in relevant VRS offsets table\r
  40         int curr_anim;\r
  41         // Delay in time units untill we should change sprite\r
  42         int delay;\r
  43         // Position of sprite on screen\r
  44         int x, y;\r
  45 };\r
  46 \r
  47 /* Retrive current animation name of sprite\r
  48 * In:\r
  49 * + struct sprite *spri - sprite to retrive current animation sequence name from\r
  50 * Out:\r
  51 * + char* - animation sequence name\r
  52 */\r
  53 char* get_curr_anim_name(struct sprite *spri);\r
  54 \r
  55 /* Change sprite's current animation to the one given by id\r
  56  * In:\r
  57  * struct sprite *spri - sprite to manipulate on\r
  58  * int id - id of a new animation sequence of th sprite\r
  59  * Out:\r
  60  * int - 0 on success, -1 on error\r
  61  */\r
  62 int set_anim_by_id(struct sprite *spri, int id);\r
  63 \r
  64 /* Animate sprite, triggering any events and changing indices if necessary\r
  65  * NB: if you want to change animation sequence after a specific sprite is shown, you should call animate_spri first\r
  66  * In:\r
  67  * + struct sprite *spri - sprite to animate\r
  68  */\r
  69 void animate_spri(struct sprite *spri, video_t *video);\r
  70 \r
  71 void print_anim_ids(struct sprite *spri);\r
  72 \r
  73 #endif\r