@workadventure/iframe-api-typings 1.21.1 → 1.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.21.1",
+  "version": "v1.22.0",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",

package/play/src/front/Api/Iframe/Player/ProximityMeeting.d.ts

@@ -99,21 +99,21 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
     })[];
     /**
      * Detecting when the user enter on a meeting.
-     * {@link https://workadventu.re/map-building/api-player.md#detecting-when-the-user-entersleaves-a-meeting | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#detecting-when-the-user-entersleaves-a-meeting | Website documentation}
      *
      * @returns {Subject<RemotePlayer[]>} Observable who return the joined users
      */
     onJoin(): Subject<RemotePlayer[]>;
     /**
      * Detecting when a participant joined on the current meeting.
-     * {@link https://workadventu.re/map-building/api-player.md#detecting-when-a-participant-entersleaves-the-current-meeting | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#detecting-when-a-participant-entersleaves-the-current-meeting | Website documentation}
      *
      * @returns {Subject<RemotePlayer>} Observable who return the joined user
      */
     onParticipantJoin(): Subject<RemotePlayer>;
     /**
      * Detecting when a participant left on the current meeting.
-     * {@link https://workadventu.re/map-building/api-player.md#detecting-when-a-participant-entersleaves-the-current-meeting | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#detecting-when-a-participant-entersleaves-the-current-meeting | Website documentation}
      *
      * @returns {Subject<RemotePlayer>} Observable who return the left user
      */

package/play/src/front/Api/Iframe/Ui/UIWebsite.d.ts

@@ -28,7 +28,7 @@ export declare class UIWebsiteCommands extends IframeApiContribution<UIWebsiteCo
     callbacks: never[];
     /**
      * Open an iFrame that is fixed in the viewport. Use this for advanced popups, additional buttons in the UI, HUD, etc... Returns a promise of a UIWebsite instance.
-     * {@link https://workadventu.re/map-building/api-ui.md#display-a-ui-website | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#display-a-ui-website | Website documentation}
      *
      * @param {CreateUIWebsiteEvent} createUIWebsite The details of the UIWebsite to create
      * @returns {Promise<UIWebsite>} Promise to return a UIWebsite
@@ -36,14 +36,14 @@ export declare class UIWebsiteCommands extends IframeApiContribution<UIWebsiteCo
     open(createUIWebsite: CreateUIWebsiteEvent): Promise<UIWebsite>;
     /**
      * Returns all UI websites (iframes positionned on the viewport)
-     * {@link https://workadventu.re/map-building/api-ui.md#get-all-ui-websites | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#get-all-ui-websites | Website documentation}
      *
      * @returns {Promise<UIWebsite[]>} Promise to return all UI websites
      */
     getAll(): Promise<UIWebsite[]>;
     /**
      * Returns one UI website (iframe positionned on the viewport) by ID.
-     * {@link https://workadventu.re/map-building/api-ui.md#get-all-ui-websites | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#get-all-ui-websites | Website documentation}
      * @param {string} id The id of the UIWebsite
      * @returns {Promise<UIWebsite | undefined>} Promise to return UI website
      */

package/play/src/front/Api/Iframe/area.d.ts

