Skip to main content

ChatProviderService

Wrapper around Roblox chat service on the server

Functions​

SetDeveloperTag​

</>
ChatProviderService:SetDeveloperTag(chatTagData: ChatTagData | nil) → Maid

Sets the developer chat tag

SetAdminTag​

</>
ChatProviderService:SetAdminTag(chatTagData: ChatTagData | nil) → Maid

Sets the admin tag to the game

PromiseAddChatTag​

</>
ChatProviderService:PromiseAddChatTag(
player: Player,
chatTagData: ChatTagData
) → Promise<Instance>

Promises to add a chat tag to the player

ClearChatTags​

</>
ChatProviderService:ClearChatTags(player: Player) → ()

Clears the player's chat chatTagData.

PromiseSetSpeakerTags​

</>
ChatProviderService:PromiseSetSpeakerTags(
speakerName: string,
chatTagDataList: {ChatTagData}
) → ()

Sets the speaker's tag (by speaker name)

Show raw api
{
    "functions": [
        {
            "name": "SetDeveloperTag",
            "desc": "Sets the developer chat tag",
            "params": [
                {
                    "name": "chatTagData",
                    "desc": "",
                    "lua_type": "ChatTagData | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Maid"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 72,
                "path": "src/chatproviderservice/src/Server/ChatProviderService.lua"
            }
        },
        {
            "name": "SetAdminTag",
            "desc": "Sets the admin tag to the game",
            "params": [
                {
                    "name": "chatTagData",
                    "desc": "",
                    "lua_type": "ChatTagData | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Maid"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 91,
                "path": "src/chatproviderservice/src/Server/ChatProviderService.lua"
            }
        },
        {
            "name": "PromiseAddChatTag",
            "desc": "Promises to add a chat tag to the player",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "chatTagData",
                    "desc": "",
                    "lua_type": "ChatTagData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Instance>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 150,
                "path": "src/chatproviderservice/src/Server/ChatProviderService.lua"
            }
        },
        {
            "name": "ClearChatTags",
            "desc": "Clears the player's chat chatTagData.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 167,
                "path": "src/chatproviderservice/src/Server/ChatProviderService.lua"
            }
        },
        {
            "name": "PromiseSetSpeakerTags",
            "desc": "Sets the speaker's tag (by speaker name)",
            "params": [
                {
                    "name": "speakerName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "chatTagDataList",
                    "desc": "",
                    "lua_type": "{ ChatTagData }"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 184,
                "path": "src/chatproviderservice/src/Server/ChatProviderService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ChatProviderService",
    "desc": "Wrapper around Roblox chat service on the server",
    "source": {
        "line": 5,
        "path": "src/chatproviderservice/src/Server/ChatProviderService.lua"
    }
}