Difference between revisions of "PlaySound"

From Multi Theft Auto: Wiki
Jump to: navigation, search
(See Also)
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
 
{{Client function}}
 
{{Client function}}
Plays a specified sound for the local player.
+
Creates a [[sound]] element and plays it immediately after creation for the local player.
 
==Syntax==  
 
==Syntax==  
<syntaxhighlight lang="lua">element playSound ( string sound, [ bool looped ] )</syntaxhighlight>  
+
<syntaxhighlight lang="lua">element playSound ( string soundName, [ bool looped ] )</syntaxhighlight>  
  
 
===Required Arguments===  
 
===Required Arguments===  
*'''sound:''' Filename of the sound you want to play. (sent to client via file xml tag in meta)
+
*'''soundName:''' Name of the sound file you want to play. (Sound file has to be predefined in the client side [[meta.xml]] file with <file /> tags.)
  
 
===Optional Arguments===  
 
===Optional Arguments===  
 
{{OptionalArg}}  
 
{{OptionalArg}}  
*'''looped:''' True if looped, False otherwise.
+
*'''looped:''' A [[boolean]] representing whether the sound will be looping or not. To loop the sound, use ''true''.
 
 
  
 
===Returns===
 
===Returns===
Returns a sound element if the sound was successfully played, ''false'' otherwise.
+
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.
  
 
==Example==  
 
==Example==  

Revision as of 20:47, 26 December 2008

Creates a sound element and plays it immediately after creation for the local player.

Syntax

element playSound ( string soundName, [ bool looped ] )

Required Arguments

  • soundName: Name of the sound file you want to play. (Sound file has to be predefined in the client side meta.xml file with <file /> tags.)

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • looped: A boolean representing whether the sound will be looping or not. To loop the sound, use true.

Returns

Returns a sound element if the sound was successfully created, false otherwise.

Example

TODO

Click to collapse [-]
Client
--TODO

See Also

FROM VERSION 1.5.6 r16216 ONWARDS