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