WoW:API format - Revision history

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

2023-08-15T04:45:33Z

Move page script moved page API format to API format without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

Bear: /* Substitution escapes */

2016-08-29T20:32:22Z

Substitution escapes

← Older revision		Revision as of 20:32, 29 August 2016
Line 1:		Line 1:
	{{~~luaapi~~}}		{{wowlua}}
	string.format~~(formatstring, e1, e2~~, .~~..)~~		Creates a formatted string from format and substitution parameters, similar to sprintf in C.
	~~format(formatstring, e1, e2, ...)~~

	~~Create a formatted~~ string ~~from the~~ format ~~and arguments provided. This is similar to the printf~~(~~"format"~~,...) ~~function in C. An additional option %q returns string in a~~ format ~~that can safely be read back by Lua interpreter~~ (~~puts quotes around a string and escapes special characters)~~, ~~but used by World of Warcraft to preparse all strings before saving them between sessions~~.		local s = string.format(formatstring, e1, e2, ...)
			local s = format(formatstring, e1, e2, ...)

	* ~~c, d, E, e, f, g, G, i, o, u, X, and x all expect a number as argument.~~		== Parameters ==
	* ~~q and s expect a string~~.		* formatstring - the format string
			* ... - list of substitutions of any relevant type

	~~> =~~ string.format("%s %q", "Hello", "Lua user!") ~~-- string and quoted string~~		=== Returns ===
			* formatted string

			== Details ==
			Create a formatted string from the format and arguments provided. This is similar to the printf("format",...) function in C. An additional option %q returns string in a format that can safely be read back by Lua interpreter (puts quotes around a string and escapes special characters), but used by World of Warcraft to preparse all strings before saving them between sessions. Lua supports the following subset of the C format specifiers, plus Lua specific 'q'

			=== Substitution escapes ===
			* c, d, E, e, f, g, G, i, o, u, X, x (expect a number as argument)
			* q, s (expect a string as argument)
			* % (escape char, to produce % use %%)

			=== Examples ===
			String and quoted string
			string.format("%s %q", "Hello", "Lua user!")
	Hello "Lua user!"		Hello "Lua user!"
	~~> =~~ string.format("%c%c%c", 76,117,97) ~~-- char~~		Char
			string.format("%c%c%c", 76,117,97)
	Lua		Lua
	~~> =~~ string.format("%e, %E", math.pi,math.pi) ~~-- exponent~~		Exponent
			string.format("%e, %E", math.pi, math.pi)
	3.141593e+000, 3.141593E+000		3.141593e+000, 3.141593E+000
	~~> =~~ string.format("%f, %g, %.2f", math.pi, math.pi, math.pi) ~~-- float and compact float~~		Float and compact float
			string.format("%f, %g, %.2f", math.pi, math.pi, math.pi)
	3.141593, 3.14159, 3.14		3.141593, 3.14159, 3.14
	~~> =~~ string.format("%d, %i, %u", -100,-100,-100) ~~-- signed, signed, unsigned integer~~		Signed, signed, unsigned integer
			string.format("%d, %i, %u", -100,-100,-100)
	-100, -100, 4294967196		-100, -100, 4294967196
	~~> =~~ string.format("%o, %x, %X", -100,-100,-100) ~~-- octal, hex, hex~~		Octal, hex, hex
			string.format("%o, %x, %X", -100,-100,-100)
	37777777634, ffffff9c, FFFFFF9C		37777777634, ffffff9c, FFFFFF9C

	~~<br>~~

	Note: if you want a % character to be output as part of your format string, you need to enter %%~~. ie.~~		Note: if you want a % character to be output as part of your format string, you need to enter %%
	~~> =~~ string.format("Ratio is %u %%",12)		string.format("Ratio is %u %%",12)
	Ratio is 12 %		Ratio is 12 %

	~~<br>~~
	==== Macro Example ====		==== Macro Example ====
	This macro prints out the time remaining on the Polymorph debuff in seconds, rounded to the nearest whole number:		This macro prints out the time remaining on the Polymorph debuff in seconds, rounded to the nearest whole number:
	~~<pre>~~		/run for i=1,40 do local n,_,_,_,_,_,x,_,_=UnitDebuff("focus",i);if (n=="Polymorph")or (n=="Polymorph(Pig)")or (n=="Polymorph(Turtle)")then SendChatMessage('''format("%.0f"''',-1*(GetTime()-x)).." secs left on "..UnitName("focus").."'s CC!","EMOTE");end end
	/run for i=1,40 do local n,_,_,_,_,_,x,_,_=UnitDebuff("focus",i);if (n=="Polymorph")or (n=="Polymorph(Pig)")or (n=="Polymorph(Turtle)")then SendChatMessage('''format("%.0f"''',-1*(GetTime()-x)).." secs left on "..UnitName("focus").."'s CC!","EMOTE");end end
	~~</pre>~~

	== External links ==		== External links ==
	* http://www.gnu.org/software/libc/manual/html_node/Formatted-Output.html#Formatted-Output		* Lua string reference - https://www.lua.org/pil/20.html
			* GCC printf format - http://www.gnu.org/software/libc/manual/html_node/Formatted-Output.html#Formatted-Output

