Godot勉強メモ

※ここではGodotの概要、仕様やGodotを利用したゲーム制作全般に関連した内容をまとめる。

関連記事

エンジン仕様

フリー、オープンソース、商用可能、売上でライセンスが変わったりもしない。

IDE上で編集するタイプ。マウスで視覚的に編集できる。

テキストエディタ内蔵だがVSCodeとも連携でき、拡張も用意されている

3Dもいけるがどちらかというと2Dのほうが強い

ビルドインのAssetLib（Unityで言うアセットストア）がある。数は少ない。

独自スクリプト言語GDScript（一応他の言語もいける）

筆者の個人的な印象

テキストエディタは高性能だが、ウィンドウパネルに問題がある気がする

現在開いているシーンと関係ないスクリプトを編集できてしまうので混乱しやすい。スクリプトエディタの上にシーンを切り替えるタブがついてる（このタブは2D/3Dビューのためのものだが、同じパネルでスクリプトエディタを入れてしまっている）のが一番の混乱のもとだと思う。スクリプトは別パネルであるべき。ちなみにスクリプトエディタはフローティングできるので、本当はこの状態がベストな気がする。

2Dゲームを作っている最中は3Dエディタはほぼ使わないのだが、開けて便利なときがあるのだろうか？

逆のケース、3Dゲーム制作中にUIなどの2D設計を行うことはあるが…。

筆者はUnityとUnrealEngine4を触ったことがある（どちらも少し前なので最新版では違うかも）ので、記憶を頼りに比較してみると、UnityとUEよりも…

2Dゲームに向いている。

2Dシーンの画面の基本単位はピクセル(整数)。3D座標系(実数)で擬似的に2Dを動かしているUnityやUEとは違って画面制御がしやすくわかりやすい。

Unityよりも…

👍️UIが見やすい。

👍️エディタが高性能。

👍️ライセンスに不安がない。

👎️AssetStoreと比べてAssetLibは物足りない。

UEよりも…

👍️エディタが軽い。起動が速い。

👍️アカウントがいらない。ログインがいらない。

👍️（特にカスタマイズせずとも）ビルドサイズが小さい。

👎️UEのノードプログラミングにはお手軽さでは負ける

用語

ゲーム内に存在するすべての要素。

Unityで言うところのGameObject。Unreal Engineでいうところのアクタやポーン。

(余談)オブジェクトなのにシーン（場面）と呼ぶことに最初違和感あったが、シーンはレイヤーのようなもので、キャラクター個々ではなくキャラクターが動き回る空間全体を管理している、と考えると理解しやすいかもしれない。

シーンに含まれている項目。画像、アニメーション、効果音、当たり判定のBOXなど。

スクリプトはノードにくっつける。

ノードの追加のショートカットはCtrl+A。

いわゆるイベント。キーが押されただとか、キャラクターが衝突したとか、フレームが更新されたとかのたびに発行される。当文書では「発火」という言葉をよく使う。

メインシーン

ゲーム起動時に最初に開かれるシーン。

ゲーム全体を管理し、このなかにタイトル画面、キャラクターやステージやUIなどの子シーンが入る。

基本的にはNode2D/3Dシーンをひとつ作ってこれをメインシーンに設定する。

メインシーンは「プロジェクト」＞「プロジェクト設定」画面で設定する。メインシーンが無い状態で実行しようとしたときはメッセージが出て設定させられる。

スクリプト

GDExtensionを使用することで、上記以外にもRust、D、Haxe、Swiftなどのコンパイル言語を使用できるが非公式。（pythonやluaやJavascirptなどのインタプリタ言語には通常対応しない…が、Codonとか使ってコンパイル済ならいけるのか？）

IDE雑多メモ

ショートカット

選択したものを中心に移動する: F

シーンの複製: Ctrl+D

テストプレイ中にコリジョン形状を表示する（デバッグ）

メニュー＞デバッグ＞コリジョン形状を表示

ドット絵がボケる

プロジェクト設定＞一般＞レンダリング＞テクスチャ＞デフォルトのテクスチャフィルタがLinerになっているならNearestにする

