VoiceChannel | custom alt:V docs JS

Hierarchy

BaseObject
- VoiceChannel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new VoiceChannel(isSpatial: boolean, maxDistance: number): VoiceChannel

Overrides BaseObject.constructor
- Defined in types-server/index.d.ts:2811
Creates a new voice channel.

remarks

This throws an error when the voice chat is not activated on serverside.

Parameters
- isSpatial: boolean
  
  Whether the voice channel should be 3D (e.g. talking in person) or 1D (e.g. talking over a telephone).
- maxDistance: number
  
  The max distance at which you can hear each other.
Returns VoiceChannel

Properties

filter

filter: number

Readonly id

id: number

Readonly isSpatial

isSpatial: boolean

Readonly maxDistance

maxDistance: number

Readonly playerCount

playerCount: number

Readonly players

players: readonly Player[]

priority

priority: number

Readonly refCount

refCount: number

Returns the ref count of the entity.

remarks: It's only available in debug-mode.

Readonly type

type: BaseObjectType

Type of the object.

Readonly valid

valid: boolean

Object usability.

returns: False if object is no longer usable.

Methods

addPlayer

addPlayer(player: Player): void

- Defined in types-server/index.d.ts:2829
Parameters
- player: Player
Returns void

deleteMeta

deleteMeta(key: string): void
deleteMeta<K>(key: K): void

Overrides BaseObject.deleteMeta
- Defined in types-server/index.d.ts:2841
Parameters
- key: string
Returns void
Overrides BaseObject.deleteMeta
- Defined in types-server/index.d.ts:2842
Type parameters
- K: shared.ExtractStringKeys<ICustomVoiceChannelMeta>
Parameters
- key: K
Returns void

deleteSyncedMeta

deleteSyncedMeta(key: string): void
deleteSyncedMeta<K>(key: K): void

Inherited from BaseObject.deleteSyncedMeta
- Defined in types-server/index.d.ts:695
Removes the specified key and the data connected to that specific key.

Parameters
- key: string
  
  The key of the value to remove.
Returns void
Inherited from BaseObject.deleteSyncedMeta
- Defined in types-server/index.d.ts:696
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectSyncedMeta>
Parameters
- key: K
Returns void

destroy

destroy(): void

Inherited from BaseObject.destroy
- Defined in types-shared/index.d.ts:2563
Removes the object from the world.

Returns void

getMeta

getMeta<K>(key: Exclude<K, keyof ICustomVoiceChannelMeta>): unknown
getMeta<K>(key: K): ICustomVoiceChannelMeta[K] | undefined
getMeta<V>(key: string): V | undefined

Overrides BaseObject.getMeta
- Defined in types-server/index.d.ts:2847
Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomVoiceChannelMeta>
Returns unknown
Overrides BaseObject.getMeta
- Defined in types-server/index.d.ts:2848
Type parameters
- K: shared.ExtractStringKeys<ICustomVoiceChannelMeta>
Parameters
- key: K
Returns ICustomVoiceChannelMeta[K] | undefined
Overrides BaseObject.getMeta
- Defined in types-server/index.d.ts:2850
deprecated

See ICustomVoiceChannelMeta

Type parameters
- V: any
Parameters
- key: string
Returns V | undefined

getMetaDataKeys

getMetaDataKeys(): readonly string[]

Inherited from BaseObject.getMetaDataKeys
- Defined in types-shared/index.d.ts:2593
Returns readonly string[]

getSyncedMeta

getSyncedMeta<K>(key: Exclude<K, keyof ICustomBaseObjectSyncedMeta>): unknown
getSyncedMeta<K>(key: K): ICustomBaseObjectSyncedMeta[K] | undefined
getSyncedMeta<V>(key: string): V | undefined

Inherited from BaseObject.getSyncedMeta
- Defined in types-shared/index.d.ts:2614
Gets a value using the specified key.

Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomBaseObjectSyncedMeta>
  
  The key of the value to get.
Returns unknown

Dynamic value associated with the specified key or undefined if no data is present.
Inherited from BaseObject.getSyncedMeta
- Defined in types-shared/index.d.ts:2615
Type parameters
- K: ExtractStringKeys<ICustomBaseObjectSyncedMeta>
Parameters
- key: K
Returns ICustomBaseObjectSyncedMeta[K] | undefined
Inherited from BaseObject.getSyncedMeta
- Defined in types-shared/index.d.ts:2617
deprecated

See "alt-shared".ICustomBaseObjectSyncedMeta

Type parameters
- V: any
Parameters
- key: string
Returns V | undefined

getSyncedMetaKeys

getSyncedMetaKeys(): readonly string[]

Inherited from BaseObject.getSyncedMetaKeys
- Defined in types-shared/index.d.ts:2628
Returns readonly string[]

hasMeta

hasMeta(key: string): boolean
hasMeta<K>(key: K): boolean

Overrides BaseObject.hasMeta
- Defined in types-server/index.d.ts:2844
Parameters
- key: string
Returns boolean
Overrides BaseObject.hasMeta
- Defined in types-server/index.d.ts:2845
Type parameters
- K: shared.ExtractStringKeys<ICustomVoiceChannelMeta>
Parameters
- key: K
Returns boolean

hasSyncedMeta

