Have familiar

From Kolmafia
Revision as of 17:35, 6 March 2010 by imported>StDoodle (Created page with '{{#vardefine:name|have_familiar}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Equipment| function1={{Function| name={{#var:name}}| …')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search



needs(code_samples);

Function Syntax

boolean have_familiar(familiar check_me )

  • check_me is the familiar to check for

Returns true if you have the specified familiar check_me (either with you or in your Terrarium), and false otherwise.

CLI Equivalent

The CLI command "familiar" with the parameter "list" functions similarly.

See Also

use_familiar()

Special

Note that in Bad Moon it only checks the familiars you've used in the current run.


Attention KoLmafia Experts!

We need your help; some details of this function's operation are unknown or unclear.

The following specific questions have been raised:

  • Does this function check your familiar hatchlings? If so, where (storage, etc.)?
  • Bonus points: does the Doppleshifter screw this up if the function is called during a combat consult script?