Amazon GameSparks でインフラを意識せずにゲームのバックエンドサービスを開発しよう

Cloud Code を利用して、ボタンクリックというイベントに対して処理を行うロジックを実装します。Cloud Code では Message という単位でリソースを作成し、ロジック実装とリクエストレスポンスのフィールド定義を行います。この Message には「Event」「Request」「Notification」以下の3つのタイプが存在し、組み合わせて利用することが可能です。

• Event : クライアントがレスポンスを必要とせず、バックエンドにデータを送信する場合やイベントのトリガーにしたい場合に利用されるタイプです。たとえば、プレイヤーが特定のアイテムを取得したことをバックエンドサービスに通知可能です。また後述の Notification と組み合わせて、イベント発生後に、プレイヤーに対して非同期で通知することも可能です。

• Request : クライアントがバックエンドからのレスポンスを必要とするタイプです。基本的にはリクエスト&レスポンス形式の API として利用します。たとえば、プレイヤーが自分の持っているアイテム一覧のリクエストを要求し、レスポンスとしてその結果を受け取る際に利用可能です。

• Notification : サーバからクライアントへの通知方法として利用するタイプです。ロジック自体は記述せずに、フィールドの定義のみを行います。たとえば、2 人プレイヤーでのターン制のゲームで、プレイヤー A がターン終了通知を Event または Request で送信し、それをトリガーにしてバックエンドサービス側からプレイヤー B に対して Notification を利用してプレイヤー A のターン終了の通知をするといったことが可能になります。

今回のデモでは、これらすべてのタイプを組み合わせて実装していきたいと思います。

まずは、ボタンがクリックされたというイベント発生時に、Amazon GameSparks に保存されたプレイヤーのクリック数をインクリメントする (存在しない場合は初期化) というロジックが必要になります。このイベントのロジックとして、ButtonPressed という Message を Event タイプで作成します。ボタンは連打される可能性があるため、ユーザー体験を損ねないように Request タイプを利用せず、非同期で処理を行う形としています。

1. 左のナビゲーションペインから [Dev] ステージを選択し、[Configuration] の中の [Cloud Code] を選択します。

2. [Create Message] をクリックした後、メッセージタイプとして [Event] を選択し「ButtonPressed」を名前として設定したあと、[Create] ボタンをクリックします。

3. 「ButtonPressed」Message 作成後、[Enable client permission] のチェックボックスを有効化します。クライアントからこのメッセージ呼び出しを許可するために必要になります。

4. [Add event handler]を選択し、「ButtonPressHandler」を入力し、[Save] をクリックします。

5. 作成した「ButtonPressHandler」のコードとして以下を入力し、[Save] をクリックします。

GameSparks().Logging().Debug("Inside ButtonPress event handler");

GameSparks().Logging().Debug("Retrieving player data");

// Retrieve player data
let data = GameSparks().CurrentPlayer().GetData(["ButtonPressed"]);

// Handle initial case with no data
if (data.ButtonPressed === undefined) {
    data.ButtonPressed = 0;
}
GameSparks().Logging().Debug("Incrementing button press counter");

// Increment the counter
data.ButtonPressed++;

GameSparks().Logging().Info("Setting a value of button press count");

// Store player data
GameSparks().CurrentPlayer().SetData(data);

こちらのコードが「ButtonPressHandler」Message における「プレイヤーのボタンクリック数のインクリメント」の JavaScript での実装になります。

全体の流れとしては、ログに処理メッセージを出力しつつ、プレイヤーデータストレージからプレイヤーのクリック数を取得した後インクリメントを行い、再度プレイヤーのデータストレージに格納する形となっています。

また、随所に GameSparks() というコードが確認できます。Cloud Code では上記のように、より簡易的にコードを記述できるように、 GameSparks() という拡張 API を提供しています。例えば 1、3、17 行目の GameSparks().Logging() という記述があります。こちらはロギングの拡張機能であり、CloudWatch Logs へのロギング機能を容易に利用することができます。また、6 行目では現在のプレイヤーのボタンクリック数を取得し、9-15 行目でインクリメントを行った後、20 行目でボタンクリック数として保存を実行しています。Amazon GameSparks では、プレイヤーの認証/アイデンティティの機能およびプレイヤーごとのデータを格納するストレージがビルトインで用意されているため、GameSparks().CurrentPlayer() という形で現在のプレイヤーに関するデータを操作することができます。

