**Colecionador de Camadas** é a classe base de contêineres de UI 2D que renderizam descendentes `Class.GuiObject`, como `Class.ScreenGui`.

  Para melhorias de desempenho, a aparência de um `Class.LayerCollector` é armazenada até que um dos seguintes eventos ocorra:

  *   Um descendente é adicionado ou removido dele.
  *   Uma propriedade de um descendente muda.
  *   Uma propriedade da própria `Class.LayerCollector` muda.

LayerCollector:GetLayoutNodeTree

LayerCollector

Alterna a visibilidade deste `Class.LayerCollector` . Quando `false` , o conteúdo da interface não será renderizar, processado o input do usuário ou atualizado em resposta às alterações.

LayerCollector.Enabled

Alterna a visibilidade deste `Class.LayerCollector` .

Quando definido para `false` e este `Class.LayerCollector` é um filho direto de `Class.StarterGui` , ele só será clonado para cada jogador `Class.PlayerGui` uma vez e não será excluído quando o personagem do jogador respawnar.

  Quando definido para (padrão), ou se este for um descendente indireto de , ele será clonado para cada jogador quando seu personagem respawnar, e ele se excluirá quando o personagem do jogador respawnar novamente.

LayerCollector.ResetOnSpawn

Determina se os ressets (se reinicia e se clona de novo no personagem do jogador) ocorrem sempre que o personagem do jogador respawna.

Controla como `Class.GuiObject.ZIndex` se comporta em todos os descendentes deste `Class.LayerCollector` .

  Com `Enum.ZIndexBehavior.Sibling` (padrão), as crianças sempre renderizam acima de seus pais e o `Class.GuiObject.ZIndex|ZIndex` é usado para decidir a ordem em que as crianças de um único objeto de UI renderizarão umas sobre as outras.

  `Enum.ZIndexBehavior.Global` classifica todos os descendentes de acordo com o `Class.GuiObject.ZIndex|ZIndex`, então quebra os laços usando a ordem hierárquica.Como resultado, os descendentes de um `Class.GuiObject` precisam ter um valor `Class.GuiObject.ZIndex|ZIndex` que seja pelo menos tão alto quanto o pai, ou eles renderizarão sob o pai deles.

LayerCollector.ZIndexBehavior

Controla como `Class.GuiObject.ZIndex` se comporta em todos os descendentes deste `Class.LayerCollector` .

A classe base de 2D contêineres de UI que renderizam `Class.GuiObject|GuiObjects` em camadas.

`Class.GuiBase2d` é uma classe abstrata herdada por 2D `Class.GuiObject|GuiObjects` .

Este evento dispara quando a seleção do gamepad se move para, deixa ou muda dentro do conectado `Class.GuiBase2d` ou de qualquer descendente `Class.GuiObject|GuiObjects`.Quando o destaque da seleção se move para um `Class.GuiObject`, as bolhas de evento daquele `Class.GuiObject` para todos os seus ancestrais informam que a seleção mudou/entrou/saiu para um `Class.GuiObject` em sua árvore descendente.

GuiBase2d.SelectionChanged

amISelected

Verdadeiro se a nova seleção corresponder ao GuiBase2d anexado.

previousSelection

newSelection

Incêndios quando a seleção do gamepad se move para, deixa ou muda dentro do conectado `Class.GuiBase2d` ou qualquer descendente `Class.GuiObject|GuiObjects`.

GuiBase2d

`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` é uma propriedade de leitura só que fornece a posição da tela de um elemento `Class.GuiBase2d` em pixels.Isso representa a posição real do pixel em que um elemento é renderizado como resultado das dimensões e posições de seus ancestrais.Observe que `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` sempre representa o canto superior esquerdo do elemento `Class.GuiBase2d`.

  Se o `Class.GuiBase2d` estiver em um `Class.ScreenGui`, a propriedade `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` usa o sistema de coordenadas de janela de visualização `Enum.ScreenInsets|CoreUISafeInsets`.A origem deste sistema de coordenadas está localizada no canto inferior esquerdo da barra superior do Roblox.Observe que este é o mesmo sistema de coordenadas usado pela propriedade `Class.InputObject.Position`.

  <img src="/assets/engine-api/classes/GuiBase2d/AbsolutePositionCoordinateSystem.png" width="840" alt="Diagram showing the origin of the AbsolutePosition coordinate system." />

  Veja também `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` e `Class.GuiBase2d.AbsoluteSize|AbsoluteSize`.

