Outfit: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
Created page with '{{#vardefine:name|outfit}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Equipment| function1={{Function| name={{#var:name}}| aggrega…'
 
imported>Bale
r9018 outfit_pieces
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{#vardefine:name|outfit}}
{{
{{#vardefine:return_type|boolean}}
#vardefine:name|outfit}}{{
#vardefine:return_type|boolean}}{{


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


function1={{Function|
function1={{Function|
Line 15: Line 15:
}}|
}}|


function_description=This function attempts to put on the outfit specified as {{pspan|name}}, and returns true if it does so successfully, and false if it does not.|
function_description=This function attempts to put on the outfit specified as {{pspan|name}}, and returns true if it does so successfully, and false if it does not. It will return false for any reason that you cannot put on the outfit including insufficient stats, not having the items or a server timeout.|


needscode=yes|
code1={{CodeSample|
title=Code Sample|
description=The following code will attempt to wear the [http://kol.coldfront.net/thekolwiki/index.php/Knob_Goblin_Harem_Girl_Disguise Knob Goblin Harem Girl Disguise].|
code=<syntaxhighlight>
if ( have_outfit( "Knob Goblin Harem Girl Disguise" ) )
  outfit( "Knob Goblin Harem Girl Disguise" );
else
  print( "You don't have the Knob Goblin Harem Girl Disguise." );
</syntaxhighlight>
}}|


see_also={{SeeAlso|have_outfit}}|
 
see_also={{SeeAlso|have_outfit|outfit_pieces}}|
cli_equiv=The CLI command command "outfit" with works similarly when supplied an outfit name as a parameter.|
cli_equiv=The CLI command command "outfit" with works similarly when supplied an outfit name as a parameter.|
}}
}}
{{RFI|What does this function return when attempting to switch to an outfit one cannot wear; false, as I would assume? Or does it only return false for programmatic / page load failures?)}}
 
[[Category:Equipment]]

Latest revision as of 05:20, 8 February 2011

Function Syntax

boolean outfit(string name )

  • name is an outfit to wear

This function attempts to put on the outfit specified as name, and returns true if it does so successfully, and false if it does not. It will return false for any reason that you cannot put on the outfit including insufficient stats, not having the items or a server timeout.

Code Sample

The following code will attempt to wear the Knob Goblin Harem Girl Disguise.

if ( have_outfit( "Knob Goblin Harem Girl Disguise" ) )
   outfit( "Knob Goblin Harem Girl Disguise" );
else
   print( "You don't have the Knob Goblin Harem Girl Disguise." );

CLI Equivalent

The CLI command command "outfit" with works similarly when supplied an outfit name as a parameter.

See Also

have_outfit() | outfit_pieces()