StarterGui

非推奨を表示

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

作成できません

サービス

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

Player.Character が生成されると、その PlayerGui の内容 (ある場合) が空になります。子供たちの StarterGui はその子孫と一緒に PlayerGui にコピーされます。ただし、オブジェクトのように、プロパティが設定されたオブジェクトは、各プレイヤーのに一度だけ配置され、リスポーン時に削除されないことに注意してください。

StarterGui には、CoreGui と対話できる幅広い機能も含まれています。たとえば、StarterGui:SetCoreGuiEnabled() は、CoreGui の要素を無効にするために使用でき、StarterGui:SetCore() は、通知の作成やシステムメッセージの送信など、幅広い機能を実行できます。

概要

プロパティ

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

このプロパティを変更すると、エクスペリエンス内の画面の向きが変更されないことに注意してください Players すでに。既存のプレイヤーの向きを変更するには、その PlayerGui.ScreenOrientation プロパティを使用します。

ShowDevelopmentGui

boolean

並列読み取り

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

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>ブールン値</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>
</tbody>

名前

バッジ通知アクティブ

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


<th>種類</th>

    <th>デフォルト</th>

    <th>説明</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>有効</code></td>

    <td>ブールン値</td>

    <td>(必要)</td>

    <td>獲得したバッジの通知が表示されるかどうかを決定します。</td>
  </tr>
</tbody>

名前

リセットボタンコールバック

プレイヤーがリセットをリクエストすると発射されるブールまたは BindableEvent を与えられたリセットボタンの動作を決定します。


<th>種類</th>

    <th>デフォルト</th>

    <th>説明</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>有効化済み</code></td>

    <td>ブールン値</td>

    <td>(必要)</td>

    <td>リセットボタンがデフォルトの動作を保持するかどうかを決定します。</td>
  </tr>

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

  <tr>
    <td><code>コールバック</code></td>

    <td><code>クラス.BindableEvent</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>configTable</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>データタイプ.Color3</code></td>

    <td><code>Datatype.Color3.fromRGB(255、255、243)</code></td>

    <td>メッセージのテキスト色。</td>
  </tr>

  <tr>
    <td><code>フォント</code></td>

    <td><code>Enum.フォント</code></td>

    <td><code>ソースサンスボールド</code></td>

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

  <tr>
    <td><code>テキストサイズ</code></td>

    <td>整数</td>

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

    <td>メッセージの文字サイズ。</td>
  </tr>
</tbody>

名前

通知を送信

画面の右下に非侵襲的な通知が表示されるようにします。通知には最大 2つのボタンがあり得ます。


<th>種類</th>

    <th>デフォルト</th>

    <th>説明</th>
  </tr>
</thead>

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

名前

トップバー有効化済み

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

無効にすると、トップバーが一度占有していた領域はまだマウスイベントをキャプチャしますが、そこに配置されたボタンはクリックに応答しません。GUI スペースの起源は、画面の上部から 36 ピクセルオフセットされ続けます。


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

名前

プロンプト送信フレンドリクエスト

現在のプレイヤーに、指定された Player に友達リクエストを送信するよう促します。


<th>種類</th>

    <th>デフォルト</th>

    <th>説明</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>playeプレイヤー</code></td>

    <td><code>クラス.Player</code></td>

    <td>(必要)</td>

    <td>フレンドリクエストを送信するプレイヤー。</td>
  </tr>
</tbody>

名前

プロンプトUnfriend

現在のプレイヤーに、指定の Player をフレンドリストから削除するように促します。


<th>種類</th>

    <th>デフォルト</th>

    <th>説明</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>playeプレイヤー</code></td>

    <td><code>クラス.Player</code></td>

    <td>(必要)</td>

    <td>友達解除すべきプレイヤー。</td>
  </tr>
</tbody>

名前

プロンプトブロックプレイヤー

現在のプレイヤーに指示して、指定された Player をブロックするようにします。


<th>種類</th>

    <th>デフォルト</th>

    <th>説明</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>playeプレイヤー</code></td>

    <td><code>クラス.Player</code></td>

    <td>(必要)</td>

    <td>ブロックすべきプレイヤー。</td>
  </tr>
