@rpgjs/client 4.3.0 → 5.0.0-alpha.1

package/lib/Gui/Vue.d.ts

@@ -1,13 +0,0 @@
-import type { Gui } from './Gui.js';
-export declare class VueGui {
-    private parentGui;
-    private renderer;
-    private gameEngine;
-    private clientEngine;
-    private app;
-    private vm;
-    private socket;
-    constructor(rootEl: HTMLDivElement, parentGui: Gui);
-    _setSceneReady(): void;
-    set gui(val: any);
-}

package/lib/Gui/Vue.js

@@ -1,114 +0,0 @@
-import { renderList as _renderList, Fragment as _Fragment, openBlock as _openBlock, createElementBlock as _createElementBlock, resolveDynamicComponent as _resolveDynamicComponent, normalizeProps as _normalizeProps, createBlock as _createBlock, mergeProps as _mergeProps, createCommentVNode as _createCommentVNode, normalizeStyle as _normalizeStyle, createElementVNode as _createElementVNode } from "vue";
-import { createApp } from 'vue';
-import { Utils } from '@rpgjs/common';
-import { EVENTS_MAP } from '../Renderer.js';
-const _hoisted_1 = {
-    id: "tooltips",
-    style: { "position": "absolute", "top": "0", "left": "0" }
-};
-function render(_ctx, _cache) {
-    return (_openBlock(), _createElementBlock("div", {}, [
-        (_openBlock(true), _createElementBlock(_Fragment, null, _renderList(_ctx.fixedGui, (ui) => {
-            return (_openBlock(), _createElementBlock(_Fragment, null, [
-                (ui.display)
-                    ? (_openBlock(), _createBlock(_resolveDynamicComponent(ui.name), _normalizeProps(_mergeProps({ key: 0, style: { pointerEvents: 'auto' } }, ui.data)), null, 16 /* FULL_PROPS */))
-                    : _createCommentVNode("v-if", true)
-            ], 64 /* STABLE_FRAGMENT */));
-        }), 256 /* UNKEYED_FRAGMENT */)),
-        _createElementVNode("div", _hoisted_1, [
-            (_openBlock(true), _createElementBlock(_Fragment, null, _renderList(_ctx.attachedGui, (ui) => {
-                return (_openBlock(), _createElementBlock(_Fragment, null, [
-                    (ui.display)
-                        ? (_openBlock(true), _createElementBlock(_Fragment, { key: 0 }, _renderList(_ctx.tooltipFilter(_ctx.tooltips, ui), (tooltip) => {
-                            return (_openBlock(), _createElementBlock("div", {
-                                style: _normalizeStyle(_ctx.tooltipPosition(tooltip.position))
-                            }, [
-                                (_openBlock(), _createBlock(_resolveDynamicComponent(ui.name), _mergeProps({ ...ui.data, spriteData: tooltip, style: { pointerEvents: 'auto' } }, {
-                                    ref_for: true,
-                                    ref: ui.name
-                                }), null, 16 /* FULL_PROPS */))
-                            ], 4 /* STYLE */));
-                        }), 256 /* UNKEYED_FRAGMENT */))
-                        : _createCommentVNode("v-if", true)
-                ], 64 /* STABLE_FRAGMENT */));
-            }), 256 /* UNKEYED_FRAGMENT */))
-        ])
-    ], 32 /* HYDRATE_EVENTS */));
-}
-export class VueGui {
-    constructor(rootEl, parentGui) {
-        this.parentGui = parentGui;
-        this.clientEngine = parentGui.clientEngine;
-        this.renderer = this.clientEngine.renderer;
-        this.gameEngine = this.clientEngine.gameEngine;
-        const { gui } = parentGui;
-        const obj = {
-            render,
-            data() {
-                return {
-                    gui: {},
-                    tooltips: []
-                };
-            },
-            provide: () => {
-                return parentGui.getInjectObject();
-            },
-            computed: {
-                fixedGui() {
-                    return Object.values(this.gui).filter((gui) => !gui.attachToSprite);
-                },
-                attachedGui() {
-                    return Object.values(this.gui).filter((gui) => gui.attachToSprite);
-                }
-            },
-            methods: {
-                tooltipPosition: parentGui.tooltipPosition.bind(parentGui),
-                tooltipFilter: parentGui.tooltipFilter.bind(parentGui)
-            }
-        };
-        this.app = createApp(obj);
-        const guiVue = Object.values(gui).filter(ui => !Utils.isFunction(ui));
-        for (let ui of guiVue) {
-            this.app.component(ui.name, ui.gui);
-        }
-        this.app.directive('propagate', {
-            mounted: (el, binding) => {
-                el.eventListeners = {};
-                EVENTS_MAP.MouseEvent.forEach(eventType => {
-                    const callback = (ev) => {
-                        this.renderer.propagateEvent(ev);
-                    };
-                    el.eventListeners[eventType] = callback;
-                    el.addEventListener(eventType, callback);
-                });
-            },
-            unmounted(el, binding) {
-                EVENTS_MAP.MouseEvent.forEach(eventType => {
-                    const callback = el.eventListeners[eventType];
-                    if (callback) {
-                        el.removeEventListener(eventType, callback);
-                    }
-                });
-            }
-        });
-        this.vm = this.app.mount(rootEl);
-        this.renderer.app = this.app;
-        this.renderer.vm = this.vm;
-    }
-    _setSceneReady() {
-        this.parentGui.listenTooltipObjects.subscribe((tooltips) => {
-            this.vm.tooltips = [...tooltips];
-        });
-        this.parentGui.currentScene?.objectsMoving.next({});
-    }
-    set gui(val) {
-        for (let key in val) {
-            // ignore react component
-            if (val[key].isFunction)
-                continue;
-            this.vm.gui[key] = val[key];
-        }
-        this.vm.gui = Object.assign({}, this.vm.gui);
-    }
-}
-//# sourceMappingURL=Vue.js.map

