summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorgumi <git@gumi.ca>2018-07-25 14:27:17 -0400
committergumi <git@gumi.ca>2018-07-28 09:52:17 -0400
commit5b62115128f5836d692b9b0305950a5ef7393306 (patch)
tree4fe6cae55f00f21f0350d4ccbe62cd97231b3c25 /doc/script_commands.txt
parentac30e506304c3e31805cbea313faac1d7625fdbb (diff)
downloadhercules-5b62115128f5836d692b9b0305950a5ef7393306.tar.gz
hercules-5b62115128f5836d692b9b0305950a5ef7393306.tar.bz2
hercules-5b62115128f5836d692b9b0305950a5ef7393306.tar.xz
hercules-5b62115128f5836d692b9b0305950a5ef7393306.zip
update the documentation for debugmes
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt16
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 44937a34d..9ab5e3f65 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -7663,15 +7663,19 @@ solution rather than sending the map and the monster_id.
//=====================================
---------------------------------------
-*debugmes("<message>")
+*debugmes("<format string>"{, <param>{, ...}})
+
+This command will print a message in the server console (map-server window),
+after applying the same format-string replacements as sprintf(). It will not be
+displayed anywhere else. Returns true on success.
+
+Example:
-This command will send the message to the server console (map-server
-window). It will not be displayed anywhere else.
-//
// Displays "NAME has clicked me!" in the map-server window.
- debugmes(strcharinfo(PC_NAME)+" has clicked me!");
+ debugmes("%s has clicked me!", strcharinfo(PC_NAME));
+
+ debugmes("\033[0;32mHello World"); // supports ANSI escape sequences
- debugmes("\033[38D\033[K ==Message== \n"); // enable colour code.
---------------------------------------
*logmes("<message>"{, <log type>})