Numeric modifier: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
m Filled in the info requested by the RFI. Code sample coming up in a bit!
imported>StDoodle
mNo edit summary
Line 53: Line 53:
}}|
}}|


function_description=Returns your current modifier total for {{pspan|modifier_name}}, or the amount of modification from {{pspan|check_me}} if specified.</p><br />
function_description=Returns your current modifier total for {{pspan|modifier_name}}, or the amount of modification from {{pspan|check_me}} if specified.</p>
 
{{Function|
{{Function|
name={{#var:name}}|
name={{#var:name}}|
Line 65: Line 66:
p1desc={{Pspan|buddy}} is the familiar to check|
p1desc={{Pspan|buddy}} is the familiar to check|
p2desc={{Pspan|check_me}} is the modifier to check|
p2desc={{Pspan|check_me}} is the modifier to check|
p3desc={{Pspan|integer}} is the familiar's weight (buffed, not including equipment)|
p3desc={{Pspan|weight}} is the familiar's weight (buffed, not including equipment)|
p4desc={{Pspan|some_item}} is the familiar's equipment|
p4desc={{Pspan|equipment}} is the familiar's equipment|
}}
}}
<p>Returns the familiar's effect on this modifier (for instance, a baby gravy fairy would return some positive float for "Item Drops").|
<p>Returns the familiar's effect on this modifier (for instance, a baby gravy fairy would return some positive float for "Item Drops").|

Revision as of 16:13, 18 March 2010

needs(code_samples);

Function Syntax

float numeric_modifier(string modifier_name )

float numeric_modifier(string check_me ,string modifier_name )

float numeric_modifier(item check_me ,string modifier_name )

float numeric_modifier(effect check_me ,string modifier_name )

float numeric_modifier(skill check_me ,string modifier_name )

  • check_me is the string, item, effect or skill to check
  • modifier_name is the modifier to check

Returns your current modifier total for modifier_name, or the amount of modification from check_me if specified.

float numeric_modifier(familiar buddy ,string check_me ,int integer ,item some_item )

  • buddy is the familiar to check
  • check_me is the modifier to check
  • weight is the familiar's weight (buffed, not including equipment)
  • equipment is the familiar's equipment

Returns the familiar's effect on this modifier (for instance, a baby gravy fairy would return some positive float for "Item Drops").

CLI Equivalent

The CLI command "modtrace" gives access to the same information when the correct parameters are specified.