SetInteriorSoundsEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Correction)
(Added example and better description of the function)
 
Line 2: Line 2:
{{Server client function}}
{{Server client function}}


This function allows you to disable the music played by default in clubs.
This function disables or enables the ambient sounds played by GTA in most interiors, like restaurants, casinos, clubs, houses, etc.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setInteriorSoundsEnabled ( bool enabled )
bool setInteriorSoundsEnabled ( bool enabled )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
*'''enabled:''' set to ''true'' to enable the interior ambient sounds, ''false'' to disable them. By default they're enabled.
 
==Returns==
If a boolean was passed to the function, it always succeeds and returns ''true''.
 
==Example==
<section name="Client" class="client" show="true">
This example disables the dancing club ambient music, without disabling other interiors' ambient sounds.
 
<syntaxhighlight lang="lua">
function disableClubMusic()
    if getElementInterior(localPlayer) == 17 and getDistanceBetweenPoints3D(493.39, -22.72, 1000.68, getElementPosition(localPlayer)) < 50 and getInteriorSoundsEnabled() then
        setInteriorSoundsEnabled(false)
    elseif not getInteriorSoundsEnabled() then
        setInteriorSoundsEnabled(true)
    end
end
addEventHandler("onClientPreRender", root, disableClubMusic)
</syntaxhighlight>
</section>
 
==See also==
{{World functions}}
{{World functions}}

Latest revision as of 08:49, 15 June 2014

This function disables or enables the ambient sounds played by GTA in most interiors, like restaurants, casinos, clubs, houses, etc.

Syntax

bool setInteriorSoundsEnabled ( bool enabled )
  • enabled: set to true to enable the interior ambient sounds, false to disable them. By default they're enabled.

Returns

If a boolean was passed to the function, it always succeeds and returns true.

Example

Click to collapse [-]
Client

This example disables the dancing club ambient music, without disabling other interiors' ambient sounds. 

function disableClubMusic()
    if getElementInterior(localPlayer) == 17 and getDistanceBetweenPoints3D(493.39, -22.72, 1000.68, getElementPosition(localPlayer)) < 50 and getInteriorSoundsEnabled() then
        setInteriorSoundsEnabled(false)
    elseif not getInteriorSoundsEnabled() then
        setInteriorSoundsEnabled(true)
    end
end
addEventHandler("onClientPreRender", root, disableClubMusic)

See also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetInteriorSoundsEnabled?oldid=39931"