GuiService

Veraltete anzeigen

*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Nicht erstellbar
Dienst
Nicht repliziert

GuiService ermöglicht es Entwicklern, zu überprüfen, was GuiObject derzeit vom Gamepad-Navigator ausgewählt wird, sowie zu überprüfen, ob das Hauptmenü von Roblox derzeit geöffnet ist.

Zusammenfassung

Eigenschaften

  • Wenn aktiviert, wird die Select Schaltfläche auf einem Gamepad oder Backslash automatisch eine GUI als ausgewähltes Objekt festlegen.

  • Verborgen
    Nicht repliziert
    Parallel lesen

    Schaltet ab, ob Objekte in der CoreGui mit einem Gamepad navigiert werden können oder nicht.

  • Wird verwendet, um die Standard-Controller-GUI-Navigation zu aktivieren und zu deaktivieren.

  • Schreibgeschützt
    Nicht repliziert
    Parallel lesen

    Gibt wahr zurück, wenn eines der Menüs von CoreGui geöffnet ist.

  • Schreibgeschützt
    Nicht repliziert
    Parallel lesen
  • Verborgen
    Schreibgeschützt
    Nicht repliziert
    Parallel lesen

    Hält die bevorzugte Transparenz des Benutzers als Zahl zwischen 0 und 1 fest, die anzeigt, wie undurchsichtig er die Hintergründe bestimmter UI-Elemente haben möchte.Die empfohlene Verwendung ist als Multiplikator der Hintergrundtransparenz eines Elements.Standard auf 1.

  • Verborgen
    Schreibgeschützt
    Nicht repliziert
    Parallel lesen

    Gibt true zurück, wenn der Benutzer reduzierte Bewegung aktiviert hat. Standard ist false .

  • Legt das GuiObject fest, auf das sich der GUI-Navigator derzeit konzentriert (wird für Gamepads verwendet).

  • Schreibgeschützt
    Nicht repliziert
    Parallel lesen

    Wird verwendet, um die absolute Größe und Position des ungestörten Bereichs innerhalb des oberen Platzzu bestimmen.

  • Wird verwendet, um Touch-Steuerelemente und Touch-Steuerelementanzeige-Benutzeroberfläche zu aktivieren und zu deaktivieren. Standard ist auf wahr.

Methoden

Ereignisse

Eigenschaften

AutoSelectGuiEnabled

Parallel lesen

Wenn aktiviert, wird die Select Schaltfläche auf einem Gamepad oder Backslash automatisch eine GUI als ausgewähltes Objekt festlegen.Das Ausschalten bedeutet, dass die Gui-Navigation immer noch funktioniert, wenn GuiService.GuiNavigationEnabled aktiviert ist, aber Sie müssen GuiService.SelectedObject manuell festlegen, um die Gui-Navigation zu starten.

CoreGuiNavigationEnabled

Verborgen
Nicht repliziert
Parallel lesen

Schaltet ab, ob Objekte in der CoreGui mit einem Gamepad navigiert werden können oder nicht.

GuiNavigationEnabled

Parallel lesen

Wird verwendet, um die Standard-Controller-GUI-Navigation zu aktivieren und zu deaktivieren.

Schreibgeschützt
Nicht repliziert
Parallel lesen

Gibt wahr zurück, wenn ein Menü von CoreGui geöffnet ist.

PreferredTextSize

Schreibgeschützt
Nicht repliziert
Parallel lesen

PreferredTransparency

Verborgen
Schreibgeschützt
Nicht repliziert
Parallel lesen

Hält die bevorzugte Transparenz des Benutzers als eine Zahl zwischen 0 und 1 fest, die anzeigt, wie viel undurchsichtiger sie den Hintergrund von UI-Elementen machen möchten.Standard auf 1.

Dieser Rückgabewert spiegelt eine Einstellung wider, die vom Benutzer auf der Seite der App-Einstellungen oder innerhalb des Erlebniseinstellungsmenüs über Hintergrundtransparenz festgelegt werden kann.Der Standardwert ist 1, was bedeutet, dass der Benutzer den Standard-Hintergrundtransparenzpreferiert.Der niedrigste Wert ist 0, was darauf hinweist, dass der Benutzer Präferenzen hat, dass Hintergründe vollständig undurchsichtig sind, was die Lesbarkeit und den Kontrast für die betroffene UI verbessert.Die Multiplikation eines Elements mit dem Wert, der aus zurückgegeben wird, ist die empfohlene Art, diese Einstellung zu verwenden; Hintergründe werden opaker, wenn sich 0 nähert.Dies sollte mit Object:GetPropertyChangedSignal() verwendet werden, damit es automatisch aktualisiert wird, wenn der Benutzer seine bevorzugte Transparenz ändert.

Code-Beispiele

