Modifier Functions: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
Created page with '<p>These functions allow access to the raw modifiers known to KoLmafia.</p> <p>For more information on what modifiers exist, please see Modifiers.</p> {{flink|boolean|boolean…'
 
imported>AlbinoRhino
mNo edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<p>These functions allow access to the raw modifiers known to KoLmafia.</p>
<p>These functions allow access to the raw modifiers known to KoLmafia.</p>
<p>For more information on what modifiers exist, please see [[Modifiers]].</p>
<p>For more information on what modifiers exist, please see [[Modifiers]].</p>
{{flink|boolean|boolean_modifier|string}}
{{flink|boolean|boolean_modifier|string|string}}
{{flink|boolean|boolean_modifier|string|string}}
{{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|numeric_modifier|string}}
{{flink|float|numeric_modifier|string|string}}
{{flink|float|numeric_modifier|string|string}}
{{flink|float|numeric_modifier|item|string}}
{{flink|float|numeric_modifier|item|string}}
{{flink|float|numeric_modifier|effect|string}}
{{flink|float|numeric_modifier|effect|string}}
{{flink|float|numeric_modifier|skill|string}}
{{flink|float|numeric_modifier|skill|string}}
{{flink|float|modifier_eval|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|string}}
{{flink|string|string_modifier|string}}
{{flink|string|string_modifier|string|string|desc=Access to string modifiers.}}
{{flink|string|string_modifier|string|string|desc=Access to string modifiers.}}


{{RFI|I'm not sure how these are used, so I didn't collapse definitions using optional parameters;<br />If you know which is which, please make those edits.}}
[[Category:Scripting]]

Latest revision as of 22:27, 17 December 2017

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 numeric_modifier( string, string )

float numeric_modifier( item, string )

float numeric_modifier( effect, string )

float numeric_modifier( skill, string )

float modifier_eval( 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 string_modifier( string, string )

Access to string modifiers.