Difference between revisions of "Familiar weight"

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
(Created page with example.)
 
imported>Ckb
 
(One intermediate revision by one other user not shown)
Line 5: Line 5:
 
FunctionPage|
 
FunctionPage|
 
name={{#var:name}}|
 
name={{#var:name}}|
function_category=Your Character|
 
  
 
function1={{Function|
 
function1={{Function|
Line 23: Line 22:
 
code=
 
code=
 
<syntaxhighlight>
 
<syntaxhighlight>
boolean fam_weight( familiar fam ) {
+
int fam_weight( familiar fam ) {
 
   return ( familiar_weight(fam) + weight_adjustment() );
 
   return ( familiar_weight(fam) + weight_adjustment() );
 
}
 
}
Line 32: Line 31:
 
special=Returns 0 when not logged in.|
 
special=Returns 0 when not logged in.|
 
}}
 
}}
 +
 +
[[Category:Your Character]]

Latest revision as of 02:32, 14 October 2016

Function Syntax

int familiar_weight(familiar fam )

  • fam is the familiar type (e.g. Mosquito, not "Nos Feratu")

Returns the base weight of the specified familiar.

Code Samples

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

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

See Also

weight_adjustment() | my_familiar()

Special

Returns 0 when not logged in.