Class Camera

constructor

• new Camera(pOptions?: CameraManagerOptions): Camera

• Initializes a new CameraPlugin instance.

  Parameters

  • OptionalpOptions: CameraManagerOptions

    Optional configuration for the CameraManager.

  Returns Camera

manager

Readonlyname

_register

• _register(pEmitter: KitPluginEmitter): void
• Internal

  Registers the plugin with Kit's event emitter.

  Parameters

  • pEmitter: KitPluginEmitter

  Returns void

createFollowCamera

• createFollowCamera(): FollowCamera

• Creates a new FollowCamera instance.

  Returns FollowCamera

createInfluenceCamera

• createInfluenceCamera(pX: number, pY: number, pMapName: string): InfluenceCamera

• Creates a new InfluenceCamera instance.

  Parameters

  • pX: number

    Initial X position.
  • pY: number

    Initial Y position.
  • pMapName: string

    Map name for the camera.

  Returns InfluenceCamera

createPanCamera

• createPanCamera(): PanCamera

• Creates a new PanCamera instance.

  Returns PanCamera

createSpectateCamera

• createSpectateCamera(): SpectateCamera

• Creates a new SpectateCamera instance.

  Returns SpectateCamera

createTransitionCamera

• createTransitionCamera(): TransitionCamera

• Creates a new TransitionCamera instance.

  Returns TransitionCamera

destroyCamera

• destroyCamera(pId: string): void

• Destroys a camera by its ID.

  Parameters

  • pId: string

    The ID of the camera to destroy.

  Returns void

emit

• emit(
      pEvent: {
          data?: Record<string, unknown>;
          event: string;
          plugin?: string;
          [key: string]: unknown;
      },
  ): void

• Emits an event through the Kit event system.

  Parameters

  • pEvent: {
        data?: Record<string, unknown>;
        event: string;
        plugin?: string;
        [key: string]: unknown;
    }

  Returns void

followTarget

• followTarget(
      pFollowCamera: FollowCamera,
      pTarget: GameInstance | Vector2D,
      pOffsets?: CameraOffset,
  ): Promise<void>

• Smoothly transitions to follow a target.

  Parameters

  • pFollowCamera: FollowCamera

    Follow camera instance to use.
  • pTarget: GameInstance | Vector2D

    Target to follow.
  • OptionalpOffsets: CameraOffset

    Optional camera offsets.

  Returns Promise<void>

getAllCameras

• getAllCameras(): BaseCamera[]

• Gets all cameras currently managed.

  Returns BaseCamera[]

getAutoPanCamera

• getAutoPanCamera(): null | PanCamera

• Gets the auto-created pan camera.

  Returns null | PanCamera

getAutoSpectateCamera

• getAutoSpectateCamera(): null | SpectateCamera

• Gets the auto-created spectate camera.

  Returns null | SpectateCamera

getAutoTransitionCamera

• getAutoTransitionCamera(): null | TransitionCamera

• Gets the auto-created transition camera.

  Returns null | TransitionCamera

getCamera

• getCamera(pId: string): undefined | BaseCamera

• Gets a camera instance by its unique ID.

  Parameters

  • pId: string

    The camera ID.

  Returns undefined | BaseCamera

getCamerasByType

• getCamerasByType(pType: string): BaseCamera[]

• Gets all cameras matching the specified camera type.

  Parameters

  • pType: string

    The camera type to filter by.

  Returns BaseCamera[]

getCurrentShakePreset

• getCurrentShakePreset(): null | ShakePreset

• Returns the name of the currently active shake preset, or null if none.

  Returns null | ShakePreset

getCurrentViewEye

• getCurrentViewEye(): null | BaseCamera

• Gets the currently active view eye camera.

  Returns null | BaseCamera

getCurrentZoom

• getCurrentZoom(): Vector2D

• Gets the current zoom level of the mapView.

  Returns Vector2D

getDebugCenterLines

• getDebugCenterLines(): boolean

• Gets whether debug center lines are enabled.

  Returns boolean

getDebugOptions

• getDebugOptions(): null | CameraDebugOptions

• Gets current debug options.

  Returns null | CameraDebugOptions

getDefaultTransition

