物理 on Godot 4 レシピ

RigidBody2D で対象物を見る

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

課題

対象物を観察するため、リジッドに滑らかな回転動作をしたい。

解決策

RigidBody2D の操作は少し複雑です。Godot の物理エンジンで制御されるため、直接移動させるのではなく、力を加える必要があります。リジッドボディを扱う前に、RigidBody2D API ドキュメントを読むことを強くオススメします。

物体を回転させるには、回転力であるトルクを加える必要があります。一度物体が回転し始めたら、最終回転に近づくにつれてトルクを小さくしていきたいものです。

これはまさに「内積」が活躍する場面です。その符号からターゲットの位置が左側か右側かを判断でき、絶対値からは我々が向いている方向とターゲット方向との距離を把握できます。

ヒント

ドット積について簡単に復習するには、ベクトル: 内積と外積の使い方をご覧ください。

extends RigidBody2D

var angular_force = 50000
var target = position + Vector2.RIGHT

func _physics_process(delta):
 var dir = transform.y.dot(position.direction_to(target))
 constant_torque = dir * angular_force

ここでtransform.yを使用している理由について疑問に思われるかもしれません。というのも、transform.xはボディの前方ベクトルを表すからです。もしtransform.xを使用していれば、ドット積が最大となるのはボディが完全にターゲット方向を向いている時になりますが、その時点でトルク値をゼロにしたいです。一方、transform.yを使用することで、ターゲット方向に完全に揃っていない状態ほどトルク値が増加するようになります。

リジッドボディを完全にスキップする

リジッドボディを一切回転させないことで、これらの問題をすべて回避できます！代わりに、子スプライトのrotationプロパティをターゲット方向に合わせるように変更してください。lerp()関数やTweenを使用することで、滑らかにアニメーションさせることが可能になります。

多くの場合、これは有効な解決策となります。覚えておいてください。基底体の向きは、付属するスプライトと必ずしも揃える必要はないのです！

CharacterBody3D : 坂道で停止する

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

ℹ️ 留意事項

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

課題

CharacterBody3D が坂道を滑り落ちてしまいます。

解決策

まず、最小限の機能で構成された CharacterBody3D から始め、以下のスクリプトで move_and_slide() メソッドを使用しています。

extends CharacterBody3D

@export var gravity = -10.0
@export var speed = 5.0
@export var rot_speed = 4.0
@export var jump_speed = 5.0

var velocity = Vector3.ZERO
var jumping = false

func get_input(delta):
 var input = Vector3.ZERO
 if Input.is_action_pressed("forward"):
 input += -transform.basis.z * speed
 if Input.is_action_pressed("back"):
 input += transform.basis.z * speed
 if Input.is_action_pressed("right"):
 rotate_y(-rot_speed * delta)
 if Input.is_action_pressed("left"):
 rotate_y(rot_speed * delta)
 velocity.x = input.x
 velocity.z = input.z

func _physics_process(delta):
 get_input(delta)
 velocity.y += gravity * delta

 move_and_slide()

 if jumping and is_on_floor():
 jumping = false

 if Input.is_action_just_pressed("jump"):
 if is_on_floor():
 jumping = true
 velocity.y = jump_speed

傾斜地で動きを止めると、問題が明らかになります。

RigidBody2D で目標位置へ移動

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

課題

リジッドボディを目標位置へ移動させたい。

解決策

物体を移動させるには、特定の方向に力を加える必要があります - これが「力」です。物体が動き始めたら、最終位置に近づくにつれてこの力は徐々に小さくなるようにします。

この場合、まさにVector2.distance_to()関数を使用するのに最適な状況です。この関数を使えばターゲットまでの距離を正確に測定でき、その値を基に適切な力を加えることができます。

# Smoothly move to target
extends RigidBody2D

var linear_force = 5
var target = position


func _physics_process(delta):
 var dist = position.distance_to(target)
 constant_force = dir * linear_force * dist

線形ダンピングを使用

デフォルト設定の RigidBody2D でこの操作を試みると、物体が目標を通り過ぎてしまうことがわかります。これはオブジェクトのLinear/Damp プロパティによるものです（デフォルト値は 1 のプロジェクト設定にあります）。この値は「摩擦」を表しており、力を加えない場合に可動式リジッドボディがどのくらいの速さで停止するかを制御します。この値を大きくすると、物体が目標地点でスムーズに減速するようになります。この値と linear_force がどのように相互作用するかを調整することで、まさに求めている動きを実現できます。

