To string: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>C22
No edit summary
imported>Deadned
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 28: Line 28:
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 (among other things) printing only a few decimal places, or placing commas to break up large numerals.|
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 (among other things) printing only a few decimal places, or placing commas to break up large numerals.|


needscode=yes|
code1={{CodeSample|
title=Code Sample|
description=Displays only two decimal places|
code=
<syntaxhighlight>
to_string(123.456789,"%.2f")
</syntaxhighlight>
Returned: 123.46}}
{{CodeSample|
description=Displays an integer with commas.|
code=<syntaxhighlight>
to_string(10000000,"%,d")
</syntaxhighlight>
Returned: 10,000,000}}|


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.|
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.|

Latest revision as of 04:14, 21 April 2013

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 (among other things) printing only a few decimal places, or placing commas to break up large numerals.

Code Sample

Displays only two decimal places

to_string(123.456789,"%.2f")

Returned: 123.46

Displays an integer with commas.

to_string(10000000,"%,d")

Returned: 10,000,000

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.