SetWorldSoundEnabled: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (merge notes) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function allows you to disable world sounds. A world sound is a sound effect which has '''''not''''' been caused by [[playSound]] or [[playSound3D]]. | This function allows you to disable world sounds. A world sound is a sound effect which has '''''not''''' been caused by [[playSound]] or [[playSound3D]]. | ||
{{Note| | {{Note| | ||
*The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound|showsound]] in conjunction with [[setDevelopmentMode]] | *The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound|showsound]] in conjunction with [[setDevelopmentMode]] | ||
*This function does not affect sounds which are already playing, such as the wind sound that can only be stopped by entering an interior.}} | *This function does not affect sounds which are already playing, such as the wind sound that can only be stopped by entering an interior. | ||
* See also: [[setAmbientSoundEnabled]]}} | |||
==Syntax== | ==Syntax== | ||
Line 18: | Line 19: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
*'''index:''' An [[int|integer]] representing an individual sound within the group | *'''index:''' An [[int|integer]] representing an individual sound within the group | ||
{{New feature/item| | {{New feature/item|3.0156|1.5.5|11860| | ||
*'''immediate:''' A [[boolean]] if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound. | *'''immediate:''' A [[boolean]] if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound. | ||
}} | }} | ||
Line 45: | Line 46: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{New feature/item| | {{New feature/item|3.0156|1.5.5|11860| | ||
This example disables the wind sound effect immediately without changing the interior afterwards. | This example disables the wind sound effect immediately without changing the interior afterwards. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
Line 56: | Line 57: | ||
==Requirements== | ==Requirements== | ||
{{Requirements|n/a|1.3.0-9.04134|}} | {{Requirements|n/a|1.3.0-9.04134|}} | ||
==Changelog== | |||
{{ChangelogHeader}} | |||
{{ChangelogItem|1.5.5-9.11860|Added immediate argument}} | |||
==See Also== | ==See Also== | ||
{{Client world functions}} | {{Client world functions}} |
Revision as of 08:41, 7 September 2019
This function allows you to disable world sounds. A world sound is a sound effect which has not been caused by playSound or playSound3D.
Note:
|
Syntax
bool setWorldSoundEnabled ( int group, [ int index = -1, ] bool enable [, bool immediate = false ] )
Required Arguments
- group: An integer representing the world sound group
- enable: Set to false to disable, true to enable
Optional Arguments
- index: An integer representing an individual sound within the group
- immediate: A boolean if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound.
Returns
Returns true if the world sound was correctly enabled/disabled, false if 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 )
This example disables the wind sound effect immediately without changing the interior afterwards.
setWorldSoundEnabled(0, 0, false, true) setWorldSoundEnabled(0, 29, false, true) setWorldSoundEnabled(0, 30, false, true)
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" />
Changelog
Version | Description |
---|
1.5.5-9.11860 | Added immediate argument |
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