@uzuhq/code-sdk 0.8.12 → 0.9.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { $ as plus, A as Deadline, B as ServerActionMap, C as SeatKind, D as ActionHandler, E as ActionContext, F as Seat, G as SetupArgs, H as ServerOnlyAction, I as SeededRandom, J as UpdateContext, K as SetupContext, L as ServerActionArgs, M as DeadlineContext, N as Emit, O as ActionMap, P as GameLogic, Q as minus, R as ServerActionContext, S as PlayersChangedMessage, T as ActionArgs, U as ServerOnlyActionContext, V as ServerEvent, W as ServerOnlyActionHandlerFn, X as GAME_START, Y as Duration, Z as GameTime, _ as EventSubscription, a as createDevHooks, b as PlayScreenMessage, c as applyJsonMergePatch, d as getPredictionWarnings, et as sub, f as BridgeChannel, g as EventHandler, h as ConnectionState, i as attachDevHooks, j as DeadlineArgs, k as DEFAULT_ICON_URLS, l as applyJsonPatch, m as ConnectionCallbacks, n as RunHandle, o as JsonMergePatch, p as BridgeMessage, q as UpdateArgs, r as UzuDevHooks, s as JsonPatchOp, t as DevHooksCtx, u as PredictionWarning, v as GameConfig, w as SendAction, x as PlayerVoiceState, y as PayloadMap, z as ServerActionHandler } from "./dev-hooks-7UDN8Xac.js";
+import { $ as GAME_START, A as Emit, B as ServerOnlyActionContext, C as ActionContext, D as Deadline, E as DEFAULT_ICON_URLS, F as ServerActionContext, G as UpdateContext, H as SetupArgs, I as ServerActionHandler, J as Pause, K as DEFAULT_VOICE_PLAN, L as ServerActionMap, M as Seat, N as SeededRandom, O as DeadlineArgs, P as ServerActionArgs, Q as Duration, R as ServerEvent, S as ActionArgs, T as ActionMap, U as SetupContext, V as ServerOnlyActionHandlerFn, W as UpdateArgs, X as VoicePlan, Y as SeatId, Z as VoicePlanArgs, _ as GameConfig, a as createDevHooks, b as SeatKind, c as applyJsonMergePatch, d as getPredictionWarnings, et as GameTime, f as BridgeChannel, g as EventSubscription, h as EventHandler, i as attachDevHooks, j as GameLogic, k as DeadlineContext, l as applyJsonPatch, m as ConnectionState, n as RunHandle, nt as plus, o as JsonMergePatch, p as BridgeMessage, q as MicPolicy, r as UzuDevHooks, rt as sub, s as JsonPatchOp, t as DevHooksCtx, tt as minus, u as PredictionWarning, v as PayloadMap, w as ActionHandler, x as SendAction, y as PlayScreenMessage, z as ServerOnlyAction } from "./dev-hooks-D30dnLtR.js";
 //#region ../engine-core/src/json-patch.d.ts
 /**
  * @docs
@@ -53,11 +53,151 @@ declare const isServerOnlyAction: <S>(handler: ActionHandler<S> | ServerActionHa
  */
 declare const gameTime: () => GameTime;
 //#endregion
