Phaser API Documentation

setFrame(frame, [updateSize], [updateOrigin])


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

The Frame has to belong to the current Texture being used.

It can be either a string or an index.

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.


name type arguments Default description
frame string | number

The name or index of the frame within the Texture.

updateSize boolean <optional> true

Should this call adjust the size of the Game Object?

updateOrigin boolean <optional> true

Should this call adjust the origin of the Game Object?


This Game Object instance.

Since: 3.0.0