@@ -16,7 +16,7 @@ export declare class WorkadventureAreaCommands extends IframeApiContribution<Wor
     })[];
     /**
      * Create a new Area object (currently limited to rectangular shapes).
-     * {@link https://workadventu.re/map-building/api-room.md#create-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#create-area | Website documentation}
      *
      * @param {{name: string, x: number, y: number, width: number, height: number}} createAreaEvent Define the name, position and size of the area
      * @returns {Area} Area object
@@ -24,7 +24,7 @@ export declare class WorkadventureAreaCommands extends IframeApiContribution<Wor
     create(createAreaEvent: CreateDynamicAreaEvent): Area;
     /**
      * Get an existing Area object.
-     * {@link https://workadventu.re/map-building/api-room.md#get-an-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#get-an-area | Website documentation}
      *
      * @param {string} name Name of the area searched
      * @returns {Area} Area found
@@ -32,7 +32,7 @@ export declare class WorkadventureAreaCommands extends IframeApiContribution<Wor
     get(name: string): Promise<Area>;
     /**
      * Delete Area by it's name.
-     * {@link https://workadventu.re/map-building/api-room.md#delete-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#delete-area | Website documentation}
      *
      * @param {string} name Area name
      * @returns {Promise<void>} Promise resolved when the removing is finished
@@ -40,7 +40,7 @@ export declare class WorkadventureAreaCommands extends IframeApiContribution<Wor
     delete(name: string): Promise<void>;
     /**
      * Listens to the position of the current user. The event is triggered when the user enters a given area.
-     * {@link https://workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
      *
      * @param {string} areaName Area name
      * @returns {Subject<void>} An observable fired when someone enters the area
@@ -48,7 +48,7 @@ export declare class WorkadventureAreaCommands extends IframeApiContribution<Wor
     onEnter(areaName: string): Observable<void>;
     /**
      * Listens to the position of the current user. The event is triggered when the user leaves a given area.
-     * {@link https://workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
      *
      * @param {string} areaName Area name
      * @returns {Subject<void>} An observable fired when someone leaves the area

package/play/src/front/Api/Iframe/camera.d.ts

@@ -14,7 +14,7 @@ export declare class WorkAdventureCameraCommands extends IframeApiContribution<W
     }[];
     /**
      * Set camera to follow the player.
-     * {@link https://workadventu.re/map-building/api-camera.md#start-following-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-camera.md#start-following-player | Website documentation}
      *
      * @param smooth Smooth transition
      */
@@ -23,7 +23,7 @@ export declare class WorkAdventureCameraCommands extends IframeApiContribution<W
      * Set camera to look at given spot. Setting width and height will adjust zoom.
      * Set lock to true to lock camera in this position.
      * Set smooth to true for smooth transition.
-     * {@link https://workadventu.re/map-building/api-camera.md#set-spot-for-camera-to-look-at | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-camera.md#set-spot-for-camera-to-look-at | Website documentation}
      *
      * @param {number} x Horizontal position
      * @param {number} y Vertical position
@@ -36,7 +36,7 @@ export declare class WorkAdventureCameraCommands extends IframeApiContribution<W
     /**
      * Listens to updates of the camera viewport.
      * It will trigger for every update of the camera's properties (position or scale for instance).
-     * {@link https://workadventu.re/map-building/api-camera.md#listen-to-camera-updates | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-camera.md#listen-to-camera-updates | Website documentation}
      *
      * @returns {Subject<WasCameraUpdatedEvent>} An observable firing event when the camera is updated
      */

package/play/src/front/Api/Iframe/chat.d.ts

@@ -18,12 +18,12 @@ export declare class WorkadventureChatCommands<PublicState extends {
     }[];
     /**
      * Open instantly the chat window.
-     * {@link https://workadventu.re/map-building/api-chat.md#open-the-chat-window | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-chat.md#open-the-chat-window | Website documentation}
      */
     open(): void;
     /**
      * Close instantly the chat window.
-     * {@link https://workadventu.re/map-building/api-chat.md#close-the-chat-window | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-chat.md#close-the-chat-window | Website documentation}
      */
     close(): void;
     /**
@@ -54,7 +54,7 @@ export declare class WorkadventureChatCommands<PublicState extends {
     stopTyping(options: SendChatMessageOptions): void;
     /**
      * Listens to messages typed in the chat history.
-     * {@link https://workadventu.re/map-building/api-chat.md#listening-to-messages-from-the-chat | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-chat.md#listening-to-messages-from-the-chat | Website documentation}
      *
      * @param {function(message: string, event: { authorId: number|undefined, user: RemotePlayerInterface|undefined }): void} callback Function that will be called when a message is received. It contains the message typed by the user
      * @param {OnChatMessageOptions} options Options to decide if we listen only to messages from the local user (default) or from all users in the bubble.

package/play/src/front/Api/Iframe/controls.d.ts

@@ -3,112 +3,112 @@ export declare class WorkadventureControlsCommands extends IframeApiContribution
     callbacks: never[];
     /**
      *  Disable player controls.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-controls | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-controls | Website documentation}
      */
     disablePlayerControls(): void;
     /**
      * Restore player controls.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-controls | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-controls | Website documentation}
      */
     restorePlayerControls(): void;
     /**
      * Turn off player microphone.
-     * {@link https://workadventu.re/map-building/api-controls.md#turn-off-webcam-or-microphone | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#turn-off-webcam-or-microphone | Website documentation}
      */
     turnOffMicrophone(): void;
     /**
      * Turn off player webcam.
-     * {@link https://workadventu.re/map-building/api-controls.md#turn-off-webcam-or-microphone | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#turn-off-webcam-or-microphone | Website documentation}
      */
     turnOffWebcam(): void;
     /**
      * Disable player microphone.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
      */
     disableMicrophone(): void;
     /**
      * Restore player microphone.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
      */
     restoreMicrophone(): void;
     /**
      * Disable player webcam.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
      */
     disableWebcam(): void;
     /**
      * Disable player webcam.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
      */
     restoreWebcam(): void;
     /**
      * Disable proximity meetings.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-proximity-meeting | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-proximity-meeting | Website documentation}
      */
     disablePlayerProximityMeeting(): void;
     /**
      * Restore proximity meettings.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-proximity-meeting | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-proximity-meeting | Website documentation}
      */
     restorePlayerProximityMeeting(): void;
     /**
      * Disable map editor mode.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-map-editor | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-map-editor | Website documentation}
      */
     disableMapEditor(): void;
     /**
      * Restore map editor mode.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-map-editor | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-map-editor | Website documentation}
      */
     restoreMapEditor(): void;
     /**
      * Disable screen sharing.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-screen-sharing | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-screen-sharing | Website documentation}
      */
     disableScreenSharing(): void;
     /**
      * Restore screen sharing.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-screen-sharing | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-screen-sharing | Website documentation}
      */
     restoreScreenSharing(): void;
     /**
      * Disable wheel zoom.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-wheel-zoom | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-wheel-zoom | Website documentation}
      */
     disableWheelZoom(): void;
     /**
      * Restore wheel zoom.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-wheel-zoom | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-wheel-zoom | Website documentation}
      */
     restoreWheelZoom(): void;
     /**
      * Disable Right Click.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-right-click | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-right-click | Website documentation}
      */
     disableRightClick(): void;
     /**
      * Restore Right Click.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-right-click | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-right-click | Website documentation}
      */
     restoreRightClick(): void;
     /**
      * Disable invite button.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-invite-button | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-invite-button | Website documentation}
      */
     disableInviteButton(): void;
     /**
      * Restore invite button.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-invite-user-button | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-invite-user-button | Website documentation}
      */
     restoreInviteButton(): void;
     /**
      * Disable room list.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-room-list | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-room-list | Website documentation}
      */
     disableRoomList(): void;
     /**
      * Restore room list.
-     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-room-list | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-room-list | Website documentation}
      */
     restoreRoomList(): void;
 }

