Lua:playSound - Revision history

Leunsel: Syntax Highlighting.

2026-06-25T20:18:53Z

Syntax Highlighting.

Leunsel at 03:58, 21 June 2026

2026-06-21T03:58:13Z

Dark Byte: mention speak command

2018-05-01T21:35:57Z

mention speak command

Jgoemat: /* Creating Files */

2018-05-01T21:16:33Z

‎Creating Files

Jgoemat: /* Creating Files */

2018-05-01T21:16:10Z

‎Creating Files

TheyCallMeTim13: /* Related Functions */

2018-01-25T00:54:38Z

‎Related Functions

TheyCallMeTim13: moved playSound to Lua:playSound

2018-01-25T00:09:34Z

moved playSound to Lua:playSound

TheyCallMeTim13 at 21:43, 19 March 2017

2017-03-19T21:43:43Z

TheyCallMeTim13 at 13:26, 19 March 2017

2017-03-19T13:26:28Z

Jgoemat: /* Samples */

2015-12-23T00:52:59Z

‎Samples

@@ Line 34: / Line 34: @@
 ===Examples===
-<pre>
+<syntaxhighlight lang="lua" line>
 playSound(findTableFile("Activate"))
 -- Wait until the sound has finished playing
 playSound(findTableFile("Deactivate"), true)
-</pre>
+</syntaxhighlight>
 {{LuaSeeAlso}}

@@ Line 1: / Line 1: @@
 [[Category:Lua]]
-'''function''' playSound(''stream'', ''waittilldone'')
+{{CodeBox|'''function''' playSound(''stream'', ''waittilldone'') ''':''' void}}
-'''function''' playSound(''tablefile'', ''waittilldone'')
+Plays a .WAV formatted sound from either a memory stream or a table file.
-Plays a sound file
+When a memory stream is provided, it must contain a .WAV formatted memory object. When a table file is provided, the memory stream stored inside the table file will be used and played.
 ===Function Parameters===
-{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
+{|width="85%" cellpadding="10%" cellspacing="0" border="0"
 !align="left"|Parameter
 !align="left"|Type
-!style="width: 60%;background-color:white;" align="left"|Description
+!style="width: 80%;background-color:white;" align="left"|Description
 |-
 |stream
-|[[Stream]]
+|MemoryStream
-|A Stream object, can be [[MemoryStream]] or [[FileStream]]
+|A memory stream containing a .WAV formatted memory object.
 |-
 |tablefile
-|[[TableFile]]
+|TableFile
-|A [[TableFile]] object, a file added and stored in the cheat table
+|A table file containing a memory stream that will be played as sound.
 |-
 |waittilldone
-|Boolean
+|Boolean (optional)
-|If true, the next LUA instruction will not execute until the sound is done playing
+|If true, the script waits until the sound has finished playing before continuing execution.
 |}
-===Samples===
+===Returns===
-Calling from LUA
+===Examples===
-<pre>playSound(findTableFile('protected.wav'))</pre>
+-- Wait until the sound has finished playing
+playSound(findTableFile("Deactivate"), true)
 </pre>
 {{LuaSeeAlso}}

@@ Line 49: / Line 49: @@
 used "File->Export Selected Audio" to export it as 'WAV (Microsoft) signed 16-bit PCM'.
-You can use a free online text-to-speech wav file generator at http://www.text2speech.org/.
+You can use a free online text-to-speech wav file generator at http://www.text2speech.org/ or use [[Lua:speak]]
 {{LuaSeeAlso}}

@@ Line 49: / Line 49: @@
 used "File->Export Selected Audio" to export it as 'WAV (Microsoft) signed 16-bit PCM'.
-You can use a free online text-to-speech wav file generator at [http://www.text2speech.org/](http://www.text2speech.org/).
+You can use a free online text-to-speech wav file generator at http://www.text2speech.org/.
 {{LuaSeeAlso}}

@@ Line 48: / Line 48: @@
 worked for me.  I recorded my microphone and selected just the portion I wanted, then
 used "File->Export Selected Audio" to export it as 'WAV (Microsoft) signed 16-bit PCM'.
 {{LuaSeeAlso}}

@@ Line 52: / Line 52: @@
 === Related Functions ===
-* [[findTableFile]]
+* [[Lua:findTableFile|findTableFile]]
 * [[Stream]]
-* [[FileStream]]
+=== Related Classes ===
-* [[MemoryStream]]
+* [[Lua:Class:Stream|Stream]]

← Older revision	Revision as of 00:09, 25 January 2018
(No difference)

← Older revision		Revision as of 13:26, 19 March 2017
Line 1:		Line 1:
		+	[[Category:Lua]]
	'''function''' playSound(''stream'', ''waittilldone'')		'''function''' playSound(''stream'', ''waittilldone'')

@@ Line 42: / Line 42: @@
    dd 2
 </pre>
 == See also ==