「GDScript」の記事 - Crieit

GDScript を覚えようぜ（＾～＾）？

2023-09-30T00:02:50+09:00

親記事から来た

📖　Godot って何だぜ（＾～＾）？

はじめに

「　👇　GDScript の説明は　下のリンク先にあるぜ」

📖　Godot Engine 4.2の日本語のドキュメント / スクリプト言語

ノード

「　👆　Godot にあるものは全て　ノード（Node）で、
GDScript というのは　そのノードを操作するものみたいだな」

Python に似ているが全然別物

「　GDScript は Python に似ているが　全然別物ということだぜ。
新しく覚え直せだぜ」

「　また、GDScript の実行速度は遅いらしいぜ。
GDScript は C++ 言語で書かれたプログラムを呼び出すから、内部的な処理は速いらしいぜ」

「　Python と同じ生き方してんな」

Godot の独特な用語：　シーン

「　👇　Godot には　ノードと　シーンという用語が出てくるんだけど、
計算機科学の　わたしたちから見ると　造語のクセがあるわよ」

📖　ノードとシーン

「　えーと、つまり」

.
「　👆　グラフセオリー（Graph Theory；グラフ理論）の一題材の　ツリー・ストラクチャー（Tree Structure；木構造）を
わたしたちは　知っているが」

「　👆　Godot は　ツリーのことを　シーン（Scene）と言い換えているのかだぜ？」

「　多分そう」

「　👆　さらに　計算機科学の　わたしたちは　木の中に含まれるサブツリー（Subtree；部分木）を知っているぜ」

「　部分木もまた　木よね」

「　👆　Godot では、シーンもまた　ノードになる、という　言い方　をしている」

「　じゃあ　シーンは　ツリーなんだ」

「　シーン、つまり　サブツリーのファイルの拡張子は　.tscn　のようね」

「　なんて発音するか分からん嫌な拡張子だ……　ティーシーン？」

「　Godot は、 .tscn を再生するプレイヤーなのよ」

GDScript Reference

「　👇　GDScript のリファレンスがあるそうだぜ。リンクをメモしておこう」

📖　GDScript reference

なんか　画像素材を１つ用意しろだぜ

「　プログラムのレッスンを進めていくんで、なにか　小さな画像素材を　１つ用意してくれだぜ」

「　👆　わたしで　いいかだぜ？」

「　しかたないな……　じゃあ　それで」

新規プロジェクト作成

「　👆　Godot で新規プロジェクトを作成するぜ」

「　👆　最初に選ぶのが　その他のノード　って　どうかしてるよな？」

「　👆　その中から　Sprite2D　を選ぶなんて、直観的に無理だぜ」

「　👆　これが　Sprite2D　をルート（Root；根）に持つ　シーン（※つまりサブツリー）を作成したところだぜ」

「　👆　テクスチャー欄へ　さっきの画像を読み込めだぜ」

新規 GDScript 作成：　ハローワールド

「　👆　次に　新規スクリプト　を作ったらいいのかな？」

「　👆　テンプレートを Object:Empty にしとけだそうだぜ」

「　👆　なんか　コード・エディターが出てくるな。ここに GDScript を書けばいいのだろう」

「　かっこいいコードを書いてくれよ」

extends Sprite2D

func _init():
    print("Hello, world!")

「　👆　サンプル通り書いてみよう」

「　👆　なんか　分からんな……　現在のものを選択 で」

「　👆　Hello, world!　と出力ビューに表示されたな」

くるくる回す

extends Sprite2D

var speed = 400
var angular_speed = PI

func _init():
    print("Hello, world!")

func _process(delta):
    rotation += angular_speed * delta

「　👆　サンプル通り書いてみよう。　くるくる回ってるぜ」

時間軸の１つ分の処理：　_process(delta)

「　func _process(delta): メソッドは　時間 delta 分の処理なんだ」

Tips: Ctrl + Click

「　👆　Ctrl キーを押しながら　コードをクリックすると　説明が出てきたり、定義に飛んだりするようだぜ」

「　そんな裏技仕込むの　止めてほしいわね」

入力

「　👇　次の課題は　入力よ」

📖　プレイヤーの入力を聞く

