Phaser API Documentation

  Version: 
SpriteSheetFromAtlasConfig
Properties:
name type arguments Default description
atlas string

The key of the Texture Atlas in which this Sprite Sheet can be found.

frame string

The key of the Texture Atlas Frame in which this Sprite Sheet can be found.

frameWidth number

The fixed width of each frame.

frameHeight number <optional>

The fixed height of each frame. If not set it will use the frameWidth as the height.

startFrame number <optional> 0

Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.

endFrame number <optional> -1

The total number of frames to extract from the Sprite Sheet. The default value of -1 means "extract all frames".

margin number <optional> 0

If the frames have been drawn with a margin, specify the amount here.

spacing number <optional> 0

If the frames have been drawn with spacing between them, specify the amount here.

Type:
object