@rpgjs/server 4.0.0-beta.9 → 4.0.0-rc.10

package/lib/Player/Player.d.ts

@@ -1,4 +1,5 @@
 import { RpgCommonPlayer, RpgCommonGame } from '@rpgjs/common';
+import { WorldClass } from 'simple-room';
 import { RpgMap, EventPosOption } from '../Game/Map';
 import { ItemManager } from './ItemManager';
 import { GoldManager } from './GoldManager';
@@ -12,8 +13,10 @@ import { GuiManager } from './GuiManager';
 import { VariableManager } from './VariableManager';
 import { MoveManager } from './MoveManager';
 import { BattleManager } from './BattleManager';
+import { RpgServerEngine } from '../server';
 import { CameraOptions, PositionXY_OptionalZ, LayoutObject } from '@rpgjs/types';
 import { ComponentManager } from './ComponentManager';
+import { EventManager, EventMode } from '../Game/EventManager';
 export interface Position {
     x: number;
     y: number;
@@ -50,45 +53,82 @@ export declare class RpgPlayer extends RpgCommonPlayer {
             teleported: {
                 $permanent: boolean;
             };
+            deleted: {
+                $permanent: boolean;
+            };
             param: ObjectConstructor;
             hp: NumberConstructor;
             sp: NumberConstructor;
             gold: NumberConstructor;
-            level: NumberConstructor;
+            level: {
+                $effects: string[];
+            };
+            expForNextlevel: {
+                $permanent: boolean;
+            };
             exp: NumberConstructor;
             name: StringConstructor;
-            expForNextlevel: NumberConstructor;
             items: {
                 nb: NumberConstructor;
                 item: {
-                    name: StringConstructor;
-                    description: StringConstructor;
-                    price: NumberConstructor;
-                    consumable: BooleanConstructor;
+                    name: {
+                        $permanent: boolean;
+                    };
+                    description: {
+                        $permanent: boolean;
+                    };
                     id: StringConstructor;
+                    price: {
+                        $permanent: boolean;
+                    };
+                    consumable: {
+                        $permanent: boolean;
+                    };
                 };
             }[];
             _class: {
-                name: StringConstructor;
-                description: StringConstructor;
+                name: {
+                    $permanent: boolean;
+                };
+                description: {
+                    $permanent: boolean;
+                };
                 id: StringConstructor;
             };
             equipments: {
-                name: StringConstructor;
-                description: StringConstructor;
-                price: NumberConstructor;
-                consumable: BooleanConstructor;
+                name: {
+                    $permanent: boolean;
+                };
+                description: {
+                    $permanent: boolean;
+                };
                 id: StringConstructor;
+                price: {
+                    $permanent: boolean;
+                };
+                consumable: {
+                    $permanent: boolean;
+                };
             }[];
             skills: {
-                name: StringConstructor;
-                description: StringConstructor;
-                spCost: NumberConstructor;
+                name: {
+                    $permanent: boolean;
+                };
+                description: {
+                    $permanent: boolean;
+                };
                 id: StringConstructor;
+                spCost: {
+                    $permanent: boolean;
+                };
             }[];
             states: {
-                name: StringConstructor;
-                description: StringConstructor;
+                name: {
+                    $permanent: boolean;
+                };
+                description: {
+                    $permanent: boolean;
+                };
                 id: StringConstructor;
             }[];
             effects: StringConstructor[];
@@ -202,45 +242,82 @@ export declare class RpgPlayer extends RpgCommonPlayer {
         teleported: {
             $permanent: boolean;
         };
+        deleted: {
+            $permanent: boolean;
+        };
         param: ObjectConstructor;
         hp: NumberConstructor;
         sp: NumberConstructor;
         gold: NumberConstructor;
-        level: NumberConstructor;
+        level: {
+            $effects: string[];
+        };
+        expForNextlevel: {
+            $permanent: boolean;
+        };
         exp: NumberConstructor;
         name: StringConstructor;
-        expForNextlevel: NumberConstructor;
         items: {
             nb: NumberConstructor;
             item: {
-                name: StringConstructor;
-                description: StringConstructor;
-                price: NumberConstructor;
-                consumable: BooleanConstructor;
+                name: {
+                    $permanent: boolean;
+                };
+                description: {
+                    $permanent: boolean;
+                };
                 id: StringConstructor;
+                price: {
+                    $permanent: boolean;
+                };
+                consumable: {
+                    $permanent: boolean;
+                };
             };
         }[];
         _class: {
-            name: StringConstructor;
-            description: StringConstructor;
+            name: {
+                $permanent: boolean;
+            };
+            description: {
+                $permanent: boolean;
+            };
             id: StringConstructor;
         };
         equipments: {
-            name: StringConstructor;
-            description: StringConstructor;
-            price: NumberConstructor;
-            consumable: BooleanConstructor;
+            name: {
+                $permanent: boolean;
+            };
+            description: {
+                $permanent: boolean;
+            };
             id: StringConstructor;
+            price: {
+                $permanent: boolean;
+            };
+            consumable: {
+                $permanent: boolean;
+            };
         }[];
         skills: {
-            name: StringConstructor;
-            description: StringConstructor;
-            spCost: NumberConstructor;
+            name: {
+                $permanent: boolean;
+            };
+            description: {
+                $permanent: boolean;
+            };
             id: StringConstructor;
+            spCost: {
+                $permanent: boolean;
+            };
         }[];
         states: {
-            name: StringConstructor;
-            description: StringConstructor;
+            name: {
+                $permanent: boolean;
+            };
+            description: {
+                $permanent: boolean;
+            };
             id: StringConstructor;
         }[];
         effects: StringConstructor[];
@@ -352,16 +429,28 @@ export declare class RpgPlayer extends RpgCommonPlayer {
     _rooms: never[];
     session: string | null;
     prevMap: string;
+    /**
+    * ```ts
+    * retreive the server instance
+    * ```
+    * @title Server Instance
+    * @prop {RpgServerEngine} player.server
+    * @memberof Player
+    * */
+    server: RpgServerEngine;
     private touchSide;
     otherPossessedPlayer: RpgPlayer | RpgEvent | null;
     following: RpgPlayer | RpgEvent | null;
+    private _dataLoading;
     _lastFramePositions: {
         frame: number;
         position: Position;
     } | undefined;
     constructor(gameEngine: RpgCommonGame, playerId: string);
     get otherPlayersCollision(): RpgPlayer[];
+    get world(): WorldClass | undefined;
     teleported: number;
+    deleted: boolean;
     _init(): void;
     private get schema();
     /**
@@ -426,16 +515,6 @@ export declare class RpgPlayer extends RpgCommonPlayer {
     createDynamicEvent(eventsList: EventPosOption | EventPosOption[], forceMode?: boolean): {
         [eventId: string]: RpgEvent;
     };
-    /**
-     * Removes an event from the map (Scenario Mode). Returns false if the event is not found
-     * @title Remove Event
-     * @since 3.0.0-beta.4
-     * @method player.removeEvent(eventId)
-     * @param {string} eventId Event Name
-     * @returns {boolean}
-     * @memberof Player
-     */
-    removeEvent(eventId: string): boolean;
     /**
      * Allows to change the positions of the player on the current map.
      * You can put the X and Y positions or the name of the created shape on Tiled Map Editor.
@@ -476,10 +555,10 @@ export declare class RpgPlayer extends RpgCommonPlayer {
      * @title Load progress
      * @method player.load(json)
      * @param {string} json The JSON sent by the method save()
-     * @returns {string}
+     * @returns {Promise<boolean | RpgMap | null>}
      * @memberof Player
      */
-    load(json: any): void;
+    load(json: any): Promise<boolean | RpgMap | null>;
     /**
      * Returns a JSON with all the data to keep in memory. Then use the `load()` method to load the data
      *
@@ -572,6 +651,7 @@ export declare class RpgPlayer extends RpgCommonPlayer {
      * This is useful, if for example, you want to make an animated character (sword stroke when pressing a key)
      * When the animation is finished, the original graphic is displayed again
      *
+     *
      * ```ts
      * player.showAnimation('sword_stroke', 'default', true)
      * ```
@@ -582,6 +662,10 @@ export declare class RpgPlayer extends RpgCommonPlayer {
      * player.showAnimation(['body', 'sword_stroke'], 'default', true)
      * ```
      *
+     * ::: tip
+     * For this to work, the animations must have been previously defined in `setGraphic`.
+     * :::
+     *
      * @title Show Animation
      * @method player.showAnimation(graphic,animationName,replaceGraphic=false)
      * @param {string | string[]} graphic spritesheet identifier
@@ -659,8 +743,9 @@ export declare class RpgPlayer extends RpgCommonPlayer {
      * @memberof Player
      */
     off(key: string): void;
+    disconnect(): void;
     emitToMap(key: string, value: any): void;
-    execMethod(methodName: string, methodData?: never[]): Promise<any[]>;
+    execMethod(methodName: string, methodData?: never[], target?: any): Promise<any>;
     _triggerHook(name: any, val?: any): void;
     private _eventChanges;
     /**
@@ -692,22 +777,18 @@ export declare class RpgPlayer extends RpgCommonPlayer {
      * @title Play Sound
      * @method player.playSound(soundId,allMap=false)
      * @param {string} soundId Sound identifier, defined on the client side
-     * @param {boolean} [allMap] Indicate if the sound is heard by the players on the map
+     * @param {boolean} [forEveryone=false] Indicate if the sound is heard by the players on the map
      * @since 3.0.0-alpha.9
      * @returns {void}
      * @memberof Player
      */
-    playSound(soundId: string, allMap?: boolean): void;
+    playSound(soundId: string, forEveryone?: boolean): void;
 }
-export interface RpgPlayer extends ItemManager, GoldManager, StateManager, SkillManager, ParameterManager, EffectManager, ClassManager, ElementManager, GuiManager, VariableManager, MoveManager, BattleManager, ComponentManager {
+export interface RpgPlayer extends EventManager, ItemManager, GoldManager, StateManager, SkillManager, ParameterManager, EffectManager, ClassManager, ElementManager, GuiManager, VariableManager, MoveManager, BattleManager, ComponentManager {
     _socket: any;
     vision: any;
     attachShape: any;
 }
-export declare enum EventMode {
-    Shared = "shared",
-    Scenario = "scenario"
-}
 export interface RpgClassEvent<T> {
     _name: string;
     new (): T;
@@ -715,5 +796,20 @@ export interface RpgClassEvent<T> {
 export declare class RpgEvent extends RpgPlayer {
     readonly type: string;
     properties: any;
+    mode: EventMode;
+    playerRelated: RpgPlayer | null;
+    constructor(gameEngine: RpgCommonGame, playerId: string);
     execMethod(methodName: string, methodData?: never[]): Promise<any>;
+    changeRoomState(path: string): void;
+    /**
+    * Deletes the event from the map (in shared or scenario mode)
+    *
+    * @title Remove
+    * @since 4.0.0
+    * @method event.remove()
+    * @returns {boolean} true if the event has been removed. If false, the event is not on the map
+    * @memberof RpgEvent
+    */
+    remove(): boolean;
+    emitToMap(key: string, value: any): void;
 }