Difference between pages "Create matcher" and "Can faxbot"

From Kolmafia
(Difference between pages)
Jump to navigation Jump to search
imported>Bale
 
 
Line 1: Line 1:
 
{{
 
{{
#vardefine:name|create_matcher}}{{
+
#vardefine:name|can_faxbot}}{{
#vardefine:return_type|matcher}}{{
+
#vardefine:return_type|boolean}}{{
  
 
FunctionPage|
 
FunctionPage|
 
name={{#var:name}}|
 
name={{#var:name}}|
function_category=String Handling Routines|
 
  
 
function1={{Function|
 
function1={{Function|
 
name={{#var:name}}|
 
name={{#var:name}}|
aggregate={{#var:aggregate}}|
 
 
return_type={{#var:return_type}}|
 
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
+
parameter1={{Param|monster|mob}}||
parameter1={{Param|string|regex}}|
+
p1desc={{Pspan|mob}} is the monster for which to check.|
p1desc={{pspan|regex}} is the regular expression to use|
 
parameter2={{Param|string|input}}|
 
p2desc={{pspan|input}} is the string to search with a regular expression|
 
 
}}|
 
}}|
  
function_description=Creates a matcher from a pattern and input string.|
+
function_description=Checks to see if {{Pspan|mob}} can be faxed by any of the faxbots known to KoLmafia. This does not check if the faxbot(s) are online.<ref>https://sourceforge.net/p/kolmafia/code/20614/tree/src/net/sourceforge/kolmafia/textui/RuntimeLibrary.java#l4753</ref>|
  
needscode=yes|
+
code1={{CodeSample|
 +
title=Code Samples|
 +
description=This will acquire a copy of a scary pirate if you can get one.|
 +
code=
 +
<syntaxhighlight>
 +
if( get_property("_photocopyUsed")=="false" && can_faxbot($monster[scary pirate]) )
 +
faxbot($monster[scary pirate]);
 +
</syntaxhighlight>
 +
}}|
 +
see_also={{SeeAlso|faxbot|is_online}}|
 +
}}
 +
==References==
 +
<references/>
  
}}
+
[[Category:Miscellaneous Functions]]

Latest revision as of 23:53, 24 January 2021

Function Syntax

boolean can_faxbot(monster mob )

  • mob is the monster for which to check.

Checks to see if mob can be faxed by any of the faxbots known to KoLmafia. This does not check if the faxbot(s) are online.[1]

Code Samples

This will acquire a copy of a scary pirate if you can get one.

if( get_property("_photocopyUsed")=="false" && can_faxbot($monster[scary pirate]) )
 faxbot($monster[scary pirate]);

See Also

faxbot() | is_online()


References