Skip to main content

BaseChannel

This item only works when running on the server. Server

Server-side base channel class handling membership state, replica updates, and audio effect definitions.

Functions​

new​

</>
BaseChannel.new(
channelDef: Channel,--

Initial channel definition table.

typeOverride: string?,--

Optional channel type identifier override.

dataToReplicate: {[string]: any}?--

Additional custom key-values to replicate.

) → BaseChannel

Constructs a new BaseChannel server instance.

AddMember​

</>
BaseChannel.AddMember(
self: BaseChannel,
memberDef: Member--

The member definition table.

) → ()

Adds a generic member to the channel.

AddPlayer​

</>
BaseChannel.AddPlayer(
self: BaseChannel,
player: Player--

The target player.

) → ()

Shorthand method to add a Player instance as a member.

RemoveMember​

</>
BaseChannel.RemoveMember(
self: BaseChannel,
memberId: string--

Unique member identifier.

) → ()

Removes a member by ID string.

RemovePlayer​

</>
BaseChannel.RemovePlayer(
self: BaseChannel,
player: Player--

Target player instance.

) → ()

Shorthand method to remove a player member.

SetIsMemberMuted​

</>
BaseChannel.SetIsMemberMuted(
self: BaseChannel,
memberId: string,--

Member identifier.

isMuted: boolean--

Mute toggle flag.

) → ()

Toggles muting state for a specified channel member.

AddEffect​

</>
BaseChannel.AddEffect(
self: BaseChannel,
effectId: AudioEffectId,--

Valid sound effect class identifier.

effectDef: AudioEffectDefinition--

Effect configuration dictionary.

) → ()

Adds an audio effect definition to the channel pipeline.

RemoveEffect​

</>
BaseChannel.RemoveEffect(
self: BaseChannel,
effectId: AudioEffectId--

The effect identifier to remove.

) → ()

Removes an audio effect from the channel.

UpdateEffect​

</>
BaseChannel.UpdateEffect(
self: BaseChannel,
effectId: AudioEffectId,--

Target effect ID.

mutatorFn: (effect: AudioEffectDefinition) → AudioEffectDefinition--

Mutator function.

) → ()

Mutates an existing audio effect via callback function.

Destroy​

</>
BaseChannel.Destroy(self: BaseChannel) → ()

Destroys the channel instance and cleans up underlying replicas.

new​

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

Client replica handle.

) → BaseChannelClient

Creates a new BaseChannel client object.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new BaseChannel server instance.",
            "params": [
                {
                    "name": "channelDef",
                    "desc": "Initial channel definition table.",
                    "lua_type": "Channel"
                },
                {
                    "name": "typeOverride",
                    "desc": "Optional channel type identifier override.",
                    "lua_type": "string?"
                },
                {
                    "name": "dataToReplicate",
                    "desc": "Additional custom key-values to replicate.",
                    "lua_type": "{[string]: any}?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BaseChannel"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "AddMember",
            "desc": "Adds a generic member to the channel.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "BaseChannel"
                },
                {
                    "name": "memberDef",
                    "desc": "The member definition table.",
                    "lua_type": "Member"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 105,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "AddPlayer",
            "desc": "Shorthand method to add a Player instance as a member.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "BaseChannel"
                },
                {
                    "name": "player",
                    "desc": "The target player.",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 120,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "RemoveMember",
            "desc": "Removes a member by ID string.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "BaseChannel"
                },
                {
                    "name": "memberId",
                    "desc": "Unique member identifier.",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 130,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "RemovePlayer",
            "desc": "Shorthand method to remove a player member.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "BaseChannel"
                },
                {
                    "name": "player",
                    "desc": "Target player instance.",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 145,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "SetIsMemberMuted",
            "desc": "Toggles muting state for a specified channel member.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "BaseChannel"
                },
                {
                    "name": "memberId",
                    "desc": "Member identifier.",
                    "lua_type": "string"
                },
                {
                    "name": "isMuted",
                    "desc": "Mute toggle flag.",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 152,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "AddEffect",
            "desc": "Adds an audio effect definition to the channel pipeline.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "BaseChannel"
                },
                {
                    "name": "effectId",
                    "desc": "Valid sound effect class identifier.",
                    "lua_type": "AudioEffectId"
                },
                {
                    "name": "effectDef",
                    "desc": "Effect configuration dictionary.",
                    "lua_type": "AudioEffectDefinition"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 167,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "RemoveEffect",
            "desc": "Removes an audio effect from the channel.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "BaseChannel"
                },
                {
                    "name": "effectId",
                    "desc": "The effect identifier to remove.",
                    "lua_type": "AudioEffectId"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 181,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "UpdateEffect",
            "desc": "Mutates an existing audio effect via callback function.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "BaseChannel"
                },
                {
                    "name": "effectId",
                    "desc": "Target effect ID.",
                    "lua_type": "AudioEffectId"
                },
                {
                    "name": "mutatorFn",
                    "desc": "Mutator function.",
                    "lua_type": "(effect: AudioEffectDefinition) -> AudioEffectDefinition"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 195,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroys the channel instance and cleans up underlying replicas.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "BaseChannel"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 220,
                "path": "src/Server/Channels/BaseChannel.lua"
            }
        },
        {
            "name": "new",
            "desc": "Creates a new BaseChannel client object.",
            "params": [
                {
                    "name": "replica",
                    "desc": "Client replica handle.",
                    "lua_type": "Replica"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BaseChannelClient"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/Client/Channels/BaseChannel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "BaseChannel",
    "desc": "Server-side base channel class handling membership state, replica updates, and audio effect definitions.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 4,
        "path": "src/Server/Channels/BaseChannel.lua"
    }
}