• getDefaultTransition(): TransitionCameraOptions

• Gets the global default transition settings.

  Returns TransitionCameraOptions

getGizmoRenderer

• getGizmoRenderer(): null | GizmoRenderer

• Gets the native GizmoRenderer instance.

  Returns null | GizmoRenderer

getGlobalGizmos

• getGlobalGizmos(): boolean

• Gets whether global gizmo rendering is enabled.

  Returns boolean

getGlobalOffsets

• getGlobalOffsets(): Readonly<{ x: number; y: number }>

• Gets the global base offsets.

  Returns Readonly<{ x: number; y: number }>

getGlobalTimeScale

• getGlobalTimeScale(): number

• Gets the current global time scale factor.

  Returns number

getMainFollowCamera

• getMainFollowCamera(): null | FollowCamera

• Gets the current main follow camera.

  Returns null | FollowCamera

getShakePreset

• getShakePreset(pName: ShakePreset): undefined | ShakePresetConfig

• Retrieves a shake preset configuration by name.

  Parameters

  • pName: ShakePreset

    The preset name.

  Returns undefined | ShakePresetConfig

isInitiated

• isInitiated(): boolean

• Checks if the camera plugin has been registered with Kit.

  Returns boolean

isShaking

• isShaking(): boolean

• Checks if the camera view eye is currently shaking.

  Returns boolean

isZooming

• isZooming(): boolean

• Checks if the camera is currently animating zoom.

  Returns boolean

on

• on<K extends CameraEventName>(
      pEvent: K,
      pListener: CameraEventListener<K>,
  ): () => void

• Subscribes a listener to camera system events directly via the plugin.

  Type Parameters

  • K extends CameraEventName

  Parameters

  • pEvent: K

    The event name
  • pListener: CameraEventListener<K>

    Event listener callback

  Returns () => void

  Unsubscribe function

onRegistered

• onRegistered(): void

• Lifecycle callback invoked when the plugin is registered with Kit.

  Returns void

panTo

• panTo(
      pTarget: GameInstance | Vector2D,
      pOptions?: PanCameraOptions,
  ): Promise<void>

• Smoothly pans to a target position or entity.

  Parameters

  • pTarget: GameInstance | Vector2D

    Position or game instance to pan towards.
  • OptionalpOptions: PanCameraOptions

    Pan options (duration, ease, panBack, etc.).

  Returns Promise<void>

setDebugCenterLines

• setDebugCenterLines(pEnabled: boolean): void

• Enables or disables debug crosshairs / center lines.

  Parameters

  • pEnabled: boolean

    Whether debug lines should render.

  Returns void

setDebugMode

• setDebugMode(pEnabledOrOptions: boolean | CameraDebugOptions): void

• Enables or configures native debug overlay mode.

  Parameters

  • pEnabledOrOptions: boolean | CameraDebugOptions

    Toggle or debug configuration.

  Returns void

setDebugOptions

• setDebugOptions(pOptions: Partial<CameraDebugOptions>): void

• Sets specific debug overlay options.

  Parameters

  • pOptions: Partial<CameraDebugOptions>

    Partial options.

  Returns void

setDefaultTransition

• setDefaultTransition(pOptions: TransitionCameraOptions): void

• Sets global default transition settings used when switching cameras.

  Parameters

  • pOptions: TransitionCameraOptions

    Transition settings.

  Returns void

setGlobalGizmos

• setGlobalGizmos(pEnabled: boolean): void

• Enables or disables debug gizmos across all cameras.

  Parameters

  • pEnabled: boolean

    Whether gizmos should render.

  Returns void

setGlobalOffsets

• setGlobalOffsets(pX: number, pY: number): void

• Sets global base offsets for the view eye.

  Parameters

  • pX: number
  • pY: number

  Returns void

setGlobalTimeScale

• setGlobalTimeScale(pTimeScale: number): void

• Sets the global time scale multiplier for camera animations (1.0 = normal).

  Parameters

  • pTimeScale: number

    Multiplier factor.

  Returns void

setIgnoreShakeTimeScale

• setIgnoreShakeTimeScale(pIgnore: boolean): void

• Toggles whether shake effects ignore time scale.

  Parameters

  • pIgnore: boolean

  Returns void

