Create Group from Config

Demonstrates how to populate a Group using configuration objects or arrays to define repetition, spacing, and initial properties for multiple sprites.

800 × 600

GitHub

class Example extends Phaser.Scene
{
    preload ()
    {
        this.load.setBaseURL('https://cdn.phaserfiles.com/v410');
        this.load.spritesheet('invader1', 'assets/tests/invaders/invader1.png', { frameWidth: 32, frameHeight: 32 });
        this.load.spritesheet('invader2', 'assets/tests/invaders/invader2.png', { frameWidth: 44, frameHeight: 32 });
        this.load.spritesheet('invader3', 'assets/tests/invaders/invader3.png', { frameWidth: 48, frameHeight: 32 });
    }

    create ()
    {
        const invader1 = this.add.group({ key: 'invader1', frame: 0, repeat: 13, setXY: { x: 32, y: 100, stepX: 40 } });

        const invader2 = this.add.group([
            { key: 'invader2', frame: 0, repeat: 10, setXY: { x: 32, y: 148, stepX: 52 } },
            { key: 'invader2', frame: 0, repeat: 10, setXY: { x: 32, y: 148 + 48, stepX: 52 } }
        ]);

        const invader3 = this.add.group([
            { key: 'invader3', frame: 0, repeat: 9, setXY: { x: 32, y: 148 + 96, stepX: 58 } },
            { key: 'invader3', frame: 0, repeat: 9, setXY: { x: 32, y: 148 + 96 + 48, stepX: 58 } }
        ]);

        Phaser.Actions.IncX(invader1.getChildren(), 100);
        Phaser.Actions.IncX(invader2.getChildren(), 100);
        Phaser.Actions.IncX(invader3.getChildren(), 100);

        Phaser.Actions.SetTint(invader1.getChildren(), 0xff0000);
        Phaser.Actions.SetTint(invader2.getChildren(), 0x00ff00);
        Phaser.Actions.SetTint(invader3.getChildren(), 0x00ffff);
    }
}

const config = {
    scale: { mode: Phaser.Scale.FIT },
    type: Phaser.AUTO,
    width: 800,
    height: 600,
    backgroundColor: '#000000',
    parent: 'game-container',
    scene: Example
};

const game = new Phaser.Game(config);

More in Group15 examples

Destroy Group ChildrenDemonstrates how calling destroy() on a Game Object automatically removes it from any Group it belongs to.

Group Create ChildDemonstrates how to use the group.create method to instantiate a new Sprite and automatically add it to both the Group and the Scene display list.

Group Create MultipleLearn how to batch-create multiple Game Objects within a Group using configuration options like frame lists, quantities, and repeat counts.

Group Create Multiple KeysDemonstrates how to populate a Group with multiple texture keys and frames simultaneously using the createMultiple method, including options for random frame selection and quantities.