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 `Class.UIDragDetector` sob qualquer instância `Class.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 `Class.UIDragDetector.DragStyle|DragStyle` de, defina como o objeto responde a movimentos através de `Class.UIDragDetector.ResponseStyle|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.

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

UIDragDetector.DragContinue

inputPosition

`Datatype.Vector2` representando a posição de entrada atual.

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

UIDragDetector.DragEnd

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

UIDragDetector.DragStart

Adiciona uma função para modificar ou restringir a movimentação proposta.A função recebe uma entrada `Datatype.UDim2` (posição) e flutuação (rotação) de **proposta** de movimento e retorna uma entrada `Datatype.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 `Class.UIDragDetector.DragSpace|DragSpace`, seja como um delta ou a posição/rotação final desejada com base na propriedade `Class.UIDragDetector.DragRelativity|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 `Datatype.RBXScriptConnection:Disconnect()|Disconnect()` na conexão retornada.

UIDragDetector:AddConstraintFunction

priority

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.

function

Função para modificar ou restringir a movimentação proposta.Essa função recebe a entrada `Datatype.UDim2` e flutuação de **proposta** de movimento e retorna uma `Datatype.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.

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

Adiciona uma função para modificar ou restringir a movimentação proposta.

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

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

UIDragDetector:GetReferencePosition

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

Retorna a posição de referência `Datatype.UDim2` da origem de referência da tração atual.

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

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

UIDragDetector:GetReferenceRotation

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

Retorna a rotação de referência da referência do arraste atual do elemento de referência.

Passa uma função a ser usada se e somente se `Class.UIDragDetector.DragStyle|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 `Datatype.Vector2` e retorna uma posição `Datatype.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 `Class.UIDragDetector.DragSpace|DragSpace` e `Class.UIDragDetector.DragRelativity|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á.

UIDragDetector:SetDragStyleFunction

Função para monitorar `Class.UIDragDetector.DragContinue|DragContinue` sinais.Essa função recebe a posição de entrada do espaço de tela do sinal e retorna um `Datatype.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.

Passa uma função a ser usada se e somente se `Class.UIDragDetector.DragStyle|DragStyle` for definido como `Enum.UIDragDetectorDragStyle.Scriptable`.

UIDragDetector

Define o ícone do cursor para exibir quando o mouse é ativado sobre o pai deste `Class.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.

UIDragDetector.ActivatedCursorIcon

Define o ícone do cursor para exibir quando o mouse é ativado sobre o pai deste `Class.UIDragDetector` .

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

UIDragDetector.BoundingBehavior

Determina o comportamento de borda do objeto UI arrastado quando o `Class.UIDragDetector.BoundingUI|BoundingUI` do detector é definido.

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

  Observe que, se uma parte do pai `Class.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.

UIDragDetector.BoundingUI

Instância cuja área de vinculação define os limites de arrastamento para o pai `Class.GuiObject`.

Define o ícone do cursor para exibir quando o mouse está sobre o pai deste `Class.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.

UIDragDetector.CursorIcon

Define o ícone do cursor para exibir quando o mouse está sobre o pai deste `Class.UIDragDetector` .

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

UIDragDetector.DragAxis

O eixo de arrastamento para a instância `Class.UIDragDetector` quando `Class.UIDragDetector.DragStyle|DragStyle` é definido como `Enum.UIDragDetectorDragStyle.TranslateLine` .

Aplica-se somente se uma função de arrastamento personalizada for registrada através de `Class.UIDragDetector:SetDragStyleFunction()|SetDragStyleFunction()` ou `Class.UIDragDetector:AddConstraintFunction()|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 .

UIDragDetector.DragRelativity

Define o paradigma que define a relatividade de entradas/saídas de uma função de arrasto personalizada.

A rotação realizada pelo arrastamento atual.Este valor é definido em graus em relação ao espaço local do `Class.UIDragDetector` a menos que `Class.UIDragDetector.ReferenceUIInstance|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.

UIDragDetector.DragRotation