ゲームウィンドウ設定

ウィンドウサイズ（ビューポート)の変更

プロジェクト設定＞表示＞ウィンドウ＞サイズ

ウィンドウのアスペクト比を固定

プロジェクト設定＞表示＞ウィンドウ＞ストレッチ＞アスペクト＞Keep

画面解像度について

ターゲットがPCで、ユーザーが任意にウィンドウサイズをいじれるようにするつもりがないなら以下のようにすれば良い

サイズ＞ビューポートの幅／高さ：1920 x 1080 以下の16:9

モード＞Windowed

初期位置タイプ: Center Primary Screen

サイズを変更可能: オフ

ストレッチ

モード: viewport

アスペクト: Keep

スケール: 任意

スケールモード: ドット絵ならinteger, 3Dならfractional

他シーンのインスタンス化

インスタンスのプロパティの扱い

個別のインスタンスのプロパティを書き換える

エディタのインスペクタ上で変更する

プログラム上で実行時にプロパティを書き換える

同じインスタンスを持つシーンすべてを書き換える

*.tscnを開いて編集する

IDE上でインスタンス化

左上の🔗ボタンを押す

選ぶ

CTRL+Dで複製

ソースでインタラクティブにインスタンス化

code:gd:Player

signal shoot(direction: Vector2, location: Vector2)

const BULLET_SPEED = 500.0

...

func _input(event:InputEvent):

if event.is_action_pressed("shoot"):

var pos = ($ShotMarker as Marker2D).global_position

shoot.emit(Vector2(1.0,0.0)*BULLET_SPEED, pos)

code:gd:Stage

const BulletScene = preload("res://player/Bullet.tscn") # *.gdではない

# プレイヤーキャラから弾の発射要求を受け取った時

func _on_player_shoot(velocity: Vector2, location: Vector2):

var spawned_bullet:Bullet = BulletScene.instantiate()

spawned_bullet.rotation = velocity.angle()

spawned_bullet.position = location

spawned_bullet.velocity = velocity

add_child(spawned_bullet)

GDScript

概要

Godot独自言語。

書き味はPython。

高速に動作するがコンパイルされたC#/C++には速度では叶わない。

プロジェクト内に複数言語の同居ができるので、速度にクリティカルな部分のみC#/C++で書き、それ以外をGDScriptで書くことを公式にオススメしている。

ガベージコレクションは無いが、メモリ管理はエンジン側で行うため気にする必要はない（自前で制御もできる）。

内部でC++に変換されているらしい（たまにC++側のエラーが出てくることがある）

言語仕様

インデントでブロックを区切る。

文末（区切り）記号は無し。

code:gd

enum DIRECTION {

right,

left

}

辞書(オブジェクト,構造体)は

code:gd

d = {

22: "value",

"some_key": 2,

"more_key": "Hello"

}

# lua風

var d = {

test22 = "value",

some_key = 2,

more_key = "Hello"

}

code:gd

match <式>:

<値>:

<文>

_:

<デフォルト文>

# breakは不要

code:gd

for i in range(10):

if ...:

break

for i in range(5, 10, 2):

if ...:

continue

for s in strings:

print(s)

for key in dict:

var i = 0

while i < strings.size():

i += 1

引数、戻り値の型指定ができる。

引数のデフォルトを指定できる(python風)。ただし呼び出し側で引数名指定はできない(python風じゃない)

code:gd

# 型指定、デフォルト値指定

func do_something(enabled:bool, label:String="default"): -> void

pass

do_something(true, "some text") # OK

do_something(false, label="some text") # エラー

ノードのプロパティはインスペクタータブ内では「Title Case」（タイトルケース）で表示するが、GDScriptコード内では「snake_case」（スネークケース）で扱う

クラスを調査する方法

code:gd

if object is Smashable:

object.smash()

でもわざわざこれでチェックしても警告は取れないことが多い…

code:gd

if object.has_method("smash"):

object.smash()

なおGDscriptでは型チェックをせず直接呼んでも問題にならないらしい（ダック・タイピング）

code:gd

object.smash()

code:gd

var ap:AnimationPlayer = $AnimationPlayer

