Use familiar

From Kolmafia
Revision as of 20:55, 9 April 2010 by imported>Slyz (return value is boolean, not familiar)
Jump to navigation Jump to search
needs(code_samples);

Function Syntax

boolean use_familiar(familiar buddy )

  • buddy is the familiar to equip

Switches your current familiar for the the familiar buddy specified. Returns true if the specified familiar buddy is your current familiar after the function's completion (so it will return true if you try to switch to your current familiar).

CLI Equivalent

The CLI command "familiar" has the same function when a familiar type is specified as the only parameter.

See Also

have_familiar()