Cluster Creator Kit Script Reference
    Preparing search index...

    Interface HapticsHandlePlayer

    プレイヤーのコントローラーやデバイスの振動機能を制御するハンドルです。 PlayerScript.hapticsHandleで取得することができます。

    interface HapticsHandle {
        maxFrequencyHz: number | null;
        minFrequencyHz: number | null;
        isAvailable(): boolean;
        playEffect(effect: HapticsEffect, target: HapticsTarget | null): void;
    }
    Index

    Properties

    maxFrequencyHz: number | null

    HapticsEffect.frequency 1 を指定した場合の振動数の絶対値をHz単位で返します。

    以下の場合、振動数の設定は実際の振動フィードバックに反映されません。

    • この API が null を返した場合
    • デバイスが振動数の設定をサポートしない場合
    minFrequencyHz: number | null

    HapticsEffect.frequency 0 を指定した場合の振動数の絶対値をHz単位で返します。

    以下の場合、振動数の設定は実際の振動フィードバックに反映されません。

    • この API が null を返した場合
    • デバイスが振動数の設定をサポートしない場合

    Methods

    • デバイスの振動機能が利用可能かどうかを取得します。

      デバイスが振動機能に対応していて、かつ設定画面から触覚のフィードバックを無効化していない場合、 true を返します。

      モバイル環境では、「設定」の「操作」タブの「触覚のフィードバック」→「バイブレーション」から振動機能の有効または無効を設定できます。

      Returns boolean

    • プレイヤーのコントローラーまたはデバイスが振動機能に対応している場合、振動フィードバックを再生します。

      VR環境ではコントローラー上で振動フィードバックを再生します。
      target"left" または "right" を指定した場合、対応する左手または右手のコントローラーで振動フィードバックを再生します。
      target が非対応の値、または null の場合、両方のコントローラーで振動フィードバックを再生します。

      振動機能に対応しているモバイル環境では、デバイス本体で振動フィードバックを再生します。 target の値は無視されます。

      デバイスの振動機能が利用できない場合、 playEffect() の呼び出しは無視されます。

      Parameters

      • effect: HapticsEffect

        振動フィードバックの内容

      • target: HapticsTarget | null

        振動させる対象を示す文字列の値( "left" または "right") 、または無指定の場合 null

      Returns void

      // VR環境では両手のコントローラーで、モバイル環境ではデバイス本体で、振動フィードバックを再生します。
      const effect = new HapticsEffect();
      effect.frequency = 0.1;
      effect.amplitude = 1;
      effect.duration = 0.1;
      _.hapticsHandle.playEffect(effect, null);