summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFlavioJS <FlavioJS@54d463be-8e91-2dee-dedb-b68131a5f0ec>2008-06-12 09:30:12 +0000
committerFlavioJS <FlavioJS@54d463be-8e91-2dee-dedb-b68131a5f0ec>2008-06-12 09:30:12 +0000
commit5edaf054f8cfac09b95583cbe4d5c64df850b82b (patch)
tree0204839448d00e0c90faff38840b235b1935bfe2 /doc
parent058ff83d028db62ccb4deb474b3e23a8413e775c (diff)
downloadhercules-5edaf054f8cfac09b95583cbe4d5c64df850b82b.tar.gz
hercules-5edaf054f8cfac09b95583cbe4d5c64df850b82b.tar.bz2
hercules-5edaf054f8cfac09b95583cbe4d5c64df850b82b.tar.xz
hercules-5edaf054f8cfac09b95583cbe4d5c64df850b82b.zip
* Added support for skill names to script commands:
- skill, addtoskill, guildskill, getskilllv, getgdskilllv, itemskill, petskillattack, petskillattack2, petskillsupport, skilleffect, npcskilleffect, unitskilluseid, unitskillusepos - bonus/bonus2/bonus3/bonus4/bonus5 for bonuses bAutoSpell, bSkillAtk, bSkillHeal, bAutoSpellWhenHit, bAddSkillBlow, bCastrate git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@12814 54d463be-8e91-2dee-dedb-b68131a5f0ec
Diffstat (limited to 'doc')
-rw-r--r--doc/item_bonus.txt32
-rw-r--r--doc/script_commands.txt28
2 files changed, 41 insertions, 19 deletions
diff --git a/doc/item_bonus.txt b/doc/item_bonus.txt
index 2ebaebcd0..51da56a80 100644
--- a/doc/item_bonus.txt
+++ b/doc/item_bonus.txt
@@ -3,16 +3,20 @@
//===== By ================================================
//= Developers
//===== Version ===========================================
-//= 1.0
+//= 1.1.20080612
//=========================================================
//= 1.0 - Standardized doc file
+//= 1.1.20080612 - skill command and bonuses (bAutoSpell, bSkillAtk,
+//= bSkillHeal, bAutoSpellWhenHit, bAddSkillBlow, bCastrate) accept
+//= skill names [FlavioJS]
+//=
//===== Description =======================================
//= List of script instructions used in item bonuses,
//= mainly bonus/bonus2/bonus3/bonus4/bonus5 arguments
//=========================================================
-skill i,n; Gives skill #i at level n
+skill i,n; Gives skill #i at level n (supports skill names)
bonus bStr,n; STR + n
bonus bAgi,n; AGI + n
@@ -114,7 +118,7 @@ bonus2 bAddEff,e,x; Adds a x/10000 chance to cause effect e to the target when
e: Eff_Blind, Eff_Sleep, Eff_Poison, Eff_Freeze, Eff_Silence, Eff_Stan, Eff_Curse, Eff_Confusion, Eff_Stone, Eff_Bleeding
bonus2 bResEff,e,x; Adds a x/10000 tolerance to effect e (e.g. x=100 makes 1% tolerance, x=10000 makes 100% tolerance, etc)
e: Eff_Blind, Eff_Sleep, Eff_Poison, Eff_Freeze, Eff_Silence, Eff_Stan, Eff_Curse, Eff_Confusion, Eff_Stone, Eff_Bleeding
-bonus2 bCastrate,n,x; Adjust casting time of skill n by x%
+bonus2 bCastrate,n,x; Adjust casting time of skill n by x% (supports skill names)
bonus2 bAddSize,n,x; +x% physical damage against size n.
n: 0=Small 1=Medium 2=Large
bonus2 bMagicAddSize,n,x; +x% magical damage against size n.
@@ -168,7 +172,7 @@ bonus3 bAddMonsterDropItem,n,x,y; When killing monsters from race x with physica
10=Boss monster, 11=Other than (normal monster) boss monster
if 'x' is negative value, then it's a part of formula
chance = -x*(killed_mob_level/10)+1
-bonus3 bAutoSpell,n,x,y; Auto Spell casting on attack of spell n at level x with y/10% chance.
+bonus3 bAutoSpell,n,x,y; Auto Spell casting on attack of spell n at level x with y/10% chance. (supports skill names)
Skill is casted on target unless it is a self or support (inf = 4/16) skill.
// bAddDamageClass, bAddMagicDamageClass and bAddMonsterDropItem it is setting possible up to 10. Those which exceed 10 are ignored.
@@ -198,15 +202,16 @@ bonus2 bCriticalAddRace,n,r; Critical + n vs. enemies of race r
bonus2 bHPRegenRate,n,x; Gain n HP every x milliseconds
bonus2 bHPLossRate,n,x; Lose n HP every x milliseconds
bonus2 bAddEffWhenHit,n,x; x/100% chance to cause n state to the enemy when being hit by physical damage
-bonus2 bSkillAtk,n,x; Increase damage of skill n by x%
-bonus2 bSkillHeal,n,x; Increase heal amount of skill n by x%
+bonus2 bSkillAtk,n,x; Increase damage of skill n by x% (supports skill names)
+bonus2 bSkillHeal,n,x; Increase heal amount of skill n by x% (supports skill names)
bonus2 bAddDamageByClass,n,x; When being hit by monster of class n increase damage by x%
bonus2 bAddRace2,n,x; Increase damage by x% vs. enemies of race n
(Check db/mob_race2_db.txt)
y: 0=Don't show damage 1=Show damage
bonus3 bAutoSpellWhenHit,x,y,n; n/10% chance to cast skill x of level y on
attacker (unless it is a self or support skill) when being hit by a
- direct attack. Target must be within spell's range to go off.
+ direct attack. (supports skill names)
+ Target must be within spell's range to go off.
bonus3 bSPDrainRate,n,x,y; When attacking there is a n% chance to either gain SP equivalent to x% of damage dealt,
OR drain the amount of sp from the enemy.
y: 0=gain sp 1:drain enemy sp
@@ -214,20 +219,20 @@ bonus3 bSPDrainValue,n,x,y; When attacking there is a n% chance to either gain
OR drain the amount of sp from the enemy.
y:0=gain sp 1:drain enemy sp
(Note: setting x to -1 or below will reduce YOUR sp)
-bonus4 bAutoSpell,x,y,n,i; n/10% chance to cast skill x of level y when attacking
+bonus4 bAutoSpell,x,y,n,i; n/10% chance to cast skill x of level y when attacking (supports skill names)
i:
0=cast on self
1=cast on enemy, not on self
2=use random skill lv in [1..y]
3=1+2 (random lv on enemy)
-bonus4 bAutoSpellWhenHit,x,y,n,i; n/10% chance to cast skill x of level y when being hit by a direct attack.
+bonus4 bAutoSpellWhenHit,x,y,n,i; n/10% chance to cast skill x of level y when being hit by a direct attack. (supports skill names)
Target must be within spell's range to go off.
i:
0=cast on self
1=cast on enemy, not on self
2=use random skill lv in [1..y]
3=1+2 (random lv on enemy)
-bonus5 bAutoSpell,x,y,n,t,i; n/10% chance to cast skill x of level y when attacking
+bonus5 bAutoSpell,x,y,n,t,i; n/10% chance to cast skill x of level y when attacking (supports skill names)
t: Trigger criteria:
BF_SHORT: Trigger on melee attack
BF_LONG: Trigger on ranged attack
@@ -249,9 +254,8 @@ bonus5 bAutoSpell,x,y,n,t,i; n/10% chance to cast skill x of level y when attac
2=use random skill lv in [1..y]
3=1+2 (random lv on enemy)
-bonus5 bAutoSpellWhenHit,x,y,n,t,i; n/10% chance to cast skill x of level y when being hit by a direct attack.
- Target must be within spell's range to go
- off.
+bonus5 bAutoSpellWhenHit,x,y,n,t,i; n/10% chance to cast skill x of level y when being hit by a direct attack. (supports skill names)
+ Target must be within spell's range to go off.
t: Trigger criteria:
BF_SHORT: Trigger on melee attack
BF_LONG: Trigger on ranged attack
@@ -324,4 +328,4 @@ bonus2 bWeaponComaRace,x,y; y/100% chance to cause Coma when attacking a monste
bAddStealRate,n; n/100% increase to Steal skill success chance
-bonus2 bAddSkillBlow,x,y; Pushback the target by y cells when using skill x \ No newline at end of file
+bonus2 bAddSkillBlow,x,y; Pushback the target by y cells when using skill x (supports skill names)
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 00c604d01..71ac40864 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.19.20080407
+//= 3.21.20080612
//=========================================================
//= 1.0 - First release, filled will as much info as I could
//= remember or figure out, most likely there are errors,
@@ -111,8 +111,13 @@
//= 3.19.20080407
//= Extended the behaviour of 'guardian'. [FlavioJS]
//= 3.20.20080425
-//= Corrected 'getitem', 'getitem2' & 'delitem2' (charid instead of accountid) [Toms]
-//= Modified 'delitem' (added optional accountid parameter) [Toms]
+//= Corrected 'getitem', 'getitem2' & 'delitem2' (charid instead of accountid) [Toms]
+//= Modified 'delitem' (added optional accountid parameter) [Toms]
+//= 3.21.20080612
+//= Script commands extended to support skill names: [FlavioJS]
+//= skill, addtoskill, guildskill, getskilllv, getgdskilllv, itemskill,
+//= petskillattack, petskillattack2, petskillsupport, skilleffect, npcskilleffect,
+//= unitskilluseid, unitskillusepos, bonus/bonus2/bonus3/bonus4/bonus5
//=========================================================
This document is a reference manual for all the scripting commands and functions
@@ -2734,6 +2739,7 @@ anything, obviously.
---------------------------------------
*getgdskilllv(<guild id>,<skill id>)
+*getgdskilllv(<guild id>,"<skill name>")
This function returns the level of the skill <skill id> of the guild <guild id>.
If the guild does not have that skill, 0 is returned.
@@ -2769,6 +2775,7 @@ Example(s):
---------------------------------------
*getskilllv(<skill id>)
+*getskilllv("<skill name>")
This function returns the level of the specified skill that the invoking
character has. If they don't have the skill, 0 will be returned. The full list
@@ -3936,6 +3943,7 @@ effect is still in effect).
---------------------------------------
*itemskill <skill id>,<skill level>;
+*itemskill "<skill name>",<skill level>;
This is a command meant for item scripts to replicate single-use skills. It will
not work properly in NPC scripts a lot of the time because casting a skill is
@@ -4132,6 +4140,7 @@ any guild.
---------------------------------------
*guildskill <skill id>,<level>
+*guildskill "<skill name>",<level>
This command will bump up the specified guild skill by the specified number of
levels. This refers to the invoking character and will only work if the invoking
@@ -4256,6 +4265,7 @@ should be rather obvious.
---------------------------------------
*skilleffect <skill id>,<number>;
+*skilleffect "<skill name>",<number>;
This command will display the visual and sound effects of a specified skill (see
'db/skill_db.txt' for a full list of skills) on the invoking character's sprite.
@@ -4278,6 +4288,7 @@ effect displays a floating number, the number given will float up.
---------------------------------------
*npcskilleffect <skill id>,<number>,<x>,<y>;
+*npcskilleffect "<skill name>",<number>,<x>,<y>;
This command behaves identically to 'skilleffect', however, the effect will not
be centered on the invoking character's sprite, nor on the NPC sprite, if any,
@@ -4383,7 +4394,9 @@ autoscript).
---------------------------------------
*skill <skill id>,<level>{,<flag>};
-*addtoskill <skill id>,<level>{,<flag>}
+*skill "<skill name",<level>{,<flag>};
+*addtoskill <skill id>,<level>{,<flag>};
+*addtoskill "<skill name>",<level>{,<flag>};
These commands will give the invoking character a specified skill. This is also
used for item scripts.
@@ -5830,8 +5843,10 @@ Example(s):
---------------------------------------
-*unitskilluseid <GID>,<skill id>,<skill lvl>;
+*unitskilluseid <GID>,<skill id>,<skill lvl>{,<target id>};
+*unitskilluseid <GID>,"<skill name>",<skill lvl>{,<target id>};
*unitskillusepos <GID>,<skill id>,<skill lvl>,<x>,<y>;
+*unitskillusepos <GID>,"<skill name>",<skill lvl>,<x>,<y>;
This is the replacement of the older commands, these use the same values for
GID as the other unit* commands (See 'GID').
@@ -6064,6 +6079,7 @@ specified. Pet will store items and return them when the maximum is reached or
when pet performance is activated.
*petskillsupport <skill id>,<skill level>,<delay>,<percent hp>,<percent sp>;
+*petskillsupport "<skill name>",<skill level>,<delay>,<percent hp>,<percent sp>;
*petheal <level>,<delay>,<percent hp>,<percent sp>;
This will make the pet use a specified support skill on the owner whenever the
@@ -6075,7 +6091,9 @@ It's not quite certain who's stats will be used for the skills cast, the
character's or the pets. Probably, Skotlex can answer that question.
*petskillattack <skill id>,<skill level>,<rate>,<bonusrate>;
+*petskillattack "<skill name>",<skill level>,<rate>,<bonusrate>;
*petskillattack2 <skill id>,<damage>,<number of attacks>,<rate>,<bonusrate>;
+*petskillattack2 "<skill name>",<damage>,<number of attacks>,<rate>,<bonusrate>;
These two commands will make the pet cast an attack skill on the enemy the pet's
owner is currently fighting. Skill IDs and levels are as per 'petskillsupport'.