StarterGui

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

StarterGui es un objeto contenedor diseñado para contener objetos LayerCollector como ScreenGuis.

Cuando se genera un Player.Character , el contenido de su PlayerGui (si es que hay alguno) se vacía.Los hijos del StarterGui se copian luego con sus descendientes en el PlayerGui .Tenga en cuenta, sin embargo, que los objetos LayerCollector como ScreenGuis con su propiedad ResetOnSpawn configurada a false solo se colocarán en el jugador PlayerGui una vez y no se eliminarán cuando los Player reaparezcan.

StarterGui también incluye una serie de funciones que te permiten interactuar con el CoreGui.Por ejemplo, StarterGui:SetCoreGuiEnabled() se puede utilizar para deshabilitar elementos del CoreGui , y StarterGui:SetCore() puede realizar una serie de funciones, incluida la creación de notificaciones y mensajes del sistema.

Resumen

Propiedades

Métodos

Métodos heredados de BasePlayerGui

Propiedades

ProcessUserInput

Oculto
No replicado
Seguridad del plugin
Leer paralelo

Permite que StarterGui procese la entrada como PlayerGui y CoreGui haga. El valor predeterminado es false .

RtlTextSupport

No programable
Leer paralelo

ScreenOrientation

Leer paralelo

Esta propiedad establece el modo de orientación de pantalla preferido para los usuarios con dispositivos móviles. Para los diferentes modos disponibles, consulte Enum.ScreenOrientation .

Por defecto, esta propiedad se establece en Sensor , lo que significa que la experiencia se muestra dependiendo de la mejor coincidencia con la orientación actual del dispositivo, ya sea paisaje (izquierda/derecha) o retrato.

Cuando un Player se une a la experiencia en un dispositivo móvil, esta propiedad determina la orientación inicial del dispositivo y establece la orientación del jugador PlayerGui.ScreenOrientation en consecuencia.También puedes obtener la orientación actual de la pantalla del jugador a través de PlayerGui.CurrentScreenOrientation, útil al usar una de las configuraciones de "Sensor" Enum.ScreenOrientation.

Tenga en cuenta que cambiar esta propiedad no cambiará la orientación de la pantalla para Players ya en la experiencia.Para cambiar la orientación para un jugador existente, use su propiedad PlayerGui.ScreenOrientation .

ShowDevelopmentGui

Leer paralelo

Esta propiedad determina si el contenido de StarterGui es visible en Studio.

VirtualCursorMode

No programable
Leer paralelo

Métodos

GetCoreGuiEnabled

Esta función devuelve si el dado Enum.CoreGuiType está habilitado o si se ha deshabilitado usando StarterGui:SetCoreGuiEnabled().Esta función debe llamarse en el cliente.

Tenga en cuenta que establecer "TopbarEnabled" a false usando SetCore() oculta todo CoreGuiTypes pero no afecta el resultado de esta función.

Parámetros

coreGuiType: Enum.CoreGuiType
Valor predeterminado: ""

Devuelve

Si el dado Enum.CoreGuiType está habilitado.

Muestras de código

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

()

Este método (que no debe confundirse con SetCoreGuiEnabled() ) expone una variedad de funcionalidades definidas por los scripts principales de Roblox, como enviar notificaciones, alternar notificaciones para insignias/puntos, definir un llamado de devolución para el botón de reinicio o alternar la barra superior.

El primer parámetro es una cadena que selecciona la funcionalidad con la que interactuará la llamada.Puede ser necesario llamar a este método varias veces usando pcall() en caso de que el respectivo script del núcleo aún no se haya cargado (o si se ha desactivado por completo).

La siguiente tabla describe las cadenas que pueden aceptarse como primer parámetro.Los parámetros que deben seguir dependen de la funcionalidad que se utilizará y se describen en tablas secundarias.

ChatActivo

Controla si el chat está activo.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>activo</code></td>
<td>booleno</td>
<td>(requerido)</td>
<td>Determina si el chat debe hacerse activo.</td>
</tr>
</tbody>
Nombre
Notificaciones de puntos activas

