StarterGui

Permite que StarterGui processe a entrada como PlayerGui e CoreGui faça. O valor padrão é false .

Essa propriedade define o modo de orientação de tela preferido para usuários com dispositivos móveis. Para os diferentes modos disponíveis, veja Enum.ScreenOrientation .

Por padrão, esta propriedade é definida como Sensor, o que significa que a experiência é exibida dependendo da melhor correspondência à orientação atual do dispositivo, seja paisagem (esquerda/direita) ou retrato.

Quando um Player entra na experiência em um dispositivo móvel, esta propriedade determina a orientação inicial do dispositivo e define a orientação do jogador PlayerGui.ScreenOrientation de acordo.Você também pode obter a orientação de tela atual do jogador através de PlayerGui.CurrentScreenOrientation, útil ao usar uma das configurações de "Sensor" Enum.ScreenOrientation.

Observe que alterar esta propriedade não mudará a orientação da tela para Players já na experiênciaPara alterar a orientação para um jogador existente, use sua propriedade PlayerGui.ScreenOrientation .

Essa propriedade determina se o conteúdo de StarterGui é visível no Studio.

Essa função retorna se o dado Enum.CoreGuiType for habilitado ou se foi desativado usando StarterGui:SetCoreGuiEnabled().Essa função deve ser chamada no cliente.

Observe que definir "TopbarEnabled" para false usando SetCore() esconde todo o CoreGuiTypes mas não afeta o resultado dessa função.

Parâmetros

Devolução

local StarterGui = game:GetService("StarterGui")

print(StarterGui:GetCoreGuiEnabled("PlayerList"))

Este método (não confundir com SetCoreGuiEnabled() ) expõe uma variedade de funcionalidades definidas pelos scripts principais do Roblox, como enviar notificações, alternar notificações por insígnias/pontos, definir um retorno de chamada para o botão de redefinição ou alternar a barra superior.

O primeiro parâmetro é uma string que seleciona a funcionalidade com a qual a chamada interagirá.Pode ser necessário chamar esse método várias vezes usando pcall() em caso de o respectivo script de núcleo ainda não ter sido carregado (ou se tiver sido desativado completamente).

A tabela a seguir descreve as strings que podem ser aceitas como o primeiro parâmetro.Os parâmetros que devem seguir dependem da funcionalidade que será usada e são descritos em sub-tabelas.

ChatAtivo

Controla se o chat está ativo.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>ativo</code></td>

    <td>booleano</td>

    <td>(obrigatório)</td>

    <td>Determina se o chat deve ser ativado.</td>
  </tr>
</tbody>

Notificações de PontosAtivas

Controla se as notificações para pontos de jogador ganhos aparecerão.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>ativo</code></td>

    <td>booleano</td>

    <td>(obrigatório)</td>

    <td>Determina se as notificações para pontos de jogador ganhos aparecerão.</td>
  </tr>
</tbody>

Notificações de InsígniasAtivas

Controla se as notificações para os emblemas ganhos aparecerão ou não.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>ativo</code></td>

    <td>booleano</td>

    <td>(obrigatório)</td>

    <td>Determina se as notificações para insígnias ganhas aparecerão.</td>
  </tr>
</tbody>

Botão de redefinição de chamada de volta

Determina o comportamento, se algum, do botão de redefinição dado um booleano ou um BindableEvent para ser disparado quando um jogador solicita a redefinir.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>ativado</code></td>

    <td>booleano</td>

    <td>(obrigatório)</td>

    <td>Determina se o botão de redefinição mantém seu comportamento padrão.</td>
  </tr>

  <tr>
    <td colspan="4"><b>OR</b></td>
  </tr>

  <tr>
    <td><code>retorno de chamada</code></td>

    <td><code>Class.BindableEvent</code></td>

    <td>(obrigatório)</td>

    <td>Um <code>Class.BindableEvent</code> a ser disparado quando o jogador confirmar que deseja redefinir.</td>
  </tr>
</tbody>

Mensagem de Criação de Chat

Exibir uma mensagem formatada no chat.Usar esse método requer que a experiência de TextChatService.ChatVersion seja definida como LegacyChatService, embora o chat legado esteja obsoleto e o uso seja desanimador.Para experiências usando o atual TextChatService, consulte TextChannel:DisplaySystemMessage() .

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>configTable</code></td>

    <td>dicionário</td>

    <td>(obrigatório)</td>

    <td>Um dicionário de informações que descreve a mensagem (veja abaixo).</td>
  </tr>
