Types.GameObjects.Sprite

Phaser API Documentation

SpriteConfig
 SpriteConfig
name
type
optional
description
key
string |
Phaser.Textures.Texture
Yes
The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
frame
string | number
Yes
An optional frame from the Texture this Game Object is rendering with.
anims
string |
Phaser.Animations.Animation
Phaser.Types.Animations.PlayAnimationConfig
Yes
The string-based key of the animation to play, or an Animation instance, or a
PlayAnimationConfig
object.
useSpriteSheet
boolean
Yes
This property is used exclusively by
Tilemap.createFromTiles
. Set to
true
if this Sprite is being created by a Tilemap and is part of a spritesheet.
Type
: object
Member of
: Phaser.Types.GameObjects.Sprite
Source:
src/gameobjects/sprite/typedefs/SpriteConfig.js#L1
Since: 3.0.0

name	type	optional	description
key	string \| Phaser.Textures.Texture	Yes	The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
frame	string \| number	Yes	An optional frame from the Texture this Game Object is rendering with.
anims	string \| Phaser.Animations.Animation	Phaser.Types.Animations.PlayAnimationConfig	Yes
useSpriteSheet	boolean	Yes	This property is used exclusively by `Tilemap.createFromTiles`. Set to `true` if this Sprite is being created by a Tilemap and is part of a spritesheet.

Types.GameObjects.Sprite

SpriteConfig

<static> SpriteConfig