View source for PlaySFX

__NOTOC__ 
{{Client function}}
{{New feature/item|3.0134|1.3.4|5731|
This function plays a sound from GTA's big sound containers.
}}

{{Note|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]}}
{{Warning|Many players use versions of GTA:SA (especially pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data) 
In case of these invalid audio files, this function returns ''false''|true}}

==Syntax==
<syntaxhighlight lang="lua">
element playSFX ( string containerName, int bankId, int soundId [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''containerName:''' The name of the audio container. Possible values are: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa"
*'''bankId:''' The audio bank id
*'''soundId:''' The sound id within the audio bank

===Optional Arguments===
*'''looped:''' A [[boolean]] representing whether the sound will be looped

==Returns==
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
The following example plays a firealarm sound (looped).
<syntaxhighlight lang="lua">
if not playSFX("script", 7, 1, true) then
    outputChatBox("You have to install some missing audio files to hear the sound")
end
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}