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

Difference between revisions of "sprint"

From Quake Wiki

 
Line 1: Line 1:
====Syntax:====
+
''void'' '''sprint'''(''entity'' player, ''string'' msg)
<code>void sprint(entity client, string s)</code>
 
  
Sends text to a single player. This is used by items to display pickup text.  '''client''' must be a player. It is, essentially, a MSG_ONE SVC_PRINT. Like [[bprint]] the function can be overloaded to support several string parameters.
+
== Usage ==
====Parameters:====
+
Prints a message to a specific player. 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>client</code> - The client to print the string to.
 
:<code>s</code> - The string to print.
 
====Returns:====
 
:void
 
====Example====
 
  
  sprint(self, self.netname);
+
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 sprint3(entity player, string start, string middle, string end) = #24;
 +
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.
 +
  sprint3(player, "You've found ", ftos(self.count), " switches\n");
 +
will display as "You've found 4 switches" if <code>self.count</code> is 4.
  
 +
=== Parameters ===
 +
*''player''
 +
:The player to send the message to.
 +
*''msg''
 +
:The message to display.
 +
 +
== Example ==
 +
// Send a pick up message to the player that picked up the item
 +
if (other.flags & FL_CLIENT)
 +
{
 +
    sprint(other, "You picked up the ");
 +
    sprint(other, self.netname);
 +
    sprint(other, "\n");
 +
}
  
 
[[Category:QuakeC Function]]
 
[[Category:QuakeC Function]]

Latest revision as of 18:12, 31 July 2023

void sprint(entity player, string msg)

Usage[edit]

Prints a message to a specific player. 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 sprint3(entity player, string start, string middle, string end) = #24;

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.

sprint3(player, "You've found ", ftos(self.count), " switches\n");

will display as "You've found 4 switches" if self.count is 4.

Parameters[edit]

  • player
The player to send the message to.
  • msg
The message to display.

Example[edit]

// Send a pick up message to the player that picked up the item
if (other.flags & FL_CLIENT)
{
    sprint(other, "You picked up the ");
    sprint(other, self.netname);
    sprint(other, "\n");
}