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.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 3784667cb..e69cca6b1 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -5286,6 +5286,10 @@ This command will destroy whatever is currently equipped in the invoking
character's specified equipment slot. For a full list of possible equipment
slots see 'getequipid'.
+It is always a good idea to check if the player actually has the item you want
+before you use this command. If you try to delete in a position that the player
+has no gear, script will be terminated with an error.
+
This command will return 1 if an item was deleted and 0 otherwise.
---------------------------------------