IsSoundPaused: Difference between revisions

Revision as of 22:46, 4 May 2013

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 )

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

@@ Line 2: / Line 2: @@
 {{Client function}}
 This function is used to return the current pause state of the specified [[sound]] element.
+{{New_feature|3.0139|1.3.2|
+If the element is a player, this function will use the players voice.
+}}
 ==Syntax==
 <syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight>
@@ Line 28: / Line 30: @@
 </syntaxhighlight>
 </section>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.2|Added player element to use a players voice}}
 ==See Also==
 {{Client_audio_functions}}