setIgnoreZoomTimeScale

• setIgnoreZoomTimeScale(pIgnore: boolean): void

• Toggles whether zoom effects ignore time scale.

  Parameters

  • pIgnore: boolean

  Returns void

setMainFollowCamera

• setMainFollowCamera(
      pFollowCamera: FollowCamera,
      pTarget: GameInstance | Vector2D,
      pOffsets?: Partial<CameraOffset>,
      pSetAsViewEye?: boolean,
  ): FollowCamera

• Sets the main follow camera that will automatically become the view eye when other cameras (spectate, pan) end their operations.

  Parameters

  • pFollowCamera: FollowCamera
  • pTarget: GameInstance | Vector2D
  • OptionalpOffsets: Partial<CameraOffset>
  • OptionalpSetAsViewEye: boolean

  Returns FollowCamera

shake

• shake(pOptions: ShakeOptions): void

• Applies a custom configured shake effect on the active view eye.

  Parameters

  • pOptions: ShakeOptions

    Custom shake parameters.

  Returns void

shakePreset

• shakePreset(
      pPresetName: ShakePreset,
      pCallback?: () => void,
      pInfiniteOverride?: boolean,
  ): void

• Triggers a preset camera shake on the active view eye.

  Parameters

  • pPresetName: ShakePreset

    One of the 29 built-in presets (e.g. 'gunshot', 'explosion-large').
  • OptionalpCallback: () => void

    Optional callback when shake finishes.
  • OptionalpInfiniteOverride: boolean

    Optional boolean to force infinite shaking.

  Returns void

spectateTarget

• spectateTarget(
      pTarget: GameInstance | Vector2D,
      pOptions?: SpectateCameraOptions,
  ): Promise<void>

• Smoothly spectates a target position or entity.

  Parameters

  • pTarget: GameInstance | Vector2D

    Position or game instance to spectate.
  • OptionalpOptions: SpectateCameraOptions

    Spectate options.

  Returns Promise<void>

stopRAF

• stopRAF(): void

• Stops the internal RAF update loop if active.

  Returns void

stopShake

• stopShake(): void

• Stops the currently active shake effect.

  Returns void

stopZoom

• stopZoom(): void

• Stops the current zoom animation.

  Returns void

switchTo

• switchTo(
      pTargetCamera: BaseCamera,
      pOptions?: TransitionCameraOptions,
  ): Promise<void>

• Smoothly switches view eye to another camera via TransitionCamera.

  Parameters

  • pTargetCamera: BaseCamera

    The destination camera.
  • OptionalpOptions: TransitionCameraOptions

    Transition options (duration, ease, time scale, onComplete).

  Returns Promise<void>

update

• update(pElapsedMs: number): void

• Manually advances the camera system by the given elapsed time in milliseconds. Useful when integrating into custom render loops with autoStart disabled.

  Parameters

  • pElapsedMs: number

    Elapsed milliseconds since last frame.

  Returns void

useInfluenceCamera

• useInfluenceCamera(pX: number, pY: number, pMapName: string): Promise<void>

• Transitions to an InfluenceCamera at the given position.

  Parameters

  • pX: number

    Target X coordinate.
  • pY: number

    Target Y coordinate.
  • pMapName: string

    Map name.

  Returns Promise<void>

zoom

• zoom(
      pDestinationLevel?: number | { x?: number; y?: number },
      pDuration?: number | DurationSettings,
      pEase?: EaseType | EaseSettings,
      pCallback?: () => void,
      pOptions?: { ignoreTimeScale?: boolean; timeScale?: number },
  ): void

• Smoothly zooms the active view eye to a target zoom level.

  Parameters

  • OptionalpDestinationLevel: number | { x?: number; y?: number }

    Target zoom level (scalar or {x, y}).
  • OptionalpDuration: number | DurationSettings

    Duration in milliseconds (scalar or {x, y}).
  • OptionalpEase: EaseType | EaseSettings

    Easing curve name (e.g. 'easeOutCubic').
  • OptionalpCallback: () => void

    Callback when zoom completes.
  • OptionalpOptions: { ignoreTimeScale?: boolean; timeScale?: number }

    Optional timescale settings.

  Returns void