Uses the user's value for GuiService.PreferredTransparency by combining it with the desired default background transparency. Also automatically updates the background transparency whenever the user changes their preferred transparency.

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

Verborgen
Schreibgeschützt
Nicht repliziert
Parallel lesen

Gibt true zurück, wenn der Benutzer reduzierte Bewegung aktiviert hat. Standard ist false .

Dieser Rückgabewert spiegelt eine Einstellung wider, die vom Benutzer auf der Seite der App-Einstellungen oder innerhalb des Erlebniseinstellungsmenüs über Bewegungsreduzierung festgelegt werden kann.Ein Wert von true zeigt an, dass der Benutzer möchte, dass Bewegungseffekte und Animationen reduziert oder vollständig entfernt werden.

Code-Beispiele

Uses the user's value for GuiService.ReducedMotionEnabled by instantly transitioning the frame instead of animating it, if the value of Reduced Motion is true.

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

Parallel lesen

Legt das GuiObject fest, auf das sich der GUI-Navigator (für Gamepads verwendet) derzeit konzentriert. Dies kann auf nil zurückgesetzt werden, wenn das Objekt außerhalb des Bildschirms ist.

Diese Eigenschaft wird durch die GuiObject.SelectionGained- und GuiObject.SelectionLost-Ereignisse geändert.

Wenn Sie bestimmen möchten, wann sich diese Eigenschaft ohne die Verfolgung der Ereignisse SelectionGained und SelectionLost für alle GUI-Elemente ändert, können Sie das Changed-Ereignis verwenden.

Code-Beispiele

The code below demonstrates how to handle when the SelectedObject changes. For instance, this event fires when the Gamepad navigates to another GUI element.

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

Schreibgeschützt
Nicht repliziert
Parallel lesen

Gibt ein Rect Objekt zurück, das den unbesetzten Bereich zwischen den Roblox-linksten Steuerelementen und dem Rand des Gerät-Sicherheitsbereichs darstellt.

Der Wert ist dynamisch und kann sich ändern, basierend auf der Sichtbarkeit von UI-Steuerelementen wie Ändern der Eigenschaftendes lokalen Spieler:inHealth, Verwendung von StarterGui:SetCoreGuiEnabled() , Ändern der Größe und Position von Roblox-UI-Steuerelementen und/oder anderen.Aus diesem Grund wird empfohlen, Änderungen dieser Eigenschaft mit Object:GetPropertyChangedSignal() zu erkennen und zu reagieren.

Code-Beispiele

This code snippet creates a new ScreenGui with a Frame that automatically adapts its size and position to a top bar space unoccupied by Roblox UI.

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

Parallel lesen

Wird verwendet, um Touch-Steuerelemente und Touch-Steuerelementanzeige-Benutzeroberfläche zu aktivieren und zu deaktivieren. Standard ist auf wahr.

Methoden

CloseInspectMenu

()

Diese Funktion schließt das Inspektionsmenü, wenn es geöffnet ist, wenn es von einem LocalScript ausgeführt wird.

Siehe auch:

  • Avatar-Inspektionsmenü, ein Artikel, der eine detailliertere Erklärung der Funktionen Inspektion und Kauf und wie sie funktionieren liefert
  • GuiService:InspectPlayerFromHumanoidDescription() , ermöglicht es einem Entwickler, das Inspektionsmenü aufzurufen, das die in diesem HumanoidDescription Objekt aufgelisteten Assets anzeigt.Dies ist besonders nützlich, wenn das, was auf dem Avatar eines Spieler:inauf der Roblox-Plattform getragen wird, nicht unbedingt mit seinem Aussehenim Spiel gleich ist
  • GuiService:InspectPlayerFromUserId() , ermöglicht es, dass das Inspektionsmenü angezeigt wird, um den Benutzer zu zeigen, der die angegebene UserId hat.Dies ist besonders nützlich, wenn du Spieler inspizieren möchtest, die nicht im aktuellen Spiel sind

Rückgaben

()

DismissNotification

Parameter

notificationId: string
Standardwert: ""

Rückgaben

GetEmotesMenuOpen

Gibt einen booleschen zurück, der anzeigt, ob das Spieler-Emotes-Menü geöffnet ist oder nicht.

Entwickler können das Emotes-Menü öffnen oder schließen, indem sie die GuiService:SetEmotesMenuOpen()-Funktion aufrufen.


Rückgaben

Zeigt an, ob das Emotes-Menü geöffnet ist.

GetGameplayPausedNotificationEnabled

Diese Funktion gibt zurück, ob die gameplay paused Benachrichtigung vom Entwickler deaktiviert wurde oder nicht.

Entwickler können die Benachrichtigung aktivieren oder deaktivieren, indem sie die GuiService:SetGameplayPausedNotificationEnabled()-Funktion aufrufen.

Siehe auch:


