OnClientSoundStarted: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client_Function}} test example until properly documented <syntaxhighlight lang="lua"> function onSoundStarted ( reason ) if ( source == currentTrack ) then if ( reason == "play" ) then ...")
 
No edit summary
Line 1: Line 1:
{{Client_Function}}
{{Client event}}
__NOTOC__
This event is triggered when a ''sound''' is started.


test example until properly documented
==Parameters==
<syntaxhighlight lang="lua">
string reason
</syntaxhighlight>
 
*'''reason''': the reason the '''sound''' was started, can be "play" or "resumed".
 
==Source==
The [[event system#Event source|source]] of this event is the [[Element/Sound|sound's element]].


==Example==
This example outputs the reason the sound started .
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onSoundStarted ( reason )
function onSoundStarted ( reason )
if ( source == currentTrack ) then
    if ( reason == "play" ) then
if ( reason == "play" ) then
        outputChatBox ( "sound started" )
outputChatBox ( "sound started" )
    elseif ( reason == "resumed" ) then
elseif ( reason == "resumed" ) then
        outputChatBox ( "sound resumed" )
outputChatBox ( "sound resumed" )
    end
end
end
end
end
addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted )
addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted )
);
</syntaxhighlight>
</syntaxhighlight>



Revision as of 13:34, 28 February 2012

This event is triggered when a sound' is started.

Parameters

string reason
  • reason: the reason the sound was started, can be "play" or "resumed".

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


Client event functions