`Class.TextChannelWindow` is a `Class.GuiObject` that renders in-experience
text chat messages from a linked `Class.TextChannel`. Place it under a
`Class.ScreenGui` or other `Class.LayerCollector` descendant to display chat
in a custom location and layout.

Set `Class.TextChannelWindow.Target|Target` to a `Class.TextChannel` to choose
which channel's messages the window shows. The window registers itself with
`Class.TextChatService` when added to the data model.

Accepted children: `Class.UICorner`, `Class.UIAspectRatioConstraint`,
`Class.UISizeConstraint`, and scripts (`Class.LocalScript`, `Class.Script`,
`Class.ModuleScript`); other child types are rejected.


TextChannelWindow

A reference to the `Class.TextChannel` whose messages this window renders.
When set, the window shows messages from the specified channel. Setting
this property to `nil` disconnects the window from any channel so it
displays no messages.

The default value is `nil` (no channel linked).


TextChannelWindow.Target

`Class.GuiObject` 是一个抽象类（类似于 `Class.BasePart`），用于 2D
用户界面对象。它定义了与图形用户界面（GUI）对象的显示相关的所有属性，例如 `Class.GuiObject.Size|Size`
和 `Class.GuiObject.Position|Position`。它还具有一些有用的只读属性，如 `Class.GuiObject.AbsolutePosition|AbsolutePosition`，
`Class.GuiObject.AbsoluteSize|AbsoluteSize` 和 `Class.GuiObject.AbsoluteRotation|AbsoluteRotation`。

要以特殊方式操作 GUI 对象的布局，可以使用布局结构，例如 [list/flex](/ui/list-flex-layouts) 或
[grid](/ui/grid-table-layouts)，并且可以通过 [appearance modifiers](/ui/appearance-modifiers) 超出其核心属性进行样式设置。

虽然可以使用 `Class.GuiObject.InputBegan|InputBegan` 和 `Class.GuiObject.InputEnded|InputEnded` 检测任何 GUI 对象上的鼠标按钮事件，
但只有 `Class.ImageButton` 和 `Class.TextButton` 具有方便的专用事件，例如 `Class.TextButton.Activated|Activated` 来检测点击/按压。


以下示例假设它在一个 GuiObject 中，例如 `TextButton`，并且
`Class.GuiObject.Draggable` 属性设置为 true。它将打印
玩家开始拖动对象时的 UDim2。


当玩家开始拖动对象时触发。

另请参见 `Class.GuiObject.DragStopped`。


GuiObject.DragBegin

initialPosition

在任何拖动操作开始之前，`Class.GuiObject` 的位置的 `Datatype.UDim2` 值。


下面的示例假设它在一个 GuiObject 中，例如 `TextButton`，并且
`Class.GuiObject.Draggable` 属性设置为 true。它将打印
玩家停止拖动 GUI 时的 X 和 Y 坐标。例如，如果玩家
在 189, 180 停止拖动对象，下面将打印 玩家在 (189, 180) 停止拖动 GuiObject


当玩家停止拖动对象时触发。

另请参见 `Class.GuiObject.DragBegin`。


GuiObject.DragStopped

鼠标的 **X** 屏幕位置（以像素为单位），相对于屏幕的左上角。


鼠标的 **Y** 屏幕位置（以像素为单位），相对于屏幕的左上角。


以下示例演示了处理用户输入的多种用法示例，
根据其类型从 InputBegan 事件中获取输入。

为了使其按预期工作，它必须放置在 `LocalScript` 中，
并且是 _gui_ 的子对象。


当用户通过人机界面设备（鼠标按钮按下，触摸开始，键盘按钮按下等）开始与 `Class.GuiObject` 交互时触发。

`Class.UserInputService` 有一个类似名称的事件，不限于特定 UI 元素：`Class.UserInputService.InputBegan`。

此事件无论游戏状态如何始终会触发。

另请参见 `Class.GuiObject.InputEnded` 和 `Class.GuiObject.InputChanged`。


GuiObject.InputBegan

input

一个 `Class.InputObject`，包含用于查询用户输入的有用数据，例如 `Enum.UserInputType|输入类型`，
`Enum.UserInputState|输入状态` 和 `Class.InputObject.Position|输入的屏幕坐标`。


当用户通过人机界面设备开始交互时触发（鼠标按钮按下，触摸开始，键盘按钮按下等）。


以下示例演示了处理用户输入的多种用法示例，
根据其类型从 InputChanged 进行处理。

为了使其按预期工作，它必须放置在 `LocalScript` 中，
并且是 _gui_ 的子项。


当用户通过人机界面设备（鼠标按钮按下，触摸开始，键盘按钮按下等）更改交互方式时触发。

`Class.UserInputService` 有一个类似名称的事件，不限于特定 UI 元素：
`Class.UserInputService.InputChanged`。

此事件无论游戏状态如何始终会触发。

另请参见 `Class.GuiObject.InputBegan` 和 `Class.GuiObject.InputEnded`。


GuiObject.InputChanged

