SetWorldSoundEnabled: Difference between revisions
Jump to navigation
Jump to search
(Info about new argument) |
mNo edit summary |
||
Line 4: | Line 4: | ||
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]]}} | ||
Note: This function does not affect sounds which are already playing, such as the wind sound that can only be stopped by entering an interior. | {{Note|Note: This function does not affect sounds which are already playing, such as the wind sound that can only be stopped by entering an interior.}} | ||
}} | }} | ||
Line 12: | Line 12: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable, | bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable [, bool immediate = false ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 22: | Line 22: | ||
*'''index :''' An integer representing an individual sound within the group | *'''index :''' An integer representing an individual sound within the group | ||
{{New feature/item|9.0156|1.5.6|11860| | {{New feature/item|9.0156|1.5.6|11860| | ||
*''' | *'''immediate:''' Boolean if set to true will cancel the sound if it's already playing. This parameter only works for stopping the sound. | ||
}} | }} | ||
Line 47: | Line 47: | ||
addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f ) | addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{New feature/item|9.0156|1.5.6|11860| | |||
This example disables the wind sound effect immediately without changing the interior afterwards. | |||
<syntaxhighlight lang="lua"> | |||
setWorldSoundEnabled(0, 0, false, true) | |||
setWorldSoundEnabled(0, 29, false, true) | |||
setWorldSoundEnabled(0, 30, false, true) | |||
</syntaxhighlight> | |||
}} | |||
==Requirements== | ==Requirements== |
Revision as of 16:29, 21 February 2018
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: The values for group and index can be determined by using the client command showsound in conjunction with setDevelopmentMode |
Note: Note: 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 template is no longer in use as it results in poor readability.
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 false to disable, true to enable
OptionalArguments
- index : An integer representing an individual sound within the group
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 )
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