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 durch den Spielpad-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 auf eine GUI als ausgewähltes Objekt gesetzt.

  • Verborgen
    Nicht repliziert
    Parallel lesen

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

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

  • Schreibgeschützt
    Nicht repliziert
    Parallel lesen

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

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

    Erzeugt die bevorzugte Transparenz des Benutzers als Zahl zwischen 0 und 1, die anzeigt, wie opake sie die Hintergründe bestimmter UI-Elemente sein möchten. Die empfohlene Verwendung ist als Multiplikator für die Hintergrundtransparenz eines Elements. Standard ist 1.

  • Verborgen
    Schreibgeschützt
    Nicht repliziert
    Parallel lesen

    Gibt true zurück, wenn der Benutzer die reduzierte Bewegung aktiviert hat. Standardmäßig auf false .

  • Setzt die GUI-Objekt-Ansicht, auf die der GUI-Navigator (für Gamepads verwendet) derzeit fokussiert ist.

  • Schreibgeschützt
    Nicht repliziert
    Parallel lesen

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

  • Wird verwendet, um Touch-Steuerelemente und Touch-Steuerelementanzeige-UI 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 als GUI ausgewähltes Objekt festgelegt. Wenn Sie dies deaktivieren, wird die Navigation von GUI immer noch funktionieren, wenn GuiService.GuiNavigationEnabled aktiviert ist, aber Sie müssen manuell auf 2> Class.GuiService.SelectedObject2> eingest

CoreGuiNavigationEnabled

Verborgen
Nicht repliziert
Parallel lesen

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

GuiNavigationEnabled

Parallel lesen

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

Schreibgeschützt
Nicht repliziert
Parallel lesen

Kehrt 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

Erzeugt die bevorzugte Transparenz des Benutzers als Zahl zwischen 0 und 1, die anzeigt, wie viel mehr die Hintergrundfarbe der Benutzeroberfläche ist. Standard auf 1.

Code-Beispiele

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 die reduzierte Bewegung aktiviert hat. Standardmäßig auf false .

Diese Rückgabewert spiegelt eine Einstellung, die von der Benutzeroberfläche in der App-Einstellungen oder innerhalb des In-Experience-Settings-Menüs über Bewegung reduzieren . Ein Wert von true deutet an, dass der Benutzer möchte, dass die Bewegungseffekte und Animationen reduziert oder vollständig entfernt werden.

Code-Beispiele

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

Setzt den GuiObject derzeit von der GUI-Navigator (verwendet für Gamepads) konzentriert. Dies kann auf null zurückgesetzt werden, wenn das Objekt off-screen ist.

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

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

Code-Beispiele

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

Kehrt ein Rect-Objekt zurück, das die nicht besetzte Zone zwischen den Roblox- linken Steuerelementen und der Kante der Geräte-Sicherheitszone darstellt.

Der Wert ist dynamisch und kann basierend auf der Sichtbarkeit von UI-Steuerelementen wie Ändern der lokalen Spieler:inClass.Humanoid.Health|Health Eigenschaften, Verwendung von StarterGui:SetCoreGuiEnabled() , Ändern der Größe und Position von Roblox-UI-Steuerelementen und/oder anderen. Aus diesem

Code-Beispiele

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-UI zu aktivieren und zu deaktivieren. Standard ist auf "Wahr".

Methoden

CloseInspectMenu

void

Diese Funktion schließt das Inspect-Menü, wenn es geöffnet ist, wenn Sie von einem LocalScript ausführen.

Siehe auch:

  • Avatar Inspect Menu , ein Artikel, der eine genauere Erklärung der Inspect und Kauf Funktion und wie sie funktioniert bietet
  • GuiService:InspectPlayerFromHumanoidDescription() , ermöglicht es einem Entwickler, das Inspect-Menü zu bringen, das die Assets anzeigt, die in diesem HumanoidDescription -Objekt auf dem Roblox-Plattform getragen werden. Dies ist besonders nützlich, wenn das, was auf einem Spieler:in's Avatar auf der Roblox-Plattform getragen wird, nicht unbedingt sein In-Game-Aussehen ist.
  • GuiService:InspectPlayerFromUserId() , ermöglicht es dem Inspect-Menü, die Benutzer anzuzeigen, die den angegebenen UserId besitzen. Dies ist besonders nützlich, wenn Sie Spieler, die nicht im aktuellen Spiel sind, inspizieren möchten

