GuiService

非推奨を表示

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

作成できません
サービス
複製されていません

GUIService は、ゲームパッドナビゲーターが現在 GuiObject を選択していること、また、Roblox のメインメニューが現在開いているかどうかを確認することができます。

概要

プロパティ

  • 並列読み取り

    有効にすると、Gamepad または Backslash 上の Select ボタンは自動的に GUI を選択したオブジェクトに設定します。

  • 非表示
    複製されていません
    並列読み取り

    ゲームパッドを使用してオブジェクトをナビゲートできるかどうかを切り替えます。

  • 並列読み取り

    デフォルトのコントローラーGUI ナビゲーションを有効におよび無効にします。

  • 読み取り専用
    複製されていません
    並列読み取り

    コアGUI のメニューが開いている場合、返します。

  • 読み取り専用
    複製されていません
    並列読み取り
  • 非表示
    読み取り専用
    複製されていません
    並列読み取り

    0 から 1 の間のユーザーの透明度を取得し、特定の UI 要素の背景を不明瞭にするためのオプションの一つを示します。推奨は、要素の背景を不明瞭にするための要素の背景透明度の乗数です。デフォルトは 1 です。

  • 非表示
    読み取り専用
    複製されていません
    並列読み取り

    ユーザーが減速モーションを有効にした場合、true が返されます。デフォルトは false です。

  • 並列読み取り

    GUI ナビゲーター (ゲームパッド用) に焦点が合っている GuiObject を設定します。

  • 読み取り専用
    複製されていません
    並列読み取り

    上部のバーのスペース内のアンオブストラクトエリアの相対サイズと位置を決定します。

  • 並列読み取り

    タッチコントロールとタッチコントロールディスプレイ UI を有効にするために使用されます。デフォルトは、「はい」です。

方法

イベント

  • ユーザーが Roblox コアGUIエスケープメニューを 閉じる ときに発動します。

  • ユーザーが Roblox コアGUI エスケープメニューを開く ときにファイア。

プロパティ

AutoSelectGuiEnabled

並列読み取り

有効にすると、ゲームパッドの Select ボタンや Backslash を自動的にGUIに設定します。これをオフにすると、GUIナビゲーションが有効になりますが、GuiService.GuiNavigationEnabled を手動で設定する必要があります。

CoreGuiNavigationEnabled

非表示
複製されていません
並列読み取り

ゲームパッドを使用してオブジェクトをナビゲートできるかどうかを切り替えます。

GuiNavigationEnabled

並列読み取り

デフォルトのコントローラーGUI ナビゲーションを有効におよび無効にします。

読み取り専用
複製されていません
並列読み取り

Class.CoreGui のメニューが開いている場合、true が返されます。

PreferredTextSize

読み取り専用
複製されていません
並列読み取り

PreferredTransparency

非表示
読み取り専用
複製されていません
並列読み取り

0 から 1 の数字の間のユーザーの透明度を取得し、UI 要素の背景をどれだけ不明瞭にしたいかを示します。デフォルトは 1 です。

コードサンプル

Uses the user's value for GuiService.PreferredTransparency by combining it with the desired default background transparency. Also automatically updates the background transparency whenever the user changes their preferred transparency.

Use Preferred Transparency

local DEFAULT_TRANSPARENCY = 0.5
local frame = script.Parent
local function setBackgroundTransparency()
frame.BackgroundTransparency = DEFAULT_TRANSPARENCY * GuiService.PreferredTransparency
end
GuiService:GetPropertyChangedSignal("PreferredTransparency"):Connect(setBackgroundTransparency)
setBackgroundTransparency()

ReducedMotionEnabled

非表示
読み取り専用
複製されていません
並列読み取り

ユーザーが減速モーションを有効にした場合、true が返されます。デフォルトは false です。

この返却値は、アプリの設定またはインエクスペリエンスの設定メニューを介して、ユーザーの側から設定できる設定を反映します。この値は、モーションを減少 を通じて、ユーザーがモーションエフェクトとアニメーションを減少または完全に削除したいと望んでいることを示します。

コードサンプル

Uses the user's value for GuiService.ReducedMotionEnabled by instantly transitioning the frame instead of animating it, if the value of Reduced Motion is true.

Use Reduced Motion

local DEFAULT_TRANSPARENCY = 0.5
local frame = script.Parent
local endPosition = UDim2.fromScale(0.5, 0.8)
if GuiService.ReducedMotionEnabled then
frame.Position = endPosition
else
local moveTweenInfo = TweenInfo.new(0.5)
local moveTweenProps = {
Position = endPosition
}
local moveTween = TweenService:Create(frame, slideInTweenInfo, slideInTweenProps)
moveTween:Play()
end

SelectedObject

並列読み取り