package/lib/Gui/Vue.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Vue.js","sourceRoot":"","sources":["../../src/Gui/Vue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,IAAI,WAAW,EAAE,QAAQ,IAAI,SAAS,EAAE,SAAS,IAAI,UAAU,EAAE,kBAAkB,IAAI,mBAAmB,EAAE,uBAAuB,IAAI,wBAAwB,EAAE,cAAc,IAAI,eAAe,EAA6C,WAAW,IAAI,YAAY,EAAE,UAAU,IAAI,WAAW,EAAE,kBAAkB,IAAI,mBAAmB,EAAE,cAAc,IAAI,eAAe,EAAE,kBAAkB,IAAI,mBAAmB,EAAE,MAAM,KAAK,CAAA;AAC9b,OAAO,EAAgC,SAAS,EAAE,MAAM,KAAK,CAAA;AAC7D,OAAO,EAAmB,KAAK,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,EAAE,UAAU,EAAe,MAAM,aAAa,CAAA;AA2BrD,MAAM,UAAU,GAAG;IACf,EAAE,EAAE,UAAU;IACd,KAAK,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE;CAC7D,CAAA;AACD,SAAS,MAAM,CAAC,IAAI,EAAE,MAAM;IACxB,OAAO,CAAC,UAAU,EAAE,EAAE,mBAAmB,CAAC,KAAK,EAAE,EAAE,EAAE;QACjD,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE;YACtF,OAAO,CAAC,UAAU,EAAE,EAAE,mBAAmB,CAAC,SAAS,EAAE,IAAI,EAAE;gBACvD,CAAC,EAAE,CAAC,OAAO,CAAC;oBACR,CAAC,CAAC,CAAC,UAAU,EAAE,EAAE,YAAY,CAAC,wBAAwB,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC;oBACjL,CAAC,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC;aAC1C,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAA;QACjC,CAAC,CAAC,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAChC,mBAAmB,CAAC,KAAK,EAAE,UAAU,EAAE;YACnC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE;gBACzF,OAAO,CAAC,UAAU,EAAE,EAAE,mBAAmB,CAAC,SAAS,EAAE,IAAI,EAAE;oBACvD,CAAC,EAAE,CAAC,OAAO,CAAC;wBACR,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE;4BAC3H,OAAO,CAAC,UAAU,EAAE,EAAE,mBAAmB,CAAC,KAAK,EAAE;gCAC7C,KAAK,EAAE,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;6BACjE,EAAE;gCACC,CAAC,UAAU,EAAE,EAAE,YAAY,CAAC,wBAAwB,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,EAAE;oCAC9I,OAAO,EAAE,IAAI;oCACb,GAAG,EAAE,EAAE,CAAC,IAAI;iCACf,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC;6BAClC,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAA;wBACtB,CAAC,CAAC,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;wBAChC,CAAC,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC;iBAC1C,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAA;YACjC,CAAC,CAAC,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;SACnC,CAAC;KACL,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAA;AAChC,CAAC;AAGD,MAAM,OAAO,MAAM;IAQf,YAAY,MAAsB,EAAU,SAAc;QAAd,cAAS,GAAT,SAAS,CAAK;QACtD,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAA;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAA;QAC1C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAA;QAC9C,MAAM,EAAE,GAAG,EAAE,GAAG,SAAS,CAAA;QAEzB,MAAM,GAAG,GAAG;YACR,MAAM;YACN,IAAI;gBACA,OAAO;oBACH,GAAG,EAAE,EAAE;oBACP,QAAQ,EAAE,EAAE;iBACf,CAAA;YACL,CAAC;YACD,OAAO,EAAE,GAAG,EAAE;gBACV,OAAO,SAAS,CAAC,eAAe,EAAE,CAAA;YACtC,CAAC;YACD,QAAQ,EAAE;gBACN,QAAQ;oBACJ,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;gBAC5E,CAAC;gBACD,WAAW;oBACP,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;gBAC3E,CAAC;aACJ;YACD,OAAO,EAAE;gBACL,eAAe,EAAE,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC1D,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC;aACzD;SACJ,CAAA;QAED,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,CAAA;QAEzB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAA;QAErE,KAAK,IAAI,EAAE,IAAI,MAAM,EAAE;YACnB,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;SACtC;QAED,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE;YAC5B,OAAO,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE;gBACrB,EAAE,CAAC,cAAc,GAAG,EAAE,CAAC;gBACvB,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;oBACtC,MAAM,QAAQ,GAAG,CAAC,EAAE,EAAE,EAAE;wBACpB,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;oBACrC,CAAC,CAAC;oBACF,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC;oBACxC,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;gBAC7C,CAAC,CAAC,CAAC;YACP,CAAC;YACD,SAAS,CAAC,EAAE,EAAE,OAAO;gBACjB,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;oBACtC,MAAM,QAAQ,GAAG,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;oBAC9C,IAAI,QAAQ,EAAE;wBACV,EAAE,CAAC,mBAAmB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;qBAC/C;gBACL,CAAC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC,CAAA;QAEF,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAgB,CAAA;QAC/C,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;QAC5B,IAAI,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;IAC9B,CAAC;IAED,cAAc;QACV,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;YACvD,IAAI,CAAC,EAAE,CAAC,QAAQ,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAA;QACpC,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACvD,CAAC;IAED,IAAI,GAAG,CAAC,GAAG;QACP,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE;YACjB,yBAAyB;YACzB,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,UAAU;gBAAE,SAAQ;YACjC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;SAC9B;QACD,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;IAChD,CAAC;CACJ"}

