Skip to content

API リファレンス

@uzupj/uzu-sdk パッケージの公開 API 一覧です。

カテゴリ

カテゴリ内容
API リファレンスinit / run / sync / on / send / playSound 等の関数と型定義
manifest.jsonゲームメタデータ (id / playerCount / characters / orientation 等)

主要 API のクイック参照

API説明
init()SDK 初期化 + Flutter/iframe ブリッジ設定
firstFrameReady()(予定) ゲーム splash 描画した瞬間。ホストの 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)ボイスチャットルーム移動