GetSoundPan: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function is used to get the pan level of the specified sound element. ==Syntax== <syntaxhighlight lang="lua">float getSoundPan ( element theSound )</co...")
 
m (Reverted edits by Ameir (talk) to last revision by Alvesvin)
Tag: Rollback
 
(7 intermediate revisions by 7 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">float getSoundPan ( element theSound )</syntaxhighlight>  
<syntaxhighlight lang="lua">float getSoundPan ( element theSound )</syntaxhighlight>  
 
{{OOP||[[sound]]:getPan|pan|setSoundPan}}
===Required Arguments===  
===Required Arguments===  
*'''theSound:''' The [[sound]] element which pan you want to modify.
*'''theSound:''' the [[sound]] element which pan you want to get.


===Returns===
===Returns===
Line 15: Line 15:
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function playMusic ()
function playMusic()
        local song = playSound('song.mp3')
    local song = playSound("song.mp3")
        setSoundPan(song, 0.3)
    setSoundPan(song, -1)
        outputChatBox("Current pan is "..tostring(getSoundPan(song)))
    outputChatBox("Current pan is " .. getSoundPan(song))
end
end
addCommandHandler("music", playMusic)
addCommandHandler("music", playMusic)
</syntaxhighlight>
</syntaxhighlight>
Line 27: Line 26:
==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[AR:getSoundPan]]
[[HU:getSoundPan]]
[[PT-BR:getSoundPan]]

Latest revision as of 16:36, 26 September 2021

This function is used to get the pan level of the specified sound element.

Syntax

float getSoundPan ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:getPan(...)
Variable: .pan
Counterpart: setSoundPan


Required Arguments

  • theSound: the sound element which pan you want to get.

Returns

Returns float value with range from -1.0 (left) to 1.0 (right), false otherwise.

Example

Click to collapse [-]
Client
function playMusic()
    local song = playSound("song.mp3")
    setSoundPan(song, -1)
    outputChatBox("Current pan is " .. getSoundPan(song))
end
addCommandHandler("music", playMusic)

See Also