「　入力のインプットを受け取る方法は　２種類あって、
Input シングルトンを使う方法と、 _unhandled_input() コールバック関数を使う方法があるようだぜ」

extends Sprite2D

var speed = 400
var angular_speed = PI

func _init():
    print("Hello, world!")

func _process(delta):
    # その場で　ねずみ花火のように　くるくる回る
    rotation += angular_speed * delta

    # 洗濯機の中の衣類のように　周る
    var velocity = Vector2.UP.rotated(rotation) * speed
    var movement = velocity * delta

    # 何も押さなければその場で回転
    var direction = 0
    # 左キー押下で頭上の方へ進む
    if Input.is_action_pressed("ui_left"):
        direction = -1
    # 右キー押下で足下の方へ進む
    if Input.is_action_pressed("ui_right"):
        direction = 1
    movement *= direction

    # 移動ベクトルを足す
    position += movement

📺　動画

「　👆　分かったぜ」

「　プロジェクト設定 の インプットマップ タブを見れば　Input.is_action_pressed() メソッドの引数に何書いたらいいか
自分で調べられるそうだぜ」

「　助かるぜ」

extends Sprite2D

var speed = 400
var angular_speed = PI

func _init():
    print("Hello, world!")

func _process(delta):

    var velocity = Vector2.ZERO

    # 上キーを押していなければ進まない仕組み
    if Input.is_action_pressed("ui_up"):
        velocity = Vector2.UP.rotated(rotation) * speed

    # その場で　ねずみ花火のように　くるくる回る
    rotation += angular_speed * delta

    # 洗濯機の中の衣類のように　周る
    var movement = velocity * delta

    # 何も押さなければその場で回転
    var direction = 0
    # 左キー押下で頭上の方へ進む
    if Input.is_action_pressed("ui_left"):
        direction = -1
    # 右キー押下で足下の方へ進む
    if Input.is_action_pressed("ui_right"):
        direction = 1
    movement *= direction

    # 移動ベクトルを足す
    position += movement

「　👆　上キーを押していなければ　進まないという仕組みも追加したぜ」

Godot の言うシグナル：　イベントハンドラーみたいなもん

「　👇　次の課題は　シグナル（Signal；信号）よ」

📖　シグナルの使用

「　イベントハンドラーじゃないのかだぜ？　Linux　みたいだな」

「　👆　新しいシーンを作れとのことだぜ。　シーンって何なんだぜ？」

「　サブツリーのルートノード（Root Node；根）なんじゃないか？

「　👆　シーンは　サブツリーなのよ。　サブツリーのルートをさらに選ぶのよ」

「　シーンなんて用語　造語されたら　ぐちゃぐちゃだぜ」

「　👆　2D シーン を選べとのことだぜ」

「　👆　なんで　2D シーン　を選んで、出てくるのが　Node2D　なんだぜ？　技術的に　ぐちゃぐちゃだな」

「　べつに　技術をウリにしてないんだろ」

「　👆　子ノードとして　Button　を追加しろとのことだぜ」

Node/CanvasItem/Control/BaseButton/Button

「　👆　なんか　クラス階層図みたいなツリー構造だな。 BaseButton の下に Button が出てくるの　カッコ悪いよな」

「　みたい、じゃなくて、クラス階層図なんじゃない？」

「　👆　あれっ？　きふわらべ　どこに行ったんだぜ？」

「　お父んの方が　別のサブツリーに行ったんだぜ」

「　だいたい　わかった」

「　👆　フォント・サイズはどこで変えれるんだぜ？」

「　Godot はノードを主張してるくせに　Button　のサブ・ノードが見えないじゃない」

「　べつに　技術をウリにしてないんだろ」

「　もう　先々　苦労しそうだな」

「　👆　F6 キーを打鍵すると　サブツリーを　動作テストできるそうだぜ」

「　そんな裏技仕込むの　止めてほしいわね」

「　👆　ノード タブをクリックすると　シグナルの一覧が出てくるぜ」

「　お前は　インスペクター　なんじゃないの？
なんで　インスペクターの隣の　ノード　タブをクリックしたんだぜ？
ノード　タブは、インスペクターじゃないってのかだぜ？」

「　ノード　タブは　インスペクター　じゃないのよ」