Rückgaben

void

DismissNotification

Parameter

notificationId: string

Rückgaben

GetEmotesMenuOpen

Kehrt einBoolean 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 Funktion Class.GuiService:SetEmotesMenuOpen() aufrufen.


Rückgaben

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

GetGameplayPausedNotificationEnabled

Diese Funktion gibt zurück, ob die Benachrichtigung gameplay paused , die entwickelt wurde, deaktiviert wurde.

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

Siehe auch:


Rückgaben

Ob die Benachrichtigung gameplay paused deaktiviert wurde.

GetGuiInset

Kehre zwei Vector2 Werte zurück, die die Anordnung der Benutzeroberflächen in Pixeln darstellen, von der oberen linken Ecke des Bildschirms und der unteren rechten Ecke des Bildschirms jeweils.

Die in diesem Funktionsbereich angegebenen Werte wirken nur auf ScreenGuis, die ihre IgnoreGuiInset Eigenschaft auf false gesetzt haben.


Rückgaben

Ein Array von zwei Vector2-Werten, die die aktuell angegebene Gui-Registerkarte beschreiben.

GetInspectMenuEnabled

Diese Funktion gibt zurück, ob die Funktionalität des Inspect and Buy-Menüs derzeit aktiviert ist. Die Funktion wird standardmäßig aktiviert und kann mit der GuiService:SetInspectMenuEnabled() -Funktion aktiviert werden.

Siehe auch:

  • Avatar Inspect Menu , ein Artikel, der eine genauere Erklärung der Inspect und Kauf Funktion und wie sie funktioniert bietet
  • GuiService:InspectPlayerFromHumanoidDescription() , ermöglicht es einem Entwickler, das Inspect-Menü zu bringen, das die Assets anzeigt, die in diesem HumanoidDescription -Objekt auf dem Roblox-Plattform getragen werden. Dies ist besonders nützlich, wenn das, was auf einem Spieler:in's Avatar auf der Roblox-Plattform getragen wird, nicht unbedingt sein In-Game-Aussehen ist.
  • GuiService:InspectPlayerFromUserId() , ermöglicht es dem Inspect-Menü, die Benutzer anzuzeigen, die den angegebenen UserId besitzen. Dies ist besonders nützlich, wenn Sie Spieler, die nicht im aktuellen Spiel sind, inspizieren möchten

Rückgaben

EinBoolean, der anzeigt, ob die Inspect-Menü-Funktion aktiviert ist.

InspectPlayerFromHumanoidDescription

void

Diese Funktion ermöglicht es einem Entwickler, das Inspect-Menü mit dem Asset-Objekt in diesem HumanoidDescription Objekt anzuzeigen.

Dies ermöglicht eine weitere Anpassung mit dem, was im Inspect-Menü angezeigt wird, wenn Spieler andere Spieler in deinem Spiel inspizieren. Wenn dein Spiel die Kleidung der Spieler modifiziert, kannst du stattdessen ein HumanoidDescription-Objekt geben, das repräsentiert, was ein Spieler trägt, und diese Elemente angezeigt werden. Du solltest auch einen Namen übermitteln, der den Namen des Spielers repräsentiert.

Siehe auch:

  • Avatar Inspect Menu , ein Artikel, der eine genauere Erklärung der Inspect und Kauf Funktion und wie sie funktioniert bietet
  • GuiService:SetInspectMenuEnabled() , ermöglicht es Entwicklern, Standard-Inspect und Kauf-Funktionen zu aktivieren oder zu deaktivieren
  • GuiService:InspectPlayerFromUserId() , ermöglicht es dem Inspect-Menü, die Benutzer anzuzeigen, die den angegebenen UserId besitzen. Dies ist besonders nützlich, wenn Sie Spieler, die nicht im aktuellen Spiel sind, inspizieren möchten.

Parameter

humanoidDescription: Instance

Ein HumanoidDescription -Objekt, das die Assets enthält, die im Inspect-Menü angezeigt werden.

name: string

Der Name des Spielers, der inspiziert wird, um im Inspect-Menü angezeigt zu werden.


Rückgaben

void

Code-Beispiele

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

