StarterGui

顯示已棄用項目

*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。

無法建立

服務

StarterGui 是一個用於裝載 LayerCollector 物件的容器對象，例如 ScreenGuis 。

當 Player.Character 生成時,其中的 PlayerGui (如果有) 內容將被清空。子女的 StarterGui 子孫將與他們一起複製到 PlayerGui 中。請注意，物件，例如具有其屬性設置為的對象，只會放置在每個玩家的一次，並不會在重生時被刪除。

StarterGui 也包括一系列功能，可讓您與 CoreGui 互動。例如 StarterGui:SetCoreGuiEnabled() 可用於禁用 CoreGui 的元素，而 StarterGui:SetCore() 可執行各種功能，包括創建通知和系統訊息。

概要

屬性

ProcessUserInput:boolean
隱藏
未複製
外掛程式安全性
平行讀取
允許此服務處理輸入，例如 PlayerGui 和 CoreGui 。
RtlTextSupport:Enum.RtlTextSupport
無法建立指令碼
平行讀取
ScreenOrientation:Enum.ScreenOrientation
平行讀取
為擁有移動裝置的使用者設定預設畫面方向模式。
ShowDevelopmentGui:boolean
平行讀取
決定是否在 Studio 中顯示 StarterGui 的內容。
VirtualCursorMode:Enum.VirtualCursorMode
無法建立指令碼
平行讀取

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

方法

GetCoreGuiEnabled(coreGuiType : Enum.CoreGuiType):boolean
返回指定的 Enum.CoreGuiType 是否啟用，或使用 StarterGui:SetCoreGuiEnabled() 已停用。
SetCore(parameterName : string,value : Variant):()
讓你能夠與 Roblox 的核心腳本進行某些互動。
SetCoreGuiEnabled(coreGuiType : Enum.CoreGuiType,enabled : boolean):()
設置是否啟用或禁用與給定 CoreGui 元素相關的 Enum.CoreGuiType 元素。
GetCore(parameterName : string):Variant
暫停
返回指定由 Roblox 核心腳指令碼的變量。

方法繼承自 BasePlayerGui

GetGuiObjectsAtPosition(x : number,y : number):Instances
返回所有 GuiObject 占用給定點的屏幕上的實例清單。

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

活動

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

屬性

ProcessUserInput

boolean

隱藏

未複製

外掛程式安全性

平行讀取

允許 StarterGui 處理輸入像 PlayerGui 和 CoreGui 那樣。默认值是 false 。

RtlTextSupport

Enum.RtlTextSupport

無法建立指令碼

平行讀取

ScreenOrientation

Enum.ScreenOrientation

平行讀取

此屬性設置了使用移動裝置的用戶的首選畫面傾斜模式。對於可用的不同模式，請參閱 Enum.ScreenOrientation 。

預設狀態下，此屬性設為 Sensor ，意味著體驗會依據裝置當前的傾向顯示，例如景觀（左右）或直放（左右）。

當 Player 在移動設裝置上加入體驗時，此屬性會決定設裝置的起始方向，並依此設置該玩家的 PlayerGui.ScreenOrientation 。您也可以通過 PlayerGui.CurrentScreenOrientation 獲得玩家當前屏幕方向，在使用任何一個"感應器"Enum.ScreenOrientation設置時都有用。

請注意，變更此屬性不會更改經體驗中已有的屏幕傾斜。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>來源桑思Bold</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>

名稱

新增AvatarContext菜單選項

新增一個選項到虛擬人偶上下文選單。


<th>類型</th>

    <th>預設</th>

    <th>說明</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>選項</code></td>

    <td><code>Enum.AvatarContextMenu選項</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>

名稱

化身上下文主題

設定可自訂的虛擬人偶上下文選單，這是一個可選擇的功能，可以透過自訂行動啟動玩家對玩家的簡單社交互動，例如啟動交易、戰鬥和更多。要了解有關如何自訂主題的更多信息，請參閱虛擬人偶上下文選單文章。

核心GUI聊天連線

設置從 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

屬性繼承自 BasePlayerGui

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

活動

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目