GuiService

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.

Création impossible
Service
Non répliqué

GuiService permet aux développeurs de contrôler ce que GuiObject est actuellement sélectionné par le navigateur du gamepad, ainsi que de vérifier si le menu principal de Roblox est actuellement ouvert.

Résumé

Propriétés

  • Lecture parallèle

    Si activé, le bouton Select sur un Gamepad ou Backslash définira automatiquement une GUI comme l'objet sélectionné.

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

    Bascule si les objets dans le CoreGui peuvent ou non être navigés à l'aide d'un Gamepad.

  • Lecture parallèle

    Utilisé pour activer et désactiver la navigation de l'interface utilisateur par défaut.

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

    Retourne vrai si un menu de CoreGui est ouvert.

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

    Obtient la transparence préférée de l'utilisateur comme un nombre entre 0 et 1, ce qui indique à quel point ils souhaitent que les arrière-plans de certains éléments de l'interface utilisateur soient opaques. L'utilisation recommandée est comme un multiplicateur de la transparence de l'arrière-plan d'un élément. Par défaut, 1.

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

    Renvoie true si l'utilisateur a activé la réduction du mouvement. Par défaut, renvoie false.

  • Lecture parallèle

    Définit l'objet GuiObject actuellement focalisé par le GUI Navigator (utilisé pour les Gamepads).

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

    Utilisé pour déterminer la taille et la position absolue de la zone non bloquée dans l'espace de la barre supérieure.

  • Lecture parallèle

    Utilisé pour activer et désactiver les commandes de touche et l'affichage de l'interface utilisateur de commande de touche. Par défaut, est vrai.

Méthodes

Évènements

Propriétés

AutoSelectGuiEnabled

Lecture parallèle

Si activé, le bouton Select sur un Gamepad ou Backslash définira automatiquement un GUI comme l'objet sélectionné. Turning this off will mean that Gui navigation will still work if GuiService.GuiNavigationEnabled is enabled but you will have to set 1> Class.GuiService.SelectedObject1> manuellement pour démarrer la navigation Gui.

CoreGuiNavigationEnabled

Caché
Non répliqué
Lecture parallèle

Bascule si les objets dans le CoreGui peuvent ou non être navigés à l'aide d'un Gamepad.

GuiNavigationEnabled

Lecture parallèle

Utilisé pour activer et désactiver la navigation de l'interface utilisateur par défaut.

Lecture uniquement
Non répliqué
Lecture parallèle

Retourne vrai si un menu de CoreGui est ouvert.

PreferredTextSize

Lecture uniquement
Non répliqué
Lecture parallèle

PreferredTransparency

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

Obtient la transparence préférée de l'utilisateur comme un nombre entre 0 et 1, ce qui indique à quel point ils souhaitent que la base des éléments de l'interface utilisateur soit opaque. Par défaut, 1.

Échantillons de code

Use Preferred Transparency

local DEFAULT_TRANSPARENCY = 0.5
local frame = script.Parent
local function setBackgroundTransparency()
frame.BackgroundTransparency = DEFAULT_TRANSPARENCY * GuiService.PreferredTransparency
end
GuiService:GetPropertyChangedSignal("PreferredTransparency"):Connect(setBackgroundTransparency)
setBackgroundTransparency()

ReducedMotionEnabled

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

Renvoie true si l'utilisateur a activé la réduction du mouvement. Par défaut, renvoie false.

Cette valeur de retour reflète un paramètre qui peut être défini du côté de l'utilisateur dans les paramètres de l'application ou dans le menu des paramètres d'expérience via Réduire le mouvement . Une valeur de true indique que l'utilisateur souhaite que les effets de mouvement et les animations soient réduits ou complètement supprimés.

Échantillons de code

Use Reduced Motion

local DEFAULT_TRANSPARENCY = 0.5
local frame = script.Parent
local endPosition = UDim2.fromScale(0.5, 0.8)
if GuiService.ReducedMotionEnabled then
frame.Position = endPosition
else
local moveTweenInfo = TweenInfo.new(0.5)
local moveTweenProps = {
Position = endPosition
}
local moveTween = TweenService:Create(frame, slideInTweenInfo, slideInTweenProps)
moveTween:Play()
end

