1 ///////////////////////////////////////////////
3 ///////////////////////
4 // This file belongs to dpmod/darkplaces
5 // AK contains all menu functions (especially the required ones)
6 ///////////////////////////////////////////////
8 float mouseButtonsPressed;
15 float menuInitialized;
16 float menuNotTheFirstFrame;
31 cvar_set("_menu_alpha", "0");
32 prvm_language = cvar_string("prvm_language");
33 if(prvm_language == "")
36 cvar_set("prvm_language", prvm_language);
37 localcmd("\nmenu_restart; togglemenu\n");
39 prvm_language = strzone(prvm_language);
40 cvar_set("_menu_prvm_language", prvm_language);
42 check_unacceptable_compiler_bugs();
45 print(sprintf(_("^4MQC Build information: ^1%s\n"), WATERMARK()));
48 // list all game dirs (TEST)
55 s = getgamedirinfo(i, GETGAMEDIRINFO_NAME);
58 dprint(s, ": ", getgamedirinfo(i, GETGAMEDIRINFO_DESCRIPTION));
62 // needs to be done so early because of the constants they create
66 float ddsload = cvar("r_texture_dds_load");
67 float texcomp = cvar("gl_texturecompression");
69 if(ddsload != cvar("r_texture_dds_load") || texcomp != cvar("gl_texturecompression"))
70 localcmd("\nr_restart\n");
74 float MENU_ASPECT = 1.25; // 1280x1024
75 float MENU_MINHEIGHT = 600;
76 float conwidth_s, conheight_s, realconwidth, realconheight, screenconwidth, screenconheight;
77 void draw_reset_cropped()
79 draw_reset(screenconwidth, screenconheight, 0.5 * (realconwidth - screenconwidth), 0.5 * (realconheight - screenconheight));
81 void draw_reset_full()
83 draw_reset(realconwidth, realconheight, 0, 0);
85 void UpdateConWidthHeight()
87 conwidth_s = conwidth;
88 conheight_s = conheight;
89 realconwidth = cvar("vid_conwidth");
90 realconheight = cvar("vid_conheight");
91 if(realconwidth / realconheight > MENU_ASPECT)
94 conwidth = realconheight * MENU_ASPECT;
95 conheight = realconheight;
100 conwidth = realconwidth;
101 conheight = realconwidth / MENU_ASPECT;
103 screenconwidth = conwidth;
104 screenconheight = conheight;
105 if(conwidth < MENU_MINHEIGHT * MENU_ASPECT)
107 conheight *= MENU_MINHEIGHT * MENU_ASPECT / conwidth;
108 conwidth = MENU_MINHEIGHT * MENU_ASPECT;
110 if(conheight < MENU_MINHEIGHT)
112 conwidth *= MENU_MINHEIGHT / conheight;
113 conheight = MENU_MINHEIGHT;
117 if(conwidth_s != conwidth || conheight_s != conheight)
119 draw_reset_cropped();
120 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
125 void m_init_delayed()
127 float fh, glob, n, i;
130 conwidth = conheight = -1;
131 UpdateConWidthHeight();
132 draw_reset_cropped();
140 if(cvar_string("menu_skin") != "")
142 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
143 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
146 if(cvar_defstring("menu_skin") != "")
148 cvar_set("menu_skin", cvar_defstring("menu_skin"));
149 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
150 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
154 draw_currentSkin = "gfx/menu/default";
155 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
159 error("cannot load any menu skin\n");
161 draw_currentSkin = strzone(draw_currentSkin);
162 while((s = fgets(fh)))
164 // these two are handled by skinlist.qc
165 if(substring(s, 0, 6) == "title ")
167 if(substring(s, 0, 7) == "author ")
169 n = tokenize_console(s);
171 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
175 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
178 n = search_getsize(glob);
179 for(i = 0; i < n; ++i)
180 precache_pic(search_getfilename(glob, i));
184 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
187 anim = spawnAnimHost();
188 main = spawnMainWindow(); main.configureMainWindow(main);
191 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
194 menuMousePos = '0.5 0.5 0';
199 m_display(); // delayed menu display
202 void m_keyup (float key, float ascii)
208 draw_reset_cropped();
209 main.keyUp(main, key, ascii, menuShiftState);
210 if(key >= K_MOUSE1 && key <= K_MOUSE3)
212 --mouseButtonsPressed;
213 if(!mouseButtonsPressed)
214 main.mouseRelease(main, menuMousePos);
215 if(mouseButtonsPressed < 0)
217 mouseButtonsPressed = 0;
218 dprint("Warning: released an already released button\n");
221 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
222 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
223 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
226 void m_keydown(float key, float ascii)
237 e.keyGrabbed(e, key, ascii);
241 draw_reset_cropped();
242 if(key >= K_MOUSE1 && key <= K_MOUSE3)
243 if(!mouseButtonsPressed)
244 main.mousePress(main, menuMousePos);
245 if(!main.keyDown(main, key, ascii, menuShiftState))
247 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
248 m_hide(); // disable menu on unhandled ESC
250 if(key >= K_MOUSE1 && key <= K_MOUSE3)
252 ++mouseButtonsPressed;
253 if(mouseButtonsPressed > 10)
255 mouseButtonsPressed = 10;
256 dprint("Warning: pressed an already pressed button\n");
259 if(key == K_ALT) menuShiftState |= S_ALT;
260 if(key == K_CTRL) menuShiftState |= S_CTRL;
261 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
264 float SCALEMODE_CROP = 0;
265 float SCALEMODE_LETTERBOX = 1;
266 float SCALEMODE_WIDTH = 2;
267 float SCALEMODE_HEIGHT = 3;
268 float SCALEMODE_STRETCH = 4;
269 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
271 vector sz, org, isz, isz_w, isz_h;
272 float width_is_larger;
274 sz = draw_PictureSize(img);
275 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
276 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
277 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
283 isz = (width_is_larger ? isz_h : isz_w);
285 case SCALEMODE_LETTERBOX:
286 isz = (width_is_larger ? isz_w : isz_h);
288 case SCALEMODE_WIDTH:
291 case SCALEMODE_HEIGHT:
294 case SCALEMODE_STRETCH:
299 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
300 draw_Picture(org, img, isz, '1 1 1', a);
303 void drawBackground(string img, float a, string algn, float force1)
305 if(main.mainNexposee.ModalController_state == 0)
315 scalemode = SCALEMODE_CROP;
317 for(i = 0; i < strlen(algn); ++i)
319 c = substring(algn, i, 1);
322 case "c": scalemode = SCALEMODE_CROP; goto nopic;
323 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
324 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
325 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
326 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
327 case "1": case "4": case "7": v_x = 0.0; break;
328 case "2": case "5": case "8": v_x = 0.5; break;
329 case "3": case "6": case "9": v_x = 1.0; break;
330 default: v_x = random(); break;
334 case "7": case "8": case "9": v_y = 0.0; break;
335 case "4": case "5": case "6": v_y = 0.5; break;
336 case "1": case "2": case "3": v_y = 1.0; break;
337 default: v_y = random(); break;
340 draw_Picture_Aligned(v, scalemode, img, a);
342 // force all secondary layers to use alpha 1. Prevents ugly issues
343 // with overlap. It's a flag because it cannot be used for the
345 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
347 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
354 float menu_tooltips_old;
355 vector menuTooltipAveragedMousePos;
356 entity menuTooltipItem;
357 vector menuTooltipOrigin;
358 vector menuTooltipSize;
359 float menuTooltipAlpha;
360 string menuTooltipText;
361 float menuTooltipState; // 0: static, 1: fading in, 2: fading out
362 float m_testmousetooltipbox(vector pos)
364 if(pos_x >= menuTooltipOrigin_x && pos_x < menuTooltipOrigin_x + menuTooltipSize_x)
365 if(pos_y >= menuTooltipOrigin_y && pos_y < menuTooltipOrigin_y + menuTooltipSize_y)
369 float m_testtooltipbox(vector tooltippos)
375 if(tooltippos_x + menuTooltipSize_x > 1)
377 if(tooltippos_y + menuTooltipSize_y > 1)
379 menuTooltipOrigin = tooltippos;
382 float m_allocatetooltipbox(vector pos)
384 vector avoidplus, avoidminus;
387 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth;
388 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight;
391 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth + menuTooltipSize_x;
392 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight + menuTooltipSize_y;
397 if(m_testtooltipbox(v))
401 v_x = pos_x - menuTooltipSize_x * 0.5;
402 if(m_testtooltipbox(v))
406 v_x = pos_x - avoidminus_x;
407 if(m_testtooltipbox(v))
411 v_y = pos_y - avoidminus_y;
412 if(m_testtooltipbox(v))
416 v_x = pos_x - menuTooltipSize_x * 0.5;
417 if(m_testtooltipbox(v))
421 v_x = pos_x + avoidplus_x;
422 if(m_testtooltipbox(v))
427 entity m_findtooltipitem(entity root, vector pos)
435 while(it.instanceOfContainer)
437 while(it.instanceOfNexposee && it.focusedChild)
439 it = it.focusedChild;
440 pos = globalToBox(pos, it.Container_origin, it.Container_size);
442 if(it.instanceOfNexposee)
444 it = it.itemFromPoint(it, pos);
447 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
451 else if(it.instanceOfModalController)
452 it = it.focusedChild;
454 it = it.itemFromPoint(it, pos);
459 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
461 pos = globalToBox(pos, it.Container_origin, it.Container_size);
468 if (menu_tooltips == 2)
471 if (menuTooltipItem.cvarName)
473 if (getCvarsMulti(menuTooltipItem))
474 s = strcat("[", menuTooltipItem.cvarName, " ", getCvarsMulti(menuTooltipItem), "]");
476 s = strcat("[", menuTooltipItem.cvarName, "]");
478 else if (menuTooltipItem.onClickCommand)
479 s = strcat("<", menuTooltipItem.onClickCommand, ">");
481 return menuTooltipItem.tooltip;
482 if (menuTooltipItem.tooltip)
483 return strcat(menuTooltipItem.tooltip, " ", s);
486 return menuTooltipItem.tooltip;
488 void m_tooltip(vector pos)
495 menu_tooltips = cvar("menu_tooltips");
498 // don't return immediately, fade out the active tooltip first
499 if (menuTooltipItem == world)
502 menu_tooltips_old = menu_tooltips;
506 f = bound(0, frametime * 2, 1);
507 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + pos * f;
508 f = vlen(pos - menuTooltipAveragedMousePos);
510 it = m_findtooltipitem(main, pos);
514 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
516 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
517 if(it != menuTooltipItem)
519 switch(menuTooltipState)
524 // another item: fade out first
525 menuTooltipState = 2;
530 menuTooltipState = 1;
531 menuTooltipItem = it;
533 menuTooltipOrigin_x = -1; // unallocated
536 strunzone(menuTooltipText);
537 menuTooltipText = strzone(gettooltip());
541 getWrappedLine_remaining = menuTooltipText;
542 while(getWrappedLine_remaining)
544 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
546 f = draw_TextWidth(s, FALSE, fontsize);
550 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
551 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
552 menuTooltipSize_z = 0;
556 // changing item while fading in: fade out first
557 menuTooltipState = 2;
560 // changing item while fading out: can't
564 else if(menuTooltipState == 2) // re-fade in?
565 menuTooltipState = 1;
568 if(!m_testmousetooltipbox(pos))
569 menuTooltipState = 2; // fade out if mouse touches it
571 switch(menuTooltipState)
574 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
575 if(menuTooltipAlpha == 1)
576 menuTooltipState = 0;
579 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
580 if(menuTooltipAlpha == 0)
582 menuTooltipState = 0;
583 menuTooltipItem = world;
588 if(menuTooltipItem == world)
592 strunzone(menuTooltipText);
593 menuTooltipText = string_null;
599 if(menu_tooltips != menu_tooltips_old)
601 if (menu_tooltips != 0 && menu_tooltips_old != 0)
602 menuTooltipItem = world; // reload tooltip next frame
603 menu_tooltips_old = menu_tooltips;
605 else if(menuTooltipOrigin_x < 0) // unallocated?
606 m_allocatetooltipbox(pos);
608 if(menuTooltipOrigin_x >= 0)
611 p = SKINBORDER_TOOLTIP;
613 p_y *= 1 / conheight;
614 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
615 p = menuTooltipOrigin;
616 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
617 p_y += SKINMARGIN_TOOLTIP_y / conheight;
618 getWrappedLine_remaining = menuTooltipText;
619 while(getWrappedLine_remaining)
621 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
622 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
634 execute_next_frame();
636 menuMouseMode = cvar("menu_mouse_absolute");
642 UpdateConWidthHeight();
646 // TODO draw an info image about this situation
650 if(!menuNotTheFirstFrame)
652 menuNotTheFirstFrame = 1;
654 if(!cvar("menu_video_played"))
656 localcmd("cd loop $menu_cdtrack; play sound/announcer/default/welcome.ogg\n");
657 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading FIXME
659 // ALWAYS set this cvar; if we start but menu is not active, this means we want no background music!
660 localcmd("set menu_video_played 1\n");
664 realFrametime = frametime = min(0.2, t - menuPrevTime);
668 t = cvar("menu_slowmo");
679 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
680 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
685 if(cvar("cl_capturevideo"))
686 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
690 gamestatus = gamestatus | GAME_ISSERVER;
691 if(clientstate() == CS_CONNECTED)
692 gamestatus = gamestatus | GAME_CONNECTED;
693 if(cvar("developer"))
694 gamestatus = gamestatus | GAME_DEVELOPER;
696 prevMenuAlpha = menuAlpha;
699 if(menuAlpha == 0 && menuLogoAlpha < 2)
701 menuLogoAlpha = menuLogoAlpha + frametime * 2;
705 menuAlpha = min(1, menuAlpha + frametime * 5);
711 menuAlpha = max(0, menuAlpha - frametime * 5);
715 draw_reset_cropped();
717 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
719 if(menuLogoAlpha > 0)
722 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
723 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
724 draw_reset_cropped();
725 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
727 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
728 draw_drawMousePointer(menuMousePos);
733 else if(SKINALPHA_BACKGROUND_INGAME)
738 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
739 draw_reset_cropped();
743 if(menuAlpha != prevMenuAlpha)
744 cvar_set("_menu_alpha", ftos(menuAlpha));
746 draw_reset_cropped();
748 draw_reset_cropped();
752 if(prevMenuAlpha > 0)
753 main.initializeDialog(main, main.firstChild);
754 draw_reset_cropped();
759 draw_alpha *= menuAlpha;
764 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
765 if(newMouse != '0 0 0')
766 if(newMouse != menuMousePos)
768 menuMousePos = newMouse;
769 if(mouseButtonsPressed)
770 main.mouseDrag(main, menuMousePos);
772 main.mouseMove(main, menuMousePos);
779 vector dMouse, minpos, maxpos;
780 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
781 if(dMouse != '0 0 0')
783 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
784 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
785 dMouse = globalToBoxSize(dMouse, draw_scale);
786 menuMousePos += dMouse * cvar("menu_mouse_speed");
787 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
788 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
789 if(mouseButtonsPressed)
790 main.mouseDrag(main, menuMousePos);
792 main.mouseMove(main, menuMousePos);
798 m_tooltip(menuMousePos);
800 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
802 draw_drawMousePointer(menuMousePos);
804 draw_reset_cropped();
813 setkeydest(KEY_MENU);
814 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
819 if(mouseButtonsPressed)
820 main.mouseRelease(main, menuMousePos);
821 mouseButtonsPressed = 0;
823 main.focusEnter(main);
824 main.showNotify(main);
830 setkeydest(KEY_GAME);
831 setmousetarget(MT_CLIENT);
836 main.focusLeave(main);
837 main.hideNotify(main);
840 void m_toggle(float mode)
861 for(e = NULL; (e = nextent(e)) != NULL; )
863 if(e.classname != "vtbl")
869 void m_focus_item_chain(entity outermost, entity innermost)
871 if(innermost.parent != outermost)
872 m_focus_item_chain(outermost, innermost.parent);
873 innermost.parent.setFocus(innermost.parent, innermost);
876 void m_activate_window(entity wnd)
881 m_activate_window(par);
883 if(par.instanceOfModalController)
885 if(wnd.tabSelectingButton)
887 TabButton_Click(wnd.tabSelectingButton, wnd);
890 par.initializeDialog(par, wnd);
892 else if(par.instanceOfNexposee)
894 // nexposee (sorry for violating abstraction here)
895 par.selectedChild = wnd;
896 par.animationState = 1;
897 Container_setFocus(par, NULL);
899 else if(par.instanceOfContainer)
903 par.setFocus(par, wnd);
907 void m_setpointerfocus(entity wnd)
909 if(wnd.instanceOfContainer)
911 entity focus = wnd.preferredFocusedGrandChild(wnd);
914 menuMousePos = focus.origin + 0.5 * focus.size;
915 menuMousePos_x *= 1 / conwidth;
916 menuMousePos_y *= 1 / conheight;
917 if(wnd.focused) // why does this never happen?
918 m_focus_item_chain(wnd, focus);
923 void m_goto(string itemname)
928 if(itemname == "") // this can be called by GameCommand
930 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
934 m_activate_window(main.mainNexposee);
940 for(e = NULL; (e = find(e, name, itemname)); )
941 if(e.classname != "vtbl")
946 m_activate_window(e);
947 m_setpointerfocus(e);
953 void m_goto_skin_selector()
957 // TODO add code to switch back to the skin selector (no idea how to do it now)
958 m_goto("skinselector");
961 void m_goto_language_selector()
965 // TODO add code to switch back to the language selector (no idea how to do it now)
966 m_goto("languageselector");
969 void m_goto_video_settings()
973 // TODO add code to switch back to the video settings (no idea how to do it now)
974 m_goto("videosettings");