GuiService

Mostrar obsoleto

*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

No creable
Servicio
No replicado

GuiService permite a los desarrolladores controlar lo que GuiObject se está seleccionando actualmente por el navegador del gamepad, así como verificar si el menú principal de Roblox está actualmente abierto.

Resumen

Propiedades

  • Si se activa, el botón Select en un Gamepad o Backslash establecerá automáticamente una interfaz de usuario como el objeto seleccionado.

  • Oculto
    No replicado
    Leer paralelo

    Alterna si los objetos en el CoreGui se pueden navegar o no usando un Gamepad.

  • Se utiliza para habilitar y deshabilitar la navegación GUI predeterminada del controlador.

  • Solo lectura
    No replicado
    Leer paralelo

    Devuelve verdadero si se abre cualquier menú de CoreGui.

  • Solo lectura
    No replicado
    Leer paralelo
  • Oculto
    Solo lectura
    No replicado
    Leer paralelo

    Obtiene la transparencia preferida del usuario como un número entre 0 y 1, lo que indica qué opaca quiere que sean los fondos de ciertos elementos de interfaz de usuario.El uso recomendado es como multiplicador de la transparencia de fondo de un elemento.Por defecto a 1.

  • Oculto
    Solo lectura
    No replicado
    Leer paralelo

    Devuelve true si el usuario ha habilitado la movilidad reducida. Se prefiere a false .

  • Establece el GuiObject que se está enfocando actualmente en el navegador GUI (usado para Gamepads).

  • Solo lectura
    No replicado
    Leer paralelo

    Se usa para determinar el tamaño y la posición absoluta del área sin obstruir dentro del espacio de la barra superior.

  • Se usa para habilitar y deshabilitar los controles táctiles y la interfaz de usuario de visualización táctil. Se prefiere verdadero.

Métodos

Eventos

Propiedades

AutoSelectGuiEnabled

Leer paralelo

Si se activa, el botón Select en un Gamepad o Backslash establecerá automáticamente una interfaz de usuario como el objeto seleccionado.Desactivar esto significará que la navegación de Gui seguirá funcionando si GuiService.GuiNavigationEnabled está habilitada, pero tendrás que configurar GuiService.SelectedObject manualmente para iniciar la navegación de Gui.

CoreGuiNavigationEnabled

Oculto
No replicado
Leer paralelo

Alterna si los objetos en el CoreGui se pueden navegar o no usando un Gamepad.

GuiNavigationEnabled

Leer paralelo

Se utiliza para habilitar y deshabilitar la navegación GUI predeterminada del controlador.

Solo lectura
No replicado
Leer paralelo

Devuelve verdadero si se abre cualquier menú de CoreGui.

PreferredTextSize

Solo lectura
No replicado
Leer paralelo

PreferredTransparency

Oculto
Solo lectura
No replicado
Leer paralelo

Obtiene la transparencia preferida del usuario como un número entre 0 y 1, lo que indica cuánto más opaca quieren que sea el fondo de los elementos de la interfaz de usuario.Por defecto a 1.

Este valor de devolución refleja una configuración que se puede establecer desde el lado del usuario en las configuraciones de la aplicación o dentro del menú de configuración en la experiencia a través de transparencia de fondo .El valor predeterminado es 1, lo que indica que el usuario prefiere la transparencia de fondo predeterminada.El valor más bajo es 0, lo que indica que el usuario prefiere que los fondos sean completamente opacos, mejorando la legibilidad y el contraste para la interfaz de usuario afectada.Multiplicar un elemento de con el valor devuelto de es la forma recomendada de utilizar esta configuración; los fondos se volverán más opacos a medida que se acerque 0.Esto debe usarse con Object:GetPropertyChangedSignal() para que se actualice automáticamente cuando el usuario cambie su transparencia preferida.

Muestras 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
Solo lectura
No replicado
Leer paralelo

Devuelve true si el usuario ha habilitado la movilidad reducida. Se prefiere a false .

Este valor de devolución refleja una configuración que se puede establecer desde el lado del usuario en los ajustes de la aplicación o dentro del menú de ajustes en la experiencia a través de Reducir el movimiento .Un valor de true indica que el usuario quiere que los efectos de movimiento y las animaciones se reduzcan o se eliminen completamente.

Muestras 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

Leer paralelo

