Interface CameraHandlePlayer Beta

プレイヤーのカメラワークを制御するハンドルです。 PlayerScript.cameraHandleで取得することができます。

Hierarchy

  • CameraHandle

Methods

  • Beta

    現在のカメラ位置をグローバル座標で取得します。 VR環境の場合、プレイヤーの1人称視点の位置を取得します。 VR環境ではない場合、1人称視点/3人称視点の選択状態に基づいたカメラ位置を取得します。

    VR環境以外では、視点が特殊なモードに切り替わったときにメソッドの結果がnullとなることがあります。 例えば、プレイヤーがアクセサリー編集を開始した場合にはnullが返されます。

    Returns null | Vector3

  • Beta

    現在のカメラ回転をグローバル座標で取得します。 VR環境の場合、プレイヤーの1人称視点の回転を取得します。 VR環境ではない場合、1人称視点/3人称視点の選択状態に基づいたカメラ回転を取得します。

    VR環境以外では、視点が特殊なモードに切り替わったときにメソッドの結果がnullとなることがあります。 例えば、プレイヤーがアクセサリー編集を開始した場合にはnullが返されます。

    Returns null | Quaternion

  • Beta

    プレイヤーが現在選択している視点が一人称視点であるかどうかを取得します。

    VR環境のプレイヤーに対して呼び出した場合、つねにtrueが返ります。 VR環境ではないプレイヤーに対して呼び出した場合、現在そのプレイヤーが選んでいる視点が1人称視点ならばtrue、そうでなければfalseを返します。

    この関数の結果は、カメラが特殊なモードになっていても有効な値を返します。 視点が有効であるかどうかを検証する場合、 CameraHandle.getPosition あるいは CameraHandle.getRotation を呼び出した結果がnullでないことを確認します。

    Returns

    プレイヤーが現在選択している視点が一人称視点かどうか

    Returns boolean

  • Beta

    VR環境ではないプレイヤーに対して、視野角(Field of View)のデフォルト値を設定します。 視野角は画面の下端から上端までの、垂直方向の角度として指定します。

    VR環境に対しても呼び出せますが、VR環境での視野角には影響しません。 この方法で視野角を変更したあとも、プレイヤーは引き続きズームイン/ズームアウト操作や、ズームによる1人称/3人称視点の切り替え操作を行えます。

    この関数で指定した値はvaluenullを指定して呼び出すか、またはPlayer Scriptの有効期間が終了した場合にリセットされます。

    Parameters

    • value: null | number

      視野角のデフォルト値(degree)。10以上、80以下の値が指定できます。範囲外の値を指定した場合、範囲内の値に丸められます。

    • immediate: boolean

      trueにすると、補間を行わず、直ちに値を適用します。この値は省略可能で、省略するとfalse相当に扱われます

    Returns void

  • Beta

    3人称視点のとき、アバターが正面方向に向くよう姿勢を固定するかどうかを設定します。 照準しながら使うようなアイテムを持っている場合にこの関数を呼び出すことで、3人称視点での挙動を最適化できます。

    この関数はプレイヤーがVR環境や1人称視点の状態でも実行できますが、VR環境や1人称視点のときの挙動には影響しません。

    この関数で指定した値はvaluenullを指定して呼び出すか、またはPlayer Scriptの有効期間が終了した場合にリセットされます。

    Parameters

    • value: null | boolean

      アバターの向きを正面方向に固定するかどうか

    Returns void

  • Beta

    3人称視点のとき、アバターの頭部付近が画面上で映る位置を、スクリーン座標で指定します。 画面の左端がx=0、右端がx=1に対応します。 画面の下端がy=0、上端がy=1に対応します。

    この関数はプレイヤーがVR環境や1人称視点の状態でも実行できますが、VR環境や1人称視点のときの挙動には影響しません。

    この関数で指定した値はposnullを指定して呼び出すか、またはPlayer Scriptの有効期間が終了した場合にリセットされます。

    Parameters

    • pos: null | Vector2

      アバターの頭部付近が画面上に映る位置。x, yいずれの成分も0以上1以下の範囲に丸められます。

    • immediate: boolean

      trueにすると、補間を行わず、直ちに値を適用します。この値は省略可能で、省略するとfalse相当に扱われます

    Returns void

  • Beta

    3人称視点のときにアバターとカメラが取りうる最大の距離をメートル単位で指定します。

    カメラとアバターの距離は必ずしも指定した値にはなりません。 アバターの周辺に壁や天井がある場合、指定した距離よりもアバターとカメラは近づく場合があります。

    この関数はプレイヤーがVR環境や1人称視点の状態でも実行できますが、VR環境や1人称視点のときの挙動には影響しません。

    この関数で指定した値はdistancenullを指定して呼び出すか、またはPlayer Scriptの有効期間が終了した場合にリセットされます。

    Parameters

    • distance: null | number

      アバターとカメラの距離の最大値。最小値は0.2で、これよも小さい値を指定した場合は0.2を指定したのと同様に扱われます。

    • immediate: boolean

      trueにすると、補間を行わず、直ちに距離を適用します。この値は省略可能で、省略するとfalse相当に扱われます

    Returns void

Generated using TypeDoc