SurfaceGui

Afficher les obsolètes

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

SurfaceGui permet de rendre des objets d'interface utilisateur sur la surface d'une pièce dans le monde 3D tout en permettant une interaction utilisateur basique de survernir.Semblable à Decals et Textures , les objets d'interface utilisateur tels que TextLabels et ImageLabels sont parentés à un visage de SurfaceGui face à la même direction que la surface sur laquelle ils se trouvent, modifiable via la propriété Face.

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

Notez que les éléments d'interface utilisateur interactifs comme ImageButtons et TextButtons à l'intérieur d'un SurfaceGui ne recevront l'entrée de l'utilisateur que si ils sont parentés au PlayerGui , généralement en plaçant le SurfaceGui à l'intérieur de StarterGui .La propriété Adornee peut être utilisée pour cibler une partie dans le monde 3D tout en laissant la SurfaceGui elle-même dans le PlayerGui.

Voir interface utilisateur en expérience pour un guide sur le travail avec SurfaceGui conteneurs.

Comportement de mise en cache

Pour aider à améliorer les performances, l'apparence d'un SurfaceGui est mise en cache jusqu'à ce que l'une des suivantes se produise, après quoi son apparence sera récalculée sur le prochain cadre de rendu.

  • Un descendant est ajouté ou supprimé du SurfaceGui.
  • Une propriété d'un descendant des modifications de la SurfaceGui .
  • Une propriété de la SurfaceGui elle-même change.

Résumé

Propriétés

Propriétés hérités de SurfaceGuiBasePropriétés hérités de LayerCollectorPropriétés hérités de GuiBase2d

Évènements

Évènements hérités de GuiBase2d

Propriétés

AlwaysOnTop

Lecture parallèle

Cette propriété détermine si la SurfaceGui rendra toujours au-dessus d'autres objets 3D.

Lorsqu'il est défini à false (par défaut), le SurfaceGui se rend comme un autre contenu 3D et est occulté par d'autres objets 3D.Lorsqu'il est défini à true , le SurfaceGui rend toujours au-dessus du contenu 3D et les modifications d'apparence sont significatives :

  • Les couleurs correspondent à la façon dont elles apparaissent à l'intérieur d'un ScreenGui .
  • Le texte peut apparaître plus net sur les appareils DPI élevés.
  • LightInfluence est traité comme s'il était 0 .
  • Brightness n'a aucun effet.

Brightness

Lecture parallèle

Cette propriété détermine le facteur par lequel la lumière du conteneur SurfaceGui est scalaire lorsque LightInfluence est 0.Par défaut, cette propriété est 1 et peut être définie à n'importe quel nombre entre 0 et 1000.En modifiant cette propriété, l'éclairage apparent d'un SurfaceGui peut être mieux adapté à son environnement.Par instance, un panneau vidéo peut être éclairé à l'intérieur d'une pièce sombre en augmentant Brightness à 10.

Notez que Brightness n'est pas accessible dans Studio et n'a aucun effet lorsque LightInfluence est 1 ou AlwaysOnTop est true .

CanvasSize

Lecture parallèle

La taille d'un "écran virtuel" en "pixels virtuels" qui rend SurfaceGuis pixel-à-pixel compatible avec ScreenGuis .

ClipsDescendants

Lecture parallèle

Lorsqu'il est défini à true (par défaut), des parties de GuiObjects qui tombent en dehors des bords de la toile SurfaceGui ne seront pas dessinées.

Même lorsque cette propriété est false , GuiObjects qui sont complètement en dehors de la toile ne seront pas rendus.

LightInfluence

Lecture parallèle

Contrôle à quel point le SurfaceGui est influencé par l'éclairage environnemental, dans une plage allant de 0 à 1.Définir ceci à 1 signifie que l'éclairage environnant a un contrôle complet sur l'apparence, tandis que le définir à 0 signifie que l'éclairage n'a aucun effet.

MaxDistance

Lecture parallèle

Cette propriété contrôle à quelle distance de la caméra la SurfaceGui sera affichée avant qu'elle ne cesse de rendre.Une valeur de 0 signifie qu'il n'y a pas de limite et qu'elle sera rendue à l'infini loin.La valeur par défaut de 1000 fonctionne bien dans la plupart des cas.

Pour SurfaceGuis qui apparaissent à l'extérieur, il est recommandé que MaxDistance soit suffisamment élevé pour garantir que l'interface utilisateur du conteneur soit suffisamment petite sur l'écran lorsqu'elle apparaît ou disparaît, minimisant l'effet de pop-in/out soudain.

PixelsPerStud

Lecture parallèle

Cette propriété détermine la densité des pixels utilisés pour chaque point d'espace mondial pour rendre le contenu du SurfaceGui .Les valeurs plus élevées provoqueront l'apparition de la taille plus petite des différentes GuiObjects à l'intérieur si elles sont maintenues de la même taille.Inversement, des valeurs plus basses provoqueront l'apparition d'objets plus grands.Cependant, si les GuiObjects sont dimensionnés proportionnellement à l'aide de UIScale , GuiObject.Size , TextLabel.TextSize ou similaire, cette propriété permet d'utiliser une définition plus élevée.

Il est important de sélectionner une valeur en fonction de la distance à laquelle vous vous attendez à ce qu'un joueur voie le SurfaceGui.Gardez également à l'esprit qu'une grande densité de pixels pourrait affecter négativement les performances si le visage de la partie décorée est assez grand.

Lecture parallèle

Lorsqu'il est défini à Enum.SurfaceGuiSizingMode.PixelsPerStud (par défaut), le SurfaceGui rend avec une taille variable basée sur PixelsPerStud et la taille de la surface en studs.

Lorsqu'il est défini à Enum.SurfaceGuiSizingMode.FixedSize, le SurfaceGui rend avec une taille fixe définie via CanvasSize.

ToolPunchThroughDistance

Lecture parallèle

Définit la distance dans laquelle le clic gauche commence à agir sur le SurfaceGui au lieu du Tool maintenu.Si un personnage se trouve à cette distance du SurfaceGui, le Tool ne s'activera pas au cliquer.

ZOffset

Lecture parallèle

Pose ceci SurfaceGui en relation avec d'autres sur le même visage (changer cela ne « soulève » ou « coule » visuellement aucun SurfaceGui de la surface).

Méthodes

Évènements