StarterGui

非推奨を表示

*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、こちらをクリックしてください。

作成できません

サービス

StarterGui は、LayerCollector オブジェクトなど、ScreenGuis のようなオブジェクトを保持するために設計されたコンテナオブジェクトです。

StarterGui には、CoreGui とインタラクトできる機能の範囲も含まれています。たとえば、StarterGui:SetCoreGuiEnabled() は、0> Class.CoreGui0> の要素を無効にすることができ、

概要

プロパティ

ProcessUserInput:bool
非表示
複製されていません
プラグインのセキュリティ
並列読み取り
このサービスは、PlayerGui や CoreGui のような入力を処理することができます。
RtlTextSupport:Enum.RtlTextSupport
スクリプト作成できません
並列読み取り
ScreenOrientation:Enum.ScreenOrientation
並列読み取り
モバイルデバイスのユーザーにデフォルトの画面オリエンテーションモードを設定します。
ShowDevelopmentGui:bool
並列読み取り
Class.StarterGui のコンテンツが Studio で表示されるかどうかを決定します。
VirtualCursorMode:Enum.VirtualCursorMode
スクリプト作成できません
並列読み取り

Instance から継承されたものをすべて表示

Object から継承されたものをすべて表示

方法

GetCoreGuiEnabled(coreGuiType : Enum.CoreGuiType):bool
Class.StarterGui:SetCoreGuiEnabled() を使用して無効にした場合、または StarterGui:SetCoreGuiEnabled() を有効にした場合を返します。
SetCore(parameterName : string,value : Variant):void
Roblox のコアスクリプトと特定のインタラクションを実行できます。
SetCoreGuiEnabled(coreGuiType : Enum.CoreGuiType,enabled : bool):void
Class.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> false 1> です。

RtlTextSupport

Enum.RtlTextSupport

スクリプト作成できません

並列読み取り

ScreenOrientation

Enum.ScreenOrientation

並列読み取り

このプロパティは、モバイルデバイスのユーザーに最適な画面オリエンテーションモードを設定します。For the different modes available, see Enum.ScreenOrientation .

デフォルトでは、このプロパティは Sensor に設定され、デバイスの現在のオリエンテーションに応じてエクスペリエンスが表示されます。たとえば、ランドスケープ (左/右) またはポートレート (上下) です。

モバイルデバイスに Player がエクスペリエンスに参加すると、このプロパティはデバイスの開始方向を決定し、そのプレイヤーの PlayerGui.ScreenOrientation を設定します。You can also get the player's current screen orientation through Class.PlayerGui.CurrentScreenOrientation</

このプロパティを変更すると、エクスペリエンス内のスクリーンオリエンテーションは変更されません。既存のプレイヤーのオリエンテーションを変更するには、Players プロパティを使用してください。

ShowDevelopmentGui

bool

並列読み取り

このプロパティは、StarterGui のコンテンツが Studio で表示されるかどうかを決定します。

VirtualCursorMode

Enum.VirtualCursorMode

スクリプト作成できません

並列読み取り

Instance から継承されたものをすべて表示

Object から継承されたものをすべて表示

方法

GetCoreGuiEnabled

bool

この関数は、Enum.CoreGuiType を使用して無効にしたか、StarterGui:SetCoreGuiEnabled() を有効にしたかを返します。この関数はクライアントによって呼び出される必要があります。

Class.StarterGui:SetCore()|SetCore() を使用して、false を SetCore() に設定すると、1>Enums.CoreGuiType|CoreGuiTypes1> の結果はすべて非表示になりますが、この関数の結果は影響しません。

パラメータ

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() ) は、RobloRoblox（ロブロックス）のコアスクリプトによって定義されたさまざまな機能を示します、例えば通知を送信、バッジ/ポイントの通知を切り替え、リセットボタンのコールバックを定義するなど。

最初のパラメーターは、呼び出しがインタラクトする機能を選択するストリングです。このメソッドを複数回使用する必要がある場合は、 pcall() を使用して、コアスクリプトがロードされていない (または完全に無効になっている) 場合にこのメソッドを呼び出す必要があります。

次の表では、最初のパラメーターとして受け入れられる文字列を説明します。次のパラメーターは、使用する機能により変更され、サブテーブルで説明されています。

チャットアクティブ

チャットがアクティブかどうかをコントロールします。


<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>
</tbody>

名前	タイプ	デフォルト	説明

バッジ通知アクティブ

獲得したバッジの通知が表示されるかどうかを制御します。


<tbody>
  <tr>
    <td><code>有効な状態 ]</code></td>
    <td>ブールーン</td>
    <td>(必須)</td>
    <td>獲得したバッジの通知が表示されるかどうかを決定します。</td>
  </tr>
</tbody>

名前	タイプ	デフォルト	説明

ボタンの再設定

プレイヤーがリセットをリクエストするときにボールーンまたは BindableEvent をファイアする動作を決定します。


<tbody>
  <tr>
    <td><code>有効化済み</code></td>
    <td>ブールーン</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.fromRGB(255, 255, 243)</code></td>
    <td>メッセージのテキストの色。</td>
  </tr>

  <tr>
    <td><code>フォント</code></td>
    <td><code>Font.Font</code></td>
    <td><code>SourceSansBold</code></td>
    <td>メッセージのフォント。</td>
  </tr>

  <tr>
    <td><code>TextSize</code></td>
    <td>整数</td>
    <td><code>18</code></td>
    <td>メッセージのテキストサイズ。</td>
  </tr>
