Skip to main content

ChannelShared

Shared accessor methods injected into both client and server channel objects.

Functions​

Inject​

</>
ChannelShared.Inject(
injectee: {[string]: any}--

Target table to inject methods into.

) → ()

Injects shared accessor functions into a metatable or class table.

HasMember​

</>
ChannelShared:HasMember(
memberId: string--

The member ID to check.

) → boolean

Checks whether a member exists in the channel.

GetMembers​

</>
ChannelShared:GetMembers() → {[string]: Member}

Retrieves the dictionary of all channel members.

GetMember​

</>
ChannelShared:GetMember(
memberId: string--

Member ID string.

) → Member?

Gets a specific member by ID.

IsMemberMuted​

</>
ChannelShared:IsMemberMuted(
memberId: string--

Member ID.

) → boolean

Returns true if the member is marked as muted.

Show raw api
{
    "functions": [
        {
            "name": "HasMember",
            "desc": "Checks whether a member exists in the channel.",
            "params": [
                {
                    "name": "memberId",
                    "desc": "The member ID to check.",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 13,
                "path": "src/Shared/ChannelShared.lua"
            }
        },
        {
            "name": "GetMembers",
            "desc": "Retrieves the dictionary of all channel members.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{[string]: Member}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 20,
                "path": "src/Shared/ChannelShared.lua"
            }
        },
        {
            "name": "GetMember",
            "desc": "Gets a specific member by ID.",
            "params": [
                {
                    "name": "memberId",
                    "desc": "Member ID string.",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Member?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 27,
                "path": "src/Shared/ChannelShared.lua"
            }
        },
        {
            "name": "IsMemberMuted",
            "desc": "Returns true if the member is marked as muted.",
            "params": [
                {
                    "name": "memberId",
                    "desc": "Member ID.",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 35,
                "path": "src/Shared/ChannelShared.lua"
            }
        },
        {
            "name": "Inject",
            "desc": "Injects shared accessor functions into a metatable or class table.",
            "params": [
                {
                    "name": "injectee",
                    "desc": "Target table to inject methods into.",
                    "lua_type": "{[string]: any}"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/Shared/ChannelShared.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ChannelShared",
    "desc": "Shared accessor methods injected into both client and server channel objects.",
    "source": {
        "line": 3,
        "path": "src/Shared/ChannelShared.lua"
    }
}