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");
25 check_unacceptable_compiler_bugs();
28 print("^4MQC Build information: ", WATERMARK(), "\n");
31 // list all game dirs (TEST)
38 s = getgamedirinfo(i, GETGAMEDIRINFO_NAME);
41 print(s, ": ", getgamedirinfo(i, GETGAMEDIRINFO_DESCRIPTION));
46 float MENU_ASPECT = 1.25; // 1280x1024
47 float MENU_MINHEIGHT = 600;
48 float conwidth_s, conheight_s, realconwidth, realconheight, screenconwidth, screenconheight;
49 void draw_reset_cropped()
51 draw_reset(screenconwidth, screenconheight, 0.5 * (realconwidth - screenconwidth), 0.5 * (realconheight - screenconheight));
53 void draw_reset_full()
55 draw_reset(realconwidth, realconheight, 0, 0);
57 void UpdateConWidthHeight()
59 conwidth_s = conwidth;
60 conheight_s = conheight;
61 realconwidth = cvar("vid_conwidth");
62 realconheight = cvar("vid_conheight");
63 if(realconwidth / realconheight > MENU_ASPECT)
66 conwidth = realconheight * MENU_ASPECT;
67 conheight = realconheight;
72 conwidth = realconwidth;
73 conheight = realconwidth / MENU_ASPECT;
75 screenconwidth = conwidth;
76 screenconheight = conheight;
77 if(conwidth < MENU_MINHEIGHT * MENU_ASPECT)
79 conheight *= MENU_MINHEIGHT * MENU_ASPECT / conwidth;
80 conwidth = MENU_MINHEIGHT * MENU_ASPECT;
82 if(conheight < MENU_MINHEIGHT)
84 conwidth *= MENU_MINHEIGHT / conheight;
85 conheight = MENU_MINHEIGHT;
89 if(conwidth_s != conwidth || conheight_s != conheight)
92 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
97 void() m_init_delayed =
102 conwidth = conheight = -1;
103 UpdateConWidthHeight();
104 draw_reset_cropped();
115 if(cvar_string("menu_skin") != "")
117 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
118 fh = fopen(strcat(draw_currentSkin, "/skinvalues.txt"), FILE_READ);
121 if(cvar_defstring("menu_skin") != "")
123 draw_currentSkin = strcat("gfx/menu/", cvar_defstring("menu_skin"));
124 fh = fopen(strcat(draw_currentSkin, "/skinvalues.txt"), FILE_READ);
128 draw_currentSkin = "gfx/menu/default";
129 fh = fopen(strcat(draw_currentSkin, "/skinvalues.txt"), FILE_READ);
131 draw_currentSkin = strzone(draw_currentSkin);
132 while((s = fgets(fh)))
134 // these two are handled by skinlist.qc
135 if(substring(s, 0, 6) == "title ")
137 if(substring(s, 0, 7) == "author ")
139 n = tokenize_console(s);
141 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
145 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
148 n = search_getsize(glob);
149 for(i = 0; i < n; ++i)
150 precache_pic(search_getfilename(glob, i));
154 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
157 anim = spawnAnimHost();
158 main = spawnMainWindow(); main.configureMainWindow(main);
161 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
164 menuMousePos = '0.5 0.5 0';
167 m_display(); // delayed menu display
170 void(float key, float ascii) m_keyup =
176 draw_reset_cropped();
177 main.keyUp(main, key, ascii, menuShiftState);
178 if(key >= K_MOUSE1 && key <= K_MOUSE3)
180 --mouseButtonsPressed;
181 if(!mouseButtonsPressed)
182 main.mouseRelease(main, menuMousePos);
183 if(mouseButtonsPressed < 0)
185 mouseButtonsPressed = 0;
186 print("Warning: released an already released button\n");
189 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
190 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
191 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
194 void(float key, float ascii) m_keydown =
205 e.keyGrabbed(e, key, ascii);
209 draw_reset_cropped();
210 if(key >= K_MOUSE1 && key <= K_MOUSE3)
211 if(!mouseButtonsPressed)
212 main.mousePress(main, menuMousePos);
213 if(!main.keyDown(main, key, ascii, menuShiftState))
215 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
216 m_hide(); // disable menu on unhandled ESC
218 if(key >= K_MOUSE1 && key <= K_MOUSE3)
220 ++mouseButtonsPressed;
221 if(mouseButtonsPressed > 10)
223 mouseButtonsPressed = 10;
224 print("Warning: pressed an already pressed button\n");
227 if(key == K_ALT) menuShiftState |= S_ALT;
228 if(key == K_CTRL) menuShiftState |= S_CTRL;
229 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
232 float SCALEMODE_CROP = 0;
233 float SCALEMODE_LETTERBOX = 1;
234 float SCALEMODE_WIDTH = 2;
235 float SCALEMODE_HEIGHT = 3;
236 float SCALEMODE_STRETCH = 4;
237 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
239 vector sz, org, isz, isz_w, isz_h;
240 float width_is_larger;
242 sz = draw_PictureSize(img);
243 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
244 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
245 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
251 isz = (width_is_larger ? isz_h : isz_w);
253 case SCALEMODE_LETTERBOX:
254 isz = (width_is_larger ? isz_w : isz_h);
256 case SCALEMODE_WIDTH:
259 case SCALEMODE_HEIGHT:
262 case SCALEMODE_STRETCH:
267 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
268 draw_Picture(org, img, isz, '1 1 1', a);
271 void(string img, float a, string algn, float force1) drawBackground =
273 if(main.mainNexposee.ModalController_state == 0)
283 scalemode = SCALEMODE_CROP;
285 for(i = 0; i < strlen(algn); ++i)
287 c = substring(algn, i, 1);
290 case "c": scalemode = SCALEMODE_CROP; goto nopic;
291 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
292 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
293 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
294 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
295 case "1": case "4": case "7": v_x = 0.0; break;
296 case "2": case "5": case "8": v_x = 0.5; break;
297 case "3": case "6": case "9": v_x = 1.0; break;
298 default: v_x = random(); break;
302 case "7": case "8": case "9": v_y = 0.0; break;
303 case "4": case "5": case "6": v_y = 0.5; break;
304 case "1": case "2": case "3": v_y = 1.0; break;
305 default: v_y = random(); break;
308 draw_Picture_Aligned(v, scalemode, img, a);
310 // force all secondary layers to use alpha 1. Prevents ugly issues
311 // with overlap. It's a flag because it cannot be used for the
313 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
315 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
322 float menu_tooltips_old;
323 vector menuTooltipAveragedMousePos;
324 entity menuTooltipItem;
325 vector menuTooltipOrigin;
326 vector menuTooltipSize;
327 float menuTooltipAlpha;
328 string menuTooltipText;
329 float menuTooltipState; // 0: static, 1: fading in, 2: fading out
330 float m_testmousetooltipbox()
332 if(menuMousePos_x >= menuTooltipOrigin_x && menuMousePos_x < menuTooltipOrigin_x + menuTooltipSize_x)
333 if(menuMousePos_y >= menuTooltipOrigin_y && menuMousePos_y < menuTooltipOrigin_y + menuTooltipSize_y)
337 float m_testtooltipbox(vector tooltippos)
343 if(tooltippos_x + menuTooltipSize_x > 1)
345 if(tooltippos_y + menuTooltipSize_y > 1)
348 menuTooltipOrigin_x = rint(tooltippos_x * cvar("vid_width")) / cvar("vid_width");
349 menuTooltipOrigin_y = rint(tooltippos_y * cvar("vid_height")) / cvar("vid_height");
350 menuTooltipOrigin_z = 0;
352 menuTooltipOrigin = tooltippos;
355 float m_allocatetooltipbox(vector pos)
357 vector avoidplus, avoidminus;
360 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x) / conwidth;
361 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y) / conheight;
364 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x) / conwidth + menuTooltipSize_x;
365 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y) / conheight + menuTooltipSize_y;
370 if(m_testtooltipbox(v))
374 v_x = pos_x - menuTooltipSize_x * 0.5;
375 if(m_testtooltipbox(v))
379 v_x = pos_x - avoidminus_x;
380 if(m_testtooltipbox(v))
384 v_y = pos_y - avoidminus_y;
385 if(m_testtooltipbox(v))
389 v_x = pos_x - menuTooltipSize_x * 0.5;
390 if(m_testtooltipbox(v))
394 v_x = pos_x + avoidplus_x;
395 if(m_testtooltipbox(v))
400 entity m_findtooltipitem(entity root, vector pos)
408 while(it.instanceOfContainer)
410 while(it.instanceOfNexposee && it.focusedChild)
412 it = it.focusedChild;
413 pos = globalToBox(pos, it.Container_origin, it.Container_size);
415 if(it.instanceOfNexposee)
417 it = it.itemFromPoint(it, pos);
420 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
424 else if(it.instanceOfModalController)
425 it = it.focusedChild;
427 it = it.itemFromPoint(it, pos);
432 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
434 pos = globalToBox(pos, it.Container_origin, it.Container_size);
441 if (menu_tooltips == 2)
444 if (menuTooltipItem.cvarName)
446 if (getCvarsMulti(menuTooltipItem))
447 s = strcat("[", menuTooltipItem.cvarName, " ", getCvarsMulti(menuTooltipItem), "]");
449 s = strcat("[", menuTooltipItem.cvarName, "]");
451 else if (menuTooltipItem.onClickCommand)
452 s = strcat("<", menuTooltipItem.onClickCommand, ">");
454 return menuTooltipItem.tooltip;
455 if (menuTooltipItem.tooltip)
456 return strcat(menuTooltipItem.tooltip, " ", s);
459 return menuTooltipItem.tooltip;
468 menu_tooltips = cvar("menu_tooltips");
471 // don't return immediately, fade out the active tooltip first
472 if (menuTooltipItem == world)
475 menu_tooltips_old = menu_tooltips;
479 f = bound(0, frametime * 2, 1);
480 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + menuMousePos * f;
481 f = vlen(menuMousePos - menuTooltipAveragedMousePos);
483 it = m_findtooltipitem(main, menuMousePos);
487 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
489 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
490 if(it != menuTooltipItem)
492 switch(menuTooltipState)
497 // another item: fade out first
498 menuTooltipState = 2;
503 menuTooltipState = 1;
504 menuTooltipItem = it;
506 menuTooltipOrigin_x = -1; // unallocated
508 menuTooltipText = strzone(gettooltip());
511 getWrappedLine_remaining = menuTooltipText;
512 while(getWrappedLine_remaining)
514 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
516 f = draw_TextWidth(s, FALSE, fontsize);
520 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
521 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
522 menuTooltipSize_z = 0;
526 // changing item while fading in: fade out first
527 menuTooltipState = 2;
530 // changing item while fading out: can't
534 else if(menuTooltipState == 2) // re-fade in?
535 menuTooltipState = 1;
538 if(!m_testmousetooltipbox())
539 menuTooltipState = 2; // fade out if mouse touches it
541 switch(menuTooltipState)
544 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
545 if(menuTooltipAlpha == 1)
546 menuTooltipState = 0;
549 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
550 if(menuTooltipAlpha == 0)
552 menuTooltipState = 0;
553 menuTooltipItem = world;
560 if(menu_tooltips != menu_tooltips_old)
562 if (menu_tooltips != 0 && menu_tooltips_old != 0)
563 menuTooltipItem = world; // reload tooltip next frame
564 menu_tooltips_old = menu_tooltips;
566 else if(menuTooltipOrigin_x < 0) // unallocated?
567 m_allocatetooltipbox(menuMousePos);
569 if(menuTooltipOrigin_x >= 0)
572 p = SKINBORDER_TOOLTIP;
574 p_y *= 1 / conheight;
575 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
576 p = menuTooltipOrigin;
577 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
578 p_y += SKINMARGIN_TOOLTIP_y / conheight;
579 getWrappedLine_remaining = menuTooltipText;
580 while(getWrappedLine_remaining)
582 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
583 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
595 menuMouseMode = cvar("menu_mouse_absolute");
601 UpdateConWidthHeight();
605 // TODO draw an info image about this situation
609 if(!menuNotTheFirstFrame)
611 menuNotTheFirstFrame = 1;
613 if(!cvar("menu_video_played"))
615 localcmd("set menu_video_played 1; cd loop $menu_cdtrack; play sound/announcer/default/welcome.ogg\n");
616 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading
621 realFrametime = frametime = min(0.2, t - menuPrevTime);
625 t = cvar("menu_slowmo");
636 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
637 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
642 if(cvar("cl_capturevideo"))
643 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
647 gamestatus = gamestatus | GAME_ISSERVER;
648 if(clientstate() == CS_CONNECTED)
649 gamestatus = gamestatus | GAME_CONNECTED;
650 if(cvar("developer"))
651 gamestatus = gamestatus | GAME_DEVELOPER;
653 prevMenuAlpha = menuAlpha;
656 if(menuAlpha == 0 && menuLogoAlpha < 2)
658 menuLogoAlpha = menuLogoAlpha + frametime * 2;
662 menuAlpha = min(1, menuAlpha + frametime * 5);
668 menuAlpha = max(0, menuAlpha - frametime * 5);
672 draw_reset_cropped();
674 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
676 if(menuLogoAlpha > 0)
679 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
680 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
681 draw_reset_cropped();
682 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
684 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
685 draw_drawMousePointer(menuMousePos);
690 else if(SKINALPHA_BACKGROUND_INGAME)
695 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
696 draw_reset_cropped();
700 if(menuAlpha != prevMenuAlpha)
701 cvar_set("_menu_alpha", ftos(menuAlpha));
703 draw_reset_cropped();
705 draw_reset_cropped();
709 if(prevMenuAlpha > 0)
710 main.initializeDialog(main, main.firstChild);
711 draw_reset_cropped();
716 draw_alpha *= menuAlpha;
721 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
722 if(newMouse != '0 0 0')
723 if(newMouse != menuMousePos)
725 menuMousePos = newMouse;
726 if(mouseButtonsPressed)
727 main.mouseDrag(main, menuMousePos);
729 main.mouseMove(main, menuMousePos);
736 vector dMouse, minpos, maxpos;
737 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
738 if(dMouse != '0 0 0')
740 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
741 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
742 dMouse = globalToBoxSize(dMouse, draw_scale);
743 menuMousePos += dMouse * cvar("menu_mouse_speed");
744 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
745 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
746 if(mouseButtonsPressed)
747 main.mouseDrag(main, menuMousePos);
749 main.mouseMove(main, menuMousePos);
757 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
759 draw_drawMousePointer(menuMousePos);
761 draw_reset_cropped();
770 setkeydest(KEY_MENU);
771 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
776 if(mouseButtonsPressed)
777 main.mouseRelease(main, menuMousePos);
778 mouseButtonsPressed = 0;
780 main.focusEnter(main);
781 main.showNotify(main);
787 setkeydest(KEY_GAME);
788 setmousetarget(MT_CLIENT);
793 main.focusLeave(main);
794 main.hideNotify(main);
810 for(e = NULL; (e = nextent(e)) != NULL; )
812 if(e.classname != "vtbl")
818 void m_focus_item_chain(entity outermost, entity innermost)
820 if(innermost.parent != outermost)
821 m_focus_item_chain(outermost, innermost.parent);
822 innermost.parent.setFocus(innermost.parent, innermost);
825 void m_activate_window(entity wnd)
830 m_activate_window(par);
832 if(par.instanceOfModalController)
834 if(wnd.tabSelectingButton)
836 TabButton_Click(wnd.tabSelectingButton, wnd);
839 par.initializeDialog(par, wnd);
841 else if(par.instanceOfNexposee)
843 // nexposee (sorry for violating abstraction here)
844 par.selectedChild = wnd;
845 par.animationState = 1;
846 Container_setFocus(par, NULL);
848 else if(par.instanceOfContainer)
852 par.setFocus(par, wnd);
856 void m_setpointerfocus(entity wnd)
858 if(wnd.instanceOfContainer)
860 entity focus = wnd.preferredFocusedGrandChild(wnd);
863 menuMousePos = focus.origin + 0.5 * focus.size;
864 menuMousePos_x *= 1 / conwidth;
865 menuMousePos_y *= 1 / conheight;
866 if(wnd.focused) // why does this never happen?
867 m_focus_item_chain(wnd, focus);
872 void(string itemname) m_goto =
877 if(itemname == "") // this can be called by GameCommand
879 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
883 m_activate_window(main.mainNexposee);
889 e = findstring(NULL, name, itemname);
893 m_activate_window(e);
894 m_setpointerfocus(e);
900 void() m_goto_skin_selector =
904 // TODO add code to switch back to the skin selector (no idea how to do it now)
905 m_goto("skinselector");
908 void() m_goto_video_settings =
912 // TODO add code to switch back to the skin selector (no idea how to do it now)
913 m_goto("videosettings");