Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace camera

Index

Functions

Functions

Const centerCamera

Const centerCameraWithinLimits

  • centerCameraWithinLimits(instanceContainer: RuntimeInstanceContainer, object: null | RuntimeObject, left: number, top: number, right: number, bottom: number, anticipateMove: boolean, layerName: string, cameraId: number): void
  • deprecated

    prefer using centerCamera and clampCamera.

    Parameters

    Returns void

Const clampCamera

  • clampCamera(instanceContainer: RuntimeInstanceContainer, left: number, top: number, right: number, bottom: number, layerName: string, cameraId: number): void

  • Parameters

    • instanceContainer: RuntimeInstanceContainer
    • left: number
    • top: number
    • right: number
    • bottom: number
    • layerName: string
    • cameraId: number

    Returns void

Const enableLayerEffect

  • Enable, or disable, an effect of a layer.

    Parameters

    • instanceContainer: RuntimeInstanceContainer

      the container owning the layer

    • layer: string

      The name of the layer

    • effect: string

      The name of the effect

    • enabled: boolean

      true to enable, false to disable.

    Returns void

Const getCameraBorderBottom

Const getCameraBorderLeft

Const getCameraBorderRight

Const getCameraBorderTop

Const getCameraHeight

Const getCameraRotation

Const getCameraWidth

Const getCameraX

Const getCameraY

Const getCameraZoom

Const getLayerDefaultZOrder

Const getLayerTimeScale

Const hideLayer

Const layerEffectEnabled

  • Check if an effect is enabled.

    Parameters

    • instanceContainer: RuntimeInstanceContainer

      the container owning the layer

    • layer: string

      The name of the layer

    • effect: string

      The name of the effect

    Returns boolean

    true if the effect is enabled, false otherwise.

Const layerIsVisible

Const setCameraRotation

Const setCameraX

Const setCameraY

Const setCameraZoom

Const setLayerAmbientLightColor

  • Parameters

    • instanceContainer: RuntimeInstanceContainer

      the container owning the layer

    • layerName: string

      The lighting layer with the ambient color.

    • rgbColor: string

      The color, in RGB format ("128;200;255").

    Returns void

Const setLayerDefaultZOrder

Const setLayerEffectBooleanParameter

  • setLayerEffectBooleanParameter(instanceContainer: RuntimeInstanceContainer, layer: string, effect: string, parameter: string, value: boolean): void

  • Enable or disable a layer effect parameter (boolean).

    Parameters

    • instanceContainer: RuntimeInstanceContainer

      the container owning the layer

    • layer: string

      The name of the layer

    • effect: string

      The name of the effect

    • parameter: string

      The parameter to update

    • value: boolean

      The new value

    Returns void

Const setLayerEffectDoubleParameter

  • setLayerEffectDoubleParameter(instanceContainer: RuntimeInstanceContainer, layer: string, effect: string, parameter: string, value: number): void

  • Update a layer effect parameter (with a number).

    Parameters

    • instanceContainer: RuntimeInstanceContainer

      the container owning the layer

    • layer: string

      The name of the layer

    • effect: string

      The name of the effect

    • parameter: string

      The parameter to update

    • value: number

      The new value

    Returns void

Const setLayerEffectStringParameter

  • setLayerEffectStringParameter(instanceContainer: RuntimeInstanceContainer, layer: string, effect: string, parameter: string, value: string): void

  • Update a layer effect parameter (with a string).

    Parameters

    • instanceContainer: RuntimeInstanceContainer

      the container owning the layer

    • layer: string

      The name of the layer

    • effect: string

      The name of the effect

    • parameter: string

      The parameter to update

    • value: string

      The new value

    Returns void

Const setLayerTimeScale

Const showLayer

Generated using TypeDoc