Tostring: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
<languages />
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
'''Class:''' [[(global)]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/(global)|(global)]]<br/>
=== <translate>Description</translate> ===
<translate>Receives an argument of any type and converts it to a string in a reasonable format. For complete control of how numbers are converted, use string.format.


If the ''metatable'' of e has a "__tostring" field, then [[Special:MyLanguage/tostring|tostring]] calls the corresponding value with e as argument, and uses the result of the call as its result.</translate>
=== Description ===
<source lang="lua">
Receives an argument of any type and converts it to a string in a reasonable format.
<syntaxhighlight lang="lua">
(string) = tostring(e)
(string) = tostring(e)
</source>
</syntaxhighlight>
=== <translate>Parameters</translate> ===
 
'''e''': (any) <translate>value to convert to string</translate> <br/>
For complete control of how numbers are converted, use string.format.
=== <translate>Return values</translate> ===
 
'''<translate>Returns</translate>''' (string) <translate>value converted to string or nil</translate><br/>
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<br/>
 
=== Return values ===
'''Returns''' (string) value converted to string or nil<br/>
 
=== See also ===
'''https://luau.org/library#global-functions'''<br/>
 
{{(global)}}

Latest revision as of 10:26, 21 July 2025

Available since: Gideros 2011.6
Class: (global)

Description

Receives an argument of any type and converts it to a string in a reasonable format.

(string) = tostring(e)
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

See also

https://luau.org/library#global-functions