SelectedObject

Lecture parallèle

Définit le GuiObject actuellement focalisé sur par le GUI Navigator (utilisé pour les Gamepads). Cela peut se réinitialiser à zéro si l'objet est hors-écran.

Cette propriété est modifiée par les événements GuiObject.SelectionGained et GuiObject.SelectionLost.

Si vous souhaitez déterminer quand cette propriété change sans suivre les événements SelectionGained et SelectionLost pour tous les éléments de l'interface graphique, vous pouvez utiliser l'événement Changed.

Échantillons de code

Printing When Gamepad Selection Changes

local GuiService = game:GetService("GuiService")
local function printChanged(value)
if value == "SelectedObject" then
print("The SelectedObject changed!")
end
end
GuiService.Changed:Connect(printChanged)

TopbarInset

Lecture uniquement
Non répliqué
Lecture parallèle

Retourne un objet Rect représentant la zone non occupée entre les commandes Roblox à gauche et le bord de la zone de sécurité de l'appareil.

La valeur est dynamique et peut être attendue à changer en fonction de la visibilité des contrôles de l'interface utilisateur tels que le changement de la propriété Health du joueur local, l'utilisation de StarterGui:SetCoreGuiEnabled() et le changement de la taille et de la position des contrôles de l'interface utilisateur Rob

Échantillons de code

Responsive Frame Within Available Top Bar Space

local GuiService = game:GetService("GuiService")
local Players = game:GetService("Players")
local screenGui = Instance.new("ScreenGui")
screenGui.IgnoreGuiInset = true
screenGui.Parent = Players.LocalPlayer.PlayerGui
local frame = Instance.new("Frame")
frame.BackgroundColor3 = Color3.fromRGB(0, 255, 0)
frame.Parent = screenGui
GuiService:GetPropertyChangedSignal("TopbarInset"):Connect(function()
local inset = GuiService.TopbarInset
frame.Size = UDim2.new(0, inset.Width, 0, inset.Height)
frame.Position = UDim2.new(0, inset.Min.X, 0, inset.Min.Y)
end)

TouchControlsEnabled

Lecture parallèle

Utilisé pour activer et désactiver les commandes de touche et l'affichage de l'interface utilisateur de commande de touche. Par défaut, est vrai.

Méthodes

CloseInspectMenu

void

Cette fonction ferme le menu Inspecter, si oui, lorsque vous exécutez un LocalScript .

Voir aussi :

  • Avatar Inspect Menu , un article fournissant une explication plus détaillée de la fonction Inspect et Buy et comment elle fonctionne
  • GuiService:InspectPlayerFromHumanoidDescription() , permet à un développeur de faire apparaître le menu Inspect affichant les ressources répertoriées dans cet objet HumanoidDescription . Ceci est particulièrement utile lorsque ce qui est porté sur l'avatar d'un joueur sur la plate-forme Roblox n'est pas nécessairement la même que leur apparence dans le jeu
  • GuiService:InspectPlayerFromUserId() , permet au menu d'inspecter d'afficher l'utilisateur qui a le UserId donné. Ceci est utile lorsque vous voulez inspecter les joueurs qui ne sont pas dans le jeu actuel

Retours

void

DismissNotification

Paramètres

notificationId: string

Retours

GetEmotesMenuOpen

Renvoie un booléen indiquant si oui ou non le menu Emotes du joueur est ouvert.

Les développeurs peuvent ouvrir ou fermer le menu Emotes en appelant la fonction GuiService:SetEmotesMenuOpen().


Retours

Indique si le menu des emotes est ouvert.

GetGameplayPausedNotificationEnabled

Cette fonction renvoie si oui ou non la notification gameplay paused a été désactivée par le développeur.

Les développeurs peuvent activer ou désactiver la notification en appelant la fonction GuiService:SetGameplayPausedNotificationEnabled().

Voir aussi :


Retours

Que la notification gameplay paused soit désactivée ou non.

GetGuiInset

