ライフ回復ポーションをカスタマイズする

Unity 用の C# スクリプトを作成するための基本的な概念について説明したので、実際にスクリプトを書いてゲームプレイを作ることができます。

このチュートリアルでは、ゲーム中に登場するポーションの効果を記述して、ポーションを使うとプレイヤーキャラクターのライフポイントを 10 増やすようにします。

この Creator Kit には、アイテムの効果を作成するために使用できる簡単なテンプレートスクリプトが含まれています。

テンプレートから新しいスクリプトを作成して開くには、以下のようにします。

1. 画面上のメニューで、Beginner Code > Create Item Effect と移動します。

2. スペースなしで名前を入力し（たとえば「AddHealthEffect」）、Create を選択します。

3. プロジェクトウィンドウで、 Assets/Creator Kit - Beginner Code/Scripts/ItemEffects に移動します。

4. AddHealthEffect.cs スクリプトファイルをダブルクリックして、スクリプトエディターで開きます。

基本的なコードは以下のようになります。

using System.Collections;
using System.Collections.Generic;
using CreatorKitCode;
using UnityEngine;

public class AddHealthEffect : UsableItem.UsageEffect
{
    public override bool Use(CharacterData user)
    {
        return false;
    }
}

これまでに学んだことをすべて使用して、この小さなスクリプトの要素を確認しましょう。

• 1 行目から 4 行目は、using で始まっています。前と同じく、これらは一旦考えないことにしましょう。
  
• 6 行目は、前のステップで指定したものと同じ名前が入ったクラス宣言です。ダイアログウィンドウでの入力によって、これが追加されました。
  

この新しいクラスは、UsableItem.UsageEffect と呼ばれる別のクラスから派生しています。これは、この Creator Kit のために作成されたクラスで、ゲーム内のアイテムに関連するすべてを制御します。これらの効果に必要な共通コードを提供し、選択した効果の個別の機能の開発に集中できるようにします。

Use 関数

8 行目は、Use という関数の宣言です。関数を分解してみましょう。

• Use は public bool 型の関数である。bool 変数型は、true または false の 2 つのブール値のいずれかを格納する。
  
  
• この関数の宣言には override という見慣れないキーワードがある。その名前が示すように、このキーワードは基本クラスの同じ関数（ここでは UsableItem.UsageEffect）を上書き（override）するために使用される。これにより、任意の Use 関数で機能する汎用的なコードを記述できる。
  
  

オブジェクトが使用されると、この関数はゲームによって呼び出され、その中のすべての命令を実行します。ゲームはオブジェクトが使用されているかどうかをチェックするため、ブール値を返します。使用されている場合は、持ち物リストから削除されます。


この機能を使って、プレイヤーのライフが満タンの時には falseを返して、ポーションが使われないようにすることもできます。

これで、スクリプトが Assets フォルダーにでき、コンパイルされてゲームコードの一部になります。これは、ゲーム内のライフ回復ポーションにこのスクリプトを割り当てることができるようになったことを意味します。

1. Unity エディターに戻る。


2. プロジェクトウィンドウで、Assets/Creator Kit - Beginner Code/Prefabs /ItemDatabase に移動する。Potion プレハブを選択する。

3. インスペクターで、 Add New Effect ドロップダウンメニューを使用して、 AddHealthEffect を選択します。これは、下の Script フィールドに表示されます。

4. Description フィールドに、効果の説明を追加する（たとえば、「10HP 回復」）。

このフィールドが表示されるのは、基本クラスに持ち物リストの UI の内容を格納する description 変数があるためです。先ほど作った効果クラスはこのクラスから派生しているため、Description フィールドが表示されます。

5. Ctrl + S（Windows）または Cmd + S（macOS）を押して、変更を保存する。

次に、AddHealthEffect スクリプトに戻って、実際に効果を発生させる関数を作成する必要があります。

関数が実行する必要があることと、使用可能なツールを確認しましょう。

Creator Kit の StatSystem

この Creator Kit には、StatSystem というキャラクターのステータスを制御するための特別なシステムがあります。あるゲームオブジェクトに CharacterData スクリプトがコンポーネントとしてアタッチされている場合、そのゲームオブジェクトは Creator Kit の StatSystem にアクセスできます。


