テーマ
API リファレンス
@uzuhq/code-sdk パッケージの公開 API 一覧です。
カテゴリ
| カテゴリ | 内容 |
|---|---|
| API リファレンス | init / run / sync / on / send / playSound 等の関数と型定義 |
| manifest.json | ゲームメタデータ (id / playerCount / characters / orientation 等) |
主要 API のクイック参照
| API | 説明 |
|---|---|
init() | SDK 初期化 + Flutter/iframe ブリッジ設定 |
firstFrameReady() | ゲームが最初のフレームを描画した瞬間。ホストの spinner を消す |
gameReady() | ユーザー操作可能になった瞬間に呼ぶ |
run<S>(config) | Host-authoritative ゲームループ実行 |
sync<S>(config) | Server-authoritative 状態同期 (JSON Patch ベース) |
on(type, handler) | Flutter/ホストからのメッセージリスナー |
send(message) | Flutter/ホストへメッセージ送信 |
playSound(name) | 効果音再生 |
playBgm(name) / stopBgm() | BGM 制御 |
setMicEnabled(bool) | マイクのオンオフ |
changeRoom(roomId | null) | ボイスチャットルーム移動 |
haptic(kind) | 端末を短く振動させる ('light' / 'medium' / 'heavy') |
finishGame() | ゲームを終えて、呼んだ端末のプレイ画面を閉じる |