Difference between pages "Template:TOCright" and "Have familiar"

From Kolmafia
(Difference between pages)
Jump to navigation Jump to search
imported>StDoodle
(Created page with '{| cellspacing="0" cellpadding="0" style="clear: {{{clear|none}}}; margin-bottom: .5em; float: right; padding: .5em 0 .8em 1.4em; background: none; width: {{{width|{{{1|auto}}}}}…')
 
imported>Bale
 
Line 1: Line 1:
{| cellspacing="0" cellpadding="0" style="clear: {{{clear|none}}}; margin-bottom: .5em; float: right; padding: .5em 0 .8em 1.4em; background: none; width: {{{width|{{{1|auto}}}}}};" {{#if:{{{limit|}}}|class="toclimit-{{{limit}}}"}}
+
{{#vardefine:name|have_familiar}}
| __TOC__
+
{{#vardefine:return_type|boolean}}
|}<noinclude>
+
 
{{pp-template|small=yes}}
+
{{FunctionPage|
{{documentation}}
+
name={{#var:name}}|
<!-- Add cats and interwikis to the /doc subpage, not here! -->
+
function_category=Equipment|
</noinclude>
+
 
 +
function1={{Function|
 +
name={{#var:name}}|
 +
aggregate={{#var:aggregate}}|
 +
return_type={{#var:return_type}}|
 +
return_also={{#var:return_also}}|
 +
parameter1={{Param|familiar|check_me}}|
 +
p1desc={{Pspan|check_me}} is the familiar to check for|
 +
}}|
 +
 
 +
function_description=Returns true if you have the specified familiar {{pspan|check_me}}, and false otherwise. The familiar will be detected if it is active or in your Terrarium. It will not notice familiar hatchlings since those are items, not familiars and need to be detected separately.
 +
 
 +
Mafia will not detect transformations of familiars due to wardrobe or doppleshifting, so this function is incapable of detecting such transformation if it is called during combat.|
 +
 
 +
needscode=yes|
 +
 
 +
see_also={{SeeAlso|use_familiar}}|
 +
cli_equiv=The CLI command "familiar" with the parameter "list" functions similarly.|
 +
special= Note that in Bad Moon it only checks the familiars you have acquired in the current run.|
 +
}}

Revision as of 19:07, 6 March 2010



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, and false otherwise. The familiar will be detected if it is active or in your Terrarium. It will not notice familiar hatchlings since those are items, not familiars and need to be detected separately. Mafia will not detect transformations of familiars due to wardrobe or doppleshifting, so this function is incapable of detecting such transformation if it is called during combat.

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 have acquired in the current run.