Rückgaben

Ob die gameplay paused Benachrichtigung deaktiviert wurde oder nicht.

GetGuiInset

Gibt zwei Vector2 Werte zurück, die die Einfügung von Benutzeroberflächen in Pixel darstellen, aus der oberen linken Ecke des Bildschirms und der unteren rechten Ecke des Bildschirms jeweils.

Die eingabe Werte, die von dieser Funktion bereitgestellt werden, treten nur dann in Kraft, wenn ScreenGuis ihre IgnoreGuiInset Eigenschaft auf false gesetzt ist.


Rückgaben

Eine Tuplizität von zwei Vector2-Werten, die die derzeit angegebene Gui-Einlage beschreiben.

GetInspectMenuEnabled

Diese Funktion gibt zurück, ob die Funktionalität von Inspektion und Kauf derzeit aktiviert ist.Die Funktion ist standardmäßig aktiviert und kann mit der Funktion GuiService:SetInspectMenuEnabled() festgelegt werden.

Siehe auch:

  • Avatar-Inspektionsmenü, ein Artikel, der eine detailliertere Erklärung der Funktionen Inspektion und Kauf und wie sie funktionieren liefert
  • GuiService:InspectPlayerFromHumanoidDescription() , ermöglicht es einem Entwickler, das Inspektionsmenü aufzurufen, das die in diesem HumanoidDescription Objekt aufgelisteten Assets anzeigt.Dies ist besonders nützlich, wenn das, was auf dem Avatar eines Spieler:inauf der Roblox-Plattform getragen wird, nicht unbedingt mit seinem Aussehenim Spiel gleich ist
  • GuiService:InspectPlayerFromUserId() , ermöglicht es, dass das Inspektionsmenü angezeigt wird, um den Benutzer zu zeigen, der die angegebene UserId hat.Dies ist besonders nützlich, wenn du Spieler inspizieren möchtest, die nicht im aktuellen Spiel sind

Rückgaben

Ein boolescher Indikator, der anzeigt, ob die Inspektmenü-Funktion aktiviert ist.

InspectPlayerFromHumanoidDescription

()

Diese Funktion ermöglicht es einem Entwickler, das Inspektionsmenü anzuzeigen, das die in diesem HumanoidDescription zeigt.

Dies ermöglicht eine weitere Anpassung mit dem, was im Inspektionsmenü angezeigt wird, wenn Spieler andere Spieler in deinem Spiel inspizieren.Wenn dein Spiel modifiziert, was die Spieler tragen, kannst du stattdessen dem Inspektionsmenü ein HumanoidDescription-Objekt geben, das darstellt, was ein Spieler trägt, und diese Artikel werden angezeigt.Du solltest auch einen Namen übergeben, um den Namen des Spielers zu repräsentieren, der überprüft wird.

Siehe auch:

  • Avatar-Inspektionsmenü, ein Artikel, der eine detailliertere Erklärung der Funktionen Inspektion und Kauf und wie sie funktionieren liefert
  • GuiService:SetInspectMenuEnabled() , ermöglicht es Entwicklern, die Standard-Inspektion und -Kauf-Funktionalität zu aktivieren oder zu deaktivieren
  • GuiService:InspectPlayerFromUserId() , ermöglicht es, dass das Inspektionsmenü angezeigt wird, um den Benutzer zu zeigen, der die angegebene UserId hat.Dies ist besonders nützlich, wenn du Spieler inspizieren möchtest, die nicht im aktuellen Spiel sind.

Parameter

humanoidDescription: Instance

Ein HumanoidDescription Objekt, das die Assets enthält, die im Inspektionsmenü angezeigt werden sollen.

Standardwert: ""
name: string

Der Name des Spielers, der im Inspektionsmenü angezeigt wird.

Standardwert: ""

Rückgaben

()

Code-Beispiele

This example demonstrates how to show an Inspect Menu containing two items (Midnight Antlers and Mid-Summer Starry Wings), for a player named MyPlayer using GuiService:InspectPlayerFromHumanoidDescription.

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

()

Diese Funktion ermöglicht es, dass das Inspektionsmenü angezeigt wird, um den Benutzer zu zeigen, der die angegebene UserId hat.Dies ist besonders nützlich, wenn du Spieler inspizieren möchtest, die nicht im aktuellen Spiel sind.

Dies zeigt die gleichen Informationen wie die Registerkarte "Derzeit trägt" im Profil des angegebenen Benutzers an.

