@xeokit/xeokit-sdk 2.2.5-beta-2 → 2.2.5-beta-3

package/types/plugins/XKTLoaderPlugin/XKTLoaderPlugin.d.ts

@@ -1,15 +1,15 @@
 import { Plugin, Viewer, PerformanceModel, IFCObjectDefaults } from "../../viewer";
 
 export declare type XKTLoaderPluginConfiguration = {
-  /** Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}. */
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
   id?: string;
   /** Map of initial default states for each loaded {@link Entity} that represents an object.  Default value is {@link IFCObjectDefaults}.*/
   objectDefaults?: IFCObjectDefaults;
   /** A custom data source through which the XKTLoaderPlugin can load model and metadata files. Defaults to an instance of {@link XKTDefaultDataSource}, which loads uover HTTP. */
   dataSource?: IXKTDefaultDataSource;
-  /** When loading metadata, only loads objects that have {@link MetaObject}s with {@link MetaObject#type} values in this list. */
+  /** When loading metadata, only loads objects that have {@link MetaObject}s with {@link MetaObject.type} values in this list. */
   includeTypes?: string[];
-  /** When loading metadata, never loads objects that have {@link MetaObject}s with {@link MetaObject#type} values in this list. */
+  /** When loading metadata, never loads objects that have {@link MetaObject}s with {@link MetaObject.type} values in this list. */
   excludeTypes?: string[];
   /** When loading metadata and this is ````true````, will only load {@link Entity}s that have {@link MetaObject}s (that are not excluded). This is useful when we don't want Entitys in the Scene that are not represented within IFC navigation components, such as {@link TreeViewPlugin}. */
   excludeUnclassifiedObjects?: boolean;
@@ -20,7 +20,7 @@ export declare type XKTLoaderPluginConfiguration = {
 };
 
 export declare type LoadXKTModel = {
-  /** ID to assign to the root {@link Entity#id}, unique among all components in the Viewer's {@link Scene}, generated automatically by default. */
+  /** ID to assign to the root {@link Entity.id}, unique among all components in the Viewer's {@link Scene}, generated automatically by default. */
   id?: string;
   /** Path to a *````.xkt````* file, as an alternative to the ````xkt```` parameter. */
   src?: string;
@@ -32,9 +32,9 @@ export declare type LoadXKTModel = {
   metaModelData?: any;
   /** Map of initial default states for each loaded {@link Entity} that represents an object. Default value is {@link IFCObjectDefaults}. */
   objectDefaults?: object;
-  /** When loading metadata, only loads objects that have {@link MetaObject}s with {@link MetaObject#type} values in this list. */
+  /** When loading metadata, only loads objects that have {@link MetaObject}s with {@link MetaObject.type} values in this list. */
   includeTypes?: string[]
-  /** When loading metadata, never loads objects that have {@link MetaObject}s with {@link MetaObject#type} values in this list. */
+  /** When loading metadata, never loads objects that have {@link MetaObject}s with {@link MetaObject.type} values in this list. */
   excludeTypes?: string[];
   /** Whether or not xeokit renders the model with edges emphasized. */
   edges?: boolean;
@@ -48,15 +48,15 @@ export declare type LoadXKTModel = {
   rotation?: number[];
   /** The model's world transform matrix. Overrides the position, scale and rotation parameters. Relative to ````origin````.*/
   matrix?: number[];
-  /** Indicates if Scalable Ambient Obscurance (SAO) will apply to the model. SAO is configured by the Scene's {@link SAO} component. Only works when {@link SAO#enabled} is also ````true```` */
+  /** Indicates if Scalable Ambient Obscurance (SAO) will apply to the model. SAO is configured by the Scene's {@link SAO} component. Only works when {@link SAO.enabled} is also ````true```` */
   saoEnabled?: boolean;
-  /** Indicates if physically-based rendering (PBR) will apply to the model. Only works when {@link Scene#pbrEnabled} is also ````true````. */
+  /** Indicates if physically-based rendering (PBR) will apply to the model. Only works when {@link Scene.pbrEnabled} is also ````true````. */
   pbrEnabled?: boolean;
   /** When we set this ````true````, then we force rendering of backfaces for the model. */
   backfaces?: boolean;
   /** When loading metadata and this is ````true````, will only load {@link Entity}s that have {@link MetaObject}s (that are not excluded). */
   excludeUnclassifiedObjects?: boolean;
-  /** Indicates whether to globalize each {@link Entity#id} and {@link MetaObject#id}, in case you need to prevent ID clashes with other models. */
+  /** Indicates whether to globalize each {@link Entity.id} and {@link MetaObject.id}, in case you need to prevent ID clashes with other models. */
   globalizeObjectIds?: boolean;
   /** Indicates whether to enable geometry reuse */
   reuseGeometries?: boolean;
@@ -131,7 +131,7 @@ export declare interface IXKTDefaultDataSource {
    * Sets the whitelist of the IFC types loaded by this XKTLoaderPlugin.
    *
    * When loading models with metadata, causes this XKTLoaderPlugin to only load objects whose types are in this
-   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject#type}.
+   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
    *
    * Default value is ````undefined````.
    *
@@ -143,7 +143,7 @@ export declare interface IXKTDefaultDataSource {
    * Gets the whitelist of the IFC types loaded by this XKTLoaderPlugin.
    *
    * When loading models with metadata, causes this XKTLoaderPlugin to only load objects whose types are in this
-   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject#type}.
+   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
    *
    * Default value is ````undefined````.
    *
@@ -156,7 +156,7 @@ export declare interface IXKTDefaultDataSource {
    * Sets the blacklist of IFC types that are never loaded by this XKTLoaderPlugin.
    *
    * When loading models with metadata, causes this XKTLoaderPlugin to **not** load objects whose types are in this
-   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject#type}.
+   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
    *
    * Default value is ````undefined````.
    *
@@ -168,7 +168,7 @@ export declare interface IXKTDefaultDataSource {
    * Gets the blacklist of IFC types that are never loaded by this XKTLoaderPlugin.
    *
    * When loading models with metadata, causes this XKTLoaderPlugin to **not** load objects whose types are in this
-   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject#type}.
+   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
    *
    * Default value is ````undefined````.
    *
@@ -211,7 +211,7 @@ export declare interface IXKTDefaultDataSource {
    *
    * The result will be be less WebGL draw calls (which are expensive), at the cost of increased memory footprint.
    *
-   * See [#769](https://github.com/xeokit/xeokit-sdk/issues/769) for more info.
+   * See [.769](https://github.com/xeokit/xeokit-sdk/issues/769) for more info.
    *
    * @type {Boolean}
    */
@@ -233,15 +233,15 @@ export declare interface IXKTDefaultDataSource {
   get supportedVersions(): string[];
 
   /**
-   * Sets whether XKTLoaderPlugin globalizes each {@link Entity#id} and {@link MetaObject#id} as it loads a model.
+   * Sets whether XKTLoaderPlugin globalizes each {@link Entity.id} and {@link MetaObject.id} as it loads a model.
    *
    * Set  this ````true```` when you need to load multiple instances of the same model, to avoid ID clashes
    * between the objects in the different instances.
    *
-   * When we load a model with this set ````true````, then each {@link Entity#id} and {@link MetaObject#id} will be
-   * prefixed by the ID of the model, ie. ````<modelId>#<objectId>````.
+   * When we load a model with this set ````true````, then each {@link Entity.id} and {@link MetaObject.id} will be
+   * prefixed by the ID of the model, ie. ````<modelId>.<objectId>````.
    *
-   * {@link Entity#originalSystemId} and {@link MetaObject#originalSystemId} will always hold the original, un-prefixed, ID values.
+   * {@link Entity.originalSystemId} and {@link MetaObject.originalSystemId} will always hold the original, un-prefixed, ID values.
    *
    * Default value is ````false````.
    *
@@ -252,7 +252,7 @@ export declare interface IXKTDefaultDataSource {
   set globalizeObjectIds(arg: boolean);
 
   /**
-   * Gets whether XKTLoaderPlugin globalizes each {@link Entity#id} and {@link MetaObject#id} as it loads a model.
+   * Gets whether XKTLoaderPlugin globalizes each {@link Entity.id} and {@link MetaObject.id} as it loads a model.
    *
    * Default value is ````false````.
    *
@@ -271,7 +271,7 @@ export declare interface IXKTDefaultDataSource {
    * in data pipelines), then that metamodel will be loaded and the metamodel in the XKT 8 file will be ignored.
    *
    * @param {LoadXKTModel} params Loading parameters.
-   * @returns {PerformanceModel} Entity representing the model, which will have {@link Entity#isModel} set ````true```` and will be registered by {@link Entity#id} in {@link Scene#models}.
+   * @returns {PerformanceModel} Entity representing the model, which will have {@link Entity.isModel} set ````true```` and will be registered by {@link Entity.id} in {@link Scene.models}.
    */
   load(params: LoadXKTModel): PerformanceModel;
 }

package/types/plugins/XML3DLoaderPlugin/XML3DLoaderPlugin.d.ts

@@ -1,13 +1,13 @@
 import { Plugin, Viewer, PerformanceModel } from "../../viewer";
 
 export declare type XML3DLoaderPluginConfiguration = {
-  /** Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}. */
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
   id?: string;
   /** Path to the directory that contains the bundled [zip.js](https://gildas-lormeau.github.io/zip.js/) archive */
   workerScriptsPath: string;
   /** What type of materials to create while loading */
   materialType?: "MetallicMaterial" | "SpecularMaterial" | "PhongMaterial";
-  /** When true, will create a {@link MetaModel} for the model in {@link MetaScene#metaModels}. */
+  /** When true, will create a {@link MetaModel} for the model in {@link MetaScene.metaModels}. */
   createMetaModel?: boolean;
 }
 
@@ -32,7 +32,7 @@ export declare type LoadXML3DModel = {
   edgeThreshold?: number;
   /** What type of materials to create while loading: "MetallicMaterial" to create {@link MetallicMaterial}s, "SpecularMaterial" to create {@link SpecularMaterial}s or "PhongMaterial" to create {@link PhongMaterial}s. As it loads XML3D's Phong materials, the XMLLoaderPlugin will do its best approximate conversion of those to the specified workflow. */
   materialType?: "MetallicMaterial" | "SpecularMaterial" | "PhongMaterial";
-  /** When true, will create a {@link MetaModel} for the model in {@link MetaScene#metaModels}. */
+  /** When true, will create a {@link MetaModel} for the model in {@link MetaScene.metaModels}. */
   createMetaModel?: boolean;
 };
 
@@ -59,7 +59,7 @@ export declare class XML3DLoaderPlugin extends Plugin {
    * Creates a tree of {@link Entity}s within the Viewer's {@link Scene} that represents the model.
    *
    * @param {LoadXML3DModel} params  Loading parameters.
-   * @returns {Entity} Entity representing the model, which will have {@link Entity#isModel} set ````true```` and will be registered by {@link Entity#id} in {@link Scene#models}
+   * @returns {Entity} Entity representing the model, which will have {@link Entity.isModel} set ````true```` and will be registered by {@link Entity.id} in {@link Scene.models}
    */
   load(params: LoadXML3DModel): PerformanceModel;
 }

package/types/viewer/Plugin.d.ts

@@ -28,16 +28,16 @@ export declare abstract class Plugin {
     viewer: Viewer;
 
     /**
-     Subscribes to an event fired at this Plugin.
-     @param {String} event The event
-     @param {Function} callback Callback fired on the event
+     * Subscribes to an event fired at this Plugin.
+     * @param {String} event The event
+     * @param {Function} callback Callback fired on the event
      */
     on(event: string, callback: ()=> void): void;
 
     /**
-     Fires an event at this Plugin.
-     @param {String} event The event type name
-     @param {Object} value The event parameters
+     * Fires an event at this Plugin.
+     * @param {String} event The event type name
+     * @param {Object} value The event parameters
      */
     fire(event: string, value: any): void;
 

package/types/viewer/Viewer.d.ts

@@ -1,27 +1,27 @@
 import { LocaleService } from "./localization/LocaleService";
 import { Scene } from "./scene/scene/Scene";
 import { MetaScene } from "./metadata/MetaScene";
-import { Camera } from "./scene/Camera";
-import { CameraFlightAnimation } from "./scene/Camera/CameraFlightAnimation";
+import { Camera } from "./scene/camera/Camera";
+import { CameraFlightAnimation } from "./scene/camera/CameraFlightAnimation";
 import { CameraControl } from "./scene/CameraControl/CameraControl";
 import { Plugin } from "./Plugin";
 
 export declare type ViewerConfiguration = {
-  /** Optional ID for this Viewer, defaults to the ID of {@link Viewer#scene}, which xeokit automatically generates. */
+  /** Optional ID for this Viewer, defaults to the ID of {@link Viewer.scene}, which xeokit automatically generates. */
   id?: string;
-  /** ID of an existing HTML canvas for the {@link Viewer#scene} - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID. */
+  /** ID of an existing HTML canvas for the {@link Viewer.scene} - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID. */
   canvasId?: string;
-  /** Reference of an existing HTML canvas for the {@link Viewer#scene} - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID. */
+  /** Reference of an existing HTML canvas for the {@link Viewer.scene} - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID. */
   canvasElement?: HTMLCanvasElement;
   /** Optional reference to HTML element on which key events should be handled. Defaults to the HTML Document. */
   keyboardEventsElement?: HTMLElement;
   /** ID of existing HTML element to show the {@link Spinner} - internally creates a default element automatically if this is omitted. */
   spinnerElementId?: string;
-  /** The number of times the {@link Viewer#scene} renders per frame. */
+  /** The number of times the {@link Viewer.scene} renders per frame. */
   passes?: number;
   /** When doing multiple passes per frame, specifies if to clear the canvas before each pass (true) or just before the first pass (false). */
   clearEachPass?: boolean;
-  /** Whether or not to preserve the WebGL drawing buffer. This needs to be ````true```` for {@link Viewer#getSnapshot} to work.*/
+  /** Whether or not to preserve the WebGL drawing buffer. This needs to be ````true```` for {@link Viewer.getSnapshot} to work.*/
   preserveDrawingBuffer?: boolean;
   /** Whether or not the canvas is transparent. */
   transparent?: boolean;
@@ -35,7 +35,7 @@ export declare type ViewerConfiguration = {
   gammaFactor?: number;
   /** Sets the canvas background color to use when ````transparent```` is false. */
   backgroundColor?: number[];
-  /**When ````transparent```` is false, set this ````true```` to derive the canvas background color from {@link AmbientLight#color}, or ````false```` to set the canvas background to ````backgroundColor````. */
+  /**When ````transparent```` is false, set this ````true```` to derive the canvas background color from {@link AmbientLight.color}, or ````false```` to set the canvas background to ````backgroundColor````. */
   backgroundColorFromAmbientLight?: boolean;
   /** The measurement unit type. */
   units?: "meters" | "centimeters" | "millimeters" | "yards" | "feet" | "inches" ;
@@ -49,9 +49,9 @@ export declare type ViewerConfiguration = {
   antialias?: boolean;
   /** Whether writing into the depth buffer is enabled or disabled when rendering transparent objects. */
   alphaDepthMask?: boolean;
-  /** Whether to enable {@link Entity#offset}. For best performance, only set this ````true```` when you need to use {@link Entity#offset}. */
+  /** Whether to enable {@link Entity.offset}. For best performance, only set this ````true```` when you need to use {@link Entity.offset}. */
   entityOffsetsEnabled?: boolean;
-  /** Whether to enable full-precision accuracy when surface picking with {@link Scene#pick}. */
+  /** Whether to enable full-precision accuracy when surface picking with {@link Scene.pick}. */
   pickSurfacePrecisionEnabled?: boolean;
   /** Whether to enable logarithmic depth buffer. */
   logarithmicDepthBufferEnabled?: boolean;
@@ -109,7 +109,7 @@ export declare class Viewer {
   id: string | number;
 
   /**
-   * The Viewer's {@link Camera}. This is also found on {@link Scene#camera}.
+   * The Viewer's {@link Camera}. This is also found on {@link Scene.camera}.
    * @property camera
    * @type {Camera}
    */
@@ -166,14 +166,14 @@ export declare class Viewer {
    *
    * @private
    */
-  addPlugin(plugin: Plugin);
+  addPlugin(plugin: Plugin): void;
 
   /**
    * Enter snapshot mode.
    *
    * Switches rendering to a hidden snapshot canvas.
    *
-   * Exit snapshot mode using {@link Viewer#endSnapshot}.
+   * Exit snapshot mode using {@link Viewer.endSnapshot}.
    */
   beginSnapshot(): void;
 

package/types/viewer/localization/LocaleService.d.ts

@@ -7,170 +7,177 @@ export declare type LocaleServiceConfiguration = {
  * Localization service for a {@link Viewer}.
  */
 export declare class LocaleService {
-    /**
-     * @constructor
-     * @param {LocaleServiceConfiguration} cfg LocaleService configuration
-     */
-    constructor(cfg?: LocaleServiceConfiguration);
+  /**
+   * @constructor
+   * @param {LocaleServiceConfiguration} cfg LocaleService configuration
+   */
+  constructor(cfg?: LocaleServiceConfiguration);
 
-    /**
-     * Replaces the current set of locale translations.
-     *
-     * * Fires an "updated" event when done.
-     * * Automatically refreshes any plugins that depend on the translations.
-     * * Does not change the current locale.
-     *
-     * ## Usage
-     *
-     * ````javascript
-     * viewer.localeService.setMessages({
-     *     messages: {
-     *         "en": { // English
-     *             "NavCube": {
-     *                 "front": "Front",
-     *                 "back": "Back",
-     *                 "top": "Top",
-     *                 "bottom": "Bottom",
-     *                 "left": "Left",
-     *                 "right": "Right"
-     *             }
-     *         },
-     *         "mi": { // Māori
-     *             "NavCube": {
-     *                 "front": "Mua",
-     *                 "back": "Tuarā",
-     *                 "top": "Runga",
-     *                 "bottom": "Raro",
-     *                 "left": "Mauī",
-     *                 "right": "Tika"
-     *             }
-     *         }
-     *    }
-     * });
-     * ````
-     *
-     * @param {*} messages The new translations.
-     */
+  /**
+   * Replaces the current set of locale translations.
+   *
+   * * Fires an "updated" event when done.
+   * * Automatically refreshes any plugins that depend on the translations.
+   * * Does not change the current locale.
+   *
+   * ## Usage
+   *
+   * ````javascript
+   * viewer.localeService.setMessages({
+   *     messages: {
+   *         "en": { // English
+   *             "NavCube": {
+   *                 "front": "Front",
+   *                 "back": "Back",
+   *                 "top": "Top",
+   *                 "bottom": "Bottom",
+   *                 "left": "Left",
+   *                 "right": "Right"
+   *             }
+   *         },
+   *         "mi": { // Māori
+   *             "NavCube": {
+   *                 "front": "Mua",
+   *                 "back": "Tuarā",
+   *                 "top": "Runga",
+   *                 "bottom": "Raro",
+   *                 "left": "Mauī",
+   *                 "right": "Tika"
+   *             }
+   *         }
+   *    }
+   * });
+   * ````
+   *
+   * @param {*} messages The new translations.
+   */
 
-    set messages(arg: any);
+  set messages(arg: any);
 
-    /**
-     * Sets the current locale.
-     *
-     * * Fires an "updated" event when done.
-     * * The given locale does not need to be in the list of available locales returned by {@link LocaleService#locales}, since
-     * this method assumes that you may want to load the locales at a later point.
-     * * Automatically refreshes any plugins that depend on the translations.
-     * * We can then get translations for the locale, if translations have been loaded for it, via {@link LocaleService#translate} and {@link LocaleService#translatePlurals}.
-     *
-     * @param {String} locale The new current locale.
-     */
-    set locale(arg: string);
+  /**
+   * Sets the current locale.
+   *
+   * * Fires an "updated" event when done.
+   * * The given locale does not need to be in the list of available locales returned by {@link LocaleService.locales}, since
+   * this method assumes that you may want to load the locales at a later point.
+   * * Automatically refreshes any plugins that depend on the translations.
+   * * We can then get translations for the locale, if translations have been loaded for it, via {@link LocaleService.translate} and {@link LocaleService.translatePlurals}.
+   *
+   * @param {String} locale The new current locale.
+   */
+  set locale(arg: string);
 
-    /**
-     * Gets the current locale.
-     *
-     * @returns {String} The current locale.
-     */
-    get locale(): string;
+  /**
+   * Gets the current locale.
+   *
+   * @returns {String} The current locale.
+   */
+  get locale(): string;
 
-    /**
-     * Loads a new set of locale translations, adding them to the existing translations.
-     *
-     * * Fires an "updated" event when done.
-     * * Automatically refreshes any plugins that depend on the translations.
-     * * Does not change the current locale.
-     *
-     * ## Usage
-     *
-     * ````javascript
-     * viewer.localeService.loadMessages({
-     *     "jp": { // Japanese
-     *         "NavCube": {
-     *             "front": "前部",
-     *             "back": "裏",
-     *             "top": "上",
-     *             "bottom": "底",
-     *             "left": "左",
-     *             "right": "右"
-     *         }
-     *     }
-     * });
-     * ````
-     *
-     * @param {*} messages The new translations.
-     */
-    loadMessages(messages?: any): void;
+  /**
+   * Loads a new set of locale translations, adding them to the existing translations.
+   *
+   * * Fires an "updated" event when done.
+   * * Automatically refreshes any plugins that depend on the translations.
+   * * Does not change the current locale.
+   *
+   * ## Usage
+   *
+   * ````javascript
+   * viewer.localeService.loadMessages({
+   *     "jp": { // Japanese
+   *         "NavCube": {
+   *             "front": "前部",
+   *             "back": "裏",
+   *             "top": "上",
+   *             "bottom": "底",
+   *             "left": "左",
+   *             "right": "右"
+   *         }
+   *     }
+   * });
+   * ````
+   *
+   * @param {*} messages The new translations.
+   */
+  loadMessages(messages?: any): void;
 
-    /**
-     * Clears all locale translations.
-     *
-     * * Fires an "updated" event when done.
-     * * Does not change the current locale.
-     * * Automatically refreshes any plugins that depend on the translations, which will cause those
-     * plugins to fall back on their internal hard-coded text values, since this method removes all
-     * our translations.
-     */
-    clearMessages(): void;
+  /**
+   * Clears all locale translations.
+   *
+   * * Fires an "updated" event when done.
+   * * Does not change the current locale.
+   * * Automatically refreshes any plugins that depend on the translations, which will cause those
+   * plugins to fall back on their internal hard-coded text values, since this method removes all
+   * our translations.
+   */
+  clearMessages(): void;
 
-    /**
-     * Gets the list of available locales.
-     *
-     * These are derived from the currently configured set of translations.
-     *
-     * @returns {String[]} The list of available locales.
-     */
+  /**
+   * Gets the list of available locales.
+   *
+   * These are derived from the currently configured set of translations.
+   *
+   * @returns {String[]} The list of available locales.
+   */
 
-    get locales(): string[];
-    /**
-     * Translates the given string according to the current locale.
-     *
-     * Returns null if no translation can be found.
-     *
-     * @param {String} msg String to translate.
-     * @param {*} [args] Extra parameters.
-     * @returns {String|null} Translated string if found, else null.
-     */
+  get locales(): string[];
+  /**
+   * Translates the given string according to the current locale.
+   *
+   * Returns null if no translation can be found.
+   *
+   * @param {String} msg String to translate.
+   * @param {*} [args] Extra parameters.
+   * @returns {String|null} Translated string if found, else null.
+   */
 
-    translate(msg: string, args?: any): string | null;
+  translate(msg: string, args?: any): string | null;
 
-    /**
-     * Translates the given phrase according to the current locale.
-     *
-     * Returns null if no translation can be found.
-     *
-     * @param {String} msg Phrase to translate.
-     * @param {Number} count The plural number.
-     * @param {*} [args] Extra parameters.
-     * @returns {String|null} Translated string if found, else null.
-     */
-    translatePlurals(msg: string, count: number, args?: any): string | null;
+  /**
+   * Translates the given phrase according to the current locale.
+   *
+   * Returns null if no translation can be found.
+   *
+   * @param {String} msg Phrase to translate.
+   * @param {Number} count The plural number.
+   * @param {*} [args] Extra parameters.
+   * @returns {String|null} Translated string if found, else null.
+   */
+  translatePlurals(msg: string, count: number, args?: any): string | null;
 
-    /**
-     * Fires an event on this LocaleService.
-     *
-     * Notifies existing subscribers to the event, optionally retains the event to give to
-     * any subsequent notifications on the event as they are made.
-     *
-     * @param {String} event The event type name.
-     * @param {Object} value The event parameters.
-     * @param {Boolean} [forget=false] When true, does not retain for subsequent subscribers.
-     */
-    fire(event: string, value: any, forget?: boolean): void;
+  /**
+   * Fires an event on this LocaleService.
+   *
+   * Notifies existing subscribers to the event, optionally retains the event to give to
+   * any subsequent notifications on the event as they are made.
+   *
+   * @param {String} event The event type name.
+   * @param {Object} value The event parameters.
+   * @param {Boolean} [forget=false] When true, does not retain for subsequent subscribers.
+   */
+  fire(event: string, value: any, forget?: boolean): void;
 
-    /**
-     * Subscribes to an event on this LocaleService.
-     *
-     * @param {String} event The event
-     * @param {Function} callback Callback fired on the event
-     * @return {String} Handle to the subscription, which may be used to unsubscribe with {@link #off}.
-     */
-    on(event: string, callback: Function): string;
+  /**
+   * Subscribes to an event on this LocaleService.
+   *
+   * @param {String} event The event
+   * @param {Function} callback Callback fired on the event
+   * @return {String} Handle to the subscription, which may be used to unsubscribe with {@link .off}.
+   */
+  on(event: string, callback: Function): string;
 
-    /**
-     * Cancels an event subscription that was previously made with {@link LocaleService#on}.
-     *
-     * @param {String} subId Subscription ID
-     */
-    off(subId: string): void;
+  /**
+   * Cancels an event subscription that was previously made with {@link LocaleService.on}.
+   *
+   * @param {String} subId Subscription ID
+   */
+  off(subId: string): void;
+
+  /**
+   * Fires when the messages or the locale are updated 
+   * @param event The loaded event
+   * @param callback Called fired on the event
+   */
+  on(event: "updated", callback: (e: LocaleService | string) => void): string
 }

package/types/viewer/metadata/MetaModel.d.ts

@@ -9,9 +9,9 @@ export declare class MetaModel {
   /**
    * Globally-unique ID.
    *
-   * MetaModels are registered by ID in {@link MetaScene#metaModels}.
+   * MetaModels are registered by ID in {@link MetaScene.metaModels}.
    *
-   * When this MetaModel corresponds to an {@link Entity} then this ID will match the {@link Entity#id}.
+   * When this MetaModel corresponds to an {@link Entity} then this ID will match the {@link Entity.id}.
    *
    */
   id: string | number;