Cluster Creator Kit Script Reference
    Preparing search index...

    Interface CameraHandlePlayer

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

    interface CameraHandle {
        calculateDefaultPosition(
            rotation: Quaternion,
            isFirstPersonView: boolean,
        ): Vector3;
        getPosition(): Vector3;
        getRotation(): Quaternion;
        isFirstPersonView(): boolean;
        setFieldOfView(value: number | null, immediate: boolean): void;
        setPerspectiveSwitchingLocked(isLocked: boolean): void;
        setPosition(position: Vector3 | null): void;
        setRotation(rotation: Quaternion | null): void;
        setThirdPersonAvatarForwardLock(value: boolean | null): void;
        setThirdPersonAvatarScreenPosition(
            pos: Vector2 | null,
            immediate: boolean,
        ): void;
        setThirdPersonDistance(distance: number | null, immediate: boolean): void;
        switchToFirstPersonView(): void;
        switchToThirdPersonView(): void;
    }
    Index

    Methods

    • setPosition()setRotation() によるカメラ姿勢の操作を行っていない状態に相当するカメラ位置を計算します。

      VR環境の場合、rotationisFirstPersonView の値を無視し、 getPosition() と同じ値を返します。 VR環境ではない場合、rotationisFirstPersonView の値に基づいたカメラの回転および視点に対応するカメラ位置を返します。

      Parameters

      • rotation: Quaternion

        カメラのグローバル回転。ただし、ロール角成分は無視されます。

      • isFirstPersonView: boolean

        1人称視点の場合はtrue、3人称視点の場合はfalse

      Returns Vector3

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

      VR環境以外でプレイヤーがアクセサリー編集を行っている場合、この関数ではアクセサリー編集中のカメラ位置は取得せず、 アクセサリー編集の終了後に適用予定のカメラ位置を取得します。

      Returns Vector3

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

      VR環境以外でプレイヤーがアクセサリー編集を行っている場合、この関数ではアクセサリー編集中のカメラ回転は取得せず、 アクセサリー編集の終了後に適用予定のカメラ回転を取得します。

      Returns Quaternion

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

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

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

      Returns boolean

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

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

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

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

      Parameters

      • value: number | null

        視野角のデフォルト値(degree)。指定した値は10以上80以下の範囲内に収められます。

      • immediate: boolean

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

      Returns void

    • HUDやズームイン/ズームアウトによる1人称視点と3人称視点の切り替えをロックします。

      この関数はプレイヤーがVR環境でも実行できますが、VR環境での挙動には影響しません。 この関数でプレイヤーによる視点切り替えの操作がロックされている場合でも、スクリプトからカメラ位置や視点を変更することは可能です。 また、Player Scriptの有効期間が終了した場合はHUDやズームイン/ズームアウトからの視点切り替えが可能になります。

      Parameters

      • isLocked: boolean

        ロックするかどうか

      Returns void

    • カメラ位置をグローバル座標で指定します。

      この関数を呼び出したときの挙動は以下の通りです。

      • VR環境の場合
        • VR環境でのカメラ位置には影響しません
      • VR環境でない場合
        • この関数を呼び出す直前に1人称視点であった場合は、3人称視点のカメラに切り替わります
        • 指定したカメラ位置が反映されます
        • 1人称視点/3人称視点の切り替え操作を無効化します
        • アバターの頭はカメラモードのカメラ目線をオンにした場合を除いて、常に進行方向を向くようになります
        • アバターの描画品質は指定したカメラ位置からの距離に応じて変化するようになります
          • ただし、プレイヤーから大きく離れたアバターのモーションや音声の品質が低下することがあります
        • 以下の項目は通常の3人称視点の場合と同じになります
          • アバターの移動操作方法
          • プレイヤーの声の発生源
          • 音の聞こえ方
          • アイテムの選択方法
      • その他の特殊なモード(アクセサリー編集中など)の場合
        • カメラ位置を指定できますが即座には反映されず、特殊なモードが終了後に反映されます

      この関数で指定した値はpositionnullを指定して呼び出すか、またはPlayer Scriptの有効期間が終了した場合にリセットされます。 リセットされた後は1人称視点/3人称視点の切り替え操作が再び有効になります。 また、この関数を呼び出す前に1人称視点であった場合は、リセット後に1人称視点に戻ります。

      Parameters

      • position: Vector3 | null

        カメラのグローバル座標。

      Returns void

    • カメラ回転をグローバル回転で指定します。

      この関数を呼び出したときの挙動は以下の通りです。

      • VR環境の場合
        • VR環境でのカメラ回転には影響しません
      • VR環境でない1人称視点の場合
        • 指定したカメラ回転が反映されます
        • マウスのドラッグ操作でのカメラ回転が無効化されます
        • カメラの回転には影響しません
      • VR環境でない3人称視点の場合
        • 指定したカメラ回転が反映されます
        • マウスのドラッグ操作でのカメラ回転が無効化されます
        • カメラの回転とプレイヤーの位置に合わせてカメラの位置が変更されます
      • その他の特殊なモード(アクセサリー編集中など)の場合
        • カメラ回転を指定できますが即座には反映されず、特殊なモードが終了後に反映されます

      この関数でrotationnullを指定して呼び出すか、またはPlayer Scriptの有効期間が終了した場合、プレイヤーがカメラ回転を操作できる状態に戻ります。 このときのカメラ回転は、最後にsetRotation()で指定していた回転からロール角成分を除去した値になります。

      Parameters

      • rotation: Quaternion | null

        カメラのグローバル回転。

      Returns void

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

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

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

      Parameters

      • value: boolean | null

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

      Returns void

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

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

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

      Parameters

      • pos: Vector2 | null

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

      • immediate: boolean

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

      Returns void

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

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

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

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

      Parameters

      • distance: number | null

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

      • immediate: boolean

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

      Returns void

    • 1人称視点に切り替えます。

      この関数はプレイヤーがVR環境や1人称視点の状態でも実行できますが、VR環境や1人称視点のときの挙動には影響しません。 また、 CameraHandle.setPosition によりカメラ位置が指定されている場合、この関数を呼び出しても視点は変更されません。

      Returns void

    • 3人称視点に切り替えます。

      この関数はプレイヤーがVR環境や3人称視点の状態でも実行できますが、VR環境や3人称視点のときの挙動には影響しません。 また、 CameraHandle.setPosition によりカメラ位置が指定されている場合、この関数を呼び出しても視点は変更されません。

      Returns void