Skip to main content
Branch: Development

VoiceChannel

Hierarchy

  • BaseObject
    • VoiceChannel

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Creates a new voice channel.

    Remarks

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

Properties

publicfilter

filter: number

Hash of the filter name (should also be created on clientside). See docs: Audio filters, Voice.

publicreadonlyid

id: number

publicreadonlyisSpatial

isSpatial: boolean

publicreadonlymaxDistance

maxDistance: number

publicreadonlyplayerCount

playerCount: number

publicreadonlyplayers

players: readonly Player[]

publicpriority

priority: number

Priority of voice channel. If a player is in two channels and both can be heard by another player, only one should play the voice. Value is of type integer, can be negative.

publicreadonlyrefCount

refCount: number

Returns the ref count of the entity.

Remarks

It’s only available in debug-mode.

publicreadonlytype

type: BaseObjectType

Type of the object.

publicreadonlyvalid

valid: boolean

Object usability.

Returns

False if object is no longer usable.

Methods

publicaddPlayer

  • addPlayer(player: Player): void

publicdeleteMeta

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

publicdeleteSyncedMeta

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

  • Removes the specified key and the data connected to that specific key.

publicdestroy

  • destroy(): void

  • Removes the object from the world.

publicgetMeta

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

  • Type parameters

    • K: string

publicgetMetaDataKeys

  • getMetaDataKeys(): readonly string[]

publicgetSyncedMeta

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

  • Gets a value using the specified key.

    Type parameters

    • K: string

publicgetSyncedMetaKeys

  • getSyncedMetaKeys(): readonly string[]

publichasMeta

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

publichasSyncedMeta

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

  • Determines whether contains the specified key.

publicisPlayerInChannel

  • isPlayerInChannel(player: Player): boolean

publicisPlayerMuted

  • isPlayerMuted(player: Player): boolean

publicmutePlayer

  • mutePlayer(player: Player): void

publicremovePlayer

  • removePlayer(player: Player): void

publicsetMeta

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

  • Type parameters

    • K: string

publicsetSyncedMeta

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

  • Stores the given value with the specified key.

    Remarks

    The given value will be shared with all clients.

    Type parameters

    • K: string

publicunmutePlayer

  • unmutePlayer(player: Player): void

publicstaticgetByID

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

  • Gets the base object with the given type and id