Godotでプログラムの動きをエディタ上にも反映させたい場合

Godotではクラスにプロパティを設定する時にexportを付けておくとエディタ上で設定ができるようになる。例えば下記のような感じ。

export(Texture) var body_texture
export(Texture) var face_texture

こうすることでエディタ上で上記の場合だとテクスチャを設定できたりする。

例えばこの場合はこのコンポーネントにテクスチャを設定すると、そのコンポーネントの子スプライトにテクスチャを割り当てるといった処理を作成することが可能。

ここで問題になることとして、それを_readyなどでスプライトに読み込ませることで設定したものをゲームプレイ時に表示すること自体は可能。ただ、開発中にシーンをいじっている場合などは何も表示されないため分かりづらい。

そのため開発中のエディタ上でも表示できるようにしたい。それが tool という機能を使うことで実現できる。具体的には公式にも解説がある。

エディタでコードを実行する — Godot Engine (stable)の日本語のドキュメント

具体的なやり方

まずファイルの先頭に tool を付ける。

tool
extends Node2D

そして次に setget という機能を用いて処理をこんな風にする。

export(Texture) var body_texture setget set_body_texture
export(Texture) var face_texture setget set_face_texture


func _ready():
    pass


func set_body_texture(texture):
    body_texture = texture
    $Body.set_texture(texture)


func set_face_texture(texture):
    face_texture = texture
    $Face.set_texture(texture)

setgetを用いることで、プロパティに直接値を入れる代わりに指定したsetメソッドが呼び出される。これによりプロパティに値を格納すると同時にスプライトにもテクスチャを設定する。こうすることでエディタ上でテクスチャを指定したと同時にスプライトにテクスチャが反映され、且つtoolの機能によってエディタ上にもテクスチャが表示される。

こんな感じで、例えばノベルゲームを作りたい時などは配置なども気になると思うため実際に編集時に表示されていると便利。機能だけ作っておいてストーリーの作成は別のシナリオライターさんにやってもらうといったことなどもやりやすくなる。