GuiService
*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。
GuiService は、開発者がゲームパッドナビゲーターによって現在選択されているもの、および Roblox のメインメニューが現在開いているかどうかをチェックできるようにします。
概要
プロパティ
有効にすると、ゲームパッドまたは Backslash の Select ボタンが自動的に GUI を選択したオブジェクトとして設定します。
CoreGui にあるオブジェクトがゲームパッドを使用してナビゲートできるかどうかを切り替えます。
デフォルトのコントローラーGUIナビゲーションを有効化/無効化するために使用します。
CoreGui のメニューが開いている場合は、真を返します。
ユーザーの好ましい透明度を 0 から 1 の数値として取得し、特定の UI 要素の背景をどれほど不透明にしたいかを示します。推奨される使用法は、要素の背景透明度の倍数としてです。デフォルトは 1 です。
ユーザーが減少モーションを有効にした場合は、true を返します。デフォルトは false です。
GUI ナビゲーター (ゲームパッド用) によって現在焦点が当てられている GuiObject を設定します。
トップバースペース内の障害のない領域の絶対サイズと位置を決定するのに使用されます。
タッチコントロールとタッチコントロールディスプレイ UI を有効化/無効化するために使用します。デフォルトは true です。
方法
インスペクトメニューを閉じ、開いている場合は
プレイヤーのエモートメニュが開いているかどうかをチェックします。
開発者によって gameplay paused 通知が無効になっているかどうかを返します。
画面の左上隅と右下隅それぞれから、ユーザーGUIの挿入を表す 2 つの Vector2 を返します。
インスペクトと購入メニュー機能が有効かどうかを返します。
開発者がこの HumanoidDescription オブジェクトにリストされたアセットを表示するインスペクトメニューを表示できるようにします。
インスペクトメニューが表示され、指定された UserId を持つユーザーを示すことができます。
クライアントが Roblox の UI の特別版である 10フィートインターフェイスを使用している場合、真を返します。これは、コンソール専用のものです。これは、ユーザーがコンソールにいるかどうかを確認する唯一の保証方法です。
GuiService.SelectedObject を PlayerGui またはその子孫の提供されたインスタンス選択親に設定します。
プレイヤーのエモートメニューを開くか閉じる。
開発者がプレイヤーのゲームプレイが一時停止したときに内蔵通知を無効にすることを許可します。
開発者がデフォルトのインスペクトと購入機能を有効化または無効化できるようにします。
イベント
ユーザーが Roblox コアGUIエスケープメニューを閉じる ときに発火します。
ユーザーが Roblox コアGUIエスケープメニューを開く ときに発火する
プロパティ
AutoSelectGuiEnabled
有効にすると、ゲームパッドまたは Backslash の Select ボタンが自動的に GUI を選択したオブジェクトとして設定します。これをオフにすると、GuiService.GuiNavigationEnabled が有効になっている場合でも Gui ナビゲーションがまだ機能するが、GuiService.SelectedObject を手動で設定して Gui ナビゲーションを開始する必要があります。
PreferredTextSize
PreferredTransparency
ユーザーの好ましい透明度を 0 から 1 の数値として取得し、UI 要素の背景がどれほど不透明になりたいかを示します。デフォルトは 1 です。
この返却値は、アプリ設定または バックグラウンド透明性 を介してユーザー側で設定できる設定を反映します。これは、エクスペリエンス内の設定メニュー内で設定できます。デフォルト値は 1 で、ユーザーがデフォルトの背景透明度を好むことを示します。最も低い値は 0 で、ユーザーが背景を完全に不透明にするのを好むことを示し、影響を受ける UI の読みやすさとコントラストを向上させます。要素の GuiObject.BackgroundTransparency を値が返された PreferredTransparency で掛け算することは、この設定を使用する推奨方法です;背景は、PreferredTransparency が 0 に近づくにつれて不透明になります。これは Object:GetPropertyChangedSignal() で自動更新されるため、ユーザーが好ましい透明度を変更するときに使用する必要があります。
コードサンプル
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.
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 です。
この返却値は、アプリ設定または モーションを減らす を介してユーザー側で設定できる設定を反映します。これは、エクスペリエンス内の設定メニュー内で設定できます。値 true は、ユーザーがモーション効果とアニメーションを減少または完全に削除したいことを示します。
コードサンプル
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.
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 を設定します。オブジェクトが画面外にある場合、これは nil にリセットされます。
このプロパティは、GuiObject.SelectionGained および GuiObject.SelectionLost イベントによって変更されます。
すべての GUI 要素の選択取得および選択失敗イベントを追跡せずに、このプロパティがいつ変更されるかを判断したい場合は、Changed イベントを使用できます。
コードサンプル
The code below demonstrates how to handle when the SelectedObject changes. For instance, this event fires when the Gamepad navigates to another GUI element.
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 オブジェクトを返します。
値は動的であり、UI コントロールの表示状況に基づいて変更される可能性があり、ローカルプレイヤーの Health プロパティの変更、 StarterGui:SetCoreGuiEnabled() の使用、Roblox UI コントロールのサイズと位置の変更、および/または他の要因により変更される可能性があります。このため、このプロパティの変更を検出し、反応するには Object:GetPropertyChangedSignal() で変更を検出することをお勧めします。
コードサンプル
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.
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)
方法
CloseInspectMenu
この機能は、LocalScript から実行すると、インスペクトメニューを閉じます。開いている場合。
参照してください:
- アバターインスペクトメニュー、インスペクトと購入機能の詳細な説明と動作についての記事
- GuiService:InspectPlayerFromHumanoidDescription() , 開発者がこの HumanoidDescription オブジェクトにリストされたアセットを表示するインスペクトメニューを表示できるようにします。これは、Roblox プラットフォーム上のプレイヤーのアバターで着用されているものが、ゲーム内の外見と必ずしも同じではない場合に特に役立ちます
- GuiService:InspectPlayerFromUserId() , インスペクトメニューが表示され、指定された UserId を持つユーザーを示すことができます。特に現在のゲームにいないプレイヤーを調査したいときに便利です
戻り値
GetEmotesMenuOpen
プレイヤーのエモートメニューが開いているかどうかを示すブールを返します。
開発者は、GuiService:SetEmotesMenuOpen() 関数を呼び出して、エモートメニューを開いたり閉じたりできます。
戻り値
エモートメニューが開いているかどうかを示します。
GetGameplayPausedNotificationEnabled
この機能は、開発者によって gameplay paused 通知が無効になっているかどうかを返します。
開発者は、GuiService:SetGameplayPausedNotificationEnabled() 関数を呼び出して通知を有効化または無効化できます。
参照してください:
- Workspace.StreamingIntegrityMode と Enum.StreamingIntegrityMode で、ゲームプレイが一時停止したときの詳細情報。
戻り値
gameplay paused 通知が無効になっているかどうか。
GetGuiInset
画面の左上隅と右下隅それぞれから、ユーザーGUIの挿入を表す 2 つの Vector2 を返します。
この関数が提供する挿入値は、ScreenGuis のプロパティが false に設定されている IgnoreGuiInset にのみ効果があります。
戻り値
現在の指定された Gui 挿入を説明する 2つの Vector2 値のツープル。
GetInspectMenuEnabled
この機能は、Inspect and Buy メニュー機能が現在有効かどうかを返します。機能はデフォルトで有効になっており、GuiService:SetInspectMenuEnabled() 関数を使用して設定できます。
参照してください:
- アバターインスペクトメニュー、インスペクトと購入機能の詳細な説明と動作についての記事
- GuiService:InspectPlayerFromHumanoidDescription() , 開発者がこの HumanoidDescription オブジェクトにリストされたアセットを表示するインスペクトメニューを表示できるようにします。これは、Roblox プラットフォーム上のプレイヤーのアバターで着用されているものが、ゲーム内の外見と必ずしも同じではない場合に特に役立ちます
- GuiService:InspectPlayerFromUserId() , インスペクトメニューが表示され、指定された UserId を持つユーザーを示すことができます。特に現在のゲームにいないプレイヤーを調査したいときに便利です
戻り値
インスペクトメニュー機能が有効かどうかを示すブール。
InspectPlayerFromHumanoidDescription
この機能により、開発者は、この HumanoidDescription オブジェクトにリストされたアセットを表示するインスペクトメニューを表示できます。
これにより、プレイヤーがゲーム内の他のプレイヤーを調査するときに表示されるインスペクトメニューで表示されるものをさらにカスタマイズできます。ゲームがプレイヤーの着用中のものを変更する場合、代わりにプレイヤーが着用中のものを表現するヒューノイド説明オブジェクトをインスペクトメニューに渡すことができ、それらのアイテムが表示されます。検査されるプレイヤーの名前を表すために、名前をパスする必要があります。
参照してください:
- アバターインスペクトメニュー、インスペクトと購入機能の詳細な説明と動作についての記事
- GuiService:SetInspectMenuEnabled() , 開発者がデフォルトのインスペクトと購入機能を有効化または無効化できるようにする
- GuiService:InspectPlayerFromUserId() , インスペクトメニューが表示され、指定された UserId を持つユーザーを示すことができます。特に、現在のゲームにいないプレイヤーを調査したいときに便利です。
パラメータ
インスペクトメニューに表示するアセットを含む HumanoidDescription オブジェクト。
インスペクトメニューに表示するプレイヤーの名前。
戻り値
コードサンプル
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.
local GuiService = game:GetService("GuiService")
local humanoidDescription = Instance.new("HumanoidDescription")
humanoidDescription.HatAccessory = "3339374070"
humanoidDescription.BackAccessory = "3339363671"
GuiService:InspectPlayerFromHumanoidDescription(humanoidDescription, "MyPlayer")
InspectPlayerFromUserId
この機能により、Inspect メニューが表示され、指定された UserId を持つユーザーが表示されます。特に、現在のゲームにいないプレイヤーを調査したいときに便利です。
これは、指定されたユーザーのプロフィールの「現在着用中」タブと同じ情報を表示します。
参照してください:
- アバターインスペクトメニュー、インスペクトと購入機能の詳細な説明と動作についての記事
- GuiService:SetInspectMenuEnabled() , 開発者がデフォルトのインスペクトと購入機能を有効化または無効化できるようにするこれは、Roblox プラットフォーム上のプレイヤーのアバターで着用されているものが、ゲーム内の外見と必ずしも同じではない場合に特に役立ちます
- GuiService:InspectPlayerFromHumanoidDescription() , 開発者がこの HumanoidDescription オブジェクトにリストされたアセットを表示するインスペクトメニューを表示できるようにする
パラメータ
戻り値
コードサンプル
The code sample below demonstrates how to use GuiService:InspectPlayerFromUserId() to open the Inspect Menu for the Roblox user with the id 772462.
local GuiService = game:GetService("GuiService")
GuiService:InspectPlayerFromUserId(772462)
IsTenFootInterface
クライアントが Roblox の UI の特別版である 10フィートインターフェイスを使用している場合、真を返します。これは、コンソール専用のものです。これは、ユーザーがコンソールにいるかどうかを確認する唯一の保証方法です。
戻り値
Select
選択が PlayerGui または PlayerGui の子孫のインスタンス選択親に呼び出されると、エンジンは選択親のすべての利用可能な選択可能な、表示可能なオンスクリーンの Guiオブジェクトを検索し、 GuiService.SelectedObject を最小の GuiService.SelectionOrder を持つ Guiオブジェクトに設定します。
パラメータ
その子孫が検索される選択の親。
戻り値
コードサンプル
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.
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()
SetGameplayPausedNotificationEnabled
このメソッドでは、開発者がプレイヤーのゲームプレイが一時停止したときに内蔵の通知を無効にできます。必要に応じてカスタマイズしたい場合は、自分の UI を追加できます。
開発者は、GuiService:GetGameplayPausedNotificationEnabled() 関数を呼び出して通知が有効になっているかをクエリーできます。
参照してください:
- Workspace.StreamingIntegrityMode と Enum.StreamingIntegrityMode で、ゲームプレイが一時停止したときの詳細情報。
パラメータ
ビルトイン通知 GUI が無効になっているかどうか。
戻り値
SetInspectMenuEnabled
この機能により、開発者はデフォルトの検査と購入機能を有効化または無効化できます。これは、ゲーム内の機能を完全にまたは特定の部分のゲーム中に無効にしたい場合に便利です (例: カットシーン)。機能はデフォルトで有効になっています。
以下のコードサンプルでは、ゲームのインスペクトメニューを無効にする方法を示します:
local GuiService = game:GetService("GuiService")GuiService:SetInspectMenuEnabled(false)
参照してください:
- アバターインスペクトメニュー、インスペクトと購入機能の詳細な説明と動作についての記事
- GuiService:InspectPlayerFromHumanoidDescription() , 開発者がこの HumanoidDescription オブジェクトにリストされたアセットを表示するインスペクトメニューを表示できるようにします。これは、Roblox プラットフォーム上のプレイヤーのアバターで着用されているものが、ゲーム内の外見と必ずしも同じではない場合に特に役立ちます
- GuiService:InspectPlayerFromUserId() , インスペクトメニューが表示され、指定された UserId を持つユーザーを示すことができます。特に現在のゲームにいないプレイヤーを調査したいときに便利です
パラメータ
インスペクトメニュー機能を有効化するか無効化するかを示すブール。
戻り値
イベント
MenuClosed
ユーザーが Roblox コアGUIエスケープメニューを閉じる ときに発火します。
MenuOpened
ユーザーが Roblox コアGUIエスケープメニューを開く ときに発火する