@littlepartytime/sdk 2.2.0 → 2.2.1

package/GAME_DEV_GUIDE.md

@@ -982,6 +982,101 @@ Renderer receives "stateUpdate" event with filtered state
 React re-renders with new state
 ```
 
+## Game Settlement Lifecycle
+
+When `isGameOver()` returns `true`, the platform **immediately** takes over: it sends `game:result` to all clients, transitions to the settlement screen, and **unloads the game renderer**. This happens in the same tick as the final `game:state` broadcast:
+
+```
+engine.handleAction(state, playerId, action) → newState
+broadcastPlayerViews(newState)          ← last game frame sent
+engine.isGameOver(newState) → true
+handleGameEnd()                         ← platform takes over, renderer unloaded
+```
+
+If your game needs an in-game settlement screen (animations, rankings, replay, etc.), you **must not** let `isGameOver()` return `true` until that screen is done.
+
+### Two-Phase Settlement Pattern
+
+Split game ending into two phases:
+
+```
+playing → (winner decided) → settlement → (player confirms or timer expires) → finished
+                               ↑                                                  ↑
+                        isGameOver = false                                 isGameOver = true
+                        game renderer shows                                platform takes over
+                        its own result screen
+```
+
+#### Engine Implementation
+
+```typescript
+handleAction(state: GameState, playerId: string, action: GameAction): GameState {
+  const data = state.data as MyGameData;
+
+  // 1. Normal gameplay — when winner is decided, enter settlement
+  if (state.phase === "playing" && winnerDecided(data)) {
+    return {
+      ...state,
+      phase: "settlement",
+      data: { ...data, rankings: computeRankings(data) },
+    };
+  }
+
+  // 2. Settlement — wait for confirm action, then finish
+  if (state.phase === "settlement" && action.type === "CONFIRM_RESULT") {
+    return { ...state, phase: "finished" };
+  }
+
+  return state;
+},
+
+isGameOver(state: GameState): boolean {
+  return state.phase === "finished";   // NOT "settlement"!
+},
+
+getPlayerView(state: GameState, playerId: string): Partial<GameState> {
+  if (state.phase === "settlement") {
+    // Return rankings / stats for the in-game result screen
+    return {
+      ...state,
+      data: { rankings: (state.data as MyGameData).rankings },
+    };
+  }
+  // ...
+},
+```
+
+#### Renderer Implementation
+
+```tsx
+export default function GameRenderer({ platform, state }: GameRendererProps) {
+  if (state.phase === "settlement") {
+    return (
+      <div>
+        {/* Show your in-game result screen here */}
+        <Rankings data={state.data.rankings} />
+        <button onClick={() => platform.send({ type: "CONFIRM_RESULT" })}>
+          确认
+        </button>
+      </div>
+    );
+  }
+  // ... normal gameplay UI
+}
+```
+
+### Common Mistakes
+
+| Mistake | Consequence |
+|---------|------------|
+| `isGameOver()` returns `true` in `settlement` phase | In-game result screen is skipped — platform unloads the renderer immediately |
+| No `settlement` phase; jumping straight from `playing` to `finished` | Players never see the in-game result animation / ranking |
+| Calling `platform.reportResult()` from the renderer | No-op — settlement is driven entirely by the server via `isGameOver` + `getResult` |
+
+### One-Liner Rule
+
+> **`isGameOver()` is the platform takeover switch. Do not return `true` until your in-game result screen is done.**
+
 ## Complete Example: Number Guessing Game
 
 See the [`examples/number-guess`](../../examples/number-guess) directory for a complete working example.

package/dist/interfaces.d.ts

@@ -32,6 +32,16 @@ export interface GameConfig {
 export interface GameEngine {
     init(players: Player[], options?: Record<string, unknown>): GameState;
     handleAction(state: GameState, playerId: string, action: GameAction): GameState;
+    /**
+     * Called after every handleAction. When this returns true, the platform
+     * immediately sends game:result, unloads the renderer, and shows the
+     * platform settlement screen.
+     *
+     * If your game has an in-game result screen (animations, rankings, etc.),
+     * keep returning false during that phase and only return true when the
+     * in-game result screen is done. See "Game Settlement Lifecycle" in
+     * GAME_DEV_GUIDE.md.
+     */
     isGameOver(state: GameState): boolean;
     getResult(state: GameState): GameResult;
     getPlayerView(state: GameState, playerId: string): Partial<GameState>;

package/dist/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU;IACzB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACtE,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC;IAChF,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IACtC,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IACxC,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACvE;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC3B"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU;IACzB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACtE,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC;IAChF;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IACtC,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IACxC,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACvE;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@littlepartytime/sdk",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Game SDK for Little Party Time platform - type definitions and testing utilities",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",