Canvas Component

UIの基準解像度、拡縮、操作Playerとゲーム入力のブロックを設定します。

設定する手順

1. UI用GameObjectをCanvasの子として配置し、操作Playerと表示順を選びます。
2. SceneViewまたはGameViewで結果を確認します。
3. 編集中のSceneまたはPrefabを保存します。

項目の説明

項目	C#名	型	操作	定義時の初期値	意味
有効	Enabled	bool	読取・変更	true	このComponentの処理を有効にします。GameObject全体のアクティブ状態とは別です。
ReferenceResolution	ReferenceResolution	Vector2	読取・変更	EngineContext::GetWindowSetting().gameSizeFloat	Canvasの配置と拡縮の基準となる幅・高さです。
ScaleMode	ScaleMode	CanvasScaleMode	読取・変更	CanvasScaleMode::ScaleWithScreenSize	基準解像度に対してUIの大きさをどう合わせるかを指定します。
ScaleFactor	ScaleFactor	float	読取・変更	1.0f	UI全体の拡縮倍率です。
MatchWidthOrHeight	MatchWidthOrHeight	float	読取・変更	0.5f	解像度追従で幅と高さのどちらを優先するかの比率です。
ソートレイヤー	SortingLayer	int	読取・変更	0	UIを並べる描画Layerです。
描画順	Order	int	読取・変更	0	同じLayer内の並び順です。
InputBlockMode	InputBlockMode	CanvasInputBlockMode	読取・変更	CanvasInputBlockMode::None	ゲーム入力を止めない・UI操作frameのみ・Canvas有効中から選びます。
Player	PlayerIndex	uint	読取・変更	0	操作を割り当てるPlayer番号です。先頭は0です。
編集中に入力有効	InputInEditMode	bool	読取・変更	false	Play前のUI操作を許可します。
決定後入力を受け付けない	BlockInputAfterSubmit	bool	読取・変更	false	決定操作後の入力消費を設定します。
キーボード入力有効	KeyboardInputEnabled	bool	読取・変更	true	キーボード操作を有効にします。
ゲームパッド入力有効	GamepadInputEnabled	bool	読取・変更	true	ゲームパッド操作を有効にします。
左スティックを使用	GamepadLeftStickEnabled	bool	読取・変更	true	左スティックによるUI選択を有効にします。
NavigationMode	NavigationMode	CanvasNavigationMode	読取・変更	CanvasNavigationMode::Automatic	自動または指定した配置情報で選択先を決めます。
ナビゲーションをループ	WrapNavigation	bool	読取・変更	true	端の選択から反対側へ移動できるようにします。
FirstSelected	FirstSelected	GameObject?	読取・変更	{}	最初に選択するUI GameObjectの保存用IDです。
リピート開始	RepeatDelay	float	読取・変更	0.35f	押し続けてから連続移動が始まるまでの秒数です。
リピート間隔	RepeatInterval	float	読取・変更	0.12f	押し続けたときの連続移動の間隔です。単位は秒です。
スティックしきい値	StickThreshold	float	読取・変更	0.5f	スティックを倒したと判定する閾値です。

Inspectorの設定と使い方

「Editor / C#」は両方から変更できる設定、「Editorのみ」は公開C# APIのない編集操作です。「Editor表示のみ」は計算結果や統計などの確認欄です。「C#のみ」は、このInspectorに編集欄のない操作です。

設定・操作	編集場所	C#の入口	意味・使い方
有効・ソートレイヤー・描画順	Editor / C#	Enabled / SortingLayer / Order	子のUIをまとめる基準です。別Canvasとの並びと、Canvas配下のボタン・文字の関係を設定します。
基準解像度・拡縮	C#のみ	ReferenceResolution / ScaleMode / ScaleFactor / MatchWidthOrHeight	現在のInspectorは基準解像度を表示するだけです。C# APIでは基準解像度・拡縮方式・倍率・幅高さの合わせ方も扱えます。表示情報と編集欄を区別してください。
Player・ゲーム入力ブロック	Editor / C#	PlayerIndex / InputBlockMode	Playerは0〜3です。入力ブロックは、なし・UI操作を消費したframe・Canvas有効中から選び、そのPlayerのゲーム入力を抑えます。UI自身の入力を止める指定ではありません。
入力有効・決定後ロック・リピート	Editor / C#	InputInEditMode / BlockInputAfterSubmit / RepeatDelay / RepeatInterval	編集時にも操作するか、決定後の再操作を抑えるか、長押しの移動開始待ちと繰り返し間隔を指定します。C#ではInputLockedで状態を読み、BlockInputAfterSubmitをfalseへ戻すと入力ロックが解除されます。
初期UI・ナビゲーション・ループ	Editor / C#	FirstSelected / NavigationMode / WrapNavigation / TransitionTable	最初に選択するUIと、自動の位置判定か遷移テーブルかを選びます。テーブルの縦横と各セルで選択先を定義し、端から反対側へ戻すかをループで指定します。
キーボード・パッド・ボタン割当	Editor / C#	KeyboardInputEnabled / GamepadInputEnabled / GamepadLeftStickEnabled / StickThreshold / SetKeyboardInputs / SetGamepadInputs	選択移動・決定などへキーやパッドボタンを割り当てます。スティック使用時はしきい値で小さな入力を除きます。既存割当の取得・追加・削除APIも下表にあります。