Controla si aparecerán notificaciones por los puntos de jugador ganados.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>activo</code></td>
<td>booleno</td>
<td>(requerido)</td>
<td>Determina si aparecerán notificaciones para los puntos de jugador ganados.</td>
</tr>
</tbody>
Nombre
Notificaciones de insignias activas

Controla si aparecerán notificaciones para insignias ganadas.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>activo</code></td>
<td>booleno</td>
<td>(requerido)</td>
<td>Determina si aparecerán notificaciones para insignias ganadas.</td>
</tr>
</tbody>
Nombre
Reiniciar llamada de botón de respuesta

Determina el comportamiento, si lo hay, del botón de reinicio dado un booleano o un BindableEvent para ser disparado cuando un jugador solicite restablecer.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>habilitado</code></td>
<td>booleno</td>
<td>(requerido)</td>
<td>Determina si el botón de reinicio mantiene su comportamiento predeterminado.</td>
</tr>
<tr>
<td colspan="4"><b>OR</b></td>
</tr>
<tr>
<td><code>devolución de llamada</code></td>
<td><code>Clase.BindableEvento</code></td>
<td>(requerido)</td>
<td>Un <code>Class.BindableEvent</code> para disparar cuando el jugador confirme que quiere restablecer.</td>
</tr>
</tbody>
Nombre
Mensaje de chatMakeSystem

Muestra un mensaje formatado en el chat.El uso de este método requiere que la experiencia se establezca en , aunque el chat legado esté obsoleto y se desanime su uso.Para experiencias que usan la actual TextChatService , consulte TextChannel:DisplaySystemMessage() .


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>tabla de configuración</code></td>
<td>diccionario</td>
<td>(requerido)</td>
<td>Un diccionario de información que describe el mensaje (ver a continuación).</td>
</tr>
</tbody>
Nombre

<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Texto</code></td>
<td>cadena</td>
<td>(requerido)</td>
<td>El mensaje para mostrar.</td>
</tr>
<tr>
<td><code>Colores</code></td>
<td><code>Tipo de datos.Color3</code></td>
<td><code>Tipo de datos.Color3.fromRGB(255, 255, 243)</code></td>
<td>Color de texto del mensaje.</td>
</tr>
<tr>
<td><code>Fuente</code></td>
<td><code>Enumeración.Font</code></td>
<td><code>SourceSansBold</code></td>
<td>Fuente del mensaje.</td>
</tr>
<tr>
<td><code>Tamaño del texto</code></td>
<td>entero</td>
<td><code>18</code></td>
<td>Tamaño del texto del mensaje.</td>
</tr>
</tbody>
Nombre
Enviar notificación

Causa una notificación no intrusiva para aparecer en la parte inferior derecha de la pantalla. La notificación puede tener hasta dos botones.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>tabla de configuración</code></td>
<td>diccionario</td>
<td>(requerido)</td>
<td>Un diccionario de información que describe la notificación (ver a continuación).</td>
</tr>
</tbody>
Nombre

<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Título</code></td>
<td>cadena</td>
<td>(requerido)</td>
<td>El título de la notificaciones.</td>
</tr>
<tr>
<td><code>Texto</code></td>
<td>cadena</td>
<td>(requerido)</td>
<td>El texto principal de la notificaciones.</td>
</tr>
<tr>
<td><code>Icono</code></td><td>cadena</td>
<td />
<td>La imagen para mostrar con la notificaciones.</td>
</tr>
<tr>
<td><code>Duración</code></td>
<td>número</td>
<td><code>5</code></td>
<td>Duración (en segundos) la notificación debe permanecer visible.</td>
</tr>
<tr>
<td><code>Devolución de llamada</code></td><td><code>Clase.BindableFunction</code></td>
<td />
<td>Una función <code>Class.BindableFunction</code> que debe invocarse con el texto del botón presionado por el jugador.</td>
</tr>
<tr>
<td><code>Botón1</code></td><td>texto</td>
<td />
<td>El texto para mostrar en el primer botón.</td>
</tr>
<tr>
<td><code>Botón2</code></td><td>texto</td>
<td />
<td>El texto para mostrar en el segundo botón.</td>
</tr>
</tbody>
Nombre
Barra superior activada

