summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt58
1 files changed, 47 insertions, 11 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 10b4e5653..4c5dab969 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -1976,18 +1976,35 @@ prontera,150,150,0 script TestNPC 123,{
*is_function("<function name>")
-This command checks whether a function exists.
-It returns 1 if function is found, or 0 if it isn't.
+This command checks whether or not a function exists and returns its type.
+Returns false if it cannot be found.
+
+return values:
+
+ FUNCTION_IS_COMMAND - built-in script command (eg: mes, select, ...)
+ FUNCTION_IS_GLOBAL - user-defined global function (callable with callfunc)
+ FUNCTION_IS_LOCAL - user-defined local function
+ FUNCTION_IS_LABEL - user-defined label function (callable with callsub)
Example:
- function script try {
+ function script func1 {
dothat();
}
- script test FAKE_NPC,{
- .@try = is_function("try"); // 1
- .@not = is_function("notafunction"); // 0
+ function func2 {
+ do_something();
+ }
+
+ func3:
+ end;
+
+ is_function("func1"); // FUNCTION_IS_GLOBAL
+ is_function("func2"); // FUNCTION_IS_LOCAL
+ is_function("func3"); // FUNCTION_IS_LABEL
+ is_function("select"); // FUNCTION_IS_COMMAND
+ is_function("invalid"); // false
}
---------------------------------------
@@ -7662,15 +7679,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>})
@@ -10136,3 +10157,18 @@ the available flags are:
Opens the styling shop on client
---------------------------------------
+
+*msgtable(<message_id>{, <color>})
+
+Show in client message by <message_id> from msg string table
+with optional <color>.
+
+---------------------------------------
+
+*msgtable2(<message_id>, <param>{, <color>})
+
+Show in client message by <message_id> from msg string table.
+<param> is parameter for this message. Can be string or int.
+Optional <color> can be used for set color for whole message.
+
+---------------------------------------