summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorai4rei <ai4rei@54d463be-8e91-2dee-dedb-b68131a5f0ec>2011-07-09 18:45:22 +0000
committerai4rei <ai4rei@54d463be-8e91-2dee-dedb-b68131a5f0ec>2011-07-09 18:45:22 +0000
commit201d8bb6a488ad6ef7eed4c46ad14228d543b71d (patch)
treef0a95a535ed7bb1552b47f6eece77e2712f3d4f7 /doc/script_commands.txt
parentab9b60f5c4501eb8d7bec4a053d73fc723ea31b5 (diff)
downloadhercules-201d8bb6a488ad6ef7eed4c46ad14228d543b71d.tar.gz
hercules-201d8bb6a488ad6ef7eed4c46ad14228d543b71d.tar.bz2
hercules-201d8bb6a488ad6ef7eed4c46ad14228d543b71d.tar.xz
hercules-201d8bb6a488ad6ef7eed4c46ad14228d543b71d.zip
* Added script command 'getmercinfo' for retrieving information about a mercenary of an online character.
git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@14894 54d463be-8e91-2dee-dedb-b68131a5f0ec
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt25
1 files changed, 24 insertions, 1 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 621438e4a..42ccbcbbe 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -4,7 +4,7 @@
//= A reference manual for the eAthena scripting language.
//= Commands are sorted depending on their functionality.
//===== Version ===========================================
-//= 3.44.20110530
+//= 3.45.20110709
//=========================================================
//= 1.0 - First release, filled will as much info as I could
//= remember or figure out, most likely there are errors,
@@ -179,6 +179,8 @@
//= cashshops as well. [Ai4rei]
//= 3.44.20110530
//= Documented special map names recognized by 'warpguild'. [Ai4rei]
+//= 3.45.20110709
+//= Added 'getmercinfo' command. [Ai4rei]
//=========================================================
This document is a reference manual for all the scripting commands and functions
@@ -7172,5 +7174,26 @@ attached character. Guild can be one or the following constants:
---------------------------------------
+*getmercinfo(<type>{,<char id>});
+
+Retrieves information about mercenary of the currently attached
+character. If char id is given, the information of that character is
+retrieved instead. Type specifies what information to retrieve and
+can be one of the following:
+
+ 0 - Database ID
+ 1 - Class
+ 2 - Name
+ 3 - Faith value for this mercenary's guild, if any
+ 4 - Calls value for this mercenary's guild, if any
+ 5 - Kill count
+ 6 - Remaining life time in msec
+ 7 - Level
+
+If the character does not have a mercenary, the command returns ""
+for name and 0 for all other types.
+
+----------------------------------------
+
Whew.
That's about all of them.