Diese Funktion erlaubt dem Inspect-Menü, die Benutzeroberfläche anzuzeigen, die den Benutzer zeigt, dass er den angegebenen UserId hat. Dies ist besonders nützlich, wenn Sie Spieler, die nicht im aktuellen Spiel sind, inspizieren möchten.

Dies zeigt die gleichen Informationen wie die "Currently Wearing"-Registerkarte im Profil des angegebenen Benutzers.

Siehe auch:

  • Avatar Inspect Menu , ein Artikel, der eine genauere Erklärung der Inspect und Kauf Funktion und wie sie funktioniert bietet
  • GuiService:SetInspectMenuEnabled() , ermöglicht es Entwicklern, die Standard-Inspect- und Kauf-Funktionalität zu aktivieren oder zu deaktivieren. Dies ist besonders nützlich, wenn das, was auf einem Spieler:inauf der Roblox-Plattform getragen wird, nicht unbedingt sein In-Game-Aussehen ist.
  • GuiService:InspectPlayerFromHumanoidDescription() , ermöglicht es einem Entwickler, das Inspect-Menü mit den Assets zu zeigen, die in diesem HumanoidDescription -Objekt aufgelistet sind

Parameter

userId: number

Der UserId des Spielers, um ihn zu inspizieren.


Rückgaben

void

Code-Beispiele

Opening the Inspect Menu for a UserId

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

IsTenFootInterface

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


Rückgaben

Select

void

Wenn Select auf einem Instanz選擇父親, der ist PlayerGui oder ein Nachkommen von PlayerGui, wird die Engine alle verfügbaren auswählbar, sichtbar und auf-Screen-GUI-Objekte suchen, die Nachkommen von選擇父親 und setzt das GuiService.SelectedObject auf das GuiObjekt mit dem kleinsten GuiService.SelectionOrder .

Parameter

selectionParent: Instance

Der Elternteil der Auswahl, dessen Nachkommen gesucht werden.


Rückgaben

void

Code-Beispiele

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

Rückgaben

SetEmotesMenuOpen

void

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

Parameter

isOpen: bool

Rückgaben

void

SetGameplayPausedNotificationEnabled

void

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

Entwickler können überprüfen, ob die Benachrichtigung aktiviert ist, indem sie die Funktion Class.GuiService:GetGameplayPausedNotificationEnabled() aufrufen.

Siehe auch:

Parameter

enabled: bool

Ob die integrierte Benachrichtigungs-GUI deaktiviert ist oder nicht.


Rückgaben

void

SetInspectMenuEnabled

void

Diese Funktion ermöglicht es Entwicklern, Standard-Inspekt- und Kauf-Funktionen zu aktivieren oder zu deaktivieren. Dies ist nützlich, wenn Sie die Funktion in Ihrem Spiel deaktivieren möchten, vollständig oder während bestimmter Teile Ihres Spiels (z. B. einer Cutscene). Die Funktion wird standardmäßig aktiviert.

Das Codebeispiel unten zeigt, wie du das Inspect-Menü für dein Spiel deaktivieren kannst:


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

Siehe auch:

  • Avatar Inspect Menu , ein Artikel, der eine genauere Erklärung der Inspect und Kauf Funktion und wie sie funktioniert bietet
  • GuiService:InspectPlayerFromHumanoidDescription() , ermöglicht es einem Entwickler, das Inspect-Menü zu bringen, das die Assets anzeigt, die in diesem HumanoidDescription -Objekt auf dem Roblox-Plattform getragen werden. Dies ist besonders nützlich, wenn das, was auf einem Spieler:in's Avatar auf der Roblox-Plattform getragen wird, nicht unbedingt sein In-Game-Aussehen ist.
  • GuiService:InspectPlayerFromUserId() , ermöglicht es dem Inspect-Menü, die Benutzer anzuzeigen, die den angegebenen UserId besitzen. Dies ist besonders nützlich, wenn Sie Spieler, die nicht im aktuellen Spiel sind, inspizieren möchten

Parameter

enabled: bool

EinBoolean, der anzeigt, ob Sie die Inspect-Menü-Funktion aktivieren oder deaktivieren möchten.


Rückgaben

void

Ereignisse

Feuert, wenn der Benutzer das Roblox-CoreGui-Entkommen-Menü schließt .


Feuert, wenn der Benutzer das Roblox-CoreGui-Entkommen-Menü öffnet.