Cluster Creator Kit Script Reference
    Preparing search index...

    Interface GiftInfoItem

    ユーザーがイベント内でギフトを贈ったときの情報です。 ClusterScript.onGiftSent のコールバックの引数として取得できます。

    interface GiftInfo {
        giftType: string;
        id: string;
        initialPosition: Vector3;
        initialRotation: Quaternion;
        initialVelocity: Vector3;
        price: number;
        sender: PlayerHandle | null;
        senderDisplayName: string;
        timestamp: number;
    }
    Index

    Properties

    giftType: string

    ギフトの種類が識別できる文字列を取得します。形状が同じでも、色が異なるギフトでは異なる値を返します。

    giftType の名称と実際のギフトとの対応関係については ギフト一覧 を参照してください。

    id: string

    ギフトを1回贈るごとに生成されるIDです。単一のイベント内で一意に割り当てられます。 senderDisplayNametimestamp 等の値によらず、この値が異なる GiftInfo は別途贈ったギフトを指します。

    initialPosition: Vector3

    ギフトの初期位置をグローバル座標で取得します。

    ギフトの初期位置とは、ギフトを贈ったプレイヤーがギフトを投げた手元付近の位置を指します。

    この位置に対してアイテムを生成するとき、ギフトが生成したアイテムに衝突してしまい、プレイヤーが意図しない位置でギフト演出が開始されることがあります。 initialPosition の位置に生成したアイテムにギフトが衝突することを避けるには、アイテムにColliderをアタッチしないようにするか、 または生成するアイテムのレイヤーを VenueLayer0, VenueLayer1, VenueLayer2 などに設定します。 ワールドで使用できるレイヤーの詳細は レイヤー を参照してください。

    initialRotation: Quaternion

    ギフトの初期姿勢をグローバル座標で取得します。

    ギフトの初期姿勢とは、ギフトを贈ったプレイヤーがギフトを投げた手元付近での姿勢を指します。

    initialVelocity: Vector3

    ギフトの初速をグローバル座標で取得します。

    ギフトの初速とは、ギフトを贈ったプレイヤーが手元からギフトを投げたときの初速度を指します。

    ギフトは PlayerHandle.setGravity 等の影響を受けず、一定の下方向の加速度を受けながら放物運動を行います。

    price: number

    贈られたギフトの価格を、クラスターコインの整数値として取得します。

    sender: PlayerHandle | null

    ギフトを贈ったプレイヤーです。 ゴーストやグループビューイングでイベントに参加しているプレイヤーがギフトを贈った場合は null になります。

    また、ギフトを贈ったプレイヤーが退室済みの場合は sender.exists()false になることがあります。

    senderDisplayName: string

    ギフトを贈ったプレイヤーの表示名です。

    この値は GiftInfo.sender とは異なり、ゴーストやグループビューイングで参加したプレイヤーがギフトを贈った場合にも有効な表示名を返します。

    timestamp: number

    ギフトが贈られた時刻(UTC)を、unix epochからの経過時刻でミリ秒単位の値として取得します。