package/play/src/front/Api/Iframe/mapEditor.d.ts

@@ -14,7 +14,7 @@ declare class WorkadventureMapEditorAreaCommands extends IframeApiContribution<W
     })[];
     /**
      * Listens to the position of the current user. The event is triggered when the user enters a given area.
-     * {@link https://workadventu.re/map-building/api-mapeditor.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-mapeditor.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
      *
      * @param {string} areaName Area name
      * @returns {Subject<void>} An observable fired when someone enters the area
@@ -22,7 +22,7 @@ declare class WorkadventureMapEditorAreaCommands extends IframeApiContribution<W
     onEnter(areaName: string): Observable<void>;
     /**
      * Listens to the position of the current user. The event is triggered when the user leaves a given area.
-     * {@link https://workadventu.re/map-building/api-mapeditor.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-mapeditor.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
      *
      * @param {string} areaName Area name
      * @returns {Subject<void>} An observable fired when someone leaves the area

package/play/src/front/Api/Iframe/nav.d.ts

@@ -8,14 +8,14 @@ export declare class WorkadventureNavigationCommands extends IframeApiContributi
     callbacks: never[];
     /**
      * Opens the webpage at "url" in your browser, in a new tab.
-     * {@link https://workadventu.re/map-building/api-nav.md#opening-a-web-page-in-a-new-tab | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#opening-a-web-page-in-a-new-tab | Website documentation}
      *
      * @param {string} url Url of the web page
      */
     openTab(url: string): void;
     /**
      * Opens the webpage at "url" in your browser in place of WorkAdventure. WorkAdventure will be completely unloaded.
-     * {@link https://workadventu.re/map-building/api-nav.md#opening-a-web-page-in-the-current-tab | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#opening-a-web-page-in-the-current-tab | Website documentation}
      *
      * @param {string} url Url of the web page
      */
