GuiService
*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.
GuiService consente agli sviluppatori di controllare ciò che GuiObject viene attualmente selezionato dal navigatore del gamepad, nonché verificare se il menu principale di Roblox è attualmente aperto.
Sommario
Proprietà
Se attivato, il pulsante Select su un Gamepad o Backslash imposterà automaticamente una GUI come oggetto selezionato.
Attiva/disattiva se gli oggetti nella CoreGui possono essere navigati o meno utilizzando un Gamepad.
Utilizzato per abilitare e disabilitare la navigazione GUI del controller predefinito.
Restituisce vero se qualsiasi menu di CoreGui è aperto.
Ottiene la trasparenza preferita dell'utente come un numero compreso tra 0 e 1, che indica quanto opaco vuole che siano i background di alcuni elementi UI.L'uso raccomandato è come moltiplicatore della trasparenza di sfondo di un elemento.Predefinito su 1.
Restituisce true se l'utente ha abilitato la riduzione del movimento. Predefinito a false .
Imposta l'oggetto Gui attualmente focalizzato dal navigatore GUI (utilizzato per i Gamepad).
Utilizzato per determinare la dimensione e la posizione assolute dell'area non ostruita all'interno dello spazio della barra Spazio.
Utilizzato per abilitare e disabilitare i controlli touch e l'interfaccia utente di visualizzazione dei controlli touch. Predefinito vero.
Metodi
Chiude il menu di ispezione, se aperto.
Verifica se il menu Emote del giocatore è aperto.
Restituisce se la notifica gameplay paused è stata disabilitata dal developer o meno.
Restituisce due valori Vector2 che rappresentano l'inserimento delle interfacce utente in pixel, dall'angolo superiore sinistro dello schermo e dall'angolo inferiore destra dello schermo rispettivamente.
Restituisce se la funzionalità del menu di ispezione e acquisto è abilitata.
Consente a un sviluppatore di aprire il menu Inspect che mostra le risorse elencate in questo oggetto HumanoidDescription .
Consente al menu di ispezione di apparire mostrando all'utente che ha il dato UserId.
Restituisce vero se il client utilizza l'interfaccia a piedi dieci, che è una versione speciale dell'interfaccia utente di Roblox, esclusiva per le console.Questo è l'unico modo garantito per verificare se l'utente è su una console o no.
Imposta GuiService.SelectedObject a un figlio della selezione dell'istanza fornita selezioneparent che è PlayerGui o suoi discendenti.
Apre o chiude il menu delle Emote del giocatore.
Consente agli sviluppatori di disabilitare la notifica integrata quando il gameplay di un giocatore viene interrotto.
Consente agli sviluppatori di abilitare o disabilitare la funzionalità di ispezione e acquisto predefinita.
Eventi
Si accende quando l'utente chiude il menu di fuga del core di Roblox.
Si accende quando l'utente apre il menu di fuga del core di Roblox.
Proprietà
AutoSelectGuiEnabled
Se attivato, il pulsante Select su un Gamepad o Backslash imposterà automaticamente una GUI come oggetto selezionato.Disattivarlo significherà che la navigazione Gui funzionerà ancora se GuiService.GuiNavigationEnabled è abilitata, ma dovrai impostare GuiService.SelectedObject manualmente per avviare la navigazione Gui.
CoreGuiNavigationEnabled
Attiva/disattiva se gli oggetti nella CoreGui possono essere navigati o meno utilizzando un Gamepad.
GuiNavigationEnabled
Utilizzato per abilitare e disabilitare la navigazione GUI del controller predefinito.
PreferredTextSize
PreferredTransparency
Ottiene la trasparenza preferita dell'utente come un numero compreso tra 0 e 1, che indica quanto più opaca vuole essere il background degli elementi dell'interfaccia utente.Predefinito su 1.
Questo valore di restituzione riflette una impostazione che può essere impostata dal lato dell'utente nelle impostazioni dell'app o all'interno del menu delle impostazioni in-experience tramite Trasparenza di sfondo .Il valore predefinito è 1, che indica che l'utente preferisce la trasparenza di sfondo predefinita.Il valore più basso è 0, che indica che l'utente preferisce che i background siano completamente opachi, migliorando la leggibilità e il contrasto per l'interfaccia utente interessata.Moltiplicare un elemento di GuiObject.BackgroundTransparency con il valore restituito da PreferredTransparency è il modo raccomandato di utilizzare questa Configurazione; i background diventeranno più opachi man mano che PreferredTransparency si avvicina a 0.Questo deve essere utilizzato con Object:GetPropertyChangedSignal() in modo che si aggiorna automaticamente quando l'utente cambia la sua trasparenza preferita.
Campioni di codice
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.
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
Restituisce true se l'utente ha abilitato la riduzione del movimento. Predefinito a false .
Questo valore di restituzione riflette una impostazione che può essere impostata dal lato dell'utente nelle impostazioni dell'app o all'interno del menu delle impostazioni in-experience tramite Riduci la velocità .Un valore di true indica che l'utente vuole ridurre o rimuovere completamente gli effetti di movimento e le animazioni.
Campioni di codice
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.
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
Imposta il GuiObject attualmente focalizzato dal navigatore GUI (utilizzato per i Gamepad). Questo può essere ripristinato a nil se l'oggetto è fuori schermo.
Questa proprietà viene modificata dagli eventi GuiObject.SelectionGained e GuiObject.SelectionLost.
Se desideri determinare quando questa proprietà cambia senza tracciare gli eventi SelectionGained e SelectionLost per tutti gli elementi GUI, puoi utilizzare l'evento Changed.
Campioni di codice
The code below demonstrates how to handle when the SelectedObject changes. For instance, this event fires when the Gamepad navigates to another GUI element.
local GuiService = game:GetService("GuiService")
local function printChanged(value)
if value == "SelectedObject" then
print("The SelectedObject changed!")
end
end
GuiService.Changed:Connect(printChanged)
TopbarInset
Restituisce un oggetto Rect che rappresenta l'area non occupata tra i controlli più a sinistra di Roblox e l'estremità dell'area sicura del dispositivo.
Il valore è dinamico e può essere atteso a cambiare in base alla visibilità dei controlli dell'interfaccia utente come il cambio della ProprietàHealth del Giocatorelocale, l'uso di StarterGui:SetCoreGuiEnabled() , il cambio delle dimensioni e della posizione dei controlli dell'interfaccia utente Roblox e/o altri.Per questo motivo, si consiglia di rilevare e reagire ai cambiamenti di questa proprietà con Object:GetPropertyChangedSignal() .
Campioni di codice
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.
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
Utilizzato per abilitare e disabilitare i controlli touch e l'interfaccia utente di visualizzazione dei controlli touch. Predefinito vero.
Metodi
CloseInspectMenu
Questa funzione chiude il menu di ispezione, se aperto, quando viene eseguito da un LocalScript .
Vedi anche:
- Menu di ispezione dell'avatar, un articolo che fornisce una spiegazione più dettagliata della funzione di ispezione e acquisto e di come funziona
- GuiService:InspectPlayerFromHumanoidDescription() , consente a un sviluppatore di visualizzare il menu di ispezione che mostra le risorse elencate in questo oggetto HumanoidDescription .Questo è particolarmente utile quando ciò che viene indossato sull'avatar di un Giocatoresulla piattaforma Roblox non è necessariamente lo stesso della sua aspettoin gioco
- GuiService:InspectPlayerFromUserId() , consente al menu di ispezione di apparire mostrando all'utente che ha il dato UserId .Questo è particolarmente utile quando vuoi ispezionare i giocatori che non sono nel Giocoattuale
Restituzioni
GetEmotesMenuOpen
Restituisce un booleano che indica se il menu Emote del giocatore è aperto o meno.
Gli sviluppatori possono aprire o chiudere il menu delle Emote chiamando la funzione GuiService:SetEmotesMenuOpen().
Restituzioni
Indica se il menu delle Emote è aperto.
GetGameplayPausedNotificationEnabled
Questa funzione restituisce se la notifica gameplay paused è stata disabilitata dal developer o meno.
Gli sviluppatori possono abilitare o disabilitare la notifica chiamando la funzione GuiService:SetGameplayPausedNotificationEnabled().
Vedi anche:
- Workspace.StreamingIntegrityMode e Enum.StreamingIntegrityMode per maggiori dettagli su quando il gameplay viene interrotto.
Restituzioni
Se la notifica gameplay paused è stata disabilitata o meno.
GetGuiInset
Restituisce due valori Vector2 che rappresentano l'inserimento delle interfacce utente in pixel, dall'angolo superiore sinistro dello schermo e dall'angolo inferiore destra dello schermo rispettivamente.
I valori degli inserimenti forniti da questa funzione hanno effetto solo su ScreenGuis quelli che hanno la loro proprietà IgnoreGuiInset impostata su false.
Restituzioni
Un tuple di due valori Vector2 che descrive l'attuale inserimento Gui specificato.
GetInspectMenuEnabled
Questa funzione restituisce se la funzionalità del menu di ispezione e acquisto è attualmente abilitata.La funzione è abilitata per impostazione predefinita e può essere impostata utilizzando la funzione GuiService:SetInspectMenuEnabled().
Vedi anche:
- Menu di ispezione dell'avatar, un articolo che fornisce una spiegazione più dettagliata della funzione di ispezione e acquisto e di come funziona
- GuiService:InspectPlayerFromHumanoidDescription() , consente a un sviluppatore di visualizzare il menu di ispezione che mostra le risorse elencate in questo oggetto HumanoidDescription .Questo è particolarmente utile quando ciò che viene indossato sull'avatar di un Giocatoresulla piattaforma Roblox non è necessariamente lo stesso della sua aspettoin gioco
- GuiService:InspectPlayerFromUserId() , consente al menu di ispezione di apparire mostrando all'utente che ha il dato UserId .Questo è particolarmente utile quando vuoi ispezionare i giocatori che non sono nel Giocoattuale
Restituzioni
Un booleano che indica se la funzione del menu di ispezione è abilitata.
InspectPlayerFromHumanoidDescription
Questa funzione consente a un sviluppatore di visualizzare il menu di ispezione che mostra le risorse elencate in questo HumanoidDescription.
Questo consente una ulteriore personalizzazione con ciò che viene mostrato nel menu ispeziona quando i giocatori ispezionano altri giocatori nel tuo Gioco.Se il tuo gioco modifica ciò che indossano i giocatori, puoi invece dare al menu di ispezione un oggetto HumanoidDescription che rappresenta ciò che indossa un giocatore e questi oggetti verranno mostrati.Dovresti passare anche un nome per rappresentare il nome del giocatore che verrà ispezionato.
Vedi anche:
- Menu di ispezione dell'avatar, un articolo che fornisce una spiegazione più dettagliata della funzione di ispezione e acquisto e di come funziona
- GuiService:SetInspectMenuEnabled() , consente agli sviluppatori di abilitare o disabilitare la funzionalità di ispezione e acquisto predefinita
- GuiService:InspectPlayerFromUserId() , consente al menu di ispezione di apparire mostrando all'utente che ha il dato UserId .Questo è particolarmente utile quando vuoi ispezionare i giocatori che non sono nel Giocoattuale.
Parametri
Un oggetto HumanoidDescription che contiene le risorse da mostrare nel menu Ispeziona.
Il nome del giocatore che viene ispezionato per essere mostrato nel menu di ispezione.
Restituzioni
Campioni di codice
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.
local GuiService = game:GetService("GuiService")
local humanoidDescription = Instance.new("HumanoidDescription")
humanoidDescription.HatAccessory = "3339374070"
humanoidDescription.BackAccessory = "3339363671"
GuiService:InspectPlayerFromHumanoidDescription(humanoidDescription, "MyPlayer")
InspectPlayerFromUserId
Questa funzione consente all'Inspect Menu di apparire mostrando all'utente che ha il dato UserId .Questo è particolarmente utile quando vuoi ispezionare i giocatori che non sono nel Giocoattuale.
Questo mostra le stesse informazioni della scheda "Attualmente indossando" sul Profilodell'utente specificato.
Vedi anche:
- Menu di ispezione dell'avatar, un articolo che fornisce una spiegazione più dettagliata della funzione di ispezione e acquisto e di come funziona
- GuiService:SetInspectMenuEnabled() , consente agli sviluppatori di abilitare o disabilitare la funzionalità di ispezione e acquisto predefinita.Questo è particolarmente utile quando ciò che viene indossato sull'avatar di un Giocatoresulla piattaforma Roblox non è necessariamente lo stesso della sua aspettoin gioco
- GuiService:InspectPlayerFromHumanoidDescription() , consente a un sviluppatore di visualizzare il menu di ispezione che mostra le risorse elencate in questo oggetto HumanoidDescription
Parametri
Restituzioni
Campioni di codice
The code sample below demonstrates how to use GuiService:InspectPlayerFromUserId() to open the Inspect Menu for the Roblox user with the id 772462.
local GuiService = game:GetService("GuiService")
GuiService:InspectPlayerFromUserId(772462)
IsTenFootInterface
Restituisce vero se il client utilizza l'interfaccia a piedi dieci, che è una versione speciale dell'interfaccia utente di Roblox, esclusiva per le console.Questo è l'unico modo garantito per verificare se l'utente è su una console o no.
Restituzioni
Select
Quando Seleziona viene chiamato su un'istanza selezioneParent che è PlayerGui o un discendente di PlayerGui, il motore cerca tutti gli GuiObject selezionabili, visibili e sullo schermo che sono discendenti di selectionParent e imposta il GuiService.SelectedObject a quell'GuiObject con il più piccolo GuiService.SelectionOrder .
Parametri
Il genitore della selezione i cui discendenti vengono cercati.
Restituzioni
Campioni di codice
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.
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()
SetEmotesMenuOpen
Apre o chiude il menu delle Emote del giocatore.
Parametri
Restituzioni
SetGameplayPausedNotificationEnabled
Questo metodo consente agli sviluppatori di disabilitare la notifica integrata quando il gioco di un giocatore viene interrotto.Possono quindi aggiungere la propria interfaccia utente se desiderano personalizzarla.
Gli sviluppatori possono chiedere se la notifica è abilitata chiamando la funzione GuiService:GetGameplayPausedNotificationEnabled().
Vedi anche:
- Workspace.StreamingIntegrityMode e Enum.StreamingIntegrityMode per maggiori dettagli su quando il gameplay viene interrotto.
Parametri
Se la GUI di notifica integrata è disabilitata o meno.
Restituzioni
SetInspectMenuEnabled
Questa funzione consente agli sviluppatori di abilitare o disabilitare la funzionalità di ispezione e acquisto predefinita.Questo è utile quando vuoi disabilitare la funzione nel tuo Gioco, interamente o durante alcune parti del tuo gioco (come una scena).La funzione è abilitata per impostazione predefinita.
L'esempio di codice qui sotto mostra come disabilitare il menu di ispezione per il tuo Gioco:
local GuiService = game:GetService("GuiService")GuiService:SetInspectMenuEnabled(false)
Vedi anche:
- Menu di ispezione dell'avatar, un articolo che fornisce una spiegazione più dettagliata della funzione di ispezione e acquisto e di come funziona
- GuiService:InspectPlayerFromHumanoidDescription() , consente a un sviluppatore di visualizzare il menu di ispezione che mostra le risorse elencate in questo oggetto HumanoidDescription .Questo è particolarmente utile quando ciò che viene indossato sull'avatar di un Giocatoresulla piattaforma Roblox non è necessariamente lo stesso della sua aspettoin gioco
- GuiService:InspectPlayerFromUserId() , consente al menu di ispezione di apparire mostrando all'utente che ha il dato UserId .Questo è particolarmente utile quando vuoi ispezionare i giocatori che non sono nel Giocoattuale
Parametri
Un booleano che indica se abilitare o disabilitare la Proprietàdel menu di ispezione.
Restituzioni
Eventi
MenuClosed
Si accende quando l'utente chiude il menu di fuga del core di Roblox.
MenuOpened
Si accende quando l'utente apre il menu di fuga del core di Roblox.