Establece el GuiObject que actualmente se está enfocando en el navegador de la interfaz gráfica (usado para Gamepads). Esto puede restablecerse a nil si el objeto está fuera de la pantalla.

Esta propiedad es cambiada por los eventos GuiObject.SelectionGained y GuiObject.SelectionLost.

Si desea determinar cuándo cambia esta propiedad sin rastrear los eventos SelectionGained y SelectionLost para todos los elementos de interfaz gráfica, puede usar el evento Changed.

Muestras 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

Solo lectura
No replicado
Leer paralelo

Devuelve un objeto Rect que representa el área no ocupada entre los controles más a la izquierda de Roblox y el borde de la zona segura del dispositivo.

El valor es dinámico y se puede esperar que cambie según la visibilidad de los controles de la interfaz de usuario, como cambiar la propiedad Health del jugador local, el uso de StarterGui:SetCoreGuiEnabled() , el cambio del tamaño y la posición de los controles de la interfaz de usuario de Roblox, y/o otros.Por esta razón, se recomienda que detectes y reacciones a los cambios de esta propiedad con Object:GetPropertyChangedSignal() .

Muestras 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

Leer paralelo

Se usa para habilitar y deshabilitar los controles táctiles y la interfaz de usuario de visualización táctil. Se prefiere verdadero.

Métodos

CloseInspectMenu

()

Esta función cierra el menú de inspección, si está abierto, cuando se ejecuta desde un LocalScript.

Vea también:

  • Menú de inspección de avatares, un artículo que proporciona una explicación más detallada de la función de inspección y compra y cómo funciona
  • GuiService:InspectPlayerFromHumanoidDescription() , permite a un desarrollador mostrar el menú de inspección que muestra los recursos enumerados en este objeto HumanoidDescription .Esto es especialmente útil cuando lo que se lleva en el avatar de un jugador en la plataforma Roblox no es necesariamente igual a su aspecto, looken el juego
  • GuiService:InspectPlayerFromUserId() , permite que el menú de inspección aparezca mostrando al usuario que tiene el dado UserId .Esto es especialmente útil cuando quieres inspeccionar a jugadores que no están en el juego actual

Devuelve

()

DismissNotification

Parámetros

notificationId: string
Valor predeterminado: ""

Devuelve

GetEmotesMenuOpen

Devuelve un booleano que indica si el menú de Emotes del jugador está abierto o no.

Los desarrolladores pueden abrir o cerrar el menú de Emotes llamando a la función GuiService:SetEmotesMenuOpen().


Devuelve

Indica si el menú de Emotes está abierto.

GetGameplayPausedNotificationEnabled

Esta función devuelve si la notificación gameplay paused se ha desactivado o no por el desarrollador.

Los desarrolladores pueden habilitar o deshabilitar la notificación llamando a la función GuiService:SetGameplayPausedNotificationEnabled().

Vea también:


Devuelve

Si la notificación gameplay paused se ha desactivado o no.

GetGuiInset

Devuelve dos valores Vector2 que representan el inserto de interfaces de usuario en píxeles, desde la esquina superior izquierda de la pantalla y la esquina inferior derecha de la pantalla, respectivamente.

Los valores de inserción proporcionados por esta función solo tienen efecto en ScreenGuis que tienen su propiedad IgnoreGuiInset establecida en false.


Devuelve

Un túnel de dos valores Vector2 que describe el inserto Gui actual especificado.

GetInspectMenuEnabled

Esta función devuelve si la funcionalidad de Inspeccionar y Comprar está actualmente habilitada.La función está habilitada por defecto y se puede configurar usando la función GuiService:SetInspectMenuEnabled().

Vea también:

  • Menú de inspección de avatares, un artículo que proporciona una explicación más detallada de la función de inspección y compra y cómo funciona
  • GuiService:InspectPlayerFromHumanoidDescription() , permite a un desarrollador mostrar el menú de inspección que muestra los recursos enumerados en este objeto HumanoidDescription .Esto es especialmente útil cuando lo que se lleva en el avatar de un jugador en la plataforma Roblox no es necesariamente igual a su aspecto, looken el juego
  • GuiService:InspectPlayerFromUserId() , permite que el menú de inspección aparezca mostrando al usuario que tiene el dado UserId .Esto es especialmente útil cuando quieres inspeccionar a jugadores que no están en el juego actual

Devuelve

