src/anim.c

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