IsSoundPaused: Difference between revisions

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

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Get the sound playing state.
+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==
-<syntaxhighlight lang="lua">bool IsSoundPaused ( element sound )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight>
+{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}
 ===Required Arguments===
-*'''sound:''' a sound element.
+*'''theSound:''' the [[sound]] [[element]] which pause state you want to return.
 ===Returns===
-Returns a ''bool'' true if the sound is paused, ''false'' if the sound is not paused or invalid arguements where passed
+Returns ''true'' if the [[sound]] [[element]] is paused, ''false'' if unpaused or invalid arguments were passed.
 ==Example==
-TODO
+This example will check and see if the sound is paused or not, and tell the player.
 <section name="Client" class="client" show="true">
 <syntaxhighlight lang="lua">
---TODO
+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)
 </syntaxhighlight>
 </section>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.2|Added player element to use a players voice}}
 ==See Also==
 {{Client_audio_functions}}
+[[hu:isSoundPaused]]
+[[ar:isSoundPaused]]
+[[pt-br:isSoundPaused]]