4 #include <client/resources.qh>
8 // This includes some functions useful for debugging.
9 // Some more bot-specific ones are in server/pathlib/debug.qc.
10 // Look for other useful commands under prvm_* in console (apropos / search).
21 REGISTER_NET_TEMP(net_debug)
25 NET_HANDLE(net_debug, bool isNew)
27 Net_Accept(net_debug);
28 this.sv_entnum = ReadShort();
29 if (ReadByte()) make_pure(this);
30 this.origin = ReadVector();
31 setorigin(this, this.origin);
32 this.debug = true; // identify server entities by this
33 this.classname = strzone(ReadString());
34 this.sourceLoc = strzone(ReadString());
40 bool debug_send(entity this, entity to, int sf)
42 int channel = MSG_ONE;
44 WriteHeader(channel, net_debug);
45 WriteShort(channel, etof(this));
46 WriteByte(channel, is_pure(this));
47 vector o = this.origin;
48 if (o == '0 0 0') // brushes
49 o = (this.absmin + this.absmax) / 2;
51 o += this.tag_entity.origin;
52 WriteVector(channel, o);
53 WriteString(channel, this.classname);
54 WriteString(channel, this.sourceLoc);
66 * 3: on (.entnum != 0)
67 * 4: on (.origin == '0 0 0')
68 * 5: on (.debug != 0), server only
71 bool autocvar_debugdraw;
75 string autocvar_debugdraw_filter, autocvar_debugdraw_filterout;
77 vector project_3d_to_2d(vector vec);
80 if (!autocvar_debugdraw) return;
81 static int debugdraw_frame;
84 FOREACH_ENTITY(true, {
85 if (it.debugdraw_last == debugdraw_frame) continue;
87 FOREACH_ENTITY_RADIUS(it.origin, 100, it.debugdraw_last != debugdraw_frame, {
88 it.debugdraw_last = debugdraw_frame;
89 vector rgb = (it.debug) ? '0 0 1' : '1 0 0';
90 if (autocvar_debugdraw_filterout != "" && strhasword(autocvar_debugdraw_filterout, it.classname)) continue;
91 if (autocvar_debugdraw_filter != "" && !strhasword(autocvar_debugdraw_filter, it.classname)) continue;
92 if (autocvar_debugdraw == 3)
94 if (!it.entnum) continue;
96 if (autocvar_debugdraw == 4)
98 if (it.origin) continue;
100 if (autocvar_debugdraw == 5)
102 if (!it.debug) continue;
104 else if (autocvar_debugdraw > 5)
108 // if (it.modelindex) break;
109 // if (it.absmin) break;
110 // if (it.absmax) break;
111 // if (it.entnum) break;
112 // if (it.drawmask) break;
113 // if (it.predraw) break;
114 // if (it.move_movetype) break;
116 // if (it.origin) break;
117 // if (it.oldorigin) break;
118 // if (it.velocity) break;
119 // if (it.angles) break;
120 // if (it.avelocity) break;
121 // if (it.classname) break;
122 // if (it.model) break;
123 // if (it.frame) break;
124 // if (it.skin) break;
125 // if (it.effects) break;
126 // if (it.mins) break;
127 // if (it.maxs) break;
128 // if (it.size) break;
129 // if (it.touch) break;
130 // if (it.use) break;
131 // if (it.think) break;
132 // if (it.blocked) break;
133 // if (it.nextthink) break;
134 // if (it.chain) break;
135 // if (it.netname) break;
136 // if (it.enemy) break;
137 // if (it.flags) break;
138 // if (it.colormap) break;
139 // if (it.owner) break;
144 else if (is_pure(it))
146 if (autocvar_debugdraw < 2) continue;
149 vector o = it.origin;
151 o += it.tag_entity.origin;
152 vector pos = project_3d_to_2d(o);
153 if (pos.z < 0) continue;
156 drawcolorcodedstring2_builtin(pos,
157 sprintf("%d: '%s'@%s", (it.debug ? it.sv_entnum : etof(it)),
158 it.classname, it.sourceLoc),
159 sz * '1 1 0', rgb, 0.5, DRAWFLAG_NORMAL);
167 COMMON_COMMAND(debugdraw_sv, "Dump all server entities")
171 case CMD_REQUEST_COMMAND:
173 if (!autocvar_debugdraw) return;
176 for (entity e = NULL; (e = findfloat(e, debug, 0)) && rem > 0; )
178 if (autocvar_debugdraw < 2 && is_pure(e)) continue;
179 debug_send(e, caller, 0);
183 LOG_INFOF("%d server entities sent", n - rem);
188 case CMD_REQUEST_USAGE:
190 LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " debugdraw_sv");
196 #endif // ENABLE_DEBUGDRAW
199 GENERIC_COMMAND(bufstr_get, "Examine a string buffer object", false)
203 case CMD_REQUEST_COMMAND:
205 int bufhandle = stof(argv(1));
206 int string_index = stof(argv(2));
207 LOG_INFO(bufstr_get(bufhandle, string_index));
212 case CMD_REQUEST_USAGE:
214 LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " bufstr_get bufhandle string_index");
221 GENERIC_COMMAND(version, "Print the current version", false)
225 case CMD_REQUEST_COMMAND:
227 LOG_INFO(PROGNAME, " version: ", WATERMARK);
231 case CMD_REQUEST_USAGE:
233 LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " version");
241 void(float bufhandle, string pattern, string antipattern) buf_cvarlist = #517;
244 GENERIC_COMMAND(cvar_localchanges, "Print locally changed cvars", false)
248 case CMD_REQUEST_COMMAND:
251 int h = buf_create();
252 buf_cvarlist(h, "", "_"); // exclude all _ cvars as they are temporary
253 int n = buf_getsize(h);
254 for (int i = 0; i < n; ++i) {
255 string k = bufstr_get(h, i);
256 string v = cvar_string(k);
257 string d = cvar_defstring(k);
260 s = strcat(s, k, " \"", v, "\" // \"", d, "\"\n");
267 case CMD_REQUEST_USAGE:
269 LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " cvar_localchanges");
276 #if ENABLE_DEBUGTRACE
277 REGISTER_STAT(TRACE_ENT, int)
280 bool autocvar_debugtrace;
282 REGISTER_MUTATOR(trace, autocvar_debugtrace);
284 .bool debug_trace_button;
286 MUTATOR_HOOKFUNCTION(trace, SV_StartFrame)
288 FOREACH_CLIENT(true, {
290 bool btn = PHYS_INPUT_BUTTON_HOOK(it);
291 if (btn == it.debug_trace_button) skip = true;
292 it.debug_trace_button = btn;
293 if (!btn || skip) continue;
294 FOREACH_ENTITY(true, {
295 it.solid_prev = it.solid;
296 it.solid = SOLID_BBOX;
298 vector forward = '0 0 0'; vector right = '0 0 0'; vector up = '0 0 0';
299 MAKE_VECTORS(it.v_angle, forward, right, up);
300 vector pos = it.origin + it.view_ofs;
301 traceline(pos, pos + forward * max_shot_distance, MOVE_NORMAL, it);
302 FOREACH_ENTITY(true, {
303 it.solid = it.solid_prev;
306 entity e = trace_ent;
308 STAT(TRACE_ENT, it) = i;
310 setorigin(e, e.origin + '0 0 100');
311 stuffcmd(it, sprintf("prvm_edict server %d\n", i));
318 void Trace_draw2d(entity this)
320 int e = STAT(TRACE_ENT);
322 vector pos = '0 0 0';
323 pos.y += vid_conheight / 2;
324 drawstring(pos, sprintf("prvm_edict server %d", e), '10 10 0', '1 1 1', 1, DRAWFLAG_NORMAL);
327 STATIC_INIT(TRACE_ENT)
329 entity e = TRACE_ENT = new_pure(TRACE_ENT);
330 e.draw2d = Trace_draw2d;
331 IL_PUSH(g_drawables_2d, e);
338 GENERIC_COMMAND(find, "Search through entities for matching classname", false)
342 case CMD_REQUEST_COMMAND:
345 FOREACH_ENTITY_CLASS_ORDERED(argv(1), true,
347 LOG_INFOF("%i (%s)", it, it.classname);
351 LOG_INFOF("Found %d entities", entcnt);
357 LOG_INFO("Incorrect parameters for ^2find^7");
359 case CMD_REQUEST_USAGE:
361 LOG_INFO("Usage:^3 " GetProgramCommandPrefix() " find classname");
362 LOG_INFO(" Where 'classname' is the classname to search for.");
369 GENERIC_COMMAND(findat, "Search through entities for matching origin", false)
373 case CMD_REQUEST_COMMAND:
375 vector match = stov(argv(1));
376 FOREACH_ENTITY_ORDERED(it.origin == match, LOG_INFOF("%i (%s)", it, it.classname));
381 LOG_INFO("Incorrect parameters for ^2findat^7");
382 case CMD_REQUEST_USAGE:
384 LOG_INFO("Usage:^3 " GetProgramCommandPrefix() " findat \"0 0 0\"");
391 // debug_test() allows drawing text from server on the client anywhere in world coordinates.
394 REGISTER_NET_TEMP(debug_text_3d);
399 CLASS(DebugText3d, Object)
400 // reusing existing fields
401 ATTRIB(DebugText3d, origin, vector);
402 ATTRIB(DebugText3d, message, string); // the text (i wanted to use the .text field but then this whole macro-based-inheritance thing shat itself)
403 ATTRIB(DebugText3d, health, float); // text alignment (recycled field)
404 ATTRIB(DebugText3d, hit_time, float); // when it was created
405 ATTRIB(DebugText3d, fade_rate, float); // how fast it should disappear
406 ATTRIB(DebugText3d, velocity, vector);
408 CONSTRUCTOR(DebugText3d, vector pos, string msg, float align, float fade_rate_, vector vel) {
409 CONSTRUCT(DebugText3d);
411 this.message = strzone(msg);
412 SetResource(this, RES_HEALTH, align);
413 this.hit_time = time;
414 this.fade_rate = fade_rate_;
416 IL_PUSH(g_drawables_2d, this);
419 DESTRUCTOR(DebugText3d) {
420 strfree(this.message);
423 void DebugText3d_draw2d(DebugText3d this) {
424 float since_created = time - this.hit_time;
425 float alpha_ = 1 - since_created * this.fade_rate;
433 vector screen_pos = project_3d_to_2d(this.origin) + since_created * this.velocity;
434 if (screen_pos.z < 0) return; // behind camera
437 float align = GetResource(this, RES_HEALTH);
441 int n = tokenizebyseparator(this.message, "\n");
442 for(int k = 0; k < n; ++k)
445 msg_pos = screen_pos + k * 1.25 * size * eY;
447 msg_pos.x -= stringwidth(msg, true, size * '1 1 0') * min(1, align);
449 drawcolorcodedstring_builtin(msg_pos, msg, size * '1 1 0', alpha_, DRAWFLAG_NORMAL);
452 ATTRIB(DebugText3d, draw2d, void(DebugText3d), DebugText3d_draw2d);
453 ENDCLASS(DebugText3d)
455 NET_HANDLE(debug_text_3d, bool is_new) {
456 vector pos = ReadVector();
457 string msg = ReadString();
458 float align = ReadFloat();
459 float duration = ReadFloat();
460 vector vel = ReadVector();
461 make_impure(NEW(DebugText3d, pos, msg, align, 1 / duration, vel));
469 // can't use autocvars because they give unused warning unless the macros are expanded
470 #define debug_text_3d(...) EVAL(OVERLOAD(debug_text_3d, __VA_ARGS__))
471 #define debug_text_3d_2(pos, msg) debug_text_3d_3(pos, msg, cvar("debug_text_3d_default_align"))
472 #define debug_text_3d_3(pos, msg, align) debug_text_3d_4(pos, msg, align, cvar("debug_text_3d_default_duration"))
473 #define debug_text_3d_4(pos, msg, align, dur) debug_text_3d_5(pos, msg, align, dur, stov(cvar_string("debug_text_3d_default_velocity")))
474 #define debug_text_3d_5(pos, msg, align, dur, vel) debug_text_3d_fn(pos, msg, align, dur, vel)
477 void debug_text_3d_fn(vector pos, string msg, float align, float duration, vector vel) {
478 WriteHeader(MSG_BROADCAST, debug_text_3d);
479 WriteVector(MSG_BROADCAST, pos);
480 WriteString(MSG_BROADCAST, msg);
481 WriteFloat(MSG_BROADCAST, align);
482 WriteFloat(MSG_BROADCAST, duration);
483 WriteVector(MSG_BROADCAST, vel);