fixed wrong position of global animations in 'door_2' in level editor
[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
1017     return (anim_event == mask ||
1018             anim_event == mask_anim_only);
1019 }
1020
1021 static boolean isClickablePart(struct GlobalAnimPartControlInfo *part, int mask)
1022 {
1023   struct GraphicInfo *c = &part->control_info;
1024   int num_init_events = GetGlobalAnimEventValueCount(c->init_event);
1025   int num_anim_events = GetGlobalAnimEventValueCount(c->anim_event);
1026   int i;
1027
1028   for (i = 0; i < num_init_events; i++)
1029   {
1030     int init_event = GetGlobalAnimEventValue(c->init_event, i);
1031
1032     if (checkGlobalAnimEvent(init_event, mask))
1033       return TRUE;
1034   }
1035
1036   for (i = 0; i < num_anim_events; i++)
1037   {
1038     int anim_event = GetGlobalAnimEventValue(c->anim_event, i);
1039
1040     if (checkGlobalAnimEvent(anim_event, mask))
1041       return TRUE;
1042   }
1043
1044   return FALSE;
1045 }
1046
1047 static boolean isClickedPart(struct GlobalAnimPartControlInfo *part,
1048                              int mx, int my, boolean clicked)
1049 {
1050   struct GraphicInfo *g = &part->graphic_info;
1051   int part_x = part->viewport_x + part->x;
1052   int part_y = part->viewport_y + part->y;
1053   int part_width  = g->width;
1054   int part_height = g->height;
1055
1056   // check if mouse click was detected at all
1057   if (!clicked)
1058     return FALSE;
1059
1060   // check if mouse click is inside the animation part's viewport
1061   if (mx <  part->viewport_x ||
1062       mx >= part->viewport_x + part->viewport_width ||
1063       my <  part->viewport_y ||
1064       my >= part->viewport_y + part->viewport_height)
1065     return FALSE;
1066
1067   // check if mouse click is inside the animation part's graphic
1068   if (mx <  part_x ||
1069       mx >= part_x + part_width ||
1070       my <  part_y ||
1071       my >= part_y + part_height)
1072     return FALSE;
1073
1074   return TRUE;
1075 }
1076
1077 static boolean clickConsumed(struct GlobalAnimPartControlInfo *part)
1078 {
1079   return (part->control_info.style & STYLE_PASSTHROUGH ? FALSE : TRUE);
1080 }
1081
1082 static void InitGlobalAnim_Triggered(struct GlobalAnimPartControlInfo *part,
1083                                      boolean *anything_clicked,
1084                                      boolean *any_event_action,
1085                                      int event_value, char *info_text)
1086 {
1087   struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[part->mode_nr];
1088
1089   int gic_anim_nr = part->old_anim_nr + 1;      // X as in "anim_X"
1090   int gic_part_nr = part->old_nr + 1;           // Y as in "part_Y"
1091   int mask = event_value | (gic_anim_nr << ANIM_EVENT_ANIM_BIT);
1092
1093   if (!part->is_base)
1094     mask |= gic_part_nr << ANIM_EVENT_PART_BIT;
1095
1096   int anim2_nr;
1097
1098   for (anim2_nr = 0; anim2_nr < ctrl->num_anims; anim2_nr++)
1099   {
1100     struct GlobalAnimMainControlInfo *anim2 = &ctrl->anim[anim2_nr];
1101     int part2_nr;
1102
1103     for (part2_nr = 0; part2_nr < anim2->num_parts_all; part2_nr++)
1104     {
1105       struct GlobalAnimPartControlInfo *part2 = &anim2->part[part2_nr];
1106
1107       if (part2->state != ANIM_STATE_RUNNING)
1108         continue;
1109
1110       if (isClickablePart(part2, mask))
1111       {
1112         part2->triggered = TRUE;
1113         *anything_clicked = clickConsumed(part);        // click was on "part"!
1114
1115 #if DEBUG_ANIM_EVENTS
1116         printf("::: => %d.%d TRIGGERED BY %s OF %d.%d\n",
1117                part2->old_anim_nr + 1, part2->old_nr + 1, info_text,
1118                part->old_anim_nr + 1, part->old_nr + 1);
1119 #endif
1120 #if 0
1121         printf("::: %d.%d TRIGGER CLICKED [%d]\n", anim2_nr, part2_nr,
1122                part2->control_info.anim_event_action);
1123 #endif
1124
1125         // after executing event action, ignore any further actions
1126         if (!*any_event_action && DoGlobalAnim_EventAction(part2))
1127           *any_event_action = TRUE;
1128       }
1129
1130 #if 0
1131       struct GraphicInfo *c = &part2->control_info;
1132
1133       printf("::: - %d.%d: 0x%08x, 0x%08x [0x%08x]",
1134              anim2_nr, part2_nr, c->init_event, c->anim_event, mask);
1135
1136       if (isClickablePart(part2, mask))
1137         printf(" <--- TRIGGERED BY %d.%d",
1138                anim_nr, part_nr);
1139
1140       printf("\n");
1141 #endif
1142     }
1143   }
1144 }
1145
1146 static void HandleGlobalAnimEvent(struct GlobalAnimPartControlInfo *part,
1147                                   int event_value, char *info_text)
1148 {
1149 #if DEBUG_ANIM_EVENTS
1150   printf("::: %d.%d %s\n", part->old_anim_nr + 1, part->old_nr + 1, info_text);
1151 #endif
1152
1153   boolean anything_clicked = FALSE;
1154   boolean any_event_action = FALSE;
1155
1156   // check if this event is defined to trigger other animations
1157   InitGlobalAnim_Triggered(part, &anything_clicked, &any_event_action,
1158                            event_value, info_text);
1159 }
1160
1161 static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
1162                                  int state)
1163 {
1164   struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[part->mode_nr];
1165   struct GlobalAnimMainControlInfo *anim = &ctrl->anim[part->anim_nr];
1166   struct GraphicInfo *g = &part->graphic_info;
1167   struct GraphicInfo *c = &part->control_info;
1168   boolean viewport_changed = SetGlobalAnimPart_Viewport(part);
1169
1170   if (viewport_changed)
1171     state |= ANIM_STATE_RESTART;
1172
1173   if (state & ANIM_STATE_RESTART)
1174   {
1175     // when drawing animations to fading buffer, only start fixed animations
1176     if (drawing_to_fading_buffer && (c->x == ARG_UNDEFINED_VALUE ||
1177                                      c->y == ARG_UNDEFINED_VALUE))
1178       return ANIM_STATE_INACTIVE;
1179
1180     ResetDelayCounterExt(&part->step_delay, anim_sync_frame);
1181
1182     part->init_delay_counter =
1183       (c->init_delay_fixed + GetSimpleRandom(c->init_delay_random));
1184
1185     part->anim_delay_counter =
1186       (c->anim_delay_fixed + GetSimpleRandom(c->anim_delay_random));
1187
1188     part->init_event_state = (c->init_event != ANIM_EVENT_UNDEFINED);
1189     part->anim_event_state = (c->anim_event != ANIM_EVENT_UNDEFINED);
1190
1191     part->initial_anim_sync_frame =
1192       (g->anim_global_sync ? 0 : anim_sync_frame + part->init_delay_counter);
1193
1194     if (c->direction & MV_HORIZONTAL)
1195     {
1196       int pos_bottom = part->viewport_height - g->height;
1197
1198       if (c->position == POS_TOP)
1199         part->y = 0;
1200       else if (c->position == POS_UPPER)
1201         part->y = GetSimpleRandom(pos_bottom / 2);
1202       else if (c->position == POS_MIDDLE)
1203         part->y = pos_bottom / 2;
1204       else if (c->position == POS_LOWER)
1205         part->y = pos_bottom / 2 + GetSimpleRandom(pos_bottom / 2);
1206       else if (c->position == POS_BOTTOM)
1207         part->y = pos_bottom;
1208       else
1209         part->y = GetSimpleRandom(pos_bottom);
1210
1211       if (c->direction == MV_RIGHT)
1212       {
1213         part->step_xoffset = c->step_offset;
1214         part->x = -g->width + part->step_xoffset;
1215       }
1216       else
1217       {
1218         part->step_xoffset = -c->step_offset;
1219         part->x = part->viewport_width + part->step_xoffset;
1220       }
1221
1222       part->step_yoffset = 0;
1223     }
1224     else if (c->direction & MV_VERTICAL)
1225     {
1226       int pos_right = part->viewport_width - g->width;
1227
1228       if (c->position == POS_LEFT)
1229         part->x = 0;
1230       else if (c->position == POS_RIGHT)
1231         part->x = pos_right;
1232       else
1233         part->x = GetSimpleRandom(pos_right);
1234
1235       if (c->direction == MV_DOWN)
1236       {
1237         part->step_yoffset = c->step_offset;
1238         part->y = -g->height + part->step_yoffset;
1239       }
1240       else
1241       {
1242         part->step_yoffset = -c->step_offset;
1243         part->y = part->viewport_height + part->step_yoffset;
1244       }
1245
1246       part->step_xoffset = 0;
1247     }
1248     else
1249     {
1250       part->x = 0;
1251       part->y = 0;
1252
1253       part->step_xoffset = 0;
1254       part->step_yoffset = 0;
1255     }
1256
1257     if (c->x != ARG_UNDEFINED_VALUE)
1258       part->x = c->x;
1259     if (c->y != ARG_UNDEFINED_VALUE)
1260       part->y = c->y;
1261
1262     if (c->position == POS_LAST &&
1263         anim->last_x > -g->width  && anim->last_x < part->viewport_width &&
1264         anim->last_y > -g->height && anim->last_y < part->viewport_height)
1265     {
1266       part->x = anim->last_x;
1267       part->y = anim->last_y;
1268     }
1269
1270     if (c->step_xoffset != ARG_UNDEFINED_VALUE)
1271       part->step_xoffset = c->step_xoffset;
1272     if (c->step_yoffset != ARG_UNDEFINED_VALUE)
1273       part->step_yoffset = c->step_yoffset;
1274
1275     if (part->init_delay_counter == 0 &&
1276         !part->init_event_state)
1277     {
1278       PlayGlobalAnimSoundAndMusic(part);
1279
1280       HandleGlobalAnimEvent(part, ANIM_EVENT_START, "START [ANIM]");
1281     }
1282     else
1283     {
1284       HandleGlobalAnimEvent(part, ANIM_EVENT_INIT, "START [INIT_DELAY/EVENT]");
1285     }
1286   }
1287
1288   if (part->clicked &&
1289       part->init_event_state)
1290   {
1291     if (part->initial_anim_sync_frame > 0)
1292       part->initial_anim_sync_frame -= part->init_delay_counter - 1;
1293
1294     part->init_delay_counter = 1;
1295     part->init_event_state = FALSE;
1296
1297     part->clicked = FALSE;
1298   }
1299
1300   if (part->clicked &&
1301       part->anim_event_state)
1302   {
1303     part->anim_delay_counter = 1;
1304     part->anim_event_state = FALSE;
1305
1306     part->clicked = FALSE;
1307   }
1308
1309   if (part->init_delay_counter > 0)
1310   {
1311     part->init_delay_counter--;
1312
1313     if (part->init_delay_counter == 0)
1314     {
1315       part->init_event_state = FALSE;
1316
1317       PlayGlobalAnimSoundAndMusic(part);
1318
1319       HandleGlobalAnimEvent(part, ANIM_EVENT_START, "START [ANIM]");
1320     }
1321
1322     return ANIM_STATE_WAITING;
1323   }
1324
1325   if (part->init_event_state)
1326     return ANIM_STATE_WAITING;
1327
1328   // animation part is now running/visible and therefore clickable
1329   part->clickable = TRUE;
1330
1331   // check if moving animation has left the visible screen area
1332   if ((part->x <= -g->width              && part->step_xoffset <= 0) ||
1333       (part->x >=  part->viewport_width  && part->step_xoffset >= 0) ||
1334       (part->y <= -g->height             && part->step_yoffset <= 0) ||
1335       (part->y >=  part->viewport_height && part->step_yoffset >= 0))
1336   {
1337     // do not wait for "anim" events for off-screen animations
1338     part->anim_event_state = FALSE;
1339
1340     // do not stop animation before "anim" or "post" counter are finished
1341     if (part->anim_delay_counter == 0 &&
1342         part->post_delay_counter == 0)
1343     {
1344       StopGlobalAnimSoundAndMusic(part);
1345
1346       HandleGlobalAnimEvent(part, ANIM_EVENT_END, "END [ANIM/OFF-SCREEN]");
1347
1348       part->post_delay_counter =
1349         (c->post_delay_fixed + GetSimpleRandom(c->post_delay_random));
1350
1351       if (part->post_delay_counter > 0)
1352         return ANIM_STATE_RUNNING;
1353
1354       // drawing last frame not needed here -- animation not visible anymore
1355       return ANIM_STATE_RESTART;
1356     }
1357   }
1358
1359   if (part->anim_delay_counter > 0)
1360   {
1361     part->anim_delay_counter--;
1362
1363     if (part->anim_delay_counter == 0)
1364     {
1365       part->anim_event_state = FALSE;
1366
1367       StopGlobalAnimSoundAndMusic(part);
1368
1369       HandleGlobalAnimEvent(part, ANIM_EVENT_END, "END [ANIM_DELAY/EVENT]");
1370
1371       part->post_delay_counter =
1372         (c->post_delay_fixed + GetSimpleRandom(c->post_delay_random));
1373
1374       if (part->post_delay_counter > 0)
1375         return ANIM_STATE_RUNNING;
1376
1377       // additional state "RUNNING" required to not skip drawing last frame
1378       return ANIM_STATE_RESTART | ANIM_STATE_RUNNING;
1379     }
1380   }
1381
1382   if (part->post_delay_counter > 0)
1383   {
1384     part->post_delay_counter--;
1385
1386     if (part->post_delay_counter == 0)
1387     {
1388       HandleGlobalAnimEvent(part, ANIM_EVENT_POST, "END [POST_DELAY]");
1389
1390       return ANIM_STATE_RESTART;
1391     }
1392
1393     return ANIM_STATE_WAITING;
1394   }
1395
1396   // special case to prevent expiring loop sounds when playing
1397   PlayGlobalAnimSoundIfLoop(part);
1398
1399   if (!DelayReachedExt(&part->step_delay, part->step_delay_value,
1400                        anim_sync_frame))
1401     return ANIM_STATE_RUNNING;
1402
1403 #if 0
1404   {
1405     static unsigned int last_counter = -1;
1406     unsigned int counter = Counter();
1407
1408     printf("::: NEXT ANIM PART [%d, %d]\n",
1409            anim_sync_frame, counter - last_counter);
1410
1411     last_counter = counter;
1412   }
1413 #endif
1414
1415   part->x += part->step_xoffset;
1416   part->y += part->step_yoffset;
1417
1418   anim->last_x = part->x;
1419   anim->last_y = part->y;
1420
1421   return ANIM_STATE_RUNNING;
1422 }
1423
1424 static void HandleGlobalAnim_Main(struct GlobalAnimMainControlInfo *anim,
1425                                   int action)
1426 {
1427   struct GlobalAnimPartControlInfo *part;
1428   struct GraphicInfo *c = &anim->control_info;
1429   int num_parts = anim->num_parts + (anim->has_base ? 1 : 0);
1430   int state, active_part_nr;
1431   int i;
1432
1433 #if 0
1434   printf("::: HandleGlobalAnim_Main: %d, %d => %d\n",
1435          anim->mode_nr, anim->nr, anim->num_parts);
1436   printf("::: %d, %d, %d\n", global.num_toons, setup.toons, num_toons);
1437 #endif
1438
1439 #if 0
1440   printf("::: %s(%d): %d, %d, %d [%d]\n",
1441          (action == ANIM_START ? "ANIM_START" :
1442           action == ANIM_CONTINUE ? "ANIM_CONTINUE" :
1443           action == ANIM_STOP ? "ANIM_STOP" : "(should not happen)"),
1444          anim->nr,
1445          anim->state & ANIM_STATE_RESTART,
1446          anim->state & ANIM_STATE_WAITING,
1447          anim->state & ANIM_STATE_RUNNING,
1448          anim->num_parts);
1449 #endif
1450
1451   switch (action)
1452   {
1453     case ANIM_START:
1454       anim->state = anim->last_state = ANIM_STATE_RESTART;
1455       anim->active_part_nr = anim->last_active_part_nr = 0;
1456       anim->part_counter = 0;
1457
1458       break;
1459
1460     case ANIM_CONTINUE:
1461       if (anim->state == ANIM_STATE_INACTIVE)
1462         return;
1463
1464       anim->state = anim->last_state;
1465       anim->active_part_nr = anim->last_active_part_nr;
1466
1467       break;
1468
1469     case ANIM_STOP:
1470       anim->state = ANIM_STATE_INACTIVE;
1471
1472       for (i = 0; i < num_parts; i++)
1473         StopGlobalAnimSoundAndMusic(&anim->part[i]);
1474
1475       return;
1476
1477     default:
1478       break;
1479   }
1480
1481   if (c->anim_mode & ANIM_ALL || anim->num_parts == 0)
1482   {
1483 #if 0
1484     printf("::: HandleGlobalAnim_Main: %d, %d => %d\n",
1485            anim->mode_nr, anim->nr, num_parts);
1486 #endif
1487
1488     for (i = 0; i < num_parts; i++)
1489     {
1490       part = &anim->part[i];
1491
1492       switch (action)
1493       {
1494         case ANIM_START:
1495           anim->state = ANIM_STATE_RUNNING;
1496           part->state = ANIM_STATE_RESTART;
1497
1498           break;
1499
1500         case ANIM_CONTINUE:
1501           if (part->state == ANIM_STATE_INACTIVE)
1502             continue;
1503
1504           break;
1505
1506         case ANIM_STOP:
1507           part->state = ANIM_STATE_INACTIVE;
1508
1509           continue;
1510
1511         default:
1512           break;
1513       }
1514
1515       part->state = HandleGlobalAnim_Part(part, part->state);
1516
1517       // when animation mode is "once", stop after animation was played once
1518       if (c->anim_mode & ANIM_ONCE &&
1519           part->state & ANIM_STATE_RESTART)
1520         part->state = ANIM_STATE_INACTIVE;
1521     }
1522
1523     anim->last_state = anim->state;
1524     anim->last_active_part_nr = anim->active_part_nr;
1525
1526     return;
1527   }
1528
1529   if (anim->state & ANIM_STATE_RESTART)         // directly after restart
1530     anim->active_part_nr = getGlobalAnimationPart(anim);
1531
1532   part = &anim->part[anim->active_part_nr];
1533
1534   // first set all animation parts to "inactive", ...
1535   for (i = 0; i < num_parts; i++)
1536     anim->part[i].state = ANIM_STATE_INACTIVE;
1537
1538   // ... then set current animation parts to "running"
1539   part->state = ANIM_STATE_RUNNING;
1540
1541   anim->state = HandleGlobalAnim_Part(part, anim->state);
1542
1543   if (anim->state & ANIM_STATE_RESTART)
1544     anim->part_counter++;
1545
1546   // when animation mode is "once", stop after all animations were played once
1547   if (c->anim_mode & ANIM_ONCE &&
1548       anim->part_counter == anim->num_parts)
1549     anim->state = ANIM_STATE_INACTIVE;
1550
1551   state = anim->state;
1552   active_part_nr = anim->active_part_nr;
1553
1554   // while the animation parts are pausing (waiting or inactive), play the base
1555   // (main) animation; this corresponds to the "boring player animation" logic
1556   // (!!! KLUDGE WARNING: I THINK THIS IS A MESS THAT SHOULD BE CLEANED UP !!!)
1557   if (anim->has_base)
1558   {
1559     if (anim->state == ANIM_STATE_WAITING ||
1560         anim->state == ANIM_STATE_INACTIVE)
1561     {
1562       anim->active_part_nr = anim->num_parts;   // part nr of base animation
1563       part = &anim->part[anim->active_part_nr];
1564
1565       if (anim->state != anim->last_state)
1566         part->state = ANIM_STATE_RESTART;
1567
1568       anim->state = ANIM_STATE_RUNNING;
1569       part->state = HandleGlobalAnim_Part(part, part->state);
1570     }
1571   }
1572
1573   anim->last_state = state;
1574   anim->last_active_part_nr = active_part_nr;
1575 }
1576
1577 static void HandleGlobalAnim_Mode(struct GlobalAnimControlInfo *ctrl, int action)
1578 {
1579   int i;
1580
1581 #if 0
1582   printf("::: HandleGlobalAnim_Mode: %d => %d\n",
1583          ctrl->nr, ctrl->num_anims);
1584 #endif
1585
1586   for (i = 0; i < ctrl->num_anims; i++)
1587     HandleGlobalAnim_Main(&ctrl->anim[i], action);
1588 }
1589
1590 static void HandleGlobalAnim(int action, int game_mode)
1591 {
1592 #if 0
1593   printf("::: HandleGlobalAnim [mode == %d]\n", game_status);
1594 #endif
1595
1596   HandleGlobalAnim_Mode(&global_anim_ctrl[game_mode], action);
1597 }
1598
1599 static void DoAnimationExt(void)
1600 {
1601   int i;
1602
1603 #if 0
1604   printf("::: DoAnimation [%d, %d]\n", anim_sync_frame, Counter());
1605 #endif
1606
1607   // global animations now synchronized with frame delay of screen update
1608   anim_sync_frame++;
1609
1610   for (i = 0; i < NUM_GAME_MODES; i++)
1611     HandleGlobalAnim(ANIM_CONTINUE, i);
1612
1613 #if 0
1614   // force screen redraw in next frame to continue drawing global animations
1615   redraw_mask = REDRAW_ALL;
1616 #endif
1617 }
1618
1619 static boolean DoGlobalAnim_EventAction(struct GlobalAnimPartControlInfo *part)
1620 {
1621   int anim_event_action = part->control_info.anim_event_action;
1622
1623   if (anim_event_action == -1)
1624     return FALSE;
1625
1626   boolean action_executed = (DoGadgetAction(anim_event_action) ||
1627                              DoScreenAction(anim_event_action) ||
1628                              DoKeysymAction(anim_event_action));
1629
1630   // check if further actions are allowed to be executed
1631   if (part->control_info.style & STYLE_MULTIPLE_ACTIONS)
1632     return FALSE;
1633
1634   return action_executed;
1635 }
1636
1637 static void InitGlobalAnim_Clickable(void)
1638 {
1639   int mode_nr;
1640
1641   for (mode_nr = 0; mode_nr < NUM_GAME_MODES; mode_nr++)
1642   {
1643     struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr];
1644     int anim_nr;
1645
1646     for (anim_nr = 0; anim_nr < ctrl->num_anims; anim_nr++)
1647     {
1648       struct GlobalAnimMainControlInfo *anim = &ctrl->anim[anim_nr];
1649       int part_nr;
1650
1651       for (part_nr = 0; part_nr < anim->num_parts_all; part_nr++)
1652       {
1653         struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
1654
1655         if (part->triggered)
1656           part->clicked = TRUE;
1657
1658         part->triggered = FALSE;
1659         part->clickable = FALSE;
1660       }
1661     }
1662   }
1663 }
1664
1665 static boolean InitGlobalAnim_Clicked(int mx, int my, boolean clicked)
1666 {
1667   boolean anything_clicked = FALSE;
1668   boolean any_part_clicked = FALSE;
1669   boolean any_event_action = FALSE;
1670   int mode_nr;
1671
1672   // check game modes in reverse draw order (to stop when clicked)
1673   for (mode_nr = NUM_GAME_MODES - 1; mode_nr >= 0; mode_nr--)
1674   {
1675     struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr];
1676     int anim_nr;
1677
1678     // check animations in reverse draw order (to stop when clicked)
1679     for (anim_nr = ctrl->num_anims - 1; anim_nr >= 0; anim_nr--)
1680     {
1681       struct GlobalAnimMainControlInfo *anim = &ctrl->anim[anim_nr];
1682       int part_nr;
1683
1684       // check animation parts in reverse draw order (to stop when clicked)
1685       for (part_nr = anim->num_parts_all - 1; part_nr >= 0; part_nr--)
1686       {
1687         struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
1688
1689         if (!clicked)
1690         {
1691           part->clicked = FALSE;
1692
1693           continue;
1694         }
1695
1696         if (!part->clickable)
1697           continue;
1698
1699         if (part->state != ANIM_STATE_RUNNING)
1700           continue;
1701
1702         // always handle "any" click events (clicking anywhere on screen) ...
1703         if (isClickablePart(part, ANIM_EVENT_ANY))
1704         {
1705 #if DEBUG_ANIM_EVENTS
1706           printf("::: => %d.%d TRIGGERED BY ANY\n",
1707                  part->old_anim_nr + 1, part->old_nr + 1);
1708 #endif
1709
1710           part->clicked = TRUE;
1711           anything_clicked = clickConsumed(part);
1712         }
1713
1714         // ... but only handle the first (topmost) clickable animation
1715         if (any_part_clicked)
1716           continue;
1717
1718         if (isClickedPart(part, mx, my, clicked))
1719         {
1720 #if 0
1721           printf("::: %d.%d CLICKED [%d]\n", anim_nr, part_nr,
1722                  part->control_info.anim_event_action);
1723 #endif
1724
1725           // after executing event action, ignore any further actions
1726           if (!any_event_action && DoGlobalAnim_EventAction(part))
1727             any_event_action = TRUE;
1728
1729           // determine if mouse clicks should be blocked from other animations
1730           any_part_clicked = clickConsumed(part);
1731
1732           if (isClickablePart(part, ANIM_EVENT_SELF))
1733           {
1734 #if DEBUG_ANIM_EVENTS
1735             printf("::: => %d.%d TRIGGERED BY SELF\n",
1736                    part->old_anim_nr + 1, part->old_nr + 1);
1737 #endif
1738
1739             part->clicked = TRUE;
1740             anything_clicked = clickConsumed(part);
1741           }
1742
1743           // check if this click is defined to trigger other animations
1744           InitGlobalAnim_Triggered(part, &anything_clicked, &any_event_action,
1745                                    ANIM_EVENT_CLICK, "CLICK");
1746         }
1747       }
1748     }
1749   }
1750
1751   return (anything_clicked || any_event_action);
1752 }
1753
1754 static void ResetGlobalAnim_Clickable(void)
1755 {
1756   InitGlobalAnim_Clickable();
1757 }
1758
1759 static void ResetGlobalAnim_Clicked(void)
1760 {
1761   InitGlobalAnim_Clicked(-1, -1, FALSE);
1762 }
1763
1764 boolean HandleGlobalAnimClicks(int mx, int my, int button)
1765 {
1766   static boolean click_consumed = FALSE;
1767   static int last_button = 0;
1768   boolean press_event;
1769   boolean release_event;
1770   boolean click_consumed_current = click_consumed;
1771
1772   // check if button state has changed since last invocation
1773   press_event   = (button != 0 && last_button == 0);
1774   release_event = (button == 0 && last_button != 0);
1775   last_button = button;
1776
1777   if (press_event)
1778   {
1779     click_consumed = InitGlobalAnim_Clicked(mx, my, TRUE);
1780     click_consumed_current = click_consumed;
1781   }
1782
1783   if (release_event)
1784     click_consumed = FALSE;
1785
1786   return click_consumed_current;
1787 }