GetSFXStatus: Difference between revisions
Jump to navigation
Jump to search
m (Documentation needed) |
No edit summary |
||
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) | {{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}} | In case of these invalid audio files, this function returns ''false''|true}} | ||
==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== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} |
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 | |
Syntax
bool getSFXStatus ( string audioContainer )
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
if not getSFXStatus("spc_ea") then outputChatBox("Please install the missing audio files to enjoy the full gaming experience") end
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
Shared