GuiBase2d.AbsolutePosition

Descreve a posição real da tela de um elemento `Class.GuiBase2d` , em pixels.

`Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` é uma propriedade de leitura apenas que descreve a rotação real da tela de um elemento `Class.GuiBase2d`, em graus.Ele não faz **não** verificar limites, então seu valor pode não estar na faixa `0` a `360`.

  Veja também `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` e `Class.GuiBase2d.AbsoluteSize|AbsoluteSize`.

GuiBase2d.AbsoluteRotation

Descreve a rotação real da tela de um elemento `Class.GuiBase2d` em graus.

`Class.GuiBase2d.AbsoluteSize|AbsoluteSize` é uma propriedade de leitura apenas que descreve o tamanho real da tela de um elemento `Class.GuiBase2d`, em pixels.

  Veja também `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` e `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation`.

GuiBase2d.AbsoluteSize

Descreve o tamanho real da tela de um elemento `Class.GuiBase2d` , em pixels.

Quando definido para `true` , a localização será aplicada a este `Class.GuiBase2d` e seus descendentes.As entradas usadas para localização são o mesmo conjunto de entradas retornadas por `Class.LocalizationService:GetTableEntries()` .Entradas com `Class.GuiBase2d.AutoLocalize|AutoLocalize` ativado são automaticamente re-traduzidas após o carregamento da tabela na nuvem, se necessário.

  Veja também `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable` .

GuiBase2d.AutoLocalize

Quando definido para `true` , a localização será aplicada a este `Class.GuiBase2d` e seus descendentes.

Essa propriedade é automaticamente definida como verdadeira quando uma tabela de localização  destina este Objetoou um ancestral deste Objeto.  com sua propriedade   apontada para uma instância localizará todos os   que são descendentes da instância raiz.

GuiBase2d.Localize

Definido automaticamente como verdadeiro quando uma tabela de localização `Class.LocalizationTable.Root` aloca este Objetoou um ancestral deste Objeto

Uma referência a um `Class.LocalizationTable` para ser usado para aplicar localização automatizada a este `Class.GuiBase2d` e seus descendentes.`Class.GuiBase2d.AutoLocalize|AutoLocalize` deve ser definido para `true` no `Class.GuiBase2d` e seus ancestrais para que a localização automatizada seja aplicada.

  Você pode definir isso para referenciar um `Class.LocalizationTable` em qualquer lugar do `Class.DataModel`.O objeto `Class.GuiBase2d` e todos os seus filhos tentarão usar esse específico `Class.LocalizationTable` e seus ancestrais para substituição automática de texto antes de usar as tabelas sob `Class.LocalizationService` em uma ordem não definida e a tabela na nuvem.

  Se não houver tradução disponível na tabela referenciada, ela procurará uma tradução no pai dessa tabela, se também for um `Class.LocalizationTable`, e assim por diante.

  Veja também `Class.LocalizationService:GetTableEntries()` que explica como o `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable` é usado para localização automatizada.

GuiBase2d.RootLocalizationTable

Uma referência a um `Class.LocalizationTable` para ser usado para aplicar localização automatizada a este `Class.GuiBase2d` e seus descendentes.

Personaliza o comportamento de seleção de gamepad na direção de baixo.

GuiBase2d.SelectionBehaviorDown

Personaliza o comportamento de seleção do gamepad na direção esquerda.

GuiBase2d.SelectionBehaviorLeft

Personaliza o comportamento de seleção do gamepad na direção certa.

GuiBase2d.SelectionBehaviorRight

Personaliza o comportamento de seleção do gamepad na direção de cima.

GuiBase2d.SelectionBehaviorUp

