StarterGui

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

StarterGui ist ein Container-Objekt, das LayerCollector Objekte wie ScreenGuis enthält.

StarterGui enthält auch eine Reihe von Funktionen, mit denen Sie mit dem CoreGui interagieren können. Zum Beispiel kann Class.StarterGui:SetCoreGuiEnabled() verwendet werden, um Elemente des 0> Class.CoreGui0> zu deaktivieren, und 3> Class.StarterGui:SetCore()

Zusammenfassung

Eigenschaften

Methoden

Methoden von BasePlayerGui übernommen

Eigenschaften

ProcessUserInput

Verborgen
Nicht repliziert
Plugin-Sicherheit
Parallel lesen

Erlaubt StarterGui , Eingaben wie PlayerGui und CoreGui zu verarbeiten. Der Standardwert ist 1> false1>.

RtlTextSupport

Nicht skriptfähig
Parallel lesen

ScreenOrientation

Parallel lesen

Dieses Eigenschaft setzt den bevorzugten Bildschirmorientierungsmodus für Benutzer mit mobilen Geräten. Für die verschiedenen Modi, siehe Enum.ScreenOrientation.

Standardmäßig ist diese Eigenschaft auf Sensor eingestellt, was bedeutet, dass die Erfahrung entsprechend der besten Match auf der Geräte-Ausrichtung angezeigt wird, entweder in der Landung (links/rechts) oder in der Hochformat.

Wenn ein Player sich der Erfahrung auf einem mobilen Gerät anschließt, bestimmt diese Eigenschaft die Ausrichtung des Geräts und setzt die PlayerGui.ScreenOrientation des Spieler:inentsprechend. Sie können auch den aktuellen Bildschir orientation des Spieler:inüber PlayerGui.CurrentScreenOrientation erhalten, nütz

Beachten Sie, dass das Ändern dieser Eigenschaft die Bildschirmorientierung für Players nicht ändern wird, die bereits in der Erlebnisist. Um die Ausrichtung für einen bestehenden Spieler:inzu ändern, verwenden Sie seine PlayerGui.ScreenOrientation Eigenschaften.

ShowDevelopmentGui

Parallel lesen

Dieses Eigenschaft bestimmt, ob die Inhalte von StarterGui in Studio sichtbar sind.

VirtualCursorMode

Nicht skriptfähig
Parallel lesen

Methoden

GetCoreGuiEnabled

Diese Funktion gibt zurück, ob das angegebene Enum.CoreGuiType aktiviert ist, oder ob es mit StarterGui:SetCoreGuiEnabled() deaktiviert wurde. Diese Funktion sollte auf dem Client aufgerufen werden.

Beachten Sie, dass das Setzen von "TopbarEnabled" auf false mit SetCore() das Gesamtergebnis all 1> Enums.CoreGuiType|CoreGuiTypes1> nicht beeinflusst, aber das Ergebnis dieser Funktion nicht beeinflusst.

Parameter

coreGuiType: Enum.CoreGuiType

Der gegebene Enum.CoreGuiType .


Rückgaben

Ob der angegebene Enum.CoreGuiType aktiviert ist.

Code-Beispiele

Checking if a Core GUI is Enabled

local StarterGui = game:GetService("StarterGui")
print(StarterGui:GetCoreGuiEnabled("PlayerList"))

SetCore

void

Diese Methode (nicht mit SetCoreGuiEnabled() zu verwechseln) zeigt eine Vielzahl von Funktionen, die von Roblox's Kernskripten definiert sind, wie das Senden von Benachrichtigungen, das Umschalten von Benachrichtigungen für Abzeichen/Punkte, das Definieren eines Rücksetzungsberechtigung oder das Umschalten der oberen Leiste.

Der erste Parameter ist eine Strings, die die Funktionalität wählt, mit der die Anrufe interagieren. Es kann nötig sein, diesen Methoden mehrere Male mit pcall() aufzurufen, falls das entsprechende Kernskript noch nicht geladen ist (oder wenn es vollständig deaktiviert ist).

Die folgende Tabelle beschreibt die Strings, die als erste Argument angenommen werden können. Die folgenden Argumente basieren auf der Funktionalität, die verwendet wird, und sind in Untertabellen beschrieben.

ChatAktiv

Steuert, ob der Chat aktiv ist.


<tbody>
<tr>
<td><code>aktiv</code></td>
<td>boolean</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob der Chat aktiviert werden soll.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
Punkte-Benachrichtigungen aktiv