Retourne deux valeurs Vector2 représentant l'insérer des utilisateurs GUIs en pixels, du coin supérieur gauche de l'écran et du coin inférieur droit de l'écran respectivement.

Les valeurs d'insérat fournies par cette fonction n'ont effet que sur ScreenGuis qui ont leur IgnoreGuiInset propriété définie sur false.


Retours

Un tableau de deux valeurs Vector2 décrivant l'emplacement actuel de l'interface graphique spécifiée.

GetInspectMenuEnabled

Cette fonction renvoie si la fonctionnalité Inspect and Buy est actuellement activée. La fonction est activée par défaut et peut être configurée en utilisant la fonction GuiService:SetInspectMenuEnabled().

Voir aussi :

  • Avatar Inspect Menu , un article fournissant une explication plus détaillée de la fonction Inspect et Buy et comment elle fonctionne
  • GuiService:InspectPlayerFromHumanoidDescription() , permet à un développeur de faire apparaître le menu Inspect affichant les ressources répertoriées dans cet objet HumanoidDescription . Ceci est particulièrement utile lorsque ce qui est porté sur l'avatar d'un joueur sur la plate-forme Roblox n'est pas nécessairement la même que leur apparence dans le jeu
  • GuiService:InspectPlayerFromUserId() , permet au menu d'inspecter d'afficher l'utilisateur qui a le UserId donné. Ceci est utile lorsque vous voulez inspecter les joueurs qui ne sont pas dans le jeu actuel

Retours

Un bouton indiquant si la fonction Inspecter du menu est activée.

InspectPlayerFromHumanoidDescription

void

Cette fonction permet à un développeur de faire apparaître le menu Inspect affichant les ressources répertoriées dans cet objet HumanoidDescription .

Cela permet une further personnalisation avec ce qui est affiché dans le menu Inspect lorsque les joueurs inspectent d'autres joueurs dans votre jeu. Si votre jeu modifie ce que les joueurs portent, vous pouvez plutôt donner à l'Inspect Menu un objet de description humanoïde qui représente ce qu'un joueur porte et ces articles seront affichés. Vous devriez également passer un nom pour représenter le nom du joueur qui sera inspecté.

Voir aussi :

  • Avatar Inspect Menu , un article fournissant une explication plus détaillée de la fonction Inspect et Buy et comment elle fonctionne
  • GuiService:SetInspectMenuEnabled() , permet aux développeurs d'activer ou de désactiver les fonctionnalités d'inspection et d'achat par défaut
  • GuiService:InspectPlayerFromUserId() , permet au menu d'inspecter d'afficher l'utilisateur qui a le UserId donné. Ceci est utile lorsque vous voulez inspecter les joueurs qui ne sont pas dans le jeu actuel.

Paramètres

humanoidDescription: Instance

Un objet HumanoidDescription qui contient les ressources à afficher dans le menu Inspect.

name: string

Le nom du joueur qui sera inspecté pour s'afficher dans le menu Inspect.


Retours

void

Échantillons de code

Opening an Inspect Menu with a HumanoidDescription

local GuiService = game:GetService("GuiService")
local humanoidDescription = Instance.new("HumanoidDescription")
humanoidDescription.HatAccessory = "3339374070"
humanoidDescription.BackAccessory = "3339363671"
GuiService:InspectPlayerFromHumanoidDescription(humanoidDescription, "MyPlayer")

InspectPlayerFromUserId

void

Cette fonction permet au menu d'inspecter d'afficher l'utilisateur qui a le UserId donné. Ceci est particulièrement utile lorsque vous voulez inspecter les joueurs qui ne sont pas dans le jeu actuel.

Ceci affiche les mêmes informations que l'onglet "Actuellement porter" sur le profil de l'utilisateur spécifié.

Voir aussi :

  • Avatar Inspect Menu , un article fournissant une explication plus détaillée de la fonction Inspect et Buy et comment elle fonctionne
  • GuiService:SetInspectMenuEnabled() , permet aux développeurs d'activer ou de désactiver la fonctionnalité d'inspecte et d'achat par défaut. Ceci est particulièrement utile lorsque ce qui est porté sur l'avatar d'un joueur sur la plate-forme Roblox n'est pas nécessairement la même que leur apparence dans le jeu
  • GuiService:InspectPlayerFromHumanoidDescription() , permet à un développeur de faire apparaître le menu Inspect affichant les ressources répertoriées dans cet objet HumanoidDescription

