Difference between revisions of "PlaySound"

From Multi Theft Auto: Wiki
m
m
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
 
{{Client function}}
 
{{Client function}}
Creates a [[sound]] element and plays it immediately after creation for the local player. Supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
+
Creates a [[sound]] element and plays it immediately after creation for the local player.<br />
 +
<br />
 +
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
 +
 
 
==Syntax==  
 
==Syntax==  
 
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped ] )</syntaxhighlight>  
 
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped ] )</syntaxhighlight>  

Revision as of 13:01, 28 November 2009

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

Note: The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.

Syntax

element playSound ( string soundPath, [ bool looped ] )

Required Arguments

  • soundPath: The filepath to 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 looped. To loop the sound, use true.

Returns

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

Example

Click to collapse [-]
Client
function wasted (killer, weapon, bodypart) 
	local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
	setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler

See Also