UIDragDetector

Mostrar obsoleto

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

A instância facilita e incentiva a interação com elementos de interface de usuário 2D em uma experiência, como sliders e spinners.As principais características incluem:

  • Coloque um UIDragDetector sob qualquer instância GuiObject para torná-la arrastável através de todos os inputs sem uma única linha de código.

  • Escolha entre várias opções DragStyle de, defina como o objeto responde a movimentos através de ResponseStyle e aplique opcionalmente limites de eixo, movimento ou bordas de arrastamento.

  • Scripts podem responder à manipulação de objetos arrastados para impulsionar respostas lógicas, como ajustar configurações.

  • Trabalhe no Studio enquanto você não estiver usando a ferramenta Selecionar, Mover, Redimensionar, ou Girar ferramentas, nem certas ferramentas de editor de Interface do usuário do Studio ou plugins.

Resumo

Propriedades

Métodos

Eventos

Propriedades

ActivatedCursorIcon

ContentId
Ler Parallel

Define o ícone do cursor para exibir quando o mouse é ativado sobre o pai deste UIDragDetector .Se esta propriedade for deixada em branco, o detector usará o ícone padrão.

Para alterar o ícone do cursor ativado, defina esta propriedade para o ID do recurso da imagem que você gostaria de usar.

Ler Parallel

Determina o comportamento de borda do objeto UI arrastado quando o BoundingUI do detector é definido. Veja Enum.UIDragDetectorBoundingBehavior para detalhes sobre o comportamento de cada configuração.

BoundingUI

Ler Parallel

Quando definido, a instância UIDragDetector não permitirá que os limites do pai GuiObject sejam arrastados fora dos limites da instância BoundingUI .

Observe que, se uma parte do pai GuiObject estiver fora dos limites da BoundingUI , a posição inicial de entrada ao arrastar e sua posição relativa durante o arrastamento serão usadas para detecção de limites até que toda a entidade arrastada esteja dentro dos limites, após o qual o objeto será limitado dentro dos limites.

CursorIcon

ContentId
Ler Parallel

Define o ícone do cursor para exibir quando o mouse está sobre o pai deste UIDragDetector .Se esta propriedade for deixada em branco, o detector usará o ícone padrão.

Para alterar o ícone do cursor, defina esta propriedade para o ID do recurso da imagem que você gostaria de usar.

DragAxis

Ler Parallel

Vector2 valor que define o eixo de movimento para o objeto arrastado quando DragStyle é definido como Enum.UIDragDetectorDragStyle.TranslateLine.O eixo é definido no espaço local do UIDragDetector a menos que ReferenceUIInstance seja definido, no qual o eixo é definido no espaço local daquele momento.

Ler Parallel

Aplica-se somente se uma função de arrastamento personalizada for registrada através de SetDragStyleFunction() ou AddConstraintFunction().Define o paradigma que define a relatividade dos inputs/outputs da função registrada.

Por exemplo, retornar um de uma função registrada com essa propriedade definida como moverá o pai do detector para no local designado , enquanto retornar o mesmo com essa propriedade definida como moverá o pai do detector para no local designado .

DragRotation

Ler Parallel

A rotação realizada pelo arrastamento atual.Este valor é definido em graus em relação ao espaço local do UIDragDetector a menos que ReferenceUIInstance seja definido, no qual a rotação é definida no espaço local dessa instância e a partir de seu eixo positivo X .

Essa propriedade pode ser alterada enquanto não há traço ativo para girar o objeto arrastado.

Ler Parallel

Aplica-se somente se uma função de arrastamento personalizada for registrada através de SetDragStyleFunction() ou AddConstraintFunction().Define o paradigma que define o espaço dos inputs/outputs da função registrada.

Por exemplo, se o pai do detector GuiObject for um filho de um pai GuiObject que foi girado:

  • Retornar um de uma função registrada com essa propriedade definida como moverá o pai do detector para a direita por 1 pixel no espaço local afetado pela rotação de seu pai.

  • Retornar um de uma função registrada com essa propriedade definida como moverá o pai do detector para a direita por 1 pixel no espaço do .

Ler Parallel

