Browse Source

* 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://svn.code.sf.net/p/rathena/svn/trunk@14802 54d463be-8e91-2dee-dedb-b68131a5f0ec
ai4rei 14 years ago
parent
commit
1816631974
2 changed files with 10 additions and 10 deletions
  1. 2 0
      Changelog-Trunk.txt
  2. 8 10
      doc/script_commands.txt

+ 2 - 0
Changelog-Trunk.txt

@@ -1,5 +1,7 @@
 Date	Added
 
+2011/04/27
+	* 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). [Ai4rei]
 2011/04/21
 	* Extended debugging code for bugreport:3504 (related r14599). [Ai4rei]
 2011/04/20

+ 8 - 10
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.