Hosting and domain costs until October 2024 have been generously sponsored by dumptruck_ds. Thank you!

Difference between revisions of "dprint"

From Quake Wiki

(Created page with "====Syntax:==== <code>void dprint(string s)</code> Similar to bprint, dprint broadcasts text to all players in the map but only when the '''developer''' console variable is s...")
 
 
Line 1: Line 1:
====Syntax:====
+
''void'' '''dprint'''(''string'' msg)
<code>void dprint(string s)</code>
 
  
Similar to bprint, dprint broadcasts text to all players in the map but only when the '''developer''' console variable is set to 1. This is used for debugging mods.
+
== Usage ==
====Parameters:====
+
Broadcasts a message to all players in the game, but they will only see it if the '''developer''' console variable is set to 1. This is mainly for debugging purposes. Messages will continue to print on the same line until a '''\n''' character is placed, allowing chaining of calls to print to the same line.
:<code>s</code> - The string to print.
 
====Returns:====
 
:void
 
  
 +
This builtin has special functionality in that it can accept an unlimited number of string arguments (with a cap of 255 characters in a string). Multiple versions of the builtin can be assigned to the same index with as many additional string arguments as needed e.g.
 +
    void dprint3(string start, string middle, string end) = #25;
 +
This can allow for easily inserting numbers into the middle of the string since normally this would require a chain of multiple calls to do.
 +
dprint3("Total steps: ", ftos(self.stepCount), "\n");
 +
will display as "Total steps: 5" if <code>self.stepCount</code> is 5.
 +
 +
=== Parameters ===
 +
*''msg''
 +
:The message to display.
 +
 +
== Example ==
 +
// Print a debug message if the target provided was invalid
 +
if (self.target)
 +
{
 +
    entity pathNode = find(world, targetname, self.target);
 +
    if (!pathNode)
 +
    {
 +
        dprint("Couldn't find target path node\n");
 +
    }
 +
    else
 +
    {
 +
        // ...
 +
    }
 +
}
  
 
[[Category:QuakeC Function]]
 
[[Category:QuakeC Function]]

Latest revision as of 18:22, 31 July 2023

void dprint(string msg)

Usage[edit]

Broadcasts a message to all players in the game, but they will only see it if the developer console variable is set to 1. This is mainly for debugging purposes. Messages will continue to print on the same line until a \n character is placed, allowing chaining of calls to print to the same line.

This builtin has special functionality in that it can accept an unlimited number of string arguments (with a cap of 255 characters in a string). Multiple versions of the builtin can be assigned to the same index with as many additional string arguments as needed e.g.

    void dprint3(string start, string middle, string end) = #25;

This can allow for easily inserting numbers into the middle of the string since normally this would require a chain of multiple calls to do.

dprint3("Total steps: ", ftos(self.stepCount), "\n");

will display as "Total steps: 5" if self.stepCount is 5.

Parameters[edit]

  • msg
The message to display.

Example[edit]

// Print a debug message if the target provided was invalid
if (self.target)
{
    entity pathNode = find(world, targetname, self.target);
    if (!pathNode)
    {
        dprint("Couldn't find target path node\n");
    }
    else
    {
        // ...
    }
}