Class CameraModeAbstract

Represents a camera mode that can attached to the camera system.

Properties

character onTargetChanged target

Methods

GetCharacterTarget GetTarget OnDisable OnEnable OnLateUpdate OnUpdate SetTarget

Properties

Protected character

character: undefined | Character

The character that camera is currently targeting. This is only set when the target GameObject has a Character component attached to it, or if one of it's ancestors or descendents has a Character component.

onTargetChanged

onTargetChanged: Signal<{
    after: CameraTarget;
    before: CameraTarget;
}> = ...

Signal that is fired when the camera mode's target is changed.

Type declaration

  • after: CameraTarget
  • before: CameraTarget

Protected target

target: undefined | GameObject

The camera's target GameObject.

Methods

GetCharacterTarget

  • GetCharacterTarget(): undefined | Character

  • Returns this camera mode's Character target, if it exists. A character target only exists if it's target GameObject, or any ancestors or descendants contain a Character component.

    Returns undefined | Character

    This camera's Character target, if it exists, otherwise undefined.

GetTarget

  • GetTarget(): undefined | GameObject

  • Returns this camera mode's target, if it exists. Otherwise this function returns undefined.

    Returns undefined | GameObject

    This camera's target, if it exists, otherwise undefined.

Abstract OnDisable

  • OnDisable(): void

  • Called when the camera mode stops.

    Returns void

Abstract OnEnable

  • OnEnable(camera, rootTransform): void

  • Called when the camera mode is enabled.

    Parameters

    • camera: Camera
    • rootTransform: Transform

    Returns void

Abstract OnLateUpdate

  • OnLateUpdate(deltaTime): CameraTransform

  • Called every frame. Use this method for constructing the CameraTransform.

    Parameters

    • deltaTime: number

    Returns CameraTransform

Abstract OnUpdate

  • OnUpdate(deltaTime): void

  • Called every frame. Useful for control logic.

    Parameters

    • deltaTime: number

    Returns void

SetTarget

  • SetTarget(target): void

  • Sets camera mode's new target and fires the onTargetChanged signal. This only affects camera modes that use the target and character fields, and not static modes like FlyCameraMode.

    Parameters

    • target: GameObject

      The camera's new target.

    Returns void

Settings

Member Visibility

Theme

On This Page

characteronTargetChangedtargetGetCharacterTargetGetTargetOnDisableOnEnableOnLateUpdateOnUpdateSetTarget