melonjs 18.0.0 → 18.2.0

package/build/renderable/trigger.d.ts

@@ -4,6 +4,7 @@
  */
 /**
  * trigger an event when colliding with another object
+ * @category Game Objects
  */
 export default class Trigger extends Renderable {
     /**

package/build/renderable/trigger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../src/renderable/trigger.js"],"names":[],"mappings":"AAOA;;;GAGG;AAEH;;GAEG;AACH;IACC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,eAxBW,MAAM,KACN,MAAM,YAEd;QAA0B,KAAK;QACL,MAAM;QACqB,MAAM;QACjC,QAAQ;QACF,KAAK,GAA7B,MAAM,GAAC,KAAK;QACM,KAAK;QACL,EAAE;QACQ,SAAS,GAArC,MAAM,GAAC,SAAS;QACI,QAAQ;QACT,OAAO;QACP,iBAAiB;KAC5C,EA+DF;IA9CA,UAAyB;IACzB,6BAAiC;IACjC,gBAAmB;IAInB,UAAyB;IACzB,QAAqB;IAGrB,8BAA4B;IAG5B;;MAGC;IAwBD,UAAiC;IAQlC;;OAEG;IACH;;MASC;IAED;;OAEG;IACH,uBAIC;IAED;;;OAGG;IACH,+BAqBC;CAcD;uBAzJsB,iBAAiB"}
+{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../src/renderable/trigger.js"],"names":[],"mappings":"AAOA;;;GAGG;AAEH;;;GAGG;AACH;IACC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,eAxBW,MAAM,KACN,MAAM,YAEd;QAA0B,KAAK;QACL,MAAM;QACqB,MAAM;QACjC,QAAQ;QACF,KAAK,GAA7B,MAAM,GAAC,KAAK;QACM,KAAK;QACL,EAAE;QACQ,SAAS,GAArC,MAAM,GAAC,SAAS;QACI,QAAQ;QACT,OAAO;QACP,iBAAiB;KAC5C,EA+DF;IA9CA,UAAyB;IACzB,6BAAiC;IACjC,gBAAmB;IAInB,UAAyB;IACzB,QAAqB;IAGrB,8BAA4B;IAG5B;;MAGC;IAwBD,UAAiC;IAQlC;;OAEG;IACH;;MASC;IAED;;OAEG;IACH,uBAIC;IAED;;;OAGG;IACH,+BAqBC;CAcD;uBA1JsB,iBAAiB"}

package/build/renderable/ui/uibaseelement.d.ts

@@ -1,105 +1,111 @@
+import type Pointer from "./../../input/pointer.ts";
+import type { Vector2d } from "../../math/vector2d.ts";
+import Container from "../container.js";
 /**
  * This is a basic clickable and draggable container which you can use in your game UI.
  * Use this for example if you want to display a panel that contains text, images or other UI elements.
+ * @category UI
  */
 export default class UIBaseElement extends Container {
+    #private;
     /**
-     *
-     * @param {number} x - The x position of the container
-     * @param {number} y - The y position of the container
-     * @param {number} w - width of the container
-     * @param {number} h - height of the container
+     * UI base elements use screen coordinates by default
+     * (Note: any child elements added to a UIBaseElement should have their floating property to false)
+     * @see Renderable.floating
+     * @default true
      */
-    constructor(x: number, y: number, w: number, h: number);
+    floating: boolean;
     /**
      * object can be clicked or not
-     * @type {boolean}
      * @default true
      */
     isClickable: boolean;
     /**
-     * object can be clicked or not
-     * @type {boolean}
+     * object can be dragged or not
      * @default false
      */
     isDraggable: boolean;
     /**
      * Tap and hold threshold timeout in ms
-     * @type {number}
      * @default 250
      */
     holdThreshold: number;
     /**
      * object can be tap and hold
-     * @type {boolean}
      * @default false
      */
     isHoldable: boolean;
     /**
      * true if the pointer is over the object
-     * @type {boolean}
      * @default false
      */
     hover: boolean;
     /**
      * false if the pointer is down, or true when the pointer status is up
-     * @type {boolean}
-     * @default false
+     * @default true
      */
     released: boolean;
     holdTimeout: number;
+    grabOffset: Vector2d | undefined;
+    /**
+     * @param x - The x position of the container
+     * @param y - The y position of the container
+     * @param w - width of the container
+     * @param h - height of the container
+     */
+    constructor(x: number, y: number, w?: number, h?: number);
     /**
      * function callback for the pointerdown event
      * @ignore
      */
-    clicked(event: any): boolean | undefined;
+    clicked(event: Pointer): boolean | void;
     /**
      * function called when the object is pressed (to be extended)
-     * @param {Pointer} event - the event object
-     * @returns {boolean} return false if we need to stop propagating the event
+     * @param _event - the event object
+     * @returns return false if we need to stop propagating the event
      */
-    onClick(): boolean;
+    onClick(_event?: Pointer): boolean;
     /**
      * function callback for the pointerEnter event
      * @ignore
      */
-    enter(event: any): void;
-    grabOffset: import("../../index.js").Vector2d | undefined;
+    enter(event: Pointer): void;
     /**
      * pointermove function
      * @ignore
      */
-    pointerMove(event: any): void;
+    pointerMove(event: Pointer): void;
     /**
      * function called when the pointer is moved over the object
-     * @param {Pointer} event - the event object
+     * @param _event - the event object
      */
-    onMove(): void;
+    onMove(_event?: Pointer): void;
     /**
      * function called when the pointer is over the object
-     * @param {Pointer} event - the event object
+     * @param _event - the event object
      */
-    onOver(): void;
+    onOver(_event?: Pointer): void;
     /**
      * function callback for the pointerLeave event
      * @ignore
      */
-    leave(event: any): void;
+    leave(event: Pointer): void;
     /**
      * function called when the pointer is leaving the object area
-     * @param {Pointer} event - the event object
+     * @param _event - the event object
      */
-    onOut(): void;
+    onOut(_event?: Pointer): void;
     /**
      * function callback for the pointerup event
      * @ignore
      */
-    release(event: any): boolean | undefined;
+    release(event: Pointer): boolean | void;
     /**
      * function called when the object is pressed and released (to be extended)
-     * @returns {boolean} return false if we need to stop propagating the event
+     * @param _event - the event object
+     * @returns return false if we need to stop propagating the event
      */
-    onRelease(): boolean;
+    onRelease(_event?: Pointer): boolean;
     /**
      * function callback for the tap and hold timer event
      * @ignore
@@ -110,7 +116,15 @@ export default class UIBaseElement extends Container {
      * to be extended <br>
      */
     onHold(): void;
-    #private;
+    /**
+     * function called when added to the game world or a container
+     * @ignore
+     */
+    onActivateEvent(): void;
+    /**
+     * function called when removed from the game world or a container
+     * @ignore
+     */
+    onDeactivateEvent(): void;
 }
-import Container from "../container.js";
 //# sourceMappingURL=uibaseelement.d.ts.map

package/build/renderable/ui/uibaseelement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uibaseelement.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uibaseelement.js"],"names":[],"mappings":"AASA;;;GAGG;AACH;IAYC;;;;;;OAMG;IACH,eALW,MAAM,KACN,MAAM,KACN,MAAM,KACN,MAAM,EAwDhB;IApDA;;;;OAIG;IACH,aAHU,OAAO,CAGM;IAEvB;;;;OAIG;IACH,aAHU,OAAO,CAGO;IAExB;;;;OAIG;IACH,eAHU,MAAM,CAGQ;IAExB;;;;OAIG;IACH,YAHU,OAAO,CAGM;IAEvB;;;;OAIG;IACH,OAHU,OAAO,CAGC;IAElB;;;;OAIG;IACH,UAHU,OAAO,CAGG;IAGpB,oBAAqB;IAWtB;;;OAGG;IACH,yCAsBC;IAED;;;;OAIG;IACH,WAFa,OAAO,CAInB;IAED;;;OAGG;IACH,wBASC;IAHC,0DAAwC;IAK1C;;;OAGG;IACH,8BASC;IAED;;;OAGG;IACH,eAEC;IAED;;;OAGG;IACH,eAEC;IAED;;;OAGG;IACH,wBAWC;IAED;;;OAGG;IACH,cAEC;IAED;;;OAGG;IACH,yCAQC;IAED;;;OAGG;IACH,aAFa,OAAO,CAInB;IAED;;;OAGG;IACH,aAOC;IAED;;;OAGG;IACH,eAAW;;CAyDX;sBA7RqB,iBAAiB"}
+{"version":3,"file":"uibaseelement.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uibaseelement.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAC;AACpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAIvD,OAAO,SAAS,MAAM,iBAAiB,CAAC;AAExC;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,SAAS;;IAGnD;;;;;OAKG;IACM,QAAQ,UAAQ;IAEzB;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAGlB,WAAW,EAAE,MAAM,CAAC;IAGpB,UAAU,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEjC;;;;;OAKG;gBACS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM;IAoBxD;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI;IAwBvC;;;;OAIG;IAEH,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAIlC;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAW3B;;;OAGG;IACH,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAajC;;;OAGG;IAEH,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAI9B;;;OAGG;IAEH,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAI9B;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAa3B;;;OAGG;IAEH,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAI7B;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI;IAUvC;;;;OAIG;IAEH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAIpC;;;OAGG;IACH,IAAI,IAAI,IAAI;IASZ;;;OAGG;IACH,MAAM,IAAI,IAAI;IAEd;;;OAGG;IACM,eAAe,IAAI,IAAI;IAsBhC;;;OAGG;IACM,iBAAiB,IAAI,IAAI;CAyBlC"}

package/build/renderable/ui/uispriteelement.d.ts

@@ -1,11 +1,44 @@
+import type Pointer from "./../../input/pointer.ts";
+import Sprite from "./../sprite.js";
 /**
  * This is a basic sprite based button which you can use in your Game UI.
+ * @category UI
  */
 export default class UISpriteElement extends Sprite {
     /**
-     * @param {number} x - the x coordinate of the UISpriteElement Object
-     * @param {number} y - the y coordinate of the UISpriteElement Object
-     * @param {object} settings - See {@link Sprite}
+     * if this UISpriteElement should use screen coordinates or local coordinates
+     * (Note: any UISpriteElement elements added to a floating parent container should have their floating property to false)
+     * @see Renderable.floating
+     * @default true
+     */
+    floating: boolean;
+    /**
+     * object can be clicked or not
+     * @default true
+     */
+    isClickable: boolean;
+    /**
+     * Tap and hold threshold timeout in ms
+     * @default 250
+     */
+    holdThreshold: number;
+    /**
+     * object can be tap and hold
+     * @default false
+     */
+    isHoldable: boolean;
+    /**
+     * true if the pointer is over the object
+     * @default false
+     */
+    hover: boolean;
+    holdTimeout: number;
+    released: boolean;
+    /**
+     * @param x - the x coordinate of the UISpriteElement Object
+     * @param y - the y coordinate of the UISpriteElement Object
+     * @param settings - See {@link Sprite}
+     * @param settings.image - the image to use for the sprite
      * @example
      * // create a basic GUI Object
      * class myButton extends UISpriteElement {
@@ -30,73 +63,52 @@ export default class UISpriteElement extends Sprite {
      * // add the object at pos (10,10)
      * world.addChild(new myButton(10,10));
      */
-    constructor(x: number, y: number, settings: object);
-    /**
-     * object can be clicked or not
-     * @type {boolean}
-     * @default true
-     */
-    isClickable: boolean;
-    /**
-     * Tap and hold threshold timeout in ms
-     * @type {number}
-     * @default 250
-     */
-    holdThreshold: number;
-    /**
-     * object can be tap and hold
-     * @type {boolean}
-     * @default false
-     */
-    isHoldable: boolean;
-    /**
-     * true if the pointer is over the object
-     * @type {boolean}
-     * @default false
-     */
-    hover: boolean;
-    holdTimeout: number;
-    released: boolean;
+    constructor(x: number, y: number, settings: {
+        image: any;
+        [key: string]: any;
+    });
     /**
      * function callback for the pointerdown event
      * @ignore
      */
-    clicked(event: any): boolean | undefined;
+    clicked(event: Pointer): boolean | void;
     /**
      * function called when the object is pressed (to be extended)
-     * @returns {boolean} return false if we need to stop propagating the event
+     * @param _event - the event object
+     * @returns return false if we need to stop propagating the event
      */
-    onClick(): boolean;
+    onClick(_event?: Pointer): boolean;
     /**
      * function callback for the pointerEnter event
      * @ignore
      */
-    enter(event: any): void;
+    enter(event: Pointer): void;
     /**
      * function called when the pointer is over the object
-     * @param {Pointer} event - the event object
+     * @param _event - the event object
      */
-    onOver(): void;
+    onOver(_event?: Pointer): void;
     /**
      * function callback for the pointerLeave event
      * @ignore
      */
-    leave(event: any): void;
+    leave(event: Pointer): void;
     /**
      * function called when the pointer is leaving the object area
-     * @param {Pointer} event - the event object
+     * @param _event - the event object
      */
-    onOut(): void;
+    onOut(_event?: Pointer): void;
     /**
      * function callback for the pointerup event
      * @ignore
      */
-    release(event: any): boolean | undefined;
+    release(event: Pointer): boolean | void;
     /**
      * function called when the object is pressed and released (to be extended)
-     * @returns {boolean} return false if we need to stop propagating the event
+     * @param _event - the event object
+     * @returns return false if we need to stop propagating the event
      */
-    onRelease(): boolean;
+    onRelease(_event?: Pointer): boolean;
     /**
      * function callback for the tap and hold timer event
      * @ignore
@@ -118,5 +130,4 @@ export default class UISpriteElement extends Sprite {
      */
     onDeactivateEvent(): void;
 }
-import Sprite from "./../sprite.js";
 //# sourceMappingURL=uispriteelement.d.ts.map

package/build/renderable/ui/uispriteelement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uispriteelement.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uispriteelement.js"],"names":[],"mappings":"AAOA;;GAEG;AACH;IAUC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,eA3BW,MAAM,KACN,MAAM,YACN,MAAM,EA+DhB;IAlCA;;;;OAIG;IACH,aAHU,OAAO,CAGM;IAEvB;;;;OAIG;IACH,eAHU,MAAM,CAGQ;IAExB;;;;OAIG;IACH,YAHU,OAAO,CAGM;IAEvB;;;;OAIG;IACH,OAHU,OAAO,CAGC;IAGlB,oBAAqB;IACrB,kBAAoB;IAMrB;;;OAGG;IACH,yCAkBC;IAED;;;OAGG;IACH,WAFa,OAAO,CAInB;IAED;;;OAGG;IACH,wBAIC;IAED;;;OAGG;IACH,eAEC;IAED;;;OAGG;IACH,wBAKC;IAED;;;OAGG;IACH,cAEC;IAED;;;OAGG;IACH,yCAQC;IAED;;;OAGG;IACH,aAFa,OAAO,CAInB;IAED;;;OAGG;IACH,aAOC;IAED;;;OAGG;IACH,eAAW;IAEX;;;OAGG;IACH,wBAiBC;IAED;;;OAGG;IACH,0BASC;CACD;mBAtOkB,gBAAgB"}
+{"version":3,"file":"uispriteelement.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uispriteelement.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAC;AAEpD,OAAO,MAAM,MAAM,gBAAgB,CAAC;AAEpC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,MAAM;IAClD;;;;;OAKG;IACM,QAAQ,UAAQ;IAEzB;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IAGf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;gBAEF,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,QAAQ,EAAE;QAAE,KAAK,EAAE,GAAG,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAgB7C;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI;IAoBvC;;;;OAIG;IAEH,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAIlC;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAM3B;;;OAGG;IAEH,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAI9B;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAO3B;;;OAGG;IAEH,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAI7B;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI;IAUvC;;;;OAIG;IAEH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAIpC;;;OAGG;IACH,IAAI,IAAI,IAAI;IASZ;;;OAGG;IACH,MAAM,IAAI,IAAI;IAEd;;;OAGG;IACH,eAAe,IAAI,IAAI;IAmBvB;;;OAGG;IACH,iBAAiB,IAAI,IAAI;CAUzB"}

package/build/renderable/ui/uitextbutton.d.ts

@@ -1,109 +1,104 @@
+import { RoundRect } from "../../geometries/roundrect.ts";
+import type { Bounds } from "../../physics/bounds.ts";
+import type Renderer from "../../video/renderer.js";
+import BitmapText from "../text/bitmaptext.js";
+import UIBaseElement from "./uibaseelement.ts";
+interface UITextButtonSettings {
+    font?: string;
+    size?: number;
+    text?: string;
+    bindKey?: string | number;
+    hoverOffColor?: string;
+    hoverOnColor?: string;
+    borderStrokeColor?: string;
+    fillStyle?: string;
+    textAlign?: string;
+    textBaseline?: string;
+    borderWidth?: number;
+    borderHeight?: number;
+    /** @deprecated use hoverOffColor */
+    backgroundColor?: string;
+    /** @deprecated use hoverOnColor */
+    hoverColor?: string;
+    [key: string]: any;
+}
 /**
  * This is a basic base text button which you can use in your Game UI.
+ * @category UI
  */
 export default class UITextButton extends UIBaseElement {
-    /**
-     * A Bitmap Text Button with an outlined background border, filled with background color.
-     * It uses a RoundRect as background and changes the background color on hovering over.
-     * The background will be drawn with 0.5 opacity, so that the background of the button is
-     * slightly shining through.
-     * @param {number} x - x pos of the button
-     * @param {number} y - y pos of the button
-     * @param {Object} settings - settings object
-     * @param {string} [settings.font] - The name of the BitmapText font to use
-     * @param {number} [settings.size=1] - The scale factor of the BitmapText
-     * @param {string} [settings.text] - The text to display
-     * @param {string} [settings.bindKey] - The key to bind the action to (default: none)
-     * @param {string} [settings.hoverOffColor="#00aa0080"] - The css value of a color to be used if the pointer is not hovering over the button
-     * @param {string} [settings.hoverOnColor="#00ff00ff"] - The css value of a color to be used if the pointer hovers over the button
-     * @param {string} [settings.borderStrokeColor="#000000"] - The css value of a color to be used to draw the border
-     * @param {string} [settings.fillStyle] - The css value of a tint color to be used to tint the BitmapText
-     * @param {string} [settings.textAlign="center"] - horizontal text alignment
-     * @param {string} [settings.textBaseline="middle"] - the text baseline
-     * @param {number} [settings.borderWidth] - Width of the button
-     * @param {number} [settings.borderHeight] - Height of the button
-     * @example
-     * // Create a new Button
-     * class PlayButton extends UITextButton {
-     *      constructor(x,y) {
-     *          super(x,y, {
-     *              font: 'my-font',
-     *              text: 'Play',
-     *              // if you omit the next two, size is calculated by the size of the text
-     *              borderWidth: 200,
-     *              borderHeight: 20,
-     *              backgroundColor: '#00aa0080',
-     *              hoverColor: '#00ff00ff'
-     *          });
-     *      }
-     *
-     *      onClick(){
-     *          state.change(state.PLAY);
-     *      }
-     * }
-     *
-     * world.addChild(new PlayButton(15,200));
-     */
-    constructor(x: number, y: number, settings: {
-        font?: string | undefined;
-        size?: number | undefined;
-        text?: string | undefined;
-        bindKey?: string | undefined;
-        hoverOffColor?: string | undefined;
-        hoverOnColor?: string | undefined;
-        borderStrokeColor?: string | undefined;
-        fillStyle?: string | undefined;
-        textAlign?: string | undefined;
-        textBaseline?: string | undefined;
-        borderWidth?: number | undefined;
-        borderHeight?: number | undefined;
-    });
     /**
      * The key to bind the action to
-     * @type {string}
      */
-    bindKey: string;
+    bindKey: string | number;
     /**
-     * The css value of a color to be used if the pointer is nothovering over the button
-     * @type {string}
+     * The css value of a color to be used if the pointer is not hovering over the button
      */
     hoverOffColor: string;
     /**
      * The css value of a color to be used if the pointer hovers over the button
-     * @type {string}
      */
     hoverOnColor: string;
     /**
      * The css value of a color to be used to draw the border
-     * @type {string}
      */
     borderStrokeColor: string;
     /**
      * Set the default text alignment (or justification),<br>
      * possible values are "left", "right", and "center".
-     * @public
-     * @type {string}
      * @default "center"
      */
-    public textAlign: string;
+    textAlign: string;
     /**
      * Set the text baseline (e.g. the Y-coordinate for the draw operation), <br>
-     * possible values are "top", "hanging, "middle, "alphabetic, "ideographic, "bottom"<br>
-     * @public
-     * @type {string}
+     * possible values are "top", "hanging", "middle", "alphabetic", "ideographic", "bottom"<br>
      * @default "middle"
      */
-    public textBaseline: string;
+    textBaseline: string;
     /**
      * the bitmapText used by the UITextButton class
-     * @type {BitmapText}
      */
     bitmapText: BitmapText;
-    dimensions: import("../text/textmetrics.js").default;
+    /**
+     * the measured text dimensions
+     */
+    dimensions: Bounds;
+    /**
+     * the round rect border
+     */
     border: RoundRect;
-    draw(renderer: any): void;
+    /**
+     * A Bitmap Text Button with an outlined background border, filled with background color.
+     * It uses a RoundRect as background and changes the background color on hovering over.
+     * The background will be drawn with 0.5 opacity, so that the background of the button is
+     * slightly shining through.
+     * @param x - x pos of the button
+     * @param y - y pos of the button
+     * @param settings - settings object
+     * @example
+     * // Create a new Button
+     * class PlayButton extends UITextButton {
+     *      constructor(x,y) {
+     *          super(x,y, {
+     *              font: 'my-font',
+     *              text: 'Play',
+     *              // if you omit the next two, size is calculated by the size of the text
+     *              borderWidth: 200,
+     *              borderHeight: 20,
+     *              backgroundColor: '#00aa0080',
+     *              hoverColor: '#00ff00ff'
+     *          });
+     *      }
+     *
+     *      onClick(){
+     *          state.change(state.PLAY);
+     *      }
+     * }
+     *
+     * world.addChild(new PlayButton(15,200));
+     */
+    constructor(x: number, y: number, settings: UITextButtonSettings);
+    draw(renderer: Renderer): void;
 }
-import UIBaseElement from "./uibaseelement.js";
-import BitmapText from "../text/bitmaptext.js";
-import { RoundRect } from "../../geometries/roundrect.ts";
+export {};
 //# sourceMappingURL=uitextbutton.d.ts.map

package/build/renderable/ui/uitextbutton.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uitextbutton.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uitextbutton.js"],"names":[],"mappings":"AAIA;;GAEG;AACH;IACC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,eArCW,MAAM,KACN,MAAM,YAEd;QAA0B,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,OAAO;QACP,aAAa;QACb,YAAY;QACZ,iBAAiB;QACjB,SAAS;QACT,SAAS;QACT,YAAY;QACZ,WAAW;QACX,YAAY;KACtC,EAoGF;IA3EA;;;OAGG;IACH,SAFU,MAAM,CAEqB;IAErC;;;OAGG;IAEH,eAHU,MAAM,CAIkD;IAElE;;;OAGG;IAEH,cAHU,MAAM,CAI4C;IAE5D;;;OAGG;IACH,mBAFU,MAAM,CAEgD;IAEhE;;;;;;OAMG;IACH,kBAHU,MAAM,CAGoD;IAEpE;;;;;;OAMG;IACH,qBAHU,MAAM,CAIkB;IAElC;;;OAGG;IACH,YAFU,UAAU,CAE4B;IAGhD,qDAA+C;IAM/C,kBAKC;IAYF,0BAUC;CACD;0BA3IyB,oBAAoB;uBADvB,uBAAuB;0BADpB,+BAA+B"}
+{"version":3,"file":"uitextbutton.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uitextbutton.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAE/C,UAAU,oBAAoB;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,aAAa;IACtD;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;gBACS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,oBAAoB;IAgDvD,IAAI,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;CAYvC"}

package/build/state/stage.d.ts

@@ -2,6 +2,7 @@
  * a default "Stage" object.
  * every "stage" object (title screen, credits, ingame, etc...) to be managed
  * through the state manager must inherit from this base class.
+ * @category Application
  * @see state
  */
 export default class Stage {
@@ -112,6 +113,6 @@ export default class Stage {
      */
     onDestroyEvent(...args: any[]): void;
 }
-import Camera2d from "./../camera/camera2d.js";
+import Camera2d from "./../camera/camera2d.ts";
 import { Color } from "./../math/color.ts";
 //# sourceMappingURL=stage.d.ts.map

package/build/state/stage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../src/state/stage.js"],"names":[],"mappings":"AAaA;;;;;GAKG;AACH;IACC;;;;;OAKG;IACH,uBAJG;QAA8B,OAAO;QACT,YAAY;QACZ,cAAc;KAC5C,EAuDA;IArDA;;;;;;;;OAQG;IACH,mCAAwB;IAExB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,iCAAuB;IAEvB;;;;;;;;OAQG;IACH,qBANU,KAAK,CAM0B;IAEzC;;;;;;OAMG;IACH,iBAFU,MAAM,CAE+C;IAGhE;;;OAGG;IACH,4BAsBC;IAED;;;;;;;OAOG;IACH,WAHW,MAAM,GACJ,OAAO,CAqBnB;IAED;;;;;;;OAOG;IACH,eAHW,QAAQ,SACR,KAAK,QA+Bf;IAED;;;OAGG;IACH,8BAUC;IAED;;;;;;;;OAQG;IACH,mCAKC;IAED;;;;;OAKG;IACH,qCAKC;CACD;qBA9NoB,yBAAyB;sBACxB,oBAAoB"}
+{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../src/state/stage.js"],"names":[],"mappings":"AAaA;;;;;;GAMG;AACH;IACC;;;;;OAKG;IACH,uBAJG;QAA8B,OAAO;QACT,YAAY;QACZ,cAAc;KAC5C,EAuDA;IArDA;;;;;;;;OAQG;IACH,mCAAwB;IAExB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,iCAAuB;IAEvB;;;;;;;;OAQG;IACH,qBANU,KAAK,CAM0B;IAEzC;;;;;;OAMG;IACH,iBAFU,MAAM,CAE+C;IAGhE;;;OAGG;IACH,4BAsBC;IAED;;;;;;;OAOG;IACH,WAHW,MAAM,GACJ,OAAO,CAqBnB;IAED;;;;;;;OAOG;IACH,eAHW,QAAQ,SACR,KAAK,QA+Bf;IAED;;;OAGG;IACH,8BAUC;IAED;;;;;;;;OAQG;IACH,mCAKC;IAED;;;;;OAKG;IACH,qCAKC;CACD;qBA/NoB,yBAAyB;sBACxB,oBAAoB"}