当用户通过人机界面设备（鼠标按钮按下，触摸开始，键盘按钮按下等）更改交互方式时触发。


以下示例演示了处理用户输入的多种用法示例，
根据其类型从 InputEnded 事件中获取输入。

为了使其按预期工作，它必须放置在 `LocalScript` 中，
并且是 _gui_ 的子对象。


当用户停止通过人机界面设备（鼠标按钮按下，触摸开始，键盘按钮按下等）交互时触发。

`Class.UserInputService` 有一个类似名称的事件，不限于特定 UI 元素：`Class.UserInputService.InputEnded`。

此事件无论游戏状态如何始终会触发。

另请参见 `Class.GuiObject.InputBegan` 和 `Class.GuiObject.InputChanged`。


GuiObject.InputEnded

一个 `Class.InputObject`，包含用于查询用户输入的有用数据，例如 `Enum.UserInputType`，`Enum.UserInputState` 和 `Class.InputObject.Position`。


当用户停止通过人机界面设备交互时触发（鼠标按钮按下，触摸开始，键盘按钮按下等）。


以下示例在鼠标进入 GUI 元素时打印鼠标位置（以像素为单位）。


当用户将鼠标移动到 `Class.GuiObject` 元素中时触发。

请不要依赖此事件传递的 `x` 和 `y` 参数作为确定用户鼠标进入 GUI 时位置的万无一失的方法。这些坐标可能会有所不同，即使鼠标通过同一边缘进入 GUI，尤其是当鼠标快速进入元素时。这是因为坐标指示事件触发时鼠标的位置，而不是鼠标进入 GUI 的确切时刻。

即使 GUI 元素在另一个元素下方渲染，此事件也会触发。

如果您想跟踪用户的鼠标何时离开 GUI 元素，可以使用 `Class.GuiObject.MouseLeave` 事件。

##### 另请参见

- `Class.GuiObject.MouseLeave`
- `Class.GuiObject.MouseMoved`
- `Class.GuiObject.MouseWheelForward`
- `Class.GuiObject.MouseWheelBackward`


GuiObject.MouseEnter

鼠标的 **X** 屏幕坐标（以像素为单位），相对于屏幕的左上角。


鼠标的 **Y** 屏幕坐标（以像素为单位），相对于屏幕的左上角。


当用户将鼠标移动到 GUI 元素中时触发。


当用户将鼠标移出 `Class.GuiObject` 元素时触发。

请不要依赖此事件传递的 `x` 和 `y` 参数作为确定用户鼠标离开 GUI 时位置的万无一失的方法。这些坐标可能会有所不同，即使鼠标通过同一边缘离开 GUI，尤其是当鼠标快速离开元素时。这是因为坐标指示事件触发时鼠标的位置，而不是鼠标离开 GUI 的确切时刻。

即使 GUI 元素在另一个元素下方渲染，此事件也会触发。

##### 另请参见

- `Class.GuiObject.MouseEnter`
- `Class.GuiObject.MouseMoved`
- `Class.GuiObject.MouseWheelForward`
- `Class.GuiObject.MouseWheelBackward`


GuiObject.MouseLeave

当用户将鼠标移出 GUI 元素时触发。


每当用户在 `Class.GuiObject` 元素内移动鼠标时触发。它类似于 `Class.Mouse.Move`，无论用户的鼠标是否在 GUI 元素上方都会触发。

请注意，此事件在鼠标位置更新时触发，因此在移动时会重复触发。

`x` 和 `y` 参数指示用户鼠标的更新屏幕坐标（以像素为单位）。这些可以用于确定鼠标在 GUI、屏幕上的位置，以及自上次位置以来的增量。

以下代码演示了如何确定用户鼠标相对于 GUI 元素的 `Datatype.Vector2` 偏移：

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

local CustomScrollingFrame = script.Parent
local SubFrame = CustomScrollingFrame:FindFirstChild("SubFrame")

local mouse = Players.LocalPlayer:GetMouse()

local function getPosition(X, Y)
	local gui_X = CustomScrollingFrame.AbsolutePosition.X
	local gui_Y = CustomScrollingFrame.AbsolutePosition.Y


	local pos = Vector2.new(math.abs(X - gui_X), math.abs(Y - gui_Y - 36))
	print(pos)
end

