Difference between revisions of "Outfit"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>Bale
(RFI Answered)
Line 16: Line 16:
 
}}|
 
}}|
  
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|
 
needscode=yes|
Line 23: Line 23:
 
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?)}}
 

Revision as of 09:17, 28 April 2010

needs(code_samples);

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.

CLI Equivalent

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

See Also

have_outfit()