GUI ナビゲーター (ゲームパッド用) に焦点が合っている GuiObject を設定します。オブジェクトが画面外の場合、これは零にリセットされます。

このプロパティは GuiObject.SelectionGainedGuiObject.SelectionLost イベントによって変更されます。

Class.Object.Changed|Changed イベントを追跡しないで、選択取得済み および 選択損失 イベントを監視なしで、このプロパティが変更されるときを特定したい場合は、1>Class.Object.Changed|Changed1> イベントを使用できます。

コードサンプル

The code below demonstrates how to handle when the SelectedObject changes. For instance, this event fires when the Gamepad navigates to another GUI element.

Printing When Gamepad Selection Changes

local GuiService = game:GetService("GuiService")
local function printChanged(value)
if value == "SelectedObject" then
print("The SelectedObject changed!")
end
end
GuiService.Changed:Connect(printChanged)

TopbarInset

読み取り専用
複製されていません
並列読み取り

Roblox の左-最もコントロールの左側とデバイスの安全エリアの間の空きエリアを表示する Rect オブジェクトを返します。

値はダイナミックであり、ローカルプレイヤーの Health プロパティ、使用の StarterGui:SetCoreGuiEnabled()、Roblox UI コントロールのサイズと位置の変更など、期待される値の変更に対応するた

コードサンプル

This code snippet creates a new ScreenGui with a Frame that automatically adapts its size and position to a top bar space unoccupied by Roblox UI.

Responsive Frame Within Available Top Bar Space

local GuiService = game:GetService("GuiService")
local Players = game:GetService("Players")
local screenGui = Instance.new("ScreenGui")
screenGui.IgnoreGuiInset = true
screenGui.Parent = Players.LocalPlayer.PlayerGui
local frame = Instance.new("Frame")
frame.BackgroundColor3 = Color3.fromRGB(0, 255, 0)
frame.Parent = screenGui
GuiService:GetPropertyChangedSignal("TopbarInset"):Connect(function()
local inset = GuiService.TopbarInset
frame.Size = UDim2.new(0, inset.Width, 0, inset.Height)
frame.Position = UDim2.new(0, inset.Min.X, 0, inset.Min.Y)
end)

TouchControlsEnabled

並列読み取り

タッチコントロールとタッチコントロールディスプレイ UI を有効にするために使用されます。デフォルトは、「はい」です。

方法

CloseInspectMenu

()

この関数は、LocalScript から実行するとき、Inspect Menu を閉じます。

参照してください:


戻り値

()

DismissNotification

パラメータ

notificationId: string

戻り値

GetEmotesMenuOpen

プレイヤーのエモートメニューが開いているかどうかを示すBooleanを返します。

開発者は、GuiService:SetEmotesMenuOpen() 関数を呼び出すことで、エモートメニューを開くか閉じることができます。


戻り値

エモートメニューが開いているかどうかを示します。

GetGameplayPausedNotificationEnabled

この関数は、 Class.Player.GameplayPaused|ゲームプレイを一時停止した|ゲームプレイを一時停止した] 通知が開発者によって無効にされているかどうかを返します。

開発者は、GuiService:SetGameplayPausedNotificationEnabled() 関数を呼び出して通知を有効にまたは無効にすることができます。

参照してください:


戻り値

Class.Player.GameplayPaused|ゲームプレイを一時停止しました通知が無効になっているかどうか。

GetGuiInset

スクリーンの左上隅から画面の右下隅まで、ユーザーGUIのインセットを表示する 2つの Vector2 値を返します。

この関数によって提供されるインセット値は、 ScreenGuis のみに IgnoreGuiInset のプロパティセットを設定している場合にのみ有効になります。


戻り値

現在の Gui インセットを記述するベクトル 2 値のツープ。

GetInspectMenuEnabled

この関数は、Inspect と Buy メニュー機能が現在有効であるかどうかを返します。機能はデフォルトで有効になっており、GuiService:SetInspectMenuEnabled() 機能を使用して設定できます。

参照してください:


戻り値

Inspect メニュー機能が有効かどうかを示すブーレット。

InspectPlayerFromHumanoidDescription

()

この機能は、開発者がこの HumanoidDescription オブジェクトにリストされたアセットを表示するインスペクトメニューを表示することを許可します。

これにより、プレイヤーがゲームの他のプレイヤーを調べるときに示すものと、そのプレイヤーが着用しているものとのさらに多くのカスタマイズが可能になります。ゲームがプレイヤーが着用しているものを変更すると、代わりに Inspect メニューにヒューマノイドの説明オブジェクトを渡すことができます。これにより、プレ

参照してください:

パラメータ

humanoidDescription: Instance

Inspect メニューに表示するアセットを含むClass.HumanoidDescriptionオブジェクト。

name: string

Inspect メニューに表示するプレイヤーの名前。


