Difference between revisions of "To effect"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
(Created page with '{{ #vardefine:name|to_effect}}{{ #vardefine:return_type|effect}}{{ FunctionPage| name={{#var:name}}| function_category=Datatype Conversions| function1={{Function| name={{#var:n…')
 
imported>StDoodle
m
Line 29: Line 29:
 
return_also={{#var:return_also}}|
 
return_also={{#var:return_also}}|
 
parameter1={{Param|skill|convert}}|
 
parameter1={{Param|skill|convert}}|
p1desc={{Pspan|convert}} is the int, string or skillt to convert|
+
p1desc={{Pspan|convert}} is the int, string or skill to convert|
 
}}|
 
}}|
 
function_description=When supplied an int or string, returns the effect that corresponds to the specified parameter {{pspan|convert}}. When supplied a skill, this returns the effect that is given when the skill {{pspan|convert}} is cast on a player.|
 
function_description=When supplied an int or string, returns the effect that corresponds to the specified parameter {{pspan|convert}}. When supplied a skill, this returns the effect that is given when the skill {{pspan|convert}} is cast on a player.|

Revision as of 00:27, 14 March 2010

needs(code_samples);

Function Syntax

effect to_effect(int convert )

effect to_effect(string convert )

effect to_effect(skill convert )

  • convert is the int, string or skill to convert

When supplied an int or string, returns the effect that corresponds to the specified parameter convert. When supplied a skill, this returns the effect that is given when the skill convert is cast on a player.

Special

If convert is an effect that cannot be given by use of a skill, and is supplied as such, or no match is found for a supplied string or int type, this function returns $effect[ none ].