1 #include "keybinder.qh"
3 #include <common/weapons/_all.qh>
7 #include "dialog_settings_input_userbind.qh"
9 const string KEY_NOT_BOUND_CMD = "// not bound";
11 const int MAX_KEYS_PER_FUNCTION = 2;
12 const int MAX_KEYBINDS = 256;
13 string KeyBinds_Functions[MAX_KEYBINDS];
14 string KeyBinds_Descriptions[MAX_KEYBINDS];
15 int KeyBinds_Count = -1;
17 void KeyBinds_BuildList()
21 #define KEYBIND_DEF(func, desc) MACRO_BEGIN \
22 if((KeyBinds_Count < MAX_KEYBINDS)) { \
23 KeyBinds_Functions[KeyBinds_Count] = strzone(func); \
24 KeyBinds_Descriptions[KeyBinds_Count] = strzone(desc); \
29 #define KEYBIND_EMPTY_LINE() KEYBIND_DEF("", "")
30 #define KEYBIND_HEADER(str) KEYBIND_DEF("", str)
32 #define KEYBIND_IS_SPECIAL(func) (substring(func, 0 ,1) == "*")
33 #define KEYBIND_SPECIAL_DEF(key, desc) KEYBIND_DEF(strcat("*", key), desc)
35 KEYBIND_HEADER(_("Moving"));
36 KEYBIND_DEF("+forward" , _("forward"));
37 KEYBIND_DEF("+back" , _("backpedal"));
38 KEYBIND_DEF("+moveleft" , _("strafe left"));
39 KEYBIND_DEF("+moveright" , _("strafe right"));
40 KEYBIND_DEF("+jump" , _("jump / swim"));
41 KEYBIND_DEF("+crouch" , _("crouch / sink"));
42 KEYBIND_DEF("+hook" , _("off-hand hook"));
43 KEYBIND_DEF("+jetpack" , _("jetpack"));
46 KEYBIND_HEADER(_("Attacking"));
47 KEYBIND_DEF("+fire" , _("primary fire"));
48 KEYBIND_DEF("+fire2" , _("secondary fire"));
51 KEYBIND_HEADER(_("Weapons"));
52 KEYBIND_DEF("weapprev" , CTX(_("WEAPON^previous")));
53 KEYBIND_DEF("weapnext" , CTX(_("WEAPON^next")));
54 KEYBIND_DEF("weaplast" , CTX(_("WEAPON^previously used")));
55 KEYBIND_DEF("weapbest" , CTX(_("WEAPON^best")));
56 KEYBIND_DEF("reload" , _("reload"));
57 KEYBIND_DEF("dropweapon" , _("drop weapon / throw nade"));
59 #define ADD_TO_W_LIST(pred) \
60 FOREACH(Weapons, it != WEP_Null, { \
61 if (it.impulse != imp) continue; \
62 if (!(pred)) continue; \
63 w_list = strcat(w_list, it.m_name, " / "); \
66 for(int imp = 1; imp <= 9; ++imp)
69 ADD_TO_W_LIST(!(it.spawnflags & (WEP_FLAG_MUTATORBLOCKED | WEP_FLAG_HIDDEN | WEP_FLAG_SPECIALATTACK | WEP_FLAG_SUPERWEAPON)));
70 ADD_TO_W_LIST((it.spawnflags & WEP_FLAG_SUPERWEAPON) && !(it.spawnflags & WEP_FLAG_HIDDEN));
71 ADD_TO_W_LIST((it.spawnflags & WEP_FLAG_MUTATORBLOCKED) && !(it.spawnflags & (WEP_FLAG_HIDDEN | WEP_FLAG_SPECIALATTACK)));
73 KEYBIND_DEF(strcat("weapon_group_", itos(imp)), substring(w_list, 0, -4));
83 KEYBIND_HEADER(_("View"));
84 KEYBIND_DEF("+zoom" , _("hold zoom"));
85 KEYBIND_DEF("togglezoom" , _("toggle zoom"));
86 KEYBIND_DEF("+showscores" , _("show scores"));
87 KEYBIND_DEF("screenshot" , _("screen shot"));
88 KEYBIND_DEF("+hud_panel_radar_maximized" , _("maximize radar"));
89 KEYBIND_DEF("toggle chase_active" , _("3rd person view"));
90 KEYBIND_DEF("spec" , _("enter spectator mode"));
93 KEYBIND_HEADER(_("Communication"));
94 KEYBIND_DEF("messagemode" , _("public chat"));
95 KEYBIND_DEF("messagemode2" , _("team chat"));
96 KEYBIND_DEF("+con_chat_maximize" , _("show chat history"));
97 KEYBIND_DEF("vyes" , _("vote YES"));
98 KEYBIND_DEF("vno" , _("vote NO"));
99 KEYBIND_DEF("ready" , _("ready"));
100 KEYBIND_EMPTY_LINE();
102 KEYBIND_HEADER(_("Client"));
103 KEYBIND_DEF("+show_info" , _("server info"));
104 // display the hardcoded shortcut to open the console as it works for all
105 // non-English keyboard layouts, unlike default keys (` and ~)
106 KEYBIND_DEF("toggleconsole" , _("enter console"));
107 string console_shortcut = strcat(translate_key("SHIFT"), "+", translate_key("ESCAPE"));
108 KEYBIND_SPECIAL_DEF(console_shortcut, _("enter console"));
109 KEYBIND_DEF("menu_showquitdialog" , _("quit / leave match"));
110 KEYBIND_EMPTY_LINE();
112 KEYBIND_HEADER(_("Teamplay"));
113 KEYBIND_DEF("team_auto" , _("auto-join team"));
114 KEYBIND_DEF("menu_showteamselect" , _("team menu"));
115 KEYBIND_DEF("spec" , _("spectate"));
116 KEYBIND_EMPTY_LINE();
118 KEYBIND_HEADER(_("Misc"));
119 KEYBIND_DEF("+use" , _("drop key/flag, exit vehicle"));
120 KEYBIND_DEF("kill" , _("suicide / respawn"));
121 KEYBIND_DEF("quickmenu" , _("quick menu"));
122 KEYBIND_EMPTY_LINE();
124 KEYBIND_HEADER(_("User defined"));
126 for(int i = 1; i <= 32; ++i)
127 KEYBIND_DEF(strcat("+userbind ", itos(i)), strcat("$userbind", itos(i)));
129 KEYBIND_EMPTY_LINE();
131 KEYBIND_HEADER(_("Development"));
132 KEYBIND_DEF("menu_showsandboxtools" , _("sandbox menu"));
133 KEYBIND_DEF("+button8" , _("drag object (sandbox)"));
134 KEYBIND_DEF("wpeditor_menu" , _("waypoint editor menu"));
139 entity makeXonoticKeyBinder()
142 me = NEW(XonoticKeyBinder);
143 me.configureXonoticKeyBinder(me);
146 void replace_bind(string from, string to)
149 float k; // not sure if float or int
150 n = tokenize(findkeysforcommand(from, 0)); // uses '...' strings
151 for(j = 0; j < n; ++j)
155 localcmd("\nbind \"", keynumtostring(k), "\" \"", to, "\"\n");
158 cvar_set("_hud_showbinds_reload", "1");
160 void XonoticKeyBinder_configureXonoticKeyBinder(entity me)
162 me.configureXonoticListBox(me);
165 // TEMP: Xonotic 0.1 to later
166 replace_bind("impulse 1", "weapon_group_1");
167 replace_bind("impulse 2", "weapon_group_2");
168 replace_bind("impulse 3", "weapon_group_3");
169 replace_bind("impulse 4", "weapon_group_4");
170 replace_bind("impulse 5", "weapon_group_5");
171 replace_bind("impulse 6", "weapon_group_6");
172 replace_bind("impulse 7", "weapon_group_7");
173 replace_bind("impulse 8", "weapon_group_8");
174 replace_bind("impulse 9", "weapon_group_9");
175 replace_bind("impulse 14", "weapon_group_0");
177 void XonoticKeyBinder_loadKeyBinds(entity me)
179 bool force_initial_selection = false;
180 if(KeyBinds_Count < 0) // me.handle not loaded yet?
181 force_initial_selection = true;
182 KeyBinds_BuildList();
183 me.nItems = KeyBinds_Count;
184 if(force_initial_selection)
185 me.setSelected(me, 0);
187 void XonoticKeyBinder_showNotify(entity me)
192 void XonoticKeyBinder_resizeNotify(entity me, vector relOrigin, vector relSize, vector absOrigin, vector absSize)
194 SUPER(XonoticKeyBinder).resizeNotify(me, relOrigin, relSize, absOrigin, absSize);
196 me.realFontSize_y = me.fontSize / (absSize.y * me.itemHeight);
197 me.realFontSize_x = me.fontSize / (absSize.x * (1 - me.controlWidth));
198 me.realUpperMargin = 0.5 * (1 - me.realFontSize.y);
200 me.columnFunctionOrigin = 0;
201 me.columnKeysSize = me.realFontSize.x * 12;
202 me.columnFunctionSize = 1 - me.columnKeysSize - 2 * me.realFontSize.x;
203 me.columnKeysOrigin = me.columnFunctionOrigin + me.columnFunctionSize + me.realFontSize.x;
205 void KeyBinder_Bind_Change(entity btn, entity me)
207 string func = KeyBinds_Functions[me.selectedItem];
208 if(func == "" || KEYBIND_IS_SPECIAL(func))
211 me.keyGrabButton.forcePressed = 1;
212 me.clearButton.disabled = 1;
215 void XonoticKeyBinder_keyGrabbed(entity me, int key, bool ascii)
220 me.keyGrabButton.forcePressed = 0;
221 me.clearButton.disabled = 0;
226 // forbid these keys from being bound in the menu
227 if(key == K_CAPSLOCK || key == K_NUMLOCK)
229 KeyBinder_Bind_Change(me, me);
233 string func = KeyBinds_Functions[me.selectedItem];
234 if(func == "" || KEYBIND_IS_SPECIAL(func))
237 n = tokenize(findkeysforcommand(func, 0)); // uses '...' strings
239 for(j = 0; j < n; ++j)
245 if(nvalid >= MAX_KEYS_PER_FUNCTION)
247 for(j = 0; j < n; ++j)
252 // bind to empty cmd instead of using unbind so it gets saved in config and overrides any default binds
253 localcmd("\nbind \"", keynumtostring(k), "\" \"", KEY_NOT_BOUND_CMD, "\"\n");
257 m_play_click_sound(MENU_SOUND_SELECT);
258 localcmd("\nbind \"", keynumtostring(key), "\" \"", func, "\"\n");
259 localcmd("-zoom\n"); // to make sure we aren't in togglezoom'd state
260 cvar_set("_hud_showbinds_reload", "1");
262 void XonoticKeyBinder_destroy(entity me)
264 if(KeyBinds_Count < 0)
267 for(int i = 0; i < MAX_KEYBINDS; ++i)
269 strfree(KeyBinds_Functions[i]);
270 strfree(KeyBinds_Descriptions[i]);
274 void XonoticKeyBinder_editUserbind(entity me, string theName, string theCommandPress, string theCommandRelease)
276 if(!me.userbindEditDialog)
279 string func = KeyBinds_Functions[me.selectedItem];
280 if(func == "" || KEYBIND_IS_SPECIAL(func))
283 string descr = KeyBinds_Descriptions[me.selectedItem];
284 if(substring(descr, 0, 1) != "$")
286 descr = substring(descr, 1, strlen(descr) - 1);
288 // Hooray! It IS a user bind!
289 cvar_set(strcat(descr, "_description"), theName);
290 cvar_set(strcat(descr, "_press"), theCommandPress);
291 cvar_set(strcat(descr, "_release"), theCommandRelease);
293 void KeyBinder_Bind_Edit(entity btn, entity me)
295 if(!me.userbindEditDialog)
298 string func = KeyBinds_Functions[me.selectedItem];
299 if(func == "" || KEYBIND_IS_SPECIAL(func))
302 string descr = KeyBinds_Descriptions[me.selectedItem];
303 if(substring(descr, 0, 1) != "$")
305 descr = substring(descr, 1, strlen(descr) - 1);
307 // Hooray! It IS a user bind!
308 me.userbindEditDialog.loadUserBind(me.userbindEditDialog, cvar_string(strcat(descr, "_description")), cvar_string(strcat(descr, "_press")), cvar_string(strcat(descr, "_release")));
310 DialogOpenButton_Click(btn, me.userbindEditDialog);
312 void KeyBinder_Bind_Clear(entity btn, entity me)
316 string func = KeyBinds_Functions[me.selectedItem];
317 if(func == "" || KEYBIND_IS_SPECIAL(func))
320 n = tokenize(findkeysforcommand(func, 0)); // uses '...' strings
321 for(j = 0; j < n; ++j)
326 // bind to empty cmd instead of using unbind so it gets saved in config and overrides any default binds
327 localcmd("\nbind \"", keynumtostring(k), "\" \"", KEY_NOT_BOUND_CMD, "\"\n");
330 m_play_click_sound(MENU_SOUND_CLEAR);
331 localcmd("-zoom\n"); // to make sure we aren't in togglezoom'd state
332 cvar_set("_hud_showbinds_reload", "1");
334 void KeyBinder_Bind_Reset_All(entity btn, entity me)
336 localcmd("unbindall\n");
337 localcmd("exec binds-xonotic.cfg\n");
338 localcmd("-zoom\n"); // to make sure we aren't in togglezoom'd state
339 cvar_set("_hud_showbinds_reload", "1");
342 void XonoticKeyBinder_doubleClickListBoxItem(entity me, float i, vector where)
344 KeyBinder_Bind_Change(NULL, me);
346 void XonoticKeyBinder_setSelected(entity me, int i)
348 // handling of "unselectable" items
349 i = floor(0.5 + bound(0, i, me.nItems - 1));
350 if (KEYBIND_IS_SPECIAL(KeyBinds_Functions[i]))
352 SUPER(XonoticKeyBinder).setSelected(me, i - 1);
355 if(me.pressed == 0 || me.pressed == 1) // keyboard or scrolling - skip unselectable items
357 if(i > me.previouslySelected)
359 while((i < me.nItems - 1) && (KeyBinds_Functions[i] == ""))
362 while((i > 0) && (KeyBinds_Functions[i] == ""))
364 while((i < me.nItems - 1) && (KeyBinds_Functions[i] == ""))
367 if(me.pressed == 3) // released the mouse - fall back to last valid item
369 if(KeyBinds_Functions[i] == "")
370 i = me.previouslySelected;
372 if(KeyBinds_Functions[i] != "")
373 me.previouslySelected = i;
374 if(me.userbindEditButton)
375 me.userbindEditButton.disabled = (substring(KeyBinds_Descriptions[i], 0, 1) != "$");
376 SUPER(XonoticKeyBinder).setSelected(me, i);
378 float XonoticKeyBinder_keyDown(entity me, int key, bool ascii, float shift)
386 KeyBinder_Bind_Change(me, me);
391 KeyBinder_Bind_Clear(me, me);
394 KeyBinder_Bind_Edit(me, me);
397 r = SUPER(XonoticKeyBinder).keyDown(me, key, ascii, shift);
403 void XonoticKeyBinder_drawListBoxItem(entity me, int i, vector absSize, bool isSelected, bool isFocused)
409 string descr = KeyBinds_Descriptions[i];
410 string func = KeyBinds_Functions[i];
414 theColor = SKINCOLOR_KEYGRABBER_TITLES;
415 theAlpha = SKINALPHA_KEYGRABBER_TITLES;
423 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_LISTBOX_WAITING, SKINALPHA_LISTBOX_WAITING);
425 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_LISTBOX_SELECTED, SKINALPHA_LISTBOX_SELECTED);
429 me.focusedItemAlpha = getFadedAlpha(me.focusedItemAlpha, SKINALPHA_LISTBOX_FOCUSED, SKINFADEALPHA_LISTBOX_FOCUSED);
430 draw_Fill('0 0 0', '1 1 0', SKINCOLOR_LISTBOX_FOCUSED, me.focusedItemAlpha);
433 theAlpha = SKINALPHA_KEYGRABBER_KEYS;
434 theColor = SKINCOLOR_KEYGRABBER_KEYS;
435 extraMargin = me.realFontSize.x * 0.5;
438 if(substring(descr, 0, 1) == "$")
440 string s = substring(descr, 1, strlen(descr) - 1);
441 descr = cvar_string(strcat(s, "_description"));
444 if(cvar_string(strcat(s, "_press")) == "")
445 if(cvar_string(strcat(s, "_release")) == "")
446 theAlpha *= SKINALPHA_DISABLED;
449 string s = draw_TextShortenToWidth(descr, me.columnFunctionSize, 0, me.realFontSize);
450 draw_Text(me.realUpperMargin * eY + extraMargin * eX, s, me.realFontSize, theColor, theAlpha, 0);
456 if (KEYBIND_IS_SPECIAL(func))
457 s = substring(func, 1, -1);
460 bool joy_active = cvar("joy_active");
461 int n = tokenize(findkeysforcommand(func, 0)); // uses '...' strings
462 for(int j = 0; j < n; ++j)
464 float k = stof(argv(j));
467 string key = keynumtostring(k);
468 if (!joy_active && startsWith(key, "JOY"))
472 s = strcat(s, translate_key(key));
476 s = draw_TextShortenToWidth(s, me.columnKeysSize, 0, me.realFontSize);
477 draw_CenterText(me.realUpperMargin * eY + (me.columnKeysOrigin + 0.5 * me.columnKeysSize) * eX, s, me.realFontSize, theColor, theAlpha, 0);