History

David Négrier 0f7ac7ba8b Added empty .npmignore to override .gitignore		2021-04-10 19:14:36 +02:00
..
.gitignore	Creating a dedicated package for iframe API typings	2021-04-10 18:50:46 +02:00
.npmignore	Added empty .npmignore to override .gitignore	2021-04-10 19:14:36 +02:00
iframe_api.js	Creating a dedicated package for iframe API typings	2021-04-10 18:50:46 +02:00
package.json	Creating a dedicated package for iframe API typings	2021-04-10 18:50:46 +02:00
README.md	Creating a dedicated package for iframe API typings	2021-04-10 18:50:46 +02:00

README.md

WorkAdventure - IFrame API typings for Typescript

This package contains Typescript typings for WorkAdventure's map scripting API

WorkAdventure comes with a scripting API. Using this API, you can add some intelligence to your map. You use this API by loading an external script directly from WorkAdventure (at https://play.workadventu.re/iframe_api.js), or this script is loaded for you if you are using the "script" property of a map.

This project contains Typescript typings for the WA object provided by this script.

Usage

This package is only useful if you are using Typescript to script your WorkAdventure maps.

Download & Installation

$ npm install @workadventure/iframe-api-typings

$ yarn add @workadventure/iframe-api-typings