Determina si se muestra la barra superior.Desactivar la barra superior también desactivará todas las CoreGuis como el chat, el inventario y la lista de jugadores (por ejemplo, aquellas establecidas con SetCoreGuiEnabled).

Cuando está desactivado, la región que la barra superior ocupó una vez aún capturará eventos de ratón; sin embargo, los botones colocados allí no responderán a los clics.El origen del espacio GUI aún se desplazará 36 píxeles desde la parte superior de la pantalla.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>habilitado</code></td>
<td>booleno</td>
<td>(requerido)</td>
<td>Determina si la barra superior debe ser visible.</td>
</tr>
</tbody>
Nombre
Consola visible de desarrollador

Determina si la Consola del desarrollador es visible.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>visibilidad</code></td>
<td>booleno</td>
<td>(requerido)</td>
<td>Determina si la consola es visible.</td>
</tr>
</tbody>
Nombre
Solicitud de envío de amigo rápida

Solicita al jugador actual que envíe una solicitud de amistad al dado Player.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>jugador</code></td>
<td><code>Clase .Player</code></td>
<td>(requerido)</td>
<td>El jugador al que se debe enviar la solicitud de amistad.</td>
</tr>
</tbody>
Nombre
Amigo de inmediato

Solicita al jugador actual que elimine un dado Player de su lista de amigos.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>jugador</code></td>
<td><code>Clase .Player</code></td>
<td>(requerido)</td>
<td>El jugador que debería ser desamigo.</td>
</tr>
</tbody>
Nombre
Reproductor de bloques de promoción

Solicita al jugador actual que bloquee el dado Player .


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>jugador</code></td>
<td><code>Clase .Player</code></td>
<td>(requerido)</td>
<td>El jugador que debe ser bloqueado.</td>
</tr>
</tbody>
Nombre
Desbloquear jugador rápido

Solicita al jugador actual que desbloquee el dado Player .


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>jugador</code></td>
<td><code>Clase .Player</code></td>
<td>(requerido)</td>
<td>El jugador que debería desbloquearse.</td>
</tr>
</tbody>
Nombre
Menú contextual de avatar habilitado

Determina si el Menú contextual de avatar está habilitado.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>habilitado</code></td>
<td>booleno</td>
<td>(requerido)</td>
<td>Determina si el menú contextual está habilitado.</td>
</tr>
</tbody>
Nombre
Menú contextual de avatarTarget

Abre forzadamente el Menú contextual de avatar.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>jugador</code></td>
<td><code>Clase .Player</code></td>
<td>(requerido)</td>
<td>El jugador en el que se abrirá el menú contextual.</td>
</tr>
</tbody>
Nombre
Añadir opción de menú contextual de avatar

Añade una opción al Menú contextual de avatar.


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>opción</code></td>
<td><code>Opción de menú contextual de avatar Enum</code></td>
<td>(requerido)</td>
<td>Opción para añadir.</td>
</tr>
<tr>
<td colspan="4"><b>OR</b></td>
</tr>
<tr>
<td><code>opción</code></td>
<td>tabla</td>
<td>(requerido)</td>
<td>Una tabla de dos elementos, donde el primero es el nombre de la acción personalizada, y el segundo es un <code>Class.BindableEvent</code> que se disparará con un jugador cuando se activó la opción.</td>
</tr>
</tbody>
Nombre
Eliminar opción de menú contextual de avatar

Elimina una opción para el contexto de menú de avatar. El argumento option debe ser el mismo que el utilizado con "AddAvatarContextMenuOption" (ver arriba).


