IsWorldSoundEnabled: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{New items|3.0140|1.3.1| | |||
{{Client function}} | {{Client function}} | ||
This function allows you to check if certain world sound effects have not been disabled by [[setWorldSoundEnabled]] | This function allows you to check if certain world sound effects have not been disabled by [[setWorldSoundEnabled]] | ||
}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
Line 9: | Line 10: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''group :''' An integer representing the world sound group | *'''group :''' An integer representing the [[World sound groups|world sound group]] | ||
===OptionalArguments=== | ===OptionalArguments=== | ||
Line 16: | Line 17: | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the world sounds are enabled, ''false'' if they are disabled or invalid values were passed. | Returns ''true'' if the world sounds are enabled, ''false'' if they are disabled or invalid values were passed. | ||
==Example== | |||
This is a simplified example that lets the client toggle their weapon sounds. | |||
<syntaxhighlight lang="lua"> | |||
function toggleWeaponSounds_f ( ) | |||
local enabled = isWorldSoundEnabled ( 5 ) -- We place this variable here for checking. | |||
enabled = not enabled -- And here we invert (toggle) the variable, so if it's false, it becomes true, if it's true, it becomes false. | |||
-- Used for the chat declaration: | |||
local state = "enabled" | |||
if ( not enabled ) then | |||
state = "disabled" | |||
end | |||
-- | |||
setWorldSoundEnabled ( 5, enabled ) -- And here the toggling happens. | |||
outputChatBox ( "Weapon sounds " .. state ) | |||
end | |||
addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f ) | |||
</syntaxhighlight> | |||
==Requirements== | |||
{{Requirements|n/a|1.3.0-9.04134|}} | |||
==See Also== | ==See Also== | ||
{{Client world functions}} | {{Client world functions}} |
Latest revision as of 20:44, 30 April 2017
This function allows you to check if certain world sound effects have not been disabled by setWorldSoundEnabled
Syntax
bool isWorldSoundEnabled( int group, [ int index = -1 ] )
Required Arguments
- group : An integer representing the world sound group
OptionalArguments
- index : An integer representing an individual sound within the group
Returns
Returns true if the world sounds are enabled, false if they are disabled or invalid values were passed.
Example
This is a simplified example that lets the client toggle their weapon sounds.
function toggleWeaponSounds_f ( ) local enabled = isWorldSoundEnabled ( 5 ) -- We place this variable here for checking. enabled = not enabled -- And here we invert (toggle) the variable, so if it's false, it becomes true, if it's true, it becomes false. -- Used for the chat declaration: local state = "enabled" if ( not enabled ) then state = "disabled" end -- setWorldSoundEnabled ( 5, enabled ) -- And here the toggling happens. outputChatBox ( "Weapon sounds " .. state ) end addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f )
Requirements
Minimum server version | n/a |
---|---|
Minimum client version | 1.3.0-9.04134 |
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04134" />
See Also
- areTrafficLightsLocked
- createSWATRope
- getAircraftMaxHeight
- getAircraftMaxVelocity
- getBirdsEnabled
- getCloudsEnabled
- getCoronaReflectionsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGarageBoundingBox
- getGaragePosition
- getGarageSize
- getGravity
- getGroundPosition
- getHeatHaze
- getInteriorFurnitureEnabled
- getInteriorSoundsEnabled
- getJetpackMaxHeight
- getMinuteDuration
- getMoonSize
- getNearClipDistance
- getOcclusionsEnabled
- getPedsLODDistance
- getPlayerBlurLevel
- getRainLevel
- getRoofPosition
- getScreenFromWorldPosition
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getVehiclesLODDistance
- getWeather
- getWindVelocity
- getWorldFromScreenPosition
- getZoneName
- isAmbientSoundEnabled
- isGarageOpen
- isLineOfSightClear
- isWorldSoundEnabled
- isWorldSpecialPropertyEnabled
- processLineOfSight
- removeWorldModel
- resetAmbientSounds
- resetBlurLevel
- resetColorFilter
- resetCoronaReflectionsEnabled
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetNearClipDistance
- resetPedsLODDistance
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetVehiclesLODDistance
- resetWindVelocity
- resetWorldSounds
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxHeight
- setAircraftMaxVelocity
- setAmbientSoundEnabled
- setBirdsEnabled
- setCloudsEnabled
- setColorFilter
- setCoronaReflectionsEnabled
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorFurnitureEnabled
- setInteriorSoundsEnabled
- setJetpackMaxHeight
- setMinuteDuration
- setMoonSize
- setNearClipDistance
- setOcclusionsEnabled
- setPedsLODDistance
- setPlayerBlurLevel
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightsLocked
- setTrafficLightState
- setVehiclesLODDistance
- setWeather
- setWeatherBlended
- setWindVelocity
- setWorldSoundEnabled
- setWorldSpecialPropertyEnabled
- testLineAgainstWater