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: ^1%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);
134 error("cannot load any menu skin\n");
136 draw_currentSkin = strzone(draw_currentSkin);
137 while((s = fgets(fh)))
139 // these two are handled by skinlist.qc
140 if(substring(s, 0, 6) == "title ")
142 if(substring(s, 0, 7) == "author ")
144 n = tokenize_console(s);
146 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
150 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
153 n = search_getsize(glob);
154 for(i = 0; i < n; ++i)
155 precache_pic(search_getfilename(glob, i));
159 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
162 anim = spawnAnimHost();
163 main = spawnMainWindow(); main.configureMainWindow(main);
166 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
169 menuMousePos = '0.5 0.5 0';
172 m_display(); // delayed menu display
175 void(float key, float ascii) m_keyup =
181 draw_reset_cropped();
182 main.keyUp(main, key, ascii, menuShiftState);
183 if(key >= K_MOUSE1 && key <= K_MOUSE3)
185 --mouseButtonsPressed;
186 if(!mouseButtonsPressed)
187 main.mouseRelease(main, menuMousePos);
188 if(mouseButtonsPressed < 0)
190 mouseButtonsPressed = 0;
191 dprint("Warning: released an already released button\n");
194 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
195 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
196 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
199 void(float key, float ascii) m_keydown =
210 e.keyGrabbed(e, key, ascii);
214 draw_reset_cropped();
215 if(key >= K_MOUSE1 && key <= K_MOUSE3)
216 if(!mouseButtonsPressed)
217 main.mousePress(main, menuMousePos);
218 if(!main.keyDown(main, key, ascii, menuShiftState))
220 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
221 m_hide(); // disable menu on unhandled ESC
223 if(key >= K_MOUSE1 && key <= K_MOUSE3)
225 ++mouseButtonsPressed;
226 if(mouseButtonsPressed > 10)
228 mouseButtonsPressed = 10;
229 dprint("Warning: pressed an already pressed button\n");
232 if(key == K_ALT) menuShiftState |= S_ALT;
233 if(key == K_CTRL) menuShiftState |= S_CTRL;
234 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
237 float SCALEMODE_CROP = 0;
238 float SCALEMODE_LETTERBOX = 1;
239 float SCALEMODE_WIDTH = 2;
240 float SCALEMODE_HEIGHT = 3;
241 float SCALEMODE_STRETCH = 4;
242 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
244 vector sz, org, isz, isz_w, isz_h;
245 float width_is_larger;
247 sz = draw_PictureSize(img);
248 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
249 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
250 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
256 isz = (width_is_larger ? isz_h : isz_w);
258 case SCALEMODE_LETTERBOX:
259 isz = (width_is_larger ? isz_w : isz_h);
261 case SCALEMODE_WIDTH:
264 case SCALEMODE_HEIGHT:
267 case SCALEMODE_STRETCH:
272 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
273 draw_Picture(org, img, isz, '1 1 1', a);
276 void(string img, float a, string algn, float force1) drawBackground =
278 if(main.mainNexposee.ModalController_state == 0)
288 scalemode = SCALEMODE_CROP;
290 for(i = 0; i < strlen(algn); ++i)
292 c = substring(algn, i, 1);
295 case "c": scalemode = SCALEMODE_CROP; goto nopic;
296 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
297 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
298 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
299 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
300 case "1": case "4": case "7": v_x = 0.0; break;
301 case "2": case "5": case "8": v_x = 0.5; break;
302 case "3": case "6": case "9": v_x = 1.0; break;
303 default: v_x = random(); break;
307 case "7": case "8": case "9": v_y = 0.0; break;
308 case "4": case "5": case "6": v_y = 0.5; break;
309 case "1": case "2": case "3": v_y = 1.0; break;
310 default: v_y = random(); break;
313 draw_Picture_Aligned(v, scalemode, img, a);
315 // force all secondary layers to use alpha 1. Prevents ugly issues
316 // with overlap. It's a flag because it cannot be used for the
318 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
320 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
326 vector menuTooltipAveragedMousePos;
327 entity menuTooltipItem;
328 vector menuTooltipOrigin;
329 vector menuTooltipSize;
330 float menuTooltipAlpha;
331 float menuTooltipState; // 0: no tooltip, 1: fading in, 2: displaying, 3: fading out
332 float m_testmousetooltipbox(vector pos)
334 if(pos_x >= menuTooltipOrigin_x && pos_x < menuTooltipOrigin_x + menuTooltipSize_x)
335 if(pos_y >= menuTooltipOrigin_y && pos_y < menuTooltipOrigin_y + menuTooltipSize_y)
339 float m_testtooltipbox(vector tooltippos)
345 if(tooltippos_x + menuTooltipSize_x > 1)
347 if(tooltippos_y + menuTooltipSize_y > 1)
349 menuTooltipOrigin = tooltippos;
352 float m_allocatetooltipbox(vector pos)
354 vector avoidplus, avoidminus;
357 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth;
358 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight;
361 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth + menuTooltipSize_x;
362 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight + menuTooltipSize_y;
367 if(m_testtooltipbox(v))
371 v_x = pos_x - menuTooltipSize_x * 0.5;
372 if(m_testtooltipbox(v))
376 v_x = pos_x - avoidminus_x;
377 if(m_testtooltipbox(v))
381 v_y = pos_y - avoidminus_y;
382 if(m_testtooltipbox(v))
386 v_x = pos_x - menuTooltipSize_x * 0.5;
387 if(m_testtooltipbox(v))
391 v_x = pos_x + avoidplus_x;
392 if(m_testtooltipbox(v))
397 entity m_findtooltipitem(entity root, vector pos)
405 while(it.instanceOfContainer)
407 while(it.instanceOfNexposee && it.focusedChild)
409 it = it.focusedChild;
410 pos = globalToBox(pos, it.Container_origin, it.Container_size);
412 if(it.instanceOfNexposee)
414 it = it.itemFromPoint(it, pos);
419 else if(it.instanceOfModalController)
420 it = it.focusedChild;
422 it = it.itemFromPoint(it, pos);
427 pos = globalToBox(pos, it.Container_origin, it.Container_size);
432 void m_tooltip(vector pos)
439 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
441 f = bound(0, frametime * 2, 1);
442 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + pos * f;
443 f = vlen(pos - menuTooltipAveragedMousePos);
446 it = m_findtooltipitem(main, pos);
450 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
451 if(it != menuTooltipItem)
453 switch(menuTooltipState)
458 // another item: fade out first
459 menuTooltipState = 2;
464 menuTooltipState = 1;
465 menuTooltipItem = it;
467 menuTooltipOrigin_x = -1; // unallocated
470 getWrappedLine_remaining = it.tooltip;
471 while(getWrappedLine_remaining)
473 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
475 f = draw_TextWidth(s, FALSE, fontsize);
479 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
480 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
481 menuTooltipSize_z = 0;
485 // changing item while fading in: fade out first
486 menuTooltipState = 2;
489 // changing item while fading out: can't
493 else if(menuTooltipState == 2) // re-fade in?
494 menuTooltipState = 1;
497 if(!m_testmousetooltipbox(pos))
498 menuTooltipState = 2; // fade out if mouse touches it
500 switch(menuTooltipState)
503 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
504 if(menuTooltipAlpha == 1)
505 menuTooltipState = 0;
508 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
509 if(menuTooltipAlpha == 0)
511 menuTooltipState = 0;
512 menuTooltipItem = world;
519 if(menuTooltipOrigin_x < 0) // unallocated?
520 m_allocatetooltipbox(pos);
522 if(menuTooltipOrigin_x >= 0)
525 p = SKINBORDER_TOOLTIP;
527 p_y *= 1 / conheight;
528 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
529 p = menuTooltipOrigin;
530 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
531 p_y += SKINMARGIN_TOOLTIP_y / conheight;
532 getWrappedLine_remaining = menuTooltipItem.tooltip;
533 while(getWrappedLine_remaining)
535 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
536 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
548 menuMouseMode = cvar("menu_mouse_absolute");
554 UpdateConWidthHeight();
558 // TODO draw an info image about this situation
562 if(!menuNotTheFirstFrame)
564 menuNotTheFirstFrame = 1;
566 if(!cvar("menu_video_played"))
568 localcmd("cd loop $menu_cdtrack; play sound/announcer/default/welcome.ogg\n");
569 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading FIXME
571 // ALWAYS set this cvar; if we start but menu is not active, this means we want no background music!
572 localcmd("set menu_video_played 1\n");
576 realFrametime = frametime = min(0.2, t - menuPrevTime);
580 t = cvar("menu_slowmo");
591 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
592 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
597 if(cvar("cl_capturevideo"))
598 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
602 gamestatus = gamestatus | GAME_ISSERVER;
603 if(clientstate() == CS_CONNECTED)
604 gamestatus = gamestatus | GAME_CONNECTED;
605 if(cvar("developer"))
606 gamestatus = gamestatus | GAME_DEVELOPER;
608 prevMenuAlpha = menuAlpha;
611 if(menuAlpha == 0 && menuLogoAlpha < 2)
613 menuLogoAlpha = menuLogoAlpha + frametime * 2;
617 menuAlpha = min(1, menuAlpha + frametime * 5);
623 menuAlpha = max(0, menuAlpha - frametime * 5);
627 draw_reset_cropped();
629 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
631 if(menuLogoAlpha > 0)
634 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
635 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
636 draw_reset_cropped();
637 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
639 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
640 draw_drawMousePointer(menuMousePos);
645 else if(SKINALPHA_BACKGROUND_INGAME)
650 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
651 draw_reset_cropped();
655 if(menuAlpha != prevMenuAlpha)
656 cvar_set("_menu_alpha", ftos(menuAlpha));
658 draw_reset_cropped();
660 draw_reset_cropped();
664 if(prevMenuAlpha > 0)
665 main.initializeDialog(main, main.firstChild);
666 draw_reset_cropped();
671 draw_alpha *= menuAlpha;
676 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
677 if(newMouse != '0 0 0')
678 if(newMouse != menuMousePos)
680 menuMousePos = newMouse;
681 if(mouseButtonsPressed)
682 main.mouseDrag(main, menuMousePos);
684 main.mouseMove(main, menuMousePos);
691 vector dMouse, minpos, maxpos;
692 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
693 if(dMouse != '0 0 0')
695 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
696 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
697 dMouse = globalToBoxSize(dMouse, draw_scale);
698 menuMousePos += dMouse * cvar("menu_mouse_speed");
699 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
700 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
701 if(mouseButtonsPressed)
702 main.mouseDrag(main, menuMousePos);
704 main.mouseMove(main, menuMousePos);
710 m_tooltip(menuMousePos);
712 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
714 draw_drawMousePointer(menuMousePos);
716 draw_reset_cropped();
725 setkeydest(KEY_MENU);
726 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
731 if(mouseButtonsPressed)
732 main.mouseRelease(main, menuMousePos);
733 mouseButtonsPressed = 0;
735 main.focusEnter(main);
736 main.showNotify(main);
742 setkeydest(KEY_GAME);
743 setmousetarget(MT_CLIENT);
748 main.focusLeave(main);
749 main.hideNotify(main);
765 for(e = NULL; (e = nextent(e)) != NULL; )
767 if(e.classname != "vtbl")
773 void m_focus_item_chain(entity outermost, entity innermost)
775 if(innermost.parent != outermost)
776 m_focus_item_chain(outermost, innermost.parent);
777 innermost.parent.setFocus(innermost.parent, innermost);
780 void m_activate_window(entity wnd)
785 m_activate_window(par);
787 if(par.instanceOfModalController)
789 if(wnd.tabSelectingButton)
791 TabButton_Click(wnd.tabSelectingButton, wnd);
794 par.initializeDialog(par, wnd);
796 else if(par.instanceOfNexposee)
798 // nexposee (sorry for violating abstraction here)
799 par.selectedChild = wnd;
800 par.animationState = 1;
801 Container_setFocus(par, NULL);
803 else if(par.instanceOfContainer)
807 par.setFocus(par, wnd);
811 void m_setpointerfocus(entity wnd)
813 if(wnd.instanceOfContainer)
815 entity focus = wnd.preferredFocusedGrandChild(wnd);
818 menuMousePos = focus.origin + 0.5 * focus.size;
819 menuMousePos_x *= 1 / conwidth;
820 menuMousePos_y *= 1 / conheight;
821 if(wnd.focused) // why does this never happen?
822 m_focus_item_chain(wnd, focus);
827 void(string itemname) m_goto =
832 if(itemname == "") // this can be called by GameCommand
834 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
838 m_activate_window(main.mainNexposee);
844 for(e = NULL; (e = findstring(e, name, itemname)); )
845 if(e.classname != "vtbl")
850 m_activate_window(e);
851 m_setpointerfocus(e);
857 void() m_goto_skin_selector =
861 // TODO add code to switch back to the skin selector (no idea how to do it now)
862 m_goto("skinselector");
865 void() m_goto_language_selector =
869 // TODO add code to switch back to the language selector (no idea how to do it now)
870 m_goto("languageselector");
873 void() m_goto_video_settings =
877 // TODO add code to switch back to the video settings (no idea how to do it now)
878 m_goto("videosettings");