Overview

This is the PlayCanvas Editor API. You can find API documentation here.

Installing

Run:

npm install

Building

Run:

npm run build

This will create a UMD build under dist/index.js and an ES6 module under dist/index.mjs.

Docs

To build the documentation run:

npm run build:docs

The resulting .md file will be under docs/modules.md.

NOTE: Build the docs after you commit any API changes, otherwise the code links in the docs might point to the wrong lines.

NOTE: The following documents are created externally. When you build the docs, revert those documents (or update them externally):

• EntityProperties.md
• AssetProperties.md
• SceneSettingsProperties.md

Tests

To run tests run:

npm test

To step through the tests using Chrome run:

npm run test:debug