ap.play("jump")

型にまつわる警告

code:gd

# ヒットエリア（食らい判定）の処理

# areaはAttackArea2DかItemArea2Dのどちらかが来る。(基底クラスはどちらもArea2D)

func _on_area_entered(area: Area2D):

# -----------------------------------------------------------------------

# AttackArea2Dにattack_powerというパラメータがあるのでそれを取得したい。

# 型が不定でも（プロパティが存在しなくても）エラーにならずに参照する方法→get("プロパティ名")

# 存在しなければnullが返る。

# どちらかというと「特定の型」ではなく、「特定のプロパティ名を持ついくつかの型」に対応したい時に使う

var ap = area.get("attack_power")

if ap:

var attack_power = (ap as int)

# -----------------------------------------------------------------------

# AttackArea2Dにremove()というメソッドを持っているのでそれを実行したい。

# なにも考えずに直接実行。一応コレでも動く。ただし警告がでる。実行時エラーの可能性もある。

area.remove()

# The method "remove()" is not present on the inferred type "Area2D" (but may be present on a subtype).

...

# メソッドが存在するか確認してから実行。実行時エラーはなくなる（引数とかが合ってれば）が、警告は出たまんま。

if area.has_method("remove"):

area.remove()

# The method "remove()" is not present on the inferred type "Area2D" (but may be present on a subtype).

# -----------------------------------------------------------------------

# いっそ直接変換してしまえば上記手間はなくなる

# AttackArea2D.gd の先頭に class_name AttackArea2D が必要。たまにクラス名を認識してくれない時がある

if area is AttackArea2D:

var aa:AttackArea2D = (area as AttackArea2D)

var attack_power = aa.attack_power

aa.remove()

注釈

変数をプロパティ化し、インスペクタで変更できるようにする

@export var <プロパティ名> = <初期値>

code:gd

@export var speed: int = 400

code:gd

var my_label

func _ready():

my_label = get_node("MyLabel")

これが面倒くさい場合

code:gd

@onready var my_label = get_node("MyLabel")

シーン仕様

１シーン１ファイル（*.tscn)

シーンはクラスである。

code:gd

var count = 0 # OK

var my_label = get_node("MyLabel") # NG。nullが返る

@onready var my_label = get_node("MyLabel") # OK

ノード自身と子ノードの準備が完了したときに実行される。ゲームの初期化は基本的にここで行う。

注: _ready はrequest_readyを使用すれば再度呼び出せるが、その他の方法、例えば一度ツリーから削除してもう一度追加しても呼び出されることはない。

code:gd

func _ready():

var timer = get_node("Timer")

timer.timeout.connect(_on_timer_timeout)

_readyにゲームの初期化を直接書くのではなく、初期する関数を別に作って_readyから呼ぶのが良さそう。そのほうがリトライもしやすくなる。

code:gd

func _process(delta):

rotation += PI * delta

_process()と_physics_process()は別に平行に動いている。

負荷がかかったりして描画フレームが遅れる場合でも、より正確な物理計算結果を出すために_physics_processは一定タイミングを保とうとする。基本的な入力やアニメーションや判定処理など場合によって重くなりそうな処理は_processに記述し、移動や物理に関わる処理のみなるべくコンパクトに_physics_processに書くのがよさそうだ

なおArea2Dなど物理がないノードでも_pysics_processは動いている。ゲーム内の他の場所で物理(Rigidbody)による移動計算が行われている場合、齟齬がないようにこちらを使うほうがよさそう

これはキーやボタンが押された/離された瞬間（ジャンプとか攻撃とか）を検出するのに向いている。押しっぱなし（移動とか）の検出は_process内でInputを使う方が良い

ため攻撃はどうするのか考え中

システム周りのキー操作は_unhandled_key_input、それ以外は_unhandled_inputを使うのがよさそう

システム周りのキー操作とはESCでポーズ（もしくはゲーム終了）、Alt+Enterで全画面表示、などゲーム内容に関係なく割とクリティカルなやつ

マウス操作とかも_unhandled_inputで取れる

シーン内のノードを参照系

