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