WoW:Lua functions - Revision history

Bear at 21:18, 2 August 2025

2025-08-02T21:18:43Z

← Older revision		Revision as of 21:18, 2 August 2025
Line 1:		Line 1:
	__NOWYSIWYG__{{wowlua}}		__NOWYSIWYG__{{wowlua}}
	This is the main reference for ~~the WoW Ui '~~Lua ~~runtime'~~ in World of Warcraft. Note: these are mostly standard Lua functions available in most Lua environments. Can also just refer to the [http://www.lua.org Lua.org] web site for Lua 5.1, but a few functions differ in Blizzard's implementation. All are all documented here for consistency, and to allow for commentary here.		This is the main reference for [[Lua]] in [[w:c:World of Warcraft\|World of Warcraft]]. Note: these are mostly standard Lua functions available in most Lua environments. Can also just refer to the [http://www.lua.org Lua.org] web site for Lua 5.1, but a few functions differ in Blizzard's implementation. All are all documented here for consistency, and to allow for commentary here.

	== Reference ==		== Reference ==

Move page script: Move page script moved page Lua functions to WoW:Lua functions without leaving a redirect

2023-08-15T04:48:34Z

Move page script moved page Lua functions to Lua functions without leaving a redirect

← Older revision	Revision as of 04:48, 15 August 2023
(No difference)

Bear at 19:39, 10 August 2022

2022-08-10T19:39:17Z

← Older revision		Revision as of 19:39, 10 August 2022
Line 1:		Line 1:
	__NOWYSIWYG__{{wowlua}}		__NOWYSIWYG__{{wowlua}}
	This is the main reference for the UI Lua runtime in World of Warcraft. Note these are mostly standard Lua functions available in most Lua environments. ~~Arguably could~~ just refer to the [http://www.lua.org Lua.org] web site, but a few functions differ in Blizzard's implementation. ~~They~~ are all documented here for consistency and to allow for commentary.		This is the main reference for the WoW Ui 'Lua runtime' in World of Warcraft. Note: these are mostly standard Lua functions available in most Lua environments. Can also just refer to the [http://www.lua.org Lua.org] web site for Lua 5.1, but a few functions differ in Blizzard's implementation. All are all documented here for consistency, and to allow for commentary here.

	== Reference ==		== Reference ==
	The [[w:c:World of Warcraft\|World of Warcraft]] Lua runtime does not provide all standard [[Lua]] functions. Notably, the operating system and file I/O libraries are not present. Nearly all of these functions are part of the default Lua 5.1 runtime environment, described [http://www.lua.org/manual/5.1/manual.html here].		The [[w:c:World of Warcraft\|World of Warcraft]] Lua runtime does not provide all of the standard [[Lua]] functions. Notably, the operating system and file I/O libraries are not present. Nearly all of these functions are part of the default Lua 5.1 runtime environment, described [http://www.lua.org/manual/5.1/manual.html here].

	=== Core ===		=== Core ===
Line 124:		Line 124:
	=== String Functions ===		=== String Functions ===
	* All strings have their metatable set to index the global string table, so any string function may be called through it with the colon syntax:		* All strings have their metatable set to index the global string table, so any string function may be called through it with the colon syntax:
	-- This...		<pre>
	local s = string.format(input, arg1, arg2, ...)		-- This...
			local s = string.format(input, arg1, arg2, ...)
	-- ...can be written as this		</pre>
	local s = input:format(arg1, arg2, ...) -- input gets passed as the first argument, replicating the above code, as per the colon syntax
			<pre>
			-- ...can be written as this
			local s = input:format(arg1, arg2, ...) -- input gets passed as the first argument, replicating the above code, as per the colon syntax
			</pre>

	To make this work for string constants, you have to use parentheses. "%d":format(arg1) is not valid Lua code, you have to do		To make this work for string constants, you have to use parentheses. "%d":format(arg1) is not valid Lua code, you have to do
	("%d"):format(arg1)		<pre>
			("%d"):format(arg1)
			</pre>

	Since this uses the string table, any function placed inside the string table works the same. The following is valid:		Since this uses the string table, any function placed inside the string table works the same. The following is valid:
	function string.print(a)		<pre>
	return print(a)		function string.print(a)
	end		return print(a)
	("test"):print()		end
			("test"):print()
			</pre>

	Though you should try to avoid populating the string table with your own functions.		Though you should try to avoid populating the string table with your own functions.

Line 143:		Line 153:
	** There's no practical reason for doing this, but it's kinda fun to know these useless things.		** There's no practical reason for doing this, but it's kinda fun to know these useless things.
	** '''Notice''' that [[API wipe\|table.wipe]] (and [[API wipe\|wipe]]) will remove itself and all other methods assigned in this manner.		** '''Notice''' that [[API wipe\|table.wipe]] (and [[API wipe\|wipe]]) will remove itself and all other methods assigned in this manner.
	tab = {}		<pre>
			tab = {}
	-- this works, of course.
	tinsert(tab, 1, value) -- change the value at index 1 to value.		-- this works, of course.
			tinsert(tab, 1, value) -- change the value at index 1 to value.
	-- as does this
	tab.insert = tinsert		-- as does this
	tab:insert(1, value) -- change the value at index 1 to value (note the ":").		tab.insert = tinsert
			tab:insert(1, value) -- change the value at index 1 to value (note the ":").
			</pre>

	== See also ==		== See also ==

Bear at 08:43, 21 May 2020

2020-05-21T08:43:22Z

← Older revision		Revision as of 08:43, 21 May 2020
Line 1:		Line 1:
	__NOWYSIWYG__{{wowlua}}		__NOWYSIWYG__{{wowlua}}
	This is the main reference for the World of Warcraft ~~Lua Runtime~~. Note ~~that~~ these are mostly standard Lua functions, available in most Lua environments. Arguably~~, we~~ could just refer to the [http://www.lua.org Lua web site], but a few functions differ ~~slightly~~ in Blizzard's implementation. They are all documented here for consistency.		This is the main reference for the UI Lua runtime in World of Warcraft. Note these are mostly standard Lua functions available in most Lua environments. Arguably could just refer to the [http://www.lua.org Lua.org] web site, but a few functions differ in Blizzard's implementation. They are all documented here for consistency and to allow for commentary.

	== Reference ==		== Reference ==
	The [[World of Warcraft]] Lua runtime does not provide all standard [[Lua]] functions. Notably, the operating system and file I/O libraries are not present. Nearly all of these functions are part of the default Lua 5.1 runtime environment, described [http://www.lua.org/manual/5.1/manual.html here].		The [[w:c:World of Warcraft\|World of Warcraft]] Lua runtime does not provide all standard [[Lua]] functions. Notably, the operating system and file I/O libraries are not present. Nearly all of these functions are part of the default Lua 5.1 runtime environment, described [http://www.lua.org/manual/5.1/manual.html here].

	=== Core ===		=== Core ===
Line 120:		Line 120:

	== Notes ==		== Notes ==
	~~Some~~ WoW specific Lua notes.		WoW specific Lua notes.

	=== String Functions ===		=== String Functions ===
Line 155:		Line 155:
	* [[Lua]], which has plenty of links to other reference material.		* [[Lua]], which has plenty of links to other reference material.
	* [[API types]], with a list of Lua types and 'psudo-types' used in WoW.		* [[API types]], with a list of Lua types and 'psudo-types' used in WoW.
			[[Category:Lua]]

Authors on WoWWiki: This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

2015-01-07T01:49:51Z

This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

Show changes

Bear: /* String */

2015-01-07T01:49:50Z

String

← Older revision	Revision as of 01:49, 7 January 2015
(No difference)

WoWWiki>Ioctl: /* Bit Functions */

2013-06-28T15:19:31Z

Bit Functions

← Older revision	Revision as of 15:19, 28 June 2013
(No difference)

WoWWiki>Sixcorners: Added section: coroutunes.. copied from lua manual.. someone please confirm information

2011-01-13T12:45:10Z

Added section: coroutunes.. copied from lua manual.. someone please confirm information

← Older revision	Revision as of 12:45, 13 January 2011
(No difference)

WoWWiki>Mecdemort at 23:59, 16 September 2009

2009-09-16T23:59:22Z

← Older revision	Revision as of 23:59, 16 September 2009
(No difference)

WoWWiki>Starlightblunder: slight tweaks

2009-06-01T23:50:08Z

slight tweaks

← Older revision	Revision as of 23:50, 1 June 2009
(No difference)