「　Godot の国語は　ぐちゃぐちゃ　だな。技術的にクソだ」

「　べつに　国語も　技術も　ウリにしてないんだろ」

「　👆　BaseButton の下に pressed() メソッドがあるから　ダブル・クリックしろだぜ」

「　pressed() はメソッドなの？　シグナルなの？」

「　pressed() メソッドは　pressed メッセージが送られてきたときに実行されるイベントハンドラーなんじゃないか？」

「　本当にそうだろうか？」

「　👆　きふわらべが　別のサブツリーに居て　アクセスできなかったので、
カット＆ペーストで　連れてきたぜ」

「　じゃあ　元　居たツリーは　今　どうなってんだぜ？」

「　👆　エンプティセット（Empty Set；空集合，くうしゅうごう）だぜ」

「　保存はできるのか？」

「　不思議な話だが、エンプティセットは　保存できないぜ」

「　ウィンドウを閉じれば　同値よ」

「　👆　センダー（Sender；送信者）である BaseButton の pressed() メソッドが呼び出されたとき、
さらに　レシーバー（Receiver；受信者）である Sprite2D の _on_button_pressed メソッドが呼び出される」

「　と考えたらいいんじゃないかだぜ？」

「　シグナルは　どこにあんのよ？」

「　Godot の開発者たちは　国語のセンスがないことが分かった。わたしが　言い換えてやるぜ」

「　👆　わたしのコードに　イベントハンドラーが　勝手に追加されたぜ」

「　じゃあ　そこに　ボタンが押されたときに　やりたい処理を書けばいいのよ」

「　👆　イベントハンドラーのシグネチャーの左横に　緑色の矢印が表示されていて、クリックできるそうだぜ」

「　👆　説明が出てきた。まあ　そうなんだろうな」

func _on_button_pressed():
    # 働いてたら休む。
    # 休んでたら働く。
    set_process(not is_processing())

「　👆　ボタンを押下したときのコードを　サンプルに従って書いたぜ。
メソッド名が悪いよな。意味が分からん。まあ　Godot は、国語がウリではないから　仕方ない」

「　👆　あれっ？　ボタンが無いぜ？」

「　エンプティセットを保存してないから、古いサブツリーを実行しているのでは？」

「　実行ボタンをクリックしたときに実行される　サブツリー　は、どこで変更できる？」

「　👆　プロジェクト設定の中を探していけば　あるぜ」

「　👆　よしでけた」

Ctrl + F1

「　エディターに戻って　Ctrl + F1 キーを押してみろだぜ」

「　👆　お前が出てきたけど……」

「　ルートに戻ったんじゃないの？」

「　メイン・シーンの方に戻ってほしいぜ」

Timer

「　👆　サンプルに従って　タイマーを追加するぜ」

「　👆　Autostart をオンに設定」

「　👆　上図のボタンをクリックすると　スクリプトのページが開くそうだぜ」

extends Sprite2D

var speed = 400
var angular_speed = PI

func _init():
    print("Hello, world!")

func _process(delta):

    var velocity = Vector2.ZERO

    # 上キーを押していなければ進まない仕組み
    if Input.is_action_pressed("ui_up"):
        velocity = Vector2.UP.rotated(rotation) * speed

    # その場で　ねずみ花火のように　くるくる回る
    rotation += angular_speed * delta

    # 洗濯機の中の衣類のように　周る
    var movement = velocity * delta

    # 何も押さなければその場で回転
    var direction = 0
    # 左キー押下で頭上の方へ進む
    if Input.is_action_pressed("ui_left"):
        direction = -1
    # 右キー押下で足下の方へ進む
    if Input.is_action_pressed("ui_right"):
        direction = 1
    movement *= direction

    # 移動ベクトルを足す
    position += movement


func _on_button_pressed():
    # 働いてたら休む。
    # 休んでたら働く。
    set_process(not is_processing())

# サブツリーが全てインスタンス化されたときに呼び出される
func _ready():
    # タイマーノード取得
    var timer = get_node("Timer")
    # timer ソースの timeout シグナルに _on_timer_timerout メソッドを接続
    timer.timeout.connect(_on_timer_timeout)

func _on_timer_timeout():
    # 可視性を反転
    visible = not visible

