PlaySFX

From Multi Theft Auto: Wiki
Revision as of 18:19, 21 August 2013 by Jusonex (talk | contribs)
Jump to navigation Jump to search

This function plays a sound from GTA's big sound containers.

[[{{{image}}}|link=|]] Note: {{{1}}}
Dialog-warning.png Warning: Many players use versions of GTA:SA (especially WareZ versions) which haven't any audio files in their AUDIO\SFX\ folder. In case of missing audio files, this function returns false

Syntax

sound playSFX ( string containerName, int bankId, int soundId [, looped = false] )

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

if not playSFX("script", 7, 1, true) then
    outputChatBox("You have to install some missing audio files to hear the sound")
end

See Also