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 une manette de jeu ou Backslash définira automatiquement une interface graphique comme objet sélectionné.

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

    Active si les objets dans le CoreGui peuvent être navigés ou non à l'aide d'une manette de jeu.

  • Lecture parallèle

    Utilisé pour activer et désactiver la navigation du contrôleur par défaut GUI.

  • 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 les arrière-plans de certains éléments d'interface utilisateur doivent être opaques.L'utilisation recommandée est comme multiplicateur de la transparence arrière-plan d'un élément.Défaut à 1.

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

    Retourne true si l'utilisateur a activé la mobilité réduite. Par défaut, c'est false .

  • Lecture parallèle

    Définit l'objet Gui qui est actuellement mis en évidence par le navigateur GUI (utilisé pour les gamepads).

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

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

  • Lecture parallèle

    Utilisé pour activer et désactiver les contrôles tactiles et l'interface utilisateur de visualisation des contrôles tactiles. Par défaut, c'est vrai.

Méthodes

Évènements

Propriétés

AutoSelectGuiEnabled

Lecture parallèle

Si activé, le bouton Select sur une manette de jeu ou Backslash définira automatiquement une interface graphique comme objet sélectionné.Désactiver cela signifiera que la navigation Gui fonctionnera toujours si GuiService.GuiNavigationEnabled est activé, mais vous devrez définir GuiService.SelectedObject manuellement pour démarrer la navigation Gui.

CoreGuiNavigationEnabled

Caché
Non répliqué
Lecture parallèle

Active si les objets dans le CoreGui peuvent être navigés ou non à l'aide d'une manette de jeu.

GuiNavigationEnabled

Lecture parallèle

Utilisé pour activer et désactiver la navigation du contrôleur par défaut GUI.

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 veulent que le fond des éléments d'interface utilisateur soit plus opaque.Défaut à 1.

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 transparence arrière .La valeur par défaut est 1, ce qui indique que l'utilisateur préfère la transparence du fond par défaut.La valeur la plus basse est 0, ce qui indique que l'utilisateur préfère que les arrière-plans soient entièrement opaques, améliorant la lisibilité et le contraste pour l'interface utilisateur affectée.Multiplier l'élément GuiObject.BackgroundTransparency avec la valeur retournée de PreferredTransparency est la façon recommandée d'utiliser ce paramètre ; les arrière-plans deviendront plus opaques au fur et à mesure que PreferredTransparency approche 0.Cela devrait être utilisé avec Object:GetPropertyChangedSignal() afin qu'il soit mis à jour automatiquement lorsque l'utilisateur modifie sa transparence préférée.

É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

Retourne true si l'utilisateur a activé la mobilité réduite. Par défaut, c'est 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 supprimés complètement.

É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 mis en évidence par le navigateur GUI (utilisé pour les Gamepads). Cela peut être réinitialisé à nil 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

Renvoie un objet Rect représentant la zone non occupée entre les contrôles les plus à gauche de Roblox 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 d'interface utilisateur tels que le changement de la propriété Health du joueur local, de l'utilisation de StarterGui:SetCoreGuiEnabled() , du changement de la taille et de la position des contrôles d'interface utilisateur Roblox, et/ou d'autres.Pour cette raison, il est recommandé de détecter et de réagir aux modifications de cette propriété avec Object:GetPropertyChangedSignal() .

É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 contrôles tactiles et l'interface utilisateur de visualisation des contrôles tactiles. Par défaut, c'est vrai.

Méthodes

CloseInspectMenu

()

Cette fonction ferme le menu d'inspection, s'il est ouvert, lorsqu'il est exécuté à partir d'un LocalScript .

Voir aussi :

  • Menu d'inspection d'avatar, un article fournissant une explication plus détaillée de la fonction d'inspection et de l'achat et de la façon dont elle fonctionne
  • GuiService:InspectPlayerFromHumanoidDescription() , permet à un développeur d'ouvrir le menu Inspect montrant les ressources listé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 le même que son apparence dans le jeu
  • GuiService:InspectPlayerFromUserId() , permet au menu d'inspection d'apparaître en montrant à l'utilisateur qui a le UserId donné.Cela est particulièrement utile lorsque vous voulez inspecter des joueurs qui ne sont pas dans le jeu actuel

Retours

()

DismissNotification

Paramètres

notificationId: string
Valeur par défaut : ""

Retours

GetEmotesMenuOpen

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

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


Retours

Indique si le menu 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

Renvoie deux valeurs Vector2 représentant l'insertion des interfaces utilisateur en pixels, du coin supérieur gauche de l'écran et du coin inférieur droit de l'écran respectivement.

Les valeurs d'insertion fournies par cette fonction ne prennent effet que sur ScreenGuis celles qui ont leur propriété IgnoreGuiInset définie sur false.


Retours

Une tuple de deux valeurs Vector2 décrivant l'insertion Gui actuelle spécifiée.

GetInspectMenuEnabled

Cette fonction renvoie si la fonctionnalité du menu d'inspection et d'achat est actuellement activée.La fonctionnalité est activée par défaut et peut être définie en utilisant la fonction GuiService:SetInspectMenuEnabled().

