Cluster Creator Kit v2.30.0.2（以下、CCK）から、「ギフトコールバックAPI」を使うことができるようになりました。
このAPIを使うと、イベント中に誰かがギフトを贈った時に何かしらの処理を追加できます。
この機能を使うことで、ギフトを受け取った時に会場に演出が追加されるようにしたり、ギフトをきっかけにした様々な表現ができるようになりました。ギフトの種類や贈ったプレイヤー情報も取得できるので、様々な条件で処理を追加することもできます。
この記事では、基本的な使い方を紹介します。
スクリプトサンプル
今回は、ギフトが投げられた時に、投げたユーザーを特定の位置に移動させるサンプルを紹介します。
空のGameObejctを作成し、Scriptable Itemコンポーネントを追加し、下記のサンプルスクリプトを貼り付けてください。
let vipRoomPosition = new Vector3(100, 100, 100);
$.onGiftSent((gifts) => {
for (let i = 0; i < gifts.length; i++) {
let player = gifts[i].sender;
if (player !== null) {
player.setPosition(vipRoomPosition);
}
}
});グループビューイングやゴースト状態のユーザーは、ユーザー情報 (PlayerHandle) が取得できず null になる点に注意してください。仕様の詳細は Cluster Script Reference をご覧ください。
ワールドでテストをする
ギフトコールバックAPIでは、ワールドでテストするための方法を用意しています。
イベントを作成してギフトを投げる必要なく、クラスターコインの使用をせずにテストを行うことができます。
テストをするためには、スラッシュコマンドを使用します。
スラッシュコマンドはコメント欄で「/」から始まる特定の文字列を入力することで様々な機能を実行できる機能です。デベロッパーメニューから有効化することができます。
スラッシュコマンドを使用可能な状態にしたら、コメント欄で「 /dummygift 」とスラッシュコマンドを入力することで、ギフトを受け取った際の挙動を確認することができます。
また、以下のコマンドでギフトの価格やプレイヤーの表示名などもテストすることができます。
- /dummygift price
- /dummygift price displayName
- /dummygift price displayName userId
- /dummygift price displayName userId giftType
仕様の詳細はCluster Creator Kitドキュメントをご覧ください。
Creators Guideベータ版では、ギフトに対して贈ってくれた人の名前付きのカスタムリアクションを表示するギミックのサンプル付きの記事も公開しているので、使ってみたい方はぜひこちらもご覧ください！
記事はこちらから。
「ギフトコールバックAPI」によって、イベント時の特別な演出を実装できるようになりました。様々な使い方ができる機能なので、ぜひ使ってみてください。
