IsSoundPaused

From Wiki G1R-MP G1 Remake Multiplayer
Jump to navigation Jump to search

isSoundPaused

AVAILABLE FROM UPDATE 0.1.2
This function is available in G1R:MP 0.1.2 and later. The contract below includes the compatibility guarantees introduced in that update.

Checks whether an owned client sound is paused.

Syntax

bool isSoundPaused(number sound)

Parameters

Name Type Required Description
sound number yes The resource-owned handle returned by playSound or playSound3D.

Returns

Returns true only when the current resource owns the handle and it is paused; otherwise returns false.

Examples

Check a sound before resuming it:

if isSoundPaused(sound) then
    setSoundPaused(sound, false)
end

Notes

  • Available only in client-side resource scripts.
  • Use isSoundPlaying separately when active playback state matters.