Difference between revisions of "To string"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
m
imported>C22
Line 15: Line 15:
 
}}|
 
}}|
  
function_description=Returns any datatype as its string equivalent.|
+
function2={{Function|
 +
name={{#var:name}}|
 +
aggregate={{#var:aggregate}}|
 +
return_type={{#var:return_type}}|
 +
return_also={{#var:return_also}}|
 +
parameter1= '''num''' {{pspan|number}}|
 +
parameter2= '''string''' {{pspan|format}}|
 +
p1desc={{Pspan|number}} is either an int or a float|
 +
p2desc={{Pspan|format}} is a format string used by the [http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Formatter.html Java formatter]|
 +
}}|
 +
 
 +
function_description=Returns any datatype as its string equivalent. For int and float types, you may optionally specify a format string, which can be useful for printing only a few decimal places, or placing commas to break up large numerals.|
  
 
needscode=yes|
 
needscode=yes|

Revision as of 04:33, 20 December 2012

needs(code_samples);

Function Syntax

string to_string( any anything)

  • anything is any data type that KoLmafia uses

string to_string( num number, string format)

  • number is either an int or a float
  • format is a format string used by the Java formatter

Returns any datatype as its string equivalent. For int and float types, you may optionally specify a format string, which can be useful for printing only a few decimal places, or placing commas to break up large numerals.

Special

Note that this function isn't needed for print() and string concatenation, as KoLmafia handles conversions transparently in those cases; however, this function is still useful for passing a non-string value as a string parameter, or a part thereof.