A rotação realizada pelo arrastamento atual.

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

  Por exemplo, se o pai do detector `Class.GuiObject` for um filho de um pai `Class.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 .

UIDragDetector.DragSpace

Define o paradigma que define o espaço de entradas/saídas a partir de uma função de arrastamento personalizada.

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.

UIDragDetector.DragStyle

O paradigma usado para gerar a proposta de movimento.

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

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

UIDragDetector.DragUDim2

A tradução realizada pela arrastada atual expressa em um valor `Datatype.UDim2` .

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

UIDragDetector.Enabled

Se o `Class.UIDragDetector` responde à entrada do usuário.

Se esta propriedade for maior que `Class.UIDragDetector.MinDragAngle|MinDragAngle`, a rotação será limitada dentro do alcance de `Class.UIDragDetector.MinDragAngle|MinDragAngle` e `Class.UIDragDetector.MaxDragAngle|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 `Class.UIDragDetector:AddConstraintFunction()|AddConstraintFunction()` para adicionar restrição personalizada a um arraste.

  Só é relevante se `Class.UIDragDetector.DragStyle|DragStyle` for `Enum.UIDragDetectorDragStyle.Rotate`.

UIDragDetector.MaxDragAngle

Junto com `Class.UIDragDetector.MinDragAngle|MinDragAngle`, impede as tentativas do detector de gerar movimento rotacional.

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

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

  Só é relevante se `Class.UIDragDetector.DragStyle|DragStyle` for `Enum.UIDragDetectorDragStyle.TranslateLine` ou `Enum.UIDragDetectorDragStyle.TranslatePlane`.

UIDragDetector.MaxDragTranslation

Junto com `Class.UIDragDetector.MinDragTranslation|MinDragTranslation`, impede as tentativas do detector de gerar movimento linear/plano.

Se esta propriedade for menor que `Class.UIDragDetector.MaxDragAngle|MaxDragAngle`, a rotação será limitada dentro do alcance de `Class.UIDragDetector.MinDragAngle|MinDragAngle` e `Class.UIDragDetector.MaxDragAngle|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 `Class.UIDragDetector:AddConstraintFunction()|AddConstraintFunction()` para adicionar restrição personalizada a um arraste.

  Só é relevante se `Class.UIDragDetector.DragStyle|DragStyle` for `Enum.UIDragDetectorDragStyle.Rotate`.

UIDragDetector.MinDragAngle

Junto com `Class.UIDragDetector.MaxDragAngle|MaxDragAngle`, impede as tentativas do detector de gerar movimento rotacional.

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

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

  Só é relevante se `Class.UIDragDetector.DragStyle|DragStyle` for `Enum.UIDragDetectorDragStyle.TranslateLine` ou `Enum.UIDragDetectorDragStyle.TranslatePlane`.

UIDragDetector.MinDragTranslation

Junto com `Class.UIDragDetector.MaxDragTranslation|MaxDragTranslation`, impede as tentativas do detector de gerar movimento linear/plano.

Uma instância `Class.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 `Class.UIDragDetector.DragUDim2|DragUDim2` , `Class.UIDragDetector.DragRotation|DragRotation` e o comportamento de `Class.UIDragDetector.DragAxis|DragAxis`.

UIDragDetector.ReferenceUIInstance

Uma instância `Class.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.

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

UIDragDetector.ResponseStyle

O paradigma usado para definir a resposta à proposta de moção.

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` .

UIDragDetector.SelectionModeDragSpeed

Velocidade máxima de arrastamento para tradução.

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

UIDragDetector.SelectionModeRotateSpeed

Ângulo máximo por segundo que o `Class.UIDragDetector` pode girar.

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

UIDragDetector.UIDragSpeedAxisMapping

Instância que facilita e incentiva a interação com elementos de UI em uma experiência.

Uma classe base para Classesde restrição e layout de UI; herda de `Class.UIBase`.

UIComponent

Uma classe base para Classesde restrição e layout de UI.

`Class.UIBase` é a classe base para Classesde layout e restrições de UI.

UIBase

`Instance` é a classe base para todas as classes na hierarquia de classe Roblox que podem fazer parte da árvore `Class.DataModel`.

  Não é possível criar diretamente objetos raiz `Instance` , mas o construtor especial `Datatype.Instance.new()` cria objetos por meio de código, usando o nome da classe como parâmetro e retornando o objeto criado.

Demonstrates detecting changes to an instance's ancestry by connecting to the `Class.Instance.AncestryChanged` event.

The ChangingPart's Parent is set to different values overtime. The parent of the part is the part's ancestor, so the `Class.Instance.AncestryChanged` event will fire whenever it changes.

