Difference between revisions of "Weight adjustment"

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
(Created page with example.)
 
imported>Heeheehee
m (Fixed to fit the description, heh.)
Line 21: Line 21:
 
code=
 
code=
 
<syntaxhighlight>
 
<syntaxhighlight>
boolean fam_weight() {
+
boolean fam_weight( familiar fam ) {
   return ( familiar_weight(my_familiar()) + weight_adjustment() );
+
   return ( familiar_weight(fam) + weight_adjustment() );
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 07:34, 10 March 2010

Function Syntax

int weight_adjustment()

Returns the cumulative total of all familiar weight adjustments from equipment, effects, passive skills, and area modifiers.

Code Samples

Checks to see how heavy a specified familiar is, including all weight-affecting effects.

boolean fam_weight( familiar fam ) {
   return ( familiar_weight(fam) + weight_adjustment() );
}

See Also

familiar_weight() | my_familiar()

Special

Returns 0 when not logged in.