ノードが見つからない場合は null を返します

code:gd

var timer = get_node("Timer")

timer.timeout.connect(_on_timer_timeout)

# あるいは

$Timer.timeout.connect(_on_timer_timeout)

code:gd

func _ready() -> void:

# ステージ内のすべての敵ノードの「弾発射」シグナルを接続する

for node in childrenNodes:

if node is Enemy:

(node as Enemy).enemy_shoot.connect(_on_enemy_enemy_shoot)

シグナル

エディタからシグナルの接続

インスペクターの隣にノードパネルがある。

シグナルタブで選択しているノードのシグナル一覧が見える。

ダブルクリックしてスクリプトに接続する。

接続すると以下の関数がソースに追加される。

code:gd

func _on_button_pressed():

pass # Replace with function body.

ソースからシグナルの接続

<ノードオブジェクト>.<シグナル名>.connect(<関数名>)

code:gd

func _ready():

var timer = get_node("Timer")

timer.timeout.connect(_on_timer_timeout)

func _on_timer_timeout():

visible = not visible

カスタムシグナル

signal <シグナル名>

<シグナル名>.emit(<渡すパラメータ>)

シグナル名は通常、過去形の動詞を使用。

code:gd

signal health_depleted

...

func take_damage(amount):

health -= amount

if health <= 0:

health_depleted.emit()

シグナルの発火をその場で待つ

await <シグナル>

code:gd

print("Timer started.")

await get_tree().create_timer(1.0).timeout

print("Timer ended.")

座標系

2Dの座標単位はピクセル。

位置、加速度は Vector2。

3Dの座標単位はメートル。

角度はラジアン。（度数に対応したプロパティもある）

ベクトル(Vector2)

code:gd

var location = Vector2(100.0, 200.0)

ノーマライズとは長さを1に揃えること。これを単位にして移動スピードをかけることで、斜めに入ったときに加速することを防ぐ。例えば(1,0)、(0,1)のベクトル長さは1だが、(1,1)のベクトル長さは√2(1.414...)になってしまうのでノーマライズが必要になる

code:gd

if velocity.length() > 0:

velocity = velocity.normalized() * speed

2D基本

Node2D.transform

コリジョン(衝突判定)

Shapeプロパティでコリジョンの形状を指定

Collision>Layer: 自分が所属するグループ

Collision>Mask: 衝突判定をするグループ

プロジェクト設定 → Layer Names でグループの名前をわかりやすいように変更できる

衝突判定はArea2Dの以下のシグナルで行う。

両方がArea2Dを持っている場合は両方同時にシグナルが発火する。

???Body2Dには衝突検知シグナルがないため、必ずArea2D側で処理することになる。

コリジョンの無効化の方法

海外掲示板を見てたら「コリジョンのサイズをゼロにした」ってのもあった。そういうのもあるのか…。

タイルマップ

ステージを作ったりする

TileMapを追加する。

TileSetを作る。

プロパティからあらかじめタイルの大きさを設定しておく。

プロパティから新規Tilesetを作る。

IDE下のTilesetパネルを開く（TileMapパネルではない）

＋ボタンを押して新規アトラスを追加。画像をロード。自動的にタイル分けされる。

タイルとして使いたくない領域がある場合は右クリックして削除する。

TileMapパネルに移動し、ステージを作成する。

クリックで設置、Eで削除、Pでスポイト

Cキー、Vキーで左右上下反転、X,Zで90度回転できる。（v4では代替えタイルは必要なくなった)

このままだとコリジョンがないためキャラクターはすり抜けてしまう。

TileMapのインスペクタのTileSetのPhysics Layerを追加する。

ここで衝突するかすり抜けるかのグループ設定ができる

TileSetパネルで適当にタイルを選択し、選択＞物理＞PhysicsLayer0であたり判定のポリゴンを設定できるようになる。

Shiftキーで複数のタイルを選択して一度に同じ当たり判定を設定できる。

タイル全面が当たり判定ならFキーを押す。

左クリックでポイント追加、右クリで削除。

微妙な数ドットを調整するくらいならグリッドスナップを活用したほうがよい