Incêndios quando a propriedade `Class.Instance.Parent` do objeto ou uma de suas ancestrais é alterada.

  Este evento inclui dois parâmetros: `child` refere-se ao `Class.Instance` cujo `Class.Instance.Parent` foi realmente alterado, enquanto `parent` refere-se ao novo `Class.Instance.Parent` desta instância.

  Você pode usar esse evento para rastrear a exclusão de uma instância no Studio, como exclusão manual no Explorer ou através de um plugin.Se você precisar detectar quando uma instância é destruída usando `Class.Instance:Destroy()`, use o evento `Class.Instance.Destroying` em vez disso.

Instance.AncestryChanged

child

O `Class.Instance` cujo `Class.Instance.Parent` foi alterado.

parent

O novo `Class.Instance.Parent` da `Class.Instance` cujo `Class.Instance.Parent` foi alterado.

Incêndios quando a propriedade `Class.Instance.Parent` do objeto ou uma de suas ancestrais é alterada.

Este evento dispara sempre que algum atributo é alterado na instância, incluindo quando um atributo é definido como `nil` .O nome do atributo modificado é passado para a função conectada.

  Por exemplo, o seguinte trecho de código conecta a função `attributeChanged()` à fogo sempre que um dos atributos da peça muda:

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

  local part = Workspace.Part

  local function attributeChanged(attributeName)
  	print(attributeName, "changed")
  end

  part.AttributeChanged:Connect(attributeChanged)
  ```

  Veja também `Class.Instance:GetAttributeChangedSignal()` que retorna um evento que dispara quando um atributo específico for modificado.

Instance.AttributeChanged

attribute

Incêndios sempre que um atributo é alterado no `Class.Instance`.

This snippet prints the names of objects as they are added to the Workspace:

Incêndios após um objeto ser associado a este `Class.Instance` .

  Observe, ao usar essa função em um cliente para detectar objetos criados pelo servidor, é necessário usar `Class.Instance:WaitForChild()`.Isso ocorre porque o objeto e seus descendentes não são garantidos de se replicarem do servidor para o cliente simultaneamente.Por exemplo:

  ```
  local Workspace = game:GetService("Workspace")

  Workspace.ChildAdded:Connect(function(child)
  	-- Use WaitForChild() since descendants may not have replicated yet
  	local head = child:WaitForChild("Head")
  end)
  ```

  Observe, essa função só funciona para filhos imediatos do `Class.Instance`. Para uma função que captura todos os descendentes, use `Class.Instance.DescendantAdded` .

  Veja também `Class.Instance.ChildRemoved` .

Instance.ChildAdded

Incêndios após um objeto ser associado a este `Class.Instance` .

This snippet prints the names of objects as they are removed from the
Workspace:

Incêndios após uma criança ser removida deste `Class.Instance` .

  Removido se refere a quando o pai de um objeto é alterado deste `Class.Instance` para algo diferente deste `Class.Instance`.Observe, este evento também será disparado quando uma criança for destruída (usando `Class.Instance:Destroy()` ) pois a função de destruição define o pai de um objeto para `nil` .

  Essa função só funciona para filhos imediatos do `Class.Instance`. Para uma função que captura todos os descendentes, use `Class.Instance.DescendantRemoving`.

  Veja também `Class.Instance.ChildAdded` .

Instance.ChildRemoved

Incêndios após uma criança ser removida deste `Class.Instance` .

O seguinte exemplo imprimirá o nome de qualquer objeto que seja adicionado ao Espaço de Trabalho:

Este evento é acionado após um descendente ser adicionado ao `Class.Instance`.

  Ao disparar para cada descendente, cuidar de um objeto para o `Class.Instance` disparará o evento para esse objeto e todos os seus descendentes individualmente.

  Se você está apenas preocupado com as crianças diretas **do** da `Class.Instance`, use `Class.Instance.ChildAdded`.

  Veja também `Class.Instance.DescendantRemoving` .

Instance.DescendantAdded

descendant

Incêndios após um descendente for adicionado ao `Class.Instance`.

The following example prints the name of any descendant as it is being removed
from the Workspace:

Este evento dispara **imediatamente antes de** as alterações do pai `Class.Instance` para que uma instância **descendente** não seja mais descendente.`Class.Instance:Destroy()|Destroy()` altera o `Class.Instance.Parent|Parent` de uma instância para `nil`, então chamar esse método em um descrente do pai fará com que esse evento seja disparado.

  Como este evento dispara **antes de** a remoção do descendente, o pai do descendente será mantido inalterado no momento do disparo deste evento.Se o descrente também for uma criança direta do pai, este evento será disparado antes de .

  Se um descendente tem filhos, este evento dispara com o descendente primeiro, seguido por seus descendentes.

  ##### Aviso

  Este evento dispara com o objeto descendente que está sendo removido.Tentar definir o `Class.Instance.Parent|Parent` do descendente para outra coisa falhará.Abaixo está um exemplo que demonstra isso:

  ```
  local Workspace = game:GetService("Workspace")

  Workspace.DescendantRemoving:Connect(function(descendant)
  	-- Do not manipulate the parent of the descendant in this function!
  	-- This event fires BECAUSE the parent was manipulated, and the change hasn't happened yet
  	-- Therefore, it is problematic to change the parent like this:
  	descendant.Parent = game
  end)

  local part = Instance.new("Part")
  part.Parent = Workspace
  part.Parent = nil
  ```

  Veja também `Class.Instance.DescendantAdded|DescendantAdded` .

Instance.DescendantRemoving

Incêndios imediatamente antes de um descendente do `Class.Instance` ser removido.

This sample demonstrates how, when using Immediate signal behavior, an Instance being destroyed remains in place until the connected function yields.

This sample demonstrates how, when using Deferred signal behavior,
an Instance is destroyed before the signal fires.

O `Class.Instance` nunca será excluído da memória enquanto uma função conectada ainda estiver usando-o.No entanto, se a função retornar em qualquer ponto, os descendentes da `Class.Instance` e seus pais serão parentados para `nil`.

  Se a propriedade `Class.Workspace.SignalBehavior` for definida como `Enum.SignalBehavior.Immediate`, este evento é disparado imediatamente antes que o `Class.Instance` ou um de seus ancestrais seja destruído com `Class.Instance:Destroy()`.

  Se a propriedade `Class.Workspace.SignalBehavior` for definida como `Enum.SignalBehavior.Deferred`, este evento será disparado no próximo ponto de retomada, que será depois que o `Class.Instance` ou um de seus ancestrais for destruído com `Class.Instance:Destroy()`.

  Com o comportamento `Enum.SignalBehavior.Deferred|Deferred`, conectar um script ao seu próprio evento `Class.Instance.Destroying` é problemático, pois o script será destruído antes que o retorno de chamada possa ser chamado (o que significa que não será executado).

  Ao excluir um `Class.Instance` em Studio, como excluir manualmente através do [Explorer](/studio/explorer) ou através de um plugin, o `Class.Instance` não é destruído.Em vez disso, o pai é definido como `nil` que você pode rastrear com `Class.Instance.AncestryChanged` .

Instance.Destroying

Incêndios imediatamente antes (ou são adiados até depois) que a instância seja destruída via `Class.Instance:Destroy()` .

Este evento dispara sempre que qualquer propriedade de estilo é alterada na instância, incluindo quando uma propriedade é definida como `nil`.

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

  local player = Players.LocalPlayer
  local playerGui = player.PlayerGui
  local HUDContainer = playerGui:WaitForChild("HUDContainer")
  local meterBar = HUDContainer.MeterBar

  local function stylePropertyChanged()
  	print("Styled properties changed")
  end

  meterBar:StyledPropertiesChanged():Connect(stylePropertyChanged)
  ```

