`InputActionLabel` 是一個拖放的 `Class.GuiObject`，自動
顯示根據玩家當前輸入設備（鍵盤/滑鼠、遊戲手柄、觸控、VR）
的 `Class.InputAction` 的適當鍵或圖標。當玩家切換設備或
綁定被重新綁定時，標籤會立即更新，無需編寫腳本。

`InputActionLabel` 的渲染取決於 `Class.InputAction`（通過
`Class.InputActionLabel.InputAction` 連結）和該動作的子
`Class.InputBinding|InputBindings`。當標籤解析要顯示的內容時，
它遵循以下順序：

1. **自定義圖像** — 如果子 `Class.InputBinding|InputBindings` 的
   `Class.InputBinding.DisplayImage|DisplayImage` 屬性被設置，
   標籤會直接渲染這些圖像，並可選擇性地由
   `Class.InputActionLabel.ImageColor3|ImageColor3` 和
   `Class.InputActionLabel.ImageTransparency|ImageTransparency` 修改。

2. **平台鍵圖像** — 如果缺少自定義圖像，標籤會通過
   `Class.UserInputService:GetImageForKeyCode()` 渲染平台提供的
   子 `Class.InputBinding|InputBindings` 圖像（如果有可用的圖像）。
   組合綁定與修飾符顯示多個圖標，並用 `+` 分隔。

3. **自定義名稱** — 如果缺少可用圖像，若子
   `Class.InputBinding|InputBindings` 的 `Class.InputBinding.DisplayName|DisplayName`
   屬性被設置，標籤會以由
   `Class.InputActionLabel.FontFace|FontFace`、
   `Class.InputActionLabel.TextColor3|TextColor3`、
   `Class.InputActionLabel.TextSize|TextSize`、
   `Class.InputActionLabel.TextTransparency|TextTransparency`、
   `Class.InputActionLabel.TextWrapped|TextWrapped`、
   `Class.InputActionLabel.TextXAlignment|TextXAlignment` 和
   `Class.InputActionLabel.TextYAlignment|TextYAlignment` 定義的樣式渲染該文本。

4. **平台鍵字符串** — 如果以上所有都缺失，標籤會通過
   `Class.UserInputService:GetStringForKeyCode()` 渲染平台提供的字符串。

5. 如果沒有分配 `Class.InputAction` 或不存在子 `Class.InputBinding`，
   標籤會渲染一個佔位符圖標。


InputActionLabel

此屬性類似於 `Class.TextLabel.FontFace`，並確定在標籤以文本模式渲染時使用的字體系列、粗細和樣式。


InputActionLabel.FontFace

此屬性確定標籤圖像的上色方式。設置為白色時，不會進行上色。此屬性對於重用圖像資產非常有用；如果源圖像完全是白色且具有透明度，您可以通過此屬性一次性設置整個標籤顏色。


InputActionLabel.ImageColor3

確定渲染的標籤圖像將如何上色。


此屬性確定渲染的標籤圖像的 alpha 值。值為 `0` 時完全不透明，值為 `1` 時完全透明（不可見）。


InputActionLabel.ImageTransparency

確定渲染的標籤圖像的透明度。


要自動解析並顯示其首選綁定的 `Class.InputAction` 實例。當綁定更改（由於重新綁定或輸入設備切換）時，標籤會自動更新。

將此設置為 `nil` 會清除顯示並顯示佔位符。


InputActionLabel.InputAction

顯示此標籤的首選綁定的 `Class.InputAction`。


當標籤以圖像模式渲染時，包含第一個解析圖像的 `Datatype.Content`。當在文本或佔位符模式下時為空。這是一個由引擎在綁定解析時設置的唯讀屬性。


InputActionLabel.ResolvedImageContent

唯讀。當前顯示的解析圖像內容。


當標籤以文本模式渲染時，包含組合的鍵名字符串，例如 `Ctrl + Shift + Space`。當標籤以圖像或佔位符模式渲染時為空。這是一個由引擎在綁定解析時設置的唯讀屬性。


