入力 on Godot 4 レシピ

マウス入力

Mon, 01 Jan 0001 00:00:00 +0000

課題

マウス入力を検出したい。

解決策

InputEventMouse はマウスイベントの基本クラスです。これには position および global_position プロパティが含まれています。このクラスを継承するサブクラスとして、InputEventMouseButton と InputEventMouseMotion の2つがあります。

メモ

インプットマップでマウスボタンイベントを割り当てられるので、is_action_pressed() 関数を使用してこれらを利用できます。

`InputEventMouseButton`

@GlobalScope.ButtonList には、各可能なボタンに対応する定数リスト（例：BUTTON_*）が格納されており、これらの値はイベントのbutton_indexプロパティで報告されます。なお、スクロールホイールも1つのボタンとしてカウントされます - 正確には2つのボタンがあり、それぞれBUTTON_WHEEL_UPとBUTTON_WHEEL_DOWNという別々のイベントとして扱われます。

ヒント

通常のボタンとは異なり、マウスホイールクリックではpressed(押された)イベントのみが発生します。マウスホイールクリックが「離された」というイベントはありません。

func _unhandled_input(event):
 if event is InputEventMouseButton:
 if event.button_index == BUTTON_LEFT:
 if event.pressed:
 print("Left button was clicked at ", event.position)
 else:
 print("Left button was released")
 if event.button_index == BUTTON_WHEEL_DOWN:
 print("Wheel down")

`InputEventMouseMotion`

これらのイベントはマウスが移動するたびに発生します。移動距離（画面座標単位）は「relative」プロパティで取得できます。

以下に、マウス操作による3Dキャラクターの回転動作を実装した具体例を紹介します。

# Converts mouse movement (pixels) to rotation (radians).
var mouse_sensitivity = 0.002

func _unhandled_input(event):
 if event is InputEventMouseMotion:
 rotate_y(-event.relative.x * mouse_sensitivity)

入力アクション

Mon, 01 Jan 0001 00:00:00 +0000

ℹ️ 留意事項

この記事は Godot 3から Godot 4 へ内容の書き換え中です。 Godot4では存在しない変数、関数が含まれている場合があります。もしその場合はリポジトリのIssuesまでご報告ください。

課題

Godotの「入力アクション」システムについて理解を深めたい。

解決策

例えば、見下ろし型キャラクターのゲームを開発していて、InputActionKeyを使って矢印キーで移動操作するコードを書いたとします。すると、多くのプレイヤーが「WASD」スタイルの操作方法を好き好んで使っていることに気づくと思います。後からコードに戻って追加のキーチェックを実装することもできますが、これでは重複した冗長なコードが生じてしまいます。

入力アクションを活用することで、コードの設定可能性を高めることができます。特定のキーをハードコーディングする代わりに、コードを変更せずに動的に調整・カスタマイズできるようになります。

入力の作成方法

入力操作は「プロジェクト設定」の「インプットマップ」タブで定義します。ここでは新しいアクションを作成するか、既存のアクションに入力を割り当てることができます。

タブをクリックすると、すでにデフォルトアクションが設定されていることがわかります。これらはすべて「ui_*」という名前になっており、これがデフォルトのインターフェース操作であることを示しています。例えば、次のUI要素に移動する「Tab」キーなどがあります。

一般的に、既存のアクションを使用するよりも、自分のゲーム用に独自のアクションを作成する方がよいでしょう。

この例では、プレイヤーがキーボードまたはマウスでゲームを操作できるようにしたいとします。プレイヤーは左クリックボタンを押すか、スペースバーを押すことで、射撃ができるようにしなければなりません。

以下の手順で新しいアクション「シュート」を作成してください。

最上部の「アクション」欄に名称を入力します
「追加」（またはEnterキー）をクリックします
画面を一番下までスクロールすると、新しく作成したアクションがリストに追加されているのが確認できるはずです

以下の手順でこのアクションに入力を割り当てることができます。右側にある「+」記号をクリックしてください。使用可能な入力には、キーボードキー、マウスボタン、またはジョイスティック/ゲームパッド入力があります。「キー」を選択したら、割り当てたいキーボード上のキーを押します - ここではスペースバーを押してみます - そして「OK」をクリックして確定します。

「+」をクリックして別の入力を追加してください。今回は「マウスボタン」を選択します。デフォルト設定の「デバイス 0」と「左ボタン」で問題ありませんが、お好みで他のオプションも選択できます。

入力アクションの使用について

以下の方法でアクションをチェックできます。

各フレームごとに単一インスタンス Input をポーリングする方法：

func _process(delta):
 if Input.is_action_pressed("shoot"):
 # This will execute every frame as long as the input is held.

