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

ist ein container-objekt, das entwickelt wurde, um objekte wie zu halten.

Wenn ein Player.Character erscheint, werden die Inhalte seiner PlayerGui (wenn vorhanden) geleert.Die Kinder der StarterGui werden dann zusammen mit ihren Nachkommen in die PlayerGui kopiert.Beachten Sie jedoch, dass LayerCollector Objekte wie ScreenGuis mit ihrer ResetOnSpawn Eigenschaft auf false platziert werden, werden nur einmal in jedem Spieler:inPlayerGui platziert und nicht gelöscht, wenn die Player Respawns wieder erscheinen.

StarterGui enthält auch eine Reihe von Funktionen, mit denen Sie mit dem CoreGui interagieren können.Zum Beispiel kann StarterGui:SetCoreGuiEnabled() verwendet werden, um Elemente der CoreGui zu deaktivieren, und StarterGui:SetCore() kann eine Reihe von Funktionen ausführen, einschließlich der Erstellung von Benachrichtigungen und Systemnachrichten.

Zusammenfassung

Eigenschaften

Methoden

Methoden von BasePlayerGui übernommen

Methoden

Eigenschaften

ProcessUserInput

Verborgen
Nicht repliziert
Plugin-Sicherheit
Parallel lesen

Erlaubt StarterGui, Eingabe wie PlayerGui und CoreGui zu verarbeiten. Der Standardwert ist false .

RtlTextSupport

Nicht skriptfähig
Parallel lesen

ScreenOrientation

Parallel lesen

Diese Eigenschaft legt die bevorzugte Bildschirmorientierungsmodi für Benutzer mit mobilen Geräten fest. Für die verfügbaren verschiedenen Modi siehe Enum.ScreenOrientation .

Standardmäßig ist diese Eigenschaft auf Sensor festgelegt, was bedeutet, dass die Erfahrung angezeigt wird, abhängig von der besten Übereinstimmung mit der aktuellen Orientierung des Geräts, entweder Landschaft (links/rechts) oder Hochformat.

Wenn sich ein an dem Erlebnis auf einem mobilen Gerät beteiligt, legt diese Eigenschaft die Startausrichtung des Geräts fest und passt die Ausrichtung des Spieler:inentsprechend an.Du kannst auch die aktuelle Bildschirmorientierung des Spieler:indurch PlayerGui.CurrentScreenOrientation erhalten, nützlich, wenn du eine der "Sensor" Enum.ScreenOrientation Einstellungen verwendest.

Beachten Sie, dass sich das Ändern dieser Eigenschaft nicht auf die Bildschirmorientierung für Players ändern wird, bereits im Erlebnis.Um die Orientierung für einen bestehenden Spieler:inzu ändern, verwende seine PlayerGui.ScreenOrientation Eigenschaften.

ShowDevelopmentGui

Parallel lesen

Diese Eigenschaft bestimmt, ob der Inhalt von StarterGui im Studio sichtbar ist.

VirtualCursorMode

Nicht skriptfähig
Parallel lesen

Methoden

GetCoreGuiEnabled

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

Beachten Sie, dass die Einstellung "TopbarEnabled" auf false mit SetCore() verborgen wird, alle CoreGuiTypes aber nicht beeinflusst das Ergebnis dieser Funktion.

Parameter

coreGuiType: Enum.CoreGuiType

Die angegebene Enum.CoreGuiType.

Standardwert: ""

Rückgaben

Ob das angegebene Enum.CoreGuiType aktiviert ist.

Code-Beispiele

The below example would print whether or not the player list is visible to the LocalPlayer.

Checking if a Core GUI is Enabled

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

SetCore

()

Diese Methode (nicht mit SetCoreGuiEnabled() zu verwechseln) offenbart eine Vielzahl von Funktionen, die von den Kernskripten von Roblox definiert wurden, wie das Senden von Benachrichtigungen, das Umschalten von Benachrichtigungen für Abzeichen/Punkte, die Festlegung eines Rückrufs für die Reset-Taste oder das Umschalten der oberen Leiste.

