Difference between pages "Minstrel instrument" and "Lock familiar equipment"

From Kolmafia
(Difference between pages)
Jump to navigation Jump to search
imported>Bale
(Created page with "{{ #vardefine:name|minstrel_instrument}}{{ #vardefine:return_type|item}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggre...")
 
imported>Bale
(r11197)
 
Line 1: Line 1:
 
{{
 
{{
#vardefine:name|minstrel_instrument}}{{
+
#vardefine:name|lock_familiar_equipment}}{{
#vardefine:return_type|item}}{{
+
#vardefine:return_type|void}}{{
  
 
FunctionPage|
 
FunctionPage|
Line 10: Line 10:
 
aggregate={{#var:aggregate}}|
 
aggregate={{#var:aggregate}}|
 
return_type={{#var:return_type}}|
 
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
+
return_also={{#var:return_also}}|
 +
parameter1={{Param|booean|locking}}|
 +
p1desc={{Pspan|locking}} is the desired lock status|
 
}}|
 
}}|
  
function_description=If you are on the "Avatar of Boris" challenge path this will return the item currently equipped on Boris' minstrel, Clancy. If you are not currently on that quest it will always return $item[none].|
+
function_description=This function will lock familiar equipment if {{Pspan|locking}} is true or unlock familiar equipment if {{Pspan|locking}} is false. If there is no need to change locking status, then this function will do nothing.|
  
needscode=yes|
+
code1={{CodeSample|
 +
title=Code Samples|
 +
description=|
 +
code=
 +
<syntaxhighlight>
 +
if( equipped_item($slot[familiar]) == $item[miniature life preserver] && !is_familiar_equipment_locked() )
 +
  lock_familiar_equipment(true);
 +
</syntaxhighlight>
 +
}}|
  
see_also={{SeeAlso|minstrel_quest|minstrel_level}}|
+
see_also={{SeeAlso|is_familiar_equipment_locked|my_familiar}}|
 
}}
 
}}
  
 
[[Category:Your Character]]
 
[[Category:Your Character]]

Latest revision as of 07:24, 11 November 2014

Function Syntax

void lock_familiar_equipment(booean locking )

  • locking is the desired lock status

This function will lock familiar equipment if locking is true or unlock familiar equipment if locking is false. If there is no need to change locking status, then this function will do nothing.

Code Samples

if( equipped_item($slot[familiar]) == $item[miniature life preserver] && !is_familiar_equipment_locked() )
   lock_familiar_equipment(true);

See Also

is_familiar_equipment_locked() | my_familiar()