debug.qh File Reference

#include <client/draw.qh>
#include <client/view.qh>
#include <common/resources/cl_resources.qh>

Include dependency graph for debug.qh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	DebugText3d

Macros
#define	debug_text_3d(...)
#define	debug_text_3d_2(pos, msg)
#define	debug_text_3d_3(pos, msg, align)
#define	debug_text_3d_4(pos, msg, align, dur)
#define	debug_text_3d_5(pos, msg, align, dur, vel)

Functions
bool	debug_send (entity this, entity to, int sf)
ERASEABLE void	debug_text_3d_fn (vector pos, string msg, float align, float duration, vector vel)
	GENERIC_COMMAND (bufstr_get, "Examine a string buffer object", false)
	GENERIC_COMMAND (cvar_localchanges, "Print locally changed cvars", false)
	GENERIC_COMMAND (findat, "Search through entities for matching origin", false)
	GENERIC_COMMAND (findent, "Search through entities for matching classname", false)
	GENERIC_COMMAND (version, "Print the current version", false)
	NET_HANDLE (debug_text_3d, bool is_new)
	NET_HANDLE (net_debug, bool isNew)
	REGISTER_NET_TEMP (debug_text_3d)
	void (float bufhandle, string pattern, string antipattern) buf_cvarlist

Variables
bool	debug
int	sv_entnum
entity	tag_entity

Macro Definition Documentation

debug_text_3d

#define debug_text_3d

(

...

)

Value:

EVAL(OVERLOAD(debug_text_3d, __VA_ARGS__))

Definition at line 486 of file debug.qh.

Referenced by debug_text_3d_fn(), NET_HANDLE(), REGISTER_NET_TEMP(), and show_entnum().

debug_text_3d_2

#define debug_text_3d_2	(		pos,
			msg )

Value:

debug_text_3d_3(pos, msg, cvar("debug_text_3d_default_align"))

Definition at line 487 of file debug.qh.

debug_text_3d_3

#define debug_text_3d_3	(		pos,
			msg,
			align )

Value:

debug_text_3d_4(pos, msg, align, cvar("debug_text_3d_default_duration"))

Definition at line 488 of file debug.qh.

debug_text_3d_4

#define debug_text_3d_4	(		pos,
			msg,
			align,
			dur )

Value:

debug_text_3d_5(pos, msg, align, dur, stov(cvar_string("debug_text_3d_default_velocity")))

Definition at line 489 of file debug.qh.

debug_text_3d_5

#define debug_text_3d_5	(		pos,
			msg,
			align,
			dur,
			vel )

Value:

debug_text_3d_fn(pos, msg, align, dur, vel)

Definition at line 490 of file debug.qh.

Function Documentation

debug_send()

bool debug_send	(	entity	this,
		entity	to,
		int	sf )

Definition at line 42 of file debug.qh.

    {
        int channel = MSG_ONE;
        msg_entity = to;
        WriteHeader(channel, net_debug);
        WriteShort(channel, etof(this));
        WriteByte(channel, is_pure(this));
        vector o = this.origin;
        if (o == '0 0 0') // brushes
            o = (this.absmin + this.absmax) * 0.5;
        if (this.tag_entity)
            o += this.tag_entity.origin;
        WriteVector(channel, o);
        WriteString(channel, this.classname);
        WriteString(channel, this.sourceLoc);
        return true;
    }

References absmax, absmin, classname, entity(), etof, is_pure, msg_entity, MSG_ONE, origin, sourceLoc, tag_entity, vector, WriteByte(), WriteHeader, WriteShort(), and WriteString().

debug_text_3d_fn()

ERASEABLE void debug_text_3d_fn	(	vector	pos,
		string	msg,
		float	align,
		float	duration,
		vector	vel )

Definition at line 493 of file debug.qh.

                                                                                       {
    WriteHeader(MSG_BROADCAST, debug_text_3d);
    WriteVector(MSG_BROADCAST, pos);
    WriteString(MSG_BROADCAST, msg);
    WriteFloat(MSG_BROADCAST, align);
    WriteFloat(MSG_BROADCAST, duration);
    WriteVector(MSG_BROADCAST, vel);
}

References debug_text_3d, MSG_BROADCAST, vector, WriteHeader, and WriteString().

GENERIC_COMMAND() [1/5]

GENERIC_COMMAND	(	bufstr_get	,
		"Examine a string buffer object"	,
		false	)

Definition at line 201 of file debug.qh.

{
    switch (request)
    {
        case CMD_REQUEST_COMMAND:
        {
            int bufhandle = stof(argv(1));
            int string_index = stof(argv(2));
            LOG_INFO(bufstr_get(bufhandle, string_index));
            return;
        }
 
        default:
        case CMD_REQUEST_USAGE:
        {
            LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " bufstr_get <bufhandle> <string_index>");
            return;
        }
    }
}

References argv(), CMD_REQUEST_COMMAND, CMD_REQUEST_USAGE, GetProgramCommandPrefix, LOG_HELP, LOG_INFO, and stof().

GENERIC_COMMAND() [2/5]

GENERIC_COMMAND	(	cvar_localchanges	,
		"Print locally changed cvars"	,
		false	)

Definition at line 246 of file debug.qh.