</tbody>

名前

プロンプトUnblockPlayer

現在のプレイヤーに指示して、指定された Player をブロック解除します。


<th>種類</th>

    <th>デフォルト</th>

    <th>説明</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>playeプレイヤー</code></td>

    <td><code>クラス.Player</code></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>
</tbody>

名前

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

強制的にアバターコンテキストメニューを開きます。


<th>種類</th>

    <th>デフォルト</th>

    <th>説明</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>playeプレイヤー</code></td>

    <td><code>クラス.Player</code></td>

    <td>(必要)</td>

    <td>コンテキストメニューが開くプレイヤー。</td>
  </tr>
</tbody>

名前

AddAvatarContextMenuオプション

アバターコンテキストメニューにオプションを追加します。


<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>2要素のテーブルで、1つ目はカスタムアクションの名前、2つ目はプレイヤーで発動される <code>Class.BindableEvent</code> が選択されたときにオプションが有効になった。</td>
  </tr>
</tbody>

名前

AvatarContextMenuOptionを削除

アバターコンテキストメニューにオプションを削除します。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

トップバーのチャットボタンとレガシーチャットシステムの間のバインド可能なゲートウェイ接続を設定します。CoreGui2番目のパラメータは、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 を返す if the アバターコンテキストメニューが有効です。

チャット活性*

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

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

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

チャットWindowPosition*

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

チャットバー無効*

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

GetBlockedUserIdsを取得

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

プレイヤーブロックイベント

プレイヤーがローカルプレイヤーにブロックされるたびに発射される BindableEvent を返します。

プレイヤーブロック解除イベント

ローカルプレイヤーによってブロック解除されるたびに発射される BindableEvent を返します。

PlayerMutedイベント

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

プレイヤーアンミュートイベント

ローカルプレイヤーによってミュート解除されるたびに発射される BindableEvent を返します。

PlayerFriendedイベント

プレイヤーがローカルプレイヤーに友達になられるたびに発射される BindableEvent を返します。

プレイヤーの友達解除イベント

プレイヤーがローカルプレイヤーに友達解除されるたびに発射される BindableEvent を返します。

デバコンソールビジブル*

true を返す if the 開発者コンソールが表示されている場合。

VRRotationインテンシティ

VR でカメラの回転感度を説明する文字列を返します：Low、High、および Smooth 。これは、VRService.VREnabled が true でない限り、利用できません。

パラメータ

parameterName: string

既定値: ""

戻り値

Variant

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

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

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

イベント

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

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

StarterGui

概要

プロパティ

方法

イベント

プロパティ

ProcessUserInput

RtlTextSupport

ScreenOrientation

ShowDevelopmentGui

VirtualCursorMode

方法

GetCoreGuiEnabled

パラメータ

戻り値

コードサンプル

SetCore

チャット活性

ポイント通知アクティブ

バッジ通知アクティブ

リセットボタンコールバック

チャットメイクシステムメッセージ

通知を送信

トップバー有効化済み

デバコンソールビジブル

プロンプト送信フレンドリクエスト

プロンプトUnfriend

プロンプトブロックプレイヤー

プロンプトUnblockPlayer

アバターコンテキストメニュー有効化済み

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

AddAvatarContextMenuオプション

AvatarContextMenuOptionを削除

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

コアGUIChatConnections

パラメータ

戻り値

コードサンプル

SetCoreGuiEnabled

パラメータ

戻り値

GetCore

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

バッジ通知有効*

アバターコンテキストメニュー有効*

チャット活性*

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

チャットWindowPosition*

チャットバー無効*

GetBlockedUserIdsを取得

プレイヤーブロックイベント

プレイヤーブロック解除イベント

PlayerMutedイベント

プレイヤーアンミュートイベント

PlayerFriendedイベント

プレイヤーの友達解除イベント

デバコンソールビジブル*

VRRotationインテンシティ

パラメータ

戻り値

イベント

ページ内容