Favorite familiars

From Kolmafia
Revision as of 05:52, 18 October 2015 by imported>Relyk (Created page with "{{#if: {{#vardefine:name|favorite_familiars}} {{#vardefine:return_type|boolean [familiar]}} {{#vardefine:aggregate|yes}} }}{{FunctionPage | name = {{#var:name}} | function1= {...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Function Syntax

boolean [familiar] favorite_familiars()

Returns a map of all the familiars that are available and in your favorites list. The map excludes any favorite familiars that aren't available as evaluated by is_unrestricted(). The boolean value is always true.

Code Samples

Print a list of your favorite familiars.

foreach fam in favorite_familiars()
{
   print(fam);
}

See Also

my_familiar()