GuiService

Mostrar obsoleto

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Não criável
Serviço
Não replicado

Serviço Gui permite que os desenvolvedores controlem o que GuiObject está sendo selecionado atualmente pelo navegador do gamepad, bem como verifiquem se o menu principal do Roblox está atualmente aberto.

Resumo

Propriedades

  • Se ativado, o botão Select na Gamepad ou Backslash será automaticamente definido como uma GUI como o Objetoselecionado.

  • Oculto
    Não replicado
    Ler Parallel

    Alterna se os objetos na CoreGui podem ou não ser navegados usando um Gamepad.

  • Usado para ativar e desativar a navegação padrão do controlador GUI.

  • Somente leitura
    Não replicado
    Ler Parallel

    Retorna verdadeiro se algum menu do CoreGui estiver aberto.

  • Somente leitura
    Não replicado
    Ler Parallel
  • Oculto
    Somente leitura
    Não replicado
    Ler Parallel

    Obtém a transparência preferida do usuário como um número entre 0 e 1, o que indica quão opaca eles querem que os fundos de certos elementos de UI sejam.O uso recomendado é como multiplicador da Transparência de Fundo de um elemento.Padrão para 1.

  • Oculto
    Somente leitura
    Não replicado
    Ler Parallel

    Retorna true se o usuário habilitou movimento reduzido. Padrão para false .

  • Define o GuiObject atualmente focado no GUI Navigator (usado para Gamepads).

  • Somente leitura
    Não replicado
    Ler Parallel

    Usado para determinar o tamanho absoluto e a posição da área desobstruída dentro do espaço da barra superior.

  • Usado para ativar e desativar controles de toque e exibir a interface de usuário de controles de toque. Padrão para verdadeiro.

Métodos

Eventos

Propriedades

AutoSelectGuiEnabled

Ler Parallel

Se ativado, o botão Select na Gamepad ou Backslash será automaticamente definido como uma GUI como o Objetoselecionado.Desligar isso significa que a navegação Gui ainda funcionará se GuiService.GuiNavigationEnabled for ativada, mas você terá que definir GuiService.SelectedObject manualmente para iniciar a navegação Gui.

CoreGuiNavigationEnabled

Oculto
Não replicado
Ler Parallel

Alterna se os objetos na CoreGui podem ou não ser navegados usando um Gamepad.

GuiNavigationEnabled

Ler Parallel

Usado para ativar e desativar a navegação padrão do controlador GUI.

Somente leitura
Não replicado
Ler Parallel

Retorna verdadeiro se algum menu de CoreGui estiver aberto.

PreferredTextSize

Somente leitura
Não replicado
Ler Parallel

PreferredTransparency

Oculto
Somente leitura
Não replicado
Ler Parallel

Obtém a transparência preferida do usuário como um número entre 0 e 1, o que indica o quão mais opaca eles querem que seja o plano de fundo de elementos de UI.Padrão para 1.

Este valor de retorno reflete uma configuração que pode ser definida do lado do usuário nas configurações do aplicativo ou dentro do menu de configurações na experiência através de Transparência de Fundo .O valor padrão é 1, indicando que o usuário prefere a transparência de fundo padrão.O menor valor é 0, indicando que o usuário prefere que os fundos sejam completamente opacos, melhorando a legibilidade e o contraste para a interface afetada.Multiplicar um elemento de com o valor retornado de é a maneira recomendada de usar essa configuração; os fundos se tornarão mais opacos à medida que se aproximam de 0.Isso deve ser usado com Object:GetPropertyChangedSignal() para que seja atualizado automaticamente quando o usuário mudar sua transparência preferida.

Amostras de código

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.

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

Oculto
Somente leitura
Não replicado
Ler Parallel

Retorna true se o usuário habilitou movimento reduzido. Padrão para false .

Este valor de retorno reflete uma configuração que pode ser definida do lado do usuário nas configurações do aplicativo ou dentro do menu de configurações na experiência através de Reduzir Movimento .Um valor de true indica que o usuário quer que os efeitos de movimento e animações sejam reduzidos ou completamente removidos.

Amostras de código

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.

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

Ler Parallel

Define o GuiObject atualmente focado no GUI Navigator (usado para Gamepads). Isso pode ser redefinido para nil se o objeto estiver fora da tela.

Essa propriedade é alterada pelos eventos GuiObject.SelectionGained e GuiObject.SelectionLost.

