Difference between revisions of "Tostring"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:
 
=== Description ===
 
=== Description ===
 
Receives an argument of any type and converts it to a string in a reasonable format.
 
Receives an argument of any type and converts it to a string in a reasonable format.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(string) = tostring(e)
 
(string) = tostring(e)
 
</source>
 
</source>

Revision as of 15:31, 13 July 2023

Available since: Gideros 2011.6
Class: (global)

Description

Receives an argument of any type and converts it to a string in a reasonable format. <syntaxhighlight lang="lua"> (string) = tostring(e) </source>

For complete control of how numbers are converted, use string.format.

If the metatable of e has a "__tostring" field, then tostring calls the corresponding value with e as argument, and uses the result of the call as its result.

Parameters

e: (any) value to convert to string

Return values

Returns (string) value converted to string or nil