Instance.StyledPropertiesChanged

Incêndios sempre que qualquer propriedade de estilo for alterada na instância, incluindo quando uma propriedade é definida como `nil` .

Instance.childAdded

Este método aplica uma etiqueta à instância, sem efeito se a etiqueta já for aplicada.Adicionar com sucesso uma tag disparará um sinal criado por `Class.CollectionService:GetInstanceAddedSignal()` com a tag fornecida.

  ##### Avertimentos

  *   As tags de uma instância que foram adicionadas do lado do cliente serão descartadas se o servidor adicionar ou remover uma tag nessa instância mais tarde, pois o servidor replica todas as tags juntas e substitui as tags anteriores.

  *   Ao rotular uma instância, é comum que alguns recursos sejam usados para dar à etiqueta sua funcionalidade, por exemplo, conexões de eventos ou tabelas.Para evitar vazamentos de memória, é uma boa ideia limpar esses (desconectar, definir como `nil` , etc.) quando não forem mais necessários para uma etiqueta.Faça isso ao chamar `Class.Instance:RemoveTag()`, chamar `Class.Instance:Destroy()` ou em uma função conectada a um sinal retornado por `Class.CollectionService:GetInstanceRemovedSignal()`.

Instance:AddTag

Essa função destrói todos os filhos e descendentes de uma instância.

  ```
  local part = Instance.new("Part")

  -- Add some sparkles
  for i = 1, 3 do
  	local sparkles = Instance.new("Sparkles")
  	sparkles.Parent = part

    local sc = Instance.new("Sparkles")
    sc.Parent = sparkles
  end

  print("Children:", #part:GetChildren())  --> Children: 3

  part:ClearAllChildren()

  print("Children:", #part:GetChildren())  --> Children: 0
  ```

  Se você não deseja destruir **todas** as crianças e descendentes, use `Class.Instance:GetChildren()` ou `Class.Instance:GetDescendants()` para percorrer essas crianças/descendentes e selecionar o que deve destruir.Por exemplo, o seguinte código de exemplo destruirá todos os `Class.BasePart|BaseParts` descendentes de um `Class.Model` :

  ```
  local Workspace = game:GetService("Workspace")

  local model = Workspace:FindFirstChild("TestModel")

  for _, descendant in model:GetDescendants() do
  	if descendant:IsA("BasePart") then
  		descendant:Destroy()
  	end
  end
  ```

