Difference between revisions of "Enthrone familiar"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
imported>Bale
m
Line 5: Line 5:
 
FunctionPage|
 
FunctionPage|
 
name={{#var:name}}|
 
name={{#var:name}}|
function_category=Equipment|
 
  
 
function1={{Function|
 
function1={{Function|
Line 34: Line 33:
 
cli_equiv=The CLI command [[enthrone (CLI)|enthrone]] has similar functionality.|
 
cli_equiv=The CLI command [[enthrone (CLI)|enthrone]] has similar functionality.|
 
}}
 
}}
 +
 +
[[Category:Equipment]]

Revision as of 22:12, 21 May 2010

Function Syntax

boolean enthrone(familiar target )

  • target is the familiar to enthrone.

Enthrones the specified familiar. Returns false if something goes wrong with the enthroning process (e.g. the player does not have the specified familiar in his terrarium, or the player does not have a Crown of Thrones).

Code Sample

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

boolean enthrone_megadrone() {
   if (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()

Special

This command automatically equips the Crown of Thrones if it is not currently equipped.