added global animation event 'unclick:any' to handle mouse release events
[rocksndiamonds.git] / src / anim.c
1 // ============================================================================
2 // Rocks'n'Diamonds - McDuffin Strikes Back!
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
5 //                  Holger Schemel
6 //                  info@artsoft.org
7 //                  http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
9 // anim.c
10 // ============================================================================
11
12 #include "libgame/libgame.h"
13
14 #include "anim.h"
15 #include "main.h"
16 #include "tools.h"
17 #include "files.h"
18 #include "events.h"
19 #include "screens.h"
20
21
22 #define DEBUG_ANIM_EVENTS               0
23
24
25 // values for global toon animation definition
26 #define NUM_GLOBAL_TOON_ANIMS           1
27 #define NUM_GLOBAL_TOON_PARTS           MAX_NUM_TOONS
28
29 // values for global animation definition (including toons)
30 #define NUM_GLOBAL_ANIMS_AND_TOONS      (NUM_GLOBAL_ANIMS +             \
31                                          NUM_GLOBAL_TOON_ANIMS)
32 #define NUM_GLOBAL_ANIM_PARTS_AND_TOONS MAX(NUM_GLOBAL_ANIM_PARTS_ALL,  \
33                                             NUM_GLOBAL_TOON_PARTS)
34
35 #define ANIM_CLASS_BIT_TITLE_INITIAL    0
36 #define ANIM_CLASS_BIT_TITLE            1
37 #define ANIM_CLASS_BIT_MAIN             2
38 #define ANIM_CLASS_BIT_SCORES           3
39 #define ANIM_CLASS_BIT_SUBMENU          4
40 #define ANIM_CLASS_BIT_MENU             5
41 #define ANIM_CLASS_BIT_TOONS            6
42 #define ANIM_CLASS_BIT_NO_TITLE         7
43
44 #define NUM_ANIM_CLASSES                8
45
46 #define ANIM_CLASS_NONE                 0
47 #define ANIM_CLASS_TITLE_INITIAL        (1 << ANIM_CLASS_BIT_TITLE_INITIAL)
48 #define ANIM_CLASS_TITLE                (1 << ANIM_CLASS_BIT_TITLE)
49 #define ANIM_CLASS_MAIN                 (1 << ANIM_CLASS_BIT_MAIN)
50 #define ANIM_CLASS_SCORES               (1 << ANIM_CLASS_BIT_SCORES)
51 #define ANIM_CLASS_SUBMENU              (1 << ANIM_CLASS_BIT_SUBMENU)
52 #define ANIM_CLASS_MENU                 (1 << ANIM_CLASS_BIT_MENU)
53 #define ANIM_CLASS_TOONS                (1 << ANIM_CLASS_BIT_TOONS)
54 #define ANIM_CLASS_NO_TITLE             (1 << ANIM_CLASS_BIT_NO_TITLE)
55
56 #define ANIM_CLASS_TOONS_SCORES         (ANIM_CLASS_TOONS       |       \
57                                          ANIM_CLASS_SCORES      |       \
58                                          ANIM_CLASS_NO_TITLE)
59
60 #define ANIM_CLASS_TOONS_MENU_MAIN      (ANIM_CLASS_TOONS       |       \
61                                          ANIM_CLASS_MENU        |       \
62                                          ANIM_CLASS_MAIN        |       \
63                                          ANIM_CLASS_NO_TITLE)
64
65 #define ANIM_CLASS_TOONS_MENU_SUBMENU   (ANIM_CLASS_TOONS       |       \
66                                          ANIM_CLASS_MENU        |       \
67                                          ANIM_CLASS_SUBMENU     |       \
68                                          ANIM_CLASS_NO_TITLE)
69
70 // values for global animation states
71 #define ANIM_STATE_INACTIVE             0
72 #define ANIM_STATE_RESTART              (1 << 0)
73 #define ANIM_STATE_WAITING              (1 << 1)
74 #define ANIM_STATE_RUNNING              (1 << 2)
75
76 // values for global animation control
77 #define ANIM_NO_ACTION                  0
78 #define ANIM_START                      1
79 #define ANIM_CONTINUE                   2
80 #define ANIM_STOP                       3
81
82
83 struct GlobalAnimPartControlInfo
84 {
85   int old_nr;           // position before mapping animation parts linearly
86   int old_anim_nr;      // position before mapping animations linearly
87
88   int nr;
89   int anim_nr;
90   int mode_nr;
91
92   boolean is_base;      // animation part is base/main/default animation part
93
94   int sound;
95   int music;
96   int graphic;
97
98   struct GraphicInfo graphic_info;
99   struct GraphicInfo control_info;
100
101   int viewport_x;
102   int viewport_y;
103   int viewport_width;
104   int viewport_height;
105
106   int x, y;
107   int step_xoffset, step_yoffset;
108
109   unsigned int initial_anim_sync_frame;
110   unsigned int step_delay, step_delay_value;
111
112   int init_delay_counter;
113   int anim_delay_counter;
114   int post_delay_counter;
115
116   boolean init_event_state;
117   boolean anim_event_state;
118
119   boolean triggered;
120   boolean clickable;
121   boolean clicked;
122
123   int drawing_stage;
124
125   int state;
126   int last_anim_status;
127 };
128
129 struct GlobalAnimMainControlInfo
130 {
131   struct GlobalAnimPartControlInfo base;
132   struct GlobalAnimPartControlInfo part[NUM_GLOBAL_ANIM_PARTS_AND_TOONS];
133
134   int nr;
135   int mode_nr;
136
137   struct GraphicInfo control_info;
138
139   int num_parts;        // number of animation parts, but without base part
140   int num_parts_all;    // number of animation parts, including base part
141   int part_counter;
142   int active_part_nr;
143
144   boolean has_base;     // animation has base/main/default animation part
145
146   int last_x, last_y;
147
148   int init_delay_counter;
149
150   int state;
151
152   int last_state, last_active_part_nr;
153 };
154
155 struct GlobalAnimControlInfo
156 {
157   struct GlobalAnimMainControlInfo anim[NUM_GLOBAL_ANIMS_AND_TOONS];
158
159   int nr;
160   int num_anims;
161 };
162
163 struct GameModeAnimClass
164 {
165   int game_mode;
166   int class;
167 } game_mode_anim_classes_list[] =
168 {
169   { GAME_MODE_TITLE_INITIAL_1,          ANIM_CLASS_TITLE_INITIAL        },
170   { GAME_MODE_TITLE_INITIAL_2,          ANIM_CLASS_TITLE_INITIAL        },
171   { GAME_MODE_TITLE_INITIAL_3,          ANIM_CLASS_TITLE_INITIAL        },
172   { GAME_MODE_TITLE_INITIAL_4,          ANIM_CLASS_TITLE_INITIAL        },
173   { GAME_MODE_TITLE_INITIAL_5,          ANIM_CLASS_TITLE_INITIAL        },
174   { GAME_MODE_TITLE_1,                  ANIM_CLASS_TITLE                },
175   { GAME_MODE_TITLE_2,                  ANIM_CLASS_TITLE                },
176   { GAME_MODE_TITLE_3,                  ANIM_CLASS_TITLE                },
177   { GAME_MODE_TITLE_4,                  ANIM_CLASS_TITLE                },
178   { GAME_MODE_TITLE_5,                  ANIM_CLASS_TITLE                },
179   { GAME_MODE_LEVELS,                   ANIM_CLASS_TOONS_MENU_SUBMENU   },
180   { GAME_MODE_LEVELNR,                  ANIM_CLASS_TOONS_MENU_SUBMENU   },
181   { GAME_MODE_INFO,                     ANIM_CLASS_TOONS_MENU_SUBMENU   },
182   { GAME_MODE_SETUP,                    ANIM_CLASS_TOONS_MENU_SUBMENU   },
183   { GAME_MODE_PSEUDO_MAINONLY,          ANIM_CLASS_TOONS_MENU_MAIN      },
184   { GAME_MODE_PSEUDO_TYPENAME,          ANIM_CLASS_TOONS_MENU_MAIN      },
185   { GAME_MODE_PSEUDO_SCORESOLD,         ANIM_CLASS_TOONS_SCORES         },
186   { GAME_MODE_PSEUDO_SCORESNEW,         ANIM_CLASS_TOONS_SCORES         },
187   { GAME_MODE_EDITOR,                   ANIM_CLASS_NO_TITLE             },
188   { GAME_MODE_PLAYING,                  ANIM_CLASS_NO_TITLE             },
189
190   { -1,                                 -1                              }
191 };
192
193 struct AnimClassGameMode
194 {
195   int class_bit;
196   int game_mode;
197 } anim_class_game_modes_list[] =
198 {
199   { ANIM_CLASS_BIT_TITLE_INITIAL,       GAME_MODE_TITLE_INITIAL         },
200   { ANIM_CLASS_BIT_TITLE,               GAME_MODE_TITLE                 },
201   { ANIM_CLASS_BIT_MAIN,                GAME_MODE_MAIN                  },
202   { ANIM_CLASS_BIT_SCORES,              GAME_MODE_SCORES                },
203   { ANIM_CLASS_BIT_SUBMENU,             GAME_MODE_PSEUDO_SUBMENU        },
204   { ANIM_CLASS_BIT_MENU,                GAME_MODE_PSEUDO_MENU           },
205   { ANIM_CLASS_BIT_TOONS,               GAME_MODE_PSEUDO_TOONS          },
206   { ANIM_CLASS_BIT_NO_TITLE,            GAME_MODE_PSEUDO_NO_TITLE       },
207
208   { -1,                                 -1                              }
209 };
210
211 // forward declaration for internal use
212 static boolean DoGlobalAnim_EventAction(struct GlobalAnimPartControlInfo *);
213 static void HandleGlobalAnim(int, int);
214 static void DoAnimationExt(void);
215 static void ResetGlobalAnim_Clickable(void);
216 static void ResetGlobalAnim_Clicked(void);
217
218 static struct GlobalAnimControlInfo global_anim_ctrl[NUM_GAME_MODES];
219
220 static unsigned int anim_sync_frame = 0;
221
222 static int game_mode_anim_classes[NUM_GAME_MODES];
223 static int anim_class_game_modes[NUM_ANIM_CLASSES];
224
225 static int anim_status_last_before_fading = GAME_MODE_DEFAULT;
226 static int anim_status_last = GAME_MODE_DEFAULT;
227 static int anim_classes_last = ANIM_CLASS_NONE;
228
229 static boolean drawing_to_fading_buffer = FALSE;
230
231
232 // ============================================================================
233 // generic animation frame calculation
234 // ============================================================================
235
236 int getAnimationFrame(int num_frames, int delay, int mode, int start_frame,
237                       int sync_frame)
238 {
239   int frame = 0;
240
241   sync_frame += start_frame * delay;
242
243   if (mode & ANIM_LOOP)                 // looping animation
244   {
245     frame = (sync_frame % (delay * num_frames)) / delay;
246   }
247   else if (mode & ANIM_LINEAR)          // linear (non-looping) animation
248   {
249     frame = sync_frame / delay;
250
251     if (frame > num_frames - 1)
252       frame = num_frames - 1;
253   }
254   else if (mode & ANIM_PINGPONG)        // oscillate (border frames once)
255   {
256     int max_anim_frames = (num_frames > 1 ? 2 * num_frames - 2 : 1);
257
258     frame = (sync_frame % (delay * max_anim_frames)) / delay;
259     frame = (frame < num_frames ? frame : max_anim_frames - frame);
260   }
261   else if (mode & ANIM_PINGPONG2)       // oscillate (border frames twice)
262   {
263     int max_anim_frames = 2 * num_frames;
264
265     frame = (sync_frame % (delay * max_anim_frames)) / delay;
266     frame = (frame < num_frames ? frame : max_anim_frames - frame - 1);
267   }
268   else if (mode & ANIM_RANDOM)          // play frames in random order
269   {
270     // note: expect different frames for the same delay cycle!
271
272     if (gfx.anim_random_frame < 0)
273       frame = GetSimpleRandom(num_frames);
274     else
275       frame = gfx.anim_random_frame % num_frames;
276   }
277   else if (mode & (ANIM_CE_VALUE | ANIM_CE_SCORE | ANIM_CE_DELAY))
278   {
279     frame = sync_frame % num_frames;
280   }
281
282   if (mode & ANIM_REVERSE)              // use reverse animation direction
283     frame = num_frames - frame - 1;
284
285   return frame;
286 }
287
288
289 // ============================================================================
290 // global animation functions
291 // ============================================================================
292
293 static int getGlobalAnimationPart(struct GlobalAnimMainControlInfo *anim)
294 {
295   struct GraphicInfo *c = &anim->control_info;
296   int last_anim_random_frame = gfx.anim_random_frame;
297   int part_nr;
298
299   gfx.anim_random_frame = -1;   // (use simple, ad-hoc random numbers)
300
301   part_nr = getAnimationFrame(anim->num_parts, 1,
302                               c->anim_mode, c->anim_start_frame,
303                               anim->part_counter);
304
305   gfx.anim_random_frame = last_anim_random_frame;
306
307   return part_nr;
308 }
309
310 static int compareGlobalAnimPartControlInfo(const void *obj1, const void *obj2)
311 {
312   const struct GlobalAnimPartControlInfo *o1 =
313     (struct GlobalAnimPartControlInfo *)obj1;
314   const struct GlobalAnimPartControlInfo *o2 =
315     (struct GlobalAnimPartControlInfo *)obj2;
316   int compare_result;
317
318   if (o1->control_info.draw_order != o2->control_info.draw_order)
319     compare_result = o1->control_info.draw_order - o2->control_info.draw_order;
320   else
321     compare_result = o1->nr - o2->nr;
322
323   return compare_result;
324 }
325
326 static int compareGlobalAnimMainControlInfo(const void *obj1, const void *obj2)
327 {
328   const struct GlobalAnimMainControlInfo *o1 =
329     (struct GlobalAnimMainControlInfo *)obj1;
330   const struct GlobalAnimMainControlInfo *o2 =
331     (struct GlobalAnimMainControlInfo *)obj2;
332   int compare_result;
333
334   if (o1->control_info.draw_order != o2->control_info.draw_order)
335     compare_result = o1->control_info.draw_order - o2->control_info.draw_order;
336   else
337     compare_result = o1->nr - o2->nr;
338
339   return compare_result;
340 }
341
342 static void InitToonControls(void)
343 {
344   int mode_nr_toons = GAME_MODE_PSEUDO_TOONS;
345   struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr_toons];
346   struct GlobalAnimMainControlInfo *anim = &ctrl->anim[ctrl->num_anims];
347   int mode_nr, anim_nr, part_nr;
348   int control = IMG_INTERNAL_GLOBAL_TOON_DEFAULT;
349   int num_toons = MAX_NUM_TOONS;
350   int i;
351
352   if (global.num_toons >= 0 && global.num_toons < MAX_NUM_TOONS)
353     num_toons = global.num_toons;
354
355   mode_nr = mode_nr_toons;
356   anim_nr = ctrl->num_anims;
357
358   anim->nr = anim_nr;
359   anim->mode_nr = mode_nr;
360   anim->control_info = graphic_info[control];
361
362   anim->num_parts = 0;
363   anim->num_parts_all = 0;
364   anim->part_counter = 0;
365   anim->active_part_nr = 0;
366
367   anim->has_base = FALSE;
368
369   anim->last_x = POS_OFFSCREEN;
370   anim->last_y = POS_OFFSCREEN;
371
372   anim->init_delay_counter = 0;
373
374   anim->state = ANIM_STATE_INACTIVE;
375
376   part_nr = 0;
377
378   for (i = 0; i < num_toons; i++)
379   {
380     struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
381     int sound = SND_UNDEFINED;
382     int music = MUS_UNDEFINED;
383     int graphic = IMG_TOON_1 + i;
384     int control = graphic;
385
386     part->nr = part_nr;
387     part->anim_nr = anim_nr;
388     part->mode_nr = mode_nr;
389
390     part->is_base = FALSE;
391
392     part->sound = sound;
393     part->music = music;
394     part->graphic = graphic;
395
396     part->graphic_info = graphic_info[graphic];
397     part->control_info = graphic_info[control];
398
399     part->graphic_info.anim_delay *= part->graphic_info.step_delay;
400
401     part->control_info.init_delay_fixed = 0;
402     part->control_info.init_delay_random = 150;
403
404     part->control_info.x = ARG_UNDEFINED_VALUE;
405     part->control_info.y = ARG_UNDEFINED_VALUE;
406
407     part->initial_anim_sync_frame = 0;
408
409     part->step_delay = 0;
410     part->step_delay_value = graphic_info[control].step_delay;
411
412     part->state = ANIM_STATE_INACTIVE;
413     part->last_anim_status = -1;
414
415     anim->num_parts++;
416     anim->num_parts_all++;
417
418     part_nr++;
419   }
420
421   ctrl->num_anims++;
422 }
423
424 static void InitGlobalAnimControls(void)
425 {
426   int i, m, a, p;
427   int mode_nr, anim_nr, part_nr;
428   int sound, music, graphic, control;
429
430   anim_sync_frame = 0;
431
432   for (m = 0; m < NUM_GAME_MODES; m++)
433   {
434     mode_nr = m;
435
436     struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr];
437
438     ctrl->nr = mode_nr;
439     ctrl->num_anims = 0;
440
441     anim_nr = 0;
442
443     for (a = 0; a < NUM_GLOBAL_ANIMS; a++)
444     {
445       struct GlobalAnimMainControlInfo *anim = &ctrl->anim[anim_nr];
446       int ctrl_id = GLOBAL_ANIM_ID_CONTROL_FIRST + a;
447
448       control = global_anim_info[ctrl_id].graphic[GLOBAL_ANIM_ID_PART_BASE][m];
449
450       // if no base animation parameters defined, use default values
451       if (control == IMG_UNDEFINED)
452         control = IMG_INTERNAL_GLOBAL_ANIM_DEFAULT;
453
454       anim->nr = anim_nr;
455       anim->mode_nr = mode_nr;
456       anim->control_info = graphic_info[control];
457
458       anim->num_parts = 0;
459       anim->num_parts_all = 0;
460       anim->part_counter = 0;
461       anim->active_part_nr = 0;
462
463       anim->has_base = FALSE;
464
465       anim->last_x = POS_OFFSCREEN;
466       anim->last_y = POS_OFFSCREEN;
467
468       anim->init_delay_counter = 0;
469
470       anim->state = ANIM_STATE_INACTIVE;
471
472       part_nr = 0;
473
474       for (p = 0; p < NUM_GLOBAL_ANIM_PARTS_ALL; p++)
475       {
476         struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
477
478         sound   = global_anim_info[a].sound[p][m];
479         music   = global_anim_info[a].music[p][m];
480         graphic = global_anim_info[a].graphic[p][m];
481         control = global_anim_info[ctrl_id].graphic[p][m];
482
483         if (graphic == IMG_UNDEFINED || graphic_info[graphic].bitmap == NULL ||
484             control == IMG_UNDEFINED)
485           continue;
486
487 #if 0
488         printf("::: mode == %d, anim = %d, part = %d [%d, %d, %d] [%d]\n",
489                m, a, p, mode_nr, anim_nr, part_nr, control);
490 #endif
491
492 #if 0
493         printf("::: mode == %d, anim = %d, part = %d [%d, %d, %d] [%d]\n",
494                m, a, p, mode_nr, anim_nr, part_nr, sound);
495 #endif
496
497         part->old_nr = p;
498         part->old_anim_nr = a;
499
500         part->nr = part_nr;
501         part->anim_nr = anim_nr;
502         part->mode_nr = mode_nr;
503
504         part->sound = sound;
505         part->music = music;
506         part->graphic = graphic;
507
508         part->graphic_info = graphic_info[graphic];
509         part->control_info = graphic_info[control];
510
511         part->initial_anim_sync_frame = 0;
512
513         part->step_delay = 0;
514         part->step_delay_value = graphic_info[control].step_delay;
515
516         part->state = ANIM_STATE_INACTIVE;
517         part->last_anim_status = -1;
518
519         anim->num_parts_all++;
520
521         if (p < GLOBAL_ANIM_ID_PART_BASE)
522         {
523           part->is_base = FALSE;
524
525           anim->num_parts++;
526           part_nr++;
527         }
528         else
529         {
530           part->is_base = TRUE;
531
532           anim->base = *part;
533           anim->has_base = TRUE;
534         }
535       }
536
537       if (anim->num_parts > 0 || anim->has_base)
538       {
539         ctrl->num_anims++;
540         anim_nr++;
541       }
542     }
543   }
544
545   InitToonControls();
546
547   // sort all animations according to draw_order and animation number
548   for (m = 0; m < NUM_GAME_MODES; m++)
549   {
550     struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[m];
551
552     // sort all main animations for this game mode
553     qsort(ctrl->anim, ctrl->num_anims,
554           sizeof(struct GlobalAnimMainControlInfo),
555           compareGlobalAnimMainControlInfo);
556
557     for (a = 0; a < ctrl->num_anims; a++)
558     {
559       struct GlobalAnimMainControlInfo *anim = &ctrl->anim[a];
560
561       // sort all animation parts for this main animation
562       qsort(anim->part, anim->num_parts,
563             sizeof(struct GlobalAnimPartControlInfo),
564             compareGlobalAnimPartControlInfo);
565     }
566   }
567
568   for (i = 0; i < NUM_GAME_MODES; i++)
569     game_mode_anim_classes[i] = ANIM_CLASS_NONE;
570   for (i = 0; game_mode_anim_classes_list[i].game_mode != -1; i++)
571     game_mode_anim_classes[game_mode_anim_classes_list[i].game_mode] =
572       game_mode_anim_classes_list[i].class;
573
574   for (i = 0; i < NUM_ANIM_CLASSES; i++)
575     anim_class_game_modes[i] = GAME_MODE_DEFAULT;
576   for (i = 0; anim_class_game_modes_list[i].game_mode != -1; i++)
577     anim_class_game_modes[anim_class_game_modes_list[i].class_bit] =
578       anim_class_game_modes_list[i].game_mode;
579
580   anim_status_last_before_fading = GAME_MODE_LOADING;
581   anim_status_last = GAME_MODE_LOADING;
582   anim_classes_last = ANIM_CLASS_NONE;
583 }
584
585 void InitGlobalAnimations(void)
586 {
587   InitGlobalAnimControls();
588 }
589
590 static void DrawGlobalAnimationsExt(int drawing_target, int drawing_stage)
591 {
592   Bitmap *fade_bitmap =
593     (drawing_target == DRAW_TO_FADE_SOURCE ? gfx.fade_bitmap_source :
594      drawing_target == DRAW_TO_FADE_TARGET ? gfx.fade_bitmap_target : NULL);
595   int game_mode_anim_action[NUM_GAME_MODES];
596   int mode_nr;
597
598   if (!setup.toons)
599     return;
600
601   if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_1 &&
602       drawing_target == DRAW_TO_SCREEN)
603     DoAnimationExt();
604
605   // always start with reliable default values (no animation actions)
606   for (mode_nr = 0; mode_nr < NUM_GAME_MODES; mode_nr++)
607     game_mode_anim_action[mode_nr] = ANIM_NO_ACTION;
608
609   if (global.anim_status != anim_status_last)
610   {
611     boolean before_fading = (global.anim_status == GAME_MODE_PSEUDO_FADING);
612     boolean after_fading  = (anim_status_last   == GAME_MODE_PSEUDO_FADING);
613     int anim_classes_next = game_mode_anim_classes[global.anim_status_next];
614     int i;
615
616     if (drawing_target == DRAW_TO_FADE_TARGET)
617       after_fading = TRUE;
618
619     // special case: changing from/to this screen is done without fading
620     if (global.anim_status == GAME_MODE_PSEUDO_TYPENAME ||
621         anim_status_last   == GAME_MODE_PSEUDO_TYPENAME)
622       after_fading = TRUE;
623
624     // ---------- part 1 ------------------------------------------------------
625     // start or stop global animations by change of game mode
626     // (special handling of animations for "current screen" and "all screens")
627
628     if (global.anim_status_next != anim_status_last_before_fading)
629     {
630       // stop animations for last screen before fading to new screen
631       game_mode_anim_action[anim_status_last] = ANIM_STOP;
632
633       // start animations for current screen after fading to new screen
634       game_mode_anim_action[global.anim_status] = ANIM_START;
635     }
636
637     // start animations for all screens after loading new artwork set
638     if (anim_status_last == GAME_MODE_LOADING)
639       game_mode_anim_action[GAME_MODE_DEFAULT] = ANIM_START;
640
641     // ---------- part 2 ------------------------------------------------------
642     // start or stop global animations by change of animation class
643     // (generic handling of animations for "class of screens")
644
645     for (i = 0; i < NUM_ANIM_CLASSES; i++)
646     {
647       int anim_class_check = (1 << i);
648       int anim_class_game_mode = anim_class_game_modes[i];
649       int anim_class_last = anim_classes_last & anim_class_check;
650       int anim_class_next = anim_classes_next & anim_class_check;
651
652       // stop animations for changed screen class before fading to new screen
653       if (before_fading && anim_class_last && !anim_class_next)
654         game_mode_anim_action[anim_class_game_mode] = ANIM_STOP;
655
656       // start animations for changed screen class after fading to new screen
657       if (after_fading && !anim_class_last && anim_class_next)
658         game_mode_anim_action[anim_class_game_mode] = ANIM_START;
659     }
660
661     if (drawing_target == DRAW_TO_SCREEN)
662     {
663       if (after_fading)
664       {
665         anim_classes_last = anim_classes_next;
666         anim_status_last_before_fading = global.anim_status;
667       }
668
669       anim_status_last = global.anim_status;
670
671       // start or stop animations determined to be started or stopped above
672       for (mode_nr = 0; mode_nr < NUM_GAME_MODES; mode_nr++)
673         if (game_mode_anim_action[mode_nr] != ANIM_NO_ACTION)
674           HandleGlobalAnim(game_mode_anim_action[mode_nr], mode_nr);
675     }
676     else if (drawing_target == DRAW_TO_FADE_TARGET)
677     {
678       drawing_to_fading_buffer = TRUE;
679
680       // start animations determined to be (temporary) started above
681       for (mode_nr = 0; mode_nr < NUM_GAME_MODES; mode_nr++)
682         if (game_mode_anim_action[mode_nr] == ANIM_START)
683           HandleGlobalAnim(ANIM_START, mode_nr);
684     }
685   }
686
687   if (global.anim_status == GAME_MODE_LOADING)
688     return;
689
690   for (mode_nr = 0; mode_nr < NUM_GAME_MODES; mode_nr++)
691   {
692     struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr];
693     int anim_nr;
694
695     // when preparing source fading buffer, only draw animations to be stopped
696     if (drawing_target == DRAW_TO_FADE_SOURCE &&
697         game_mode_anim_action[mode_nr] != ANIM_STOP)
698       continue;
699
700     // when preparing target fading buffer, only draw animations to be started
701     if (drawing_target == DRAW_TO_FADE_TARGET &&
702         game_mode_anim_action[mode_nr] != ANIM_START)
703       continue;
704
705 #if 0
706     if (mode_nr != GFX_SPECIAL_ARG_DEFAULT &&
707         mode_nr != game_status)
708       continue;
709 #endif
710
711     for (anim_nr = 0; anim_nr < ctrl->num_anims; anim_nr++)
712     {
713       struct GlobalAnimMainControlInfo *anim = &ctrl->anim[anim_nr];
714       struct GraphicInfo *c = &anim->control_info;
715       int part_first, part_last;
716       int part_nr;
717
718       if (!(anim->state & ANIM_STATE_RUNNING))
719         continue;
720
721       part_first = part_last = anim->active_part_nr;
722
723       if (c->anim_mode & ANIM_ALL || anim->num_parts == 0)
724       {
725         int num_parts = anim->num_parts + (anim->has_base ? 1 : 0);
726
727         part_first = 0;
728         part_last = num_parts - 1;
729       }
730
731       for (part_nr = part_first; part_nr <= part_last; part_nr++)
732       {
733         struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
734         struct GraphicInfo *g = &part->graphic_info;
735         Bitmap *src_bitmap;
736         int src_x, src_y;
737         int width  = g->width;
738         int height = g->height;
739         int dst_x = part->x;
740         int dst_y = part->y;
741         int cut_x = 0;
742         int cut_y = 0;
743         int sync_frame;
744         int frame;
745         void (*blit_bitmap)(Bitmap *, Bitmap *, int, int, int, int, int, int) =
746           (g->draw_masked ? BlitBitmapMasked : BlitBitmap);
747         void (*blit_screen)(Bitmap *, int, int, int, int, int, int) =
748           (g->draw_masked ? BlitToScreenMasked : BlitToScreen);
749
750         if (!(part->state & ANIM_STATE_RUNNING))
751           continue;
752
753         if (part->drawing_stage != drawing_stage)
754           continue;
755
756         if (part->x < 0)
757         {
758           dst_x = 0;
759           width += part->x;
760           cut_x = -part->x;
761         }
762         else if (part->x > part->viewport_width - g->width)
763           width -= (part->x - (part->viewport_width - g->width));
764
765         if (part->y < 0)
766         {
767           dst_y = 0;
768           height += part->y;
769           cut_y = -part->y;
770         }
771         else if (part->y > part->viewport_height - g->height)
772           height -= (part->y - (part->viewport_height - g->height));
773
774         if (width <= 0 || height <= 0)
775           continue;
776
777         dst_x += part->viewport_x;
778         dst_y += part->viewport_y;
779
780         sync_frame = anim_sync_frame - part->initial_anim_sync_frame;
781         frame = getAnimationFrame(g->anim_frames, g->anim_delay,
782                                   g->anim_mode, g->anim_start_frame,
783                                   sync_frame);
784
785         getFixedGraphicSource(part->graphic, frame, &src_bitmap,
786                               &src_x, &src_y);
787
788         src_x += cut_x;
789         src_y += cut_y;
790
791         if (drawing_target == DRAW_TO_SCREEN)
792           blit_screen(src_bitmap, src_x, src_y, width, height,
793                       dst_x, dst_y);
794         else
795           blit_bitmap(src_bitmap, fade_bitmap, src_x, src_y, width, height,
796                       dst_x, dst_y);
797       }
798     }
799   }
800
801   if (drawing_target == DRAW_TO_FADE_TARGET)
802   {
803     // stop animations determined to be (temporary) started above
804     for (mode_nr = 0; mode_nr < NUM_GAME_MODES; mode_nr++)
805       if (game_mode_anim_action[mode_nr] == ANIM_START)
806         HandleGlobalAnim(ANIM_STOP, mode_nr);
807
808     drawing_to_fading_buffer = FALSE;
809   }
810 }
811
812 void DrawGlobalAnimations(int drawing_target, int drawing_stage)
813 {
814   if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_1)
815     ResetGlobalAnim_Clickable();
816
817   DrawGlobalAnimationsExt(drawing_target, drawing_stage);
818
819   if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_2)
820     ResetGlobalAnim_Clicked();
821 }
822
823 static boolean SetGlobalAnimPart_Viewport(struct GlobalAnimPartControlInfo *part)
824 {
825   int viewport_x;
826   int viewport_y;
827   int viewport_width;
828   int viewport_height;
829   boolean changed = FALSE;
830
831   if (part->last_anim_status == global.anim_status)
832     return FALSE;
833
834   part->last_anim_status = global.anim_status;
835
836   part->drawing_stage = DRAW_GLOBAL_ANIM_STAGE_1;
837
838   if (part->control_info.class == get_hash_from_key("window") ||
839       part->control_info.class == get_hash_from_key("border"))
840   {
841     viewport_x = 0;
842     viewport_y = 0;
843     viewport_width  = WIN_XSIZE;
844     viewport_height = WIN_YSIZE;
845
846     part->drawing_stage = DRAW_GLOBAL_ANIM_STAGE_2;
847   }
848   else if (part->control_info.class == get_hash_from_key("door_1"))
849   {
850     viewport_x = DX;
851     viewport_y = DY;
852     viewport_width  = DXSIZE;
853     viewport_height = DYSIZE;
854   }
855   else if (part->control_info.class == get_hash_from_key("door_2"))
856   {
857     if (part->mode_nr == GAME_MODE_EDITOR)
858     {
859       viewport_x = EX;
860       viewport_y = EY;
861       viewport_width  = EXSIZE;
862       viewport_height = EYSIZE;
863     }
864     else
865     {
866       viewport_x = VX;
867       viewport_y = VY;
868       viewport_width  = VXSIZE;
869       viewport_height = VYSIZE;
870     }
871   }
872   else          // default: "playfield"
873   {
874     viewport_x = REAL_SX;
875     viewport_y = REAL_SY;
876     viewport_width  = FULL_SXSIZE;
877     viewport_height = FULL_SYSIZE;
878   }
879
880   if (viewport_x != part->viewport_x ||
881       viewport_y != part->viewport_y ||
882       viewport_width  != part->viewport_width ||
883       viewport_height != part->viewport_height)
884   {
885     part->viewport_x = viewport_x;
886     part->viewport_y = viewport_y;
887     part->viewport_width  = viewport_width;
888     part->viewport_height = viewport_height;
889
890     changed = TRUE;
891   }
892
893   return changed;
894 }
895
896 static void PlayGlobalAnimSound(struct GlobalAnimPartControlInfo *part)
897 {
898   int sound = part->sound;
899
900   if (sound == SND_UNDEFINED)
901     return;
902
903   if ((!setup.sound_simple && !IS_LOOP_SOUND(sound)) ||
904       (!setup.sound_loops && IS_LOOP_SOUND(sound)))
905     return;
906
907   // !!! TODO: ADD STEREO POSITION FOR MOVING ANIMATIONS !!!
908   if (IS_LOOP_SOUND(sound))
909     PlaySoundLoop(sound);
910   else
911     PlaySound(sound);
912
913 #if 0
914   printf("::: PLAY SOUND %d.%d.%d: %d\n",
915          part->anim_nr, part->nr, part->mode_nr, sound);
916 #endif
917 }
918
919 static void StopGlobalAnimSound(struct GlobalAnimPartControlInfo *part)
920 {
921   int sound = part->sound;
922
923   if (sound == SND_UNDEFINED)
924     return;
925
926   StopSound(sound);
927
928 #if 0
929   printf("::: STOP SOUND %d.%d.%d: %d\n",
930          part->anim_nr, part->nr, part->mode_nr, sound);
931 #endif
932 }
933
934 static void PlayGlobalAnimMusic(struct GlobalAnimPartControlInfo *part)
935 {
936   int music = part->music;
937
938   if (music == MUS_UNDEFINED)
939     return;
940
941   if (!setup.sound_music)
942     return;
943
944   if (IS_LOOP_MUSIC(music))
945     PlayMusicLoop(music);
946   else
947     PlayMusic(music);
948
949 #if 0
950   printf("::: PLAY MUSIC %d.%d.%d: %d\n",
951          part->anim_nr, part->nr, part->mode_nr, music);
952 #endif
953 }
954
955 static void StopGlobalAnimMusic(struct GlobalAnimPartControlInfo *part)
956 {
957   int music = part->music;
958
959   if (music == MUS_UNDEFINED)
960     return;
961
962   StopMusic();
963
964 #if 0
965   printf("::: STOP MUSIC %d.%d.%d: %d\n",
966          part->anim_nr, part->nr, part->mode_nr, music);
967 #endif
968 }
969
970 static void PlayGlobalAnimSoundAndMusic(struct GlobalAnimPartControlInfo *part)
971 {
972   // when drawing animations to fading buffer, do not play sounds or music
973   if (drawing_to_fading_buffer)
974     return;
975
976   PlayGlobalAnimSound(part);
977   PlayGlobalAnimMusic(part);
978 }
979
980 static void StopGlobalAnimSoundAndMusic(struct GlobalAnimPartControlInfo *part)
981 {
982   StopGlobalAnimSound(part);
983   StopGlobalAnimMusic(part);
984 }
985
986 static void PlayGlobalAnimSoundIfLoop(struct GlobalAnimPartControlInfo *part)
987 {
988   // when drawing animations to fading buffer, do not play sounds
989   if (drawing_to_fading_buffer)
990     return;
991
992   // loop sounds only expire when playing
993   if (game_status != GAME_MODE_PLAYING)
994     return;
995
996   // check if any sound is defined for this animation part
997   if (part->sound == SND_UNDEFINED)
998     return;
999
1000   // normal (non-loop) sounds do not expire when playing
1001   if (!IS_LOOP_SOUND(part->sound))
1002     return;
1003
1004   // prevent expiring loop sounds when playing
1005   PlayGlobalAnimSound(part);
1006 }
1007
1008 static boolean checkGlobalAnimEvent(int anim_event, int mask)
1009 {
1010   int mask_anim_only = mask & ~ANIM_EVENT_PART_MASK;
1011
1012   if (mask & ANIM_EVENT_ANY)
1013     return (anim_event & ANIM_EVENT_ANY);
1014   else if (mask & ANIM_EVENT_SELF)
1015     return (anim_event & ANIM_EVENT_SELF);
1016   else if (mask & ANIM_EVENT_UNCLICK_ANY)
1017     return (anim_event & ANIM_EVENT_UNCLICK_ANY);
1018   else
1019     return (anim_event == mask ||
1020             anim_event == mask_anim_only);
1021 }
1022
1023 static boolean isClickablePart(struct GlobalAnimPartControlInfo *part, int mask)
1024 {
1025   struct GraphicInfo *c = &part->control_info;
1026   int num_init_events = GetGlobalAnimEventValueCount(c->init_event);
1027   int num_anim_events = GetGlobalAnimEventValueCount(c->anim_event);
1028   int i;
1029
1030   for (i = 0; i < num_init_events; i++)
1031   {
1032     int init_event = GetGlobalAnimEventValue(c->init_event, i);
1033
1034     if (checkGlobalAnimEvent(init_event, mask))
1035       return TRUE;
1036   }
1037
1038   for (i = 0; i < num_anim_events; i++)
1039   {
1040     int anim_event = GetGlobalAnimEventValue(c->anim_event, i);
1041
1042     if (checkGlobalAnimEvent(anim_event, mask))
1043       return TRUE;
1044   }
1045
1046   return FALSE;
1047 }
1048
1049 static boolean isClickedPart(struct GlobalAnimPartControlInfo *part,
1050                              int mx, int my, boolean clicked)
1051 {
1052   struct GraphicInfo *g = &part->graphic_info;
1053   int part_x = part->viewport_x + part->x;
1054   int part_y = part->viewport_y + part->y;
1055   int part_width  = g->width;
1056   int part_height = g->height;
1057
1058   // check if mouse click was detected at all
1059   if (!clicked)
1060     return FALSE;
1061
1062   // check if mouse click is inside the animation part's viewport
1063   if (mx <  part->viewport_x ||
1064       mx >= part->viewport_x + part->viewport_width ||
1065       my <  part->viewport_y ||
1066       my >= part->viewport_y + part->viewport_height)
1067     return FALSE;
1068
1069   // check if mouse click is inside the animation part's graphic
1070   if (mx <  part_x ||
1071       mx >= part_x + part_width ||
1072       my <  part_y ||
1073       my >= part_y + part_height)
1074     return FALSE;
1075
1076   return TRUE;
1077 }
1078
1079 static boolean clickConsumed(struct GlobalAnimPartControlInfo *part)
1080 {
1081   return (part->control_info.style & STYLE_PASSTHROUGH ? FALSE : TRUE);
1082 }
1083
1084 static void InitGlobalAnim_Triggered(struct GlobalAnimPartControlInfo *part,
1085                                      boolean *anything_clicked,
1086                                      boolean *any_event_action,
1087                                      int event_value, char *info_text)
1088 {
1089   struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[part->mode_nr];
1090
1091   int gic_anim_nr = part->old_anim_nr + 1;      // X as in "anim_X"
1092   int gic_part_nr = part->old_nr + 1;           // Y as in "part_Y"
1093   int mask = event_value | (gic_anim_nr << ANIM_EVENT_ANIM_BIT);
1094
1095   if (!part->is_base)
1096     mask |= gic_part_nr << ANIM_EVENT_PART_BIT;
1097
1098   int anim2_nr;
1099
1100   for (anim2_nr = 0; anim2_nr < ctrl->num_anims; anim2_nr++)
1101   {
1102     struct GlobalAnimMainControlInfo *anim2 = &ctrl->anim[anim2_nr];
1103     int part2_nr;
1104
1105     for (part2_nr = 0; part2_nr < anim2->num_parts_all; part2_nr++)
1106     {
1107       struct GlobalAnimPartControlInfo *part2 = &anim2->part[part2_nr];
1108
1109       if (part2->state != ANIM_STATE_RUNNING)
1110         continue;
1111
1112       if (isClickablePart(part2, mask))
1113       {
1114         part2->triggered = TRUE;
1115         *anything_clicked = clickConsumed(part);        // click was on "part"!
1116
1117 #if DEBUG_ANIM_EVENTS
1118         printf("::: => %d.%d TRIGGERED BY %s OF %d.%d\n",
1119                part2->old_anim_nr + 1, part2->old_nr + 1, info_text,
1120                part->old_anim_nr + 1, part->old_nr + 1);
1121 #endif
1122 #if 0
1123         printf("::: %d.%d TRIGGER CLICKED [%d]\n", anim2_nr, part2_nr,
1124                part2->control_info.anim_event_action);
1125 #endif
1126
1127         // after executing event action, ignore any further actions
1128         if (!*any_event_action && DoGlobalAnim_EventAction(part2))
1129           *any_event_action = TRUE;
1130       }
1131
1132 #if 0
1133       struct GraphicInfo *c = &part2->control_info;
1134
1135       printf("::: - %d.%d: 0x%08x, 0x%08x [0x%08x]",
1136              anim2_nr, part2_nr, c->init_event, c->anim_event, mask);
1137
1138       if (isClickablePart(part2, mask))
1139         printf(" <--- TRIGGERED BY %d.%d",
1140                anim_nr, part_nr);
1141
1142       printf("\n");
1143 #endif
1144     }
1145   }
1146 }
1147
1148 static void HandleGlobalAnimEvent(struct GlobalAnimPartControlInfo *part,
1149                                   int event_value, char *info_text)
1150 {
1151 #if DEBUG_ANIM_EVENTS
1152   printf("::: %d.%d %s\n", part->old_anim_nr + 1, part->old_nr + 1, info_text);
1153 #endif
1154
1155   boolean anything_clicked = FALSE;
1156   boolean any_event_action = FALSE;
1157
1158   // check if this event is defined to trigger other animations
1159   InitGlobalAnim_Triggered(part, &anything_clicked, &any_event_action,
1160                            event_value, info_text);
1161 }
1162
1163 static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
1164                                  int state)
1165 {
1166   struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[part->mode_nr];
1167   struct GlobalAnimMainControlInfo *anim = &ctrl->anim[part->anim_nr];
1168   struct GraphicInfo *g = &part->graphic_info;
1169   struct GraphicInfo *c = &part->control_info;
1170   boolean viewport_changed = SetGlobalAnimPart_Viewport(part);
1171
1172   if (viewport_changed)
1173     state |= ANIM_STATE_RESTART;
1174
1175   if (state & ANIM_STATE_RESTART)
1176   {
1177     // when drawing animations to fading buffer, only start fixed animations
1178     if (drawing_to_fading_buffer && (c->x == ARG_UNDEFINED_VALUE ||
1179                                      c->y == ARG_UNDEFINED_VALUE))
1180       return ANIM_STATE_INACTIVE;
1181
1182     ResetDelayCounterExt(&part->step_delay, anim_sync_frame);
1183
1184     part->init_delay_counter =
1185       (c->init_delay_fixed + GetSimpleRandom(c->init_delay_random));
1186
1187     part->anim_delay_counter =
1188       (c->anim_delay_fixed + GetSimpleRandom(c->anim_delay_random));
1189
1190     part->init_event_state = (c->init_event != ANIM_EVENT_UNDEFINED);
1191     part->anim_event_state = (c->anim_event != ANIM_EVENT_UNDEFINED);
1192
1193     part->initial_anim_sync_frame =
1194       (g->anim_global_sync ? 0 : anim_sync_frame + part->init_delay_counter);
1195
1196     if (c->direction & MV_HORIZONTAL)
1197     {
1198       int pos_bottom = part->viewport_height - g->height;
1199
1200       if (c->position == POS_TOP)
1201         part->y = 0;
1202       else if (c->position == POS_UPPER)
1203         part->y = GetSimpleRandom(pos_bottom / 2);
1204       else if (c->position == POS_MIDDLE)
1205         part->y = pos_bottom / 2;
1206       else if (c->position == POS_LOWER)
1207         part->y = pos_bottom / 2 + GetSimpleRandom(pos_bottom / 2);
1208       else if (c->position == POS_BOTTOM)
1209         part->y = pos_bottom;
1210       else
1211         part->y = GetSimpleRandom(pos_bottom);
1212
1213       if (c->direction == MV_RIGHT)
1214       {
1215         part->step_xoffset = c->step_offset;
1216         part->x = -g->width + part->step_xoffset;
1217       }
1218       else
1219       {
1220         part->step_xoffset = -c->step_offset;
1221         part->x = part->viewport_width + part->step_xoffset;
1222       }
1223
1224       part->step_yoffset = 0;
1225     }
1226     else if (c->direction & MV_VERTICAL)
1227     {
1228       int pos_right = part->viewport_width - g->width;
1229
1230       if (c->position == POS_LEFT)
1231         part->x = 0;
1232       else if (c->position == POS_RIGHT)
1233         part->x = pos_right;
1234       else
1235         part->x = GetSimpleRandom(pos_right);
1236
1237       if (c->direction == MV_DOWN)
1238       {
1239         part->step_yoffset = c->step_offset;
1240         part->y = -g->height + part->step_yoffset;
1241       }
1242       else
1243       {
1244         part->step_yoffset = -c->step_offset;
1245         part->y = part->viewport_height + part->step_yoffset;
1246       }
1247
1248       part->step_xoffset = 0;
1249     }
1250     else
1251     {
1252       part->x = 0;
1253       part->y = 0;
1254
1255       part->step_xoffset = 0;
1256       part->step_yoffset = 0;
1257     }
1258
1259     if (c->x != ARG_UNDEFINED_VALUE)
1260       part->x = c->x;
1261     if (c->y != ARG_UNDEFINED_VALUE)
1262       part->y = c->y;
1263
1264     if (c->position == POS_LAST &&
1265         anim->last_x > -g->width  && anim->last_x < part->viewport_width &&
1266         anim->last_y > -g->height && anim->last_y < part->viewport_height)
1267     {
1268       part->x = anim->last_x;
1269       part->y = anim->last_y;
1270     }
1271
1272     if (c->step_xoffset != ARG_UNDEFINED_VALUE)
1273       part->step_xoffset = c->step_xoffset;
1274     if (c->step_yoffset != ARG_UNDEFINED_VALUE)
1275       part->step_yoffset = c->step_yoffset;
1276
1277     if (part->init_delay_counter == 0 &&
1278         !part->init_event_state)
1279     {
1280       PlayGlobalAnimSoundAndMusic(part);
1281
1282       HandleGlobalAnimEvent(part, ANIM_EVENT_START, "START [ANIM]");
1283     }
1284     else
1285     {
1286       HandleGlobalAnimEvent(part, ANIM_EVENT_INIT, "START [INIT_DELAY/EVENT]");
1287     }
1288   }
1289
1290   if (part->clicked &&
1291       part->init_event_state)
1292   {
1293     if (part->initial_anim_sync_frame > 0)
1294       part->initial_anim_sync_frame -= part->init_delay_counter - 1;
1295
1296     part->init_delay_counter = 1;
1297     part->init_event_state = FALSE;
1298
1299     part->clicked = FALSE;
1300   }
1301
1302   if (part->clicked &&
1303       part->anim_event_state)
1304   {
1305     part->anim_delay_counter = 1;
1306     part->anim_event_state = FALSE;
1307
1308     part->clicked = FALSE;
1309   }
1310
1311   if (part->init_delay_counter > 0)
1312   {
1313     part->init_delay_counter--;
1314
1315     if (part->init_delay_counter == 0)
1316     {
1317       part->init_event_state = FALSE;
1318
1319       PlayGlobalAnimSoundAndMusic(part);
1320
1321       HandleGlobalAnimEvent(part, ANIM_EVENT_START, "START [ANIM]");
1322     }
1323
1324     return ANIM_STATE_WAITING;
1325   }
1326
1327   if (part->init_event_state)
1328     return ANIM_STATE_WAITING;
1329
1330   // animation part is now running/visible and therefore clickable
1331   part->clickable = TRUE;
1332
1333   // check if moving animation has left the visible screen area
1334   if ((part->x <= -g->width              && part->step_xoffset <= 0) ||
1335       (part->x >=  part->viewport_width  && part->step_xoffset >= 0) ||
1336       (part->y <= -g->height             && part->step_yoffset <= 0) ||
1337       (part->y >=  part->viewport_height && part->step_yoffset >= 0))
1338   {
1339     // do not wait for "anim" events for off-screen animations
1340     part->anim_event_state = FALSE;
1341
1342     // do not stop animation before "anim" or "post" counter are finished
1343     if (part->anim_delay_counter == 0 &&
1344         part->post_delay_counter == 0)
1345     {
1346       StopGlobalAnimSoundAndMusic(part);
1347
1348       HandleGlobalAnimEvent(part, ANIM_EVENT_END, "END [ANIM/OFF-SCREEN]");
1349
1350       part->post_delay_counter =
1351         (c->post_delay_fixed + GetSimpleRandom(c->post_delay_random));
1352
1353       if (part->post_delay_counter > 0)
1354         return ANIM_STATE_RUNNING;
1355
1356       // drawing last frame not needed here -- animation not visible anymore
1357       return ANIM_STATE_RESTART;
1358     }
1359   }
1360
1361   if (part->anim_delay_counter > 0)
1362   {
1363     part->anim_delay_counter--;
1364
1365     if (part->anim_delay_counter == 0)
1366     {
1367       part->anim_event_state = FALSE;
1368
1369       StopGlobalAnimSoundAndMusic(part);
1370
1371       HandleGlobalAnimEvent(part, ANIM_EVENT_END, "END [ANIM_DELAY/EVENT]");
1372
1373       part->post_delay_counter =
1374         (c->post_delay_fixed + GetSimpleRandom(c->post_delay_random));
1375
1376       if (part->post_delay_counter > 0)
1377         return ANIM_STATE_RUNNING;
1378
1379       // additional state "RUNNING" required to not skip drawing last frame
1380       return ANIM_STATE_RESTART | ANIM_STATE_RUNNING;
1381     }
1382   }
1383
1384   if (part->post_delay_counter > 0)
1385   {
1386     part->post_delay_counter--;
1387
1388     if (part->post_delay_counter == 0)
1389     {
1390       HandleGlobalAnimEvent(part, ANIM_EVENT_POST, "END [POST_DELAY]");
1391
1392       return ANIM_STATE_RESTART;
1393     }
1394
1395     return ANIM_STATE_WAITING;
1396   }
1397
1398   // special case to prevent expiring loop sounds when playing
1399   PlayGlobalAnimSoundIfLoop(part);
1400
1401   if (!DelayReachedExt(&part->step_delay, part->step_delay_value,
1402                        anim_sync_frame))
1403     return ANIM_STATE_RUNNING;
1404
1405 #if 0
1406   {
1407     static unsigned int last_counter = -1;
1408     unsigned int counter = Counter();
1409
1410     printf("::: NEXT ANIM PART [%d, %d]\n",
1411            anim_sync_frame, counter - last_counter);
1412
1413     last_counter = counter;
1414   }
1415 #endif
1416
1417   part->x += part->step_xoffset;
1418   part->y += part->step_yoffset;
1419
1420   anim->last_x = part->x;
1421   anim->last_y = part->y;
1422
1423   return ANIM_STATE_RUNNING;
1424 }
1425
1426 static void HandleGlobalAnim_Main(struct GlobalAnimMainControlInfo *anim,
1427                                   int action)
1428 {
1429   struct GlobalAnimPartControlInfo *part;
1430   struct GraphicInfo *c = &anim->control_info;
1431   int num_parts = anim->num_parts + (anim->has_base ? 1 : 0);
1432   int state, active_part_nr;
1433   int i;
1434
1435 #if 0
1436   printf("::: HandleGlobalAnim_Main: %d, %d => %d\n",
1437          anim->mode_nr, anim->nr, anim->num_parts);
1438   printf("::: %d, %d, %d\n", global.num_toons, setup.toons, num_toons);
1439 #endif
1440
1441 #if 0
1442   printf("::: %s(%d): %d, %d, %d [%d]\n",
1443          (action == ANIM_START ? "ANIM_START" :
1444           action == ANIM_CONTINUE ? "ANIM_CONTINUE" :
1445           action == ANIM_STOP ? "ANIM_STOP" : "(should not happen)"),
1446          anim->nr,
1447          anim->state & ANIM_STATE_RESTART,
1448          anim->state & ANIM_STATE_WAITING,
1449          anim->state & ANIM_STATE_RUNNING,
1450          anim->num_parts);
1451 #endif
1452
1453   switch (action)
1454   {
1455     case ANIM_START:
1456       anim->state = anim->last_state = ANIM_STATE_RESTART;
1457       anim->active_part_nr = anim->last_active_part_nr = 0;
1458       anim->part_counter = 0;
1459
1460       break;
1461
1462     case ANIM_CONTINUE:
1463       if (anim->state == ANIM_STATE_INACTIVE)
1464         return;
1465
1466       anim->state = anim->last_state;
1467       anim->active_part_nr = anim->last_active_part_nr;
1468
1469       break;
1470
1471     case ANIM_STOP:
1472       anim->state = ANIM_STATE_INACTIVE;
1473
1474       for (i = 0; i < num_parts; i++)
1475         StopGlobalAnimSoundAndMusic(&anim->part[i]);
1476
1477       return;
1478
1479     default:
1480       break;
1481   }
1482
1483   if (c->anim_mode & ANIM_ALL || anim->num_parts == 0)
1484   {
1485 #if 0
1486     printf("::: HandleGlobalAnim_Main: %d, %d => %d\n",
1487            anim->mode_nr, anim->nr, num_parts);
1488 #endif
1489
1490     for (i = 0; i < num_parts; i++)
1491     {
1492       part = &anim->part[i];
1493
1494       switch (action)
1495       {
1496         case ANIM_START:
1497           anim->state = ANIM_STATE_RUNNING;
1498           part->state = ANIM_STATE_RESTART;
1499
1500           break;
1501
1502         case ANIM_CONTINUE:
1503           if (part->state == ANIM_STATE_INACTIVE)
1504             continue;
1505
1506           break;
1507
1508         case ANIM_STOP:
1509           part->state = ANIM_STATE_INACTIVE;
1510
1511           continue;
1512
1513         default:
1514           break;
1515       }
1516
1517       part->state = HandleGlobalAnim_Part(part, part->state);
1518
1519       // when animation mode is "once", stop after animation was played once
1520       if (c->anim_mode & ANIM_ONCE &&
1521           part->state & ANIM_STATE_RESTART)
1522         part->state = ANIM_STATE_INACTIVE;
1523     }
1524
1525     anim->last_state = anim->state;
1526     anim->last_active_part_nr = anim->active_part_nr;
1527
1528     return;
1529   }
1530
1531   if (anim->state & ANIM_STATE_RESTART)         // directly after restart
1532     anim->active_part_nr = getGlobalAnimationPart(anim);
1533
1534   part = &anim->part[anim->active_part_nr];
1535
1536   // first set all animation parts to "inactive", ...
1537   for (i = 0; i < num_parts; i++)
1538     anim->part[i].state = ANIM_STATE_INACTIVE;
1539
1540   // ... then set current animation parts to "running"
1541   part->state = ANIM_STATE_RUNNING;
1542
1543   anim->state = HandleGlobalAnim_Part(part, anim->state);
1544
1545   if (anim->state & ANIM_STATE_RESTART)
1546     anim->part_counter++;
1547
1548   // when animation mode is "once", stop after all animations were played once
1549   if (c->anim_mode & ANIM_ONCE &&
1550       anim->part_counter == anim->num_parts)
1551     anim->state = ANIM_STATE_INACTIVE;
1552
1553   state = anim->state;
1554   active_part_nr = anim->active_part_nr;
1555
1556   // while the animation parts are pausing (waiting or inactive), play the base
1557   // (main) animation; this corresponds to the "boring player animation" logic
1558   // (!!! KLUDGE WARNING: I THINK THIS IS A MESS THAT SHOULD BE CLEANED UP !!!)
1559   if (anim->has_base)
1560   {
1561     if (anim->state == ANIM_STATE_WAITING ||
1562         anim->state == ANIM_STATE_INACTIVE)
1563     {
1564       anim->active_part_nr = anim->num_parts;   // part nr of base animation
1565       part = &anim->part[anim->active_part_nr];
1566
1567       if (anim->state != anim->last_state)
1568         part->state = ANIM_STATE_RESTART;
1569
1570       anim->state = ANIM_STATE_RUNNING;
1571       part->state = HandleGlobalAnim_Part(part, part->state);
1572     }
1573   }
1574
1575   anim->last_state = state;
1576   anim->last_active_part_nr = active_part_nr;
1577 }
1578
1579 static void HandleGlobalAnim_Mode(struct GlobalAnimControlInfo *ctrl, int action)
1580 {
1581   int i;
1582
1583 #if 0
1584   printf("::: HandleGlobalAnim_Mode: %d => %d\n",
1585          ctrl->nr, ctrl->num_anims);
1586 #endif
1587
1588   for (i = 0; i < ctrl->num_anims; i++)
1589     HandleGlobalAnim_Main(&ctrl->anim[i], action);
1590 }
1591
1592 static void HandleGlobalAnim(int action, int game_mode)
1593 {
1594 #if 0
1595   printf("::: HandleGlobalAnim [mode == %d]\n", game_status);
1596 #endif
1597
1598   HandleGlobalAnim_Mode(&global_anim_ctrl[game_mode], action);
1599 }
1600
1601 static void DoAnimationExt(void)
1602 {
1603   int i;
1604
1605 #if 0
1606   printf("::: DoAnimation [%d, %d]\n", anim_sync_frame, Counter());
1607 #endif
1608
1609   // global animations now synchronized with frame delay of screen update
1610   anim_sync_frame++;
1611
1612   for (i = 0; i < NUM_GAME_MODES; i++)
1613     HandleGlobalAnim(ANIM_CONTINUE, i);
1614
1615 #if 0
1616   // force screen redraw in next frame to continue drawing global animations
1617   redraw_mask = REDRAW_ALL;
1618 #endif
1619 }
1620
1621 static boolean DoGlobalAnim_EventAction(struct GlobalAnimPartControlInfo *part)
1622 {
1623   int anim_event_action = part->control_info.anim_event_action;
1624
1625   if (anim_event_action == -1)
1626     return FALSE;
1627
1628   boolean action_executed = (DoGadgetAction(anim_event_action) ||
1629                              DoScreenAction(anim_event_action) ||
1630                              DoKeysymAction(anim_event_action));
1631
1632   // check if further actions are allowed to be executed
1633   if (part->control_info.style & STYLE_MULTIPLE_ACTIONS)
1634     return FALSE;
1635
1636   return action_executed;
1637 }
1638
1639 static void InitGlobalAnim_Clickable(void)
1640 {
1641   int mode_nr;
1642
1643   for (mode_nr = 0; mode_nr < NUM_GAME_MODES; mode_nr++)
1644   {
1645     struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr];
1646     int anim_nr;
1647
1648     for (anim_nr = 0; anim_nr < ctrl->num_anims; anim_nr++)
1649     {
1650       struct GlobalAnimMainControlInfo *anim = &ctrl->anim[anim_nr];
1651       int part_nr;
1652
1653       for (part_nr = 0; part_nr < anim->num_parts_all; part_nr++)
1654       {
1655         struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
1656
1657         if (part->triggered)
1658           part->clicked = TRUE;
1659
1660         part->triggered = FALSE;
1661         part->clickable = FALSE;
1662       }
1663     }
1664   }
1665 }
1666
1667 #define ANIM_CLICKED_RESET      0
1668 #define ANIM_CLICKED_PRESSED    1
1669 #define ANIM_CLICKED_RELEASED   2
1670
1671 static boolean InitGlobalAnim_Clicked(int mx, int my, int clicked_event)
1672 {
1673   boolean anything_clicked = FALSE;
1674   boolean any_part_clicked = FALSE;
1675   boolean any_event_action = FALSE;
1676   int mode_nr;
1677
1678   // check game modes in reverse draw order (to stop when clicked)
1679   for (mode_nr = NUM_GAME_MODES - 1; mode_nr >= 0; mode_nr--)
1680   {
1681     struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr];
1682     int anim_nr;
1683
1684     // check animations in reverse draw order (to stop when clicked)
1685     for (anim_nr = ctrl->num_anims - 1; anim_nr >= 0; anim_nr--)
1686     {
1687       struct GlobalAnimMainControlInfo *anim = &ctrl->anim[anim_nr];
1688       int part_nr;
1689
1690       // check animation parts in reverse draw order (to stop when clicked)
1691       for (part_nr = anim->num_parts_all - 1; part_nr >= 0; part_nr--)
1692       {
1693         struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
1694
1695         if (clicked_event == ANIM_CLICKED_RESET)
1696         {
1697           part->clicked = FALSE;
1698
1699           continue;
1700         }
1701
1702         if (!part->clickable)
1703           continue;
1704
1705         if (part->state != ANIM_STATE_RUNNING)
1706           continue;
1707
1708         // always handle "any" click events (clicking anywhere on screen) ...
1709         if (clicked_event == ANIM_CLICKED_PRESSED &&
1710             isClickablePart(part, ANIM_EVENT_ANY))
1711         {
1712 #if DEBUG_ANIM_EVENTS
1713           printf("::: => %d.%d TRIGGERED BY ANY\n",
1714                  part->old_anim_nr + 1, part->old_nr + 1);
1715 #endif
1716
1717           part->clicked = TRUE;
1718           anything_clicked = clickConsumed(part);
1719         }
1720
1721         // always handle "unclick:any" events (releasing anywhere on screen) ...
1722         if (clicked_event == ANIM_CLICKED_RELEASED &&
1723             isClickablePart(part, ANIM_EVENT_UNCLICK_ANY))
1724         {
1725 #if DEBUG_ANIM_EVENTS
1726           printf("::: => %d.%d TRIGGERED BY UNCLICK:ANY\n",
1727                  part->old_anim_nr + 1, part->old_nr + 1);
1728 #endif
1729
1730           part->clicked = TRUE;
1731           anything_clicked = clickConsumed(part);
1732         }
1733
1734         // ... but only handle the first (topmost) clickable animation
1735         if (any_part_clicked)
1736           continue;
1737
1738         if (clicked_event == ANIM_CLICKED_PRESSED &&
1739             isClickedPart(part, mx, my, TRUE))
1740         {
1741 #if 0
1742           printf("::: %d.%d CLICKED [%d]\n", anim_nr, part_nr,
1743                  part->control_info.anim_event_action);
1744 #endif
1745
1746           // after executing event action, ignore any further actions
1747           if (!any_event_action && DoGlobalAnim_EventAction(part))
1748             any_event_action = TRUE;
1749
1750           // determine if mouse clicks should be blocked from other animations
1751           any_part_clicked = clickConsumed(part);
1752
1753           if (isClickablePart(part, ANIM_EVENT_SELF))
1754           {
1755 #if DEBUG_ANIM_EVENTS
1756             printf("::: => %d.%d TRIGGERED BY SELF\n",
1757                    part->old_anim_nr + 1, part->old_nr + 1);
1758 #endif
1759
1760             part->clicked = TRUE;
1761             anything_clicked = clickConsumed(part);
1762           }
1763
1764           // check if this click is defined to trigger other animations
1765           InitGlobalAnim_Triggered(part, &anything_clicked, &any_event_action,
1766                                    ANIM_EVENT_CLICK, "CLICK");
1767         }
1768       }
1769     }
1770   }
1771
1772   return (anything_clicked || any_event_action);
1773 }
1774
1775 static void ResetGlobalAnim_Clickable(void)
1776 {
1777   InitGlobalAnim_Clickable();
1778 }
1779
1780 static void ResetGlobalAnim_Clicked(void)
1781 {
1782   InitGlobalAnim_Clicked(-1, -1, ANIM_CLICKED_RESET);
1783 }
1784
1785 boolean HandleGlobalAnimClicks(int mx, int my, int button)
1786 {
1787   static boolean click_consumed = FALSE;
1788   static int last_button = 0;
1789   boolean press_event;
1790   boolean release_event;
1791   boolean click_consumed_current = click_consumed;
1792
1793   // check if button state has changed since last invocation
1794   press_event   = (button != 0 && last_button == 0);
1795   release_event = (button == 0 && last_button != 0);
1796   last_button = button;
1797
1798   if (press_event)
1799   {
1800     click_consumed = InitGlobalAnim_Clicked(mx, my, ANIM_CLICKED_PRESSED);
1801     click_consumed_current = click_consumed;
1802   }
1803
1804   if (release_event)
1805   {
1806     InitGlobalAnim_Clicked(mx, my, ANIM_CLICKED_RELEASED);
1807     click_consumed = FALSE;
1808   }
1809
1810   return click_consumed_current;
1811 }