IsPlaybackPaused
Revision as of 17:34, 29 October 2024 by Habi (talk | contribs) (Created page with "{{v1_8_beta}} {{Welcome|desc=This function tells whether any playback is in paused state.| params=<source>NoParams</source>| example=<source lang="lua"> if(IsPlaybackRunning()) { if(IsPlaybackPaused()) print("The playback is paused\n"); }| retvals=true, if playback is paused and false otherwise(playback is not running or running but not paused)| note=This function returns false when playback is not running| relfuncs=*IsPlaybackRunning }}")
This function was added in v1.8 beta and will not work on previous versions.
Description:
This function tells whether any playback is in paused state.
Parameters:
NoParams
Return Values:
true, if playback is paused and false otherwise(playback is not running or running but not paused)
Important Note:
This function returns false when playback is not running
Example <source lang="lua"> if(IsPlaybackRunning()) {
if(IsPlaybackPaused())
print("The playback is paused\n");
}
Related Functions
The following functions may be helpful as they relate to this function in one way or another.