# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: ChatWindowMessageProperties
type: class
memory_category: Instances
summary: ''
description: |
  Can be used to customize the appearance of text chat messages sent to the
  ChatWindow. Inherits from `Class.TextChatMessageProperies`. To create a new
  `ChatWindowMessageProperties` instance, use
  `Class.ChatWindowConfiguration:DeriveNewMessageProperties()` which will have
  the current properties from `Class.ChatWindowConfiguration`.

  ```lua
  local TextChatService = game:GetService("TextChatService")

  local ChatWindowConfiguration = TextChatService:FindFirstChildOfClass("ChatWindowConfiguration")

  TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
    -- Derive chat message properties
    local properties = ChatWindowConfiguration:DeriveNewMessageProperties()

    -- Change color of message within the chat window
    properties.TextColor3 = Color3.fromRGB(255, 121, 121)

    return properties
  end
  ```
code_samples: []
inherits:
  - TextChatMessageProperties
descendants: []
tags:
  - NotCreatable
deprecation_message: ''
properties:
  - name: ChatWindowMessageProperties.FontFace
    summary: |
      Font used to render text in the chat window.
    description: |
      Determines the font used to render text in the chat window. Default is
      `Enum.Font.BuilderSansMedium`.
    code_samples: []
    type: Datatype.Font
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
  - name: ChatWindowMessageProperties.PrefixTextProperties
    summary: |
      Determines the properties of the
      `Class.TextChatMessage.PrefixText|PrefixText` preceding the chat message.
    description: |
      Determines the properties of the `Class.TextChatMessage.PrefixText`
      preceding the chat message.
    code_samples: []
    type: ChatWindowMessageProperties
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
  - name: ChatWindowMessageProperties.TextColor3
    summary: |
      Color of the text in the chat window.
    description: |
      Determines the color of the text in the chat window. Default value is
      `Datatype.Color3.fromRGB(255, 255, 255)` (white).
    code_samples: []
    type: Color3
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
  - name: ChatWindowMessageProperties.TextSize
    summary: |
      Size of the text in the chat window.
    description: |
      Determines the size of the text in the chat window.
    code_samples: []
    type: int
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
  - name: ChatWindowMessageProperties.TextStrokeColor3
    summary: |
      Stroke color applied to text in the chat window.
    description: |
      Determines the stroke color applied to text in the chat window. Default
      value is `Datatype.Color3.fromRGB(0, 0, 0)` (black).
    code_samples: []
    type: Color3
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
  - name: ChatWindowMessageProperties.TextStrokeTransparency
    summary: |
      Transparency of the stroke applied to text in the chat window.
    description: |
      Determines the transparency of the stroke applied to text in the chat
      window. Default value is `0.5`.
    code_samples: []
    type: double
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
methods: []
events: []
callbacks: []