Contains methods relating to the active camera for the specified player.

Hierarchy

  • Camera

Constructors

Methods

Constructors

  • Returns Camera

Methods

  • Returns void

    Remarks

    Clears the active camera for the specified player. Causes the specified players to end any in-progress camera perspectives, including any eased camera motions, and return to their normal perspective.

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

  • Parameters

    • Optional fadeCameraOptions: CameraFadeOptions

      Additional options around camera fade operations.

    Returns void

    Remarks

    Begins a camera fade transition. A fade transition is a full-screen color that fades-in, holds, and then fades-out.

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.