InputActionLabel.ResolvedText

此屬性確定標籤渲染的所有文本的顏色。


InputActionLabel.TextColor3

控制文本模式渲染的字體大小（以像素為單位）。值限制在 `1` 和 `200` 之間。


InputActionLabel.TextSize

此屬性確定標籤渲染的所有文本的透明度。


InputActionLabel.TextTransparency

當 `true` 時，文本在標籤的空間內以多行渲染，以便 `Class.InputActionLabel.TextSize|TextSize` 行不會超過對象的 `Class.GuiBase2d.AbsoluteSize`。這是通過將長文本行分成多行來實現的。


InputActionLabel.TextWrapped

確定文本是否在標籤的空間內換行。


此屬性確定在標籤的空間內渲染文本的水平對齊方式。


InputActionLabel.TextXAlignment

確定渲染文本的水平對齊方式。


此屬性確定在標籤的空間內渲染文本的垂直對齊方式。


InputActionLabel.TextYAlignment

確定渲染文本的垂直對齊方式。


一個 `Class.GuiObject`，自動顯示動作的鍵位綁定
作為文本或圖像。


`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` 值。

以下示例假設它位於 `TextButton` 等 GuiObject 中，並且
`Class.GuiObject.Draggable` 屬性設置為 true。它將打印
玩家停止拖動 GUI 的 X 和 Y。例如，如果玩家在 189, 180 停止拖動對象，則下面將打印 玩家在 (189, 180) 停止拖動 GuiObject


當玩家停止拖動物件時觸發。

另請參見 `Class.GuiObject.DragBegin`。

GuiObject.DragStopped

滑鼠的 **X** 螢幕位置（以像素為單位），相對於螢幕的左上角。

滑鼠的 **Y** 螢幕位置（以像素為單位），相對於螢幕的左上角。

以下範例展示了根據輸入類型處理用戶輸入的多種用法示例。

為了使其按預期工作，必須將其放置在 `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|輸入的螢幕坐標`。

當用戶開始通過人機介面設備互動時觸發（滑鼠按鈕按下、觸控開始、鍵盤按鈕按下等）。

以下範例展示了根據輸入類型處理用戶輸入的多種用法示例之一。

為了使其按預期工作，必須將其放置在 `LocalScript` 中，
並且是 _gui_ 的子項。

當用戶改變他們通過人機介面設備（滑鼠按鈕按下、觸控開始、鍵盤按鈕按下等）的互動方式時觸發。

`Class.UserInputService` 有一個類似名稱的事件，該事件不限制於特定的 UI 元素：`Class.UserInputService.InputChanged`。

此事件無論遊戲狀態如何都會始終觸發。

另請參見 `Class.GuiObject.InputBegan` 和 `Class.GuiObject.InputEnded`。

GuiObject.InputChanged

當用戶改變他們通過人機介面設備的互動方式時觸發（滑鼠按鈕按下、觸控開始、鍵盤按鈕按下等）。

當用戶停止通過人機介面設備（滑鼠按鈕按下、觸控開始、鍵盤按鈕按下等）互動時觸發。

`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` 偏移量。
`Class.GuiObject.AbsolutePosition|AbsolutePosition` 是在螢幕的 GUI 內縮內測量的，而這個事件的 `x` 和 `y` 參數是包含內縮的螢幕座標，因此範例調用 `Class.GuiService:GetGuiInset()|GetGuiInset()` 來調和這兩個空間，而不是假設固定的內縮大小。

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

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

local mouse = Players.LocalPlayer:GetMouse()

local function getPosition(X, Y)
	local topLeftInset = GuiService:GetGuiInset()

	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 - topLeftInset.Y))
	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 元素上按住一段時間來操控某些 UI 元素的螢幕位置，例如 `Frame`。然後，玩家移動手指並放開。在手勢期間，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

指示手勢在每個維度中執行的速度。

