FormatNumber - Revision history

AirNewSCR: Improved and optimized for performance and reliability issues, removed unnecessary codes.

2025-06-14T05:29:21Z

Improved and optimized for performance and reliability issues, removed unnecessary codes.

← Older revision		Revision as of 05:29, 14 June 2025
Line 1:		Line 1:
	{{Useful Function}} __NOTOC__		{{Useful Function}} __NOTOC__
	This function formats large numbers by adding ~~commas to it~~. For example, 100000 becomes 100 000<br>		This function formats large numbers by adding separators for thousands. For example, 100000 becomes 100 000.<br>

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">string formatNumber( int~~/string~~ number, [ string sep = " " ] )</syntaxhighlight>		<syntaxhighlight lang="lua">
			string formatNumber( int number, [ string sep = "." ] )
			</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	* '''number''': The number to be ~~converted~~.		* '''number''': The number to be formatted.

	===Optional Arguments===		===Optional Arguments===
	* '''sep''': A string of the ~~character you want to split~~		* '''sep''': A string used as the thousands separator. Default is '''"."'''.

	===Returns===		===Returns===
	Returns a string containing the ~~converted~~ number.		Returns a string containing the formatted number.

	==Code==		==Code==
	<section name="Example 1: Shared" class="both" show="true">		<section name="Example 1: Shared" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function formatNumber( ~~number~~, sep )		function formatNumber(n, sep)
	~~local debugInfo = debug.getinfo~~( ~~2, "Sl"~~ )		assert(type(n) == "number", "Bad argument @'formatNumber' [Expected number at argument 1, got "..type(n).."]")
	~~local debugSource~~ = ~~debugInfo and debugInfo.short_src or "unknown"~~		assert(not sep or type(sep) == "string", "Bad argument @'formatNumber' [Expected string or nil at argument 2, got "..type(sep).."]")
	~~local debugLine~~ = ~~debugInfo and debugInfo.currentline or~~ "~~unknown~~"		sep = sep or '.'
			local s = string.format("%.0f", n)
	~~if not tonumber( number ) then~~		repeat s, c = s:gsub("^(-?%d+)(%d%d%d)", "%1"..sep.."%2") until c == 0
	~~outputDebugString(~~		return s
	"Bad argument @'formatNumber' [Expected number at argument 1, got "..type(~~number~~).."] ~~"..~~
	~~"Called from: "..debugSource.." (line "..debugLine..~~")",
	2
	)
	~~error~~( ~~"Bad argument", 2 )~~
	~~end~~

	if sep ~~~= nil and~~ type( sep ) ~= "string" ~~then~~
	~~outputDebugString(~~
	"Bad argument @'formatNumber' [Expected string or nil at argument 2, got "..type(sep).."] ~~"..~~
	~~"Called from: "..debugSource.." (line "..debugLine..~~"~~)",~~
	2
	)
	~~error( "Bad argument", 2~~ )
	~~end~~

	sep = sep or ~~" "~~

	local ~~moneyStr~~ = ~~tostring( math~~.~~floor( tonumber~~( ~~number ) ) )~~
	~~local isNegative = moneyStr:sub( 1, 1 ) ==~~ "-"

	~~if isNegative then~~
	~~moneyStr = moneyStr:sub( 2~~ )
	~~end~~

	~~local len~~ = ~~moneyStr~~:~~len~~( )
	~~for i = 1, math.ceil~~( ~~len / 3 )~~ - ~~1 do~~
	~~local pos = len - 3 * i~~ + 1
	~~moneyStr = moneyStr:sub~~( 1, ~~pos -~~ 1 ) .. sep .. ~~moneyStr:sub( pos~~ )
	~~end~~

	return ~~( isNegative and "-" or "") .. moneyStr~~
	end		end
	</syntaxhighlight>		</syntaxhighlight>
Line 61:		Line 31:

	==Example==		==Example==

	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	This example converts a player's money, and outputs it to the chatbox when they type 'money' into the console:		This example converts a player's money and outputs it to the chatbox when they type '''money''' into the console:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function convertPlayerMoney()		function convertPlayerMoney()
	local pMoney = getPlayerMoney()		local pMoney = getPlayerMoney()
	local convertedMoney = formatNumber(pMoney)		local convertedMoney = formatNumber(pMoney)
	outputChatBox(convertedMoney)		outputChatBox(convertedMoney)
	end		end
	addCommandHandler("money", convertPlayerMoney)		addCommandHandler("money", convertPlayerMoney)
	</syntaxhighlight>		</syntaxhighlight>

	</section>		</section>

	==See Also==		==See Also==
	{{Useful_Functions}}		{{Useful_Functions}}

Claus at 13:47, 18 April 2025

2025-04-18T13:47:47Z

← Older revision		Revision as of 13:47, 18 April 2025
Line 1:		Line 1:
	{{Useful Function}} __NOTOC__		{{Useful Function}} __NOTOC__
	This function formats large numbers by adding commas to it. For example, 100000 becomes 100.000<br>		This function formats large numbers by adding commas to it. For example, 100000 becomes 100 000<br>

	==Syntax==		==Syntax==

Claus: /* Syntax */

2025-04-18T13:47:33Z

Syntax