衝突レイヤーとマスク

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

はじめに

衝突レイヤーとマスクは、Godot 4においてどのオブジェクト同士が相互作用するかを制御する上で不可欠な要素です。

システム

Collision Layer(衝突判定レイヤー)：オブジェクトが 存在する レイヤを指定します。
Collision Mask(衝突検知マスク)：オブジェクトが 衝突を検出する 対象のレイヤを指定します。

サンプルプロジェクトでの設定例

ノード	レイヤー	マスク	相互作用
プレイヤー	1	2, 3	敵とコインをスキャン
敵キャラ	2	1	プレイヤーをスキャン
コイン	3	(なし)	特にスキャンする必要がない

セットアップ方法

Godot 4では、プロジェクト設定の［レイヤー名］＞［2D物理］でレイヤーに名前を付けられます。これにより、インスペクターでの管理が大幅に効率化されます。

ノードの選択方法

Godot 4では、ビット操作を容易にするため、get_collision_layer_value(layer_number)とset_collision_layer_value(layer_number, value)を使用することをオススメします。

# Enable layer 2
set_collision_layer_value(2, true)

# Check if masking layer 3
if get_collision_mask_value(3):
 print("Scanning layer 3")

Godot 3から4への移行ポイントまとめ

レイヤー用インスペクタUIが改善されました
set_collision_layer_value()などの新ヘルパーメソッドにより、複雑なビット演算処理(例: 1 << (layer - 1))が不要になりました

動摩擦

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

ℹ️ 留意事項

課題

運動キャラクターに摩擦と加速度を加え、より自然な動きを実現したい。

解決策

多くのゲームにおいて、必ずしも完全な物理シミュレーションを求めているわけではありません。重要なのはアクション性、反応の良さ、そしてアーケードならではの爽快感です。だからこそ、RigidBodyではなくKinematicBodyを選択するのです - これによって物体の動きを直接制御できるようになります。ただし、ある程度の物理的な挙動は必要です。これはつまり、オブジェクトが突然方向を変えたり停止したりしないようにするためです。

以下に、シンプルな運動力学に基づくプラットフォーマーキャラクター用のコードを示します。

extends CharacterBody2D

var speed = 1200
var jump_speed = -1800
var gravity = 4000

var velocity = Vector2.ZERO

func get_input():
 velocity.x = 0
 if Input.is_action_pressed("ui_right"):
 velocity.x += speed
 if Input.is_action_pressed("ui_left"):
 velocity.x -= speed

func _physics_process(delta):
 get_input()
 velocity.y += gravity * delta
 move_and_slide()
 if Input.is_action_just_pressed("ui_select"):
 if is_on_floor():
 velocity.y = jump_speed

このコードを実行すると、キャラクターのx方向速度が瞬時に変化してしまうことに気づくでしょう。これを修正するために、lerp()関数を使用して速度を徐々に増減させるようにします。

`lerp`の使用例

lerp(start_value, end_value, amount)

lerp()（線形補間）は、2つの数値間で「ブレンドされた」値を求める関数です。詳細は補間処理を参照してください。

以下のコードでは、friction(摩擦係数)はキャラクターが停止する速度を、acceleration(加速力)は最大加速するまでの速度を決定する要素です。どちらも値が0.0から1.0の範囲内で設定されます。

get_input()のコードを以下に置き換えます。

var friction = 0.1
var acceleration = 0.5

func get_input():
 var input_dir = 0
 if Input.is_action_pressed("ui_right"):
 input_dir += 1
 if Input.is_action_pressed("ui_left"):
 input_dir -= 1
 if dir != 0:
 # accelerate when there's input
 velocity.x = lerp(velocity.x, dir * speed, acceleration)
 else:
 # slow down when there's no input
 velocity.x = lerp(velocity.x, 0, friction)

解説

friction(摩擦係数)とacceleration(加速力)をブレンド量として使用します。speedには、現在速度から最大速度までの適切な値を求めます。減速時には、現在速度を徐々に0へ減衰させます。

RigidBody2D: ドラッグ＆ドロップ操作

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

課題

マウスでリジッドボディを選択して移動させたい。

解決策

リジッドボディを扱う際には注意が必要です。Godotの物理演算エンジンがこれらの動きを制御しており、これに干渉すると予期しない結果を招くことがあります。重要なのは、オブジェクトのmodeプロパティを活用する点です。これは2Dでも3Dでも同様に適用されます。

