StarterGui

显示已弃用

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

无法创建

服务

StarterGui 是一个用于容器化 LayerCollector 对象，例如 ScreenGuis 。

StarterGui 还包括一系列允许您与 CoreGui 互动的函数。例如 StarterGui:SetCoreGuiEnabled() 可用于禁用 0> Class.CoreGui0> 的元素，而 StarterGui3> 可以执行一系

概要

属性

ProcessUserInput:bool
隐藏
未复制
插件安全性
读取并联
允许此服务处理输入，例如 PlayerGui 和 CoreGui 。
RtlTextSupport:Enum.RtlTextSupport
不可写入脚本
读取并联
ScreenOrientation:Enum.ScreenOrientation
读取并联
为用户设置移动设备的默认屏幕布局模式。
ShowDevelopmentGui:bool
读取并联
确定 Studio 中是否显示 StarterGui 的内容。
VirtualCursorMode:Enum.VirtualCursorMode
不可写入脚本
读取并联

查看继承自 Instance 的全部

查看继承自 Object 的全部

方法

GetCoreGuiEnabled(coreGuiType : Enum.CoreGuiType):bool
返回是否启用 Enum.CoreGuiType 或使用 StarterGui:SetCoreGuiEnabled() 来禁用它。
SetCore(parameterName : string,value : Variant):void
允许您执行某些与 Roblox 核心脚本的交互。
SetCoreGuiEnabled(coreGuiType : Enum.CoreGuiType,enabled : bool):void
设置是否启用或禁用指定的 CoreGui 元素与 Enum.CoreGuiType 元素之间的关联。
GetCore(parameterName : string):Variant
暂停
返回 Roblox 核心脚本指定的变量。

继承自BasePlayerGui的方法

GetGuiObjectsAtPosition(x : number,y : number):Instances
返回屏幕上显示的所有 GuiObject 实例的列表。

查看继承自 Instance 的全部

查看继承自 Object 的全部

活动

查看继承自 Instance 的全部

查看继承自 Object 的全部

属性

ProcessUserInput

bool

隐藏

未复制

插件安全性

读取并联

允许 StarterGui 处理输入，喜欢 PlayerGui 和 CoreGui 做。默认值是 1> false1> 。

RtlTextSupport

Enum.RtlTextSupport

不可写入脚本

读取并联

ScreenOrientation

Enum.ScreenOrientation

读取并联

这个属性为用户使用移动设备时设置了最佳屏幕方向模式。对于不同的模式，请参阅Enum.ScreenOrientation。

默认情况下，此属性设置为 Sensor，意味着体验会根据设备当前的方向（左/右）或面部（头部/左竖向）进行显示。

当 Player 加入体验在移动设备上时，此属性确定设备的起始方向并设置该玩家的 PlayerGui.ScreenOrientation 相应。您还可以通过 PlayerGui.CurrentScreenOrientation 获取玩家当前屏幕方向。

注意，改变此属性不会改变体验中的屏幕布局。要更改现有玩家的布局，请使用其 Class.PlayerGui.ScreenOrientation 属性。

ShowDevelopmentGui

bool

读取并联

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

VirtualCursorMode

Enum.VirtualCursorMode

不可写入脚本

读取并联

查看继承自 Instance 的全部

查看继承自 Object 的全部

方法

GetCoreGuiEnabled

bool

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

注意将 "TopbarEnabled" 设置为 false 使用 SetCore() 隐藏所有 2> Class.CoreGuiType|CoreGuiTypes2> 但不会影响此函数的结果。

参数

coreGuiType: Enum.CoreGuiType

给出 Enum.CoreGuiType 。

bool

是否启用给出的 Enum.CoreGuiType。

代码示例

Checking if a Core GUI is Enabled

local StarterGui = game:GetService("StarterGui")

print(StarterGui:GetCoreGuiEnabled("PlayerList"))

SetCore

void

此方法 (不要与 SetCoreGuiEnabled() 混淆) 暴露了 Roblox 核心脚本定义的各种功能，例如发送通知、切换通知为徽章/积分、定义回调按钮或切换顶部栏。

第一个参数是一个字符串，选择与调用交互的功能。可能需要使用 pcall() 多次，以确保核心脚本已经加载（或已禁用）。

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

聊天活跃

控制聊天是否激活。


<tbody>
  <tr>
    <td><code>有效</code></td>
    <td>boolean</td>
    <td>(需要)</td>
    <td>确定聊天是否应该启用。</td>
  </tr>