← Older revision		Revision as of 13:47, 18 April 2025
Line 3:		Line 3:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">string formatNumber( int/string number, [ string sep = "." ] )</syntaxhighlight>		<syntaxhighlight lang="lua">string formatNumber( int/string number, [ string sep = " " ] )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

Claus: /* Code */

2025-04-18T13:47:06Z

Code

@@ Line 17: / Line 17: @@
 <section name="Example 1: Shared" class="both" show="true">
 <syntaxhighlight lang="lua">
-function formatNumber(number, sep)
+function formatNumber( number, sep )
-	assert(type(tonumber(number))=="number", "Bad argument @'formatNumber' [Expected number at argument 1 got "..type(number).."]")
+    local debugInfo = debug.getinfo( 2, "Sl" )
-	assert(not sep or type(sep)=="string", "Bad argument @'formatNumber' [Expected string at argument 2 got "..type(sep).."]")
+    local debugSource = debugInfo and debugInfo.short_src or "unknown"
-	sep = sep or '.'
+    local debugLine = debugInfo and debugInfo.currentline or "unknown"
-	local money = number
-	for i = 1, tostring(money):len()/3 do
+    if not tonumber( number ) then
-		money = string.gsub(money, "^(-?%d+)(%d%d%d)", "%1"..sep.."%2")
+        outputDebugString(
-	end
+            "Bad argument @'formatNumber' [Expected number at argument 1, got "..type(number).."] "..
-	return money
+            "Called from: "..debugSource.." (line "..debugLine..")",
 end
 </syntaxhighlight>

ItsHasaN: /* Code */

2024-04-10T10:57:41Z

Code

← Older revision		Revision as of 10:57, 10 April 2024
Line 20:		Line 20:
	assert(type(tonumber(number))=="number", "Bad argument @'formatNumber' [Expected number at argument 1 got "..type(number).."]")		assert(type(tonumber(number))=="number", "Bad argument @'formatNumber' [Expected number at argument 1 got "..type(number).."]")
	assert(not sep or type(sep)=="string", "Bad argument @'formatNumber' [Expected string at argument 2 got "..type(sep).."]")		assert(not sep or type(sep)=="string", "Bad argument @'formatNumber' [Expected string at argument 2 got "..type(sep).."]")
	sep = sep or '.'		sep = sep or '.'
	local money = number		local money = number
	for i = 1, tostring(money):len()/3 do		for i = 1, tostring(money):len()/3 do

ItsHasaN: /* Code */

2024-04-10T10:57:18Z

Code

← Older revision		Revision as of 10:57, 10 April 2024
Line 20:		Line 20:
	assert(type(tonumber(number))=="number", "Bad argument @'formatNumber' [Expected number at argument 1 got "..type(number).."]")		assert(type(tonumber(number))=="number", "Bad argument @'formatNumber' [Expected number at argument 1 got "..type(number).."]")
	assert(not sep or type(sep)=="string", "Bad argument @'formatNumber' [Expected string at argument 2 got "..type(sep).."]")		assert(not sep or type(sep)=="string", "Bad argument @'formatNumber' [Expected string at argument 2 got "..type(sep).."]")
			sep = sep or '.'
	local money = number		local money = number
	for i = 1, tostring(money):len()/3 do		for i = 1, tostring(money):len()/3 do

JeViCo: Removed incorrect 2nd approach

2023-03-27T14:18:44Z

Removed incorrect 2nd approach

@@ Line 25: / Line 25: @@
 	end
 	return money
 end
 </syntaxhighlight>

Alex7202 at 19:32, 9 April 2021

2021-04-09T19:32:03Z

← Older revision		Revision as of 19:32, 9 April 2021
Line 14:		Line 14:
	Returns a string containing the converted number.		Returns a string containing the converted number.

	==~~Example~~==		==Code==

	<section name="Example 1: Shared" class="both" show="true">		<section name="Example 1: Shared" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 41:		Line 40:
	</section>		</section>

	<section name="~~Example 3:~~ Client" class="client" show="true">		==Example==

			<section name="Client" class="client" show="true">
	This example converts a player's money, and outputs it to the chatbox when they type 'money' into the console:		This example converts a player's money, and outputs it to the chatbox when they type 'money' into the console:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Dutchman101: t

2020-12-12T22:10:39Z

← Older revision		Revision as of 22:10, 12 December 2020
Line 41:		Line 41:
	</section>		</section>

	<section name="Client" class="client" show="true">		<section name="Example 3: Client" class="client" show="true">
	This example converts a player's money, and outputs it to the chatbox when they type 'money' into the console:		This example converts a player's money, and outputs it to the chatbox when they type 'money' into the console:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Dutchman101: t

2020-12-12T22:10:19Z

← Older revision		Revision as of 22:10, 12 December 2020
Line 16:		Line 16:
	==Example==		==Example==

	<section name="Example 1: Shared" class="~~server~~" show="true">		<section name="Example 1: Shared" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function formatNumber(number, sep)		function formatNumber(number, sep)
Line 30:		Line 30:
	</section>		</section>

	<section name="Example 2: Shared" class="~~server~~" show="true">		<section name="Example 2: Shared" class="both" show="true">
	This example uses double string reverse & patterns to paste separator		This example uses double string reverse & patterns to paste separator
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">