@@ -23,14 +23,14 @@ export declare class WorkadventureNavigationCommands extends IframeApiContributi
     /**
      * 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]"
-     * {@link https://workadventu.re/map-building/api-nav.md#going-to-a-different-map-from-the-script | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#going-to-a-different-map-from-the-script | Website documentation}
      *
      * @param {string} url Url of the web page
      */
     goToRoom(url: string): void;
     /**
      * Opens the webpage at "url" in an iFrame (on the right side of the screen) or close that iFrame.
-     * {@link https://workadventu.re/map-building/api-nav.md#openingclosing-web-page-in-co-websites | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#openingclosing-web-page-in-co-websites | Website documentation}
      *
      * @param {string} url Url of the web page
      * @param {boolean|undefined} allowApi  Allows the webpage to use the "IFrame API" and execute script (it is equivalent to putting the openWebsiteAllowApi property in the map)
@@ -44,7 +44,7 @@ export declare class WorkadventureNavigationCommands extends IframeApiContributi
     openCoWebSite(url: string, allowApi?: boolean, allowPolicy?: string, widthPercent?: number, position?: number, closable?: boolean, lazy?: boolean): Promise<CoWebsite>;
     /**
      * Get all opened co-websites with their ids and positions.
-     * {@link https://workadventu.re/map-building/api-nav.md#get-all-co-websites | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#get-all-co-websites | Website documentation}
      *
      * @returns {CoWebsite[]} All Cowebsites
      */

package/play/src/front/Api/Iframe/player.d.ts

@@ -26,7 +26,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player name.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-name | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-name | Website documentation}
      *
      * @returns {string} Player name
      */
@@ -34,7 +34,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player UUID.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-uuid | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-uuid | Website documentation}
      * @deprecated Use WA.player.uuid instead
      *
      * @returns {string|undefined} Player UUID
@@ -43,7 +43,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player id.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-id | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-id | Website documentation}
      *
      * @returns {number} Player id
      */
@@ -51,7 +51,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player UUID.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-uuid | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-uuid | Website documentation}
      *
      * @returns {string|undefined} Player UUID
      */
@@ -59,7 +59,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player language.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-language | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-language | Website documentation}
      *
      * @returns {string} Player language
      */
@@ -67,7 +67,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player tags.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-tags-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-tags-of-the-player | Website documentation}
      *
      * @returns {string[]} Player tags
      */
@@ -75,7 +75,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player position.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-position-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-position-of-the-player | Website documentation}
      *
      * @returns {Position} Player position
      */
@@ -83,7 +83,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Listens to the movement of the current user and calls the callback.
      * Sends an event when the user stops moving, changes direction and every 200ms when moving in the same direction.
-     * {@link https://workadventu.re/map-building/api-player.md#listen-to-player-movement | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#listen-to-player-movement | Website documentation}
      *
      * @param {HasPlayerMovedEventCallback} callback Function that will be called when the current player is moving. It contains the event
      * @return {Subscription} Subscription to the stream. Use ".unsubscribe()" to stop listening.
@@ -91,7 +91,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     onPlayerMove(callback: HasPlayerMovedEventCallback): Subscription;
     /**
      * Player will try to find the shortest path to the destination point and proceed to move there.
-     * {@link https://workadventu.re/map-building/api-player.md#move-player-to-position | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#move-player-to-position | Website documentation}
      *
      * @param {number} x Horizontal position
      * @param {number} y Vertical position
@@ -112,14 +112,14 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
      *
      * If you are using the self-hosted version of WorkAdventure and you developed your own administration panel, the token can be anything.
      * By default, self-hosted versions of WorkAdventure don't come with an administration panel, so the token string will be empty.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-user-room-token-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-user-room-token-of-the-player | Website documentation}
      *
      * @returns {string|undefined} User room token
      */
     get userRoomToken(): string | undefined;
     /**
      * Display a thin line around your player's name (the "outline").
-     * {@link https://workadventu.re/map-building/api-player.md#set-the-outline-color-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#set-the-outline-color-of-the-player | Website documentation}
      *
      * @param {number} red
      * @param {number} green
@@ -129,7 +129,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     setOutlineColor(red: number, green: number, blue: number): Promise<void>;
     /**
      * Remove the thin line around your player's name (the "outline").
-     * {@link https://workadventu.re/map-building/api-player.md#set-the-outline-color-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#set-the-outline-color-of-the-player | Website documentation}
      *
      * @returns {Promise<void>} Promise to await to known when the outline has been removed
      */
@@ -138,7 +138,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get a value to provide connected status for the current player.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-tags-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-tags-of-the-player | Website documentation}
      *
      * @returns {boolean} Player tags
      */
