Skip to main content

Procedural Levels

This project uses clone() function on the Entity to randomly generate a level from Entities that have been created in the Editor.

Try it from the Editor in the tutorial project.

This script below is a very simple level generation program. It takes two Entities that have been setup in the Editor: 'Grass' and 'House' and uses them as tiles for a grid based level. The level is created by randomly choosing one of the tiles, cloning the tile to create a new Entity, then placing the new Entity at the correct grid position.

import { Script } from 'playcanvas';

export class Generate extends Script {
static scriptName = "generate";

/**
* @attribute
* @title Num Tiles X
* @type {number}
*/
numTilesX = 10;

/**
* @attribute
* @title Num Tiles Y
* @type {number}
*/
numTilesY = 10;

// initialize code called once per entity
initialize() {
// We've created a couple of templates that are our world tiles
// In the Editor hierarchy, we have disabled the templates because
// we don't want them to be visible. We just want our generated
// world to be visible
const templates = this.app.root.findByName('Templates');
const grass = templates.findByName('Grass');
const house = templates.findByName('House');

for (let y = 0; y < this.numTilesY; y++) {
for (let x = 0; x < this.numTilesX; x++) {
// Pick a tile at random, with grass more likely than a house
var tile = (Math.random() > 0.8) ? house : grass;

// Clone the tile
var e = tile.clone();

// Set the world position of the cloned tile. Note that because
// our tiles are 10x10 in X,Z dimensions, we have to multiply
// the position by 10
e.setPosition((x - this.numTilesX / 2) * 10, 0, (y - this.numTilesX / 2) * 10);

// Add the tile to the scene's hierarchy
this.app.root.addChild(e);
}
}
}
}