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 float ddsload = cvar("r_texture_dds_load");
81 float texcomp = cvar("gl_texturecompression");
83 if(ddsload != cvar("r_texture_dds_load") || texcomp != cvar("gl_texturecompression"))
84 localcmd("\nr_restart\n");
88 if(cvar("_menu_initialized")) // always show menu after menu_restart
92 cvar_set("_menu_initialized", "1");
96 const float MENU_ASPECT = 1.25; // 1280x1024
98 void draw_reset_cropped()
100 draw_reset(conwidth, conheight, 0.5 * (realconwidth - conwidth), 0.5 * (realconheight - conheight));
102 void draw_reset_full()
104 draw_reset(realconwidth, realconheight, 0, 0);
107 void UpdateConWidthHeight(float w, float h, float p)
109 if (w != vidwidth_s || h != vidheight_s || p != vidpixelheight_s)
111 updateConwidths(w, h, p);
114 vidpixelheight_s = p;
116 conwidth_s = conwidth;
117 conheight_s = conheight;
118 realconwidth = cvar("vid_conwidth");
119 realconheight = cvar("vid_conheight");
120 if(realconwidth / realconheight > MENU_ASPECT)
123 conwidth = realconheight * MENU_ASPECT;
124 conheight = realconheight;
129 conwidth = realconwidth;
130 conheight = realconwidth / MENU_ASPECT;
134 if(conwidth_s != conwidth || conheight_s != conheight)
136 draw_reset_cropped();
137 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
142 vidwidth_s = vidheight_s = vidpixelheight_s = 0; // retry next frame
146 string m_goto_buffer;
147 void m_init_delayed()
149 float fh, glob, n, i;
152 draw_reset_cropped();
160 if(cvar_string("menu_skin") != "")
162 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
163 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
166 if(cvar_defstring("menu_skin") != "")
168 cvar_set("menu_skin", cvar_defstring("menu_skin"));
169 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
170 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
174 draw_currentSkin = "gfx/menu/default";
175 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
179 error("cannot load any menu skin\n");
181 draw_currentSkin = strzone(draw_currentSkin);
182 while((s = fgets(fh)))
184 // these two are handled by skinlist.qc
185 if(substring(s, 0, 6) == "title ")
187 if(substring(s, 0, 7) == "author ")
189 n = tokenize_console(s);
191 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
195 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
198 n = search_getsize(glob);
199 for(i = 0; i < n; ++i)
200 precache_pic(search_getfilename(glob, i));
204 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
207 anim = spawnAnimHost();
208 main = spawnMainWindow(); main.configureMainWindow(main);
211 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
214 menuMousePos = '0.5 0.5 0';
220 m_goto(m_goto_buffer);
221 strunzone(m_goto_buffer);
222 m_goto_buffer = string_null;
226 m_display(); // delayed menu display
229 void m_keyup (float key, float ascii)
235 draw_reset_cropped();
236 main.keyUp(main, key, ascii, menuShiftState);
237 if(key >= K_MOUSE1 && key <= K_MOUSE3)
239 --mouseButtonsPressed;
240 if(!mouseButtonsPressed)
241 main.mouseRelease(main, menuMousePos);
242 if(mouseButtonsPressed < 0)
244 mouseButtonsPressed = 0;
245 dprint("Warning: released an already released button\n");
248 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
249 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
250 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
253 void m_keydown(float key, float ascii)
261 if(key >= K_MOUSE1 && key <= K_MOUSE3)
263 // detect a click outside of the game window
264 vector p = getmousepos();
265 if(p_x < 0 || p_x > realconwidth || p_y < 0 || p_y > realconheight)
267 ++mouseButtonsPressed;
277 e.keyGrabbed(e, key, ascii);
281 draw_reset_cropped();
282 if(key >= K_MOUSE1 && key <= K_MOUSE3)
283 if(!mouseButtonsPressed)
284 main.mousePress(main, menuMousePos);
285 if(!main.keyDown(main, key, ascii, menuShiftState))
287 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
288 m_hide(); // disable menu on unhandled ESC
290 if(key >= K_MOUSE1 && key <= K_MOUSE3)
292 ++mouseButtonsPressed;
293 if(mouseButtonsPressed > 10)
295 mouseButtonsPressed = 10;
296 dprint("Warning: pressed an already pressed button\n");
299 if(key == K_ALT) menuShiftState |= S_ALT;
300 if(key == K_CTRL) menuShiftState |= S_CTRL;
301 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
304 const float SCALEMODE_CROP = 0;
305 const float SCALEMODE_LETTERBOX = 1;
306 const float SCALEMODE_WIDTH = 2;
307 const float SCALEMODE_HEIGHT = 3;
308 const float SCALEMODE_STRETCH = 4;
309 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
311 vector sz, org, isz, isz_w, isz_h;
312 float width_is_larger;
314 sz = draw_PictureSize(img);
315 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
316 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
317 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
326 isz = (width_is_larger ? isz_h : isz_w);
328 case SCALEMODE_LETTERBOX:
329 isz = (width_is_larger ? isz_w : isz_h);
331 case SCALEMODE_WIDTH:
334 case SCALEMODE_HEIGHT:
337 case SCALEMODE_STRETCH:
342 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
343 draw_Picture(org, img, isz, '1 1 1', a);
346 void drawBackground(string img, float a, string algn, float force1)
348 if(main.mainNexposee.ModalController_state == 0)
358 scalemode = SCALEMODE_CROP;
361 for(i = 0; i < strlen(algn); ++i)
363 c = substring(algn, i, 1);
366 case "c": scalemode = SCALEMODE_CROP; goto nopic;
367 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
368 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
369 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
370 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
371 case "1": case "4": case "7": v_x = 0.0; break;
372 case "2": case "5": case "8": v_x = 0.5; break;
373 case "3": case "6": case "9": v_x = 1.0; break;
374 default: v_x = random(); break;
378 case "7": case "8": case "9": v_y = 0.0; break;
379 case "4": case "5": case "6": v_y = 0.5; break;
380 case "1": case "2": case "3": v_y = 1.0; break;
381 default: v_y = random(); break;
384 draw_Picture_Aligned(v, scalemode, img, a);
386 // force all secondary layers to use alpha 1. Prevents ugly issues
387 // with overlap. It's a flag because it cannot be used for the
389 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
391 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
398 float menu_tooltips_old;
399 vector menuTooltipAveragedMousePos;
400 entity menuTooltipItem;
401 vector menuTooltipOrigin;
402 vector menuTooltipSize;
403 float menuTooltipAlpha;
404 string menuTooltipText;
405 float menuTooltipState; // 0: static, 1: fading in, 2: fading out
406 float m_testmousetooltipbox(vector pos)
408 if(pos_x >= menuTooltipOrigin_x && pos_x < menuTooltipOrigin_x + menuTooltipSize_x)
409 if(pos_y >= menuTooltipOrigin_y && pos_y < menuTooltipOrigin_y + menuTooltipSize_y)
413 float m_testtooltipbox(vector tooltippos)
419 if(tooltippos_x + menuTooltipSize_x > 1)
421 if(tooltippos_y + menuTooltipSize_y > 1)
423 menuTooltipOrigin = tooltippos;
426 float m_allocatetooltipbox(vector pos)
428 vector avoidplus, avoidminus;
431 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth;
432 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight;
435 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth + menuTooltipSize_x;
436 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight + menuTooltipSize_y;
441 if(m_testtooltipbox(v))
445 v_x = pos_x - menuTooltipSize_x * 0.5;
446 if(m_testtooltipbox(v))
450 v_x = pos_x - avoidminus_x;
451 if(m_testtooltipbox(v))
455 v_y = pos_y - avoidminus_y;
456 if(m_testtooltipbox(v))
460 v_x = pos_x - menuTooltipSize_x * 0.5;
461 if(m_testtooltipbox(v))
465 v_x = pos_x + avoidplus_x;
466 if(m_testtooltipbox(v))
471 entity m_findtooltipitem(entity root, vector pos)
479 while(it.instanceOfContainer)
481 while(it.instanceOfNexposee && it.focusedChild)
483 it = it.focusedChild;
484 pos = globalToBox(pos, it.Container_origin, it.Container_size);
486 if(it.instanceOfNexposee)
488 it = it.itemFromPoint(it, pos);
491 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
495 else if(it.instanceOfModalController)
496 it = it.focusedChild;
498 it = it.itemFromPoint(it, pos);
503 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
505 pos = globalToBox(pos, it.Container_origin, it.Container_size);
512 if (menu_tooltips == 2)
515 if (menuTooltipItem.cvarName)
517 if (getCvarsMulti(menuTooltipItem))
518 s = strcat("[", menuTooltipItem.cvarName, " ", getCvarsMulti(menuTooltipItem), "]");
520 s = strcat("[", menuTooltipItem.cvarName, "]");
522 else if (menuTooltipItem.onClickCommand)
523 s = strcat("<", menuTooltipItem.onClickCommand, ">");
525 return menuTooltipItem.tooltip;
526 if (menuTooltipItem.tooltip)
527 return strcat(menuTooltipItem.tooltip, " ", s);
530 return menuTooltipItem.tooltip;
532 void m_tooltip(vector pos)
539 menu_tooltips = cvar("menu_tooltips");
542 // don't return immediately, fade out the active tooltip first
543 if (menuTooltipItem == world)
546 menu_tooltips_old = menu_tooltips;
550 f = bound(0, frametime * 2, 1);
551 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + pos * f;
552 f = vlen(pos - menuTooltipAveragedMousePos);
554 it = m_findtooltipitem(main, pos);
558 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
560 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
561 if(it != menuTooltipItem)
563 switch(menuTooltipState)
568 // another item: fade out first
569 menuTooltipState = 2;
574 menuTooltipState = 1;
575 menuTooltipItem = it;
577 menuTooltipOrigin_x = -1; // unallocated
580 strunzone(menuTooltipText);
581 menuTooltipText = strzone(gettooltip());
585 getWrappedLine_remaining = menuTooltipText;
586 while(getWrappedLine_remaining)
588 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
590 f = draw_TextWidth(s, FALSE, fontsize);
594 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
595 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
596 menuTooltipSize_z = 0;
600 // changing item while fading in: fade out first
601 menuTooltipState = 2;
604 // changing item while fading out: can't
608 else if(menuTooltipState == 2) // re-fade in?
609 menuTooltipState = 1;
612 if(!m_testmousetooltipbox(pos))
613 menuTooltipState = 2; // fade out if mouse touches it
615 switch(menuTooltipState)
618 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
619 if(menuTooltipAlpha == 1)
620 menuTooltipState = 0;
623 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
624 if(menuTooltipAlpha == 0)
626 menuTooltipState = 0;
627 menuTooltipItem = world;
632 if(menuTooltipItem == world)
636 strunzone(menuTooltipText);
637 menuTooltipText = string_null;
643 if(menu_tooltips != menu_tooltips_old)
645 if (menu_tooltips != 0 && menu_tooltips_old != 0)
646 menuTooltipItem = world; // reload tooltip next frame
647 menu_tooltips_old = menu_tooltips;
649 else if(menuTooltipOrigin_x < 0) // unallocated?
650 m_allocatetooltipbox(pos);
652 if(menuTooltipOrigin_x >= 0)
655 p = SKINBORDER_TOOLTIP;
657 p_y *= 1 / conheight;
658 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
659 p = menuTooltipOrigin;
660 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
661 p_y += SKINMARGIN_TOOLTIP_y / conheight;
662 getWrappedLine_remaining = menuTooltipText;
663 while(getWrappedLine_remaining)
665 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
666 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
673 void m_draw(float width, float height)
680 execute_next_frame();
682 menuMouseMode = cvar("menu_mouse_absolute");
687 UpdateConWidthHeight(width, height, cvar("vid_pixelheight"));
691 // TODO draw an info image about this situation
695 if(!menuNotTheFirstFrame)
697 menuNotTheFirstFrame = 1;
699 if(!cvar("menu_video_played"))
701 localcmd("cd loop $menu_cdtrack; play sound/announcer/default/welcome.wav\n");
702 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading FIXME
704 // ALWAYS set this cvar; if we start but menu is not active, this means we want no background music!
705 localcmd("set menu_video_played 1\n");
709 realFrametime = frametime = min(0.2, t - menuPrevTime);
713 t = cvar("menu_slowmo");
724 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
725 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
730 if(cvar("cl_capturevideo"))
731 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
733 prevMenuAlpha = menuAlpha;
736 if(menuAlpha == 0 && menuLogoAlpha < 2)
738 menuLogoAlpha = menuLogoAlpha + frametime * 2;
742 menuAlpha = min(1, menuAlpha + frametime * 5);
748 menuAlpha = max(0, menuAlpha - frametime * 5);
752 draw_reset_cropped();
754 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
756 if(menuLogoAlpha > 0)
759 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
760 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
761 draw_reset_cropped();
762 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
764 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
765 draw_drawMousePointer(menuMousePos);
770 else if(SKINALPHA_BACKGROUND_INGAME)
775 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
776 draw_reset_cropped();
780 if(menuAlpha != prevMenuAlpha)
781 cvar_set("_menu_alpha", ftos(menuAlpha));
783 draw_reset_cropped();
785 draw_reset_cropped();
789 if(prevMenuAlpha > 0)
790 main.initializeDialog(main, main.firstChild);
791 draw_reset_cropped();
796 draw_alpha *= menuAlpha;
800 // do not update mouse position
801 // it prevents mouse jumping to '0 0 0' when menu is fading out
803 else if(menuMouseMode)
806 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
807 if(newMouse != '0 0 0')
808 if(newMouse != menuMousePos)
810 menuMousePos = newMouse;
811 if(mouseButtonsPressed)
812 main.mouseDrag(main, menuMousePos);
814 main.mouseMove(main, menuMousePos);
821 vector dMouse, minpos, maxpos;
822 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
823 if(dMouse != '0 0 0')
825 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
826 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
827 dMouse = globalToBoxSize(dMouse, draw_scale);
828 menuMousePos += dMouse * cvar("menu_mouse_speed");
829 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
830 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
831 if(mouseButtonsPressed)
832 main.mouseDrag(main, menuMousePos);
834 main.mouseMove(main, menuMousePos);
840 m_tooltip(menuMousePos);
842 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
844 draw_drawMousePointer(menuMousePos);
846 draw_reset_cropped();
855 setkeydest(KEY_MENU);
856 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
861 if(mouseButtonsPressed)
862 main.mouseRelease(main, menuMousePos);
863 mouseButtonsPressed = 0;
865 main.focusEnter(main);
866 main.showNotify(main);
872 setkeydest(KEY_GAME);
873 setmousetarget(MT_CLIENT);
878 main.focusLeave(main);
879 main.hideNotify(main);
882 void m_toggle(float mode)
903 for(e = NULL; (e = nextent(e)) != NULL; )
905 if(e.classname != "vtbl")
911 void m_focus_item_chain(entity outermost, entity innermost)
913 if(innermost.parent != outermost)
914 m_focus_item_chain(outermost, innermost.parent);
915 innermost.parent.setFocus(innermost.parent, innermost);
918 void m_activate_window(entity wnd)
923 m_activate_window(par);
925 if(par.instanceOfModalController)
927 if(wnd.tabSelectingButton)
929 TabButton_Click(wnd.tabSelectingButton, wnd);
932 par.initializeDialog(par, wnd);
934 else if(par.instanceOfNexposee)
936 // nexposee (sorry for violating abstraction here)
937 par.selectedChild = wnd;
938 par.animationState = 1;
939 Container_setFocus(par, NULL);
941 else if(par.instanceOfContainer)
945 par.setFocus(par, wnd);
949 void m_setpointerfocus(entity wnd)
951 if(wnd.instanceOfContainer)
953 entity focus = wnd.preferredFocusedGrandChild(wnd);
956 menuMousePos = focus.origin + 0.5 * focus.size;
957 menuMousePos_x *= 1 / conwidth;
958 menuMousePos_y *= 1 / conheight;
959 if(wnd.focused) // why does this never happen?
960 m_focus_item_chain(wnd, focus);
965 void m_goto(string itemname)
971 strunzone(m_goto_buffer);
972 m_goto_buffer = strzone(itemname);
975 if(itemname == "") // this can be called by GameCommand
977 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
983 m_activate_window(main.mainNexposee);
989 for(e = NULL; (e = find(e, name, itemname)); )
990 if(e.classname != "vtbl")
993 if((e) && (!e.requiresConnection || (gamestatus & (GAME_ISSERVER | GAME_CONNECTED))))
996 m_activate_window(e);
997 m_setpointerfocus(e);