WoW:API tonumber: Difference between revisions
Jump to navigation
Jump to search
m (remove signature) |
m (Proper notation for optional argument. Added notes.) |
||
| Line 1: | Line 1: | ||
Native Lua statement: | Native Lua statement: | ||
;''Arguments'' | ;''Arguments'' | ||
:'''tonumber(arg | :'''tonumber(arg[, base])''' | ||
::'''arg''' - this value will be converted to a numeric value. | ::'''arg''' - this value will be converted to a numeric value. | ||
::'''base''' - 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 may have a decimal part, as well as an optional exponent part. In other bases, only unsigned integers are accepted. | ::'''base''' - 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 may have a decimal part, as well as an optional exponent part. In other bases, only unsigned integers are accepted. | ||
| Line 20: | Line 19: | ||
tonumber("argqerg") | tonumber("argqerg") | ||
--Returns nil | --Returns nil | ||
tonumber("argqerg", 36) | |||
--Returns 4294967295 | |||
tonumber("13", 8) | tonumber("13", 8) | ||
| Line 26: | Line 28: | ||
tonumber ("D", 16) | tonumber ("D", 16) | ||
--Returns 13 | --Returns 13 | ||
== Notes == | |||
* This function always converts ''arg'' into base 10 (decimal). | |||
:If you want to convert from one base to another, you'll have to do the math yourself. | |||
* If ''base'' is less than 2 or greater than 36, an error will be thrown ("Base out of range"). | |||
* If ''arg'' cannot be converted from ''base'' to decimal, nil will be returned. | |||
{{LUA}} | {{LUA}} | ||
Revision as of 05:54, 23 September 2009
Native Lua statement:
- Arguments
- tonumber(arg[, base])
- arg - this value will be converted to a numeric value.
- base - 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 may have a decimal part, as well as an optional exponent part. In other bases, only unsigned integers are accepted.
- Returns
- The argument as a numeric value or nil if the value cannot be converted.
- Examples
tonumber("123")
--Returns 123
tonumber("argqerg")
--Returns nil
tonumber("argqerg", 36)
--Returns 4294967295
tonumber("13", 8)
--Returns 11
tonumber ("D", 16)
--Returns 13
Notes
- This function always converts arg into base 10 (decimal).
- If you want to convert from one base to another, you'll have to do the math yourself.
- If base is less than 2 or greater than 36, an error will be thrown ("Base out of range").
- If arg cannot be converted from base to decimal, nil will be returned.