BillboardGui

Mostrar obsoleto

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

BillboardGui é um contêiner para objetos de UI aparecerem no espaço 3D, mas sempre enfrentem a Câmera.A posição do contêiner é relativa ao pai BasePart ou Attachment (ou ao Adornee ).Para BaseParts , a propriedade Position é usada, enquanto para Attachments , a propriedade WorldPosition é usada.

BillboardGui with a TextLabel describing the screen console it floats above.

A propriedade de uma bilboard Size funciona de forma ligeiramente diferente de GuiObject.Size.Enquanto os componentes de deslocamento são os mesmos, os componentes de escala são usados como tamanhos de estaca no espaço 3D.

Ao criar um tamanho escalonado BillboardGui que contém um TextLabel , é útil habilitar a propriedade de rótulo TextScaled para que seu texto aumente ao longo da janela de exibição à medida que a distância da câmera muda.

Observe que elementos de interface interativa como ImageButtons e TextButtons dentro de um BillboardGui só receberão a entrada do usuário se forem parentados ao PlayerGui, geralmente colocando o BillboardGui dentro do StarterGui.A propriedade Adornee pode ser usada para alcançar uma parte ou anexo no mundo 3D enquanto o BillboardGui próprio permanece no PlayerGui.

Veja Interface de usuário na experiência para um guia sobre como trabalhar com BillboardGui.

Comportamento de Cacheamento

Para ajudar a melhorar o performance, a aparência de um BillboardGui é armazenada até que uma das seguintes ocorra, após o qual sua aparência será recalculada no próximo quadro de renderização.

  • Um descendente é adicionado ou removido do BillboardGui.
  • Uma propriedade de um descendente das alterações de BillboardGui mudanças.
  • Uma propriedade da própria BillboardGui muda.

Resumo

Propriedades

Propriedades herdados de LayerCollectorPropriedades herdados de GuiBase2d

Eventos

Eventos herdados de GuiBase2d

Propriedades

Active

Ler Parallel

Controla se os descendentes receberão eventos de entrada.Se o conter um , esse botão só se tornará clicável se for definido como no botão e no botão .

Observe que elementos de interface interativa como ImageButtons e TextButtons dentro de um BillboardGui só receberão a entrada do usuário se forem parentados ao PlayerGui, geralmente colocando o BillboardGui dentro do StarterGui.A propriedade Adornee pode ser usada para alcançar uma parte ou anexo no mundo 3D enquanto o BillboardGui próprio permanece no PlayerGui.

Adornee

Ler Parallel

Define o alvo BasePart ou Attachment que o BillboardGui está posicionado em relação ao, substituindo a parte ou anexo pai.

AlwaysOnTop

Ler Parallel

Essa propriedade determina se o BillboardGui renderizará sempre em cima de outros objetos 3D.

Quando definido para false (padrão), o BillboardGui é renderizado como outro conteúdo 3D e é ocultado por outros objetos 3D.Quando definido para true , o BillboardGui sempre é renderizado acima do conteúdo 3D e as alterações na aparência são significativas:

  • As cores correspondem ao modo como aparecem dentro de um ScreenGui .
  • O texto pode parecer mais nítido em dispositivos de alto DPI.
  • LightInfluence é tratado como se fosse 0 .
  • Brightness não tem efeito.

Brightness

Ler Parallel

Essa propriedade determina o fator pelo qual a luz do contêiner BillboardGui é escalada quando LightInfluence é 0.Por padrão, esta propriedade é 1 e pode ser definida para qualquer número entre 0 e 1000.Ao modificar essa propriedade, a aparente brilho de um BillboardGui pode ser melhor combinado com seu ambiente.Por instância, um letreiro de vídeo pode ser iluminado dentro de uma sala escura aumentando Brightness para 10.

Observe que Brightness é inacessível no Studio e não tem efeito quando LightInfluence é 1 ou AlwaysOnTop é true.

ClipsDescendants

Ler Parallel

Quando definido para true (padrão), partes de GuiObjects que ficam fora das bordas da tela BillboardGui não serão desenadas.

Mesmo quando essa propriedade é false , GuiObjects que estão completamente fora do canvas não renderizarão.

CurrentDistance

Somente leitura
Não replicado
Ler Parallel

A distância atual em studs que o BillboardGui está da Câmerado jogador.Um evento alterado não dispara para esta propriedade a menos que DistanceStep seja maior que 0.

DistanceLowerLimit

Ler Parallel

Determina a distância em studs em que o BillboardGui parará de aumentar de tamanho em relação à Câmeraatual do jogador, com um padrão de 0 .Se o CurrentDistance do BillboardGui for inferior a esse valor, ele não escalará maior do que seria nessa distância DistanceLowerLimit.

DistanceStep

Ler Parallel

