Filter
Members
Description:
The Texture Frame this Game Object is using to render with.
Type:
Description:
The Texture this Game Object is using to render with.
Methods
Description:
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:
| name | type | arguments | description |
|---|---|---|---|
| key | string | Phaser.Textures.Texture |
The key of the texture to be used, as stored in the Texture Manager, or a Texture instance. |
|
| frame | string | number | <optional> |
The name or index of the frame within the Texture. |
Returns:
Description:
This Game Object instance.
Description:
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:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| frame | string | number | Phaser.Textures.Frame |
The name or index of the frame within the Texture, or a Frame instance. |
||
| 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? |
Returns:
Description:
This Game Object instance.