Filter
Members
Description:
The Texture Frame this Game Object is using to render with.
Type:
Description:
A boolean flag indicating if this Game Object is being cropped or not.
You can toggle this at any time after setCrop has been called, to turn cropping on or off.
Equally, calling setCrop with no arguments will reset the crop and disable it.
Type:
Description:
The Texture this Game Object is using to render with.
Methods
Description:
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 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 rect 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:
| name | type | arguments | description |
|---|---|---|---|
| x | number | Phaser.Geom.Rectangle | <optional> |
The x coordinate to start the crop from. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored. |
| y | number | <optional> |
The y coordinate to start the crop from. |
| width | number | <optional> |
The width of the crop rectangle in pixels. |
| height | number | <optional> |
The height of the crop rectangle in pixels. |
Returns:
Description:
This Game Object instance.
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 |
The key of the texture to be used, as stored in the Texture Manager. |
|
| 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.
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.
Parameters:
| 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? |
Returns:
Description:
This Game Object instance.