ボディ設定

はじめに、リジッドボディオブジェクトを作成します。まずSprite2DとCollisionShape2Dを追加してください。さらに物理特性を設定したい場合はPhysicsMaterialも追加できます。このマテリアルでは Bounce（反発係数） と Friction（摩擦係数） のプロパティを調整できます。

物理演算エンジンの制御から一時的に解放するために、リジッドボディの freeze プロパティを使用します。ドラッグ操作中も移動可能にしておく必要があるため、デフォルト値である「静的モード」ではなく、フリーズモードを「運動学的」に設定します。

体を「pickable」というグループに配置します。この設定により、メインシーンで複数のpick可能オブジェクトインスタンスを使用可能になります。Bodyにスクリプトをアタッチし、その_input_eventシグナルに接続してください。

extends RigidBody2D

signal clicked

var held = false

func _on_input_event(viewport, event, shape_idx):
 if event is InputEventMouseButton and event.button_index == MOUSE_BUTTON_LEFT:
 if event.pressed:
 print("clicked")
 clicked.emit(self)

マウスクリックを検知すると、ボディへの参照を含むシグナルを発報します。複数のボディが存在する可能性があるため、メインシーン側で各ボディがドラッグ可能かどうか、あるいは既に held(ホールド) 状態にあるかどうかを管理する仕組みを設けます。

ボディがドラッグされている間は、その位置をマウスカーソルに合わせて更新します。

func _physics_process(delta):
 if held:
 global_transform.origin = get_global_mouse_position()

最後に、これらの関数はボディがピックアップされた時とドロップされた時に呼び出すものです。freezeをtrueに変更すると物理演算エンジンの処理から除外されます。ただし、他のオブジェクトはこの物体に衝突する可能性がある点に注意してください。もしこれを望まない場合は、ここでcollision_layerおよび/またはcollision_maskも無効化できます。ただその場合、ドロップ時には再度有効化することを忘れないでください。

func pickup():
 if held:
 return
 freeze = true
 held = true

func drop(impulse=Vector2.ZERO):
 if held:
 freeze = false
 apply_central_impulse(impulse)
 held = false

drop関数内では、freezeを再びfalseに設定した後、ボディは物理エンジンの制御下に戻ります。オプションで衝撃値を指定することで、リリース時にオブジェクトを『投げる』機能を追加することも可能になります。

メインシーン

メインシーンを作成し、静的な障害物を配置するか、TileMapを使用して、選択可能なボディのインスタンスを作成してください。

メインシーン用のスクリプトです。まず、シーンで使用可能なすべてのボディに対して clicked シグナルを接続するところから始めます。

extends Node2D

var held_object = null

func _ready():
 for node in get_tree().get_nodes_in_group("pickable"):
 node.clicked.connect(_on_pickable_clicked)

次に、シグナルを接続する関数について説明します。接続された関数ではheld_object変数を設定して現在ドラッグ中のものを記録し、ボディのpickup()メソッドを呼び出してオブジェクトのピックアップ操作を開始します。

CharacterとRigidBodyの相互作用

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

課題

キャラクターのボディをリジッドボディと相互作用させたい場合に使用します。

解決策

メモ

このレシピは2Dノードと3Dノードの両方に同様に適用できます。

デフォルトでは、 move_and_slide() または move_and_collide() で移動させた CharacterBody2D は、衝突する任意の RigidBody2D を押しません。リジッドボディは全く反応せず、単なる StaticBody2D と同じように振る舞います。

場合によってはこれで十分なこともあります。ただし、ボディーを押し出したい場合は、何点か変更が必要です。

この例では、プラットフォーマー用キャラクターレシピで解説されている2Dキャラクターを使用します。この例ではキャラクター移動の最も一般的な方法である move_and_slide() を採用しています。もし代わりに move_and_collide() を使用している場合は、以下の実装を適切に変更してください。

リジッドボディとのインタラクション方法を決定する際には、以下の2つの選択肢があります。

物理を無視して直接押すこともできます。Godot 3.x に慣れている方なら、これは"infinite inertia(無限慣性)“オプションと同等の機能です。
キャラクターの想定する「質量」と「速度」に基づいて押力を発揮させることもできます。これにより「リアルな」結果が得られます - 重い物体は少し、軽い物体は大きく押し出されるようになります。

以下の両方のオプションを試してみます。

無限の慣性力

