@rpgjs/common 3.0.0-beta → 3.0.0-beta.4

package/lib/EventEmitter.d.ts

@@ -5,4 +5,5 @@ export declare class EventEmitter {
     on(name: string, cb: Function): EventEmitter;
     emit(name: string, data?: any, rest?: boolean): Promise<any[]>;
     off(name: string): void;
+    clear(): void;
 }

package/lib/EventEmitter.js

@@ -44,6 +44,10 @@ class EventEmitter {
         delete this.listeners[name];
         delete this.listenersOnce[name];
     }
+    clear() {
+        this.listeners = {};
+        this.listenersOnce = {};
+    }
 }
 exports.EventEmitter = EventEmitter;
 //# sourceMappingURL=EventEmitter.js.map

package/lib/EventEmitter.js.map

@@ -1 +1 @@
-{"version":3,"file":"EventEmitter.js","sourceRoot":"","sources":["../src/EventEmitter.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AAEnC,MAAa,YAAY;IAAzB;QACY,cAAS,GAEb,EAAE,CAAA;QAEE,kBAAa,GAEjB,EAAE,CAAA;IAqCV,CAAC;IAnCG,IAAI,CAAC,IAAY,EAAE,EAAY;QAC3B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;QAC7B,OAAO,IAAI,CAAA;IACf,CAAC;IAED,EAAE,CAAC,IAAY,EAAE,EAAY;QACzB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;QACpD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC7B,OAAO,IAAI,CAAA;IACf,CAAC;IAED,IAAI,CAAC,IAAY,EAAE,IAAU,EAAE,OAAgB,KAAK;QAChD,MAAM,GAAG,GAAQ,EAAE,CAAA;QACnB,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;YACtB,KAAK,IAAI,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;gBACvC,IAAI,IAAI;oBAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;;oBAChC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;aAChC;SACJ;aACI,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE;YAC/B,IAAI,IAAI;gBAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;;gBAChD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;SAChD;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC7B,IAAI,CAAC,iBAAS,CAAC,GAAG,CAAC,EAAE;gBACjB,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;aAC9B;YACD,OAAO,GAAG,CAAA;QACd,CAAC,CAAC,CAAC,CAAA;IACP,CAAC;IAED,GAAG,CAAC,IAAY;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;CACJ;AA5CD,oCA4CC"}
+{"version":3,"file":"EventEmitter.js","sourceRoot":"","sources":["../src/EventEmitter.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AAEnC,MAAa,YAAY;IAAzB;QACY,cAAS,GAEb,EAAE,CAAA;QAEE,kBAAa,GAEjB,EAAE,CAAA;IA0CV,CAAC;IAxCG,IAAI,CAAC,IAAY,EAAE,EAAY;QAC3B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;QAC7B,OAAO,IAAI,CAAA;IACf,CAAC;IAED,EAAE,CAAC,IAAY,EAAE,EAAY;QACzB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;QACpD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC7B,OAAO,IAAI,CAAA;IACf,CAAC;IAED,IAAI,CAAC,IAAY,EAAE,IAAU,EAAE,OAAgB,KAAK;QAChD,MAAM,GAAG,GAAQ,EAAE,CAAA;QACnB,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;YACtB,KAAK,IAAI,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;gBACvC,IAAI,IAAI;oBAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;;oBAChC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;aAChC;SACJ;aACI,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE;YAC/B,IAAI,IAAI;gBAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;;gBAChD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;SAChD;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC7B,IAAI,CAAC,iBAAS,CAAC,GAAG,CAAC,EAAE;gBACjB,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;aAC9B;YACD,OAAO,GAAG,CAAA;QACd,CAAC,CAAC,CAAC,CAAA;IACP,CAAC;IAED,GAAG,CAAC,IAAY;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;IAED,KAAK;QACD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QACnB,IAAI,CAAC,aAAa,GAAG,EAAE,CAAA;IAC3B,CAAC;CACJ;AAjDD,oCAiDC"}

package/lib/Game.d.ts

@@ -1,4 +1,6 @@
 import { EventEmitter } from './EventEmitter';
+import { Direction } from './Player';
+import { Control } from './Input';
 export default class Game extends EventEmitter {
     private side;
     events: any;
@@ -8,5 +10,7 @@ export default class Game extends EventEmitter {
     addObject(_class: any, playerId?: any): any;
     addPlayer(playerClass: any, playerId: any): any;
     addEvent(eventClass: any): any;
-    processInput(inputData: any, playerId: any): void;
+    processInput(inputData: {
+        input: Control | Direction;
+    }, playerId: string): void;
 }

package/lib/Game.js

@@ -37,6 +37,7 @@ class Game extends EventEmitter_1.EventEmitter {
     processInput(inputData, playerId) {
         const player = this.world.getObject(playerId);
         const { input } = inputData;
+        let moving = false;
         if (!player)
             return;
         if (!player.canMove)
@@ -48,10 +49,11 @@ class Game extends EventEmitter_1.EventEmitter {
             input == Player_1.Direction.Right ||
             input == Player_1.Direction.Up ||
             input == Player_1.Direction.Down) {
+            moving = true;
             player.moveByDirection(input);
         }
         if (this.side == 'server')
-            Plugin_1.RpgPlugin.emit('Server.onInput', [player, inputData], true);
+            Plugin_1.RpgPlugin.emit('Server.onInput', [player, Object.assign(Object.assign({}, inputData), { moving })], true);
     }
 }
 exports.default = Game;

package/lib/Game.js.map

@@ -1 +1 @@
-{"version":3,"file":"Game.js","sourceRoot":"","sources":["../src/Game.ts"],"names":[],"mappings":";;AAAA,mCAAqC;AACrC,iDAA6C;AAC7C,qCAAqD;AACrD,mCAAiC;AACjC,qCAAoC;AAEpC,MAAqB,IAAK,SAAQ,2BAAY;IAK1C,YAAoB,IAAY;QAC5B,KAAK,EAAE,CAAA;QADS,SAAI,GAAJ,IAAI,CAAQ;QAE5B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA,CAAC,+BAA+B;IACpD,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACtB,CAAC;IAED,SAAS,CAAC,MAAM,EAAE,QAAS;QACvB,IAAI,KAAK,CAAA;QACT,IAAI,CAAC,QAAQ;YAAE,QAAQ,GAAG,mBAAW,EAAE,CAAA;QACvC,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,UAAU,EAAE;YACvC,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;SACrC;aACI;YACD,KAAK,GAAG,MAAM,CAAA;SACjB;QACD,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,SAAS,CAAC,WAAW,EAAE,QAAQ;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;QACpD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,QAAQ,CAAC,UAAU;QACf,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QACxC,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,YAAY,CAAC,SAAS,EAAE,QAAQ;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC7C,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAA;QAE3B,IAAI,CAAC,MAAM;YAAE,OAAM;QACnB,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAM;QAE3B,IAAI,KAAK,IAAI,eAAO,CAAC,MAAM,EAAE;YACzB,MAAM,CAAC,oBAAoB,CAAC,wBAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SAC9D;aACI,IACD,KAAK,IAAI,kBAAS,CAAC,IAAI;YACvB,KAAK,IAAI,kBAAS,CAAC,KAAK;YACxB,KAAK,IAAI,kBAAS,CAAC,EAAE;YACrB,KAAK,IAAI,kBAAS,CAAC,IAAI,EACrB;YACF,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;SAChC;QACD,IAAI,IAAI,CAAC,IAAI,IAAI,QAAQ;YAAE,kBAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,CAAA;IAC1F,CAAC;CACJ;AAxDD,uBAwDC"}
+{"version":3,"file":"Game.js","sourceRoot":"","sources":["../src/Game.ts"],"names":[],"mappings":";;AAAA,mCAAqC;AACrC,iDAA6C;AAC7C,qCAAqD;AACrD,mCAAiC;AACjC,qCAAoC;AAEpC,MAAqB,IAAK,SAAQ,2BAAY;IAK1C,YAAoB,IAAY;QAC5B,KAAK,EAAE,CAAA;QADS,SAAI,GAAJ,IAAI,CAAQ;QAE5B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA,CAAC,+BAA+B;IACpD,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACtB,CAAC;IAED,SAAS,CAAC,MAAM,EAAE,QAAS;QACvB,IAAI,KAAK,CAAA;QACT,IAAI,CAAC,QAAQ;YAAE,QAAQ,GAAG,mBAAW,EAAE,CAAA;QACvC,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,UAAU,EAAE;YACvC,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;SACrC;aACI;YACD,KAAK,GAAG,MAAM,CAAA;SACjB;QACD,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,SAAS,CAAC,WAAW,EAAE,QAAQ;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;QACpD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,QAAQ,CAAC,UAAU;QACf,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QACxC,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,YAAY,CAAC,SAAyC,EAAE,QAAgB;QACpE,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC7C,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAA;QAC3B,IAAI,MAAM,GAAG,KAAK,CAAA;QAElB,IAAI,CAAC,MAAM;YAAE,OAAM;QACnB,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAM;QAE3B,IAAI,KAAK,IAAI,eAAO,CAAC,MAAM,EAAE;YACzB,MAAM,CAAC,oBAAoB,CAAC,wBAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SAC9D;aACI,IACD,KAAK,IAAI,kBAAS,CAAC,IAAI;YACvB,KAAK,IAAI,kBAAS,CAAC,KAAK;YACxB,KAAK,IAAI,kBAAS,CAAC,EAAE;YACrB,KAAK,IAAI,kBAAS,CAAC,IAAI,EACrB;YACF,MAAM,GAAG,IAAI,CAAA;YACb,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;SAChC;QACD,IAAI,IAAI,CAAC,IAAI,IAAI,QAAQ;YAAE,kBAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,MAAM,kCAC5D,SAAS,KACZ,MAAM,IACR,EAAE,IAAI,CAAC,CAAA;IACb,CAAC;CACJ;AA7DD,uBA6DC"}

package/lib/Hit.d.ts

@@ -1,13 +1,13 @@
 import SAT from 'sat';
 export interface HitObject {
-    ellipse: boolean;
-    gid: number | null;
+    ellipse?: boolean;
+    gid?: number;
     height: number;
-    polygon: any[] | null;
-    polyline: any[] | null;
-    properties: object;
-    rotation: number;
-    visible: boolean;
+    polygon?: any[];
+    polyline?: any[];
+    properties?: object;
+    rotation?: number;
+    visible?: boolean;
     width: number;
     x: number;
     y: number;
@@ -15,12 +15,12 @@ export interface HitObject {
     name?: string;
 }
 declare class HitClass {
-    createObjectHitbox(x: number, y: number, z: number, w: number, h: number): any;
+    createObjectHitbox(x: number, y: number, z: number, w: number, h: number): SAT.Box;
     getHitbox(obj: HitObject, offset?: {
         x: number;
         y: number;
     }): {
-        properties: object;
+        properties: object | undefined;
         hitbox: any;
         type: any;
         name: string | undefined;

package/lib/Map.d.ts

@@ -1,40 +1,237 @@
 import { HitObject } from './Hit';
-import { Shape } from './Shape';
-interface TileInfo {
+import { RpgShape } from './Shape';
+export interface TileInfo {
     tiles: any[];
     hasCollision: boolean;
     isClimbable?: boolean;
     isOverlay: boolean;
     objectGroups: HitObject[];
+    tileIndex: number;
+}
+export interface LayerInfo {
+    type: string;
+    name: string;
+    opacity: number;
+    visible: boolean;
+    properties: any;
+    objects: HitObject[];
+    tiles: any[];
 }
 export default class RpgCommonMap {
+    /**
+     * @title Data of map
+     * @prop {object} [data]
+     * @readonly
+     * @memberof Map
+     * @memberof RpgSceneMap
+     * */
     data: any;
     width: number;
     height: number;
+    /**
+     * @title Width of a tile
+     * @prop {number} [tileWidth]
+     * @readonly
+     * @memberof Map
+     * @memberof RpgSceneMap
+     * */
     tileWidth: number;
+    /**
+    * @title Height of a tile
+    * @prop {number} [tileHeight]
+    * @readonly
+    * @memberof Map
+    * @memberof RpgSceneMap
+    * */
     tileHeight: number;
-    layers: any[];
+    /**
+     * @title Layers of map
+     * @prop {object[]} [layers]
+     * @readonly
+     * @memberof Map
+     * @memberof RpgSceneMap
+     * */
+    layers: LayerInfo[];
     private shapes;
     static get buffer(): Map<any, any>;
     load(data: any): void;
+    /**
+     * @title Width of the map in pixels
+     * @prop {number} [widthPx]
+     * @readonly
+     * @memberof Map
+     * @memberof RpgSceneMap
+     * */
     get widthPx(): number;
+    /**
+     * @title Height of the map in pixels
+     * @prop {number} [heightPx]
+     * @readonly
+     * @memberof Map
+     * @memberof RpgSceneMap
+     * */
     get heightPx(): number;
+    /**
+     * @title The depth of the map in pixels (this is the height of a tile ;))
+     * @prop {number} map.zTileHeight
+     * @readonly
+     * @memberof Map
+     * @memberof RpgSceneMap
+     * */
     get zTileHeight(): number;
     _extractShapes(): void;
-    createShape(obj: HitObject): Shape;
+    /**
+     * Find a layer by name. Returns `undefined` is the layer is not found
+
+     * @title Get Layer by name
+     * @method map.getLayerByName(name)
+     * @param {string} name layer name
+     * @returns {LayerInfo | undefined}
+     * @example
+     *  ```ts
+     *  const tiles = map.getLayerByName(0, 0)
+     *  ```
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getLayerByName(name: string): LayerInfo | undefined;
+    /**
+     * Create a shape dynamically on the map
+     *
+     * Object:
+     *  - (number) x: Position X
+     *  - (number) y: Position Y
+     *  - (number) width: Width
+     *  - (number) height: Height
+     *  - (object) properties (optionnal):
+     *      - (number) z: Position Z
+     *      - (hexadecimal) color: Color (shared with client)
+     *      - (boolean) collision
+     *      - You can your own properties
+     *
+     * @title Create Shape
+     * @since 3.0.0-beta.3
+     * @method map.createShape(obj)
+     * @param {object} obj
+     * @returns {RpgShape}
+     * @memberof Map
+     */
+    createShape(obj: HitObject): RpgShape;
+    /**
+     * Delete a shape
+     *
+     * @title Get Shapes
+     * @method map.removeShape(name)
+     * @param {string} name Name of shape
+     * @returns {void}
+     * @memberof Map
+     */
     removeShape(name: string): void;
-    getShapes(): Shape[];
-    getPositionByShape(filter: any): {
+    /**
+     * Return all shapes on the map
+     *
+     * @title Get Shapes
+     * @method map.getShapes()
+     * @returns {RpgShape[]}
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getShapes(): RpgShape[];
+    /**
+     * Returns a shape by its name. Returns undefined is nothing is found
+     *
+     * @title Get Shape by name
+     * @method map.getShape(name)
+     * @param {string} name Name of shape
+     * @returns {RpgShape[] | undefined}
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getShape(name: string): RpgShape | undefined;
+    getPositionByShape(filter: (shape: RpgShape) => {}): {
         x: number;
         y: number;
         z: number;
     } | null;
-    getTileIndex(x: any, y: any, [z]: [any]): number;
-    getTileByIndex(tileIndex: any, zPlayer: any): TileInfo;
-    getTileOriginPosition(x: any, y: any): {
+    setTile(x: number, y: number, layerFilter: string | ((layer: any) => boolean), tileInfo: any): {
+        x: number;
+        y: number;
+        tiles: {
+            [tileIndex: number]: object;
+        };
+    };
+    /**
+     * Get the tile index on the tileset
+     *
+     * @title Get index of tile
+     * @method map.getTileIndex(x,y)
+     * @param {number} x Position X
+     * @param {number} x Position Y
+     * @returns {number}
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getTileIndex(x: number, y: number, [z]?: [number]): number;
+    /**
+     * Retrieves tiles according to its index
+
+     * @title Get tile by index
+     * @method map.getTileByIndex(tileIndex)
+     * @param {number} tileIndex tile index
+     * @returns {TileInfo}
+     * @example
+     *  ```ts
+     *  const index = map.getTileIndex(0, 0)
+     *  const tiles = map.getTileByIndex(index)
+     *  ```
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getTileByIndex(tileIndex: number, zPlayer?: [number, number]): TileInfo;
+    /**
+     * Find the point of origin (top left) of a tile. Of course, its position depends on the size of the tile
+
+     * @title Get origin position of tile
+     * @method map.getTileOriginPosition(x,y)
+     * @param {number} x Position X
+     * @param {number} x Position Y
+     * @returns { {x: number, y: number }}
+     * @example
+     *  ```ts
+     *  // If the size of a tile is 32x32px
+     *  const position = map.getTileOriginPosition(35, 12)
+     *  console.log(position) // { x: 32, y: 0 }
+     *  ```
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getTileOriginPosition(x: number, y: number): {
         x: number;
         y: number;
     };
-    getTileByPosition(x: any, y: any, z: any): TileInfo;
+    /**
+     * Recover tiles according to a position
+
+     * @title Get tile by position
+     * @method map.getTileByPosition(x,y)
+     * @param {number} x Position X
+     * @param {number} x Position Y
+     * @returns {TileInfo}
+     * @example
+     *  ```ts
+     *  const tiles = map.getTileByPosition(0, 0)
+     *  ```
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getTileByPosition(x: number, y: number, z?: [number, number]): TileInfo;
+    /**
+     * Get tile and verify collision with hitbox
+     * @param hitbox
+     * @param x
+     * @param y
+     * @param z
+     * @returns TileInfo
+     */
+    getTile(hitbox: any, x: number, y: number, z?: [number, number]): TileInfo;
 }
-export {};

package/lib/Map.js

@@ -2,13 +2,35 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const Utils_1 = require("./Utils");
 const Shape_1 = require("./Shape");
+const Hit_1 = require("./Hit");
 const buffer = new Map();
 class RpgCommonMap {
     constructor() {
         this.width = 0;
         this.height = 0;
+        /**
+         * @title Width of a tile
+         * @prop {number} [tileWidth]
+         * @readonly
+         * @memberof Map
+         * @memberof RpgSceneMap
+         * */
         this.tileWidth = 0;
+        /**
+        * @title Height of a tile
+        * @prop {number} [tileHeight]
+        * @readonly
+        * @memberof Map
+        * @memberof RpgSceneMap
+        * */
         this.tileHeight = 0;
+        /**
+         * @title Layers of map
+         * @prop {object[]} [layers]
+         * @readonly
+         * @memberof Map
+         * @memberof RpgSceneMap
+         * */
         this.layers = [];
         this.shapes = [];
     }
@@ -24,12 +46,33 @@ class RpgCommonMap {
         this.layers = data.layers;
         this._extractShapes();
     }
+    /**
+     * @title Width of the map in pixels
+     * @prop {number} [widthPx]
+     * @readonly
+     * @memberof Map
+     * @memberof RpgSceneMap
+     * */
     get widthPx() {
         return this.width * this.tileWidth;
     }
+    /**
+     * @title Height of the map in pixels
+     * @prop {number} [heightPx]
+     * @readonly
+     * @memberof Map
+     * @memberof RpgSceneMap
+     * */
     get heightPx() {
         return this.height * this.tileHeight;
     }
+    /**
+     * @title The depth of the map in pixels (this is the height of a tile ;))
+     * @prop {number} map.zTileHeight
+     * @readonly
+     * @memberof Map
+     * @memberof RpgSceneMap
+     * */
     get zTileHeight() {
         return this.tileHeight;
     }
@@ -42,19 +85,90 @@ class RpgCommonMap {
             }
         }
     }
+    /**
+     * Find a layer by name. Returns `undefined` is the layer is not found
+
+     * @title Get Layer by name
+     * @method map.getLayerByName(name)
+     * @param {string} name layer name
+     * @returns {LayerInfo | undefined}
+     * @example
+     *  ```ts
+     *  const tiles = map.getLayerByName(0, 0)
+     *  ```
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getLayerByName(name) {
+        return this.layers.find(layer => layer.name == name);
+    }
+    /**
+     * Create a shape dynamically on the map
+     *
+     * Object:
+     *  - (number) x: Position X
+     *  - (number) y: Position Y
+     *  - (number) width: Width
+     *  - (number) height: Height
+     *  - (object) properties (optionnal):
+     *      - (number) z: Position Z
+     *      - (hexadecimal) color: Color (shared with client)
+     *      - (boolean) collision
+     *      - You can your own properties
+     *
+     * @title Create Shape
+     * @since 3.0.0-beta.3
+     * @method map.createShape(obj)
+     * @param {object} obj
+     * @returns {RpgShape}
+     * @memberof Map
+     */
     createShape(obj) {
         obj.name = (obj.name || Utils_1.generateUID());
-        const shape = new Shape_1.Shape(obj);
+        obj.properties = obj.properties || {};
+        const shape = new Shape_1.RpgShape(obj);
         this.shapes.push(shape);
-        return shape;
+        // trick to sync with client
+        return this.shapes[this.shapes.length - 1];
     }
+    /**
+     * Delete a shape
+     *
+     * @title Get Shapes
+     * @method map.removeShape(name)
+     * @param {string} name Name of shape
+     * @returns {void}
+     * @memberof Map
+     */
     removeShape(name) {
         // TODO: out players after delete shape
         this.shapes = this.shapes.filter(shape => shape.name != name);
     }
+    /**
+     * Return all shapes on the map
+     *
+     * @title Get Shapes
+     * @method map.getShapes()
+     * @returns {RpgShape[]}
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
     getShapes() {
         return this.shapes;
     }
+    /**
+     * Returns a shape by its name. Returns undefined is nothing is found
+     *
+     * @title Get Shape by name
+     * @method map.getShape(name)
+     * @param {string} name Name of shape
+     * @returns {RpgShape[] | undefined}
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getShape(name) {
+        return this.shapes.find(shape => shape.name == name);
+    }
     getPositionByShape(filter) {
         const startsFind = this.getShapes().filter(filter);
         if (startsFind.length) {
@@ -63,10 +177,58 @@ class RpgCommonMap {
         }
         return null;
     }
-    getTileIndex(x, y, [z]) {
+    setTile(x, y, layerFilter, tileInfo) {
+        const tileIndex = this.getTileIndex(x, y);
+        let fnFilter;
+        let tilesEdited = {};
+        if (Utils_1.isString(layerFilter)) {
+            fnFilter = (layer) => layer.name == layerFilter;
+        }
+        else {
+            fnFilter = layerFilter;
+        }
+        for (let layer of this.layers) {
+            if (!fnFilter(layer))
+                continue;
+            tilesEdited[layer.name] = tileInfo;
+            layer.tiles[tileIndex] = tilesEdited[layer.name];
+        }
+        return {
+            x,
+            y,
+            tiles: tilesEdited
+        };
+    }
+    /**
+     * Get the tile index on the tileset
+     *
+     * @title Get index of tile
+     * @method map.getTileIndex(x,y)
+     * @param {number} x Position X
+     * @param {number} x Position Y
+     * @returns {number}
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getTileIndex(x, y, [z] = [0]) {
         return this.width * Math.floor((y - z) / this.tileHeight) + Math.floor(x / this.tileWidth);
     }
-    getTileByIndex(tileIndex, zPlayer) {
+    /**
+     * Retrieves tiles according to its index
+
+     * @title Get tile by index
+     * @method map.getTileByIndex(tileIndex)
+     * @param {number} tileIndex tile index
+     * @returns {TileInfo}
+     * @example
+     *  ```ts
+     *  const index = map.getTileIndex(0, 0)
+     *  const tiles = map.getTileByIndex(index)
+     *  ```
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getTileByIndex(tileIndex, zPlayer = [0, 0]) {
         const tiles = [];
         for (let layer of this.layers) {
             if (layer.type != 'tile') {
@@ -76,7 +238,9 @@ class RpgCommonMap {
             if (!_tiles) {
                 continue;
             }
-            const zLayer = layer.properties.z;
+            if (!_tiles.properties)
+                _tiles.properties = {};
+            const zLayer = layer.properties ? layer.properties.z : 0;
             const zTile = _tiles.properties.z;
             let z, zIntersection;
             if (zLayer !== undefined) {
@@ -103,7 +267,8 @@ class RpgCommonMap {
                 tiles,
                 hasCollision: true,
                 isOverlay: false,
-                objectGroups: []
+                objectGroups: [],
+                tileIndex
             };
         }
         const hasCollision = getLastTile.properties.collision;
@@ -115,19 +280,77 @@ class RpgCommonMap {
             hasCollision,
             isOverlay,
             objectGroups,
-            isClimbable
+            isClimbable,
+            tileIndex
         };
     }
+    /**
+     * Find the point of origin (top left) of a tile. Of course, its position depends on the size of the tile
+
+     * @title Get origin position of tile
+     * @method map.getTileOriginPosition(x,y)
+     * @param {number} x Position X
+     * @param {number} x Position Y
+     * @returns { {x: number, y: number }}
+     * @example
+     *  ```ts
+     *  // If the size of a tile is 32x32px
+     *  const position = map.getTileOriginPosition(35, 12)
+     *  console.log(position) // { x: 32, y: 0 }
+     *  ```
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
     getTileOriginPosition(x, y) {
         return {
             x: Math.floor(x / this.tileWidth) * this.tileWidth,
             y: Math.floor(y / this.tileHeight) * this.tileHeight
         };
     }
-    getTileByPosition(x, y, z) {
-        const tileIndex = this.getTileIndex(x, y, z);
+    /**
+     * Recover tiles according to a position
+
+     * @title Get tile by position
+     * @method map.getTileByPosition(x,y)
+     * @param {number} x Position X
+     * @param {number} x Position Y
+     * @returns {TileInfo}
+     * @example
+     *  ```ts
+     *  const tiles = map.getTileByPosition(0, 0)
+     *  ```
+     * @memberof Map
+     * @memberof RpgSceneMap
+     */
+    getTileByPosition(x, y, z = [0, 0]) {
+        const tileIndex = this.getTileIndex(x, y, [z[0]]);
         return this.getTileByIndex(tileIndex, z);
     }
+    /**
+     * Get tile and verify collision with hitbox
+     * @param hitbox
+     * @param x
+     * @param y
+     * @param z
+     * @returns TileInfo
+     */
+    getTile(hitbox, x, y, z = [0, 0]) {
+        const tile = this.getTileByPosition(x, y, z);
+        const tilePos = this.getTileOriginPosition(x, y);
+        if (tile.objectGroups) {
+            for (let object of tile.objectGroups) {
+                const hit = Hit_1.Hit.getHitbox(object, {
+                    x: tilePos.x,
+                    y: tilePos.y
+                });
+                const collided = Hit_1.Hit.testPolyCollision(hit.type, hit.hitbox, hitbox);
+                if (collided) {
+                    tile.hasCollision = true;
+                }
+            }
+        }
+        return tile;
+    }
 }
 exports.default = RpgCommonMap;
 //# sourceMappingURL=Map.js.map