Inaccessible reason: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Bale
r9555
 
imported>Relyk
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{
{{
#vardefine:name|inaccessible_reason}}{{
#vardefine:name|inaccessible_reason}}{{
#vardefine:return_type|boolean}}{{
#vardefine:return_type|string}}{{


FunctionPage|
FunctionPage|
Line 9: Line 9:
name={{#var:name}}|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
aggregate={{#var:aggregate}}|
return_type=boolean|
return_type=string|
return_also={{#var:return_also}}|
return_also={{#var:return_also}}|
parameter1={{Param|coinmaster|master}}|
parameter1={{Param|coinmaster|master}}|
Line 33: Line 33:
}}|
}}|


see_also={{SeeAlso|inaccessible_reason|to_coinmaster|is_coinmaster_item}}|
see_also={{SeeAlso|is_accessible|to_coinmaster|is_coinmaster_item}}|
}}
}}


[[Category:Item Management]]
[[Category:Item Management]]

Latest revision as of 03:17, 27 September 2015

Function Syntax

string inaccessible_reason(coinmaster master )

  • master is the coinmaster to check

Returns a sentence explaining why master is currently unavailable. If master is available, then it returns an empty string.

Code Sample

Check if a coinmaster is available and if not, explains why.

boolean check(coinmaster master) {
   if(is_accessible(master))
      return true;
   print(master+ " is not accesible! "
      + inaccessible_reason(master));
   return false;
}

See Also

is_accessible() | to_coinmaster() | is_coinmaster_item()