summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2013-10-14 03:35:38 +0200
committerHaru <haru@dotalux.com>2013-10-14 03:53:38 +0200
commiteacfb1dcfae1798f23ac8d32c812aab74639f79c (patch)
treed57e71783e204f7b5c0a42561f1e9fad320e4410 /doc/script_commands.txt
parent7ddcff9ae2c45659605c649a0af8bb25539ecade (diff)
downloadhercules-eacfb1dcfae1798f23ac8d32c812aab74639f79c.tar.gz
hercules-eacfb1dcfae1798f23ac8d32c812aab74639f79c.tar.bz2
hercules-eacfb1dcfae1798f23ac8d32c812aab74639f79c.tar.xz
hercules-eacfb1dcfae1798f23ac8d32c812aab74639f79c.zip
Added documentation for addmonsterdrop/delmonsterdrop
Follow-up to 7ddcff9ae2c45659605c649a0af8bb25539ecade Resolves #191 Signed-off-by: Haru <haru@dotalux.com>
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 756efd992..661e84bee 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -3320,6 +3320,39 @@ Check sample in doc/sample/getmonsterinfo.txt
---------------------------------------
+*addmonsterdrop(<mob id or name>, <item id>, <rate>)
+
+This command will temporarily add a drop to an existing monster. If the
+monster already drops the specified item, its drop rate will be updated to the
+given value.
+
+Both the monster and the item must be valid. Acceptable values for the drop
+rate are in the range [1:10000].
+
+Return value will be 1 in case of success (the item was added or its drop rate
+was updated), and 0 otherwise (there were no free item drop slots).
+
+Example:
+ // Add Poring Doll (741) to the Poring's (1002) drops, with 1% (100) rate
+ addmonsterdrop(1002, 741, 100);
+
+---------------------------------------
+
+*delmonsterdrop(<mob id or name>, <item id>)
+
+This command will temporarily remove a drop from an existing monster.
+
+Both the monster and the item must be valid.
+
+Return value will be 1 in case of success (the item was removed), and 0
+otherwise (the monster didn't have the specified item in its drop list).
+
+Example:
+ // Remove Jellopy (909) from the Poring's (1002) drops
+ delmonsterdrop(1002, 909);
+
+---------------------------------------
+
*getmobdrops(<mob id>)
This command will find all drops of the specified mob and return the item