UIDragDetector

顯示已棄用項目

*此內容是使用 AI(Beta 測試版)翻譯,可能含有錯誤。若要以英文檢視此頁面,請按一下這裡

UI拖曳器 實例可以與 2D 用戶界面元素在體驗中進行互動,例如滑動器和旋轉器。鑰匙功能包括:

  • UIDragDetector 放在任何 GuiObject 實例下,以便能夠在所有輸入無需單條代碼的情況下拖曳。

  • 從多個 DragStyle 選項中選擇,定義對象以何種方式應對運動以及ResponseStyle 的定義,並且可選擇拖動界限或拖動邊界。

  • 腳本可以回應拖曳對象的操作來駕駛論理回應,例如調整設定。

  • UIDragDetectors 在 Studio 工作,直到你不是使用 選擇移動 、0> 調整0> 或 3> 旋轉3> 工具,或某些插件或 Studio 的 UIDragDetectors6> 編輯器工具。

概要

屬性

方法

活動

屬性

ActivatedCursorIcon

ContentId
平行讀取

設定鼠標啟用時顯示的游標圖示。如果此屬性為空,則探測器會使用預設圖示。

若要變更啟用的指针圖示,將此屬性設置為您想要使用的圖像的資產 ID。

平行讀取

決定拖曳 UI 對象的綁定行為,當探測器的 BoundingUI 設定。參閱 Enum.UIDragDetectorBoundingBehavior 了解每個設定的行為。

BoundingUI

平行讀取

設定時,UIDragDetector 實例將不允許父親 GuiObject 的限制拖曳到 界面控制器 實個體、實例的外部。

注意,如果 GuiObject 的一部分位於 界面限制 之外,在拖曳開始時和其相對位置在拖曳過程中使用的初始輸入位置將被用於偵測綁定直到拖曳對象內,並在拖曳對象內後,對象將被限制在內部。

CursorIcon

ContentId
平行讀取

設定鼠標暫停在此 UIDragDetector 的上方時顯示的曲標圖示。如果此屬性為空,探測器將使用預設圖示。

若要變更鼠標圖示,請將此屬性設為使用者想要使用的圖像的資產 ID。

DragAxis

平行讀取

Vector2 值,定義拖曳對象的移動軸,當 DragStyle 設為 Enum.UIDragDetectorDragStyle.TranslateLine 時。 軸是在 0> Class

平行讀取

只適用於 SetDragStyleFunction()AddConstraintFunction() 註冊的拖曳功能。設定並定義注册功能輸入/輸出的重力。

DragRotation

平行讀取

當前拖曳執行的旋轉。這個值是以相對於本地空間的 UIDragDetector 的度數定義,除非 ReferenceUIInstance 被定義,在此情況下旋轉是在該例子和正向 X 軸的本地空間定義的。

此屬性可以在沒有啟用拖曳對物件旋轉時變更。

平行讀取

只適用於已經註冊過自訂拖曳功能通過 SetDragStyleFunction()AddConstraintFunction() 。設定並定義空間的注冊功能輸入/輸出。

舉例來說,如果偵測器的父親 GuiObject 是一個旋轉的父親 GuiObject 的子:

平行讀取

使用預覽動作來生成所提出的動作,並且在輸入位置向量中提供一個輸入位置。 請參閱 Enum.UIDragDetectorDragStyle 獲取選項。

DragUDim2

平行讀取

目前拖曳的翻譯以 UDim2 值表示。翻譯是通過 OffsetScale 值變更依據 <

此屬性可以在拖曳對象時沒有啟用的拖曳對物件時變更。

Enabled

平行讀取

如果 trueUIDragDetector 會回應使用者輸入;如果 false ,它不會。

MaxDragAngle

平行讀取

如果此屬性大於 MinDragAngle ,旋轉將在 MinDragAngleMaxDragAngle 範圍內受到抵禦。正向值會阻止時鐘旋轉,負向值會阻止反時鐘旋轉。

這不是限制式;它僅會阻止偵測器嘗試在生成運動以便保持在限制內。請參閱 AddConstraintFunction() 以將自訂限制添加到拖動。

只有相關 if DragStyleEnum.UIDragDetectorDragStyle.Rotate

MaxDragTranslation

平行讀取

如果 Offset 和/或 Scale 值大於 MinDragTranslation 的所有尺寸,則將在 1> Class.UIDrag

這不是限制式;它僅會阻止偵測器嘗試在生成運動以便保持在限制內。請參閱 AddConstraintFunction() 以將自訂限制添加到拖動。

只有相關 if DragStyleEnum.UIDragDetectorDragStyle.TranslateLineEnum.UIDragDetectorDragStyle.TranslatePlane