Der erste Parameter ist eine Zeichenkette, die die Funktionalität auswählt, mit der die Anrufe interagieren.Es kann notwendig sein, diese Methode mehrmals mit pcall() aufzurufen, falls das entsprechende Kernskript noch nicht geladen wurde (oder wenn es vollständig deaktiviert wurde).

Die folgende Tabelle beschreibt die Zeichen, die als erster Parameter akzeptiert werden können.Die Parameter, die folgen sollten, hängen von der Funktionalität ab, die verwendet wird, und werden in Untertabellen beschrieben.

ChatAktiv

Steuert, ob der Chat aktiv ist.


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>aktiviert</code></td>
<td>boolesisch</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob der Chat aktiviert werden soll.</td>
</tr>
</tbody>
Namen
Aktive Punktebenachrichtigungen

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


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>aktiviert</code></td>
<td>boolesisch</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob Benachrichtigungen für verdiente Spielerpunkte angezeigt werden.</td>
</tr>
</tbody>
Namen
AbzeichenBenachrichtigungenAktiv

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


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>aktiviert</code></td>
<td>boolesisch</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob Benachrichtigungen für verdiente Abzeichen angezeigt werden.</td>
</tr>
</tbody>
Namen
Zurücksetzungs按钮回调

Bestimmt das Verhalten, wenn vorhanden, des Zurücksetzungs按钮, wenn ein boolescher oder ein BindableEvent an einen Spieler gesendet wird, der zurücksetzen möchte.


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>aktiviert</code></td>
<td>boolesisch</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob die Zurücksetzungstaste ihr Standardverhalten behält.</td>
</tr>
<tr>
<td colspan="4"><b>OR</b></td>
</tr>
<tr>
<td><code>callback</code></td>
<td><code>Klasse.BindableEvent</code></td>
<td>(erforderlich)</td>
<td>Eine <code>Class.BindableEvent</code>, die abgefeuert wird, wenn der Spieler bestätigt, dass er zurücksetzen möchte.</td>
</tr>
</tbody>
Namen
ChattenMakeSystemMessage

Zeige eine formatierte Nachricht im Chat an.Die Verwendung dieser Methode erfordert, dass die Erfahrung auf gesetzt wird , obwohl der Legacy-Chat deprecated ist und die Verwendung vermieden wird.Für Erlebnisse, die die aktuelle TextChatService verwenden, siehe TextChannel:DisplaySystemMessage() .


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Konfigurationstisch</code></td>
<td>dictionär</td>
<td>(erforderlich)</td>
<td>Ein Wörterbuch mit Informationen, die die Nachricht beschreiben (siehe unten).</td>
</tr>
</tbody>
Namen

<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<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>Datentyp.Farbe3</code></td>
<td><code>Datentyp.Farbe3.vonRGB(255, 255, 243)</code></td>
<td>Textfarbe der Nachricht.</td>
</tr>
<tr>
<td><code>Schrift</code></td>
<td><code>Enum.Font</code></td>
<td><code>SourceSansBold</code></td>
<td>Schriftart 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>
Namen
Benachrichtigung senden

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


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Konfigurationstisch</code></td>
<td>dictionär</td>
<td>(erforderlich)</td>
<td>Ein Wörterbuch mit Informationen, die die Benachrichtigung beschreiben (siehe unten).</td>
</tr>
</tbody>
Namen

<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<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>Icon</code></td><td>Zeichen</td>
<td />
<td>Das Bild, das mit der Benachrichtigungenangezeigt wird.</td>
</tr>
<tr>
<td><code>Dauer</code></td>
<td>zahl</td>
<td><code>5</code></td>
<td>Dauer (in Sekunden) sollte die Benachrichtigung sichtbar bleiben.</td>
</tr>
<tr>
<td><code>Rückruf</code></td><td><code>Class.BindableFunction</code></td>
<td />
<td>Eine <code>Class.BindableFunction</code>, die mit dem Text der von dem Spieler:ingedrückten Schaltfläche aufgerufen werden sollte.</td>
</tr>
<tr>
<td><code>Button1</code></td><td>Zeichen</td>
<td />
<td>Der Text, der auf dem ersten Knopf angezeigt wird.</td>
</tr>
<tr>
<td><code>Button2</code></td><td>Zeichen</td>
<td />
<td>Der Text, der auf dem zweiten Knopf angezeigt wird.</td>
</tr>
</tbody>
Namen
TopbarAktiviert

