StarterGui

Permet à StarterGui de traiter l'entrée comme PlayerGui et CoreGui le font. La valeur par défaut est 1> false1>.

Cette propriété définit le mode d'orientation d'écran préféré pour les utilisateurs avec des appareils mobiles. Pour les différents modes disponibles, voir Enum.ScreenOrientation.

Par défaut, cette propriété est réglée sur Sensor, ce qui signifie que l'expérience est affichée en fonction du meilleur match à l'orientation actuelle de l'appareil, soit l'orientation paysage (gauche/droite) ou le portrait.

Lorsqu'un Player rejoint l'expérience sur un appareil mobile, cette propriété détermine l'orientation de départ de l'appareil et définit la position de départ de ce joueur. Vous pouvez également obtenir l'orientation de l'écran actuelle du joueur via PlayerGui.ScreenOrientation, utile lors de l'utilisation de l

Notez que le changement de cette propriété ne changera pas l'orientation de l'écran pour Players déjà dans l'expérience. Pour modifier l'orientation d'un joueur existant, utilisez sa propriété PlayerGui.ScreenOrientation.

Cette propriété détermine si le contenu de StarterGui est visible dans Studio.

Cette fonction renvoie si le Enum.CoreGuiType donné est activé ou non en utilisant StarterGui:SetCoreGuiEnabled(). Cette fonction devrait être appelée sur le client.

Notez que le paramètre "TopbarEnabled" de « TopbarEnabled » à « false » en utilisant Class.StarterGui:SetCore()|SetCore() » hide tous les Class.CoreGuiType|Class.GuiTypes » mais n'affecte pas le résultat de cette fonction.

Paramètres

Retours

local StarterGui = game:GetService("StarterGui")

print(StarterGui:GetCoreGuiEnabled("PlayerList"))

Cette méthode (ne pas confondre avec SetCoreGuiEnabled() ) expose une variété de fonctionnalités définies par les scripts de base de Roblox, tels que l'envoi de notifications, le basculage des notifications pour des badges/points, la définition d'un rappel pour le bouton de réinitialisation ou le basculage de la barre supérieure.

