Favorite familiars

From Kolmafia
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()