@@ -147,7 +147,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
      * Get a base64 string of the Woka image of the current player.
      * The Woka is in "still" position facing south.
      * @returns {Promise<string>}
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-woka-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-woka-of-the-player | Website documentation}
      *
      * @returns {Promise<string>} Current player woka in base64
      */

package/play/src/front/Api/Iframe/players.d.ts

@@ -61,7 +61,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     private registerRemotePlayer;
     /**
      * Start the tracking players. You need to call this method before being able to listen to players positions.
-     * {@link https://workadventu.re/map-building/api-players.md#enabling-players-tracking | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#enabling-players-tracking | Website documentation}
      *
      * ```ts
      * await WA.players.configureTracking({
@@ -78,7 +78,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     }): Promise<void>;
     /**
      * Listens to a given variable change on all available players.
-     * {@link https://workadventu.re/map-building/api-players.md#listen-to-a-remote-player-variable-changes | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#listen-to-a-remote-player-variable-changes | Website documentation}
      *
      * ```ts
      * WA.players.onVariableChange("score").subscribe({ player, value } => {
@@ -94,7 +94,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
      * These will be triggered when a remote player is entering our "zone" (zone ~= viewport)
      * This means this will NOT be triggered when a remote player enters the map, but when the remote player is
      * getting visible.
-     * {@link https://workadventu.re/map-building/api-players.md#tracking-players-in-real-time | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#tracking-players-in-real-time | Website documentation}
      *
      * Usage:
      *
@@ -108,7 +108,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
      * These will be triggered when a remote player is leaving our "zone" (zone ~= viewport)
      * This means this will be triggered when a remote player leaves the map, but ALSO when the remote player is
      * walking away and is no longer visible.
-     * {@link https://workadventu.re/map-building/api-players.md#tracking-players-in-real-time | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#tracking-players-in-real-time | Website documentation}
      *
      * Usage:
      *
@@ -120,7 +120,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     /**
      * Listens to movement from all players who are in our zone (zone ~= viewport)
      * This means this may NOT be triggered when a remote player moves but is far away from us.
-     * {@link https://workadventu.re/map-building/api-players.md#tracking-players-movement | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#tracking-players-movement | Website documentation}
      *
      * Usage:
      *
@@ -131,7 +131,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     get onPlayerMoves(): Observable<RemotePlayerMoved>;
     /**
      * Returns a RemotePlayer by its id.
-     * {@link https://workadventu.re/map-building/api-players.md#getting-a-remote-player-by-id | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#getting-a-remote-player-by-id | Website documentation}
      *
      * Note: if the same user is connected twice, it will be considered as 2 different players with 2 different IDs.
      */
@@ -139,7 +139,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     /**
      * Returns the list of all nearby remote players.
      * The list only contains the players in the same zone as the current player (where zone ~= viewport).
-     * {@link https://workadventu.re/map-building/api-players.md#getting-a-list-of-players-around-me | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#getting-a-list-of-players-around-me | Website documentation}
      */
     list(): IterableIterator<RemotePlayerInterface>;
 }

package/play/src/front/Api/Iframe/room.d.ts