</tbody>

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Texto</code></td>

    <td>string / cadeia / texto</td>

    <td>(obrigatório)</td>

    <td>A mensagem a ser exibida.</td>
  </tr>

  <tr>
    <td><code>Cor</code></td>

    <td><code>Tipo de dado.Cor3</code></td>

    <td><code>Tipo de dado.Cor3.fromRGB(255, 255, 243)</code></td>

    <td>Cor do texto da mensagem.</td>
  </tr>

  <tr>
    <td><code>Fonte</code></td>

    <td><code>Enum.Font</code></td>

    <td><code>FontSansBold da Fonte</code></td>

    <td>Fonte da mensagem.</td>
  </tr>

  <tr>
    <td><code>Tamanho do Texto</code></td>

    <td>integral</td>

    <td><code>18</code></td>

    <td>Tamanho do texto da mensagem.</td>
  </tr>
</tbody>

Enviar Notificação

Causa uma notificação não invasiva para aparecer no canto inferior direito da tela. A notificação pode ter até dois botões.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>configTable</code></td>

    <td>dicionário</td>

    <td>(obrigatório)</td>

    <td>Um dicionário de informações que descreve a notificação (veja abaixo).</td>
  </tr>
</tbody>

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Título</code></td>

    <td>string / cadeia / texto</td>

    <td>(obrigatório)</td>

    <td>O título da notificações.</td>
  </tr>

  <tr>
    <td><code>Texto</code></td>

    <td>string / cadeia / texto</td>

    <td>(obrigatório)</td>

    <td>O texto principal da notificações.</td>
  </tr>

  <tr>
    <td><code>Ícone</code></td><td>string</td>

    <td />

    <td>A imagem para exibir com a notificações.</td>
  </tr>

  <tr>
    <td><code>Duração</code></td>

    <td>número</td>

    <td><code>5</code></td>

    <td>Duração (em segundos) a notificação deve permanecer visível.</td>
  </tr>

  <tr>
    <td><code>Chamada de volta</code></td><td><code>Class.BindableFunction</code></td>

    <td />

    <td>Uma classe <code>Class.BindableFunction</code> que deve ser invocada com o texto do botão pressionado pelo jogador.</td>
  </tr>

  <tr>
    <td><code>Botão1</code></td><td>string</td>

    <td />

    <td>O texto a ser exibido no primeiro botão.</td>
  </tr>

  <tr>
    <td><code>Botão2</code></td><td>string</td>

    <td />

    <td>O texto a ser exibido no segundo botão.</td>
  </tr>
</tbody>

Barra superior ativada

Determina se a barra superior é exibida.Desabilitar a barra superior também desabilitará todos os CoreGuis como o chat, inventário e lista de jogadores (por exemplo, aqueles definidos com SetCoreGuiEnabled).

Quando desativado, a região que a barra superior ocupava uma vez ainda capturará eventos de mouse; no entanto, os botões colocados lá não responderão a cliques.A origem do espaço GUI ainda será deslocada 36 pixels da parte superior da tela.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>ativado</code></td>

    <td>booleano</td>

    <td>(obrigatório)</td>

    <td>Determina se a barra superior deve ser visível.</td>
  </tr>
</tbody>

DevConsoleVisível

Determina se o Console de Desenvolvedor é visível.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>visibilidade</code></td>

    <td>booleano</td>

    <td>(obrigatório)</td>

    <td>Determina se o console está visível.</td>
  </tr>
</tbody>

Solicitação de envio de amigo

Solicita ao jogador atual que envie um pedido de amizade para o dado Player.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>jogador</code></td>

    <td><code>Classe.Player</code></td>

    <td>(obrigatório)</td>

    <td>O jogador para o qual a solicitação de amigo deve ser sentença / frase</td>
  </tr>
</tbody>

Desfazer Amigo Rápido

Solicita ao jogador atual para remover um determinado Player da lista de amigos.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>jogador</code></td>

    <td><code>Classe.Player</code></td>

    <td>(obrigatório)</td>

    <td>O jogador que deve ser desfeito de amigo.</td>
  </tr>
</tbody>

Jogador de Bloco de Ação Rápida

Solicita ao jogador atual que bloqueie o dado Player .

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>jogador</code></td>

    <td><code>Classe.Player</code></td>

    <td>(obrigatório)</td>

    <td>O jogador que deve ser bloqueado.</td>
  </tr>
</tbody>

Desbloquear Jogador Rápido

Solicita ao jogador atual para desbloquear o dado Player.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>jogador</code></td>

    <td><code>Classe.Player</code></td>

    <td>(obrigatório)</td>

    <td>O jogador que deve ser desbloqueado.</td>
  </tr>
</tbody>

Menu de contexto de avatar ativado

Determina se o Menu de contexto do Avatar está habilitado.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>ativado</code></td>

    <td>booleano</td>

    <td>(obrigatório)</td>

    <td>Determina se o menu de contexto está habilitado.</td>
  </tr>
</tbody>

Menu de contexto de avatar alvo