Instance:ClearAllChildren

Essa função destrói todos os filhos de uma instância.

Demonstrates cloning a model using `Class.Instance:Clone()`.

`Clone()` cria uma cópia de uma instância e todos os seus descendentes, ignorando todas as instâncias que não são `Class.Instance.Archivable|Archivable` .A cópia da instância raiz é retornada por este método e seu `Class.Instance.Parent|Parent` é definido como `nil` .Observe que, se a própria instância tiver `Class.Instance.Archivable|Archivable` definido para `false`, essa função retornará `nil` .

  Se uma propriedade de referência, como `Class.ObjectValue.Value` for definida em uma instância clonada, o valor da propriedade da cópia depende do valor da propriedade original:

  *   Se uma propriedade de referência se referir a uma instância que foi **também** clonada, a cópia se referirá à cópia.
  *   Se uma propriedade de referência se referir a um objeto que não foi **clonado** , o mesmo valor é mantido na cópia.

Instance:Clone

Crie uma cópia de uma instância e todos os seus descendentes, ignorando instâncias que não sejam `Class.Instance.Archivable|Archivable` .

Demonstrates destroying a Part using the `Class.Instance:Destroy()` function.

This function is the correct way to dispose of objects that are no longer required.

Define a propriedade `Class.Instance.Parent` para `nil`, bloqueia a propriedade `Class.Instance.Parent` e desconecta todas as conexões, chamando `Destroy()` em todos os filhos.Essa função é a maneira correta de descartar objetos que não são mais necessários.

  Dispor de objetos desnecessários é importante, pois objetos e conexões desnecessários em um local consomem memória que pode levar a problemas sérios de desempenho ao longo do tempo.

  Como melhor prática após chamar `Destroy()` em um objeto, defina qualquer variável que referencie o objeto (ou seus descendentes) para `nil`.Isso impede que seu código acesse qualquer coisa relacionada ao objeto.

  ```lua
  local part = Instance.new("Part")
  part.Name = "Hello, world"
  part:Destroy()
  -- Não faça isso:
  print(part.Name)  --> "Olá, mundo"
  -- Faça isso para evitar que a linha acima funcione:
  part = nil
  ```

  Uma vez que um `Class.Instance` foi destruído por este método, não pode ser reutilizado porque a propriedade `Class.Instance.Parent` está bloqueada.Para temporariamente remover um objeto em vez de destruí-lo, defina para >.Por exemplo:

  ```
  local Workspace = game:GetService("Workspace")

  object.Parent = nil
  task.wait(2)
  object.Parent = Workspace
  ```

  Para destruir um objeto após um período de tempo definido, use `Class.Debris:AddItem()` .

Instance:Destroy

Define a propriedade `Class.Instance.Parent` para `nil`, bloqueia a propriedade `Class.Instance.Parent` e desconecta todas as conexões, chamando `Destroy()` em todos os filhos.

Retorna o primeiro ancestral do `Class.Instance` cujo `Class.Instance.Name` é igual ao nome dado.

  Essa função funciona em direção ao topo, o que significa que ela começa no imediato da instância `Class.Instance.Parent` e funciona em direção ao `Class.DataModel`.Se nenhum ancestral correspondente for encontrado, ele retorna `nil` .

  O seguinte trecho de código encontraria o primeiro ancestral do objeto chamado `Car`.

  ```
  local car = object:FindFirstAncestor("Car")
  ```

  Para variantes dessa função que encontram ancestrais de uma classe específica, consulte `Class.Instance:FindFirstAncestorOfClass()` e `Class.Instance:FindFirstAncestorWhichIsA()`.