この設定には長所と短所があります。最大の利点は、追加コードが不要であることです。必要なのはオブジェクトの衝突レイヤー/マスクを正しく設定することだけです。本事例では、以下の3つの物理レイヤを定義しています。

硬体オブジェクトについては、「アイテム」レイヤー（レイヤー3）に配置し、マスクはデフォルト設定のまま全レイヤーを覆う状態にしています。

次に、プレイヤーを「プレイヤー」レイヤー（レイヤー2）に配置し、マスクを設定して「アイテム」を無視するように構成しました。

ゲームを実行してみると、ボックスを自由に移動できることがわかります。なお、箱の質量は関係ありません。すべて同じように押されます。

このオプションの欠点もここに現れています。箱の物理演算が無視されているため、壁を貫通したり、上に乗ることすらできません。

一部のゲームではこれで問題ありませんが、オブジェクトのめり込み（クリッピング）を防ぎたい場合は次の方法を試してみてください。

インパルスの適用方法

衝突する物体に「押し」を与えるには、インパルスを適用が必要です。インパルスとは「瞬間的な衝撃的の力」のことで、野球でバットがボールを打つようなイメージです。これは、物体に対して連続的に力を加えるのとは異なります。

# This represents the player's inertia.
var push_force = 80.0

func _physics_process(delta):
 # after calling move_and_slide()
 for i in get_slide_collision_count():
 var c = get_slide_collision(i)
 if c.get_collider() is RigidBody2D:
 c.get_collider().apply_central_impulse(-c.get_normal() * push_force)

衝突時の法線ベクトルはリジッドボディの外側を指しているため、これを反転させてキャラクターから離れる方向に調整し、push_force 係数を適用します。これで再び押す動作が可能になります。なお、壁越しにリジッドボディを移動させることはできません。

2Dジョイントを使う

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

ℹ️ 留意事項

課題

GodotのJoint2Dノードについて理解したい。

解決策

ジョイントは、接続された物理オブジェクトの動きを制限するために使います。任意のジョイントノードには、PhysicsObject2D から拡張される2つのボディを結合が必要です。

プロパティ

これらのプロパティはすべての関節ノードに共通です。

Node A and Node B：割り当てられた物理ボディ
Bias：両オブジェクトが離れる方向に関節が引き寄せる速度。デフォルト値は 0 です
Disable Collisions：接続されたオブジェクト間の衝突を考慮しないようにできます。デフォルトは true（有効）です

以下の3種類の Joint2D があります。すべての例で、1つの RigidBody2D がジョイントを介して StaticBody2D に接続されています。画面で「コリジョン形状を表示」が有効化されているため、ジョイントの表現を確認できます。

PinJoint2D

「ピン接合」は、2つの部材を1点で接続し、自由に回転できるようにします。

ピン接合部の Softness プロパティにより、接続にある程度の「弾力」が与えられます。この値はデフォルト値の 0（移動不可）から最大値 16 まで設定できます。

DampedSpringJoint2D

この継手はスプリング状の力によって2つの部材を連結します。

以下のプロパティでスプリングの挙動を調整できます。

Length : 関節の最大許容長値
Rest Length : 外力や運動が作用していない状態における関節の長さ
Stiffness : ばねの「伸びにくさ」、すなわち外力に対する抵抗強度を表す指標
Damping : ばねが「反発動作」を停止する速度特性を示すパラメータ

GrooveJoint2D

この関節は、接続された物体が直線的に移動するように制約します。

コンベアベルト

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

ℹ️ 留意事項

課題

キャラクターまたはリジッドボディを移動させるコンベアベルトオブジェクトを作成したい。

解決策

constant_linear_velocity プロパティを使用することで、StaticBody2Dだけでコンベアベルトオブジェクトを作成できます。

メモ

この問題を3D環境で解決する方法については以下を参照ください。

以下に具体例を示します。StaticBody2DとRigidBody2Dを使用しています。追加コードは一切ありません。スタティックボディの線速度一定は (200, 0) に設定されています。

ベルトの動きをアニメーション化

コンベアベルトの「外観」を表現する方法は、使用するアートアセットによって異なります。今回のデモプロジェクトでは、以下の単一サイズ88×88ピクセルのタイルマップのみを使用しています。

スタティックボディに Sprite を追加し、 テクスチャ セクションで「新規AtlasTexture」を選択してください。

タイルテクスチャをプロパティのTexture項目に配置し、Regionを(0, 0, 880, 88)に設定してください。

