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 = strzone(cvar_string("prvm_language"));
34 check_unacceptable_compiler_bugs();
37 print(sprintf(_("^4MQC Build information: ^1%s\n"), WATERMARK()));
40 // list all game dirs (TEST)
47 s = getgamedirinfo(i, GETGAMEDIRINFO_NAME);
50 dprint(s, ": ", getgamedirinfo(i, GETGAMEDIRINFO_DESCRIPTION));
55 float MENU_ASPECT = 1.25; // 1280x1024
56 float MENU_MINHEIGHT = 600;
57 float conwidth_s, conheight_s, realconwidth, realconheight, screenconwidth, screenconheight;
58 void draw_reset_cropped()
60 draw_reset(screenconwidth, screenconheight, 0.5 * (realconwidth - screenconwidth), 0.5 * (realconheight - screenconheight));
62 void draw_reset_full()
64 draw_reset(realconwidth, realconheight, 0, 0);
66 void UpdateConWidthHeight()
68 conwidth_s = conwidth;
69 conheight_s = conheight;
70 realconwidth = cvar("vid_conwidth");
71 realconheight = cvar("vid_conheight");
72 if(realconwidth / realconheight > MENU_ASPECT)
75 conwidth = realconheight * MENU_ASPECT;
76 conheight = realconheight;
81 conwidth = realconwidth;
82 conheight = realconwidth / MENU_ASPECT;
84 screenconwidth = conwidth;
85 screenconheight = conheight;
86 if(conwidth < MENU_MINHEIGHT * MENU_ASPECT)
88 conheight *= MENU_MINHEIGHT * MENU_ASPECT / conwidth;
89 conwidth = MENU_MINHEIGHT * MENU_ASPECT;
91 if(conheight < MENU_MINHEIGHT)
93 conwidth *= MENU_MINHEIGHT / conheight;
94 conheight = MENU_MINHEIGHT;
98 if(conwidth_s != conwidth || conheight_s != conheight)
100 draw_reset_cropped();
101 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
106 void m_init_delayed()
108 float fh, glob, n, i;
111 conwidth = conheight = -1;
112 UpdateConWidthHeight();
113 draw_reset_cropped();
123 if(cvar_string("menu_skin") != "")
125 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
126 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
129 if(cvar_defstring("menu_skin") != "")
131 cvar_set("menu_skin", cvar_defstring("menu_skin"));
132 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
133 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
137 draw_currentSkin = "gfx/menu/default";
138 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
142 error("cannot load any menu skin\n");
144 draw_currentSkin = strzone(draw_currentSkin);
145 while((s = fgets(fh)))
147 // these two are handled by skinlist.qc
148 if(substring(s, 0, 6) == "title ")
150 if(substring(s, 0, 7) == "author ")
152 n = tokenize_console(s);
154 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
158 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
161 n = search_getsize(glob);
162 for(i = 0; i < n; ++i)
163 precache_pic(search_getfilename(glob, i));
167 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
170 anim = spawnAnimHost();
171 main = spawnMainWindow(); main.configureMainWindow(main);
174 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
177 menuMousePos = '0.5 0.5 0';
182 m_display(); // delayed menu display
185 void m_keyup (float key, float ascii)
191 draw_reset_cropped();
192 main.keyUp(main, key, ascii, menuShiftState);
193 if(key >= K_MOUSE1 && key <= K_MOUSE3)
195 --mouseButtonsPressed;
196 if(!mouseButtonsPressed)
197 main.mouseRelease(main, menuMousePos);
198 if(mouseButtonsPressed < 0)
200 mouseButtonsPressed = 0;
201 dprint("Warning: released an already released button\n");
204 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
205 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
206 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
209 void m_keydown(float key, float ascii)
220 e.keyGrabbed(e, key, ascii);
224 draw_reset_cropped();
225 if(key >= K_MOUSE1 && key <= K_MOUSE3)
226 if(!mouseButtonsPressed)
227 main.mousePress(main, menuMousePos);
228 if(!main.keyDown(main, key, ascii, menuShiftState))
230 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
231 m_hide(); // disable menu on unhandled ESC
233 if(key >= K_MOUSE1 && key <= K_MOUSE3)
235 ++mouseButtonsPressed;
236 if(mouseButtonsPressed > 10)
238 mouseButtonsPressed = 10;
239 dprint("Warning: pressed an already pressed button\n");
242 if(key == K_ALT) menuShiftState |= S_ALT;
243 if(key == K_CTRL) menuShiftState |= S_CTRL;
244 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
247 float SCALEMODE_CROP = 0;
248 float SCALEMODE_LETTERBOX = 1;
249 float SCALEMODE_WIDTH = 2;
250 float SCALEMODE_HEIGHT = 3;
251 float SCALEMODE_STRETCH = 4;
252 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
254 vector sz, org, isz, isz_w, isz_h;
255 float width_is_larger;
257 sz = draw_PictureSize(img);
258 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
259 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
260 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
266 isz = (width_is_larger ? isz_h : isz_w);
268 case SCALEMODE_LETTERBOX:
269 isz = (width_is_larger ? isz_w : isz_h);
271 case SCALEMODE_WIDTH:
274 case SCALEMODE_HEIGHT:
277 case SCALEMODE_STRETCH:
282 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
283 draw_Picture(org, img, isz, '1 1 1', a);
286 void drawBackground(string img, float a, string algn, float force1)
288 if(main.mainNexposee.ModalController_state == 0)
298 scalemode = SCALEMODE_CROP;
300 for(i = 0; i < strlen(algn); ++i)
302 c = substring(algn, i, 1);
305 case "c": scalemode = SCALEMODE_CROP; goto nopic;
306 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
307 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
308 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
309 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
310 case "1": case "4": case "7": v_x = 0.0; break;
311 case "2": case "5": case "8": v_x = 0.5; break;
312 case "3": case "6": case "9": v_x = 1.0; break;
313 default: v_x = random(); break;
317 case "7": case "8": case "9": v_y = 0.0; break;
318 case "4": case "5": case "6": v_y = 0.5; break;
319 case "1": case "2": case "3": v_y = 1.0; break;
320 default: v_y = random(); break;
323 draw_Picture_Aligned(v, scalemode, img, a);
325 // force all secondary layers to use alpha 1. Prevents ugly issues
326 // with overlap. It's a flag because it cannot be used for the
328 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
330 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
337 float menu_tooltips_old;
338 vector menuTooltipAveragedMousePos;
339 entity menuTooltipItem;
340 vector menuTooltipOrigin;
341 vector menuTooltipSize;
342 float menuTooltipAlpha;
343 string menuTooltipText;
344 float menuTooltipState; // 0: static, 1: fading in, 2: fading out
345 float m_testmousetooltipbox(vector pos)
347 if(pos_x >= menuTooltipOrigin_x && pos_x < menuTooltipOrigin_x + menuTooltipSize_x)
348 if(pos_y >= menuTooltipOrigin_y && pos_y < menuTooltipOrigin_y + menuTooltipSize_y)
352 float m_testtooltipbox(vector tooltippos)
358 if(tooltippos_x + menuTooltipSize_x > 1)
360 if(tooltippos_y + menuTooltipSize_y > 1)
362 menuTooltipOrigin = tooltippos;
365 float m_allocatetooltipbox(vector pos)
367 vector avoidplus, avoidminus;
370 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth;
371 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight;
374 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth + menuTooltipSize_x;
375 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight + menuTooltipSize_y;
380 if(m_testtooltipbox(v))
384 v_x = pos_x - menuTooltipSize_x * 0.5;
385 if(m_testtooltipbox(v))
389 v_x = pos_x - avoidminus_x;
390 if(m_testtooltipbox(v))
394 v_y = pos_y - avoidminus_y;
395 if(m_testtooltipbox(v))
399 v_x = pos_x - menuTooltipSize_x * 0.5;
400 if(m_testtooltipbox(v))
404 v_x = pos_x + avoidplus_x;
405 if(m_testtooltipbox(v))
410 entity m_findtooltipitem(entity root, vector pos)
418 while(it.instanceOfContainer)
420 while(it.instanceOfNexposee && it.focusedChild)
422 it = it.focusedChild;
423 pos = globalToBox(pos, it.Container_origin, it.Container_size);
425 if(it.instanceOfNexposee)
427 it = it.itemFromPoint(it, pos);
430 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
434 else if(it.instanceOfModalController)
435 it = it.focusedChild;
437 it = it.itemFromPoint(it, pos);
442 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
444 pos = globalToBox(pos, it.Container_origin, it.Container_size);
451 if (menu_tooltips == 2)
454 if (menuTooltipItem.cvarName)
456 if (getCvarsMulti(menuTooltipItem))
457 s = strcat("[", menuTooltipItem.cvarName, " ", getCvarsMulti(menuTooltipItem), "]");
459 s = strcat("[", menuTooltipItem.cvarName, "]");
461 else if (menuTooltipItem.onClickCommand)
462 s = strcat("<", menuTooltipItem.onClickCommand, ">");
464 return menuTooltipItem.tooltip;
465 if (menuTooltipItem.tooltip)
466 return strcat(menuTooltipItem.tooltip, " ", s);
469 return menuTooltipItem.tooltip;
471 void m_tooltip(vector pos)
478 menu_tooltips = cvar("menu_tooltips");
481 // don't return immediately, fade out the active tooltip first
482 if (menuTooltipItem == world)
485 menu_tooltips_old = menu_tooltips;
489 f = bound(0, frametime * 2, 1);
490 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + pos * f;
491 f = vlen(pos - menuTooltipAveragedMousePos);
493 it = m_findtooltipitem(main, pos);
497 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
499 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
500 if(it != menuTooltipItem)
502 switch(menuTooltipState)
507 // another item: fade out first
508 menuTooltipState = 2;
513 menuTooltipState = 1;
514 menuTooltipItem = it;
516 menuTooltipOrigin_x = -1; // unallocated
519 strunzone(menuTooltipText);
520 menuTooltipText = strzone(gettooltip());
524 getWrappedLine_remaining = menuTooltipText;
525 while(getWrappedLine_remaining)
527 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
529 f = draw_TextWidth(s, FALSE, fontsize);
533 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
534 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
535 menuTooltipSize_z = 0;
539 // changing item while fading in: fade out first
540 menuTooltipState = 2;
543 // changing item while fading out: can't
547 else if(menuTooltipState == 2) // re-fade in?
548 menuTooltipState = 1;
551 if(!m_testmousetooltipbox(pos))
552 menuTooltipState = 2; // fade out if mouse touches it
554 switch(menuTooltipState)
557 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
558 if(menuTooltipAlpha == 1)
559 menuTooltipState = 0;
562 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
563 if(menuTooltipAlpha == 0)
565 menuTooltipState = 0;
566 menuTooltipItem = world;
571 if(menuTooltipItem == world)
575 strunzone(menuTooltipText);
576 menuTooltipText = string_null;
582 if(menu_tooltips != menu_tooltips_old)
584 if (menu_tooltips != 0 && menu_tooltips_old != 0)
585 menuTooltipItem = world; // reload tooltip next frame
586 menu_tooltips_old = menu_tooltips;
588 else if(menuTooltipOrigin_x < 0) // unallocated?
589 m_allocatetooltipbox(pos);
591 if(menuTooltipOrigin_x >= 0)
594 p = SKINBORDER_TOOLTIP;
596 p_y *= 1 / conheight;
597 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
598 p = menuTooltipOrigin;
599 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
600 p_y += SKINMARGIN_TOOLTIP_y / conheight;
601 getWrappedLine_remaining = menuTooltipText;
602 while(getWrappedLine_remaining)
604 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
605 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
617 menuMouseMode = cvar("menu_mouse_absolute");
623 UpdateConWidthHeight();
627 // TODO draw an info image about this situation
631 if(!menuNotTheFirstFrame)
633 menuNotTheFirstFrame = 1;
635 if(!cvar("menu_video_played"))
637 localcmd("cd loop $menu_cdtrack; play sound/announcer/default/welcome.ogg\n");
638 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading FIXME
640 // ALWAYS set this cvar; if we start but menu is not active, this means we want no background music!
641 localcmd("set menu_video_played 1\n");
645 realFrametime = frametime = min(0.2, t - menuPrevTime);
649 t = cvar("menu_slowmo");
660 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
661 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
666 if(cvar("cl_capturevideo"))
667 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
671 gamestatus = gamestatus | GAME_ISSERVER;
672 if(clientstate() == CS_CONNECTED)
673 gamestatus = gamestatus | GAME_CONNECTED;
674 if(cvar("developer"))
675 gamestatus = gamestatus | GAME_DEVELOPER;
677 prevMenuAlpha = menuAlpha;
680 if(menuAlpha == 0 && menuLogoAlpha < 2)
682 menuLogoAlpha = menuLogoAlpha + frametime * 2;
686 menuAlpha = min(1, menuAlpha + frametime * 5);
692 menuAlpha = max(0, menuAlpha - frametime * 5);
696 draw_reset_cropped();
698 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
700 if(menuLogoAlpha > 0)
703 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
704 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
705 draw_reset_cropped();
706 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
708 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
709 draw_drawMousePointer(menuMousePos);
714 else if(SKINALPHA_BACKGROUND_INGAME)
719 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
720 draw_reset_cropped();
724 if(menuAlpha != prevMenuAlpha)
725 cvar_set("_menu_alpha", ftos(menuAlpha));
727 draw_reset_cropped();
729 draw_reset_cropped();
733 if(prevMenuAlpha > 0)
734 main.initializeDialog(main, main.firstChild);
735 draw_reset_cropped();
740 draw_alpha *= menuAlpha;
745 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
746 if(newMouse != '0 0 0')
747 if(newMouse != menuMousePos)
749 menuMousePos = newMouse;
750 if(mouseButtonsPressed)
751 main.mouseDrag(main, menuMousePos);
753 main.mouseMove(main, menuMousePos);
760 vector dMouse, minpos, maxpos;
761 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
762 if(dMouse != '0 0 0')
764 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
765 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
766 dMouse = globalToBoxSize(dMouse, draw_scale);
767 menuMousePos += dMouse * cvar("menu_mouse_speed");
768 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
769 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
770 if(mouseButtonsPressed)
771 main.mouseDrag(main, menuMousePos);
773 main.mouseMove(main, menuMousePos);
779 m_tooltip(menuMousePos);
781 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
783 draw_drawMousePointer(menuMousePos);
785 draw_reset_cropped();
794 setkeydest(KEY_MENU);
795 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
800 if(mouseButtonsPressed)
801 main.mouseRelease(main, menuMousePos);
802 mouseButtonsPressed = 0;
804 main.focusEnter(main);
805 main.showNotify(main);
811 setkeydest(KEY_GAME);
812 setmousetarget(MT_CLIENT);
817 main.focusLeave(main);
818 main.hideNotify(main);
821 void m_toggle(float mode)
842 for(e = NULL; (e = nextent(e)) != NULL; )
844 if(e.classname != "vtbl")
850 void m_focus_item_chain(entity outermost, entity innermost)
852 if(innermost.parent != outermost)
853 m_focus_item_chain(outermost, innermost.parent);
854 innermost.parent.setFocus(innermost.parent, innermost);
857 void m_activate_window(entity wnd)
862 m_activate_window(par);
864 if(par.instanceOfModalController)
866 if(wnd.tabSelectingButton)
868 TabButton_Click(wnd.tabSelectingButton, wnd);
871 par.initializeDialog(par, wnd);
873 else if(par.instanceOfNexposee)
875 // nexposee (sorry for violating abstraction here)
876 par.selectedChild = wnd;
877 par.animationState = 1;
878 Container_setFocus(par, NULL);
880 else if(par.instanceOfContainer)
884 par.setFocus(par, wnd);
888 void m_setpointerfocus(entity wnd)
890 if(wnd.instanceOfContainer)
892 entity focus = wnd.preferredFocusedGrandChild(wnd);
895 menuMousePos = focus.origin + 0.5 * focus.size;
896 menuMousePos_x *= 1 / conwidth;
897 menuMousePos_y *= 1 / conheight;
898 if(wnd.focused) // why does this never happen?
899 m_focus_item_chain(wnd, focus);
904 void m_goto(string itemname)
909 if(itemname == "") // this can be called by GameCommand
911 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
915 m_activate_window(main.mainNexposee);
921 for(e = NULL; (e = find(e, name, itemname)); )
922 if(e.classname != "vtbl")
927 m_activate_window(e);
928 m_setpointerfocus(e);
934 void m_goto_skin_selector()
938 // TODO add code to switch back to the skin selector (no idea how to do it now)
939 m_goto("skinselector");
942 void m_goto_language_selector()
946 // TODO add code to switch back to the language selector (no idea how to do it now)
947 m_goto("languageselector");
950 void m_goto_video_settings()
954 // TODO add code to switch back to the video settings (no idea how to do it now)
955 m_goto("videosettings");