WoWWiki>Parallaxtz: removed opinion text

2010-07-10T20:49:01Z

removed opinion text

← Older revision		Revision as of 20:49, 10 July 2010
Line 3:		Line 3:
	format(formatstring, e1, e2, ...)		format(formatstring, e1, e2, ...)

	Create a formatted string from the format and arguments provided. This is similar to the printf("format",...) function in C. An additional option %q returns string in a format that can safely be read back by Lua interpreter (puts quotes around a string and escapes special characters)~~, it has little or no use in addon programming~~, but used by World of Warcraft to preparse all strings before saving them between sessions.		Create a formatted string from the format and arguments provided. This is similar to the printf("format",...) function in C. An additional option %q returns string in a format that can safely be read back by Lua interpreter (puts quotes around a string and escapes special characters), but used by World of Warcraft to preparse all strings before saving them between sessions.

	* c, d, E, e, f, g, G, i, o, u, X, and x all expect a number as argument.		* c, d, E, e, f, g, G, i, o, u, X, and x all expect a number as argument.

WoWWiki>Starlightblunder: {{luaapi}}

2010-03-25T22:39:41Z

← Older revision		Revision as of 22:39, 25 March 2010
Line 1:		Line 1:
	{{~~:Lua/Libshortcut\|format\|string.format~~}}		{{luaapi}}
	string.format(formatstring, e1, e2, ...)		string.format(formatstring, e1, e2, ...)
			format(formatstring, e1, e2, ...)

	Create a formatted string from the format and arguments provided. This is similar to the printf("format",...) function in C. An additional option %q returns string in a format that can safely be read back by Lua interpreter (puts quotes around a string and escapes special characters), it has little or no use in addon programming, but used by World of Warcraft to preparse all strings before saving them between sessions.		Create a formatted string from the format and arguments provided. This is similar to the printf("format",...) function in C. An additional option %q returns string in a format that can safely be read back by Lua interpreter (puts quotes around a string and escapes special characters), it has little or no use in addon programming, but used by World of Warcraft to preparse all strings before saving them between sessions.
Line 35:		Line 36:
	== External links ==		== External links ==
	* http://www.gnu.org/software/libc/manual/html_node/Formatted-Output.html#Formatted-Output		* http://www.gnu.org/software/libc/manual/html_node/Formatted-Output.html#Formatted-Output

	~~{{LUA}}~~

WoWWiki>LCAmethyst: Added note on outputting a % character within the format string

2009-09-20T22:06:52Z

Added note on outputting a % character within the format string

← Older revision		Revision as of 22:06, 20 September 2009
Line 20:		Line 20:
	37777777634, ffffff9c, FFFFFF9C		37777777634, ffffff9c, FFFFFF9C

			<br>

			Note: if you want a % character to be output as part of your format string, you need to enter %%. ie.
			> = string.format("Ratio is %u %%",12)
			Ratio is 12 %

	<br>		<br>
	==== Macro Example ====		==== Macro Example ====

WoWWiki>Belleboom at 23:15, 16 October 2008