Se você quiser determinar quando essa propriedade muda sem rastrear os eventos SelectionGained e SelectionLost para todos os elementos de GUI, você pode usar o evento Changed.

Amostras de código

The code below demonstrates how to handle when the SelectedObject changes. For instance, this event fires when the Gamepad navigates to another GUI element.

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

Somente leitura
Não replicado
Ler Parallel

Retorna um objeto Rect que representa a área não ocupada entre os controles mais à esquerda do Roblox e a borda da área segura do dispositivo.

O valor é dinâmico e pode ser esperado que mude com base na visibilidade de controles de UI, como alterar a propriedade Health do jogador local, uso de StarterGui:SetCoreGuiEnabled() , alterar o tamanho e a posição dos controles de UI do Roblox e/ou outros.Por esse motivo, é recomendado que você detecte e reaja às alterações dessa propriedade com Object:GetPropertyChangedSignal() .

Amostras de código

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.

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

Ler Parallel

Usado para ativar e desativar controles de toque e exibir a interface de usuário de controles de toque. Padrão para verdadeiro.

Métodos

CloseInspectMenu

()

Essa função fecha o menu de inspeção, se aberto, quando executada a partir de um LocalScript .

Veja também:

  • Menu de inspeção de avatar, um artigo que fornece uma explicação mais detalhada da funcionalidade de inspeção e compra e como ela funciona
  • GuiService:InspectPlayerFromHumanoidDescription() , permite que um desenvolvedor levante o menu Inspecionar mostrando os recursos listados neste ObjetoHumanoidDescription.Isso é especialmente útil quando o que está sendo usado no avatar de um jogador na plataforma Roblox não é necessariamente o mesmo que sua aparência no jogo
  • GuiService:InspectPlayerFromUserId() , permite que o Menu de Inspeção apareça mostrando ao usuário que tem o dado UserId .Isso é especialmente útil quando você quer inspecionar jogadores que não estão no jogo atual

Devolução

()

DismissNotification

Parâmetros

notificationId: string
Valor Padrão: ""

Devolução

GetEmotesMenuOpen

Retorna um booleano indicando se o menu Emotes do jogador está aberto ou não.

Os desenvolvedores podem abrir ou fechar o menu de Emotes chamando a função GuiService:SetEmotesMenuOpen().


Devolução

Indica se o menu Emotes está aberto.

GetGameplayPausedNotificationEnabled

Essa função retorna se a notificação gameplay paused foi desativada pelo desenvolvedor ou não.

Os desenvolvedores podem habilitar ou desabilitar a notificação ao chamar a função GuiService:SetGameplayPausedNotificationEnabled().

Veja também:


Devolução

Se a notificação gameplay paused foi desativada ou não.

GetGuiInset

Retorna dois valores Vector2 representando a inserção de GUIs do usuário em pixels, do canto superior esquerdo da tela e do canto inferior direito da tela, respectivamente.

Os valores de inserção fornecidos por essa função só entram em vigor em ScreenGuis que têm sua propriedade IgnoreGuiInset definida como falsa.


Devolução

Um tuple de dois valores Vector2 que descreve o inserção Gui atual especificada.

GetInspectMenuEnabled

Essa função retorna se a funcionalidade do menu Inspecionar e Comprar está atualmente habilitada.O recurso está habilitado por padrão e pode ser definido usando a função GuiService:SetInspectMenuEnabled().

Veja também:

  • Menu de inspeção de avatar, um artigo que fornece uma explicação mais detalhada da funcionalidade de inspeção e compra e como ela funciona
  • GuiService:InspectPlayerFromHumanoidDescription() , permite que um desenvolvedor levante o menu Inspecionar mostrando os recursos listados neste ObjetoHumanoidDescription.Isso é especialmente útil quando o que está sendo usado no avatar de um jogador na plataforma Roblox não é necessariamente o mesmo que sua aparência no jogo
  • GuiService:InspectPlayerFromUserId() , permite que o Menu de Inspeção apareça mostrando ao usuário que tem o dado UserId .Isso é especialmente útil quando você quer inspecionar jogadores que não estão no jogo atual

Devolução

Um booleano que indica se a funcionalidade do Menu de Inspeção está habilitada.

InspectPlayerFromHumanoidDescription

()

Essa função permite que um desenvolvedor abra o menu Inspecionar mostrando os recursos listados neste Objeto.

