Index

Search Results for

    Class VoiceChannel

    Inheritance
    BaseObject
    BaseObject
    VoiceChannel
    Inherited Members
    BaseObject.type
    BaseObject.valid
    BaseObject.id
    BaseObject.destroy
    BaseObject.getMetaDataKeys
    BaseObject.getSyncedMeta
    BaseObject.hasSyncedMeta
    BaseObject.getSyncedMetaKeys
    BaseObject.refCount
    Module: alt-server
    Package: @altmp/altv-types
    Syntax
    class VoiceChannel extends BaseObject

    Constructors

    | Improve this Doc View Source

    VoiceChannel(boolean, number)

    Declaration
    VoiceChannel(isSpatial: boolean, maxDistance: number): VoiceChannel
    Parameters
    Type Name Description
    boolean isSpatial
    number maxDistance

    Properties

    | Improve this Doc View Source

    maxDistance

    Declaration
    public readonly maxDistance: number
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    isSpatial

    Declaration
    public readonly isSpatial: boolean
    Property Value
    Type Description
    boolean
    | Improve this Doc View Source

    priority

    Declaration
    public priority: number
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    filter

    Declaration
    public filter: number
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    players

    Declaration
    public readonly players: readonly Player[]
    Property Value
    Type Description
    readonly Player[]
    | Improve this Doc View Source

    playerCount

    Declaration
    public readonly playerCount: number
    Property Value
    Type Description
    number

    Methods

    | Improve this Doc View Source

    addPlayer(Player)

    Declaration
    public addPlayer(player: Player): void
    Parameters
    Type Name Description
    Player player
    | Improve this Doc View Source

    isPlayerInChannel(Player)

    Declaration
    public isPlayerInChannel(player: Player): boolean
    Parameters
    Type Name Description
    Player player
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isPlayerMuted(Player)

    Declaration
    public isPlayerMuted(player: Player): boolean
    Parameters
    Type Name Description
    Player player
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    mutePlayer(Player)

    Declaration
    public mutePlayer(player: Player): void
    Parameters
    Type Name Description
    Player player
    | Improve this Doc View Source

    removePlayer(Player)

    Declaration
    public removePlayer(player: Player): void
    Parameters
    Type Name Description
    Player player
    | Improve this Doc View Source

    unmutePlayer(Player)

    Declaration
    public unmutePlayer(player: Player): void
    Parameters
    Type Name Description
    Player player
    | Improve this Doc View Source

    deleteMeta(string)

    Declaration
    public deleteMeta(key: string): void
    Parameters
    Type Name Description
    string key
    | Improve this Doc View Source

    deleteMeta<K extends never>(K)

    Declaration
    public deleteMeta<K extends never>(key: K): void
    Parameters
    Type Name Description
    K key
    | Improve this Doc View Source

    hasMeta(string)

    Declaration
    public hasMeta(key: string): boolean
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    hasMeta<K extends never>(K)

    Declaration
    public hasMeta<K extends never>(key: K): boolean
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getMeta<K extends string>(Exclude<K, never>)

    Declaration
    public getMeta<K extends string>(key: Exclude<K, never>): unknown
    Parameters
    Type Name Description
    Exclude<K, never> key
    Returns
    Type Description
    unknown
    | Improve this Doc View Source

    getMeta<K extends never>(K)

    Declaration
    public getMeta<K extends never>(key: K): undefined | ICustomVoiceChannelMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomVoiceChannelMeta[K]
    | Improve this Doc View Source

    getMeta<V extends unknown>(string)

    Declaration
    public getMeta<V extends unknown>(key: string): undefined | V
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    undefined | V
    | Improve this Doc View Source

    setMeta<K extends string>(K, InterfaceValueByKey<ICustomVoiceChannelMeta, K, unknown, void>)

    Declaration
    public setMeta<K extends string>(key: K, value: InterfaceValueByKey<ICustomVoiceChannelMeta, K, unknown, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomVoiceChannelMeta, K, unknown, void> value
    | Improve this Doc View Source

    setMeta<K extends never>(K, ICustomVoiceChannelMeta[K])

    Declaration
    public setMeta<K extends never>(key: K, value: ICustomVoiceChannelMeta[K]): void
    Parameters
    Type Name Description
    K key
    ICustomVoiceChannelMeta[K] value
    | Improve this Doc View Source

    setMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomVoiceChannelMeta, K, V, void>)

    Declaration
    public setMeta<V extends unknown, K extends string>(key: K, value: InterfaceValueByKey<ICustomVoiceChannelMeta, K, V, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomVoiceChannelMeta, K, V, void> value
    | Improve this Doc View Source

    setMeta(MetaValues<ICustomVoiceChannelMeta>)

    Declaration
    public setMeta(values: MetaValues<ICustomVoiceChannelMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomVoiceChannelMeta> values