</tbody>

名称	类型	默认	描述

积分通知

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


<tbody>
  <tr>
    <td><code>有效</code></td>
    <td>boolean</td>
    <td>(需要)</td>
    <td>决定是否显示玩家积分的通知。</td>
  </tr>
</tbody>

名称	类型	默认	描述

徽章通知已激活

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


<tbody>
  <tr>
    <td><code>有效</code></td>
    <td>boolean</td>
    <td>(需要)</td>
    <td>决定是否显示赢得徽章的通知。</td>
  </tr>
</tbody>

名称	类型	默认	描述

重置按钮回调

确定按钮上的任何重置按钮给一个Boolean或一个 BindableEvent 来发射时，玩家请求时发射。


<tbody>
  <tr>
    <td><code>启用了</code></td>
    <td>boolean</td>
    <td>(需要)</td>
    <td>确定是否按下重置按钮。</td>
  </tr>

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

  <tr>
    <td><code>回调</code></td>
    <td><code>Class.BindableEvent</code></td>
    <td>(需要)</td>
    <td>一个 <code>Class.BindableEvent</code> 来在玩家确认要重置时触发。</td>
  </tr>
</tbody>

名称	类型	默认	描述

聊天系统消息

在聊天中显示格式化的消息。


<tbody>
  <tr>
    <td><code>配置表</code></td>
    <td>字典</td>
    <td>(需要)</td>
    <td>描述消息的字典信息（见下面）。</td>
  </tr>
</tbody>

名称	类型	默认	描述


<tbody>
  <tr>
    <td><code>文本</code></td>
    <td>字符串</td>
    <td>(需要)</td>
    <td>显示的消息。</td>
  </tr>

  <tr>
    <td><code>颜色</code></td>
    <td><code>Datatype.Color3</code></td>
    <td><code>Datatype.Color3.从RGB(255, 255, 243)</code></td>
    <td>消信息的文本颜色。</td>
  </tr>

  <tr>
    <td><code>字体</code></td>
    <td><code>枚数字字体</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>

名称	类型	默认	描述

发送通知

会弹出屏幕右下角的一条不会打扰的通知。通知可能有两个按钮。


<tbody>
  <tr>
    <td><code>配置表</code></td>
    <td>字典</td>
    <td>(需要)</td>
    <td>描述通知的信息的字典(请参阅下面)。</td>
  </tr>
</tbody>

名称	类型	默认	描述


<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 such as chat、inventory 和玩家列表 (例如, 设置有 SetCoreGuiEnabled 的)。

禁用时，顶部栏一次占用的区域仍然会捕获鼠标事件；但是，放置在那里的按钮不会对单击回应。屏幕顶部的 GUI 空间仍然会在 36 像素的位置上。


<tbody>
  <tr>
    <td><code>启用了</code></td>
    <td>boolean</td>
    <td>(需要)</td>
    <td>确定是否显示顶部栏。</td>
  </tr>
</tbody>

名称	类型	默认	描述

开发者控制台可见

确定是否显示开发者控制器。


<tbody>
  <tr>
    <td><code>可见度</code></td>
    <td>boolean</td>
    <td>(需要)</td>
    <td>是否显示控制器。</td>
  </tr>
</tbody>

名称	类型	默认	描述

提示发送朋友请求

提示当前玩家发送一个朋友请求给指定的 Player 。


<tbody>
  <tr>
    <td><code>玩家</code></td>
    <td><code>Class.Player</code></td>
    <td>(需要)</td>
    <td>应该向以下玩家发送好友请求。</td>
  </tr>
</tbody>

名称	类型	默认	描述

提示取消好友

提示当前玩家将其当前玩家从其朋友列表中移除给予 Player 。


<tbody>
  <tr>
    <td><code>玩家</code></td>
    <td><code>Class.Player</code></td>
    <td>(需要)</td>
    <td>该玩家应该被解除好友权限。</td>
  </tr>
</tbody>

名称	类型	默认	描述

提示方块玩家

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


<tbody>
  <tr>
    <td><code>玩家</code></td>
    <td><code>Class.Player</code></td>
    <td>(需要)</td>
    <td>应该被屏蔽的玩家。</td>
  </tr>
</tbody>

名称	类型	默认	描述

提示解锁玩家

提示当前玩家解锁指定 Player 。


<tbody>
  <tr>
    <td><code>玩家</code></td>
    <td><code>Class.Player</code></td>
    <td>(需要)</td>
    <td>应该解锁的玩家。</td>
  </tr>
