Cluster Creator Kit Script Reference
    Preparing search index...

    Interface OverlapEffectItem

    アイテムに「触れた参加者への効果」(Overlap Effect)を設定するハンドルです。 ClusterScript.overlapEffectからアクセスできます。

    効果が設定されている間、アイテムのOverlapDetectorShapeに触れた参加者に効果が適用されます。 ここでの参加者には、通常の参加者だけでなく、イベントのゴーストやグループビューイングの参加者も含まれます。 詳細はゴースト参加者についてを参照してください。

    効果は種類ごとに1つ設定できます。効果を設定するメソッドを呼び出すたびに、同じ種類の以前の効果は新しい効果で置き換えられます。 異なる種類の効果は組み合わせて設定できます。

    効果には単発効果と持続効果があります。 単発効果(setPosition / setRotation / respawn / addVelocity)は、参加者が範囲に入るたびに1回ずつ適用されます。 複数の単発効果が同時に適用される場合、その順序はそれぞれの効果が最後に設定された順になります。 持続効果(setMoveSpeedRate / setJumpSpeedRate / setGravity / setPostProcessEffects)は、参加者が範囲に入っている間適用され、 範囲から出るか、効果が解除されると適用されなくなります。 同じ種類の持続効果がほかに適用されていなければ、PlayerHandleなどで設定されている値に戻ります。 持続効果は、PlayerHandleやPlayerScriptによる同じ種類の設定より優先されます。 参加者に同じ種類の持続効果が複数適用されている場合、最後に設定された効果が有効になります。

    効果の設定はアイテムの状態として同期され、後から入室した参加者が範囲に入った場合にも適用されます。 単発効果を設定・変更すると、既に範囲内にいる参加者にも1回適用されます。 同じ種類の単発効果を短い間隔で続けて設定した場合、途中の効果は適用されないことがあります。 持続効果を設定・変更すると、範囲内にいる参加者にもその場で適用・更新されます。

    アイテムにOverlapDetectorShapeがない場合、効果は適用されません。

    interface OverlapEffect {
        addVelocity(velocity: Vector3): void;
        clear(): void;
        clearGravity(): void;
        clearJumpSpeedRate(): void;
        clearMoveSpeedRate(): void;
        clearPosition(): void;
        clearPostProcessEffects(): void;
        clearRespawn(): void;
        clearRotation(): void;
        clearVelocity(): void;
        respawn(): void;
        setGravity(gravity: number): void;
        setJumpSpeedRate(jumpSpeedRate: number): void;
        setMoveSpeedRate(moveSpeedRate: number): void;
        setPosition(position: Vector3): void;
        setPostProcessEffects(effects: PostProcessEffects): void;
        setRotation(rotation: Quaternion): void;
    }
    Index

    Methods

    • 触れた参加者に速度を加える単発効果を設定します。 参加者の最終的な移動速度は、加えられた速度と参加者の入力の両方から決定されます。 参加者が地面に接している間、加えられた速度は摩擦と似たような原理で減速し続けます。

      速度にNaNやInfinity、-Infinityを含む場合は、エラーになります。

      Parameters

      • velocity: Vector3

        加えられる速度 (グローバル座標)

      Returns void

    • 設定されている全ての効果を解除します。 持続効果が適用されている参加者は、PlayerHandleなどで設定されている値に戻ります。

      Returns void

    • 重力加速度を変更する持続効果を解除します。

      Returns void

    • ジャンプ速度の倍率を変更する持続効果を解除します。

      Returns void

    • 移動速度の倍率を変更する持続効果を解除します。

      Returns void

    • 位置を変更する単発効果を解除します。

      Returns void

    • Beta

      PostProcessEffectsを適用する持続効果を解除します。

      Returns void

    • リスポーンさせる単発効果を解除します。

      Returns void

    • 向きを変更する単発効果を解除します。

      Returns void

    • 速度を加える単発効果を解除します。

      Returns void

    • 触れた参加者をリスポーンさせる単発効果を設定します。

      Returns void

    • 範囲内にいる参加者にかかる重力加速度(単位:m/s^2)を変更する持続効果を設定します。 参加者が範囲から出ると、この効果が適用されていない状態に戻ります。

      NaNやInfinity、-Infinityを指定した場合は、エラーになります。

      Parameters

      • gravity: number

        重力加速度

      Returns void

    • 範囲内にいる参加者のジャンプ速度の倍率を変更する持続効果を設定します。 参加者が範囲から出ると、この効果が適用されていない状態に戻ります。

      NaNやInfinity、-Infinityを指定した場合は、エラーになります。

      Parameters

      • jumpSpeedRate: number

        ジャンプ速度の倍率

      Returns void

    • 範囲内にいる参加者の移動速度の倍率を変更する持続効果を設定します。 参加者が範囲から出ると、この効果が適用されていない状態に戻ります。

      NaNやInfinity、-Infinityを指定した場合は、エラーになります。

      Parameters

      • moveSpeedRate: number

        移動速度の倍率

      Returns void

    • 触れた参加者の位置を変更する単発効果を設定します。

      位置にNaNやInfinity、-Infinityを含む場合は、エラーになります。

      Parameters

      • position: Vector3

        足元の中心位置の移動先 (グローバル座標)

      Returns void

    • Beta

      範囲内にいる参加者にPostProcessEffectsを適用する持続効果を設定します。 参加者が範囲から出ると、この効果が適用されていない状態に戻ります。

      nullを指定した場合は、エラーになります。効果の解除にはOverlapEffect.clearPostProcessEffectsを使用してください。

      Parameters

      Returns void

    • 触れた参加者の向きを変更する単発効果を設定します。 体の向きは鉛直のままで、y軸回転以外は動きません。

      向きにNaNやInfinity、-Infinityを含む場合は、エラーになります。

      Parameters

      • rotation: Quaternion

        参加者の向き (グローバル座標)

      Returns void