</tbody>

名前	タイプ	デフォルト	説明

通知を送信

画面の右下に表示される非侵入的な通知を引き起こします。通知には最大 2つのボタンがあります。


<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>2番目のボタンに表示するテキスト。</td>
  </tr>
</tbody>

名前	タイプ	デフォルト	説明

トップバーが有効になりました

トップバーが表示されるかどうかを決定します。トップバーを無効にすると、チャット、インベントリ、プレイヤーリストなどのすべての CoreGuis が無効になります (たとえ、 SetCoreGuiEnabled が設持ち物リストされていても)。

無効にすると、上のバーにあった領域はまだマウスイベントをキャプチャしますが、ボタンはそこに配置されたものではありません。GUI スペースの起源は、画面の上部の 36 ピクセルからオフセットされます。


<tbody>
  <tr>
    <td><code>有効化済み</code></td>
    <td>ブールーン</td>
    <td>(必須)</td>
    <td>トップバーが表示されるかどうかを決定します。</td>
  </tr>
</tbody>

名前	タイプ	デフォルト	説明

DevConsoleVisible

開発者コンソールが表示されるかどうかを決定します。


<tbody>
  <tr>
    <td><code>透明度</code></td>
    <td>ブールーン</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>

名前	タイプ	デフォルト	説明

プロンプトUnblockPlayer

現在のプレイヤーに、Player をブロック解除するよう促します。


<tbody>
  <tr>
    <td><code>プレイヤー</code></td>
    <td><code>Class.Player</code></td>
    <td>(必須)</td>
    <td>アンブロックするべきプレーヤー。</td>
  </tr>
</tbody>

名前	タイプ	デフォルト	説明

AvatarContextMenuEnabled

アバターコンテキストメニューが有効かどうかを決定します。


<tbody>
  <tr>
    <td><code>有効化済み</code></td>
    <td>ブールーン</td>
    <td>(必須)</td>
    <td>コンテキストメニューが有効かどうかを決定します。</td>
  </tr>
</tbody>

名前	タイプ	デフォルト	説明

アバターコンテキストメニューターゲット

Forcibly opens the アバターコンテキストメニュー .


<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>Enum.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>2つの要素のテーブル、Class.BindableEvent は、オプションが有効になったときにプレイヤーが選択した 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チャット接続

Class.CoreGui トップバーのチャットボタンとレガシーチャットシステムの間にバインド可能なゲートウェイ接続を設定します。第 2 引数は、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 と関連付けられたかどうかを設定します。

上のバーをこの機能を使用して無効にすることはできません。それを無効にするには、"TopbarEnabled" を使用して false を StarterGui:SetCore() に設定しています。

パラメータ

coreGuiType: Enum.CoreGuiType

以下の Enum.CoreGuiType を与えます。

enabled: bool

以下の Enum.CoreGuiType を有効にするかどうかを設定します。

戻り値

void

GetCore

Variant

イールド

このメソッドは、Roblox のコアスクリプトによって設定されたデータセットまたは作成されたデータセットを返します。最初のパラメータは、取得する情報を選択するストリングです。次のセクションでは、この関数によって返されるストリングとデータを説明します。

このメソッドを呼び出すと、多くのこれらも同等の SetCore() 関数を登録します (これらはアスタークスでマークされています)。

ポイント通知アクティブ *

プレイヤーポイント通知が有効になっている場合、true を返します。

BadgesNotificationsActive *

バッジ通知が有効になっている場合、true を返します。

AvatarContextMenuEnabled *

アバターコンテキストメニューが有効になっている場合、true が返されます。

ChatActive *

チャットがアクティブかどうかを返します。これは、トップバーのチャットアイコンの選択状態によって表示されます。

チャットウィンドウサイズ*

チャットウィンドウのサイズを UDim2 として返します。

チャットウィンドウポジション*

チャットウィンドウのサイズを UDim2 として返します。

ChatBarDisabled *

チャットバーが無効になっている場合、true を返します。

GetBlockedUserIds を取得

ローカルプレイヤーによってブロックされたユーザーと関連付けられた UserIds のリストを返します。

PlayerBlockedEvent

ローカルプレイヤーによってブロックされたときに発動する BindableEvent を返します。

PlayerUnblockedEvent

ローカルプレイヤーによってブロックされたときにプレイヤーがアンブロックされるたびに BindableEvent を返します。

PlayerMutedEvent

ローカルプレイヤーによってミュートされたときに発動する BindableEvent を返します。

PlayerUnMutedEvent

ローカルプレイヤーにミュート解除されたときに発動する BindableEvent を返します。

PlayerFriendedEvent

ローカルプレイヤーによってフレンド化されるときに発動する BindableEvent を返します。

PlayerUnfriendedEvent

ローカルプレイヤーからプレイヤーを友達解除したときに発動する BindableEvent を返します。

DevConsoleVisible *

開発者コンソールが表示される場合、true を返します。

VRRotationIntensity

VR のカメラ回転感度を記述するストリングを返します： Low、High および Smooth 。これは 1> Class.VRService.VREnabled1> が 4> true4> でない場合にのみ利用可能です。

パラメータ

parameterName: string

戻り値

Variant

プロパティは BasePlayerGui から継承されました

Instance から継承されたものをすべて表示

Object から継承されたものをすべて表示

イベント

Instance から継承されたものをすべて表示

Object から継承されたものをすべて表示