「　👆　全部のコード載せたろ」

📺　動画

カスタムシグナル

「　👇　シグナルを自作する方法の解説も載ってるわよ」

📖　カスタムシグナル

このあと

「　このあとも　チュートリアルは続くが、洋ゲーなんで　興味無いんで　スキップする！」

「　よっしゃ！」

「　じゃあ　本題へ戻りましょう

親記事へ戻る

📖　Godot って何だぜ（＾～＾）？

以下、独習

📖　GDScript reference

GodotでAdMobを使う - Androidの場合

2019-11-08T21:29:19+09:00

追記）Godot3.2以降は簡単になったので下記参照。

Godot3.2以降でAdMobを使う

追記終わり。

GodotでもAdMobを使うことが出来る。コード自体はGodot上にてGDScriptで書けばいいだけなので簡単だけど、ちょっと仕組み的には複雑かもしれない。ただ、やってみると、あーなるほど、そういう仕組で動いてるのか、と分かる。ちなみにGodot3.1.1現在。

iOSの場合はこちら。Godotのビルドの解説をしていたり、Godot3.2を使っていたり、Android、iOS両方に対応したGodotのコードの例もある。（ビルドはもしかしたらAndroid側は関係なくなっているのかもしれないが）

GodotでAdMobを使う - iOSの場合

モジュールを追加

具体的には下記のリポジトリにあるモジュールを利用する。

kloder-games/godot-admob: Module Admob for Godot engine

詳しい説明もここに書かれている。２つやり方があって、「Using precompiled templates (Second Option)」と書かれている方が簡単。そこの説明のhereと書かれているリンクをクリックすると下記に遷移する。

Shin-NiL/godot-custom-mobile-template: Godot Game Engine Custom Mobile Template

ここのReleaseに色々あるので、自分が使っているGodotのバージョンと同じ番号のものをダウンロードする。それを解凍したら、GodotのエクスポートメニューのAndroidの設定のところに、「Custom Package」という設定があるのでそこにDebugとRelease用のパッケージを指定する。

あとは説明にあるように下記のパーミッションを有効にしておく。

Access Network State
Internet

これは一体何をやっているのかというと、簡単に言えばAndroid Studioで作られたプロジェクトの部分がこのCustom Packageとして提供されている感じなのではないかと思う。なのでAdMobのようにネイティブ側で対応が必要な機能を提供する際にはそういったモジュールを追加してビルドされたCustom Packageを利用することで、Godot側でも利用できるようになる、という感じだと思われる。

実際問題Second Optionではない正規の方法では、モジュールを追加して自分でビルドしてくれ、という形になっている。今回はAdMobを使いたいだけなのでビルド済みのもので問題ないが、色々とモジュールを必要に応じて追加したプロジェクトを使う場合には自分でビルドしないといけないと思う。

が、Godot3.2からはもっと簡単にできるようになるよ、ということも最初のリポジトリの説明に書かれている。なのでまあとりあえず今はビルド済みのを使っておいたほうが楽かもしれない。

Godot側にモジュール追加設定

Custom Packageの準備ができたら、今度はGodotのプロジェクト側にモジュールの追加設定を行う。Godotのプロジェクトファイルがテキストファイルになっており、それを直接いじるので恐らくGodotを起動していると勝手に書き換えられて無効になってしまう。そのため一旦Godotを終了してから、下記のテキストをproject.godotに追加する。

[android]
modules="org/godotengine/godot/GodotAdMob"

AdMobを表示するコードを追加

そしたらあとはAdMobを表示するコードをシーンに追加するだけ。僕の場合は下記のようにした。デバッグ時にはテスト広告を表示し、且つAdMobモジュールが正常にロードできているかをLabelに表示して確認している。ちなみに実機でしか動作しない。

var admob = null

func _ready():
    if Engine.has_singleton("AdMob"):
        admob = Engine.get_singleton("AdMob")
        # 一般向けの場合
        # init(isReal, instance_id)
        # 子ども向けの場合
        admob.initWithContentRating(!OS.is_debug_build(), get_instance_id(), true, 'G')
        if OS.is_debug_build():
            admob.loadBanner('ca-app-pub-3940256099942544/6300978111', false)
            $UILayer/DebugLabel.set_text('ad initialized')
        else:
            admob.loadBanner('本番の広告ユニットID', false)
    else:
        if OS.is_debug_build():
            $UILayer/DebugLabel.set_text('ad not initialized')

