@rpgjs/server 5.0.0-beta.2 → 5.0.0-beta.4

package/dist/Player/SkillManager.d.ts

@@ -3,9 +3,19 @@ import { RpgPlayer } from './Player';
 /**
  * Type for skill class constructor
  */
-type SkillClass = {
+export type SkillClass = {
     new (...args: any[]): any;
 };
+export type SkillChangeAction = "learn" | "forget";
+export interface SkillChangeOptions {
+    source?: "manual" | "level" | "class" | "studio" | string;
+    level?: number;
+}
+export interface SkillChangePayload extends SkillChangeOptions {
+    action: SkillChangeAction;
+    skill: SkillClass | SkillObject | string;
+    skillId: string;
+}
 /**
  * Interface defining the hooks that can be implemented on skill classes or objects
  *
@@ -180,7 +190,7 @@ export interface ISkillManager {
      * @returns The learned skill data
      * @throws SkillLog.alreadyLearned if the player already knows the skill
      */
-    learnSkill(skillInput: SkillClass | SkillObject | string): any;
+    learnSkill(skillInput: SkillClass | SkillObject | string, options?: SkillChangeOptions): any;
     /**
      * Forget a skill
      *
@@ -188,7 +198,7 @@ export interface ISkillManager {
      * @returns The forgotten skill data
      * @throws SkillLog.notLearned if trying to forget a skill not learned
      */
-    forgetSkill(skillInput: SkillClass | SkillObject | string): any;
+    forgetSkill(skillInput: SkillClass | SkillObject | string, options?: SkillChangeOptions): any;
     /**
      * Use a skill
      *
@@ -202,4 +212,3 @@ export interface ISkillManager {
      */
     useSkill(skillInput: SkillClass | SkillObject | string, otherPlayer?: RpgPlayer | RpgPlayer[]): any;
 }
-export {};

package/dist/RpgServer.d.ts

@@ -3,6 +3,7 @@ import { RpgPlayer, RpgEvent } from './Player/Player';
 import { RpgMap } from './rooms/map';
 import { RpgServerEngine } from './RpgServerEngine';
 import { WorldMapConfig, RpgShape, MapPhysicsInitContext, MapPhysicsEntityContext } from '../../common/src';
+import { SkillChangePayload } from './Player/SkillManager';
 type RpgClassMap<T> = new () => T;
 type RpgClassEvent<T> = RpgEvent;
 type MatchMakerOption = any;
@@ -196,6 +197,13 @@ export interface RpgPlayerHooks {
     */
     onLevelUp?: (player: RpgPlayer, nbLevel: number) => any;
     /**
+    *  When a player learns or forgets a skill
+    *
+    * @prop { (player: RpgPlayer, payload: SkillChangePayload) => any } [onSkillChange]
+    * @memberof RpgPlayerHooks
+    */
+    onSkillChange?: (player: RpgPlayer, payload: SkillChangePayload) => any;
+    /**
     *  When the player's HP drops to 0
     *
     * @prop { (player: RpgPlayer) => any } [onDead]