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;
23 cvar_set("_menu_alpha", "0");
24 prvm_language = strzone(cvar_string("prvm_language"));
26 check_unacceptable_compiler_bugs();
29 print(sprintf(_("^4MQC Build information: %s\n"), WATERMARK()));
32 // list all game dirs (TEST)
39 s = getgamedirinfo(i, GETGAMEDIRINFO_NAME);
42 dprint(s, ": ", getgamedirinfo(i, GETGAMEDIRINFO_DESCRIPTION));
47 float MENU_ASPECT = 1.25; // 1280x1024
48 float MENU_MINHEIGHT = 600;
49 float conwidth_s, conheight_s, realconwidth, realconheight, screenconwidth, screenconheight;
50 void draw_reset_cropped()
52 draw_reset(screenconwidth, screenconheight, 0.5 * (realconwidth - screenconwidth), 0.5 * (realconheight - screenconheight));
54 void draw_reset_full()
56 draw_reset(realconwidth, realconheight, 0, 0);
58 void UpdateConWidthHeight()
60 conwidth_s = conwidth;
61 conheight_s = conheight;
62 realconwidth = cvar("vid_conwidth");
63 realconheight = cvar("vid_conheight");
64 if(realconwidth / realconheight > MENU_ASPECT)
67 conwidth = realconheight * MENU_ASPECT;
68 conheight = realconheight;
73 conwidth = realconwidth;
74 conheight = realconwidth / MENU_ASPECT;
76 screenconwidth = conwidth;
77 screenconheight = conheight;
78 if(conwidth < MENU_MINHEIGHT * MENU_ASPECT)
80 conheight *= MENU_MINHEIGHT * MENU_ASPECT / conwidth;
81 conwidth = MENU_MINHEIGHT * MENU_ASPECT;
83 if(conheight < MENU_MINHEIGHT)
85 conwidth *= MENU_MINHEIGHT / conheight;
86 conheight = MENU_MINHEIGHT;
90 if(conwidth_s != conwidth || conheight_s != conheight)
93 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
98 void() m_init_delayed =
100 float fh, glob, n, i;
103 conwidth = conheight = -1;
104 UpdateConWidthHeight();
105 draw_reset_cropped();
116 if(cvar_string("menu_skin") != "")
118 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
119 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
122 if(cvar_defstring("menu_skin") != "")
124 draw_currentSkin = strcat("gfx/menu/", cvar_defstring("menu_skin"));
125 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
129 draw_currentSkin = "gfx/menu/default";
130 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
132 draw_currentSkin = strzone(draw_currentSkin);
133 while((s = fgets(fh)))
135 // these two are handled by skinlist.qc
136 if(substring(s, 0, 6) == "title ")
138 if(substring(s, 0, 7) == "author ")
140 n = tokenize_console(s);
142 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
146 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
149 n = search_getsize(glob);
150 for(i = 0; i < n; ++i)
151 precache_pic(search_getfilename(glob, i));
155 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
158 anim = spawnAnimHost();
159 main = spawnMainWindow(); main.configureMainWindow(main);
162 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
165 menuMousePos = '0.5 0.5 0';
168 m_display(); // delayed menu display
171 void(float key, float ascii) m_keyup =
177 draw_reset_cropped();
178 main.keyUp(main, key, ascii, menuShiftState);
179 if(key >= K_MOUSE1 && key <= K_MOUSE3)
181 --mouseButtonsPressed;
182 if(!mouseButtonsPressed)
183 main.mouseRelease(main, menuMousePos);
184 if(mouseButtonsPressed < 0)
186 mouseButtonsPressed = 0;
187 dprint("Warning: released an already released button\n");
190 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
191 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
192 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
195 void(float key, float ascii) m_keydown =
206 e.keyGrabbed(e, key, ascii);
210 draw_reset_cropped();
211 if(key >= K_MOUSE1 && key <= K_MOUSE3)
212 if(!mouseButtonsPressed)
213 main.mousePress(main, menuMousePos);
214 if(!main.keyDown(main, key, ascii, menuShiftState))
216 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
217 m_hide(); // disable menu on unhandled ESC
219 if(key >= K_MOUSE1 && key <= K_MOUSE3)
221 ++mouseButtonsPressed;
222 if(mouseButtonsPressed > 10)
224 mouseButtonsPressed = 10;
225 dprint("Warning: pressed an already pressed button\n");
228 if(key == K_ALT) menuShiftState |= S_ALT;
229 if(key == K_CTRL) menuShiftState |= S_CTRL;
230 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
233 float SCALEMODE_CROP = 0;
234 float SCALEMODE_LETTERBOX = 1;
235 float SCALEMODE_WIDTH = 2;
236 float SCALEMODE_HEIGHT = 3;
237 float SCALEMODE_STRETCH = 4;
238 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
240 vector sz, org, isz, isz_w, isz_h;
241 float width_is_larger;
243 sz = draw_PictureSize(img);
244 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
245 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
246 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
252 isz = (width_is_larger ? isz_h : isz_w);
254 case SCALEMODE_LETTERBOX:
255 isz = (width_is_larger ? isz_w : isz_h);
257 case SCALEMODE_WIDTH:
260 case SCALEMODE_HEIGHT:
263 case SCALEMODE_STRETCH:
268 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
269 draw_Picture(org, img, isz, '1 1 1', a);
272 void(string img, float a, string algn, float force1) drawBackground =
274 if(main.mainNexposee.ModalController_state == 0)
284 scalemode = SCALEMODE_CROP;
286 for(i = 0; i < strlen(algn); ++i)
288 c = substring(algn, i, 1);
291 case "c": scalemode = SCALEMODE_CROP; goto nopic;
292 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
293 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
294 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
295 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
296 case "1": case "4": case "7": v_x = 0.0; break;
297 case "2": case "5": case "8": v_x = 0.5; break;
298 case "3": case "6": case "9": v_x = 1.0; break;
299 default: v_x = random(); break;
303 case "7": case "8": case "9": v_y = 0.0; break;
304 case "4": case "5": case "6": v_y = 0.5; break;
305 case "1": case "2": case "3": v_y = 1.0; break;
306 default: v_y = random(); break;
309 draw_Picture_Aligned(v, scalemode, img, a);
311 // force all secondary layers to use alpha 1. Prevents ugly issues
312 // with overlap. It's a flag because it cannot be used for the
314 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
316 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
323 float menu_tooltips_old;
324 vector menuTooltipAveragedMousePos;
325 entity menuTooltipItem;
326 vector menuTooltipOrigin;
327 vector menuTooltipSize;
328 float menuTooltipAlpha;
329 string menuTooltipText;
330 float menuTooltipState; // 0: static, 1: fading in, 2: fading out
331 float m_testmousetooltipbox()
333 if(menuMousePos_x >= menuTooltipOrigin_x && menuMousePos_x < menuTooltipOrigin_x + menuTooltipSize_x)
334 if(menuMousePos_y >= menuTooltipOrigin_y && menuMousePos_y < menuTooltipOrigin_y + menuTooltipSize_y)
338 float m_testtooltipbox(vector tooltippos)
344 if(tooltippos_x + menuTooltipSize_x > 1)
346 if(tooltippos_y + menuTooltipSize_y > 1)
348 menuTooltipOrigin = tooltippos;
351 float m_allocatetooltipbox(vector pos)
353 vector avoidplus, avoidminus;
356 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x) / conwidth;
357 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y) / conheight;
360 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x) / conwidth + menuTooltipSize_x;
361 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y) / conheight + menuTooltipSize_y;
366 if(m_testtooltipbox(v))
370 v_x = pos_x - menuTooltipSize_x * 0.5;
371 if(m_testtooltipbox(v))
375 v_x = pos_x - avoidminus_x;
376 if(m_testtooltipbox(v))
380 v_y = pos_y - avoidminus_y;
381 if(m_testtooltipbox(v))
385 v_x = pos_x - menuTooltipSize_x * 0.5;
386 if(m_testtooltipbox(v))
390 v_x = pos_x + avoidplus_x;
391 if(m_testtooltipbox(v))
396 entity m_findtooltipitem(entity root, vector pos)
404 while(it.instanceOfContainer)
406 while(it.instanceOfNexposee && it.focusedChild)
408 it = it.focusedChild;
409 pos = globalToBox(pos, it.Container_origin, it.Container_size);
411 if(it.instanceOfNexposee)
413 it = it.itemFromPoint(it, pos);
416 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
420 else if(it.instanceOfModalController)
421 it = it.focusedChild;
423 it = it.itemFromPoint(it, pos);
428 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
430 pos = globalToBox(pos, it.Container_origin, it.Container_size);
437 if (menu_tooltips == 2)
440 if (menuTooltipItem.cvarName)
442 if (getCvarsMulti(menuTooltipItem))
443 s = strcat("[", menuTooltipItem.cvarName, " ", getCvarsMulti(menuTooltipItem), "]");
445 s = strcat("[", menuTooltipItem.cvarName, "]");
447 else if (menuTooltipItem.onClickCommand)
448 s = strcat("<", menuTooltipItem.onClickCommand, ">");
450 return menuTooltipItem.tooltip;
451 if (menuTooltipItem.tooltip)
452 return strcat(menuTooltipItem.tooltip, " ", s);
455 return menuTooltipItem.tooltip;
464 menu_tooltips = cvar("menu_tooltips");
467 // don't return immediately, fade out the active tooltip first
468 if (menuTooltipItem == world)
471 menu_tooltips_old = menu_tooltips;
475 f = bound(0, frametime * 2, 1);
476 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + menuMousePos * f;
477 f = vlen(menuMousePos - menuTooltipAveragedMousePos);
479 it = m_findtooltipitem(main, menuMousePos);
483 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
485 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
486 if(it != menuTooltipItem)
488 switch(menuTooltipState)
493 // another item: fade out first
494 menuTooltipState = 2;
499 menuTooltipState = 1;
500 menuTooltipItem = it;
502 menuTooltipOrigin_x = -1; // unallocated
504 menuTooltipText = strzone(gettooltip());
507 getWrappedLine_remaining = menuTooltipText;
508 while(getWrappedLine_remaining)
510 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
512 f = draw_TextWidth(s, FALSE, fontsize);
516 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
517 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
518 menuTooltipSize_z = 0;
522 // changing item while fading in: fade out first
523 menuTooltipState = 2;
526 // changing item while fading out: can't
530 else if(menuTooltipState == 2) // re-fade in?
531 menuTooltipState = 1;
534 if(!m_testmousetooltipbox())
535 menuTooltipState = 2; // fade out if mouse touches it
537 switch(menuTooltipState)
540 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
541 if(menuTooltipAlpha == 1)
542 menuTooltipState = 0;
545 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
546 if(menuTooltipAlpha == 0)
548 menuTooltipState = 0;
549 menuTooltipItem = world;
556 if(menu_tooltips != menu_tooltips_old)
558 if (menu_tooltips != 0 && menu_tooltips_old != 0)
559 menuTooltipItem = world; // reload tooltip next frame
560 menu_tooltips_old = menu_tooltips;
562 else if(menuTooltipOrigin_x < 0) // unallocated?
563 m_allocatetooltipbox(menuMousePos);
565 if(menuTooltipOrigin_x >= 0)
568 p = SKINBORDER_TOOLTIP;
570 p_y *= 1 / conheight;
571 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
572 p = menuTooltipOrigin;
573 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
574 p_y += SKINMARGIN_TOOLTIP_y / conheight;
575 getWrappedLine_remaining = menuTooltipText;
576 while(getWrappedLine_remaining)
578 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
579 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
591 menuMouseMode = cvar("menu_mouse_absolute");
597 UpdateConWidthHeight();
601 // TODO draw an info image about this situation
605 if(!menuNotTheFirstFrame)
607 menuNotTheFirstFrame = 1;
609 if(!cvar("menu_video_played"))
611 localcmd("set menu_video_played 1; cd loop $menu_cdtrack; play sound/announcer/default/welcome.ogg\n");
612 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading FIXME
617 realFrametime = frametime = min(0.2, t - menuPrevTime);
621 t = cvar("menu_slowmo");
632 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
633 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
638 if(cvar("cl_capturevideo"))
639 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
643 gamestatus = gamestatus | GAME_ISSERVER;
644 if(clientstate() == CS_CONNECTED)
645 gamestatus = gamestatus | GAME_CONNECTED;
646 if(cvar("developer"))
647 gamestatus = gamestatus | GAME_DEVELOPER;
649 prevMenuAlpha = menuAlpha;
652 if(menuAlpha == 0 && menuLogoAlpha < 2)
654 menuLogoAlpha = menuLogoAlpha + frametime * 2;
658 menuAlpha = min(1, menuAlpha + frametime * 5);
664 menuAlpha = max(0, menuAlpha - frametime * 5);
668 draw_reset_cropped();
670 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
672 if(menuLogoAlpha > 0)
675 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
676 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
677 draw_reset_cropped();
678 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
680 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
681 draw_drawMousePointer(menuMousePos);
686 else if(SKINALPHA_BACKGROUND_INGAME)
691 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
692 draw_reset_cropped();
696 if(menuAlpha != prevMenuAlpha)
697 cvar_set("_menu_alpha", ftos(menuAlpha));
699 draw_reset_cropped();
701 draw_reset_cropped();
705 if(prevMenuAlpha > 0)
706 main.initializeDialog(main, main.firstChild);
707 draw_reset_cropped();
712 draw_alpha *= menuAlpha;
717 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
718 if(newMouse != '0 0 0')
719 if(newMouse != menuMousePos)
721 menuMousePos = newMouse;
722 if(mouseButtonsPressed)
723 main.mouseDrag(main, menuMousePos);
725 main.mouseMove(main, menuMousePos);
732 vector dMouse, minpos, maxpos;
733 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
734 if(dMouse != '0 0 0')
736 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
737 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
738 dMouse = globalToBoxSize(dMouse, draw_scale);
739 menuMousePos += dMouse * cvar("menu_mouse_speed");
740 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
741 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
742 if(mouseButtonsPressed)
743 main.mouseDrag(main, menuMousePos);
745 main.mouseMove(main, menuMousePos);
753 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
755 draw_drawMousePointer(menuMousePos);
757 draw_reset_cropped();
766 setkeydest(KEY_MENU);
767 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
772 if(mouseButtonsPressed)
773 main.mouseRelease(main, menuMousePos);
774 mouseButtonsPressed = 0;
776 main.focusEnter(main);
777 main.showNotify(main);
783 setkeydest(KEY_GAME);
784 setmousetarget(MT_CLIENT);
789 main.focusLeave(main);
790 main.hideNotify(main);
806 for(e = NULL; (e = nextent(e)) != NULL; )
808 if(e.classname != "vtbl")
814 void m_focus_item_chain(entity outermost, entity innermost)
816 if(innermost.parent != outermost)
817 m_focus_item_chain(outermost, innermost.parent);
818 innermost.parent.setFocus(innermost.parent, innermost);
821 void m_activate_window(entity wnd)
826 m_activate_window(par);
828 if(par.instanceOfModalController)
830 if(wnd.tabSelectingButton)
832 TabButton_Click(wnd.tabSelectingButton, wnd);
835 par.initializeDialog(par, wnd);
837 else if(par.instanceOfNexposee)
839 // nexposee (sorry for violating abstraction here)
840 par.selectedChild = wnd;
841 par.animationState = 1;
842 Container_setFocus(par, NULL);
844 else if(par.instanceOfContainer)
848 par.setFocus(par, wnd);
852 void m_setpointerfocus(entity wnd)
854 if(wnd.instanceOfContainer)
856 entity focus = wnd.preferredFocusedGrandChild(wnd);
859 menuMousePos = focus.origin + 0.5 * focus.size;
860 menuMousePos_x *= 1 / conwidth;
861 menuMousePos_y *= 1 / conheight;
862 if(wnd.focused) // why does this never happen?
863 m_focus_item_chain(wnd, focus);
868 void(string itemname) m_goto =
873 if(itemname == "") // this can be called by GameCommand
875 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
879 m_activate_window(main.mainNexposee);
885 for(e = NULL; (e = findstring(e, name, itemname)); )
886 if(e.classname != "vtbl")
891 m_activate_window(e);
892 m_setpointerfocus(e);
898 void() m_goto_skin_selector =
902 // TODO add code to switch back to the skin selector (no idea how to do it now)
903 m_goto("skinselector");
906 void() m_goto_language_selector =
910 // TODO add code to switch back to the language selector (no idea how to do it now)
911 m_goto("languageselector");
914 void() m_goto_video_settings =
918 // TODO add code to switch back to the video settings (no idea how to do it now)
919 m_goto("videosettings");