SurfaceGui

Mostrar obsoleto

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

SurfaceGui permite o renderizamento de objetos de UI na superfície de uma peça no mundo 3D, enquanto também permite que a interação básica do usuário ocorrer.Semelhante a Decals e Textures , objetos de interface de usuário, como TextLabels e ImageLabels , parentados a um SurfaceGui rosto na mesma direção que a superfície em que estão, editável através da propriedade Face.

SurfaceGui on a 3D part in the place with an ImageLabel child to depict a screen console.

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

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

Comportamento de Cacheamento

Para ajudar a melhorar o performance, a aparência de um SurfaceGui é 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 SurfaceGui.
  • Uma propriedade de um descendente das alterações de SurfaceGui mudanças.
  • Uma propriedade da própria SurfaceGui muda.

Resumo

Propriedades

Propriedades herdados de SurfaceGuiBasePropriedades herdados de LayerCollectorPropriedades herdados de GuiBase2d

Eventos

Eventos herdados de GuiBase2d

Propriedades

AlwaysOnTop

Ler Parallel

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

Quando definido para false (padrão), o SurfaceGui é renderizado como outro conteúdo 3D e é ocultado por outros objetos 3D.Quando definido para true , o SurfaceGui 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 SurfaceGui é 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 SurfaceGui 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.

CanvasSize

Ler Parallel

O tamanho de uma "tela virtual" em "pixels virtuais" que torna SurfaceGuis pixel-to-pixel compatível com ScreenGuis .

ClipsDescendants

Ler Parallel

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

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

LightInfluence

Ler Parallel

Controla o quanto o SurfaceGui é 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 SurfaceGui será exibido antes de parar de renderizar.Um valor de 0 significa que não há limite e ele renderizará infinitamente longe.O valor padrão de 1000 funciona bem para a maioria dos casos.

Para SurfaceGuis 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.

PixelsPerStud

Ler Parallel

Essa propriedade determina a densidade de pixels usados para cada estudo de espaço mundial para renderizar o conteúdo do SurfaceGui.Valores mais altos farão com que os vários GuiObjects dentro apareçam menores se forem mantidos do mesmo tamanho.Inversamente, valores mais baixos farão com que os objetos pareçam maiores.No entanto, se os GuiObjects forem escalonados proporcionalmente através do uso de UIScale , GuiObject.Size , TextLabel.TextSize ou semelhantes, esta propriedade permite que uma definição mais alta seja usada.

É importante selecionar um valor com base em quão longe você espera que um jogador veja o SurfaceGui .Também tenha em mente que uma grande densidade de pixels pode afetar negativamente o desempenho se a face da peça adornada for grande o suficiente.

Ler Parallel

Quando definido para Enum.SurfaceGuiSizingMode.PixelsPerStud (padrão), o SurfaceGui renderiza com um tamanho variável com base em PixelsPerStud e no tamanho da superfície em studs.

Quando definido para Enum.SurfaceGuiSizingMode.FixedSize , o SurfaceGui renderiza com um tamanho fixo definido através de CanvasSize .

ToolPunchThroughDistance

Ler Parallel

Define a distância em que o clique esquerdo começa a agir no SurfaceGui em vez de para o segurado Tool.Se um personagem estiver dentro dessa distância do SurfaceGui, o Tool não será ativado ao clicar.

ZOffset

Ler Parallel

Coloca isso SurfaceGui em relação aos outros na mesma face (alterar isso não "levanta" ou "afunda" visualmente um SurfaceGui da superfície).

Métodos

Eventos