Le premier argument est une chaîne qui sélectionne la fonctionnalité avec laquelle l'appel interagira. Il peut s'avérer nécessaire d'appeler ce méthode plusieurs fois en utilisant pcall() dans le cas où le script respectant coeur n'a pas encore été chargé (ou s'il a été désactivé complètement).

Le tableau suivant décrit les chaînes qui peuvent être acceptées comme premier argument. Les paramètres qui suivent sont dépendants de la fonctionnalité utilisée et sont décrits dans les sous-tables.

ChatActif

Contrôle si le chat est actif.

<tbody>
  <tr>
    <td><code>actif</code></td>
    <td>boîtier</td>
    <td>(requis)</td>
    <td>Détermine si le chat doit être activé.</td>
  </tr>
</tbody>

PointsNotificationsActifs

Contrôle si les notifications pour les points de joueur gagnés apparaissent.

<tbody>
  <tr>
    <td><code>actif</code></td>
    <td>boîtier</td>
    <td>(requis)</td>
    <td>Détermine si les notifications pour les points de joueur gagnés apparaîtront.</td>
  </tr>
</tbody>

BadgesNotificationsActifs

Contrôle si les notifications pour les badges gagnés apparaissent.

<tbody>
  <tr>
    <td><code>actif</code></td>
    <td>boîtier</td>
    <td>(requis)</td>
    <td>Détermine si les notifications pour les badges gagnés apparaîtront.</td>
  </tr>
</tbody>

Réinitialiser le bouton d'appel

Détermine le comportement, si nécessaire, du bouton de réinitialisation donné à un booléen ou à un BindableEvent pour être tiré lorsqu'un joueur demande de réinitialiser.

<tbody>
  <tr>
    <td><code>activé</code></td>
    <td>boîtier</td>
    <td>(requis)</td>
    <td>Détermine si le bouton de réinitialisation conserve son comportement par défaut.</td>
  </tr>

  <tr>
    <td colspan="4"><b>OU</b></td>
  </tr>

  <tr>
    <td><code>appel à rebours</code></td>
    <td><code>Événement lié à la classe</code></td>
    <td>(requis)</td>
    <td>Un <code>Class.BindableEvent</code> pour être déclenché lorsque le joueur confirme qu'il souhaite réinitialiser.</td>
  </tr>
</tbody>

ChatMakeSystemMessage

Affiche un message formaté dans le chat.

<tbody>
  <tr>
    <td><code>Configurateur de tableaux</code></td>
    <td>dictionnaire</td>
    <td>(requis)</td>
    <td>Un dictionnaire d'informations décrivant le message (voir ci-dessous).</td>
  </tr>
</tbody>

<tbody>
  <tr>
    <td><code>Texte</code></td>
    <td>chaîne</td>
    <td>(requis)</td>
    <td>Le message à afficher.</td>
  </tr>

  <tr>
    <td><code>Couleur</code></td>
    <td><code>Couleur de type de données.3</code></td>
    <td><code>Datatype.Color3.fromRGB(255, 255, 243)</code></td>
    <td>Couleur du texte du message.</td>
  </tr>

  <tr>
    <td><code>Police</code></td>
    <td><code>Font.</code></td>
    <td><code>SourceSansBold</code></td>
    <td>police de le message.</td>
  </tr>

  <tr>
    <td><code>Taille du texte</code></td>
    <td>entier</td>
    <td><code>18</code></td>
    <td>Taille du texte du message.</td>
  </tr>
</tbody>

Envoyer un avis

Affiche une notification non intrusive en bas à droite de l'écran. La notification peut avoir jusqu'à deux boutons.

<tbody>
  <tr>
    <td><code>Configurateur de tableaux</code></td>
    <td>dictionnaire</td>
    <td>(requis)</td>
    <td>Un dictionnaire d'informations décrivant la notification (voir ci-dessous).</td>
  </tr>
</tbody>

<tbody>
  <tr>
    <td><code>Titre</code></td>
    <td>chaîne</td>
    <td>(requis)</td>
    <td>Titre de la notification.</td>
  </tr>

  <tr>
    <td><code>Texte</code></td>
    <td>chaîne</td>
    <td>(requis)</td>
    <td>Le texte principal de la notification.</td>
  </tr>

  <tr>
    <td><code>Icône</code></td>
    <td>chaîne</td>

    <td />

    <td>L'image à afficher avec la notification.</td>
  </tr>

  <tr>
    <td><code>Durée</code></td>
    <td>number</td>
    <td><code>5</code></td>
    <td>Durée (en secondes) la notification doit rester visible.</td>
  </tr>

  <tr>
    <td><code>Appel à rebours</code></td>
    <td><code>Class.BindableFunction</code></td>

    <td />

    <td>Une <code>Class.BindableFunction</code> qui doit être invoquée avec le texte du bouton pressé par le joueur.</td>
  </tr>

  <tr>
    <td><code>Bouton1</code></td>
    <td>chaîne</td>

    <td />

    <td>Le texte à afficher sur le premier bouton.</td>
  </tr>

  <tr>
    <td><code>Bouton 2</code></td>
    <td>chaîne</td>

    <td />

    <td>Le texte à afficher sur le deuxième bouton.</td>
  </tr>
</tbody>

Topbar activé

Détermine si la barre supérieure est affichée ou non. En désactivant la barre supérieure, vous désactiverez également tous les CoreGuis tels que le chat, l'inventaire et la liste des joueurs (par exemple, ceux avec SetCoreGuiEnabled).

Lorsqu'il est désactivé, la région de la barre supérieure capturera toujours les événements de la souris ; cependant, les boutons placés là-bas ne répondront pas aux clics. L'origine de l'espace GUI sera toujours décalée de 36 pixels du haut de l'écran.

<tbody>
  <tr>
    <td><code>activé</code></td>
    <td>boîtier</td>
    <td>(requis)</td>
    <td>Détermine si la barre supérieure devrait être visible.</td>
  </tr>
</tbody>

DevConsoleVisible

Détermine si la Console du développeur est visible.

<tbody>
  <tr>
    <td><code>visibilité</code></td>
    <td>boîtier</td>
    <td>(requis)</td>
    <td>Détermine si la console est visible.</td>
  </tr>
</tbody>

Inviter un ami

Invite le joueur actuel à envoyer une demande d'ami au Player donné.

<tbody>
  <tr>
    <td><code>joueur</code></td>
    <td><code>Class.Player</code></td>
    <td>(requis)</td>
    <td>Le joueur auquel la demande d'ami doit être envoyée.</td>
  </tr>
</tbody>

Supprimer l'ami

Invite le joueur actuel à supprimer un Player donné de sa liste d'amis.

<tbody>
  <tr>
    <td><code>joueur</code></td>
    <td><code>Class.Player</code></td>
    <td>(requis)</td>
    <td>Le joueur qui devrait être désamiti.</td>
  </tr>
</tbody>

Bloqueur de fenêtre

Invite le joueur actuel à bloquer le Player donné.

<tbody>
  <tr>
    <td><code>joueur</code></td>
    <td><code>Class.Player</code></td>
    <td>(requis)</td>
    <td>Le joueur qui devrait être bloqué.</td>
  </tr>
</tbody>

bloqueur de prom示

Invite le joueur actuel à débloquer le Player donné.

<tbody>
  <tr>
    <td><code>joueur</code></td>
    <td><code>Class.Player</code></td>
    <td>(requis)</td>
    <td>Le joueur qui devrait être débloqué.</td>
  </tr>
</tbody>

AvatarContextMenuActivé

Détermine si le Menu contextuel d'avatar est activé.

<tbody>
  <tr>
    <td><code>activé</code></td>
    <td>boîtier</td>
    <td>(requis)</td>
    <td>Détermine si le menu contextuel est activé.</td>
  </tr>
</tbody>

Mise à jour de l'avatar

Forcée d'ouvrir le Menu contextuel de l'avatar .

<tbody>
  <tr>
    <td><code>joueur</code></td>
    <td><code>Class.Player</code></td>
    <td>(requis)</td>
    <td>Le joueur sur lequel le menu contextuel sera ouvert.</td>
  </tr>
</tbody>

Ajouter un menu contextuel pour ajouter un avatar

Ajoute une option au Menu contextuel d'avatar .

<tbody>
  <tr>
    <td><code>option</code></td>
    <td><code>Menu contextuel d'avatar d'éntrée</code></td>
    <td>(requis)</td>
    <td>Option à ajouter.</td>
  </tr>

  <tr>
    <td colspan="4"><b>OU</b></td>
  </tr>

  <tr>
    <td><code>option</code></td>
    <td>table</td>
    <td>(requis)</td>
    <td>Une table à deux éléments, où le premier est le nom de l'action personnalisée, et le second est un <code>Class.BindableEvent</code> qui sera déclenché avec un joueur sélectionné lorsque l'option a été activée.</td>
  </tr>
</tbody>

Supprimer l'option contextuelle d'avatar

Supprime une option au Menu contextuel d'avatar. L'argument option doit être le même que ce qui était utilisé avec "AddAvatarContextMenuOption" (voir ci-dessus).

<tbody>
  <tr>
    <td><code>option</code></td>
    <td>Variante</td>
    <td>(requis)</td>
    <td>La même valeur fournie à <b>ajouter un menu contextuel d'avatar</b> .</td>
  </tr>
</tbody>

Menu du thème Avatar contextuel

Configure le avatar context menu personnalisable qui est un opt-in qui permet une interaction sociale facile entre les joueurs via des actions personnalisées, telles que l'initiation de transactions, des batailles et plus encore. Pour plus d'informations sur la façon de personnaliser son thème, voir l'article avatar context menu.

Connections à CoreGuiChat

Définit une connexion de mise en relation de la passerelle configurée entre le bouton de discussion de la barre supérieure de Class.CoreGui et le système de chat legacy. Le deuxième paramètre doit être une table de CoreGui et BindableEvents.

Paramètres

Retours

local StarterGui = game:GetService("StarterGui")

StarterGui:SetCore("AvatarContextMenuTheme", {
	BackgroundImage = "",
	BackgroundTransparency = 0.5,
	BackgroundColor = Color3.fromRGB(111, 145, 242),
	NameTagColor = Color3.fromRGB(0, 0, 200),
	NameUnderlineColor = Color3.fromRGB(213, 233, 255),
	ButtonFrameColor = Color3.fromRGB(15, 24, 65),
	ButtonFrameTransparency = 0.2,
	ButtonUnderlineColor = Color3.fromRGB(213, 233, 255),
	Font = Enum.Font.SciFi,
})

Cette fonction détermine si l'élément CoreGui associé avec le Enum.CoreGuiType donné est activé ou désactivé.

La barre supérieure ne peut pas être désactivée en utilisant cette fonction. Pour la désactiver, définissez "TopbarEnabled" à false en utilisant StarterGui:SetCore().

Paramètres

Retours

Cette méthode renvoie un tableau de données ou un élément de données créé par les scripts de base de Roblox. Le premier et seul paramètre est une chaîne qui sélectionne l'information à récupérer. Les sections suivantes décrivent les chaînes et les données qu'elle renvoie par cette fonction.

L'appel de cette méthode peut générer. Beaucoup d'entre elles enregistrent également une fonction équivalente SetCore() (ces derniers sont marqués d'un astérisque).

PointsNotificationsActifs *

Renvoie true si les notifications de points de joueur sont activées.

BadgesNotificationsActif *

Renvoie true si les notifications de badge sont activées.

AvatarContextMenuActivé *

Retourne true si le Avatar Context Menu est activé.

ChatActif *

Renvoie si le chat est actif ou non. Ceci est indiqué par l'état de sélection de l'icône de chat de la barre supérieure.

Taille de la fenêtre de chat *

Retourne la taille de la fenêtre de discussion comme un UDim2 .

Position de la fenêtre de chat *

Retourne la taille de la fenêtre de discussion comme un UDim2 .

ChatBarDisabled *

Retourne true si la barre de discussion est désactivée.

Obtenez les noms d'utilisateur bloqués

Renvoie une liste de UserIds associés aux utilisateurs qui ont été bloqués par le joueur local.

JoueurBloquéÉvénement

Retourne un BindableEvent qui est déclenché chaque fois qu'un joueur est bloqué par le joueur local.

Joueur non bloqué

Renvoie un BindableEvent qui est déclenché chaque fois qu'un joueur est débloqué par le joueur local.

Événement de joueur muet

Retourne un BindableEvent qui est déclenché chaque fois qu'un joueur est muet par le joueur local.

Événement de fin de la mutation

Retourne un BindableEvent qui est déclenché chaque fois qu'un joueur est désactivé par le joueur local.

Événement amical

Retourne un BindableEvent qui est déclenché chaque fois qu'un joueur est ami par le joueur local.

Événement PlayerUnfriended

Retourne un BindableEvent qui est déclenché chaque fois qu'un joueur est désamiti par le joueur local.

DevConsoleVisible *

Retourne true si la Console du développeur est visible.

Vitesse de rotation VR

Retourne une chaîne décrivant la sensibilité de rotation de la caméra dans VR : Low, High et Smooth. Cela ne sera pas disponible à moins que 1> Class.VRService.VREnabled1> soit 4> true4>.

Paramètres

Retours