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