Instance:FindFirstAncestor

name

Retorna o primeiro ancestral do `Class.Instance` cujo `Class.Instance.Name` é igual ao nome dado.

Retorna o primeiro ancestral do `Class.Instance` cujo `Class.Object.ClassName` é igual à classe dada.

  Essa função funciona em direção ao topo, o que significa que ela começa no imediato da instância `Class.Instance.Parent` e funciona em direção ao `Class.DataModel`.Se nenhum ancestral correspondente for encontrado, ele retorna `nil` .

  Um uso comum dessa função é encontrar o `Class.Model` a `Class.BasePart` pertence. Por exemplo:

  ```
  local model = part:FindFirstAncestorOfClass("Model")
  ```

  Essa função é uma variante de `Class.Instance:FindFirstAncestor()` que verifica a propriedade `Class.Object.ClassName` em vez de `Class.Instance.Name`.`Class.Instance:FindFirstAncestorWhichIsA()` também existe, usando o método `Class.Object:IsA()` em vez de respeitar a herança de classe.

Instance:FindFirstAncestorOfClass

className

O `Class.Object.ClassName` a ser procurado.

Retorna o primeiro ancestral do `Class.Instance` cujo `Class.Object.ClassName` é igual à classe dada.

Retorna o primeiro ancestral do `Class.Instance` para quem `Class.Object:IsA()` retorna verdadeiro para a classe dada.

  Essa função funciona em direção ao topo, o que significa que ela começa no imediato da instância `Class.Instance.Parent` e funciona em direção ao `Class.DataModel`.Se nenhum ancestral correspondente for encontrado, ele retorna `nil` .

  Ao contrário de `Class.Instance:FindFirstAncestorOfClass()`, esta função usa `Class.Object:IsA()` que respeita a herança de classe. Por exemplo:

  ```
  print(part:IsA("Part"))  --> true
  print(part:IsA("BasePart"))  --> true
  print(part:IsA("Instance"))  --> true
  ```

  Portanto, o seguinte exemplo de código retornará o primeiro ancestral `Class.BasePart` , independentemente de se ele é um `Class.WedgePart` , `Class.MeshPart` ou `Class.Part`.

  ```
  local part = object:FindFirstAncestorWhichIsA("BasePart")
  ```

  Veja também `Class.Instance:FindFirstAncestor()` .

Instance:FindFirstAncestorWhichIsA

Retorna o primeiro ancestral do `Class.Instance` para quem `Class.Object:IsA()` retorna verdadeiro para a classe dada.

O abaixo procuraria no Espaço de Trabalho por um nome de objeto "Tijolo". Se encontrado, mudaria o nome do objeto para "Foo".

Retorna o primeiro filho do `Class.Instance` com o nome dado, ou `nil` se não existir tal filho.Se o argumento opcional `recursive` for `true`, esta função pesquisa todos os descendentes em vez de apenas os filhos imediatos do `Class.Instance`.

  ##### Verificando a existência de um objeto

  `FindFirstChild()` é necessário se você precisar verificar se um objeto existe antes de continuar.Tentar indexar uma criança por nome usando o operador ponto lança um erro se a criança não existir.

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

  -- Os seguintes erros de linha ocorrem se a peça não existir no espaço de trabalho
  Workspace.Part.Transparency = 0.5
  ```

  Uma abordagem melhor é usar `FindFirstChild()` para verificar primeiro `Part` , então usar uma declaração `if` para executar código que precisa dela.

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

  local part = Workspace:FindFirstChild("Part")
  if part then
  	part.Transparency = 0.5
  end
  ```

  ##### Encontrando uma criança cujo nome corresponde a uma propriedade

  Às vezes, o `Class.Instance.Name|Name` de um objeto é o mesmo que o de uma propriedade de seu `Class.Instance.Parent|Parent` .Ao usar o operador ponto, as propriedades têm precedência sobre as crianças se compartilharem um nome.

  No seguinte exemplo, um `Class.Folder` chamado `Color` é adicionado a um `Class.Part`, que também tem a propriedade `Class.Part.Color`.Observe que `part.Color` refere-se ao valor da propriedade `Datatype.Color3` , não à instância filha `Class.Folder`.Um benefício de usar `Class.Instance:FindFirstChild()|FindFirstChild()` é que a introdução de novas propriedades não impõe um risco ao seu código.

  ```lua
  local part = Instance.new("Part")
  local folder = Instance.new("Folder")
  folder.Name = "Color"
  folder.Parent = part
  local c1 = part.Color  -- Propriedade
  local c2 = part:FindFirstChild("Color")  -- The child folder
  ```

  ##### Notas de desempenho

  `Class.Instance:FindFirstChild()|FindFirstChild()` leva cerca de 20% mais tempo do que usar o operador de ponto e quase 8 vezes mais tempo do que simplesmente armazenar uma referência a um objeto.Portanto, você deve evitar chamá-lo em código dependente de desempenho, como em loops apertados ou funções conectadas a `Class.RunService.Heartbeat` e `Class.RunService.PreRender`.Em vez disso, armazene o resultado em uma variável, ou considere usar `Class.Instance.ChildAdded|ChildAdded` ou `Class.Instance:WaitForChild()|WaitForChild()` para detectar quando um filho de um determinado nome ficará disponível.