package/lib/Interfaces/Character.d.ts

@@ -1,6 +0,0 @@
-import { RpgSprite } from '../Sprite/Player.js';
-export interface ISpriteCharacter {
-    onCharacterWalk(sprite: RpgSprite): void;
-    onCharacterStand(sprite: RpgSprite): void;
-    onCharacterAction(sprite: RpgSprite): void;
-}

package/lib/Interfaces/Character.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=Character.js.map

package/lib/Interfaces/Character.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Character.js","sourceRoot":"","sources":["../../src/Interfaces/Character.ts"],"names":[],"mappings":""}

package/lib/Interfaces/Scene.d.ts

@@ -1,10 +0,0 @@
-export interface IScene {
-    load(obj: object): any;
-    draw(t: number, dt: number, frame: number): any;
-    removeObject(id: string): any;
-    addObject(obj: object, id: string): any;
-    updateScene(obj: {
-        data: object;
-        partial: object;
-    }): any;
-}

package/lib/Interfaces/Scene.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=Scene.js.map

package/lib/Interfaces/Scene.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Scene.js","sourceRoot":"","sources":["../../src/Interfaces/Scene.ts"],"names":[],"mappings":""}

package/lib/KeyboardControls.d.ts

@@ -1,367 +0,0 @@
-import { InjectContext } from '@rpgjs/common';
-import { ControlOptions, Controls } from '@rpgjs/types';
-type BoundKey = {
-    actionName: string;
-    options: ControlOptions;
-    parameters?: any;
-};
-export declare class KeyboardControls {
-    private context;
-    private clientEngine;
-    private keyState;
-    private boundKeys;
-    private stop;
-    private lastKeyPressed;
-    private _controlsOptions;
-    constructor(context: InjectContext);
-    private directionToAngle;
-    private setupListeners;
-    private bindKey;
-    private applyKeyDown;
-    private applyKeyUp;
-    private applyKeyPress;
-    private onKeyChange;
-    /**
-     * From the name of the entry, we retrieve the control information
-     *
-     * ```ts
-     * import { Input, inject, KeyboardControls } from '@rpgjs/client'
-     *
-     * const controls = inject(KeyboardControls)
-     * controls.getControl(Input.Enter)
-
-     * if (control) {
-     *    console.log(control.actionName) // action
-     * }
-     * ```
-     * @title Get Control
-     * @method getControl(inputName)
-     * @param {string} inputName
-     * @returns { { actionName: string, options: any } | undefined }
-     * @memberof KeyboardControls
-     */
-    getControl(inputName: string): BoundKey | undefined;
-    /**
-     * Returns all controls
-     *
-     * @method getControls()
-     * @since 4.2.0
-     * @returns { { [key: string]: BoundKey } }
-     * @memberof KeyboardControls
-     */
-    getControls(): {
-        [key: string]: BoundKey;
-    };
-    /**
-     * Triggers an input according to the name of the control
-     *
-     * ```ts
-     * import { Control, inject, KeyboardControls } from '@rpgjs/client'
-     *
-     * const controls = inject(KeyboardControls)
-     * controls.applyControl(Control.Action)
-     * ```
-     *
-     * You can put a second parameter or indicate on whether the key is pressed or released
-     *
-     * ```ts
-     * import { Control, inject, KeyboardControls } from '@rpgjs/client'
-     *
-     * const controls = inject(KeyboardControls)
-     * controls.applyControl(Control.Up, true) // keydown
-     * controls.applyControl(Control.Up, false) // keyup
-     * ```
-     * @title Apply Control
-     * @method applyControl(controlName,isDown)
-     * @param {string} controlName
-     * @param {boolean} [isDown]
-     * @returns {Promise<void>}
-     * @memberof KeyboardControls
-     */
-    applyControl(controlName: string | number, isDown?: boolean | undefined): Promise<void>;
-    /**
-     * Stop listening to the inputs. Pressing a key won't do anything
-     *
-     * @title Stop Inputs
-     * @method stopInputs()
-     * @returns {void}
-     * @memberof KeyboardControls
-     */
-    stopInputs(): void;
-    /**
-     * Listen to the inputs again
-     *
-     * @title Listen Inputs
-     * @method listenInputs()
-     * @returns {void}
-     * @memberof KeyboardControls
-     */
-    listenInputs(): void;
-    /**
-     * Assign custom inputs to the scene
-     *
-     * The object is the following:
-     *
-     * * the key of the object is the name of the control. Either it is existing controls (Up, Dow, Left, Right, Action, Back) or customized controls
-     * * The value is an object representing control information:
-     *      * repeat {boolean} The key can be held down to repeat the action. (false by default)
-     *      * bind {string | string[]} To which key is linked the control
-     *      * method {Function} Function to be triggered. If you do not set this property, the name of the control is sent directly to the server.
-     *      * delay {object|number} (since v3.2.0) Indicates how long (in milliseconds) the player can press the key again to perform the action
-     *          * delay.duration
-     *          * delay.otherControls {string | string[]} Indicates the other controls that will also have the delay at the same time
-     *
-     * ```ts
-     * import { Control, Input, inject, KeyboardControls } from '@rpgjs/client'
-     *
-     * const controls = inject(KeyboardControls)
-     * controls.setInputs({
-            [Control.Up]: {
-                repeat: true,
-                bind: Input.Up
-            },
-            [Control.Down]: {
-                repeat: true,
-                bind: Input.Down
-            },
-            [Control.Right]: {
-                repeat: true,
-                bind: Input.Right
-            },
-            [Control.Left]: {
-                repeat: true,
-                bind: Input.Left
-            },
-            [Control.Action]: {
-                bind: [Input.Space, Input.Enter]
-            },
-            [Control.Back]: {
-                bind: Input.Escape
-            },
-
-            // The myscustom1 control is sent to the server when the A key is pressed.
-            mycustom1: {
-                bind: Input.A
-            },
-
-            // the myAction method is executed when the B key is pressed
-            mycustom2: {
-                bind: Input.B,
-                method({ actionName }) {
-                    console.log('cool', actionName)
-                }
-            },
-
-            // The player can redo the action after 400ms
-            mycustom3: {
-                bind: Input.C,
-                delay: 400 // ms
-            },
-
-            // The player can redo the action (mycustom4) and the directions after 400ms
-            mycustom4: {
-                bind: Input.C,
-                delay: {
-                    duration: 400,
-                    otherControls: [Control.Up, Control.Down, Control.Left, Control.Right]
-                }
-            }
-        })
-     *
-     * ```
-     * @enum {string} Control
-     *
-     * Control.Up | up
-     * Control.Down | down
-     * Control.Left | left
-     * Control.Right | right
-     * Control.Action | action
-     * Control.Back | back
-     *
-     * @enum {string} Mouse Event
-     *
-     * click | Click
-     * dblclick | Double Click
-     * mousedown | Mouse Down
-     * mouseup | Mouse Up
-     * mouseover | Mouse Over
-     * mousemove | Mouse Move
-     * mouseout | Mouse Out
-     * contextmenu | Context Menu
-     *
-     *
-     * @enum {string} Input
-     *
-     * break | Pause
-    * backspace | Backspace / Delete
-    * tab | Tab
-    * clear | Clear
-    * enter | Enter
-    * shift | Shift
-    * ctrl | Control
-    * alt | Alt
-    * pause/break | Pause / Break
-    * caps lock | Caps Lock
-    * escape | Escape
-    * conversion | Conversion
-    * non-conversion | Non-conversion
-    * space | Space
-    * page up | Page Up
-    * page down | Page Down
-    * end | End
-    * home | Home
-    * left | Left Arrow
-    * up | Up Arrow
-    * right | Right Arrow
-    * down | Down Arrow
-    * select | Select
-    * print | Print
-    * execute | Execute
-    * Print Screen | Print Screen
-    * insert | Insert
-    * delete | Delete
-    * n0 | 0
-    * n1 | 1
-    * n2 | 2
-    * n3 | 3
-    * n4 | 4
-    * n5 | 5
-    * n6 | 6
-    * n7 | 7
-    * n8 | 8
-    * n9 | 9
-    * : | Colon
-    * semicolon (firefox), equals | Semicolon (Firefox), Equals
-    * < | Less Than
-    * equals (firefox) | Equals (Firefox)
-    * ß | Eszett
-    * @ | At
-    * a | A
-    * b | B
-    * c | C
-    * d | D
-    * e | E
-    * f | F
-    * g | G
-    * h | H
-    * i | I
-    * j | J
-    * k | K
-    * l | L
-    * m | M
-    * n | N
-    * o | O
-    * p | P
-    * q | Q
-    * r | R
-    * s | S
-    * t | T
-    * u | U
-    * v | V
-    * w | W
-    * x | X
-    * y | Y
-    * z | Z
-    * Windows Key / Left ⌘ / Chromebook Search key | Windows Key / Left Command ⌘ / Chromebook Search Key
-    * right window key | Right Windows Key
-    * Windows Menu / Right ⌘ | Windows Menu / Right Command ⌘
-    * numpad 0 | Numpad 0
-    * numpad 1 | Numpad 1
-    * numpad 2 | Numpad 2
-    * numpad 3 | Numpad 3
-    * numpad 4 | Numpad 4
-    * numpad 5 | Numpad 5
-    * numpad 6 | Numpad 6
-    * numpad 7 | Numpad 7
-    * numpad 8 | Numpad 8
-    * numpad 9 | Numpad 9
-    * multiply | Multiply
-    * add | Add
-    * numpad period (firefox) | Numpad Period (Firefox)
-    * subtract | Subtract
-    * decimal point | Decimal Point
-    * divide | Divide
-    * f1 | F1
-    * f2 | F2
-    * f3 | F3
-    * f4 | F4
-    * f5 | F5
-    * f6 | F6
-    * f7 | F7
-    * f8 | F8
-    * f9 | F9
-    * f10 | F10
-    * f11 | F11
-    * f12 | F12
-    * f13 | F13
-    * f14 | F14
-    * f15 | F15
-    * f16 | F16
-    * f17 | F17
-    * f18 | F18
-    * f19 | F19
-    * f20 | F20
-    * f21 | F21
-    * f22 | F22
-    * f23 | F23
-    * f24 | F24
-    * num lock | Num Lock
-    * scroll lock | Scroll Lock
-    * ^ | Caret
-    * ! | Exclamation Point
-    * # | Hash
-    * $ | Dollar Sign
-    * ù | Grave Accent U
-    * page backward | Page Backward
-    * page forward | Page Forward
-    * closing paren (AZERTY) | Closing Parenthesis (AZERTY)
-    * * | Asterisk
-    * ~ + * key | Tilde + Asterisk Key
-    * minus (firefox), mute/unmute | Minus (Firefox), Mute/Unmute
-    * decrease volume level | Decrease Volume Level
-    * increase volume level | Increase Volume Level
-    * next | Next
-    * previous | Previous
-    * stop | Stop
-    * play/pause | Play/Pause
-    * e-mail | Email
-    * mute/unmute (firefox) | Mute/Unmute (Firefox)
-    * decrease volume level (firefox) | Decrease Volume Level (Firefox)
-    * increase volume level (firefox) | Increase Volume Level (Firefox)
-    * semi-colon / ñ | Semicolon / ñ
-    * equal sign | Equal Sign
-    * comma | Comma
-    * dash | Dash
-    * period | Period
-    * forward slash / ç | Forward Slash / ç
-    * grave accent / ñ / æ | Grave Accent / ñ / æ
-    * ?, / or ° | ?, / or °
-    * numpad period (chrome) | Numpad Period (Chrome)
-    * open bracket | Open Bracket
-    * back slash | Backslash
-    * close bracket / å | Close Bracket / å
-    * single quote / ø | Single Quote / ø
-    * \` | Backtick
-    * left or right ⌘ key (firefox) | Left or Right Command Key (Firefox)
-    * altgr | AltGr
-    * < /git > | < /git >
-    * GNOME Compose Key | GNOME Compose Key
-    * ç | ç
-    * XF86Forward | XF86Forward
-    * XF86Back | XF86Back
-    * alphanumeric | Alphanumeric
-    * hiragana/katakana | Hiragana/Katakana
-    * half-width/full-width | Half-Width/Full-Width
-    * kanji | Kanji
-    * toggle touchpad | Toggle Touchpad
-     *
-     * @title Set Inputs
-     * @method setInputs(inputs)
-     * @param {object} inputs
-     * @memberof KeyboardControls
-     */
-    setInputs(inputs: Controls): void;
-    get options(): Controls;
-    private transformDirectionInNumber;
-}
-export {};