Browse Source

* Resolved missing script documentation (bugreport:4578).
- Added documentation for bonus bAutoSpellOnSkill (follow up to r13596).
- Added documentation for script command progressbar (follow up to r14024).

git-svn-id: https://svn.code.sf.net/p/rathena/svn/trunk@14527 54d463be-8e91-2dee-dedb-b68131a5f0ec

ai4rei 14 years ago
parent
commit
df022f175d
3 changed files with 28 additions and 1 deletions
  1. 3 0
      Changelog-Trunk.txt
  2. 8 1
      doc/item_bonus.txt
  3. 17 0
      doc/script_commands.txt

+ 3 - 0
Changelog-Trunk.txt

@@ -1,6 +1,9 @@
 Date	Added
 
 2010/11/30
+	* Resolved missing script documentation (bugreport:4578). [Ai4rei]
+	- Added documentation for bonus bAutoSpellOnSkill (follow up to r13596).
+	- Added documentation for script command progressbar (follow up to r14024).
 	* Made job_db1.txt, job_db2.txt, size_fix.txt and refine_db.txt reading use sv_readdb. [Ai4rei]
 	- NOTE: Any MAX_LEVEL (map.h) increase requires at least same increase of SV_READDB_MAX_FIELDS as well.
 	* Added SV_READDB_MAX_FIELDS define for configuration of the sv_readdb limit. [Ai4rei]

+ 8 - 1
doc/item_bonus.txt

@@ -3,7 +3,7 @@
 //===== By ================================================
 //= Developers
 //===== Version ===========================================
-//= 1.1.20090524
+//= 1.1.20101130
 //=========================================================
 //= 1.0 - Standardized doc file
 //= 1.1.20080612 - skill command and bonuses (bAutoSpell, bSkillAtk, 
@@ -13,6 +13,7 @@
 //= 1.1.20090421 - added the correct bonus documentation for bSPDrainValue [Playtester]
 //= 1.1.20090524 - removed outdated bMatk/bMatk1/bMatk2 doc [ultramage]
 //= 1.1.20090529 - added documentation for bHealPower, bHealPower2 [Inkfish]
+//= 1.1.20101130 - added documentation for bAutoSpellOnSkill [Ai4rei]
 //===== Description =======================================
 //= List of script instructions used in item bonuses,
 //= mainly bonus/bonus2/bonus3/bonus4/bonus5 arguments
@@ -376,3 +377,9 @@ bonus3 bSubEle,n,x,t;			x% Damage reduction against element n.
 					   i: 1=cast on enemy, not on self
 					   2=use random skill lv in [1..y]
 					   3=1+2 (random lv on enemy)
+bonus4 bAutoSpellOnSkill,s,x,l,n	Adds a n/10% chance to autospell skill x at level l when using skill s. (supports skill names)
+									Supportive spells are casted on self, others on target of skill s.
+bonus5 bAutoSpellOnSkill,s,x,l,n,i	Adds a n/10% chance to autospell skill x at level l when using skill s. (supports skill names)
+									i: Flags (bitfield)
+										&1: Forces the skill to be casted on self, rather than on the target of skill s.
+										&2: Random skill level between 1 and l is chosen.

+ 17 - 0
doc/script_commands.txt

@@ -137,6 +137,12 @@
 //=       Added info on strcharinfo(3) [Skotlex]
 //= 3.29.20101123
 //=       Added 'pushpc' command. [Ai4rei]
+//= 3.30.20101126
+//=       Added 'setfont', 'mercenary_create', 'mercenary_heal', 'mercenary_sc_start',
+//=       'mercenary_create', 'mercenary_get_calls', 'mercenary_set_calls',
+//=       'mercenary_get_faith' and 'mercenary_set_faith' commands. [Ai4rei]
+//= 3.31.20101130
+//=       Added 'progressbar' command. [Ai4rei]
 //=========================================================
 
 This document is a reference manual for all the scripting commands and functions 
@@ -5445,6 +5451,17 @@ Examples:
 	sleep2 5000; //pause the script for 5 seconds, and continue with the RID attached.
 	awake "NPC"; //Cancels any running sleep timers on the NPC 'NPC'.
 
+---------------------------------------
+
+*progressbar "<color>",<seconds>;
+
+This command works almost like sleep2, but displays a progress bar
+above the head of the currently attached character (like cast bar).
+Once the given amount of seconds passes, the script resumes. If the
+character moves while the progress bar progresses, it is aborted and
+the script ends. The color format is in RGB (0xRRGGBB). The color is
+currently ignored by the client and appears always green.
+
 ---------------------------------------
 //
 5,1.- End of time-related commands