WoW:API EditBox GetNumber - Revision history

Move page script: Move page script moved page API EditBox GetNumber to WoW:API EditBox GetNumber without leaving a redirect

2023-08-15T04:45:27Z

Move page script moved page API EditBox GetNumber to API EditBox GetNumber without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>Corwin MacGregor: /* Note */ Added comment about checking for literal zero in text

2010-04-03T11:01:39Z

Note: Added comment about checking for literal zero in text

← Older revision		Revision as of 11:01, 3 April 2010
Line 25:		Line 25:
	* "14e6" => 14000000		* "14e6" => 14000000
	* "21,000" => 21		* "21,000" => 21

			== Note ==
			To verify that a 0 returned is indeed the numerical value in the editbox field, convert the results of '''GetNumber()''' to a string using [[API tostring\|tostring()]], and compare to the results of [[API EditBox GetText\|GetText()]].

WoWWiki>Fibby at 04:27, 8 September 2007

2007-09-08T04:27:28Z

← Older revision		Revision as of 04:27, 8 September 2007
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}}

	~~<center>~~'~~''GetNumber''' ''-Documentation by DerGhulbus-''</center>~~		This function reads text entered into the editBox, tries to convert it into a number, and returns corresponding numerical value, or 0 if text didn't look like a number.

	~~number~~ = editBox:GetNumber()		num = editBox:GetNumber()

	~~If a number was entered, it returns a numerical value of the number. If anything else was entered (including nil) it returns 0.~~		=== Arguments ===
			:''none''

	~~----~~		=== Returns ===
	~~;''Arguments''~~

	~~''none''~~		:;num: number entered in the EditBox
	~~----~~
	;~~''Returns''~~

	~~:number~~		=== Details ===
	~~:;number: Number - corresponding to the number entered in the EditBox~~

	~~----~~
	~~;''~~Details''

	This function proves to be very useful when reading in numbers. While [[API EditBox GetText\|GetText()]] will return a string, which you can't perform any arithmetic operations or comparison with, this function converts the TextString to a number. This will even work for all strings that are considered as well formed numerical constants in lua (so it will work for '314.16e-2' too).		This function proves to be very useful when reading in numbers. While [[API EditBox GetText\|GetText()]] will return a string, which you can't perform any arithmetic operations or comparison with, this function converts the TextString to a number. This will even work for all strings that are considered as well formed numerical constants in lua (so it will work for '314.16e-2' too).

	~~If you enter~~ a ~~string~~, or ~~a hybrid like~~ '~~abc123def~~'~~, the function~~ returns 0.		Function will scan editbox text and return once it finds text which cannot be interpreted as part of a number. It will return number ''recognized so far'', or 0 if there were no valid digits recognized. The function will never return '''nil'''. For example (User input => Function returns):
			* ":)" => 0
	~~If you enter a hybrid like 12abc34 the function will ignore everything after the last valid digit (thus returning 12 in the example)~~		* "123punks! 42" => 123
			* "-2.78" => -2.7799999713898
			* "+3.15" => 0
			* "222e-03" => 0.22200000286102
			* "0.31415926536e+1" => 3.1415927410126
			* "14e6" => 14000000
			* "21,000" => 21

WoWWiki>Mikk: {{widgetmethod}}

2006-06-10T11:47:22Z

← Older revision		Revision as of 11:47, 10 June 2006
Line 1:		Line 1:
			{{widgetmethod}}

	<center>'''GetNumber''' ''-Documentation by DerGhulbus-''</center>		<center>'''GetNumber''' ''-Documentation by DerGhulbus-''</center>

Line 23:		Line 25:

	If you enter a hybrid like 12abc34 the function will ignore everything after the last valid digit (thus returning 12 in the example)		If you enter a hybrid like 12abc34 the function will ignore everything after the last valid digit (thus returning 12 in the example)

	~~----~~
	~~{{Template:WoW API}}~~

WoWWiki>Anticrash at 15:45, 4 January 2006

2006-01-04T15:45:56Z

← Older revision		Revision as of 15:45, 4 January 2006
Line 26:		Line 26:
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}
	~~[[Category:API Functions\|EditBox]]~~

WoWWiki>DerGhulbus: i just read the type is really number, not float; strange language, this lua ;)

2005-03-12T13:37:38Z

i just read the type is really number, not float; strange language, this lua ;)

New page

<center>'''GetNumber''' ''-Documentation by DerGhulbus-''</center>

number = editBox:GetNumber()

If a number was entered, it returns a numerical value of the number. If anything else was entered (including nil) it returns 0.

----
;''Arguments''

''none''
----
;''Returns''

:number
:;number: Number - corresponding to the number entered in the EditBox

----
;''Details''

This function proves to be very useful when reading in numbers. While [[API EditBox GetText|GetText()]] will return a string, which you can't perform any arithmetic operations or comparison with, this function converts the TextString to a number. This will even work for all strings that are considered as well formed numerical constants in lua (so it will work for '314.16e-2' too).

If you enter a string, or a hybrid like 'abc123def', the function returns 0.

If you enter a hybrid like 12abc34 the function will ignore everything after the last valid digit (thus returning 12 in the example)

----
{{Template:WoW API}}
[[Category:API Functions|EditBox]]