BillboardGui

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.

BillboardGuis sont des conteneurs pour GuiObjects qui apparaissent dans l'espace 3D. BillboardGuis est toujours face à la caméra, et peut soit changer la taille avec la distance, soit rester la même taille sur l'écran en fonction de la propriété BillboardGui.Size.

Leur position est relative à la BillboardGui.Adornee. Si aucune Adornee n'est configurer, alors le parent du BillboardGui sera utilisé comme adornee. Pour les BaseParts, la propriété Position sera utilisée. Pour

La propriété Size d'un BillboardGui fonctionne légèrement différemment de GuiObject.Size. La partie Offset fonctionne de la même façon, mais la partie Scale est utilisée comme une taille en studs dans l'espace 3D.

Une taille de UDim2.fromScale(4, 5) est 4x5 studs, et échelle l'interface utilisateur plus grande et plus petite en fonction de la distance de la caméra. Une taille de UDim2.fromOffset(200, 100) est toujours 200x100 sur l'écran, et ne change pas la

Lors de la création d'un BillboardGuis de taille, il est important de vérifier que tous les objets de l'interface utilisateur utilisent la mise à l'échelle de taille et que tout le texte a TextLabel.TextScaled activé, pour assurer un bon escalage.

La propriété AbsolutePosition d'un BillboardGui et de tous ses descendants est relative à le coin supérieur gauche de son kanvas, et est donc toujours 0, 0 pour l'instance BillboardGui.

Cacher l'interface utilisateur statique pour les performances

L'apparence d'un Gui est mise en cache jusqu'à ce qu'un des événements suivants se produise :

  • Un descendant est ajouté à la Gui.
  • Un descendant est supprimé de la Gui.
  • Une propriété d'un descendant de la Gui change.
  • Une propriété de la Gui change.

Si l'un de ces événements survernir, l'apparence de la Gui sera récalculée la prochaine fois qu'elle sera rendue.

Résumé

Propriétés

  • Lecture parallèle

    Contrôle si les descendants recevront des événements d'entrée.

  • Lecture parallèle

    Définit la partie ou l'attribut cible que le BillboardGui est positionné par rapport à.

  • Lecture parallèle

    Détermine si le BillboardGui sera rendu devant du contenu 3D ou derrière.

  • Lecture parallèle

    Détermine le facteur par lequel la lumière de l'interface utilisateur graphiqueest mise à l'échelle lorsque LightInfluence est 0.

  • Lecture parallèle

    Lorsqu'il est réglé sur vrai, les parties de GuiObjects qui tombent en dehors des limites du BillboardGui ne seront pas dessinées.

  • Lecture uniquement
    Non répliqué
    Lecture parallèle

    La distance actuelle en studs à partir de laquelle le BillboardGui est de la caméra du joueur.

  • Lecture parallèle

    Détermine la distance en studs que un BillboardGui arrêtera de redimensionner plus grande à l'échelle.

  • Lecture parallèle

    La distance sera arrondie à l'augmentation de cette valeur.

  • Lecture parallèle

    Détermine la distance en studs que un BillboardGui arrêtera de redimensionner plus petit à.

  • Lecture parallèle

    Détermine comment le BillboardGui est décalé de son Adornee, par rapport à l'orientation et aux unités de l'unité de Camera, la boîte de délimitation de la Camera est de moitié de la dimension de la 2>Class.Camera2> boîte de modélisationde délimitation de la 5>Class.Camera5>.

  • Détermine comment le BillboardGui est décalé de son Adornee , par rapport aux axes et unités globales sont la moitié de la dimension des coins de la boîte de modélisationde délimitation de l'axe de modèlisation.

  • Lecture parallèle

    Contrôle la mesure dans laquelle le BillboardGui est influencé par l'éclairage dans l'environnement.

  • Lecture parallèle

    Définit la distance maximale qu'un panneau peut être de la caméra et qu'il puisse toujours être dessiné.

  • Lecture parallèle

    Utilisé par les scripts pour cacher le BillboardGui d'un joueur spécifique.

  • Lecture parallèle

    Contrôle la taille que le BillboardGui aura sur l'écran.

  • Lecture parallèle

    Un décalage 2D dans les unités de taille relative qui agit comme un point d'ancrage.

  • Lecture parallèle

    Détermine comment le BillboardGui est décalé de son Adornee , par rapport à l'orientation et aux unités dans studs.

  • Lecture parallèle

    Détermine comment le BillboardGui est décalé de son Adornee , par rapport aux axes et unités globales en studs.

Proprié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

Active

Lecture parallèle

Contrôle si les descendants recevront des événements d'entrée. Si l'interface utilisateur contient un GuiButton alors ce bouton ne deviendra cliquable que si Active est réglé sur vrai sur le BillboardGui et le bouton.