<th>Tipo</th>
<th>Por defecto</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>opción</code></td>
<td>Variante</td>
<td>(requerido)</td>
<td>El mismo valor proporcionado a <b>AddAvatarContextMenuOption</b>.</td>
</tr>
</tbody>
Nombre
Tema del menú contextual de avatar

Configura el menú contextual personalizable Avatar que es una característica opcional que permite una fácil interacción social entre jugadores a través de acciones personalizadas, como iniciar intercambios, batallas y más.Para obtener más información sobre cómo personalizar su tema, consulte el artículo Menú contextual de avatar.

CoreGuiChatConnections

Configura una conexión de puerto vinculable entre el botón de chat de la barra superior CoreGui y el sistema de chat legado.El segundo parámetro debe ser una tabla de BindableEvents y BindableFunctions.

Parámetros

parameterName: string

Selecciona la funcionalidad con la que la llamada interactuará.

Valor predeterminado: ""
value: Variant
Valor predeterminado: ""

Devuelve

()

Muestras de código

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

()

Esta función establece si el elemento CoreGui asociado con el dado Enum.CoreGuiType está habilitado o deshabilitado.

La barra superior no se puede desactivar usando esta función. Para desactivarla, establece "TopbarEnabled" a false usando StarterGui:SetCore() .

Parámetros

coreGuiType: Enum.CoreGuiType
Valor predeterminado: ""
enabled: boolean

Si habilitar o deshabilitar el dado Enum.CoreGuiType .

Valor predeterminado: ""

Devuelve

()

GetCore

Variant
Proporciona

Este método devuelve un conjunto de datos o lo pone a disposición de los scripts principales de Roblox.El primer y único parámetro es una cadena que selecciona la información para recuperar.Las siguientes secciones describen las cadenas y los datos que devuelven por esta función.

Llamar a este método puede producir. Muchos de estos también registran una función equivalente SetCore() (estos se marcan con un asterisco).

Notificaciones de puntos activas *

Devuelve true si las notificaciones de puntos del jugador están habilitadas.

Notificaciones de insignias activas *

Devuelve true si las notificaciones de insignia están habilitadas.

Menú contextual de avatar habilitado *

Devuelve true si el menú contextual de avatar está habilitado.

ChatActivo*

Devuelve si el chat está activo o no. Esto se indica por el estado de selección del íconode chat de la barra superior.

Tamaño de la ventana de chat *

Devuelve el tamaño de la ventana de chat como un UDim2 .

Posición de la ventana de chat *

Devuelve el tamaño de la ventana de chat como un UDim2 .

Barra de chat deshabilitada *

Devuelve true si la barra de chat está deshabilitada.

Obtener ID de usuario bloqueado

Devuelve una lista de UserIds asociada con usuarios que han sido bloqueados por el jugador local.

Evento bloqueado por el jugador

Devuelve un BindableEvent que se dispara cada vez que un jugador es bloqueado por el jugador local.

Evento desbloqueado del jugador

Devuelve un BindableEvent que se dispara cada vez que un jugador es desbloqueado por el jugador local.

Evento de jugador silenciado

Devuelve un BindableEvent que se dispara cada vez que un jugador es silenciado por el jugador local.

Evento desilenciado del jugador

Devuelve un BindableEvent que se dispara cada vez que un jugador es desactivado por el jugador local.

Evento amigado con el jugador

Devuelve un BindableEvent que se dispara cada vez que un jugador es amigo del jugador local.

Evento de desamigo del jugador

Devuelve un BindableEvent que se dispara cada vez que un jugador es desamigo por el jugador local.

DevConsoleVisible *

Devuelve true si la consola del desarrollador es visible.

VRRotaciónIntensidad

Devuelve una cadena que describe la sensibilidad de rotación de la cámara en VR: Low , High y Smooth .Esto no estará disponible a menos que VRService.VREnabled sea true .

Parámetros

parameterName: string
Valor predeterminado: ""

Devuelve

Variant

Eventos