Phaser API Documentation

name type arguments Default description
id number <optional>

A unique Object ID to convert.

gid number <optional>

An Object GID to convert.

name string <optional>

An Object Name to convert.

classType Phaser.GameObjects.GameObject <optional> Phaser.GameObjects.Sprite

A custom class type to convert the objects in to.

scene Phaser.Scene <optional>

A Scene reference, passed to the Game Objects constructors.

container Phaser.GameObjects.Container <optional>

Optional Container to which the Game Objects are added.

key string | Phaser.Textures.Texture <optional>

Optional key of a Texture to be used, as stored in the Texture Manager, or a Texture instance.

frame string | number <optional>

Optional name or index of the frame within the Texture.