Difference between revisions of "Tonumber"
From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
| + | '''Class:''' [[(global)]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | Tries to convert its argument to a number. If the argument is already a number or a string convertible to a number, | + | Tries to convert its argument to a number. |
| + | <syntaxhighlight lang="lua"> | ||
| + | (number) = tonumber(e,base) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | If the argument is already a number or a string convertible to a number, ''tonumber'' returns this number, otherwise returns nil. | ||
| + | An optional argument specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive: | ||
| + | *in bases above 10, the letter 'A' (in either upper or lower case) represents 10, 'B' represents 11, and so forth, with 'Z' representing 35 | ||
| + | *in base 10 (the default), the number can have a decimal part, as well as an optional exponent part | ||
| + | *in other bases, only unsigned integers are accepted | ||
| − | |||
| − | |||
| − | |||
| − | |||
=== Parameters === | === Parameters === | ||
| − | '''e''': (any) value to convert to number <br/> | + | '''e''': (any) value to convert to number<br/> |
'''base''': (varies) the base to convert number to, default: 10 '''optional'''<br/> | '''base''': (varies) the base to convert number to, default: 10 '''optional'''<br/> | ||
| + | |||
=== Return values === | === Return values === | ||
'''Returns''' (number) returns the number or nil if it could not be converted<br/> | '''Returns''' (number) returns the number or nil if it could not be converted<br/> | ||
| + | |||
| + | {{(global)}} | ||
Latest revision as of 15:33, 13 July 2023
Available since: Gideros 2011.6
Class: (global)
Description
Tries to convert its argument to a number.
(number) = tonumber(e,base)
If the argument is already a number or a string convertible to a number, tonumber returns this number, otherwise returns nil.
An optional argument specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive:
- in bases above 10, the letter 'A' (in either upper or lower case) represents 10, 'B' represents 11, and so forth, with 'Z' representing 35
- in base 10 (the default), the number can have a decimal part, as well as an optional exponent part
- in other bases, only unsigned integers are accepted
Parameters
e: (any) value to convert to number
base: (varies) the base to convert number to, default: 10 optional
Return values
Returns (number) returns the number or nil if it could not be converted
