UIDragDetector

Mostrar obsoleto

*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

La instancia UIDragDetector facilita y promueve la interacción con los elementos de la interfaz de usuario 2D en una experiencia, como los desplazadores y los spinners. Las características clave incluyen:

  • Coloca un UIDragDetector debajo de cualquier instancia de GuiObject para hacerlo arrastrable a través de todos los elementos sin una sola línea de código.

  • Elija entre varias opciones de DragStyle, defina cómo el objeto responde a la movilidad a través de ResponseStyle y opcionalmente aplique límites de velocidad, límites de movimiento o límites de arrastre.

  • Los scripts pueden responder a la manipulación de objetos arrastrados para proporcionar respuestas lógicas, como ajustar la configuración.

  • UIragDetectors funcionan en Studio mientras estés no usando las herramientas de Seleccionar , 0>Mover0>, 3>Escala3> o UIDragDetectors6> herramientas, o algunos plugins o herramientas de Studio.

Resumen

Propiedades

Métodos

Eventos

Propiedades

ActivatedCursorIcon

ContentId
Leer paralelo

Establece el icono del cursor para mostrar cuando el mouse está activado sobre el padre de este UIDragDetector . Si esta propiedad se deja en blanco, el detector usará el íconopredeterminado.

Para cambiar el íconodel cursor activado, establece esta propiedad en el ID de la imagen que deseas usar.

Leer paralelo

Determina el comportamiento de enfoque de la interfaz de usuario arrastrada cuando el detector establece el BoundingUI . Consulte Enum.UIDragDetectorBoundingBehavior para obtener más información sobre el comportamiento de cada configuración.

BoundingUI

Leer paralelo

Cuando se establecer, la instancia UIDragDetector no permitirá que los límites del padre GuiObject se arrastren fuera de los límites de la instancia BoundingUI .

Nota que si una parte del padre GuiObject está fuera de los límites de BoundingUI , la posición de entrada inicial en el arranque de arrastre y su posición relativa durante el arrastre se usarán para la detección de vinculación hasta que la entidad del objeto arrastrado esté dentro de los límites, después de lo cual el objeto se limitará dentro de los límites.

CursorIcon

ContentId
Leer paralelo

Establece el icono del cursor para mostrar cuando el mouse está sobre el padre de este UIDragDetector . Si esta propiedad se deja en blanco, el detector usará el íconopredeterminado.

Para cambiar el íconodel cursor, establece esta propiedad en el ID de la imagen que quieres usar.

DragAxis

Leer paralelo

Vector2 valor que define el eje de movimiento para el objeto arrastrado cuando Class.UIDragDetector.DragStyle|DragStyle está configurado como DragStyle . El eje se define en el espacio local del Class.UIDragDetector a menos

Leer paralelo

Solo se aplica si se registra una función de drag personalizada a través de SetDragStyleFunction() o AddConstraintFunction() . Establece el paradigma que define los input/output de la función registrada.

Por

DragRotation

Leer paralelo

La rotación realizada por el valor actual de la fuerza de sujeción. Este valor se define en grados relativos al espacio local del UIDragDetector a menos que ReferenceUIInstance esté definido, en cuyo caso la rotación se define en el espacio local de ese instante y desde su eje positivo X .

Esta propiedad se puede cambiar mientras no hay un arrastre activo para rotar el objeto arrastrado.

Leer paralelo

Solo se aplica si se registra una función de drag personalizada a través de SetDragStyleFunction() o AddConstraintFunction() . Establece el paradigma que define el espacio de las entradas/salidas de la función registrada.

Por ejemplo, si el padre del detector GuiObject es un hijo de un padre GuiObject que gira:

  • Devolver un Datatype.UDim2.fromOffset(1, 0) de una función registrada con esta propiedad setado a Class.GuiObject</Class.GuiObject> padre del detector para mover el padre del detector Class.GuiObject hacia la derecha por 1 pixel en el espacio local afectado por su padre de rotación.

  • Devolver un UDim2.fromOffset(1, 0) de una función registrada con esta propiedad setado a Enum.UIDragDetectorDragSpace.LayerCollector moverá el padre del detector GuiObject a la derecha en 1 pixel en el espacio del 1> Class.LayerCollector1> .

Leer paralelo

El paradigma utilizado para generar la propuesta de movimiento, dado un conjunto de posiciones de entrada. Ver Enum.UIDragDetectorDragStyle para opciones.

DragUDim2

Leer paralelo

La traducción se realiza a través de la expresión de drag actual expresada en un valor UDim2 . La traducción se realiza a través de la expresión de drag Offset o Datatype.UDim.Scale

Esta propiedad se puede cambiar mientras no hay un agarre activo para mover el objeto arrastrado.

Enabled

Leer paralelo

Si true, el UIDragDetector responde a la entrada del usuario; si false, no lo hace.

MaxDragAngle

Leer paralelo

Si esta propiedad es mayor que MinDragAngle , la rotación se ajustará dentro del rango de MinDragAngle y MaxDragAngle . Los valores positivos impiden la rotación hacia la izquierda mientras que los valores negativos impiden la rotación hacia la derecha.

Esto no es una restricción; simplemente impide que los intentos del detector de generar movimiento para permanecer dentro de los límites. Vea AddConstraintFunction() para agregar una limitación personalizada a un arrastre.

Solo es relevante si DragStyle es Enum.UIDragDetectorDragStyle.Rotate .

MaxDragTranslation

Leer paralelo

Si los valores correspondientes Offset y/o Scale son mayores que los de MinDragTranslation en todas las dimensiones, la traducción lineal/plana se

Esto no es una restricción; simplemente impide que los intentos del detector de generar movimiento para permanecer dentro de los límites. Vea AddConstraintFunction() para agregar una limitación personalizada a un arrastre.