これは、継続的な動作――例えば移動など、常時確認が必要な状況に最適です。

もし代わりに、アクションが発生したその瞬間に検出したい場合は、_input()または_unhandled_input()コールバックを使用できます。

func _unhandled_input(event):
 if event.is_action_pressed("shoot"):
 # This will run once on the frame when the action is first pressed

入力状態を確認するために使える関数があります。

マウスのキャプチャ

Mon, 01 Jan 0001 00:00:00 +0000

課題

マウスカーソルを隠し、ゲームウィンドウからマウス。これは多くの3Dゲーム（および一部の2Dゲーム）で一般的な機能です。

解決策

マウスの状態を設定したい場合は、Input.mouse_modeを使用できます。利用可能なマウスモードは以下の4種類です。

MOUSE_MODE_VISIBLE: マウスが視認可能で、ウィンドウ内外を自由に移動できます。これがデフォルト状態です。
MOUSE_MODE_HIDDEN：マウスカーソルは表示されませんが、マウス操作でウィンドウ外に移動できます。
MOUSE_MODE_CAPTURED：マウスカーソルが非表示になり、ゲームウィンドウの外側にマウスを移動させることができなくなります。
MOUSE_MODE_CONFINED ：マウスは表示されていますが、ゲームウィンドウの外には移動できません。

「キャプチャ」は最も一般的に使用されるオプションです。実行時にマウスモードを設定するには、以下のコマンドを使用できます。

func _ready():
 Input.mouse_mode = Input.MOUSE_MODE_CAPTURED

マウスが捕捉されている状態でも、通常どおりマウス入力イベントは伝達されます。ただし、問題が生じることに注意してください。ゲームを終了したり他のウィンドウに切り替えたい場合、それが不可能になります。このため、「マウス解放」機能も実装しておくと便利です。例えば、プレイヤーがEscキーを押したときにマウスを解放するには。

func _input(event):
 if event.is_action_pressed("ui_cancel"):
 Input.mouse_mode = Input.MOUSE_MODE_VISIBLE

他のウィンドウに表示されている時にマウス操作がゲームに反映されないようにするには、キャラクターコントローラ内で以下を使用してキャプチャ状態を判定できます。

if Input.mouse_mode == Input.MOUSE_MODE_CAPTURED:

マウスボタンを離すと、再びクリック操作を開始するために再キャプチャが必要になります。インプットマップにマウスクリック用のイベントが設定されている場合、以下のように対処できます。

 if event.is_action_pressed("click"):
 if Input.mouse_mode == Input.MOUSE_MODE_VISIBLE:
 Input.mouse_mode = Input.MOUSE_MODE_CAPTURED

マウスクリックで射撃や別のアクションを実行する場合もあるため、イベント伝播を停止させるのは有効な方法です。マウスモード設定後に以下を追加してください。

get_tree().set_input_as_handled()

実行中に入力アクションを追加する

Mon, 01 Jan 0001 00:00:00 +0000

課題

実行時にインプットマップにアクションを追加が必要です。

解決策

通常、入力アクションは[プロジェクト設定]から追加します（詳細はレシピ : 入力アクション参照）。ただし、スクリプト内で直接アクションを追加する必要がある場合もあります。このような場合には、InputMapシングルトンが提供するメソッドが便利です。

以下に、スペースキーを使用して「攻撃」という新しいアクションを追加する例を示します。

func _ready():
 InputMap.add_action("attack")
 var ev = InputEventKey.new()
 ev.keycode = KEY_SPACE
 InputMap.action_add_event("attack", ev)

左マウスボタンも同じ操作に追加したい場合は。

ev = InputEventMouseButton.new()
ev.button_index = MOUSE_BUTTON_LEFT
InputMap.action_add_event("attack", ev)

メモ

InputMap.add_action() メソッドは、同じアクションが既に存在する場合にエラーを発生させます。新しいアクションを追加する前に、まず InputMap.has_action() で確認することをオススメします。

実際の使用例

たとえば、レシピ: プラットフォームキャラクターで作成したプラットフォームキャラクターを別のプロジェクトで再利用したい場合を考えてみます。シーンファイル、スクリプト、およびアセットをすべて単一フォルダに保存していれば、そのフォルダ全体を新規プロジェクトにコピーするだけで済みます。ただし、入力が正常に機能するようにするには、インタラクションマップも編集が必要です。

代わりに、以下のコードをプレイヤースクリプトに追加すれば、必要な入力アクションが自動的に追加されるようになります。

var controls = {"walk_right": [KEY_RIGHT, KEY_D],
 "walk_left": [KEY_LEFT, KEY_A],
 "jump": [KEY_UP, KEY_W, KEY_SPACE]}

