Interface TextureCrop

frame

isCropped

texture

setCrop

• setCrop(
      x?: number | Geom.Rectangle,
      y?: number,
      width?: number,
      height?: number,
  ): this

  Applies a crop to a texture based Game Object, such as a Sprite or Image.

  The crop is a rectangle that limits the area of the texture frame that is visible during rendering.

  Cropping a Game Object does not change its size, dimensions, physics body or hit area, it just changes what is shown when rendered.

  The crop size as well as coordinates can not exceed the the size of the texture frame.

  The crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.

  Therefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left half of it, you could call setCrop(0, 0, 400, 600).

  It is also scaled to match the Game Object scale automatically. Therefore a crop rectangle of 100x50 would crop an area of 200x100 when applied to a Game Object that had a scale factor of 2.

  You can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.

  Call this method with no arguments at all to reset the crop, or toggle the property isCropped to false.

  You should do this if the crop rectangle becomes the same size as the frame itself, as it will allow the renderer to skip several internal calculations.

  Parameters

  • Optionalx: number | Geom.Rectangle

    The x coordinate to start the crop from. Cannot be negative or exceed the Frame width. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.
  • Optionaly: number

    The y coordinate to start the crop from. Cannot be negative or exceed the Frame height.
  • Optionalwidth: number

    The width of the crop rectangle in pixels. Cannot exceed the Frame width.
  • Optionalheight: number

    The height of the crop rectangle in pixels. Cannot exceed the Frame height.

  Returns this

setFrame

• setFrame(
      frame: string | number | Frame,
      updateSize?: boolean,
      updateOrigin?: boolean,
  ): this

  Sets the frame this Game Object will use to render with.

  If you pass a string or index then the Frame has to belong to the current Texture being used by this Game Object.

  If you pass a Frame instance, then the Texture being used by this Game Object will also be updated.

  Calling setFrame will modify the width and height properties of your Game Object.

  It will also change the origin if the Frame has a custom pivot point, as exported from packages like Texture Packer.

  Parameters

  • frame: string | number | Frame

    The name or index of the frame within the Texture, or a Frame instance.
  • OptionalupdateSize: boolean

    Should this call adjust the size of the Game Object? Default true.
  • OptionalupdateOrigin: boolean

    Should this call adjust the origin of the Game Object? Default true.

  Returns this

setTexture

• setTexture(key: string, frame?: string | number): this

  Sets the texture and frame this Game Object will use to render with.

  Textures are referenced by their string-based keys, as stored in the Texture Manager.

  Parameters

  • key: string

    The key of the texture to be used, as stored in the Texture Manager.
  • Optionalframe: string | number

    The name or index of the frame within the Texture.

  Returns this