StarterGui

显示已弃用

*此内容使用人工智能（Beta）翻译，可能包含错误。若要查看英文页面，请点按 此处。

无法创建
服务

StarterGui 是一个用于容纳 LayerCollector 对象的容器对象，如 ScreenGuis 。

当 Player.Character 生成时,其 PlayerGui (如果有) 内容将被清空。孩子们的 StarterGui 随后复制到 PlayerGui 中，与他们的后裔一起。请注意， 对象，例如 具有其 属性集置于每个玩家的 一次，将不会在重生时被删除。

StarterGui 还包括一系列功能，可让您与 CoreGui 互动。例如 StarterGui:SetCoreGuiEnabled() 可用于禁用 CoreGui 的元素，而 StarterGui:SetCore() 可以执行包括创建通知和系统消息在内的一系列功能。

概要

属性

查看继承自 Instance 的全部
查看继承自 Object 的全部

方法

继承自BasePlayerGui的方法
查看继承自 Instance 的全部
查看继承自 Object 的全部

属性

ProcessUserInput

boolean
隐藏
未复制
插件安全性
读取并联

允许 StarterGui 处理输入像 PlayerGui 和 CoreGui 那样。默认值为 false 。

RtlTextSupport

Enum.RtlTextSupport
不可写入脚本
读取并联

ScreenOrientation

Enum.ScreenOrientation
读取并联

此属性设置了使用移动设备的用户的首选屏幕 orient 模式。对于可用的不同模式，请参阅 Enum.ScreenOrientation 。

默认情况下，此属性设置为 Sensor ,意味着体验会根据设备当前方向的最佳匹配显示，即地平线（左右）或竖向像（左右）。

当 Player 在移动设备上加入体验时，此属性决定设备的初始方向，并根据该玩家的 PlayerGui.ScreenOrientation 设置相应的方向。您还可以通过 PlayerGui.CurrentScreenOrientation 获得玩家当前屏幕的方向，在使用任何“传感器”Enum.ScreenOrientation设置时都有用。

请注意，更改此属性不会更改体验中已有的屏幕 orientation Players。要更改现有玩家的方向，请使用其 PlayerGui.ScreenOrientation 属性。

ShowDevelopmentGui

boolean
读取并联

该属性决定是否在 Studio 中显示 StarterGui 的内容。

VirtualCursorMode

Enum.VirtualCursorMode
不可写入脚本
读取并联
查看继承自 Instance 的全部
查看继承自 Object 的全部

方法

GetCoreGuiEnabled

boolean

这个函数返回是否启用给定的 Enum.CoreGuiType，或使用 StarterGui:SetCoreGuiEnabled() 禁用它。此函数应在客户端上调用。

注意，将 "TopbarEnabled" 设置为 false 使用 SetCore() 隐藏所有 CoreGuiTypes 但不会影响此函数的输出结果。

参数

coreGuiType: Enum.CoreGuiType

给定的 Enum.CoreGuiType 。

默认值：""

返回

boolean

是否启用给定的 Enum.CoreGuiType。

代码示例

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

()

这个方法（不要与 SetCoreGuiEnabled() 混淆）暴露了 Roblox 核心脚本定义的各种功能，例如发送通知、切换通知以获得徽章/积分、定义重置按钮的回调或切换顶部栏等等

第一个参数是一个选择调用将与之互动的功能的字符串。如果相应的核心脚本尚未加载(或已完全禁用)，可能需要多次调用此方法，使用 pcall() 在案件中。

下表描述了可以作为第一个参数接受的字符串。应该跟随的参数取决于将被使用的功能，并且在子表中描述。

聊天活跃

控制聊天是否激活。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>激活</code></td>



    <td>boolean 类型</td>



    <td>(需要)</td>



    <td>决定聊天是否应该激活。</td>

  </tr>

</tbody>
名称
点击通知激活

控制是否显示赢得的玩家积分的通知。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>激活</code></td>



    <td>boolean 类型</td>



    <td>(需要)</td>



    <td>决定是否出现赢得的玩家积分的通知。</td>

  </tr>

</tbody>
名称
徽章通知激活

控制是否显示赢得的徽章通知。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>激活</code></td>



    <td>boolean 类型</td>



    <td>(需要)</td>



    <td>决定是否出现赢得的徽章通知。</td>

  </tr>

</tbody>
名称
重置按钮调用

决定重置按钮的行为，如果有的话，在玩家请求重置时发射一个 boolean 或 BindableEvent 。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>启用</code></td>



    <td>boolean 类型</td>



    <td>(需要)</td>



    <td>决定重置按钮是否保留默认行为。</td>

  </tr>



  <tr>

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

  </tr>



  <tr>

    <td><code>回调</code></td>



    <td><code>Class.Bindable事件</code></td>



    <td>(需要)</td>



    <td>一个 <code>Class.BindableEvent</code> 将在玩家确认要重置时发射。</td>

  </tr>