@@ -45,7 +45,7 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
     onLeaveZone(name: string, callback: () => void): Subscription;
     /**
      * Listens to the position of the current user. The event is triggered when the user enters a given layer.
-     * {@link https://workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-a-layer | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-a-layer | Website documentation}
      *
      * @param {string} layerName Name of the layer who as defined in Tiled
      * @returns {Subject<void>} Event subject can be listen by a subscribtion
@@ -53,7 +53,7 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
     onEnterLayer(layerName: string): Observable<void>;
     /**
      * Listens to the position of the current user. The event is triggered when the user leaves a given layer.
-     * {@link https://workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-a-layer | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-a-layer | Website documentation}
      *
      * @param {string} layerName Name of the layer who as defined in Tiled
      * @returns {Subject<void>} Event subject can be listen by a subscribtion
@@ -61,14 +61,14 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
     onLeaveLayer(layerName: string): Observable<void>;
     /**
      * This methods can be used to show a layer. if layerName is the name of a group layer, show all the layer in that group layer.
-     * {@link https://workadventu.re/map-building/api-room.md#show--hide-a-layer | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#show--hide-a-layer | Website documentation}
      *
      * @param {string} layerName Name of the layer/group layer who as defined in Tiled
      */
     showLayer(layerName: string): void;
     /**
      * This methods can be used to hide a layer. if layerName is the name of a group layer, hide all the layer in that group layer.
-     * {@link https://workadventu.re/map-building/api-room.md#show--hide-a-layer | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#show--hide-a-layer | Website documentation}
      *
      * @param {string} layerName Name of the layer/group layer who as defined in Tiled
      */
@@ -77,7 +77,7 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
      * Set the value of the propertyName property of the layer layerName at propertyValue.
      * If the property doesn't exist, create the property propertyName and set the value of the property at propertyValue.
      * Note : To unset a property from a layer, use setProperty with propertyValue set to undefined.