Permite personalizar como a seleção do gamepad pode se mover entre botões, que são descendentes do grupo de seleção, sair do grupo e selecionar outros botões.

  Configurar `Class.GuiBase2d.SelectionGroup|SelectionGroup` para `true` expor as propriedades `Class.GuiBase2d.SelectionBehaviorUp|SelectionBehaviorUp`, `Class.GuiBase2d.SelectionBehaviorDown|SelectionBehaviorDown`, `Class.GuiBase2d.SelectionBehaviorLeft|SelectionBehaviorLeft` e `Class.GuiBase2d.SelectionBehaviorRight|SelectionBehaviorRight`.Para esses comportamentos de seleção, uma configuração de `Enum.SelectionBehavior.Escape` (padrão) significa que a seleção do gamepad tenta encontrar uma seleção dentro do grupo de seleção e só se move para fora se não encontrar um botão adequado.Alternativamente, uma configuração de `Enum.SelectionBehavior.Stop` significa que a seleção do gamepad só olha dentro do grupo de seleção e não se move fora do grupo a partir da direção do comportamento de seleção.

GuiBase2d.SelectionGroup

Permite a personalização do movimento de seleção do gamepad.

Uma classe abstrata herdada por 2D `Class.GuiObject|GuiObjects` .

GuiBase é uma classe abstrata que a maioria dos objetos de interface gráfica do usuário herda.

GuiBase

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

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.

Este método de objeto retorna um array que contém todos os descendentes desse objeto.Ao contrário de `Class.Instance:GetChildren()`, que retorna apenas os filhos imediatos de um objeto, este método encontra cada filho do objeto, cada filho desses filhos e assim por diante.

Instance:GetDescendants

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

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

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.

This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.

Retorna uma string que descreve a ancestralidade da instância.A string é uma concatenação do `Class.Instance.Name|Name` do objeto e de seus ancestrais, separados por períodos.O `Class.DataModel` ( `game` ) não é considerado.Por exemplo, um `Class.Part` dentro do `Class.Workspace` pode retornar `Class.Workspace.Part` .

  Quando chamado em um `Class.Instance` que não é um descendente do `Class.DataModel` , esta função considera todos os ancestrais até e incluindo o mais antigo sem um `Class.Instance.Parent|Parent` .

  Essa função é útil para registro e depuração.Você não deve tentar analisar a string retornada para qualquer operação útil; esta função não escapa períodos (ou qualquer outro símbolo) em nomes de objetos.Em outras palavras, embora sua saída muitas vezes pareça ser um identificador Luau válido, não é garantida.

Instance:GetFullName

Retorna uma string que descreve a ancestralidade da instância.