ということでちょっと面倒くさい…けどビルド済みCustom Packageだとだいぶ楽。

GodotでTweenを動的に使ってアニメーションする

2019-11-07T23:49:04+09:00

GodotのTweenは他の言語やライブラリでもよくあるように、いちいち細かい処理を書かなくてもパラメータを指定するだけでアニメーションを行ってくれるもの。Cocos2dxでいうアクションみたいなもの。それの実際の使い方をいくつかメモ。

よく見かける例だとシーンに配置されているTweenを使っている物が多いので、その都度dynamicallyにTweenを使う方法。

パラメータを変動させるTween

移動したりサイズを変えたりというパラメータを変動させるタイプのTweenはinterpolate_propertyというメソッドを使う。例えば下記のような感じ。

    var tween = Tween.new()
    tween.interpolate_property(node,
        'position',
        Vector2(0, 0), 
        Vector2(100, 100),
        10,
        Tween.TRANS_LINEAR,
        Tween.EASE_IN_OUT)
    tween.start()
    scene.add_child(tween)

この例だとnodeを10秒かけて座標(0, 0)から(100, 100)に一定の速度で移動させるアニメーションを実行する、というもの。動的に作る場合の注意点としてTween自体もシーンにadd_childしておく必要がある。しないと多分そのまま消えてしまって何も起こらない。アニメーションするnodeに入れる形でも大丈夫。

連続してアクションを行いたい場合はTweenを作るわけではなく続けて必要な分だけinterpolate_property等を呼び出せばいい。

コールバックを呼ぶためのTween

Tweenでアニメーションした後に例えばそのNodeを削除したりなど、特定の処理を実行させることも出来る。その場合はinterpolate_callbackというメソッドを使う。例えば下記のような感じ。

    var tween = Tween.new()
    tween.interpolate_callback(self, 10, 'remove_node', node)
    tween.start()
    scene.add_child(tween)


func remove_node(node):
    remove_child(node)
    node.queue_free()

これは10秒経ったらnodeをremove_nodeというメソッドを呼んでその中で削除する、というTween。さっきの処理と合わせるとアニメーションした後に自動的に削除することが出来る。メソッド名の後には5つくらいメソッドに渡す引数を指定することが出来る。

この例だとシーン上で行っているが、実際にはnode自体のスクリプト上でやった方がシンプルだと思う。

参考

Tween — Godot Engine latest documentation

GodotのScrollContainerを使ってスマホでスワイプ出来ない場合

2019-11-06T09:54:55+09:00

GodotのScrollContainerはその下にContainerを入れておくとそのサイズによって勝手にスクロールをしてくれる便利なもの。しかし実際に試してみるとPCのデバッグ時にはマウスホイールでスクロールできるのに、実際にスマホで試してみるとスワイプしてみてもスクロールできない、ということがある。

原因

原因は、ScrollContainerの下に入れてあるContainerがスワイプのイベントを全部取ってしまっているため。

修正方法

下のContainerはイベントを取らないようにする。具体的には下記の画像のMouse > Filterのところ。デフォルトではStopになっているので、ここをIgnoreにしてイベントを取得しないようにする。Passでもいいらしい。

たしかになんか他のフレームワークでも同じような現象よくあるような気がする。

Godotで他のNodeを取得する

2019-11-06T09:47:35+09:00

Godotでコードを書いていると、他のNodeを操作したり取得したりという連携が必要になる場合がある。その際に他の要素を取得するための方法。

指定して取得

get_nodeメソッドで取得できる。下記のような感じで自分の位置からの相対パス、絶対パスを指定できる。

var node = get_node('../SelectBox/TrainsScrollContainer/Container')

ドルマークをつけて直接アクセスする方法もあるっぽい。

$SelectBox/TrainsScrollContainer/Container.visible = false

親を取得

親を取得したいときもある。たとえばモーダルの閉じるボタンとか。

var parent = get_parent().visible = false

参考

Node — Godot Engine latest documentation