BillboardGuis ne recevra l'entrée de l'utilisateur que si ils sont parentés à PlayerGui. La propriété BillboardGui.Adornee peut être utilisée pour cibler une partie dans l'espace de travail pendant que l'interface utilisateur elle-même est dans le PlayerGui.

Adornee

Lecture parallèle

Définit la partie ou l'attribut cible que le BillboardGui est positionné par rapport. Si aucun Adornee n'est configurer, alors le Parent est utilisé à la place.

AlwaysOnTop

Lecture parallèle

Détermine si le BillboardGui rendra au-dessus du contenu 3D, ou sera bloqué par lui.

Lorsqu'il est réglé sur false, le BillboardGui rendra comme d'autres contenus 3D, et sera occlué par d'autres objets 3D.

Quand il est réglé sur vrai, il rend toujours au-dessus du contenu 3D, et les changements d'apparence sont importants :

Brightness

Lecture parallèle

La luminosité détermine le facteur par lequel la lumière émise de l'interface est mise à l'échelle. Par défaut, cette propriété est de 1 et peut être réglée sur n'importe quel nombre de la portée [0, 1000].

En modifiant cette propriété, la luminosité apparente d'un GUI peut être mieux adaptée à son environnement. Par instance, un panneau vidéo comme ceux trouvés dans Times Square peuvent être rendus plus brillants pour être clairement visibles dans un jour ensoleillé.

Cette propriété ne produira aucun effet dans les scénarios suivants dans lesquels la GUI ne produit pas de lumière :

  • Lorsque AlwaysOnTop est vrai, la couleur de chaque pixel est la couleur affichée à l'écran.
  • Lorsque LightInfluence est 1, toute la lumière de l'interface est réfléchie de l'environnement au lieu d'être émise.

ClipsDescendants

Lecture parallèle

Lorsqu'il est réglé sur vrai, les parties de GuiObjects qui tombent en dehors des limites du BillboardGui ne seront pas dessinées.

Même si cette propriété est fausse, les objets qui sont complètement en dehors du cadre du BillboardGui ne seront pas rendus.

CurrentDistance

Lecture uniquement
Non répliqué
Lecture parallèle

La distance actuelle en studs à partir de laquelle le BillboardGui est de la caméra du joueur. Un événement modifié ne se déclenche pas pour cette propriété à moins que le gui's BillboardGui.DistanceStep ne soit supérieur à 0.

DistanceLowerLimit

Lecture parallèle

Détermine la distance en studs que un BillboardGui arrêtera de redimensionner plus grand en taille par rapport à la caméra actuelle du joueur. Si la distance du gui est inférieure à cette valeur, il ne sera pas redimensionné plus grand que ce qu'il serait à cette distance. La valeur de cette propriété par défaut est 0 studs.

DistanceStep

Lecture parallèle

Détermine la taille des augmentations et des diminutions de BillboardGui.CurrentDistance dans les studs à mesure que la caméra du joueur se rapproche et se déplace plus loin de la BillboardGui . La propriété par défaut est 0 et les arrondissements commencent à partir de BillboardGui.DistanceLowerLimit .

Par exemple, si cette propriété est réglée sur 0,5 et que la caméra du joueur se déplace de la gui à partir de 0, alors la distance actuelle sera augmentée de 0 -> 0,5 -> 1 -> 1,5 -> ... et ainsi de suite.

DistanceUpperLimit

Lecture parallèle

Détermine la distance en studs que un BillboardGui arrêtera de redimensionner plus petit en relation avec la caméra actuelle du joueur. Si la distance du gui est supérieure à cette valeur, il ne sera pas redimensionné plus petit que ce qu'il serait à cette distance.

Cette propriété est ignorée si la valeur est inférieure à 0. La valeur par défaut est -1, ce qui signifie que la propriété est ignorée par défaut.

ExtentsOffset

Lecture parallèle

Offset de BillboardGui détermine comment le BillboardGui est décalé de son Class.BillboardGui.Adornee|Adorne , par rapport à l'orientation et aux unités de la Class.Camera boîte de modélisationde délimitation de la boîte de délimitation de la boîte de délimination de la boîte de délimination de la boîte de délimitation de la boîte de délimination de la boîte de délimination de la boîte de délimination de

Voir aussi :

  • ExtentsOffsetWorldSpace , qui fonctionne de la même façon sauf que l'orientation de l'Offset est relative aux axes globaux
  • StudsOffset , qui fonctionne de la même façon sauf que les unités sont des studs

ExtentsOffsetWorldSpace

Lecture parallèle

ExtentsOffsetWorldSpace détermine comment le BillboardGui est décalé de son Adornee , par rapport aux axes et unités globales, sont deux fois plus petits que les dimensions de la boîte de modélisationde délimitation d'axe de modèlisation.

