PlaySFX: Difference between revisions

Revision as of 11:02, 23 May 2014

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

[[{{{image}}}\|link=\|]]	Note: There is a tool available which allows you to find bank and sound IDs easily: [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

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

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

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

ADDED/UPDATED IN VERSION 1.4 r6443:

element playSFX ( string "radio", string radioStation, int trackId [, bool looped = false ] )

radio: The string "radio" (used to differentiate to the first syntax)
radioStation: The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "KROSE", "K-DST", "Cutscene", "Beats", "Bounce FM", "SFUR", "Radio Los Santos", "Radio X", "CSR", "K-JAH", "Master Sounds", "WCTR".
trackId : The radio track id within the radio station audio file

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

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

@@ Line 21: / Line 21: @@
 ===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.
+{{New feature/item|4.0140|1.4|6443|
+==Syntax 2==
+<syntaxhighlight lang="lua">
+element playSFX ( string "radio", string radioStation, int trackId [, bool looped = false ] )
+</syntaxhighlight>
+===Required Arguments===
+*'''radio:''' The string "radio" (used to differentiate to the first syntax)
+*'''radioStation:''' The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "KROSE", "K-DST", "Cutscene", "Beats", "Bounce FM", "SFUR", "Radio Los Santos", "Radio X", "CSR", "K-JAH", "Master Sounds", "WCTR".
+*'''trackId :''' The radio track id within the radio station audio file
+===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==