{
    switch (request)
    {
        case CMD_REQUEST_COMMAND:
        {
            string s = "";
            int h = buf_create();
            buf_cvarlist(h, "", "_"); // exclude all _ cvars as they are temporary
            int n = buf_getsize(h);
            for (int i = 0; i < n; ++i) {
                string k = bufstr_get(h, i);
                string v = cvar_string(k);
                string d = cvar_defstring(k);
                if (v == d)
                    continue;
                s = strcat(s, k, " \"", v, "\" // \"", d, "\"\n");
            }
            buf_del(h);
            LOG_INFO(s);
            return;
        }
        default:
        case CMD_REQUEST_USAGE:
        {
            LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " cvar_localchanges");
            return;
        }
    }
}

References buf_create, CMD_REQUEST_COMMAND, CMD_REQUEST_USAGE, cvar_defstring(), cvar_string(), GetProgramCommandPrefix, LOG_HELP, LOG_INFO, and strcat().

GENERIC_COMMAND() [3/5]

GENERIC_COMMAND	(	findat	,
		"Search through entities for matching origin"	,
		false	)

Definition at line 369 of file debug.qh.

{
    switch (request)
    {
        case CMD_REQUEST_COMMAND:
        {
            vector org = stov(argv(1));
            float dist = stof(argv(2));
            int entcnt = 0;
            FOREACH_ENTITY_ORDERED(true,
            {
                if (dist > 0)
                {
                    if (!vdist(it.origin - org, <, dist))
                        continue;
                }
                else if (it.origin != org)
                    continue;
                LOG_HELPF("%i (%s)", it, it.classname);
                ++entcnt;
            });
            if(entcnt)
                LOG_HELPF("Found %d entities", entcnt);
            return;
        }
 
        default:
            LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
        case CMD_REQUEST_USAGE:
        {
            LOG_HELP("Usage:^3 " GetProgramCommandPrefix() " findat <position> [<dist>]");
            LOG_HELP("  Where <position> is a vector \"x y z\"");
            return;
        }
    }
}

References argv(), CMD_REQUEST_COMMAND, CMD_REQUEST_USAGE, FOREACH_ENTITY_ORDERED, GetProgramCommandPrefix, LOG_HELP, LOG_HELPF, LOG_INFOF, org, stof(), stov(), vdist, and vector.

GENERIC_COMMAND() [4/5]

GENERIC_COMMAND	(	findent	,
		"Search through entities for matching classname"	,
		false	)

Definition at line 340 of file debug.qh.

{
    switch (request)
    {
        case CMD_REQUEST_COMMAND:
        {
            int entcnt = 0;
            FOREACH_ENTITY_CLASS_ORDERED(argv(1), true,
            {
                LOG_HELPF("%i (%s)", it, it.classname);
                ++entcnt;
            });
            if(entcnt)
                LOG_HELPF("Found %d entities", entcnt);
            return;
        }
 
        default:
            LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
        case CMD_REQUEST_USAGE:
        {
            LOG_HELP("Usage:^3 " GetProgramCommandPrefix() " find <classname>");
            LOG_HELP("  Where <classname> is the classname to search for.");
            return;
        }
    }
}

References argv(), CMD_REQUEST_COMMAND, CMD_REQUEST_USAGE, FOREACH_ENTITY_CLASS_ORDERED, GetProgramCommandPrefix, LOG_HELP, LOG_HELPF, and LOG_INFOF.

GENERIC_COMMAND() [5/5]

GENERIC_COMMAND	(	version	,
		"Print the current version"	,
		false	)

Definition at line 223 of file debug.qh.

{
    switch (request)
    {
        case CMD_REQUEST_COMMAND:
        {
            LOG_INFO(PROGNAME, " version: ", WATERMARK);
            return;
        }
        default:
        case CMD_REQUEST_USAGE:
        {
            LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " version");
            return;
        }
    }
}

References CMD_REQUEST_COMMAND, CMD_REQUEST_USAGE, GetProgramCommandPrefix, LOG_HELP, LOG_INFO, and PROGNAME.

NET_HANDLE() [1/2]

NET_HANDLE	(	debug_text_3d	,
		bool	is_new )

Definition at line 471 of file debug.qh.

                                       {
    vector pos = ReadVector();
    string msg = ReadString();
    float align = ReadFloat();
    float duration = ReadFloat();
    vector vel = ReadVector();
    make_impure(NEW(DebugText3d, pos, msg, align, 1 / duration, vel));
    return true;
}

References debug_text_3d, make_impure, NET_HANDLE, NEW, ReadFloat, ReadString, ReadVector, and vector.

NET_HANDLE() [2/2]

NET_HANDLE	(	net_debug	,
		bool	isNew )

Definition at line 27 of file debug.qh.

    {
        Net_Accept(net_debug);
        this.sv_entnum = ReadShort();
        if (ReadByte()) make_pure(this);
        this.origin = ReadVector();
        setorigin(this, this.origin);
        this.debug = true;  // identify server entities by this
        this.classname = strzone(ReadString());
        this.sourceLoc = strzone(ReadString());
        return true;
    }

References classname, debug, make_pure, Net_Accept, origin, ReadByte(), ReadString, ReadVector, sourceLoc, strzone(), and sv_entnum.

REGISTER_NET_TEMP()

REGISTER_NET_TEMP

(

debug_text_3d

)

References debug_text_3d.

void()

void	(	float	bufhandle,
		string	pattern,
		string	antipattern )

Variable Documentation

debug

bool debug

Definition at line 21 of file debug.qh.

Referenced by NET_HANDLE().

sv_entnum

int sv_entnum

Definition at line 22 of file debug.qh.

tag_entity

entity tag_entity

Definition at line 16 of file debug.qh.