SetSoundPanningEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page, but needs documentation and testing)
 
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
{{Client function}}
{{Client function}}
This function toggles the panning of a sound (hearing it closer to the left or right side of the speakers due to the camera position). By default a sound has its panning enabled.
This function toggles the panning of a sound (hearing it closer to the left or right side of the speakers due to the camera position). By default a sound has its panning enabled.
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundPanningEnabled ( element sound, bool enable )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundPanningEnabled ( element sound, bool enable )</syntaxhighlight>
{{New feature/item|3.0141|1.4.0|6987|{{OOP|The method name was incorrect (setPann'''n'''ingEnabled) before version '''1.5.8 r20761'''.|[[sound]]:setPanningEnabled|panningEnabled|isSoundPanningEnabled}}}}


===Required arguments===  
===Required arguments===  
Line 11: Line 11:


===Returns===
===Returns===
Returns ''true'' if the sound is valid, is 3D and good arguments were passed, ''false'' if not.
Returns ''true'' if the sound is valid and good arguments were passed, ''false'' if not.
 
If the sound is not 3D, this function will return ''true'' as well, but [[isSoundPanningEnabled]] will always return ''true'' after this (so it has no effect).


==Example==  
==Example==  
This example creates a sound at the center of the map when the resource which cointains it starts and adds a command called /soundpanning, which changes the panning of the sound.
This example creates a sound at the center of the map when the resource which cointains it starts and adds a command called /soundpanning, which changes the panning of the sound.


<syntaxhighlight lang="lua">local panned
<syntaxhighlight lang="lua">local panned = true
local sound = playSFX3D("script", 7, 1, 0, 0, 20, true)
local sound = playSFX3D("script", 7, 1, 0, 0, 20, true)


Line 29: Line 31:
end
end
addCommandHandler("soundpanning", changePanning)</syntaxhighlight>
addCommandHandler("soundpanning", changePanning)</syntaxhighlight>
==See also==
{{Client_audio_functions}}
[[hu:setSoundPanningEnabled]]

Latest revision as of 21:15, 23 September 2021

This function toggles the panning of a sound (hearing it closer to the left or right side of the speakers due to the camera position). By default a sound has its panning enabled.

Syntax

bool setSoundPanningEnabled ( element sound, bool enable )

OOP Syntax Help! I don't understand this!

Note: The method name was incorrect (setPannningEnabled) before version 1.5.8 r20761.
Method: sound:setPanningEnabled(...)
Variable: .panningEnabled
Counterpart: isSoundPanningEnabled

Required arguments

  • sound: a sound element to change the panning of.
  • enable: true to enable the panning, false otherwise.

Returns

Returns true if the sound is valid and good arguments were passed, false if not.

If the sound is not 3D, this function will return true as well, but isSoundPanningEnabled will always return true after this (so it has no effect).

Example

This example creates a sound at the center of the map when the resource which cointains it starts and adds a command called /soundpanning, which changes the panning of the sound. 

local panned = true
local sound = playSFX3D("script", 7, 1, 0, 0, 20, true)

function changePanning()
    if sound then
        setSoundPanningEnabled(sound, not panned)
        panned = not panned
        outputChatBox("Sound panning changed to " .. tostring(panned))
    else
        outputDebugString("Looks that your GTA was ripped.")
    end
end
addCommandHandler("soundpanning", changePanning)

See also

Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundPanningEnabled?oldid=72686"