</tbody>

名称	类型	默认	描述

启用虚拟形象上下文菜单

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


<tbody>
  <tr>
    <td><code>启用了</code></td>
    <td>boolean</td>
    <td>(需要)</td>
    <td>确定是否启用上下文菜单。</td>
  </tr>
</tbody>

名称	类型	默认	描述

虚拟形象上下文菜单目标

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


<tbody>
  <tr>
    <td><code>玩家</code></td>
    <td><code>Class.Player</code></td>
    <td>(需要)</td>
    <td>上下文菜单将打开的玩家。</td>
  </tr>
</tbody>

名称	类型	默认	描述

添加虚拟形象上下文菜单选项

在头像上下文菜单中添加选项。


<tbody>
  <tr>
    <td><code>选项</code></td>
    <td><code>枚数。AvatarContextMenuOption</code></td>
    <td>(需要)</td>
    <td>选项添加。</td>
  </tr>

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

  <tr>
    <td><code>选项</code></td>
    <td>表</td>
    <td>(需要)</td>
    <td>两元表，其中第一个是自定义操动作的名称，第二个是一个 <code>Class.BindableEvent</code> ，将在选项激活时发射一个玩家选中时使用。</td>
  </tr>
</tbody>

名称	类型	默认	描述

移除虚拟形象上下文菜单选项

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


<tbody>
  <tr>
    <td><code>选项</code></td>
    <td>变体</td>
    <td>(需要)</td>
    <td>同一个值提供到 <b>添加虚拟形象上下文菜单选项</b>。</td>
  </tr>
</tbody>

名称	类型	默认	描述

虚拟形象上下文菜单

配置可定制的虚拟形象上下文菜单，这是一个选择性功能，可以通过自定义操作轻松玩家之间的社交互动。例如启动交易、战斗和更多。有关自定义其主题的更多信息，请参阅虚拟形象上下文菜单文章。

核心聊天连接

设置一个可以在 CoreGui 顶部栏的聊天按钮和传统聊天系统之间的可绑定门户连接。第二个参数必须为表 BindableEvents 和 BindableFunctions 。

参数

parameterName: string

选择与调用交互的功能。

value: Variant

Class.BindableEvent|BindableEvents 和 BindableFunctions 的表。

void

代码示例

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

void

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

顶部栏不能使用此功能来禁用它。要禁用它，请将 "TopbarEnabled" 设置为 false 使用 StarterGui:SetCore() 。

参数

coreGuiType: Enum.CoreGuiType

给出 Enum.CoreGuiType 。

enabled: bool

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

void

GetCore

Variant

暂停

此方法将 Roblox 的核心脚本中返回的数据集或数据资源返回给您。第一个参数是选择要获取的信息的字符串。下面的部分描述这个方法的字符串和它所返回的数据。

调用此方法可能会生成。许多 of these 也注册一个相当的 SetCore() 函数 (这些都被标记为了一个星号).

点击通知激活*

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

徽章通知激活*

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

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

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

聊天活跃*

返回聊天是否激活。这是通过顶部栏的聊天标志的选择状态来表示的。

聊天窗口大小*

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

聊天窗口位置*

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

聊天栏已禁用*

如果聊天栏已禁用，返回 true。

获取阻止用户的 User ID

返回一个列表UserIds 与本地玩家关联的用户。

已屏蔽玩家事件

返回一个 BindableEvent ，该事件发生在玩家被本地玩家阻止时触发。

玩家已解锁事件

返回一个 BindableEvent ，该发生在玩家被本地玩家解锁时。

玩家静音事件

返回一个 BindableEvent ，该发生在玩家被本地玩家静音时。

玩家UnMutedEvent

返回一个 BindableEvent ，该发生在玩家被本地玩家解除屏蔽时。

玩家友好的事件

返回一个 BindableEvent ，该发生在玩家与本地玩家成为朋友时。

未友好的玩家

返回一个 BindableEvent ，该发生在玩家被本地玩家解除友好时。

DevConsoleVisible *

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

VRRotationIntensity

在 VR 中返回一个描述相机旋转灵敏度的字符串： Low ， High 和 Smooth 。这将不会在 VR 中可用，除非 1> Class.VRService.VREnabled1> 是 4> true4> 。

参数

parameterName: string

Variant

属性继承自BasePlayerGui

查看继承自 Instance 的全部

查看继承自 Object 的全部

活动

查看继承自 Instance 的全部

查看继承自 Object 的全部