Difference between revisions of "Use skill"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>StDoodle
m
Line 30: Line 30:
  
 
function_description=Attempts to cast the skill {{pspan|to_use}} a number of times specified by {{pspan|casts}}. Defaults to casting on yourself, but you can specify a {{pspan|target}} for buffs.|
 
function_description=Attempts to cast the skill {{pspan|to_use}} a number of times specified by {{pspan|casts}}. Defaults to casting on yourself, but you can specify a {{pspan|target}} for buffs.|
}}
+
}}=In-combat Consulting={{
=In-combat Consulting={{
 
  
 
FunctionPage|
 
FunctionPage|

Revision as of 01:36, 9 March 2010

Normal Use

Function Syntax

boolean use_skill(int casts ,skill to_use )

boolean use_skill(int casts ,skill to_use ,string target )

  • casts is the number of casts
  • target is the recipient (optional, for use with buffs only)

Attempts to cast the skill to_use a number of times specified by casts. Defaults to casting on yourself, but you can specify a target for buffs.

In-combat Consulting

Function Syntax

string use_skill(skill to_use )

string 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 of one time) using the specified skill to_use, never reconsulting the script until the loop is complete.

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).