戻り値

()

コードサンプル

This example demonstrates how to show an Inspect Menu containing two items (Midnight Antlers and Mid-Summer Starry Wings), for a player named MyPlayer using GuiService:InspectPlayerFromHumanoidDescription.

Opening an Inspect Menu with a HumanoidDescription

local GuiService = game:GetService("GuiService")
local humanoidDescription = Instance.new("HumanoidDescription")
humanoidDescription.HatAccessory = "3339374070"
humanoidDescription.BackAccessory = "3339363671"
GuiService:InspectPlayerFromHumanoidDescription(humanoidDescription, "MyPlayer")

InspectPlayerFromUserId

()

この関数は、ユーザーが UserId を持っていることを示すインスペクトメニューを表示することができます。これは、現在のゲームでないプレイヤーを調べるときに特に便利です。

これは、指定されたユーザーのプロフィールの「現在着用中」タブと同じ情報を表示します。

参照してください:

  • アバターの調べるメニュー、Inspect と Buy 機能の詳細な説明と、作動方法を提供する記事
  • GuiService:SetInspectMenuEnabled() は、開発者がデフォルトのInspect と Buy 機能を有効にまたは無効にすることができます。これは、Roblox プラットフォームのプレイヤーのアバターに装備されているものと同じではありませんが、特にゲーム内の見た外見と同じではありません。
  • GuiService:InspectPlayerFromHumanoidDescription() により、開発者はこの HumanoidDescription オブジェクトにリストされたアセットを表示するインスペクトメニューを開くことができます

パラメータ

userId: number

Class.Player.UserId|userId のプレイヤーを調べる。


戻り値

()

コードサンプル

The code sample below demonstrates how to use GuiService:InspectPlayerFromUserId() to open the Inspect Menu for the Roblox user with the id 772462.

Opening the Inspect Menu for a UserId

local GuiService = game:GetService("GuiService")
GuiService:InspectPlayerFromUserId(772462)

IsTenFootInterface

クライアントが 10 フィートインターフェイスを使用している場合、これは Roblox's UI の特別なバージョンで、コンソール限定です。これは、ユーザーがコンソールにいるかどうかを確認する唯一の保証された方法です。


戻り値

Select

()

Select は、PlayerGui または PlayerGui の子孫である選択可能な子グリッドオブジェクトのインスタンス選択Parent を呼び出すと、エンジンは選択可能な子グリッドオブジェクトをすべて検索し、GuiService.SelectedObject を GuiObj に最小限の GuiService.SelectionOrder を設定します。

パラメータ

selectionParent: Instance

検索の子孫である選択の親。


戻り値

()

コードサンプル

Uses the user's value for GuiService.PreferredTransparency by combining it with the desired default background transparency. Also automatically updates the background transparency whenever the user changes their preferred transparency.

Use Preferred Transparency

local DEFAULT_TRANSPARENCY = 0.5
local frame = script.Parent
local function setBackgroundTransparency()
frame.BackgroundTransparency = DEFAULT_TRANSPARENCY * GuiService.PreferredTransparency
end
GuiService:GetPropertyChangedSignal("PreferredTransparency"):Connect(setBackgroundTransparency)
setBackgroundTransparency()

SendNotification

パラメータ

notificationInfo: Dictionary

戻り値

SetEmotesMenuOpen

()

プレイヤーのエモートメニューを開くまたは閉じます。

パラメータ

isOpen: boolean

戻り値

()

SetGameplayPausedNotificationEnabled

()

このメソッドは、プレイヤーのゲームプレイを一時停止するときに、ディスクトラクトされた通知を無効にすることができます。その後、プレイヤーがカスタマイズしたい場合は、自分の UI を追加できます。

開発者は、GuiService:GetGameplayPausedNotificationEnabled() 関数を呼び出して通知を有効にするかどうかをクエリーできます。

参照してください:

パラメータ

enabled: boolean

内蔵の通知GUI を無効にするかどうか。


戻り値

()

SetInspectMenuEnabled

()

この機能は、開発者がデフォルトの Inspect と Buy 機能を有効にまたは無効にすることができます。これは、ゲーム内の機能を完全にまたは特定の部分で無効にしたいときに便利です (例えば、カットシーン)。この機能はデフォルトで有効になっています。

下のコードサンプルでは、ゲームのインスペクトメニューを無効にする方法を示しています:


local GuiService = game:GetService("GuiService")
GuiService:SetInspectMenuEnabled(false)

参照してください:

パラメータ

enabled: boolean

Inspect メニュー機能を有効にするかどうかを示すブーレット。


戻り値

()

イベント

ユーザーが Roblox コアGUIエスケープメニューを 閉じる ときに発動します。


ユーザーが Roblox コアGUI エスケープメニューを開く ときにファイア。