• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    ChannelInfo

    Represents a chat channel in the game that voice and text can be sent through in order to communicate with the correct other players.

    Properties

    activePlayers

    ClientAndServer
    ReadOnly

    All players that have this channel as their active channel

    allowsText

    boolean
    ClientAndServer
    ReadOnly

    Whether or not this channel allows text chat.

    allowsVoice

    boolean
    ClientAndServer
    ReadOnly

    Whether or not this channel allows voice chat.

    channelId

    number
    ClientOnly
    ReadOnly

    isActive

    boolean
    ClientOnly

    The chat channel the local player is currently active in

    isJoined

    boolean
    ClientOnly

    Whether the local player has the ability to switch to this channel

    maxVolumeDistance

    number
    ClientAndServer
    ReadOnly

    minVolumeDistance

    number
    ClientAndServer
    ReadOnly

    name

    string
    ClientAndServer
    ReadOnly

    The unique name of the channel.

    players

    ClientAndServer
    ReadOnly

    The list of players in the channel.

    priority

    number
    ClientAndServer
    ReadOnly

    proximityChatEnabled

    boolean
    ClientAndServer
    ReadOnly

    speakerFilter

    (arg: Player) -> (boolean)
    ServerOnly
    WriteOnly

    Methods

    Returns

    void

    Parameters

    maxVolumeDistance
    number
    minVolumeDistance
    number

    Returns

    void

    IsPlayerActiveChannel

    ClientAndServer

    Parameters

    player

    Returns

    boolean

    IsPlayerInChannel

    ClientAndServer

    Parameters

    player

    Returns

    boolean

    Updated 9 days ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.