GetPlayerVoiceVolume
Jump to navigation
Jump to search
getPlayerVoiceVolume
Returns the player's server-authoritative voice volume multiplier.
Syntax
number|false getPlayerVoiceVolume(int playerId)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | The connected player identifier. |
Returns
Returns a multiplier from 0.0 through 2.0, or false for an invalid player.
Examples
Read the volume multiplier:
local volume = getPlayerVoiceVolume(playerId)
if volume then
outputDebugString(tostring(volume))
end
Notes
- Available only in server-side resource scripts.