Difference between pages "Use familiar" and "Familiar equipped equipment"

From Kolmafia
(Difference between pages)
Jump to navigation Jump to search
imported>Bale
m
 
imported>StDoodle
m
 
Line 1: Line 1:
 
{{
 
{{
#vardefine:name|use_familiar}}{{
+
#vardefine:name|familiar_equipped_equipment}}{{
#vardefine:return_type|boolean}}{{
+
#vardefine:return_type|item}}{{
  
 
FunctionPage|
 
FunctionPage|
 
name={{#var:name}}|
 
name={{#var:name}}|
 +
function_category=Equipment|
  
 
function1={{Function|
 
function1={{Function|
Line 11: Line 12:
 
return_type={{#var:return_type}}|
 
return_type={{#var:return_type}}|
 
return_also={{#var:return_also}}|
 
return_also={{#var:return_also}}|
parameter1={{Param|familiar|buddy}}|
+
parameter1={{Param|familiar|check_me}}|
p1desc={{Pspan|buddy}} is the familiar to equip|
+
p1desc={{Pspan|check_me}} is the familiar to check|
 
}}|
 
}}|
  
function_description=Switches your current familiar for the the  familiar {{pspan|buddy}} specified. Returns true if the specified familiar {{pspan|buddy}} is your current familiar after the function's completion (so it will return true if you try to switch to your current familiar).|
+
function_description=Returns the familiar equipment worn by the specified familiar {{pspan|check_me}}. If {{pspan|check_me}} is not wearing any equipment, or you do not have that familiar, it will return $item[none].|
  
 
needscode=yes|
 
needscode=yes|
  
see_also={{SeeAlso|have_familiar}}|
+
see_also={{SeeAlso|familiar_equipment}}|
cli_equiv=The CLI command "familiar" has the same function when a familiar type is specified as the only parameter.|
 
 
}}
 
}}
 
[[Category:Equipment]]
 

Revision as of 21:20, 8 March 2010

needs(code_samples);

Function Syntax

item familiar_equipped_equipment(familiar check_me )

  • check_me is the familiar to check

Returns the familiar equipment worn by the specified familiar check_me. If check_me is not wearing any equipment, or you do not have that familiar, it will return $item[none].

See Also

familiar_equipment()