OnClientSoundStarted: Difference between revisions
Jump to navigation
Jump to search
OpenIDUser34 (talk | contribs) No edit summary |
No edit summary |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Client event}} | {{Client event}} | ||
__NOTOC__ | __NOTOC__ | ||
{{New items|3.0140|1.4| | |||
This event is triggered when a '''sound''' is started. | This event is triggered when a '''sound''' is started. | ||
}} | |||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 8: | Line 9: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''reason''': the reason the '''sound''' was started, can be "play" or " | *'''reason''': the reason the '''sound''' was started, can be "play", "resumed" or "enabled". | ||
==Source== | ==Source== | ||
| Line 24: | Line 25: | ||
end | end | ||
addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted ) | addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 20:35, 2 September 2019
This event is triggered when a sound is started.
Parameters
string reason
- reason: the reason the sound was started, can be "play", "resumed" or "enabled".
Source
The source of this event is the sound's element.
Example
This example outputs the reason the sound started .
function onSoundStarted ( reason )
if ( reason == "play" ) then
outputChatBox ( "sound started" )
elseif ( reason == "resumed" ) then
outputChatBox ( "sound resumed" )
end
end
addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted )
See Also
Client sound events
- onClientSoundBeat
- onClientSoundChangedMeta
- onClientSoundFinishedDownload
- onClientSoundStarted
- onClientSoundStopped
- onClientSoundStream
Client event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerLatentServerEvent
- triggerServerEvent
- wasEventCancelled