Abre forçadamente o Menu de contexto de avatar.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>jogador</code></td>

    <td><code>Classe.Player</code></td>

    <td>(obrigatório)</td>

    <td>O jogador em que o menu de contexto será aberto.</td>
  </tr>
</tbody>

AdicionarOpção de Menu de Contexto de Avatar

Adiciona uma opção ao Menu de contexto do avatar.

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>opção</code></td>

    <td><code>Opção de Menu de Contexto de Avatar Enum</code></td>

    <td>(obrigatório)</td>

    <td>Opção para adicionar.</td>
  </tr>

  <tr>
    <td colspan="4"><b>OR</b></td>
  </tr>

  <tr>
    <td><code>opção</code></td>

    <td>tabela</td>

    <td>(obrigatório)</td>

    <td>Uma tabela de dois elementos, onde o primeiro é o nome da ação personalizada e o segundo é um <code>Class.BindableEvent</code> que será disparado com um jogador foi selecionado quando a opção foi ativada.</td>
  </tr>
</tbody>

RemoverOpção de Menu de Contexto de Avatar

Remove uma opção para o Menu de contexto do Avatar. O argumento option deve ser o mesmo usado com "AddAvatarContextMenuOption" (veja acima).

<th>Tipo</th>

    <th>Padrão</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>opção</code></td>

    <td>Váriação</td>

    <td>(obrigatório)</td>

    <td>O mesmo valor fornecido para <b>AdicionarOpção de Menu de Contexto de Avatar</b>.</td>
  </tr>
</tbody>

Tema do Menu de Contexto de Avatar

Configura o menu contextual personalizável Avatar, que é um recurso opcional que permite uma interação social fácil entre jogadores através de ações personalizadas, como iniciar trocas, batalhas e muito mais.Para mais informações sobre como personalizar seu tema, veja o artigo Menu de contexto do Avatar.

Conexões de Chat do Núcleo

Configura uma conexão de gateway vinculável entre o botão de chat da barra superior CoreGui e o sistema de chat legado.O segundo parâmetro deve ser uma tabela de BindableEvents e BindableFunctions.

Parâmetros

Devolução

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,
})

Essa função define se o elemento CoreGui associado ao dado Enum.CoreGuiType está ativado ou desativado.

A barra superior não pode ser desativada usando essa função. Para desativá-la, defina "TopbarEnabled" para false usando StarterGui:SetCore() .

Parâmetros

Devolução

Este método retorna conjunto de dados ou tornado disponível pelos scripts principais do Roblox.O primeiro e único parâmetro é uma string que seleciona a informação a ser recuperada.As seções a seguir descrevem as strings e os dados que elas retornam por esta função.

Chamar este método pode renderizar. Muitos deles também registram uma função equivalente SetCore() (estes são marcados com um asterisco).

Notificações de PontosAtivas *

Retorna true se as notificações de pontos do jogador estiverem habilitadas.

Notificações de insígniasAtivas *

Retorna true se as notificações de insígnia forem ativadas.

Menu de contexto de avatar ativado*

Retorna true se o Menu de contexto do Avatar estiver habilitado.

ChatAtivo *

Retorna se o chat está ativo ou não. Isso é indicado pelo estado de seleção do ícone de bate-papo da barra superior.

Tamanho da janela de chat *

Retorna o tamanho da janela de bate-papo como um UDim2.

Posição da janela de bate-papo *

Retorna o tamanho da janela de bate-papo como um UDim2.

Barra de Chat Desativada *

Retorna true se a barra de chat estiver desativada.

Obter IDs de Usuário Bloqueados

Retorna uma lista de UserIds associada a usuários que foram bloqueados pelo jogador local.

JogadorBloqueadoEvento

Retorna um BindableEvent que é disparado sempre que um jogador é bloqueado pelo jogador local.

Evento Desbloqueado do Jogador

Retorna um BindableEvent que é disparado sempre que um jogador for desbloqueado pelo jogador local.

Evento de Silenciamento de Jogador

Retorna um BindableEvent que é disparado sempre que um jogador for silenciado pelo jogador local.

Evento Desativado de Jogador

Retorna um BindableEvent que é disparado sempre que um jogador é desativado pelo jogador local.

Evento Amigo de Jogador

Retorna um BindableEvent que é disparado sempre que um jogador é amigo do jogador local.

Evento de Desamigo de Jogador

Retorna um BindableEvent que é disparado sempre que um jogador é desfeito por um jogador local.

DevConsoleVisível *

Retorna true se o Console do Desenvolvedor for visível.

VRRotaçãoIntensidade

Retorna uma string que descreve a sensibilidade de rotação da câmera na VR: Low , High e Smooth .Isso não estará disponível a menos que VRService.VREnabled seja true .

Parâmetros

Devolução