Difference between revisions of "Modifier Functions"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>Heeheehee
m (Filled in some info; added modifier_eval() -- should it go in Math and Numbers, instead?)
Line 4: Line 4:
 
{{flink|boolean|boolean_modifier|item|string|desc=Access to boolean modifiers.}}
 
{{flink|boolean|boolean_modifier|item|string|desc=Access to boolean modifiers.}}
 
{{flink|class|class_modifier|string|string}}
 
{{flink|class|class_modifier|string|string}}
{{flink|class|class_modifier|item|string|desc=Access to class modifiers (is this just a shortcut to the string modifier for "class"?)}}
+
{{flink|class|class_modifier|item|string|desc=Access to modifiers that return one of the six classes (e.g. "Class").}}
 
{{flink|effect|effect_modifier|string|string}}
 
{{flink|effect|effect_modifier|string|string}}
{{flink|effect|effect_modifier|item|string|desc=Access to effect modifiers (is this just a shortcut to the string modifier for "effect"?)}}
+
{{flink|effect|effect_modifier|item|string|desc=Access to modifiers that return an effect(e.g. "Intrinsic Effect" or, introduced more recently, "Effect").}}
 +
{{flink|float|modifier_eval|string|desc=Evaluates an expression using certain guidelines.}}
 
{{flink|float|numeric_modifier|{{opt|string}}|string}}
 
{{flink|float|numeric_modifier|{{opt|string}}|string}}
 
{{flink|float|numeric_modifier|item|string}}
 
{{flink|float|numeric_modifier|item|string}}
Line 12: Line 13:
 
{{flink|float|numeric_modifier|skill|string}}
 
{{flink|float|numeric_modifier|skill|string}}
 
{{flink|float|numeric_modifier|familiar|string|int|item|desc=Access to numeric modifiers.}}
 
{{flink|float|numeric_modifier|familiar|string|int|item|desc=Access to numeric modifiers.}}
{{flink|stat|stat_modifier|effect|string|desc=Access to stat modifiers (is this just a shortcut to the string modifier for "stat tuning"?)}}
+
{{flink|stat|stat_modifier|effect|string|desc=Access to modifiers that return one of the stats (e.g. "Equalize").}}
 
{{flink|string|string_modifier|{{opt|string}}|string|desc=Access to string modifiers.}}
 
{{flink|string|string_modifier|{{opt|string}}|string|desc=Access to string modifiers.}}

Revision as of 03:33, 19 March 2010

These functions allow access to the raw modifiers known to KoLmafia.

For more information on what modifiers exist, please see Modifiers.

boolean boolean_modifier( [string], string )

boolean boolean_modifier( item, string )

Access to boolean modifiers.

class class_modifier( string, string )

class class_modifier( item, string )

Access to modifiers that return one of the six classes (e.g. "Class").

effect effect_modifier( string, string )

effect effect_modifier( item, string )

Access to modifiers that return an effect(e.g. "Intrinsic Effect" or, introduced more recently, "Effect").

float modifier_eval( string )

Evaluates an expression using certain guidelines.

float numeric_modifier( [string], string )

float numeric_modifier( item, string )

float numeric_modifier( effect, string )

float numeric_modifier( skill, string )

float numeric_modifier( familiar, string, int, item )

Access to numeric modifiers.

stat stat_modifier( effect, string )

Access to modifiers that return one of the stats (e.g. "Equalize").

string string_modifier( [string], string )

Access to string modifiers.