Determina os aumentos e diminuições de tamanho CurrentDistance em studs à medida que a câmera do jogador se move mais perto e mais longe do BillboardGui.A propriedade padrão para 0 e arredonda a partir de DistanceLowerLimit.

DistanceUpperLimit

Ler Parallel

Determina a distância em studs em que o BillboardGui parará de escalonar menor em tamanho em relação à Câmeraatual do jogador.Se o CurrentDistance do BillboardGui estiver acima desse valor, ele não escalará menor do que seria nessa distância DistanceUpperLimit.

Essa propriedade é ignorada se o valor for menor que 0. O valor padrão é -1, significando que a propriedade é ignorada por padrão.

ExtentsOffset

Ler Parallel

Essa propriedade determina como o BillboardGui é deslocado de seu Adornee , em relação à orientação Camera , em unidades com metade das dimensões da caixa de borda alinhada do modelo Camera.

Veja também StudsOffset que funciona de forma semelhante, mas usa unidades de estudo, ou ExtentsOffsetWorldSpace que funciona de forma semelhante, exceto que a orientação de deslocamento é relativa aos eixos globais.

ExtentsOffsetWorldSpace

Ler Parallel

Essa propriedade determina como o BillboardGui é deslocado de seu Adornee , em relação aos eixos globais, em unidades com metade das dimensões da caixa de borda alinhada do modelo.

Veja também StudsOffset que funciona de forma semelhante, mas usa unidades de estudo, ou ExtentsOffset que funciona de forma semelhante, exceto que a orientação de deslocamento é relativa ao Camera.

LightInfluence

Ler Parallel

Controla o quanto o BillboardGui é influenciado pela iluminação ambiental, em uma faixa de 0 a 1.Definir isso para 1 significa que a iluminação envolvente tem controle completo sobre a aparência, enquanto definir para 0 significa que a iluminação não tem efeito.

MaxDistance

Ler Parallel

Essa propriedade controla até onde da câmera o BillboardGui será exibido antes de parar de renderizar.Um valor de 0 ou inf (padrão) significa que não há limite e ele renderizará infinitamente longe.

Para BillboardGuis que aparecem ao ar livre, é recomendado que MaxDistance seja suficientemente alto para garantir que a interface do usuário do contêiner seja suficientemente pequena na tela quando aparece ou desaparece, minimizando o efeito pop-in/out repentino.

PlayerToHideFrom

Ler Parallel

Usado por scripts para ocultar o BillboardGui de um jogador específico.

Para ocultar um BillboardGui de mais de um jogador, coloque-o em StarterGui e use um script para definir a propriedade Enabled de acordo com se o LocalPlayer deve ser capaz de vê-la.A propriedade Adornee pode ser usada para anexar o BillboardGui a um BasePart ou Attachment na Workspace , em vez de parentê-lo.

Size

Ler Parallel

Controla o tamanho que o BillboardGui terá na tela.Ao contrário de GuiObject.Size , os componentes de escala deste conjunto de propriedades definem o tamanho do estudo da bilboard no espaço 3D.

SizeOffset

Ler Parallel

Um deslocamento de 2D em unidades relativas a tamanho que atua como um ponto de âncora.Isso pode ser usado de forma semelhante à propriedade GuiObject.AnchorPoint, mas os valores são diferentes.


<tbody>
<tr>
<td><code>0, 0</code></td>
<td>O padrão em que a interface será ancorada em seu centro.</td>
</tr>
<tr>
<td><code>0.5, 0.5</code></td>
<td>A UI vai ancorar na parte inferior esquerda.</td>
</tr>
<tr>
<td><code>0.5, -0.5</code></td>
<td>A UI vai ancorar no topo esquerdo.</td>
</tr>
<tr>
<td><code>-0.5, 0.5</code></td>
<td>A UI será ancorada na parte superior direita.</td>
</tr>
<tr>
<td><code>-0.5, -0.5</code></td>
<td>A UI vai ancorar na parte inferior direita.</td>
</tr>
</tbody>
Deslocamento de TamanhoExplicação

Veja também StudsOffset , StudsOffsetWorldSpace , ExtentsOffset e ExtentsOffsetWorldSpace , que são propriedades de deslocamento que funcionam no espaço 3D em vez disso.

StudsOffset

Ler Parallel

Essa propriedade determina como o BillboardGui é deslocado de seu Adornee em studs, em relação à orientação Camera.

Veja também StudsOffsetWorldSpace que funciona de forma semelhante, exceto que a orientação de deslocamento é relativa aos eixos globais.

StudsOffsetWorldSpace

Ler Parallel

Essa propriedade determina como o BillboardGui é deslocado de seu Adornee em studs, em relação aos eixos globais.

Veja também StudsOffset que funciona de forma semelhante, exceto que a orientação de deslocamento é relativa ao Camera.

Métodos

Eventos