-//#region src/pause-state.d.ts
-/** 緊急停止中か。 */
-declare const isPaused: () => boolean;
-/** 停止状態の変化を購読する。 */
-declare const onPauseChange: (cb: (paused: boolean) => void) => void;
+//#region src/presence-types.d.ts
+/** マイクの状態。サーバーが配る方針と、本人の操作を合わせた結果。 */
+type Mic = {
+  status: 'open';
+} |
+/** scenario = 場面の頭で切られたまま。本人は戻せる。 */
+{
+  status: 'muted';
+  by: 'self' | 'scenario';
+} |
+/** 場面の間は本人も解除できない。 */
+{
+  status: 'locked';
+} |
+/** ライブ配信の観戦者。聴くだけで話せない。 */
+{
+  status: 'listen-only';
+};
+type Quality = 'good' | 'poor';
+/**
+ * 接続と通話の状態。誰か (名前・キャラクター) は名簿 (setup の players / state) から、
+ * 自分の席 ID と席種は `onState` の引数から引く。同じ情報を 2 か所に持たせない。
+ */
+type Presence = {
+  /** 観測席でも必ずある。 */
+  me: Me;
+  /** 自分以外のプレイヤー。キーは席 ID。 */
+  others: Record<SeatId, Other>;
+  /** 観測席 (観戦・進行管理) は人数と、今話している人だけ。 */
+  observers: {
+    count: number;
+    speaking: ObserverRef[];
+  };
+};
+/** 観測席は名簿にいないので、話している人を出すための最小限だけ持つ。 */
+type ObserverRef = {
+  id: SeatId;
+  nickname: string;
+};
+type Me = {
+  /** 自分のゲームの接続。since は端末の時刻 (ms)。 */
+  connection: {
+    status: 'online';
+  } | {
+    status: 'connecting' | 'reconnecting' | 'offline';
+    since: number;
+  };
+  voice:
+  /** 卓が通話を使わない / この端末は通話に入らない (エミュレータなど)。 */
+  {
+    status: 'off';
+    reason: 'table' | 'this-device';
+  } | {
+    status: 'connecting' | 'reconnecting';
+    since: number;
+  } | {
+    status: 'failed';
+    reason: 'mic-permission' | 'network';
+    since: number;
+  } | {
+    status: 'here';
+    room: string | null;
+    mic: Mic;
+    speaking: boolean;
+    quality: Quality;
+  };
+};
+/**
+ * 自分以外のプレイヤー。出すのは声が届くかだけ。
+ *
+ * ゲームの接続は出さない。アプリが裏に回るとゲーム画面は止まるが、通話は続くので、
+ * 接続で判断すると、話せている人を「いない」と扱ってしまう。
+ */
+type Other = {
+  voice: {
+    status: 'off';
+  } |
+  /** 自分と同じ部屋で聞こえている。 */
+  {
+    status: 'here';
+    mic: Mic;
+    speaking: boolean;
+    quality: Quality;
+  } |
+  /** 本人の申告で、別の部屋にいる。 */
+  {
+    status: 'elsewhere';
+    room: string | null;
+  } |
+  /**
+   * 声が届かない。本人の通話が切れた (サーバーが確定した) か、自分と同じ部屋にいるはずなのに
+   * この端末で聞こえなくなった。since は届かなくなった端末の時刻 (ms)。
+   */
+  {
+    status: 'lost';
+    since: number;
+  } |
+  /**
+   * 自分が通話にいない / 本人の申告が届かず、自分にも聞こえていない
+   * (まだ一度も入っていない人もここ)。
+   */
+  {
+    status: 'unknown';
+    reason: 'me-not-connected' | 'no-report';
+  };
+};
+type ConnectionStatus = Me['connection']['status'];
+type VoiceStatus = Me['voice']['status'] | Other['voice']['status'];
+/** 変わったところ。自分の変化も入る (seatId は自分の席 ID)。発話とミュートは入らない。 */
+type PresenceChange =
+/** 自分のゲームの接続だけ。他の人の接続は出さない。 */
+{
+  kind: 'connection';
+  seatId: SeatId;
+  from: ConnectionStatus;
+  to: ConnectionStatus;
+} | {
+  kind: 'voice';
+  seatId: SeatId;
+  from: VoiceStatus;
+  to: VoiceStatus;
+} | {
+  kind: 'observers';
+  from: number;
+  to: number;
+};
+//#endregion
+//#region src/presence.d.ts
+type PresenceListener = (presence: Presence, changes: PresenceChange[]) => void;
+type PauseListener = (pause: Pause) => void;
+/** 今の接続と通話の状態。 */
+declare const getPresence: () => Presence;
+/**
+ * 接続と通話の状態が変わったときに呼ばれる。値全体と、変わったところの一覧を渡す。
+ * 発話やミュートの変化では `changes` は空で、値だけが新しくなる。
+ * 戻り値を呼ぶと、呼ばれなくなる。
+ */
+declare const onPresenceChange: (listener: PresenceListener) => (() => void);
+/** 今止まっているか、止まっていればその理由。止まっていなければ null。 */
+declare const getPause: () => Pause;
+/**
+ * 止まった・再開したときに呼ばれる。理由は今後増えることがあるので、知らない理由でも止まって
+ * いるものとして扱う。戻り値を呼ぶと、呼ばれなくなる。
+ */
+declare const onPauseChange: (listener: PauseListener) => (() => void);
 //#endregion
 //#region src/reconnectable-ws.d.ts
 /**
@@ -178,7 +318,6 @@ declare const onInsetsChange: (cb: (insets: UzuInsets) => void) => (() => void);
 //#endregion
 //#region src/index.d.ts
 type GameMessageHandler = (payload: Record<string, unknown>) => void;
-type PlayersChangedHandler = (players: Record<string, PlayerVoiceState>) => void;
 declare const isHosted: boolean;
 declare const init: (_opts?: {
   playerCount?: number;
@@ -196,8 +335,20 @@ declare const on: (type: string, handler: GameMessageHandler) => void;
 declare const playSound: (sound: string) => void;
 declare const playBgm: (sound: string) => void;
 declare const stopBgm: () => void;
-declare const setMicEnabled: (enabled: boolean) => void;
-declare const changeRoom: (roomId: string | null) => void;
+/**
+ * 観測席 (観戦・進行管理) が聴く通話の部屋を選ぶ。null は全体の部屋。
+ *
+ * プレイヤーの部屋はロジックの `voicePlan` が決めるので、プレイヤー席では何も起きない。
+ */
+declare const setListeningRoom: (room: string | null) => void;
+/**
+ * 本人のマイクをミュートする。
+ *
+ * 作品からできるのはミュートだけで、外すことはできない。外すのは本人が HUD のマイクボタンで
+ * 行う。勝手にマイクを開くと、本人の知らないうちに声が他の人へ届いてしまうため。
+ * 場面ごとに決まったミュートは `voicePlan` の `mic` で宣言する。
+ */
+declare const muteMic: () => void;
 /**
  * 振動の強さ。
  *
@@ -267,8 +418,6 @@ declare const gameReady: () => void;
  * ```
  */
 declare const finishGame: () => void;