Solo es relevante si DragStyle es Enum.UIDragDetectorDragStyle.TranslateLine o Enum.UIDragDetectorDragStyle.TranslatePlane .

MinDragAngle

Leer paralelo

Si esta propiedad es menor que MaxDragAngle , la rotación se ajustará dentro del rango de MinDragAngle y MaxDragAngle . Los valores positivos impiden la rotación hacia la izquierda mientras que los valores negativos impiden la rotación

Esto no es una restricción; simplemente impide que los intentos del detector de generar movimiento para permanecer dentro de los límites. Vea AddConstraintFunction() para agregar una limitación personalizada a un arrastre.

Solo es relevante si DragStyle es Enum.UIDragDetectorDragStyle.Rotate .

MinDragTranslation

Leer paralelo

Si los valores correspondientes Offset y/o Scale son inferiores a los de MaxDragTranslation en todos los ámbitos, la traducción lineal/plana se

Esto no es una restricción; simplemente impide que los intentos del detector de generar movimiento para permanecer dentro de los límites. Vea AddConstraintFunction() para agregar una limitación personalizada a un arrastre.

Solo es relevante si DragStyle es Enum.UIDragDetectorDragStyle.TranslateLine o Enum.UIDragDetectorDragStyle.TranslatePlane .

ReferenceUIInstance

Leer paralelo

Una instancia de GuiObject cuyo espacio local y posición de centro es el espacio de referencia y el origen para el detector. Establecer esta posición de referencia afecta propiedades como DragUDim2 , DragRotation y el comportamiento de 1>

Leer paralelo

Una vez que se ha determinado y se ha movido (o no se ha movido) el GuiObject afectado por el UIDragDetector, se usa este paradigma para determinar cómo mover (o no herramienta de movimiento) el Enum.UIDragDetectorResponseStyle afectado por el 2>IDUDRAGDETOR2>. Véase 5> Class.Gui5> para obtener opciones.

SelectionModeDragSpeed

Leer paralelo

Define la velocidad de arrastre máxima para la traducción como una combinación de Scale y Offset del primer ancestro ScreenGui o 1> Class.SurfaceGui</

SelectionModeRotateSpeed

Leer paralelo

Define el ángulo máximo por segundo en el que se puede rotarel UIDragDetector. Este valor debe ser positivo y cualquier valor debajo de 0 se ajustará a 0 .

UIDragSpeedAxisMapping

Leer paralelo

Enum.UIDragSpeedAxisMapping valor que determina la velocidad de escalado de dimensión X / Y .

Métodos

AddConstraintFunction

Añade una función para modificar o limitar el movimiento propuesto. La función toma una entrada UDim2 (posición) y flota (rotación) de propuesto movimiento y devuelve un UDim2 y flota de 1> modificado1> o no modificado movimiento. P

La entrada se expresa en el espacio definido por la propiedad DragSpace , ya sea como un Delta o la posición deseado final / rotación basada en la propiedad DragRelativity . La salida debería exp

Para eliminar una función de restricción agregada, llame a Disconnect() en el objeto de conexión devuelto.

Parámetros

priority: number

El orden de prioridad para las funciones agregadas a través de este método. Los valores más altos tienen prioridad sobre los valores más bajos.

function: function

Función para modificar o limitar la propuesta de movimiento. Esta función toma la entrada UDim2 y flota de la propuesta de movimiento propuesta y devuelve un Datatype.UDim2 y flota de la propuesta de movimiento modificada o no mod


Devuelve

Usa este objeto de conexión para eliminar la función de restricción.

GetReferencePosition

Cuando no se ha establecerninguna ReferenceUIInstance Class.UIragDetector.ReferenceUIInstance|ReferenceUIInstance, esta función devuelve la posición de UDim2 de la raíz del objeto arrastrado inmediatamente padre GuiObject (si existe uno), o la posición de 2>Datatype.UDim22> del objeto arrastrado.

Cuando se establecerun ReferenceUIInstance, esta función devuelve la posición UDim2 de esa instancia de referencia.


Devuelve

UDim2 posición del elemento de referencia de la actual drag.

GetReferenceRotation

Cuando no se establecerninguna ReferenceUIInstance, esta función devuelve la rotación del objeto arrastrado inmediato padre GuiObject (si existe uno) o la rotación del objeto arrastrado.

Cuando se establecerun ReferenceUIInstance, esta función devuelve la rotación de esa instancia de referencia.


Devuelve

Rotación del elemento de referencia de la actual drag.

SetDragStyleFunction

void

Pasa una función para usar si y solo si DragStyle está configurado como Enum.UIDragDetectorDragStyle.Scriptable . La función

Si la función devuelve nil , el objeto no se moverá. Esto es útil si el script aún no ha recopilado toda la información que necesita para dar la respuesta correcta, o en casos temporales donde desea que el objeto se mantenga donde está.

Parámetros

function: function

Función para monitorear señales de DragContinue . Esta función recibe la posición de entrada de espacio del signo y devuelve un UDim2 y flotante que contiene el movimiento deseado del drag en el espacio y la relatividad deseados. Si esta función devuelve nil, el objeto no se moverá.


Devuelve

void

Eventos

DragContinue

Se activa cuando un usuario continúa arrastrando el elemento de UI después de que se haya iniciado DragStart .

Parámetros

inputPosition: Vector2

Vector2 representando la posición de entrada actual.


DragEnd

Se activa cuando un usuario deja de arrastrar el elemento de la interfaz de usuario.

Parámetros

inputPosition: Vector2

Vector2 representando la posición de entrada actual.


DragStart

Se activa cuando un usuario comienza a arrastrar el elemento de la interfaz de usuario.

Parámetros

inputPosition: Vector2

Vector2 representando la posición de entrada actual.