カスタムリソースを使用
この記事は Godot 3から Godot 4 へ内容の書き換え中です。 Godot4では存在しない変数、関数が含まれている場合があります。もしその場合はリポジトリのIssuesまでご報告ください。
課題
ゲーム内でデータを処理する方法や、柔軟なデータオブジェクトを作成する方法を探しています。
解決策
GodotのResourceクラスは、データを格納・操作するための強力なツールです。Godotで扱う最も一般的なオブジェクトの多くはResourceタイプを拡張しています。アニメーション、衝突形状、画像など。リソースは単なるデータ保持だけでなく、そのデータを操作することもできます（Unityの ScriptableObject に似ています。）。
Godot に標準で用意されているすべての リソースタイプに加え、独自のカスタムリソースを作成してゲーム固有のデータを管理することもできます。これはデータの抽象化とカプセル化を実現する利点があり、ゲーム内の他のあらゆるオブジェクトから利用できる汎用的なコンポーネントを作成できます。
例：プレイヤーの移動
この例では、プラットフォーマーゲームにおけるプレイヤーのHP管理を取り上げます。多くのゲームプレイシステムはプレイヤーのHP・状態と連動しています。
- プレイヤーが障害物に衝突するとダメージを受ける場合があります
- 敵キャラクターがプレイヤーに触れたり攻撃したりすることでダメージを与えられます
- オブジェクトを拾う、または特定の場所に立つことでプレイヤーが回復できます
- ゲーム画面にはHPゲージを表示し、発生する変化を適切に表示する必要があります
さらに、他の相互作用も存在する可能性があります。プレイヤーがHPを減らすとゲームのサウンドトラックが変化する、あるいは敵の行動パターンがプレイヤーのステータスに応じて変化する、といった具合です。
これは意図的に簡略化した例です。実際の運用では、ここで使用している機能よりも多くの機能が必要になる場合や、ゲームのアーキテクチャに合わせてこの例を修正する必要があるでしょう。
まず最初に、新しいカスタムリソースPlayerHealthを定義する必要があります。このリソースはHPに関連するプロパティを管理する必要があります。さらに、HPの変化（回復やダメージを受けるなど）を処理するための機能とシグナルを提供します。
Script タブで、 ファイル >新規スクリプト を選択します。Resourceを継承するように設定し、ファイル名を PlayerHealth.gd とします。
これを部分ごとに分解して考えてください。
上部には extends 行とリソースに割り当てる class_name があります。このページ名はエディター内の様々な場所で表示されます。
extends Resource
class_name PlayerHealth
次に、ゲームオブジェクトがプレイヤーのHP変化を監視するために購読できるシグナルがあります。また、HPがゼロに達するなどの追加イベント用のシグナルも実装できます。
signal health_changed
使用するプロパティです。
@export var max_value: int
var current_value = 0
この関数を使用すると、HPを最大値に初期化できます。ゲームの再起動時や新しいレベルを開始する際に実行するとよいでしょう。
func reset():
current_value = max_value
この関数はプレイヤーにダメージが与えられた際に毎回呼び出されるべきです。
func take_damage(amount):
current_value = max(0, current_value - amount)
emit_signal("health_changed", current_value)
この関数はプレイヤーの回復が必要な時に随時呼び出されるべきです。
func heal(amount):
current_value = min(max_value, current_value + amount)
emit_signal("health_changed", current_value)
以下が完全なスクリプトです。
extends Resource
class_name PlayerHealth
signal health_empty
signal health_changed
@export var max_value: int
var current_value = 0
func reset():
current_value = max_value
func take_damage(amount):
current_value = max(0, current_value - amount)
emit_signal("health_changed", current_value)
func heal(amount):
current_value = min(max_value, current_value + amount)
emit_signal("health_changed", current_value)
新規リソースの作成
一度PlayerHealthクラスを定義すれば、新しいインスタンスを作成できます。インスペクター上部の「新規リソース作成」ボタンをクリックしてください。
「新規リソース作成」ダイアログでは、様々な種類のリソースが一覧表示されます。検索機能を使って、作成した PlayerHealth タイプを見つけてください。
これで、希望するmax_valueを設定し、新しいリソースを.tresファイルとして保存できます。
リソースの使用方法
リソースの作成と保存が完了したら、いよいよ使用準備が整います。このシナリオでは、以下のオブジェクトがあります。
- プレイヤー：
CharacterBody2Dコンポーネントを搭載したキャラクターモデル - UI： 体力ゲージを表示する
ProgressTextureを含むインターフェースシステム - 回復ゾーン： その上を通過する対象を回復する
Area2Dオブジェクト - スパイクタイル： 接触時にダメージを与える
TileMap要素のタイルセット
ゲームの全コードを掲載するのではなく、HPリソースに関連する部分だけを取り上げます。
プレイヤー側では、インスペクター経由でリソースを割り当てるために変数を エクスポート しています。移動処理コードの一部として、プレイヤーがスパイクに接触した際には hurt() 関数を呼び出すようになっています。
@export var health: Resource
func _ready():
health.reset()
func hurt(amount):
# Called when running into obstacles
health.take_damage(amount)
回復ゾーン（Area2Dオブジェクト）は、内部に位置しhealthプロパティを持つすべてのオブジェクトに影響を与えます。
func _physics_process(delta):
for body in get_overlapping_bodies():
if "health" in body:
body.health.heal(heal_rate * delta)
最後に、UIにHPステータスを表示するために、同じHPリソースを接続し、そのhealth_changedシグナルに接続します。
@export var player_health: Resource
func _ready():
if player_health:
player_health.health_changed.connect(_on_player_health_changed)
func _on_player_health_changed(value):
healthbar.value = float(value) / player_health.max_value * 100
動作例をご覧ください。
プロジェクトファイルをこちらからダウンロードしてください: custom_resources.zip