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 cvar_set("menu_skin", cvar_defstring("menu_skin"));
125 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
126 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
130 draw_currentSkin = "gfx/menu/default";
131 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
135 error("cannot load any menu skin\n");
137 draw_currentSkin = strzone(draw_currentSkin);
138 while((s = fgets(fh)))
140 // these two are handled by skinlist.qc
141 if(substring(s, 0, 6) == "title ")
143 if(substring(s, 0, 7) == "author ")
145 n = tokenize_console(s);
147 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
151 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
154 n = search_getsize(glob);
155 for(i = 0; i < n; ++i)
156 precache_pic(search_getfilename(glob, i));
160 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
163 anim = spawnAnimHost();
164 main = spawnMainWindow(); main.configureMainWindow(main);
167 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
170 menuMousePos = '0.5 0.5 0';
173 m_display(); // delayed menu display
176 void(float key, float ascii) m_keyup =
182 draw_reset_cropped();
183 main.keyUp(main, key, ascii, menuShiftState);
184 if(key >= K_MOUSE1 && key <= K_MOUSE3)
186 --mouseButtonsPressed;
187 if(!mouseButtonsPressed)
188 main.mouseRelease(main, menuMousePos);
189 if(mouseButtonsPressed < 0)
191 mouseButtonsPressed = 0;
192 dprint("Warning: released an already released button\n");
195 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
196 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
197 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
200 void(float key, float ascii) m_keydown =
211 e.keyGrabbed(e, key, ascii);
215 draw_reset_cropped();
216 if(key >= K_MOUSE1 && key <= K_MOUSE3)
217 if(!mouseButtonsPressed)
218 main.mousePress(main, menuMousePos);
219 if(!main.keyDown(main, key, ascii, menuShiftState))
221 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
222 m_hide(); // disable menu on unhandled ESC
224 if(key >= K_MOUSE1 && key <= K_MOUSE3)
226 ++mouseButtonsPressed;
227 if(mouseButtonsPressed > 10)
229 mouseButtonsPressed = 10;
230 dprint("Warning: pressed an already pressed button\n");
233 if(key == K_ALT) menuShiftState |= S_ALT;
234 if(key == K_CTRL) menuShiftState |= S_CTRL;
235 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
238 float SCALEMODE_CROP = 0;
239 float SCALEMODE_LETTERBOX = 1;
240 float SCALEMODE_WIDTH = 2;
241 float SCALEMODE_HEIGHT = 3;
242 float SCALEMODE_STRETCH = 4;
243 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
245 vector sz, org, isz, isz_w, isz_h;
246 float width_is_larger;
248 sz = draw_PictureSize(img);
249 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
250 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
251 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
257 isz = (width_is_larger ? isz_h : isz_w);
259 case SCALEMODE_LETTERBOX:
260 isz = (width_is_larger ? isz_w : isz_h);
262 case SCALEMODE_WIDTH:
265 case SCALEMODE_HEIGHT:
268 case SCALEMODE_STRETCH:
273 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
274 draw_Picture(org, img, isz, '1 1 1', a);
277 void(string img, float a, string algn, float force1) drawBackground =
279 if(main.mainNexposee.ModalController_state == 0)
289 scalemode = SCALEMODE_CROP;
291 for(i = 0; i < strlen(algn); ++i)
293 c = substring(algn, i, 1);
296 case "c": scalemode = SCALEMODE_CROP; goto nopic;
297 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
298 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
299 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
300 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
301 case "1": case "4": case "7": v_x = 0.0; break;
302 case "2": case "5": case "8": v_x = 0.5; break;
303 case "3": case "6": case "9": v_x = 1.0; break;
304 default: v_x = random(); break;
308 case "7": case "8": case "9": v_y = 0.0; break;
309 case "4": case "5": case "6": v_y = 0.5; break;
310 case "1": case "2": case "3": v_y = 1.0; break;
311 default: v_y = random(); break;
314 draw_Picture_Aligned(v, scalemode, img, a);
316 // force all secondary layers to use alpha 1. Prevents ugly issues
317 // with overlap. It's a flag because it cannot be used for the
319 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
321 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
327 vector menuTooltipAveragedMousePos;
328 entity menuTooltipItem;
329 vector menuTooltipOrigin;
330 vector menuTooltipSize;
331 float menuTooltipAlpha;
332 float menuTooltipState; // 0: no tooltip, 1: fading in, 2: displaying, 3: fading out
333 float m_testmousetooltipbox(vector pos)
335 if(pos_x >= menuTooltipOrigin_x && pos_x < menuTooltipOrigin_x + menuTooltipSize_x)
336 if(pos_y >= menuTooltipOrigin_y && pos_y < menuTooltipOrigin_y + menuTooltipSize_y)
340 float m_testtooltipbox(vector tooltippos)
346 if(tooltippos_x + menuTooltipSize_x > 1)
348 if(tooltippos_y + menuTooltipSize_y > 1)
350 menuTooltipOrigin = tooltippos;
353 float m_allocatetooltipbox(vector pos)
355 vector avoidplus, avoidminus;
358 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth;
359 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight;
362 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth + menuTooltipSize_x;
363 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight + menuTooltipSize_y;
368 if(m_testtooltipbox(v))
372 v_x = pos_x - menuTooltipSize_x * 0.5;
373 if(m_testtooltipbox(v))
377 v_x = pos_x - avoidminus_x;
378 if(m_testtooltipbox(v))
382 v_y = pos_y - avoidminus_y;
383 if(m_testtooltipbox(v))
387 v_x = pos_x - menuTooltipSize_x * 0.5;
388 if(m_testtooltipbox(v))
392 v_x = pos_x + avoidplus_x;
393 if(m_testtooltipbox(v))
398 entity m_findtooltipitem(entity root, vector pos)
406 while(it.instanceOfContainer)
408 while(it.instanceOfNexposee && it.focusedChild)
410 it = it.focusedChild;
411 pos = globalToBox(pos, it.Container_origin, it.Container_size);
413 if(it.instanceOfNexposee)
415 it = it.itemFromPoint(it, pos);
420 else if(it.instanceOfModalController)
421 it = it.focusedChild;
423 it = it.itemFromPoint(it, pos);
428 pos = globalToBox(pos, it.Container_origin, it.Container_size);
433 void m_tooltip(vector pos)
440 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
442 f = bound(0, frametime * 2, 1);
443 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + pos * f;
444 f = vlen(pos - menuTooltipAveragedMousePos);
447 it = m_findtooltipitem(main, pos);
451 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
452 if(it != menuTooltipItem)
454 switch(menuTooltipState)
459 // another item: fade out first
460 menuTooltipState = 2;
465 menuTooltipState = 1;
466 menuTooltipItem = it;
468 menuTooltipOrigin_x = -1; // unallocated
471 getWrappedLine_remaining = it.tooltip;
472 while(getWrappedLine_remaining)
474 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
476 f = draw_TextWidth(s, FALSE, fontsize);
480 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
481 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
482 menuTooltipSize_z = 0;
486 // changing item while fading in: fade out first
487 menuTooltipState = 2;
490 // changing item while fading out: can't
494 else if(menuTooltipState == 2) // re-fade in?
495 menuTooltipState = 1;
498 if(!m_testmousetooltipbox(pos))
499 menuTooltipState = 2; // fade out if mouse touches it
501 switch(menuTooltipState)
504 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
505 if(menuTooltipAlpha == 1)
506 menuTooltipState = 0;
509 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
510 if(menuTooltipAlpha == 0)
512 menuTooltipState = 0;
513 menuTooltipItem = world;
520 if(menuTooltipOrigin_x < 0) // unallocated?
521 m_allocatetooltipbox(pos);
523 if(menuTooltipOrigin_x >= 0)
526 p = SKINBORDER_TOOLTIP;
528 p_y *= 1 / conheight;
529 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
530 p = menuTooltipOrigin;
531 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
532 p_y += SKINMARGIN_TOOLTIP_y / conheight;
533 getWrappedLine_remaining = menuTooltipItem.tooltip;
534 while(getWrappedLine_remaining)
536 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
537 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
549 menuMouseMode = cvar("menu_mouse_absolute");
555 UpdateConWidthHeight();
559 // TODO draw an info image about this situation
563 if(!menuNotTheFirstFrame)
565 menuNotTheFirstFrame = 1;
567 if(!cvar("menu_video_played"))
569 localcmd("cd loop $menu_cdtrack; play sound/announcer/default/welcome.ogg\n");
570 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading FIXME
572 // ALWAYS set this cvar; if we start but menu is not active, this means we want no background music!
573 localcmd("set menu_video_played 1\n");
577 realFrametime = frametime = min(0.2, t - menuPrevTime);
581 t = cvar("menu_slowmo");
592 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
593 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
598 if(cvar("cl_capturevideo"))
599 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
603 gamestatus = gamestatus | GAME_ISSERVER;
604 if(clientstate() == CS_CONNECTED)
605 gamestatus = gamestatus | GAME_CONNECTED;
606 if(cvar("developer"))
607 gamestatus = gamestatus | GAME_DEVELOPER;
609 prevMenuAlpha = menuAlpha;
612 if(menuAlpha == 0 && menuLogoAlpha < 2)
614 menuLogoAlpha = menuLogoAlpha + frametime * 2;
618 menuAlpha = min(1, menuAlpha + frametime * 5);
624 menuAlpha = max(0, menuAlpha - frametime * 5);
628 draw_reset_cropped();
630 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
632 if(menuLogoAlpha > 0)
635 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
636 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
637 draw_reset_cropped();
638 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
640 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
641 draw_drawMousePointer(menuMousePos);
646 else if(SKINALPHA_BACKGROUND_INGAME)
651 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
652 draw_reset_cropped();
656 if(menuAlpha != prevMenuAlpha)
657 cvar_set("_menu_alpha", ftos(menuAlpha));
659 draw_reset_cropped();
661 draw_reset_cropped();
665 if(prevMenuAlpha > 0)
666 main.initializeDialog(main, main.firstChild);
667 draw_reset_cropped();
672 draw_alpha *= menuAlpha;
677 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
678 if(newMouse != '0 0 0')
679 if(newMouse != menuMousePos)
681 menuMousePos = newMouse;
682 if(mouseButtonsPressed)
683 main.mouseDrag(main, menuMousePos);
685 main.mouseMove(main, menuMousePos);
692 vector dMouse, minpos, maxpos;
693 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
694 if(dMouse != '0 0 0')
696 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
697 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
698 dMouse = globalToBoxSize(dMouse, draw_scale);
699 menuMousePos += dMouse * cvar("menu_mouse_speed");
700 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
701 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
702 if(mouseButtonsPressed)
703 main.mouseDrag(main, menuMousePos);
705 main.mouseMove(main, menuMousePos);
711 m_tooltip(menuMousePos);
713 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
715 draw_drawMousePointer(menuMousePos);
717 draw_reset_cropped();
726 setkeydest(KEY_MENU);
727 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
732 if(mouseButtonsPressed)
733 main.mouseRelease(main, menuMousePos);
734 mouseButtonsPressed = 0;
736 main.focusEnter(main);
737 main.showNotify(main);
743 setkeydest(KEY_GAME);
744 setmousetarget(MT_CLIENT);
749 main.focusLeave(main);
750 main.hideNotify(main);
766 for(e = NULL; (e = nextent(e)) != NULL; )
768 if(e.classname != "vtbl")
774 void m_focus_item_chain(entity outermost, entity innermost)
776 if(innermost.parent != outermost)
777 m_focus_item_chain(outermost, innermost.parent);
778 innermost.parent.setFocus(innermost.parent, innermost);
781 void m_activate_window(entity wnd)
786 m_activate_window(par);
788 if(par.instanceOfModalController)
790 if(wnd.tabSelectingButton)
792 TabButton_Click(wnd.tabSelectingButton, wnd);
795 par.initializeDialog(par, wnd);
797 else if(par.instanceOfNexposee)
799 // nexposee (sorry for violating abstraction here)
800 par.selectedChild = wnd;
801 par.animationState = 1;
802 Container_setFocus(par, NULL);
804 else if(par.instanceOfContainer)
808 par.setFocus(par, wnd);
812 void m_setpointerfocus(entity wnd)
814 if(wnd.instanceOfContainer)
816 entity focus = wnd.preferredFocusedGrandChild(wnd);
819 menuMousePos = focus.origin + 0.5 * focus.size;
820 menuMousePos_x *= 1 / conwidth;
821 menuMousePos_y *= 1 / conheight;
822 if(wnd.focused) // why does this never happen?
823 m_focus_item_chain(wnd, focus);
828 void(string itemname) m_goto =
833 if(itemname == "") // this can be called by GameCommand
835 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
839 m_activate_window(main.mainNexposee);
845 for(e = NULL; (e = findstring(e, name, itemname)); )
846 if(e.classname != "vtbl")
851 m_activate_window(e);
852 m_setpointerfocus(e);
858 void() m_goto_skin_selector =
862 // TODO add code to switch back to the skin selector (no idea how to do it now)
863 m_goto("skinselector");
866 void() m_goto_language_selector =
870 // TODO add code to switch back to the language selector (no idea how to do it now)
871 m_goto("languageselector");
874 void() m_goto_video_settings =
878 // TODO add code to switch back to the video settings (no idea how to do it now)
879 m_goto("videosettings");