Outfit: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Bale
mNo edit summary
imported>PhilmASTErpLus
Added code sample
Line 17: Line 17:
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.|
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}}|

Revision as of 10:16, 26 June 2010

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()