PlaySound: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 6: Line 6:
{{Note|For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
{{Note|For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false ] )</syntaxhighlight>
{{New feature/item|3.0150|1.5||
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>  
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>  
}}
{{OOP||[[Sound]].create}}
{{OOP||[[Sound]].create}}
===Required Arguments===  
===Required Arguments===  
Line 17: Line 14:
{{OptionalArg}}  
{{OptionalArg}}  
*'''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.
*'''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.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled. To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled. To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
}}


===Returns===
===Returns===

Revision as of 11:34, 25 May 2015

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).

[[{{{image}}}|link=|]] Note: For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.

Syntax

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

OOP Syntax Help! I don't understand this!

Method: Sound.create(...)


Required Arguments

  • soundPath: the filepath or URL of the sound file you want to play. (Sound specified by filepath 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.
  • throttled: a boolean representing whether the sound will be throttled. To throttle the sound, use true. Sounds will be throttled per default and only for URLs.

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

Retrieved from "https://wiki.multitheftauto.com/wiki/PlaySound?oldid=45229"