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

package/src/Player/StateManager.ts

@@ -5,9 +5,12 @@ import { StateLog } from '../logs/state'
 
 const { 
     isInstanceOf,
-    applyMixins
+    applyMixins,
+    isString
 } = Utils
 
+type StateClass = { new(...args: any[]) }
+
 export class StateManager {
 
     states: any[] = []
@@ -119,12 +122,18 @@ export class StateManager {
      * 
      * @title Get State
      * @method player.getState(stateClass)
-     * @param {StateClass} stateClass
+     * @param {StateClass | string} stateClass or state id
      * @returns {instance of StateClass | null}
      * @memberof StateManager
      */
-    getState(stateClass) {
-        return this.states.find(({ state }) => state instanceof stateClass)
+    getState(stateClass: StateClass | string) {
+        if (isString(stateClass)) stateClass = this.databaseById(stateClass)
+        return this.states.find((state) => {
+            if (isString(stateClass)) {
+                return state.id == stateClass
+            }
+            return isInstanceOf(state, stateClass)
+        })
     }
 
     /**
@@ -142,7 +151,7 @@ export class StateManager {
      * 
      * @title Add State
      * @method player.addState(stateClass,chance=1)
-     * @param {StateClass} stateClass
+     * @param {StateClass | string} stateClass state class or state id
      * @param {number} [chance] 1 by default
      * @throws {StateLog} addFailed 
      * If the chance to add the state has failed (defined with the `chance` param)
@@ -156,14 +165,17 @@ export class StateManager {
      * @memberof StateManager
      * @todo
      */
-    addState(stateClass, chance = 1): object | null {
+    addState(stateClass: StateClass | string, chance = 1): object | null {
         const state = this.getState(stateClass)
+        if (isString(stateClass)) {
+            stateClass = this.databaseById(stateClass)
+        }
         if (!state) {
             if (Math.random() > chance) {
                 throw StateLog.addFailed(stateClass)
             }
             //const efficiency = this.findStateEfficiency(stateClass)
-            const instance = new stateClass()
+            const instance = new (stateClass as StateClass)()
             this.states.push(instance)
             this.applyStates(<any>this, instance)
             return instance
@@ -186,7 +198,7 @@ export class StateManager {
      * 
      * @title Remove State
      * @method player.removeState(stateClass,chance=1)
-     * @param {StateClass} stateClass
+     * @param {StateClass|string} stateClass class state or state id
      * @param {number} [chance] 1 by default
      * @throws {StateLog} removeFailed 
      * If the chance to remove the state has failed (defined with the `chance` param)
@@ -207,8 +219,13 @@ export class StateManager {
      * @returns {instance of StateClass}
      * @memberof StateManager
      */
-    removeState(stateClass, chance = 1) {
-        const index = this.states.findIndex(state => state instanceof stateClass)
+    removeState(stateClass: StateClass | string, chance = 1) {
+        const index = this.states.findIndex((state) => {
+            if (isString(stateClass)) {
+                return state.id == stateClass
+            }
+            return isInstanceOf(state, stateClass)
+        })
         if (index != -1) {
             if (Math.random() > chance) {
                 throw StateLog.removeFailed(stateClass)
@@ -227,4 +244,6 @@ export class StateManager {
 
 applyMixins(StateManager, [ItemFixture])
 
-export interface StateManager extends ItemFixture { }
+export interface StateManager extends ItemFixture { 
+    databaseById(stateClass: any),
+}

package/src/RpgServer.ts

@@ -136,7 +136,6 @@ export interface RpgPlayerHooks {
     *  When the player increases one level
     * 
     * @prop { (player: RpgPlayer, nbLevel: number) => any } [onLevelUp]
-    * @stability 1
     * @memberof RpgPlayerHooks
     */
     onLevelUp?: (player: RpgPlayer, nbLevel: number) => any
@@ -145,7 +144,6 @@ export interface RpgPlayerHooks {
     *  When the player's HP drops to 0
     * 
     * @prop { (player: RpgPlayer) => any } [onDead]
-    * @stability 1
     * @memberof RpgPlayerHooks
     */
     onDead?: (player: RpgPlayer) => any,
@@ -196,6 +194,48 @@ export interface RpgPlayerHooks {
 }
 
 export interface RpgServer {
+    /**
+     * Add hooks to the player or engine. All modules can listen to the hook
+     * 
+     * @prop { { player: string[], engine: string[] } } [hooks]
+     * @memberof RpgServer
+     * @since 4.0.0
+     * @stability 1
+     * @example
+     * 
+     * ```ts
+     * import { RpgServer, RpgModule } from '@rpgjs/server'
+     * 
+     * @RpgModule<RpgServer>({
+     *     hooks: {
+     *        player: ['onAuth']
+     *    }
+     * })
+     * class RpgServerEngine { }
+     * ```
+     * 
+     * Emit the hook:
+     * 
+     * ```ts
+     * server.module.emit('server.player.onAuth', player)
+     * ```
+     * 
+     * And listen to the hook:
+     * 
+     * ```ts
+     * import { RpgPlayerHooks, RpgPlayer } from '@rpgjs/server'
+     * 
+     * const player: RpgPlayerHooks = {
+     *    onAuth(player: RpgPlayer) {
+     *       console.log('player is authenticated') 
+     *   }
+     * }
+     * ```
+     */
+    hooks?: {
+        player?: string[],
+        engine?: string[]
+    }
 
     /**
      * Adding sub-modules

package/src/Scenes/Map.ts

@@ -48,6 +48,8 @@ export class SceneMap {
 
     /**
      * Returns an array of RpgClassMap objects that represent maps with static properties.
+     * 
+     * @method sceneMap.getMaps()
      * @returns {RpgClassMap<RpgMap>[]} Array of RpgClassMap objects.
      * @since 4.0.0
      * @example
@@ -293,6 +295,7 @@ export class SceneMap {
         player = World.getUser(player.id) as RpgPlayer
 
         if (player) {
+            mapInstance.loadCommonEvents(this.server.inputOptions.events, player)
             player.createDynamicEvent(<any>mapInstance._events, false)
             await player.execMethod('onJoinMap', <any>[mapInstance])
         }

package/src/express/server.ts

@@ -1,6 +1,7 @@
 import http from 'http'
 import path from 'path'
 import express from 'express'
+import cors from 'cors'
 import { Server } from 'socket.io'
 import entryPoint from '../entry-point'
 import PrettyError from 'pretty-error'
@@ -37,7 +38,7 @@ export function expressServer(modules: ModuleType[], options: ExpressServerOptio
 
         // @ts-ignore
         const isBuilt = !!envs.VITE_BUILT
-        
+
         // @ts-ignore
         const hasStatic = process.env.STATIC_DIRECTORY_ENABLED
         const staticDirectory = isBuilt ? '' : 'dist'
@@ -50,13 +51,17 @@ export function expressServer(modules: ModuleType[], options: ExpressServerOptio
                 limit: '50mb'
             }))
         }
-       
+
+        app.use(cors())
+
         if (staticEnabled) {
             app.use('/', express.static(path.join(dirname, '..', staticDirectory, 'client')))
         }
 
+        let rpgGame: RpgServerEngine
+
         async function start() {
-            const rpgGame = await entryPoint(modules, { io, ...options })
+            rpgGame = await entryPoint(modules, { io, ...options })
             rpgGame.app = app
             rpgGame.start()
             app.use('/api', api(rpgGame))
@@ -89,6 +94,7 @@ export function expressServer(modules: ModuleType[], options: ExpressServerOptio
                 Query.getPlayers().forEach(player => {
                     player.gameReload()
                 })
+                rpgGame.stop()
             });
         }
     })

package/src/index.ts

@@ -1,11 +1,11 @@
 export { default as entryPoint } from './entry-point'
-export { 
-    Direction, 
-    Input, 
-    Control, 
-    RpgPlugin, 
-    HookServer, 
-    HookClient, 
+export {
+    Direction,
+    Input,
+    Control,
+    RpgPlugin,
+    HookServer,
+    HookClient,
     RpgModule,
     RpgShape,
     ShapePositioning,
@@ -26,3 +26,4 @@ export { SceneMap as RpgSceneMap, RpgClassMap } from './Scenes/Map'
 export { RpgMatchMaker } from './MatchMaker'
 export { IStoreState } from './Interfaces/StateStore'
 export { Components } from './Player/ComponentManager'
+export { Gui } from './Gui/Gui'

package/src/models/Item.ts

@@ -2,7 +2,7 @@ import { ItemOptions } from '@rpgjs/database'
 import { RpgPlayer } from '../Player/Player';
 
 export interface ItemModel extends ItemOptions {
-    id: string
+    id?: string
     equipped?: boolean
     onUseFailed?: (player: RpgPlayer) => {}
     onUse?: (player: RpgPlayer) => {}

package/src/server.ts

@@ -336,6 +336,10 @@ export class RpgServerEngine {
         return this.getScene<SceneMap>(SceneMap.id)
     }
 
+    get module() {
+        return RpgPlugin
+    }
+
     sendToPlayer(currentPlayer, eventName, data) {
         currentPlayer._socket.emit(eventName, data)
     }
@@ -360,7 +364,7 @@ export class RpgServerEngine {
         })
 
         socket.on('disconnect', () => {
-            this.onPlayerDisconnected(socket.id, playerId)
+            this.onPlayerDisconnected(playerId)
         })
 
         this.world.setUser(player, socket)
@@ -383,14 +387,13 @@ export class RpgServerEngine {
         }
     }
 
-    /**
-     * 
-     * @param {string} socketId - The socketId of the player that disconnected
-     * @param {string} playerId - The playerId of the player that disconnected 
-     */
-    private onPlayerDisconnected(socketId, playerId: string) {
+    private onPlayerDisconnected(playerId: string) {
         const player: RpgPlayer = World.getUser(playerId) as RpgPlayer
         player.execMethod('onDisconnected')
         this.world.disconnectUser(playerId)
     }
+
+    stop() {
+        this.scheduler.stop()
+    }
 }