Custom Text Chat Commands

TextChatService has built-in chat commands for common purposes, such as muting other players and using avatar emotes. You can enable them by setting TextChatService.CreateDefaultCommands to true in the Studio Properties panel.

You can also add custom commands using TextChatCommand. Users sending a defined command in the chat input bar trigger a callback defined by TextChatCommand.Triggered to perform your customized actions.

The following example shows how to create a chat command that allows players to increase or decrease their character's size when they input /super or /mini.

1. Add a TextChatCommand instance inside TextChatService.

2. Rename it SizeCommand.

   

3. Set its PrimaryAlias property to /super and its SecondaryAlias to /mini.

   

4. Insert the following Script inside ServerScriptService to define a callback for the chat command that scales the character's size:

   Script
   local TextChatService = game:GetService("TextChatService")
   local Players = game:GetService("Players")
   
   local sizeCommand: TextChatCommand = TextChatService:WaitForChild("SizeCommand")
   
   sizeCommand.Triggered:Connect(function(textSource, message)
    local scaleMult = 1
    local messageWords = string.split(message, " ")
    if messageWords[1] == "/super" then
      scaleMult = 2
    elseif messageWords[1] == "/mini" then
      scaleMult = 0.5
    end
   
    local player = Players:GetPlayerByUserId(textSource.UserId)
    if player then
      local character = player.Character
      if character then
        local humanoid = character:FindFirstChildWhichIsA("Humanoid")
        if humanoid then
          for _, child in humanoid:GetChildren() do
            if child:IsA("NumberValue") then
              child.Value *= scaleMult
            end
          end
        end
      end
    end
   end)