Les conteneurs UI en expérience contiennent des GuiObjects que vous souhaitez afficher dans le monde 3D de votre expérience.
- Un SurfaceGui permet de rendre des objets UI sur la surface d'une pièce dans le monde 3D tout en permettant également une interaction de base de l'utilisateur.
- Un BillboardGui est un conteneur pour que les objets UI apparaissent dans l'espace 3D en faisant toujours face à la caméra.
UI de Surface
Semblable aux Decals et aux Textures, les objets UI tels que TextLabels et ImageLabels parentés à un SurfaceGui font face à la même direction que la surface sur laquelle ils se trouvent, modifiable par la propriété SurfaceGui.Face.
Pour appliquer un SurfaceGui à un BasePart en expérience, il suffit de le parenté à cette pièce et de définir la propriété SurfaceGui.Face. Les objets UI enfants apparaissent alors sur ce face de la pièce parente.
Alternativement, vous pouvez placer le SurfaceGui à l'intérieur d'un conteneur tel que StarterGui et ensuite définir sa propriété Adornee sur n'importe quel BasePart, ainsi que le Face cible. Définir Adornee remplace l'association directe parentale, permettant plus de flexibilité dans le placement, car elle peut être définie par un script pendant le temps d'exécution.
Les éléments UI interactifs comme ImageButtons et TextButtons à l'intérieur d'un SurfaceGui ne recevront des entrées utilisateur que s'ils sont parentés au PlayerGui du joueur, généralement en plaçant le SurfaceGui à l'intérieur de StarterGui comme noté ci-dessus. De plus, la propriété CanQuery de la pièce doit être true pour que l'élément UI interactif reçoive des entrées.
Pour aider à choisir le bon face pour un SurfaceGui, faites un clic droit sur la pièce cible et sélectionnez Afficher l'indicateur d'orientation. Cela affiche un cercle bleu avec un F et une ligne attachée au face Front de l'objet, et une flèche verte qui pointe dans la direction du face Top de l'objet.
Taille et position
La "toile" d'un SurfaceGui occupe l'ensemble de la Face de la pièce parente ou de la pièce Adornee. En tant que meilleure pratique, il est recommandé d'utiliser des valeurs échelle pour la taille et la position des objets UI enfants comme ImageLabels. Vous pouvez également appliquer un UIAspectRatioConstraint aux enfants du SurfaceGui pour maintenir leur ratio d'aspect souhaité indépendamment de la taille de la face.
Mode d'occlusion
La propriété AlwaysOnTop détermine si le SurfaceGui sera rendu au-dessus du contenu 3D ou sera masqué par celui-ci. Lorsqu'elle est définie sur false (par défaut), le SurfaceGui se rend comme d'autres contenus 3D et est masqué par d'autres objets 3D. Lorsqu'elle est définie sur true, elle se rend toujours au-dessus du contenu 3D et n'est pas influencée par la luminosité/lumière dans l'environnement 3D.
Influence de la luminosité et de la lumière
Brightness et LightInfluence fonctionnent ensemble pour déterminer comment la lumière environnementale affecte le contenu UI du SurfaceGui.
Brightness détermine le facteur par lequel la lumière émise est mise à l'échelle dans une plage de 0 à 1000, vous permettant d'adapter le SurfaceGui à son environnement. Par exemple, un panneau vidéo peut être éclairé dans une pièce sombre en augmentant Brightness à 10.
LightInfluence contrôle combien le SurfaceGui est influencé par l'éclairage dans le lieu, dans une plage de 0 à 1. Si cela est réglé sur 1, cela signifie que l'éclairage environnant a un contrôle total sur l'apparence, tandis que si c'est réglé sur 0, cela signifie que l'éclairage n'a aucun effet.
Notez que Brightness est inaccessible dans Studio et n'a aucun effet lorsque LightInfluence est 1 ou que AlwaysOnTop est true.
Visibilité à distance
MaxDistance contrôle jusqu'à quelle distance de la caméra le SurfaceGui sera affiché avant qu'il cesse de se rendre. Une valeur de 0 signifie qu'il n'y a pas de limite et qu'il se rendra indéfiniment loin. La valeur par défaut de 1000 fonctionne bien pour la plupart des cas.
Pour les SurfaceGuis qui apparaissent à l'extérieur, il est recommandé que MaxDistance soit suffisamment élevé pour garantir que l'UI du conteneur soit suffisamment petite à l'écran lorsqu'elle apparaît ou disparaît, minimisant l'effet de pop-in/out soudain.
Ordre d'affichage
Si plusieurs conteneurs SurfaceGui existent sur le même face, vous pouvez les superposer par index Z via leur propriété ZOffset (modifier cela ne "soulève" ou "enfonce" visuellement pas le conteneur de la surface).
UI de Billboard
Le conteneur BillboardGui affiche des objets UI dans l'espace 3D mais, contrairement à SurfaceGui, les enfants d'un BillboardGui font toujours face à la caméra. Ce conteneur est utile pour afficher des informations orientées vers l'avant au-dessus d'objets en expérience, tels que des compteurs de santé ou des noms au-dessus des personnages joueurs, des marqueurs pour guider les joueurs vers un objet dans le monde 3D, et plus encore.
Pour lier un BillboardGui à un BasePart ou Attachment en expérience, il suffit de le parenté à cette pièce ou attachement et, si désiré, d'ajuster sa taille/position.
Alternativement, vous pouvez placer le BillboardGui à l'intérieur d'un conteneur tel que StarterGui et ensuite définir sa propriété Adornee sur n'importe quel BasePart ou Attachment. Cette méthode offre plus de flexibilité dans le placement puisque Adornee peut être définie par un script pendant le temps d'exécution, par exemple pour placer un BillboardGui au-dessus de la tête des personnages joueurs pendant l'exécution.
Les éléments UI interactifs comme ImageButtons et TextButtons à l'intérieur d'un BillboardGui ne recevront des entrées utilisateur que s'ils sont parentés au PlayerGui du joueur, généralement en plaçant le BillboardGui à l'intérieur de StarterGui comme noté ci-dessus.
Taille et position
Pour la taille des panneaux, les composants échelle de la propriété Size définissent la taille du panneau en studs dans l'espace 3D. Par exemple, un réglage de {10, 0},{2, 0} (UDim2.fromScale(10, 2)) forme un panneau avec un ratio d'aspect 10:2 qui s'agrandit ou rétrécit en fonction de sa distance de la caméra.
Pour le positionnement, la propriété StudsOffset déplace la toile du panneau sur l'axe X (gauche/droite), l'axe Y (haut/bas), et l'axe Z (avant/arrière) par rapport à la caméra.
Lors de la création d'un BillboardGui redimensionné qui contient un TextLabel, il est utile d'activer la propriété TextScaled de l'étiquette afin que son texte soit à l'échelle avec la toile du panneau à mesure que la distance de la caméra change.
Mode d'occlusion
La propriété AlwaysOnTop détermine si le BillboardGui sera rendu au-dessus du contenu 3D ou sera masqué par celui-ci. Lorsqu'elle est définie sur false (par défaut), le BillboardGui se rend comme d'autres contenus 3D et est masqué par d'autres objets 3D. Lorsqu'elle est définie sur true, elle se rend toujours au-dessus du contenu 3D et n'est pas influencée par la luminosité/lumière dans l'environnement 3D.
Influence de la luminosité et de la lumière
Brightness et LightInfluence fonctionnent ensemble pour déterminer comment la lumière environnementale affecte le contenu UI du BillboardGui.
Brightness détermine le facteur par lequel la lumière émise est mise à l'échelle dans une plage de 0 à 1000, vous permettant d'adapter le BillboardGui à son environnement. Par exemple, un panneau vidéo peut être éclairé dans une pièce sombre en augmentant Brightness à 10.
LightInfluence contrôle combien le BillboardGui est influencé par l'éclairage dans le lieu, dans une plage de 0 à 1. Si cela est réglé sur 1, cela signifie que l'éclairage environnant a un contrôle total sur l'apparence, tandis que si c'est réglé sur 0, cela signifie que l'éclairage n'a aucun effet.
Notez que Brightness est inaccessible dans Studio et n'a aucun effet lorsque LightInfluence est 1 ou que AlwaysOnTop est true.
Visibilité à distance
MaxDistance contrôle jusqu'à quelle distance de la caméra le BillboardGui sera affiché avant qu'il cesse de se rendre. Une valeur de 0 ou inf (par défaut) signifie qu'il n'y a pas de limite et qu'il se rendra indéfiniment loin.