レイキャスト（遮蔽物判定）

レイキャストは他ゲームエンジンでも搭載されている機能で、地点Aから地点Bまでの直線上になにかが存在しているか/なにもないかを判定する機能。これによって、例えば「移動先（足元）に地面があるか」「敵からプレイヤーが視認できるか（敵の視界に入ったか）」を判定でき、特に敵の行動パターン（敵AI）の判断材料などに使われる。レイ（光線）を当てて光が届いたかどうかを確認する様に似ていることからレイキャストと呼ばれる。

特に「普段はじっとしている（あるいは決まった巡回ルートを移動している）が、プレイヤーが視界に入ったら襲ってくる」という敵行動パターンは鉄板で、この処理と地形があるだけで鬼ごっこゲームが成立する。

アニメーション

インスペクターからAnimation＞SpriteFramesに「新規SpriteFrames」を設定

IDE下部のパネルにアニメーションパネル。

アニメーションごとにセルを追加する

連番画像を使う場合

スプライト シートを使う場合

網目アイコン(🏁）をクリックして画像をシートとして読み込む。

ウィンドウが出てフレームの大きさ調整ができる。

フレームをクリックした順番にセルが登録される。

再生ボタンでアニメの確認。

再生速度は「ト(FPS)」で指定

プロパティのTextureにスプライトシートをロードする。

Animationプロパティでフレームの大きさを設定する。

Frameを変更して絵が切り替わることを確認する。

アニメーションをクリックして「新規」

トラックの右上の数値が長さ（単位：秒）、その隣がループの有無　を設定

Sprite2D側のフレームを変更しながら、横の鍵🔑マークを押して登録していく。

登録するごとにアニメーションパネル側のフレームは先に進むのでプロパティパネル側を操作するだけで次々登録していける。

アニメーションごとに表示位置をずらしたいとき

トラックを追加ボタンを押して「プロパティトラック」を追加する。（しなくてもOK）

Sprite2Dのオフセットを開く。

アニメーションフレームを表示し、ずらしたいフレームでオフセット値を調整して🔑ボタンをおしてキーフレームを登録する。

AnimationPlayerをあらゆる条件にそって操作するノード

AnimationTreeはTransitionやBlendなどの分岐ができるノードを使って各アニメーションを接続する。スクリプト上で各分岐ノードにパラメータを与えることで選択させる。

$Animation_tree.set("<パラメータパス>", <値>)

code:gd

# トランジションの分岐をstate_2に切り替えることを要求する

$Animation_tree.set("parameters/Transition/transition_request", "state_2")

シェーダー

GLSLの書き味はJavascriptっぽい感じ。

超簡易シェーダーの例：キャラクター画像の色を変える

Sprite2Dを用意する。あらかじめ適当な画像ファイルをTextureにロードしておく。

CanvasItem＞MaterialのMaterialに新規ShaderMaterialを作成。

さらにShaderを作成。ファイル名は*.gdshader。内容は以下（スクリプトエディタではなくその下のシェーダーエディターで編集を行う）。

code:gdshader

shader_type canvas_item;

void fragment() {

COLOR.r = 1.0;

}

実行して表示してみると画像が赤っぽくなってるはず。

状態検知ノード

タイマー（時間が経過したかの判定）

code:gd

func _ready():

$Timer.wait_time = 3.0

$Timer.start()

...

func _on_timer_timeout():

print("timeout")

短い間、一時停止する必要がある場合は、Timerノードを使用する代わりに、SceneTreeの create_timer() 関数を使用します。 これは、遅延させるのに非常に役立ちます。

code:gd

# この場で3秒待つ

# 他の処理は平行して動いており、ゲーム全体を停止させるわけではないことに注意

await get_tree().create_timer(3.0).timeout

画面内に存在しているか(出ていったか)の判定

VisibleOnScreenNotifier2D

入力

Godotでは、プレイヤーの入力を処理するために、主に2つのツールが用意されています。

組み込みの入力コールバック。主に _unhandled_input()です。例えば Space を押してジャンプするような、毎フレームで発生しないイベントに反応するために使用するツールです。

Inputシングルトン。これは、毎フレーム入力があるかどうかを確認するのに適したツールです。

Input

code:gd

var direction = 0

if Input.is_action_pressed("ui_left"):

direction = -1

if Input.is_action_pressed("ui_right"):

direction = 1

InputEvent

Node._unhandled_input(<InputEvent>)

他の箇所で拾われていないキーイベントに反応する。例えばステータス画面表示中などでGUIが表示中でキーで操作可能になっている最中は反応しない。ゲームでは一般的にGUIが表示中ならそちらが優先されるべきだからである。

入力キーの種類

カメラ

基本的にはCamera2Dをプレイヤーキャラクターの子に追加しておけば、カメラ（視点）は勝手にプレイヤーを追従する。

ユーザーインターフェース/HUD

Sprite2Dなど描画オブジェクトを持つシーンの「表示」を管理する。以下のような設定ができる

Layer: 表示順、奥行き。

Follow Viewport: カメラに追従するか否か。

つまり、CanvasLayerを利用して「表示順が位置番手前で」「カメラに追従しない（画面固定）」レイヤーを作れば、HUDやUIとして利用できる。

フォントの変更: Theme Overrides＞Font, Font Sizes

背景

ParallaxLayerはSprite2Dを子ノードに必要とする

motion_mirroring: 繰り返しの幅（名前のくせにミラーされない…と公式ドキュメントにも書いてある）

motion_offset: 視差ズレ幅

motion_scaling: 視差拡大率

特にスクリプトなど必要とせず、置いておけば勝手に背景として機能するようだ

スクロールしない画面固定の背景（空など）を置きたいならCanvasLayerを使う。

サウンド

AudioStreamPlayer2D

オーディオは ループしない状態でインポートされる。ループさせたい場合は「Stream」プロパティの矢印「v」をクリックして「ユニーク化」を選択し、「Loop」にチェック。

パーティクル

ParticleProcessMaterialを新規作成

なんか小便みたいに出てくる

Textureを設定

Time>Lifetimeで消えるまでの時間を設定

ProcessMaterial内で細かく設定

セーブデータ

リソース(JSONファイルなどの読み込み)

バイナリパック化されるので効率的。

ユーザーによる安易な改竄を防げる（完全に改竄を防げるわけではない）

プロパティで直接参照できる

参照はエンジンの管理化に置かれるので明示的にファイルハンドルやメモリを開放する必要がない

キャッシュが効く（最初の１回だけ読み込まれ、以降は何度読み込んでも負荷がかからない）

作成方法

ファイルシステムを右クリックして「新規作成＞リソース」

JSONを検索、選択して「作成」

名前をつけて保存。拡張子は「.tres」になる

エディタ上で編集できる。JSON形式に従う。

例：チュートリアル用に、キャラクターが重なったときにメッセージが表示される看板を作る場合

code:json://dialogue/turorial.tres

[

"左右移動: 左スティック／カーソルキー",

"ジャンプ: Aボタン/Zキー"

]

code:gd

...

const tutorial_text_resource = preload("res://dialogue/turorial.tres")

...

func _on_area_entered(_area: Area2D) -> void:

$CanvasLayer.visible = true

...

func _on_area_exited(_area: Area2D) -> void:

$CanvasLayer.visible = false

全画面モード

code:gd

func _unhandled_key_input(event):

if event.is_action_pressed("full_screen"):

swap_fullscreen_mode()

func swap_fullscreen_mode():

if DisplayServer.window_get_mode() == DisplayServer.WINDOW_MODE_FULLSCREEN:

DisplayServer.window_set_mode(DisplayServer.WINDOW_MODE_WINDOWED)

else:

DisplayServer.window_set_mode(DisplayServer.WINDOW_MODE_FULLSCREEN)

フルスクリーンがちゃんと拡大されず黒帯になるのは調査中

ESCキーで即時終了

この場合、ESCキーはキーカスタマイズの対象にしないほうが安全な気がする

code:gd

func _unhandled_key_input(event):

if event is InputEventKey:

if event.pressed and event.keycode == KEY_ESCAPE:

get_tree().quit()