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