Use skill: Difference between revisions
imported>Pineapple of Despair Added missing single-cast ashref declarations, fixed a pXdef typo. |
imported>Bale No edit summary |
||
Line 1: | Line 1: | ||
There are two forms of this function. In a combat consult script, this returns a buffer, but otherwise it returns a boolean. Note both forms below. | |||
{{ | {{ | ||
#vardefine:name|use_skill}}{{ | #vardefine:name|use_skill}}{{ | ||
Line 86: | Line 88: | ||
}} | }} | ||
[[Category:Skills and Effects]] | [[Category:Skills and Effects]][[Category:In-combat Consulting]] |
Revision as of 01:22, 26 March 2015
There are two forms of this function. In a combat consult script, this returns a buffer, but otherwise it returns a boolean. Note both forms below.
Normal Use
Function Syntax
boolean use_skill(skill to_use )
boolean use_skill(int casts ,skill to_use )
boolean use_skill(skill to_use ,string target )
boolean use_skill(int casts ,skill to_use ,string target )
- casts is the (optional) number of casts
- to_use is the skill to use
- target is the recipient (optional, for use with buffs only)
Attempts to cast the skill to_use a number of times specified by casts, or once if not specified. Defaults to casting on yourself, but you can specify a target for buffs.
Code Sample
This example will attempt to cast the specified skill as many times as it can with the MP the character has left.
effect chosen = $effect[ Empathy ];
use_skill( my_mp() / mp_cost( to_skill(chosen) ) , to_skill(chosen) );
CLI Equivalent
The CLI command "cast" functions similarly to the normal version of this function (with similar parameters).
In-combat Consulting
Function Syntax
buffer use_skill(skill to_use )
buffer use_skill(int casts ,skill to_use )
- casts is the (optional) number of casts
- to_use is the skill to use
Will loop the specified number of casts (default to 1 if omitted) using the specified skill to_use, never reconsulting the script until the loop is complete. One exception: this will not work with Lasagna Bandages, since it tries to cast the out-of-combat version of the skill. Using visit_url()
is required for casting Lasagna Bandages in combat.