Skip to main content

ProximityChannel

This item only works when running on the server. Server

Server implementation of 3D spatial voice chat channels with distance attenuation.

Functions​

new​

</>
ProximityChannel.new(
channelDef: Channel--

The channel configuration table.

) → ProximityChannel

Creates a new server ProximityChannel.

new​

</>
ProximityChannel.new(
replica: Replica--

Client channel replica.

) → ProximityChannelClient

Creates a new ProximityChannel client handler.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new server ProximityChannel.",
            "params": [
                {
                    "name": "channelDef",
                    "desc": "The channel configuration table.",
                    "lua_type": "Channel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ProximityChannel"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 19,
                "path": "src/Server/Channels/ProximityChannel.lua"
            }
        },
        {
            "name": "new",
            "desc": "Creates a new ProximityChannel client handler.",
            "params": [
                {
                    "name": "replica",
                    "desc": "Client channel replica.",
                    "lua_type": "Replica"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ProximityChannelClient"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 26,
                "path": "src/Client/Channels/ProximityChannel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ProximityChannel",
    "desc": "Server implementation of 3D spatial voice chat channels with distance attenuation.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 4,
        "path": "src/Server/Channels/ProximityChannel.lua"
    }
}