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\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");
76 float MENU_ASPECT = 1.25; // 1280x1024
77 float MENU_MINHEIGHT = 600;
78 float conwidth_s, conheight_s, realconwidth, realconheight, screenconwidth, screenconheight;
79 void draw_reset_cropped()
81 draw_reset(screenconwidth, screenconheight, 0.5 * (realconwidth - screenconwidth), 0.5 * (realconheight - screenconheight));
83 void draw_reset_full()
85 draw_reset(realconwidth, realconheight, 0, 0);
87 void UpdateConWidthHeight()
89 conwidth_s = conwidth;
90 conheight_s = conheight;
91 realconwidth = cvar("vid_conwidth");
92 realconheight = cvar("vid_conheight");
93 if(realconwidth / realconheight > MENU_ASPECT)
96 conwidth = realconheight * MENU_ASPECT;
97 conheight = realconheight;
102 conwidth = realconwidth;
103 conheight = realconwidth / MENU_ASPECT;
105 screenconwidth = conwidth;
106 screenconheight = conheight;
107 if(conwidth < MENU_MINHEIGHT * MENU_ASPECT)
109 conheight *= MENU_MINHEIGHT * MENU_ASPECT / conwidth;
110 conwidth = MENU_MINHEIGHT * MENU_ASPECT;
112 if(conheight < MENU_MINHEIGHT)
114 conwidth *= MENU_MINHEIGHT / conheight;
115 conheight = MENU_MINHEIGHT;
119 if(conwidth_s != conwidth || conheight_s != conheight)
121 draw_reset_cropped();
122 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
127 void m_init_delayed()
129 float fh, glob, n, i;
132 conwidth = conheight = -1;
133 UpdateConWidthHeight();
134 draw_reset_cropped();
142 if(cvar_string("menu_skin") != "")
144 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
145 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
148 if(cvar_defstring("menu_skin") != "")
150 cvar_set("menu_skin", cvar_defstring("menu_skin"));
151 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
152 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
156 draw_currentSkin = "gfx/menu/default";
157 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
161 error("cannot load any menu skin\n");
163 draw_currentSkin = strzone(draw_currentSkin);
164 while((s = fgets(fh)))
166 // these two are handled by skinlist.qc
167 if(substring(s, 0, 6) == "title ")
169 if(substring(s, 0, 7) == "author ")
171 n = tokenize_console(s);
173 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
177 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
180 n = search_getsize(glob);
181 for(i = 0; i < n; ++i)
182 precache_pic(search_getfilename(glob, i));
186 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
189 anim = spawnAnimHost();
190 main = spawnMainWindow(); main.configureMainWindow(main);
193 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
196 menuMousePos = '0.5 0.5 0';
201 m_display(); // delayed menu display
204 void m_keyup (float key, float ascii)
210 draw_reset_cropped();
211 main.keyUp(main, key, ascii, menuShiftState);
212 if(key >= K_MOUSE1 && key <= K_MOUSE3)
214 --mouseButtonsPressed;
215 if(!mouseButtonsPressed)
216 main.mouseRelease(main, menuMousePos);
217 if(mouseButtonsPressed < 0)
219 mouseButtonsPressed = 0;
220 dprint("Warning: released an already released button\n");
223 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
224 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
225 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
228 void m_keydown(float key, float ascii)
239 e.keyGrabbed(e, key, ascii);
243 draw_reset_cropped();
244 if(key >= K_MOUSE1 && key <= K_MOUSE3)
245 if(!mouseButtonsPressed)
246 main.mousePress(main, menuMousePos);
247 if(!main.keyDown(main, key, ascii, menuShiftState))
249 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
250 m_hide(); // disable menu on unhandled ESC
252 if(key >= K_MOUSE1 && key <= K_MOUSE3)
254 ++mouseButtonsPressed;
255 if(mouseButtonsPressed > 10)
257 mouseButtonsPressed = 10;
258 dprint("Warning: pressed an already pressed button\n");
261 if(key == K_ALT) menuShiftState |= S_ALT;
262 if(key == K_CTRL) menuShiftState |= S_CTRL;
263 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
266 float SCALEMODE_CROP = 0;
267 float SCALEMODE_LETTERBOX = 1;
268 float SCALEMODE_WIDTH = 2;
269 float SCALEMODE_HEIGHT = 3;
270 float SCALEMODE_STRETCH = 4;
271 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
273 vector sz, org, isz, isz_w, isz_h;
274 float width_is_larger;
276 sz = draw_PictureSize(img);
277 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
278 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
279 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
285 isz = (width_is_larger ? isz_h : isz_w);
287 case SCALEMODE_LETTERBOX:
288 isz = (width_is_larger ? isz_w : isz_h);
290 case SCALEMODE_WIDTH:
293 case SCALEMODE_HEIGHT:
296 case SCALEMODE_STRETCH:
301 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
302 draw_Picture(org, img, isz, '1 1 1', a);
305 void drawBackground(string img, float a, string algn, float force1)
307 if(main.mainNexposee.ModalController_state == 0)
317 scalemode = SCALEMODE_CROP;
319 for(i = 0; i < strlen(algn); ++i)
321 c = substring(algn, i, 1);
324 case "c": scalemode = SCALEMODE_CROP; goto nopic;
325 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
326 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
327 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
328 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
329 case "1": case "4": case "7": v_x = 0.0; break;
330 case "2": case "5": case "8": v_x = 0.5; break;
331 case "3": case "6": case "9": v_x = 1.0; break;
332 default: v_x = random(); break;
336 case "7": case "8": case "9": v_y = 0.0; break;
337 case "4": case "5": case "6": v_y = 0.5; break;
338 case "1": case "2": case "3": v_y = 1.0; break;
339 default: v_y = random(); break;
342 draw_Picture_Aligned(v, scalemode, img, a);
344 // force all secondary layers to use alpha 1. Prevents ugly issues
345 // with overlap. It's a flag because it cannot be used for the
347 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
349 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
356 float menu_tooltips_old;
357 vector menuTooltipAveragedMousePos;
358 entity menuTooltipItem;
359 vector menuTooltipOrigin;
360 vector menuTooltipSize;
361 float menuTooltipAlpha;
362 string menuTooltipText;
363 float menuTooltipState; // 0: static, 1: fading in, 2: fading out
364 float m_testmousetooltipbox(vector pos)
366 if(pos_x >= menuTooltipOrigin_x && pos_x < menuTooltipOrigin_x + menuTooltipSize_x)
367 if(pos_y >= menuTooltipOrigin_y && pos_y < menuTooltipOrigin_y + menuTooltipSize_y)
371 float m_testtooltipbox(vector tooltippos)
377 if(tooltippos_x + menuTooltipSize_x > 1)
379 if(tooltippos_y + menuTooltipSize_y > 1)
381 menuTooltipOrigin = tooltippos;
384 float m_allocatetooltipbox(vector pos)
386 vector avoidplus, avoidminus;
389 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth;
390 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight;
393 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth + menuTooltipSize_x;
394 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight + menuTooltipSize_y;
399 if(m_testtooltipbox(v))
403 v_x = pos_x - menuTooltipSize_x * 0.5;
404 if(m_testtooltipbox(v))
408 v_x = pos_x - avoidminus_x;
409 if(m_testtooltipbox(v))
413 v_y = pos_y - avoidminus_y;
414 if(m_testtooltipbox(v))
418 v_x = pos_x - menuTooltipSize_x * 0.5;
419 if(m_testtooltipbox(v))
423 v_x = pos_x + avoidplus_x;
424 if(m_testtooltipbox(v))
429 entity m_findtooltipitem(entity root, vector pos)
437 while(it.instanceOfContainer)
439 while(it.instanceOfNexposee && it.focusedChild)
441 it = it.focusedChild;
442 pos = globalToBox(pos, it.Container_origin, it.Container_size);
444 if(it.instanceOfNexposee)
446 it = it.itemFromPoint(it, pos);
449 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
453 else if(it.instanceOfModalController)
454 it = it.focusedChild;
456 it = it.itemFromPoint(it, pos);
461 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
463 pos = globalToBox(pos, it.Container_origin, it.Container_size);
470 if (menu_tooltips == 2)
473 if (menuTooltipItem.cvarName)
475 if (getCvarsMulti(menuTooltipItem))
476 s = strcat("[", menuTooltipItem.cvarName, " ", getCvarsMulti(menuTooltipItem), "]");
478 s = strcat("[", menuTooltipItem.cvarName, "]");
480 else if (menuTooltipItem.onClickCommand)
481 s = strcat("<", menuTooltipItem.onClickCommand, ">");
483 return menuTooltipItem.tooltip;
484 if (menuTooltipItem.tooltip)
485 return strcat(menuTooltipItem.tooltip, " ", s);
488 return menuTooltipItem.tooltip;
490 void m_tooltip(vector pos)
497 menu_tooltips = cvar("menu_tooltips");
500 // don't return immediately, fade out the active tooltip first
501 if (menuTooltipItem == world)
504 menu_tooltips_old = menu_tooltips;
508 f = bound(0, frametime * 2, 1);
509 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + pos * f;
510 f = vlen(pos - menuTooltipAveragedMousePos);
512 it = m_findtooltipitem(main, pos);
516 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
518 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
519 if(it != menuTooltipItem)
521 switch(menuTooltipState)
526 // another item: fade out first
527 menuTooltipState = 2;
532 menuTooltipState = 1;
533 menuTooltipItem = it;
535 menuTooltipOrigin_x = -1; // unallocated
538 strunzone(menuTooltipText);
539 menuTooltipText = strzone(gettooltip());
543 getWrappedLine_remaining = menuTooltipText;
544 while(getWrappedLine_remaining)
546 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
548 f = draw_TextWidth(s, FALSE, fontsize);
552 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
553 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
554 menuTooltipSize_z = 0;
558 // changing item while fading in: fade out first
559 menuTooltipState = 2;
562 // changing item while fading out: can't
566 else if(menuTooltipState == 2) // re-fade in?
567 menuTooltipState = 1;
570 if(!m_testmousetooltipbox(pos))
571 menuTooltipState = 2; // fade out if mouse touches it
573 switch(menuTooltipState)
576 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
577 if(menuTooltipAlpha == 1)
578 menuTooltipState = 0;
581 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
582 if(menuTooltipAlpha == 0)
584 menuTooltipState = 0;
585 menuTooltipItem = world;
590 if(menuTooltipItem == world)
594 strunzone(menuTooltipText);
595 menuTooltipText = string_null;
601 if(menu_tooltips != menu_tooltips_old)
603 if (menu_tooltips != 0 && menu_tooltips_old != 0)
604 menuTooltipItem = world; // reload tooltip next frame
605 menu_tooltips_old = menu_tooltips;
607 else if(menuTooltipOrigin_x < 0) // unallocated?
608 m_allocatetooltipbox(pos);
610 if(menuTooltipOrigin_x >= 0)
613 p = SKINBORDER_TOOLTIP;
615 p_y *= 1 / conheight;
616 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
617 p = menuTooltipOrigin;
618 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
619 p_y += SKINMARGIN_TOOLTIP_y / conheight;
620 getWrappedLine_remaining = menuTooltipText;
621 while(getWrappedLine_remaining)
623 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
624 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
636 execute_next_frame();
638 menuMouseMode = cvar("menu_mouse_absolute");
644 UpdateConWidthHeight();
648 // TODO draw an info image about this situation
652 if(!menuNotTheFirstFrame)
654 menuNotTheFirstFrame = 1;
656 if(!cvar("menu_video_played"))
658 localcmd("cd loop $menu_cdtrack; play sound/announcer/default/welcome.ogg\n");
659 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading FIXME
661 // ALWAYS set this cvar; if we start but menu is not active, this means we want no background music!
662 localcmd("set menu_video_played 1\n");
666 realFrametime = frametime = min(0.2, t - menuPrevTime);
670 t = cvar("menu_slowmo");
681 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
682 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
687 if(cvar("cl_capturevideo"))
688 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
692 gamestatus = gamestatus | GAME_ISSERVER;
693 if(clientstate() == CS_CONNECTED)
694 gamestatus = gamestatus | GAME_CONNECTED;
695 if(cvar("developer"))
696 gamestatus = gamestatus | GAME_DEVELOPER;
698 prevMenuAlpha = menuAlpha;
701 if(menuAlpha == 0 && menuLogoAlpha < 2)
703 menuLogoAlpha = menuLogoAlpha + frametime * 2;
707 menuAlpha = min(1, menuAlpha + frametime * 5);
713 menuAlpha = max(0, menuAlpha - frametime * 5);
717 draw_reset_cropped();
719 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
721 if(menuLogoAlpha > 0)
724 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
725 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
726 draw_reset_cropped();
727 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
729 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
730 draw_drawMousePointer(menuMousePos);
735 else if(SKINALPHA_BACKGROUND_INGAME)
740 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
741 draw_reset_cropped();
745 if(menuAlpha != prevMenuAlpha)
746 cvar_set("_menu_alpha", ftos(menuAlpha));
748 draw_reset_cropped();
750 draw_reset_cropped();
754 if(prevMenuAlpha > 0)
755 main.initializeDialog(main, main.firstChild);
756 draw_reset_cropped();
761 draw_alpha *= menuAlpha;
766 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
767 if(newMouse != '0 0 0')
768 if(newMouse != menuMousePos)
770 menuMousePos = newMouse;
771 if(mouseButtonsPressed)
772 main.mouseDrag(main, menuMousePos);
774 main.mouseMove(main, menuMousePos);
781 vector dMouse, minpos, maxpos;
782 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
783 if(dMouse != '0 0 0')
785 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
786 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
787 dMouse = globalToBoxSize(dMouse, draw_scale);
788 menuMousePos += dMouse * cvar("menu_mouse_speed");
789 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
790 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
791 if(mouseButtonsPressed)
792 main.mouseDrag(main, menuMousePos);
794 main.mouseMove(main, menuMousePos);
800 m_tooltip(menuMousePos);
802 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
804 draw_drawMousePointer(menuMousePos);
806 draw_reset_cropped();
815 setkeydest(KEY_MENU);
816 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
821 if(mouseButtonsPressed)
822 main.mouseRelease(main, menuMousePos);
823 mouseButtonsPressed = 0;
825 main.focusEnter(main);
826 main.showNotify(main);
832 setkeydest(KEY_GAME);
833 setmousetarget(MT_CLIENT);
838 main.focusLeave(main);
839 main.hideNotify(main);
842 void m_toggle(float mode)
863 for(e = NULL; (e = nextent(e)) != NULL; )
865 if(e.classname != "vtbl")
871 void m_focus_item_chain(entity outermost, entity innermost)
873 if(innermost.parent != outermost)
874 m_focus_item_chain(outermost, innermost.parent);
875 innermost.parent.setFocus(innermost.parent, innermost);
878 void m_activate_window(entity wnd)
883 m_activate_window(par);
885 if(par.instanceOfModalController)
887 if(wnd.tabSelectingButton)
889 TabButton_Click(wnd.tabSelectingButton, wnd);
892 par.initializeDialog(par, wnd);
894 else if(par.instanceOfNexposee)
896 // nexposee (sorry for violating abstraction here)
897 par.selectedChild = wnd;
898 par.animationState = 1;
899 Container_setFocus(par, NULL);
901 else if(par.instanceOfContainer)
905 par.setFocus(par, wnd);
909 void m_setpointerfocus(entity wnd)
911 if(wnd.instanceOfContainer)
913 entity focus = wnd.preferredFocusedGrandChild(wnd);
916 menuMousePos = focus.origin + 0.5 * focus.size;
917 menuMousePos_x *= 1 / conwidth;
918 menuMousePos_y *= 1 / conheight;
919 if(wnd.focused) // why does this never happen?
920 m_focus_item_chain(wnd, focus);
925 void m_goto(string itemname)
930 if(itemname == "") // this can be called by GameCommand
932 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
936 m_activate_window(main.mainNexposee);
942 for(e = NULL; (e = find(e, name, itemname)); )
943 if(e.classname != "vtbl")
948 m_activate_window(e);
949 m_setpointerfocus(e);
955 void m_goto_skin_selector()
959 // TODO add code to switch back to the skin selector (no idea how to do it now)
960 m_goto("skinselector");
963 void m_goto_language_selector()
967 // TODO add code to switch back to the language selector (no idea how to do it now)
968 m_goto("languageselector");
971 void m_goto_video_settings()
975 // TODO add code to switch back to the video settings (no idea how to do it now)
976 m_goto("videosettings");