@uzuhq/code-sdk 0.8.8 → 0.8.9

package/README.md

@@ -296,6 +296,24 @@ changeRoom(null); // デフォルトルーム（全員が同じ音声チャン
 - 初期状態ではすべてのプレイヤーがデフォルトルーム（`null`）に所属する
 - `roomId` に文字列を指定すると、そのプレイヤーは指定ルームへ移動する
 
+### `finishGame(): void`
+
+ゲームを終えて、この端末のプレイ画面を閉じる。ホストはイベントを終了扱いにし、呼んだプレイヤーを退出させる。
+
+```ts
+import { finishGame } from '@uzuhq/code-sdk';
+
+onState(state) {
+  if (state.debriefClosed) finishGame();
+}
+```
+
+- 結果や感想戦を見終えて閉じるときに呼ぶ。勝敗が決まった瞬間 (`gameover` など) に呼ぶと、結果を見る前に画面が閉じる
+- 途中退出は UZU メニューの「退出」が担うので、ゲーム内の exit / quit ボタンには使わない
+- 閉じるのは呼んだ端末だけ。全員を閉じたいときは、終了を表す state を全員へ配り、各端末で呼ぶ
+- 再描画のたびに呼んでもよい (ホストは処理中の 2 回目以降を無視する)
+- 対応していない古いアプリや `uzu dev` では何も起きないので、呼んだあとも画面を操作不能にしない
+
 ### `onPlayersChanged(handler: (players: Record<string, PlayerVoiceState>) => void): void`
 
 プレイヤーのリアルタイム状態（音声状態）が変化したときのハンドラを登録する。

package/dist/index.d.ts