O paradigma usado para gerar a proposta de movimento, dado um fluxo de vetores de posição de entrada. Veja Enum.UIDragDetectorDragStyle para opções.

DragUDim2

Ler Parallel

A tradução realizada pela arrastada atual expressa em um valor UDim2 .A tradução é feita através de Offset ou Scale alterações de valor dependendo do valor DragRelativity e é relativa ao espaço local do detector, a menos que um ReferenceUIInstance seja definido.

Essa propriedade pode ser alterada enquanto não há arrasto ativo para mover o objeto arrastado.

Enabled

Ler Parallel

Se true , o UIDragDetector responde à entrada do usuário; se false , não o faz.

MaxDragAngle

Ler Parallel

Se esta propriedade for maior que MinDragAngle, a rotação será limitada dentro do alcance de MinDragAngle e MaxDragAngle.Os valores positivos impedem a rotação no sentido horário enquanto os valores negativos impedem a rotação no sentido antihorário.

Esta não é uma restrição; ele apenas impede as tentativas do detector de gerar movimento para permanecer dentro dos limites.Veja AddConstraintFunction() para adicionar restrição personalizada a um arraste.

Só é relevante se DragStyle for Enum.UIDragDetectorDragStyle.Rotate.

MaxDragTranslation

Ler Parallel

Se os valores correspondentes Offset e/ou Scale forem maiores que os de MinDragTranslation em todas as dimensões, a tradução linear/plana será limitada dentro do alcance de MinDragTranslation e MaxDragTranslation .

Esta não é uma restrição; ele apenas impede as tentativas do detector de gerar movimento para permanecer dentro dos limites.Veja AddConstraintFunction() para adicionar restrição personalizada a um arraste.

Só é relevante se DragStyle for Enum.UIDragDetectorDragStyle.TranslateLine ou Enum.UIDragDetectorDragStyle.TranslatePlane.

MinDragAngle

Ler Parallel

Se esta propriedade for menor que MaxDragAngle, a rotação será limitada dentro do alcance de MinDragAngle e MaxDragAngle.Os valores positivos impedem a rotação no sentido horário enquanto os valores negativos impedem a rotação no sentido antihorário.

Esta não é uma restrição; ele apenas impede as tentativas do detector de gerar movimento para permanecer dentro dos limites.Veja AddConstraintFunction() para adicionar restrição personalizada a um arraste.

Só é relevante se DragStyle for Enum.UIDragDetectorDragStyle.Rotate.

MinDragTranslation

Ler Parallel

Se os valores correspondentes de Offset e/ou Scale forem menores que os de MaxDragTranslation em todas as dimensões, a tradução linear/plana será limitada dentro do alcance de MinDragTranslation e MaxDragTranslation .

Esta não é uma restrição; ele apenas impede as tentativas do detector de gerar movimento para permanecer dentro dos limites.Veja AddConstraintFunction() para adicionar restrição personalizada a um arraste.

Só é relevante se DragStyle for Enum.UIDragDetectorDragStyle.TranslateLine ou Enum.UIDragDetectorDragStyle.TranslatePlane.

ReferenceUIInstance

Ler Parallel

Uma instância GuiObject que tem o espaço local e a posição do centro absoluto como o espaço de referência e a origem para o detector.Definir essa referência afeta propriedades como DragUDim2 , DragRotation e o comportamento de DragAxis.

Ler Parallel

Uma vez que a moção proposta foi computada e potencialmente restrita, este paradigma é usado para determinar como mover (ou não mover) o GuiObject afetado pelo UIDragDetector.Veja Enum.UIDragDetectorResponseStyle para opções.

SelectionModeDragSpeed

Ler Parallel

Define a velocidade máxima de arrastamento para tradução como uma combinação de e da primeira ancestral ou a que pertence.Este valor deve ser positivo e qualquer valor abaixo de 0 será clampado para 0 .

SelectionModeRotateSpeed

Ler Parallel

Define o ângulo máximo por segundo em que o UIDragDetector pode girar.Este valor deve ser positivo e qualquer valor abaixo de 0 será clampado para 0 .

UIDragSpeedAxisMapping

Ler Parallel

