Unity のビルトインの変数

Unity のビルトインスタイルシートは、エディターインターフェースのデフォルト値を設定する USS 変数 を定義します。これらの変数を独自のスタイルシートで使用して、カスタムのインターフェースが Unity スタイルに一致させます。

特定の変数に関する情報は、ビルトインの Unity 変数のリスト を参照してください。

Unity の変数名

Unity では、ビルトイン変数をどこでどのように使用するかを示すために、特定の命名規則を使用しています。変数名は、ハイフンで区切られた 1 つまたは複数の部分から構成されます。各パートは、アンダースコアで区切られた 1 つまたは複数の単語で構成されます。

--unity-{group}-{role_and_control}-{sub_element}-{pseudo_state_sequence}

名前の各部分は、その変数を使用する USS 規則の種類について何かを教えてくれます。

• Group: その変数が表すデータの種類。
• Role/Control: 変数が影響を与える要素の概念的なグループです。
• Sub-Element: 変数が影響を与える要素またはコントロールの一部。
• Pseudo States: Unity がその変数を使用する状態のリスト。

例えば、変数名は以下のようになります。

--unity-colors-button-text-hover

Unity が変数をどのように使用するかについては、以下の通りです。

	値	意味
Group	colors	色のデータを表す変数です。
Role/Control	button	ボタンに影響を与える変数です。
Sub-Element	text	この変数はテキストに影響を与えます。その group が colors であることから、それがテキストの色に影響を与えることがわかります。
Pseudo-States	hover	Unity では、マウスポインターが要素の上に乗ったときに適用されるスタイルでこの変数を使用しています。

つまり、Unity では、ユーザーがボタンにカーソルを重ねるときに、ボタンのテキストの色を変更するスタイルでこの変数を使用しています。

このセクションの残りの部分では、変数名の形式の各部分について詳細な情報を提供します。

Group

Group (グループ) は、その変数がどのようなデータを表しているかを指定します。各グループには、いくつかの可能な サブ要素 があります。

Unity の変数名には以下のグループがあります。

Group:	用途
colors	background-color や border-color などの色のプロパティ。
metrics	寸法や形状を制御するプロパティ。例えば、 border-radius、border-width、margin、padding
icons	標準的な Unity のアイコン画像。

Role and Control

Role and Control (ロールとコントロール) は、概念的に要素をグループ化する 2 つの方法です。

• Role (ロール) は、各要素がどのタイプであるかに関わらず、同じ目的を持つ要素のグループを指します。例えば、error ロールには、ユーザーにエラーメッセージを表示することに関係あるすべての要素が含まれます。
• Control (コントロール) は、何をするかに関わらず、同じタイプの要素のグループを指します。例えば、buttons は、エディターのすべてのボタンを含みます。

すべての Unity の変数は、ロールかコントロールのどちらかを持っています。両方を持つことはできません。

Unity の変数名には、以下のような役割やコントロールが可能です。

Roles:

Role:	説明
default	文字色、背景、余白などのデフォルトのスタイル設定。
alternated_rows	表形式のデータを交互に行の色を変えて表示する要素。例えば、リストビューのリストアイテムなど。
error	エラーの状態をユーザーに伝えるための要素。
highlight	UI のハイライト部分。例えば、テキストの選択部分や、ツリービューでの選択項目など。
link	UI のパーツ (通常はテキスト) でクリックできるリンク。これは、クリックされていない状態です。
play_mode	エディターが再生モードのときに表示される要素。
visited_link	UI のパーツ (通常はテキスト) でクリックできるリンク。これは、クリックされていない状態です。
warning	ユーザーに警告メッセージを伝えるための要素。

Controls:

Control:	説明
app_toolbar	Unity のメインツールバー
app_toolbar_button	Unity のメインツールバーのボタン
box	Editor UI で要素をグループ化するためのボックス
button	ツールバーを除く UI のボタン
dropdown	ドロップダウンリストやメニュー
helpbox	ヘルプ情報を表示するボックス
input_field	テキストや数値を入力するフィールド
label	エディター UI のテキストラベル
object_field	オブジェクトの値に使用されるフィールド。例えば、ゲームオブジェクトやアセットのプロパティ値など。
popup	ポップアップメニューなどのポップアップコントロール
preview	プレビューを表示するためのビュー。例えば、メッシュやテクスチャなどのアセットのプレビューを表示します。
scrollbar_groove	ユーザーがスクロールバーのつまみをドラッグするスクロールバーの背景要素
scrollbar_thumb	スクロールバーのドラッグ可能なハンドル要素
slider_groove	ユーザーがスライダーのつまみをドラッグする際のスライダーの背景要素
slider_thumb	スライダーのドラッグ可能なハンドル要素
slider_thumb_halo	ユーザーがスライダーのサムをドラッグしたときに、サムの周囲に表示されるオーバーレイ
tab	タブコントロールのタブアイテム
toolbar	Unity のメインツールバー (app_toolbar) 以外のエディターツールバー
toolbar_button	エディターツールバーのボタン
window	エディターウィンドウ

Sub-Element

Sub-Element (サブ要素) とは、変数が影響を与える要素の一部です。変数の group と合わせて、サブ要素はその変数がどのようなデータを表しているかを正確に伝えます。

例えば、変数名に colors グループと text サブ要素が付いている場合です。これは、Unity がテキストの色に影響を与えるスタイルでその変数を使用することを意味します。

Unity の変数名は、以下のサブ要素を持つことができます。

Group:	Sub-element:	説明
colors
	background	要素の背景色
	border	要素の境界色
	border_accent	要素の内側の境界線の色を表します。たとえば、Inspector ウィンドウには、ツートンカラーの境界線があります。
	text	テキストを表示する要素の文字色
metrics
	margin_{left, top, right, bottom}	要素のマージン値
	padding_{left, top, right, bottom}	要素のパディング値
	border_{left, top, right, bottom}_width	要素のボーダー幅の値
	border_{left_top, left_bottom, right_top, right_bottom}_radius	要素の境界線の半径値
	width, height	要素の幅と高さの値

Pseudo-States

Pseudo-State (疑似状態) シーケンスは、Unity が変数を使用する UI 状態のリストです。

例えば、変数名に hover という疑似状態が付いている場合です。これは、ユーザーが要素にポインターを重ねるときに要素に影響を与えるスタイルの変数を Unity が使用するという意味です。

例えば、--unity-colors-toolbar_button-text-hover

一つの変数名に複数の疑似状態を持たせることができます。複数の疑似状態は、アンダースコア _ で区切られたアルファベット順に表示されます。

例えば、 --unity-colors-toolbar_button-text-focus_selected

Unity の変数名には、以下の疑似状態のすべての組み合わせが可能です。

Pseudo-state:	説明
(なし)	通常の状態
checked	チェックボックスタイプのコントロールがオンです。
disabled	コントロールがオフです。
focus	コントロールにフォーカスがあります。
hover	ユーザーがコントロールにカーソルを重ねています。
inactive	コントロールにフォーカスがありません。
pressed	コントロールが押されました。
selected	コントロールが選択されました。

ビルトインの Unity 変数のリスト

---