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