Class AirshipCameraSingleton

Optional cameraSystem

Readonly firstPersonChanged

Readonly lookBackwardsChanged

ClearMode

• ClearMode(): void

• Sets the camera to a static view.

  Returns void

GetFOV

• GetFOV(targetCamera): number

• Returns the camera's field-of-view.

  Parameters

  • targetCamera: CharacterCameraType

  Returns number

GetMode

• GetMode<T>(): undefined | T

• Returns the CameraMode of type T.

  You likely want to pass the generic GetMode<FixedCameraMode>(), or whatever mode your game uses.

  Type Parameters

  • T extends CameraMode = CameraMode

  Returns undefined | T

  The CameraMode, if it exists. Otherwise, undefined.

IsEnabled

• IsEnabled(): undefined | boolean

• Returns true if the camera system is enabled.

  Returns undefined | boolean

IsFOVManaged

• IsFOVManaged(): boolean

• If Field of View is managed, camera fov will be updated by tweens. You must control the FOV by calling SetFOV

  It's useful to turn this off when you want to manage FOV entirely yourself.

  Returns boolean

  true if FOV is being managed by the CharacterCamera system.

IsFirstPerson

• IsFirstPerson(): boolean

• Returns true if the player is in first-person mode.

  Returns boolean

ObserveFirstPerson

• ObserveFirstPerson(observer): (() => void)

• Observes the current first-person state.

  Parameters

  • observer: ((isFirstPerson) => CleanupFunc)
    • • (isFirstPerson): CleanupFunc

      • Parameters

        • isFirstPerson: boolean

        Returns CleanupFunc

  Returns (() => void)

  • • (): void

    • Returns void

ObserveLookBackwards

• ObserveLookBackwards(observer): (() => void)

• Observes whether or not the player wants to look backwards.

  Parameters

  • observer: ((lookBackwards) => CleanupFunc)
    • • (lookBackwards): CleanupFunc

      • Parameters

        • lookBackwards: boolean

        Returns CleanupFunc

  Returns (() => void)

  • • (): void

    • Returns void

SetEnabled

• SetEnabled(enabled): void

• Sets whether or not the camera system is enabled. Disable the camera system if custom camera code is being used.

  Parameters

  • enabled: boolean

  Returns void

SetFOV

• SetFOV(targetCameraType, fieldOfView, smooth?): void

• Set the camera's field-of-view.

  Parameters

  • targetCameraType: CharacterCameraType
  • fieldOfView: number

    Field of view.
  • smooth: boolean = false

    If true the FOV will transition smoothly to the target.

  Returns void

SetFOVManaged

• SetFOVManaged(shouldManage): void

• Sets if camera FOVs should be tweened.

  Parameters

  • shouldManage: boolean

    True if camera FOVs should be tweened by this class.

  Returns void

SetFirstPerson

• SetFirstPerson(value): void

• Changes the preferred perspective for the local character.

  This will only work if using CharacterCameraMode.Fixed. You can set this with ()

  Parameters

  • value: boolean

  Returns void

SetMode

• SetMode(characterCameraMode): CameraMode

• Sets a new CharacterCameraMode. If the local character does not exist when this function is called, the camera mode's target is set to a GameObject located at Vector3.zero.

  Parameters

  • characterCameraMode: CharacterCameraMode

    A CharacterCameraMode.

  Returns CameraMode

SetModeCustom

• SetModeCustom(mode): CameraMode

• Sets and returns a new custom CameraMode.

  Parameters

  • mode: CameraMode

    The CameraMode that is being set.

  Returns CameraMode

  The new CameraMode.

SetSprintFOVMultiplier

• SetSprintFOVMultiplier(multipler): void

• Sets multiplier on base FOV when sprinting. For example if FOV is 80 and multipler is 1.1 the player FOV while sprinting will be 88.

  Parameters

  • multipler: number

    Sprint FOV multiplier, set to 1 to disable sprint FOV. Defaults to 1.08

  Returns void

StopCameraSystem

• StopCameraSystem(): void

• Shutdown the whole Airship.Character camera system.

  This will cause the CameraRig to stop being controlled in any way.

  Returns void