2008-10-16T23:15:54Z

← Older revision		Revision as of 23:15, 16 October 2008
Line 19:		Line 19:
	> = string.format("%o, %x, %X", -100,-100,-100) -- octal, hex, hex		> = string.format("%o, %x, %X", -100,-100,-100) -- octal, hex, hex
	37777777634, ffffff9c, FFFFFF9C		37777777634, ffffff9c, FFFFFF9C

			<br>
			==== Macro Example ====
			This macro prints out the time remaining on the Polymorph debuff in seconds, rounded to the nearest whole number:
			<pre>
			/run for i=1,40 do local n,_,_,_,_,_,x,_,_=UnitDebuff("focus",i);if (n=="Polymorph")or (n=="Polymorph(Pig)")or (n=="Polymorph(Turtle)")then SendChatMessage('''format("%.0f"''',-1*(GetTime()-x)).." secs left on "..UnitName("focus").."'s CC!","EMOTE");end end
			</pre>

	== External links ==		== External links ==

WoWWiki>Watchout: added external link to printf manual node

2008-10-08T11:24:53Z

added external link to printf manual node

← Older revision		Revision as of 11:24, 8 October 2008
Line 19:		Line 19:
	> = string.format("%o, %x, %X", -100,-100,-100) -- octal, hex, hex		> = string.format("%o, %x, %X", -100,-100,-100) -- octal, hex, hex
	37777777634, ffffff9c, FFFFFF9C		37777777634, ffffff9c, FFFFFF9C

			== External links ==
			* http://www.gnu.org/software/libc/manual/html_node/Formatted-Output.html#Formatted-Output

	{{LUA}}		{{LUA}}

WoWWiki>Drundia at 23:48, 3 July 2006

2006-07-03T23:48:31Z

← Older revision		Revision as of 23:48, 3 July 2006
Line 2:		Line 2:
	string.format(formatstring, e1, e2, ...)		string.format(formatstring, e1, e2, ...)

	Create a formatted string from the format and arguments provided. This is similar to the printf("format",...) function in C. An additional option %q puts quotes around a string.		Create a formatted string from the format and arguments provided. This is similar to the printf("format",...) function in C. An additional option %q returns string in a format that can safely be read back by Lua interpreter (puts quotes around a string and escapes special characters), it has little or no use in addon programming, but used by World of Warcraft to preparse all strings before saving them between sessions.

	* c, d, E, e, f, g, G, i, o, u, X, and x all expect a number as argument.		* c, d, E, e, f, g, G, i, o, u, X, and x all expect a number as argument.

WoWWiki>Mikk: Fixed slight whoops with template call.

2006-05-26T12:23:26Z

Fixed slight whoops with template call.

← Older revision		Revision as of 12:23, 26 May 2006
Line 1:		Line 1:
			{{:Lua/Libshortcut\|format\|string.format}}
	string.format(formatstring, e1, e2, ...)		string.format(formatstring, e1, e2, ...)

Line 19:		Line 20:
	37777777634, ffffff9c, FFFFFF9C		37777777634, ffffff9c, FFFFFF9C

	~~----~~		{{LUA}}
	{{~~WoW API~~}}

WoWWiki>Slippingmind at 07:25, 23 April 2006

2006-04-23T07:25:29Z

← Older revision		Revision as of 07:25, 23 April 2006
Line 12:		Line 12:
	> = string.format("%e, %E", math.pi,math.pi) -- exponent		> = string.format("%e, %E", math.pi,math.pi) -- exponent
	3.141593e+000, 3.141593E+000		3.141593e+000, 3.141593E+000
	> = string.format("%f, %g", math.pi,math.pi) -- float and compact float		> = string.format("%f, %g, %.2f", math.pi, math.pi, math.pi) -- float and compact float
	3.141593, 3.14159		3.141593, 3.14159, 3.14
	> = string.format("%d, %i, %u", -100,-100,-100) -- signed, signed, unsigned integer		> = string.format("%d, %i, %u", -100,-100,-100) -- signed, signed, unsigned integer
	-100, -100, 4294967196		-100, -100, 4294967196