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;
33 gamestatus = gamestatus | GAME_ISSERVER;
34 if(clientstate() == CS_CONNECTED || isdemo())
35 gamestatus = gamestatus | GAME_CONNECTED;
37 gamestatus = gamestatus | GAME_DEVELOPER;
43 cvar_set("_menu_alpha", "0");
44 prvm_language = cvar_string("prvm_language");
45 if(prvm_language == "")
48 cvar_set("prvm_language", prvm_language);
49 localcmd("\nmenu_restart\n");
52 prvm_language = strzone(prvm_language);
53 cvar_set("_menu_prvm_language", prvm_language);
55 check_unacceptable_compiler_bugs();
58 print(sprintf(_("^4MQC Build information: ^1%s\n"), WATERMARK()));
61 // list all game dirs (TEST)
68 s = getgamedirinfo(i, GETGAMEDIRINFO_NAME);
71 dprint(s, ": ", getgamedirinfo(i, GETGAMEDIRINFO_DESCRIPTION));
75 // needs to be done so early because of the constants they create
79 float ddsload = cvar("r_texture_dds_load");
80 float texcomp = cvar("gl_texturecompression");
82 if(ddsload != cvar("r_texture_dds_load") || texcomp != cvar("gl_texturecompression"))
83 localcmd("\nr_restart\n");
88 if(cvar("_menu_initialized")) // always show menu after menu_restart
92 cvar_set("_menu_initialized", "1");
96 float MENU_ASPECT = 1.25; // 1280x1024
97 float MENU_MINHEIGHT = 600;
98 float conwidth_s, conheight_s, realconwidth, realconheight, screenconwidth, screenconheight;
99 void draw_reset_cropped()
101 draw_reset(screenconwidth, screenconheight, 0.5 * (realconwidth - screenconwidth), 0.5 * (realconheight - screenconheight));
103 void draw_reset_full()
105 draw_reset(realconwidth, realconheight, 0, 0);
107 void UpdateConWidthHeight()
109 conwidth_s = conwidth;
110 conheight_s = conheight;
111 realconwidth = cvar("vid_conwidth");
112 realconheight = cvar("vid_conheight");
113 if(realconwidth / realconheight > MENU_ASPECT)
116 conwidth = realconheight * MENU_ASPECT;
117 conheight = realconheight;
122 conwidth = realconwidth;
123 conheight = realconwidth / MENU_ASPECT;
125 screenconwidth = conwidth;
126 screenconheight = conheight;
127 if(conwidth < MENU_MINHEIGHT * MENU_ASPECT)
129 conheight *= MENU_MINHEIGHT * MENU_ASPECT / conwidth;
130 conwidth = MENU_MINHEIGHT * MENU_ASPECT;
132 if(conheight < MENU_MINHEIGHT)
134 conwidth *= MENU_MINHEIGHT / conheight;
135 conheight = MENU_MINHEIGHT;
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 string m_goto_buffer;
148 void m_init_delayed()
150 float fh, glob, n, i;
153 conwidth = conheight = -1;
154 UpdateConWidthHeight();
155 draw_reset_cropped();
163 if(cvar_string("menu_skin") != "")
165 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
166 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
169 if(cvar_defstring("menu_skin") != "")
171 cvar_set("menu_skin", cvar_defstring("menu_skin"));
172 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
173 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
177 draw_currentSkin = "gfx/menu/default";
178 fh = fopen(language_filename(strcat(draw_currentSkin, "/skinvalues.txt")), FILE_READ);
182 error("cannot load any menu skin\n");
184 draw_currentSkin = strzone(draw_currentSkin);
185 while((s = fgets(fh)))
187 // these two are handled by skinlist.qc
188 if(substring(s, 0, 6) == "title ")
190 if(substring(s, 0, 7) == "author ")
192 n = tokenize_console(s);
194 Skin_ApplySetting(argv(0), substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
198 glob = search_begin(strcat(draw_currentSkin, "/*.tga"), TRUE, TRUE);
201 n = search_getsize(glob);
202 for(i = 0; i < n; ++i)
203 precache_pic(search_getfilename(glob, i));
207 draw_setMousePointer(SKINGFX_CURSOR, SKINSIZE_CURSOR, SKINOFFSET_CURSOR);
210 anim = spawnAnimHost();
211 main = spawnMainWindow(); main.configureMainWindow(main);
214 main.resizeNotify(main, '0 0 0', eX * conwidth + eY * conheight, '0 0 0', eX * conwidth + eY * conheight);
217 menuMousePos = '0.5 0.5 0';
223 m_goto(m_goto_buffer);
224 strunzone(m_goto_buffer);
225 m_goto_buffer = string_null;
229 m_display(); // delayed menu display
232 void m_keyup (float key, float ascii)
238 draw_reset_cropped();
239 main.keyUp(main, key, ascii, menuShiftState);
240 if(key >= K_MOUSE1 && key <= K_MOUSE3)
242 --mouseButtonsPressed;
243 if(!mouseButtonsPressed)
244 main.mouseRelease(main, menuMousePos);
245 if(mouseButtonsPressed < 0)
247 mouseButtonsPressed = 0;
248 dprint("Warning: released an already released button\n");
251 if(key == K_ALT) menuShiftState -= (menuShiftState & S_ALT);
252 if(key == K_CTRL) menuShiftState -= (menuShiftState & S_CTRL);
253 if(key == K_SHIFT) menuShiftState -= (menuShiftState & S_SHIFT);
256 void m_keydown(float key, float ascii)
267 e.keyGrabbed(e, key, ascii);
271 draw_reset_cropped();
272 if(key >= K_MOUSE1 && key <= K_MOUSE3)
273 if(!mouseButtonsPressed)
274 main.mousePress(main, menuMousePos);
275 if(!main.keyDown(main, key, ascii, menuShiftState))
277 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED)) // don't back out to console only
278 m_hide(); // disable menu on unhandled ESC
280 if(key >= K_MOUSE1 && key <= K_MOUSE3)
282 ++mouseButtonsPressed;
283 if(mouseButtonsPressed > 10)
285 mouseButtonsPressed = 10;
286 dprint("Warning: pressed an already pressed button\n");
289 if(key == K_ALT) menuShiftState |= S_ALT;
290 if(key == K_CTRL) menuShiftState |= S_CTRL;
291 if(key == K_SHIFT) menuShiftState |= S_SHIFT;
294 float SCALEMODE_CROP = 0;
295 float SCALEMODE_LETTERBOX = 1;
296 float SCALEMODE_WIDTH = 2;
297 float SCALEMODE_HEIGHT = 3;
298 float SCALEMODE_STRETCH = 4;
299 void draw_Picture_Aligned(vector algn, float scalemode, string img, float a)
301 vector sz, org, isz, isz_w, isz_h;
302 float width_is_larger;
304 sz = draw_PictureSize(img);
305 width_is_larger = (sz_x * draw_scale_y >= sz_y * draw_scale_x);
306 isz_w = '1 0 0' + '0 1 0' * ((sz_y / sz_x) * (draw_scale_x / draw_scale_y));
307 isz_h = '0 1 0' + '1 0 0' * ((sz_x / sz_y) * (draw_scale_y / draw_scale_x));
313 isz = (width_is_larger ? isz_h : isz_w);
315 case SCALEMODE_LETTERBOX:
316 isz = (width_is_larger ? isz_w : isz_h);
318 case SCALEMODE_WIDTH:
321 case SCALEMODE_HEIGHT:
324 case SCALEMODE_STRETCH:
329 org = eX * (algn_x * (1 - isz_x)) + eY * (algn_y * (1 - isz_y));
330 draw_Picture(org, img, isz, '1 1 1', a);
333 void drawBackground(string img, float a, string algn, float force1)
335 if(main.mainNexposee.ModalController_state == 0)
345 scalemode = SCALEMODE_CROP;
348 for(i = 0; i < strlen(algn); ++i)
350 c = substring(algn, i, 1);
353 case "c": scalemode = SCALEMODE_CROP; goto nopic;
354 case "l": scalemode = SCALEMODE_LETTERBOX; goto nopic;
355 case "h": scalemode = SCALEMODE_HEIGHT; goto nopic;
356 case "w": scalemode = SCALEMODE_WIDTH; goto nopic;
357 case "s": scalemode = SCALEMODE_STRETCH; goto nopic;
358 case "1": case "4": case "7": v_x = 0.0; break;
359 case "2": case "5": case "8": v_x = 0.5; break;
360 case "3": case "6": case "9": v_x = 1.0; break;
361 default: v_x = random(); break;
365 case "7": case "8": case "9": v_y = 0.0; break;
366 case "4": case "5": case "6": v_y = 0.5; break;
367 case "1": case "2": case "3": v_y = 1.0; break;
368 default: v_y = random(); break;
371 draw_Picture_Aligned(v, scalemode, img, a);
373 // force all secondary layers to use alpha 1. Prevents ugly issues
374 // with overlap. It's a flag because it cannot be used for the
376 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), 1);
378 draw_Picture_Aligned(v, scalemode, strcat(img, "_l", ftos(l+1)), a);
385 float menu_tooltips_old;
386 vector menuTooltipAveragedMousePos;
387 entity menuTooltipItem;
388 vector menuTooltipOrigin;
389 vector menuTooltipSize;
390 float menuTooltipAlpha;
391 string menuTooltipText;
392 float menuTooltipState; // 0: static, 1: fading in, 2: fading out
393 float m_testmousetooltipbox(vector pos)
395 if(pos_x >= menuTooltipOrigin_x && pos_x < menuTooltipOrigin_x + menuTooltipSize_x)
396 if(pos_y >= menuTooltipOrigin_y && pos_y < menuTooltipOrigin_y + menuTooltipSize_y)
400 float m_testtooltipbox(vector tooltippos)
406 if(tooltippos_x + menuTooltipSize_x > 1)
408 if(tooltippos_y + menuTooltipSize_y > 1)
410 menuTooltipOrigin = tooltippos;
413 float m_allocatetooltipbox(vector pos)
415 vector avoidplus, avoidminus;
418 avoidplus_x = (SKINAVOID_TOOLTIP_x + SKINSIZE_CURSOR_x - SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth;
419 avoidplus_y = (SKINAVOID_TOOLTIP_y + SKINSIZE_CURSOR_y - SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight;
422 avoidminus_x = (SKINAVOID_TOOLTIP_x + SKINOFFSET_CURSOR_x * SKINSIZE_CURSOR_x) / conwidth + menuTooltipSize_x;
423 avoidminus_y = (SKINAVOID_TOOLTIP_y + SKINOFFSET_CURSOR_y * SKINSIZE_CURSOR_y) / conheight + menuTooltipSize_y;
428 if(m_testtooltipbox(v))
432 v_x = pos_x - menuTooltipSize_x * 0.5;
433 if(m_testtooltipbox(v))
437 v_x = pos_x - avoidminus_x;
438 if(m_testtooltipbox(v))
442 v_y = pos_y - avoidminus_y;
443 if(m_testtooltipbox(v))
447 v_x = pos_x - menuTooltipSize_x * 0.5;
448 if(m_testtooltipbox(v))
452 v_x = pos_x + avoidplus_x;
453 if(m_testtooltipbox(v))
458 entity m_findtooltipitem(entity root, vector pos)
466 while(it.instanceOfContainer)
468 while(it.instanceOfNexposee && it.focusedChild)
470 it = it.focusedChild;
471 pos = globalToBox(pos, it.Container_origin, it.Container_size);
473 if(it.instanceOfNexposee)
475 it = it.itemFromPoint(it, pos);
478 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
482 else if(it.instanceOfModalController)
483 it = it.focusedChild;
485 it = it.itemFromPoint(it, pos);
490 else if(menu_tooltips == 2 && (it.cvarName || it.onClickCommand))
492 pos = globalToBox(pos, it.Container_origin, it.Container_size);
499 if (menu_tooltips == 2)
502 if (menuTooltipItem.cvarName)
504 if (getCvarsMulti(menuTooltipItem))
505 s = strcat("[", menuTooltipItem.cvarName, " ", getCvarsMulti(menuTooltipItem), "]");
507 s = strcat("[", menuTooltipItem.cvarName, "]");
509 else if (menuTooltipItem.onClickCommand)
510 s = strcat("<", menuTooltipItem.onClickCommand, ">");
512 return menuTooltipItem.tooltip;
513 if (menuTooltipItem.tooltip)
514 return strcat(menuTooltipItem.tooltip, " ", s);
517 return menuTooltipItem.tooltip;
519 void m_tooltip(vector pos)
526 menu_tooltips = cvar("menu_tooltips");
529 // don't return immediately, fade out the active tooltip first
530 if (menuTooltipItem == world)
533 menu_tooltips_old = menu_tooltips;
537 f = bound(0, frametime * 2, 1);
538 menuTooltipAveragedMousePos = menuTooltipAveragedMousePos * (1 - f) + pos * f;
539 f = vlen(pos - menuTooltipAveragedMousePos);
541 it = m_findtooltipitem(main, pos);
545 fontsize = '1 0 0' * (SKINFONTSIZE_TOOLTIP / conwidth) + '0 1 0' * (SKINFONTSIZE_TOOLTIP / conheight);
547 // float menuTooltipState; // 0: static, 1: fading in, 2: fading out
548 if(it != menuTooltipItem)
550 switch(menuTooltipState)
555 // another item: fade out first
556 menuTooltipState = 2;
561 menuTooltipState = 1;
562 menuTooltipItem = it;
564 menuTooltipOrigin_x = -1; // unallocated
567 strunzone(menuTooltipText);
568 menuTooltipText = strzone(gettooltip());
572 getWrappedLine_remaining = menuTooltipText;
573 while(getWrappedLine_remaining)
575 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
577 f = draw_TextWidth(s, FALSE, fontsize);
581 menuTooltipSize_x = w + 2 * (SKINMARGIN_TOOLTIP_x / conwidth);
582 menuTooltipSize_y = i * fontsize_y + 2 * (SKINMARGIN_TOOLTIP_y / conheight);
583 menuTooltipSize_z = 0;
587 // changing item while fading in: fade out first
588 menuTooltipState = 2;
591 // changing item while fading out: can't
595 else if(menuTooltipState == 2) // re-fade in?
596 menuTooltipState = 1;
599 if(!m_testmousetooltipbox(pos))
600 menuTooltipState = 2; // fade out if mouse touches it
602 switch(menuTooltipState)
605 menuTooltipAlpha = bound(0, menuTooltipAlpha + 5 * frametime, 1);
606 if(menuTooltipAlpha == 1)
607 menuTooltipState = 0;
610 menuTooltipAlpha = bound(0, menuTooltipAlpha - 2 * frametime, 1);
611 if(menuTooltipAlpha == 0)
613 menuTooltipState = 0;
614 menuTooltipItem = world;
619 if(menuTooltipItem == world)
623 strunzone(menuTooltipText);
624 menuTooltipText = string_null;
630 if(menu_tooltips != menu_tooltips_old)
632 if (menu_tooltips != 0 && menu_tooltips_old != 0)
633 menuTooltipItem = world; // reload tooltip next frame
634 menu_tooltips_old = menu_tooltips;
636 else if(menuTooltipOrigin_x < 0) // unallocated?
637 m_allocatetooltipbox(pos);
639 if(menuTooltipOrigin_x >= 0)
642 p = SKINBORDER_TOOLTIP;
644 p_y *= 1 / conheight;
645 draw_BorderPicture(menuTooltipOrigin, SKINGFX_TOOLTIP, menuTooltipSize, '1 1 1', menuTooltipAlpha, p);
646 p = menuTooltipOrigin;
647 p_x += SKINMARGIN_TOOLTIP_x / conwidth;
648 p_y += SKINMARGIN_TOOLTIP_y / conheight;
649 getWrappedLine_remaining = menuTooltipText;
650 while(getWrappedLine_remaining)
652 s = getWrappedLine(SKINWIDTH_TOOLTIP, fontsize, draw_TextWidth_WithoutColors);
653 draw_Text(p, s, fontsize, '1 1 1', SKINALPHA_TOOLTIP * menuTooltipAlpha, FALSE);
667 execute_next_frame();
669 menuMouseMode = cvar("menu_mouse_absolute");
675 UpdateConWidthHeight();
679 // TODO draw an info image about this situation
683 if(!menuNotTheFirstFrame)
685 menuNotTheFirstFrame = 1;
687 if(!cvar("menu_video_played"))
689 localcmd("cd loop $menu_cdtrack; play sound/announcer/default/welcome.ogg\n");
690 menuLogoAlpha = -0.8; // no idea why, but when I start this at zero, it jumps instead of fading FIXME
692 // ALWAYS set this cvar; if we start but menu is not active, this means we want no background music!
693 localcmd("set menu_video_played 1\n");
697 realFrametime = frametime = min(0.2, t - menuPrevTime);
701 t = cvar("menu_slowmo");
712 if(getmousetarget() == (menuMouseMode ? MT_CLIENT : MT_MENU) && (getkeydest() == KEY_MENU || getkeydest() == KEY_MENU_GRABBED))
713 setkeydest(keyGrabber ? KEY_MENU_GRABBED : KEY_MENU);
718 if(cvar("cl_capturevideo"))
719 frametime = t / cvar("cl_capturevideo_fps"); // make capturevideo work smoothly
721 prevMenuAlpha = menuAlpha;
724 if(menuAlpha == 0 && menuLogoAlpha < 2)
726 menuLogoAlpha = menuLogoAlpha + frametime * 2;
730 menuAlpha = min(1, menuAlpha + frametime * 5);
736 menuAlpha = max(0, menuAlpha - frametime * 5);
740 draw_reset_cropped();
742 if(!(gamestatus & (GAME_CONNECTED | GAME_ISSERVER)))
744 if(menuLogoAlpha > 0)
747 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_BACKGROUND, 1);
748 drawBackground(SKINGFX_BACKGROUND, bound(0, menuLogoAlpha, 1), SKINALIGN_BACKGROUND, TRUE);
749 draw_reset_cropped();
750 if(menuAlpha <= 0 && SKINALPHA_CURSOR_INTRO > 0)
752 draw_alpha = SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1);
753 draw_drawMousePointer(menuMousePos);
758 else if(SKINALPHA_BACKGROUND_INGAME)
763 drawBackground(SKINGFX_BACKGROUND_INGAME, menuAlpha * SKINALPHA_BACKGROUND_INGAME, SKINALIGN_BACKGROUND_INGAME, FALSE);
764 draw_reset_cropped();
768 if(menuAlpha != prevMenuAlpha)
769 cvar_set("_menu_alpha", ftos(menuAlpha));
771 draw_reset_cropped();
773 draw_reset_cropped();
777 if(prevMenuAlpha > 0)
778 main.initializeDialog(main, main.firstChild);
779 draw_reset_cropped();
784 draw_alpha *= menuAlpha;
789 newMouse = globalToBox(getmousepos(), draw_shift, draw_scale);
790 if(newMouse != '0 0 0')
791 if(newMouse != menuMousePos)
793 menuMousePos = newMouse;
794 if(mouseButtonsPressed)
795 main.mouseDrag(main, menuMousePos);
797 main.mouseMove(main, menuMousePos);
804 vector dMouse, minpos, maxpos;
805 dMouse = getmousepos() * (frametime / realFrametime); // for capturevideo
806 if(dMouse != '0 0 0')
808 minpos = globalToBox('0 0 0', draw_shift, draw_scale);
809 maxpos = globalToBox(eX * (realconwidth - 1) + eY * (realconheight - 1), draw_shift, draw_scale);
810 dMouse = globalToBoxSize(dMouse, draw_scale);
811 menuMousePos += dMouse * cvar("menu_mouse_speed");
812 menuMousePos_x = bound(minpos_x, menuMousePos_x, maxpos_x);
813 menuMousePos_y = bound(minpos_y, menuMousePos_y, maxpos_y);
814 if(mouseButtonsPressed)
815 main.mouseDrag(main, menuMousePos);
817 main.mouseMove(main, menuMousePos);
823 m_tooltip(menuMousePos);
825 draw_alpha = max(draw_alpha, SKINALPHA_CURSOR_INTRO * bound(0, menuLogoAlpha, 1));
827 draw_drawMousePointer(menuMousePos);
829 draw_reset_cropped();
838 setkeydest(KEY_MENU);
839 setmousetarget((menuMouseMode ? MT_CLIENT : MT_MENU));
844 if(mouseButtonsPressed)
845 main.mouseRelease(main, menuMousePos);
846 mouseButtonsPressed = 0;
848 main.focusEnter(main);
849 main.showNotify(main);
855 setkeydest(KEY_GAME);
856 setmousetarget(MT_CLIENT);
861 main.focusLeave(main);
862 main.hideNotify(main);
865 void m_toggle(float mode)
886 for(e = NULL; (e = nextent(e)) != NULL; )
888 if(e.classname != "vtbl")
894 void m_focus_item_chain(entity outermost, entity innermost)
896 if(innermost.parent != outermost)
897 m_focus_item_chain(outermost, innermost.parent);
898 innermost.parent.setFocus(innermost.parent, innermost);
901 void m_activate_window(entity wnd)
906 m_activate_window(par);
908 if(par.instanceOfModalController)
910 if(wnd.tabSelectingButton)
912 TabButton_Click(wnd.tabSelectingButton, wnd);
915 par.initializeDialog(par, wnd);
917 else if(par.instanceOfNexposee)
919 // nexposee (sorry for violating abstraction here)
920 par.selectedChild = wnd;
921 par.animationState = 1;
922 Container_setFocus(par, NULL);
924 else if(par.instanceOfContainer)
928 par.setFocus(par, wnd);
932 void m_setpointerfocus(entity wnd)
934 if(wnd.instanceOfContainer)
936 entity focus = wnd.preferredFocusedGrandChild(wnd);
939 menuMousePos = focus.origin + 0.5 * focus.size;
940 menuMousePos_x *= 1 / conwidth;
941 menuMousePos_y *= 1 / conheight;
942 if(wnd.focused) // why does this never happen?
943 m_focus_item_chain(wnd, focus);
948 void m_goto(string itemname)
954 strunzone(m_goto_buffer);
955 m_goto_buffer = strzone(itemname);
958 if(itemname == "") // this can be called by GameCommand
960 if(gamestatus & (GAME_ISSERVER | GAME_CONNECTED))
966 m_activate_window(main.mainNexposee);
972 for(e = NULL; (e = find(e, name, itemname)); )
973 if(e.classname != "vtbl")
978 m_activate_window(e);
979 m_setpointerfocus(e);