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