SetSoundPaused: Difference between revisions

Latest revision as of 19:12, 18 July 2019

This function is used to either pause or unpause the playback of the specified sound element.

Use a player element to control a players voice with this function.

Syntax

bool setSoundPaused ( element theSound, bool paused )

OOP Syntax Help! I don't understand this!

Method: sound:setPaused(...)

Variable: .paused

Counterpart: isSoundPaused

Required Arguments

theSound: the sound element which you want to pause/unpause.
paused: a boolean value representing whether the sound should be paused or not. To pause the sound, use true.

Returns

Returns true if the sound element was successfully paused, false otherwise.

Example

This example will allow the user to toggle sounds from paused to playing, and from playing to paused

Click to collapse [-]

Client

theSound = playSound("music/song.mp3", true)
function togglePausedSound()
    if(isSoundPaused(theSound)) then --sound is paused, un-pause it
        setSoundPaused(theSound, false)
    else --sound is not paused, pause it
        setSoundPaused(theSound, true)
    end
end
addCommandHandler("pausesound", togglePausedSound)

Changelog

Version	Description

1.3.2

Added player element for voice control

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Set the sound playing state.
+This function is used to either pause or unpause the playback of the specified [[sound]] [[element]].
+{{New feature/item|3.0132|1.3.2||
+Use a player element to control a players voice with this function.
+}}
 ==Syntax==
-<syntaxhighlight lang="lua">bool setSoundPaused ( element sound, bool paused )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool setSoundPaused ( element theSound, bool paused )</syntaxhighlight>
+{{OOP||[[sound]]:setPaused|paused|isSoundPaused}}
 ===Required Arguments===
-*'''sound:''' a sound element.
+*'''theSound:''' the [[sound]] [[element]] which you want to pause/unpause.
-*'''Paused:''' a boolean value to pause or unpause the sound respectivly.
+*'''paused:''' a [[boolean]] value representing whether the sound should be paused or not. To pause the sound, use ''true''.
 ===Returns===
-Returns a ''bool'' true if the sound paused false if invalid arguements where passed.
+Returns ''true'' if the [[sound]] [[element]] was successfully paused, ''false'' otherwise.
 ==Example==
-TODO
+This example will allow the user to toggle sounds from paused to playing, and from playing to paused
 <section name="Client" class="client" show="true">
 <syntaxhighlight lang="lua">
---TODO
+theSound = playSound("music/song.mp3", true)
+function togglePausedSound()
+    if(isSoundPaused(theSound)) then --sound is paused, un-pause it
+        setSoundPaused(theSound, false)
+    else --sound is not paused, pause it
+        setSoundPaused(theSound, true)
+    end
+end
+addCommandHandler("pausesound", togglePausedSound)
 </syntaxhighlight>
 </section>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.2|Added player element for voice control}}
 ==See Also==
-{{audio functions}}
+{{Client_audio_functions}}
+[[hu:setSoundPaused]]
+[[AR:setSoundPaused]]
+[[RO:setSoundPaused]]