IsSoundPaused: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added Example)
mNo edit summary
 
(14 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
This function is used to return the current pause state of the specified [[sound]] element.
This function is used to return the current pause state of the specified [[sound]] [[element]].


{{New feature/item|3.0132|1.3.2||
If the element is a [[player]], this function will use the players voice.
}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight>  
 
{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}
===Required Arguments===  
===Required Arguments===  
*'''theSound:''' The [[sound]] element which pause state you want to return.
*'''theSound:''' the [[sound]] [[element]] which pause state you want to return.


===Returns===
===Returns===
Returns ''true'' if the [[sound]] element is paused, ''false'' if unpaused or invalid arguments were passed.
Returns ''true'' if the [[sound]] [[element]] is paused, ''false'' if unpaused or invalid arguments were passed.


==Example==  
==Example==  
Line 20: Line 23:
     local pause = isSoundPaused(theSound)
     local pause = isSoundPaused(theSound)
     if(pause == true) then
     if(pause == true) then
         outputChatBox("The sound is paused!", getLocalPlayer())
         outputChatBox("The sound is paused!")
     else
     else
         outputChatBox("The sound is not paused!", getLocalPlayer())
         outputChatBox("The sound is not paused!")
     end
     end
end
end
Line 28: Line 31:
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}


==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[hu:isSoundPaused]]
[[ar:isSoundPaused]]
[[pt-br:isSoundPaused]]

Latest revision as of 00:36, 18 August 2021

This function is used to return the current pause state of the specified sound element.

If the element is a player, this function will use the players voice.

Syntax

bool isSoundPaused ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:isPaused(...)
Variable: .paused
Counterpart: setSoundPaused


Required Arguments

  • theSound: the sound element which pause state you want to return.

Returns

Returns true if the sound element is paused, false if unpaused or invalid arguments were passed.

Example

This example will check and see if the sound is paused or not, and tell the player.

Click to collapse [-]
Client
theSound = playSound("music/song.mp3")
function checkSongPause()
    local pause = isSoundPaused(theSound)
    if(pause == true) then
        outputChatBox("The sound is paused!")
    else
        outputChatBox("The sound is not paused!")
    end
end
addCommandHandler("checkpause", checkSongPause)

Changelog

Version Description
1.3.2 Added player element to use a players voice

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/IsSoundPaused?oldid=71836"