-/** Flutter からの playersChanged メッセージを受信するハンドラを登録する。 */
-declare const onPlayersChanged: (handler: PlayersChangedHandler) => void;
 /**
  * `A` に既定値が要る。 TypeScript は型引数の部分推論ができないので、 既定が無いと
  * 既存の `run<State>({…})` が「2 つ必要」で落ちる。 既定を置けば型引数を書かない
@@ -280,4 +429,4 @@ declare const onPlayersChanged: (handler: PlayersChangedHandler) => void;
  */
 declare const 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, HapticKind, 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, haptic, 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 ConnectionState, type ConnectionStatus, DEFAULT_ICON_URLS, DEFAULT_VOICE_PLAN, type Deadline, type DeadlineArgs, type DeadlineContext, type DevHooksCtx, type Duration, type Emit, type EventHandler, type EventSubscription, GAME_START, type GameConfig, type GameLogic, type GameTime, HapticKind, type Insets, type JsonMergePatch, type JsonPatchOp, type Me, type Mic, type MicPolicy, type ObserverRef, type Operation, type Other, type Pause, type PayloadMap, type PlayScreenMessage, type PredictionWarning, type Presence, type PresenceChange, type Quality, type ReconnectableWSOptions, ReconnectableWebSocket, type RunHandle, type Seat, type SeatId, 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, type VoicePlan, type VoicePlanArgs, type VoiceStatus, applyJsonMergePatch, applyJsonPatch, attachDevHooks, createDevHooks, finishGame, firstFrameReady, gameReady, gameTime, getInsets, getPause, getPredictionWarnings, getPresence, haptic, init, isHosted, isServerOnlyAction, minus, muteMic, on, onInsetsChange, onPauseChange, onPresenceChange, playBgm, playSound, plus, run, send, serverOnly, setListeningRoom, stopBgm, sub };