GetSFXStatus: Difference between revisions

Revision as of 11:31, 25 May 2014

This function gets the status of a sound in the GTA world from GTA's big sound containers.

	Script Example Missing Function GetSFXStatus needs a script example, help out by writing one.
	Before submitting check out Editing Guidelines Script Examples.

	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

bool getSFXStatus ( string audioContainer )

audioContainer: The container name. Possible values are: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa"

Returns true if the sound container is available, false otherwise.

if not getSFXStatus("spc_ea") then
   outputChatBox("Please install the missing audio files to enjoy the full gaming experience")
end

@@ Line 6: / Line 6: @@
 {{Needs_Example}}{{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}}
-TODO
+==Syntax==
+<syntaxhighlight lang="lua">bool getSFXStatus ( string audioContainer )</syntaxhighlight>
+===Required Arguments===
+*'''audioContainer:''' The container name. Possible values are: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa"
+==Returns==
+Returns ''true'' if the sound container is available, ''false'' otherwise.
+==Example==
+<syntaxhighlight lang="lua">
+if not getSFXStatus("spc_ea") then
+   outputChatBox("Please install the missing audio files to enjoy the full gaming experience")
+end
+</syntaxhighlight>
 ==See Also==
 {{Client_audio_functions}}