`Class.BillboardGui` es un contenedor para que los objetos de la interfaz de usuario aparezcan en el espacio 3D pero siempre se enfrenten a la cámara.La posición del contenedor es relativa a la posición del padre `Class.BasePart` o `Class.Attachment` (o el `Class.BillboardGui.Adornee|Adornee` ).Para `Class.BasePart|BaseParts` , se utiliza la propiedad `Class.BasePart.Position|Position` , mientras que para `Class.Attachment|Attachments` , se utiliza la propiedad `Class.Attachment.WorldPosition|WorldPosition`.

  <img src="/assets/ui/in-experience/BillboardGui-Diagram.jpg" width="800" alt="BillboardGui with a TextLabel describing the screen console it floats above." />

  La propiedad de una valla publicitaria `Class.BillboardGui.Size|Size` funciona de manera ligeramente diferente a `Class.GuiObject.Size` .Mientras que los componentes de desplazamiento trabajan de la misma manera, los componentes de escala se utilizan como tamaños de perno en el espacio 3D.

  Al crear un tamaño escalado `Class.BillboardGui` que contiene un `Class.TextLabel` , es útil habilitar la propiedad de etiqueta `Class.TextLabel.TextScaled|TextScaled` para que su texto se escalone junto con el lienzo de anuncio a medida que cambia la distancia de la cámara.

  Tenga en cuenta que los elementos de interfaz de usuario interactivos como `Class.ImageButton|ImageButtons` y `Class.TextButton|TextButtons` dentro de un `Class.BillboardGui` solo recibirán la entrada del usuario si se les asigna como padres al `Class.PlayerGui` , generalmente colocando el `Class.BillboardGui` dentro de `Class.StarterGui` .La propiedad `Class.BillboardGui.Adornee|Adornee` se puede usar para dirigir una parte o un accesorio en el mundo 3D mientras el `Class.BillboardGui` mismo permanece en el `Class.PlayerGui` .

  Vea [Interfaz de usuario en experiencia](/ui/in-experience-containers#billboard-ui) para obtener una guía sobre cómo trabajar con `Class.BillboardGui` contenedores.

  ##### Comportamiento de caché

  Para ayudar a mejorar el ejecución, la apariencia de un `Class.BillboardGui` se cacha hasta que ocurra uno de los siguientes, después de lo cual su apariencia se recalculará en el próximo marco de renderizado.

  *   Se agrega o se elimina un descendiente del `Class.BillboardGui`.
  *   Una propiedad de un descendiente de los cambios de `Class.BillboardGui` .
  *   Una propiedad del propio `Class.BillboardGui` cambia.

BillboardGui

Controla si los descendientes recibirán eventos de entrada.Si el `Class.BillboardGui` contiene un `Class.GuiButton` , ese botón solo será clicable si `Class.BillboardGui.Active|Active` está configurado como `true` en ambos `Class.BillboardGui` **y** botón.

  Tenga en cuenta que los elementos de interfaz de usuario interactivos como `Class.ImageButton|ImageButtons` y `Class.TextButton|TextButtons` dentro de un `Class.BillboardGui` solo recibirán la entrada del usuario si se les asigna como padres al `Class.PlayerGui` , generalmente colocando el `Class.BillboardGui` dentro de `Class.StarterGui` .La propiedad `Class.BillboardGui.Adornee|Adornee` se puede usar para dirigir una parte o un accesorio en el mundo 3D mientras el `Class.BillboardGui` mismo permanece en el `Class.PlayerGui` .

BillboardGui.Active

Controla si los descendientes recibirán eventos de entrada.

Establece el objetivo `Class.BasePart` o `Class.Attachment` que el `Class.BillboardGui` está posicionado relativo a, reemplazando la parte o el conexiónpadre.

BillboardGui.Adornee

Establece la pieza o adjunto objetivo a la que se posiciona el `Class.BillboardGui`.

Esta propiedad determina si el `Class.BillboardGui` siempre se renderizará encima de otros objetos 3D.

  Cuando se establece en `false` (predeterminado), el `Class.BillboardGui` se renderiza como otro contenido 3D y se oculta por otros objetos 3D.Cuando se establece en `true` , el `Class.BillboardGui` siempre se renderiza encima del contenido 3D y los cambios de apariencia son significativos:

  *   Los colores coinciden con la forma en que aparecen dentro de un `Class.ScreenGui` .
  *   El texto puede aparecer más nítido en dispositivos de alto DPI.
  *   `Class.BillboardGui.LightInfluence|LightInfluence` se trata como si fuera `0` .
  *   `Class.BillboardGui.Brightness|Brightness` no tiene efecto.

BillboardGui.AlwaysOnTop

Determina si el `Class.BillboardGui` siempre se renderizará encima de otros objetos 3D.

Esta propiedad determina el factor por el cual la luz del contenedor `Class.BillboardGui` se escala cuando `Class.BillboardGui.LightInfluence|LightInfluence` es `0`.Por defecto, esta propiedad es `1` y se puede establecer a cualquier número entre `0` y `1000` .Al modificar esta propiedad, el brillo aparente de un `Class.BillboardGui` puede ser mejor ajustado a su entorno, ambiente.Por instancia, una pantalla de video se puede iluminar dentro de una habitación oscura al aumentar `Class.BillboardGui.Brightness|Brightness` a `10` .

  Tenga en cuenta que `Class.BillboardGui.Brightness|Brightness` no es accesible en Studio y no tiene efecto cuando `Class.BillboardGui.LightInfluence|LightInfluence` es `1` o `Class.BillboardGui.AlwaysOnTop|AlwaysOnTop` es `true` .

BillboardGui.Brightness

Determina el factor por el cual la luz del contenedor `Class.BillboardGui` se escala cuando `Class.BillboardGui.LightInfluence|LightInfluence` es `0` .

Cuando se establece en `true` (predeterminado), las porciones de `Class.GuiObject|GuiObjects` que caigan fuera de los bordes del lienzo de `Class.BillboardGui` no se dibujarán.

  Incluso cuando esta propiedad es `false` , `Class.GuiObject|GuiObjects` que están **completamente** fuera del lienzo no se Renderizar.

BillboardGui.ClipsDescendants

Si se dibujarán partes de `Class.GuiObject|GuiObjects` que estén fuera de los límites del lienzo `Class.BillboardGui`.

La distancia actual en píxeles que el `Class.BillboardGui` está desde la cámara del jugador.Un evento cambiado no se activa para esta propiedad a menos que `Class.BillboardGui.DistanceStep|DistanceStep` sea mayor que `0`.

BillboardGui.CurrentDistance

La distancia actual en píxeles que el `Class.BillboardGui` está desde la cámara del jugador.

Determina la distancia en studs en la que el `Class.BillboardGui` dejará de escalar en tamaño mayor en relación con la cámara actual del jugador, con un valor predeterminado de `0` .Si el `Class.BillboardGui.CurrentDistance|CurrentDistance` de la `Class.BillboardGui` no está por encima de este valor, no se escalará más grande de lo que sería a esta distancia `Class.BillboardGui.DistanceLowerLimit|DistanceLowerLimit`.

BillboardGui.DistanceLowerLimit

Determina la distancia en studs en la que el `Class.BillboardGui` dejará de escalar en tamaño más grande.

Determina los aumentos y disminuciones de tamaño `Class.BillboardGui.CurrentDistance|CurrentDistance` en studs a medida que la cámara del jugador se mueve más cerca y más lejos del `Class.BillboardGui`.La propiedad se restablece a `0` y se redondea a partir de `Class.BillboardGui.DistanceLowerLimit|DistanceLowerLimit` .

BillboardGui.DistanceStep

Determina los aumentos y disminuciones de tamaño `Class.BillboardGui.CurrentDistance|CurrentDistance` en studs a medida que la cámara del jugador se mueve más cerca y más lejos del `Class.BillboardGui`.

Determina la distancia en studs en la que el `Class.BillboardGui` dejará de escalar en tamaño más pequeño en relación con la cámara actual del jugador.Si el `Class.BillboardGui.CurrentDistance|CurrentDistance` de la `Class.BillboardGui` está por encima de este valor, no se reducirá más pequeño de lo que sería a esta distancia `Class.BillboardGui.DistanceUpperLimit|DistanceUpperLimit`.

  Esta propiedad se ignora si el valor es inferior a `0` . El valor predeterminado es `-1` , lo que significa que la propiedad se ignora por defecto.

BillboardGui.DistanceUpperLimit

Determina la distancia en studs en la que el `Class.BillboardGui` dejará de escalar en tamaño más pequeño.

Esta propiedad determina cómo el `Class.BillboardGui` se desplaza de su `Class.BillboardGui.Adornee|Adornee` , con respecto a la orientación `Class.Camera` , en unidades que son la mitad de las dimensiones de la caja delimitadorade contención alineada con el aplicación de modeladode `Class.Camera` .

  Vea también `Class.BillboardGui.StudsOffset|StudsOffset` que funciona de manera similar pero usa unidades de estudio, o `Class.BillboardGui.ExtentsOffsetWorldSpace|ExtentsOffsetWorldSpace` que funciona de manera similar excepto que la orientación de desplazamiento es relativa a los ejes globales.

BillboardGui.ExtentsOffset

Determina cómo el `Class.BillboardGui` se desplaza de su `Class.BillboardGui.Adornee|Adornee` , en relación con la orientación `Class.Camera` , en unidades que son la mitad de las dimensiones de la caja delimitadorade contención alineada de aplicación de modelado`Class.Camera`.

Esta propiedad determina cómo el `Class.BillboardGui` se desplaza de su `Class.BillboardGui.Adornee|Adornee` , con respecto a los ejes globales, en unidades de mitad de las dimensiones de la caja delimitadorade contención alineada con el eje del aplicación de modelado.

  Vea también `Class.BillboardGui.StudsOffset|StudsOffset` que funciona de manera similar pero usa unidades de estudio, o `Class.BillboardGui.ExtentsOffset|ExtentsOffset` que funciona de manera similar excepto que la orientación de desplazamiento es relativa al `Class.Camera`.

BillboardGui.ExtentsOffsetWorldSpace

Determina cómo el `Class.BillboardGui` se desplaza de su `Class.BillboardGui.Adornee|Adornee` , en relación con los ejes globales, en unidades de mitad de las dimensiones del caja delimitadoraalineado con el eje del aplicación de modelado.

Controla cuánto el `Class.BillboardGui` es influenciado por la iluminación ambiental, en un rango de `0` a `1` .Establecer esto en `1` significa que la iluminación circundante tiene control completo sobre la aspecto, look, mientras que establecerlo en `0` significa que la iluminación no tiene efecto.

BillboardGui.LightInfluence

Controla cuánto el `Class.BillboardGui` es influenciado por la iluminación ambiental.

Esta propiedad controla qué tan lejos de la cámara se mostrará el `Class.BillboardGui` antes de que deje de renderizar.Un valor de `0` o `inf` (predeterminado) significa que no hay límite y se renderizará infinitamente lejos.

  Para `Class.BillboardGui|BillboardGuis` que aparecen al aire libre, se recomienda que `Class.BillboardGui.MaxDistance|MaxDistance` sea lo suficientemente alto como para garantizar que la interfaz de usuario del contenedor sea lo suficientemente pequeña en la pantalla cuando aparece o desaparece, minimizando el efecto de aparición repentina/desaparición.

BillboardGui.MaxDistance

Controla qué tan lejos se puede mostrar el `Class.BillboardGui` antes de que se detenga el renderizado.

Utilizado por los scripts para ocultar el `Class.BillboardGui` de un jugador específico.

  Para ocultar un `Class.BillboardGui` de más de un jugador, colócalo en `Class.StarterGui` y usa un script para establecer la propiedad `Class.BillboardGui.Enabled|Enabled` de acuerdo con si el `Class.Players.LocalPlayer|LocalPlayer` debería poder verla.La propiedad `Class.BillboardGui.Adornee|Adornee` se puede usar para unir el `Class.BillboardGui` a un `Class.BasePart` o `Class.Attachment` en el `Class.Workspace` , en lugar de criarlo.

BillboardGui.PlayerToHideFrom

Utilizado por los scripts para ocultar el `Class.BillboardGui` de un jugador específico.

Controla el tamaño que el `Class.BillboardGui` tendrá en la pantalla.A diferencia de , los componentes de escala de este conjunto de propiedades establecen el tamaño de los estudios de la valla publicitaria en el espacio 3D.

BillboardGui.Size

Controla el tamaño que el `Class.BillboardGui` tendrá en la pantalla.

Un desplazamiento de 2D en unidades relativas a tamaño que actúa como un punto de anclaje.Esto se puede usar de manera similar a la propiedad `Class.GuiObject.AnchorPoint`, pero los valores son diferentes.

  <table size="small">
    <thead>
      <th>Desplazamiento de tamaño</th><th>Explicación</th>
    </thead>

    <tbody>
      <tr>
        <td><code>0, 0</code></td>

        <td>El predeterminado en el que la interfaz se anclará en su centro.</td>
      </tr>

      <tr>
        <td><code>0.5, 0.5</code></td>

        <td>La interfaz se anclará en la parte inferior izquierda.</td>
      </tr>

      <tr>
        <td><code>0.5, -0.5</code></td>

        <td>La interfaz se anclará en la parte superior izquierda.</td>
      </tr>

      <tr>
        <td><code>-0.5, 0.5</code></td>

        <td>La interfaz se anclará en la parte superior derecha.</td>
      </tr>

      <tr>
        <td><code>-0.5, -0.5</code></td>

        <td>La interfaz se anclará en la parte inferior derecha.</td>
      </tr>
    </tbody>
  </table>

  Vea también `Class.BillboardGui.StudsOffset|StudsOffset` , `Class.BillboardGui.StudsOffsetWorldSpace|StudsOffsetWorldSpace` , `Class.BillboardGui.ExtentsOffset|ExtentsOffset` , y `Class.BillboardGui.ExtentsOffsetWorldSpace|ExtentsOffsetWorldSpace` que son propiedades desplazadas que funcionan en el espacio 3D en lugar de eso.

BillboardGui.SizeOffset

Un desplazamiento de 2D en unidades relativas a tamaño que actúa como un punto de anclaje.

Esta propiedad determina cómo el `Class.BillboardGui` se desplaza de su `Class.BillboardGui.Adornee|Adornee` en studs, en relación con la orientación `Class.Camera`.

  Vea también `Class.BillboardGui.StudsOffsetWorldSpace|StudsOffsetWorldSpace` que funciona de manera similar excepto que la orientación de desplazamiento es relativa a los ejes globales.

BillboardGui.StudsOffset

Determina cómo el `Class.BillboardGui` se desplaza de su `Class.BillboardGui.Adornee|Adornee` en studs, en relación con la orientación `Class.Camera`.

Esta propiedad determina cómo se desplaza el `Class.BillboardGui` de su `Class.BillboardGui.Adornee|Adornee` en studs, en relación con los ejes globales.

  Vea también `Class.BillboardGui.StudsOffset|StudsOffset` que funciona de manera similar excepto que la orientación de desplazamiento es relativa al `Class.Camera`.

BillboardGui.StudsOffsetWorldSpace

Determina cómo se desplaza el `Class.BillboardGui` de su `Class.BillboardGui.Adornee|Adornee` en studs, en relación con los ejes globales.

Un contenedor para `Class.GuiObject|GuiObjects` que se renderiza en el espacio 3D frente a la cámara.

**LayerCollector** es la clase base de contenedores de interfaz de usuario de 2D que renderizan descendientes `Class.GuiObject`, como `Class.ScreenGui`.

  Para mejoras de rendimiento, la apariencia de un `Class.LayerCollector` se cacha hasta que ocurra uno de los siguientes eventos:

  *   Se agrega o se elimina un descendiente de él.
  *   Una propiedad de un descendiente cambia.
  *   Una propiedad del propio `Class.LayerCollector` cambia.

LayerCollector:GetLayoutNodeTree

LayerCollector

Alterna la visibilidad de este `Class.LayerCollector` . Cuando `false` , el contenido de la interfaz de usuario no se Renderizar, procesará la entrada del usuario o se actualizará en respuesta a cambios.

LayerCollector.Enabled

Alterna la visibilidad de este `Class.LayerCollector` .

Cuando se establece en `false` y este `Class.LayerCollector` es un hijo directo de `Class.StarterGui` , solo se clonará en el jugador `Class.PlayerGui` una vez y no se eliminará cuando el personaje del jugador reaparezca.

  Cuando se establece en `true` (predeterminado), o si este `Class.LayerCollector` es un descendiente indirecto de **** de `Class.StarterGui` , se clonará en cada jugador `Class.PlayerGui` cuando su personaje reaparezca, y se borrará cuando el personaje del jugador reaparezca de nuevo

LayerCollector.ResetOnSpawn

Determina si los `Class.LayerCollector` reinicios (se elimina a sí mismo y se reclona en el personaje del jugador `Class.PlayerGui`) cada vez que el personaje del jugador reaparece.

Controla cómo `Class.GuiObject.ZIndex` se comporta en todos los descendientes de este `Class.LayerCollector` .

  Con `Enum.ZIndexBehavior.Sibling` (predeterminado), los hijos siempre se renderizan por encima de sus padres, y el `Class.GuiObject.ZIndex|ZIndex` se usa para decidir el orden en que los hijos de un solo objeto de interfaz de usuario se renderizarán el uno sobre el otro.

  `Enum.ZIndexBehavior.Global` ordena todos los descendientes según el `Class.GuiObject.ZIndex|ZIndex`, luego rompe los lazos usando el orden de la jerarquía.Como resultado, los descendientes de un `Class.GuiObject` necesitan tener un valor `Class.GuiObject.ZIndex|ZIndex` que sea al menos tan alto como el padre, o se renderizarán debajo de su padre.

LayerCollector.ZIndexBehavior

Controla cómo `Class.GuiObject.ZIndex` se comporta en todos los descendientes de este `Class.LayerCollector` .

La clase base de contenedores de interfaz de usuario 2D que renderizan `Class.GuiObject|GuiObjects` en capas.

`Class.GuiBase2d` es una clase abstracta heredada por 2D `Class.GuiObject|GuiObjects` .

Este evento se activa cuando la selección del gamepad se mueve, se queda o cambia dentro del conectado `Class.GuiBase2d` o cualquier descendiente `Class.GuiObject|GuiObjects` .Cuando el resaltado de la selección se mueve a un , las burbujas de evento se informan de que la selección ha cambiado/ingresado/salido a un en su árbol descendente.

GuiBase2d.SelectionChanged

amISelected

Verdadero si la nueva selección coincide con el GuiBase2d adjunto.

previousSelection

newSelection

Se enciende cuando la selección del gamepad se mueve a, deja o cambia dentro del conectado `Class.GuiBase2d` o cualquier descendiente `Class.GuiObject|GuiObjects` .

GuiBase2d

`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` es una propiedad de solo lectura que proporciona la posición de la pantalla de un elemento `Class.GuiBase2d` en píxeles.Esto representa la posición de píxel real en la que un elemento se renderiza como resultado de las dimensiones y posiciones de sus ancestros.Tenga en cuenta que `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` siempre representa la esquina superior izquierda del elemento `Class.GuiBase2d`.

  Si el `Class.GuiBase2d` está en un `Class.ScreenGui` , la propiedad `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` usa el sistema de coordenadas de la ventana de visualización `Enum.ScreenInsets|CoreUISafeInsets`.El origen de este sistema de coordenadas se encuentra en la esquina inferior izquierda de la barra superior de Roblox.Tenga en cuenta que este es el mismo sistema de coordenadas utilizado por la propiedad `Class.InputObject.Position`.

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

  Vea también `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` y `Class.GuiBase2d.AbsoluteSize|AbsoluteSize` .

GuiBase2d.AbsolutePosition

Describe la posición actual de la pantalla de un elemento `Class.GuiBase2d` , en píxeles.

`Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` es una propiedad de solo lectura que describe la rotación real de la pantalla de un elemento `Class.GuiBase2d` en grados.No realiza **comprobación de límites** , por lo que su valor puede no estar en el rango `0` a `360`.

  Vea también `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` y `Class.GuiBase2d.AbsoluteSize|AbsoluteSize` .

GuiBase2d.AbsoluteRotation

Describe la rotación de la pantalla actual de un elemento `Class.GuiBase2d` en grados.

`Class.GuiBase2d.AbsoluteSize|AbsoluteSize` es una propiedad de solo lectura que describe el tamaño real de la pantalla de un elemento `Class.GuiBase2d` , en píxeles.

  Vea también `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` y `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` .

GuiBase2d.AbsoluteSize

Describe el tamaño de la pantalla actual de un elemento `Class.GuiBase2d` , en píxeles.

Cuando se establece en `true`, la localización se aplicará a este `Class.GuiBase2d` y a sus descendientes.Las entradas utilizadas para la localización son el mismo conjunto de entradas devueltas por `Class.LocalizationService:GetTableEntries()` .Las entradas con `Class.GuiBase2d.AutoLocalize|AutoLocalize` habilitadas se traducen automáticamente después de que la tabla de la nube se cargue si es necesario.

  Vea también `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable` .

GuiBase2d.AutoLocalize

Cuando se establece en `true`, la localización se aplicará a este `Class.GuiBase2d` y a sus descendientes.

Esta propiedad se establece automáticamente en verdad cuando una tabla de localización apunta a este objeto, o a un ancestro de este objeto. `Class.LocalizationTable|LocalizationTables` con su propiedad `Class.LocalizationTable.Root` apuntando a una instancia se localizará todo `Class.TextLabel.TextButton` que son descendientes de la instancia raíz.

GuiBase2d.Localize

Se establece automáticamente en verdad cuando una tabla de localización apunta a este objeto, o a un ancestro de este objeto.

Una referencia a un `Class.LocalizationTable` para usar para aplicar localización automatizada a este `Class.GuiBase2d` y sus descendientes. `Class.GuiBase2d.AutoLocalize|AutoLocalize` debe establecerse en `true` en el `Class.GuiBase2d` y sus ancestros para que se aplique la localización automatizada.

  Puedes establecer esto para referenciar un `Class.LocalizationTable` en cualquier lugar del `Class.DataModel`.El objeto `Class.GuiBase2d` y todos sus hijos intentarán usar ese específico `Class.LocalizationTable` y sus ancestros para la sustitución de texto automática antes de usar las tablas bajo `Class.LocalizationService` en un orden no definido y la tabla de la nube.

  Si no hay una traducción disponible en la tabla referenciada, buscará una traducción en el padre de esa tabla, si también es un `Class.LocalizationTable` , y así sucesivamente.

  Vea también `Class.LocalizationService:GetTableEntries()` que explica cómo se usa el `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable` para la localización automatizada.

GuiBase2d.RootLocalizationTable

Una referencia a un `Class.LocalizationTable` para usar para aplicar localización automatizada a este `Class.GuiBase2d` y sus descendientes.

Personaliza el comportamiento de selección del gamepad en la dirección de abajo.

GuiBase2d.SelectionBehaviorDown

Personaliza el comportamiento de selección del gamepad en la dirección izquierda.

GuiBase2d.SelectionBehaviorLeft

Personaliza el comportamiento de selección del gamepad en la dirección correcta.

GuiBase2d.SelectionBehaviorRight

Personaliza el comportamiento de selección del gamepad en la dirección de arriba.

GuiBase2d.SelectionBehaviorUp

Permite la personalización de cómo la selección del gamepad puede moverse entre botones, que son descendientes del grupo de selección, salir del grupo y seleccionar otros botones.

  Configurar `Class.GuiBase2d.SelectionGroup|SelectionGroup` a `true` expondrá las propiedades `Class.GuiBase2d.SelectionBehaviorUp|SelectionBehaviorUp`, `Class.GuiBase2d.SelectionBehaviorDown|SelectionBehaviorDown`, `Class.GuiBase2d.SelectionBehaviorLeft|SelectionBehaviorLeft` y `Class.GuiBase2d.SelectionBehaviorRight|SelectionBehaviorRight`.Para estos comportamientos de selección, una configuración de `Enum.SelectionBehavior.Escape` (predeterminada) significa que la selección del gamepad intenta encontrar una selección dentro del grupo de selección y solo se mueve fuera si no encuentra un botón adecuado.Alternativamente, una configuración de `Enum.SelectionBehavior.Stop` significa que la selección del gamepad solo se ve dentro del grupo de selección y no se mueve fuera del grupo desde la dirección de comportamiento de selección.

GuiBase2d.SelectionGroup

Permite la personalización del movimiento de selección del gamepad.

Una clase abstracta heredada por 2D `Class.GuiObject|GuiObjects` .

GuiBase es una clase abstracta de la que la mayoría de los objetos de interfaz gráfica heredan.

GuiBase

`Instance` es la clase base para todas las clases en la jerarquía de clases de Roblox que pueden formar parte del árbol `Class.DataModel`.

  No es posible crear directamente objetos raíz `Instance` , pero el constructor especial `Datatype.Instance.new()` crea objetos a través de código, tomando el nombre de la clase como parámetro y devolviendo el objeto creado.

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.

Se incendia cuando la propiedad `Class.Instance.Parent` de la objeto o una de sus ancestros cambia.

  Este evento incluye dos parámetros: `child` se refiere al `Class.Instance` cuyo `Class.Instance.Parent` realmente se cambió, mientras que `parent` se refiere al nuevo `Class.Instance.Parent` de esta instancia.

  Puedes usar este evento para rastrear la eliminación de una instancia en Studio, como la eliminación manual en el Explorador o a través de un plugin.Si necesita detectar cuando se destruye una instancia usando `Class.Instance:Destroy()` , use el evento `Class.Instance.Destroying` en su lugar.

Instance.AncestryChanged

child

El `Class.Instance` cuyo `Class.Instance.Parent` ha sido cambiado.

parent

El nuevo `Class.Instance.Parent` de la `Class.Instance` cuyo `Class.Instance.Parent` se cambió.

Se incendia cuando la propiedad `Class.Instance.Parent` de la objeto o una de sus ancestros cambia.

Este evento se activa cada vez que se cambia cualquier atributo en la instancia, incluido cuando un atributo se establece en `nil`.El nombre del atributo cambiado se pasa a la función conectada.

  Por ejemplo, el siguiente fragmento de código conecta la función `attributeChanged()` a disparar cada vez que cambia uno de los atributos de la parte:

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

  local part = Workspace.Part

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

  part.AttributeChanged:Connect(attributeChanged)
  ```

  Vea también `Class.Instance:GetAttributeChangedSignal()` que devuelve un evento que se activa cuando un atributo específico cambia.

Instance.AttributeChanged

attribute

El nombre del atributo que se ha cambiado.

Se enciende cada vez que se cambia un atributo en el `Class.Instance`.

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

Se produce fuegos después de que un objeto sea padre de este `Class.Instance` .

  Tenga en cuenta, al usar esta función en un cliente para detectar objetos creados por el servidor, es necesario usar `Class.Instance:WaitForChild()` al indexar los descendientes de estos objetos.Esto se debe a que el objeto y sus descendientes no se garantizan de replicarse simultáneamente desde el servidor al cliente.Por ejemplo:

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

  Nota, esta función solo funciona para los hijos inmediatos del `Class.Instance` . Para una función que captura todos los descendientes, use `Class.Instance.DescendantAdded` .

  Vea también `Class.Instance.ChildRemoved` .

Instance.ChildAdded

Se produce fuegos después de que un objeto sea padre de este `Class.Instance` .

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

Se produce fuegos después de que se elimine a un niño de este `Class.Instance` .

  Removed se refiere a cuando el padre de un objeto se cambia de este `Class.Instance` a algo diferente a esto `Class.Instance` .Nota, este evento también se disparará cuando se destruya un niño (usando `Class.Instance:Destroy()` ) ya que la función de destrucción establece al padre de un objeto en `nil` .

  Esta función solo funciona para los hijos inmediatos del `Class.Instance` . Para una función que capture a todos los descendientes, use `Class.Instance.DescendantRemoving` .

  Vea también `Class.Instance.ChildAdded` .

Instance.ChildRemoved

Se produce fuegos después de que se elimine a un niño de este `Class.Instance` .

This following example will print the name of any object that is added to the
Workspace:

Este evento se activa después de que se agregue un descendiente a la `Class.Instance`.

  Al disparar por cada descendiente, hacer padre de un objeto al `Class.Instance` disparará el evento para este objeto y todos sus descendientes individualmente.

  Si solo te preocupas por los hijos directos del , usa en su lugar.

  Vea también `Class.Instance.DescendantRemoving` .

Instance.DescendantAdded

descendant

Se produce fuegos después de que se agregue un descendiente al `Class.Instance`.

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

Este evento se activa **inmediatamente antes de** que el padre `Class.Instance` cambie tal que una instancia **descendiente** ya no sea descendiente. `Class.Instance:Destroy()|Destroy()` cambia el `Class.Instance.Parent|Parent` de una instancia a `nil`, por lo que llamar ese método a un descendiente del padre hará que se active este evento.

  Dado que este evento dispara **antes de** la eliminación del descendiente, el padre del descendente se mantendrá sin cambios al momento de disparo de este evento.Si el descendiente es también un **niño directo** del padre, este evento se disparará antes de `Class.Instance.ChildRemoved` .

  Si un descendiente tiene hijos, este evento se activa con el descendiente primero, seguido de sus descendientes.

  ##### Advertencia

  Este evento se dispara con el objeto descendente que se está eliminando.Intentar establecer el `Class.Instance.Parent|Parent` del descendente a algo más fallará.A continuación se muestra un ejemplo que demuestra esto:

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

  Vea también `Class.Instance.DescendantAdded|DescendantAdded` .

Instance.DescendantRemoving

El `Class.Instance` que se está eliminando.

Se incendia inmediatamente antes de que se elimine un descendiente del `Class.Instance` se elimine.

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.

El `Class.Instance` nunca se eliminará de la memoria mientras una función conectada aún lo esté utilizando.Sin embargo, si la función se rinde en cualquier punto, los `Class.Instance` y sus descendientes serán padres de `nil` .

  Si la propiedad `Class.Workspace.SignalBehavior` se establece en `Enum.SignalBehavior.Immediate`, este evento se activa inmediatamente antes de que se destruya `Class.Instance` o uno de sus ancestros con `Class.Instance:Destroy()` .

  Si la propiedad `Class.Workspace.SignalBehavior` se establece en `Enum.SignalBehavior.Deferred`, este evento se activa en el siguiente punto de reanudación, que será después de que se destruya el `Class.Instance` o uno de sus ancestros con `Class.Instance:Destroy()`.

  Con el comportamiento `Enum.SignalBehavior.Deferred|Deferred`, conectar un script a su propio evento `Class.Instance.Destroying` es problemático, ya que el script se destruirá antes de que se pueda llamar la llamada de devolución (lo que significa que no se ejecutará).

  Al eliminar un `Class.Instance` en Studio, como eliminar manualmente a través del [Explorador](/studio/explorer) o a través de un plugin, el `Class.Instance` no se destruye.En cambio, el padre se establece en `nil` que puedes rastrear con `Class.Instance.AncestryChanged` .

Instance.Destroying

Se incendia inmediatamente antes (o se retrasa hasta después) de que la instancia se destruya a través de `Class.Instance:Destroy()` .

Este evento se activa cada vez que se cambia cualquier propiedad de estilo en la instancia, incluida cuando una propiedad se establece en `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

Se activa cada vez que se cambia cualquier propiedad de estilo en la instancia, incluida cuando una propiedad se establece en `nil`.

Instance.childAdded

Este método aplica una etiqueta a la instancia, sin efecto si la etiqueta ya se aplica.Añadir con éxito una etiqueta disparará una señal creada por `Class.CollectionService:GetInstanceAddedSignal()` con la etiqueta dada.

  ##### Advertencias

  *   Las etiquetas de una instancia que se agregaron en el lado del cliente se eliminarán si el servidor luego agrega o elimina una etiqueta en esa instancia porque el servidor replica todas las etiquetas juntas y reemplaza etiquetas anteriores.

  *   Cuando se etiqueta una instancia, es común que se utilicen algunos recursos para darle al etiqueta su funcionalidad, por ejemplo conexiones de eventos o tablas.Para evitar fugas de memoria, es una buena idea limpiarlas (desconectarse, establecer en `nil` , etc.) cuando ya no se necesitan para una etiqueta.Haz esto al llamar `Class.Instance:RemoveTag()` , llamar `Class.Instance:Destroy()` o en una función conectada a una señal devuelta por `Class.CollectionService:GetInstanceRemovedSignal()` .

Instance:AddTag

Esta función destruye todos los hijos y descendientes de una instancia.

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

  Si no desea destruir **todos** los hijos e hijos, use `Class.Instance:GetChildren()` o `Class.Instance:GetDescendants()` para recorrer esos hijos/descendientes y seleccionar qué destruir.Por ejemplo, el siguiente ejemplo de código destruirá todos los `Class.BasePart|BaseParts` descendientes de un `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

Esta función destruye todos los hijos de una instancia.

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

`Clone()` crea una copia de una instancia y todos sus descendientes, ignorando todas las instancias que no sean `Class.Instance.Archivable|Archivable`.Se devuelve una copia de la instancia raíz por este método y su `Class.Instance.Parent|Parent` se establece en `nil` .Tenga en cuenta que si la instancia misma tiene `Class.Instance.Archivable|Archivable` establecido a `false` , esta función devolverá `nil` .

  Si una propiedad de referencia como `Class.ObjectValue.Value` se establece en una instancia clonada, el valor de la propiedad de la copia depende del valor de la propiedad original:

  *   Si una propiedad de referencia se refiere a una instancia que también fue **clonada** , la copia se referirá a la copia.
  *   Si una propiedad de referencia se refiere a un objeto que no fue **clonado** , el mismo valor se mantiene en la copia.

Instance:Clone

Crea una copia de una instancia y todos sus descendientes, ignorando las instancias que no sean `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.

Establece la propiedad `Class.Instance.Parent` a `nil`, bloquea la propiedad `Class.Instance.Parent` y desconecta todas las conexiones, y llama `Destroy()` a todos los hijos.Esta función es la manera correcta de deshacerse de objetos que ya no son necesarios.

  Deshacerse de objetos no necesarios es importante, ya que los objetos y conexiones innecesarios en un lugar agotan la memoria que puede conducir a problemas de rendimiento serios con el tiempo.

  Como mejor práctica después de llamar `Destroy()` a un objeto, establece cualquier variable que haga referencia al objeto (o sus descendientes) a `nil`.Esto impide que tu código acceda a cualquier cosa que tenga que ver con el objeto.

  ```lua
  local part = Instance.new("Part")
  part.Name = "Hello, world"
  part:Destroy()
  -- No haga esto:
  print(part.Name)  --> "Hola, mundo"
  -- Haz esto para evitar que la línea anterior funcione:
  part = nil
  ```

  Una vez que un `Class.Instance` se ha destruido por este método, no se puede volver a usar porque la propiedad `Class.Instance.Parent` está bloqueada.Para **temporalmente** eliminar un objeto en lugar de destruirlo, establece `Class.Instance.Parent|Parent` a `nil` .Por ejemplo:

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

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

  Para destruir un objeto después de una cantidad determinada de tiempo, usa `Class.Debris:AddItem()` .

Instance:Destroy

Establece la propiedad `Class.Instance.Parent` a `nil`, bloquea la propiedad `Class.Instance.Parent` y desconecta todas las conexiones, y llama `Destroy()` a todos los hijos.

Devuelve al primer ancestro del `Class.Instance` cuyo `Class.Instance.Name` es igual al nombre dado.

  Esta función trabaja hacia arriba, lo que significa que comienza en el inmediato `Class.Instance.Parent` de la instancia y trabaja hacia el `Class.DataModel` .Si no se encuentra un ancestro coincidente, devuelve `nil` .

  El siguiente fragmento de código encontraría al primer ancestro del objeto llamado `Car` .

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

  Para las variantes de esta función que encuentran ancestros de una clase específica, consulte `Class.Instance:FindFirstAncestorOfClass()` y `Class.Instance:FindFirstAncestorWhichIsA()` .

Instance:FindFirstAncestor

name

El `Class.Instance.Name` que hay que buscar.

Devuelve al primer ancestro del `Class.Instance` cuyo `Class.Instance.Name` es igual al nombre dado.

Devuelve al primer ancestro del `Class.Instance` cuyo `Class.Object.ClassName` es igual a la clase dada.

  Esta función trabaja hacia arriba, lo que significa que comienza en el inmediato `Class.Instance.Parent` de la instancia y trabaja hacia el `Class.DataModel` .Si no se encuentra un ancestro coincidente, devuelve `nil` .

  Un uso común de esta función es encontrar el `Class.Model` a `Class.BasePart` pertenece. Por ejemplo:

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

  Esta función es una variante de `Class.Instance:FindFirstAncestor()` que comprueba la propiedad `Class.Object.ClassName` en lugar de `Class.Instance.Name`.`Class.Instance:FindFirstAncestorWhichIsA()` también existe, usando el método `Class.Object:IsA()` en lugar de respetar la herencia de clase.

Instance:FindFirstAncestorOfClass

className

El `Class.Object.ClassName` que hay que buscar.

Devuelve al primer ancestro del `Class.Instance` cuyo `Class.Object.ClassName` es igual a la clase dada.

Devuelve al primer ancestro del `Class.Instance` para el que `Class.Object:IsA()` devuelve verdadero para la clase dada.

  Esta función trabaja hacia arriba, lo que significa que comienza en el inmediato `Class.Instance.Parent` de la instancia y trabaja hacia el `Class.DataModel` .Si no se encuentra un ancestro coincidente, devuelve `nil` .

  A diferencia de `Class.Instance:FindFirstAncestorOfClass()`, esta función usa `Class.Object:IsA()` que respeta la herencia de clase. Por ejemplo:

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

  Por lo tanto, el siguiente ejemplo de código devolverá al primer ancestro `Class.BasePart` , independientemente de si es un `Class.WedgePart` , `Class.MeshPart` o `Class.Part`.

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

  Vea también `Class.Instance:FindFirstAncestor()` .

Instance:FindFirstAncestorWhichIsA

Devuelve al primer ancestro del `Class.Instance` para el que `Class.Object:IsA()` devuelve verdadero para la clase dada.

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".

Devuelve el primer hijo del `Class.Instance` con el nombre dado, o `nil` si no existe tal hijo.Si el argumento opcional `recursive` es `true`, esta función busca todos los descendientes en lugar de solo los hijos inmediatos del `Class.Instance`.

  ##### Comprobación de la existencia de un objeto

  `FindFirstChild()` es necesario si necesitas verificar que un objeto exista antes de continuar.Intentar indexar a un hijo por su nombre usando el operador punto arroja un error si el hijo no existe.

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

  -- Los siguientes errores de línea ocurren si la parte no existe en el espacio de trabajo
  Workspace.Part.Transparency = 0.5
  ```

  Un enfoque mejor es usar `FindFirstChild()` para primero verificar `Part` , luego usar una declaración `if` para ejecutar código que lo necesita.

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

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

  ##### Encontrar un niño cuyo nombre coincida con una propiedad

  A veces el `Class.Instance.Name|Name` de un objeto es igual al de una propiedad de su `Class.Instance.Parent|Parent` .Al usar el operador de punto, las propiedades tienen prioridad sobre los hijos si comparten un nombre.

  En el siguiente ejemplo, se agrega un `Class.Folder` llamado `Color` a un `Class.Part` , que también tiene la propiedad `Class.Part.Color`.Observe que `part.Color` se refiere al valor de la propiedad `Datatype.Color3` , no a la instancia hija `Class.Folder`.Una ventaja de usar `Class.Instance:FindFirstChild()|FindFirstChild()` es que la introducción de nuevas propiedades no impone un riesgo en tu código.

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

  ##### Notas de rendimiento

  `Class.Instance:FindFirstChild()|FindFirstChild()` toma aproximadamente un 20% más de tiempo que usar el operador de punto y casi 8 veces más tiempo que simplemente almacenar una referencia a un objeto.Por lo tanto, debe evitar llamarlo en código dependiente del rendimiento, como en bucles estrechos o funciones conectadas a `Class.RunService.Heartbeat` y `Class.RunService.PreRender` .En cambio, almacene el resultado en una variable, o considere usar `Class.Instance.ChildAdded|ChildAdded` o `Class.Instance:WaitForChild()|WaitForChild()` para detectar cuando un hijo de un nombre dado se vuelve disponible.

Instance:FindFirstChild

recursive

Si debe o no llevarse a cabo la búsqueda recursivamente.

Devuelve el primer hijo del `Class.Instance` encontrado con el nombre dado.

Devuelve el primer hijo del `Class.Instance` cuyo `Class.Object.ClassName|ClassName` es igual al dado `className` .A diferencia de `Class.Instance:FindFirstChildWhichIsA()`, esta función solo devuelve objetos cuya clase coincida con `className`, ignorando la herencia de clases.Si no se encuentra un niño coincidente, esta función devuelve `nil` .

Instance:FindFirstChildOfClass

Devuelve el primer hijo del `Class.Instance` cuyo `Class.Object.ClassName|ClassName` es igual al nombre de clase dado.

Devuelve el primer hijo del `Class.Instance` para quien `Class.Object:IsA()` devuelve verdadero para la clase dada.

  Si no se encuentra un niño coincidente, esta función devuelve `nil` .Si el argumento recursivo opcional es verdadero, esta función busca todos los descendientes en lugar de solo los hijos inmediatos del `Class.Instance` .

  A diferencia de `Class.Instance:FindFirstChildOfClass()`, esta función usa `Class.Object:IsA()` que respeta la herencia de clase. Por ejemplo:

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

  Por lo tanto, el siguiente ejemplo de código devolverá el primer `Class.BasePart` hijo, independientemente de si es un `Class.WedgePart` , `Class.MeshPart` o `Class.Part` .

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

  Los desarrolladores que buscan un niño por nombre deberían usar `Class.Instance:FindFirstChild()` en su lugar.

Instance:FindFirstChildWhichIsA

Devuelve el primer hijo del `Class.Instance` para quien `Class.Object:IsA()` devuelve verdadero para la clase dada.

Devuelve al primer descendiente encontrado con el dado `Class.Instance.Name` .

  Este método está deshabilitado y no se puede usar.Para encontrar el primer descendiente de una instancia, considere usar el parámetro `recursive` en `Class.Instance:FindFirstChild()` en lugar.

Instance:FindFirstDescendant

Devuelve al primer descendiente encontrado con el dado `Class.Instance.Name` .

Si el `Class.Instance` es un `Class.Actor` , se devuelve el `Class.Actor` mismo.De lo contrario, se devuelve su ancestro más cercano `Class.Actor` .Si ningún ancestro es un `Class.Actor` , el resultado es `nil` .

Instance:GetActor

Devuelve el `Class.Actor` asociado con la Instancia, si hay alguno.

Este método devuelve el valor que se ha asignado al nombre del atributo dado. Si no se ha asignado ningún atributo, se devuelve `nil`.

  Por ejemplo, el siguiente fragmento de código establece y luego obtiene el valor del atributo `InitialPosition` de la instancia:

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

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

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

  ##### Ver también

  *   `Class.Instance:SetAttribute()` que establece el atributo con el nombre dado al valor dado.
  *   `Class.Instance:GetAttributes()` que devuelve un diccionario de pares clave-valor para cada uno de los atributos de la instancia.

Instance:GetAttribute

El nombre del atributo que se está recuperando.

El valor que se ha asignado al nombre del atributo dado. Si no se ha asignado ningún atributo, se devuelve `nil`.

Devuelve el valor que se ha asignado al nombre de atributo dado.

Instance

`Instance` es la clase base para todas las clases en la jerarquía de clases de Roblox que pueden formar parte del árbol `Class.DataModel`.

/reference/engine/classes/BillboardGui.yaml

BillboardGui

Resumen

Propiedades

Métodos

Eventos

Propiedades

Active

Adornee

AlwaysOnTop

Brightness

ClipsDescendants

CurrentDistance

DistanceLowerLimit

DistanceStep

DistanceUpperLimit

ExtentsOffset

ExtentsOffsetWorldSpace

LightInfluence

MaxDistance

PlayerToHideFrom

Size

SizeOffset

StudsOffset

StudsOffsetWorldSpace

Métodos

Eventos