summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorai4rei <ai4rei@54d463be-8e91-2dee-dedb-b68131a5f0ec>2011-04-27 14:32:56 +0000
committerai4rei <ai4rei@54d463be-8e91-2dee-dedb-b68131a5f0ec>2011-04-27 14:32:56 +0000
commit0bb7c7bfc2312ceb33c062f045c087d17382129d (patch)
tree4ece6826d5c162ad2129e6b876c5c3f6e3ff4004 /doc/script_commands.txt
parentf41e10d3301d186f5075168c7d5503b588f7ba33 (diff)
downloadhercules-0bb7c7bfc2312ceb33c062f045c087d17382129d.tar.gz
hercules-0bb7c7bfc2312ceb33c062f045c087d17382129d.tar.bz2
hercules-0bb7c7bfc2312ceb33c062f045c087d17382129d.tar.xz
hercules-0bb7c7bfc2312ceb33c062f045c087d17382129d.zip
* Fixed description for script command 'itemheal' claiming, that this command is responsible for potion visual effects which it is not (item-use causes the client to display these) (since r2397).
git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@14802 54d463be-8e91-2dee-dedb-b68131a5f0ec
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt18
1 files changed, 8 insertions, 10 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index f9d5c0059..2e930e8a3 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.39.20110322
+//= 3.41.20110427
//=========================================================
//= 1.0 - First release, filled will as much info as I could
//= remember or figure out, most likely there are errors,
@@ -168,6 +168,9 @@
//= Documented optional parameter 'npc name' of 'waitingroom2bg' command.
//= 3.40.20110404
//= Updated description of 'waitingroom' command to include required zeny/lvl. [Kisuka]
+//= 3.41.20110427
+//= Updated description of 'itemheal' primarily to remove overhead and lies
+//= about client effects. [Ai4rei]
//=========================================================
This document is a reference manual for all the scripting commands and functions
@@ -3727,15 +3730,10 @@ character and produces no other output whatsoever.
*itemheal <hp>,<sp>;
-This command works on the invoking character like 'heal', however, it is not
-normally used in NPC scripts and will not work as expected there, but is used
-all over in item scripts.
-
-Unlike 'heal', which just alters hp/sp and doesn't do anything else at all, this
-command also shows healing animations for potions and other stuff, checks
-whether the potion was made by a famous alchemist and alters the amount healed,
-etc, etc. Since which kind of effect is shown depends on what item was used,
-using it in an NPC script will not have a desired effect.
+This command heals given absolute amounts of HP and/or SP on the invoking
+character. Unlike heal, this command is intended for use in item scripts. It
+applies potion-related bonuses, such as alchemist ranking, cards and status
+changes. When used inside an NPC script, certain bonuses are omitted.
There is also a nice example on using this with the 'rand' function, to give you
a random amount of healing.