Paramètres

userId: number

Le UserId du joueur à inspecter.


Retours

void

Échantillons de code

Opening the Inspect Menu for a UserId

local GuiService = game:GetService("GuiService")
GuiService:InspectPlayerFromUserId(772462)

IsTenFootInterface

Retourne vrai si le client utilise l'interface de dix pieds, qui est une version spéciale de l'interface de Roblox, exclusive aux consoles. Ceci est la seule façon garantie de vérifier si l'utilisateur est sur une console ou pas.


Retours

Select

void

Lorsque Select est appelé sur un instance selectionParent qui est PlayerGui ou un descendant de PlayerGui, le moteur recherche tous les GuiObjects sélectionnables, visibles et sur l'écran qui sont les descendants de sélectionParent et définit le GuiService.SelectedObject à l'objet Gui avec le plus petit GuiService.SelectionOrder .

Paramètres

selectionParent: Instance

Le parent de la sélection dont les descendants sont recherchés.


Retours

void

Échantillons de code

Use Preferred Transparency

local DEFAULT_TRANSPARENCY = 0.5
local frame = script.Parent
local function setBackgroundTransparency()
frame.BackgroundTransparency = DEFAULT_TRANSPARENCY * GuiService.PreferredTransparency
end
GuiService:GetPropertyChangedSignal("PreferredTransparency"):Connect(setBackgroundTransparency)
setBackgroundTransparency()

SendNotification

Paramètres

notificationInfo: Dictionary

Retours

SetEmotesMenuOpen

void

Ouvre ou ferme le menu Emotes du joueur.

Paramètres

isOpen: bool

Retours

void

SetGameplayPausedNotificationEnabled

void

Cette méthode permet aux développeurs de désactiver la notification intégrée lorsqu'un jeu de joueur est interrompu. Ils peuvent ensuite ajouter leur propre interface utilisateur si ils le souhaitent.

Les développeurs peuvent obtenir si la notification est activée en appelant la fonction GuiService:GetGameplayPausedNotificationEnabled().

Voir aussi :

Paramètres

enabled: bool

Que la notification GUI intégrée soit ou non désactivée.


Retours

void

SetInspectMenuEnabled

void

Cette fonctionnalité permet aux développeurs d'activer ou de désactiver la fonctionnalité Inspect and Buy par défaut. Ceci est utile lorsque vous souhaitez désactiver la fonctionnalité dans votre jeu, entièrement ou pendant certaines parties de votre jeu (tel qu'un cutscene). La fonctionnalité est activée par défaut.

L'exemple de code ci-dessous montre comment désactiver le menu Inspecter pour votre jeu :


local GuiService = game:GetService("GuiService")
GuiService:SetInspectMenuEnabled(false)

Voir aussi :

  • Avatar Inspect Menu , un article fournissant une explication plus détaillée de la fonction Inspect et Buy et comment elle fonctionne
  • GuiService:InspectPlayerFromHumanoidDescription() , permet à un développeur de faire apparaître le menu Inspect affichant les ressources répertoriées dans cet objet HumanoidDescription . Ceci est particulièrement utile lorsque ce qui est porté sur l'avatar d'un joueur sur la plate-forme Roblox n'est pas nécessairement la même que leur apparence dans le jeu
  • GuiService:InspectPlayerFromUserId() , permet au menu d'inspecter d'afficher l'utilisateur qui a le UserId donné. Ceci est utile lorsque vous voulez inspecter les joueurs qui ne sont pas dans le jeu actuel

Paramètres

enabled: bool

Un bouton indiquant si vous souhaitez activer ou désactiver la fonction Inspecter du fonctionalité.


Retours

void

Évènements

Se déclenche lorsque l'utilisateur ferme le menu d'évasion du noyau Roblox.


Se déclenche lorsque l'utilisateur ouvre le menu d'évasion du noyau Roblox.