Siehe auch:

  • Avatar-Inspektionsmenü, ein Artikel, der eine detailliertere Erklärung der Funktionen Inspektion und Kauf und wie sie funktionieren liefert
  • GuiService:SetInspectMenuEnabled() , ermöglicht es Entwicklern, die Standard-Inspektion- und Kauf-Funktionalität zu aktivieren oder zu deaktivieren.Dies ist besonders nützlich, wenn das, was auf dem Avatar eines Spieler:inauf der Roblox-Plattform getragen wird, nicht unbedingt mit seinem Aussehenim Spiel gleich ist
  • GuiService:InspectPlayerFromHumanoidDescription() , ermöglicht es einem Entwickler, das Inspektionsmenü anzuzeigen, das die in diesem HumanoidDescription Objekt aufgelisteten Assets zeigt

Parameter

userId: number

Das UserId des Spielers zum Überprüfen.

Standardwert: ""

Rückgaben

()

Code-Beispiele

The code sample below demonstrates how to use GuiService:InspectPlayerFromUserId() to open the Inspect Menu for the Roblox user with the id 772462.

Opening the Inspect Menu for a UserId

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

IsTenFootInterface

Gibt wahr zurück, wenn der Client die zehnfuß-Schnittstelle verwendet, die eine spezielle Version der Benutzeroberfläche von Roblox ist, die exklusiv für Konsolen ist.Dies ist der einzige garantierte Weg, um zu überprüfen, ob der Benutzer auf einer Konsole ist oder nicht.


Rückgaben

Select

()

Wenn Select auf einer Instanzauswahl-Elterninstanz angerufen wird, die PlayerGui oder ein Nachkomme von PlayerGui ist, sucht die Engine alle verfügbaren auswählbaren, sichtbaren und auf-Bildschirm-Gui-Objekte, die Nachkommen von SelectionParent sind, und legt das GuiService.SelectedObject auf das GuiObject mit dem kleinsten GuiService.SelectionOrder fest.

Parameter

selectionParent: Instance

Der Elternteil der Auswahl, deren Nachkommen gesucht werden.

Standardwert: ""

Rückgaben

()

Code-Beispiele

Uses the user's value for GuiService.PreferredTransparency by combining it with the desired default background transparency. Also automatically updates the background transparency whenever the user changes their preferred transparency.

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

Parameter

notificationInfo: Dictionary
Standardwert: ""

Rückgaben

SetEmotesMenuOpen

()

Öffnet oder schließt das Spieler-Emotes-Menü.

Parameter

isOpen: boolean
Standardwert: ""

Rückgaben

()

SetGameplayPausedNotificationEnabled

()

Diese Methode ermöglicht es Entwicklern, die integrierte Benachrichtigung zu deaktivieren, wenn das Spiel eines Spielers unterbrochen wird.Sie können dann ihre eigene Benutzeroberfläche hinzufügen, wenn sie sie anpassen möchten.

Entwickler können abfragen, ob die Benachrichtigung aktiviert ist, indem sie die GuiService:GetGameplayPausedNotificationEnabled()-Funktion aufrufen.

Siehe auch:

Parameter

enabled: boolean

Ob die integrierte Benachrichtigungs-GUI deaktiviert ist oder nicht.

Standardwert: ""

Rückgaben

()

SetInspectMenuEnabled

()

Diese Funktion ermöglicht es Entwicklern, die Standard-Inspektion und -Kauf-Funktionalität zu aktivieren oder zu deaktivieren.Dies ist nützlich, wenn du die Funktion in deinem Spiel deaktivieren möchtest, ganz oder während bestimmter Teile deines Spiels (z. B. eine Cutscene).Die Funktion ist standardmäßig aktiviert.

Das Codebeispiel unten zeigt, wie du das Inspektionsmenü für dein Spiel deaktivierst:


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

Siehe auch:

  • Avatar-Inspektionsmenü, ein Artikel, der eine detailliertere Erklärung der Funktionen Inspektion und Kauf und wie sie funktionieren liefert
  • GuiService:InspectPlayerFromHumanoidDescription() , ermöglicht es einem Entwickler, das Inspektionsmenü aufzurufen, das die in diesem HumanoidDescription Objekt aufgelisteten Assets anzeigt.Dies ist besonders nützlich, wenn das, was auf dem Avatar eines Spieler:inauf der Roblox-Plattform getragen wird, nicht unbedingt mit seinem Aussehenim Spiel gleich ist
  • GuiService:InspectPlayerFromUserId() , ermöglicht es, dass das Inspektionsmenü angezeigt wird, um den Benutzer zu zeigen, der die angegebene UserId hat.Dies ist besonders nützlich, wenn du Spieler inspizieren möchtest, die nicht im aktuellen Spiel sind

Parameter

enabled: boolean

Ein boolescher Indikator, der anzeigt, ob die Funktionaktivieren oder deaktivieren soll.

Standardwert: ""

Rückgaben

()

Ereignisse

Feuert, wenn der Benutzer schließt das Roblox-Coregui-Escape-Menü.


Feuert, wenn der Benutzer das Roblox-Coregui-Escape-Menü öffnet .