SetPlayerVoiceEnabled: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetPlayerVoiceEnabled(player, enable)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{Func..."
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Enable a player's voice chat.}}


{{FuncSyntax|SetPlayerVoiceEnabled(player, enable)}}
{{FuncSyntax|SetPlayerVoiceEnabled(playerid, bEnable)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|playerid|The player identifier.}}
{{FuncParam|enable|__EDIT_ME__}}
{{FuncParam|bEnable|The boolean enable status.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' if the change was succesfull, otherwise '''false'''.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
SetPlayerVoiceEnabled(player, false) -- mute
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:VoiceFunctions}}

Latest revision as of 14:46, 26 June 2021

SetPlayerVoiceEnabled

Type: Function
Context: Server
Introduced: v1.0

Description

Enable a player's voice chat.

Syntax

SetPlayerVoiceEnabled(playerid, bEnable)

Parameters

  • playerid
    The player identifier.
  • bEnable
    The boolean enable status.

Return Value

  • Returns true if the change was succesfull, otherwise false.

Example

SetPlayerVoiceEnabled(player, false) -- mute

See also