StarterGui

顯示已棄用項目

*此內容是使用 AI（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元素屬性的Class.CoreGui。
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

平行讀取

此屬性決定 StarterGui 內容是否在 Studio 可視。

VirtualCursorMode

Enum.VirtualCursorMode

無法建立指令碼

平行讀取

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

方法

GetCoreGuiEnabled

bool

此功能返回是否啟用 Enum.CoreGuiType ，或使用 StarterGui:SetCoreGuiEnabled() 來禁用它。此功能應該在客戶端上呼叫。

注意設定 "TopbarEnabled" 為 false 使用 SetCore() 隱藏所有 1> ень核GuiType|核GuiTypes1> ，但不會影響此功能的結果。

參數

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 核心指令所定義的各種功能，例如發送通知、切換通知為徽章/點數、定義回歸按鈕、或切換檯面。

第一個參數是一個 string ，它選擇與呼叫交互的功能。可能需要使用 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>

名稱	類型	預設	說明

重設按鈕回來

決定重設按鈕所提供的任何行為或 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>Class.BindableEvent 可以在玩家確認要重置時發射。</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>SourceSansBold</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 ，例如聊天、資源和玩家列表 (例如具有 Class.StarterGui:SetCoreGuiEnabled()|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>枚號 Avatar 上下文菜單選項</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> ，它會在選項啟用時發射，與玩家選擇了一個選項時選擇的 Class.BindableEvent 。</td>
  </tr>
</tbody>

名稱	類型	預設	說明

移除虛擬人偶上下文菜單選項

移除虛擬人偶上下文選單的選項。 option 參數必須與使用 "AddAvatarContextMenuOption" 的參數相同 (請參閱上方)。


<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

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

此功能設定是否啟用或啟用CoreGui與指定的Enum.CoreGuiType元素關聯的Class.CoreGui元素是否啟用或關閉。

上方欄表無法使用此功能來禁用。若要禁用，請將 "TopbarEnabled" 設定為 false 使用。

參數

coreGuiType: Enum.CoreGuiType

提供的 Enum.CoreGuiType 。

enabled: bool

是否啟用或啟用提供的 Enum.CoreGuiType 。

void

GetCore

Variant

暫停

此方法將 Roblox 核心指令碼中的資料集合或資料資源提供給您。第一個參數是您選擇要擷取的資訊的字串。下列部分將描述這個方法的字串和它所提供的資料。

呼叫此方法可能會產生。許多 of these 也會注冊相當的 SetCore() 函數(這些是由asterisk標記的)。

點數通知已啟用 *

返回 true 玩家點數通知已啟用。

徽章通知已啟用 *

如果啟用徽章通知，則會返回 true。

虛擬人偶上下文菜單已啟用 *

如果虛擬人偶上下文菜單啟用，則返回 true。

聊天活動 *

返回聊天是否啟用。這是由箭頭狀態的聊天圖示的選擇狀態來表示的。

聊天視窗尺寸*

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

聊天視窗位置*

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

聊天欄已禁用*

如果聊天欄是無效的，則返回 true。

取得BlockedUserIds

返回與本地玩家關聯的 UserIds 清單。

玩家已封鎖事件

返回一個 BindableEvent ，該玩家每次被本地玩家阻止時會發生。

玩家已解除屏蔽事件

返回一個 BindableEvent ，該玩家每次被本地玩家解鎖時會發生。

玩家關閉事件

返回一個 BindableEvent ，該玩家每次被本地玩家靜音時發射。

PlayerUnmuted事件

返回 BindableEvent 發生時，玩家會被本地玩家解除靜音。

玩家友好事件

返回一個 BindableEvent ，該玩家每次與本地玩家交友時發生。

玩家Unfriended事件

返回一個 BindableEvent ，該玩家每次被本地玩家取消友好時發生。

開發者控制器可見*

返回 true 如果開發者控制器可見。

VRRotationIntensity

返回 VR 中描述鏡頭旋轉靈敏度的字串：Low、High 和 Smooth。這將不會在 VR 中可用，除非 1> Class.VRService.VREnabled1> 是 4> true4> 。

參數

parameterName: string

Variant

屬性繼承自 BasePlayerGui

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

活動

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目