Difference between revisions of "Enthrone familiar"

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
(moved Enthrone to Enthrone (CLI): Also an ASH command for this, now.)
 
imported>Heeheehee
m (New page, crude code sample.)
Line 1: Line 1:
#REDIRECT [[Enthrone (CLI)]]
+
{{
 +
#vardefine:name|enthrone}}{{
 +
#vardefine:return_type|boolean}}{{
 +
 
 +
FunctionPage|
 +
name={{#var:name}}|
 +
function_category=Equipment|
 +
 
 +
function1={{Function|
 +
name={{#var:name}}|
 +
aggregate={{#var:aggregate}}|
 +
return_type={{#var:return_type}}|
 +
return_also={{#var:return_also}}|
 +
parameter1={{Param|slot|check}}|
 +
p1desc={{Pspan|check}} is the item slot to check|
 +
}}|
 +
 
 +
function_description=Enthrones the specified familiar if you have the Crown of Thrones equipped.|
 +
 
 +
code1={{CodeSample|
 +
title=Code Sample|
 +
description=Returns true if the El Vibrato Megadrone is successfully equipped to the Crown of Thrones.|
 +
code=
 +
<syntaxhighlight>
 +
boolean enthrone_megadrone() {
 +
  if (equipped_item($slot[hat])==$item[Crown of Thrones] && my_enthroned_familiar()!=$familiar[el vibrato megadrone])
 +
      return enthrone($familiar[megadrone]);
 +
  return false;
 +
}
 +
</syntaxhighlight>}}|
 +
 
 +
see_also={{SeeAlso|my_enthroned_familiar|equipped_item}}|
 +
cli_equiv=The CLI command "enthrone" has similar functionality.|
 +
}}

Revision as of 03:59, 21 May 2010

Function Syntax

boolean enthrone(slot check )

  • check is the item slot to check

Enthrones the specified familiar if you have the Crown of Thrones equipped.

Code Sample

Returns true if the El Vibrato Megadrone is successfully equipped to the Crown of Thrones.

boolean enthrone_megadrone() {
   if (equipped_item($slot[hat])==$item[Crown of Thrones] && my_enthroned_familiar()!=$familiar[el vibrato megadrone])
      return enthrone($familiar[megadrone]);
   return false;
}

CLI Equivalent

The CLI command "enthrone" has similar functionality.

See Also

my_enthroned_familiar() | equipped_item()