Bestimmt, ob die oberste Leiste angezeigt wird.Die Deaktivierung der oberen Leiste deaktiviert auch alle CoreGuis wie den Chat, das Inventar und die Spielerliste (zum Beispiel diejenigen, die mit SetCoreGuiEnabled festgelegt wurden).

Wenn deaktiviert, wird die Region, die die oberste Leiste einmal besetzt war, weiterhin Mausereignisse erfassen; jedoch reagieren die dort platzierten Schaltflächen nicht auf Klicks.Die Herkunft des GUI-Raums wird immer noch 36 Pixel von der oberen Kante des Bildschirms entfernt sein.


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>aktiviert</code></td>
<td>boolesisch</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob die oberste Leiste sichtbar sein soll.</td>
</tr>
</tbody>
Namen
DevConsoleSichtbarkeit

Bestimmt, ob die Entwicklerkonsole sichtbar ist.


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>sichtbarkeit</code></td>
<td>boolesisch</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob die Konsole sichtbar ist.</td>
</tr>
</tbody>
Namen
Sofortige Freundesanfrage senden

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


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>spieler:in</code></td>
<td><code>Klasse.Spieler</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, an den die Freundesanfrage gesendet werden soll.</td>
</tr>
</tbody>
Namen
Freund schnell entfernen

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


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>spieler:in</code></td>
<td><code>Klasse.Spieler</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, der unfriended werden sollte.</td>
</tr>
</tbody>
Namen
PromptBlockPlayer

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


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>spieler:in</code></td>
<td><code>Klasse.Spieler</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, der blockiert werden sollte.</td>
</tr>
</tbody>
Namen
Schnellstart-Entblocker-Spieler

Fordert den aktuellen Spieler auf, den angegebenen Player freizuschalten.


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>spieler:in</code></td>
<td><code>Klasse.Spieler</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, der blockiert werden sollte.</td>
</tr>
</tbody>
Namen
Avatar-Kontextmenü aktiviert

Bestimmt, ob das Avatar-Kontextmenü aktiviert ist.


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>aktiviert</code></td>
<td>boolesisch</td>
<td>(erforderlich)</td>
<td>Bestimmt, ob das Kontextmenü aktiviert ist.</td>
</tr>
</tbody>
Namen
AvatarContextMenuZiel

Erzwingt das Öffnen des Avatar-Kontextmenüs.


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>spieler:in</code></td>
<td><code>Klasse.Spieler</code></td>
<td>(erforderlich)</td>
<td>Der Spieler, auf den das Kontextmenü geöffnet wird.</td>
</tr>
</tbody>
Namen
HinzufügenAvatarContextMenuOption

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


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>optionen</code></td>
<td><code>Enum.AvatarContextMenuOption</code></td>
<td>(erforderlich)</td>
<td>Option zum hinzufügen.</td>
</tr>
<tr>
<td colspan="4"><b>OR</b></td>
</tr>
<tr>
<td><code>optionen</code></td>
<td>tabelle</td>
<td>(erforderlich)</td>
<td>Eine zweiteilige Tabelle, bei der der erste der Name der benutzerdefinierten Actionist und der zweite eine <code>Class.BindableEvent</code> ist, die mit einem Spieler abgefeuert wird, wenn die Option aktiviert wurde.</td>
</tr>
</tbody>
Namen
EntfernenAvatarKontextmenüoption

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


<th>Typ</th>
<th>Standardmäßig</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>optionen</code></td>
<td>Variante</td>
<td>(erforderlich)</td>
<td>Der gleiche Wert, der an <b>AddAvatarContextMenuOption</b> übergeben wurde.</td>
</tr>
</tbody>
Namen
Avatar-Kontextmenüthema