また、今回、詳細は割愛しますが Amazon Game Sparks は Lambda および DynamoDB ともネイティブに統合されています。そのため、DynamoDB 向けの GameSparks().DynamoDB() や Lambda 向けの GameSparks().Lambda() といった API が用意されており、たった一行でこれらのサービスに対して操作を行うことが可能です。

ボタンクリック数を更新し、クライアントに現在のクリック数を通知する必要があります。今回クリック時のイベントの Message タイプとしては、レスポンスを必要としない Event タイプを選択しました。

この Event タイプにて、処理後にクライアントに通知を行うためには、Notification タイプの Message を利用する必要があります。

1. ステップ 4-1 と同様に [Create Message] をクリックし、[Notification] を選択し、「ButtonPressedNotification」を名前として設定したあと、[Create] ボタンをクリックします。

2. Notification fields に次のフィールドを定義し、[Save] をクリックします。

• Field name : buttonPressCount

• Shape : Integer

• Required : Yes

このフィールドの定義に基づいて Amazon GameSparks はクライアントにデータを送信します。

3. 1 つ前のステップ 4-1 で作成した event タイプの Message [ButtonPressed] に戻り、[Add event handler] をクリックし、「NotificationHandler」という名前で [Save] をクリックしてハンドラを追加します。

4. 作成した「ButtonPressHandler」のコードとして以下を入力し、[Save] をクリックします。

GameSparks().Logging().Debug("Inside ButtonPressed Notification dispatch handler");

let data = GameSparks().CurrentPlayer().GetData(["ButtonPressed"]);

// Handle initial case with no data
if (data.ButtonPressed === undefined) {
    data.ButtonPressed = 0;
}
GameSparks().Logging().Debug("Sending notification: " +  data.ButtonPressed);

GameSparks().CurrentPlayer().SendNotification("Custom.Game.ButtonPressedNotification", { "buttonPressCount": parseInt(data.ButtonPressed) });

これは、さきほど作成した「ButtonPressedNotification」という Notification を利用してクライアントに通知を送るためのハンドラです。現在のプレイヤーのクリック数を取得し、クライアントに通知する形となっています。

11 行目の GameSparks().CurrentPlayer().SendNotification() で、このイベントを呼び出したプレイヤーに対して通知を行う処理となっています

Custom.Game.ButtonPressedNotification は、作成した 「ButtonPressedNotification」を示しており、 Message 内で定義したフィールドの値であるクリック数を設定しています。

ゲームを開始したタイミングでは、プレイヤーの認証および識別を行い、現在のクリック数を取得し、ゲーム上に反映する必要があります。そのため、シンプルな現在のクリック数を取得する API のようなロジックが必要です。

ここでは、Request というシンプルなリクエスト&レスポンスの API を構築できるメッセージタイプを使用します。

1. ここまでのステップと同様に [Create Message] をクリックし、[Request] を選択し、「GetButtonPressCount」を名前として設定したあと、[Create] ボタンをクリックします。

2.「GetButtonPressCount」Message 作成後、[Enable client permission] のチェックボックスを有効化します。このメッセージもクライアントから呼び出すことを許可する必要があります。

3. Response fields に次のパラメータを定義し、[Save] をクリックします。今回の場合は特にクライアントからデータを送信する必要もなく、このイベントを呼び出すことができれば問題ないので、レスポンス時のフィールド定義さえ設定していれば問題はありません。

• Field name : buttonPressCount

• Shape : Integer

• Required : Yes

4. 作成した「GetButtonPressCount」のコードとして以下を入力し、[Save] をクリックします。

GameSparks().Logging().Debug("Inside GetButtonPressCount request handler");

let data = GameSparks().CurrentPlayer().GetData(["ButtonPressed"]);

// Handle initial case with no data
if (data.ButtonPressed === undefined) {
    data.ButtonPressed = 0;
}

return GameSparks().Messaging().Response( { "buttonPressCount": parseInt(data.ButtonPressed) } );

内容や構文はこれまでのコードと大きな違いはなく、プレイヤーのクリック数を取得し、Response fields に指定した定義をもとにコードを記述します。

ここまでで Cloud Code で接続時やボタンクリック時のイベントのカスタムロジックを実装しました。

Test harness という機能を利用することで、マネジメントコンソール上から各メッセージが正常に動作しているかをテストすることができます。