初期値はEngineのComponent定義時の値で、C++表記を含みます。C#へ貼り付ける実行例ではありません。既存Sceneの保存値や既定Assetがある場合はそちらが優先されます。数値の編集範囲はInspectorで制限される場合があります。

C#から使う

操作型はCanvasです。 GameObjectから取得する基本操作はGameObjectの操作を参照してください。以下には基本プロパティだけでなく、公開関数・追加の設定API・継承した共通操作も掲載します。

設定用・関連するC#型

• CanvasTransitionTable
• CanvasInputAction

選択値（Enum）

型・各値の詳説	使える値
CanvasInputAction	Down / Left / Right / Submit / Up
CanvasInputBlockMode	ConsumedFrame / None / WhileVisible
CanvasNavigationMode	Automatic / TransitionTable
CanvasScaleMode	ConstantPixelSize / ScaleWithScreenSize
GamepadButton	A / B / Back / Down / Left / LeftShoulder / LeftThumb / LeftTrigger / Right / RightShoulder / RightThumb / RightTrigger / Start / Up / X / Y
KeyCode	103件。型のページで全候補を確認できます。

Canvas

宣言・詳説	種類・操作	役割
public void AddGamepadInput(CanvasInputAction action, GamepadButton button)	関数	指定操作へゲームパッド入力を追加する
public void AddKeyboardInput(CanvasInputAction action, KeyCode key)	関数	指定操作へキーボード入力を追加する
public bool BlockInputAfterSubmit	プロパティ（読取・変更）	決定操作後の入力消費を設定します。
public void ClearGamepadInputs(CanvasInputAction action)	関数	指定操作のゲームパッド入力をすべて削除する
public void ClearKeyboardInputs(CanvasInputAction action)	関数	指定操作のキーボード入力をすべて削除する
public bool Enabled	プロパティ（読取・変更）	このComponentの処理を有効にします。GameObject全体のアクティブ状態とは別です。
public GameObject? FirstSelected	プロパティ（読取・変更）	最初に選択するUI GameObjectの保存用IDです。
public static Canvas FromEntity(GameObject gameObject)	関数	既にComponentを持つGameObjectから操作用の参照を作ります。Componentを追加する操作ではありません。
public bool GamepadInputEnabled	プロパティ（読取・変更）	ゲームパッド操作を有効にします。
public bool GamepadLeftStickEnabled	プロパティ（読取・変更）	左スティックによるUI選択を有効にします。
public IReadOnlyList<GamepadButton> GetGamepadInputs(CanvasInputAction action)	関数	指定操作に割り当てたゲームパッド入力を取得する
public IReadOnlyList<KeyCode> GetKeyboardInputs(CanvasInputAction action)	関数	指定操作に割り当てたキーボード入力を取得する
public CanvasInputBlockMode InputBlockMode	プロパティ（読取・変更）	ゲーム入力を止めない・UI操作frameのみ・Canvas有効中から選びます。
public bool InputInEditMode	プロパティ（読取・変更）	Play前のUI操作を許可します。
public bool InputLocked	プロパティ（読取専用）	決定後にCanvas入力がロックされているか
public bool KeyboardInputEnabled	プロパティ（読取・変更）	キーボード操作を有効にします。
public float MatchWidthOrHeight	プロパティ（読取・変更）	解像度追従で幅と高さのどちらを優先するかの比率です。
public CanvasNavigationMode NavigationMode	プロパティ（読取・変更）	自動または指定した配置情報で選択先を決めます。
public int Order	プロパティ（読取・変更）	同じLayer内の並び順です。
public uint PlayerIndex	プロパティ（読取・変更）	操作を割り当てるPlayer番号です。先頭は0です。
public Vector2 ReferenceResolution	プロパティ（読取・変更）	Canvasの配置と拡縮の基準となる幅・高さです。
public bool RemoveGamepadInput(CanvasInputAction action, GamepadButton button)	関数	指定操作からゲームパッド入力を削除する
public bool RemoveKeyboardInput(CanvasInputAction action, KeyCode key)	関数	指定操作からキーボード入力を削除する
public float RepeatDelay	プロパティ（読取・変更）	押し続けてから連続移動が始まるまでの秒数です。
public float RepeatInterval	プロパティ（読取・変更）	押し続けたときの連続移動の間隔です。単位は秒です。
public float ScaleFactor	プロパティ（読取・変更）	UI全体の拡縮倍率です。
public CanvasScaleMode ScaleMode	プロパティ（読取・変更）	基準解像度に対してUIの大きさをどう合わせるかを指定します。
public void SetGamepadInputs(CanvasInputAction action, params GamepadButton[] buttons)	関数	指定操作のゲームパッド入力を置き換える
public void SetKeyboardInputs(CanvasInputAction action, params KeyCode[] keys)	関数	指定操作のキーボード入力を置き換える
public int SortingLayer	プロパティ（読取・変更）	UIを並べる描画Layerです。
public float StickThreshold	プロパティ（読取・変更）	スティックを倒したと判定する閾値です。
public CanvasTransitionTable TransitionTable	プロパティ（読取専用）	行列形式のUI遷移テーブル
public bool TryScreenToLocalPoint(Vector2 screenPosition, out Vector2 localPosition)	関数	GameViewピクセル座標をCanvasローカル座標へ変換する
public bool WrapNavigation	プロパティ（読取・変更）	端の選択から反対側へ移動できるようにします。
public static int componentTypeID	プロパティ（読取専用）	組み込みComponentの接続識別子です。通常のゲームコードではGetComponentで取得します。

