PlaySound: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (→‎Example: No point of section as it's already only client-sided)
Line 18: Line 18:
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.


==Example==  
==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)  
function wasted (killer, weapon, bodypart)  
Line 28: Line 27:
addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[AR:playSound]]
[[AR:playSound]]

Revision as of 14:26, 19 July 2013

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, S3M and PLS(e.g. Webstream).

Syntax

element playSound ( string soundPath, [ bool looped = false ] )

Required Arguments

  • soundPath: The filepath to the sound file you want to play. (Sound file has to be predefined in the meta.xml file with <file /> tag.)

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. Loop is not available for streaming sounds, only for sound files.

Returns

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

Example

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