]> git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/client/hud.qh
Define client entity classes
[xonotic/xonotic-data.pk3dir.git] / qcsrc / client / hud.qh
1 #ifndef HUD_H
2 #define HUD_H
3
4 #include "../common/weapons/weapons.qh"
5
6 const int HUD_PANEL_MAX = 24;
7 entity hud_panel[HUD_PANEL_MAX];
8 const int HUD_PANEL_FIRST = 0;
9 int HUD_PANEL_NUM;
10 int HUD_PANEL_LAST;
11
12 int panel_order[HUD_PANEL_MAX];
13 string hud_panelorder_prev;
14
15 float hud_draw_maximized;
16 float hud_panel_radar_maximized;
17 float chat_panel_modified;
18 float radar_panel_modified;
19
20 vector mousepos;
21 vector panel_click_distance; // mouse cursor distance from the top left corner of the panel (saved only upon a click)
22 vector panel_click_resizeorigin; // coordinates for opposite point when resizing
23 float resizeCorner; // 1 = topleft, 2 = topright, 3 = bottomleft, 4 = bottomright
24 entity highlightedPanel;
25 float highlightedAction; // 0 = nothing, 1 = move, 2 = resize
26
27 const float BORDER_MULTIPLIER = 0.25;
28 float scoreboard_bottom;
29 int weapon_accuracy[WEP_MAXCOUNT];
30
31 int complain_weapon;
32 string complain_weapon_name;
33 float complain_weapon_type;
34 float complain_weapon_time;
35
36 int ps_primary, ps_secondary;
37 int ts_primary, ts_secondary;
38
39 int last_switchweapon;
40 int last_activeweapon;
41 float weapontime;
42 float weaponprevtime;
43
44 float teamnagger;
45
46 float hud_configure_checkcollisions;
47 float hud_configure_prev;
48 vector hud_configure_gridSize;
49 vector hud_configure_realGridSize;
50
51 int hudShiftState;
52 const int S_SHIFT = 1;
53 const int S_CTRL = 2;
54 const int S_ALT = 4;
55
56 float menu_enabled; // 1 showing the entire HUD, 2 showing only the clicked panel
57
58 float hud_fade_alpha;
59
60 string hud_skin_path;
61 string hud_skin_prev;
62
63 vector myteamcolors;
64
65 entity highlightedPanel_backup;
66 vector panel_pos_backup;
67 vector panel_size_backup;
68
69 vector panel_size_copied;
70
71 entity panel;
72 entityclass(HUDPanel)
73 class(HUDPanel) .string panel_name;
74 class(HUDPanel) .int panel_id;
75 class(HUDPanel) .vector current_panel_pos;
76 class(HUDPanel) .vector current_panel_size;
77 class(HUDPanel) .string current_panel_bg;
78 class(HUDPanel) .float current_panel_bg_alpha;
79 class(HUDPanel) .float current_panel_bg_border;
80 class(HUDPanel) .vector current_panel_bg_color;
81 class(HUDPanel) .float current_panel_bg_color_team;
82 class(HUDPanel) .float current_panel_bg_padding;
83 class(HUDPanel) .float current_panel_fg_alpha;
84 class(HUDPanel) .float update_time;
85 float panel_enabled;
86 vector panel_pos;
87 vector panel_size;
88 string panel_bg_str; // "_str" vars contain the raw value of the cvar, non-"_str" contains what hud.qc code should use
89 vector panel_bg_color;
90 string panel_bg_color_str;
91 float panel_bg_color_team;
92 string panel_bg_color_team_str;
93 float panel_fg_alpha;
94 float panel_bg_alpha;
95 string panel_bg_alpha_str;
96 float panel_bg_border;
97 string panel_bg_border_str;
98 float panel_bg_padding;
99 string panel_bg_padding_str;
100
101 class(HUDPanel) .void() panel_draw;
102
103 float current_player;
104
105 float GetPlayerColorForce(int i);
106
107
108 #define HUD_PANELS(HUD_PANEL)                                                                                                                                                                           \
109         HUD_PANEL(WEAPONS      , HUD_Weapons      , weapons)                                                                                                                    \
110         HUD_PANEL(AMMO         , HUD_Ammo         , ammo)                                                                                                                               \
111         HUD_PANEL(POWERUPS     , HUD_Powerups     , powerups)                                                                                                                   \
112         HUD_PANEL(HEALTHARMOR  , HUD_HealthArmor  , healtharmor)                                                                                                                \
113         HUD_PANEL(NOTIFY       , HUD_Notify       , notify)                                                                                                                     \
114         HUD_PANEL(TIMER        , HUD_Timer        , timer)                                                                                                                              \
115         HUD_PANEL(RADAR        , HUD_Radar        , radar)                                                                                                                              \
116         HUD_PANEL(SCORE        , HUD_Score        , score)                                                                                                                              \
117         HUD_PANEL(RACETIMER    , HUD_RaceTimer    , racetimer)                                                                                                                  \
118         HUD_PANEL(VOTE         , HUD_Vote         , vote)                                                                                                                               \
119         HUD_PANEL(MODICONS     , HUD_ModIcons     , modicons)                                                                                                                   \
120         HUD_PANEL(PRESSEDKEYS  , HUD_PressedKeys  , pressedkeys)                                                                                                                \
121         HUD_PANEL(CHAT         , HUD_Chat         , chat)                                                                                                                               \
122         HUD_PANEL(ENGINEINFO   , HUD_EngineInfo   , engineinfo)                                                                                                                 \
123         HUD_PANEL(INFOMESSAGES , HUD_InfoMessages , infomessages)                                                                                                               \
124         HUD_PANEL(PHYSICS      , HUD_Physics      , physics)                                                                                                                    \
125         HUD_PANEL(CENTERPRINT  , HUD_CenterPrint  , centerprint)                                                                                                                \
126         HUD_PANEL(BUFFS        , HUD_Buffs        , buffs)
127
128 #define HUD_PANEL(NAME, draw_func, name)                                                                                                                                                        \
129         int HUD_PANEL_##NAME;                                                                                                                                                                                   \
130         void draw_func(void);                                                                                                                                                                                   \
131         void RegisterHUD_Panel_##NAME() {                                                                                                                                                               \
132                 HUD_PANEL_LAST = HUD_PANEL_##NAME = HUD_PANEL_NUM;                                                                                                                      \
133                 entity hud_panelent = spawn();                                                                                                                                                          \
134                 hud_panel[HUD_PANEL_##NAME] = hud_panelent;                                                                                                                             \
135                 hud_panelent.classname = "hud_panel";                                                                                                                                           \
136                 hud_panelent.panel_name = #name;                                                                                                                                                        \
137                 hud_panelent.panel_id = HUD_PANEL_##NAME;                                                                                                                                       \
138                 hud_panelent.panel_draw = draw_func;                                                                                                                                            \
139                 HUD_PANEL_NUM++;                                                                                                                                                                                        \
140         }                                                                                                                                                                                                                               \
141         ACCUMULATE_FUNCTION(RegisterHUD_Panels, RegisterHUD_Panel_##NAME);
142
143 HUD_PANELS(HUD_PANEL)
144 #undef HUD_PANEL
145
146 #define HUD_PANEL(NAME) hud_panel[HUD_PANEL_##NAME]
147
148
149 // Because calling lots of functions in QC apparently cuts fps in half on many machines:
150 // ----------------------
151 // MACRO HELL STARTS HERE
152 // ----------------------
153 // Little help for the poor people who have to make sense of this: Start from the bottom ;)
154
155 // Get value for panel.current_panel_bg: if "" fetch default, else use panel_bg_str
156 // comment on last line of macro: // we probably want to see a background in config mode at all times...
157 #define HUD_Panel_GetBg() do {                                                                                      \
158         string panel_bg;                                                                                                \
159         if (!autocvar__hud_configure && panel_bg_str == "0") {                                                          \
160                 panel_bg = "0";                                                                                             \
161         } else {                                                                                                        \
162                 if (panel_bg_str == "") {                                                                                   \
163                         panel_bg_str = autocvar_hud_panel_bg;                                                                   \
164                 }                                                                                                           \
165                 if (panel_bg_str == "0" && !autocvar__hud_configure) {                                                      \
166                         panel_bg = "0";                                                                                         \
167                 } else {                                                                                                    \
168                         if (panel_bg_str == "0" && autocvar__hud_configure)                                                     \
169                                 panel_bg_alpha_str = "0";                                                                           \
170                         panel_bg = strcat(hud_skin_path, "/", panel_bg_str);                                                    \
171                         if (precache_pic(panel_bg) == "") {                                                                     \
172                                 panel_bg = strcat(hud_skin_path, "/", "border_default");                                            \
173                                 if (precache_pic(panel_bg) == "") {                                                                 \
174                                         panel_bg = strcat("gfx/hud/default/", "border_default");                                        \
175                                 }                                                                                                   \
176                         }                                                                                                       \
177                 }                                                                                                           \
178         }                                                                                                               \
179         if (panel.current_panel_bg)                                                                                     \
180                 strunzone(panel.current_panel_bg);                                                                          \
181         panel.current_panel_bg = strzone(panel_bg);                                                                     \
182 } while(0)
183
184 // Get value for panel_bg_color: if "" fetch default, else use panel_bg_color. Convert pants, shirt or teamcolor into a vector.
185 #define HUD_Panel_GetColor() do {                                                                                   \
186         if ((teamplay) && panel_bg_color_team) {                                                                        \
187                 if (autocvar__hud_configure && myteam == NUM_SPECTATOR)                                                     \
188                         panel_bg_color = '1 0 0' * panel_bg_color_team;                                                         \
189                 else                                                                                                        \
190                         panel_bg_color = myteamcolors * panel_bg_color_team;                                                    \
191         } else if (autocvar_hud_configure_teamcolorforced && autocvar__hud_configure && panel_bg_color_team) {          \
192                 panel_bg_color = '1 0 0' * panel_bg_color_team;                                                             \
193         } else {                                                                                                        \
194                 if (panel_bg_color_str == "") {                                                                             \
195                         panel_bg_color = autocvar_hud_panel_bg_color;                                                           \
196                 } else {                                                                                                    \
197                         if (panel_bg_color_str == "shirt") {                                                                    \
198                                 panel_bg_color = colormapPaletteColor(floor(stof(getplayerkeyvalue(current_player - 1, "colors")) / 16), 0);\
199                         } else if (panel_bg_color_str == "pants") {                                                             \
200                                 panel_bg_color = colormapPaletteColor(stof(getplayerkeyvalue(current_player - 1, "colors")) % 16, 1);\
201                         } else {                                                                                                \
202                                 panel_bg_color = stov(panel_bg_color_str);                                                          \
203                         }                                                                                                       \
204                 }                                                                                                           \
205         }                                                                                                               \
206 } while(0)
207
208 // Get value for panel_bg_color_team: if "" fetch default, else use panel_bg_color_team_str
209 #define HUD_Panel_GetColorTeam() do {                                                                               \
210         if (panel_bg_color_team_str == "") {                                                                            \
211                 panel_bg_color_team = autocvar_hud_panel_bg_color_team;                                                     \
212         } else {                                                                                                        \
213                 panel_bg_color_team = stof(panel_bg_color_team_str);                                                        \
214         }                                                                                                               \
215 } while(0)
216
217 // Get value for panel_bg_alpha: if "" fetch default, else use panel_bg_alpha. Also do various menu dialog fadeout/in checks, and minalpha checks
218 // comment on line 3 of macro: // do not set a minalpha cap when showing the config dialog for this panel
219 #define HUD_Panel_GetBgAlpha() do {                                                                                 \
220         if (panel_bg_alpha_str == "") {                                                                                 \
221                 panel_bg_alpha_str = ftos(autocvar_hud_panel_bg_alpha);                                                     \
222         }                                                                                                               \
223         panel_bg_alpha = stof(panel_bg_alpha_str);                                                                      \
224         if (autocvar__hud_configure) {                                                                                  \
225                 if (!panel_enabled)                                                                                         \
226                         panel_bg_alpha = 0.25;                                                                                  \
227                 else if (menu_enabled == 2 && panel == highlightedPanel)                                                    \
228                         panel_bg_alpha = (1 - autocvar__menu_alpha) * max(cvar("hud_configure_bg_minalpha"), panel_bg_alpha) + autocvar__menu_alpha * panel_bg_alpha;\
229                 else                                                                                                        \
230                         panel_bg_alpha = max(cvar("hud_configure_bg_minalpha"), panel_bg_alpha);                                \
231         }                                                                                                               \
232 } while(0)
233
234 // Get value for panel_fg_alpha. Also do various minalpha checks
235 // comment on line 2 of macro: // ALWAYS show disabled panels at 0.25 alpha when in config mode
236 #define HUD_Panel_GetFgAlpha() do {                                                                                 \
237         panel_fg_alpha = autocvar_hud_panel_fg_alpha;                                                                   \
238         if (autocvar__hud_configure && !panel_enabled)                                                                  \
239                 panel_fg_alpha = 0.25;                                                                                      \
240 } while(0)
241
242 // Get border. See comments above, it's similar.
243 #define HUD_Panel_GetBorder() do {                                                                                  \
244         if (panel_bg_border_str == "") {                                                                                \
245                 panel_bg_border = autocvar_hud_panel_bg_border;                                                             \
246         } else {                                                                                                        \
247                 panel_bg_border = stof(panel_bg_border_str);                                                                \
248         }                                                                                                               \
249 } while(0)
250
251 // Get padding. See comments above, it's similar.
252 // last line is a port of the old function, basically always make sure the panel contents are at least 5 pixels tall/wide, to disallow extreme padding values
253 #define HUD_Panel_GetPadding() do {                                                                                 \
254         if (panel_bg_padding_str == "") {                                                                               \
255                 panel_bg_padding = autocvar_hud_panel_bg_padding;                                                           \
256         } else {                                                                                                        \
257                 panel_bg_padding = stof(panel_bg_padding_str);                                                              \
258         }                                                                                                               \
259         panel_bg_padding = min(min(panel_size.x, panel_size.y)/2 - 5, panel_bg_padding);                                \
260 } while(0)
261
262 // return smoothly faded pos and size of given panel when a dialog is active
263 #define HUD_Panel_UpdatePosSize_ForMenu() do {                                                                      \
264         vector menu_enable_pos;                                                                                         \
265         vector menu_enable_size = '0 0 0';                                                                              \
266         float menu_enable_maxsize_x = 0.3 * vid_conwidth;                                                               \
267         float menu_enable_maxsize_y = 0.18 * vid_conheight;                                                             \
268         if (panel_size.x > panel_size.y) {                                                                              \
269                 if (panel_size.y > menu_enable_maxsize_y) {                                                                 \
270                         menu_enable_size.y = menu_enable_maxsize_y;                                                             \
271                         menu_enable_size.x = panel_size.x * (menu_enable_maxsize_y/panel_size.y);                               \
272                         panel_size = (1 - autocvar__menu_alpha) * panel_size + (autocvar__menu_alpha) * menu_enable_size;       \
273                 }                                                                                                           \
274                 menu_enable_pos = eX * 0.5 * vid_conwidth - eX * 0.5 * panel_size.x + eY * (vid_conheight - menu_enable_maxsize_y);\
275         } else {                                                                                                        \
276                 if (panel_size.x > menu_enable_maxsize_x) {                                                                 \
277                         menu_enable_size.x = menu_enable_maxsize_x;                                                             \
278                         menu_enable_size.y = panel_size.y * (menu_enable_maxsize_x/panel_size.x);                               \
279                         panel_size = (1 - autocvar__menu_alpha) * panel_size + (autocvar__menu_alpha) * menu_enable_size;       \
280                 }                                                                                                           \
281                 menu_enable_pos = eY * 0.5 * vid_conheight - eY * 0.5 * panel_size.y + eX * (vid_conwidth - menu_enable_maxsize_x);\
282         }                                                                                                               \
283         panel_pos = (1 - autocvar__menu_alpha) * panel_pos + (autocvar__menu_alpha) * menu_enable_pos;                  \
284 } while(0)
285
286 // Scale the pos and size vectors to absolute coordinates
287 #define HUD_Panel_ScalePosSize() do {                                                                               \
288         panel_pos.x *= vid_conwidth;  panel_pos.y *= vid_conheight;                                                     \
289         panel_size.x *= vid_conwidth; panel_size.y *= vid_conheight;                                                    \
290 } while(0)
291
292 // NOTE: in hud_configure mode cvars must be reloaded every frame
293 #define HUD_Panel_UpdateCvars() do {                                                                                \
294         if (panel.update_time <= time) {                                                                                \
295                 if (autocvar__hud_configure) panel_enabled = cvar(strcat("hud_panel_", panel.panel_name));                  \
296                 panel_pos = stov(cvar_string(strcat("hud_panel_", panel.panel_name, "_pos")));                              \
297                 panel_size = stov(cvar_string(strcat("hud_panel_", panel.panel_name, "_size")));                            \
298                 HUD_Panel_ScalePosSize();                                                                                   \
299                 panel_bg_str = cvar_string(strcat("hud_panel_", panel.panel_name, "_bg"));                                  \
300                 panel_bg_color_str = cvar_string(strcat("hud_panel_", panel.panel_name, "_bg_color"));                      \
301                 panel_bg_color_team_str = cvar_string(strcat("hud_panel_", panel.panel_name, "_bg_color_team"));            \
302                 panel_bg_alpha_str = cvar_string(strcat("hud_panel_", panel.panel_name, "_bg_alpha"));                      \
303                 panel_bg_border_str = cvar_string(strcat("hud_panel_", panel.panel_name, "_bg_border"));                    \
304                 panel_bg_padding_str = cvar_string(strcat("hud_panel_", panel.panel_name, "_bg_padding"));                  \
305                 HUD_Panel_GetBg();                                                                                          \
306                 if (panel.current_panel_bg != "0") {                                                                        \
307                         HUD_Panel_GetColorTeam();                                                                               \
308                         HUD_Panel_GetColor();                                                                                   \
309                         HUD_Panel_GetBgAlpha();                                                                                 \
310                         HUD_Panel_GetBorder();                                                                                  \
311                 }                                                                                                           \
312                 HUD_Panel_GetFgAlpha();                                                                                     \
313                 HUD_Panel_GetPadding();                                                                                     \
314                 panel.current_panel_bg_alpha = panel_bg_alpha;                                                              \
315                 panel.current_panel_fg_alpha = panel_fg_alpha;                                                              \
316                 if (menu_enabled == 2 && panel == highlightedPanel) {                                                       \
317                         HUD_Panel_UpdatePosSize_ForMenu();                                                                      \
318                 } else {                                                                                                    \
319                         panel_bg_alpha *= hud_fade_alpha;                                                                       \
320                         panel_fg_alpha *= hud_fade_alpha;                                                                       \
321                 }                                                                                                           \
322                 panel.current_panel_pos = panel_pos;                                                                        \
323                 panel.current_panel_size = panel_size;                                                                      \
324                 panel.current_panel_bg_border = panel_bg_border;                                                            \
325                 panel.current_panel_bg_color = panel_bg_color;                                                              \
326                 panel.current_panel_bg_color_team = panel_bg_color_team;                                                    \
327                 panel.current_panel_bg_padding = panel_bg_padding;                                                          \
328                 panel.update_time = (autocvar__hud_configure) ? time : time + autocvar_hud_panel_update_interval;           \
329         } else {                                                                                                        \
330                 panel_pos = panel.current_panel_pos;                                                                        \
331                 panel_size = panel.current_panel_size;                                                                      \
332                 panel_bg_alpha = panel.current_panel_bg_alpha * hud_fade_alpha;                                             \
333                 panel_bg_border = panel.current_panel_bg_border;                                                            \
334                 panel_bg_color = panel.current_panel_bg_color;                                                              \
335                 panel_bg_color_team = panel.current_panel_bg_color_team;                                                    \
336                 panel_bg_padding = panel.current_panel_bg_padding;                                                          \
337                 panel_fg_alpha = panel.current_panel_fg_alpha * hud_fade_alpha;                                             \
338         }                                                                                                               \
339 } while(0)
340
341 #define HUD_Panel_UpdatePosSize() do {                                                                              \
342         panel_enabled = cvar(strcat("hud_panel_", panel.panel_name));                                                   \
343         panel_pos = stov(cvar_string(strcat("hud_panel_", panel.panel_name, "_pos")));                                  \
344         panel_size = stov(cvar_string(strcat("hud_panel_", panel.panel_name, "_size")));                                \
345         HUD_Panel_ScalePosSize();                                                                                       \
346         if (menu_enabled == 2 && panel == highlightedPanel) {                                                           \
347                 HUD_Panel_UpdatePosSize_ForMenu();                                                                          \
348         }                                                                                                               \
349         panel_bg_border_str = cvar_string(strcat("hud_panel_", panel.panel_name, "_bg_border"));                        \
350         HUD_Panel_GetBorder();                                                                                          \
351 } while(0)
352
353 const int NOTIFY_MAX_ENTRIES = 10;
354 const float NOTIFY_ICON_MARGIN = 0.02;
355
356 int notify_index;
357 int notify_count;
358 float notify_times[NOTIFY_MAX_ENTRIES];
359 string notify_attackers[NOTIFY_MAX_ENTRIES];
360 string notify_victims[NOTIFY_MAX_ENTRIES];
361 string notify_icons[NOTIFY_MAX_ENTRIES];
362
363 void HUD_Notify_Push(string icon, string attacker, string victim);
364
365 var void HUD_ModIcons_GameType(vector pos, vector size);
366 void HUD_ModIcons_SetFunc();
367 #endif