SetSoundPaused: Difference between revisions

Revision as of 20:52, 26 December 2008

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

bool setSoundPaused ( element theSound, bool paused )

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 true if the sound element was successfully paused, false otherwise.

TODO

Click to collapse [-]

Client

--TODO

@@ 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.
 ==Syntax==
-<syntaxhighlight lang="lua">bool setSoundPaused ( element sound, bool paused )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool setSoundPaused ( element theSound, bool paused )</syntaxhighlight>
 ===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==