@esengine/server 1.1.4 → 1.2.0

package/dist/Room-BnKpl5Sj.d.ts

@@ -0,0 +1,237 @@
+import { Connection } from '@esengine/rpc';
+
+/**
+ * @zh 玩家类
+ * @en Player class
+ */
+
+/**
+ * @zh 玩家接口
+ * @en Player interface
+ */
+interface IPlayer<TData = Record<string, unknown>> {
+    readonly id: string;
+    readonly roomId: string;
+    data: TData;
+    send<T>(type: string, data: T): void;
+    leave(reason?: string): void;
+}
+/**
+ * @zh 玩家实现
+ * @en Player implementation
+ */
+declare class Player<TData = Record<string, unknown>> implements IPlayer<TData> {
+    readonly id: string;
+    readonly roomId: string;
+    data: TData;
+    private _conn;
+    private _sendFn;
+    private _leaveFn;
+    constructor(options: {
+        id: string;
+        roomId: string;
+        conn: Connection<any>;
+        sendFn: (conn: Connection<any>, type: string, data: unknown) => void;
+        leaveFn: (player: Player<TData>, reason?: string) => void;
+        initialData?: TData;
+    });
+    /**
+     * @zh 获取底层连接
+     * @en Get underlying connection
+     */
+    get connection(): Connection<any>;
+    /**
+     * @zh 发送消息给玩家
+     * @en Send message to player
+     */
+    send<T>(type: string, data: T): void;
+    /**
+     * @zh 让玩家离开房间
+     * @en Make player leave the room
+     */
+    leave(reason?: string): void;
+}
+
+/**
+ * @zh 房间基类
+ * @en Room base class
+ */
+
+/**
+ * @zh 房间配置
+ * @en Room options
+ */
+interface RoomOptions {
+    [key: string]: unknown;
+}
+/**
+ * @zh 房间基类
+ * @en Room base class
+ *
+ * @example
+ * ```typescript
+ * class GameRoom extends Room {
+ *     maxPlayers = 4
+ *     tickRate = 20
+ *
+ *     onJoin(player: Player) {
+ *         this.broadcast('Joined', { id: player.id })
+ *     }
+ *
+ *     @onMessage('Move')
+ *     handleMove(data: { x: number, y: number }, player: Player) {
+ *         // handle move
+ *     }
+ * }
+ * ```
+ */
+declare abstract class Room<TState = any, TPlayerData = Record<string, unknown>> {
+    /**
+     * @zh 最大玩家数
+     * @en Maximum players
+     */
+    maxPlayers: number;
+    /**
+     * @zh Tick 速率（每秒），0 = 不自动 tick
+     * @en Tick rate (per second), 0 = no auto tick
+     */
+    tickRate: number;
+    /**
+     * @zh 空房间自动销毁
+     * @en Auto dispose when empty
+     */
+    autoDispose: boolean;
+    /**
+     * @zh 房间状态
+     * @en Room state
+     */
+    state: TState;
+    private _id;
+    private _players;
+    private _locked;
+    private _disposed;
+    private _tickInterval;
+    private _lastTickTime;
+    private _broadcastFn;
+    private _sendFn;
+    private _disposeFn;
+    /**
+     * @zh 房间 ID
+     * @en Room ID
+     */
+    get id(): string;
+    /**
+     * @zh 所有玩家
+     * @en All players
+     */
+    get players(): ReadonlyArray<Player<TPlayerData>>;
+    /**
+     * @zh 玩家数量
+     * @en Player count
+     */
+    get playerCount(): number;
+    /**
+     * @zh 是否已满
+     * @en Is full
+     */
+    get isFull(): boolean;
+    /**
+     * @zh 是否已锁定
+     * @en Is locked
+     */
+    get isLocked(): boolean;
+    /**
+     * @zh 是否已销毁
+     * @en Is disposed
+     */
+    get isDisposed(): boolean;
+    /**
+     * @zh 房间创建时调用
+     * @en Called when room is created
+     */
+    onCreate(options?: RoomOptions): void | Promise<void>;
+    /**
+     * @zh 玩家加入时调用
+     * @en Called when player joins
+     */
+    onJoin(player: Player<TPlayerData>): void | Promise<void>;
+    /**
+     * @zh 玩家离开时调用
+     * @en Called when player leaves
+     */
+    onLeave(player: Player<TPlayerData>, reason?: string): void | Promise<void>;
+    /**
+     * @zh 游戏循环
+     * @en Game tick
+     */
+    onTick(dt: number): void;
+    /**
+     * @zh 房间销毁时调用
+     * @en Called when room is disposed
+     */
+    onDispose(): void | Promise<void>;
+    /**
+     * @zh 广播消息给所有玩家
+     * @en Broadcast message to all players
+     */
+    broadcast<T>(type: string, data: T): void;
+    /**
+     * @zh 广播消息给除指定玩家外的所有玩家
+     * @en Broadcast message to all players except one
+     */
+    broadcastExcept<T>(except: Player<TPlayerData>, type: string, data: T): void;
+    /**
+     * @zh 获取玩家
+     * @en Get player by id
+     */
+    getPlayer(id: string): Player<TPlayerData> | undefined;
+    /**
+     * @zh 踢出玩家
+     * @en Kick player
+     */
+    kick(player: Player<TPlayerData>, reason?: string): void;
+    /**
+     * @zh 锁定房间
+     * @en Lock room
+     */
+    lock(): void;
+    /**
+     * @zh 解锁房间
+     * @en Unlock room
+     */
+    unlock(): void;
+    /**
+     * @zh 手动销毁房间
+     * @en Manually dispose room
+     */
+    dispose(): void;
+    /**
+     * @internal
+     */
+    _init(options: {
+        id: string;
+        sendFn: (conn: any, type: string, data: unknown) => void;
+        broadcastFn: (type: string, data: unknown) => void;
+        disposeFn: () => void;
+    }): void;
+    /**
+     * @internal
+     */
+    _create(options?: RoomOptions): Promise<void>;
+    /**
+     * @internal
+     */
+    _addPlayer(id: string, conn: any): Promise<Player<TPlayerData> | null>;
+    /**
+     * @internal
+     */
+    _removePlayer(id: string, reason?: string): Promise<void>;
+    /**
+     * @internal
+     */
+    _handleMessage(type: string, data: unknown, playerId: string): void;
+    private _startTick;
+    private _stopTick;
+}
+
+export { type IPlayer as I, Player as P, Room as R, type RoomOptions as a };