Un booleano que indica si la función del menú de inspección está habilitada.

InspectPlayerFromHumanoidDescription

()

Esta función permite a un desarrollador mostrar el menú de inspección que muestra los recursos enumerados en este objeto HumanoidDescription.

Esto permite una mayor personalización con lo que se muestra en el menú de inspección cuando los jugadores inspeccionan a otros jugadores en tu juego.Si tu juego modifica lo que los jugadores están usando, puedes darle al menú de inspección un objeto de Descripción Humanoide que represente lo que un jugador está usando y esos artículos se mostrarán.Deberías pasar un nombre también para representar el nombre del jugador que se inspeccionará.

Vea también:

Parámetros

humanoidDescription: Instance

Un objeto HumanoidDescription que contiene los recursos para mostrar en el menú de inspección.

Valor predeterminado: ""
name: string

El nombre del jugador que se está inspeccionando para mostrar en el menú de inspección.

Valor predeterminado: ""

Devuelve

()

Muestras 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

()

Esta función permite que el menú de inspección aparezca mostrando al usuario que tiene el dado UserId .Esto es especialmente útil cuando quieres inspeccionar a jugadores que no están en el juego actual.

Esto muestra la misma información que la pestaña "Actualmente usando" en el perfil del usuario especificado.

Vea también:

Parámetros

userId: number

El UserId del jugador para inspeccionar.

Valor predeterminado: ""

Devuelve

()

Muestras 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

Devuelve verdadero si el cliente está utilizando la interfaz de diez pies, que es una versión especial de la interfaz de usuario de Roblox, exclusiva para consolas.Esta es la única manera garantizada de verificar si el usuario está en una consola o no.


Devuelve

Select

()

Cuando se llama Select en una selección de instanciasParent que es PlayerGui o un descendiente de PlayerGui, el motor busca todos los GuiObjects seleccionables, visibles y en la pantalla disponibles que son descendientes de selectionParent y establece el al GuiObject con el GuiObject más pequeño.

Parámetros

selectionParent: Instance

El padre de la selección cuyos descendientes se buscan.

Valor predeterminado: ""

Devuelve

()

Muestras 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 predeterminado: ""

Devuelve

SetEmotesMenuOpen

()

Abre o cierra el menú de Emotes del jugador.

Parámetros

isOpen: boolean
Valor predeterminado: ""

Devuelve

()

SetGameplayPausedNotificationEnabled

()

Este método permite a los desarrolladores deshabilitar la notificación integrada cuando se pausa el juego de un jugador.Luego pueden agregar su propia interfaz de usuario si desean personalizarla.

Los desarrolladores pueden consultar si la notificación está habilitada llamando a la función GuiService:GetGameplayPausedNotificationEnabled().

Vea también:

Parámetros

enabled: boolean

Si se desactiva o no la interfaz de notificación integrada.

Valor predeterminado: ""

Devuelve

()

SetInspectMenuEnabled

()

Esta función permite a los desarrolladores habilitar o deshabilitar la funcionalidad predeterminada de inspección y compra.Esto es útil cuando quieres desactivar la función en tu juego, completamente o durante ciertas partes de tu juego (como una escena de corte).La función está habilitada por defecto.

El ejemplo de código a continuación muestra cómo deshabilitar el menú de inspección para tu juego:


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

Vea también:

  • Menú de inspección de avatares, un artículo que proporciona una explicación más detallada de la función de inspección y compra y cómo funciona
  • GuiService:InspectPlayerFromHumanoidDescription() , permite a un desarrollador mostrar el menú de inspección que muestra los recursos enumerados en este objeto HumanoidDescription .Esto es especialmente útil cuando lo que se lleva en el avatar de un jugador en la plataforma Roblox no es necesariamente igual a su aspecto, looken el juego
  • GuiService:InspectPlayerFromUserId() , permite que el menú de inspección aparezca mostrando al usuario que tiene el dado UserId .Esto es especialmente útil cuando quieres inspeccionar a jugadores que no están en el juego actual

Parámetros

enabled: boolean

Un booleano que indica si habilitar o deshabilitar la función del menú de inspección.

Valor predeterminado: ""

Devuelve

()

Eventos

Se enciende cuando el usuario cierra el menú de escape del núcleo de Roblox.


Se enciende cuando el usuario abre el menú de escape del núcleo de Roblox.