StarterGui
*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.
StarterGui è un oggetto container progettato per contenere oggetti LayerCollector come ScreenGuis.
Quando un Player.Character viene generato, i contenuti del loro PlayerGui (se presenti) vengono svuotati.I figli del StarterGui vengono quindi copiati insieme ai loro discendenti nel PlayerGui .Nota, tuttavia, che gli oggetti come con il loro set di proprietà verranno posizionati solo una volta nel Giocatoree non verranno eliminati quando i respawneranno.
StarterGui include anche una gamma di funzioni che ti consentono di interagire con il CoreGui.Ad esempio StarterGui:SetCoreGuiEnabled() può essere utilizzato per disabilitare elementi del CoreGui e StarterGui:SetCore() può eseguire una gamma di funzioni tra cui la creazione di notifiche e messaggi di sistema.
Sommario
Proprietà
Consente a questo servizio di elaborare l'input come PlayerGui e CoreGui fare.
Imposta la modalità di orientamento dello schermo predefinita per gli utenti con dispositivi mobili.
Determina se i contenuti di StarterGui sono visibili in Studio.
Metodi
Restituisce se il dato Enum.CoreGuiType è abilitato o se è stato disabilitato utilizzando StarterGui:SetCoreGuiEnabled() .
Consente di eseguire determinate interazioni con gli script principali di Roblox.
Imposta se l'elemento CoreGui associato al Enum.CoreGuiType dato è abilitato o disabilitato.
Restituisce una variabile che è stata specificata da uno script del nucleo Roblox.
Restituisce un elenco di tutte le GuiObject istanze che occupano il punto dato sullo schermo.
Proprietà
ProcessUserInput
Consente a StarterGui di elaborare l'input come PlayerGui e CoreGui fa. Il valore predefinito è false .
RtlTextSupport
ScreenOrientation
Questa proprietà imposta la modalità di orientamento dello schermo preferita per gli utenti con dispositivi mobili. Per i diversi modi disponibili, vedi Enum.ScreenOrientation .
Per impostazione predefinita, questa proprietà è impostata su Sensor , il che significa che l'esperienza viene visualizzata a seconda della migliore corrispondenza all'orientamento attuale del Dispositivo, ad esempio paesaggio (sinistra/destra) o portrait.
Quando un Player si unisce all'esperienza su un Dispositivomobile, questa proprietà determina l'orientamento iniziale del Dispositivoe imposta il PlayerGui.ScreenOrientation di quel Giocatoredi conseguenza.Puoi anche ottenere l'orientamento dello schermo attuale del Giocatoreattraverso PlayerGui.CurrentScreenOrientation , utile quando si utilizza una delle impostazioni "sensor" Enum.ScreenOrientation.
Nota che cambiare questa proprietà non cambierà l'orientamento dello schermo per Players già nell'esperienza.Per cambiare l'orientamento per un Giocatoreesistente, usa la loro ProprietàPlayerGui.ScreenOrientation .
VirtualCursorMode
Metodi
GetCoreGuiEnabled
Questa funzione restituisce se il dato Enum.CoreGuiType è abilitato, o se è stato disabilitato utilizzando StarterGui:SetCoreGuiEnabled() .Questa funzione deve essere chiamata sul client.
Nota che l'impostazione "TopbarEnabled" a false usando SetCore() nasconde tutto CoreGuiTypes ma non influisce sul risultato di questa funzione.
Parametri
Il dato Enum.CoreGuiType .
Restituzioni
Se il dato Enum.CoreGuiType è abilitato.
Campioni di codice
The below example would print whether or not the player list is visible to the LocalPlayer.
local StarterGui = game:GetService("StarterGui")
print(StarterGui:GetCoreGuiEnabled("PlayerList"))
SetCore
Questo metodo (non da confondersi con SetCoreGuiEnabled() ) esporrà una varietà di funzionalità definite dagli script principali di Roblox, come l'invio di notifiche, l'attivazione di notifiche per badge/punti, la definizione di un richiamo per il pulsante di ripristino o l'attivazione della barra superiore.
Il primo parametro è una stringa che seleziona la funzionalità con cui la chiamata interagirà.Potrebbe essere necessario chiamare questo metodo più volte utilizzando pcall() in caso il rispettivo script del core non è ancora stato caricato (o se è stato disabilitato completamente).
La seguente tabella descrive le stringhe che possono essere accettate come primo parametro.I parametri che dovrebbero seguire dipendono dalla funzionalità che verrà utilizzata e sono descritti in tabelle secondarie.
ChatAttivo
Controlla se la chat è attiva.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>attivo</code></td><td>booleano</td><td>(richiesto)</td><td>Determina se la chat debba essere attivata.</td></tr></tbody>
Nome |
---|
Notifiche punti attive
Controlla se le notifiche per i punti player guadagnati appariranno o meno.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>attivo</code></td><td>booleano</td><td>(richiesto)</td><td>Determina se le notifiche per i punti player guadagnati appariranno o meno.</td></tr></tbody>
Nome |
---|
BadgesNotificationsAttivo
Controlla se le notifiche per i badge guadagnati appariranno o meno.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>attivo</code></td><td>booleano</td><td>(richiesto)</td><td>Determina se le notifiche per i badge guadagnati appariranno o meno.</td></tr></tbody>
Nome |
---|
RipristinaButtonCallback
Determina il comportamento, se presente, del pulsante di ripristino dato un booleano o un BindableEvent da essere attivato quando un giocatore richiede di Ripristina.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>abilitato</code></td><td>booleano</td><td>(richiesto)</td><td>Determina se il pulsante di ripristino mantenga il suo comportamento predefinito.</td></tr><tr><td colspan="4"><b>OR</b></td></tr><tr><td><code>richiama</code></td><td><code>Class.BindableEvent</code></td><td>(richiesto)</td><td>Un <code>Class.BindableEvent</code> da essere attivato quando il giocatore conferma di voler Ripristina.</td></tr></tbody>
Nome |
---|
ChatMakeSystemMessage
Mostra un messaggio formattato nella chat.L'utilizzo di questo metodo richiede che l'esperienza di TextChatService.ChatVersion venga impostata su LegacyChatService, anche se la chat legacy è deprecata e l'uso è scoraggiato.Per le esperienze che utilizzano l'attuale TextChatService , fai riferimento a TextChannel:DisplaySystemMessage() .
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>tabella di configurazione</code></td><td>dictionario</td><td>(richiesto)</td><td>Un dizionario di informazioni che descrive il messaggio (vedi sotto).</td></tr></tbody>
Nome |
---|
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>Testo</code></td><td>stringa</td><td>(richiesto)</td><td>Il messaggio da visualizzare.</td></tr><tr><td><code>Colore</code></td><td><code>Tipo di dati.Color3</code></td><td><code>Tipo di dati.Color3.fromRGB(255, 255, 243)</code></td><td>Colore del testo del Messaggio.</td></tr><tr><td><code>Carattere</code></td><td><code>Enumerazione.Font</code></td><td><code>SourceSansBold</code></td><td>Fonte del Messaggio.</td></tr><tr><td><code>Dimensione del testo</code></td><td>integro</td><td><code>18</code></td><td>Dimensione del testo del Messaggio.</td></tr></tbody>
Nome |
---|
Invia notifica
Causa l'apparizione di una notifica non invadente nella parte inferiore destra dello schermo. La notifica può avere fino a due pulsanti.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>tabella di configurazione</code></td><td>dictionario</td><td>(richiesto)</td><td>Un dizionario di informazioni che descrive la notifica (vedi sotto).</td></tr></tbody>
Nome |
---|
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>Titolo</code></td><td>stringa</td><td>(richiesto)</td><td>Il titolo della Notifiche.</td></tr><tr><td><code>Testo</code></td><td>stringa</td><td>(richiesto)</td><td>Il testo principale della Notifiche.</td></tr><tr><td><code>Icona</code></td><td>struttura della stringa</td><td /><td>L'immagine da mostrare con la Notifiche.</td></tr><tr><td><code>Durata</code></td><td>numbero</td><td><code>5</code></td><td>Durata (in secondi) la notifica dovrebbe rimanere visibile.</td></tr><tr><td><code>Callback</code></td><td><code>Class.BindableFunction</code></td><td /><td>Un <code>Class.BindableFunction</code> che dovrebbe essere invocato con il testo del pulsante premuto dal Giocatore.</td></tr><tr><td><code>Button1</code></td><td>struttura della stringa</td><td /><td>Il testo da mostrare sul primo pulsante.</td></tr><tr><td><code>Button2</code></td><td>struttura della stringa</td><td /><td>Il testo da mostrare sul secondo pulsante.</td></tr></tbody>
Nome |
---|
TopbarAbilitato
Determina se la barra superiore viene visualizzata.La disattivazione della barra superiore disabiliterà anche tutto CoreGuis come la chat, l'Inventario, reportorioe la lista dei giocatori (ad esempio, quelli impostati con SetCoreGuiEnabled ).
Quando è disabilitato, la regione che la barra superiore ha occupato una volta catturerà ancora eventi del mouse; tuttavia, i pulsanti posizionati lì non risponderanno ai clic.L'origine dello spazio GUI sarà ancora spostata di 36 pixel dalla parte superiore dello schermo.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>abilitato</code></td><td>booleano</td><td>(richiesto)</td><td>Determina se la barra superiore debba essere visibile.</td></tr></tbody>
Nome |
---|
DevConsoleVisible
Determina se la Console di sviluppatore è visibile.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>visione</code></td><td>booleano</td><td>(richiesto)</td><td>Determina se la console è visibile.</td></tr></tbody>
Nome |
---|
Invia richiesta amicoPrompt
Invita il giocatore attuale a inviare una richiesta di amicizia al dato Player .
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>giocatore</code></td><td><code>Class.Player</code></td><td>(richiesto)</td><td>Il giocatore a cui inviare la richiesta di amicizia.</td></tr></tbody>
Nome |
---|
Rimuovi amico
Invita il giocatore attuale a rimuovere un dato Player dalla loro lista di amici.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>giocatore</code></td><td><code>Class.Player</code></td><td>(richiesto)</td><td>Il giocatore che dovrebbe essere rimosso come amico.</td></tr></tbody>
Nome |
---|
PromptBlockPlayer
Invita il giocatore attuale a bloccare il Player.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>giocatore</code></td><td><code>Class.Player</code></td><td>(richiesto)</td><td>Il giocatore che dovrebbe essere bloccato.</td></tr></tbody>
Nome |
---|
Sblocca giocatore rapido
Invita il giocatore attuale a sbloccare il dato Player .
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>giocatore</code></td><td><code>Class.Player</code></td><td>(richiesto)</td><td>Il giocatore che dovrebbe essere sbloccato.</td></tr></tbody>
Nome |
---|
Menù contestuale di AvatarAbilitato
Determina se il Menù contestuale dell'Avatar è abilitato.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>abilitato</code></td><td>booleano</td><td>(richiesto)</td><td>Determina se il menu contestuale è abilitato.</td></tr></tbody>
Nome |
---|
Menù contestuale dell'avatarTarget
Apre forzatamente il Menù contestuale dell'Avatar.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>giocatore</code></td><td><code>Class.Player</code></td><td>(richiesto)</td><td>Il giocatore su cui verrà aperto il menu contestuale.</td></tr></tbody>
Nome |
---|
AggiungiAvatarContextMenuOption
Aggiunge un'opzione al Menù contestuale dell'Avatar.
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>opzione</code></td><td><code>Enum.AvatarContextMenuOpzione</code></td><td>(richiesto)</td><td>Opzione da aggiungere or Inserire.</td></tr><tr><td colspan="4"><b>OR</b></td></tr><tr><td><code>opzione</code></td><td>tavola</td><td>(richiesto)</td><td>Un tavolo a due elementi, dove il primo è il nome dell'azione personalizzata e il secondo è un <code>Class.BindableEvent</code> che verrà attivato con un giocatore quando l'opzione è stata attivata.</td></tr></tbody>
Nome |
---|
RimuoviAvatarContextMenuOption
Rimuove un'opzione per il Contesto menu dell'Avatar. L'argomento option deve essere lo stesso di quello utilizzato con "AddAvatarContextMenuOption" (vedi sopra).
<th>Tipo</th><th>Basilare</th><th>Descrizione</th></tr></thead><tbody><tr><td><code>opzione</code></td><td>Variante</td><td>(richiesto)</td><td>Lo stesso valore fornito a <b>AddAvatarContextMenuOption</b> .</td></tr></tbody>
Nome |
---|
AvatarContextMenuTheme
Configura il menu contestuale personalizzabile Avatar, che è una funzione opzionale che consente una facile interazione sociale tra giocatori attraverso azioni personalizzate, come l'avvio di scambi, battaglie e altro ancora.Per maggiori informazioni su come personalizzare il suo tema, vedi l'articolo Menù contestuale dell'Avatar.
Connessioni CoreGuiChat
Configura una connessione gatewaybindabile tra il pulsante di chat della barra superiore CoreGui e il sistema di chat legacy.Il secondo parametro deve essere una tabella di BindableEvents e BindableFunctions .
Parametri
Seleziona la funzionalità con cui la chiamata interagirà.
Una tabella di BindableEvents e BindableFunctions.
Restituzioni
Campioni di codice
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
Questa funzione imposta se l'elemento CoreGui associato al Enum.CoreGuiType dato è abilitato o disabilitato.
La barra superiore non può essere disabilitata utilizzando questa funzione. Per disabilitarla, imposta "TopbarEnabled" a false utilizzando StarterGui:SetCore() .
Parametri
Il dato Enum.CoreGuiType .
Se abilitare o disabilitare il dato Enum.CoreGuiType .
Restituzioni
GetCore
Questo metodo restituisce un insieme di dati o reso disponibile dagli script principali di Roblox.Il primo e unico parametro è una stringa che seleziona le informazioni da recuperare.Le seguenti sezioni descrivono le stringhe e i dati che restituiscono con questa funzione.
Chiamare questo metodo può produrre. Molti di questi registrano anche una funzione equivalente SetCore() (questi sono contrassegnati con un asterisco).
Notifiche di puntiAttive *
Restituisce true se le notifiche di punti del giocatore sono abilitate.
BadgeNotificheAttive *
Restituisce true se le notifiche di badge sono abilitate.
Menù contestuale di Avatar abilitato *
Restituisce true se il Menu contestuale dell'Avatar è abilitato.
ChatAttivo *
Restituisce se la chat è attiva o meno. Questo è indicato dallo stato di selezione dell'Iconadella chat della barra superiore.
Dimensione della finestra di chat *
Restituisce la dimensione della finestra di chat come UDim2 .
Posizione di ChatWindow *
Restituisce la dimensione della finestra di chat come UDim2 .
Barra di chat disabilitata *
Restituisce true se la barra di chat è disabilitata.
Ottieni gli ID utente bloccati
Restituisce una lista di UserIds associati agli utenti che sono stati bloccati dal Giocatorelocale.
Bloccato evento giocatore
Restituisce un BindableEvent che viene attivato ogni volta che un giocatore viene bloccato dal Giocatorelocale.
Evento Unbloccato Giocatore
Restituisce un BindableEvent che viene attivato ogni volta che un giocatore viene sbloccato dal Giocatorelocale.
Evento PlayerMuto
Restituisce un BindableEvent che viene sparato ogni volta che un giocatore viene disattivato dal Giocatorelocale.
Evento di disattivazione giocatore
Restituisce un BindableEvent che viene attivato ogni volta che un giocatore viene disattivato dal Giocatorelocale.
Evento di PlayerFriended
Restituisce un BindableEvent che viene sparato ogni volta che un giocatore viene amico del Giocatorelocale.
Evento di PlayerUnfriended
Restituisce un BindableEvent che viene attivato ogni volta che un giocatore viene disamico dal Giocatorelocale.
DevConsoleVisible *
Restituisce true se la Console di sviluppatore è visibile.
VRRotazioneIntensità
Restituisce una stringa che descrive la sensibilità alla rotazione della fotocamera in VR: Low , High e Smooth .Questo non sarà disponibile a meno che VRService.VREnabled non sia true .