Isso permite uma maior personalização com o que é mostrado no menu de inspeção quando os jogadores inspecionam outros jogadores em seu jogo.Se o seu jogo modificar o que os jogadores estão vestindo, você pode dar ao menu de inspeção um objeto de Descrição Humanoide que representa o que um jogador está vestindo e esses itens serão mostrados.Você deve passar um nome também para representar o nome do jogador que será inspecionado.

Veja também:

Parâmetros

humanoidDescription: Instance

Um objeto HumanoidDescription que contém os recursos a mostrar no menu Inspecionar.

Valor Padrão: ""
name: string

O nome do jogador que está sendo inspecionado para mostrar no menu de inspeção.

Valor Padrão: ""

Devolução

()

Amostras de código

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.

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

()

Essa função permite que o menu de inspeção apareça mostrando ao usuário que tem o dado UserId.Isso é especialmente útil quando você quer inspecionar jogadores que não estão no jogo atual.

Isso mostra a mesma informação da aba "Atualmente Usando" no perfil do usuário especificado.

Veja também:

Parâmetros

userId: number

O UserId do jogador para inspecionar.

Valor Padrão: ""

Devolução

()

Amostras de código

The code sample below demonstrates how to use GuiService:InspectPlayerFromUserId() to open the Inspect Menu for the Roblox user with the id 772462.

Opening the Inspect Menu for a UserId

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

IsTenFootInterface

Retorna verdadeiro se o cliente estiver usando a interface de dez pés, que é uma versão especial da interface do Roblox, exclusiva para consoles.Esta é a única maneira garantida de verificar se o usuário está em um console ou não.


Devolução

Select

()

Quando a seleção Selecionar é chamada em uma seleção de instânciasParent que é PlayerGui ou um descende de PlayerGui, o motor pesquisa todos os GuiObjects selecionáveis, visíveis e na tela disponíveis que são descendentes de seleçãoParent e define o GuiService.SelectedObject para o GuiObject com o menor GuiService.SelectionOrder .

Parâmetros

selectionParent: Instance

O pai da seleção cujos descendentes são pesquisados.

Valor Padrão: ""

Devolução

()

Amostras de código

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.

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

Parâmetros

notificationInfo: Dictionary
Valor Padrão: ""

Devolução

SetEmotesMenuOpen

()

Abre ou fecha o menu de Emotes do jogador.

Parâmetros

isOpen: boolean
Valor Padrão: ""

Devolução

()

SetGameplayPausedNotificationEnabled

()

Este método permite que os desenvolvedores desabilitem a notificação integrada quando o jogo de um jogador for pausado.Eles podem então adicionar sua própria interface de usuário se desejarem personalizá-la.

Os desenvolvedores podem consultar se a notificação está habilitada ao chamar a função GuiService:GetGameplayPausedNotificationEnabled().

Veja também:

Parâmetros

enabled: boolean

Se a GUI de notificação integrada está ou não desativada.

Valor Padrão: ""

Devolução

()

SetInspectMenuEnabled

()

Essa função permite que os desenvolvedores ativem ou desativem a funcionalidade padrão de Inspeção e Compra.Isso é útil quando você quer desativar o recurso em seu jogo, inteiramente ou durante certas partes de seu jogo (como uma cutscene).O recurso é habilitado por padrão.

O exemplo de código abaixo mostra como desativar o Menu de Inspeção para o seu jogo:


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

Veja também:

  • Menu de inspeção de avatar, um artigo que fornece uma explicação mais detalhada da funcionalidade de inspeção e compra e como ela funciona
  • GuiService:InspectPlayerFromHumanoidDescription() , permite que um desenvolvedor levante o menu Inspecionar mostrando os recursos listados neste ObjetoHumanoidDescription.Isso é especialmente útil quando o que está sendo usado no avatar de um jogador na plataforma Roblox não é necessariamente o mesmo que sua aparência no jogo
  • GuiService:InspectPlayerFromUserId() , permite que o Menu de Inspeção apareça mostrando ao usuário que tem o dado UserId .Isso é especialmente útil quando você quer inspecionar jogadores que não estão no jogo atual

Parâmetros

enabled: boolean

Um booleano que indica se habilitar ou desabilitar a funcionalidadedo menu Inspecionar.

Valor Padrão: ""

Devolução

()

Eventos

Incêndios quando o usuário fecha o menu de escapamento do núcleo do Roblox.


Incêndios quando o usuário abre o menu de escapatória do núcleo do Roblox.