GetSFXStatus: Difference between revisions
Jump to navigation
Jump to search
m (Changed hierarchy in the left panel) |
m (Change See Also template) |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{Warning|Many players use versions of GTA:SA (especially pirated versions) that have audio files full of zeros so that they can compress better in their ''AUDIO\SFX\'' folder. (They lack any data) | {{Warning|Many players use versions of GTA:SA (especially pirated versions) that have audio files full of zeros so that they can compress 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}} | ||
This function checks if a big sound container is available to use or not. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool getSFXStatus ( string audioContainer )</syntaxhighlight> | <syntaxhighlight lang="lua"> | ||
bool getSFXStatus ( string audioContainer ) | |||
</syntaxhighlight> | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''audioContainer:''' The container name. Possible values are: | *'''audioContainer:''' The container name. Possible values are: | ||
{{Audio_Containers}} | |||
==Returns== | ==Returns== | ||
Returns ''true'' if the sound container is available, ''false'' otherwise. | Returns '''true''' if the sound container is available, '''false''' otherwise. | ||
==Example== | ==Example== | ||
Line 24: | Line 26: | ||
==See Also== | ==See Also== | ||
{{ | {{Audio_functions|client}} | ||
[[ar:getSFXStatus]] | [[ar:getSFXStatus]] | ||
[[hu:getSFXStatus]] | [[hu:getSFXStatus]] | ||
[[pl:getSFXStatus]] | [[pl:getSFXStatus]] | ||
[[pt-br:getSFXStatus]] | |||
[[ro:getSFXStatus]] | [[ro:getSFXStatus]] | ||
[[ru:getSFXStatus]] | [[ru:getSFXStatus]] | ||
Latest revision as of 22:11, 6 September 2024
This function checks if a big sound container is available to use or not.
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
- playSoundFrontEnd