Faxbot: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Bale
add navigation
imported>Gausie
Added new overload
Line 13: Line 13:
}}|
}}|


function_description=Requests the specified monster from FaxBot, returning true if the fax is successful and false if it fails. As of revision 14139, it also checks FaustBot and Easyfax and uses the first one that's online and has the monster.|
{{
#vardefine:name|faxbot}}{{
#vardefine:return_type|boolean}}{{
 
FunctionPage|
name={{#var:name}}|
 
function1={{Function|
name={{#var:name}}|
return_type={{#var:return_type}}|
parameter1={{Param|monster|m}}||
p1desc={{Pspan|m}} is the monster of which to request a fax.|
parameter2={{Param|bot|n}}||
p2desc={{Pspan|n}} is the name of the supported bot from to request a fax. If not specified, mafia will traverse its list of faxbots and pick the first one that is online and has your monster.|
}}|
 
function_description=Requests the specified monster from one of mafia's known faxbots (as of r19492 this is just EasyFax or CheeseFax).|


code1={{CodeSample|
code1={{CodeSample|

Revision as of 21:11, 19 August 2019

{{

FunctionPage| name=faxbot|

function1=

boolean faxbot(monster m )

  • m is the monster to request a fax of.

|


Function Syntax

boolean faxbot(monster m ,bot n )

  • m is the monster of which to request a fax.
  • n is the name of the supported bot from to request a fax. If not specified, mafia will traverse its list of faxbots and pick the first one that is online and has your monster.

Requests the specified monster from one of mafia's known faxbots (as of r19492 this is just EasyFax or CheeseFax).

Code Samples

This will acquire a copy of a scary pirate if you're able to get a fax.

if ((get_property("_photocopyUsed")=="false")&&(item_amount($item[photocopied monster])==0)) {
 faxbot($monster[scary pirate]);
}

See Also

can_faxbot() | is_online()

Special

The chat must be open for this function to successfully work, just as for other mafia fax interfaces.