Konfiguriert das anpassbare Avatar-Kontextmenü, das ein Opt-in-Feature ist, das einfache soziale Interaktionen zwischen Spielern durch benutzerdefinierte Aktionen ermöglicht, wie das Initiieren von Handeln, Schlachten und mehr.Für weitere Informationen darüber, wie sein Thema angepasst werden kann, siehe den Artikel Avatar-Kontextmenü.

CoreGuiChatVerbindungen

Einrichtet eine bindbare Gateway-Verbindung zwischen dem Chat-Button der oberen Leiste CoreGui und dem veralteten Chat-System.Der zweite Parameter muss eine Tabelle von BindableEvents und BindableFunctions sein.

Parameter

parameterName: string

Wählt die Funktionalität aus, mit der die Anrufe interagieren werden.

Standardwert: ""
value: Variant

Eine Tabelle von BindableEvents und BindableFunctions.

Standardwert: ""

Rückgaben

()

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

()

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

Die oberste Leiste kann mit dieser Funktion nicht deaktiviert werden. Um sie zu deaktivieren, stellen Sie "TopbarEnabled" auf false mit StarterGui:SetCore() ein.

Parameter

coreGuiType: Enum.CoreGuiType

Die angegebene Enum.CoreGuiType.

Standardwert: ""
enabled: boolean

Ob der gegebene Enum.CoreGuiType aktivieren oder deaktivieren soll.

Standardwert: ""

Rückgaben

()

GetCore

Variant
Angehalten

Diese Methode gibt eine Datenmenge zurück, die von den Kernskripten von Roblox bereitgestellt oder verfügbar gemacht wurde.Der erste und einzige Parameter ist eine Zeichenkette, die die zu abrufenden Informationen auswählt.Die folgenden Abschnitte beschreiben die Zeichenketten und die Daten, die sie durch diese Funktion zurückgeben.

Das Aufrufen dieser Methode kann zu Ergebnissen führen. Viele von ihnen registrieren auch eine entsprechende SetCore()-Funktion (diese werden mit einem Sternchen markiert).

Punktebenachrichtigungen aktiv *

Gibt true zurück, wenn Spielerpunktbenachrichtigungen aktiviert sind.

AbzeichenBenachrichtigungenAktiv *

Gibt true zurück, wenn Abzeichenbenachrichtigungen aktiviert sind.

Avatar-Kontextmenü aktiviert *

Gibt 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 der oberen Leiste angezeigt.

ChatWindowGröße *

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

ChatWindowPosition *

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

ChatBarDisabled *

Gibt true zurück, wenn die Chatleiste deaktiviert ist.

GetBlockedUserIds erhalten

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

Spielerblockierte Ereignis

Gibt eine BindableEvent zurück, die abgefeuert wird, wenn ein Spieler vom lokalen Spieler:inblockiert wird.

Spielerentblockte Ereignis

Gibt eine BindableEvent zurück, die abgefeuert wird, wenn ein Spieler vom lokalen Spieler:infreigeschaltet wird.

SpielerStummgeschaltetesEreignis

Gibt eine BindableEvent zurück, die abgefeuert wird, wenn ein Spieler vom lokalen Spieler:instummgeschaltet wird.

SpielerUnmutedEvent

Gibt eine BindableEvent zurück, die abgefeuert wird, wenn ein Spieler vom lokalen Spieler:instummgeschaltet wird.

Spielerfreundetevent

Gibt eine BindableEvent zurück, die abgefeuert wird, wann immer ein Spieler vom lokalen Spieler:inbefreundet wird.

SpielerUnfriendedEvent

Gibt eine BindableEvent zurück, die abgefeuert wird, wenn ein Spieler vom lokalen Spieler:inunfriended wird.

Dev Console Sichtbar *

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

VRRotationIntensität

Gibt eine Zeichenkette zurück, die die Kameraempfindlichkeit bei der Rotation in VR beschreibt: Low , High und Smooth .Dies wird nicht verfügbar sein, es sei denn VRService.VREnabled ist true .

Parameter

parameterName: string
Standardwert: ""

Rückgaben

Variant

Events