Kolmafia - User contributions [en]

To string

2013-04-21T04:14:07Z

Deadned:

{{
#vardefine:name|to_string}}{{
#vardefine:return_type|string}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1= '''any''' {{pspan|anything}}|
p1desc={{Pspan|anything}} is any data type that KoLmafia uses|
}}|

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

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

}}

[[Category:Datatype Conversions]]

To string

2013-04-21T04:10:10Z

Deadned: Two examples for formatting

{{
#vardefine:name|to_string}}{{
#vardefine:return_type|string}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1= '''any''' {{pspan|anything}}|
p1desc={{Pspan|anything}} is any data type that KoLmafia uses|
}}|

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

code1={{CodeSample|
title=Code Sample|
description=Displays only two decimal places|
code=
<syntaxhighlight>
ash 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.|

}}

[[Category:Datatype Conversions]]