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.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 2a7d4329b..e85b964ef 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -2423,6 +2423,22 @@ Available information types are:
1 - X coordinate
2 - Y coordinate
+ ---------------------------------------
+
+ *getcharip{(<Character Name/Account ID/Char ID>)}
+
+ This function will return the IP address of the currently attached player
+ or the currently attached Character Name/Account ID/Character ID. This command
+ returns a blank str if there is no player attached.
+
+Example 1: Sets the variable, @ip$, into the IP address of currently attached player.
+
+ @ip$ = getcharip;
+
+Example 2: Sets the variable, @ip$, into the IP address of character "Silver".
+
+ @ip$ = getcharip("Silver");
+
---------------------------------------
\\
2,2 Item-related commands