Familiar equipped equipment: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
Created page with '{{#vardefine:name|familiar_equipped_equipment}} {{#vardefine:return_type|item}} {{FunctionPage| name={{#var:name}}| function_category=Equipment| function1={{Function| name={{#v…'
 
imported>Eliteofdelete
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{#vardefine:name|familiar_equipped_equipment}}
{{
{{#vardefine:return_type|item}}
#vardefine:name|familiar_equipped_equipment}}{{
#vardefine:return_type|item}}{{


{{FunctionPage|
FunctionPage|
name={{#var:name}}|
name={{#var:name}}|
function_category=Equipment|


function1={{Function|
function1={{Function|
Line 16: Line 16:


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].|
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].|
code1={{CodeSample|
title=Code Samples|
description=This example tells you what your current familiar has equipped.|
code=
<syntaxhighlight>
item fam_equip = familiar_equipped_equipment(my_familiar());
if (fam_equip == $item[none])
  print("Your familiar "+my_familiar()+" currently has nothing equipped.", "blue");
else print("Your familiar "+my_familiar()+" currently has "+fam_equip+" equipped.", "blue");
</syntaxhighlight>|


needscode=yes|
}}|


see_also={{SeeAlso|familiar_equipment}}|
see_also={{SeeAlso|familiar_equipment}}|
}}
}}
[[Category:Equipment]]

Latest revision as of 03:33, 14 January 2015

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].

Code Samples

This example tells you what your current familiar has equipped.

item fam_equip = familiar_equipped_equipment(my_familiar());
if (fam_equip == $item[none])
   print("Your familiar "+my_familiar()+" currently has nothing equipped.", "blue");
else print("Your familiar "+my_familiar()+" currently has "+fam_equip+" equipped.", "blue");

See Also

familiar_equipment()