Voir aussi :

  • ExtentsOffset , qui fonctionne de la même façon sauf que l'orientation de l'Offset est relative à la Camera
  • StudsOffsetWorldSpace , qui fonctionne de la même façon sauf que les unités sont des studs

LightInfluence

Lecture parallèle

Contrôle la mesure dans laquelle le BillboardGui est influencé par l'éclairage dans l'environnement.

Lorsqu'il est réglé sur 0, l'interface utilisateur se comporte comme un écran LCD, agissant comme sa propre source de lumière et apparaissant indépendamment de l'éclairage environnant.

Lorsqu'il est réglé sur 1, l'interface utilisateur fonctionne de manière similaire à un morceau de papier, ne reflétant que la lumière d'une autre source.

MaxDistance

Lecture parallèle

La propriété MaxDistance d'un BillboardGui détermine la distance max de ce panneau jusqu'à la caméra et comment il peut toujours être dessiné. Si la caméra et le panneau sont déplacés plus loin que la distance maximale, le panneau ne sera pas visible indépendamment de toutes les autres propriétés du panneau ou des objets GUI qu'il contient. La valeur par défaut de cette propriété est infinie

Si cette valeur est réglée inférieure ou égale à 0, la distance maximale sera traitée comme infinie et le panneau sera toujours dessinable.

Exemple


-- Attendez que les scripts de caméra/de contrôle par défaut se charger
task.wait(5)
-- Déclarer et initialiser des objets
local camera = workspace.CurrentCamera
local part = Instance.new("Part")
local billboard = Instance.new("BillboardGui")
local label = Instance.new("TextLabel")
-- Définir le taperde caméra
camera.CameraType = Enum.CameraType.Scriptable
-- Définir la position de la partie et la emplacement
part.CFrame = CFrame.new(0, 10, 0)
part.Anchored = true
-- Configurer le panneau
billboard.MaxDistance = 10
billboard.Adornee = part
billboard.AlwaysOnTop = true
billboard.Size = UDim2.fromOffset(50, 50)
-- Configurer l'étiquette
label.Size = UDim2.fromScale(1, 1)
-- Définir les parents d'objets
label.Parent = billboard
billboard.Parent = part
part.Parent = workspace
-- Déplacer la caméra à côté de la pièce. Attendez un peu et puis déplacez la caméra
local cameraPosition0 = part.Position + Vector3.new(0, 0, 10)
local cameraPosition1 = part.Position + Vector3.new(0, 0, 20)
camera.CFrame = CFrame.lookAt(cameraPosition0, part.Position)
-- Le contenu du panneau sera visible ici
task.wait(2)
camera.CFrame = CFrame.lookAt(cameraPosition1, part.Position)
-- Contents of billboard will no longer be visible (outside MaxDistance)

PlayerToHideFrom

Lecture parallèle

Utilisé par les scripts pour cacher le BillboardGui d'un joueur spécifique.

Pour cacher l'interface de l'utilisateur d'un plus d'un joueur, placez le BillboardGui dans StarterGui et utilisez un script pour définir la propriété Class

Size

Lecture parallèle

Contrôle la taille que le BillboardGui aura sur l'écran.

La composante de l'échelle de la taille est interprétée comme une taille en studs, et l'interface utilisateur sera automatiquement mise à l'échelle avec la distance si les valeurs de l'échelle sont utilisées.

Les parties de l'échelle et de l'Offset sont ajoutées ensemble et peuvent être utilisées en même temps.

SizeOffset

Lecture parallèle

Un décalage 2D dans les unités de taille relative qui agit comme un point d'ancrage. Cela peut être utilisé de la même façon que la propriété GuiObject.AnchorPoint, mais les valeurs sont différentes.

Valeurs courantes

| SizeOffset | Explanation | | : | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |

Voir aussi :

StudsOffset

Lecture parallèle

StudsOffset détermine comment le BillboardGui est décalé de son Adornee , par rapport à l'orientation avec des unités en studs.

Voir aussi :

  • StudsOffsetWorldSpace , qui fonctionne de la même façon sauf que l'orientation de l'Offset est relative aux axes globaux
  • ExtentsOffset , qui fonctionne de la même façon sauf que les unités sont deux fois plus petites que les limites de la boîte de dessin de l'boîte de modélisation

StudsOffsetWorldSpace

Lecture parallèle

StudsOffsetWorldSpace détermine comment le BillboardGui est décalé de son Adornee , par rapport aux axes globaux avec des unités en studs.

Voir aussi :

  • StudsOffset , qui fonctionne de la même façon sauf que l'orientation de l'Offset est relative à la Camera
  • ExtentsOffsetWorldSpace , qui fonctionne de la même façon sauf que les unités sont de la moitié de la taille des dimensions de la boîte de modélisationde délimitation d'axe du modèlisation

Méthodes

Évènements