https://g1r-mp.com/wiki/index.php?action=history&feed=atom&title=OnPlayerVoiceStateChange
OnPlayerVoiceStateChange - Revision history
2026-09-19T07:26:56Z
Revision history for this page on the wiki
MediaWiki 1.46.0
https://g1r-mp.com/wiki/index.php?title=OnPlayerVoiceStateChange&diff=653&oldid=prev
QCherry: Document Protocol 23 voice and player presentation APIs
2026-08-24T06:15:14Z
<p>Document Protocol 23 voice and player presentation APIs</p>
<p><b>New page</b></p><div><!-- This page is generated from the verified Lua event definition: onPlayerVoiceStateChange. --><br />
= onPlayerVoiceStateChange =<br />
Triggered after a player's authoritative voice-routing or capture policy changes.<br />
<br />
== Availability ==<br />
This event is available in '''server-side''' scripts.<br />
<br />
== Callback signature ==<br />
<syntaxhighlight lang="lua"><br />
onPlayerVoiceStateChange(playerId, mode, rangePreset, flags, channelId, range, volume)<br />
</syntaxhighlight><br />
<br />
== Parameters ==<br />
{| class="wikitable"<br />
! Name !! Type !! Description<br />
|-<br />
| <code>playerId</code> || <code>int</code> || The affected connected player ID.<br />
|-<br />
| <code>mode</code> || <code>int</code> || Voice mode: 0 disabled, 1 proximity, 2 channel, or 3 global.<br />
|-<br />
| <code>rangePreset</code> || <code>int</code> || Range preset: 0 whisper, 1 normal, 2 shout, or 3 custom.<br />
|-<br />
| <code>flags</code> || <code>int</code> || Bitmask: enabled 1, speaking 2, server-muted 4, and push-to-talk 8.<br />
|-<br />
| <code>channelId</code> || <code>int</code> || The authoritative voice channel identifier.<br />
|-<br />
| <code>range</code> || <code>number</code> || The effective proximity range in metres.<br />
|-<br />
| <code>volume</code> || <code>number</code> || The authoritative volume multiplier from 0.0 through 2.0.<br />
|}<br />
<br />
== Examples ==<br />
Handle the event:<br />
<syntaxhighlight lang="lua" line><br />
addEventHandler("onPlayerVoiceStateChange", root, function(playerId, mode, rangePreset, flags, channelId, range, volume)<br />
outputDebugString("Voice state updated for player " .. playerId .. ", mode " .. mode)<br />
end)<br />
</syntaxhighlight><br />
<br />
== Notes ==<br />
* The state is reliable and replayed during late join.<br />
* Use the voice getter functions when string mode or preset names are more convenient than numeric protocol values.<br />
<br />
[[Category:Lua Events]]<br />
[[Category:Server Events]]<br />
[[Category:Voice Events]]</div>
QCherry