Skip to main content
Version: Phaser v4.0.0-rc.6

Types.GameObjects.Sprite

SpriteConfig

<static> SpriteConfig

nametypeoptionaldescription
keystring | Phaser.Textures.TextureYesThe key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
framestring | numberYesAn optional frame from the Texture this Game Object is rendering with.
animsstring | Phaser.Animations.AnimationPhaser.Types.Animations.PlayAnimationConfigYes
useSpriteSheetbooleanYesThis 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