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