View source for OnClientSoundBeat

{{Client event}}
__NOTOC__ 
{{New feature|3.0131|1.3.1|
This event is triggered when a '''sound''' beats.
}}
{{Note|This event does not work correctly pre 1.3.1-9-04627
}}
{{Note|This event is triggered ahead of a sound beat the number passed is the play time at which the beat occurs
}}
==Parameters== 
<syntaxhighlight lang="lua">
double theTime
</syntaxhighlight> 

*'''theTime''': the position in the song of the beat

==Source==
The [[event system#Event source|source]] of this event is the [[Element/Sound|sound's element]].

==Example== 
<section name="Client" class="client" show="true">
This code will change the vehicle color to a random value if the sound beats and the localPlayer is inside a vehicle
<syntaxhighlight lang="lua">
 function playMySound()
    playSound("sound.mp3") -- play the sound used for onClientSoundBeat
    addEventHandler("onClientSoundBeat", getRootElement(), changeVehicleColorOnSoundBeat)
end
addEventHandler("onClientResourceStart", getRootElement(), playMySound)

function changeVehicleColorOnSoundBeat()
    if getPedOccupiedVehicle(localPlayer) then -- if the player is inside a vehicle
    setVehicleColor( getPedOccupiedVehicle(localPlayer), math.random(0,255), math.random(0,255), math.random(0,255) ) -- apply the color to the vehicle
    outputChatBox("The color of your vehicle was changed.") 
    else 
    outputChatBox("Could not change the vehicle color, the localPlayer is not inside a vehicle.") 
    return end;
end
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3.0-9.04162}}

==See Also==
===Client sound events===
{{Sound_events}}
===Client event functions===
{{Client_event_functions}}