CustomScrollingFrame.MouseMoved:Connect(getPosition)
```
请注意，此事件可能不会在用户鼠标进入或离开 GUI 元素时准确触发。因此，`x` 和 `y` 参数可能与 GUI 边缘的坐标不完全匹配。

##### 另请参见

- `Class.GuiObject.MouseEnter`
- `Class.GuiObject.MouseLeave`
- `Class.GuiObject.MouseWheelForward`
- `Class.GuiObject.MouseWheelBackward`


GuiObject.MouseMoved

每当用户在 GUI 元素内移动鼠标时触发。


当用户在 `Class.GuiObject` 元素上向后滚动鼠标滚轮时触发。它类似于 `Class.Mouse.WheelBackward`，无论用户的鼠标是否在 GUI 元素上方都会触发。

此事件仅作为滚轮向后移动的指示。这意味着 `x` 和 `y` 鼠标坐标参数不会因此事件而改变。这些坐标仅在鼠标移动时更改，可以通过 `Class.GuiObject.MouseMoved` 事件进行跟踪。

##### 另请参见

- `Class.GuiObject.MouseEnter`
- `Class.GuiObject.MouseLeave`
- `Class.GuiObject.MouseMoved`
- `Class.GuiObject.MouseWheelForward`


GuiObject.MouseWheelBackward

当用户在 GUI 元素上向后滚动鼠标滚轮时触发。


当用户在 `Class.GuiObject` 元素上向前滚动鼠标滚轮时触发。它类似于 `Class.Mouse.WheelForward`，无论用户的鼠标是否在 GUI 元素上方都会触发。

此事件仅作为滚轮向前移动的指示。这意味着 **X** 和 **Y** 鼠标坐标参数不会因此事件而改变。这些坐标仅在鼠标移动时更改，可以通过 `Class.GuiObject.MouseMoved` 事件进行跟踪。

##### 另请参见

- `Class.GuiObject.MouseEnter`
- `Class.GuiObject.MouseLeave`
- `Class.GuiObject.MouseMoved`
- `Class.GuiObject.MouseWheelBackward`


GuiObject.MouseWheelForward

当用户在 GUI 元素上向前滚动鼠标滚轮时触发。


以下示例在用户使用游戏手柄选择对象时打印一条消息。

为了使其按预期工作，它必须放置在 `LocalScript` 中，并且是 _gui_ 的子对象。


当游戏手柄选择器开始聚焦于 `Class.GuiObject` 时触发。

如果您想检查游戏手柄选择停止聚焦于 GUI 元素，可以使用 `Class.GuiObject.SelectionLost` 事件。

当 GUI 获得选择焦点时，`Class.GuiService.SelectedObject|SelectedObject` 属性的值也会更改为获得选择的对象。要确定哪个 GUI 获得了选择，请检查此属性的值。


GuiObject.SelectionGained

当 GuiObject 被游戏手柄选择器聚焦时触发。


以下示例在元素失去焦点时打印一条消息，
在游戏手柄上。

为了使其按预期工作，它必须放置在 `LocalScript` 中，
并且是 _gui_ 的子项。


当游戏手柄选择器停止聚焦于 `Class.GuiObject` 时触发。

如果您想检查游戏手柄选择开始聚焦于 GUI 元素，可以使用 `Class.GuiObject.SelectionGained` 事件。

当 GUI 失去选择焦点时，`Class.GuiService.SelectionObject|SelectionObject` 属性的值会更改为 `nil` 或获得选择焦点的 GUI 元素。要确定哪个 GUI 获得了选择，或者如果没有 GUI 被选中，请检查此属性的值。


GuiObject.SelectionLost

当游戏手柄选择器停止聚焦于 GuiObject 时触发。


此代码示例允许玩家通过短暂按住 UI 元素（如 `Frame`）来操控某些 UI 元素的屏幕位置。然后，玩家移动手指并释放。在手势期间，Frame 的颜色为蓝色，边框为白色。


当玩家使用触摸设备在 UI 元素上按住手指时，此事件在短暂的时刻后触发。它会触发一个描述参与手势的手指相对屏幕位置的 `Datatype.Vector2` 表。并且，它会多次触发：在短暂延迟后触发 `Enum.UserInputState.Begin`，
如果玩家在手势期间移动手指，则触发 `Enum.UserInputState.Change`，最后在他们释放手指时触发 `Enum.UserInputState.End`。延迟与平台相关；在 Studio 中，它略长于一秒。


GuiObject.TouchLongPress

touchPositions

一个 `Datatype.Vector2` 数组，描述参与手势的手指的 **相对** 位置。


state

一个 `Enum.UserInputState`，描述手势的状态：

- Begin 在手势开始时触发一次（在短暂延迟后）
- Change 如果玩家在按下时移动手指，则触发
- End 在手势结束时触发一次，当他们释放手指时。


当玩家开始、继续和停止长按 UI 元素时触发。


此代码示例旨在放置在一个 `LocalScript` 中，该脚本位于一个内部 `Frame` 中，而该内部 `Frame` 又位于一个外部 `Frame` 或其他 `GuiObject` 中。它允许玩家通过在外部框架上移动手指来操控内部框架的位置。


当玩家使用触摸设备在 UI 元素上移动手指时触发。它在 `Class.GuiObject.TouchSwipe` 之前短暂触发，并且不会与 `Class.GuiObject.TouchTap` 一起触发。此事件对于允许玩家操纵屏幕上 UI 元素的位置非常有用。

此事件会触发一个描述参与手势的手指相对屏幕位置的 `Datatype.Vector2` 表。并且，它会多次触发：在短暂延迟后触发 `Enum.UserInputState.Begin`，在手势期间玩家移动手指时触发 `Enum.UserInputState.Change`，最后在 `Enum.UserInputState.End` 时触发。


GuiObject.TouchPan

一个 Luau 数组，包含 `Datatype.Vector2` 对象，每个对象指示参与手势的所有手指的位置。


totalTranslation

指示平移手势从起始点移动的距离。


velocity

指示手势在每个维度上执行的速度。


指示手势的 `Enum.UserInputState`。


当玩家在 UI 元素上移动手指时触发。


此代码示例适用于一个位于外部 `Frame` 内部的 `LocalScript`，或其他 `GuiObject`。它允许玩家通过在外部框架上执行 `Class.GuiObject.TouchPinch` 手势来缩放内部框架。


当玩家使用两个手指在 UI 元素上执行捏合或拉动手势时触发。**捏合**发生在两个或更多手指靠近时，**拉动**发生在它们分开时。此事件与 `Class.GuiObject.TouchPan` 一起触发。此事件对于允许玩家操纵屏幕上 UI 元素的缩放（大小）非常有用，通常用于缩放功能。

此事件会触发一个描述参与手势的手指相对屏幕位置的 `Datatype.Vector2` 表。并且，它会多次触发：在短暂延迟后触发 `Enum.UserInputState.Begin`，在玩家在手势期间移动手指时触发 `Enum.UserInputState.Change`，最后在 `Enum.UserInputState.End` 时触发。应注意，缩放应 **乘法** 使用。


GuiObject.TouchPinch

一个 Luau 数组，包含 `Datatype.Vector2` 对象，每个对象指示参与捏合手势的所有手指的位置。


scale

一个浮点数，指示与捏合手势开始时的差异。


一个浮点数，指示捏合手势发生的速度。


当玩家使用两个手指在 UI 元素上执行捏合或拉动手势时触发。


此代码示例适用于一个位于外部 `Frame` 内部的 `LocalScript`，或其他 `GuiObject`。它允许玩家通过在外部框架上执行 `Class.GuiObject.TouchRotate` 手势来旋转内部框架。


当玩家使用两个手指在触摸设备上对 UI 元素进行捏合或拉动手势时，此事件触发。当两个手指之间的线的角度发生变化时，旋转发生。此事件与 `Class.GuiObject.TouchPan` 一起触发。此事件对于允许玩家操控屏幕上 UI 元素的旋转非常有用。

此事件触发时会带有一个 `Datatype.Vector2` 的表，描述参与手势的手指的相对屏幕位置。此外，它会多次触发：在短暂延迟后触发 `Enum.UserInputState.Begin`，在玩家在手势中移动手指时触发 `Enum.UserInputState.Change`，最后触发 `Enum.UserInputState.End`。

GuiObject.TouchRotate

一个 Luau 数组，包含 `Datatype.Vector2` 对象，每个对象表示参与手势的所有手指的位置。

rotation

一个浮点数，表示旋转从手势开始时的变化量。

一个浮点数，表示手势执行的速度。

当玩家在 UI 元素上使用两个手指执行旋转手势时触发。

此代码示例将在触摸设备（或Studio的模拟器）上执行滑动手势时使`Frame`（或其他`GuiObject`）弹跳。
水平滑动将改变`Class.GuiObject.BackgroundColor3`的色调，而垂直滑动将改变饱和度。


当玩家在触摸设备上对 UI 元素执行滑动手势时，此事件触发。它会带有手势的方向（上、下、左或右）和参与手势的触点数量。滑动手势通常用于在移动 UI 中切换标签。

GuiObject.TouchSwipe

swipeDirection

一个 `Enum.SwipeDirection`，表示滑动手势的方向（上、下、左或右）。

numberOfTouches

参与手势的触点数量（通常为 1）。

当玩家在 UI 元素上执行滑动手势时触发。

此代码示例将在触摸设备上点击时切换 UI 元素（如 `Frame`）的 `Class.GuiObject.BackgroundTransparency`。

当玩家在触摸设备上对 UI 元素执行点击手势时，此事件触发。点击是一个快速的单次触摸，没有任何移动（较长的按压会触发 `Class.GuiObject.TouchLongPress`，而在触摸期间移动会触发 `Class.GuiObject.TouchPan` 和/或 `Class.GuiObject.TouchSwipe`）。它会带有一个 `Datatype.Vector2` 对象的表，描述参与手势的手指的相对位置。

GuiObject.TouchTap

一个 `Datatype.Vector2` 数组，描述参与手势的手指的 **相对** 位置。

当玩家在 UI 元素上执行点击手势时触发。

此代码示例演示了通过定义回调函数来检测平滑过渡何时完成/取消，从而更复杂地使用 TweenPosition。它还打印平滑过渡是否会播放。


平滑地将 GUI 移动到指定时间内的新 `Datatype.UDim2` 位置，使用指定的 `Enum.EasingDirection` 和 `Enum.EasingStyle`。

此函数将返回 tween 是否会播放。如果另一个 tween 正在作用于 `Class.GuiObject` 且覆盖参数为 `false`，则不会播放。

另请参见 `Class.GuiObject:TweenSize()` 和 `Class.GuiObject:TweenSizeAndPosition()`。


GuiObject:TweenPosition

endPosition

easingDirection

将 GUI 缓和到 _endPosition_ 的方向。


easingStyle

将 GUI 缓和到 _endPosition_ 的样式。


time

缓和完成所需的时间（以秒为单位）。


override

缓和是否会覆盖正在进行的缓和。


callback

缓和完成时要执行的回调函数。


平滑地将 GUI 移动到新的 `Datatype.UDim2`。


此代码示例演示了 `Class.GuiObject:TweenSize()`
函数的用法。它在父对象的 `Class.GuiObject.Size`
属性上启动动画，目标为 `UDim2.new(0.5, 0, 0.5, 0)`，这表示在两个轴上都是 `GuiObject` 的一半
父对象大小。

此外，它演示了如何使用回调参数来检测
当补间动画停止时（无论是被另一个补间动画取消还是完成）。


平滑地将 `Class.GuiObject` 调整大小到新的 `Datatype.UDim2`，在指定时间内使用指定的 `Enum.EasingDirection` 和 `Enum.EasingStyle`。

此函数将返回缓和是否会播放。通常这将始终返回 `true`，但如果另一个缓和处于活动状态且覆盖设置为 `false`，则将返回 `false`。

另请参见 `Class.GuiObject:TweenSize()` 和 `Class.GuiObject:TweenSizeAndPosition()`。


GuiObject:TweenSize

endSize

将 GUI 缓和到 _endSize_ 的方向。


将 GUI 缓和到 _endSize_ 的样式。


平滑地将 `Class.GuiObject` 调整大小到新的 `Datatype.UDim2`。


下面的示例将一个 `Class.Frame` 动画调整到父级的左上角
并将其大小调整为 0。


平滑地调整大小并将 GUI 移动到新的 `Datatype.UDim2` 大小和位置，在指定时间内使用指定的 `Enum.EasingDirection` 和 `Enum.EasingStyle`。

此函数将返回缓和是否会播放。通常这将始终返回 `true`，但如果另一个缓和处于活动状态且覆盖设置为 `false`，则将返回 `false`。

另请参见 `Class.GuiObject:TweenSize()` 和 `Class.GuiObject:TweenSizeAndPosition()`。


GuiObject:TweenSizeAndPosition

将 GUI 缓和到 _endSize_ 和 _endPosition_ 的方向。


将 GUI 缓和到 _endSize_ 和 _endPosition_ 的样式。


平滑地将 GUI 移动到新的大小和位置。


GuiObject

此代码示例演示了 Active 属性作为 Activated 事件的去抖动的用法。

此属性确定 `Class.GuiObject` 是否会将输入传递到 3D 空间，例如具有 `Class.ClickDetector` 类的底层模型，如 `Class.DragDetector`。

对于 `Class.GuiButton` 对象（`Class.ImageButton` 和 `Class.TextButton`），此属性确定 `Class.GuiButton.Activated|Activated` 是否会触发
（`Class.GuiButton.AutoButtonColor|AutoButtonColor` 对于这些对象仍然有效）。事件 `Class.GuiObject.InputBegan|InputBegan`，
`Class.GuiObject.InputChanged|InputChanged` 和 `Class.GuiObject.InputEnded|InputEnded` 无论此属性的值如何都正常工作。


GuiObject.Active

确定此 UI 元素是否接收输入。


此代码示例将 UI 元素移动到父元素的不同侧面。
它从左上角开始，结束于右下角。将其粘贴到
ScreenGui 中的 Frame 的 LocalScript 中。


此属性确定 `Class.GuiObject` 的原点，相对于其绝对大小。原点确定元素的位置（通过 `Class.GuiObject.Position`）以及渲染的 `Class.GuiObject.Size` 从何处扩展。

有关插图和详细信息，请参见 [这里](/ui/position-and-size#anchorpoint)。


GuiObject.AnchorPoint

确定 `Class.GuiObject` 的原点，相对于其绝对大小。


以下脚本创建一个自动调整大小的父框架，带有`UIListLayout`，然后插入几个自动调整大小的`TextLabel`对象。注意父`UIListLayout`如何自动调整大小以适应其子内容，以及标签如何自动调整大小以适应其文本内容。此脚本可以作为`ScreenGui`的子对象。

此属性用于根据其后代的大小自动调整父 UI 对象的大小。您可以使用此属性在编辑或运行时动态添加文本和其他内容到 UI 对象，大小将调整以适应该内容。

当 `Class.GuiObject.AutomaticSize|AutomaticSize` 设置为 `Enum.AutomaticSize` 的值时，除了 `Enum.AutomaticSize|None`，此 UI 对象可能会根据其子内容调整大小。

有关如何使用此属性及其工作原理的更多信息，请参见 [这里](/ui/size-modifiers#automatic-sizing)。


GuiObject.AutomaticSize

确定是否根据子内容进行调整大小。


确定 `Class.GuiObject` 背景的颜色。


GuiObject.BackgroundColor

此代码示例使父框架循环遍历所有颜色的
彩虹，使用 Color3.fromHSV。


此属性确定 `Class.GuiObject` 背景的颜色（填充颜色）。如果您的元素包含文本，例如 `Class.TextBox`，
`Class.TextButton` 或 `Class.TextLabel`，请确保背景的颜色与文本的颜色形成对比。

另一个确定背景视觉属性的属性是 `Class.GuiObject.BackgroundTransparency`；如果设置为 `1`，则背景和边框都不会渲染。

另请参见 `Class.GuiObject.BorderColor3|BorderColor3`。


GuiObject.BackgroundColor3

确定 `Class.GuiObject` 背景颜色。


此属性确定 `Class.GuiObject` 背景和边框的透明度。然而，它不确定文本的透明度，如果 GUI 是 `Class.TextBox`，
`Class.TextButton` 或 `Class.TextLabel`；文本透明度由 `Class.TextBox.TextTransparency`，`Class.TextButton.TextTransparency` 和 `Class.TextLabel.TextTransparency` 分别确定。

如果此属性设置为 `1`，则背景和边框都不会渲染，GUI 背景将完全透明。


GuiObject.BackgroundTransparency

确定 `Class.GuiObject` 背景和边框的透明度。


确定 `Class.GuiObject` 边框的颜色。


GuiObject.BorderColor

此代码示例使父级 GuiObject 的边框在用户将鼠标悬停在元素上时高亮。

确定 `Class.GuiObject` 矩形边框的颜色（也称为描边颜色）。这与对象的 `Class.GuiObject.BackgroundColor3` 是分开的。如果其 `Class.GuiObject.BorderSizePixel` 属性设置为 `0`，则无法看到对象的边框。

请注意，`Class.UIStroke` 组件允许更高级的边框效果。


GuiObject.BorderColor3

此属性确定 `Class.GuiObject` 边框相对于其尺寸的布局方式，使用同名的枚举 `Enum.BorderMode`。

请注意，`Class.UIStroke` 可以覆盖此属性并允许更高级的边框效果。


GuiObject.BorderMode

确定 `Class.GuiObject` 边框相对于其尺寸的布局方式。


此属性确定 `Class.GuiObject` 边框的宽度，以像素为单位。将其设置为 0 会完全禁用边框。

请注意，`Class.UIStroke` 可以覆盖此属性并允许更高级的边框效果。


GuiObject.BorderSizePixel

确定 `Class.GuiObject` 边框的像素宽度。


此属性确定 `Class.GuiObject` 是否会剪裁（使不可见）任何后代 GUI 元素的部分，否则这些部分会在矩形边界外渲染。

#### 旋转行为

当 `Class.StarterGui.ClipsDescendantsSupportsRotation` 启用时，剪裁对于旋转的形状工作正常。然而，旋转形状（当剪裁父本身旋转时）或圆角（`Class.UICorner`）的剪裁不受支持。

当 `Class.StarterGui.ClipsDescendantsSupportsRotation` **未** 启用，并且此 `Class.GuiObject` 或任何祖先 `Class.GuiObject` 具有 **非零** `Class.GuiObject.Rotation|Rotation`，此属性将被 **忽略**，后代 GUI 元素将无论此属性的值如何都渲染。


GuiObject.ClipsDescendants

确定超出父 GUI 元素边界的后代 `Class.GuiObject|GuiObjects` 是否应渲染。


这表示 `Class.GuiObject`（及其后代）是否可以在屏幕上拖动。


GuiObject.Draggable

确定 `Class.GuiObject`（及其后代）是否可以在屏幕上拖动。


当玩家的手指在 `Class.GuiObject` 上被点击并保持时，`Class.GuiObject.GuiState|GuiState` 将被设置为 `Enum.GuiState.Press|Press`。类似地，当玩家的手指从 `Class.GuiObject` 上释放时，`Class.GuiObject.GuiState|GuiState` 将被设置为 `Enum.GuiState.Idle|Idle`，而当 `Class.GuiObject.Interactable|Interactable` 在 `Class.GuiObject` 上关闭时，`Class.GuiState` 将被设置为 `Enum.GuiState.NonInteractable|NonInteractable`。


GuiObject.GuiState

确定玩家的鼠标是否正在 `Class.GuiObject` 上被按下。


GuiObject.InputSink

确定 `Class.GuiButton` 是否可以与之交互，或者 `Class.GuiObject` 的 `Enum.GuiState|GuiState` 是否正在变化。

在 `Class.GuiButton` 上：

- 当 `Class.GuiObject.Interactable|Interactable` 设置为 `false` 时，`Class.GuiButton` 将不再能够被按下或点击，且 `Class.GuiObject.GuiState|GuiState` 将始终设置为 `Enum.GuiState.NonInteractable|NonInteractable`。
- 当 `Class.GuiObject.Interactable|Interactable` 设置为 `true` 时，`Class.GuiButton` 将恢复正常行为，`Class.GuiObject.GuiState|GuiState` 也将恢复正常。

在 `Class.GuiObject` 上：

- 当 `Class.GuiObject.Interactable|Interactable` 设置为 `false` 时，`Class.GuiObject.GuiState|GuiState` 将始终设置为 `Enum.GuiState.NonInteractable|NonInteractable`。
- 当 `Class.GuiObject.Interactable|Interactable` 设置为 `true` 时，`Class.GuiObject.GuiState|GuiState` 将恢复正常行为。


GuiObject.Interactable

确定 `Class.GuiButton` 是否可以与之交互，或者 `Class.GuiObject` 的 `Enum.GuiState|GuiState` 是否正在变化。


此属性控制 `Class.GuiObject` 在使用 `Class.UIGridStyleLayout`（例如 `Class.UIListLayout` 或 `Class.UIPageLayout`）时的排序顺序，
`Class.UIGridStyleLayout.SortOrder|SortOrder` 设置为 `Enum.SortOrder.LayoutOrder`。如果对象没有兄弟 UI 布局结构，则此属性没有功能。

`Class.GuiObject|GuiObjects` 按升序排序，较低的值优先于较高的值。具有相同值的对象将回退到它们被添加的顺序。

如果您不确定将来是否需要在两个现有元素之间添加元素，使用 `100` 的倍数（`0`，`100`，`200` 等）是一个好习惯。这确保了布局顺序值之间有一个大的间隙，您可以在其他元素之间使用这些值。

另请参见 `Class.GuiObject.ZIndex|ZIndex`，它确定对象的 **渲染** 顺序，而不是排序顺序。


GuiObject.LayoutOrder

控制 `Class.GuiObject` 在与 `Class.UIGridStyleLayout` 一起使用时的排序顺序。


此示例演示如何通过一个网格中的 `GuiObject|GUI` 元素启用手柄导航，而无需手动连接每个元素的 `Class.GuiObject.NextSelectionUp`、`Class.GuiObject.NextSelectionDown`、`GuiObject|NextSelectionRight` 和 `Class.GuiObject.NextSelectionLeft` 属性。

请注意，此代码示例假设您的 `UIGridLayout` 是按 `Class.UIGridLayout.SortOrder|name` 排序的，其中元素按连续的数字顺序命名。

代码依赖于此来为与 UIGridLayout 在同一层级的所有 `GuiObjects` 设置 NextSelection 属性。在我们的示例中，UIGridLayoutObject 和网格中的 GUI 元素都是名为 _"Container"_ 的 `Frame` 的子对象。代码 `Class.Instance:GetChildren()|获取子对象` _"Container"_ 的子对象并循环遍历每个子对象。不是 GuiObjects 的子对象会被忽略。对于每个 GUI 元素，代码尝试使用以下逻辑分配 NextSelection 属性：

1. 从 1 开始，所有 GUI 元素的名称与它们在网格中的位置匹配
2. 左：左侧的项目编号始终比当前元素少 1
3. 右：右侧的项目编号始终比当前元素多 1
4. 上：上方的项目编号始终是当前元素所在行的 GUI 数量减 1
5. 下：下方的项目编号始终是当前元素所在行的 GUI 数量加 1 此逻辑还允许行首和行尾的 GUI 元素（不包括第一个和最后一个元素）环绕到下一行和上一行。如果左、右、上或下没有元素，NextSelection 将保持为 nil，手柄选择器在该方向上移动将不会改变所选的 GUI。

此示例还包含代码，以便使用键盘的箭头键（上、下、左、右）测试网格，以防您没有手柄进行测试。此部分代码最初通过将其分配给 `Class.GuiService.SelectedObject` 属性来选择名为 _"1"_ 的元素。


此属性设置在用户向下移动 [游戏手柄](/input/gamepad) 选择器时所选的 `Class.GuiObject`。如果此属性为空，向下移动游戏手柄将不会更改所选的 GUI。

向下移动游戏手柄选择器将 `Class.GuiService.SelectedObject` 设置为此对象，除非 GUI 不是 `Class.GuiObject.Selectable|Selectable`。请注意，即使此属性未设置为 `Class.GuiObject.Selectable|Selectable`，也可以将其设置为 GUI 元素，因此您应该确保 GUI 的可选择属性值与您的预期行为匹配。

另请参见 `Class.GuiObject.NextSelectionUp|NextSelectionUp`，`Class.GuiObject.NextSelectionLeft|NextSelectionLeft` 和 `Class.GuiObject.NextSelectionRight|NextSelectionRight`。


GuiObject.NextSelectionDown

设置在游戏手柄选择器向下移动时将被选中的 `Class.GuiObject`。


此属性设置在用户向左移动 [游戏手柄](/input/gamepad) 选择器时所选的 `Class.GuiObject`。如果此属性为空，向左移动游戏手柄将不会更改所选的 GUI。

向左移动游戏手柄选择器将 `Class.GuiService.SelectedObject` 设置为此对象，除非 GUI 不是 `Class.GuiObject.Selectable|Selectable`。请注意，即使此属性未设置为 `Class.GuiObject.Selectable|Selectable`，也可以将其设置为 GUI 元素，因此您应该确保 GUI 的可选择属性值与您的预期行为匹配。

另请参见 `Class.GuiObject.NextSelectionUp|NextSelectionUp`，`Class.GuiObject.NextSelectionDown|NextSelectionDown` 和 `Class.GuiObject.NextSelectionRight|NextSelectionRight`。


GuiObject.NextSelectionLeft

设置在游戏手柄选择器向左移动时将被选中的 `Class.GuiObject`。


此属性设置在用户向右移动 [游戏手柄](/input/gamepad) 选择器时所选的 `Class.GuiObject`。如果此属性为空，向右移动游戏手柄将不会更改所选的 GUI。

向右移动游戏手柄选择器将 `Class.GuiService.SelectedObject` 设置为此对象，除非 GUI 不是 `Class.GuiObject.Selectable|Selectable`。请注意，即使此属性未设置为 `Class.GuiObject.Selectable|Selectable`，也可以将其设置为 GUI 元素，因此您应该确保 GUI 的可选择属性值与您的预期行为匹配。

另请参见 `Class.GuiObject.NextSelectionUp|NextSelectionUp`，`Class.GuiObject.NextSelectionDown|NextSelectionDown` 和 `Class.GuiObject.NextSelectionLeft|NextSelectionLeft`。


GuiObject.NextSelectionRight

设置在游戏手柄选择器向右移动时将被选中的 `Class.GuiObject`。


此属性设置在用户向上移动 [游戏手柄](/input/gamepad) 选择器时所选的 `Class.GuiObject`。如果此属性为空，向上移动游戏手柄将不会更改所选的 GUI。

向上移动游戏手柄选择器将 `Class.GuiService.SelectedObject` 设置为此对象，除非 GUI 不是 `Class.GuiObject.Selectable|Selectable`。请注意，即使此属性未设置为 `Class.GuiObject.Selectable|Selectable`，也可以将其设置为 GUI 元素，因此您应该确保 GUI 的可选择属性值与您的预期行为匹配。

另请参见 `Class.GuiObject.NextSelectionDown|NextSelectionDown`，`Class.GuiObject.NextSelectionLeft|NextSelectionLeft` 和 `Class.GuiObject.NextSelectionRight|NextSelectionRight`。


GuiObject.NextSelectionUp

设置在游戏手柄选择器向上移动时将被选中的 `Class.GuiObject`。


此属性使用 `Datatype.UDim2` 确定 `Class.GuiObject` 的像素和标量位置。位置围绕对象的 `Class.GuiObject.AnchorPoint` 进行居中。

标量位置相对于父 GUI 元素的大小（如果有）。

`Datatype.UDim2` 值的像素部分与父 GUI 的大小无关。值表示对象在像素中的位置。对象的实际像素位置可以从 `Class.GuiBase2d.AbsolutePosition` 属性中读取。


GuiObject.Position

确定 `Class.GuiObject` 的像素和标量位置。


此属性确定 `Class.GuiObject` 旋转的度数。旋转相对于对象的 **中心**，**而不是** `Class.GuiObject.AnchorPoint|AnchorPoint`，这意味着您无法更改旋转点。此外，此属性与 `Class.GuiObject.ClipsDescendants|ClipsDescendants` 不兼容。


GuiObject.Rotation

确定 `Class.GuiObject` 旋转的度数。


下面的示例提供了一个简单的演示，展示如何使用
`Class.GuiObject.Selectable` 属性来限制 GUI 元素何时可以被
游戏手柄导航器选择。

当 `TextBox` 获得焦点时，它可以被选择。然而，当 TextBox
失去焦点时，它将无法再被选择。

虽然这是一个简单的演示，但该属性也可以用于
防止导航器选择那些存在于外观而非功能目的的 UI 元素。例如，菜单
屏幕上的按钮应该是可选择的，但标题图像则不应该。

此属性确定在使用游戏手柄导航 GUI 时，`Class.GuiObject` 是否可以被选择。

如果此属性为 `true`，则可以选择 GUI。选择 GUI 还会将 `Class.GuiService.SelectedObject` 属性设置为该对象。

当此属性为 `false` 时，GUI 不能被选择。然而，当 GUI 被选择时将其设置为 `false` 不会取消选择它，也不会更改 `Class.GuiService.SelectedObject` 属性的值。

添加 `Class.GuiObject.SelectionGained` 和 `Class.GuiObject.SelectionLost` 将不会触发该元素。要取消选择 GuiObject，您必须更改 `Class.GuiService.SelectedObject` 属性。

如果 GUI 通过此类属性连接到多个 GUI，例如 `Class.GuiObject.NextSelectionUp`，
`Class.GuiObject.NextSelectionDown`，`Class.GuiObject|NextSelectionRight`，或 `Class.GuiObject|NextSelectionLeft`，此属性非常有用。与其更改所有属性以使游戏手柄无法选择 GUI，不如禁用其可选择属性以暂时防止其被选择。然后，当您希望游戏手柄选择器能够选择 GUI 时，只需重新启用其可选择属性。


GuiObject.Selectable

确定 `Class.GuiObject` 是否可以被游戏手柄选择。


所有 2D 用户界面对象的抽象类。


/reference/engine/classes/TextChannelWindow.yaml