1 // ============================================================================
2 // Rocks'n'Diamonds - McDuffin Strikes Back!
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
12 #include "libgame/libgame.h"
23 #define DEBUG_ANIM_DELAY 0
24 #define DEBUG_ANIM_EVENTS 0
27 // values for global toon animation definition
28 #define NUM_GLOBAL_TOON_ANIMS 1
29 #define NUM_GLOBAL_TOON_PARTS MAX_NUM_TOONS
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)
37 #define MAX_GLOBAL_ANIM_LIST (NUM_GAME_MODES * \
38 NUM_GLOBAL_ANIMS_AND_TOONS * \
39 NUM_GLOBAL_ANIM_PARTS_AND_TOONS)
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
52 #define NUM_ANIM_CLASSES 10
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)
66 #define ANIM_CLASS_TOONS_SCORES (ANIM_CLASS_TOONS | \
70 #define ANIM_CLASS_TOONS_SCORESONLY (ANIM_CLASS_TOONS | \
72 ANIM_CLASS_SCORESONLY | \
75 #define ANIM_CLASS_TOONS_MENU_MAIN (ANIM_CLASS_TOONS | \
80 #define ANIM_CLASS_TOONS_MENU_SUBMENU (ANIM_CLASS_TOONS | \
82 ANIM_CLASS_SUBMENU | \
85 #define ANIM_CLASS_TOONS_MENU_SUBMENU_2 (ANIM_CLASS_TOONS | \
87 ANIM_CLASS_SUBMENU | \
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)
97 // values for global animation control
98 #define ANIM_NO_ACTION 0
100 #define ANIM_CONTINUE 2
104 struct GlobalAnimPartControlInfo
106 int old_nr; // position before mapping animation parts linearly
107 int old_anim_nr; // position before mapping animations linearly
113 boolean is_base; // animation part is base/main/default animation part
119 struct GraphicInfo graphic_info;
120 struct GraphicInfo control_info;
122 boolean class_playfield_or_door;
130 int step_xoffset, step_yoffset;
133 int tile_xoffset, tile_yoffset;
135 unsigned int initial_anim_sync_frame;
136 unsigned int anim_random_frame;
138 DelayCounter step_delay;
140 int init_delay_counter;
141 int anim_delay_counter;
142 int post_delay_counter;
144 int fade_delay_counter;
147 boolean init_event_state;
148 boolean anim_event_state;
157 int last_anim_status;
160 struct GlobalAnimMainControlInfo
162 struct GlobalAnimPartControlInfo base;
163 struct GlobalAnimPartControlInfo part[NUM_GLOBAL_ANIM_PARTS_AND_TOONS];
168 struct GraphicInfo control_info;
170 int num_parts; // number of animation parts, but without base part
171 int num_parts_all; // number of animation parts, including base part
175 boolean has_base; // animation has base/main/default animation part
179 int init_delay_counter;
183 int last_state, last_active_part_nr;
186 struct GlobalAnimControlInfo
188 struct GlobalAnimMainControlInfo anim[NUM_GLOBAL_ANIMS_AND_TOONS];
194 struct GameModeAnimClass
198 } game_mode_anim_classes_list[] =
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 },
228 struct AnimClassGameMode
232 } anim_class_game_modes_list[] =
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 },
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);
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;
260 static unsigned int anim_sync_frame = 0;
262 static int game_mode_anim_classes[NUM_GAME_MODES];
263 static int anim_class_game_modes[NUM_ANIM_CLASSES];
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;
269 static boolean drawing_to_fading_buffer = FALSE;
271 static boolean handle_click = FALSE;
274 // ============================================================================
275 // generic animation frame calculation
276 // ============================================================================
278 int getAnimationFrame(int num_frames, int delay, int mode, int start_frame,
283 if (delay < 1) // delay must be at least 1
286 sync_frame += start_frame * delay;
288 if (mode & ANIM_LOOP) // looping animation
290 frame = (sync_frame % (delay * num_frames)) / delay;
292 else if (mode & ANIM_LINEAR) // linear (non-looping) animation
294 frame = sync_frame / delay;
296 if (frame > num_frames - 1)
297 frame = num_frames - 1;
299 else if (mode & ANIM_PINGPONG) // oscillate (border frames once)
301 int max_anim_frames = (num_frames > 1 ? 2 * num_frames - 2 : 1);
303 frame = (sync_frame % (delay * max_anim_frames)) / delay;
304 frame = (frame < num_frames ? frame : max_anim_frames - frame);
306 else if (mode & ANIM_PINGPONG2) // oscillate (border frames twice)
308 int max_anim_frames = 2 * num_frames;
310 frame = (sync_frame % (delay * max_anim_frames)) / delay;
311 frame = (frame < num_frames ? frame : max_anim_frames - frame - 1);
313 else if (mode & ANIM_RANDOM) // play frames in random order
315 // note: expect different frames for the same delay cycle!
317 if (gfx.anim_random_frame < 0)
318 frame = GetSimpleRandom(num_frames);
320 frame = gfx.anim_random_frame % num_frames;
322 else if (mode & ANIM_LEVEL_NR) // play frames by level number
324 int level_pos = level_nr - gfx.anim_first_level;
326 frame = level_pos % num_frames;
328 else if (mode & (ANIM_CE_VALUE | ANIM_CE_SCORE | ANIM_CE_DELAY))
330 frame = sync_frame % num_frames;
333 if (mode & ANIM_REVERSE) // use reverse animation direction
334 frame = num_frames - frame - 1;
340 // ============================================================================
341 // global animation functions
342 // ============================================================================
344 static int getGlobalAnimationPart(struct GlobalAnimMainControlInfo *anim)
346 struct GraphicInfo *c = &anim->control_info;
347 int last_anim_random_frame = gfx.anim_random_frame;
350 gfx.anim_random_frame = -1; // (use simple, ad-hoc random numbers)
352 part_nr = getAnimationFrame(anim->num_parts, 1,
353 c->anim_mode, c->anim_start_frame,
356 gfx.anim_random_frame = last_anim_random_frame;
361 static int compareGlobalAnimPartControlInfo(const void *obj1, const void *obj2)
363 const struct GlobalAnimPartControlInfo *o1 =
364 *(struct GlobalAnimPartControlInfo **)obj1;
365 const struct GlobalAnimPartControlInfo *o2 =
366 *(struct GlobalAnimPartControlInfo **)obj2;
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;
376 compare_result = o1->nr - o2->nr;
378 return compare_result;
381 static boolean isPausedOnPlayfieldOrDoor(struct GlobalAnimPartControlInfo *part)
383 // only pause playfield and door animations when playing
384 if (game_status != GAME_MODE_PLAYING)
387 // do not pause animations when game ended (and engine is running)
388 if (checkGameEnded())
391 // only pause animations on playfield and doors
392 if (!part->class_playfield_or_door)
395 // only pause animations when engine is paused or request dialog is active
396 if (!tape.pausing && !game.request_active)
402 static void InitToonControls(void)
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;
412 if (global.num_toons >= 0 && global.num_toons < MAX_NUM_TOONS)
413 num_toons = global.num_toons;
415 mode_nr = mode_nr_toons;
416 anim_nr = ctrl->num_anims;
419 anim->mode_nr = mode_nr;
420 anim->control_info = graphic_info[control];
423 anim->num_parts_all = 0;
424 anim->part_counter = 0;
425 anim->active_part_nr = 0;
427 anim->has_base = FALSE;
429 anim->last_x = POS_OFFSCREEN;
430 anim->last_y = POS_OFFSCREEN;
432 anim->init_delay_counter = 0;
434 anim->state = ANIM_STATE_INACTIVE;
438 for (i = 0; i < num_toons; i++)
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;
448 part->anim_nr = anim_nr;
449 part->mode_nr = mode_nr;
451 part->is_base = FALSE;
455 part->graphic = graphic;
457 part->graphic_info = graphic_info[graphic];
458 part->control_info = graphic_info[control];
460 part->graphic_info.anim_delay *= part->graphic_info.step_delay;
462 part->control_info.init_delay_fixed = 0;
463 part->control_info.init_delay_random = 150;
465 part->control_info.x = ARG_UNDEFINED_VALUE;
466 part->control_info.y = ARG_UNDEFINED_VALUE;
468 part->initial_anim_sync_frame = 0;
469 part->anim_random_frame = -1;
471 part->step_delay.count = 0;
472 part->step_delay.value = graphic_info[control].step_delay;
474 part->state = ANIM_STATE_INACTIVE;
475 part->last_anim_status = -1;
478 anim->num_parts_all++;
486 static void InitGlobalAnimControls(void)
489 int mode_nr, anim_nr, part_nr;
490 int sound, music, graphic, control;
494 for (m = 0; m < NUM_GAME_MODES; m++)
498 struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr];
505 for (a = 0; a < NUM_GLOBAL_ANIMS; a++)
507 struct GlobalAnimMainControlInfo *anim = &ctrl->anim[anim_nr];
508 int ctrl_id = GLOBAL_ANIM_ID_CONTROL_FIRST + a;
510 control = global_anim_info[ctrl_id].graphic[GLOBAL_ANIM_ID_PART_BASE][m];
512 // if no base animation parameters defined, use default values
513 if (control == IMG_UNDEFINED)
514 control = IMG_INTERNAL_GLOBAL_ANIM_DEFAULT;
517 anim->mode_nr = mode_nr;
518 anim->control_info = graphic_info[control];
521 anim->num_parts_all = 0;
522 anim->part_counter = 0;
523 anim->active_part_nr = 0;
525 anim->has_base = FALSE;
527 anim->last_x = POS_OFFSCREEN;
528 anim->last_y = POS_OFFSCREEN;
530 anim->init_delay_counter = 0;
532 anim->state = ANIM_STATE_INACTIVE;
536 for (p = 0; p < NUM_GLOBAL_ANIM_PARTS_ALL; p++)
538 struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
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];
545 if (graphic == IMG_UNDEFINED || graphic_info[graphic].bitmap == NULL ||
546 control == IMG_UNDEFINED)
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);
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);
562 part->old_anim_nr = a;
565 part->anim_nr = anim_nr;
566 part->mode_nr = mode_nr;
570 part->graphic = graphic;
572 part->graphic_info = graphic_info[graphic];
573 part->control_info = graphic_info[control];
575 part->initial_anim_sync_frame = 0;
576 part->anim_random_frame = -1;
578 part->step_delay.count = 0;
579 part->step_delay.value = graphic_info[control].step_delay;
581 part->state = ANIM_STATE_INACTIVE;
582 part->last_anim_status = -1;
584 anim->num_parts_all++;
586 if (p < GLOBAL_ANIM_ID_PART_BASE)
588 part->is_base = FALSE;
595 part->is_base = TRUE;
598 anim->has_base = TRUE;
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;
607 if (anim->num_parts > 0 || anim->has_base)
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];
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);
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;
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;
642 anim_status_last_before_fading = GAME_MODE_LOADING;
643 anim_status_last = GAME_MODE_LOADING;
644 anim_classes_last = ANIM_CLASS_NONE;
647 static void SetGlobalAnimEventsForCustomElements(int list_pos)
649 int num_events = GetGlobalAnimEventValueCount(list_pos);
652 for (i = 0; i < num_events; i++)
654 int event = GetGlobalAnimEventValue(list_pos, i);
656 if (event & ANIM_EVENT_CE_CHANGE)
658 int nr = (event >> ANIM_EVENT_CE_BIT) & 0xff;
660 if (nr >= 0 && nr < NUM_CUSTOM_ELEMENTS)
661 element_info[EL_CUSTOM_START + nr].has_anim_event = TRUE;
666 void InitGlobalAnimEventsForCustomElements(void)
671 // custom element events for global animations only relevant while playing
672 m = GAME_MODE_PLAYING;
674 for (a = 0; a < NUM_GLOBAL_ANIMS; a++)
676 int ctrl_id = GLOBAL_ANIM_ID_CONTROL_FIRST + a;
678 control = global_anim_info[ctrl_id].graphic[GLOBAL_ANIM_ID_PART_BASE][m];
680 // if no base animation parameters defined, use default values
681 if (control == IMG_UNDEFINED)
682 control = IMG_INTERNAL_GLOBAL_ANIM_DEFAULT;
684 SetGlobalAnimEventsForCustomElements(graphic_info[control].init_event);
685 SetGlobalAnimEventsForCustomElements(graphic_info[control].anim_event);
687 for (p = 0; p < NUM_GLOBAL_ANIM_PARTS_ALL; p++)
689 control = global_anim_info[ctrl_id].graphic[p][m];
691 if (control == IMG_UNDEFINED)
694 SetGlobalAnimEventsForCustomElements(graphic_info[control].init_event);
695 SetGlobalAnimEventsForCustomElements(graphic_info[control].anim_event);
700 void InitGlobalAnimations(void)
702 InitGlobalAnimControls();
705 static void BlitGlobalAnimation(struct GlobalAnimPartControlInfo *part,
706 Bitmap *src_bitmap, int src_x0, int src_y0,
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);
721 for (y = 0; y < c->stacked_yfactor; y++)
723 for (x = 0; x < c->stacked_xfactor; x++)
727 int dst_x = part->x + x * (g->width + c->stacked_xoffset);
728 int dst_y = part->y + y * (g->height + c->stacked_yoffset);
731 int width = g->width;
732 int height = g->height;
740 else if (dst_x > part->viewport_width - g->width)
742 width -= (dst_x - (part->viewport_width - g->width));
751 else if (dst_y > part->viewport_height - g->height)
753 height -= (dst_y - (part->viewport_height - g->height));
756 if (width <= 0 || height <= 0)
762 dst_x += part->viewport_x;
763 dst_y += part->viewport_y;
765 SetBitmapAlphaNextBlit(src_bitmap, alpha);
767 if (drawing_target == DRAW_TO_SCREEN)
768 blit_screen(src_bitmap, src_x, src_y, width, height,
771 blit_bitmap(src_bitmap, fade_bitmap, src_x, src_y, width, height,
777 static void DrawGlobalAnimationsExt(int drawing_target, int drawing_stage)
779 int game_mode_anim_action[NUM_GAME_MODES];
786 if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_1 &&
787 drawing_target == DRAW_TO_SCREEN)
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;
794 if (global.anim_status != anim_status_last)
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];
801 if (drawing_target == DRAW_TO_FADE_TARGET)
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)
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")
815 if (global.anim_status_next != anim_status_last_before_fading)
817 // stop animations for last screen before fading to new screen
818 game_mode_anim_action[anim_status_last] = ANIM_STOP;
820 // start animations for current screen after fading to new screen
821 game_mode_anim_action[global.anim_status] = ANIM_START;
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;
828 // ---------- part 2 ------------------------------------------------------
829 // start or stop global animations by change of animation class
830 // (generic handling of animations for "class of screens")
832 for (i = 0; i < NUM_ANIM_CLASSES; i++)
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;
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;
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;
848 if (drawing_target == DRAW_TO_SCREEN)
852 anim_classes_last = anim_classes_next;
853 anim_status_last_before_fading = global.anim_status;
856 anim_status_last = global.anim_status;
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);
863 else if (drawing_target == DRAW_TO_FADE_TARGET)
865 drawing_to_fading_buffer = TRUE;
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);
874 // when restarting global animations, do not redraw them, but stop here
875 if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_RESTART)
878 if (global.anim_status == GAME_MODE_LOADING)
881 for (i = 0; i < num_global_anim_list; i++)
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;
891 int last_anim_random_frame = gfx.anim_random_frame;
893 // when preparing source fading buffer, only draw animations to be stopped
894 if (drawing_target == DRAW_TO_FADE_SOURCE &&
895 game_mode_anim_action[part->mode_nr] != ANIM_STOP)
898 // when preparing target fading buffer, only draw animations to be started
899 if (drawing_target == DRAW_TO_FADE_TARGET &&
900 game_mode_anim_action[part->mode_nr] != ANIM_START)
903 if (!(anim->state & ANIM_STATE_RUNNING))
906 if (!(part->state & ANIM_STATE_RUNNING))
909 if (part->drawing_stage != drawing_stage)
912 // if game is paused, also pause playfield and door animations
913 if (isPausedOnPlayfieldOrDoor(part))
914 part->initial_anim_sync_frame++;
916 sync_frame = anim_sync_frame - part->initial_anim_sync_frame;
918 // re-initialize random animation frame after animation delay
919 if (g->anim_mode == ANIM_RANDOM &&
920 sync_frame % g->anim_delay == 0 &&
922 part->anim_random_frame = GetSimpleRandom(g->anim_frames);
924 gfx.anim_random_frame = part->anim_random_frame;
926 frame = getAnimationFrame(g->anim_frames, g->anim_delay,
927 g->anim_mode, g->anim_start_frame,
930 gfx.anim_random_frame = last_anim_random_frame;
932 getGlobalAnimGraphicSource(part->graphic, frame, &src_bitmap,
935 BlitGlobalAnimation(part, src_bitmap, src_x, src_y, drawing_target);
938 if (drawing_target == DRAW_TO_FADE_TARGET)
940 // stop animations determined to be (temporary) started above
941 for (mode_nr = 0; mode_nr < NUM_GAME_MODES; mode_nr++)
942 if (game_mode_anim_action[mode_nr] == ANIM_START)
943 HandleGlobalAnim(ANIM_STOP, mode_nr);
945 drawing_to_fading_buffer = FALSE;
949 void DrawGlobalAnimations(int drawing_target, int drawing_stage)
951 int last_cursor_mode_override = gfx.cursor_mode_override;
953 if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_1)
955 ResetGlobalAnim_Clickable();
957 gfx.cursor_mode_override = CURSOR_UNDEFINED;
960 DrawGlobalAnimationsExt(drawing_target, drawing_stage);
962 if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_2)
964 ResetGlobalAnim_Clicked();
967 if (gfx.cursor_mode_override != last_cursor_mode_override)
968 SetMouseCursor(gfx.cursor_mode);
971 static boolean SetGlobalAnimPart_Viewport(struct GlobalAnimPartControlInfo *part)
977 boolean changed = FALSE;
979 if (part->last_anim_status == global.anim_status &&
980 part->control_info.class != get_hash_from_key("pointer"))
983 part->last_anim_status = global.anim_status;
985 part->drawing_stage = DRAW_GLOBAL_ANIM_STAGE_1;
987 part->class_playfield_or_door = FALSE;
989 if (part->control_info.class == get_hash_from_key("window") ||
990 part->control_info.class == get_hash_from_key("border"))
994 viewport_width = WIN_XSIZE;
995 viewport_height = WIN_YSIZE;
997 part->drawing_stage = DRAW_GLOBAL_ANIM_STAGE_2;
999 else if (part->control_info.class == get_hash_from_key("pointer"))
1001 int mx = MIN(MAX(0, gfx.mouse_x), WIN_XSIZE - 1);
1002 int my = MIN(MAX(0, gfx.mouse_y), WIN_YSIZE - 1);
1004 // prevent displaying off-screen custom mouse cursor in upper left corner
1005 if (gfx.mouse_x == POS_OFFSCREEN &&
1006 gfx.mouse_y == POS_OFFSCREEN)
1007 mx = my = POS_OFFSCREEN;
1009 viewport_x = mx - part->control_info.x;
1010 viewport_y = my - part->control_info.y;
1011 viewport_width = part->graphic_info.width;
1012 viewport_height = part->graphic_info.height;
1014 part->drawing_stage = DRAW_GLOBAL_ANIM_STAGE_3;
1016 // do not use global animation mouse pointer when reloading artwork
1017 if (global.anim_status != GAME_MODE_LOADING)
1018 gfx.cursor_mode_override = CURSOR_NONE;
1020 else if (part->control_info.class == get_hash_from_key("door_1"))
1024 viewport_width = DXSIZE;
1025 viewport_height = DYSIZE;
1027 part->class_playfield_or_door = TRUE;
1029 else if (part->control_info.class == get_hash_from_key("door_2"))
1031 if (part->mode_nr == GAME_MODE_EDITOR)
1035 viewport_width = EXSIZE;
1036 viewport_height = EYSIZE;
1042 viewport_width = VXSIZE;
1043 viewport_height = VYSIZE;
1046 part->class_playfield_or_door = TRUE;
1048 else // default: "playfield"
1050 viewport_x = REAL_SX;
1051 viewport_y = REAL_SY;
1052 viewport_width = FULL_SXSIZE;
1053 viewport_height = FULL_SYSIZE;
1055 part->class_playfield_or_door = TRUE;
1058 if (viewport_x != part->viewport_x ||
1059 viewport_y != part->viewport_y ||
1060 viewport_width != part->viewport_width ||
1061 viewport_height != part->viewport_height)
1063 part->viewport_x = viewport_x;
1064 part->viewport_y = viewport_y;
1065 part->viewport_width = viewport_width;
1066 part->viewport_height = viewport_height;
1068 if (part->control_info.class != get_hash_from_key("pointer"))
1075 static void PlayGlobalAnimSound(struct GlobalAnimPartControlInfo *part)
1077 int sound = part->sound;
1079 if (sound == SND_UNDEFINED)
1082 if ((!setup.sound_simple && !IS_LOOP_SOUND(sound)) ||
1083 (!setup.sound_loops && IS_LOOP_SOUND(sound)))
1086 // !!! TODO: ADD STEREO POSITION FOR MOVING ANIMATIONS !!!
1087 if (IS_LOOP_SOUND(sound))
1088 PlaySoundLoop(sound);
1093 Debug("anim:PlayGlobalAnimSound", "PLAY SOUND %d.%d.%d: %d",
1094 part->anim_nr, part->nr, part->mode_nr, sound);
1098 static void StopGlobalAnimSound(struct GlobalAnimPartControlInfo *part)
1100 int sound = part->sound;
1102 if (sound == SND_UNDEFINED)
1108 Debug("anim:StopGlobalAnimSound", "STOP SOUND %d.%d.%d: %d",
1109 part->anim_nr, part->nr, part->mode_nr, sound);
1113 static void PlayGlobalAnimMusic(struct GlobalAnimPartControlInfo *part)
1115 int music = part->music;
1117 if (music == MUS_UNDEFINED)
1120 if (!setup.sound_music)
1123 if (IS_LOOP_MUSIC(music))
1124 PlayMusicLoop(music);
1129 Debug("anim:PlayGlobalAnimMusic", "PLAY MUSIC %d.%d.%d: %d",
1130 part->anim_nr, part->nr, part->mode_nr, music);
1134 static void StopGlobalAnimMusic(struct GlobalAnimPartControlInfo *part)
1136 int music = part->music;
1138 if (music == MUS_UNDEFINED)
1141 char *anim_music = getMusicInfoEntryFilename(music);
1142 char *curr_music = getCurrentlyPlayingMusicFilename();
1144 // do not stop music if global anim music differs from current music
1145 if (!strEqual(curr_music, anim_music))
1151 Debug("anim:StopGlobalAnimMusic", "STOP MUSIC %d.%d.%d: %d",
1152 part->anim_nr, part->nr, part->mode_nr, music);
1156 static void PlayGlobalAnimSoundAndMusic(struct GlobalAnimPartControlInfo *part)
1158 // when drawing animations to fading buffer, do not play sounds or music
1159 if (drawing_to_fading_buffer)
1162 PlayGlobalAnimSound(part);
1163 PlayGlobalAnimMusic(part);
1166 static void StopGlobalAnimSoundAndMusic(struct GlobalAnimPartControlInfo *part)
1168 StopGlobalAnimSound(part);
1169 StopGlobalAnimMusic(part);
1172 static void PlayGlobalAnimSoundIfLoop(struct GlobalAnimPartControlInfo *part)
1174 // when drawing animations to fading buffer, do not play sounds
1175 if (drawing_to_fading_buffer)
1178 // loop sounds only expire when playing
1179 if (game_status != GAME_MODE_PLAYING)
1182 // check if any sound is defined for this animation part
1183 if (part->sound == SND_UNDEFINED)
1186 // normal (non-loop) sounds do not expire when playing
1187 if (!IS_LOOP_SOUND(part->sound))
1190 // prevent expiring loop sounds when playing
1191 PlayGlobalAnimSound(part);
1194 static boolean checkGlobalAnimEvent(int anim_event, int mask)
1196 int mask_anim_only = mask & ~ANIM_EVENT_PART_MASK;
1197 int mask_ce_only = mask & ~ANIM_EVENT_PAGE_MASK;
1199 if (mask & ANIM_EVENT_ANY)
1200 return (anim_event & ANIM_EVENT_ANY);
1201 else if (mask & ANIM_EVENT_SELF)
1202 return (anim_event & ANIM_EVENT_SELF);
1203 else if (mask & ANIM_EVENT_UNCLICK_ANY)
1204 return (anim_event & ANIM_EVENT_UNCLICK_ANY);
1205 else if (mask & ANIM_EVENT_CE_CHANGE)
1206 return (anim_event == mask ||
1207 anim_event == mask_ce_only);
1209 return (anim_event == mask ||
1210 anim_event == mask_anim_only);
1213 static boolean isClickablePart(struct GlobalAnimPartControlInfo *part, int mask)
1215 struct GraphicInfo *c = &part->control_info;
1218 if (part->init_event_state)
1220 int num_init_events = GetGlobalAnimEventValueCount(c->init_event);
1222 for (i = 0; i < num_init_events; i++)
1224 int init_event = GetGlobalAnimEventValue(c->init_event, i);
1226 if (checkGlobalAnimEvent(init_event, mask))
1230 else if (part->anim_event_state)
1232 int num_anim_events = GetGlobalAnimEventValueCount(c->anim_event);
1234 for (i = 0; i < num_anim_events; i++)
1236 int anim_event = GetGlobalAnimEventValue(c->anim_event, i);
1238 if (checkGlobalAnimEvent(anim_event, mask))
1246 static boolean isInsidePartStacked(struct GlobalAnimPartControlInfo *part,
1249 struct GraphicInfo *g = &part->graphic_info;
1250 struct GraphicInfo *c = &part->control_info;
1251 int part_x = part->viewport_x + part->x;
1252 int part_y = part->viewport_y + part->y;
1253 int part_width = g->width;
1254 int part_height = g->height;
1257 for (y = 0; y < c->stacked_yfactor; y++)
1259 for (x = 0; x < c->stacked_xfactor; x++)
1261 int part_stacked_x = part_x + x * (part_width + c->stacked_xoffset);
1262 int part_stacked_y = part_y + y * (part_height + c->stacked_yoffset);
1264 if (mx >= part_stacked_x &&
1265 mx < part_stacked_x + part_width &&
1266 my >= part_stacked_y &&
1267 my < part_stacked_y + part_height)
1275 static boolean isClickedPart(struct GlobalAnimPartControlInfo *part,
1276 int mx, int my, boolean clicked)
1278 // check if mouse click was detected at all
1282 // check if mouse click is outside the animation part's viewport
1283 if (mx < part->viewport_x ||
1284 mx >= part->viewport_x + part->viewport_width ||
1285 my < part->viewport_y ||
1286 my >= part->viewport_y + part->viewport_height)
1289 // check if mouse click is inside the animation part's (stacked) graphic
1290 if (isInsidePartStacked(part, mx, my))
1296 static boolean clickBlocked(struct GlobalAnimPartControlInfo *part)
1298 return ((part->control_info.style & STYLE_BLOCK) ? TRUE : FALSE);
1301 static boolean clickConsumed(struct GlobalAnimPartControlInfo *part)
1303 return ((part->control_info.style & STYLE_PASSTHROUGH) ? FALSE : TRUE);
1306 static void SetGlobalAnimPartTileXY(struct GlobalAnimPartControlInfo *part)
1308 // calculate playfield position (with scrolling) for related CE tile
1309 // (do not use FX/FY, which are incorrect during envelope requests)
1310 int FX0 = 2 * TILEX_VAR; // same as FX during DRAW_TO_FIELDBUFFER
1311 int FY0 = 2 * TILEY_VAR; // same as FY during DRAW_TO_FIELDBUFFER
1312 int fx = getFieldbufferOffsetX_RND(ScreenMovDir, ScreenGfxPos);
1313 int fy = getFieldbufferOffsetY_RND(ScreenMovDir, ScreenGfxPos);
1314 int sx = FX0 + SCREENX(part->tile_x) * TILEX_VAR;
1315 int sy = FY0 + SCREENY(part->tile_y) * TILEY_VAR;
1316 int cx = SX - REAL_SX;
1317 int cy = SY - REAL_SY;
1318 int x = sx - fx + cx;
1319 int y = sy - fy + cy;
1321 part->tile_xoffset += part->step_xoffset;
1322 part->tile_yoffset += part->step_yoffset;
1324 part->x = x + part->tile_xoffset;
1325 part->y = y + part->tile_yoffset;
1328 static void InitGlobalAnim_Triggered(struct GlobalAnimPartControlInfo *part,
1329 boolean *click_consumed,
1330 boolean *any_event_action,
1331 int event_value, char *info_text)
1333 struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[part->mode_nr];
1335 int gic_anim_nr = part->old_anim_nr + 1; // X as in "anim_X"
1336 int gic_part_nr = part->old_nr + 1; // Y as in "part_Y"
1337 int mask = event_value | (gic_anim_nr << ANIM_EVENT_ANIM_BIT);
1340 mask |= gic_part_nr << ANIM_EVENT_PART_BIT;
1344 for (anim2_nr = 0; anim2_nr < ctrl->num_anims; anim2_nr++)
1346 struct GlobalAnimMainControlInfo *anim2 = &ctrl->anim[anim2_nr];
1349 for (part2_nr = 0; part2_nr < anim2->num_parts_all; part2_nr++)
1351 struct GlobalAnimPartControlInfo *part2 = &anim2->part[part2_nr];
1353 if (!(part2->state & (ANIM_STATE_RUNNING | ANIM_STATE_WAITING)))
1356 if (isClickablePart(part2, mask))
1358 part2->triggered = TRUE;
1359 *click_consumed |= clickConsumed(part); // click was on "part"!
1361 #if DEBUG_ANIM_EVENTS
1362 Debug("anim:InitGlobalAnim_Triggered",
1363 "%d.%d TRIGGERED BY %s OF %d.%d",
1364 part2->old_anim_nr + 1, part2->old_nr + 1, info_text,
1365 part->old_anim_nr + 1, part->old_nr + 1);
1368 Debug("anim:InitGlobalAnim_Triggered",
1369 "%d.%d TRIGGER CLICKED [%d]", anim2_nr, part2_nr,
1370 part2->control_info.anim_event_action);
1373 // after executing event action, ignore any further actions
1374 if (!*any_event_action && DoGlobalAnim_EventAction(part2))
1375 *any_event_action = TRUE;
1379 struct GraphicInfo *c = &part2->control_info;
1381 if (isClickablePart(part2, mask))
1382 Debug("anim:InitGlobalAnim_Triggered",
1383 "%d.%d: 0x%08x, 0x%08x [0x%08x] <--- TRIGGERED BY %d.%d",
1384 anim2_nr, part2_nr, c->init_event, c->anim_event, mask,
1387 Debug("anim:InitGlobalAnim_Triggered",
1388 "%d.%d: 0x%08x, 0x%08x [0x%08x]",
1389 anim2_nr, part2_nr, c->init_event, c->anim_event, mask);
1395 static void InitGlobalAnim_Triggered_ByCustomElement(int nr, int page,
1400 struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[GAME_MODE_PLAYING];
1402 int event_value = ANIM_EVENT_CE_CHANGE;
1403 int event_bits = (nr << ANIM_EVENT_CE_BIT) | (page << ANIM_EVENT_PAGE_BIT);
1404 int mask = event_value | event_bits;
1407 for (anim2_nr = 0; anim2_nr < ctrl->num_anims; anim2_nr++)
1409 struct GlobalAnimMainControlInfo *anim2 = &ctrl->anim[anim2_nr];
1412 for (part2_nr = 0; part2_nr < anim2->num_parts_all; part2_nr++)
1414 struct GlobalAnimPartControlInfo *part2 = &anim2->part[part2_nr];
1416 if (!(part2->state & (ANIM_STATE_RUNNING | ANIM_STATE_WAITING)))
1419 if (isClickablePart(part2, mask) && !part2->triggered)
1421 struct GraphicInfo *c = &part2->control_info;
1423 if (c->position == POS_CE ||
1424 c->position == POS_CE_TRIGGER)
1426 // store CE tile and offset position to handle scrolling
1427 part2->tile_x = (c->position == POS_CE_TRIGGER ? trigger_x : x);
1428 part2->tile_y = (c->position == POS_CE_TRIGGER ? trigger_y : y);
1429 part2->tile_xoffset = c->x;
1430 part2->tile_yoffset = c->y;
1432 // set resulting animation position relative to CE tile position
1433 // (but only for ".init_event", not ".anim_event" type events)
1434 if (part2->init_event_state)
1435 SetGlobalAnimPartTileXY(part2);
1437 // restart animation (by using current sync frame)
1438 part2->initial_anim_sync_frame = anim_sync_frame;
1441 part2->triggered = TRUE;
1443 // do not trigger any other animation if CE change event was consumed
1444 if (c->style == STYLE_CONSUME_CE_EVENT)
1448 Debug("anim:InitGlobalAnim_Triggered_ByCustomElement",
1449 "%d.%d TRIGGERED BY CE %d", anim2_nr, part2_nr, nr + 1);
1456 static void HandleGlobalAnimDelay(struct GlobalAnimPartControlInfo *part,
1457 int delay_type, char *info_text)
1459 #if DEBUG_ANIM_DELAY
1460 Debug("anim:HandleGlobalAnimDelay", "%d.%d %s",
1461 part->old_anim_nr + 1, part->old_nr + 1, info_text);
1464 DoGlobalAnim_DelayAction(part, delay_type);
1467 static void HandleGlobalAnimEvent(struct GlobalAnimPartControlInfo *part,
1468 int event_value, char *info_text)
1470 #if DEBUG_ANIM_EVENTS
1471 Debug("anim:HandleGlobalAnimEvent", "%d.%d %s",
1472 part->old_anim_nr + 1, part->old_nr + 1, info_text);
1475 boolean click_consumed = FALSE;
1476 boolean any_event_action = FALSE;
1478 // check if this event is defined to trigger other animations
1479 InitGlobalAnim_Triggered(part, &click_consumed, &any_event_action,
1480 event_value, info_text);
1483 static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
1486 if (handle_click && !part->clicked)
1489 struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[part->mode_nr];
1490 struct GlobalAnimMainControlInfo *anim = &ctrl->anim[part->anim_nr];
1491 struct GraphicInfo *g = &part->graphic_info;
1492 struct GraphicInfo *c = &part->control_info;
1493 boolean viewport_changed = SetGlobalAnimPart_Viewport(part);
1494 int alpha = (g->alpha != -1 ? g->alpha : SDL_ALPHA_OPAQUE);
1496 // if game is paused, also pause playfield and door animations
1497 if (isPausedOnPlayfieldOrDoor(part))
1500 if (viewport_changed)
1501 state |= ANIM_STATE_RESTART;
1503 if (state & ANIM_STATE_RESTART)
1505 // when drawing animations to fading buffer, only start fixed animations
1506 if (drawing_to_fading_buffer && (c->x == ARG_UNDEFINED_VALUE ||
1507 c->y == ARG_UNDEFINED_VALUE))
1508 return ANIM_STATE_INACTIVE;
1510 ResetDelayCounterExt(&part->step_delay, anim_sync_frame);
1512 part->init_delay_counter =
1513 (c->init_delay_fixed + GetSimpleRandom(c->init_delay_random));
1515 part->anim_delay_counter =
1516 (c->anim_delay_fixed + GetSimpleRandom(c->anim_delay_random));
1518 part->post_delay_counter = 0;
1520 part->init_event_state = (c->init_event != ANIM_EVENT_UNDEFINED);
1521 part->anim_event_state = (c->anim_event != ANIM_EVENT_UNDEFINED);
1523 part->initial_anim_sync_frame =
1524 (g->anim_global_sync || g->anim_global_anim_sync ? 0 :
1525 anim_sync_frame + part->init_delay_counter);
1527 // do not re-initialize random animation frame after fade-in
1528 if (part->anim_random_frame == -1)
1529 part->anim_random_frame = GetSimpleRandom(g->anim_frames);
1531 if (c->fade_mode & FADE_MODE_FADE)
1533 // when fading in screen, first frame is 100 % transparent or opaque
1534 part->fade_delay_counter = c->fade_delay + 1;
1535 part->fade_alpha = (c->fade_mode == FADE_MODE_FADE_IN ? 0 : alpha);
1539 part->fade_delay_counter = 0;
1540 part->fade_alpha = -1;
1543 if (c->direction & MV_HORIZONTAL)
1545 int pos_bottom = part->viewport_height - g->height;
1547 if (c->position == POS_TOP)
1549 else if (c->position == POS_UPPER)
1550 part->y = GetSimpleRandom(pos_bottom / 2);
1551 else if (c->position == POS_MIDDLE)
1552 part->y = pos_bottom / 2;
1553 else if (c->position == POS_LOWER)
1554 part->y = pos_bottom / 2 + GetSimpleRandom(pos_bottom / 2);
1555 else if (c->position == POS_BOTTOM)
1556 part->y = pos_bottom;
1558 part->y = GetSimpleRandom(pos_bottom);
1560 if (c->direction == MV_RIGHT)
1562 part->step_xoffset = c->step_offset;
1563 part->x = -g->width + part->step_xoffset;
1567 part->step_xoffset = -c->step_offset;
1568 part->x = part->viewport_width + part->step_xoffset;
1571 part->step_yoffset = 0;
1573 else if (c->direction & MV_VERTICAL)
1575 int pos_right = part->viewport_width - g->width;
1577 if (c->position == POS_LEFT)
1579 else if (c->position == POS_RIGHT)
1580 part->x = pos_right;
1582 part->x = GetSimpleRandom(pos_right);
1584 if (c->direction == MV_DOWN)
1586 part->step_yoffset = c->step_offset;
1587 part->y = -g->height + part->step_yoffset;
1591 part->step_yoffset = -c->step_offset;
1592 part->y = part->viewport_height + part->step_yoffset;
1595 part->step_xoffset = 0;
1602 part->step_xoffset = 0;
1603 part->step_yoffset = 0;
1606 if (part->control_info.class != get_hash_from_key("pointer"))
1608 if (c->x != ARG_UNDEFINED_VALUE)
1610 if (c->y != ARG_UNDEFINED_VALUE)
1614 if (c->position == POS_LAST &&
1615 anim->last_x > -g->width && anim->last_x < part->viewport_width &&
1616 anim->last_y > -g->height && anim->last_y < part->viewport_height)
1618 part->x = anim->last_x;
1619 part->y = anim->last_y;
1622 if (c->step_xoffset != ARG_UNDEFINED_VALUE)
1623 part->step_xoffset = c->step_xoffset;
1624 if (c->step_yoffset != ARG_UNDEFINED_VALUE)
1625 part->step_yoffset = c->step_yoffset;
1627 if (part->init_delay_counter == 0 &&
1628 !part->init_event_state)
1630 PlayGlobalAnimSoundAndMusic(part);
1632 HandleGlobalAnimDelay(part, ANIM_DELAY_INIT, "START [INIT_DELAY]");
1633 HandleGlobalAnimEvent(part, ANIM_EVENT_START, "START [ANIM]");
1637 HandleGlobalAnimEvent(part, ANIM_EVENT_INIT, "START [INIT_DELAY/EVENT]");
1641 if (part->clicked &&
1642 part->init_event_state)
1644 if (part->initial_anim_sync_frame > 0)
1645 part->initial_anim_sync_frame = anim_sync_frame;
1647 part->init_delay_counter = 1;
1648 part->init_event_state = FALSE;
1650 part->clicked = FALSE;
1653 if (part->clicked &&
1654 part->anim_event_state)
1656 part->anim_delay_counter = 1;
1657 part->anim_event_state = FALSE;
1659 part->clicked = FALSE;
1662 if (part->init_delay_counter > 0)
1664 part->init_delay_counter--;
1666 if (part->init_delay_counter == 0)
1668 part->init_event_state = FALSE;
1670 PlayGlobalAnimSoundAndMusic(part);
1672 HandleGlobalAnimDelay(part, ANIM_DELAY_INIT, "START [INIT_DELAY]");
1673 HandleGlobalAnimEvent(part, ANIM_EVENT_START, "START [ANIM]");
1675 // continue with state ANIM_STATE_RUNNING (set below)
1679 return ANIM_STATE_WAITING;
1683 if (part->init_event_state)
1684 return ANIM_STATE_WAITING;
1686 // animation part is now running/visible and therefore clickable
1687 part->clickable = TRUE;
1689 // check if moving animation has left the visible screen area
1690 if ((part->x <= -g->width && part->step_xoffset <= 0) ||
1691 (part->x >= part->viewport_width && part->step_xoffset >= 0) ||
1692 (part->y <= -g->height && part->step_yoffset <= 0) ||
1693 (part->y >= part->viewport_height && part->step_yoffset >= 0))
1695 // do not wait for "anim" events for off-screen animations
1696 part->anim_event_state = FALSE;
1698 // do not stop animation before "anim" or "post" counter are finished
1699 if (part->anim_delay_counter == 0 &&
1700 part->post_delay_counter == 0)
1702 StopGlobalAnimSoundAndMusic(part);
1704 HandleGlobalAnimEvent(part, ANIM_EVENT_END, "END [ANIM/OFF-SCREEN]");
1706 part->post_delay_counter =
1707 (c->post_delay_fixed + GetSimpleRandom(c->post_delay_random));
1709 if (part->post_delay_counter > 0)
1710 return ANIM_STATE_RUNNING;
1712 // drawing last frame not needed here -- animation not visible anymore
1713 return ANIM_STATE_RESTART;
1717 if (part->anim_delay_counter > 0)
1719 part->anim_delay_counter--;
1721 if (part->anim_delay_counter == 0)
1723 part->anim_event_state = FALSE;
1725 StopGlobalAnimSoundAndMusic(part);
1727 HandleGlobalAnimDelay(part, ANIM_DELAY_ANIM, "END [ANIM_DELAY]");
1728 HandleGlobalAnimEvent(part, ANIM_EVENT_END, "END [ANIM_DELAY/EVENT]");
1730 part->post_delay_counter =
1731 (c->post_delay_fixed + GetSimpleRandom(c->post_delay_random));
1733 if (part->post_delay_counter > 0)
1734 return ANIM_STATE_RUNNING;
1736 // additional state "RUNNING" required to not skip drawing last frame
1737 return ANIM_STATE_RESTART | ANIM_STATE_RUNNING;
1741 if (part->post_delay_counter > 0)
1743 part->post_delay_counter--;
1745 if (part->post_delay_counter == 0)
1747 HandleGlobalAnimDelay(part, ANIM_DELAY_POST, "END [POST_DELAY]");
1748 HandleGlobalAnimEvent(part, ANIM_EVENT_POST, "END [POST_DELAY]");
1750 return ANIM_STATE_RESTART;
1753 return ANIM_STATE_WAITING;
1756 if (part->fade_delay_counter > 0)
1758 part->fade_delay_counter--;
1759 part->fade_alpha = alpha * (c->fade_mode == FADE_MODE_FADE_IN ?
1760 c->fade_delay - part->fade_delay_counter :
1761 part->fade_delay_counter) / c->fade_delay;
1764 // special case to prevent expiring loop sounds when playing
1765 PlayGlobalAnimSoundIfLoop(part);
1767 if (!DelayReachedExt(&part->step_delay, anim_sync_frame))
1768 return ANIM_STATE_RUNNING;
1772 static unsigned int last_counter = -1;
1773 unsigned int counter = Counter();
1775 Debug("anim:HandleGlobalAnim_Part", "NEXT ANIM PART [%d, %d]",
1776 anim_sync_frame, counter - last_counter);
1778 last_counter = counter;
1782 if (c->position == POS_CE ||
1783 c->position == POS_CE_TRIGGER)
1785 SetGlobalAnimPartTileXY(part);
1789 part->x += part->step_xoffset;
1790 part->y += part->step_yoffset;
1793 anim->last_x = part->x;
1794 anim->last_y = part->y;
1796 return ANIM_STATE_RUNNING;
1799 static void HandleGlobalAnim_Main(struct GlobalAnimMainControlInfo *anim,
1802 struct GlobalAnimPartControlInfo *part;
1803 struct GraphicInfo *c = &anim->control_info;
1804 int num_parts = anim->num_parts + (anim->has_base ? 1 : 0);
1805 int state, active_part_nr;
1809 Debug("anim:HandleGlobalAnim_Main", "%d, %d => %d",
1810 anim->mode_nr, anim->nr, anim->num_parts);
1811 Debug("anim:HandleGlobalAnim_Main",
1812 "%d, %d, %d", global.num_toons, setup.toons, num_toons);
1816 Debug("anim:HandleGlobalAnim_Main", "%s(%d): %d, %d, %d [%d]",
1817 (action == ANIM_START ? "ANIM_START" :
1818 action == ANIM_CONTINUE ? "ANIM_CONTINUE" :
1819 action == ANIM_STOP ? "ANIM_STOP" : "(should not happen)"),
1821 anim->state & ANIM_STATE_RESTART,
1822 anim->state & ANIM_STATE_WAITING,
1823 anim->state & ANIM_STATE_RUNNING,
1830 anim->state = anim->last_state = ANIM_STATE_RESTART;
1831 anim->active_part_nr = anim->last_active_part_nr = 0;
1832 anim->part_counter = 0;
1837 if (anim->state == ANIM_STATE_INACTIVE)
1840 anim->state = anim->last_state;
1841 anim->active_part_nr = anim->last_active_part_nr;
1846 anim->state = ANIM_STATE_INACTIVE;
1848 for (i = 0; i < num_parts; i++)
1849 StopGlobalAnimSoundAndMusic(&anim->part[i]);
1857 if (c->anim_mode & ANIM_ALL || anim->num_parts == 0)
1860 Debug("anim:HandleGlobalAnim_Main", "%d, %d => %d",
1861 anim->mode_nr, anim->nr, num_parts);
1864 for (i = 0; i < num_parts; i++)
1866 part = &anim->part[i];
1871 anim->state = ANIM_STATE_RUNNING;
1872 part->state = ANIM_STATE_RESTART;
1877 if (part->state == ANIM_STATE_INACTIVE)
1883 part->state = ANIM_STATE_INACTIVE;
1891 part->state = HandleGlobalAnim_Part(part, part->state);
1893 // when animation mode is "once", stop after animation was played once
1894 if (c->anim_mode & ANIM_ONCE &&
1895 part->state & ANIM_STATE_RESTART)
1896 part->state = ANIM_STATE_INACTIVE;
1899 anim->last_state = anim->state;
1900 anim->last_active_part_nr = anim->active_part_nr;
1905 if (anim->state & ANIM_STATE_RESTART) // directly after restart
1906 anim->active_part_nr = getGlobalAnimationPart(anim);
1908 part = &anim->part[anim->active_part_nr];
1910 // first set all animation parts to "inactive", ...
1911 for (i = 0; i < num_parts; i++)
1912 anim->part[i].state = ANIM_STATE_INACTIVE;
1914 // ... then set current animation part to "running" ...
1915 part->state = ANIM_STATE_RUNNING;
1917 // ... unless it is waiting for an initial event
1918 if (part->init_event_state)
1919 part->state = ANIM_STATE_WAITING;
1921 anim->state = HandleGlobalAnim_Part(part, anim->state);
1923 if (anim->state & ANIM_STATE_RESTART)
1924 anim->part_counter++;
1926 // when animation mode is "once", stop after all animations were played once
1927 if (c->anim_mode & ANIM_ONCE &&
1928 anim->part_counter == anim->num_parts)
1929 anim->state = ANIM_STATE_INACTIVE;
1931 state = anim->state;
1932 active_part_nr = anim->active_part_nr;
1934 // while the animation parts are pausing (waiting or inactive), play the base
1935 // (main) animation; this corresponds to the "boring player animation" logic
1936 // (!!! KLUDGE WARNING: I THINK THIS IS A MESS THAT SHOULD BE CLEANED UP !!!)
1939 if (anim->state == ANIM_STATE_WAITING ||
1940 anim->state == ANIM_STATE_INACTIVE)
1942 anim->active_part_nr = anim->num_parts; // part nr of base animation
1943 part = &anim->part[anim->active_part_nr];
1945 if (anim->state != anim->last_state)
1946 part->state = ANIM_STATE_RESTART;
1948 anim->state = ANIM_STATE_RUNNING;
1949 part->state = HandleGlobalAnim_Part(part, part->state);
1953 anim->last_state = state;
1954 anim->last_active_part_nr = active_part_nr;
1957 static void HandleGlobalAnim_Mode(struct GlobalAnimControlInfo *ctrl, int action)
1962 Debug("anim:HandleGlobalAnim_Mode", "%d => %d", ctrl->nr, ctrl->num_anims);
1965 for (i = 0; i < ctrl->num_anims; i++)
1966 HandleGlobalAnim_Main(&ctrl->anim[i], action);
1969 static void HandleGlobalAnim(int action, int game_mode)
1972 Debug("anim:HandleGlobalAnim", "mode == %d", game_status);
1975 HandleGlobalAnim_Mode(&global_anim_ctrl[game_mode], action);
1978 static void DoAnimationExt(void)
1983 Debug("anim:DoAnimationExt", "%d, %d", anim_sync_frame, Counter());
1986 // global animations now synchronized with frame delay of screen update
1989 for (i = 0; i < NUM_GAME_MODES; i++)
1990 HandleGlobalAnim(ANIM_CONTINUE, i);
1993 // force screen redraw in next frame to continue drawing global animations
1994 redraw_mask = REDRAW_ALL;
1998 static void DoGlobalAnim_DelayAction(struct GlobalAnimPartControlInfo *part,
2002 (delay_type == ANIM_DELAY_INIT ? part->control_info.init_delay_action :
2003 delay_type == ANIM_DELAY_ANIM ? part->control_info.anim_delay_action :
2004 delay_type == ANIM_DELAY_POST ? part->control_info.post_delay_action :
2005 ANIM_DELAY_ACTION_NONE);
2007 if (delay_action == ANIM_DELAY_ACTION_NONE)
2010 PushUserEvent(USEREVENT_ANIM_DELAY_ACTION, delay_action, 0);
2013 static boolean DoGlobalAnim_EventAction(struct GlobalAnimPartControlInfo *part)
2015 int event_action = (part->init_event_state ?
2016 part->control_info.init_event_action :
2017 part->control_info.anim_event_action);
2019 if (event_action == ANIM_EVENT_ACTION_NONE)
2022 if (event_action < MAX_IMAGE_FILES)
2023 PushUserEvent(USEREVENT_ANIM_EVENT_ACTION, event_action, 0);
2025 OpenURLFromHash(anim_url_hash, event_action);
2027 // check if further actions are allowed to be executed
2028 if (part->control_info.style & STYLE_MULTIPLE_ACTIONS)
2034 static void InitGlobalAnim_Clickable(void)
2038 for (i = 0; i < num_global_anim_list; i++)
2040 struct GlobalAnimPartControlInfo *part = global_anim_list[i];
2042 if (part->triggered)
2043 part->clicked = TRUE;
2045 part->triggered = FALSE;
2046 part->clickable = FALSE;
2050 #define ANIM_CLICKED_RESET 0
2051 #define ANIM_CLICKED_PRESSED 1
2052 #define ANIM_CLICKED_RELEASED 2
2054 static boolean InitGlobalAnim_Clicked(int mx, int my, int clicked_event)
2056 boolean click_consumed = FALSE;
2057 boolean anything_clicked = FALSE;
2058 boolean any_part_clicked = FALSE;
2059 boolean any_event_action = FALSE;
2062 // check animation parts in reverse draw order (to stop when clicked)
2063 for (i = num_global_anim_list - 1; i >= 0; i--)
2065 struct GlobalAnimPartControlInfo *part = global_anim_list[i];
2067 // if request dialog is active, only handle pointer-style animations
2068 if (game.request_active &&
2069 part->control_info.class != get_hash_from_key("pointer"))
2072 if (clicked_event == ANIM_CLICKED_RESET)
2074 part->clicked = FALSE;
2079 if (!part->clickable)
2082 if (!(part->state & ANIM_STATE_RUNNING))
2085 // always handle "any" click events (clicking anywhere on screen) ...
2086 if (clicked_event == ANIM_CLICKED_PRESSED &&
2087 isClickablePart(part, ANIM_EVENT_ANY))
2089 #if DEBUG_ANIM_EVENTS
2090 Debug("anim:InitGlobalAnim_Clicked", "%d.%d TRIGGERED BY ANY",
2091 part->old_anim_nr + 1, part->old_nr + 1);
2094 anything_clicked = part->clicked = TRUE;
2095 click_consumed |= clickConsumed(part);
2098 // always handle "unclick:any" events (releasing anywhere on screen) ...
2099 if (clicked_event == ANIM_CLICKED_RELEASED &&
2100 isClickablePart(part, ANIM_EVENT_UNCLICK_ANY))
2102 #if DEBUG_ANIM_EVENTS
2103 Debug("anim:InitGlobalAnim_Clicked", "%d.%d TRIGGERED BY UNCLICK:ANY",
2104 part->old_anim_nr + 1, part->old_nr + 1);
2107 anything_clicked = part->clicked = TRUE;
2108 click_consumed |= clickConsumed(part);
2111 // ... but only handle the first (topmost) clickable animation
2112 if (any_part_clicked)
2115 if (clicked_event == ANIM_CLICKED_PRESSED &&
2116 isClickedPart(part, mx, my, TRUE))
2119 Debug("anim:InitGlobalAnim_Clicked", "%d.%d CLICKED [%d]",
2120 anim_nr, part_nr, part->control_info.anim_event_action);
2123 // after executing event action, ignore any further actions
2124 if (!any_event_action && DoGlobalAnim_EventAction(part))
2125 any_event_action = TRUE;
2127 // determine if mouse clicks should be blocked from other animations
2128 any_part_clicked |= clickConsumed(part);
2130 if (isClickablePart(part, ANIM_EVENT_SELF))
2132 #if DEBUG_ANIM_EVENTS
2133 Debug("anim:InitGlobalAnim_Clicked", "%d.%d TRIGGERED BY SELF",
2134 part->old_anim_nr + 1, part->old_nr + 1);
2137 anything_clicked = part->clicked = TRUE;
2138 click_consumed |= clickConsumed(part);
2141 // determine if mouse clicks should be blocked by this animation
2142 click_consumed |= clickBlocked(part);
2144 // check if this click is defined to trigger other animations
2145 InitGlobalAnim_Triggered(part, &click_consumed, &any_event_action,
2146 ANIM_EVENT_CLICK, "CLICK");
2150 if (anything_clicked)
2152 handle_click = TRUE;
2154 for (i = 0; i < NUM_GAME_MODES; i++)
2155 HandleGlobalAnim(ANIM_CONTINUE, i);
2157 handle_click = FALSE;
2159 // prevent ignoring release event if processed within same game frame
2160 StopProcessingEvents();
2163 return (click_consumed || any_event_action);
2166 static void ResetGlobalAnim_Clickable(void)
2168 InitGlobalAnim_Clickable();
2171 static void ResetGlobalAnim_Clicked(void)
2173 InitGlobalAnim_Clicked(-1, -1, ANIM_CLICKED_RESET);
2176 void RestartGlobalAnimsByStatus(int status)
2178 int anim_status_last = global.anim_status;
2180 global.anim_status = status;
2182 // force restarting global animations by changed global animation status
2183 DrawGlobalAnimationsExt(DRAW_TO_SCREEN, DRAW_GLOBAL_ANIM_STAGE_RESTART);
2185 global.anim_status = anim_status_last;
2188 void SetAnimStatusBeforeFading(int status)
2190 anim_status_last_before_fading = status;
2193 boolean HandleGlobalAnimClicks(int mx, int my, int button, boolean force_click)
2195 static boolean click_consumed = FALSE;
2196 static int last_button = 0;
2197 boolean press_event;
2198 boolean release_event;
2199 boolean click_consumed_current = click_consumed;
2201 if (button != 0 && force_click)
2204 // check if button state has changed since last invocation
2205 press_event = (button != 0 && last_button == 0);
2206 release_event = (button == 0 && last_button != 0);
2207 last_button = button;
2211 click_consumed = InitGlobalAnim_Clicked(mx, my, ANIM_CLICKED_PRESSED);
2212 click_consumed_current = click_consumed;
2217 InitGlobalAnim_Clicked(mx, my, ANIM_CLICKED_RELEASED);
2218 click_consumed = FALSE;
2221 return click_consumed_current;
2224 int getGlobalAnimSyncFrame(void)
2226 return anim_sync_frame;
2229 void HandleGlobalAnimEventByElementChange(int element, int page, int x, int y,
2230 int trigger_x, int trigger_y)
2232 if (!IS_CUSTOM_ELEMENT(element))
2235 // custom element stored as 0 to 255, change page stored as 1 to 32
2236 InitGlobalAnim_Triggered_ByCustomElement(element - EL_CUSTOM_START, page + 1,
2237 x, y, trigger_x, trigger_y);