</tbody>
名称
聊天创建系统消息

在聊天中显示格式化的消息。使用此方法需要将体验的 TextChatService.ChatVersion 设置为 LegacyChatService ,尽管遗产聊天已被废弃 **** 且使用受到鼓励。对于使用当前TextChatService的体验，请参阅TextChannel:DisplaySystemMessage()。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>配置表</code></td>



    <td>词典</td>



    <td>(需要)</td>



    <td>描述消息的信息词典(见下面)。</td>

  </tr>

</tbody>
名称
<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>文本</code></td>



    <td>字符串</td>



    <td>(需要)</td>



    <td>要显示的消息。</td>

  </tr>



  <tr>

    <td><code>颜色</code></td>



    <td><code>数据类型。颜色3</code></td>



    <td><code>数据类型。颜色3.从RGB(255, 255, 243)</code></td>



    <td>消信息的文本颜色。</td>

  </tr>



  <tr>

    <td><code>字体</code></td>



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



    <td><code>源SansBold</code></td>



    <td>消信息的字体。</td>

  </tr>



  <tr>

    <td><code>文本大小</code></td>



    <td>整数</td>



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



    <td>消信息的文本大小。</td>

  </tr>

</tbody>
名称
发送通知

导致非干涉通知出现在屏幕右下角。通知可能有最多两个按钮。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>配置表</code></td>



    <td>词典</td>



    <td>(需要)</td>



    <td>描述通知的信息词典(见下面)。</td>

  </tr>

</tbody>
名称
<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>标题</code></td>



    <td>字符串</td>



    <td>(需要)</td>



    <td>通知的标题。</td>

  </tr>



  <tr>

    <td><code>文本</code></td>



    <td>字符串</td>



    <td>(需要)</td>



    <td>通知的主文本。</td>

  </tr>



  <tr>

    <td><code>图标</code></td><td>字符串</td>



    <td />



    <td>用于通知显示的图像。</td>

  </tr>



  <tr>

    <td><code>持续时间</code></td>



    <td>数字</td>



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



    <td>通知在（秒）内保持可见的时间长度。</td>

  </tr>



  <tr>

    <td><code>回调</code></td><td><code>Class.BindableFunction</code></td>



    <td />



    <td>一个 <code>Class.BindableFunction</code> ，应该用按钮玩家按下的文本启用，以便被调用。</td>

  </tr>



  <tr>

    <td><code>按钮1</code></td><td>字符串</td>



    <td />



    <td>第一个按钮上显示的文本。</td>

  </tr>



  <tr>

    <td><code>按钮2</code></td><td>字符串</td>



    <td />



    <td>第二个按钮上显示的文本。</td>

  </tr>

</tbody>
名称
顶部栏已启用

决定是否显示顶部栏。禁用顶部栏也会禁用所有 CoreGuis 例如聊天、道具和玩家列表（例如，设置为 SetCoreGuiEnabled 的）。

禁用时，顶部栏曾占用的区域仍会捕获鼠标事件；但放置在那里的按钮不会对点击反应。GUI空间的起源仍然会从屏幕顶部偏移 36 像素。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>启用</code></td>



    <td>boolean 类型</td>



    <td>(需要)</td>



    <td>决定顶部栏是否应该显示。</td>

  </tr>

</tbody>
名称
开发控制台可见

决定是否显示 开发者控制台。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>可见性</code></td>



    <td>boolean 类型</td>



    <td>(需要)</td>



    <td>决定是否显示控制台。</td>

  </tr>

</tbody>
名称
快速发送好友请求

提示当前玩家向指定的 Player 发送好友请求。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>玩家</code></td>



    <td><code>Class.Player</code></td>



    <td>(需要)</td>



    <td>好友请求应该发送到的玩家。</td>

  </tr>

</tbody>
名称
快速添加好友

提示当前玩家从他们的好友列表中删除给定的 Player 。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>玩家</code></td>



    <td><code>Class.Player</code></td>



    <td>(需要)</td>



    <td>应该被解除为朋友的玩家。</td>

  </tr>

</tbody>
名称
快速播放器块

提示当前玩家阻止指定的 Player 。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>玩家</code></td>



    <td><code>Class.Player</code></td>



    <td>(需要)</td>



    <td>应被阻止的玩家。</td>

  </tr>

</tbody>
名称
提示解锁玩家

提示当前玩家解锁给定的 Player 。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>玩家</code></td>



    <td><code>Class.Player</code></td>



    <td>(需要)</td>



    <td>应该被解锁的玩家。</td>

  </tr>

</tbody>
名称
虚拟形象上下文菜单启用

决定是否启用 虚拟形象上下文菜单。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>启用</code></td>



    <td>boolean 类型</td>



    <td>(需要)</td>



    <td>决定是否启用上下文菜单。</td>

  </tr>

