StarterGui

Permet à StarterGui de traiter l'entrée comme PlayerGui et CoreGui de le faire. La valeur par défaut est false.

Cette propriété définit le mode d'orientation de l'é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 définie sur Sensor , ce qui signifie que l'expérience est affichée en fonction du meilleur match à l'orientation actuelle du appareil, soit paysage (gauche/droite) ou 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 PlayerGui.ScreenOrientation du joueur en conséquence.Vous pouvez également obtenir l'orientation actuelle de l'écran du joueur via PlayerGui.CurrentScreenOrientation, utile lors de l'utilisation de l'une des paramètres « capteur » Enum.ScreenOrientation.

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 changer l'orientation pour 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 la donnée Enum.CoreGuiType donnée est activée ou si elle a été désactivée en utilisant StarterGui:SetCoreGuiEnabled() .Cette fonction doit être appelée sur le client.

Notez que le paramètre "TopbarEnabled" à false en utilisant SetCore() cache tout CoreGuiTypes 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 (qui ne doit pas être confondue avec SetCoreGuiEnabled() ) expose une variété de fonctionnalités définies par les scripts du noyau de Roblox, telles que l'envoi de notifications, le basculement des notifications pour les badges/points, la définition d'un rappel pour le bouton de réinitialisation ou le basculement de la barre supérieure.

Le premier paramètre est une chaîne qui sélectionne la fonctionnalité avec laquelle l'appel interagira.Il peut être nécessaire d'appeler cette méthode plusieurs fois en utilisant pcall() en cas de script de noyau respectif n'ayant pas encore été chargé (ou s'il a été désactivé entièrement).

La table suivante décrit les chaînes qui peuvent être acceptées comme premier paramètre.Les paramètres qui devraient suivre dépendent de la fonctionnalité qui sera utilisée et sont décrits dans des sous-tables.

ChatActif

Contrôle si le chat est actif.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>actif</code></td>

    <td>booléen</td>

    <td>(nécessaire)</td>

    <td>Détermine si le chat doit être activé.</td>
  </tr>
</tbody>

Notifications de points actives

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

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>actif</code></td>

    <td>booléen</td>

    <td>(nécessaire)</td>

    <td>Détermine si les notifications pour les points de joueur gagnés apparaîtront ou non.</td>
  </tr>
</tbody>

BadgesNotificationsActif

Contrôle si les notifications pour les badges obtenus apparaissent ou non.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>actif</code></td>

    <td>booléen</td>

    <td>(nécessaire)</td>

    <td>Détermine si les notifications pour les badges obtenus apparaîtront ou non.</td>
  </tr>
</tbody>

Réinitialiser le bouton de rappel

Détermine le comportement, le cas échéant, du bouton de réinitialisation donné un booléen ou un BindableEvent à être déclenché lorsqu'un joueur demande de réinitialiser.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>activé</code></td>

    <td>booléen</td>

    <td>(nécessaire)</td>

    <td>Détermine si le bouton de réinitialisation conserve son comportement par défaut.</td>
  </tr>

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

  <tr>
    <td><code>rappel</code></td>

    <td><code>Class.BindableEvent</code></td>

    <td>(nécessaire)</td>

    <td>Un <code>Class.BindableEvent</code> à être déclenché lorsque le joueur confirme qu'il souhaite réinitialiser.</td>
  </tr>
</tbody>

Message de chat MakeSystem

Afficher un message formaté dans le chat.L'utilisation de cette méthode nécessite que l'expérience soit définie sur , bien que le chat hérité soit obsolète et que son utilisation soit découragée.Pour les expériences utilisant la version actuelle de TextChatService , référez-vous à TextChannel:DisplaySystemMessage() .

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>tableau de configuration</code></td>

    <td>dictionnaire</td>

    <td>(nécessaire)</td>

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

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Texte</code></td>

    <td>chaîne</td>

    <td>(nécessaire)</td>

    <td>Le message à afficher.</td>
  </tr>

  <tr>
    <td><code>Couleur</code></td>

    <td><code>Type de données.Couleur3</code></td>

    <td><code>Type de données.Color3.fromRGB(255, 255, 243)</code></td>

    <td>Couleur du texte du message.</td>
  </tr>

  <tr>
    <td><code>Police</code></td>

    <td><code>Enum.Font</code></td>

    <td><code>SourceSansBold</code></td>

    <td>La police du 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 une notification

Fait apparaître une notification non intrusive en bas à droite de l'écran. La notification peut comporter jusqu'à deux boutons.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>tableau de configuration</code></td>

    <td>dictionnaire</td>

    <td>(nécessaire)</td>

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

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Titre</code></td>

    <td>chaîne</td>

    <td>(nécessaire)</td>

    <td>Le titre de la notification.</td>
  </tr>

  <tr>
    <td><code>Texte</code></td>

    <td>chaîne</td>

    <td>(nécessaire)</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>numéro</td>

    <td><code>5</code></td>

    <td>La durée (en secondes) pendant laquelle la notification doit rester visible.</td>
  </tr>

  <tr>
    <td><code>Fonction de rappel</code></td><td><code>Classe.BindableFunction</code></td>

    <td />

    <td>Une classe <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>Bouton2</code></td><td>chaîne</td>

    <td />

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

Barre supérieure activée