Instance:FindFirstChild

O `Class.Instance.Name` a ser pesquisado.

recursive

Se a pesquisa deve ser conduzida recursivamente ou não.

Retorna o primeiro filho do `Class.Instance` encontrado com o nome dado.

Retorna o primeiro filho do `Class.Instance` cujo `Class.Object.ClassName|ClassName` é igual ao dado `className` .Ao contrário de `Class.Instance:FindFirstChildWhichIsA()`, esta função retorna apenas objetos cuja classe corresponda a `className`, ignorando a herança de classe.Se nenhuma criança correspondente for encontrada, esta função retorna `nil` .

Instance:FindFirstChildOfClass

Retorna o primeiro filho do `Class.Instance` cujo `Class.Object.ClassName|ClassName` é igual ao nome da classe dado.

Retorna o primeiro filho do `Class.Instance` para quem `Class.Object:IsA()` retorna verdadeiro para a classe dada.

  Se nenhuma criança correspondente for encontrada, esta função retorna `nil` .Se o argumento recursivo opcional for verdadeiro, esta função pesquisa todos os descendentes em vez de apenas os filhos imediatos do `Class.Instance`.

  Ao contrário de `Class.Instance:FindFirstChildOfClass()`, esta função usa `Class.Object:IsA()` que respeita a herança de classe. Por exemplo:

  ```lua
  print(part:IsA("Part")) --> verdadeiro
  print(part:IsA("BasePart")) --> verdadeiro
  print(part:IsA("Instance")) --> true
  ```

  Portanto, o seguinte exemplo de código retornará o primeiro filho `Class.BasePart` , independentemente de se ele é um `Class.WedgePart` , `Class.MeshPart` ou `Class.Part` .

  ```
  local part = object:FindFirstChildWhichIsA("BasePart")
  ```

  Desenvolvedores que buscam uma criança por nome devem usar `Class.Instance:FindFirstChild()` em vez disso.

Instance:FindFirstChildWhichIsA

O `Class.Object.ClassName` a ser pesquisado.

Retorna o primeiro filho do `Class.Instance` para quem `Class.Object:IsA()` retorna verdadeiro para a classe dada.

Retorna o primeiro descendente encontrado com o dado `Class.Instance.Name`.

  Este método está desativado e não pode ser usado.Para encontrar o primeiro descendente de uma instância, considere usar o parâmetro `recursive` em `Class.Instance:FindFirstChild()` em vez disso.

Instance:FindFirstDescendant

Retorna o primeiro descendente encontrado com o dado `Class.Instance.Name`.

Se o `Class.Instance` for um `Class.Actor`, o `Class.Actor` próprio é retornado.Caso contrário, seu ancestral mais próximo `Class.Actor` é retornado.Se nenhum ancestral for um `Class.Actor` , o resultado é `nil` .

Instance:GetActor

Retorna o `Class.Actor` associado à Instância, se houver.

