Class ParallaxSystem

ParallaxSystems present a set of images that seem to scroll relative to the position of the actor on whom the camera is centered.

The speeds of layers are a very important concept.

  • 1 means "moves at same speed as hero", which means "fixed position"
  • 0 means "doesn't move", which means "looks like a tiled background"
  • in-between should be interesting
  • negative means "moves too fast"

Constructors

constructor

Methods

addLayer render

Constructors

constructor

Methods

addLayer

  • addLayer(cfg): void

  • Add a parallax layer to the current level

    Parameters

    • cfg: {
          anchor: {
              cx: number;
              cy: number;
          };
          imageMaker: (() => ImageSprite | AnimatedSprite);
          isAuto?: boolean;
          isHorizontal?: boolean;
          speed: number;
      }
      • anchor: {
            cx: number;
            cy: number;
        }

        The position of one instance of the image. All other instances will be tiled from this point.

        • cx: number
        • cy: number
      • imageMaker: (() => ImageSprite | AnimatedSprite)

        Code for making each ImageSprite or AnimatedSprite

      • Optional isAuto?: boolean

        Should the image scroll automatically, or in relation to the camera position?

      • Optional isHorizontal?: boolean

        True for moving in X, false for moving in Y

      • speed: number

        Speed that the picture seems to move.

    Returns void

render

  • render(camera, elapsedMs, foreground): void

  • Render all of the layers of this parallax scene

    Parameters

    • camera: CameraService

      The camera for the world that these layers accompany

    • elapsedMs: number

      The time since the last render

    • foreground: boolean

      Does this go in the foreground (true) or background (false)?

    Returns void

Settings

Member Visibility

Theme

On This Page