-     * {@link https://workadventu.re/map-building/api-room.md#setcreate-properties-in-a-layer | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#setcreate-properties-in-a-layer | Website documentation}
      *
      * @param {string} layerName Name of the layer who as defined in Tiled
      * @param {string} propertyName Name of the property
@@ -87,14 +87,14 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
     /**
      * Returns a promise that resolves to the JSON map file.
      * Check the {@link https://doc.mapeditor.org/en/stable/reference/json-map-format/ | Tiled documentation to learn more about the format of the JSON map}.
-     * {@link https://workadventu.re/map-building/api-room.md#getting-map-data | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#getting-map-data | Website documentation}
      *
      * @returns {Promise<ITiledMap>} Map in Tiled JSON format
      */
     getTiledMap(): Promise<ITiledMap>;
     /**
      * Replace the tile at the x and y coordinates in the layer named layer by the tile with the id tile.
-     * {@link https://workadventu.re/map-building/api-room.md#changing-tiles | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#changing-tiles | Website documentation}
      *
      * @param {TileDescriptor[]} tiles Description of a tile
      */
@@ -102,7 +102,7 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
     /**
      * The ID of the current room is available from the WA.room.id property.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-room.md#get-the-room-id | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#get-the-room-id | Website documentation}
      *
      * @returns {string} Id of the room
      */
@@ -110,7 +110,7 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
     /**
      * The URL of the map is available from the WA.room.mapURL property.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-room.md#get-the-map-url | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#get-the-map-url | Website documentation}
      *
      * @returns {string} Url of the map
      */
@@ -122,7 +122,7 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
     get hashParameters(): Record<string, string>;
     /**
      * Load a tileset in JSON format from an url and return the id of the first tile of the loaded tileset.
-     * {@link https://workadventu.re/map-building/api-room.md#loading-a-tileset | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#loading-a-tileset | Website documentation}
      *
      * @param {string} url Url of the tileset
      * @returns {Promise<number>} Promise to return the id of the tileset

package/play/src/front/Api/Iframe/sound.d.ts

@@ -10,7 +10,7 @@ export declare class WorkadventureSoundCommands extends IframeApiContribution<Wo
      * The Sound class that represents a loaded sound contains two methods: play(soundConfig : SoundConfig|undefined) and stop().
      *
      * The parameter soundConfig is optional, if you call play without a Sound config the sound will be played with the basic configuration.
-     * {@link https://workadventu.re/map-building/api-sound.md#load-a-sound-from-an-url | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-sound.md#load-a-sound-from-an-url | Website documentation}
      *
      * @param url
      * @returns

package/play/src/front/Api/Iframe/ui.d.ts

@@ -85,7 +85,7 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     })[];
     /**
      * Open a popup in front of the game.
-     * {@link https://workadventu.re/map-building/api-ui.md#opening-a-popup | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#opening-a-popup | Website documentation}
      *
      * @param {string} targetObject Targeted object name
      * @param {string} message Message to display
@@ -95,7 +95,7 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     openPopup(targetObject: string, message: string, buttons: ButtonDescriptor[]): Popup;
     /**
      * Add a custom menu item containing the text commandDescriptor in the navbar of the menu. options attribute accepts an object.
-     * {@link https://workadventu.re/map-building/api-ui.md#add-custom-menu | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#add-custom-menu | Website documentation}
      *
      * @param {string} commandDescriptor Command description
      * @param {MenuOptions | ((commandDescriptor: string) => void)} options Manu options
@@ -122,7 +122,7 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     removeBubble(): void;
     /**
      * Displays a message at the bottom of the screen (that will disappear when space bar is pressed).
-     * {@link https://workadventu.re/map-building/api-ui.md#awaiting-user-confirmation-with-space-bar | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#awaiting-user-confirmation-with-space-bar | Website documentation}
      *
      * @param {ActionMessageOptions} actionMessageOptions Action options
      * @returns {ActionMessage} Trigger action message
@@ -130,7 +130,7 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     displayActionMessage(actionMessageOptions: ActionMessageOptions): ActionMessage;
     /**
      * Displays a player message at the top of the user head (that will disappear when space bar is pressed).
-     * {@link https://workadventu.re/map-building/api-ui.md#awaiting-user-confirmation-with-space-bar | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#awaiting-user-confirmation-with-space-bar | Website documentation}
      *
      * @param {PlayerMessageOptions} playerMessageOptions player options
      * @returns {PlayerMessage} Trigger player message

package/play/src/front/Api/Iframe/website.d.ts

@@ -5,7 +5,7 @@ export declare class WorkadventureRoomWebsiteCommands extends IframeApiContribut
     callbacks: never[];
     /**
      * You can get an instance of an embedded website by using the WA.room.website.get() method. It returns a promise of an EmbeddedWebsite instance.
-     * {@link https://workadventu.re/map-building/api-room.md#getting-an-instance-of-a-website-already-embedded-in-the-map | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#getting-an-instance-of-a-website-already-embedded-in-the-map | Website documentation}
      *
      * @param {string} objectName Object name
      * @returns {Promise<EmbeddedWebsite>} Promise to get a embed website
@@ -13,7 +13,7 @@ export declare class WorkadventureRoomWebsiteCommands extends IframeApiContribut
     get(objectName: string): Promise<EmbeddedWebsite>;
     /**
      * You can create an instance of an embedded website by using the WA.room.website.create() method. It returns an EmbeddedWebsite instance.
-     * {@link https://workadventu.re/map-building/api-room.md#adding-a-new-website-in-a-map | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#adding-a-new-website-in-a-map | Website documentation}
      *
      * @param createEmbeddedWebsiteEvent
      * @returns {EmbeddedWebsite} Created embed website
@@ -21,7 +21,7 @@ export declare class WorkadventureRoomWebsiteCommands extends IframeApiContribut
     create(createEmbeddedWebsiteEvent: CreateEmbeddedWebsiteEvent): EmbeddedWebsite;
     /**
      * Use WA.room.website.delete to completely remove an embedded website from your map.
-     * {@link https://workadventu.re/map-building/api-room.md#deleting-a-website-from-a-map | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#deleting-a-website-from-a-map | Website documentation}
      *
      * @param {string} objectName Object name
      * @returns {Promise<void>} Promise to away to known when the object has been deleted

package/play/src/iframe_api.d.ts

@@ -36,7 +36,7 @@ declare const wa: {
      * When your script / iFrame loads WorkAdventure, it takes a few milliseconds for your
      * script / iFrame to exchange data with WorkAdventure. You should wait for the WorkAdventure
      * API to be fully ready using the WA.onInit() method.
-     * {@link https://workadventu.re/map-building/api-start.md#waiting-for-workadventure-api-to-be-available | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-start.md#waiting-for-workadventure-api-to-be-available | Website documentation}
      *
      * Some properties (like the current username, or the room ID) are not available until WA.onInit has completed.
      *
@@ -46,7 +46,7 @@ declare const wa: {
     /**
      * The metadata sent by the administration website.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-metadata.md | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-metadata.md | Website documentation}
      *
      * @returns {unknown|undefined} Metadata
      */
@@ -54,7 +54,7 @@ declare const wa: {
     /**
      * The iframeId (only set if the code is executed from a UIWebsite iframe)
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-ui.md#get-ui-website-by-id | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#get-ui-website-by-id | Website documentation}
      *
      * @returns {string|undefined} IframeId
      */