Steuert, ob Benachrichtigungen für verdiente Spielerpunkte angezeigt werden.


<tbody>
<tr>
<td><code>aktiv</code></td>
<td>boolean</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob Benachrichtigungen für verdiente Spielerpunkte angezeigt werden.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
Abzeichen-Benachrichtigungen

Steuert, ob Benachrichtigungen für verdiente Abzeichen angezeigt werden.


<tbody>
<tr>
<td><code>aktiv</code></td>
<td>boolean</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob Benachrichtigungen für verdiente Abzeichen angezeigt werden.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
ResetButtonKlingel

Bestimmt das Verhalten, wenn vorhanden, des zurücksetzen-Buttons, der eineBoolean oder ein BindableEvent ist, zu verfügbar, wenn ein Spieler eine Rücksetzung anfordert.


<tbody>
<tr>
<td><code>aktiviert</code></td>
<td>boolean</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob die Schaltfläche "Zurücksetzen" ihr Standardverhalten behält.</td>
</tr>
<tr>
<td colspan="4"><b>ODER</b></td>
</tr>
<tr>
<td><code>rückruf</code></td>
<td><code>Klasse.BindableEvent</code></td>
<td>(erforderlich)</td>
<td>Ein <code>Class.BindableEvent</code>, das ausgeführt wird, wenn der Spieler bestätigt, dass er zurücksetzen möchte.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
ChatMakeSystemNachricht

Zeige eine formatierte Nachricht im Chat an.


<tbody>
<tr>
<td><code>konfigTable</code></td>
<td>wörterbuch</td>
<td>(erforderlich)</td>
<td>Ein Wörterbuch von Informationen, die die Nachricht beschreiben (siehe unten).</td>
</tr>
</tbody>
NameTypStandardBeschreibung

<tbody>
<tr>
<td><code>Text</code></td>
<td>string</td>
<td>(erforderlich)</td>
<td>Die Nachricht zum Anzeigen.</td>
</tr>
<tr>
<td><code>Farbe</code></td>
<td><code>Datatype.Color3</code></td>
<td><code>Datatype.Color3.fromRGB(255, 255, 243)</code></td>
<td>Textfarbe der Nachricht.</td>
</tr>
<tr>
<td><code>Schriftart</code></td>
<td><code>Font-열거형</code></td>
<td><code>SourceSansBold</code></td>
<td>Font der Nachricht.</td>
</tr>
<tr>
<td><code>Textgröße</code></td>
<td>ganzzahlig</td>
<td><code>18</code></td>
<td>Textgröße der Nachricht.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
SendSchreiben

Verursacht eine nicht-invasive Benachrichtigung, die unten rechts auf dem Bildschirm erscheint. Die Benachrichtigung kann bis zu zwei Schaltflächen haben.


<tbody>
<tr>
<td><code>konfigTable</code></td>
<td>wörterbuch</td>
<td>(erforderlich)</td>
<td>Ein Wörterbuch von Informationen, die die Benachrichtigung beschreibt (siehe unten).</td>
</tr>
</tbody>
NameTypStandardBeschreibung

<tbody>
<tr>
<td><code>Titel)</code></td>
<td>string</td>
<td>(erforderlich)</td>
<td>Der Titel der Benachrichtigungen.</td>
</tr>
<tr>
<td><code>Text</code></td>
<td>string</td>
<td>(erforderlich)</td>
<td>Der Haupttext der Benachrichtigungen.</td>
</tr>
<tr>
<td><code>Symbol</code></td>
<td>string</td>
<td />
<td>Das Bild, das mit der Benachrichtigungenangezeigt wird.</td>
</tr>
<tr>
<td><code>Dauer</code></td>
<td>nummer</td>
<td><code>5</code></td>
<td>Die Dauer (in Sekunden) der Benachrichtigung sollte bleiben.</td>
</tr>
<tr>
<td><code>Rückruf</code></td>
<td><code>Class.BindableFunction</code></td>
<td />
<td>Ein <code>Class.BindableFunction</code>, der mit dem Text des Buttons, der vom Spieler:ingedrückt wird, aufgerufen werden sollte.</td>
</tr>
<tr>
<td><code>Button1</code></td>
<td>string</td>
<td />
<td>Der Text, der beim ersten Button angezeigt wird.</td>
</tr>
<tr>
<td><code>Button2</code></td>
<td>string</td>
<td />
<td>Der Text, der auf der zweiten Schaltfläche angezeigt wird.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
Topbar aktiviert

