@workadventure/iframe-api-typings
Advanced tools
@workadventure/iframe-api-typings - npm Package Compare versions
Comparing version
| { | ||
| "name": "@workadventure/iframe-api-typings", | ||
| "version": "v1.21.1", | ||
| "version": "v1.22.0", | ||
| "description": "Typescript typings for WorkAdventure iFrame API", | ||
@@ -5,0 +5,0 @@ "main": "iframe_api.js", |
@@ -19,3 +19,3 @@ import type { Observable } from "rxjs"; | ||
| * 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} | ||
| * | ||
@@ -28,3 +28,3 @@ * @param {{name: string, x: number, y: number, width: number, height: number}} createAreaEvent Define the name, position and size of the 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} | ||
| * | ||
@@ -37,3 +37,3 @@ * @param {string} name Name of the area searched | ||
| * 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} | ||
| * | ||
@@ -46,3 +46,3 @@ * @param {string} name Area name | ||
| * 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} | ||
| * | ||
@@ -55,3 +55,3 @@ * @param {string} areaName Area name | ||
| * 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} | ||
| * | ||
@@ -58,0 +58,0 @@ * @param {string} areaName Area name |
@@ -17,3 +17,3 @@ import type { Observable } from "rxjs"; | ||
| * 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} | ||
| * | ||
@@ -27,3 +27,3 @@ * @param smooth Smooth transition | ||
| * 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} | ||
| * | ||
@@ -41,3 +41,3 @@ * @param {number} x Horizontal position | ||
| * 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} | ||
| * | ||
@@ -44,0 +44,0 @@ * @returns {Subject<WasCameraUpdatedEvent>} An observable firing event when the camera is updated |
@@ -21,3 +21,3 @@ import { Subscription } from "rxjs"; | ||
| * 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} | ||
| */ | ||
@@ -27,3 +27,3 @@ 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} | ||
| */ | ||
@@ -59,3 +59,3 @@ close(): 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} | ||
| * | ||
@@ -62,0 +62,0 @@ * @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 |
@@ -6,3 +6,3 @@ import { IframeApiContribution } from "./IframeApiContribution"; | ||
| * 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} | ||
| */ | ||
@@ -12,3 +12,3 @@ 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} | ||
| */ | ||
@@ -18,3 +18,3 @@ 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} | ||
| */ | ||
@@ -24,3 +24,3 @@ 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} | ||
| */ | ||
@@ -30,3 +30,3 @@ 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} | ||
| */ | ||
@@ -36,3 +36,3 @@ 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} | ||
| */ | ||
@@ -42,3 +42,3 @@ 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} | ||
| */ | ||
@@ -48,3 +48,3 @@ 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} | ||
| */ | ||
@@ -54,3 +54,3 @@ 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} | ||
| */ | ||
@@ -60,3 +60,3 @@ 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} | ||
| */ | ||
@@ -66,3 +66,3 @@ 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} | ||
| */ | ||
@@ -72,3 +72,3 @@ 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} | ||
| */ | ||
@@ -78,3 +78,3 @@ 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} | ||
| */ | ||
@@ -84,3 +84,3 @@ 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} | ||
| */ | ||
@@ -90,3 +90,3 @@ 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} | ||
| */ | ||
@@ -96,3 +96,3 @@ 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} | ||
| */ | ||
@@ -102,3 +102,3 @@ 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} | ||
| */ | ||
@@ -108,3 +108,3 @@ 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} | ||
| */ | ||
@@ -114,3 +114,3 @@ 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} | ||
| */ | ||
@@ -120,3 +120,3 @@ 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} | ||
| */ | ||
@@ -126,3 +126,3 @@ 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} | ||
| */ | ||
@@ -132,3 +132,3 @@ 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} | ||
| */ | ||
@@ -135,0 +135,0 @@ restoreRoomList(): void; |
@@ -17,3 +17,3 @@ import type { Observable } from "rxjs"; | ||
| * 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} | ||
| * | ||
@@ -26,3 +26,3 @@ * @param {string} areaName Area name | ||
| * 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} | ||
| * | ||
@@ -29,0 +29,0 @@ * @param {string} areaName Area name |
@@ -11,3 +11,3 @@ import { IframeApiContribution } from "./IframeApiContribution"; | ||
| * 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} | ||
| * | ||
@@ -19,3 +19,3 @@ * @param {string} url Url of the web page | ||
| * 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} | ||
| * | ||
@@ -28,3 +28,3 @@ * @param {string} url Url of the web page | ||
| * 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} | ||
| * | ||
@@ -36,3 +36,3 @@ * @param {string} url Url of the web page | ||
| * 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} | ||
| * | ||
@@ -51,3 +51,3 @@ * @param {string} url Url of the web page | ||
| * 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} | ||
| * | ||
@@ -54,0 +54,0 @@ * @returns {CoWebsite[]} All Cowebsites |
@@ -29,3 +29,3 @@ import { Subscription } from "rxjs"; | ||
| * 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} | ||
| * | ||
@@ -38,3 +38,3 @@ * @returns {string} 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-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 | ||
@@ -48,3 +48,3 @@ * | ||
| * 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} | ||
| * | ||
@@ -57,3 +57,3 @@ * @returns {number} 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-uuid | Website documentation} | ||
| * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-uuid | Website documentation} | ||
| * | ||
@@ -66,3 +66,3 @@ * @returns {string|undefined} 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-language | Website documentation} | ||
| * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-language | Website documentation} | ||
| * | ||
@@ -75,3 +75,3 @@ * @returns {string} 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-tags-of-the-player | Website documentation} | ||
| * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-tags-of-the-player | Website documentation} | ||
| * | ||
@@ -84,3 +84,3 @@ * @returns {string[]} 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-position-of-the-player | Website documentation} | ||
| * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-position-of-the-player | Website documentation} | ||
| * | ||
@@ -93,3 +93,3 @@ * @returns {Position} Player position | ||
| * 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} | ||
| * | ||
@@ -102,3 +102,3 @@ * @param {HasPlayerMovedEventCallback} callback Function that will be called when the current player is moving. It contains the event | ||
| * 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} | ||
| * | ||
@@ -124,3 +124,3 @@ * @param {number} x Horizontal position | ||
| * 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} | ||
| * | ||
@@ -132,3 +132,3 @@ * @returns {string|undefined} User room token | ||
| * 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} | ||
| * | ||
@@ -143,3 +143,3 @@ * @param {number} red | ||
| * 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} | ||
| * | ||
@@ -153,3 +153,3 @@ * @returns {Promise<void>} Promise to await to known when the outline has been removed | ||
| * 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} | ||
| * | ||
@@ -163,3 +163,3 @@ * @returns {boolean} Player tags | ||
| * @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} | ||
| * | ||
@@ -166,0 +166,0 @@ * @returns {Promise<string>} Current player woka in base64 |
@@ -102,3 +102,3 @@ import { Subject } from "rxjs"; | ||
| * 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} | ||
| * | ||
@@ -110,3 +110,3 @@ * @returns {Subject<RemotePlayer[]>} Observable who return the joined users | ||
| * 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} | ||
| * | ||
@@ -118,3 +118,3 @@ * @returns {Subject<RemotePlayer>} Observable who return the joined user | ||
| * 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} | ||
| * | ||
@@ -121,0 +121,0 @@ * @returns {Subject<RemotePlayer>} Observable who return the left user |
@@ -64,3 +64,3 @@ import type { Observable } from "rxjs"; | ||
| * 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} | ||
| * | ||
@@ -82,3 +82,3 @@ * ```ts | ||
| * 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} | ||
| * | ||
@@ -99,3 +99,3 @@ * ```ts | ||
| * 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} | ||
| * | ||
@@ -114,3 +114,3 @@ * Usage: | ||
| * 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} | ||
| * | ||
@@ -127,3 +127,3 @@ * Usage: | ||
| * 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} | ||
| * | ||
@@ -139,3 +139,3 @@ * Usage: | ||
| * 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} | ||
| * | ||
@@ -148,3 +148,3 @@ * Note: if the same user is connected twice, it will be considered as 2 different players with 2 different IDs. | ||
| * 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} | ||
| */ | ||
@@ -151,0 +151,0 @@ list(): IterableIterator<RemotePlayerInterface>; |
@@ -48,3 +48,3 @@ import type { Observable } from "rxjs"; | ||
| * 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} | ||
| * | ||
@@ -57,3 +57,3 @@ * @param {string} layerName Name of the layer who as defined in Tiled | ||
| * 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} | ||
| * | ||
@@ -66,3 +66,3 @@ * @param {string} layerName Name of the layer who as defined in Tiled | ||
| * 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} | ||
| * | ||
@@ -74,3 +74,3 @@ * @param {string} layerName Name of the layer/group layer who as defined in Tiled | ||
| * 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} | ||
| * | ||
@@ -84,3 +84,3 @@ * @param {string} layerName Name of the layer/group layer who as defined in Tiled | ||
| * 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} | ||
| * | ||
@@ -95,3 +95,3 @@ * @param {string} layerName Name of the layer who as defined in Tiled | ||
| * 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} | ||
| * | ||
@@ -103,3 +103,3 @@ * @returns {Promise<ITiledMap>} Map in Tiled JSON format | ||
| * 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} | ||
| * | ||
@@ -112,3 +112,3 @@ * @param {TileDescriptor[]} tiles Description of a tile | ||
| * 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} | ||
| * | ||
@@ -121,3 +121,3 @@ * @returns {string} Id of the room | ||
| * 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} | ||
| * | ||
@@ -134,3 +134,3 @@ * @returns {string} Url of the map | ||
| * 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} | ||
| * | ||
@@ -137,0 +137,0 @@ * @param {string} url Url of the tileset |
@@ -13,3 +13,3 @@ import { IframeApiContribution } from "./IframeApiContribution"; | ||
| * 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} | ||
| * | ||
@@ -16,0 +16,0 @@ * @param url |
@@ -88,3 +88,3 @@ import type { Observable } from "rxjs"; | ||
| * 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} | ||
| * | ||
@@ -99,3 +99,3 @@ * @param {string} targetObject Targeted object name | ||
| * 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} | ||
| * | ||
@@ -127,3 +127,3 @@ * @param {string} commandDescriptor Command description | ||
| * 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} | ||
| * | ||
@@ -136,3 +136,3 @@ * @param {ActionMessageOptions} actionMessageOptions Action options | ||
| * 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} | ||
| * | ||
@@ -139,0 +139,0 @@ * @param {PlayerMessageOptions} playerMessageOptions player options |
@@ -31,3 +31,3 @@ import type { CreateUIWebsiteEvent, UIWebsiteMargin, UIWebsitePosition, UIWebsiteSize, UIWebsiteEvent } from "../../Events/Ui/UIWebsiteEvent"; | ||
| * 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} | ||
| * | ||
@@ -40,3 +40,3 @@ * @param {CreateUIWebsiteEvent} createUIWebsite The details of the UIWebsite to create | ||
| * 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} | ||
| * | ||
@@ -48,3 +48,3 @@ * @returns {Promise<UIWebsite[]>} Promise to return all UI websites | ||
| * 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 | ||
@@ -51,0 +51,0 @@ * @returns {Promise<UIWebsite | undefined>} Promise to return UI website |
@@ -8,3 +8,3 @@ import type { CreateEmbeddedWebsiteEvent } from "../Events/EmbeddedWebsiteEvent"; | ||
| * 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} | ||
| * | ||
@@ -17,3 +17,3 @@ * @param {string} objectName Object name | ||
| * 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} | ||
| * | ||
@@ -26,3 +26,3 @@ * @param createEmbeddedWebsiteEvent | ||
| * 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} | ||
| * | ||
@@ -29,0 +29,0 @@ * @param {string} objectName Object name |
@@ -39,3 +39,3 @@ import type { CoWebsite } from "./front/Api/Iframe/nav"; | ||
| * 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} | ||
| * | ||
@@ -50,3 +50,3 @@ * Some properties (like the current username, or the room ID) are not available until WA.onInit has completed. | ||
| * 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} | ||
| * | ||
@@ -59,3 +59,3 @@ * @returns {unknown|undefined} Metadata | ||
| * 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} | ||
| * | ||
@@ -62,0 +62,0 @@ * @returns {string|undefined} IframeId |
New alerts
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
Fixed alerts
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
262302
0.17%