Difference between revisions of "Is goal"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
(Created page with '{{ #vardefine:name|is_goal}}{{ #vardefine:return_type|boolean}}{{ FunctionPage| name={{#var:name}}| function_category=Adventuring| function1={{Function| name={{#var:name}}| agg…')
 
imported>Bale
(That ceased to be true some time ago. Update.)
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
FunctionPage|
 
FunctionPage|
 
name={{#var:name}}|
 
name={{#var:name}}|
function_category=Adventuring|
 
  
 
function1={{Function|
 
function1={{Function|
Line 16: Line 15:
 
}}|
 
}}|
  
function_description=Checks to see if any adventuring goals would be satisfied by a {{pspan|want}}. Unfortunately there is currently no way to check for a non-item goal.|
+
function_description=Checks to see if any adventuring goals would be satisfied by a {{pspan|want}}. For a non-item goal you need to use {{f|get_goals}} or {{f|goal_exists}}.|
  
 
needscode=yes|
 
needscode=yes|
  
see_also={{SeeAlso|adventure|add_item_condition}}|
+
see_also={{SeeAlso|adventure|add_item_condition|get_goals|goal_exists}}|
 
}}
 
}}
 +
 +
[[Category:Adventuring]]

Latest revision as of 02:45, 5 November 2014

needs(code_samples);

Function Syntax

boolean is_goal(item want )

  • want is checked to see if it is a goal

Checks to see if any adventuring goals would be satisfied by a want. For a non-item goal you need to use get_goals() or goal_exists().

See Also

adventure() | add_item_condition() | get_goals() | goal_exists()