Bestimmt, ob die Top-Leiste angezeigt wird. Wenn Sie die Top-Leiste deaktivieren, deaktivieren Sie auch alle CoreGuis wie die Chat-Chat-Liste, die Inventar- und Spielerliste (z. B. mit SetCoreGuiEnabled).

Wenn deaktiviert, wird die obere Leiste der Region, die einst besetzt war, immer noch Maus-Ereignisse erfassen; jedoch reagieren die Buttons, die dort platziert werden, nicht auf Klicks. Die Herkunft des GUI-Bereichs wird immer noch 36 Pixel vom oberen Rand des Bildschirms abgezogen sein.


<tbody>
<tr>
<td><code>aktiviert</code></td>
<td>boolean</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob die Topbar sichtbar sein soll.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
DevConsoleSichtbar

Bestimmt, ob die Entwickler-Konsole sichtbar ist.


<tbody>
<tr>
<td><code>sichtbarkeit</code></td>
<td>boolean</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob die Konsole sichtbar ist.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
Aufforderung, einen Freund zu senden

Fordert den aktuellen Spieler auf, eine Freundesanfrage an den angegebenen Player zu senden.


<tbody>
<tr>
<td><code>spieler</code></td>
<td><code>Class.Player</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, dem die Freundesanfrage gesendet werden sollte.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
Unfreunden

Fordert den aktuellen Spieler auf, einen bestimmten Player von seiner Freundesliste zu entfernen.


<tbody>
<tr>
<td><code>spieler</code></td>
<td><code>Class.Player</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, der befreundet werden sollte.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
AufforderungBlockPlayer

Fordert den aktuellen Spieler auf, die gegebene Player zu blockieren.


<tbody>
<tr>
<td><code>spieler</code></td>
<td><code>Class.Player</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, der blockiert werden sollte.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
UnblockPlayer anzeigen

Fordert den aktuellen Spieler auf, die gegebene Player zu entsperren.


<tbody>
<tr>
<td><code>spieler</code></td>
<td><code>Class.Player</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, der entblockt werden sollte.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
Avatar Kontextmenü aktiviert

Bestimmt, ob das Avatar-Kontextmenü aktiviert ist.


<tbody>
<tr>
<td><code>aktiviert</code></td>
<td>boolean</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob das Kontextmenü aktiviert ist.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
Avatar Kontextmenüziel

Öffnet die erzwungene Avatar-Kontextmenü .


<tbody>
<tr>
<td><code>spieler</code></td>
<td><code>Class.Player</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, auf den das Kontextmenü geöffnet wird.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
Avatar Kontextmenü Option hinzufügen

Fügt dem Avatar-Kontextmenü eine Option hinzu.


<tbody>
<tr>
<td><code>option)</code></td>
<td><code>enum.AvatarContextMenuOption</code></td>
<td>(erforderlich)</td>
<td>Option zum hinzufügen.</td>
</tr>
<tr>
<td colspan="4"><b>ODER</b></td>
</tr>
<tr>
<td><code>option)</code></td>
<td>tabelle</td>
<td>(erforderlich)</td>
<td>Eine zweifarbige Tabelle, in der die erste die Name der benutzerdefinierten Actionist, und die zweite ein <code>Class.BindableEvent</code> ist, das mit einem Spieler ausgewählt wird, wenn die Option aktiviert wird.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
RemoveAvatar KontextmenüOption

Entfernt eine Option aus dem Avatar-Kontextmenü. Das option-Argument muss dasselbe sein wie das, was mit "AddAvatarContextMenuOption" (oben) verwendet wurde.


<tbody>
<tr>
<td><code>option)</code></td>
<td>Variante</td>
<td>(erforderlich)</td>
<td>Der gleiche Wert, der für <b>AddAvatarContextMenuOption</b> bereitgestellt wird.</td>
</tr>
</tbody>
NameTypStandardBeschreibung
Avatar Kontextmenü Thema

Konfiguriert das anpassbare Avatar-Kontextmenü, das ein opt-in-Feature ist, das einfache Spieler-zu-Spieler-Sozialität über benutzerdefinierte Aktionen, wie das Starten von Handeln, Schlachten und mehr, ermöglicht. Weitere Informationen darüber, wie man sein Thema anpasst, finden Sie im Artikel Avatar-Kontextmenü.

