@workadventure/iframe-api-typings
Advanced tools
Changelog
Version 1.5.0
openTab
property (#1419)Changelog
Version 1.4.14
WA.room.loadTileset(url: string) : Promise<number>
to load a tileset from a JSON file.Changelog
Version 1.4.15
WA.ui.registerMenuCommand(commandDescriptor: string, options: MenuOptions): Menu
to add a custom menu or an iframe to the menu.jitsiWidth
parameter to set the width of Jitsi and Cowebsite (#1398 @tabascoeye)WA.room.setPropertyLayer
now have a real-time impact (#1395)WA.state
now answers correctly to "in" keyword (#1393)Changelog
Version 1.4.11
exitUrl
, silent
, etc...) can now also used in tile properties #1210 (@jonnytest1)WA.onInit(): Promise<void>
to wait for scripting API initializationWA.room.showLayer(): void
to show a layerWA.room.hideLayer(): void
to hide a layerWA.room.setProperty() : void
to add, delete or change existing property of a layerWA.player.onPlayerMove(): void
to track the movement of the current playerWA.player.id: string|undefined
to get the ID of the current playerWA.player.name: string
to get the name of the current playerWA.player.tags: string[]
to get the tags of the current playerWA.room.id: string
to get the ID of the roomWA.room.mapURL: string
to get the URL of the mapWA.room.mapURL: string
to get the URL of the mapWA.room.getMap(): Promise<ITiledMap>
to get the JSON map fileWA.room.setTiles(): void
to add, delete or change an array of tilesWA.ui.registerMenuCommand(): void
to add a custom menuWA.state.loadVariable(key: string): unknown
to retrieve a variableWA.state.saveVariable(key: string, value: unknown): Promise<void>
to set a variable (across the room, for all users)WA.state.onVariableChange(key: string): Observable<unknown>
to track a variableWA.state.[any variable]: unknown
to access directly any variable (this is a shortcut to using WA.state.loadVariable
and WA.state.saveVariable
)/api/map
: now accepts a complete room URL instead of organization/world/room slugs/api/ban
: new endpoint to report users