hasSyncedMeta(key: string): boolean
hasSyncedMeta<K>(key: K): boolean

Inherited from BaseObject.hasSyncedMeta
- Defined in types-shared/index.d.ts:2625
Determines whether contains the specified key.

Parameters
- key: string
  
  The key of the value to locate.
Returns boolean

True if the meta table contains any data at the specified key or False if not
Inherited from BaseObject.hasSyncedMeta
- Defined in types-shared/index.d.ts:2626
Type parameters
- K: ExtractStringKeys<ICustomBaseObjectSyncedMeta>
Parameters
- key: K
Returns boolean

isPlayerInChannel

isPlayerInChannel(player: Player): boolean

- Defined in types-server/index.d.ts:2831
Parameters
- player: Player
Returns boolean

isPlayerMuted

isPlayerMuted(player: Player): boolean

- Defined in types-server/index.d.ts:2833
Parameters
- player: Player
Returns boolean

mutePlayer

mutePlayer(player: Player): void

- Defined in types-server/index.d.ts:2835
Parameters
- player: Player
Returns void

removePlayer

removePlayer(player: Player): void

- Defined in types-server/index.d.ts:2837
Parameters
- player: Player
Returns void

setMeta

setMeta<K>(key: K, value: shared.InterfaceValueByKey<ICustomVoiceChannelMeta, K>): void
setMeta<K>(key: K, value: ICustomVoiceChannelMeta[K]): void
setMeta<V, K>(key: K, value: shared.InterfaceValueByKey<ICustomVoiceChannelMeta, K, V>): void

Overrides BaseObject.setMeta
- Defined in types-server/index.d.ts:2852
Type parameters
- K: string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomVoiceChannelMeta, K>
Returns void
Overrides BaseObject.setMeta
- Defined in types-server/index.d.ts:2853
Type parameters
- K: shared.ExtractStringKeys<ICustomVoiceChannelMeta>
Parameters
- key: K
- value: ICustomVoiceChannelMeta[K]
Returns void
Overrides BaseObject.setMeta
- Defined in types-server/index.d.ts:2855
deprecated

See ICustomVoiceChannelMeta

Type parameters
- V: any
- K: string = string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomVoiceChannelMeta, K, V>
Returns void

setSyncedMeta

setSyncedMeta<K>(key: K, value: shared.InterfaceValueByKey<ICustomBaseObjectSyncedMeta, K>): void
setSyncedMeta<K>(key: K, value: ICustomBaseObjectSyncedMeta[K]): void
setSyncedMeta<V, K>(key: K, value: shared.InterfaceValueByKey<ICustomBaseObjectSyncedMeta, K, V>): void

Inherited from BaseObject.setSyncedMeta
- Defined in types-server/index.d.ts:706
Stores the given value with the specified key.

remarks

The given value will be shared with all clients.

Type parameters
- K: string
Parameters
- key: K
  
  The key of the value to store.
- value: shared.InterfaceValueByKey<ICustomBaseObjectSyncedMeta, K>
  
  The value to store.
Returns void
Inherited from BaseObject.setSyncedMeta
- Defined in types-server/index.d.ts:707
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectSyncedMeta>
Parameters
- key: K
- value: ICustomBaseObjectSyncedMeta[K]
Returns void
Inherited from BaseObject.setSyncedMeta
- Defined in types-server/index.d.ts:709
deprecated

See "alt-shared".ICustomBaseObjectSyncedMeta

Type parameters
- V: any
- K: string = string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomBaseObjectSyncedMeta, K, V>
Returns void

unmutePlayer

unmutePlayer(player: Player): void

- Defined in types-server/index.d.ts:2839
Parameters
- player: Player
Returns void

Static getByID

getByID(type: BaseObjectType, id: number): BaseObject | null

Inherited from BaseObject.getByID
- Defined in types-server/index.d.ts:672
Gets the base object with the given type and id

Parameters
- type: BaseObjectType
- id: number
Returns BaseObject | null

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

isSpatial: boolean

maxDistance: number

Returns VoiceChannel

Properties

filter

Readonly id

Readonly isSpatial

Readonly maxDistance

Readonly playerCount

Readonly players

priority

Readonly refCount

Readonly type

Readonly valid

Methods

addPlayer

Parameters

player: Player

Returns void

deleteMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomVoiceChannelMeta>

Parameters

key: K

Returns void

deleteSyncedMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomBaseObjectSyncedMeta>

Parameters

key: K

Returns void

destroy

Returns void

getMeta

Type parameters

K: string

Parameters

key: Exclude<K, keyof ICustomVoiceChannelMeta>

Returns unknown

Type parameters

K: shared.ExtractStringKeys<ICustomVoiceChannelMeta>

Parameters

key: K

Returns ICustomVoiceChannelMeta[K] | undefined

Type parameters

V: any

Parameters

key: string

Returns V | undefined

getMetaDataKeys

Returns readonly string[]

getSyncedMeta

Type parameters

K: string

Parameters

key: Exclude<K, keyof ICustomBaseObjectSyncedMeta>

Returns unknown

Type parameters

K: ExtractStringKeys<ICustomBaseObjectSyncedMeta>

Parameters

key: K

Returns ICustomBaseObjectSyncedMeta[K] | undefined

Type parameters

V: any

Parameters

key: string