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;
19 float conwidth_s, conheight_s, vidwidth_s, vidheight_s, vidpixelheight_s,
20 realconwidth, realconheight;
25 vidwidth_s = vidheight_s = vidpixelheight_s = 0; // Force updateConwidths on next draw.
34 gamestatus = gamestatus | GAME_ISSERVER;
35 if(clientstate() == CS_CONNECTED || isdemo())
36 gamestatus = gamestatus | GAME_CONNECTED;
38 gamestatus = gamestatus | GAME_DEVELOPER;
44 cvar_set("_menu_alpha", "0");
45 prvm_language = cvar_string("prvm_language");
46 if(prvm_language == "")
49 cvar_set("prvm_language", prvm_language);
50 localcmd("\nmenu_restart\n");
53 prvm_language = strzone(prvm_language);
54 cvar_set("_menu_prvm_language", prvm_language);
56 check_unacceptable_compiler_bugs();
59 print(sprintf(_("^4MQC Build information: ^1%s\n"), WATERMARK));
62 // list all game dirs (TEST)
69 s = getgamedirinfo(i, GETGAMEDIRINFO_NAME);
72 dprint(s, ": ", getgamedirinfo(i, GETGAMEDIRINFO_DESCRIPTION));
76 // needs to be done so early because of the constants they create
77 CALL_ACCUMULATED_FUNCTION(RegisterWeapons);
78 CALL_ACCUMULATED_FUNCTION(RegisterGametypes);
80 RegisterSLCategories();
82 float ddsload = cvar("r_texture_dds_load");
83 float texcomp = cvar("gl_texturecompression");
85 if(ddsload != cvar("r_texture_dds_load") || texcomp != cvar("gl_texturecompression"))
86 localcmd("\nr_restart\n");
90 if(cvar("_menu_initialized")) // always show menu after menu_restart
94 cvar_set("_menu_initialized", "1");
100 const float MENU_ASPECT = 1.25; // 1280x1024
102 void draw_reset_cropped()
104 draw_reset(conwidth, conheight, 0.5 * (realconwidth - conwidth), 0.5 * (realconheight - conheight));
106 void draw_reset_full()
108 draw_reset(realconwidth, realconheight, 0, 0);
111 void UpdateConWidthHeight(float w, float h, float p)
113 if (w != vidwidth_s || h != vidheight_s || p != vidpixelheight_s)
115 if (updateConwidths(w, h, p))
116 localcmd(sprintf("\nexec %s\n", cvar_string("menu_font_cfg")));
119 vidpixelheight_s = p;
121 conwidth_s = conwidth;
122 conheight_s = conheight;
123 realconwidth = cvar("vid_conwidth");
124 realconheight = cvar("vid_conheight");
125 if(realconwidth / realconheight > MENU_ASPECT)
128 conwidth = realconheight * MENU_ASPECT;
129 conheight = realconheight;
134 conwidth = realconwidth;
135 conheight = realconwidth / MENU_ASPECT;
139 if(conwidth_s != conwidth || conheight_s != conheight)
141 draw_reset_cropped();
142 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
147 vidwidth_s = vidheight_s = vidpixelheight_s = 0; // retry next frame
151 string m_goto_buffer;
152 void m_init_delayed()
154 float fh, glob, n, i;
157 draw_reset_cropped();
165 if(cvar_string("menu_skin") != "")
167 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
168 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
171 if(cvar_defstring("menu_skin") != "")
173 cvar_set("menu_skin", cvar_defstring("menu_skin"));
174 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
175 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
179 draw_currentSkin = "gfx/menu/default";
180 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
184 error("cannot load any menu skin\n");
186 draw_currentSkin = strzone(draw_currentSkin);
187 while((s = fgets(fh)))
189 // these two are handled by skinlist.qc
190 if(substring(s, 0, 6) == "title ")
192 if(substring(s, 0, 7) == "author ")
194 n = tokenize_console(s);
196 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
200 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
203 n = search_getsize(glob);
204 for(i = 0; i < n; ++i)
205 precache_pic(search_getfilename(glob, i));
209 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
212 anim = spawnAnimHost();
213 main = spawnMainWindow(); main.configureMainWindow(main);
216 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
219 menuMousePos = '0.5 0.5 0';
225 m_goto(m_goto_buffer);
226 strunzone(m_goto_buffer);
227 m_goto_buffer = string_null;
231 m_display(); // delayed menu display
234 void m_keyup (float key, float ascii)
240 draw_reset_cropped();
241 main.keyUp(main, key, ascii, menuShiftState);
242 if(key >= K_MOUSE1 && key <= K_MOUSE3)
244 --mouseButtonsPressed;
245 if(!mouseButtonsPressed)
246 main.mouseRelease(main, menuMousePos);
247 if(mouseButtonsPressed < 0)
249 mouseButtonsPressed = 0;
250 dprint("Warning: released an already released button\n");
253 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
254 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
255 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
258 void m_keydown(float key, float ascii)
266 if(key >= K_MOUSE1 && key <= K_MOUSE3)
268 // detect a click outside of the game window
269 vector p = getmousepos();
270 if(p_x < 0 || p_x > realconwidth || p_y < 0 || p_y > realconheight)
272 ++mouseButtonsPressed;
282 e.keyGrabbed(e, key, ascii);
286 draw_reset_cropped();
287 if(key >= K_MOUSE1 && key <= K_MOUSE3)
288 if(!mouseButtonsPressed)
289 main.mousePress(main, menuMousePos);
290 if(!main.keyDown(main, key, ascii, menuShiftState))
292 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
293 m_hide(); // disable menu on unhandled ESC
295 if(key >= K_MOUSE1 && key <= K_MOUSE3)
297 ++mouseButtonsPressed;
298 if(mouseButtonsPressed > 10)
300 mouseButtonsPressed = 10;
301 dprint("Warning: pressed an already pressed button\n");
304 if(key == K_ALT) menuShiftState |= S_ALT;
305 if(key == K_CTRL) menuShiftState |= S_CTRL;
306 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
309 const float SCALEMODE_CROP = 0;
310 const float SCALEMODE_LETTERBOX = 1;
311 const float SCALEMODE_WIDTH = 2;
312 const float SCALEMODE_HEIGHT = 3;
313 const float SCALEMODE_STRETCH = 4;
314 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
316 vector sz, org, isz, isz_w, isz_h;
317 float width_is_larger;
319 sz = draw_PictureSize(img);
320 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
321 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
322 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
331 isz = (width_is_larger ? isz_h : isz_w);
333 case SCALEMODE_LETTERBOX:
334 isz = (width_is_larger ? isz_w : isz_h);
336 case SCALEMODE_WIDTH:
339 case SCALEMODE_HEIGHT:
342 case SCALEMODE_STRETCH:
347 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
348 draw_Picture(org, img, isz, '1 1 1', a);
351 void drawBackground(string img, float a, string algn, float force1)
353 if(main.mainNexposee.ModalController_state == 0)
363 scalemode = SCALEMODE_CROP;
366 for(i = 0; i < strlen(algn); ++i)
368 c = substring(algn, i, 1);
371 case "c": scalemode = SCALEMODE_CROP; goto nopic;
372 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
373 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
374 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
375 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
376 case "1": case "4": case "7": v_x = 0.0; break;
377 case "2": case "5": case "8": v_x = 0.5; break;
378 case "3": case "6": case "9": v_x = 1.0; break;
379 default: v_x = random(); break;
383 case "7": case "8": case "9": v_y = 0.0; break;
384 case "4": case "5": case "6": v_y = 0.5; break;
385 case "1": case "2": case "3": v_y = 1.0; break;
386 default: v_y = random(); break;
389 draw_Picture_Aligned(v, scalemode, img, a);
391 // force all secondary layers to use alpha 1. Prevents ugly issues
392 // with overlap. It's a flag because it cannot be used for the
394 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
396 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
403 float menu_tooltips_old;
404 vector menuTooltipAveragedMousePos;
405 entity menuTooltipItem;
406 vector menuTooltipOrigin;
407 vector menuTooltipSize;
408 float menuTooltipAlpha;
409 string menuTooltipText;
410 float menuTooltipState; // 0: static, 1: fading in, 2: fading out
411 float m_testmousetooltipbox(vector pos)
413 if(pos_x >= menuTooltipOrigin_x && pos_x < menuTooltipOrigin_x + menuTooltipSize_x)
414 if(pos_y >= menuTooltipOrigin_y && pos_y < menuTooltipOrigin_y + menuTooltipSize_y)
418 float m_testtooltipbox(vector tooltippos)
424 if(tooltippos_x + menuTooltipSize_x > 1)
426 if(tooltippos_y + menuTooltipSize_y > 1)
428 menuTooltipOrigin = tooltippos;
431 float m_allocatetooltipbox(vector pos)
433 vector avoidplus, avoidminus;
436 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth;
437 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight;
440 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth + menuTooltipSize_x;
441 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight + menuTooltipSize_y;
446 if(m_testtooltipbox(v))
450 v_x = pos_x - menuTooltipSize_x * 0.5;
451 if(m_testtooltipbox(v))
455 v_x = pos_x - avoidminus_x;
456 if(m_testtooltipbox(v))
460 v_y = pos_y - avoidminus_y;
461 if(m_testtooltipbox(v))
465 v_x = pos_x - menuTooltipSize_x * 0.5;
466 if(m_testtooltipbox(v))
470 v_x = pos_x + avoidplus_x;
471 if(m_testtooltipbox(v))
476 entity m_findtooltipitem(entity root, vector pos)
484 while(it.instanceOfContainer)
486 while(it.instanceOfNexposee && it.focusedChild)
488 it = it.focusedChild;
489 pos = globalToBox(pos, it.Container_origin, it.Container_size);
491 if(it.instanceOfNexposee)
493 it = it.itemFromPoint(it, pos);
496 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
500 else if(it.instanceOfModalController)
501 it = it.focusedChild;
503 it = it.itemFromPoint(it, pos);
508 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
510 pos = globalToBox(pos, it.Container_origin, it.Container_size);
517 if (menu_tooltips == 2)
520 if (menuTooltipItem.cvarName)
522 if (getCvarsMulti(menuTooltipItem))
523 s = strcat("[", menuTooltipItem.cvarName, " ", getCvarsMulti(menuTooltipItem), "]");
525 s = strcat("[", menuTooltipItem.cvarName, "]");
527 else if (menuTooltipItem.onClickCommand)
528 s = strcat("<", menuTooltipItem.onClickCommand, ">");
530 return menuTooltipItem.tooltip;
531 if (menuTooltipItem.tooltip)
532 return strcat(menuTooltipItem.tooltip, " ", s);
535 return menuTooltipItem.tooltip;
537 void m_tooltip(vector pos)
544 menu_tooltips = cvar("menu_tooltips");
547 // don't return immediately, fade out the active tooltip first
548 if (menuTooltipItem == world)
551 menu_tooltips_old = menu_tooltips;
555 f = bound(0, frametime * 2, 1);
556 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + pos * f;
557 f = vlen(pos - menuTooltipAveragedMousePos);
559 it = m_findtooltipitem(main, pos);
563 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
565 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
566 if(it != menuTooltipItem)
568 switch(menuTooltipState)
573 // another item: fade out first
574 menuTooltipState = 2;
579 menuTooltipState = 1;
580 menuTooltipItem = it;
582 menuTooltipOrigin_x = -1; // unallocated
585 strunzone(menuTooltipText);
586 menuTooltipText = strzone(gettooltip());
590 getWrappedLine_remaining = menuTooltipText;
591 while(getWrappedLine_remaining)
593 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
595 f = draw_TextWidth(s, FALSE, fontsize);
599 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
600 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
601 menuTooltipSize_z = 0;
605 // changing item while fading in: fade out first
606 menuTooltipState = 2;
609 // changing item while fading out: can't
613 else if(menuTooltipState == 2) // re-fade in?
614 menuTooltipState = 1;
617 if(!m_testmousetooltipbox(pos))
618 menuTooltipState = 2; // fade out if mouse touches it
620 switch(menuTooltipState)
623 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
624 if(menuTooltipAlpha == 1)
625 menuTooltipState = 0;
628 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
629 if(menuTooltipAlpha == 0)
631 menuTooltipState = 0;
632 menuTooltipItem = world;
637 if(menuTooltipItem == world)
641 strunzone(menuTooltipText);
642 menuTooltipText = string_null;
648 if(menu_tooltips != menu_tooltips_old)
650 if (menu_tooltips != 0 && menu_tooltips_old != 0)
651 menuTooltipItem = world; // reload tooltip next frame
652 menu_tooltips_old = menu_tooltips;
654 else if(menuTooltipOrigin_x < 0) // unallocated?
655 m_allocatetooltipbox(pos);
657 if(menuTooltipOrigin_x >= 0)
660 p = SKINBORDER_TOOLTIP;
662 p_y *= 1 / conheight;
663 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
664 p = menuTooltipOrigin;
665 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
666 p_y += SKINMARGIN_TOOLTIP_y / conheight;
667 getWrappedLine_remaining = menuTooltipText;
668 while(getWrappedLine_remaining)
670 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
671 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
678 void m_draw(float width, float height)
685 execute_next_frame();
687 menuMouseMode = cvar("menu_mouse_absolute");
692 UpdateConWidthHeight(width, height, cvar("vid_pixelheight"));
696 // TODO draw an info image about this situation
700 if(!menuNotTheFirstFrame)
702 menuNotTheFirstFrame = 1;
704 if(!cvar("menu_video_played"))
706 localcmd("cd loop $menu_cdtrack; play sound/announcer/default/welcome.wav\n");
707 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading FIXME
709 // ALWAYS set this cvar; if we start but menu is not active, this means we want no background music!
710 localcmd("set menu_video_played 1\n");
714 realFrametime = frametime = min(0.2, t - menuPrevTime);
718 t = cvar("menu_slowmo");
729 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
730 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
735 if(cvar("cl_capturevideo"))
736 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
738 prevMenuAlpha = menuAlpha;
741 if(menuAlpha == 0 && menuLogoAlpha < 2)
743 menuLogoAlpha = menuLogoAlpha + frametime * 2;
747 menuAlpha = min(1, menuAlpha + frametime * 5);
753 menuAlpha = max(0, menuAlpha - frametime * 5);
757 draw_reset_cropped();
759 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
761 if(menuLogoAlpha > 0)
764 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
765 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
766 draw_reset_cropped();
767 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
769 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
770 draw_drawMousePointer(menuMousePos);
775 else if(SKINALPHA_BACKGROUND_INGAME)
780 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
781 draw_reset_cropped();
785 if(menuAlpha != prevMenuAlpha)
786 cvar_set("_menu_alpha", ftos(menuAlpha));
788 draw_reset_cropped();
790 draw_reset_cropped();
794 if(prevMenuAlpha > 0)
795 main.initializeDialog(main, main.firstChild);
796 draw_reset_cropped();
801 draw_alpha *= menuAlpha;
805 // do not update mouse position
806 // it prevents mouse jumping to '0 0 0' when menu is fading out
808 else if(menuMouseMode)
811 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
812 if(newMouse != '0 0 0')
813 if(newMouse != menuMousePos)
815 menuMousePos = newMouse;
816 if(mouseButtonsPressed)
817 main.mouseDrag(main, menuMousePos);
819 main.mouseMove(main, menuMousePos);
826 vector dMouse, minpos, maxpos;
827 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
828 if(dMouse != '0 0 0')
830 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
831 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
832 dMouse = globalToBoxSize(dMouse, draw_scale);
833 menuMousePos += dMouse * cvar("menu_mouse_speed");
834 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
835 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
836 if(mouseButtonsPressed)
837 main.mouseDrag(main, menuMousePos);
839 main.mouseMove(main, menuMousePos);
845 m_tooltip(menuMousePos);
847 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
849 draw_drawMousePointer(menuMousePos);
851 draw_reset_cropped();
860 setkeydest(KEY_MENU);
861 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
866 if(mouseButtonsPressed)
867 main.mouseRelease(main, menuMousePos);
868 mouseButtonsPressed = 0;
870 main.focusEnter(main);
871 main.showNotify(main);
877 setkeydest(KEY_GAME);
878 setmousetarget(MT_CLIENT);
883 main.focusLeave(main);
884 main.hideNotify(main);
887 void m_toggle(float mode)
908 for(e = NULL; (e = nextent(e)) != NULL; )
910 if(e.classname != "vtbl")
916 void m_focus_item_chain(entity outermost, entity innermost)
918 if(innermost.parent != outermost)
919 m_focus_item_chain(outermost, innermost.parent);
920 innermost.parent.setFocus(innermost.parent, innermost);
923 void m_activate_window(entity wnd)
928 m_activate_window(par);
930 if(par.instanceOfModalController)
932 if(wnd.tabSelectingButton)
934 TabButton_Click(wnd.tabSelectingButton, wnd);
937 par.initializeDialog(par, wnd);
939 else if(par.instanceOfNexposee)
941 // nexposee (sorry for violating abstraction here)
942 par.selectedChild = wnd;
943 par.animationState = 1;
944 Container_setFocus(par, NULL);
946 else if(par.instanceOfContainer)
950 par.setFocus(par, wnd);
954 void m_setpointerfocus(entity wnd)
956 if(wnd.instanceOfContainer)
958 entity focus = wnd.preferredFocusedGrandChild(wnd);
961 menuMousePos = focus.origin + 0.5 * focus.size;
962 menuMousePos_x *= 1 / conwidth;
963 menuMousePos_y *= 1 / conheight;
964 if(wnd.focused) // why does this never happen?
965 m_focus_item_chain(wnd, focus);
970 void m_goto(string itemname)
976 strunzone(m_goto_buffer);
977 m_goto_buffer = strzone(itemname);
980 if(itemname == "") // this can be called by GameCommand
982 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
988 m_activate_window(main.mainNexposee);
994 for(e = NULL; (e = find(e, name, itemname)); )
995 if(e.classname != "vtbl")
998 if((e) && (!e.requiresConnection || (gamestatus & (GAME_ISSERVER | GAME_CONNECTED))))
1001 m_activate_window(e);
1002 m_setpointerfocus(e);