https://g1r-mp.com/wiki/index.php?action=history&feed=atom&title=StopGameSoundStopGameSound - Revision history2026-10-01T15:27:14ZRevision history for this page on the wikiMediaWiki 1.46.0https://g1r-mp.com/wiki/index.php?title=StopGameSound&diff=1189&oldid=prevQCherry: Document upcoming 0.1.7 game audio: 11 client APIs, result event, limits and complete dialogue catalog; not a release2026-10-01T10:20:58Z<p>Document upcoming 0.1.7 game audio: 11 client APIs, result event, limits and complete dialogue catalog; not a release</p>
<p><b>New page</b></p><div>= stopGameSound =<br />
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"><br />
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">PLANNED FOR UPDATE 0.1.7</div><br />
<div style="color:#111111; margin-top:0.25rem;">This function is planned for G1R:MP 0.1.7. It is not included in the public 0.1.6 release.</div><br />
</div><br />
<br />
Requests that a game sound owned by this client resource stop, including a sound whose play request is still loading.<br />
<br />
== Syntax ==<br />
<syntaxhighlight lang="lua"><br />
number|false stopGameSound(number handle)<br />
</syntaxhighlight><br />
<br />
== Parameters ==<br />
{| class="wikitable"<br />
! Name !! Type !! Required !! Description<br />
|-<br />
| <code>handle</code> || <code>number</code> || yes || Positive integer handle returned by [[playSoundFromGame]] or [[playSound3DFromGame]], owned by the current resource. Valid IDs do not exceed 9007199254740991.<br />
|}<br />
<br />
== Returns ==<br />
Returns a positive integer request ID when the command is accepted for asynchronous processing, or <code>false</code> when rejected locally. The request ID identifies this command; it is not a new sound handle. Observe [[onClientGameSoundResult]] for the result.<br />
<br />
== Examples ==<br />
Start a campfire sound and cancel or stop it after three seconds:<br />
<syntaxhighlight lang="lua" line><br />
local sound = playSoundFromGame("event:/SFX/Objects/Fire/SFX_OBJ_Fire_Campfire_BurnLoop", {volume = 0.3})<br />
if sound then<br />
setTimer(function()<br />
local requestId = stopGameSound(sound)<br />
if not requestId then<br />
outputDebugString("Stop rejected; the sound may already have ended")<br />
end<br />
end, 3000, 1)<br />
end<br />
</syntaxhighlight><br />
<br />
== Notes ==<br />
* Planned for update 0.1.7; not included in public 0.1.6.<br />
* Available only in client-side resource scripts. See [[Game audio]] for ownership, lifecycle, limits and server-triggered playback.<br />
* Controls require a nonterminal handle owned by the current resource. Unknown, expired, foreign-resource or terminal handles are rejected.<br />
* A return value of <code>false</code> has no result event for that attempted command. Rejection can also mean the game is not ready or a request limit has been reached.<br />
* Control acceptance does not change the cached playback state immediately. Native acknowledgements and observed state changes arrive asynchronously.<br />
* Successful stopping reports <code>state = "stopped"</code>. A stopped, finished or failed sound cannot be restarted with its old handle.<br />
* Cancelling a pending play can produce a successful result for the original play request whose data already says <code>stopped</code> and <code>confirmed = false</code>. Other queued controls for that sound can fail with <code>cancelled</code>.<br />
* This stops only the selected owned instance. It does not stop unrelated game ambience, music or dialogue.<br />
<br />
[[Category:Lua Functions]]<br />
[[Category:Client Functions]]<br />
[[Category:Audio Functions]]</div>QCherry