Enum.UIDragSpeedAxisMapping valor que determina as velocidades de arrastamento da dimensão X / Y .

Métodos

AddConstraintFunction

Adiciona uma função para modificar ou restringir a movimentação proposta.A função recebe uma entrada UDim2 (posição) e flutuação (rotação) de proposta de movimento e retorna uma entrada UDim2 e flutuação de modificada ou não modificada de movimento.Você pode adicionar múltiplas funções que serão chamadas em ordem por priority, passando os resultados em uma cadeia.

A entrada é expressa no espaço definido pela propriedade DragSpace, seja como um delta ou a posição/rotação final desejada com base na propriedade DragRelativity.A saída deve ser expressa no mesmo espaço e relatividade, a menos que substituída por retornar um valor de retorno especificado Enum.UIDragDetectorDragRelativity e Enum.UIDragDetectorDragSpace como os terceiro e quarto valores de retorno.

Para remover uma função de restrição adicionada, chame Disconnect() na conexão retornada.

Parâmetros

priority: number

A ordem de prioridade para funções adicionadas via este método. Os valores mais altos têm precedência sobre os valores mais baixos.

Valor Padrão: ""
function: function

Função para modificar ou restringir a movimentação proposta.Essa função recebe a entrada UDim2 e flutuação de proposta de movimento e retorna uma UDim2 e flutuação de modificada ou não modificada de movimento.Ele pode opcionalmente retornar um Enum.UIDragDetectorDragRelativity e Enum.UIDragDetectorDragSpace como os terceiro e quarto valores de retorno como substituições de saída.

Valor Padrão: ""

Devolução

Use este objeto de conexão para remover a função de restrição.

GetReferencePosition

Quando nenhum ReferenceUIInstance é definido, esta função retorna a posição UDim2 do pai imediato do objeto arrastado GuiObject (se existir um), ou então a posição UDim2 do objeto arrastado.

Quando um ReferenceUIInstance é definido, essa função retorna a posição UDim2 daquela instância de referência.


Devolução

UDim2 posição do elemento de referência da tração atual.

GetReferenceRotation

Quando nenhum ReferenceUIInstance é definido, essa função retorna a rotação do pai imediato do objeto arrastado GuiObject (se existir um), ou então a rotação do objeto arrastado.

Quando um ReferenceUIInstance é definido, essa função retorna a rotação daquela instância de referência.


Devolução

Rotação do elemento de referência da arrancada atual.

SetDragStyleFunction

()

Passa uma função a ser usada se e somente se DragStyle for definido como Enum.UIDragDetectorDragStyle.Scriptable.A função dada recebe a posição de espaço na tela do sinal com o tipo Vector2 e retorna uma posição UDim2 (posição) e flutuação (rotação) que contém o movimento desejado do arrasto.O espaço dos valores de retorno e a relatividade do movimento são determinados pelas propriedades DragSpace e DragRelativity, a menos que sejam substituídas por retornar um valor especificado Enum.UIDragDetectorDragRelativity e Enum.UIDragDetectorDragSpace como os terceiro e quarto valores de retorno.

Se a função retornar nil, o objeto não será movido.Isso é útil se o script ainda não coletou todas as informações de que precisa para dar a resposta correta ou em casos temporários em que você quer que o objeto permaneça onde está.

Parâmetros

function: function

Função para monitorar DragContinue sinais.Essa função recebe a posição de entrada do espaço de tela do sinal e retorna um UDim2 e flutuação que contém o movimento desejado do arrasto no espaço e relatividade desejados.Se essa função retornar nil, o objeto não será movido.

Valor Padrão: ""

Devolução

()

Eventos

DragContinue

Incêndios quando um usuário continua arrastando o elemento da interface de usuário depois que DragStart foi iniciado.

Parâmetros

inputPosition: Vector2

Vector2 representando a posição de entrada atual.


DragEnd

Dispara quando um usuário para de arrastar o elemento da interface de usuário.

Parâmetros

inputPosition: Vector2

Vector2 representando a posição de entrada atual.


DragStart

Dispara quando um usuário começa a arrastar o elemento da interface de usuário.

Parâmetros

inputPosition: Vector2

Vector2 representando a posição de entrada atual.