1. 左のナビゲーションペインから [Dev] の配下にある [Test harness] を選択し、Player が 「Connected」になるまで待ちます。これはプレイヤーをアノニマス認証し、接続が正常に完了したことを示しています。

2. 左の Messages が「ButtonPressed」に選択されていることを確認し、 [Populate example] を 1 度クリックしたのち、[Send message] をクリックすると、クリック数のインクリメントとプレイヤーへの現在のクリック数の通知が実施されます。毎回 [Send message] を押すたびにカウントが 1 ずつ増加していれば問題なく処理できています。

また、Messages にて「GetButtonPressCount」を選択し、再度 [Populate example] を 1 度クリックしたのち、[Send message] をクリックすると、今度は値のインクリメントはなしに現在のクリック数が取得できていることを確認できます。

Amazon GameSparks 上の設定はここまでです。ここまでは、基本的にロジックの処理を記載していましたが、インフラを意識することなく、セットアップを完了することができました。

今回は手順として SDK のサンプルの中にすでに自動生成のライブラリコードが含まれているので自動生成の手順はスキップしますが、独自に開発する場合はこの自動生成を利用することで、ゲームエンジンとの統合を素早くおこなうことが可能です。

では、ここから Unity 側の設定に移ります。上述のとおり今回は SDK の中に含まれるサンプルを利用します。

1. Unity上における [Window] の [Package Manager] を選択し、Amazon GameSparks の Samples の Button Blaster の横の [Import] をクリックします。

2. GameSparks コンソールのナビゲーションパネルの [Dev] の [Dev stage configuration] から Key をコピーします。

3. /Assets/Samples/Amazon GameSparks/0.0.1/Button Blaster/UsingScriptableObjects/Assets/Connection をクリックし、Inspector Pane にて、さきほどコピーした Game Key を貼り付けます。

この Connection オブジェクトに接続先の Amazon GameSparks の情報としてキー、リージョン、認証方式を設定します。

※ 今回はサンプルのため、すでに Connection オブジェクトが生成されていますが、この Connection オブジェクトは SDK インストール後の Unity の GameSparks メニューにて、[Set up scene]→[Create Connection] を選択すると、Assets/Amazon/GameSparks/Connection.asset に自動生成されます。

1. /Assets/Samples/Amazon GameSparks/0.0.1/Button Blaster/UsingScriptableObjects/Assets/Scenes を開き、サンプルのシーンを確認します。

2. プレイボタンをクリックし、青いボタンをクリックすると総カウントが増えていくことを確認できます。また、Unity のコンソールログを合わせて確認すると Amazon Game Sparks との通信の状況を確認することができます。

3. 最後にクライアント側のコードを確認します (具体的な操作ではないので、スキップしてもらっても問題ありません)。サンプルコード内の重要なコードは次の 2 つです。

• ボタンオブジェクト (Player オブジェクト) のコンポーネントスクリプト: Assets/Samples/Amazon GameSparks/0.0.1/Button Blaster/UsingScriptableObjects/Scripts/Player.cs

• Amazon GameSparks により自動生成されたクラスライブラリ : Assets/Samples/Amazon GameSparks/0.0.1/Button Blaster/Scripts/Generated/ButtonBlasterOperations.cs

基本的には、ボタンオブジェクト (Player オブジェクト) にコンポーネントとして追加されている Player.cs にクライアントサイドのロジックを記述していく形となります。例えば今回のように「オブジェクト上でのボタンクリックをトリガーとして ButtonPressed を呼び出す」といった処理を記述をしていきます。この際、Amazon GameSparks に対しては、Player.cs のパラメータとして設定された Connection オブジェクトと Amazon GameSparks による自動生成されたクラスライブラリを利用して、容易に通信できる形となっています。

3. /Assets/Samples/Amazon GameSparks/0.0.1/Button Blaster/UsingScriptableObjects/Assets/Connection をクリックし、Inspector Pane にて、さきほどコピーした Game Key を貼り付けます。

この Connection オブジェクトに接続先の Amazon GameSparks の情報としてキー、リージョン、認証方式を設定します。

※ 今回はサンプルのため、すでに Connection オブジェクトが生成されていますが、この Connection オブジェクトは SDK インストール後の Unity の GameSparks メニューにて、[Set up scene]→[Create Connection] を選択すると、Assets/Amazon/GameSparks/Connection.asset に自動生成されます。