</tbody>
名称
虚拟形象上下文菜单目标

强制打开 虚拟形象上下文菜单。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>玩家</code></td>



    <td><code>Class.Player</code></td>



    <td>(需要)</td>



    <td>上下文菜单将打开的玩家。</td>

  </tr>

</tbody>
名称
添加虚拟形象上下文菜单选项

添加一个选项到 虚拟形象上下文菜单。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>选项</code></td>



    <td><code>Enum.AvatarContext菜单选项</code></td>



    <td>(需要)</td>



    <td>可选添加。</td>

  </tr>



  <tr>

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

  </tr>



  <tr>

    <td><code>选项</code></td>



    <td>表</td>



    <td>(需要)</td>



    <td>两元素表，其中第一个是自定义行动作的名称，第二个是 <code>Class.BindableEvent</code>，当选项启用时将被触发与玩家一起发射。</td>

  </tr>

</tbody>
名称
移除虚拟形象上下文菜单选项

移除一个选项到 虚拟形象上下文菜单 . option 参数必须与 "AddAvatarContextMenuOption" 使用的相同(见上面)。

<th>类型</th>



    <th>默认</th>



    <th>描述</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>选项</code></td>



    <td>变体</td>



    <td>(需要)</td>



    <td>与 <b>AddAvatarContextMenuOption</b> 提供的相同值。</td>

  </tr>

</tbody>
名称
虚拟形象上下文菜单主题

配置可定制的虚拟形象上下文菜单，这是一项可选功能，可以通过自定义行动启动简单的玩家对玩家社交互动，例如启动交易、战斗等。了解有关如何自定义主题的更多信息，请参阅虚拟形象上下文菜单文章。

核心GuiChatConnections

设置从 CoreGui 顶部栏的聊天按钮到遗产聊天系统的可绑定网关连接。第二个参数必须是 BindableEvents 和 BindableFunctions 的表。

参数

parameterName: string

选择调用将与之交互的功能。

默认值：""
value: Variant

一个表的 BindableEvents 和 BindableFunctions .

默认值：""

返回

()

代码示例

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

()

这个函数设置是否启用或禁用与给定 CoreGui 元素相关的 Enum.CoreGuiType 元素。

无法使用此函数禁用顶部栏。要禁用它，请使用 "TopbarEnabled" 将 false 设置为 StarterGui:SetCore() 。

参数

coreGuiType: Enum.CoreGuiType

给定的 Enum.CoreGuiType 。

默认值：""
enabled: boolean

是否启用或禁用给定的 Enum.CoreGuiType 。

默认值：""

返回

()

GetCore

Variant
暂停

该方法返回由 Roblox 核心脚本提供或可用的数据集。第一个和唯一的参数是一个选择要获取的信息的字符串。以下部分描述了由此函数返回的字符串和数据。

调用此方法可能会产生。许多这些也注册了相等的 SetCore() 函数（这些被标记为星号）。

点击通知激活*

如果玩家点击通知已启用，返回 true 如果玩家点击通知已启用。

徽章通知激活*

返回 true 如果徽章通知已启用。

虚拟形象上下文菜单启用*

返回 true 如果 虚拟形象上下文菜单 启用。

聊天激活*

返回聊天是否激活。这是由顶部栏的聊天标志选择状态所示。

聊天窗口大小*

将聊天窗口的大小返回为 UDim2。

聊天窗口位置*

将聊天窗口的大小返回为 UDim2。

聊天栏禁用*

返回 true 如果聊天栏被禁用。

获取阻止用户ID

返回与本地玩家阻止相关的用户的列表 UserIds

玩家阻止事件

返回一个 BindableEvent ，该返回每当玩家被本地玩家阻止时触发。

玩家解锁事件

返回一个 BindableEvent ，该返回每当玩家被本地玩家解锁时触发。

玩家静音事件

返回一个 BindableEvent ，该返回每当玩家被本地玩家静音时触发。

玩家取消静音事件

返回一个 BindableEvent ，该返回每当玩家被本地玩家静音时触发。

玩家友好事件

返回一个 BindableEvent ，该返回每当玩家被本地玩家友好时触发。

玩家解除朋友事件

返回一个 BindableEvent ，该返回每当玩家被本地玩家解除朋友时触发。

开发控制台可见*

返回 true 如果 开发者控制台 可见。

VRRotationIntensity旋转强度

返回描述虚拟现实中相机旋转灵敏度的字符串：Low、High和Smooth。这将不可用，除非 VRService.VREnabled 是 true 。

参数

parameterName: string
默认值：""

返回

Variant
查看继承自 Instance 的全部
查看继承自 Object 的全部

活动

查看继承自 Instance 的全部
查看继承自 Object 的全部