Este método retorna o valor que foi atribuído ao nome do atributo dado. Se nenhum atributo foi atribuído, `nil` é retornado.

  Por exemplo, o seguinte trecho de código define e então obtém o valor do atributo da instância `InitialPosition`:

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

  local part = Workspace.Part
  part:SetAttribute("InitialPosition", part.Position)

  local initialPosition = instance:GetAttribute("InitialPosition")
  print(initialPosition)
  ```

  ##### Veja também

  *   `Class.Instance:SetAttribute()` que define o atributo com o nome dado para o valor dado.
  *   `Class.Instance:GetAttributes()` que retorna um dicionário de pares de chave-valor para cada atributo da instância.

Instance:GetAttribute

O valor que foi atribuído ao nome do atributo dado. Se nenhum atributo foi atribuído, `nil` é retornado.

Retorna o valor que foi atribuído ao nome do atributo dado.

Essa função retorna um evento que se comporta exatamente como o evento `Class.Object.Changed|Changed`, exceto que só é disparado quando o atributo específico muda; efetivamente, é semelhante a `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()` para atributos.

  É geralmente uma boa ideia usar esse método em vez de uma conexão com `Class.Object.Changed|Changed` com uma função que verifica o nome do atributo.Chamadas subsequentes a este método no mesmo objeto com o mesmo nome de atributo retornam o mesmo evento.

  O seguinte exemplo de código retorna um sinal que ativa a função `attributeChanged()` quando o atributo da peça `InitialPosition` muda:

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

  local part = Workspace.Part
  part:SetAttribute("InitialPosition", part.Position)

  local function attributeChanged()
  	print("Attribute changed")
  end

  part:GetAttributeChangedSignal("InitialPosition"):Connect(attributeChanged)
  ```

  Veja também `Class.Instance.AttributeChanged` que dispara sempre que algum atributo for alterado na instância.

Instance:GetAttributeChangedSignal

O nome do atributo especificado para o qual o sinal de alteração está sendo retornado.

Um evento que dispara quando o atributo dado muda.

Retorna um evento que dispara quando o atributo dado muda.

Este método retorna um dicionário de pares de chave-valor para cada atributo onde a chave é o nome do atributo e o valor é um valor não `nil` .

  Por exemplo, o seguinte trecho de código exibe os atributos e valores de uma instância:

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

  local part = Workspace.Part
  part:SetAttribute("InitialPosition", part.Position)
  part:SetAttribute("CanUse", true)

  for name, value in part:GetAttributes() do
  	print(name .. " = " .. value)
  end
  ```

  Veja também `Class.Instance:GetAttribute()` que retorna o valor que foi atribuído ao nome do atributo dado.

Instance:GetAttributes

Um dicionário de pares de corda → variáveis para cada atributo onde a corda é o nome do atributo e a variável é um valor não nulo.

Retorna um dicionário dos atributos da instância.

The below would print the name of all objects currently in Workspace when ran.

Retorna um array (uma tabela numericamente indexada) que contém todos os filhos diretos da instância ou todos os `Class.Instance` que seu `Class.Instance.Parent|Parent` é igual ao objeto.O array pode ser iterado usando um for-loop numérico ou genérico:

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

  -- Exemplo de ciclo for numérico
  local children = Workspace:GetChildren()
  for i = 1, #children do
  	local child = children[i]
  	print(child.Name .. " is child number " .. i)
  end
  ```

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

  -- Exemplo genérico de for-loop
  local children = Workspace:GetChildren()
  for i, child in children do
  	print(child.Name .. " is child number " .. i)
  end
  ```

  As crianças são classificadas pela ordem em que sua propriedade `Class.Instance.Parent|Parent` foi definida para o objeto.

  Veja também a função `Class.Instance:GetDescendants()|GetDescendants` .

Instance:GetChildren

Um array que contém os filhos da instância.

Retorna um array que contém todos os filhos da instância.

Retorna uma string codificada do ID de depuração usado internamente pelo Roblox. Observe que:

  *   Este item está protegido. Tentar usá-lo em um `Class.Script` ou `Class.LocalScript` causará um erro.
  *   Um ID de debug é um ID usado em processos de depuração.Permite que um depurador leia cada instrução antes que uma aplicação processe-a.Todos os objetos no Roblox agem como processos e instruções de execução (ou "código") que podem ser debugadas se necessário.
  *   Isso pode ser útil para plugins que precisam distinguir objetos semelhantes uns dos outros (como objetos que compartilham o mesmo nome).

Instance:GetDebugId

scopeLength

Retorna uma string codificada do ID de depuração usado internamente pelo Roblox.

Instance

`Instance` é a classe base para todas as classes na hierarquia de classe Roblox que podem fazer parte da árvore `Class.DataModel`.

/reference/engine/classes/UIDragDetector.yaml

UIDragDetector

Resumo

Propriedades

Métodos

Eventos

Propriedades

Métodos

Eventos