Este método retorna o valor estilizado ou explicitamente modificado da propriedade especificada, ou o valor padrão da propriedade se não tiver sido estilizado/modificado.Isso difere ligeiramente de acessar o valor da propriedade diretamente, como `[GuiObject].Rotation`, que retorna o valor padrão ou modificado da propriedade.

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

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

  local coreSheet = ReplicatedStorage:FindFirstChild("CoreSheet")
  local rule = coreSheet:FindFirstChildWhichIsA("StyleRule")
  rule.Selector = "TextButton"

  -- Referência a um botão
  local button = HUDContainer:FindFirstChildWhichIsA("TextButton")

  print(button:GetStyled("Rotation")) --> 0 (valor padrão)
  print(button.Rotation) --> 0 (valor padrão)

  -- Aplicar rotação através da propriedade de regra de estilo
  rule:SetProperty("Rotation", 30)

  print(button:GetStyled("Rotation")) --> 30 (valor estilizado com base em regra)
  print(button.Rotation) --> 0 (valor padrão)

  -- Modificar/substituir propriedade estilizada explicitamente
  button.Rotation = 45

  print(button:GetStyled("Rotation")) --> 45 ( valor modificado )
  print(button.Rotation) --> 45 (modified value)
  ```

Instance:GetStyled

O valor estilizado ou explicitamente modificado da propriedade especificada, ou o valor padrão da propriedade se não tiver sido estilizado/modificado.

Retorna o valor estilizado ou explicitamente modificado da propriedade especificada, ou o valor padrão da propriedade se não tiver sido estilizado/modificado.

Este método retorna um evento que se comporta exatamente como o evento `Class.Instance.StyledPropertiesChanged|StyledPropertiesChanged`, exceto que só é disparado quando a propriedade de estilo dada muda.É geralmente uma boa ideia usar esse método em vez de uma conexão com `Class.Instance.StyledPropertiesChanged|StyledPropertiesChanged` com uma função que verifica o nome da propriedade.Chamadas subsequentes a este método no mesmo objeto com o mesmo nome de propriedade retornam o mesmo evento.

  Observe que este evento não passará nenhum argumento para uma função conectada, portanto, o valor da propriedade modificada deve ser lido diretamente dentro de um script.

  ```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("Style property changed!")
  end

  meterBar:GetStyledPropertyChangedSignal("AnchorPoint"):Connect(stylePropertyChanged)
  ```

Instance:GetStyledPropertyChangedSignal

property

Nome da propriedade de estilo para a qual ouvir alterações.

Evento que dispara quando a propriedade de estilo dada muda.

Este método retorna um array de tags aplicadas à instância dada, como strings.Você pode adicionar tags tanto no Studio na janela [Propriedades](/studio/properties) ou em tempo de execução com `Class.Instance:AddTag()|AddTag()` .

  Este método é útil quando você quer fazer algo com várias etiquetas em uma instância de uma vez.No entanto, é ineficiente usar esse método para verificar a existência de uma única tag; em vez disso, use `Class.Instance:HasTag()|HasTag()` para verificar uma tag específica.

Instance:GetTags

Obtém um array de todas as tags aplicadas à instância.

Este método retorna `true` se a tag fornecida foi adicionada ao objeto.Você pode adicionar tags tanto no Studio na janela [Propriedades](/studio/properties) ou em tempo de execução com `Class.Instance:AddTag()|AddTag()`.

Instance:HasTag

Verifique se a instância tem uma tag dada.

Demonstrates determining if one instance is the ancestor of another using `Class.Instance:IsAncestorOf()`

Workspace and SpawnLocation are ancestors of the SpawnLocation's decal.
Workspace is an ancestor of SpawnLocation.

SpawnLocation and its decal are descendants of Workspace, not ancenstors.
Decal is a descendant to SpawnLocation, not an ancestor.

Retorna verdadeiro se um `Class.Instance` for um ancestral do descrente dado.

  Um `Class.Instance` é considerado o ancestral de um objeto se o objeto de `Class.Instance.Parent` ou um de seus pais de `Class.Instance.Parent` for definido como `Class.Instance`.

  Veja também, `Class.Instance:IsDescendantOf()` .

Instance:IsAncestorOf

Verdadeiro se o `Class.Instance` for um ancestral do descrente dado.

Retorna verdadeiro se um `Class.Instance` for um ancestral do descrente dado.

Retorna `true` se um `Class.Instance` for descendente do ancestral dado.

  Observe que `IsDescendantOf()` não pode ser usado com um parâmetro de `nil` para verificar se um objeto foi removido.

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

Instance:IsDescendantOf

ancestor

Verdadeiro se o `Class.Instance` for um descendente do ancestral dado.

Retorna `true` se um `Class.Instance` for descendente do ancestral dado.

Retorna `true` se o valor armazenado na propriedade especificada for igual ao padrão instanciado pelo código.Por exemplo, se exportar a propriedade `Class.TextLabel.TextSize|TextSize` de um `Class.TextLabel` indicar `8` , então chamar `IsPropertyModified("TextSize")` no rótulo retornará `false` porque `8` é o valor padrão para `Class.TextLabel.TextSize` quando o rótulo é criado via `Instance.new("TextLabel")` em vez de ser inserido através dos fluxos de trabalho de inserção do Studio.

  Observe que se este método retornar , o estilo não afetará a propriedade porque modificar explicitamente uma propriedade tem precedência sobre estilizá-la.

Instance:IsPropertyModified

Booleano indicando se a propriedade foi modificada.

Retorna `true` se o valor armazenado na propriedade especificada for igual ao padrão instanciado por código.

The following code demonstrates how a part can be re-added to the DataModel
after being removed:

Essa função define o `Class.Instance.Parent` do objeto para `nil` e faz o mesmo para todos os seus descendentes.

  Se o objeto for referenciado antes de ser removido, é possível recuperar o objeto em um momento posterior.

Instance:Remove

Define o objeto de `Parent` para `nil` e faz o mesmo para todos os seus descendentes.

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/LayerCollector.yaml

LayerCollector

Resumo

Propriedades

Métodos

Eventos

Propriedades

Enabled

ResetOnSpawn

ZIndexBehavior

Métodos

Eventos