キャラクターのライフの状態を変更するには、ChangeHealth() 関数を使います。この関数を使用すると、StatSystem がアタッチされたゲームオブジェクトの状態を変更できます。

関数が実行するべき処理

ライフ回復ポーションを使用するときにプレイヤーキャラクターのライフの値を変更するには、効果を発生させる関数で以下のことを行う必要があります。

1. プレイヤーの CharacterData スクリプトにアクセスする。

2. ドット演算子を使用して、Stats クラスにアクセスする。

3. ドット演算子をもう 1 つ使用して、Stats 内にある ChangeHealth() 関数にアクセスする。

4. 関数の引数として int 値を渡し、回復するプレイヤーキャラクターのライフの量を決める。

このプロセスにおいては、効果を発生させる関数は「return false;」ではなく、「return true;」で終わります。アイテムは消費され、プレイヤーの持ち物リストから消えます。

課題：関数を書く

ドット演算子を使用して効果を発生させる関数を記述してみましょう。記述が終わったら、次のステップに進んで解答を確認してください。独力で記述できないと思われる場合は、先に次のステップに進んで解答を確認しても構いません。

効果を発生させる関数は以下のようになります。

public class AddHealthEffect : UsableItem.UsageEffect
{
    public override bool Use(CharacterData user)
    {
        user.Stats.ChangeHealth(10);
        return true;
    }
}

次に、ライフ回復量を変数に変更してみます。以下の情報を参考にしてください。

• ライフ回復量の変数には整数を格納する必要があるため、変数の型は int とする。
• 変数を public にする。こうすると、Unity エディターでインスペクターのフィールドとして表示されるようになる。
• Use 関数の宣言より前に変数を宣言する。

ヒント：なかなか完成できないようであれば、変数の概要を確認し、参考にしてください。

まずはこの置き換えをやってみてから、次のステップに進んで解答を確認してください。

修正されたスクリプトは以下のようになります。

public class AddHealthEffect : UsableItem.UsageEffect
{
    public int HealthAmount;

    public override bool Use(CharacterData user)
    {
        user.Stats.ChangeHealth(HealthAmount);
        return true;
    }
}

Ctrl + S（Windows）または Cmd + S（macOS）を押して、変更を保存しましょう。

これで、Unity エディターからこの変数を編集できます。


1. インスペクターで、Description フィールドの下に公開変数の Health Amount フィールドが表示されている。

2. 値を変更し、Ctrl + S（Windows）または Cmd + S（macOS）を押して、変更を保存する。

3. 再生ボタンを押して再生モードに入り、ゲームへの変更をテストする。

これで終わりです。完成しました！

このチュートリアルでは、このプロジェクトでこれまで学んだ内容を応用して、以下の活動を行いました。

• カスタムのライフ回復効果を発生させるスクリプトを作成する
• プレイヤーのライフポイント（HP）を上げるための新しい命令を書く
• HP の増分の値を Unity エディターで変更できる変数にする

おめでとうございます。これで、Unity ではじめての C# コードを作成し、「Creator Kit：コーディング入門」の主要部分を修了したことになります。

もう少し Rancho Rodadora にいませんか？

この学習プロジェクトの主要なチュートリアルは完了しましたが、まだまだ学ぶことがたくさんあります。

最後のチュートリアルは、この Creator Kit に合わせて作成したスクリプトのテンプレートを使って、ゲームをカスタマイズするためのリファレンスガイドです。これを使って、さまざまなアイテムやエフェクトを作成できます。

さらなる学びを始める準備はいいですか？

「Creator Kit：コーディング入門」で学んだ内容は、奥深い Unity と C# スクリプティングの世界に踏み出す第一歩にすぎません。

このプロジェクトの続きに学ぶ内容としては、以下の 2 つをおすすめいたします。

• 「John Lemon's Haunted Jaunt：3D 入門」で 3D ステルスゲームを作成する
  
• 「Ruby's Adventure：2D 入門」で 2D RPG をゼロから構築する