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