Kern-Guigui-Verbindungen

Setzt eine verbindliche Gateway-Verbindung zwischen dem Chat-Button der CoreGui-Oberleiste und dem Legacy-Chat-System. Der zweite Parallelbereich muss eine Tabelle von BindableEvents und BindableFunctions sein.

Parameter

parameterName: string

Wählt die Funktionalität, mit der der Anruf interagiert.

value: Variant

Eine Tabelle von BindableEvents und BindableFunctions .


Rückgaben

void

Code-Beispiele

StarterGui Setting Core GUI

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,
})

SetCoreGuiEnabled

void

Diese Funktion setzt, ob das CoreGui -Element, das mit dem angegebenen Enum.CoreGuiType verbunden ist, aktiviert oder deaktiviert ist.

Die obere Leiste kann mit dieser Funktion nicht deaktiviert werden. Um sie zu deaktivieren, setzen Sie "TopbarEnabled" auf false mit der Verwendung von StarterGui:SetCore().

Parameter

coreGuiType: Enum.CoreGuiType

Der gegebene Enum.CoreGuiType .

enabled: bool

Ob Sie die angegebene Enum.CoreGuiType aktivieren oder deaktivieren möchten.


Rückgaben

void

GetCore

Variant
Angehalten

Diese Methode gibt Daten zurück, die von Roblox's Kernskripten bereitgestellt werden. Der erste und einzige Parameter ist eine Strings, die die Informationen auswählt, die abgerufen werden sollen. Die folgenden Abschnitte beschreiben die Strings und die Daten, die sie durch diese Funktion zurückgeben.

Aufrufen dieser Methode kann möglicherweise liefern. Viele von diesen registrieren auch einen entsprechenden SetCore() Funktion (diese werden mit einem Sternchen markiert).

Punkte-Benachrichtigungen aktiv *

Kehrt true zurück, wenn Spieler-Punkt-Benachrichtigungen aktiviert sind.

BadgesNotificationsActive *

Gibt true zurück, wenn die Abzeichen-Benachrichtigungen aktiviert sind.

Avatar Kontextmenü aktiviert *

Kehrt true zurück, wenn das Avatar-Kontextmenü aktiviert ist.

ChatAktiv *

Gibt zurück, ob der Chat aktiv ist oder nicht. Dies wird durch den Auswahlzustand des Chat-Symbols in der oberen Leiste angezeigt.

ChatWindowSize *

Gibt die Größe des Chat-Fensters als UDim2 zurück.

ChatWindowPosition *

Gibt die Größe des Chat-Fensters als UDim2 zurück.

ChatBar *

Kehrt true zurück, wenn die Chat-Bar deaktiviert ist.

GetBlockedUserIds

Gibt eine Liste von UserIds zurück, die mit Benutzern verbunden sind, die vom lokalen Spieler:inblockiert wurden.

SpielerBlockedEvent

Gibt ein BindableEvent zurück, das immer ausgeführt wird, wenn ein Spieler vom lokalen Spieler:inblockiert wird.

Spieler entblockt Ereignis

Gibt ein BindableEvent zurück, das jedes Mal ausgeführt wird, wenn ein Spieler durch den lokalen Spieler:inentblockt wird.

PlayerMutedEreignis

Gibt ein BindableEvent zurück, das jedes Mal ausgeführt wird, wenn ein Spieler von dem lokalen Spieler:instummgeschaltet wird.

PlayerUnmutedEvent

Gibt ein BindableEvent zurück, das immer ist, wenn ein Spieler durch den lokalen Spieler:indeaktiviert wird.

Spielerfreundliches Ereignis

Kehrt ein BindableEvent zurück, das immer zurückgegeben wird, wenn ein Spieler vom lokalen Spieler:inbefreundet wird.

PlayerUnfriendedEvent

Kehrt ein BindableEvent zurück, das immer zurückgegeben wird, wenn ein Spieler vom lokalen Spieler:inentfernt wird.

DevConsoleVisible *

Kehrt true zurück, wenn die Entwicklerkonsole sichtbar ist.

VRRotationIntensität

Gibt eine Zeichenfolge zurück, die die Kamera-Rotation-Empfindlichkeit in VR beschreibt: Low , High und Smooth. Dies wird nicht verfügbar sein, wenn 1> Class.VRService.VREnabled1> nicht 4> true4> ist.

Parameter

parameterName: string

Rückgaben

Variant

Ereignisse