880を選択すれば、幅が正確に10タイルのコンベアベルトを作成できます。必要な幅を自由に設定できます。

ヒント

画像が繰り返されていない、または表示がおかしい場合、リピート フラグを「有効」に設定して再インポートしてください。

Region プロパティの x の値を調整してみてください。タイルがずれるのが確認できるはずです。これがベルトのアニメーションに必要な動きです。このアニメーションは AnimationPlayerを使用するか、コードで実装するかです。ここでは後者の方法を実演します。

extends StaticBody2D

@export var speed = 100

func _ready():
 constant_linear_velocity.x = speed

func _process(delta):
 $Sprite.texture.region.position.x -= speed * delta

このコードは、ベルトが目標速度で動作することと、アニメーションが物理効果と同期することを保証します。注意点として、方向は反対になっています。領域の x 値を増やすと画像は左方向に移動します。

アステロイド風物理演算（RigidBody2Dを使用）

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

課題

「Astroids」のような半リアルな宇宙船を作成するため、RigidBody2Dを使いたい。

解決策

RigidBody2D を使用する際には少し注意が必要です。Godotの物理エンジンによって制御されるため、直接移動させるのではなく力を加える必要があります。リジッドボディを扱う前に、RigidBody2D APIドキュメントを必ず確認することを強くオススメします。これからこの例を進めていく過程で、このドキュメントを参照しながら進めていきます。

本例では、以下のノード設定を使用します。

 RigidBody2D (Ship)
 Sprite2D
 CollisionShape2D

Spriteの向き

必ずスプライトを正しく配置してください。回転していないオブジェクトは +X軸 方向に向くようにしてください（つまり右方向を向いている状態）。スプライトのアートワークが別の方向を向いて描かれている場合は、 Sprite2D（親ボディではなく）を適切に整列させるために回転させてください。

以下の入力を「インプットマップ」で使用します。

アクション	キー
`thrust`	w または ↑
`rotate_right`	d または →
`rotate_left`	a または ←

RigidBody2Dにスクリプトを追加し、変数を定義します。

extends RigidBody2D

@export var engine_power = 800
@export var spin_power = 10000

var thrust = Vector2.ZERO
var rotation_dir = 0

最初の2つの変数は、船の「操縦性」を制御する方法を決定します。engine_powerは加速と最高速度に影響を与えます。spin_powerは船が回転する速さを調整します。

thrust と rotation_dir は入力操作によって設定されます。次にその方法を確認してください。

func get_input():
 thrust = Vector2.ZERO
 if Input.is_action_pressed("thrust"):
 thrust = transform.x * engine_power
 rotation_dir = Input.get_axis("rotate_left", "rotate_right")

もし"thrust"入力が有効になっている場合、thrustベクトルを船の進行方向に設定します。一方、rotation_dirは回転入力に応じて +/-1 に設定されます。

これらの値を _physics_process() で適用することで飛行を開始できます。

func _physics_process(_delta):
 get_input()
 constant_force = thrust
 constant_torque = rotation_dir * spin_power

動作はしますが、コントロールが非常に難しいのがお分かりでしょう。回転速度が速すぎて、画面外へ出る前に急激に加速してしまいます。ここで「実際の」宇宙物理の法則から脱却したい点があります。宇宙空間には摩擦がありませんが、弊社開発の『アステロイド』風宇宙船の場合、推力をかけていない時には自然に減速するようになれば、より簡単に操縦できるようになります。この制御には「減衰効果」が有効です。

物理 on Godot 4 レシピ

RigidBody2D で対象物を見る

課題

解決策

リジッドボディを完全にスキップする

関連レシピ

CharacterBody3D : 坂道で停止する

課題

解決策

RigidBody2D で目標位置へ移動

課題

解決策

関連レシピ

衝突レイヤーとマスク

はじめに

システム

サンプルプロジェクトでの設定例

セットアップ方法

ノードの選択方法

動摩擦

課題

解決策

lerpの使用例

解説

RigidBody2D: ドラッグ＆ドロップ操作

課題

解決策

ボディ設定

メインシーン

CharacterとRigidBodyの相互作用

課題

解決策

無限の慣性力

インパルスの適用方法

2Dジョイントを使う

課題

解決策

プロパティ

PinJoint2D

DampedSpringJoint2D

GrooveJoint2D

コンベアベルト

課題

解決策

ベルトの動きをアニメーション化

アステロイド風物理演算（RigidBody2Dを使用）

課題

解決策

`lerp`の使用例