Voice
constVoice:object
Defined in: server/api.d.ts:2726
Server-side proximity voice rules: how far voice carries, and who may talk to or hear whom.
Type Declaration
Section titled “Type Declaration”getPlayerRange()
Section titled “getPlayerRange()”getPlayerRange(
player):number
Reads how far a player’s voice carries, with the server-wide default already resolved.
Parameters
Section titled “Parameters”player
Section titled “player”Player to query.
Returns
Section titled “Returns”number
Radius in world units.
getRange()
Section titled “getRange()”getRange():
number
Reads the server-wide proximity range.
Returns
Section titled “Returns”number
Radius in world units.
isLocallyMuted()
Section titled “isLocallyMuted()”isLocallyMuted(
listener,target):boolean
Checks a one-way mute.
Parameters
Section titled “Parameters”listener
Section titled “listener”Player doing the muting.
target
Section titled “target”Player being muted.
Returns
Section titled “Returns”boolean
True when the listener does not receive the target.
isPlayerDeaf()
Section titled “isPlayerDeaf()”isPlayerDeaf(
player):boolean
Checks the server-wide deafen flag.
Parameters
Section titled “Parameters”player
Section titled “player”Player to query.
Returns
Section titled “Returns”boolean
True when the player receives nobody’s voice.
isPlayerMuted()
Section titled “isPlayerMuted()”isPlayerMuted(
player):boolean
Checks the server-wide mute flag.
Parameters
Section titled “Parameters”player
Section titled “player”Player to query.
Returns
Section titled “Returns”boolean
True when the player’s voice reaches nobody.
isPlayerVoiceEnabled()
Section titled “isPlayerVoiceEnabled()”isPlayerVoiceEnabled(
player):boolean
Checks whether a player left voice chat enabled in their own client settings. A preference, not a permission: use setPlayerMuted or setPlayerDeaf to enforce anything.
Parameters
Section titled “Parameters”player
Section titled “player”Player to query.
Returns
Section titled “Returns”boolean
True unless the player turned voice chat off.
setLocalMute()
Section titled “setLocalMute()”setLocalMute(
listener,target,muted):void
One-way mute between two players, enforced by the server rather than the client.
Parameters
Section titled “Parameters”listener
Section titled “listener”Player who stops hearing the target.
target
Section titled “target”Player the listener stops hearing.
boolean
True to mute, false to restore.
Returns
Section titled “Returns”void
setPlayerDeaf()
Section titled “setPlayerDeaf()”setPlayerDeaf(
player,deaf):void
Server-wide deafen: a deaf player receives nobody.
Parameters
Section titled “Parameters”player
Section titled “player”Player to deafen or undeafen.
boolean
True to stop them receiving anyone’s voice.
Returns
Section titled “Returns”void
setPlayerMuted()
Section titled “setPlayerMuted()”setPlayerMuted(
player,muted):void
Server-wide mute: a muted player’s voice reaches nobody.
Parameters
Section titled “Parameters”player
Section titled “player”Player to mute or unmute.
boolean
True to stop their voice reaching anyone.
Returns
Section titled “Returns”void
setPlayerRange()
Section titled “setPlayerRange()”setPlayerRange(
player,range):void
Overrides how far one player’s voice carries, for whisper and shout modes.
Parameters
Section titled “Parameters”player
Section titled “player”Player whose voice carries the given distance.
number
Audibility radius in world units; values <= 0 return them to the server-wide range.
Returns
Section titled “Returns”void
setRange()
Section titled “setRange()”setRange(
range):void
Sets how far voice carries for talkers with no override of their own. Connected clients are told, so their playback fades out at the same distance.
Parameters
Section titled “Parameters”number
Audibility radius in world units; values <= 0 restore the default of 25.
Returns
Section titled “Returns”void