Voir aussi :

  • Menu d'inspection d'avatar, un article fournissant une explication plus détaillée de la fonction d'inspection et de l'achat et de la façon dont elle fonctionne
  • GuiService:InspectPlayerFromHumanoidDescription() , permet à un développeur d'ouvrir le menu Inspect montrant les ressources listé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 le même que son apparence dans le jeu
  • GuiService:InspectPlayerFromUserId() , permet au menu d'inspection d'apparaître en montrant à l'utilisateur qui a le UserId donné.Cela est particulièrement utile lorsque vous voulez inspecter des joueurs qui ne sont pas dans le jeu actuel

Retours

Un booléen indiquant si la fonctionnalité du menu d'inspection est activée.

InspectPlayerFromHumanoidDescription

()

Cette fonction permet à un développeur d'ouvrir le menu Inspect montrant les ressources listées dans cet HumanoidDescription.

Cela permet une plus grande personnalisation avec ce qui est affiché dans le menu d'inspection 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'inspecteur un objet de description humanoïde qui représente ce que porte un joueur et ces articles seront affichés.Vous devez également passer un nom pour représenter le nom du joueur qui sera inspecté.

Voir aussi :

  • Menu d'inspection d'avatar, un article fournissant une explication plus détaillée de la fonction d'inspection et de l'achat et de la façon dont elle fonctionne
  • GuiService:SetInspectMenuEnabled() , permet aux développeurs d'activer ou de désactiver la fonctionnalité d'inspection et d'achat par défaut
  • GuiService:InspectPlayerFromUserId() , permet au menu d'inspection d'apparaître en montrant à l'utilisateur qui a le UserId donné.Cela est particulièrement utile lorsque vous voulez inspecter des joueurs qui ne sont pas dans le jeu actuel.

Paramètres

humanoidDescription: Instance

Un objet HumanoidDescription qui contient les ressources à afficher dans le menu d'inspection.

Valeur par défaut : ""
name: string

Le nom du joueur qui est inspecté pour être affiché dans le menu d'inspection.

Valeur par défaut : ""

Retours

()

É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

()

Cette fonction permet au menu d'inspection d'apparaître en montrant à l'utilisateur qui a le UserId donné.Cela est particulièrement utile lorsque vous voulez inspecter des joueurs qui ne sont pas dans le jeu actuel.

Cela affiche les mêmes informations que l'onglet "Porte actuellement" sur le profil de l'utilisateur spécifié.

Voir aussi :

  • Menu d'inspection d'avatar, un article fournissant une explication plus détaillée de la fonction d'inspection et de l'achat et de la façon dont elle fonctionne
  • GuiService:SetInspectMenuEnabled() , permet aux développeurs d'activer ou de désactiver la fonctionnalité d'inspection 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 le même que son apparence dans le jeu
  • GuiService:InspectPlayerFromHumanoidDescription() , permet à un développeur d'ouvrir le menu Inspect montrant les ressources listées dans cet objet HumanoidDescription

Paramètres

userId: number

Le UserId du joueur à inspecter.

Valeur par défaut : ""

Retours

()

Échantillons de code

Opening the Inspect Menu for a UserId

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

IsTenFootInterface

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


Retours

Select

()

Lorsque Select est appelé sur une sélection d'instanceParent qui est PlayerGui ou un descendant de PlayerGui, le moteur recherche tous les GuiObjects sélectionnables, visibles et à l'écran disponibles qui sont des descendants de selectionParent et définit le GuiService.SelectedObject sur le GuiObject avec le plus petit GuiService.SelectionOrder.

Paramètres

selectionParent: Instance

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

Valeur par défaut : ""

Retours

()

É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
Valeur par défaut : ""

Retours

SetEmotesMenuOpen

()

Ouvre ou ferme le menu Emotes du joueur.

Paramètres

isOpen: boolean
Valeur par défaut : ""

Retours

()

SetGameplayPausedNotificationEnabled

()

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

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

Voir aussi :

Paramètres

enabled: boolean

Si oui ou non la notification intégrée GUI est désactivée.

Valeur par défaut : ""

Retours

()

SetInspectMenuEnabled

()

Cette fonction permet aux développeurs d'activer ou de désactiver la fonction d'inspection et d'achat par défaut.Cela est utile lorsque vous souhaitez désactiver la fonctionnalité dans votre jeu, entièrement ou pendant certaines parties de votre jeu (comme une scène coupée).La fonction est activée par défaut.

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


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

Voir aussi :

  • Menu d'inspection d'avatar, un article fournissant une explication plus détaillée de la fonction d'inspection et de l'achat et de la façon dont elle fonctionne
  • GuiService:InspectPlayerFromHumanoidDescription() , permet à un développeur d'ouvrir le menu Inspect montrant les ressources listé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 le même que son apparence dans le jeu
  • GuiService:InspectPlayerFromUserId() , permet au menu d'inspection d'apparaître en montrant à l'utilisateur qui a le UserId donné.Cela est particulièrement utile lorsque vous voulez inspecter des joueurs qui ne sont pas dans le jeu actuel

Paramètres

enabled: boolean

Un booléen indiquant si activer ou désactiver la fonctionnalité du fonctionalitéd'inspection.

Valeur par défaut : ""

Retours

()

Évènements

S'enflamme 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.