# 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: ChatWindowConfiguration
type: class
memory_category: Instances
summary: |
  Configures properties of the default chat window.
description: |
  Configures properties of the default text chat window. It is parented to
  `Class.TextChatService`.
code_samples: []
inherits:
  - TextChatConfigurations
descendants: []
tags:
  - NotCreatable
deprecation_message: ''
properties:
  - name: ChatWindowConfiguration.AbsolutePosition
    summary: |
      Actual screen position of the default chat window, in pixels.
    description: |
      Read-only property that provides the screen position of the default chat
      window in pixels. Behaves similarly to `Class.GuiBase2d.AbsolutePosition`.
    code_samples: []
    type: Vector2
    tags:
      - ReadOnly
      - NotReplicated
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: Unsafe
    category: Data
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.AbsoluteSize
    summary: |
      Actual screen size of the default chat window, in pixels.
    description: |
      Read-only property that provides the screen size of the default chat
      window in pixels. Behaves similarly to `Class.GuiBase2d.AbsoluteSize`.
    code_samples: []
    type: Vector2
    tags:
      - ReadOnly
      - NotReplicated
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: Unsafe
    category: Data
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.BackgroundColor3
    summary: |
      Background color of the default chat window.
    description: |
      Background color of the default chat window. If the background color is
      not overridden, this value will respect the user's
      `Class.GuiService.PreferredTransparency` by making the menu more gray as
      the transparency of the menu decreases. Default value is
      `Datatype.Color3|Color3.new(25, 27, 29)`.
    code_samples: []
    type: Color3
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.BackgroundTransparency
    summary: |
      Background transparency of the default chat window.
    description: |
      Background transparency of the default chat window as a number between `0`
      and `1`. This value is multiplied with the user's
      `Class.GuiService.PreferredTransparency` to create the effective
      background transparency used by the chat window, which may be more opaque
      than this value set here. Default value is `0.3`.
    code_samples: []
    type: double
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.Enabled
    summary: |
      Whether to show the default chat window.
    description: |
      Whether to show the default chat window. Set to `false` to hide.
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Behavior
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.FontFace
    summary: |
      Font used to render text in the default chat window.
    description: |
      Font used to render text in the default 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: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.HeightScale
    summary: |
      Factor by which the height of the default chat window should be scaled.
    description: |
      Factor by which the height of the default chat window should be scaled.
      Must be a value between `0.5` and `2`. Defining a value outside of range
      clamps the actual value to the closest bound.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Behavior
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.HorizontalAlignment
    summary: |
      Horizontal alignment of the chat window.
    description: |
      Horizontal alignment of the chat window. Behaves similarly to
      `Class.UIGridStyleLayout.HorizontalAlignment`. Setting to
      `Enum.HorizontalAlignment|Left` or `Enum.HorizontalAlignment|Right` adding
      a small padding away from touching the corresponding horizontal edge of
      the screen. Setting to `Enum.HorizontalAlignment|Center` aligns the window
      in the horizontal middle of the screen. Default value is
      `Enum.HorizontalAlignment|Left`.
    code_samples: []
    type: HorizontalAlignment
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: Unsafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.TextColor3
    summary: |
      Color of the text in default chat window.
    description: |
      Color of the text in default chat window. Default value is
      `Datatype.Color3|Color3.new(255, 255, 255)`.
    code_samples: []
    type: Color3
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.TextSize
    summary: |
      Size of the text in default chat window.
    description: |
      Size of the text in default chat window. Default value is `14`.
    code_samples: []
    type: int64
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.TextStrokeColor3
    summary: |
      Color of the text stroke for text in default chat window.
    description: |
      Color of the text stroke for text in default chat window. Default value is
      `Datatype.Color3|Color3.new(0, 0, 0)`.
    code_samples: []
    type: Color3
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.TextStrokeTransparency
    summary: |
      Transparency of the text stroke for text in default chat window.
    description: |
      Transparency of the text stroke for text in default 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: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.VerticalAlignment
    summary: |
      Vertical alignment of the chat window.
    description: |
      Vertical alignment of the chat window. Behaves similarly to
      `Class.UIGridStyleLayout.VerticalAlignment`. Setting to
      `Enum.VerticalAlignment|Top` or `Enum.VerticalAlignment|Bottom` adds a
      small padding away from touching the corresponding edge of the screen.
      Setting to `Enum.VerticalAlignment|Center` aligns the window in the
      vertical middle of the screen. Default value is
      `Enum.VerticalAlignment|Top`.
    code_samples: []
    type: VerticalAlignment
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: Unsafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
  - name: ChatWindowConfiguration.WidthScale
    summary: |
      Factor by which the width of the default chat window should be scaled.
    description: |
      Factor by which the width of the default chat window should be scaled.
      Must be a value between `0.5` and `2`. Defining a value outside of range
      clamps the actual value to the closest bound.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Behavior
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Chat
methods:
  - name: ChatWindowConfiguration:DeriveNewMessageProperties
    summary: |
      Creates a new `Class.ChatWindowMessageProperties` instance that can be
      used to customize the appearance of messages in the chat window.
    description: |
      Creates a new `Class.ChatWindowMessageProperties` instance that can be
      used to customize the appearance of messages in the chat window.
      `Class.ChatWindowMessageProperties` inherits from
      `Class.TextChatMessageProperties`.

      This is intended to be used during custom
      `Class.TextChatService.OnChatWindowAdded` callbacks.

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

      TextChatService.OnChatWindowAdded = function(textChatMessage)
        local properties = ChatWindowConfiguration:DeriveNewMessageProperties()

        if textChatMessage.Metadata == "Important" then
          properties.TextColor3 = Color3.fromRGB(255, 0, 0)
        end

        return properties
      end
      ```
    code_samples:
      - TextChatService-User-Chat
    parameters: []
    returns:
      - type: ChatWindowMessageProperties
        summary: ''
    tags: []
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Chat
events: []
callbacks: []