當玩家在 UI 元素上移動手指時觸發。

此代碼範例適用於內部 `Frame` 中的 `LocalScript`，該 `Frame` 位於外部 `Frame` 或其他 `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

rotation

一個浮點數，指示從手勢開始的旋轉量。

一個浮點數，指示手勢執行的速度。

當玩家在 UI 元素上用兩根手指執行旋轉手勢時觸發。

這段程式碼範例會使 `Frame`（或其他 `GuiObject`）在觸控設備（或 Studio 的模擬器）上執行滑動手勢時彈跳。
水平滑動會改變 `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

當玩家在 UI 元素上執行點擊手勢時觸發。

此代碼範例展示了 TweenPosition 的更複雜用法，通過定義回調函數來檢測動畫何時完成/取消。它還會打印動畫是否會播放。

平滑地將 GUI 移動到指定時間內的新 `Datatype.UDim2` 位置，使用指定的 `Enum.EasingDirection` 和 `Enum.EasingStyle`。
如果 `easingStyle` 是 `Enum.EasingStyle.Bezier` 或 `Enum.EasingStyle.Spring`，則此方法會引發錯誤。

此函數將返回 tween 是否會播放。如果另一個 tween 正在作用於 `Class.GuiObject` 且 override 參數為 `false`，則不會播放。

另請參見 `Class.GuiObject:TweenSize()` 和 `Class.GuiObject:TweenSizeAndPosition()`。


GuiObject:TweenPosition

endPosition

easingDirection

將 GUI 以 _endPosition_ 的方向進行緩和。

easingStyle

將 GUI 以 _endPosition_ 的樣式進行緩和。

time

緩和應該完成的時間（以秒為單位）。

override

該 tween 是否會覆蓋正在進行的 tween。

callback

當 tween 完成時要執行的回調函數。

平滑地將 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`。如果 `easingStyle` 是 `Enum.EasingStyle.Bezier` 或 `Enum.EasingStyle.Spring`，則此方法會引發錯誤。

此函數將返回 tween 是否會播放。通常這將始終返回 `true`，但如果另一個 tween 正在活動且 override 設置為 `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`。如果 `easingStyle` 是 `Enum.EasingStyle.Bezier` 或 `Enum.EasingStyle.Spring`，則此方法會引發錯誤。

此函數將返回 tween 是否會播放。通常這將始終返回 `true`，但如果另一個 tween 正在活動且 override 設置為 `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` 的值時，該 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` 背景和邊框的透明度。然而，這不會確定文本的透明度，如果 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` 上被按下。

控制 `Class.GuiObject` 如何以及在多大程度上接收發生在其上的輸入，使用 `Enum.InputSink`。接收輸入會阻止其傳遞到元素後面的物件，包括世界中的 3D 物件，例如具有 `Class.ClickDetector` 或 `Class.DragDetector` 的物件。預設為 `Enum.InputSink.None`，但在 `Class.GuiButton` 物件（`Class.ImageButton` 和 `Class.TextButton`）上預設為 `Enum.InputSink.Activate`。

- `Enum.InputSink.None` — 物件不會自行接收輸入。
- `Enum.InputSink.Activate` — 物件接收用於激活它的滑鼠按鈕和觸控按下/釋放輸入，但允許其他輸入（例如滑鼠移動）通過。
- `Enum.InputSink.All` — 物件接收所有發生在其上的輸入。

此屬性是布林值 `Class.GuiObject.Active|Active` 屬性的更細粒度的後繼，該屬性只能接收所有輸入或不接收。`Class.GuiObject.InputBegan|InputBegan`、`Class.GuiObject.InputChanged|InputChanged` 和 `Class.GuiObject.InputEnded|InputEnded` 事件無論此屬性的值如何都會觸發。

GuiObject.InputSink

控制 `Class.GuiObject` 如何接收發生在其上的輸入。

所有 2D 使用者介面物件的抽象類別。

/reference/engine/classes/InputActionLabel.yaml

概要