summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnnieRuru <jeankof@ymail.com>2015-11-17 05:28:16 +0800
committerAnnieRuru <jeankof@ymail.com>2015-11-17 05:28:16 +0800
commitd90c00ef4641e7809df15960d318e67e2414abb2 (patch)
treec0ef4ff3fce37528e56e6f4581aa0fe5c3e56da1
parent44a79fd2d56ca8c9ec0a13eb3ce206d940e0d4ae (diff)
downloadhercules-d90c00ef4641e7809df15960d318e67e2414abb2.tar.gz
hercules-d90c00ef4641e7809df15960d318e67e2414abb2.tar.bz2
hercules-d90c00ef4641e7809df15960d318e67e2414abb2.tar.xz
hercules-d90c00ef4641e7809df15960d318e67e2414abb2.zip
Add some FAQ documentation that some script command can return value
- getitemname can return "null" - getmapusers can return -1 and fix the bad ... misleading global function example
-rw-r--r--doc/script_commands.txt3
-rw-r--r--npc/other/Global_Functions.txt8
2 files changed, 7 insertions, 4 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index dff4461af..f5fdab851 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -2777,6 +2777,7 @@ See 'getequipid' for a full list of valid equipment slots.
Given the database ID number of an item, this function will return the
text stored in the 'japanese name' field (which, in Hercules, stores an
English name the players would normally see on screen).
+Return "null" if no such item exist.
---------------------------------------
@@ -3247,6 +3248,8 @@ Currently being used in the PVP scripts to check if a PVP room is full of
not, if the number returned it equal to the maximum allowed it will not
let you enter.
+Return -1 if the map name is invalid.
+
---------------------------------------
*getareausers({"<map name>",}{<x1>,<y1>,<x2>,<y2>})
diff --git a/npc/other/Global_Functions.txt b/npc/other/Global_Functions.txt
index ff5b78b2d..dc675f8d0 100644
--- a/npc/other/Global_Functions.txt
+++ b/npc/other/Global_Functions.txt
@@ -46,10 +46,10 @@
// Returns a number with commas based on precision of digits and custom separator.
// -- callfunc "F_InsertComma",<number>{,<precision>,<separator>}
// Examples:
-// callfunc("F_InsertComma",7777777{,<precision>,<separator>}) // returns "7,777,777"
-// callfunc("F_InsertComma",1000000000,3,","}) // returns "1,000,000,000"
-// callfunc("F_InsertComma",1000000000,3,"_"}) // returns "1_000_000_000"
-// callfunc("F_InsertComma",1000000000,4) // returns "10,0000,0000"
+// callfunc("F_InsertComma",7777777) // returns "7,777,777"
+// callfunc("F_InsertComma",1000000000,3,",") // returns "1,000,000,000"
+// callfunc("F_InsertComma",1000000000,3,"_") // returns "1_000_000_000"
+// callfunc("F_InsertComma",1000000000,4) // returns "10,0000,0000"
//////////////////////////////////////////////////////////////////////////////////
function script F_InsertComma {
.@value = getarg(0);