https://g1r-mp.com/wiki/index.php?action=history&feed=atom&title=SetPlayerVoiceMode
SetPlayerVoiceMode - Revision history
2026-09-19T07:31:34Z
Revision history for this page on the wiki
MediaWiki 1.46.0
https://g1r-mp.com/wiki/index.php?title=SetPlayerVoiceMode&diff=640&oldid=prev
QCherry: Document Protocol 23 voice and player presentation APIs
2026-08-24T06:13:26Z
<p>Document Protocol 23 voice and player presentation APIs</p>
<p><b>New page</b></p><div><!-- This page is generated automatically from the function definition: setPlayerVoiceMode. --><br />
= setPlayerVoiceMode =<br />
Changes how the server routes a player's voice packets.<br />
<br />
== Syntax ==<br />
<syntaxhighlight lang="lua"><br />
bool setPlayerVoiceMode(int playerId, string mode)<br />
</syntaxhighlight><br />
<br />
== Parameters ==<br />
{| class="wikitable"<br />
! Name !! Type !! Required !! Description<br />
|-<br />
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.<br />
|-<br />
| <code>mode</code> || <code>string</code> || yes || One of <code>disabled</code>, <code>proximity</code>, <code>channel</code>, or <code>global</code>.<br />
|}<br />
<br />
== Returns ==<br />
Returns <code>true</code> when the validated mode was accepted; otherwise returns <code>false</code>.<br />
<br />
== Examples ==<br />
Enable proximity voice:<br />
<syntaxhighlight lang="lua" line><br />
setPlayerVoiceMode(playerId, "proximity")<br />
</syntaxhighlight><br />
<br />
== Notes ==<br />
* Available only in server-side resource scripts.<br />
* Proximity routes to listeners in range, channel routes to the same channel, and global routes to every eligible listener.<br />
* Mode names are case-insensitive.<br />
<br />
[[Category:Lua Functions]]<br />
[[Category:Server Functions]]<br />
[[Category:Player Functions]]<br />
[[Category:Voice Functions]]</div>
QCherry