Skip to main content

VoiceChatUtils

Functions​

promiseIsVoiceEnabledForPlayer​

</>
VoiceChatUtils.promiseIsVoiceEnabledForPlayer(player: Player) → Promise<boolean>

Reports whether voice chat is enabled

promiseIsVoiceEnabledForUserId​

</>
VoiceChatUtils.promiseIsVoiceEnabledForUserId(userId: number) → Promise<boolean>

Wraps whether voice chat is enabled

Show raw api
{
    "functions": [
        {
            "name": "promiseIsVoiceEnabledForPlayer",
            "desc": "Reports whether voice chat is enabled",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 19,
                "path": "src/voicechat/src/Shared/VoiceChatUtils.lua"
            }
        },
        {
            "name": "promiseIsVoiceEnabledForUserId",
            "desc": "Wraps whether voice chat is enabled",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 31,
                "path": "src/voicechat/src/Shared/VoiceChatUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "VoiceChatUtils",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/voicechat/src/Shared/VoiceChatUtils.lua"
    }
}