func _ready():
 add_inputs()

func add_inputs():
 var ev
 for action in controls:
 if not InputMap.has_action(action):
 InputMap.add_action(action)
 for key in controls[action]:
 ev = InputEventKey.new()
 ev.keycode = key
 InputMap.action_add_event(action, ev)

カーソルのカスタマイズ

Mon, 01 Jan 0001 00:00:00 +0000

ℹ️ 留意事項

課題

ゲーム中のマウスカーソルをカスタマイズしたい。

解決策

マウスカーソルの設定は Input.set_custom_mouse_cursor() メソッドを使用して行います。必要なのは使用するテクスチャだけです。なお、このテクスチャのサイズは最大で 256x256 ピクセル以内にしてください。

例えば、以下の画像を使用するには。

以下で照準をマウスカーソルの中央位置に設定します。

extends Node2D

func _ready():
 Input.set_custom_mouse_cursor(cursor_image,
 Input.CURSOR_ARROW,
 Vector2(64, 64))

第2パラメーターはどのシステムカーソルを置き換えるかを指定します。このパラメーターの全ての一覧は入力ドキュメントを参照してください。

マウスドラッグでユニットを選択

Mon, 01 Jan 0001 00:00:00 +0000

課題

RTS(リアルタイムストラテジー)のように、複数ユニットを選択するためにクリック＆ドラッグしたい。

解決策

リアルタイムストラテジー（RTS）ゲームでは、複数ユニットに同時に命令する事があります。一般的な操作手法として、対象ユニットをマウスでクリックしてドラッグすることで選択範囲を決定。またユニットを選択したら、マップ上をクリックすることで移動コマンドを実行させる事が多いです。

以下に目指すべき例を示します。

ユニット設定

この機能を実際に試すには、基本的なRTSスタイルのユニットが必要です。これらのユニットはターゲットに向かって移動し、互いに衝突しないように設計されています。チュートリアルではこの点について詳しく説明しません。カスタムRTSユニット作成のベースとして使いたい場合は、ユニットスクリプトにコメントが付いています。プロジェクトをダウンロードするためのリンクは以下の通りです。

ワールドのセットアップ

ユニット選択の処理はワールド内で行います。まず「World」という名前のNode2Dオブジェクトを作成し、その中にUnitインスタンスを追加してください。Worldノードにスクリプトをアタッチし、以下の変数を設定してください。

extends Node2D

var dragging = false # Are we currently dragging?
var selected = [] # Array of selected units.
var drag_start = Vector2.ZERO # Location where drag began.
var select_rect = RectangleShape2D.new() # Collision shape for drag box.

※ボックスを描画した後は、その内部にどのユニットが位置しているかを確認する方法が必要となります。 RectangleShape2Dを使用すると物理エンジンに問い合わせて、衝突した対象を確認できます。

ボックスの描画方法

この操作にはマウスの左ボタンを使用します。クリックすることでドラッグが開始され、指を離すと終了します。この作業中に、視認性のために長方形を描いていきます。

func _unhandled_input(event):
 if event is InputEventMouseButton and event.button_index == MOUSE_BUTTON_LEFT:
 if event.pressed:
 # If the mouse was clicked and nothing is selected, start dragging
 if selected.size() == 0:
 dragging = true
 drag_start = event.position
 # If the mouse is released and is dragging, stop dragging
 elif dragging:
 dragging = false
 queue_redraw()
 if event is InputEventMouseMotion and dragging:
 queue_redraw()

func _draw():
 if dragging:
 draw_rect(Rect2(drag_start, get_global_mouse_position() - drag_start),
 Color.YELLOW, false, 2.0)

ユニットの選択方法

選択ボックスが作成できたら、その内部に位置するユニットを特定する必要があります。ボタンを放してドラッグ操作が終了した際には、物理空間クエリを実行して対象のユニットを検索する必要があります。なお、対象となるユニットはCharacterBody2Dですが、Area2Dやその他のボディタイプでも問題ありません。

入力 on Godot 4 レシピ

マウス入力

課題

解決策

InputEventMouseButton

InputEventMouseMotion

入力アクション

課題

解決策

入力の作成方法

入力アクションの使用について

マウスのキャプチャ

課題

解決策

実行中に入力アクションを追加する

課題

解決策

実際の使用例

関連レシピ

カーソルのカスタマイズ

課題

解決策

マウスドラッグでユニットを選択

課題

解決策

ユニット設定

ワールドのセットアップ

ボックスの描画方法

ユニットの選択方法

`InputEventMouseButton`

`InputEventMouseMotion`