Détermine si la barre supérieure est affichée.La désactivation de la barre supérieure désactivera également toutes les CoreGuis telles que le chat, l'inventaire et la liste des joueurs (par exemple, celles définies avec SetCoreGuiEnabled).

Lorsqu'il est désactivé, la région que la barre supérieure a autrefois occupée capturera toujours les événements de 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 en haut de l'écran.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>activé</code></td>

    <td>booléen</td>

    <td>(nécessaire)</td>

    <td>Détermine si la barre supérieure doit être visible.</td>
  </tr>
</tbody>

DevConsoleVisible

Détermine si la console de développeur est visible.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>visibilité</code></td>

    <td>booléen</td>

    <td>(nécessaire)</td>

    <td>Détermine si la console est visible.</td>
  </tr>
</tbody>

Demander une requête d'ami rapide

Demande au joueur actuel d'envoyer une demande d'ami à l'ami donné Player.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>joueur</code></td>

    <td><code>Class.Joueur</code></td>

    <td>(nécessaire)</td>

    <td>Le joueur auquel la demande d'ami devrait être envoyée.</td>
  </tr>
</tbody>

PromptUnfriend

Demande au joueur actuel de supprimer un certain Player de sa liste d'amis.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>joueur</code></td>

    <td><code>Class.Joueur</code></td>

    <td>(nécessaire)</td>

    <td>Le joueur qui devrait être désamicalisé.</td>
  </tr>
</tbody>

Joueur de bloc de rappel

Demande au joueur actuel de bloquer le Player.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>joueur</code></td>

    <td><code>Class.Joueur</code></td>

    <td>(nécessaire)</td>

    <td>Le joueur qui devrait être bloqué.</td>
  </tr>
</tbody>

Joueur de déblocage rapide

Demande au joueur actuel de débloquer le Player.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>joueur</code></td>

    <td><code>Class.Joueur</code></td>

    <td>(nécessaire)</td>

    <td>Le joueur qui devrait être débloqué.</td>
  </tr>
</tbody>

Menu contextuel d'avatar activé

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

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>activé</code></td>

    <td>booléen</td>

    <td>(nécessaire)</td>

    <td>Détermine si le menu contextuel est activé.</td>
  </tr>
</tbody>

Cible du menu contextuel d'avatar

Ouvre forcément le Menu contextuel d'avatar.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>joueur</code></td>

    <td><code>Class.Joueur</code></td>

    <td>(nécessaire)</td>

    <td>Le joueur sur lequel le menu contextuel sera ouvert.</td>
  </tr>
</tbody>

AjouterAvatarContextMenuOption

Ajoute une option au menu contextuel d'avatar.

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>option</code></td>

    <td><code>Enum.AvatarContextMenuOption</code></td>

    <td>(nécessaire)</td>

    <td>Option à ajouter.</td>
  </tr>

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

  <tr>
    <td><code>option</code></td>

    <td>tableau</td>

    <td>(nécessaire)</td>

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

Supprimer l'option de menu contextuel d'avatar

Supprime une option du menu contextuel d'avatar . L'argument doit être le même que celui utilisé avec (voir ci-dessus).

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>option</code></td>

    <td>Variante</td>

    <td>(nécessaire)</td>

    <td>La même valeur fournie à <b>AddAvatarContextMenuOption</b>.</td>
  </tr>
</tbody>

Thème du menu contextuel d'avatar

Configure le menu contextuel personnalisable Avatar qui est une fonctionnalité facultative qui permet une interaction sociale facile entre joueurs via des actions personnalisées, telles que l'initiation d'échanges, de batailles et plus encore.Pour plus d'informations sur la façon de personnaliser son thème, voir l'article Menu contextuel d'avatar.

Connexions de chat CoreGuiChat

Configure une connexion de passerelle bindable entre le bouton de chat de la barre supérieure CoreGui et le système de chat hérité.Le deuxième paramètre doit être une table de BindableEvents et BindableFunctions.

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éfinit si l'élément CoreGui associé au 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 ensemble de données ou rendu disponible par les scripts du noyau de Roblox.Le premier et le seul paramètre est une chaîne qui sélectionne les informations à récupérer.Les sections suivantes décrivent les chaînes et les données qu'elles retournent par cette fonction.

L'appel de cette méthode peut produire. Beaucoup d'entre elles enregistrent également une fonction équivalente SetCore() (elles sont marquées d'un astérisque).

Notifications de points actives *

Retourne true si les notifications de point du joueur sont activées.

BadgesNotificationsActif *

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

Menu contextuel d'avatar activé *

Retourne true si le menu contextuel d'avatar est activé.

ChatActif *

Renvoie si le chat est actif ou non. Cela 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 *

Renvoie la taille de la fenêtre de chat en tant que UDim2 .

Position de la fenêtre de chat *

Renvoie la taille de la fenêtre de chat en tant que UDim2 .

Bar de chat désactivé *

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

Obtenir les ID d'utilisateur bloqués

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

Événement de blocage du joueur

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

Événement débloqué du joueur

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

Événement de désactivation du joueur

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

Événement désactivé du joueur

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

Événement ami du joueur

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

Événement de désamitié du joueur

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

DevConsoleVisible *

Retourne true si la console de développeur est visible.

VRRotationIntensité

Renvoie une chaîne décrivant la sensibilité de la rotation de la caméra en VR : Low , High et Smooth .Cela ne sera pas disponible à moins que VRService.VREnabled ne soit true .

Paramètres

Retours