workadventure/docs/maps/api-nav.md

{.section-title.accent.text-primary}

API Navigation functions reference

Opening a web page in a new tab

WA.nav.openTab(url: string): void

Opens the webpage at "url" in your browser, in a new tab.

Example:

WA.nav.openTab('https://www.wikipedia.org/');

Opening a web page in the current tab

WA.nav.goToPage(url: string): void

Opens the webpage at "url" in your browser in place of WorkAdventure. WorkAdventure will be completely unloaded.

Example:

WA.nav.goToPage('https://www.wikipedia.org/');

Going to a different map from the script

WA.nav.goToRoom(url: string): void

Load the map at url without unloading workadventure

relative urls: "../subFolder/map.json[#start-layer-name]" global urls: "/_/global/domain/path/map.json[#start-layer-name]"

Example:

WA.nav.goToRoom("/@/tcm/workadventure/floor0")  // workadventure urls
WA.nav.goToRoom('../otherMap/map.json');
WA.nav.goToRoom("/_/global/<path to global map>.json#start-layer-2")

Opening/closing a web page in an iFrame

WA.nav.openCoWebSite(url: string, allowApi: boolean = false, allowPolicy: string = ""): void
WA.nav.closeCoWebSite(): void

Opens the webpage at "url" in an iFrame (on the right side of the screen) or close that iFrame. allowApi parameter allow the iframe to use the "IFrame API" and communicate with WorkAdventure. allowPolicy parameter grant additional rights to the iframe.

Example:

WA.nav.openCoWebSite('https://www.wikipedia.org/');
// ...
WA.nav.closeCoWebSite();