Class ImageSprite

constructor

• new ImageSprite(opts): ImageSprite

• Build an image that can be rendered

  Parameters

  • opts: {
        height: number;
        img: string | Sprite;
        offset?: {
            dx: number;
            dy: number;
        };
        width: number;
        z?: ZIndex;
    }

    • height: number

      The height of the image, in meters

    • img: string | Sprite

      The name of the file to use as the image, or a PixiSprite

    • Optional offset?: {
          dx: number;
          dy: number;
      }

      An offset between the component's center and its RigidBody's center (optional)

      • dx: number

      • dy: number

    • width: number

      The width of the image, in meters

    • Optional z?: ZIndex

      An optional z index in the range [-2,2]

  Returns ImageSprite

Optional actor

height

image

img

offset

width

z

overrideImage

• overrideImage(pixi_sprite): void

• An internal method that lets us overwrite the image used by an ImageSprite with something generated directly by PIXI. This lets us turn screenshots into ImageSprites.

  Parameters

  • pixi_sprite: Sprite

    The sprite to use

  Returns void

prerender

• prerender(_elapsedMs): void

• Perform any custom updates to the image before displaying it

  Parameters

  • _elapsedMs: number

  Returns void

render

• render(camera, _elapsedMs, location): void

• Render the image

  Parameters

  • camera: CameraService

    The camera for the current stage

  • _elapsedMs: number

    The time since the last render

  • location: SpriteLocation

    Where should this be drawn (WORLD/OVERLAY/HUD)

  Returns void

renderAsParallax

• renderAsParallax(anchor, camera, _elapsedMs, foreground): void

• Render the image when it does not have a rigidBody. This is only used for Parallax

  Parameters

  • anchor: {
        cx: number;
        cy: number;
    }

    The center x/y at which to draw the image

    • cx: number

    • cy: number

  • camera: CameraService

    The camera for the current stage

  • _elapsedMs: number

    The time since the last render

  • foreground: boolean

    Does this belong in the foreground (true) or background?

  Returns void

resize

• resize(scale): void

• Change the size of the image. You shouldn't call this directly. It gets called by Actor.resize().

  Parameters

  • scale: number

    The amount to scale the size by. 1 means "no change", >1 means "grow", 0 < scale < 1 means "shrink".

  Returns void

setImage

• setImage(imgName): void

• Change the image being used to display the actor

  Parameters

  • imgName: string

    The name of the new image file to use

  Returns void