Combat rate modifier: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Grotfang
imported>Grotfang
Conform to template
Line 1: Line 1:
 
{{#vardefine:name|combat_rate_modifier}}
{{#vardefine:return_type|float}}
 
{{FunctionPage|
name={{#var:name}}|
function_category=Your Character|
 
function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|
 
function_description=Returns the current percentage change on combat frequency including equipment and effects.|
 
code1={{CodeSample|
title=Code Samples|
description=Checks that your combat frequency modifier is positive (for example, before adventuring in the Purple Light District).|
code=
<syntaxhighlight>
boolean is_combat_positive() {
  if(combat_rate_modifier() > 0) {
      return true;
  }
  return false;
}
</syntaxhighlight>
}}|
 
see_also={{SeeAlso|appearance_rates}}|
special=Returns 0 when not logged in.
}}

Revision as of 23:04, 28 February 2010



Function Syntax

float combat_rate_modifier()

Returns the current percentage change on combat frequency including equipment and effects.

Code Samples

Checks that your combat frequency modifier is positive (for example, before adventuring in the Purple Light District).

boolean is_combat_positive() {
   if(combat_rate_modifier() > 0) {
      return true;
   }
   return false;
}

See Also

appearance_rates()

Special

Returns 0 when not logged in.