Difference between pages "User:Heeheehee" and "Have familiar"
imported>Heeheehee m |
imported>Heeheehee (RFI!) |
||
| Line 1: | Line 1: | ||
| − | + | {{ | |
| − | + | #vardefine:name|have_familiar}}{{ | |
| − | + | #vardefine:return_type|boolean}}{{ | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | FunctionPage| | |
| − | + | name={{#var:name}}| | |
| − | + | function_category=Equipment| | |
| − | + | ||
| + | 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.</p> | ||
| + | |||
| + | <p>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.| | ||
| + | }} | ||
| + | |||
| + | {{RFI|I'm almost completely sure that this is the case, but can someone confirm that this function returns false if you can't access the familiar in question because you're in BM (assuming that you've used the hatchling in a previous incarnation)?}} | ||
Revision as of 07:51, 9 March 2010
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
Special
Note that in Bad Moon it only checks the familiars you have acquired 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 question has been raised:
- I'm almost completely sure that this is the case, but can someone confirm that this function returns false if you can't access the familiar in question because you're in BM (assuming that you've used the hatchling in a previous incarnation)?