Tostring: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
Line 2: Line 2:
'''Available since:''' Gideros 2011.6<br/>
'''Available since:''' Gideros 2011.6<br/>
=== Description ===
=== Description ===
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.  
<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 `tostring` calls the corresponding value with e as argument, and uses the result of the call as its result.
  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.</translate>
<source lang="lua">
<source lang="lua">
(string) = tostring(e)
(string) = tostring(e)
</source>
</source>
=== Parameters ===
=== Parameters ===
'''e''': (any) value to convert to string <br/>
'''e''': (any) <translate>value to convert to string</translate> <br/>
=== Return values ===
=== Return values ===
'''Returns''' (string) value converted to string or nil<br/>
'''Returns''' (string) <translate>value converted to string or nil</translate><br/>

Revision as of 12:38, 23 August 2018

Available since: Gideros 2011.6

Description

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 `tostring]]] calls the corresponding value with e as argument, and uses the result of the call as its result.
(string) = tostring(e)

Parameters

e: (any) value to convert to string

Return values

Returns (string) value converted to string or nil