MinDragAngle

平行讀取

如果此屬性小於 MaxDragAngle ,旋轉將在 Class.UIDragDetector.MinDragAngle|MinDragAngle 和 Class.UI拖動器.MaxDragAngle 的範圍內縮放。正向值會阻止時鐘旋轉,負向值會阻止反時鐘旋轉。

這不是限制式;它僅會阻止偵測器嘗試在生成運動以便保持在限制內。請參閱 AddConstraintFunction() 以將自訂限制添加到拖動。

只有相關 if DragStyleEnum.UIDragDetectorDragStyle.Rotate

MinDragTranslation

平行讀取

如果 Offset 和/或 Scale 值小於 MaxDragTranslation 在所有尺寸上,則平行/平面翻譯將

這不是限制式;它僅會阻止偵測器嘗試在生成運動以便保持在限制內。請參閱 AddConstraintFunction() 以將自訂限制添加到拖動。

只有相關 if DragStyleEnum.UIDragDetectorDragStyle.TranslateLineEnum.UIDragDetectorDragStyle.TranslatePlane

ReferenceUIInstance

平行讀取

一個 GuiObject 實例的本地空間和相對中心位置是探測器的參考空間和起始位置。設置此參考會影響如下屬性,例如 DragUDim2DragRotation 和 1> Class

平行讀取

當建議的運動已計算並可能受到限制後,此模型是用於決定如何移動 (或不移動工具) 受影響的 GuiObject 。 參見 UIDragDetector 獲得選項。

SelectionModeDragSpeed

平行讀取

定義最大拖曳速度為 ScaleOffset 的第一個祖先 ScreenGui 或 1> Class.SurfaceGui1>

SelectionModeRotateSpeed

平行讀取

定義 UIDragDetector 每秒鐘可以旋轉的最大角度。此值必須為正,任何值在 0 以下的值都必須被捕捉到 0

UIDragSpeedAxisMapping

平行讀取

Enum.UIDragSpeedAxisMapping 值,決定 X / Y 尺寸拖動速度。

方法

AddConstraintFunction

添加一個功能來修改或限制所提供的動作。功能接受輸入 UDim2 (位置) 和浮動 (旋轉) 的所提供動作和返回 Datatype.UDim2 和浮動的 UDim2 或未修改動作。你可以添加多個功能,

輸入是由 DragSpace 屬性定義的空間來表示,或作為 Delta 或最終目標位置/旋轉位置的最終位置,取決於 DragRelativity

要移除新增的限制函數,請在返回的連接對物件上呼叫 Disconnect()

參數

priority: number

這個方法添加的功能的優先權。更高的值取得優先權。

function: function

修改或限制所提出的動作的功能。這個功能接受輸入 UDim2 和浮動的 提出的 動作和返回 UDim2 和浮動的 1>修改1>


返回

使用此連接對象來移除限制函數。

GetReferencePosition

當沒有 ReferenceUIInstance 設定時,此功能將返回拖曳對物件的即時父親 UDim2 (如果存在) 或拖曳對物件的即時父親 GuiObject (如果存在) 的位置。

ReferenceUIInstance 設設定時,此功能會返回該參考實個體、實例的 UDim2 位置。


返回

UDim2 位置是當前拖動元素的引用元素。

GetReferenceRotation

當沒有 ReferenceUIInstance 設設定時,此函數會返回拖曳對物件的即時父 GuiObject (如果存在) 或者拖曳對物件的旋轉。

ReferenceUIInstance 設設定時,此函數會返回該引用範個體、實例的旋轉。


返回

旋轉目前拖動元素的參考元素。

SetDragStyleFunction

void

如果 DragStyle 設為 Enum.UIDragDetectorDragStyle.Scriptable ,則輸入的輸入位置會取得

如果函數返回 nil ,對象將不會移動。這很有用,如果腳本尚未收集到正確的答案,或在暫時情況下,您想要讓對象保留在原位。

參數

function: function

監視DragContinue信號的功能。這個功能接收單一的輸入位置,並返回UDim2和漂浮在指定位置和重力的拖動。如果此功能返回nil,對象將不會移動。


返回

void

活動

DragContinue

發生在使用者拖曳 UI 元素後, DragStart 已初始化後。

參數

inputPosition: Vector2

Vector2 代表目前輸入位置。


DragEnd

使用者停止拖曳 UI 元素時會發生火焰。

參數

inputPosition: Vector2

Vector2 代表目前輸入位置。


DragStart

發生時,使用者開始拖曳 UI 元素時。

參數

inputPosition: Vector2

Vector2 代表目前輸入位置。