継承する共通操作：Component

宣言・詳説	種類・操作	役割
public T AddComponent<T>() where T : Component	関数	ComponentまたはScriptを追加し、操作する参照を返します。
public T? GetComponent<T>() where T : class	関数	component access(owner GameObjectへの委譲)
public T? GetComponentInChildren<T>(bool includeInactive = false) where T : class	関数	子階層から指定型のComponentを探します。
public T? GetComponentInParent<T>(bool includeInactive = false) where T : class	関数	親階層から指定型のComponentを探します。
public T[] GetComponents<T>() where T : class	関数	同じGameObjectにある指定型のComponentをすべて取得します。
public void GetComponents<T>(List<T> results) where T : class	関数	同じGameObjectにある指定型のComponentをすべて取得します。
public T[] GetComponentsInChildren<T>(bool includeInactive = false) where T : class	関数	子階層にある指定型のComponentを収集します。
public void GetComponentsInChildren<T>(bool includeInactive, List<T> results) where T : class	関数	子階層にある指定型のComponentを収集します。
public void GetComponentsInChildren<T>(List<T> results) where T : class	関数	子階層にある指定型のComponentを収集します。
public T[] GetComponentsInParent<T>(bool includeInactive = false) where T : class	関数	親階層にある指定型のComponentを収集します。
public void GetComponentsInParent<T>(bool includeInactive, List<T> results) where T : class	関数	親階層にある指定型のComponentを収集します。
public override int GetHashCode()	関数	同じ値を検索Keyに使うためのHashを返します。
public bool HasComponent<T>() where T : class	関数	指定型のComponentを持つかを調べます。
public void RemoveComponent<T>() where T : Component	関数	指定型のComponentを取り除きます。
public bool TryGetComponent<T>(out T component) where T : class	関数	Componentを検索し、見つかったかをbool、結果をout引数で返します。
public GameObject gameObject	プロパティ（読取専用）	このComponentを所有するGameObjectです。
public Transform transform	プロパティ（読取専用）	所有GameObjectのTransformです。

継承する共通操作：Object

宣言・詳説	種類・操作	役割
public static void Destroy(Object? target)	関数	参照先の個体だけを安全地点で破棄する
public override bool Equals(object? obj)	関数	2つの値が等しいかを調べます。
public override int GetHashCode()	関数	同じ値を検索Keyに使うためのHashを返します。
public static GameObject Instantiate(Prefab original)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static GameObject Instantiate(Prefab original, GameObject? parent)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static GameObject Instantiate(Prefab original, Vector3 position, Quaternion rotation)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static GameObject Instantiate(Prefab original, Vector3 position, Quaternion rotation, GameObject? parent)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original, GameObject? parent) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original, Vector3 position, Quaternion rotation) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original, Vector3 position, Quaternion rotation, GameObject? parent) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static bool operator ==(Object? lhs, Object? rhs)	関数	等値比較を行います。引数型と戻り値型で、成分ごとの演算か対象参照の比較かを確認してください。
public static implicit operator bool(Object? value)	関数	暗黙の型変換を行います。引数型と戻り値型で、成分ごとの演算か対象参照の比較かを確認してください。
public static bool operator !=(Object? lhs, Object? rhs)	関数	不等値比較を行います。引数型と戻り値型で、成分ごとの演算か対象参照の比較かを確認してください。

使用時の注意

入力ブロックはUI操作を止める設定ではありません。割り当てたPlayerのゲーム側入力を止めます。

Play中の変更は実行用Worldへ反映します。Scene編集のUndoと実行中の値の変更は別です。保存方法は編集と実行時変更を参照してください。

関連項目

• 機能の使い方
• Component一覧
• C# API一覧