@@ -232,6 +232,27 @@ declare function firstFrameReady(): void;
  * ```
  */
 declare function gameReady(): void;
+/**
+ * ゲームを終えてプレイ画面を閉じるよう Flutter ホストに通知する。
+ *
+ * 閉じるのは**呼んだ端末だけ**。全員を閉じたいときは、終了を表す state を全員へ配り、
+ * 各端末の `onState` から呼ぶ。ホストはイベントを終了扱いにし (finishedAt を立てるのは
+ * 最初の 1 人だけ)、呼んだプレイヤーを退出させてから画面を閉じる。
+ *
+ * 呼び出しタイミング: 結果や感想戦を見終えて閉じるときなど、シナリオとしてゲームが完全に
+ * 終わった瞬間。勝敗が決まった瞬間 (`gameover` など) に呼ぶと、結果を見る前に画面が閉じる。
+ *
+ * 対応していない古いアプリや `uzu dev` harness では何も起きない。呼んだあとも画面を
+ * 操作不能にしないこと。
+ *
+ * @example
+ * ```ts
+ * onState(state) {
+ *   if (state.debriefClosed) finishGame();
+ * }
+ * ```
+ */
+declare function finishGame(): void;
 /** Flutter からの playersChanged メッセージを受信するハンドラを登録する。 */
 declare function onPlayersChanged(handler: PlayersChangedHandler): void;
 /**
@@ -245,4 +266,4 @@ declare function onPlayersChanged(handler: PlayersChangedHandler): void;
  */
 declare function run<S, A extends ActionMap<S> = ActionMap<S>, SA extends ServerActionMap<S> = Record<never, never>>(config: GameConfig<S, A, SA>): void;
 //#endregion
-export { type ActionArgs, type ActionContext, type ActionHandler, type ActionMap, type BridgeChannel, type BridgeMessage, type ConnectionCallbacks, type ConnectionState, DEFAULT_ICON_URLS, type Deadline, type DeadlineArgs, type DeadlineContext, type DevHooksCtx, type Duration, type Emit, type EventHandler, type EventSubscription, GAME_START, type GameConfig, type GameLogic, type GameTime, type Insets, type JsonMergePatch, type JsonPatchOp, type Operation, type PayloadMap, type PlayScreenMessage, type PlayerVoiceState, type PlayersChangedMessage, type PredictionWarning, type ReconnectableWSOptions, ReconnectableWebSocket, type RunHandle, type Seat, type SeatKind, type SeededRandom, SeededRandomImpl, type SendAction, type ServerActionArgs, type ServerActionContext, type ServerActionHandler, type ServerActionMap, type ServerEvent, type ServerOnlyAction, type ServerOnlyActionContext, type ServerOnlyActionHandlerFn, type SetupArgs, type SetupContext, type UpdateArgs, type UpdateContext, type UzuDevHooks, type UzuInsets, applyJsonMergePatch, applyJsonPatch, attachDevHooks, changeRoom, createDevHooks, firstFrameReady, gameReady, gameTime, getInsets, getPredictionWarnings, init, isHosted, isPaused, isServerOnlyAction, minus, on, onInsetsChange, onPauseChange, onPlayersChanged, playBgm, playSound, plus, run, send, serverOnly, setMicEnabled, stopBgm, sub };
+export { type ActionArgs, type ActionContext, type ActionHandler, type ActionMap, type BridgeChannel, type BridgeMessage, type ConnectionCallbacks, type ConnectionState, DEFAULT_ICON_URLS, type Deadline, type DeadlineArgs, type DeadlineContext, type DevHooksCtx, type Duration, type Emit, type EventHandler, type EventSubscription, GAME_START, type GameConfig, type GameLogic, type GameTime, type Insets, type JsonMergePatch, type JsonPatchOp, type Operation, type PayloadMap, type PlayScreenMessage, type PlayerVoiceState, type PlayersChangedMessage, type PredictionWarning, type ReconnectableWSOptions, ReconnectableWebSocket, type RunHandle, type Seat, type SeatKind, type SeededRandom, SeededRandomImpl, type SendAction, type ServerActionArgs, type ServerActionContext, type ServerActionHandler, type ServerActionMap, type ServerEvent, type ServerOnlyAction, type ServerOnlyActionContext, type ServerOnlyActionHandlerFn, type SetupArgs, type SetupContext, type UpdateArgs, type UpdateContext, type UzuDevHooks, type UzuInsets, applyJsonMergePatch, applyJsonPatch, attachDevHooks, changeRoom, createDevHooks, finishGame, firstFrameReady, gameReady, gameTime, getInsets, getPredictionWarnings, init, isHosted, isPaused, isServerOnlyAction, minus, on, onInsetsChange, onPauseChange, onPlayersChanged, playBgm, playSound, plus, run, send, serverOnly, setMicEnabled, stopBgm, sub };

package/dist/index.js

@@ -2075,6 +2075,29 @@ function firstFrameReady() {
 function gameReady() {
 	sendRaw("sdk", "gameReady", {});
 }
+/**
+* ゲームを終えてプレイ画面を閉じるよう Flutter ホストに通知する。
+*
+* 閉じるのは**呼んだ端末だけ**。全員を閉じたいときは、終了を表す state を全員へ配り、
+* 各端末の `onState` から呼ぶ。ホストはイベントを終了扱いにし (finishedAt を立てるのは
+* 最初の 1 人だけ)、呼んだプレイヤーを退出させてから画面を閉じる。
+*
+* 呼び出しタイミング: 結果や感想戦を見終えて閉じるときなど、シナリオとしてゲームが完全に
+* 終わった瞬間。勝敗が決まった瞬間 (`gameover` など) に呼ぶと、結果を見る前に画面が閉じる。
+*
+* 対応していない古いアプリや `uzu dev` harness では何も起きない。呼んだあとも画面を
+* 操作不能にしないこと。
+*
+* @example
+* ```ts
+* onState(state) {
+*   if (state.debriefClosed) finishGame();
+* }
+* ```
+*/
+function finishGame() {
+	sendRaw("sdk", "finishGame", {});
+}
 /** Flutter からの playersChanged メッセージを受信するハンドラを登録する。 */
 function onPlayersChanged(handler) {
 	_playersChangedHandlers.push(handler);
@@ -2196,4 +2219,4 @@ function handleMessage(msg) {
 	}
 }
 //#endregion
-export { DEFAULT_ICON_URLS, GAME_START, ReconnectableWebSocket, SeededRandomImpl, applyJsonMergePatch, applyJsonPatch, attachDevHooks, changeRoom, createDevHooks, firstFrameReady, gameReady, gameTime, getInsets, getPredictionWarnings, init, isHosted, isPaused, isServerOnlyAction, minus, on, onInsetsChange, onPauseChange, onPlayersChanged, playBgm, playSound, plus, run, send, serverOnly, setMicEnabled, stopBgm, sub };
+export { DEFAULT_ICON_URLS, GAME_START, ReconnectableWebSocket, SeededRandomImpl, applyJsonMergePatch, applyJsonPatch, attachDevHooks, changeRoom, createDevHooks, finishGame, firstFrameReady, gameReady, gameTime, getInsets, getPredictionWarnings, init, isHosted, isPaused, isServerOnlyAction, minus, on, onInsetsChange, onPauseChange, onPlayersChanged, playBgm, playSound, plus, run, send, serverOnly, setMicEnabled, stopBgm, sub };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uzuhq/code-sdk",
-  "version": "0.8.8",
+  "version": "0.8.9",
   "description": "UZU PlayScreen SDK - Flutter ↔ JS ゲーム通信ライブラリ",
   "type": "module",
   "exports": {