REVO / API version 0.0.10
VoiceChannel
A player can speak on multiple channels independently. Speakers do not hear themselves.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new VoiceChannel(
options?):VoiceChannel
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
IVoiceChannelOptions |
Returns
Section titled “Returns”VoiceChannel
Overrides
Section titled “Overrides”Base.constructor
Properties
Section titled “Properties”| Property | Type | Details |
|---|---|---|
category |
string |
Client-defined AudioCategory name. An empty name uses the neutral voice category. |
effects |
readonly AudioEffect[] |
Up to 16 effects, applied in order before category effects, separately for each speaker and listener. Returns a copy. Assign a new array to update, or [] to clear. |
enabled |
boolean |
— |
id |
number |
|
networkId |
number | null |
— |
playerCount |
number |
— |
players |
readonly Player[] |
— |
range |
number |
Maximum delivery distance in metres for spatial channels. Must be positive. GTA handles local attenuation. |
spatial |
boolean |
— |
type |
BaseType |
|
valid |
boolean |
|
volume |
number |
-100..0 dB. |
all |
readonly VoiceChannel[] |
|
count |
number |
Methods
Section titled “Methods”addPlayer()
Section titled “addPlayer()”addPlayer(
player,permissions?):boolean
Omitted permissions default to true. Existing members keep their permissions.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
Player |
permissions? |
Partial<IVoicePermissions> |
Returns
Section titled “Returns”boolean
clearPlayers()
Section titled “clearPlayers()”clearPlayers():
void
Returns
Section titled “Returns”void
deleteSyncedMeta()
Section titled “deleteSyncedMeta()”deleteSyncedMeta(
key):void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Returns
Section titled “Returns”void
getPlayerPermissions()
Section titled “getPlayerPermissions()”getPlayerPermissions(
player):Readonly<IVoicePermissions> |null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
Player |
Returns
Section titled “Returns”Readonly<IVoicePermissions> | null
getSyncedMeta()
Section titled “getSyncedMeta()”Call Signature
Section titled “Call Signature”getSyncedMeta<
K>(key):ICustomBaseSyncedMeta[K] |undefined
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends never |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
K |
Returns
Section titled “Returns”ICustomBaseSyncedMeta[K] | undefined
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”getSyncedMeta<
T>(key):T|undefined
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T |
TransportValue |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”T | undefined
Inherited from
Section titled “Inherited from”getSyncedMetaKeys()
Section titled “getSyncedMetaKeys()”getSyncedMetaKeys():
string[]
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”hasPlayer()
Section titled “hasPlayer()”hasPlayer(
player):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
Player |
Returns
Section titled “Returns”boolean
hasSyncedMeta()
Section titled “hasSyncedMeta()”hasSyncedMeta(
key):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”removePlayer()
Section titled “removePlayer()”removePlayer(
player):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
Player |
Returns
Section titled “Returns”boolean
setPlayerPermissions()
Section titled “setPlayerPermissions()”setPlayerPermissions(
player,permissions):boolean
Returns false if the player is not a member.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
player |
Player |
permissions |
IVoicePermissions |
Returns
Section titled “Returns”boolean
setSyncedMeta()
Section titled “setSyncedMeta()”Call Signature
Section titled “Call Signature”setSyncedMeta<
K>(key,value):void
Copies and replicates the value to the object’s audience. Player metadata also goes to that player.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends string |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
K |
value |
K extends never ? ICustomBaseSyncedMeta[K] : TransportValue |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”setSyncedMeta(
values):void
Atomically merges own enumerable fields. Unsupported values reject the entire batch.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
values |
Partial<ICustomBaseSyncedMeta> & Record<string, TransportValue> |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getById()
Section titled “getById()”
staticgetById(id):VoiceChannel|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”VoiceChannel | null
Overrides
Section titled “Overrides”getByNetworkId()
Section titled “getByNetworkId()”
staticgetByNetworkId(networkId):VoiceChannel|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
networkId |
number |
Returns
Section titled “Returns”VoiceChannel | null