property

型に関する情報は下部に記載しています。

コード 説明
$whim.users [User] ルームに入っているユーザー一覧
$whim.room Room Room Object
$whim.accessUser User 現在アクセスしているUser
$whim.state State ゲームの状態

Room型

key 詳細
id そのroomのユニークなid。英数字で構成される。 そのroomのユニークなid。英数字で構成される。

User型

key 詳細
id String ユーザーのユニークなID。
name String ユーザーが設定した名前。
timestamp Date ユーザがルームに参加した時間
postionNumber Integer ユーザーが画面上で位置している場所。左上からZ字上に1,2,3,4と割り振られる

State型

この型はゲームに必要な情報に応じて任意に使用可能です。

この型は、そのroomに参加しているユーザーに対して常に同期されます。

functions

ここでは ゲーム情報を変更し、そのルームに入っている各ユーザーに同期するためのAPIを提供しています。

コード 引数 説明
$whim.assignState(Object) Object ゲーム情報を追記更新、
存在しないキーの場合:追記
存在するキーの場合:更新
$whim.replaceState(Object) Object ゲーム情報を渡されたObjectにすべて変える
$whim.deleteState   ゲーム情報を空にする

目次ページに戻る

目次へ